View Javadoc
1   /*
2    *  Licensed to the Apache Software Foundation (ASF) under one
3    *  or more contributor license agreements.  See the NOTICE file
4    *  distributed with this work for additional information
5    *  regarding copyright ownership.  The ASF licenses this file
6    *  to you under the Apache License, Version 2.0 (the
7    *  "License"); you may not use this file except in compliance
8    *  with the License.  You may obtain a copy of the License at
9    *
10   *    http://www.apache.org/licenses/LICENSE-2.0
11   *
12   *  Unless required by applicable law or agreed to in writing,
13   *  software distributed under the License is distributed on an
14   *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15   *  KIND, either express or implied.  See the License for the
16   *  specific language governing permissions and limitations
17   *  under the License.
18   *
19   */
20  package org.apache.directory.api.ldap.codec.actions.bindRequest;
21  
22  
23  import org.apache.directory.api.asn1.DecoderException;
24  import org.apache.directory.api.asn1.ber.grammar.GrammarAction;
25  import org.apache.directory.api.asn1.ber.tlv.TLV;
26  import org.apache.directory.api.ldap.codec.api.LdapMessageContainer;
27  import org.apache.directory.api.ldap.codec.decorators.BindRequestDecorator;
28  import org.apache.directory.api.ldap.model.message.BindRequest;
29  import org.apache.directory.api.util.StringConstants;
30  import org.apache.directory.api.util.Strings;
31  import org.slf4j.Logger;
32  import org.slf4j.LoggerFactory;
33  
34  
35  /**
36   * The action used to store the BindRequest simple authentication
37   * <pre>
38   * BindRequest ::= [APPLICATION 0] SEQUENCE {
39   *     ....
40   *     authentication          AuthenticationChoice }
41   *
42   * AuthenticationChoice ::= CHOICE {
43   *     simple                  [0] OCTET STRING,
44   *     ...
45   *
46   * We have to create an Authentication Object to store the credentials.
47   * </pre>
48   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
49   */
50  public class StoreSimpleAuth extends GrammarAction<LdapMessageContainer<BindRequestDecorator>>
51  {
52      /** The logger */
53      private static final Logger LOG = LoggerFactory.getLogger( StoreSimpleAuth.class );
54  
55      /** Speedup for logs */
56      private static final boolean IS_DEBUG = LOG.isDebugEnabled();
57  
58  
59      /**
60       * Instantiates a new action.
61       */
62      public StoreSimpleAuth()
63      {
64          super( "Store BindRequest Simple Authentication" );
65      }
66  
67  
68      /**
69       * {@inheritDoc}
70       */
71      public void action( LdapMessageContainer<BindRequestDecorator> container ) throws DecoderException
72      {
73          BindRequest bindRequestMessage = container.getMessage();
74          TLV tlv = container.getCurrentTLV();
75  
76          // Allocate the Authentication Object
77          bindRequestMessage.setSimple( true );
78  
79          // We have to handle the special case of a 0 length simple
80          if ( tlv.getLength() == 0 )
81          {
82              bindRequestMessage.setCredentials( StringConstants.EMPTY_BYTES );
83          }
84          else
85          {
86              bindRequestMessage.setCredentials( tlv.getValue().getData() );
87          }
88  
89          // We can have an END transition
90          container.setGrammarEndAllowed( true );
91  
92          if ( IS_DEBUG )
93          {
94              LOG.debug( "The simple authentication is : {}", Strings.dumpBytes( bindRequestMessage
95                  .getCredentials() ) );
96          }
97      }
98  }