jdk/src/java.base/share/classes/sun/security/ssl/SessionId.java
author jnimeh
Thu, 22 Jan 2015 20:19:42 -0800
changeset 28565 48712ca501c1
parent 25859 3317bb8137f4
child 31538 0981099a3e54
permissions -rw-r--r--
8044860: Vectors and fixed length fields should be verified for allowed sizes. Reviewed-by: xuelei
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     1
/*
23010
6dadb192ad81 8029235: Update copyright year to match last edit in jdk8 jdk repository for 2013
lana
parents: 14664
diff changeset
     2
 * Copyright (c) 1996, 2012, 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: 715
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: 715
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: 715
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 715
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 715
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
90ce3da70b43 Initial load
duke
parents:
diff changeset
    27
package sun.security.ssl;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    28
90ce3da70b43 Initial load
duke
parents:
diff changeset
    29
import java.security.SecureRandom;
28565
48712ca501c1 8044860: Vectors and fixed length fields should be verified for allowed sizes.
jnimeh
parents: 25859
diff changeset
    30
import javax.net.ssl.SSLProtocolException;
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    31
90ce3da70b43 Initial load
duke
parents:
diff changeset
    32
/**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    33
 * Encapsulates an SSL session ID.  SSL Session IDs are not reused by
90ce3da70b43 Initial load
duke
parents:
diff changeset
    34
 * servers during the lifetime of any sessions it created.  Sessions may
90ce3da70b43 Initial load
duke
parents:
diff changeset
    35
 * be used by many connections, either concurrently (for example, two
90ce3da70b43 Initial load
duke
parents:
diff changeset
    36
 * connections to a web server at the same time) or sequentially (over as
90ce3da70b43 Initial load
duke
parents:
diff changeset
    37
 * long a time period as is allowed by a given server).
90ce3da70b43 Initial load
duke
parents:
diff changeset
    38
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    39
 * @author Satish Dharmaraj
90ce3da70b43 Initial load
duke
parents:
diff changeset
    40
 * @author David Brownell
90ce3da70b43 Initial load
duke
parents:
diff changeset
    41
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    42
final
90ce3da70b43 Initial load
duke
parents:
diff changeset
    43
class SessionId
90ce3da70b43 Initial load
duke
parents:
diff changeset
    44
{
28565
48712ca501c1 8044860: Vectors and fixed length fields should be verified for allowed sizes.
jnimeh
parents: 25859
diff changeset
    45
    static int MAX_LENGTH = 32;
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    46
    private byte sessionId [];          // max 32 bytes
90ce3da70b43 Initial load
duke
parents:
diff changeset
    47
90ce3da70b43 Initial load
duke
parents:
diff changeset
    48
    /** Constructs a new session ID ... perhaps for a rejoinable session */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    49
    SessionId (boolean isRejoinable, SecureRandom generator)
