SASLAuthentication.java 31.1 KB
Newer Older
1 2 3 4 5
/**
 * $RCSfile$
 * $Revision: $
 * $Date: $
 *
6
 * Copyright (C) 2007 Jive Software. All rights reserved.
7 8 9 10 11
 *
 * This software is published under the terms of the GNU Public License (GPL),
 * a copy of which is included in this distribution.
 */

12
package org.jivesoftware.openfire.net;
13

Alex Wenckus's avatar
Alex Wenckus committed
14
import org.dom4j.DocumentHelper;
15
import org.dom4j.Element;
Alex Wenckus's avatar
Alex Wenckus committed
16
import org.dom4j.Namespace;
17
import org.dom4j.QName;
18
import org.jivesoftware.openfire.Connection;
19 20 21
import org.jivesoftware.openfire.XMPPServer;
import org.jivesoftware.openfire.auth.AuthFactory;
import org.jivesoftware.openfire.auth.AuthToken;
22
import org.jivesoftware.openfire.auth.AuthorizationManager;
23 24 25 26 27
import org.jivesoftware.openfire.session.*;
import org.jivesoftware.util.CertificateManager;
import org.jivesoftware.util.JiveGlobals;
import org.jivesoftware.util.Log;
import org.jivesoftware.util.StringUtils;
28 29
import org.xmpp.packet.JID;

30
import javax.net.ssl.SSLPeerUnverifiedException;
31 32 33
import javax.security.sasl.Sasl;
import javax.security.sasl.SaslException;
import javax.security.sasl.SaslServer;
34
import java.io.UnsupportedEncodingException;
35
import java.security.Security;
36 37
import java.security.cert.Certificate;
import java.security.cert.X509Certificate;
38
import java.util.*;
39 40 41 42 43

/**
 * SASLAuthentication is responsible for returning the available SASL mechanisms to use and for
 * actually performing the SASL authentication.<p>
 *
Matt Tucker's avatar
Matt Tucker committed
44 45
 * The list of available SASL mechanisms is determined by:
 * <ol>
46
 *      <li>The type of {@link org.jivesoftware.openfire.user.UserProvider} being used since
Matt Tucker's avatar
Matt Tucker committed
47 48 49 50 51
 *      some SASL mechanisms require the server to be able to retrieve user passwords</li>
 *      <li>Whether anonymous logins are enabled or not.</li>
 *      <li>Whether shared secret authentication is enabled or not.</li>
 *      <li>Whether the underlying connection has been secured or not.</li>
 * </ol>
52 53 54 55 56 57 58 59 60 61 62 63 64 65 66
 *
 * @author Hao Chen
 * @author Gaston Dombiak
 */
public class SASLAuthentication {

    /**
     * The utf-8 charset for decoding and encoding Jabber packet streams.
     */
    protected static String CHARSET = "UTF-8";

    private static final String SASL_NAMESPACE = "xmlns=\"urn:ietf:params:xml:ns:xmpp-sasl\"";

    private static Map<String, ElementType> typeMap = new TreeMap<String, ElementType>();

67 68 69 70 71
    private static Set<String> mechanisms = null;

    static {
        initMechanisms();
    }
72

73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96
    public enum ElementType {

        AUTH("auth"), RESPONSE("response"), CHALLENGE("challenge"), FAILURE("failure"), UNDEF("");

        private String name = null;

        public String toString() {
            return name;
        }

        private ElementType(String name) {
            this.name = name;
            typeMap.put(this.name, this);
        }

        public static ElementType valueof(String name) {
            if (name == null) {
                return UNDEF;
            }
            ElementType e = typeMap.get(name);
            return e != null ? e : UNDEF;
        }
    }

97
    @SuppressWarnings({"UnnecessarySemicolon"})  // Support for QDox Parser
98 99 100 101 102 103 104 105 106 107 108 109 110 111
    public enum Status {
        /**
         * Entity needs to respond last challenge. Session is still negotiating
         * SASL authentication.
         */
        needResponse,
        /**
         * SASL negotiation has failed. The entity may retry a few times before the connection
         * is closed.
         */
        failed,
        /**
         * SASL negotiation has been successful.
         */
112
        authenticated;
113 114 115 116 117 118 119
    }

