| /* |
| * 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; |
| |
| |
| import static org.junit.jupiter.api.Assertions.assertEquals; |
| import static org.junit.jupiter.api.Assertions.assertFalse; |
| import static org.junit.jupiter.api.Assertions.assertThrows; |
| import static org.junit.jupiter.api.Assertions.assertTrue; |
| |
| import java.nio.ByteBuffer; |
| 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.Asn1Container; |
| 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.message.AbandonRequest; |
| import org.apache.directory.api.ldap.model.message.AbandonRequestImpl; |
| import org.apache.directory.api.ldap.model.message.Control; |
| import org.apache.directory.api.ldap.model.message.Message; |
| import org.apache.directory.api.ldap.model.message.controls.Cascade; |
| import org.apache.directory.api.ldap.model.message.controls.ManageDsaIT; |
| import org.apache.directory.api.ldap.model.message.controls.PagedResults; |
| import org.apache.directory.api.ldap.model.message.controls.SortRequest; |
| import org.junit.jupiter.api.Test; |
| import org.junit.jupiter.api.parallel.Execution; |
| import org.junit.jupiter.api.parallel.ExecutionMode; |
| |
| |
| @Execution(ExecutionMode.CONCURRENT) |
| public class LdapControlTest extends AbstractCodecServiceTest |
| { |
| /** |
| * Test the decoding of a Request with controls |
| */ |
| @Test |
| public void testDecodeRequestWithControls() throws DecoderException, EncoderException |
| { |
| ByteBuffer stream = ByteBuffer.allocate( 0x9C ); |
| stream.put( new byte[] |
| { |
| 0x30, (byte)0x81, (byte)0x99, // LDAPMessage ::=SEQUENCE { |
| 0x02, 0x01, 0x03, // messageID MessageID |
| 0x50, 0x01, 0x02, // CHOICE { ..., abandonRequest |
| ( byte ) 0xA0, (byte)0x81, (byte)0x90, // controls [0] Controls OPTIONAL } |
| 0x30, 0x2E, // Control ::= SEQUENCE { |
| 0x04, 0x16, // controlType LDAPOID, |
| // SortRequest |
| '1', '.', '2', '.', '8', '4', '0', '.', |
| '1', '1', '3', '5', '5', '6', '.', '1', |
| '.', '4', '.', '4', '7', '3', |
| 0x01, 0x01, ( byte ) 0xFF, // criticality BOOLEAN DEFAULT FALSE, |
| 0x04, 0x11, // controlValue OCTET STRING OPTIONAL } |
| 0x30, 0x0F, // SortKeyList ::= SEQUENCE OF SEQUENCE { |
| 0x30, 0x07, // SEQUENCE |
| 0x04, 0x02, // attributeType AttributeDescription, |
| 'c', 'n', |
| (byte)0x81, 0x01, (byte)0xFF, // reverseOrder [1] BOOLEAN DEFAULT FALSE } |
| 0x30, 0x04, // SEQUENCE |
| 0x04, 0x02, // attributeType AttributeDescription, |
| 's', 'n', |
| 0x30, 0x25, // Control ::= SEQUENCE { |
| 0x04, 0x16, // controlType LDAPOID, |
| // PagedResults |
| '1', '.', '2', '.', '8', '4', '0', '.', |
| '1', '1', '3', '5', '5', '6', '.', '1', |
| '.', '4', '.', '3', '1', '9', |
| 0x04, 0x0B, // controlValue OCTET STRING OPTIONAL } |
| 0x30, 0x09, // realSearchControlValue ::= SEQUENCE { |
| 0x02, 0x01, 0x10, // size INTEGER (0..maxInt), |
| 0x04, 0x04, // cookie OCTET STRING |
| 't', 't', 't', 't', |
| 0x30, 0x1C, // Control ::= SEQUENCE { |
| 0x04, 0x17, // controlType LDAPOID, |
| // ManageDsaIT |
| '2', '.', '1', '6', '.', '8', '4', '0', |
| '.', '1', '.', '1', '1', '3', '7', '3', |
| '0', '.', '3', '.', '4', '.', '2', |
| 0x01, 0x01, ( byte ) 0xFF, // criticality BOOLEAN DEFAULT FALSE } |
| 0x30, 0x19, // Control ::= SEQUENCE { |
| 0x04, 0x17, // controlType LDAPOID} |
| // Cascade |
| '1', '.', '3', '.', '6', '.', '1', '.', |
| '4', '.', '1', '.', '1', '8', '0', '6', |
| '0', '.', '0', '.', '0', '.', '1' |
| } ); |
| |
| stream.flip(); |
| |
| // Allocate a LdapMessageContainer Container |
| LdapMessageContainer<AbandonRequest> ldapMessageContainer = |
| new LdapMessageContainer<>( codec ); |
| |
| // Decode the PDU |
| Asn1Decoder.decode( stream, ldapMessageContainer ); |
| |
| // Check that everything is OK |
| AbandonRequest abandonRequest = ldapMessageContainer.getMessage(); |
| |
| // Copy the message |
| AbandonRequest internalAbandonRequest = new AbandonRequestImpl( abandonRequest.getAbandoned() ); |
| internalAbandonRequest.setMessageId( abandonRequest.getMessageId() ); |
| |
| assertEquals( 3, abandonRequest.getMessageId() ); |
| assertEquals( 2, abandonRequest.getAbandoned() ); |
| |
| // Check the Controls |
| Map<String, Control> controls = abandonRequest.getControls(); |
| |
| assertEquals( 4, controls.size() ); |
| |
| Control control = controls.get( "1.2.840.113556.1.4.473" ); |
| assertEquals( "1.2.840.113556.1.4.473", control.getOid() ); |
| assertTrue( control instanceof SortRequest ); |
| assertTrue( control.isCritical() ); |
| assertEquals( 2, ( ( SortRequest ) control ).getSortKeys().size() ); |
| internalAbandonRequest.addControl( control ); |
| |
| control = controls.get( "1.2.840.113556.1.4.319" ); |
| assertEquals( "1.2.840.113556.1.4.319", control.getOid() ); |
| assertTrue( control instanceof PagedResults ); |
| assertFalse( control.isCritical() ); |
| internalAbandonRequest.addControl( control ); |
| |
| control = controls.get( "2.16.840.1.113730.3.4.2" ); |
| assertEquals( "2.16.840.1.113730.3.4.2", control.getOid() ); |
| assertTrue( control instanceof ManageDsaIT ); |
| assertTrue( control.isCritical() ); |
| internalAbandonRequest.addControl( control ); |
| |
| control = controls.get( "1.3.6.1.4.1.18060.0.0.1" ); |
| assertEquals( "1.3.6.1.4.1.18060.0.0.1", control.getOid() ); |
| assertTrue( control instanceof Cascade ); |
| assertFalse( control.isCritical() ); |
| internalAbandonRequest.addControl( control ); |
| |
| // Check the encoding |
| Asn1Buffer buffer = new Asn1Buffer(); |
| ByteBuffer bb = LdapEncoder.encodeMessage( buffer, codec, internalAbandonRequest ); |
| |
| // Check the length |
| assertEquals( 0x9C, bb.limit() ); |
| |
| // Don't check the PDU, as control are in a Map, and can be in a different order |
| // So we decode the generated PDU, and we compare it with the initial message |
| Asn1Decoder.decode( bb, ldapMessageContainer ); |
| |
| AbandonRequest abandonRequest2 = ldapMessageContainer.getMessage(); |
| |
| assertEquals( abandonRequest, abandonRequest2 ); |
| } |
| |
| |
| /** |
| * Test the decoding of a Request with an empty list of controls |
| */ |
| @Test |
| public void testDecodeRequestWithEmptyControls() throws DecoderException, EncoderException |
| { |
| ByteBuffer stream = ByteBuffer.allocate( 0x0A ); |
| stream.put( new byte[] |
| { |
| 0x30, 0x08, // LDAPMessage ::=SEQUENCE { |
| 0x02, 0x01, 0x03, // messageID MessageID |
| 0x50, 0x01, 0x02, // CHOICE { ..., abandonRequest |
| // AbandonRequest,... |
| ( byte ) 0xA0, 0x00 // controls [0] Controls OPTIONAL } |
| } ); |
| |
| stream.flip(); |
| |
| // Allocate a LdapMessageContainer Container |
| LdapMessageContainer<AbandonRequest> ldapMessageContainer = |
| new LdapMessageContainer<>( codec ); |
| |
| // Decode the PDU |
| Asn1Decoder.decode( stream, ldapMessageContainer ); |
| |
| // Check that everything is OK |
| AbandonRequest abandonRequest = ldapMessageContainer.getMessage(); |
| |
| // Copy the message |
| AbandonRequest internalAbandonRequest = new AbandonRequestImpl( abandonRequest.getAbandoned() ); |
| internalAbandonRequest.setMessageId( abandonRequest.getMessageId() ); |
| |
| assertEquals( 3, abandonRequest.getMessageId() ); |
| assertEquals( 2, abandonRequest.getAbandoned() ); |
| |
| // Check the Controls |
| Map<String, Control> controls = abandonRequest.getControls(); |
| |
| assertEquals( 0, controls.size() ); |
| |
| // Check the encoding |
| Asn1Buffer buffer = new Asn1Buffer(); |
| ByteBuffer bb = LdapEncoder.encodeMessage( buffer, codec, internalAbandonRequest ); |
| |
| // Check the length, which should be 2 bytes shorter, as we don't encode teh empty control |
| assertEquals( 0x08, bb.limit() ); |
| |
| // Don't check the PDU, as control are in a Map, and can be in a different order |
| // So we decode the generated PDU, and we compare it with the initial message |
| Asn1Decoder.decode( bb, ldapMessageContainer ); |
| |
| AbandonRequest abandonRequest2 = ldapMessageContainer.getMessage(); |
| |
| assertEquals( abandonRequest, abandonRequest2 ); |
| } |
| |
| |
| /** |
| * Test the decoding of a Request with null OID controls |
| */ |
| @Test |
| public void testDecodeRequestWithControlsNullOID() throws DecoderException |
| { |
| ByteBuffer stream = ByteBuffer.allocate( 0x19 ); |
| stream.put( new byte[] |
| { |
| 0x30, 0x17, // LDAPMessage ::=SEQUENCE { |
| 0x02, 0x01, 0x03, // messageID MessageID |
| 0x50, 0x01, 0x02, // CHOICE { ..., abandonRequest |
| // AbandonRequest,... |
| ( byte ) 0xA0, 0x0F, // controls [0] Controls OPTIONAL } |
| 0x30, 0x0D, // Control ::= SEQUENCE { |
| 0x04, 0x00, // controlType LDAPOID, |
| 0x01, 0x01, ( byte ) 0xFF, // criticality BOOLEAN DEFAULT FALSE, |
| 0x04, 0x06, // controlValue OCTET STRING OPTIONAL } |
| 'a', 'b', 'c', 'd', 'e', 'f', |
| } ); |
| |
| stream.flip(); |
| |
| // Allocate a LdapMessageContainer Container |
| Asn1Container ldapMessageContainer = new LdapMessageContainer<Message>( codec ); |
| |
| // Decode the PDU |
| assertThrows( DecoderException.class, ( ) -> |
| { |
| Asn1Decoder.decode( stream, ldapMessageContainer ); |
| } ); |
| } |
| |
| |
| /** |
| * Test the decoding of a Request with bad OID controls |
| */ |
| @Test |
| public void testDecodeRequestWithControlsBadOID() throws DecoderException |
| { |
| ByteBuffer stream = ByteBuffer.allocate( 0x20 ); |
| stream.put( new byte[] |
| { |
| 0x30, 0x1E, // LDAPMessage ::=SEQUENCE { |
| 0x02, 0x01, 0x03, // messageID MessageID |
| 0x50, 0x01, 0x02, // CHOICE { ..., abandonRequest |
| // AbandonRequest,... |
| ( byte ) 0xA0, 0x16, // controls [0] Controls OPTIONAL } |
| 0x30, 0x14, // Control ::= SEQUENCE { |
| // controlType LDAPOID, |
| 0x04, 0x07, // criticality BOOLEAN DEFAULT FALSE, |
| 'b', 'a', 'd', ' ', 'o', 'i', 'd', |
| 0x01, 0x01, ( byte ) 0xFF, |
| 0x04, 0x06, // controlValue OCTET STRING OPTIONAL } |
| 'a', 'b', 'c', 'd', 'e', 'f', |
| } ); |
| |
| stream.flip(); |
| |
| // Allocate a LdapMessageContainer Container |
| Asn1Container ldapMessageContainer = new LdapMessageContainer<>( codec ); |
| |
| // Decode the PDU |
| assertThrows( DecoderException.class, ( ) -> |
| { |
| Asn1Decoder.decode( stream, ldapMessageContainer ); |
| } ); |
| } |
| |
| |
| /** |
| * Test the decoding of a Request with bad criticality |
| */ |
| @Test |
| public void testDecodeRequestWithControlsBadCriticality() throws DecoderException |
| { |
| ByteBuffer stream = ByteBuffer.allocate( 0x25 ); |
| stream.put( new byte[] |
| { |
| 0x30, 0x23, // LDAPMessage ::=SEQUENCE { |
| 0x02, 0x01, 0x03, // messageID MessageID |
| 0x50, 0x01, 0x02, // CHOICE { ..., abandonRequest |
| // AbandonRequest,... |
| ( byte ) 0xA0, 0x1B, // controls [0] Controls OPTIONAL } |
| 0x30, 0x19, // Control ::= SEQUENCE { |
| // controlType LDAPOID, |
| 0x04, 0x0D, |
| '1', '.', '3', '.', '6', '.', '1', '.', '5', '.', '5', '.', '1', |
| 0x01, 0x00, // criticality BOOLEAN DEFAULT FALSE, |
| 0x04, 0x06, // controlValue OCTET STRING OPTIONAL } |
| 'a', 'b', 'c', 'd', 'e', 'f', } ); |
| |
| stream.flip(); |
| |
| // Allocate a LdapMessageContainer Container |
| Asn1Container ldapMessageContainer = new LdapMessageContainer<>( codec ); |
| |
| // Decode the PDU |
| assertThrows( DecoderException.class, ( ) -> |
| { |
| Asn1Decoder.decode( stream, ldapMessageContainer ); |
| } ); |
| } |
| } |