001/*
002 *  Licensed to the Apache Software Foundation (ASF) under one
003 *  or more contributor license agreements.  See the NOTICE file
004 *  distributed with this work for additional information
005 *  regarding copyright ownership.  The ASF licenses this file
006 *  to you under the Apache License, Version 2.0 (the
007 *  "License"); you may not use this file except in compliance
008 *  with the License.  You may obtain a copy of the License at
009 *
010 *    http://www.apache.org/licenses/LICENSE-2.0
011 *
012 *  Unless required by applicable law or agreed to in writing,
013 *  software distributed under the License is distributed on an
014 *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
015 *  KIND, either express or implied.  See the License for the
016 *  specific language governing permissions and limitations
017 *  under the License.
018 *
019 */
020package org.apache.directory.api.ldap.codec.actions.bindRequest;
021
022
023import org.apache.directory.api.asn1.DecoderException;
024import org.apache.directory.api.asn1.ber.grammar.GrammarAction;
025import org.apache.directory.api.asn1.ber.tlv.TLV;
026import org.apache.directory.api.ldap.codec.api.LdapMessageContainer;
027import org.apache.directory.api.ldap.codec.decorators.BindRequestDecorator;
028import org.apache.directory.api.ldap.model.message.BindRequest;
029import org.apache.directory.api.util.Strings;
030import org.slf4j.Logger;
031import org.slf4j.LoggerFactory;
032
033
034/**
035 * The action used to store the BindRequest simple authentication
036 * <pre>
037 * BindRequest ::= [APPLICATION 0] SEQUENCE {
038 *     ....
039 *     authentication          AuthenticationChoice }
040 *
041 * AuthenticationChoice ::= CHOICE {
042 *     simple                  [0] OCTET STRING,
043 *     ...
044 *
045 * We have to create an Authentication Object to store the credentials.
046 * </pre>
047 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
048 */
049public class StoreSimpleAuth extends GrammarAction<LdapMessageContainer<BindRequestDecorator>>
050{
051    /** The logger */
052    private static final Logger LOG = LoggerFactory.getLogger( StoreSimpleAuth.class );
053
054    /** Speedup for logs */
055    private static final boolean IS_DEBUG = LOG.isDebugEnabled();
056
057
058    /**
059     * Instantiates a new action.
060     */
061    public StoreSimpleAuth()
062    {
063        super( "Store BindRequest Simple Authentication" );
064    }
065
066
067    /**
068     * {@inheritDoc}
069     */
070    public void action( LdapMessageContainer<BindRequestDecorator> container ) throws DecoderException
071    {
072        BindRequest bindRequestMessage = container.getMessage();
073        TLV tlv = container.getCurrentTLV();
074
075        // Allocate the Authentication Object
076        bindRequestMessage.setSimple( true );
077
078        // We have to handle the special case of a 0 length simple
079        if ( tlv.getLength() == 0 )
080        {
081            bindRequestMessage.setCredentials( Strings.EMPTY_BYTES );
082        }
083        else
084        {
085            bindRequestMessage.setCredentials( tlv.getValue().getData() );
086        }
087
088        // We can have an END transition
089        container.setGrammarEndAllowed( true );
090
091        if ( IS_DEBUG )
092        {
093            LOG.debug( "The simple authentication is : {}", Strings.dumpBytes( bindRequestMessage
094                .getCredentials() ) );
095        }
096    }
097}