jdk/src/java.security.sasl/share/classes/com/sun/security/sasl/ExternalClient.java
author avstepan
Tue, 25 Aug 2015 18:45:09 +0300
changeset 32275 17eeb583a331
parent 25859 3317bb8137f4
permissions -rw-r--r--
8133802: replace some <tt> tags (obsolete in html5) in security-libs docs Reviewed-by: mullan
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     1
/*
7668
d4a77089c587 6962318: Update copyright year
ohair
parents: 5820
diff changeset
     2
 * Copyright (c) 1999, 2010, Oracle and/or its affiliates. All rights reserved.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
90ce3da70b43 Initial load
duke
parents:
diff changeset
     4
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
90ce3da70b43 Initial load
duke
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    10
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
90ce3da70b43 Initial load
duke
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
90ce3da70b43 Initial load
duke
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
90ce3da70b43 Initial load
duke
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
90ce3da70b43 Initial load
duke
parents:
diff changeset
    15
 * accompanied this code).
90ce3da70b43 Initial load
duke
parents:
diff changeset
    16
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
90ce3da70b43 Initial load
duke
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    20
 *
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    23
 * questions.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    24
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    25
90ce3da70b43 Initial load
duke
parents:
diff changeset
    26
package com.sun.security.sasl;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    27
90ce3da70b43 Initial load
duke
parents:
diff changeset
    28
import javax.security.sasl.*;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    29
90ce3da70b43 Initial load
duke
parents:
diff changeset
    30
/**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    31
  * Implements the EXTERNAL SASL client mechanism.
5820
4f5e99470724 6967036: Need to fix links with // in Javadoc comments
ohair
parents: 5506
diff changeset
    32
  * (<A HREF="http://www.ietf.org/rfc/rfc2222.txt">RFC 2222</A>).
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    33
  * The EXTERNAL mechanism returns the optional authorization ID as
90ce3da70b43 Initial load
duke
parents:
diff changeset
    34
  * the initial response. It processes no challenges.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    35
  *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    36
  * @author Rosanna Lee
90ce3da70b43 Initial load
duke
parents:
diff changeset
    37
  */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    38
final class ExternalClient implements SaslClient {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    39
    private byte[] username;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    40
    private boolean completed = false;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    41
90ce3da70b43 Initial load
duke
parents:
diff changeset
    42
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    43
     * Constructs an External mechanism with optional authorization ID.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    44
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    45
     * @param authorizationID If non-null, used to specify authorization ID.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    46
     * @throws SaslException if cannot convert authorizationID into UTF-8
90ce3da70b43 Initial load
duke
parents:
diff changeset
    47
     *     representation.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    48
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    49
    ExternalClient(String authorizationID) throws SaslException {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    50
        if (authorizationID != null) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    51
            try {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    52
                username = authorizationID.getBytes("UTF8");
90ce3da70b43 Initial load
duke
parents:
diff changeset
    53
            } catch (java.io.UnsupportedEncodingException e) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    54
                throw new SaslException("Cannot convert " + authorizationID +
90ce3da70b43 Initial load
duke
parents:
diff changeset
    55
                    " into UTF-8", e);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    56
            }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    57
        } else {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    58
            username = new byte[0];
90ce3da70b43 Initial load
duke
parents:
diff changeset
    59
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    60
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    61
90ce3da70b43 Initial load
duke
parents:
diff changeset
    62
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    63
     * Retrieves this mechanism's name for initiating the "EXTERNAL" protocol
90ce3da70b43 Initial load
duke
parents:
diff changeset
    64
     * exchange.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    65
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    66
     * @return  The string "EXTERNAL".
90ce3da70b43 Initial load
duke
parents:
diff changeset
    67
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    68
    public String getMechanismName() {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    69
        return "EXTERNAL";
90ce3da70b43 Initial load
duke
parents:
diff changeset
    70
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    71
90ce3da70b43 Initial load
duke
parents:
diff changeset
    72
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    73
     * This mechanism has an initial response.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    74
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    75
    public boolean hasInitialResponse() {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    76
        return true;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    77
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    78
90ce3da70b43 Initial load
duke
parents:
diff changeset
    79
    public void dispose() throws SaslException {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    80
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    81
90ce3da70b43 Initial load
duke
parents:
diff changeset
    82
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    83
     * Processes the challenge data.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    84
     * It returns the EXTERNAL mechanism's initial response,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    85
     * which is the authorization id encoded in UTF-8.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    86
     * This is the optional information that is sent along with the SASL command.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    87
     * After this method is called, isComplete() returns true.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    88
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    89
     * @param challengeData Ignored.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    90
     * @return The possible empty initial response.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    91
     * @throws SaslException If authentication has already been called.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    92
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    93
    public byte[] evaluateChallenge(byte[] challengeData)
90ce3da70b43 Initial load
duke
parents:
diff changeset
    94
        throws SaslException {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    95
        if (completed) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    96
            throw new IllegalStateException(
90ce3da70b43 Initial load
duke
parents:
diff changeset
    97
                "EXTERNAL authentication already completed");
90ce3da70b43 Initial load
duke
parents:
diff changeset
    98
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    99
        completed = true;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   100
        return username;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   101
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   102
90ce3da70b43 Initial load
duke
parents:
diff changeset
   103
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   104
     * Returns whether this mechanism is complete.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   105
     * @return true if initial response has been sent; false otherwise.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   106
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   107
    public boolean isComplete() {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   108
        return completed;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   109
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   110
90ce3da70b43 Initial load
duke
parents:
diff changeset
   111
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   112
      * Unwraps the incoming buffer.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   113
      *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   114
      * @throws SaslException Not applicable to this mechanism.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   115
      */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   116
    public byte[] unwrap(byte[] incoming, int offset, int len)
90ce3da70b43 Initial load
duke
parents:
diff changeset
   117
        throws SaslException {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   118
        if (completed) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   119
            throw new SaslException("EXTERNAL has no supported QOP");
90ce3da70b43 Initial load
duke
parents:
diff changeset
   120
        } else {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   121
            throw new IllegalStateException(
90ce3da70b43 Initial load
duke
parents:
diff changeset
   122
                "EXTERNAL authentication Not completed");
90ce3da70b43 Initial load
duke
parents:
diff changeset
   123
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   124
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   125
90ce3da70b43 Initial load
duke
parents:
diff changeset
   126
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   127
      * Wraps the outgoing buffer.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   128
      *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   129
      * @throws SaslException Not applicable to this mechanism.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   130
      */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   131
    public byte[] wrap(byte[] outgoing, int offset, int len)
90ce3da70b43 Initial load
duke
parents:
diff changeset
   132
        throws SaslException {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   133
        if (completed) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   134
            throw new SaslException("EXTERNAL has no supported QOP");
90ce3da70b43 Initial load
duke
parents:
diff changeset
   135
        } else {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   136
            throw new IllegalStateException(
90ce3da70b43 Initial load
duke
parents:
diff changeset
   137
                "EXTERNAL authentication not completed");
90ce3da70b43 Initial load
duke
parents:
diff changeset
   138
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   139
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   140
90ce3da70b43 Initial load
duke
parents:
diff changeset
   141
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   142
     * Retrieves the negotiated property.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   143
     * This method can be called only after the authentication exchange has
32275
17eeb583a331 8133802: replace some <tt> tags (obsolete in html5) in security-libs docs
avstepan
parents: 25859
diff changeset
   144
     * completed (i.e., when {@code isComplete()} returns true);
17eeb583a331 8133802: replace some <tt> tags (obsolete in html5) in security-libs docs
avstepan
parents: 25859
diff changeset
   145
     * otherwise, an {@code IllegalStateException} is thrown.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   146
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   147
     * @return null No property is applicable to this mechanism.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   148
     * @exception IllegalStateException if this authentication exchange
90ce3da70b43 Initial load
duke
parents:
diff changeset
   149
     * has not completed
90ce3da70b43 Initial load
duke
parents:
diff changeset
   150
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   151
    public Object getNegotiatedProperty(String propName) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   152
        if (completed) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   153
            return null;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   154
        } else {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   155
            throw new IllegalStateException(
90ce3da70b43 Initial load
duke
parents:
diff changeset
   156
                "EXTERNAL authentication not completed");
90ce3da70b43 Initial load
duke
parents:
diff changeset
   157
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   158
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   159
}