    /**
     * Returns a string with the valid SASL mechanisms available for the specified session. If
     * the session's connection is not secured then only include the SASL mechanisms that don't
     * require TLS.
     *
120 121
     * @param session The current session
     *
122 123 124
     * @return a string with the valid SASL mechanisms available for the specified session.
     */
    public static String getSASLMechanisms(Session session) {
125 126 127
        if (!(session instanceof ClientSession) && !(session instanceof IncomingServerSession)) {
            return "";
        }
128 129
        StringBuilder sb = new StringBuilder(195);
        sb.append("<mechanisms xmlns=\"urn:ietf:params:xml:ns:xmpp-sasl\">");
130
        if (session instanceof IncomingServerSession) {
131
            // Server connections dont follow the same rules as clients
132
            if (session.isSecure()) {
133 134 135
                // Offer SASL EXTERNAL only if TLS has already been negotiated
                sb.append("<mechanism>EXTERNAL</mechanism>");
            }
136
        }
137
        else {
138
            for (String mech : getSupportedMechanisms()) {
139 140 141
                sb.append("<mechanism>");
                sb.append(mech);
                sb.append("</mechanism>");
142 143
            }
        }
144 145 146 147
        sb.append("</mechanisms>");
        return sb.toString();
    }

Alex Wenckus's avatar
Alex Wenckus committed
148 149 150 151 152 153 154 155 156
    public static Element getSASLMechanismsElement(Session session) {
        if (!(session instanceof ClientSession) && !(session instanceof IncomingServerSession)) {
            return null;
        }

        Element mechs = DocumentHelper.createElement(new QName("mechanisms",
                new Namespace("", "urn:ietf:params:xml:ns:xmpp-sasl")));
        if (session instanceof IncomingServerSession) {
            // Server connections dont follow the same rules as clients
157
            if (session.isSecure()) {
Alex Wenckus's avatar
Alex Wenckus committed
158 159 160 161 162 163
                // Offer SASL EXTERNAL only if TLS has already been negotiated
                Element mechanism = mechs.addElement("mechanism");
                mechanism.setText("EXTERNAL");
            }
        }
        else {
164
            for (String mech : getSupportedMechanisms()) {
Alex Wenckus's avatar
Alex Wenckus committed
165 166 167 168 169 170 171
                Element mechanism = mechs.addElement("mechanism");
                mechanism.setText(mech);
            }
        }
        return mechs;
    }

172 173 174 175 176 177 178 179 180 181 182 183
    /**
     * Handles the SASL authentication packet. The entity may be sending an initial
     * authentication request or a response to a challenge made by the server. The returned
     * value indicates whether the authentication has finished either successfully or not or
     * if the entity is expected to send a response to a challenge.
     *
     * @param session the session that is authenticating with the server.
     * @param doc the stanza sent by the authenticating entity.
     * @return value that indicates whether the authentication has finished either successfully
     *         or not or if the entity is expected to send a response to a challenge.
     * @throws UnsupportedEncodingException If UTF-8 charset is not supported.
     */
184
    public static Status handle(LocalSession session, Element doc) throws UnsupportedEncodingException {
185 186 187 188 189 190 191 192 193 194
        Status status;
        String mechanism;
        if (doc.getNamespace().asXML().equals(SASL_NAMESPACE)) {
            ElementType type = ElementType.valueof(doc.getName());
            switch (type) {
                case AUTH:
                    mechanism = doc.attributeValue("mechanism");
                    // Store the requested SASL mechanism by the client
                    session.setSessionData("SaslMechanism", mechanism);
                    //Log.debug("SASLAuthentication.doHandshake() AUTH entered: "+mechanism);
195
                    if (mechanism.equalsIgnoreCase("ANONYMOUS") &&
196
                            mechanisms.contains("ANONYMOUS")) {
197 198 199 200 201
                        status = doAnonymousAuthentication(session);
                    }
                    else if (mechanism.equalsIgnoreCase("EXTERNAL")) {
                        status = doExternalAuthentication(session, doc);
                    }
202
                    else if (mechanisms.contains(mechanism)) {
203 204 205 206 207 208 209
                        // The selected SASL mechanism requires the server to send a challenge
                        // to the client
                        try {
                            Map<String, String> props = new TreeMap<String, String>();
                            props.put(Sasl.QOP, "auth");
                            if (mechanism.equals("GSSAPI")) {
                                props.put(Sasl.SERVER_AUTH, "TRUE");
210
                            }
211
                            SaslServer ss = Sasl.createSaslServer(mechanism, "xmpp",
212
                                    JiveGlobals.getProperty("xmpp.fqdn", session.getServerName()), props,
213 214 215
                                    new XMPPCallbackHandler());
                            // evaluateResponse doesn't like null parameter
                            byte[] token = new byte[0];
216
                            if (doc.getText().length() > 0) {
217
                                // If auth request includes a value then validate it
218
                                token = StringUtils.decodeBase64(doc.getText().trim());
219 220
                                if (token == null) {
                                    token = new byte[0];
221
                                }
222
                            }
Jay Kline's avatar
Jay Kline committed
223 224 225 226 227 228
                            if (mechanism.equals("DIGEST-MD5")) {
                                // RFC2831 (DIGEST-MD5) says the client MAY provide an initial response on subsequent
                                // authentication. Java SASL does not (currently) support this and thows an exception
                                // if we try.  This violates the RFC, so we just strip any initial token.
                                token = new byte[0];
                            }
229
                            byte[] challenge = ss.evaluateResponse(token);
230 231 232 233 234 235 236 237 238 239
                            if (ss.isComplete()) {
                                authenticationSuccessful(session, ss.getAuthorizationID(),
                                    challenge);
                                status = Status.authenticated;
                            }
                            else {
                                // Send the challenge
                                sendChallenge(session, challenge);
                                status = Status.needResponse;
                            }
240 241 242 243 244 245
                            session.setSessionData("SaslServer", ss);
                        }
                        catch (SaslException e) {
                            Log.warn("SaslException", e);
                            authenticationFailed(session);
                            status = Status.failed;
246
                        }
247 248 249 250 251 252 253 254 255 256 257
                    }
                    else {
                        Log.warn("Client wants to do a MECH we don't support: '" +
                                mechanism + "'");
                        authenticationFailed(session);
                        status = Status.failed;
                    }
                    break;
                case RESPONSE:
                    // Store the requested SASL mechanism by the client
                    mechanism = (String) session.getSessionData("SaslMechanism");
258
                    if (mechanism.equalsIgnoreCase("EXTERNAL")) {
259 260
                        status = doExternalAuthentication(session, doc);
                    }
Matt Tucker's avatar
Matt Tucker committed
261 262 263
                    else if (mechanism.equalsIgnoreCase("JIVE-SHAREDSECRET")) {
                        status = doSharedSecretAuthentication(session, doc);
                    }
264
                    else if (mechanisms.contains(mechanism)) {
265 266
                        SaslServer ss = (SaslServer) session.getSessionData("SaslServer");
                        if (ss != null) {
267
                            boolean ssComplete = ss.isComplete();
268 269
                            String response = doc.getTextTrim();
                            try {
270
                                if (ssComplete) {
271 272 273
                                    authenticationSuccessful(session, ss.getAuthorizationID(),
                                            null);
                                    status = Status.authenticated;
274 275
                                }
                                else {
276 277 278 279
                                    byte[] data = StringUtils.decodeBase64(response);
                                    if (data == null) {
                                        data = new byte[0];
                                    }
280
                                    byte[] challenge = ss.evaluateResponse(data);
281
                                    if (ss.isComplete()) {
282
                                        authenticationSuccessful(session, ss.getAuthorizationID(),
283
                                                challenge);
284
                                        status = Status.authenticated;
285 286 287
                                    }
                                    else {
                                        // Send the challenge
288 289
                                        sendChallenge(session, challenge);
                                        status = Status.needResponse;
290
                                    }
291 292 293
                                }
                            }
                            catch (SaslException e) {
294
                                Log.debug("SASLAuthentication: SaslException", e);
295 296
                                authenticationFailed(session);
                                status = Status.failed;
297 298 299 300
                            }
                        }
                        else {
                            Log.fatal("SaslServer is null, should be valid object instead.");
301 302
                            authenticationFailed(session);
                            status = Status.failed;
303
                        }
304
                    }
305 306 307 308 309 310 311 312 313 314 315 316
                    else {
                        Log.warn(
                                "Client responded to a MECH we don't support: '" + mechanism + "'");
                        authenticationFailed(session);
                        status = Status.failed;
                    }
                    break;
                default:
                    authenticationFailed(session);
                    status = Status.failed;
                    // Ignore
                    break;
317
            }
318
        }
319
        else {
320
            Log.debug("SASLAuthentication: Unknown namespace sent in auth element: " + doc.asXML());
321 322 323 324 325 326 327 328 329 330 331
            authenticationFailed(session);
            status = Status.failed;
        }
        // Check if SASL authentication has finished so we can clean up temp information
        if (status == Status.failed || status == Status.authenticated) {
            // Remove the SaslServer from the Session
            session.removeSessionData("SaslServer");
            // Remove the requested SASL mechanism by the client
            session.removeSessionData("SaslMechanism");
        }
        return status;
332 333
    }

Matt Tucker's avatar
Matt Tucker committed
334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394
    /**
     * Returns true if shared secret authentication is enabled. Shared secret
     * authentication creates an anonymous session, but requires that the authenticating
     * entity know a shared secret key. The client sends a digest of the secret key,
     * which is compared against a digest of the local shared key.
     *
     * @return true if shared secret authentication is enabled.
     */
    public static boolean isSharedSecretAllowed() {
        return JiveGlobals.getBooleanProperty("xmpp.auth.sharedSecretEnabled");
    }

