001 /*
002 * Copyright 1999-2006 Sun Microsystems, Inc. All Rights Reserved.
003 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
004 *
005 * This code is free software; you can redistribute it and/or modify it
006 * under the terms of the GNU General Public License version 2 only, as
007 * published by the Free Software Foundation. Sun designates this
008 * particular file as subject to the "Classpath" exception as provided
009 * by Sun in the LICENSE file that accompanied this code.
010 *
011 * This code is distributed in the hope that it will be useful, but WITHOUT
012 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
013 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
014 * version 2 for more details (a copy is included in the LICENSE file that
015 * accompanied this code).
016 *
017 * You should have received a copy of the GNU General Public License version
018 * 2 along with this work; if not, write to the Free Software Foundation,
019 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
020 *
021 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
022 * CA 95054 USA or visit www.sun.com if you need additional information or
023 * have any questions.
024 */
025
026 package javax.security.sasl;
027
028 import java.util.Map;
029 import javax.security.auth.callback.CallbackHandler;
030
031 /**
032 * An interface for creating instances of <tt>SaslClient</tt>.
033 * A class that implements this interface
034 * must be thread-safe and handle multiple simultaneous
035 * requests. It must also have a public constructor that accepts no
036 * argument.
037 *<p>
038 * This interface is not normally accessed directly by a client, which will use the
039 * <tt>Sasl</tt> static methods
040 * instead. However, a particular environment may provide and install a
041 * new or different <tt>SaslClientFactory</tt>.
042 *
043 * @since 1.5
044 *
045 * @see SaslClient
046 * @see Sasl
047 *
048 * @author Rosanna Lee
049 * @author Rob Weltman
050 */
051 public abstract interface SaslClientFactory {
052 /**
053 * Creates a SaslClient using the parameters supplied.
054 *
055 * @param mechanisms The non-null list of mechanism names to try. Each is the
056 * IANA-registered name of a SASL mechanism. (e.g. "GSSAPI", "CRAM-MD5").
057 * @param authorizationId The possibly null protocol-dependent
058 * identification to be used for authorization.
059 * If null or empty, the server derives an authorization
060 * ID from the client's authentication credentials.
061 * When the SASL authentication completes successfully,
062 * the specified entity is granted access.
063 * @param protocol The non-null string name of the protocol for which
064 * the authentication is being performed (e.g., "ldap").
065 * @param serverName The non-null fully qualified host name
066 * of the server to authenticate to.
067 * @param props The possibly null set of properties used to select the SASL
068 * mechanism and to configure the authentication exchange of the selected
069 * mechanism. See the <tt>Sasl</tt> class for a list of standard properties.
070 * Other, possibly mechanism-specific, properties can be included.
071 * Properties not relevant to the selected mechanism are ignored,
072 * including any map entries with non-String keys.
073 *
074 * @param cbh The possibly null callback handler to used by the SASL
075 * mechanisms to get further information from the application/library
076 * to complete the authentication. For example, a SASL mechanism might
077 * require the authentication ID, password and realm from the caller.
078 * The authentication ID is requested by using a <tt>NameCallback</tt>.
079 * The password is requested by using a <tt>PasswordCallback</tt>.
080 * The realm is requested by using a <tt>RealmChoiceCallback</tt> if there is a list
081 * of realms to choose from, and by using a <tt>RealmCallback</tt> if
082 * the realm must be entered.
083 *
084 *@return A possibly null <tt>SaslClient</tt> created using the parameters
085 * supplied. If null, this factory cannot produce a <tt>SaslClient</tt>
086 * using the parameters supplied.
087 *@exception SaslException If cannot create a <tt>SaslClient</tt> because
088 * of an error.
089 */
090 public abstract SaslClient createSaslClient(String[] mechanisms,
091 String authorizationId, String protocol, String serverName,
092 Map<String, ?> props, CallbackHandler cbh)
093 throws SaslException;
094
095 /**
096 * Returns an array of names of mechanisms that match the specified
097 * mechanism selection policies.
098 * @param props The possibly null set of properties used to specify the
099 * security policy of the SASL mechanisms. For example, if <tt>props</tt>
100 * contains the <tt>Sasl.POLICY_NOPLAINTEXT</tt> property with the value
101 * <tt>"true"</tt>, then the factory must not return any SASL mechanisms
102 * that are susceptible to simple plain passive attacks.
103 * See the <tt>Sasl</tt> class for a complete list of policy properties.
104 * Non-policy related properties, if present in <tt>props</tt>, are ignored,
105 * including any map entries with non-String keys.
106 * @return A non-null array containing a IANA-registered SASL mechanism names.
107 */
108 public abstract String[] getMechanismNames(Map<String, ?> props);
109 }
|