001 /*
002 * Copyright 2000-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>SaslServer</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 server, 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>SaslServerFactory</tt>.
042 *
043 * @since 1.5
044 *
045 * @see SaslServer
046 * @see Sasl
047 *
048 * @author Rosanna Lee
049 * @author Rob Weltman
050 */
051 public abstract interface SaslServerFactory {
052 /**
053 * Creates a <tt>SaslServer</tt> using the parameters supplied.
054 * It returns null
055 * if no <tt>SaslServer</tt> can be created using the parameters supplied.
056 * Throws <tt>SaslException</tt> if it cannot create a <tt>SaslServer</tt>
057 * because of an error.
058 *
059 * @param mechanism The non-null
060 * IANA-registered name of a SASL mechanism. (e.g. "GSSAPI", "CRAM-MD5").
061 * @param protocol The non-null string name of the protocol for which
062 * the authentication is being performed (e.g., "ldap").
063 * @param serverName The non-null fully qualified host name of the server
064 * to authenticate to.
065 * @param props The possibly null set of properties used to select the SASL
066 * mechanism and to configure the authentication exchange of the selected
067 * mechanism. See the <tt>Sasl</tt> class for a list of standard properties.
068 * Other, possibly mechanism-specific, properties can be included.
069 * Properties not relevant to the selected mechanism are ignored,
070 * including any map entries with non-String keys.
071 *
072 * @param cbh The possibly null callback handler to used by the SASL
073 * mechanisms to get further information from the application/library
074 * to complete the authentication. For example, a SASL mechanism might
075 * require the authentication ID, password and realm from the caller.
076 * The authentication ID is requested by using a <tt>NameCallback</tt>.
077 * The password is requested by using a <tt>PasswordCallback</tt>.
078 * The realm is requested by using a <tt>RealmChoiceCallback</tt> if there is a list
079 * of realms to choose from, and by using a <tt>RealmCallback</tt> if
080 * the realm must be entered.
081 *
082 *@return A possibly null <tt>SaslServer</tt> created using the parameters
083 * supplied. If null, this factory cannot produce a <tt>SaslServer</tt>
084 * using the parameters supplied.
085 *@exception SaslException If cannot create a <tt>SaslServer</tt> because
086 * of an error.
087 */
088 public abstract SaslServer createSaslServer(String mechanism,
089 String protocol, String serverName, Map<String, ?> props,
090 CallbackHandler cbh) throws SaslException;
091
092 /**
093 * Returns an array of names of mechanisms that match the specified
094 * mechanism selection policies.
095 * @param props The possibly null set of properties used to specify the
096 * security policy of the SASL mechanisms. For example, if <tt>props</tt>
097 * contains the <tt>Sasl.POLICY_NOPLAINTEXT</tt> property with the value
098 * <tt>"true"</tt>, then the factory must not return any SASL mechanisms
099 * that are susceptible to simple plain passive attacks.
100 * See the <tt>Sasl</tt> class for a complete list of policy properties.
101 * Non-policy related properties, if present in <tt>props</tt>, are ignored,
102 * including any map entries with non-String keys.
103 * @return A non-null array containing a IANA-registered SASL mechanism names.
104 */
105 public abstract String[] getMechanismNames(Map<String, ?> props);
106 }
|