| /** |
| * 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.hadoop.security; |
| |
| import java.io.ByteArrayInputStream; |
| import java.io.DataInput; |
| import java.io.DataInputStream; |
| import java.io.DataOutput; |
| import java.io.IOException; |
| import java.util.TreeMap; |
| import java.util.Map; |
| |
| 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 javax.security.sasl.Sasl; |
| |
| import org.apache.commons.codec.binary.Base64; |
| import org.apache.commons.logging.Log; |
| import org.apache.commons.logging.LogFactory; |
| import org.apache.hadoop.classification.InterfaceAudience; |
| import org.apache.hadoop.classification.InterfaceStability; |
| import org.apache.hadoop.ipc.Server; |
| import org.apache.hadoop.security.token.SecretManager; |
| import org.apache.hadoop.security.token.TokenIdentifier; |
| import org.apache.hadoop.security.UserGroupInformation.AuthenticationMethod; |
| import org.apache.hadoop.security.token.SecretManager.InvalidToken; |
| |
| /** |
| * A utility class for dealing with SASL on RPC server |
| */ |
| @InterfaceAudience.LimitedPrivate({"HDFS", "MapReduce"}) |
| @InterfaceStability.Evolving |
| public class SaslRpcServer { |
| public static final Log LOG = LogFactory.getLog(SaslRpcServer.class); |
| public static final String SASL_DEFAULT_REALM = "default"; |
| public static final Map<String, String> SASL_PROPS = |
| new TreeMap<String, String>(); |
| static { |
| // Request authentication plus integrity protection |
| SASL_PROPS.put(Sasl.QOP, "auth-int"); |
| // Request mutual authentication |
| SASL_PROPS.put(Sasl.SERVER_AUTH, "true"); |
| } |
| public static final int SWITCH_TO_SIMPLE_AUTH = -88; |
| |
| static String encodeIdentifier(byte[] identifier) { |
| return new String(Base64.encodeBase64(identifier)); |
| } |
| |
| static byte[] decodeIdentifier(String identifier) { |
| return Base64.decodeBase64(identifier.getBytes()); |
| } |
| |
| public static TokenIdentifier getIdentifier(String id, |
| SecretManager<TokenIdentifier> secretManager) throws InvalidToken { |
| byte[] tokenId = decodeIdentifier(id); |
| TokenIdentifier tokenIdentifier = secretManager.createIdentifier(); |
| try { |
| tokenIdentifier.readFields(new DataInputStream(new ByteArrayInputStream( |
| tokenId))); |
| } catch (IOException e) { |
| throw (InvalidToken) new InvalidToken( |
| "Can't de-serialize tokenIdentifier").initCause(e); |
| } |
| return tokenIdentifier; |
| } |
| |
| static char[] encodePassword(byte[] password) { |
| return new String(Base64.encodeBase64(password)).toCharArray(); |
| } |
| |
| /** Splitting fully qualified Kerberos name into parts */ |
| public static String[] splitKerberosName(String fullName) { |
| return fullName.split("[/@]"); |
| } |
| |
| @InterfaceStability.Evolving |
| public enum SaslStatus { |
| SUCCESS (0), |
| ERROR (1); |
| |
| public final int state; |
| private SaslStatus(int state) { |
| this.state = state; |
| } |
| } |
| |
| /** Authentication method */ |
| @InterfaceStability.Evolving |
| public static enum AuthMethod { |
| SIMPLE((byte) 80, "", AuthenticationMethod.SIMPLE), |
| KERBEROS((byte) 81, "GSSAPI", AuthenticationMethod.KERBEROS), |
| DIGEST((byte) 82, "DIGEST-MD5", AuthenticationMethod.TOKEN); |
| |
| /** The code for this method. */ |
| public final byte code; |
| public final String mechanismName; |
| public final AuthenticationMethod authenticationMethod; |
| |
| private AuthMethod(byte code, String mechanismName, |
| AuthenticationMethod authMethod) { |
| this.code = code; |
| this.mechanismName = mechanismName; |
| this.authenticationMethod = authMethod; |
| } |
| |
| private static final int FIRST_CODE = values()[0].code; |
| |
| /** Return the object represented by the code. */ |
| private static AuthMethod valueOf(byte code) { |
| final int i = (code & 0xff) - FIRST_CODE; |
| return i < 0 || i >= values().length ? null : values()[i]; |
| } |
| |
| /** Return the SASL mechanism name */ |
| public String getMechanismName() { |
| return mechanismName; |
| } |
| |
| /** Read from in */ |
| public static AuthMethod read(DataInput in) throws IOException { |
| return valueOf(in.readByte()); |
| } |
| |
| /** Write to out */ |
| public void write(DataOutput out) throws IOException { |
| out.write(code); |
| } |
| }; |
| |
| /** CallbackHandler for SASL DIGEST-MD5 mechanism */ |
| @InterfaceStability.Evolving |
| public static class SaslDigestCallbackHandler implements CallbackHandler { |
| private SecretManager<TokenIdentifier> secretManager; |
| private Server.Connection connection; |
| |
| public SaslDigestCallbackHandler( |
| SecretManager<TokenIdentifier> secretManager, |
| Server.Connection connection) { |
| this.secretManager = secretManager; |
| this.connection = connection; |
| } |
| |
| private char[] getPassword(TokenIdentifier tokenid) throws InvalidToken { |
| return encodePassword(secretManager.retrievePassword(tokenid)); |
| } |
| |
| /** {@inheritDoc} */ |
| @Override |
| public void handle(Callback[] callbacks) throws InvalidToken, |
| UnsupportedCallbackException { |
| NameCallback nc = null; |
| PasswordCallback pc = null; |
| AuthorizeCallback ac = null; |
| for (Callback callback : callbacks) { |
| if (callback instanceof AuthorizeCallback) { |
| ac = (AuthorizeCallback) callback; |
| } else if (callback instanceof NameCallback) { |
| nc = (NameCallback) callback; |
| } else if (callback instanceof PasswordCallback) { |
| pc = (PasswordCallback) callback; |
| } else if (callback instanceof RealmCallback) { |
| continue; // realm is ignored |
| } else { |
| throw new UnsupportedCallbackException(callback, |
| "Unrecognized SASL DIGEST-MD5 Callback"); |
| } |
| } |
| if (pc != null) { |
| TokenIdentifier tokenIdentifier = getIdentifier(nc.getDefaultName(), secretManager); |
| char[] password = getPassword(tokenIdentifier); |
| UserGroupInformation user = null; |
| user = tokenIdentifier.getUser(); // may throw exception |
| connection.attemptingUser = user; |
| |
| if (LOG.isDebugEnabled()) { |
| LOG.debug("SASL server DIGEST-MD5 callback: setting password " |
| + "for client: " + tokenIdentifier.getUser()); |
| } |
| pc.setPassword(password); |
| } |
| if (ac != null) { |
| String authid = ac.getAuthenticationID(); |
| String authzid = ac.getAuthorizationID(); |
| if (authid.equals(authzid)) { |
| ac.setAuthorized(true); |
| } else { |
| ac.setAuthorized(false); |
| } |
| if (ac.isAuthorized()) { |
| String username = getIdentifier(authzid, secretManager).getUser() |
| .getUserName().toString(); |
| if (LOG.isDebugEnabled()) |
| LOG.debug("SASL server DIGEST-MD5 callback: setting " |
| + "canonicalized client ID: " + username); |
| ac.setAuthorizedID(authzid); |
| } |
| } |
| } |
| } |
| |
| /** CallbackHandler for SASL GSSAPI Kerberos mechanism */ |
| @InterfaceStability.Evolving |
| public static class SaslGssCallbackHandler implements CallbackHandler { |
| |
| /** {@inheritDoc} */ |
| @Override |
| public void handle(Callback[] callbacks) throws |
| UnsupportedCallbackException { |
| AuthorizeCallback ac = null; |
| for (Callback callback : callbacks) { |
| if (callback instanceof AuthorizeCallback) { |
| ac = (AuthorizeCallback) callback; |
| } else { |
| throw new UnsupportedCallbackException(callback, |
| "Unrecognized SASL GSSAPI Callback"); |
| } |
| } |
| if (ac != null) { |
| String authid = ac.getAuthenticationID(); |
| String authzid = ac.getAuthorizationID(); |
| if (authid.equals(authzid)) { |
| ac.setAuthorized(true); |
| } else { |
| ac.setAuthorized(false); |
| } |
| if (ac.isAuthorized()) { |
| if (LOG.isDebugEnabled()) |
| LOG.debug("SASL server GSSAPI callback: setting " |
| + "canonicalized client ID: " + authzid); |
| ac.setAuthorizedID(authzid); |
| } |
| } |
| } |
| } |
| } |