Module iu.util.crypt

Package edu.iu.crypt

Enum Class WebCryptoHeader.Param

java.lang.Object

java.lang.Enum<WebCryptoHeader.Param>

edu.iu.crypt.WebCryptoHeader.Param

All Implemented Interfaces:

Serializable, Comparable<WebCryptoHeader.Param>, Constable

Enclosing interface:

WebCryptoHeader

public static enum WebCryptoHeader.Param
extends Enum<WebCryptoHeader.Param>

Enumerates standard header parameters.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALGORITHM	Encryption/signature algorithm.
CERTIFICATE_CHAIN	Certificate chain.
CERTIFICATE_SHA256_THUMBPRINT	Certificate SHA-1 thumb print.
CERTIFICATE_THUMBPRINT	Certificate SHA-1 thumb print.
CERTIFICATE_URI	Certificate chain URI.
CONTENT_TYPE	Content media type.
CRITICAL_PARAMS	Extended parameter names that must be included in the protected header.
ENCRYPTION	Content encryption algorithm.
EPHEMERAL_PUBLIC_KEY	Ephemeral public key for key agreement algorithms.
INITIALIZATION_VECTOR	Initialization vector for GCM key wrap.
KEY	Well-known public key.
KEY_ID	Well-known key identifier.
KEY_SET_URI	Well-known key set URI.
PARTY_UINFO	Public originator identifier (PartyUInfo) for key derivation.
PARTY_VINFO	Public recipient identifier (PartyVInfo) for key derivation.
PASSWORD_COUNT	PBKDF2 iteration count for use with PBES2.
PASSWORD_SALT	Password salt for use with PBES2.
TAG	Authentication tag for GCM key wrap.
TYPE	Signature/encryption media type.
ZIP	Plain-text compression algorithm for encryption.

Field Summary

Fields

Modifier and Type	Field	Description
final String	name	JOSE standard parameter name.
final boolean	required	Indicates if the parameter is required for this algorithm.

Method Summary

Modifier and Type	Method	Description
static WebCryptoHeader.Param	from(String name)	Gets a parameter by JOSE standard parameter name.
Object	get(WebCryptoHeader header)	Gets the header value.
boolean	isPresent(WebCryptoHeader header)	Verifies that the header contains a non-null value.
boolean	isUsedFor(WebKey.Use use)	Determines if a header applies to a public JWK use case.
static WebCryptoHeader.Param	valueOf(String name)	Returns the enum constant of this class with the specified name.
static WebCryptoHeader.Param[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ALGORITHM

public static final WebCryptoHeader.Param ALGORITHM

Encryption/signature algorithm.

KEY_ID

public static final WebCryptoHeader.Param KEY_ID

Well-known key identifier.

KEY_SET_URI

public static final WebCryptoHeader.Param KEY_SET_URI

Well-known key set URI.

KEY

public static final WebCryptoHeader.Param KEY

Well-known public key.

CERTIFICATE_URI

public static final WebCryptoHeader.Param CERTIFICATE_URI

Certificate chain URI.

CERTIFICATE_CHAIN

public static final WebCryptoHeader.Param CERTIFICATE_CHAIN

Certificate chain.

CERTIFICATE_THUMBPRINT

public static final WebCryptoHeader.Param CERTIFICATE_THUMBPRINT

Certificate SHA-1 thumb print.

CERTIFICATE_SHA256_THUMBPRINT

public static final WebCryptoHeader.Param CERTIFICATE_SHA256_THUMBPRINT

Certificate SHA-1 thumb print.

TYPE

public static final WebCryptoHeader.Param TYPE

Signature/encryption media type.

CONTENT_TYPE

public static final WebCryptoHeader.Param CONTENT_TYPE

Content media type.

CRITICAL_PARAMS

public static final WebCryptoHeader.Param CRITICAL_PARAMS

Extended parameter names that must be included in the protected header.

ENCRYPTION

public static final WebCryptoHeader.Param ENCRYPTION

Content encryption algorithm.

ZIP

public static final WebCryptoHeader.Param ZIP

Plain-text compression algorithm for encryption.

EPHEMERAL_PUBLIC_KEY

public static final WebCryptoHeader.Param EPHEMERAL_PUBLIC_KEY

Ephemeral public key for key agreement algorithms.

See Also:

• WebKey.Algorithm.ECDH_ES
• WebKey.Algorithm.ECDH_ES_A128KW
• WebKey.Algorithm.ECDH_ES_A192KW
• WebKey.Algorithm.ECDH_ES_A256KW

PARTY_UINFO

public static final WebCryptoHeader.Param PARTY_UINFO

Public originator identifier (PartyUInfo) for key derivation.

See Also:

• WebKey.Algorithm.ECDH_ES
• WebKey.Algorithm.ECDH_ES_A128KW
• WebKey.Algorithm.ECDH_ES_A192KW
• WebKey.Algorithm.ECDH_ES_A256KW

PARTY_VINFO

public static final WebCryptoHeader.Param PARTY_VINFO

Public recipient identifier (PartyVInfo) for key derivation.

See Also:

• WebKey.Algorithm.ECDH_ES
• WebKey.Algorithm.ECDH_ES_A128KW
• WebKey.Algorithm.ECDH_ES_A192KW
• WebKey.Algorithm.ECDH_ES_A256KW

INITIALIZATION_VECTOR

public static final WebCryptoHeader.Param INITIALIZATION_VECTOR

Initialization vector for GCM key wrap.

See Also:

• WebKey.Algorithm.A128GCMKW
• WebKey.Algorithm.A192GCMKW
• WebKey.Algorithm.A256GCMKW

TAG

public static final WebCryptoHeader.Param TAG

Authentication tag for GCM key wrap.

See Also:

• WebKey.Algorithm.A128GCMKW
• WebKey.Algorithm.A192GCMKW
• WebKey.Algorithm.A256GCMKW

PASSWORD_SALT

public static final WebCryptoHeader.Param PASSWORD_SALT

Password salt for use with PBES2.

See Also:

• WebKey.Algorithm.PBES2_HS256_A128KW
• WebKey.Algorithm.PBES2_HS384_A192KW
• WebKey.Algorithm.PBES2_HS512_A256KW

PASSWORD_COUNT

public static final WebCryptoHeader.Param PASSWORD_COUNT

PBKDF2 iteration count for use with PBES2.

See Also:

• WebKey.Algorithm.PBES2_HS256_A128KW
• WebKey.Algorithm.PBES2_HS384_A192KW
• WebKey.Algorithm.PBES2_HS512_A256KW

Field Details

name

public final String name

JOSE standard parameter name.

required

public final boolean required

Indicates if the parameter is required for this algorithm.

Method Details

values

public static WebCryptoHeader.Param[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static WebCryptoHeader.Param valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

from

public static WebCryptoHeader.Param from(String name)

Gets a parameter by JOSE standard parameter name.

Parameters:

name - JOSE standard name

Returns:

WebCryptoHeader.Param

isPresent

public boolean isPresent(WebCryptoHeader header)

Verifies that the header contains a non-null value.

Parameters:

header - header

Returns:

true if the value is present; else false

isUsedFor

public boolean isUsedFor(WebKey.Use use)

Determines if a header applies to a public JWK use case.

Parameters:

use - public key use

Returns:

true if the header parameter is registered for the public JWK use case.

get

public Object get(WebCryptoHeader header)

Gets the header value.

Parameters:

header - header

Returns:

header value