Share via

KeyWrapAlgorithm Class

Package:
com.azure.security.keyvault.keys.cryptography.models
Maven Artifact:
com.azure:azure-security-keyvault-keys:4.10.4

public final class KeyWrapAlgorithm
extends ExpandableStringEnum<KeyWrapAlgorithm>

Defines values for KeyWrapAlgorithm.

Field Summary

Modifier and Type Field and Description
static final KeyWrapAlgorithm A128KW

128-bit AES key wrap.
static final KeyWrapAlgorithm A192KW

192-bit AES key wrap.
static final KeyWrapAlgorithm A256KW

256-bit AES key wrap.
static final KeyWrapAlgorithm CKM_AES_KEY_WRAP

CKM AES key wrap.
static final KeyWrapAlgorithm CKM_AES_KEY_WRAP_PAD

CKM AES key wrap with padding.
static final KeyWrapAlgorithm RSA1_5

[Not recommended] RSAES-PKCS1-V1_5 key encryption, as described in https://tools.ietf.org/html/rfc3447.
static final KeyWrapAlgorithm RSA_OAEP

[Not recommended] RSAES using Optimal Asymmetric Encryption Padding (OAEP), as described in https://tools.ietf.org/html/rfc3447, with the default parameters specified by RFC 3447 in Section A.2.1.
static final KeyWrapAlgorithm RSA_OAEP_256

RSAES using Optimal Asymmetric Encryption Padding with a hash function of SHA-256 and a mask generation function of MGF1 with SHA-256.

Constructor Summary

Constructor Description
KeyWrapAlgorithm()

Deprecated

Use the fromString(String name) factory method.

Creates a new instance of KeyWrapAlgorithm without a #toString() value.

Method Summary

Modifier and Type Method and Description
static KeyWrapAlgorithm fromString(String name)

Creates or finds a KeyWrapAlgorithm from its string representation.
static Collection<KeyWrapAlgorithm> values()

Gets known KeyWrapAlgorithm values.

Methods inherited from ExpandableStringEnum

<T>fromString <T>values equals getValue hashCode toString

Methods inherited from java.lang.Object

clone finalize getClass notify notifyAll wait wait wait

Field Details

A128KW

public static final KeyWrapAlgorithm A128KW

128-bit AES key wrap.

A192KW

public static final KeyWrapAlgorithm A192KW

192-bit AES key wrap.

A256KW

public static final KeyWrapAlgorithm A256KW

256-bit AES key wrap.

CKM_AES_KEY_WRAP

public static final KeyWrapAlgorithm CKM_AES_KEY_WRAP

CKM AES key wrap.

CKM_AES_KEY_WRAP_PAD

public static final KeyWrapAlgorithm CKM_AES_KEY_WRAP_PAD

CKM AES key wrap with padding.

RSA1_5

public static final KeyWrapAlgorithm RSA1_5

[Not recommended] RSAES-PKCS1-V1_5 key encryption, as described in https://tools.ietf.org/html/rfc3447. Microsoft recommends using RSA_OAEP_256 or stronger algorithms for enhanced security. Microsoft does *not* recommend RSA_1_5, which is included solely for backwards compatibility. Cryptographic standards no longer consider RSA with the PKCS#1 v1.5 padding scheme secure for encryption.

RSA_OAEP

public static final KeyWrapAlgorithm RSA_OAEP

[Not recommended] RSAES using Optimal Asymmetric Encryption Padding (OAEP), as described in https://tools.ietf.org/html/rfc3447, with the default parameters specified by RFC 3447 in Section A.2.1. Those default parameters are using a hash function of SHA-1 and a mask generation function of MGF1 with SHA-1. Microsoft recommends using RSA_OAEP_256 or stronger algorithms for enhanced security. Microsoft does *not* recommend RSA_OAEP, which is included solely for backwards compatibility. RSA_OAEP utilizes SHA1, which has known collision problems.

RSA_OAEP_256

public static final KeyWrapAlgorithm RSA_OAEP_256

RSAES using Optimal Asymmetric Encryption Padding with a hash function of SHA-256 and a mask generation function of MGF1 with SHA-256.

Constructor Details

KeyWrapAlgorithm

@Deprecated
public KeyWrapAlgorithm()

Deprecated

Use the fromString(String name) factory method.

Creates a new instance of KeyWrapAlgorithm without a #toString() value.

This constructor shouldn't be called as it will produce a KeyWrapAlgorithm which doesn't have a String enum value.

Method Details

fromString

public static KeyWrapAlgorithm fromString(String name)

Creates or finds a KeyWrapAlgorithm from its string representation.

Parameters:

name - a name to look for.

Returns:

the corresponding KeyWrapAlgorithm.

values

public static Collection<KeyWrapAlgorithm> values()

Gets known KeyWrapAlgorithm values.

Returns:

known KeyWrapAlgorithm values.

Applies to