blob: 75b4b7d2c2a7f5cf4088cbcb74c441ceb1d6ff9d [file] [log] [blame]
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*
*/
package org.apache.directory.api.ldap.codec.search;
import static org.junit.jupiter.api.Assertions.assertArrayEquals;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertNotNull;
import static org.junit.jupiter.api.Assertions.assertNull;
import static org.junit.jupiter.api.Assertions.assertThrows;
import java.nio.ByteBuffer;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.apache.directory.api.asn1.DecoderException;
import org.apache.directory.api.asn1.EncoderException;
import org.apache.directory.api.asn1.ber.Asn1Decoder;
import org.apache.directory.api.asn1.util.Asn1Buffer;
import org.apache.directory.api.ldap.codec.api.LdapEncoder;
import org.apache.directory.api.ldap.codec.api.LdapMessageContainer;
import org.apache.directory.api.ldap.codec.osgi.AbstractCodecServiceTest;
import org.apache.directory.api.ldap.model.constants.SchemaConstants;
import org.apache.directory.api.ldap.model.exception.LdapException;
import org.apache.directory.api.ldap.model.filter.ExprNode;
import org.apache.directory.api.ldap.model.filter.ExtensibleNode;
import org.apache.directory.api.ldap.model.message.AliasDerefMode;
import org.apache.directory.api.ldap.model.message.SearchRequest;
import org.apache.directory.api.ldap.model.message.SearchScope;
import org.apache.directory.api.ldap.model.schema.normalizers.DeepTrimToLowerNormalizer;
import org.apache.directory.api.ldap.model.schema.normalizers.OidNormalizer;
import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.parallel.Execution;
import org.junit.jupiter.api.parallel.ExecutionMode;
/**
* A test case for SearchRequest messages
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
@Execution( ExecutionMode.CONCURRENT)
public class SearchRequestMatchingRuleAssertionTest extends AbstractCodecServiceTest
{
/** An oid normalizer map */
static Map<String, OidNormalizer> oids = new HashMap<String, OidNormalizer>();
@BeforeAll
public static void setUp() throws Exception
{
// DC normalizer
OidNormalizer dcOidNormalizer = new OidNormalizer( "dc", new DeepTrimToLowerNormalizer(
SchemaConstants.DOMAIN_COMPONENT_AT_OID ) );
oids.put( "dc", dcOidNormalizer );
oids.put( "domaincomponent", dcOidNormalizer );
oids.put( "0.9.2342.19200300.100.1.25", dcOidNormalizer );
// OU normalizer
OidNormalizer ouOidNormalizer = new OidNormalizer( "ou", new DeepTrimToLowerNormalizer(
SchemaConstants.OU_AT_OID ) );
oids.put( "ou", ouOidNormalizer );
oids.put( "organizationalUnitName", ouOidNormalizer );
oids.put( "2.5.4.11", ouOidNormalizer );
// ObjectClass normalizer
OidNormalizer objectClassOidNormalizer = new OidNormalizer( "objectClass", new DeepTrimToLowerNormalizer(
SchemaConstants.OBJECT_CLASS_AT_OID ) );
oids.put( "objectclass", objectClassOidNormalizer );
oids.put( "2.5.4.0", objectClassOidNormalizer );
}
/**
* Tests an search request decode with a simple equality match filter.
*/
@Test
public void testDecodeSearchRequestExtensibleMatch() throws DecoderException, EncoderException, LdapException
{
ByteBuffer stream = ByteBuffer.allocate( 0x63 );
stream.put( new byte[]
{
0x30, 0x61, // LDAPMessage ::= SEQUENCE {
0x02, 0x01, 0x01, // messageID
0x63, 0x5C, // protocolOp CHOICE {
// searchRequest SearchRequest,
//
// SearchRequest ::= [APPLICATION 3] SEQUENCE {
0x04, 0x11, // "dc=example,dc=com"
'd', 'c', '=', 'e', 'x', 'a', 'm', 'p', 'l', 'e', ',', 'd', 'c', '=', 'c', 'o', 'm',
// scope ENUMERATED {
0x0A, 0x01, 0x00, // baseObject (0), ...
// derefAliases ENUMERATED {
0x0A, 0x01, 0x02, // derefFindingBaseObj (2),...
0x02, 0x01, 0x02, // sizeLimit INTEGER (0 .. maxInt), (2)
0x02, 0x01, 0x03, // timeLimit INTEGER (0 .. maxInt), (3)
0x01, 0x01, ( byte ) 0xFF, // typesOnly BOOLEAN, (true)
( byte ) 0xA9, 0x21, // filter Filter,
//
// Filter ::= CHOICE {
// extensibleMatch [9] MatchingRuleAssertion }
//
// MatchingRuleAssertion ::= SEQUENCE {
( byte ) 0x81, 0x13, // matchingRule [1] MatchingRuleId OPTIONAL,
'1', '.', '2', '.', '8', '4', '0', '.', '4', '8', '0', '1', '8', '.', '1', '.', '2', '.', '2',
( byte ) 0x82, 0x02, // type [2] AttributeDescription OPTIONAL,
'c', 'n',
( byte ) 0x83, 0x03, // matchValue [3] AssertionValue,
'a', 'o', 'k',
// dnAttributes [4] BOOLEAN DEFAULT FALSE }
( byte ) 0x84, 0x01, ( byte ) 0xFF,
0x30, 0x15, // AttributeDescriptionList ::= SEQUENCE OF AttributeDescription
0x04, 0x05,
'a', 't', 't', 'r', '0', // AttributeDescription ::= LDAPString
0x04, 0x05,
'a', 't', 't', 'r', '1', // AttributeDescription ::= LDAPString
0x04, 0x05,
'a', 't', 't', 'r', '2', // AttributeDescription ::= LDAPString
});
stream.flip();
// Allocate a BindRequest Container
LdapMessageContainer<SearchRequest> ldapMessageContainer = new LdapMessageContainer<>( codec );
Asn1Decoder.decode( stream, ldapMessageContainer );
SearchRequest searchRequest = ldapMessageContainer.getMessage();
assertEquals( 1, searchRequest.getMessageId() );
assertEquals( "dc=example,dc=com", searchRequest.getBase().toString() );
assertEquals( SearchScope.OBJECT, searchRequest.getScope() );
assertEquals( AliasDerefMode.DEREF_FINDING_BASE_OBJ, searchRequest.getDerefAliases() );
assertEquals( 2, searchRequest.getSizeLimit() );
assertEquals( 3, searchRequest.getTimeLimit() );
assertEquals( true, searchRequest.getTypesOnly() );
// The attributes
List<String> attributes = searchRequest.getAttributes();
for ( String attribute : attributes )
{
assertNotNull( attribute );
}
// Check encode reverse
Asn1Buffer buffer = new Asn1Buffer();
LdapEncoder.encodeMessage( buffer, codec, searchRequest );
assertArrayEquals( stream.array(), buffer.getBytes().array() );
}
/**
* Test the decoding of a SearchRequest with an empty extensible match
*/
@Test
public void testDecodeSearchRequestEmptyExtensibleMatch() throws DecoderException
{
byte[] asn1BER = new byte[]
{
0x30, 0x3B,
0x02, 0x01, 0x04, // messageID
0x63, 0x36, // baseObject LDAPDN,
0x04, 0x1F, // baseObject LDAPDN,
'u', 'i', 'd', '=', 'a', 'k', 'a', 'r', 'a', 's', 'u', 'l', 'u', ',',
'd', 'c', '=', 'e', 'x', 'a', 'm', 'p', 'l', 'e', ',', 'd', 'c', '=', 'c', 'o', 'm',
0x0A, 0x01, 0x01,
0x0A, 0x01, 0x03,
0x02, 0x01, 0x00,
0x02, 0x01, 0x00,
0x01, 0x01, ( byte ) 0xFF,
( byte ) 0xA9, 0x00,
0x30, 0x02, // AttributeDescriptionList ::= SEQUENCE OF AttributeDescription
0x04, 0x00
};
ByteBuffer stream = ByteBuffer.allocate( asn1BER.length );
stream.put( asn1BER );
stream.flip();
// Allocate a LdapMessage Container
LdapMessageContainer<SearchRequest> ldapMessageContainer = new LdapMessageContainer<>( codec );
// Decode a SearchRequest message
assertThrows( DecoderException.class, ( ) ->
{
Asn1Decoder.decode( stream, ldapMessageContainer );
} );
}
/**
* Test the decoding of a SearchRequest with an extensible match and an
* empty matching rule
*/
@Test
public void testDecodeSearchRequestExtensibleMatchEmptyMatchingRule() throws DecoderException
{
byte[] asn1BER = new byte[]
{
0x30, 0x3D,
0x02, 0x01, 0x04, // messageID
0x63, 0x38,
0x04, 0x1F, // baseObject LDAPDN,
'u', 'i', 'd', '=', 'a', 'k', 'a', 'r', 'a', 's', 'u', 'l', 'u', ',',
'd', 'c', '=', 'e', 'x', 'a', 'm', 'p', 'l', 'e', ',', 'd', 'c', '=', 'c', 'o', 'm',
0x0A, 0x01, 0x01,
0x0A, 0x01, 0x03,
0x02, 0x01, 0x00,
0x02, 0x01, 0x00,
0x01, 0x01, ( byte ) 0xFF,
( byte ) 0xA9, 0x02,
( byte ) 0x81, 0x00, // matchingRule [1] MatchingRuleId OPTIONAL,
0x30, 0x02, // AttributeDescriptionList ::= SEQUENCE OF AttributeDescription
0x04, 0x00
};
ByteBuffer stream = ByteBuffer.allocate( asn1BER.length );
stream.put( asn1BER );
stream.flip();
// Allocate a LdapMessage Container
LdapMessageContainer<SearchRequest> ldapMessageContainer = new LdapMessageContainer<>( codec );
// Decode a SearchRequest message
assertThrows( DecoderException.class, ( ) ->
{
Asn1Decoder.decode( stream, ldapMessageContainer );
} );
}
/**
* Test the decoding of a SearchRequest with an extensible match and an
* empty type
*/
@Test
public void testDecodeSearchRequestExtensibleMatchEmptyType() throws DecoderException
{
byte[] asn1BER = new byte[]
{
0x30, 0x3D,
0x02, 0x01, 0x04, // messageID
0x63, 0x38,
0x04, 0x1F, // baseObject LDAPDN,
'u', 'i', 'd', '=', 'a', 'k', 'a', 'r', 'a', 's', 'u', 'l', 'u', ',',
'd', 'c', '=', 'e', 'x', 'a', 'm', 'p', 'l', 'e', ',', 'd', 'c', '=', 'c', 'o', 'm',
0x0A, 0x01, 0x01,
0x0A, 0x01, 0x03,
0x02, 0x01, 0x00,
0x02, 0x01, 0x00,
0x01, 0x01, ( byte ) 0xFF,
( byte ) 0xA9, 0x02,
( byte ) 0x82, 0x00, // type [2] AttributeDescription OPTIONAL
0x30, 0x02, // AttributeDescriptionList ::= SEQUENCE OF AttributeDescription
0x04, 0x00
};
ByteBuffer stream = ByteBuffer.allocate( asn1BER.length );
stream.put( asn1BER );
stream.flip();
// Allocate a LdapMessage Container
LdapMessageContainer<SearchRequest> ldapMessageContainer = new LdapMessageContainer<>( codec );
// Decode a SearchRequest message
assertThrows( DecoderException.class, ( ) ->
{
Asn1Decoder.decode( stream, ldapMessageContainer );
} );
}
/**
* Test the decoding of a SearchRequest with an extensible match and an
* empty matchValue
*/
@Test
public void testDecodeSearchRequestExtensibleMatchEmptyMatchValue() throws DecoderException, EncoderException, LdapException
{
byte[] asn1BER = new byte[]
{
0x30, 0x41,
0x02, 0x01, 0x04, // messageID
0x63, 0x3C,
0x04, 0x1F, // baseObject LDAPDN,
'u', 'i', 'd', '=', 'a', 'k', 'a', 'r', 'a', 's', 'u', 'l', 'u', ',',
'd', 'c', '=', 'e', 'x', 'a', 'm', 'p', 'l', 'e', ',', 'd', 'c', '=', 'c', 'o', 'm',
0x0A, 0x01, 0x01,
0x0A, 0x01, 0x03,
0x02, 0x01, 0x00,
0x02, 0x01, 0x00,
0x01, 0x01, ( byte ) 0xFF,
( byte ) 0xA9, 0x08,
( byte ) 0x81, 0x04,
't', 'e', 's', 't',
( byte ) 0x83, 0x00, // matchValue [3] AssertionValue,
0x30, 0x00 // AttributeDescriptionList ::= SEQUENCE OF AttributeDescription
};
ByteBuffer stream = ByteBuffer.allocate( asn1BER.length );
stream.put( asn1BER );
stream.flip();
// Allocate a LdapMessage Container
LdapMessageContainer<SearchRequest> ldapMessageContainer = new LdapMessageContainer<>( codec );
// Decode a SearchRequest message
Asn1Decoder.decode( stream, ldapMessageContainer );
SearchRequest searchRequest = ldapMessageContainer.getMessage();
assertEquals( 4, searchRequest.getMessageId() );
assertEquals( "uid=akarasulu,dc=example,dc=com", searchRequest.getBase().toString() );
assertEquals( SearchScope.ONELEVEL, searchRequest.getScope() );
assertEquals( AliasDerefMode.DEREF_ALWAYS, searchRequest.getDerefAliases() );
assertEquals( 0, searchRequest.getSizeLimit() );
assertEquals( 0, searchRequest.getTimeLimit() );
assertEquals( true, searchRequest.getTypesOnly() );
// Extended
ExprNode filter = searchRequest.getFilter();
ExtensibleNode extensibleNode = ( ExtensibleNode ) filter;
assertNotNull( extensibleNode );
assertEquals( "test", extensibleNode.getMatchingRuleId() );
assertNull( extensibleNode.getAttribute() );
assertEquals( "", extensibleNode.getValue().getString() );
assertFalse( extensibleNode.hasDnAttributes() );
List<String> attributes = searchRequest.getAttributes();
assertEquals( 0, attributes.size() );
// Check encode reverse
Asn1Buffer buffer = new Asn1Buffer();
LdapEncoder.encodeMessage( buffer, codec, searchRequest );
assertArrayEquals( stream.array(), buffer.getBytes().array() );
}
/**
* Test the decoding of a SearchRequest with an extensible match and an
* matching rule and an empty type
*/
@Test
public void testDecodeSearchRequestExtensibleMatchMatchingRuleEmptyType() throws DecoderException
{
byte[] asn1BER = new byte[]
{
0x30, 0x43,
0x02, 0x01, 0x04, // messageID
0x63, 0x3E,
0x04, 0x1F, // baseObject LDAPDN,
'u', 'i', 'd', '=', 'a', 'k', 'a', 'r', 'a', 's', 'u', 'l', 'u', ',',
'd', 'c', '=', 'e', 'x', 'a', 'm', 'p', 'l', 'e', ',', 'd', 'c', '=', 'c', 'o', 'm',
0x0A, 0x01, 0x01,
0x0A, 0x01, 0x03,
0x02, 0x01, 0x00,
0x02, 0x01, 0x00,
0x01, 0x01, ( byte ) 0xFF,
( byte ) 0xA9, 0x08,
( byte ) 0x81, 0x04,
't', 'e', 's', 't',
( byte ) 0x82, 0x00, // type [2] AttributeDescription OPTIONAL,
0x30, 0x02, // AttributeDescriptionList ::= SEQUENCE OF AttributeDescription
0x04, 0x00
};
ByteBuffer stream = ByteBuffer.allocate( asn1BER.length );
stream.put( asn1BER );
stream.flip();
// Allocate a LdapMessage Container
LdapMessageContainer<SearchRequest> ldapMessageContainer = new LdapMessageContainer<>( codec );
// Decode a SearchRequest message
assertThrows( DecoderException.class, ( ) ->
{
Asn1Decoder.decode( stream, ldapMessageContainer );
} );
}
/**
* Test the decoding of a SearchRequest with an extensible match and an
* matching rule and an empty dnAttributes
*/
@Test
public void testDecodeSearchRequestExtensibleMatchDnAttributesEmptyType() throws DecoderException
{
byte[] asn1BER = new byte[]
{
0x30, 0x60, // LDAPMessage ::= SEQUENCE {
0x02, 0x01, 0x01, // messageID
0x63, 0x5B, // protocolOp CHOICE {
// searchRequest SearchRequest,
//
// SearchRequest ::= [APPLICATION 3] SEQUENCE {
0x04, 0x11, // "dc=example,dc=com"
'd', 'c', '=', 'e', 'x', 'a', 'm', 'p', 'l', 'e', ',', 'd', 'c', '=', 'c', 'o', 'm',
// scope ENUMERATED {
0x0A, 0x01, 0x00, // baseObject (0), ...
// derefAliases ENUMERATED {
0x0A, 0x01, 0x02, // derefFindingBaseObj (2),...
0x02, 0x01, 0x02, // sizeLimit INTEGER (0 .. maxInt), (2)
0x02, 0x01, 0x03, // timeLimit INTEGER (0 .. maxInt), (3)
0x01, 0x01, ( byte ) 0xFF, // typesOnly BOOLEAN, (true)
( byte ) 0xA9, 0x20, // filter Filter,
//
// Filter ::= CHOICE {
// extensibleMatch [9] MatchingRuleAssertion }
//
// MatchingRuleAssertion ::= SEQUENCE {
( byte ) 0x81, 0x02, // matchingRule [1] MatchingRuleId OPTIONAL,
'c', 'n',
( byte ) 0x82, 0x13, // type [2] AttributeDescription OPTIONAL,
'1', '.', '2', '.', '8', '4', '0', '.', '4', '8', '0', '1', '8', '.', '1', '.', '2', '.', '2',
( byte ) 0x83, 0x03, // matchValue [3] AssertionValue,
'a', 'o', 'k',
( byte ) 0x84, 0x00, // dnAttributes [4] BOOLEAN DEFAULT FALSE }
0x30, 0x15, // AttributeDescriptionList ::= SEQUENCE OF AttributeDescription
0x04, 0x05,
'a', 't', 't', 'r', '0', // AttributeDescription ::= LDAPString
0x04, 0x05,
'a', 't', 't', 'r', '1', // AttributeDescription ::= LDAPString
0x04, 0x05,
'a', 't', 't', 'r', '2', // AttributeDescription ::= LDAPString
};
ByteBuffer stream = ByteBuffer.allocate( asn1BER.length );
stream.put( asn1BER );
stream.flip();
// Allocate a LdapMessage Container
LdapMessageContainer<SearchRequest> ldapMessageContainer = new LdapMessageContainer<>( codec );
// Decode a SearchRequest message
assertThrows( DecoderException.class, ( ) ->
{
Asn1Decoder.decode( stream, ldapMessageContainer );
} );
}
/**
* Test the decoding of a SearchRequest with an extensible match and a
* matching rule and nothing else
*/
@Test
public void testDecodeSearchRequestExtensibleMatchMatchingRuleAlone() throws DecoderException
{
byte[] asn1BER = new byte[]
{
0x30, 0x41,
0x02, 0x01, 0x04, // messageID
0x63, 0x3C,
0x04, 0x1F, // baseObject LDAPDN,
'u', 'i', 'd', '=', 'a', 'k', 'a', 'r', 'a', 's', 'u', 'l', 'u', ',',
'd', 'c', '=', 'e', 'x', 'a', 'm', 'p', 'l', 'e', ',', 'd', 'c', '=', 'c', 'o', 'm',
0x0A, 0x01, 0x01,
0x0A, 0x01, 0x03,
0x02, 0x01, 0x00,
0x02, 0x01, 0x00,
0x01, 0x01, ( byte ) 0xFF,
( byte ) 0xA9, 0x06,
( byte ) 0x81, 0x04,
't', 'e', 's', 't',
0x30, 0x02, // AttributeDescriptionList ::= SEQUENCE OF AttributeDescription
0x04, 0x00
};
ByteBuffer stream = ByteBuffer.allocate( asn1BER.length );
stream.put( asn1BER );
stream.flip();
// Allocate a LdapMessage Container
LdapMessageContainer<SearchRequest> ldapMessageContainer = new LdapMessageContainer<>( codec );
// Decode a SearchRequest message
assertThrows( DecoderException.class, ( ) ->
{
Asn1Decoder.decode( stream, ldapMessageContainer );
} );
}
/**
* Test the decoding of a SearchRequest with an extensible match and a type
* and nothing else
*/
@Test
public void testDecodeSearchRequestExtensibleMatchTypeAlone() throws DecoderException, EncoderException
{
byte[] asn1BER = new byte[]
{
0x30, 0x43,
0x02, 0x01, 0x04, // messageID
0x63, 0x3E,
0x04, 0x1F, // baseObject LDAPDN,
'u', 'i', 'd', '=', 'a', 'k', 'a', 'r', 'a', 's', 'u', 'l', 'u', ',',
'd', 'c', '=', 'e', 'x', 'a', 'm', 'p', 'l', 'e', ',', 'd', 'c', '=', 'c', 'o', 'm',
0x0A, 0x01, 0x01,
0x0A, 0x01, 0x03,
0x02, 0x01, 0x00,
0x02, 0x01, 0x00,
0x01, 0x01, ( byte ) 0xFF,
( byte ) 0xA9, 0x06,
( byte ) 0x82, 0x04,
't', 'e', 's', 't',
0x30, 0x02, // AttributeDescriptionList ::= SEQUENCE OF AttributeDescription
0x04, 0x00
};
ByteBuffer stream = ByteBuffer.allocate( asn1BER.length );
stream.put( asn1BER );
stream.flip();
// Allocate a LdapMessage Container
LdapMessageContainer<SearchRequest> ldapMessageContainer = new LdapMessageContainer<>( codec );
// Decode a SearchRequest message
assertThrows( DecoderException.class, ( ) ->
{
Asn1Decoder.decode( stream, ldapMessageContainer );
} );
}
/**
* Test the decoding of a SearchRequest with an extensible match and a match
* Value and nothing else
*/
@Test
public void testDecodeSearchRequestExtensibleMatchMatchValueAlone() throws DecoderException
{
byte[] asn1BER = new byte[]
{
0x30, 0x43,
0x02, 0x01, 0x04, // messageID
0x63, 0x3E,
0x04, 0x1F, // baseObject LDAPDN,
'u', 'i', 'd', '=', 'a', 'k', 'a', 'r', 'a', 's', 'u', 'l', 'u', ',',
'd', 'c', '=', 'e', 'x', 'a', 'm', 'p', 'l', 'e', ',', 'd', 'c', '=', 'c', 'o', 'm',
0x0A, 0x01, 0x01,
0x0A, 0x01, 0x03,
0x02, 0x01, 0x00,
0x02, 0x01, 0x00,
0x01, 0x01, ( byte ) 0xFF,
( byte ) 0xA9, 0x06,
( byte ) 0x83, 0x04,
't', 'e', 's', 't',
0x30, 0x02, // AttributeDescriptionList ::= SEQUENCE OF AttributeDescription
0x04, 0x00
};
ByteBuffer stream = ByteBuffer.allocate( asn1BER.length );
stream.put( asn1BER );
stream.flip();
// Allocate a LdapMessage Container
LdapMessageContainer<SearchRequest> ldapMessageContainer = new LdapMessageContainer<>( codec );
// Decode a SearchRequest message
assertThrows( DecoderException.class, ( ) ->
{
Asn1Decoder.decode( stream, ldapMessageContainer );
} );
}
}