0N/A/*
3261N/A * Copyright (c) 1999, 2010, 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 EXTERNAL SASL client mechanism.
2507N/A * (<A HREF="http://www.ietf.org/rfc/rfc2222.txt">RFC 2222</A>).
0N/A * The EXTERNAL mechanism returns the optional authorization ID as
0N/A * the initial response. It processes no challenges.
0N/A *
0N/A * @author Rosanna Lee
0N/A */
0N/Afinal class ExternalClient implements SaslClient {
0N/A private byte[] username;
0N/A private boolean completed = false;
0N/A
0N/A /**
0N/A * Constructs an External mechanism with optional authorization ID.
0N/A *
0N/A * @param authorizationID If non-null, used to specify authorization ID.
0N/A * @throws SaslException if cannot convert authorizationID into UTF-8
0N/A * representation.
0N/A */
0N/A ExternalClient(String authorizationID) throws SaslException {
0N/A if (authorizationID != null) {
0N/A try {
0N/A username = authorizationID.getBytes("UTF8");
0N/A } catch (java.io.UnsupportedEncodingException e) {
0N/A throw new SaslException("Cannot convert " + authorizationID +
0N/A " into UTF-8", e);
0N/A }
0N/A } else {
0N/A username = new byte[0];
0N/A }
0N/A }
0N/A
0N/A /**
0N/A * Retrieves this mechanism's name for initiating the "EXTERNAL" protocol
0N/A * exchange.
0N/A *
0N/A * @return The string "EXTERNAL".
0N/A */
0N/A public String getMechanismName() {
0N/A return "EXTERNAL";
0N/A }
0N/A
0N/A /**
0N/A * This mechanism has an initial response.
0N/A */
0N/A public boolean hasInitialResponse() {
0N/A return true;
0N/A }
0N/A
0N/A public void dispose() throws SaslException {
0N/A }
0N/A
0N/A /**
0N/A * Processes the challenge data.
0N/A * It returns the EXTERNAL mechanism's initial response,
0N/A * which is the authorization id encoded in UTF-8.
0N/A * This is the optional information that is sent along with the SASL command.
0N/A * After this method is called, isComplete() returns true.
0N/A *
0N/A * @param challengeData Ignored.
0N/A * @return The possible empty initial response.
0N/A * @throws SaslException If authentication has already been called.
0N/A */
0N/A public byte[] evaluateChallenge(byte[] challengeData)
0N/A throws SaslException {
0N/A if (completed) {
0N/A throw new IllegalStateException(
0N/A "EXTERNAL authentication already completed");
0N/A }
0N/A completed = true;
0N/A return username;
0N/A }
0N/A
0N/A /**
0N/A * Returns whether this mechanism is complete.
0N/A * @return true if initial response has been sent; 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("EXTERNAL has no supported QOP");
0N/A } else {
0N/A throw new IllegalStateException(
0N/A "EXTERNAL 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)
0N/A throws SaslException {
0N/A if (completed) {
0N/A throw new SaslException("EXTERNAL has no supported QOP");
0N/A } else {
0N/A throw new IllegalStateException(
0N/A "EXTERNAL 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>IllegalStateException</tt> is thrown.
0N/A *
0N/A * @return null No property is applicable to this mechanism.
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 return null;
0N/A } else {
0N/A throw new IllegalStateException(
0N/A "EXTERNAL authentication not completed");
0N/A }
0N/A }
0N/A}