    /**
     * Sets whether shared secret authentication is enabled. Shared secret
     * authentication creates an anonymous session, but requires that the authenticating
     * entity know a shared secret key. The client sends a digest of the secret key,
     * which is compared against a digest of the local shared key.
     *
     * @param sharedSecretAllowed true if shared secret authentication should be enabled.
     */
    public static void setSharedSecretAllowed(boolean sharedSecretAllowed) {
        JiveGlobals.setProperty("xmpp.auth.sharedSecretEnabled", sharedSecretAllowed ? "true" : "false");
    }

    /**
     * Returns the shared secret value, or <tt>null</tt> if shared secret authentication is
     * disabled. If this is the first time the shared secret value has been requested (and
     * shared secret auth is enabled), the key will be randomly generated and stored in the
     * property <tt>xmpp.auth.sharedSecret</tt>.
     *
     * @return the shared secret value.
     */
    public static String getSharedSecret() {
        if (!isSharedSecretAllowed()) {
            return null;
        }
        String sharedSecret = JiveGlobals.getProperty("xmpp.auth.sharedSecret");
        if (sharedSecret == null) {
            sharedSecret = StringUtils.randomString(8);
            JiveGlobals.setProperty("xmpp.auth.sharedSecret", sharedSecret);
        }
        return sharedSecret;
    }