90ce3da70b43 Initial load
duke
parents:
diff changeset
    50
    {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    51
        if (isRejoinable)
90ce3da70b43 Initial load
duke
parents:
diff changeset
    52
            // this will be unique, it's a timestamp plus much randomness
90ce3da70b43 Initial load
duke
parents:
diff changeset
    53
            sessionId = new RandomCookie (generator).random_bytes;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    54
        else
90ce3da70b43 Initial load
duke
parents:
diff changeset
    55
            sessionId = new byte [0];
90ce3da70b43 Initial load
duke
parents:
diff changeset
    56
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    57
90ce3da70b43 Initial load
duke
parents:
diff changeset
    58
    /** Constructs a session ID from a byte array (max size 32 bytes) */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    59
    SessionId (byte sessionId [])
90ce3da70b43 Initial load
duke
parents:
diff changeset
    60
        { this.sessionId = sessionId; }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    61
90ce3da70b43 Initial load
duke
parents:
diff changeset
    62
    /** Returns the length of the ID, in bytes */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    63
    int length ()
90ce3da70b43 Initial load
duke
parents:
diff changeset
    64
        { return sessionId.length; }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    65
90ce3da70b43 Initial load
duke
parents:
diff changeset
    66
    /** Returns the bytes in the ID.  May be an empty array.  */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    67
    byte [] getId ()
90ce3da70b43 Initial load
duke
parents:
diff changeset
    68
    {
51
6fe31bc95bbc 6600143: Remove another 450 unnecessary casts
martin
parents: 2
diff changeset
    69
        return sessionId.clone ();
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    70
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    71
90ce3da70b43 Initial load
duke
parents:
diff changeset
    72
    /** Returns the ID as a string */
14664
e71aa0962e70 8003950: Adds missing Override annotations and removes unnecessary imports in sun.security.ssl
xuelei
parents: 5506
diff changeset
    73
    @Override
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    74
    public String toString ()
90ce3da70b43 Initial load
duke
parents:
diff changeset
    75
    {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    76
        int             len = sessionId.length;
24969
afa6934dd8e8 8041679: Replace uses of StringBuffer with StringBuilder within core library classes
psandoz
parents: 23010
diff changeset
    77
        StringBuilder    sb = new StringBuilder (10 + 2 * len);
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    78
24969
afa6934dd8e8 8041679: Replace uses of StringBuffer with StringBuilder within core library classes
psandoz
parents: 23010
diff changeset
    79
        sb.append("{");
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    80
        for (int i = 0; i < len; i++) {
24969
afa6934dd8e8 8041679: Replace uses of StringBuffer with StringBuilder within core library classes
psandoz
parents: 23010
diff changeset
    81
            sb.append(0x0ff & sessionId[i]);
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    82
            if (i != (len - 1))
24969
afa6934dd8e8 8041679: Replace uses of StringBuffer with StringBuilder within core library classes
psandoz
parents: 23010
diff changeset
    83
                sb.append (", ");
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    84
        }
24969
afa6934dd8e8 8041679: Replace uses of StringBuffer with StringBuilder within core library classes
psandoz
parents: 23010
diff changeset
    85
        sb.append("}");
afa6934dd8e8 8041679: Replace uses of StringBuffer with StringBuilder within core library classes
psandoz
parents: 23010
diff changeset
    86
        return sb.toString ();
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    87
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
    88
90ce3da70b43 Initial load
duke
parents:
diff changeset
    89
90ce3da70b43 Initial load
duke
parents:
diff changeset
    90
    /** Returns a value which is the same for session IDs which are equal */
14664
e71aa0962e70 8003950: Adds missing Override annotations and removes unnecessary imports in sun.security.ssl
xuelei
parents: 5506
diff changeset
    91
    @Override
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    92
    public int hashCode ()
90ce3da70b43 Initial load
duke
parents:
diff changeset
    93
    {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    94
        int     retval = 0;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    95
90ce3da70b43 Initial load
duke
parents:
diff changeset
    96
        for (int i = 0; i < sessionId.length; i++)
90ce3da70b43 Initial load
duke
parents:
diff changeset
    97
            retval += sessionId [i];
90ce3da70b43 Initial load
duke
parents:
diff changeset
    98
        return retval;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    99
    }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   100
90ce3da70b43 Initial load
duke
parents:
diff changeset
   101
    /** Returns true if the parameter is the same session ID */
14664
e71aa0962e70 8003950: Adds missing Override annotations and removes unnecessary imports in sun.security.ssl
xuelei
parents: 5506
diff changeset
   102
    @Override
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   103
    public boolean equals (Object obj)
90ce3da70b43 Initial load
duke
parents:
diff changeset
   104
    {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   105
        if (!(obj instanceof SessionId))
90ce3da70b43 Initial load
duke
parents:
diff changeset
   106
            return false;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   107
90ce3da70b43 Initial load
duke
parents:
diff changeset
   108
        SessionId s = (SessionId) obj;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   109
        byte b [] = s.getId ();
90ce3da70b43 Initial load
duke
parents:
diff changeset
   110
90ce3da70b43 Initial load
duke
parents:
diff changeset
   111
        if (b.length != sessionId.length)
90ce3da70b43 Initial load
duke
parents:
diff changeset
   112
            return false;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   113
        for (int i = 0; i < sessionId.length; i++) {
90ce3da70b43 Initial load
duke
parents:
diff changeset
   114
            if (b [i] != sessionId [i])
90ce3da70b43 Initial load
duke
parents:
diff changeset
   115
                return false;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   116
        }
90ce3da70b43 Initial load
duke
parents:
diff changeset
   117
        return true;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   118
    }
28565
48712ca501c1 8044860: Vectors and fixed length fields should be verified for allowed sizes.
jnimeh
parents: 25859
diff changeset
   119
48712ca501c1 8044860: Vectors and fixed length fields should be verified for allowed sizes.
jnimeh
parents: 25859
diff changeset
   120
    /**
48712ca501c1 8044860: Vectors and fixed length fields should be verified for allowed sizes.
jnimeh
parents: 25859
diff changeset
   121
     * Checks the length of the session ID to make sure it sits within
48712ca501c1 8044860: Vectors and fixed length fields should be verified for allowed sizes.
jnimeh
parents: 25859
diff changeset
   122
     * the range called out in the specification
48712ca501c1 8044860: Vectors and fixed length fields should be verified for allowed sizes.
jnimeh
parents: 25859
diff changeset
   123
     */
48712ca501c1 8044860: Vectors and fixed length fields should be verified for allowed sizes.
jnimeh
parents: 25859
diff changeset
   124
    void checkLength(ProtocolVersion pv) throws SSLProtocolException {
48712ca501c1 8044860: Vectors and fixed length fields should be verified for allowed sizes.
jnimeh
parents: 25859
diff changeset
   125
        // As of today all versions of TLS have a 32-byte maximum length.
48712ca501c1 8044860: Vectors and fixed length fields should be verified for allowed sizes.
jnimeh
parents: 25859
diff changeset
   126
        // In the future we can do more here to support protocol versions
48712ca501c1 8044860: Vectors and fixed length fields should be verified for allowed sizes.
jnimeh
parents: 25859
diff changeset
   127
        // that may have longer max lengths.
48712ca501c1 8044860: Vectors and fixed length fields should be verified for allowed sizes.
jnimeh
parents: 25859
diff changeset
   128
        if (sessionId.length > MAX_LENGTH) {
48712ca501c1 8044860: Vectors and fixed length fields should be verified for allowed sizes.
jnimeh
parents: 25859
diff changeset
   129
            throw new SSLProtocolException("Invalid session ID length (" +
48712ca501c1 8044860: Vectors and fixed length fields should be verified for allowed sizes.
jnimeh
parents: 25859
diff changeset
   130
                    sessionId.length + " bytes)");
48712ca501c1 8044860: Vectors and fixed length fields should be verified for allowed sizes.
jnimeh
parents: 25859
diff changeset
   131
        }
48712ca501c1 8044860: Vectors and fixed length fields should be verified for allowed sizes.
jnimeh
parents: 25859
diff changeset
   132
    }
48712ca501c1 8044860: Vectors and fixed length fields should be verified for allowed sizes.
jnimeh
parents: 25859
diff changeset
   133
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   134
}