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.api.ResponseCarryingException;
028import org.apache.directory.api.ldap.codec.decorators.BindRequestDecorator;
029import org.apache.directory.api.ldap.model.exception.LdapInvalidDnException;
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.apache.directory.api.ldap.model.name.Dn;
034import org.apache.directory.api.util.Strings;
035import org.slf4j.Logger;
036import org.slf4j.LoggerFactory;
037
038
039/**
040 * The action used to store the BindRequest name.
041 * <pre>
042 * BindRequest ::= [APPLICATION 0] SEQUENCE {
043 *     ....
044 *     name                    LDAPDN,
045 *     ....
046 * </pre>
047 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
048 */
049public class StoreName extends GrammarAction<LdapMessageContainer<BindRequestDecorator>>
050{
051    /** The logger */
052    private static final Logger LOG = LoggerFactory.getLogger( StoreName.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 StoreName()
062    {
063        super( "Store BindRequest Name value" );
064    }
065
066
067    /**
068     * {@inheritDoc}
069     */
070    public void action( LdapMessageContainer<BindRequestDecorator> container ) throws DecoderException
071    {
072        BindRequest bindRequestMessage = container.getMessage();
073
074        // Get the Value and store it in the BindRequest
075        TLV tlv = container.getCurrentTLV();
076
077        // We have to handle the special case of a 0 length name
078        if ( tlv.getLength() == 0 )
079        {
080            bindRequestMessage.setName( "" );
081        }
082        else
083        {
084            byte[] nameBytes = tlv.getValue().getData();
085            String nameStr = Strings.utf8ToString( nameBytes );
086
087            try
088            {
089                // Testing the name as a DN
090                new Dn( nameStr );
091                bindRequestMessage.setName( nameStr );
092            }
093            catch ( LdapInvalidDnException ine )
094            {
095                String msg = "Incorrect DN given : " + nameStr + " (" + Strings.dumpBytes( nameBytes )
096                    + ") is invalid";
097                LOG.error( "{} : {}", msg, ine.getMessage() );
098
099                BindResponseImpl response = new BindResponseImpl( bindRequestMessage.getMessageId() );
100
101                throw new ResponseCarryingException( msg, response, ResultCodeEnum.INVALID_DN_SYNTAX,
102                    Dn.EMPTY_DN, ine );
103            }
104        }
105
106        if ( IS_DEBUG )
107        {
108            LOG.debug( " The Bind name is {}", bindRequestMessage.getName() );
109        }
110    }
111}