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 * http://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.bindResponse;
21
22
23 import org.apache.directory.api.asn1.DecoderException;
24 import org.apache.directory.api.asn1.ber.grammar.GrammarAction;
25 import org.apache.directory.api.asn1.ber.tlv.TLV;
26 import org.apache.directory.api.ldap.codec.api.LdapMessageContainer;
27 import org.apache.directory.api.ldap.codec.decorators.BindResponseDecorator;
28 import org.apache.directory.api.ldap.model.message.BindResponse;
29 import org.apache.directory.api.util.Strings;
30 import org.slf4j.Logger;
31 import org.slf4j.LoggerFactory;
32
33
34 /**
35 * The action used to store a SASL credentials :
36 * <pre>
37 * BindResponse ::= APPLICATION 1] SEQUENCE {
38 * ...
39 * serverSaslCreds [7] OCTET STRING OPTIONAL }
40 * </pre>
41 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
42 */
43 public class StoreServerSASLCreds extends GrammarAction<LdapMessageContainer<BindResponseDecorator>>
44 {
45 /** The logger */
46 private static final Logger LOG = LoggerFactory.getLogger( StoreServerSASLCreds.class );
47
48 /** Speedup for logs */
49 private static final boolean IS_DEBUG = LOG.isDebugEnabled();
50
51
52 /**
53 * Instantiates a new server sasl creds action.
54 */
55 public StoreServerSASLCreds()
56 {
57 super( "Store server sasl credentials value" );
58 }
59
60
61 /**
62 * {@inheritDoc}
63 */
64 public void action( LdapMessageContainer<BindResponseDecorator> container ) throws DecoderException
65 {
66 // Get the Value and store it in the BindRequest
67 TLV tlv = container.getCurrentTLV();
68
69 // We have to handle the special case of a 0 length server
70 // sasl credentials
71 byte[] serverSaslCreds;
72
73 if ( tlv.getLength() == 0 )
74 {
75 serverSaslCreds = Strings.EMPTY_BYTES;
76 }
77 else
78 {
79 serverSaslCreds = tlv.getValue().getData();
80 }
81
82 BindResponse response = container.getMessage();
83 response.setServerSaslCreds( serverSaslCreds );
84
85 // We can have an END transition
86 container.setGrammarEndAllowed( true );
87
88 if ( IS_DEBUG )
89 {
90 LOG.debug( "The SASL credentials value is : {}", Strings.dumpBytes( serverSaslCreds ) );
91 }
92 }
93 }