src/java.base/share/classes/sun/security/ssl/KAKeyDerivation.java
author apetcher
Mon, 20 Aug 2018 13:16:49 -0400
branchJDK-8171279-XDH-TLS-branch-2
changeset 56864 ec60669bc501
child 56871 bda6e40cd2f4
permissions -rw-r--r--
Factoring out some duplicate code.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
56864
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
     1
/*
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
     2
 * Copyright (c) 2018, Oracle and/or its affiliates. All rights reserved.
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
     4
 *
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    10
 *
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    15
 * accompanied this code).
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    16
 *
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    20
 *
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    23
 * questions.
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    24
 */
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    25
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    26
package sun.security.ssl;
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    27
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    28
import javax.crypto.KeyAgreement;
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    29
import javax.crypto.SecretKey;
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    30
import javax.crypto.spec.SecretKeySpec;
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    31
import javax.net.ssl.SSLHandshakeException;
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    32
import java.io.IOException;
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    33
import java.security.GeneralSecurityException;
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    34
import java.security.PrivateKey;
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    35
import java.security.PublicKey;
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    36
import java.security.spec.AlgorithmParameterSpec;
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    37
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    38
public class KAKeyDerivation implements SSLKeyDerivation {
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    39
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    40
    private final String algorithmName;
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    41
    private final HandshakeContext context;
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    42
    private final PrivateKey localPrivateKey;
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    43
    private final PublicKey peerPublicKey;
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    44
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    45
    KAKeyDerivation(String algorithmName,
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    46
                    HandshakeContext context,
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    47
                    PrivateKey localPrivateKey,
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    48
                    PublicKey peerPublicKey) {
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    49
        this.algorithmName = algorithmName;
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    50
        this.context = context;
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    51
        this.localPrivateKey = localPrivateKey;
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    52
        this.peerPublicKey = peerPublicKey;
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    53
    }
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    54
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    55
    @Override
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    56
    public SecretKey deriveKey(String algorithm,
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    57
                               AlgorithmParameterSpec params) throws IOException {
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    58
        if (!context.negotiatedProtocol.useTLS13PlusSpec()) {
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    59
            return t12DeriveKey(algorithm, params);
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    60
        } else {
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    61
            return t13DeriveKey(algorithm, params);
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    62
        }
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    63
    }
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    64
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    65
    private SecretKey t12DeriveKey(String algorithm,
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    66
                                   AlgorithmParameterSpec params) throws IOException {
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    67
        try {
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    68
            KeyAgreement ka = JsseJce.getKeyAgreement(algorithmName);
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    69
            ka.init(localPrivateKey);
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    70
            ka.doPhase(peerPublicKey, true);
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    71
            SecretKey preMasterSecret =
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    72
            ka.generateSecret("TlsPremasterSecret");
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    73
            SSLMasterKeyDerivation mskd =
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    74
            SSLMasterKeyDerivation.valueOf(
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    75
            context.negotiatedProtocol);
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    76
            if (mskd == null) {
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    77
                // unlikely
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    78
                throw new SSLHandshakeException(
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    79
                "No expected master key derivation for protocol: " +
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    80
                context.negotiatedProtocol.name);
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    81
            }
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    82
            SSLKeyDerivation kd = mskd.createKeyDerivation(
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    83
            context, preMasterSecret);
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    84
            return kd.deriveKey("MasterSecret", params);
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    85
        } catch (GeneralSecurityException gse) {
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    86
            throw (SSLHandshakeException) new SSLHandshakeException(
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    87
            "Could not generate secret").initCause(gse);
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    88
        }
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    89
    }
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    90
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    91
    private SecretKey t13DeriveKey(String algorithm,
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    92
                                   AlgorithmParameterSpec params) throws IOException {
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    93
        try {
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    94
            KeyAgreement ka = JsseJce.getKeyAgreement(algorithmName);
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    95
            ka.init(localPrivateKey);
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    96
            ka.doPhase(peerPublicKey, true);
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    97
            SecretKey sharedSecret =
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    98
            ka.generateSecret("TlsPremasterSecret");
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
    99
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
   100
            CipherSuite.HashAlg hashAlg = context.negotiatedCipherSuite.hashAlg;
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
   101
            SSLKeyDerivation kd = context.handshakeKeyDerivation;
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
   102
            HKDF hkdf = new HKDF(hashAlg.name);
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
   103
            if (kd == null) {   // No PSK is in use.
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
   104
                // If PSK is not in use Early Secret will still be
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
   105
                // HKDF-Extract(0, 0).
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
   106
                byte[] zeros = new byte[hashAlg.hashLength];
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
   107
                SecretKeySpec ikm =
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
   108
                new SecretKeySpec(zeros, "TlsPreSharedSecret");
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
   109
                SecretKey earlySecret =
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
   110
                hkdf.extract(zeros, ikm, "TlsEarlySecret");
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
   111
                kd = new SSLSecretDerivation(context, earlySecret);
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
   112
            }
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
   113
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
   114
            // derive salt secret
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
   115
            SecretKey saltSecret = kd.deriveKey("TlsSaltSecret", null);
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
   116
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
   117
            // derive handshake secret
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
   118
            return hkdf.extract(saltSecret, sharedSecret, algorithm);
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
   119
        } catch (GeneralSecurityException gse) {
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
   120
            throw (SSLHandshakeException) new SSLHandshakeException(
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
   121
            "Could not generate secret").initCause(gse);
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
   122
        }
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
   123
    }
ec60669bc501 Factoring out some duplicate code.
apetcher
parents:
diff changeset
   124
}