    /**
     * Returns true if the supplied digest matches the shared secret value. The digest
     * must be an MD5 hash of the secret key, encoded as hex. This value is supplied
     * by clients attempting shared secret authentication.
     *
     * @param digest the MD5 hash of the secret key, encoded as hex.
     * @return true if authentication succeeds.
     */
    public static boolean authenticateSharedSecret(String digest) {
        if (!isSharedSecretAllowed()) {
            return false;
        }
        String sharedSecert = getSharedSecret();
        return StringUtils.hash(sharedSecert).equals(digest);
    }


395
    private static Status doAnonymousAuthentication(LocalSession session) {
396
        if (XMPPServer.getInstance().getIQAuthHandler().isAnonymousAllowed()) {
397
            // Just accept the authentication :)
398 399
            authenticationSuccessful(session, null, null);
            return Status.authenticated;
400 401 402
        }
        else {
            // anonymous login is disabled so close the connection
403 404
            authenticationFailed(session);
            return Status.failed;
405 406 407
        }
    }

408
    private static Status doExternalAuthentication(LocalSession session, Element doc)
409
            throws UnsupportedEncodingException {
410
        // At this point the connection has already been secured using TLS
411

412 413 414 415 416 417 418
        if (session instanceof IncomingServerSession) {

            String hostname = doc.getTextTrim();
            if (hostname == null || hostname.length() == 0) {
                // No hostname was provided so send a challenge to get it
                sendChallenge(session, new byte[0]);
                return Status.needResponse;
419
            }
420 421 422 423 424 425 426 427 428 429
    
            hostname = new String(StringUtils.decodeBase64(hostname), CHARSET);
            // Check if cerificate validation is disabled for s2s
            // Flag that indicates if certificates of the remote server should be validated.
            // Disabling certificate validation is not recommended for production environments.
            boolean verify =
                    JiveGlobals.getBooleanProperty("xmpp.server.certificate.verify", true);
            if (!verify) {
                authenticationSuccessful(session, hostname, null);
                return Status.authenticated;
430
            }
431 432 433 434
            // Check that hostname matches the one provided in a certificate
            SocketConnection connection = (SocketConnection) session.getConnection();
            try {
                for (Certificate certificate : connection.getSSLSession().getPeerCertificates()) {
435 436 437 438 439
                    for (String identity : CertificateManager.getPeerIdentities((X509Certificate) certificate)) {
                        if (identity.equals(hostname) || identity.equals("*." + hostname)) {
                            authenticationSuccessful(session, hostname, null);
                            return Status.authenticated;
                        }
440
                    }
441
                }
442
            }
443 444 445
            catch (SSLPeerUnverifiedException e) {
                Log.warn("Error retrieving client certificates of: " + session, e);
            }
446
        }
447
        else if (session instanceof LocalClientSession) {
448 449
            // Client EXTERNALL login
            Log.debug("SASLAuthentication: EXTERNAL authentication via SSL certs for c2s connection");
450
            
451
            // This may be null, we will deal with that later
452
            String username = new String(StringUtils.decodeBase64(doc.getTextTrim()), CHARSET); 
453 454
            String principal = "";
            ArrayList<String> principals = new ArrayList<String>();
455 456 457 458 459 460
            Connection connection = session.getConnection();
            if (connection.getSSLSession() == null) {
                Log.debug("SASLAuthentication: EXTERNAL authentication requested, but no SSL/TLS connection found.");
                authenticationFailed(session);
                return Status.failed; 
            }
461 462 463 464 465 466 467 468 469
            try {
                for (Certificate certificate : connection.getSSLSession().getPeerCertificates()) {
                    principals.addAll(CertificateManager.getPeerIdentities((X509Certificate)certificate));
                }
            }
            catch (SSLPeerUnverifiedException e) {
                Log.warn("Error retrieving client certificates of: " + session, e);
            }

470 471 472

            principal = principals.get(0);

473
            if (username == null || username.length() == 0) {
474 475 476 477 478 479 480 481 482 483 484 485 486 487
                // No username was provided, according to XEP-0178 we need to:
                //    * attempt to get it from the cert first
                //    * have the server assign one

                // There shouldn't be more than a few principals in here. One ideally
                // We set principal to the first one in the list to have a sane default
                // If this list is empty, then the cert had no identity at all, which
                // will cause an authorization failure
                for(String princ : principals) {
                    String u = AuthorizationManager.map(princ);
                    if(!u.equals(princ)) {
                        username = u;
                        principal = princ;
                        break;
488
                    }
489 490 491 492 493 494
                }
                if (username == null || username.length() == 0) {
                    // Still no username.  Punt.
                    username = principal;
                }
                Log.debug("SASLAuthentication: no username requested, using "+username);
495
            }
496

497 498 499 500
            //Its possible that either/both username and principal are null here
            //The providers should not allow a null authorization
            if (AuthorizationManager.authorize(username,principal)) {
                Log.debug("SASLAuthentication: "+principal+" authorized to "+username);
501
                authenticationSuccessful(session, username,  null);
502 503
                return Status.authenticated;
            }
504 505
        } else {
            Log.debug("SASLAuthentication: unknown session type. Cannot perform EXTERNAL authentication");
506 507 508
        }
        authenticationFailed(session);
        return Status.failed;
509 510
    }

511
    private static Status doSharedSecretAuthentication(LocalSession session, Element doc)
Matt Tucker's avatar
Matt Tucker committed
512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535
            throws UnsupportedEncodingException
    {
        String secretDigest;
        String response = doc.getTextTrim();
        if (response == null || response.length() == 0) {
            // No info was provided so send a challenge to get it
            sendChallenge(session, new byte[0]);
            return Status.needResponse;
        }

        // Parse data and obtain username & password
        String data = new String(StringUtils.decodeBase64(response), CHARSET);
        StringTokenizer tokens = new StringTokenizer(data, "\0");
        tokens.nextToken();
        secretDigest = tokens.nextToken();
        if (authenticateSharedSecret(secretDigest)) {
            authenticationSuccessful(session, null, null);
            return Status.authenticated;
        }
        // Otherwise, authentication failed.
        authenticationFailed(session);
        return Status.failed;
    }

536
    private static void sendChallenge(Session session, byte[] challenge) {
537
        StringBuilder reply = new StringBuilder(250);
Matt Tucker's avatar
Matt Tucker committed
538
        if (challenge == null) {
539 540
            challenge = new byte[0];
        }
541 542 543 544
        String challenge_b64 = StringUtils.encodeBase64(challenge).trim();
        if ("".equals(challenge_b64)) {
            challenge_b64 = "="; // Must be padded if null
        }
545 546
        reply.append(
                "<challenge xmlns=\"urn:ietf:params:xml:ns:xmpp-sasl\">");
547
        reply.append(challenge_b64);
548
        reply.append("</challenge>");
549
        session.deliverRawText(reply.toString());
550 551
    }

552
    private static void authenticationSuccessful(LocalSession session, String username,
553
            byte[] successData) {
554 555 556
        StringBuilder reply = new StringBuilder(80);
        reply.append("<success xmlns=\"urn:ietf:params:xml:ns:xmpp-sasl\"");
        if (successData != null) {
557 558
            String successData_b64 = StringUtils.encodeBase64(successData).trim();
            reply.append(">").append(successData_b64).append("</success>");
559 560 561 562
        }
        else {
            reply.append("/>");
        }
563
        session.deliverRawText(reply.toString());
564 565
        // We only support SASL for c2s
        if (session instanceof ClientSession) {
566
            ((LocalClientSession) session).setAuthToken(new AuthToken(username));
567 568 569 570 571 572 573
        }
        else if (session instanceof IncomingServerSession) {
            String hostname = username;
            // Set the first validated domain as the address of the session
            session.setAddress(new JID(null, hostname, null));
            // Add the validated domain as a valid domain. The remote server can
            // now send packets from this address
574
            ((LocalIncomingServerSession) session).addValidatedDomain(hostname);
575 576 577
        }
    }

578
    private static void authenticationFailed(LocalSession session) {
579 580 581
        StringBuilder reply = new StringBuilder(80);
        reply.append("<failure xmlns=\"urn:ietf:params:xml:ns:xmpp-sasl\">");
        reply.append("<not-authorized/></failure>");
582
        session.deliverRawText(reply.toString());
583 584 585
        // Give a number of retries before closing the connection
        Integer retries = (Integer) session.getSessionData("authRetries");
        if (retries == null) {
586
            retries = 1;
587 588 589 590 591 592 593
        }
        else {
            retries = retries + 1;
        }
        session.setSessionData("authRetries", retries);
        if (retries >= JiveGlobals.getIntProperty("xmpp.auth.retries", 3) ) {
            // Close the connection
594
            session.close();
595
        }
596
    }
597 598

