mirror of
https://github.com/openjdk/jdk.git
synced 2026-02-03 23:18:28 +00:00
aafb2b0474
TLS v1.2 algorithms for key and MAC derivation added to SunPKCS11 crypto provider. Reviewed-by: valeriep
246 lines
9.4 KiB
Java
246 lines
9.4 KiB
Java
/*
|
|
* Copyright (c) 2005, 2018, Oracle and/or its affiliates. All rights reserved.
|
|
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
|
|
*
|
|
* This code is free software; you can redistribute it and/or modify it
|
|
* under the terms of the GNU General Public License version 2 only, as
|
|
* published by the Free Software Foundation. Oracle designates this
|
|
* particular file as subject to the "Classpath" exception as provided
|
|
* by Oracle in the LICENSE file that accompanied this code.
|
|
*
|
|
* This code is distributed in the hope that it will be useful, but WITHOUT
|
|
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
|
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
|
* version 2 for more details (a copy is included in the LICENSE file that
|
|
* accompanied this code).
|
|
*
|
|
* You should have received a copy of the GNU General Public License version
|
|
* 2 along with this work; if not, write to the Free Software Foundation,
|
|
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
|
|
*
|
|
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
|
|
* or visit www.oracle.com if you need additional information or have any
|
|
* questions.
|
|
*/
|
|
|
|
package sun.security.pkcs11;
|
|
|
|
import java.util.*;
|
|
|
|
import java.security.*;
|
|
import java.security.spec.AlgorithmParameterSpec;
|
|
|
|
import javax.crypto.*;
|
|
import javax.crypto.spec.*;
|
|
|
|
import sun.security.internal.spec.*;
|
|
import sun.security.internal.interfaces.TlsMasterSecret;
|
|
|
|
import static sun.security.pkcs11.TemplateManager.*;
|
|
import sun.security.pkcs11.wrapper.*;
|
|
|
|
import static sun.security.pkcs11.wrapper.PKCS11Constants.*;
|
|
|
|
/**
|
|
* KeyGenerator to calculate the SSL/TLS key material (cipher keys and ivs,
|
|
* mac keys) from the master secret.
|
|
*
|
|
* @author Andreas Sterbenz
|
|
* @since 1.6
|
|
*/
|
|
public final class P11TlsKeyMaterialGenerator extends KeyGeneratorSpi {
|
|
|
|
private final static String MSG = "TlsKeyMaterialGenerator must be "
|
|
+ "initialized using a TlsKeyMaterialParameterSpec";
|
|
|
|
// token instance
|
|
private final Token token;
|
|
|
|
// algorithm name
|
|
private final String algorithm;
|
|
|
|
// mechanism id
|
|
private long mechanism;
|
|
|
|
private int tlsVersion;
|
|
|
|
// parameter spec
|
|
@SuppressWarnings("deprecation")
|
|
private TlsKeyMaterialParameterSpec spec;
|
|
|
|
// master secret as a P11Key
|
|
private P11Key p11Key;
|
|
|
|
// whether SSLv3 is supported
|
|
private final boolean supportSSLv3;
|
|
|
|
P11TlsKeyMaterialGenerator(Token token, String algorithm, long mechanism)
|
|
throws PKCS11Exception {
|
|
super();
|
|
this.token = token;
|
|
this.algorithm = algorithm;
|
|
this.mechanism = mechanism;
|
|
|
|
// Given the current lookup order specified in SunPKCS11.java,
|
|
// if CKM_SSL3_KEY_AND_MAC_DERIVE is not used to construct this object,
|
|
// it means that this mech is disabled or unsupported.
|
|
this.supportSSLv3 = (mechanism == CKM_SSL3_KEY_AND_MAC_DERIVE);
|
|
}
|
|
|
|
protected void engineInit(SecureRandom random) {
|
|
throw new InvalidParameterException(MSG);
|
|
}
|
|
|
|
@SuppressWarnings("deprecation")
|
|
protected void engineInit(AlgorithmParameterSpec params,
|
|
SecureRandom random) throws InvalidAlgorithmParameterException {
|
|
if (params instanceof TlsKeyMaterialParameterSpec == false) {
|
|
throw new InvalidAlgorithmParameterException(MSG);
|
|
}
|
|
|
|
TlsKeyMaterialParameterSpec spec = (TlsKeyMaterialParameterSpec)params;
|
|
tlsVersion = (spec.getMajorVersion() << 8) | spec.getMinorVersion();
|
|
|
|
if ((tlsVersion == 0x0300 && !supportSSLv3) ||
|
|
(tlsVersion < 0x0300) || (tlsVersion > 0x0303)) {
|
|
throw new InvalidAlgorithmParameterException
|
|
("Only" + (supportSSLv3? " SSL 3.0,": "") +
|
|
" TLS 1.0, TLS 1.1 and TLS 1.2 are supported (" +
|
|
tlsVersion + ")");
|
|
}
|
|
try {
|
|
p11Key = P11SecretKeyFactory.convertKey
|
|
(token, spec.getMasterSecret(), "TlsMasterSecret");
|
|
} catch (InvalidKeyException e) {
|
|
throw new InvalidAlgorithmParameterException("init() failed", e);
|
|
}
|
|
this.spec = spec;
|
|
if (tlsVersion == 0x0300) {
|
|
mechanism = CKM_SSL3_KEY_AND_MAC_DERIVE;
|
|
} else if (tlsVersion == 0x0301 || tlsVersion == 0x0302) {
|
|
mechanism = CKM_TLS_KEY_AND_MAC_DERIVE;
|
|
}
|
|
}
|
|
|
|
protected void engineInit(int keysize, SecureRandom random) {
|
|
throw new InvalidParameterException(MSG);
|
|
}
|
|
|
|
@SuppressWarnings("deprecation")
|
|
protected SecretKey engineGenerateKey() {
|
|
if (spec == null) {
|
|
throw new IllegalStateException
|
|
("TlsKeyMaterialGenerator must be initialized");
|
|
}
|
|
int macBits = spec.getMacKeyLength() << 3;
|
|
int ivBits = spec.getIvLength() << 3;
|
|
|
|
int expandedKeyBits = spec.getExpandedCipherKeyLength() << 3;
|
|
int keyBits = spec.getCipherKeyLength() << 3;
|
|
boolean isExportable;
|
|
if (expandedKeyBits != 0) {
|
|
isExportable = true;
|
|
} else {
|
|
isExportable = false;
|
|
expandedKeyBits = keyBits;
|
|
}
|
|
|
|
CK_SSL3_RANDOM_DATA random = new CK_SSL3_RANDOM_DATA
|
|
(spec.getClientRandom(), spec.getServerRandom());
|
|
Object params = null;
|
|
CK_MECHANISM ckMechanism = null;
|
|
if (tlsVersion < 0x0303) {
|
|
params = new CK_SSL3_KEY_MAT_PARAMS
|
|
(macBits, keyBits, ivBits, isExportable, random);
|
|
ckMechanism = new CK_MECHANISM(mechanism, (CK_SSL3_KEY_MAT_PARAMS)params);
|
|
} else if (tlsVersion == 0x0303) {
|
|
params = new CK_TLS12_KEY_MAT_PARAMS
|
|
(macBits, keyBits, ivBits, isExportable, random,
|
|
Functions.getHashMechId(spec.getPRFHashAlg()));
|
|
ckMechanism = new CK_MECHANISM(mechanism, (CK_TLS12_KEY_MAT_PARAMS)params);
|
|
}
|
|
|
|
String cipherAlgorithm = spec.getCipherAlgorithm();
|
|
long keyType = P11SecretKeyFactory.getKeyType(cipherAlgorithm);
|
|
if (keyType < 0) {
|
|
if (keyBits != 0) {
|
|
throw new ProviderException
|
|
("Unknown algorithm: " + spec.getCipherAlgorithm());
|
|
} else {
|
|
// NULL encryption ciphersuites
|
|
keyType = CKK_GENERIC_SECRET;
|
|
}
|
|
}
|
|
|
|
Session session = null;
|
|
try {
|
|
session = token.getObjSession();
|
|
CK_ATTRIBUTE[] attributes;
|
|
if (keyBits != 0) {
|
|
attributes = new CK_ATTRIBUTE[] {
|
|
new CK_ATTRIBUTE(CKA_CLASS, CKO_SECRET_KEY),
|
|
new CK_ATTRIBUTE(CKA_KEY_TYPE, keyType),
|
|
new CK_ATTRIBUTE(CKA_VALUE_LEN, expandedKeyBits >> 3),
|
|
};
|
|
} else {
|
|
// ciphersuites with NULL ciphers
|
|
attributes = new CK_ATTRIBUTE[0];
|
|
}
|
|
attributes = token.getAttributes
|
|
(O_GENERATE, CKO_SECRET_KEY, keyType, attributes);
|
|
// the returned keyID is a dummy, ignore
|
|
token.p11.C_DeriveKey(session.id(),
|
|
ckMechanism, p11Key.keyID, attributes);
|
|
|
|
CK_SSL3_KEY_MAT_OUT out = null;
|
|
if (params instanceof CK_SSL3_KEY_MAT_PARAMS) {
|
|
out = ((CK_SSL3_KEY_MAT_PARAMS)params).pReturnedKeyMaterial;
|
|
} else if (params instanceof CK_TLS12_KEY_MAT_PARAMS) {
|
|
out = ((CK_TLS12_KEY_MAT_PARAMS)params).pReturnedKeyMaterial;
|
|
}
|
|
// Note that the MAC keys do not inherit all attributes from the
|
|
// template, but they do inherit the sensitive/extractable/token
|
|
// flags, which is all P11Key cares about.
|
|
SecretKey clientMacKey, serverMacKey;
|
|
|
|
// The MAC size may be zero for GCM mode.
|
|
//
|
|
// PKCS11 does not support GCM mode as the author made the comment,
|
|
// so the macBits is unlikely to be zero. It's only a place holder.
|
|
if (macBits != 0) {
|
|
clientMacKey = P11Key.secretKey
|
|
(session, out.hClientMacSecret, "MAC", macBits, attributes);
|
|
serverMacKey = P11Key.secretKey
|
|
(session, out.hServerMacSecret, "MAC", macBits, attributes);
|
|
} else {
|
|
clientMacKey = null;
|
|
serverMacKey = null;
|
|
}
|
|
|
|
SecretKey clientCipherKey, serverCipherKey;
|
|
if (keyBits != 0) {
|
|
clientCipherKey = P11Key.secretKey(session, out.hClientKey,
|
|
cipherAlgorithm, expandedKeyBits, attributes);
|
|
serverCipherKey = P11Key.secretKey(session, out.hServerKey,
|
|
cipherAlgorithm, expandedKeyBits, attributes);
|
|
} else {
|
|
clientCipherKey = null;
|
|
serverCipherKey = null;
|
|
}
|
|
IvParameterSpec clientIv = (out.pIVClient == null)
|
|
? null : new IvParameterSpec(out.pIVClient);
|
|
IvParameterSpec serverIv = (out.pIVServer == null)
|
|
? null : new IvParameterSpec(out.pIVServer);
|
|
|
|
return new TlsKeyMaterialSpec(clientMacKey, serverMacKey,
|
|
clientCipherKey, clientIv, serverCipherKey, serverIv);
|
|
|
|
} catch (Exception e) {
|
|
throw new ProviderException("Could not generate key", e);
|
|
} finally {
|
|
token.releaseSession(session);
|
|
}
|
|
}
|
|
|
|
}
|