software.amazon.awscdk.services.kms

Enum KeySpec

java.lang.Object

java.lang.Enum<KeySpec>

software.amazon.awscdk.services.kms.KeySpec

All Implemented Interfaces:

Serializable, Comparable<KeySpec>

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:40.351Z")
 @Stability(value=Stable)
public enum KeySpec
extends Enum<KeySpec>

The key spec, represents the cryptographic configuration of keys.

Example:

 Key key = Key.Builder.create(this, "MyKey")
         .keySpec(KeySpec.ECC_SECG_P256K1) // Default to SYMMETRIC_DEFAULT
         .keyUsage(KeyUsage.SIGN_VERIFY)
         .build();
 

Enum Constant Summary

Enum Constants

Enum Constant and Description
ECC_NIST_P256 NIST FIPS 186-4, Section 6.4, ECDSA signature using the curve specified by the key and SHA-256 for the message digest.
ECC_NIST_P384 NIST FIPS 186-4, Section 6.4, ECDSA signature using the curve specified by the key and SHA-384 for the message digest.
ECC_NIST_P521 NIST FIPS 186-4, Section 6.4, ECDSA signature using the curve specified by the key and SHA-512 for the message digest.
ECC_SECG_P256K1 Standards for Efficient Cryptography 2, Section 2.4.1, ECDSA signature on the Koblitz curve.
RSA_2048 RSA with 2048 bits of key.
RSA_3072 RSA with 3072 bits of key.
RSA_4096 RSA with 4096 bits of key.
SYMMETRIC_DEFAULT The default key spec.

Method Summary

Modifier and Type	Method and Description
static KeySpec	valueOf(String name) Returns the enum constant of this type with the specified name.
static KeySpec[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

SYMMETRIC_DEFAULT

@Stability(value=Stable)
public static final KeySpec SYMMETRIC_DEFAULT

The default key spec.

Valid usage: ENCRYPT_DECRYPT

RSA_2048

@Stability(value=Stable)
public static final KeySpec RSA_2048

RSA with 2048 bits of key.

Valid usage: ENCRYPT_DECRYPT and SIGN_VERIFY

RSA_3072

@Stability(value=Stable)
public static final KeySpec RSA_3072

RSA with 3072 bits of key.

Valid usage: ENCRYPT_DECRYPT and SIGN_VERIFY

RSA_4096

@Stability(value=Stable)
public static final KeySpec RSA_4096

RSA with 4096 bits of key.

Valid usage: ENCRYPT_DECRYPT and SIGN_VERIFY

ECC_NIST_P256

@Stability(value=Stable)
public static final KeySpec ECC_NIST_P256

NIST FIPS 186-4, Section 6.4, ECDSA signature using the curve specified by the key and SHA-256 for the message digest.

Valid usage: SIGN_VERIFY

ECC_NIST_P384

@Stability(value=Stable)
public static final KeySpec ECC_NIST_P384

NIST FIPS 186-4, Section 6.4, ECDSA signature using the curve specified by the key and SHA-384 for the message digest.

Valid usage: SIGN_VERIFY

ECC_NIST_P521

@Stability(value=Stable)
public static final KeySpec ECC_NIST_P521

NIST FIPS 186-4, Section 6.4, ECDSA signature using the curve specified by the key and SHA-512 for the message digest.

Valid usage: SIGN_VERIFY

ECC_SECG_P256K1

@Stability(value=Stable)
public static final KeySpec ECC_SECG_P256K1

Standards for Efficient Cryptography 2, Section 2.4.1, ECDSA signature on the Koblitz curve.

Valid usage: SIGN_VERIFY

Method Detail

values

public static KeySpec[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (KeySpec c : KeySpec.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static KeySpec valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null