    /**
599
     * Adds a new SASL mechanism to the list of supported SASL mechanisms by the server. The
Matt Tucker's avatar
Matt Tucker committed
600 601 602
     * new mechanism will be offered to clients and connection managers as stream features.<p>
     *
     * Note: this method simply registers the SASL mechanism to be advertised as a supported
603
     * mechanism by Openfire. Actual SASL handling is done by Java itself, so you must add
Matt Tucker's avatar
Matt Tucker committed
604
     * the provider to Java.
605 606 607
     *
     * @param mechanism the new SASL mechanism.
     */
608
    public static void addSupportedMechanism(String mechanism) {
609 610 611 612 613 614 615 616
        mechanisms.add(mechanism);
    }

    /**
     * Removes a SASL mechanism from the list of supported SASL mechanisms by the server.
     *
     * @param mechanism the SASL mechanism to remove.
     */
617
    public static void removeSupportedMechanism(String mechanism) {
618 619 620 621 622 623 624 625 626 627 628 629
        mechanisms.remove(mechanism);
    }

    /**
     * Returns the list of supported SASL mechanisms by the server. Note that Java may have
     * support for more mechanisms but some of them may not be returned since a special setup
     * is required that might be missing. Use {@link #addSupportedMechanism(String)} to add
     * new SASL mechanisms.
     *
     * @return the list of supported SASL mechanisms by the server.
     */
    public static Set<String> getSupportedMechanisms() {
630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654
        Set<String> answer = new HashSet<String>(mechanisms);
        // Clean up not-available mechanisms
        for (Iterator<String> it=answer.iterator(); it.hasNext();) {
            String mech = it.next();
            if (mech.equals("CRAM-MD5") || mech.equals("DIGEST-MD5")) {
                // Check if the user provider in use supports passwords retrieval. Accessing
                // to the users passwords will be required by the CallbackHandler
                if (!AuthFactory.getAuthProvider().supportsPasswordRetrieval()) {
                    it.remove();
                }
            }
            else if (mech.equals("ANONYMOUS")) {
                // Check anonymous is supported
                if (!XMPPServer.getInstance().getIQAuthHandler().isAnonymousAllowed()) {
                    it.remove();
                }
            }
            else if (mech.equals("JIVE-SHAREDSECRET")) {
                // Check shared secret is supported
                if (!isSharedSecretAllowed()) {
                    it.remove();
                }
            }
        }
        return answer;
655 656 657 658 659 660 661 662 663 664
    }

