geronimo-javamail_1.5/geronimo-javamail_1.4_provider/src/main/java/org/apache/geronimo/javamail/authentication/SASLAuthenticator.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *  http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package org.apache.geronimo.javamail.authentication;

import java.io.UnsupportedEncodingException ;
import java.util.Map;        
import java.util.Properties; 

import javax.mail.MessagingException;

import javax.security.auth.callback.Callback;
import javax.security.auth.callback.CallbackHandler;
import javax.security.auth.callback.NameCallback;
import javax.security.auth.callback.PasswordCallback;
import javax.security.sasl.Sasl; 
import javax.security.sasl.SaslClient; 
import javax.security.sasl.SaslException; 
import javax.security.sasl.RealmCallback; 
import javax.security.sasl.RealmChoiceCallback; 

public class SASLAuthenticator implements ClientAuthenticator, CallbackHandler {
    // The realm we're authenticating within 
    protected String realm; 
    // the user we're authenticating
    protected String username;
    // the user's password (the "shared secret")
    protected String password;
    // the authenticator we're proxying 
    protected SaslClient authenticator; 

    protected boolean complete = false;

    /**
     * Main constructor.
     * 
     * @param username
     *            The login user name.
     * @param password
     *            The login password.
     */
    public SASLAuthenticator(String[] mechanisms, Properties properties, String protocol, String host, String realm, 
            String authorizationID, String username, String password) throws MessagingException {
        this.realm = realm; 
        this.username = username;
        this.password = password;
        try {
            authenticator = Sasl.createSaslClient(mechanisms, authorizationID, protocol, host, (Map)properties, 
                this); 
        } catch (SaslException e) {
        } 
    }
    
    
    /**
     * Respond to the hasInitialResponse query. We defer this to the Sasl client.  
     * 
     * @return The SaslClient response to the same query. 
     */
    public boolean hasInitialResponse() {
        return authenticator.hasInitialResponse(); 
    }

    /**
     * Indicate whether the challenge/response process is complete.
     * 
     * @return True if the last challenge has been processed, false otherwise.
     */
    public boolean isComplete() {
        return authenticator.hasInitialResponse(); 
    }

    /**
     * Retrieve the authenticator mechanism name.
     * 
     * @return Always returns the string "PLAIN"
     */
    public String getMechanismName() {
        // the authenticator selects this for us. 
        return authenticator.getMechanismName(); 
    }

    /**
     * Evaluate a login challenge, returning the a result string that
     * should satisfy the clallenge.  This is forwarded to the 
     * SaslClient, which will use the CallBackHandler to retrieve the 
     * information it needs for the given protocol. 
     * 
     * @param challenge
     *            The decoded challenge data, as byte array.
     * 
     * @return A formatted challege response, as an array of bytes.
     * @exception MessagingException
     */
    public byte[] evaluateChallenge(byte[] challenge) throws MessagingException {
        // for an initial response challenge, there's no challenge date.  The SASL 
        // client still expects a byte array argument. 
        if (challenge == null) {
            challenge = new byte[0];
        }
        
        try {
            return authenticator.evaluateChallenge(challenge);
        } catch (SaslException e) {
            // got an error, fail this
            throw new MessagingException("Error performing SASL validation", e);
        }
    }
    
    public void handle(Callback[] callBacks) {
        for (int i = 0; i < callBacks.length; i++) {
            Callback callBack = callBacks[i]; 
            // requesting the user name 
            if (callBack instanceof NameCallback) {
                ((NameCallback)callBack).setName(username); 
            }
            // need the password 
            else if (callBack instanceof PasswordCallback) {
                ((PasswordCallback)callBack).setPassword(password.toCharArray()); 
            }
            // direct request for the realm information 
            else if (callBack instanceof RealmCallback) {
                RealmCallback realmCallback = (RealmCallback)callBack; 
                // we might not have a realm, so use the default from the 
                // callback item 
                if (realm == null) {
                    realmCallback.setText(realmCallback.getDefaultText()); 
                }
                else { 
                    realmCallback.setText(realm); 
                }
            }
            // asked to select the realm information from a list 
            else if (callBack instanceof RealmChoiceCallback) {
                RealmChoiceCallback realmCallback = (RealmChoiceCallback)callBack; 
                // if we don't have a realm, just tell it to use the default 
                if (realm == null) {
                    realmCallback.setSelectedIndex(realmCallback.getDefaultChoice()); 
                }
                else {
                    // locate our configured one in the list 
                    String[] choices = realmCallback.getChoices(); 

                    for (int j = 0; j < choices.length; j++) {
                        // set the index to any match and get out of here. 
                        if (choices[j].equals(realm)) {
                            realmCallback.setSelectedIndex(j); 
                            break; 
                        }
                    }
                    // NB:  If there was no match, we don't set anything.  
                    // this should cause an authentication failure. 
                }
            }
        }
    }
}