Package io.jans.as.model.crypto.signature

Enum SignatureAlgorithm

java.lang.Object

java.lang.Enum<SignatureAlgorithm>

io.jans.as.model.crypto.signature.SignatureAlgorithm

All Implemented Interfaces:

Serializable, Comparable<SignatureAlgorithm>, java.lang.constant.Constable

public enum SignatureAlgorithm
extends Enum<SignatureAlgorithm>

Signature Algorithms. JWS digital signature and MAC "alg" (algorithm) values (RFC 7518, A.1. Digital Signature/MAC Algorithm Identifier Cross-Reference). CFRG Elliptic Curve Diffie-Hellman (ECDH) and Signatures in JSON Object Signing and Encryption (JOSE) signature algorithm "Ed25519".

Version:

October 26, 2021

Author:

Javier Rojas Blum, Sergey Manoylo

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
EDDSA
ES256
ES256K
ES384
ES512
HS256
HS384
HS512
NONE
PS256
PS384
PS512
RS256
RS384
RS512

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEF_ED25519
static final String	DEF_EDDDSA
static final String	DEF_ES256
static final String	DEF_ES256K
static final String	DEF_ES384
static final String	DEF_ES512
static final String	DEF_HMACSHA256
static final String	DEF_HMACSHA384
static final String	DEF_HMACSHA512
static final String	DEF_HS256
static final String	DEF_HS384
static final String	DEF_HS512
static final String	DEF_PS256
static final String	DEF_PS384
static final String	DEF_PS512
static final String	DEF_RS256
static final String	DEF_RS384
static final String	DEF_RS512
static final String	DEF_SHA256WITHECDSA
static final String	DEF_SHA256WITHRSA
static final String	DEF_SHA256WITHRSAANDMGF1
static final String	DEF_SHA384WITHECDSA
static final String	DEF_SHA384WITHRSA
static final String	DEF_SHA384WITHRSAANDMGF1
static final String	DEF_SHA512WITHECDSA
static final String	DEF_SHA512WITHRSA
static final String	DEF_SHA512WITHRSAANDMGF1

Method Summary

Modifier and Type	Method	Description
static SignatureAlgorithm	fromString(String param)	Returns the corresponding SignatureAlgorithm for a parameter alg of the JWK endpoint.
static List<SignatureAlgorithm>	fromString(String[] params)
Algorithm	getAlg()
String	getAlgorithm()
EllipticEdvardsCurve	getCurve()
AlgorithmFamily	getFamily()
com.nimbusds.jose.JWSAlgorithm	getJwsAlgorithm()	Returns this.jwsAlgorithm (JSON Web Signature (JWS) algorithm name)
JwtType	getJwtType()
String	getName()
String	toString()	Returns a string representation of the object.
static SignatureAlgorithm	valueOf(String name)	Returns the enum constant of this type with the specified name.
static SignatureAlgorithm[]	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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NONE

public static final SignatureAlgorithm NONE

HS256

public static final SignatureAlgorithm HS256

HS384

public static final SignatureAlgorithm HS384

HS512

public static final SignatureAlgorithm HS512

RS256

public static final SignatureAlgorithm RS256

RS384

public static final SignatureAlgorithm RS384

RS512

public static final SignatureAlgorithm RS512

ES256

public static final SignatureAlgorithm ES256

ES256K

public static final SignatureAlgorithm ES256K

ES384

public static final SignatureAlgorithm ES384

ES512

public static final SignatureAlgorithm ES512

PS256

public static final SignatureAlgorithm PS256

PS384

public static final SignatureAlgorithm PS384

PS512

public static final SignatureAlgorithm PS512

EDDSA

public static final SignatureAlgorithm EDDSA

Field Details

DEF_HS256

public static final String DEF_HS256

See Also:

• Constant Field Values

DEF_HS384

public static final String DEF_HS384

See Also:

• Constant Field Values

DEF_HS512

public static final String DEF_HS512

See Also:

• Constant Field Values

DEF_RS256

public static final String DEF_RS256

See Also:

• Constant Field Values

DEF_RS384

public static final String DEF_RS384

See Also:

• Constant Field Values

DEF_RS512

public static final String DEF_RS512

See Also:

• Constant Field Values

DEF_ES256

public static final String DEF_ES256

See Also:

• Constant Field Values

DEF_ES256K

public static final String DEF_ES256K

See Also:

• Constant Field Values

DEF_ES384

public static final String DEF_ES384

See Also:

• Constant Field Values

DEF_ES512

public static final String DEF_ES512

See Also:

• Constant Field Values

DEF_PS256

public static final String DEF_PS256

See Also:

• Constant Field Values

DEF_PS384

public static final String DEF_PS384

See Also:

• Constant Field Values

DEF_PS512

public static final String DEF_PS512

See Also:

• Constant Field Values

DEF_ED25519

public static final String DEF_ED25519

See Also:

• Constant Field Values

DEF_EDDDSA

public static final String DEF_EDDDSA

See Also:

• Constant Field Values

DEF_HMACSHA256

public static final String DEF_HMACSHA256

See Also:

• Constant Field Values

DEF_HMACSHA384

public static final String DEF_HMACSHA384

See Also:

• Constant Field Values

DEF_HMACSHA512

public static final String DEF_HMACSHA512

See Also:

• Constant Field Values

DEF_SHA256WITHRSA

public static final String DEF_SHA256WITHRSA

See Also:

• Constant Field Values

DEF_SHA384WITHRSA

public static final String DEF_SHA384WITHRSA

See Also:

• Constant Field Values

DEF_SHA512WITHRSA

public static final String DEF_SHA512WITHRSA

See Also:

• Constant Field Values

DEF_SHA256WITHECDSA

public static final String DEF_SHA256WITHECDSA

See Also:

• Constant Field Values

DEF_SHA384WITHECDSA

public static final String DEF_SHA384WITHECDSA

See Also:

• Constant Field Values

DEF_SHA512WITHECDSA

public static final String DEF_SHA512WITHECDSA

See Also:

• Constant Field Values

DEF_SHA256WITHRSAANDMGF1

public static final String DEF_SHA256WITHRSAANDMGF1

See Also:

• Constant Field Values

DEF_SHA384WITHRSAANDMGF1

public static final String DEF_SHA384WITHRSAANDMGF1

See Also:

• Constant Field Values

DEF_SHA512WITHRSAANDMGF1

public static final String DEF_SHA512WITHRSAANDMGF1

See Also:

• Constant Field Values

Method Details

values

public static SignatureAlgorithm[] values()

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

Returns:

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

valueOf

public static SignatureAlgorithm 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

getAlg

public Algorithm getAlg()

getName

public String getName()

getFamily

public AlgorithmFamily getFamily()

getAlgorithm

public String getAlgorithm()

getCurve

public EllipticEdvardsCurve getCurve()

getJwtType

public JwtType getJwtType()

fromString

public static List<SignatureAlgorithm> fromString(String[] params)

fromString

public static SignatureAlgorithm fromString(String param)

Returns the corresponding SignatureAlgorithm for a parameter alg of the JWK endpoint.

Parameters:

param - The alg parameter.

Returns:

The corresponding alg if found, otherwise null.

toString

public String toString()

Returns a string representation of the object. In this case the parameter name.

Overrides:

toString in class Enum<SignatureAlgorithm>

Returns:

The string representation of the object.

getJwsAlgorithm

public com.nimbusds.jose.JWSAlgorithm getJwsAlgorithm()

Returns this.jwsAlgorithm (JSON Web Signature (JWS) algorithm name)

Returns:

this.jwsAlgorithm (JSON Web Signature (JWS) algorithm name)