    private static void initMechanisms() {
        mechanisms = new HashSet<String>();
        String available = JiveGlobals.getXMLProperty("sasl.mechs");
        if (available == null) {
            mechanisms.add("ANONYMOUS");
            mechanisms.add("PLAIN");
            mechanisms.add("DIGEST-MD5");
            mechanisms.add("CRAM-MD5");
Matt Tucker's avatar
Matt Tucker committed
665 666 667
            mechanisms.add("JIVE-SHAREDSECRET");
        }
        else {
668 669 670 671
            StringTokenizer st = new StringTokenizer(available, " ,\t\n\r\f");
            while (st.hasMoreTokens()) {
                String mech = st.nextToken().toUpperCase();
                // Check that the mech is a supported mechansim. Maybe we shouldnt check this and allow any?
672 673 674 675
                if (mech.equals("ANONYMOUS") ||
                        mech.equals("PLAIN") ||
                        mech.equals("DIGEST-MD5") ||
                        mech.equals("CRAM-MD5") ||
Matt Tucker's avatar
Matt Tucker committed
676
                        mech.equals("GSSAPI") ||
677
                        mech.equals("EXTERNAL") ||
Matt Tucker's avatar
Matt Tucker committed
678 679
                        mech.equals("JIVE-SHAREDSECRET")) 
                {
680
                    Log.debug("SASLAuthentication: Added " + mech + " to mech list");
681 682 683
                    mechanisms.add(mech);
                }
            }
684

685
            if (mechanisms.contains("GSSAPI")) {
686 687 688 689 690 691 692
                if (JiveGlobals.getXMLProperty("sasl.gssapi.config") != null) {
                    System.setProperty("java.security.krb5.debug",
                            JiveGlobals.getXMLProperty("sasl.gssapi.debug", "false"));
                    System.setProperty("java.security.auth.login.config",
                            JiveGlobals.getXMLProperty("sasl.gssapi.config"));
                    System.setProperty("javax.security.auth.useSubjectCredsOnly",
                            JiveGlobals.getXMLProperty("sasl.gssapi.useSubjectCredsOnly", "false"));
Matt Tucker's avatar
Matt Tucker committed
693 694
                }
                else {
695 696 697 698 699 700
                    //Not configured, remove the option.
                    Log.debug("SASLAuthentication: Removed GSSAPI from mech list");
                    mechanisms.remove("GSSAPI");
                }
            }
        }
701 702
        //Add our providers to the Security class
        Security.addProvider(new org.jivesoftware.openfire.sasl.SaslProvider());
703
    }
704
}