jdk/src/share/classes/sun/security/util/Password.java
author weijun
Tue, 18 Aug 2009 10:20:50 +0800
changeset 3624 e214b718aeef
parent 2 90ce3da70b43
child 5506 202f599c92aa
permissions -rw-r--r--
6829785: TextCallbackHandler does not honor PasswordCallback.isEchoOn() Reviewed-by: mullan
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     1
/*
3624
e214b718aeef 6829785: TextCallbackHandler does not honor PasswordCallback.isEchoOn()
weijun
parents: 2
diff changeset
     2
 * Copyright 2003-2009 Sun Microsystems, Inc.  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
90ce3da70b43 Initial load
duke
parents:
diff changeset
     7
 * published by the Free Software Foundation.  Sun designates this
90ce3da70b43 Initial load
duke
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
90ce3da70b43 Initial load
duke
parents:
diff changeset
     9
 * by Sun in the LICENSE file that accompanied this code.
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
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    21
 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    22
 * CA 95054 USA or visit www.sun.com if you need additional information or
90ce3da70b43 Initial load
duke
parents:
diff changeset
    23
 * have any questions.
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 sun.security.util;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    27
90ce3da70b43 Initial load
duke
parents:
diff changeset
    28
import java.io.*;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    29
import java.nio.*;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    30
import java.nio.charset.*;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    31
import java.util.Arrays;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    32
90ce3da70b43 Initial load
duke
parents:
diff changeset
    33
/**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    34
 * A utility class for reading passwords
90ce3da70b43 Initial load
duke
parents:
diff changeset
    35
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    36
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    37
public class Password {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    38
    /** Reads user password from given input stream. */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    39
    public static char[] readPassword(InputStream in) throws IOException {
3624
e214b718aeef 6829785: TextCallbackHandler does not honor PasswordCallback.isEchoOn()
weijun
parents: 2
diff changeset
    40
        return readPassword(in, false);
e214b718aeef 6829785: TextCallbackHandler does not honor PasswordCallback.isEchoOn()
weijun
parents: 2
diff changeset
    41
    }
e214b718aeef 6829785: TextCallbackHandler does not honor PasswordCallback.isEchoOn()
weijun
parents: 2
diff changeset
    42
e214b718aeef 6829785: TextCallbackHandler does not honor PasswordCallback.isEchoOn()
weijun
parents: 2
diff changeset
    43
    /** Reads user password from given input stream.
e214b718aeef 6829785: TextCallbackHandler does not honor PasswordCallback.isEchoOn()
weijun
parents: 2
diff changeset
    44
     * @param isEchoOn true if the password should be echoed on the screen
e214b718aeef 6829785: TextCallbackHandler does not honor PasswordCallback.isEchoOn()
weijun
parents: 2
diff changeset
    45
     */
e214b718aeef 6829785: TextCallbackHandler does not honor PasswordCallback.isEchoOn()
weijun
parents: 2
diff changeset
    46
    public static char[] readPassword(InputStream in, boolean isEchoOn)
