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   *    https://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.request.bind;
21  
22  
23  import org.apache.directory.api.asn1.ber.grammar.GrammarAction;
24  import org.apache.directory.api.asn1.ber.tlv.TLV;
25  import org.apache.directory.api.i18n.I18n;
26  import org.apache.directory.api.ldap.codec.api.LdapMessageContainer;
27  import org.apache.directory.api.ldap.model.message.BindRequest;
28  import org.apache.directory.api.util.Strings;
29  import org.slf4j.Logger;
30  import org.slf4j.LoggerFactory;
31  
32  
33  /**
34   * The action used to store the BindRequest simple authentication
35   * <pre>
36   * BindRequest ::= [APPLICATION 0] SEQUENCE {
37   *     ....
38   *     authentication          AuthenticationChoice }
39   *
40   * AuthenticationChoice ::= CHOICE {
41   *     simple                  [0] OCTET STRING,
42   *     ...
43   *
44   * We have to create an Authentication Object to store the credentials.
45   * </pre>
46   * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
47   */
48  public class StoreSimpleAuth extends GrammarAction<LdapMessageContainer<BindRequest>>
49  {
50      /** The logger */
51      private static final Logger LOG = LoggerFactory.getLogger( StoreSimpleAuth.class );
52  
53      /**
54       * Instantiates a new action.
55       */
56      public StoreSimpleAuth()
57      {
58          super( "Store BindRequest Simple Authentication" );
59      }
60  
61  
62      /**
63       * {@inheritDoc}
64       */
65      @Override
66      public void action( LdapMessageContainer<BindRequest> container )
67      {
68          BindRequest bindRequestMessage = container.getMessage();
69          TLV tlv = container.getCurrentTLV();
70  
71          // Allocate the Authentication Object
72          bindRequestMessage.setSimple( true );
73  
74          // We have to handle the special case of a 0 length simple
75          if ( tlv.getLength() == 0 )
76          {
77              bindRequestMessage.setCredentials( Strings.EMPTY_BYTES );
78          }
79          else
80          {
81              bindRequestMessage.setCredentials( tlv.getValue().getData() );
82          }
83  
84          // We can have an END transition
85          container.setGrammarEndAllowed( true );
86  
87          if ( LOG.isDebugEnabled() )
88          {
89              LOG.debug( I18n.msg( I18n.MSG_05119_SIMPLE_CREDENTIAL_DECODED ) );
90          }
91      }
92  }