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.StringConstants;
030import org.apache.directory.api.util.Strings;
031import org.slf4j.Logger;
032import org.slf4j.LoggerFactory;
033
034
035/**
036 * The action used to store the BindRequest simple authentication
037 * <pre>
038 * BindRequest ::= [APPLICATION 0] SEQUENCE {
039 *     ....
040 *     authentication          AuthenticationChoice }
041 *
042 * AuthenticationChoice ::= CHOICE {
043 *     simple                  [0] OCTET STRING,
044 *     ...
045 *
046 * We have to create an Authentication Object to store the credentials.
047 * </pre>
048 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
049 */
050public class StoreSimpleAuth extends GrammarAction<LdapMessageContainer<BindRequestDecorator>>
051{
052    /** The logger */
053    private static final Logger LOG = LoggerFactory.getLogger( StoreSimpleAuth.class );
054
055    /** Speedup for logs */
056    private static final boolean IS_DEBUG = LOG.isDebugEnabled();
057
058
059    /**
060     * Instantiates a new action.
061     */
062    public StoreSimpleAuth()
063    {
064        super( "Store BindRequest Simple Authentication" );
065    }
066
067
068    /**
069     * {@inheritDoc}
070     */
071    public void action( LdapMessageContainer<BindRequestDecorator> container ) throws DecoderException
072    {
073        BindRequest bindRequestMessage = container.getMessage();
074        TLV tlv = container.getCurrentTLV();
075
076        // Allocate the Authentication Object
077        bindRequestMessage.setSimple( true );
078
079        // We have to handle the special case of a 0 length simple
080        if ( tlv.getLength() == 0 )
081        {
082            bindRequestMessage.setCredentials( StringConstants.EMPTY_BYTES );
083        }
084        else
085        {
086            bindRequestMessage.setCredentials( tlv.getValue().getData() );
087        }
088
089        // We can have an END transition
090        container.setGrammarEndAllowed( true );
091
092        if ( IS_DEBUG )
093        {
094            LOG.debug( "The simple authentication is : {}", Strings.dumpBytes( bindRequestMessage
095                .getCredentials() ) );
096        }
097    }
098}