zookeeper-server/src/main/java/org/apache/zookeeper/SaslClientCallbackHandler.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.zookeeper;

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.auth.callback.UnsupportedCallbackException;
import javax.security.sasl.AuthorizeCallback;
import javax.security.sasl.RealmCallback;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * This is used by the SASL mechanisms to get further information to complete
 * the authentication. For example, a SASL mechanism might use this callback
 * handler to do verification operation. The CallbackHandler interface here
 * refers to javax.security.auth.callback.CallbackHandler. It should not be
 * confused with ZooKeeper packet callbacks like
 * org.apache.zookeeper.server.auth.SaslServerCallbackHandler.
 */
public class SaslClientCallbackHandler implements CallbackHandler {

    private String password = null;
    private static final Logger LOG = LoggerFactory.getLogger(SaslClientCallbackHandler.class);
    private final String entity;
    public SaslClientCallbackHandler(String password, String client) {
        this.password = password;
        this.entity = client;
    }

    public void handle(Callback[] callbacks) throws UnsupportedCallbackException {
        for (Callback callback : callbacks) {
            if (callback instanceof NameCallback) {
                NameCallback nc = (NameCallback) callback;
                nc.setName(nc.getDefaultName());
            } else {
                if (callback instanceof PasswordCallback) {
                    PasswordCallback pc = (PasswordCallback) callback;
                    if (password != null) {
                        pc.setPassword(this.password.toCharArray());
                    } else {
                        LOG.warn(
                            "Could not login: the {} is being asked for a password, but the ZooKeeper {}"
                                + " code does not currently support obtaining a password from the user."
                                + " Make sure that the {} is configured to use a ticket cache (using"
                                + " the JAAS configuration setting 'useTicketCache=true)' and restart the {}. If"
                                + " you still get this message after that, the TGT in the ticket cache has expired and must"
                                + " be manually refreshed. To do so, first determine if you are using a password or a"
                                + " keytab. If the former, run kinit in a Unix shell in the environment of the user who"
                                + " is running this Zookeeper {} using the command"
                                + " 'kinit <princ>' (where <princ> is the name of the {}'s Kerberos principal)."
                                + " If the latter, do"
                                + " 'kinit -k -t <keytab> <princ>' (where <princ> is the name of the Kerberos principal, and"
                                + " <keytab> is the location of the keytab file). After manually refreshing your cache,"
                                + " restart this {}. If you continue to see this message after manually refreshing"
                                + " your cache, ensure that your KDC host's clock is in sync with this host's clock.",
                            entity,
                            entity,
                            entity,
                            entity,
                            entity,
                            entity,
                            entity);
                    }
                } else {
                    if (callback instanceof RealmCallback) {
                        RealmCallback rc = (RealmCallback) callback;
                        rc.setText(rc.getDefaultText());
                    } else {
                        if (callback instanceof AuthorizeCallback) {
                            AuthorizeCallback ac = (AuthorizeCallback) callback;
                            String authid = ac.getAuthenticationID();
                            String authzid = ac.getAuthorizationID();
                            if (authid.equals(authzid)) {
                                ac.setAuthorized(true);
                            } else {
                                ac.setAuthorized(false);
                            }
                            if (ac.isAuthorized()) {
                                ac.setAuthorizedID(authzid);
                            }
                        } else {
                            throw new UnsupportedCallbackException(
                                callback,
                                "Unrecognized SASL " + entity + "Callback");
                        }
                    }
                }
            }
        }
    }

}