e214b718aeef 6829785: TextCallbackHandler does not honor PasswordCallback.isEchoOn()
weijun
parents: 2
diff changeset
    47
            throws IOException {
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    48
90ce3da70b43 Initial load
duke
parents:
diff changeset
    49
        char[] consoleEntered = null;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    50
        byte[] consoleBytes = null;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    51
90ce3da70b43 Initial load
duke
parents:
diff changeset
    52
        try {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    53
            // Use the new java.io.Console class
90ce3da70b43 Initial load
duke
parents:
diff changeset
    54
            Console con = null;
3624
e214b718aeef 6829785: TextCallbackHandler does not honor PasswordCallback.isEchoOn()
weijun
parents: 2
diff changeset
    55
            if (!isEchoOn && in == System.in && ((con = System.console()) != null)) {
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    56
                consoleEntered = con.readPassword();
90ce3da70b43 Initial load
duke
parents:
diff changeset
    57
                // readPassword returns "" if you just print ENTER,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    58
                // to be compatible with old Password class, change to null
90ce3da70b43 Initial load
duke
parents:
diff changeset
    59
                if (consoleEntered != null && consoleEntered.length == 0) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    60
                    return null;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    61
                }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    62
                consoleBytes = convertToBytes(consoleEntered);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    63
                in = new ByteArrayInputStream(consoleBytes);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    64
            }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    65
90ce3da70b43 Initial load
duke
parents:
diff changeset
    66
            // Rest of the lines still necessary for KeyStoreLoginModule
90ce3da70b43 Initial load
duke
parents:
diff changeset
    67
            // and when there is no console.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    68
90ce3da70b43 Initial load
duke
parents:
diff changeset
    69
            char[] lineBuffer;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    70
            char[] buf;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    71
            int i;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    72
90ce3da70b43 Initial load
duke
parents:
diff changeset
    73
            buf = lineBuffer = new char[128];
90ce3da70b43 Initial load
duke
parents:
diff changeset
    74
90ce3da70b43 Initial load
duke
parents:
diff changeset
    75
            int room = buf.length;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    76
            int offset = 0;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    77
            int c;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    78
90ce3da70b43 Initial load
duke
parents:
diff changeset
    79
            boolean done = false;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    80
            while (!done) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    81
                switch (c = in.read()) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    82
                  case -1:
90ce3da70b43 Initial load
duke
parents:
diff changeset
    83
                  case '\n':
90ce3da70b43 Initial load
duke
parents:
diff changeset
    84
                      done = true;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    85
                      break;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    86
90ce3da70b43 Initial load
duke
parents:
diff changeset
    87
                  case '\r':
90ce3da70b43 Initial load
duke
parents:
diff changeset
    88
                    int c2 = in.read();
90ce3da70b43 Initial load
duke
parents:
diff changeset
    89
                    if ((c2 != '\n') && (c2 != -1)) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    90
                        if (!(in instanceof PushbackInputStream)) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    91
                            in = new PushbackInputStream(in);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    92
                        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    93
                        ((PushbackInputStream)in).unread(c2);
90ce3da70b43 Initial load
duke
parents:
diff changeset
    94
                    } else {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    95
                        done = true;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    96
                        break;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    97
                    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    98
90ce3da70b43 Initial load
duke
parents:
diff changeset
    99
                  default:
90ce3da70b43 Initial load
duke
parents:
diff changeset
   100
                    if (--room < 0) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   101
                        buf = new char[offset + 128];
90ce3da70b43 Initial load
duke
parents:
diff changeset
   102
                        room = buf.length - offset - 1;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   103
                        System.arraycopy(lineBuffer, 0, buf, 0, offset);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   104
                        Arrays.fill(lineBuffer, ' ');
90ce3da70b43 Initial load
duke
parents:
diff changeset
   105
                        lineBuffer = buf;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   106
                    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   107
                    buf[offset++] = (char) c;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   108
                    break;
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
            if (offset == 0) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   113
                return null;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   114
            }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   115
90ce3da70b43 Initial load
duke
parents:
diff changeset
   116
            char[] ret = new char[offset];
90ce3da70b43 Initial load
duke
parents:
diff changeset
   117
            System.arraycopy(buf, 0, ret, 0, offset);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   118
            Arrays.fill(buf, ' ');
90ce3da70b43 Initial load
duke
parents:
diff changeset
   119
90ce3da70b43 Initial load
duke
parents:
diff changeset
   120
            return ret;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   121
        } finally {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   122
            if (consoleEntered != null) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   123
                Arrays.fill(consoleEntered, ' ');
90ce3da70b43 Initial load
duke
parents:
diff changeset
   124
            }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   125
            if (consoleBytes != null) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   126
                Arrays.fill(consoleBytes, (byte)0);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   127
            }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   128
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   129
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   130
90ce3da70b43 Initial load
duke
parents:
diff changeset
   131
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   132
     * Change a password read from Console.readPassword() into
90ce3da70b43 Initial load
duke
parents:
diff changeset
   133
     * its original bytes.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   134
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   135
     * @param pass a char[]
90ce3da70b43 Initial load
duke
parents:
diff changeset
   136
     * @return its byte[] format, similar to new String(pass).getBytes()
90ce3da70b43 Initial load
duke
parents:
diff changeset
   137
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   138
    private static byte[] convertToBytes(char[] pass) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   139
        if (enc == null) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   140
            synchronized (Password.class) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   141
                enc = sun.misc.SharedSecrets.getJavaIOAccess()
90ce3da70b43 Initial load
duke
parents:
diff changeset
   142
                        .charset()
90ce3da70b43 Initial load
duke
parents:
diff changeset
   143
                        .newEncoder()
90ce3da70b43 Initial load
duke
parents:
diff changeset
   144
                        .onMalformedInput(CodingErrorAction.REPLACE)
90ce3da70b43 Initial load
duke
parents:
diff changeset
   145
                        .onUnmappableCharacter(CodingErrorAction.REPLACE);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   146
            }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   147
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   148
        byte[] ba = new byte[(int)(enc.maxBytesPerChar() * pass.length)];
90ce3da70b43 Initial load
duke
parents:
diff changeset
   149
        ByteBuffer bb = ByteBuffer.wrap(ba);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   150
        synchronized (enc) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   151
            enc.reset().encode(CharBuffer.wrap(pass), bb, true);
90ce3da70b43 Initial load
duke
parents:
diff changeset
   152
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   153
        if (bb.position() < ba.length) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   154
            ba[bb.position()] = '\n';
90ce3da70b43 Initial load
duke
parents:
diff changeset
   155
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   156
        return ba;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   157
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   158
    private static volatile CharsetEncoder enc;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   159
}