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 */
020
021package org.apache.directory.server.ldap.handlers.sasl;
022
023
024/**
025 * SASL Constants used to store informations releated to the Challenge/response
026 * exchange during the SASL negociation.
027 *
028 * @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
029 */
030public final class SaslConstants
031{
032    /**
033     * A key constant for storing the SASL Server in the session.
034     */
035    public static final String SASL_SERVER = "saslServer";
036
037    /**
038     * A key constant for storing the SASL host in the session
039     */
040    public static final String SASL_HOST = "host";
041
042    /**
043     * A key constant used when creating a SaslServer
044     */
045    public static final String LDAP_PROTOCOL = "ldap";
046
047    /**
048     * A key constant for storing the place where we are to search for user's pasword
049     */
050    public static final String SASL_USER_BASE_DN = "userBaseDn";
051
052    /**
053     * A key constant for storing the current mechanism
054     */
055    public static final String SASL_MECH = "saslMech";
056
057    /**
058     * A key constant for storing the authenticated user
059     */
060    public static final String SASL_AUTHENT_USER = "saslAuthentUser";
061
062    /**
063     * A key constant for storing the evaluated credentials
064     */
065    public static final String SASL_CREDS = "saslCreds";
066
067    /**
068     * A key constant for storing the Quality Of Protection
069     */
070    public static final String SASL_QOP = "saslQop";
071
072    /**
073     * A key constant for storing the realm
074     */
075    public static final String SASL_REALM = "saslRealm";
076
077    /**
078     * A key constant representing the SASL properties 
079     */
080    public static final String SASL_PROPS = "saslProps";
081
082    /**
083     * A key constant representing the SASL mechanism handler
084     */
085    public static final String SASL_MECH_HANDLER = "saslmechHandler";
086
087    /**
088     * A key constant representing the SASL IoFilter 
089     */
090    public static final String SASL_FILTER = "SASL_FILTER";
091
092
093    private SaslConstants()
094    {
095    }
096}