0N/A/*
2362N/A * Copyright (c) 2000, 2006, Oracle and/or its affiliates. All rights reserved.
0N/A * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
0N/A *
0N/A * This code is free software; you can redistribute it and/or modify it
0N/A * under the terms of the GNU General Public License version 2 only, as
2362N/A * published by the Free Software Foundation. Oracle designates this
0N/A * particular file as subject to the "Classpath" exception as provided
2362N/A * by Oracle in the LICENSE file that accompanied this code.
0N/A *
0N/A * This code is distributed in the hope that it will be useful, but WITHOUT
0N/A * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
0N/A * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
0N/A * version 2 for more details (a copy is included in the LICENSE file that
0N/A * accompanied this code).
0N/A *
0N/A * You should have received a copy of the GNU General Public License version
0N/A * 2 along with this work; if not, write to the Free Software Foundation,
0N/A * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
0N/A *
2362N/A * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
2362N/A * or visit www.oracle.com if you need additional information or have any
2362N/A * questions.
0N/A */
0N/A
0N/Apackage com.sun.security.sasl;
0N/A
0N/Aimport javax.security.sasl.*;
0N/A
0N/A/**
0N/A * Implements the PLAIN SASL client mechanism.
0N/A * (<A
0N/A * HREF="http://ftp.isi.edu/in-notes/rfc2595.txt">RFC 2595</A>)
0N/A *
0N/A * @author Rosanna Lee
0N/A */
0N/Afinal class PlainClient implements SaslClient {
0N/A private boolean completed = false;
0N/A private byte[] pw;
0N/A private String authorizationID;
0N/A private String authenticationID;
0N/A private static byte SEP = 0; // US-ASCII <NUL>
0N/A
0N/A /**
0N/A * Creates a SASL mechanism with client credentials that it needs
0N/A * to participate in Plain authentication exchange with the server.
0N/A *
0N/A * @param authorizationID A possibly null string representing the principal
0N/A * for which authorization is being granted; if null, same as
0N/A * authenticationID
0N/A * @param authenticationID A non-null string representing the principal
0N/A * being authenticated. pw is associated with with this principal.
0N/A * @param pw A non-null byte[] containing the password.
0N/A */
0N/A PlainClient(String authorizationID, String authenticationID, byte[] pw)
0N/A throws SaslException {
0N/A if (authenticationID == null || pw == null) {
0N/A throw new SaslException(
0N/A "PLAIN: authorization ID and password must be specified");
0N/A }
0N/A
0N/A this.authorizationID = authorizationID;
0N/A this.authenticationID = authenticationID;
0N/A this.pw = pw; // caller should have already cloned
0N/A }
0N/A
0N/A /**
0N/A * Retrieves this mechanism's name for to initiate the PLAIN protocol
0N/A * exchange.
0N/A *
0N/A * @return The string "PLAIN".
0N/A */
0N/A public String getMechanismName() {
0N/A return "PLAIN";
0N/A }
0N/A
0N/A public boolean hasInitialResponse() {
0N/A return true;
0N/A }
0N/A
0N/A public void dispose() throws SaslException {
0N/A clearPassword();
0N/A }
0N/A
0N/A /**
0N/A * Retrieves the initial response for the SASL command, which for
0N/A * PLAIN is the concatenation of authorization ID, authentication ID
0N/A * and password, with each component separated by the US-ASCII <NUL> byte.
0N/A *
0N/A * @param challengeData Ignored
0N/A * @return A non-null byte array containing the response to be sent to the server.
0N/A * @throws SaslException If cannot encode ids in UTF-8
0N/A * @throw IllegalStateException if authentication already completed
0N/A */
0N/A public byte[] evaluateChallenge(byte[] challengeData) throws SaslException {
0N/A if (completed) {
0N/A throw new IllegalStateException(
0N/A "PLAIN authentication already completed");
0N/A }
0N/A completed = true;
0N/A
0N/A try {
0N/A byte[] authz = (authorizationID != null)?
0N/A authorizationID.getBytes("UTF8") :
0N/A null;
0N/A byte[] auth = authenticationID.getBytes("UTF8");
0N/A
0N/A byte[] answer = new byte[pw.length + auth.length + 2 +
0N/A (authz == null ? 0 : authz.length)];
0N/A
0N/A int pos = 0;
0N/A if (authz != null) {
0N/A System.arraycopy(authz, 0, answer, 0, authz.length);
0N/A pos = authz.length;
0N/A }
0N/A answer[pos++] = SEP;
0N/A System.arraycopy(auth, 0, answer, pos, auth.length);
0N/A
0N/A pos += auth.length;
0N/A answer[pos++] = SEP;
0N/A
0N/A System.arraycopy(pw, 0, answer, pos, pw.length);
0N/A
0N/A clearPassword();
0N/A return answer;
0N/A } catch (java.io.UnsupportedEncodingException e) {
0N/A throw new SaslException("Cannot get UTF-8 encoding of ids", e);
0N/A }
0N/A }
0N/A
0N/A /**
0N/A * Determines whether this mechanism has completed.
0N/A * Plain completes after returning one response.
0N/A *
0N/A * @return true if has completed; false otherwise;
0N/A */
0N/A public boolean isComplete() {
0N/A return completed;
0N/A }
0N/A
0N/A /**
0N/A * Unwraps the incoming buffer.
0N/A *
0N/A * @throws SaslException Not applicable to this mechanism.
0N/A */
0N/A public byte[] unwrap(byte[] incoming, int offset, int len)
0N/A throws SaslException {
0N/A if (completed) {
0N/A throw new SaslException(
0N/A "PLAIN supports neither integrity nor privacy");
0N/A } else {
0N/A throw new IllegalStateException("PLAIN authentication not completed");
0N/A }
0N/A }
0N/A
0N/A /**
0N/A * Wraps the outgoing buffer.
0N/A *
0N/A * @throws SaslException Not applicable to this mechanism.
0N/A */
0N/A public byte[] wrap(byte[] outgoing, int offset, int len) throws SaslException {
0N/A if (completed) {
0N/A throw new SaslException(
0N/A "PLAIN supports neither integrity nor privacy");
0N/A } else {
0N/A throw new IllegalStateException("PLAIN authentication not completed");
0N/A }
0N/A }
0N/A
0N/A /**
0N/A * Retrieves the negotiated property.
0N/A * This method can be called only after the authentication exchange has
0N/A * completed (i.e., when <tt>isComplete()</tt> returns true); otherwise, a
0N/A * <tt>SaslException</tt> is thrown.
0N/A *
0N/A * @return value of property; only QOP is applicable to PLAIN.
0N/A * @exception IllegalStateException if this authentication exchange
0N/A * has not completed
0N/A */
0N/A public Object getNegotiatedProperty(String propName) {
0N/A if (completed) {
0N/A if (propName.equals(Sasl.QOP)) {
0N/A return "auth";
0N/A } else {
0N/A return null;
0N/A }
0N/A } else {
0N/A throw new IllegalStateException("PLAIN authentication not completed");
0N/A }
0N/A }
0N/A
0N/A private void clearPassword() {
0N/A if (pw != null) {
0N/A // zero out password
0N/A for (int i = 0; i < pw.length; i++) {
0N/A pw[i] = (byte)0;
0N/A }
0N/A pw = null;
0N/A }
0N/A }
0N/A
0N/A protected void finalize() {
0N/A clearPassword();
0N/A }
0N/A}