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 * https://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.response.bind; 021 022 023import org.apache.directory.api.asn1.ber.grammar.GrammarAction; 024import org.apache.directory.api.asn1.ber.tlv.TLV; 025import org.apache.directory.api.i18n.I18n; 026import org.apache.directory.api.ldap.codec.api.LdapMessageContainer; 027import org.apache.directory.api.ldap.model.message.BindResponse; 028import org.apache.directory.api.util.Strings; 029import org.slf4j.Logger; 030import org.slf4j.LoggerFactory; 031 032 033/** 034 * The action used to store a SASL credentials : 035 * <pre> 036 * BindResponse ::= APPLICATION 1] SEQUENCE { 037 * ... 038 * serverSaslCreds [7] OCTET STRING OPTIONAL } 039 * </pre> 040 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a> 041 */ 042public class StoreServerSASLCreds extends GrammarAction<LdapMessageContainer<BindResponse>> 043{ 044 /** The logger */ 045 private static final Logger LOG = LoggerFactory.getLogger( StoreServerSASLCreds.class ); 046 047 /** 048 * Instantiates a new server sasl creds action. 049 */ 050 public StoreServerSASLCreds() 051 { 052 super( "Store server sasl credentials value" ); 053 } 054 055 056 /** 057 * {@inheritDoc} 058 */ 059 public void action( LdapMessageContainer<BindResponse> container ) 060 { 061 // Get the Value and store it in the BindRequest 062 TLV tlv = container.getCurrentTLV(); 063 064 // We have to handle the special case of a 0 length server 065 // sasl credentials 066 byte[] serverSaslCreds; 067 068 if ( tlv.getLength() == 0 ) 069 { 070 serverSaslCreds = Strings.EMPTY_BYTES; 071 } 072 else 073 { 074 serverSaslCreds = tlv.getValue().getData(); 075 } 076 077 BindResponse response = container.getMessage(); 078 response.setServerSaslCreds( serverSaslCreds ); 079 080 // We can have an END transition 081 container.setGrammarEndAllowed( true ); 082 083 if ( LOG.isDebugEnabled() ) 084 { 085 LOG.debug( I18n.msg( I18n.MSG_05168_SASL_CREDENTIALS_VALUE_STORED ) ); 086 } 087 } 088}