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.i18n.I18n;
027import org.apache.directory.api.ldap.codec.api.LdapMessageContainer;
028import org.apache.directory.api.ldap.codec.api.ResponseCarryingException;
029import org.apache.directory.api.ldap.codec.decorators.BindRequestDecorator;
030import org.apache.directory.api.ldap.model.message.BindRequest;
031import org.apache.directory.api.ldap.model.message.BindResponseImpl;
032import org.apache.directory.api.ldap.model.message.ResultCodeEnum;
033import org.slf4j.Logger;
034import org.slf4j.LoggerFactory;
035
036
037/**
038 * The action used to store the BindRequest version MessageID.
039 * <pre>
040 * BindRequest ::= [APPLICATION 0] SEQUENCE {
041 *     ....
042 *     authentication          AuthenticationChoice }
043 *
044 * AuthenticationChoice ::= CHOICE {
045 *     ...
046 *     sasl                  [3] SaslCredentials }
047 *     ...
048 *
049 * We have to create an Authentication Object to store the credentials.
050 * </pre>
051 *
052 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
053 */
054public class InitSaslBind extends GrammarAction<LdapMessageContainer<BindRequestDecorator>>
055{
056    /** The logger */
057    private static final Logger LOG = LoggerFactory.getLogger( InitSaslBind.class );
058
059    /** Speedup for logs */
060    private static final boolean IS_DEBUG = LOG.isDebugEnabled();
061
062
063    /**
064     * Instantiates a new action.
065     */
066    public InitSaslBind()
067    {
068        super( "Initialize Bind SASL Authentication" );
069    }
070
071
072    /**
073     * {@inheritDoc}
074     */
075    public void action( LdapMessageContainer<BindRequestDecorator> container ) throws DecoderException
076    {
077        BindRequest bindRequestMessage = container.getMessage();
078        TLV tlv = container.getCurrentTLV();
079
080        // We will check that the sasl is not null
081        if ( tlv.getLength() == 0 )
082        {
083            String msg = I18n.err( I18n.ERR_04079 );
084            LOG.error( msg );
085
086            BindResponseImpl response = new BindResponseImpl( bindRequestMessage.getMessageId() );
087
088            throw new ResponseCarryingException( msg, response, ResultCodeEnum.INVALID_CREDENTIALS,
089                bindRequestMessage.getDn(), null );
090        }
091
092        bindRequestMessage.setSimple( false );
093
094        if ( IS_DEBUG )
095        {
096            LOG.debug( "The SaslCredential has been created" );
097        }
098    }
099}