blob: 814b6182c94110400b610682740b0ad1e6e4d2ac [file] [log] [blame]
J. Duke319a3b92007-12-01 00:00:00 +00001/*
2 * Copyright 2005-2007 Sun Microsystems, Inc. All Rights Reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation. Sun designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Sun in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
22 * CA 95054 USA or visit www.sun.com if you need additional information or
23 * have any questions.
24 */
25
26package sun.security.internal.interfaces;
27
28import javax.crypto.SecretKey;
29
30/**
31 * An SSL/TLS master secret key. It is a <code>SecretKey</code> that optionally
32 * contains protocol version information that is used to detect version
33 * rollback attacks during the SSL/TLS handshake.
34 *
35 * <p>Implementation of this interface are returned by the
36 * <code>generateKey()</code> method of KeyGenerators of the type
37 * "TlsMasterSecret".
38 *
39 * @since 1.6
40 * @author Andreas Sterbenz
41 * @deprecated Sun JDK internal use only --- WILL BE REMOVED in Dolphin (JDK 7)
42 */
43@Deprecated
44public interface TlsMasterSecret extends SecretKey {
45
46 public static final long serialVersionUID = -461748105810469773L;
47
48 /**
49 * Returns the major version number encapsulated in the premaster secret
50 * this master secret was derived from, or -1 if it is not available.
51 *
52 * <p>This information will only usually only be available when RSA
53 * was used as the key exchange algorithm.
54 *
55 * @return the major version number, or -1 if it is not available
56 */
57 public int getMajorVersion();
58
59 /**
60 * Returns the minor version number encapsulated in the premaster secret
61 * this master secret was derived from, or -1 if it is not available.
62 *
63 * <p>This information will only usually only be available when RSA
64 * was used as the key exchange algorithm.
65 *
66 * @return the major version number, or -1 if it is not available
67 */
68 public int getMinorVersion();
69
70}