| // Copyright 2018 Google Inc. |
| // |
| // Licensed under the Apache License, Version 2.0 (the "License"); |
| // you may not use this file except in compliance with the License. |
| // You may obtain a copy of the License at |
| // |
| // http://www.apache.org/licenses/LICENSE-2.0 |
| // |
| // Unless required by applicable law or agreed to in writing, software |
| // distributed under the License is distributed on an "AS IS" BASIS, |
| // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| // See the License for the specific language governing permissions and |
| // limitations under the License. |
| // |
| //////////////////////////////////////////////////////////////////////////////// |
| |
| package com.google.crypto.tink.signature; |
| |
| import com.google.crypto.tink.KeyTemplate; |
| import com.google.crypto.tink.KeyTypeManager; |
| import com.google.crypto.tink.PrivateKeyTypeManager; |
| import com.google.crypto.tink.PublicKeySign; |
| import com.google.crypto.tink.Registry; |
| import com.google.crypto.tink.proto.HashType; |
| import com.google.crypto.tink.proto.KeyData.KeyMaterialType; |
| import com.google.crypto.tink.proto.RsaSsaPssKeyFormat; |
| import com.google.crypto.tink.proto.RsaSsaPssParams; |
| import com.google.crypto.tink.proto.RsaSsaPssPrivateKey; |
| import com.google.crypto.tink.proto.RsaSsaPssPublicKey; |
| import com.google.crypto.tink.signature.internal.SigUtil; |
| import com.google.crypto.tink.subtle.EngineFactory; |
| import com.google.crypto.tink.subtle.RsaSsaPssSignJce; |
| import com.google.crypto.tink.subtle.SelfKeyTestValidators; |
| import com.google.crypto.tink.subtle.Validators; |
| import com.google.protobuf.ByteString; |
| import com.google.protobuf.ExtensionRegistryLite; |
| import com.google.protobuf.InvalidProtocolBufferException; |
| import java.math.BigInteger; |
| import java.security.GeneralSecurityException; |
| import java.security.KeyPair; |
| import java.security.KeyPairGenerator; |
| import java.security.interfaces.RSAPrivateCrtKey; |
| import java.security.interfaces.RSAPublicKey; |
| import java.security.spec.RSAKeyGenParameterSpec; |
| import java.security.spec.RSAPrivateCrtKeySpec; |
| import java.security.spec.RSAPublicKeySpec; |
| import java.util.Collections; |
| import java.util.HashMap; |
| import java.util.Map; |
| |
| /** |
| * This key manager generates new {@code RsaSsaPssPrivateKey} keys and produces new instances of |
| * {@code RsaSsaPssSignJce}. |
| */ |
| public final class RsaSsaPssSignKeyManager |
| extends PrivateKeyTypeManager<RsaSsaPssPrivateKey, RsaSsaPssPublicKey> { |
| RsaSsaPssSignKeyManager() { |
| super( |
| RsaSsaPssPrivateKey.class, |
| RsaSsaPssPublicKey.class, |
| new KeyTypeManager.PrimitiveFactory<PublicKeySign, RsaSsaPssPrivateKey>( |
| PublicKeySign.class) { |
| @Override |
| public PublicKeySign getPrimitive(RsaSsaPssPrivateKey keyProto) |
| throws GeneralSecurityException { |
| java.security.KeyFactory kf = EngineFactory.KEY_FACTORY.getInstance("RSA"); |
| RSAPrivateCrtKey privateKey = |
| (RSAPrivateCrtKey) |
| kf.generatePrivate( |
| new RSAPrivateCrtKeySpec( |
| new BigInteger(1, keyProto.getPublicKey().getN().toByteArray()), |
| new BigInteger(1, keyProto.getPublicKey().getE().toByteArray()), |
| new BigInteger(1, keyProto.getD().toByteArray()), |
| new BigInteger(1, keyProto.getP().toByteArray()), |
| new BigInteger(1, keyProto.getQ().toByteArray()), |
| new BigInteger(1, keyProto.getDp().toByteArray()), |
| new BigInteger(1, keyProto.getDq().toByteArray()), |
| new BigInteger(1, keyProto.getCrt().toByteArray()))); |
| RsaSsaPssParams params = keyProto.getPublicKey().getParams(); |
| |
| RSAPublicKey publicKey = |
| (RSAPublicKey) |
| kf.generatePublic( |
| new RSAPublicKeySpec( |
| new BigInteger(1, keyProto.getPublicKey().getN().toByteArray()), |
| new BigInteger(1, keyProto.getPublicKey().getE().toByteArray()))); |
| SelfKeyTestValidators.validateRsaSsaPss( |
| privateKey, |
| publicKey, |
| SigUtil.toHashType(params.getSigHash()), |
| SigUtil.toHashType(params.getMgf1Hash()), |
| params.getSaltLength()); |
| return new RsaSsaPssSignJce( |
| privateKey, |
| SigUtil.toHashType(params.getSigHash()), |
| SigUtil.toHashType(params.getMgf1Hash()), |
| params.getSaltLength()); |
| } |
| }); |
| } |
| |
| @Override |
| public String getKeyType() { |
| return "type.googleapis.com/google.crypto.tink.RsaSsaPssPrivateKey"; |
| } |
| |
| @Override |
| public int getVersion() { |
| return 0; |
| } |
| |
| @Override |
| public RsaSsaPssPublicKey getPublicKey(RsaSsaPssPrivateKey privKeyProto) |
| throws GeneralSecurityException { |
| return privKeyProto.getPublicKey(); |
| } |
| |
| @Override |
| public KeyMaterialType keyMaterialType() { |
| return KeyMaterialType.ASYMMETRIC_PRIVATE; |
| } |
| |
| @Override |
| public RsaSsaPssPrivateKey parseKey(ByteString byteString) throws InvalidProtocolBufferException { |
| return RsaSsaPssPrivateKey.parseFrom(byteString, ExtensionRegistryLite.getEmptyRegistry()); |
| } |
| |
| @Override |
| public void validateKey(RsaSsaPssPrivateKey keyProto) throws GeneralSecurityException { |
| Validators.validateVersion(keyProto.getVersion(), getVersion()); |
| Validators.validateRsaModulusSize( |
| new BigInteger(1, keyProto.getPublicKey().getN().toByteArray()).bitLength()); |
| Validators.validateRsaPublicExponent( |
| new BigInteger(1, keyProto.getPublicKey().getE().toByteArray())); |
| SigUtil.validateRsaSsaPssParams(keyProto.getPublicKey().getParams()); |
| } |
| |
| @Override |
| public KeyFactory<RsaSsaPssKeyFormat, RsaSsaPssPrivateKey> keyFactory() { |
| return new KeyFactory<RsaSsaPssKeyFormat, RsaSsaPssPrivateKey>(RsaSsaPssKeyFormat.class) { |
| @Override |
| public void validateKeyFormat(RsaSsaPssKeyFormat format) throws GeneralSecurityException { |
| SigUtil.validateRsaSsaPssParams(format.getParams()); |
| Validators.validateRsaModulusSize(format.getModulusSizeInBits()); |
| Validators.validateRsaPublicExponent( |
| new BigInteger(1, format.getPublicExponent().toByteArray())); |
| } |
| |
| @Override |
| public RsaSsaPssKeyFormat parseKeyFormat(ByteString byteString) |
| throws InvalidProtocolBufferException { |
| return RsaSsaPssKeyFormat.parseFrom(byteString, ExtensionRegistryLite.getEmptyRegistry()); |
| } |
| |
| @Override |
| public RsaSsaPssPrivateKey createKey(RsaSsaPssKeyFormat format) |
| throws GeneralSecurityException { |
| RsaSsaPssParams params = format.getParams(); |
| Validators.validateRsaModulusSize(format.getModulusSizeInBits()); |
| Validators.validateSignatureHash(SigUtil.toHashType(params.getSigHash())); |
| KeyPairGenerator keyGen = EngineFactory.KEY_PAIR_GENERATOR.getInstance("RSA"); |
| RSAKeyGenParameterSpec spec = |
| new RSAKeyGenParameterSpec( |
| format.getModulusSizeInBits(), |
| new BigInteger(1, format.getPublicExponent().toByteArray())); |
| keyGen.initialize(spec); |
| KeyPair keyPair = keyGen.generateKeyPair(); |
| RSAPublicKey pubKey = (RSAPublicKey) keyPair.getPublic(); |
| RSAPrivateCrtKey privKey = (RSAPrivateCrtKey) keyPair.getPrivate(); |
| |
| // Creates RsaSsaPssPublicKey. |
| RsaSsaPssPublicKey pssPubKey = |
| RsaSsaPssPublicKey.newBuilder() |
| .setVersion(getVersion()) |
| .setParams(params) |
| .setE(ByteString.copyFrom(pubKey.getPublicExponent().toByteArray())) |
| .setN(ByteString.copyFrom(pubKey.getModulus().toByteArray())) |
| .build(); |
| |
| // Creates RsaSsaPssPrivateKey. |
| return RsaSsaPssPrivateKey.newBuilder() |
| .setVersion(getVersion()) |
| .setPublicKey(pssPubKey) |
| .setD(ByteString.copyFrom(privKey.getPrivateExponent().toByteArray())) |
| .setP(ByteString.copyFrom(privKey.getPrimeP().toByteArray())) |
| .setQ(ByteString.copyFrom(privKey.getPrimeQ().toByteArray())) |
| .setDp(ByteString.copyFrom(privKey.getPrimeExponentP().toByteArray())) |
| .setDq(ByteString.copyFrom(privKey.getPrimeExponentQ().toByteArray())) |
| .setCrt(ByteString.copyFrom(privKey.getCrtCoefficient().toByteArray())) |
| .build(); |
| } |
| |
| @Override |
| public Map<String, KeyFactory.KeyFormat<RsaSsaPssKeyFormat>> keyFormats() |
| throws GeneralSecurityException { |
| Map<String, KeyFactory.KeyFormat<RsaSsaPssKeyFormat>> result = new HashMap<>(); |
| result.put( |
| "RSA_SSA_PSS_3072_SHA256_F4", |
| new KeyFormat<>( |
| createKeyFormat( |
| HashType.SHA256, |
| HashType.SHA256, |
| /*saltLength=*/ 32, |
| /*modulusSize=*/ 3072, |
| RSAKeyGenParameterSpec.F4), |
| KeyTemplate.OutputPrefixType.TINK)); |
| result.put( |
| "RSA_SSA_PSS_3072_SHA256_F4_RAW", |
| new KeyFormat<>( |
| createKeyFormat( |
| HashType.SHA256, |
| HashType.SHA256, |
| /*saltLength=*/ 32, |
| /*modulusSize=*/ 3072, |
| RSAKeyGenParameterSpec.F4), |
| KeyTemplate.OutputPrefixType.RAW)); |
| // This is identical to RSA_SSA_PSS_3072_SHA256_F4. It is needed to maintain backward |
| // compatibility with SignatureKeyTemplates. |
| // TODO(b/185475349): remove this in Tink 2.0.0. |
| result.put( |
| "RSA_SSA_PSS_3072_SHA256_SHA256_32_F4", |
| new KeyFormat<>( |
| createKeyFormat( |
| HashType.SHA256, |
| HashType.SHA256, |
| /*saltLength=*/ 32, |
| /*modulusSize=*/ 3072, |
| RSAKeyGenParameterSpec.F4), |
| KeyTemplate.OutputPrefixType.TINK)); |
| |
| result.put( |
| "RSA_SSA_PSS_4096_SHA512_F4", |
| new KeyFormat<>( |
| createKeyFormat( |
| HashType.SHA512, |
| HashType.SHA512, |
| /*saltLength=*/ 64, |
| /*modulusSize=*/ 4096, |
| RSAKeyGenParameterSpec.F4), |
| KeyTemplate.OutputPrefixType.TINK)); |
| result.put( |
| "RSA_SSA_PSS_4096_SHA512_F4_RAW", |
| new KeyFormat<>( |
| createKeyFormat( |
| HashType.SHA512, |
| HashType.SHA512, |
| /*saltLength=*/ 64, |
| /*modulusSize=*/ 4096, |
| RSAKeyGenParameterSpec.F4), |
| KeyTemplate.OutputPrefixType.RAW)); |
| // This is identical to RSA_SSA_PSS_4096_SHA512_F4. It is needed to maintain backward |
| // compatibility with SignatureKeyTemplates. |
| // TODO(b/185475349): remove this in Tink 2.0.0. |
| result.put( |
| "RSA_SSA_PSS_4096_SHA512_SHA512_64_F4", |
| new KeyFormat<>( |
| createKeyFormat( |
| HashType.SHA512, |
| HashType.SHA512, |
| /*saltLength=*/ 64, |
| /*modulusSize=*/ 4096, |
| RSAKeyGenParameterSpec.F4), |
| KeyTemplate.OutputPrefixType.TINK)); |
| return Collections.unmodifiableMap(result); |
| } |
| }; |
| } |
| |
| /** |
| * Registers the {@link RsaSsaPssSignKeyManager} and the {@link RsaSsaPssVerifyKeyManager} with |
| * the registry, so that the the RsaSsaPss-Keys can be used with Tink. |
| */ |
| public static void registerPair(boolean newKeyAllowed) throws GeneralSecurityException { |
| Registry.registerAsymmetricKeyManagers( |
| new RsaSsaPssSignKeyManager(), new RsaSsaPssVerifyKeyManager(), newKeyAllowed); |
| } |
| |
| /** |
| * @return A {@link KeyTemplate} that generates new instances of RSA-SSA-PSS key pairs with the |
| * following parameters: |
| * <ul> |
| * <li>Signature hash: SHA256. |
| * <li>MGF1 hash: SHA256. |
| * <li>Salt length: 32 (i.e., SHA256's output length). |
| * <li>Modulus size: 3072 bit. |
| * <li>Public exponent: 65537 (aka F4). |
| * <li>Prefix type: {@link KeyTemplate.OutputPrefixType#TINK}. |
| * </ul> |
| * @deprecated use {@code KeyTemplates.get("RSA_SSA_PSS_3072_SHA256_F4")} |
| */ |
| @Deprecated |
| public static final KeyTemplate rsa3072PssSha256F4Template() { |
| return createKeyTemplate( |
| HashType.SHA256, |
| HashType.SHA256, |
| /*saltLength=*/ 32, |
| /*modulusSize=*/ 3072, |
| RSAKeyGenParameterSpec.F4, |
| KeyTemplate.OutputPrefixType.TINK); |
| } |
| /** |
| * @return A {@link KeyTemplate} that generates new instances of RSA-SSA-PSS key pairs with the |
| * following parameters: |
| * <ul> |
| * <li>Signature hash: SHA256. |
| * <li>MGF1 hash: SHA256. |
| * <li>Salt length: 32 (i.e., SHA256's output length). |
| * <li>Modulus size: 3072 bit. |
| * <li>Public exponent: 65537 (aka F4). |
| * <li>Prefix type: {@link KeyTemplate.OutputPrefixType#RAW} (no prefix). |
| * </ul> |
| * <p>Keys generated from this template create signatures compatible with OpenSSL and other |
| * libraries. |
| * @deprecated use {@code KeyTemplates.get("RSA_SSA_PSS_3072_SHA256_F4_RAW")} |
| */ |
| @Deprecated |
| public static final KeyTemplate rawRsa3072PssSha256F4Template() { |
| return createKeyTemplate( |
| HashType.SHA256, |
| HashType.SHA256, |
| /*saltLength=*/ 32, |
| /*modulusSize=*/ 3072, |
| RSAKeyGenParameterSpec.F4, |
| KeyTemplate.OutputPrefixType.RAW); |
| } |
| |
| /** |
| * @return A {@link KeyTemplate} that generates new instances of RSA-SSA-PSS key pairs with the |
| * following parameters: |
| * <ul> |
| * <li>Signature hash: SHA512. |
| * <li>MGF1 hash: SHA512. |
| * <li>Salt length: 64 (i.e., SHA512's output length). |
| * <li>Modulus size: 4096 bit. |
| * <li>Public exponent: 65537 (aka F4). |
| * <li>Prefix type: {@link KeyTemplate.OutputPrefixType#TINK}. |
| * </ul> |
| * @deprecated use {@code KeyTemplates.get("RSA_SSA_PSS_4096_SHA512_F4")} |
| */ |
| @Deprecated |
| public static final KeyTemplate rsa4096PssSha512F4Template() { |
| return createKeyTemplate( |
| HashType.SHA512, |
| HashType.SHA512, |
| /*saltLength=*/ 64, |
| /*modulusSize=*/ 4096, |
| RSAKeyGenParameterSpec.F4, |
| KeyTemplate.OutputPrefixType.TINK); |
| } |
| |
| /** |
| * @return A {@link KeyTemplate} that generates new instances of RSA-SSA-PSS key pairs with the |
| * following parameters: |
| * <ul> |
| * <li>Signature hash: SHA512. |
| * <li>MGF1 hash: SHA512. |
| * <li>Salt length: 64 (i.e., SHA512's output length). |
| * <li>Modulus size: 4096 bit. |
| * <li>Public exponent: 65537 (aka F4). |
| * <li>Prefix type: {@link KeyTemplate.OutputPrefixType#RAW} (no prefix). |
| * </ul> |
| * <p>Keys generated from this template create signatures compatible with OpenSSL and other |
| * libraries. |
| * @deprecated use {@code KeyTemplates.get("RSA_SSA_PSS_4096_SHA512_F4_RAW")} |
| */ |
| @Deprecated |
| public static final KeyTemplate rawRsa4096PssSha512F4Template() { |
| return createKeyTemplate( |
| HashType.SHA512, |
| HashType.SHA512, |
| /*saltLength=*/ 64, |
| /*modulusSize=*/ 4096, |
| RSAKeyGenParameterSpec.F4, |
| KeyTemplate.OutputPrefixType.RAW); |
| } |
| |
| /** |
| * @return a {@link KeyTemplate} containing a {@link RsaSsaPssKeyFormat} with some specified |
| * parameters. |
| */ |
| private static KeyTemplate createKeyTemplate( |
| HashType sigHash, |
| HashType mgf1Hash, |
| int saltLength, |
| int modulusSize, |
| BigInteger publicExponent, |
| KeyTemplate.OutputPrefixType prefixType) { |
| RsaSsaPssKeyFormat format = |
| createKeyFormat(sigHash, mgf1Hash, saltLength, modulusSize, publicExponent); |
| return KeyTemplate.create( |
| new RsaSsaPssSignKeyManager().getKeyType(), format.toByteArray(), prefixType); |
| } |
| |
| private static RsaSsaPssKeyFormat createKeyFormat( |
| HashType sigHash, |
| HashType mgf1Hash, |
| int saltLength, |
| int modulusSize, |
| BigInteger publicExponent) { |
| RsaSsaPssParams params = |
| RsaSsaPssParams.newBuilder() |
| .setSigHash(sigHash) |
| .setMgf1Hash(mgf1Hash) |
| .setSaltLength(saltLength) |
| .build(); |
| return RsaSsaPssKeyFormat.newBuilder() |
| .setParams(params) |
| .setModulusSizeInBits(modulusSize) |
| .setPublicExponent(ByteString.copyFrom(publicExponent.toByteArray())) |
| .build(); |
| } |
| } |
