com.google.crypto.tink.signature.PredefinedSignatureParameters Maven / Gradle / Ivy
// Copyright 2023 Google LLC
//
// 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 static com.google.crypto.tink.internal.TinkBugException.exceptionIsBug;
/**
* Pre-generated {@link Parameter} objects for {@link com.google.crypto.tink.PublicKeySign} and
* {@link com.google.crypto.tink.PublicKeyVerify}. keys.
*
* Note: if you want to keep dependencies small, consider inlining the constants here.
*/
public final class PredefinedSignatureParameters {
/**
* A {@link Parameters} object that generates new instances of {@link EcdsaPrivateKey} objects
* with the following parameters:
*
*
* - Hash function: SHA256
*
- Curve: NIST P-256
*
- Signature encoding: DER (this is the encoding that Java uses).
*
- Prefix type: {@link OutputPrefixType.TINK}
*
*/
public static final EcdsaParameters ECDSA_P256 =
exceptionIsBug(
() ->
EcdsaParameters.builder()
.setHashType(EcdsaParameters.HashType.SHA256)
.setCurveType(EcdsaParameters.CurveType.NIST_P256)
.setSignatureEncoding(EcdsaParameters.SignatureEncoding.DER)
.setVariant(EcdsaParameters.Variant.TINK)
.build());
/**
* A {@link Parameters} that generates new instances of {@link EcdsaPrivateKey} objects with the
* following parameters:
*
*
* - Hash function: SHA512
*
- Curve: NIST P-384
*
- Signature encoding: DER (this is the encoding that Java uses).
*
- Prefix type: {@link OutputPrefixType.TINK}
*
*/
public static final EcdsaParameters ECDSA_P384 =
exceptionIsBug(
() ->
EcdsaParameters.builder()
.setHashType(EcdsaParameters.HashType.SHA512)
.setCurveType(EcdsaParameters.CurveType.NIST_P384)
.setSignatureEncoding(EcdsaParameters.SignatureEncoding.DER)
.setVariant(EcdsaParameters.Variant.TINK)
.build());
/**
* A {@link Parameters} that generates new instances of {@link EcdsaPrivateKey} objects with the
* following parameters:
*
*
* - Hash function: SHA512
*
- Curve: NIST P-521
*
- Signature encoding: DER (this is the encoding that Java uses).
*
- Prefix type: {@link OutputPrefixType.TINK}
*
*/
public static final EcdsaParameters ECDSA_P521 =
exceptionIsBug(
() ->
EcdsaParameters.builder()
.setHashType(EcdsaParameters.HashType.SHA512)
.setCurveType(EcdsaParameters.CurveType.NIST_P521)
.setSignatureEncoding(EcdsaParameters.SignatureEncoding.DER)
.setVariant(EcdsaParameters.Variant.TINK)
.build());
/**
* A {@link Parameters} that generates new instances of {@link EcdsaPrivateKey} objects with the
* following parameters:
*
*
* - Hash function: SHA256
*
- Curve: NIST P-256
*
- Signature encoding: IEEE_P1363 (this is the encoding that JWS and WebCrypto use).
*
- Prefix type: {@link OutputPrefixType.TINK}
*
*/
public static final EcdsaParameters ECDSA_P256_IEEE_P1363 =
exceptionIsBug(
() ->
EcdsaParameters.builder()
.setSignatureEncoding(EcdsaParameters.SignatureEncoding.IEEE_P1363)
.setCurveType(EcdsaParameters.CurveType.NIST_P256)
.setHashType(EcdsaParameters.HashType.SHA256)
.setVariant(EcdsaParameters.Variant.TINK)
.build());
/**
* A {@link Parameters} that generates new instances of {@link EcdsaPrivateKey} objects with the
* following parameters:
*
*
* - Hash function: SHA512
*
- Curve: NIST P-384
*
- Signature encoding: IEEE_P1363 (this is the encoding that JWS and WebCrypto use).
*
- Prefix type: {@link OutputPrefixType.TINK}
*
*/
public static final EcdsaParameters ECDSA_P384_IEEE_P1363 =
exceptionIsBug(
() ->
EcdsaParameters.builder()
.setSignatureEncoding(EcdsaParameters.SignatureEncoding.IEEE_P1363)
.setCurveType(EcdsaParameters.CurveType.NIST_P384)
.setHashType(EcdsaParameters.HashType.SHA512)
.setVariant(EcdsaParameters.Variant.TINK)
.build());
/**
* A {@link Parameters} that generates new instances of {@link EcdsaPrivateKey} objects with the
* following parameters:
*
*
* - Hash function: SHA256
*
- Curve: NIST P-256
*
- Signature encoding: DER (this is the encoding that Java uses).
*
- Prefix type: None
*
*
* The digital signature generated by this key would be 64 bytes exactly.
*/
public static final EcdsaParameters ECDSA_P256_IEEE_P1363_WITHOUT_PREFIX =
exceptionIsBug(
() ->
EcdsaParameters.builder()
.setSignatureEncoding(EcdsaParameters.SignatureEncoding.IEEE_P1363)
.setCurveType(EcdsaParameters.CurveType.NIST_P256)
.setHashType(EcdsaParameters.HashType.SHA256)
.setVariant(EcdsaParameters.Variant.NO_PREFIX)
.build());
/**
* A {@link Parameters} that generates new instances of {@link EcdsaPrivateKey} objects with the
* following parameters:
*
*
* - Hash function: SHA512
*
- Curve: NIST P-521
*
- Signature encoding: IEEE_P1363 (this is the encoding that JWS and WebCrypto use).
*
- Prefix type: {@link OutputPrefixType.TINK}
*
*/
public static final EcdsaParameters ECDSA_P521_IEEE_P1363 =
exceptionIsBug(
() ->
EcdsaParameters.builder()
.setHashType(EcdsaParameters.HashType.SHA512)
.setCurveType(EcdsaParameters.CurveType.NIST_P521)
.setSignatureEncoding(EcdsaParameters.SignatureEncoding.IEEE_P1363)
.setVariant(EcdsaParameters.Variant.TINK)
.build());
/**
* A {@link Parameters} that generates new instances of {@link Ed25519PrivateKey} objects.
*
* @since 1.1.0
*/
public static final Ed25519Parameters ED25519 =
exceptionIsBug(() -> Ed25519Parameters.create(Ed25519Parameters.Variant.TINK));
/**
* A {@link Parameters} that generates new instances of {@link ED25519PrivateKey}.
*
* The difference between {@link ED25519WithRawOutput} and {@link ED25519} is the format of
* signatures generated. {@link ED25519WithRawOutput} generates signatures of {@link
* OutputPrefixType.RAW} format, which is 64 bytes long.
*
* @since 1.3.0
*/
public static final Ed25519Parameters ED25519WithRawOutput =
exceptionIsBug(() -> Ed25519Parameters.create(Ed25519Parameters.Variant.NO_PREFIX));
/**
* A {@link Parameters} that generates new instances of {@link RsaSsaPkcs1PrivateKey} objects with
* the following parameters:
*
*
* - Hash function: SHA256.
*
- Modulus size: 3072 bit.
*
- Public exponent: 65537 (aka F4).
*
- Prefix type: {@link OutputPrefixType.TINK}
*
*/
public static final RsaSsaPkcs1Parameters RSA_SSA_PKCS1_3072_SHA256_F4 =
exceptionIsBug(
() ->
RsaSsaPkcs1Parameters.builder()
.setHashType(RsaSsaPkcs1Parameters.HashType.SHA256)
.setModulusSizeBits(3072)
.setPublicExponent(RsaSsaPkcs1Parameters.F4)
.setVariant(RsaSsaPkcs1Parameters.Variant.TINK)
.build());
/**
* A {@link Parameters} that generates new instances of {@link RsaSsaPkcs1PrivateKey} objects with
* the following parameters:
*
*
* - Hash function: SHA256.
*
- Modulus size: 3072 bit.
*
- Public exponent: 65537 (aka F4).
*
- Prefix type: None
*
*/
public static final RsaSsaPkcs1Parameters RSA_SSA_PKCS1_3072_SHA256_F4_WITHOUT_PREFIX =
exceptionIsBug(
() ->
RsaSsaPkcs1Parameters.builder()
.setHashType(RsaSsaPkcs1Parameters.HashType.SHA256)
.setModulusSizeBits(3072)
.setPublicExponent(RsaSsaPkcs1Parameters.F4)
.setVariant(RsaSsaPkcs1Parameters.Variant.NO_PREFIX)
.build());
/**
* A {@link Parameters} that generates new instances of {@link RsaSsaPkcs1PrivateKey} objects with
* the following parameters:
*
*
* - Hash function: SHA512.
*
- Modulus size: 4096 bit.
*
- Public exponent: 65537 (aka F4).
*
- Prefix type: {@link OutputPrefixType.TINK}
*
*/
public static final RsaSsaPkcs1Parameters RSA_SSA_PKCS1_4096_SHA512_F4 =
exceptionIsBug(
() ->
RsaSsaPkcs1Parameters.builder()
.setHashType(RsaSsaPkcs1Parameters.HashType.SHA512)
.setModulusSizeBits(4096)
.setPublicExponent(RsaSsaPkcs1Parameters.F4)
.setVariant(RsaSsaPkcs1Parameters.Variant.TINK)
.build());
/**
* A {@link Parameters} that generates new instances of {@link RsaSsaPssPrivateKey} objects with
* the following parameters:
*
*
* - Signature hash: SHA256.
*
- MGF1 hash: SHA256.
*
- Salt length: 32 (i.e., SHA256's output length).
*
- Modulus size: 3072 bit.
*
- Public exponent: 65537 (aka F4).
*
*/
public static final RsaSsaPssParameters RSA_SSA_PSS_3072_SHA256_SHA256_32_F4 =
exceptionIsBug(
() ->
RsaSsaPssParameters.builder()
.setSigHashType(RsaSsaPssParameters.HashType.SHA256)
.setMgf1HashType(RsaSsaPssParameters.HashType.SHA256)
.setSaltLengthBytes(32)
.setModulusSizeBits(3072)
.setPublicExponent(RsaSsaPssParameters.F4)
.setVariant(RsaSsaPssParameters.Variant.TINK)
.build());
/**
* A {@link Parameters} that generates new instances of {@link RsaSsaPssPrivateKey} objects with
* the following parameters:
*
*
* - Signature hash: SHA512.
*
- MGF1 hash: SHA512.
*
- Salt length: 64 (i.e., SHA512's output length).
*
- Modulus size: 4096 bit.
*
- Public exponent: 65537 (aka F4).
*
*/
public static final RsaSsaPssParameters RSA_SSA_PSS_4096_SHA512_SHA512_64_F4 =
exceptionIsBug(
() ->
RsaSsaPssParameters.builder()
.setSigHashType(RsaSsaPssParameters.HashType.SHA512)
.setMgf1HashType(RsaSsaPssParameters.HashType.SHA512)
.setSaltLengthBytes(64)
.setModulusSizeBits(4096)
.setPublicExponent(RsaSsaPssParameters.F4)
.setVariant(RsaSsaPssParameters.Variant.TINK)
.build());
private PredefinedSignatureParameters() {}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy