org.eclipse.californium.scandium.dtls

Class SignatureAndHashAlgorithm

java.lang.Object

org.eclipse.californium.scandium.dtls.SignatureAndHashAlgorithm

public final class SignatureAndHashAlgorithm
extends Object

See RFC 5246 for details. Since 2.4: added support for RFC 8422.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SignatureAndHashAlgorithm.HashAlgorithm Hash algorithms as defined by RFC 5246.
static class	SignatureAndHashAlgorithm.SignatureAlgorithm Signature algorithms as defined by RFC 5246.

Field Summary

Fields

Modifier and Type	Field and Description
static List<SignatureAndHashAlgorithm>	DEFAULT Default list of supported signature and hash algorithms.
static SignatureAndHashAlgorithm	INTRINSIC_WITH_ED25519 INTRINSIC_WITH_ED25519.
static SignatureAndHashAlgorithm	INTRINSIC_WITH_ED448 INTRINSIC_WITH_ED448.
static SignatureAndHashAlgorithm	SHA1_WITH_ECDSA SHA1_with_Ecdsa.
static SignatureAndHashAlgorithm	SHA256_WITH_ECDSA SHA256_with_Ecdsa.
static SignatureAndHashAlgorithm	SHA256_WITH_RSA SHA256_with_Rsa.
static SignatureAndHashAlgorithm	SHA384_WITH_ECDSA SHA384_with_Ecdsa.

Constructor Summary

Constructors

Constructor and Description
SignatureAndHashAlgorithm(int hashAlgorithmCode, int signatureAlgorithmCode) Creates an instance for corresponding algorithm codes.
SignatureAndHashAlgorithm(SignatureAndHashAlgorithm.HashAlgorithm hashAlgorithm, SignatureAndHashAlgorithm.SignatureAlgorithm signatureAlgorithm) Creates an instance for a hash and signature algorithm.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
static List<SignatureAndHashAlgorithm>	getCommonSignatureAlgorithms(List<SignatureAndHashAlgorithm> proposedSignatureAndHashAlgorithms, List<SignatureAndHashAlgorithm> supportedSignatureAndHashAlgorithms) Get the common signature and hash algorithms in the order of the proposed list.
static List<SignatureAndHashAlgorithm>	getDefaultSignatureAlgorithms(List<X509Certificate> certificateChain) Get list of default signature and hash algorithms including the algorithms used by the certificate chain.
static List<SignatureAndHashAlgorithm>	getDefaultSignatureAlgorithms(PublicKey publicKey) Get list of default signature and hash algorithms including the algorithms usable by the public key.
static List<SignatureAndHashAlgorithm>	getEcdsaCompatibleSignatureAlgorithms(List<SignatureAndHashAlgorithm> signatureAndHashAlgorithms) Get ECDSA compatible signature and hash algorithms.
SignatureAndHashAlgorithm.HashAlgorithm	getHash() Gets the hash algorithm in use.
String	getJcaName() Gets the JCA standard name corresponding to this combination of hash and signature algorithm.
SignatureAndHashAlgorithm.SignatureAlgorithm	getSignature() Gets the signature algorithm in use.
static SignatureAndHashAlgorithm	getSupportedSignatureAlgorithm(List<SignatureAndHashAlgorithm> supportedSignatureAlgorithms, PublicKey key) Gets a signature and hash algorithm that is compatible with a given public key.
ThreadLocalSignature	getThreadLocalSignature() Get thread local signature for this signature and hash algorithm.
static ThreadLocalSignature	getThreadLocalSignature(String algorithm) Get thread local signature.
int	hashCode()
static boolean	isSignedWithSupportedAlgorithms(List<SignatureAndHashAlgorithm> supportedSignatureAlgorithms, List<X509Certificate> certificateChain) Checks if all of a given certificates in the chain have been signed using a algorithm supported by the server.
boolean	isSupported() Check, if signature and hash algorithm is supported by JRE.
String	jcaName() Deprecated. use getJcaName().
String	toString() Returns literal name, if signature or hash algortihm is unknown.
static SignatureAndHashAlgorithm	valueOf(String jcaName) Get signature and hash algorithm from JCA name.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SHA1_WITH_ECDSA

public static SignatureAndHashAlgorithm SHA1_WITH_ECDSA

SHA1_with_Ecdsa.

Since:

2.3

SHA256_WITH_ECDSA

public static SignatureAndHashAlgorithm SHA256_WITH_ECDSA

SHA256_with_Ecdsa.

Since:

2.3

SHA384_WITH_ECDSA

public static SignatureAndHashAlgorithm SHA384_WITH_ECDSA

SHA384_with_Ecdsa.

Since:

2.3

SHA256_WITH_RSA

public static SignatureAndHashAlgorithm SHA256_WITH_RSA

SHA256_with_Rsa.

Since:

2.3

INTRINSIC_WITH_ED25519

public static SignatureAndHashAlgorithm INTRINSIC_WITH_ED25519

INTRINSIC_WITH_ED25519.

Since:

2.4

INTRINSIC_WITH_ED448

public static SignatureAndHashAlgorithm INTRINSIC_WITH_ED448

INTRINSIC_WITH_ED448.

Since:

2.4

DEFAULT

public static List<SignatureAndHashAlgorithm> DEFAULT

Default list of supported signature and hash algorithms. Contains only SHA256_with_Ecdsa.

Since:

2.3

Constructor Detail

SignatureAndHashAlgorithm

public SignatureAndHashAlgorithm(SignatureAndHashAlgorithm.HashAlgorithm hashAlgorithm,
                         SignatureAndHashAlgorithm.SignatureAlgorithm signatureAlgorithm)

Creates an instance for a hash and signature algorithm.

Parameters:

hashAlgorithm - The hash algorithm.

signatureAlgorithm - The signature algorithm.

Throws:

NullPointerException - if one of the provided arguments was null

SignatureAndHashAlgorithm

public SignatureAndHashAlgorithm(int hashAlgorithmCode,
                         int signatureAlgorithmCode)

Creates an instance for corresponding algorithm codes.

Parameters:

hashAlgorithmCode - the hash algorithm's code.

signatureAlgorithmCode - the signature algorithm's code.

Method Detail

getThreadLocalSignature

public static ThreadLocalSignature getThreadLocalSignature(String algorithm)

Get thread local signature.

Parameters:

algorithm - name of signature algorithm

Returns:

thread local signature.

Since:

2.3

valueOf

public static SignatureAndHashAlgorithm valueOf(String jcaName)

Get signature and hash algorithm from JCA name.

Parameters:

jcaName - name of signature and hash algorithm. e.g. "SHA256withECDSA".

Returns:

signature and hash algorithm, or null, if signature or hash is unknown.

Since:

2.3

getDefaultSignatureAlgorithms

public static List<SignatureAndHashAlgorithm> getDefaultSignatureAlgorithms(List<X509Certificate> certificateChain)

Get list of default signature and hash algorithms including the algorithms used by the certificate chain.

Parameters:

certificateChain - certificate chain. May be null.

Returns:

list list of default signature and hash algorithms

Since:

2.3

getDefaultSignatureAlgorithms

public static List<SignatureAndHashAlgorithm> getDefaultSignatureAlgorithms(PublicKey publicKey)

Get list of default signature and hash algorithms including the algorithms usable by the public key.

Parameters:

publicKey - publicKey. May be null.

Returns:

list list of default signature and hash algorithms

Since:

2.4

getCommonSignatureAlgorithms

public static List<SignatureAndHashAlgorithm> getCommonSignatureAlgorithms(List<SignatureAndHashAlgorithm> proposedSignatureAndHashAlgorithms,
                                                           List<SignatureAndHashAlgorithm> supportedSignatureAndHashAlgorithms)

Get the common signature and hash algorithms in the order of the proposed list.

Parameters:

proposedSignatureAndHashAlgorithms - proposed signature and hash algorithms, ordered

supportedSignatureAndHashAlgorithms - supported signature and hash algorithms

Returns:

list of common signature and hash algorithms in the order of the proposed list. empty, if no common signature and hash algorithm is found.

Since:

2.3

getSupportedSignatureAlgorithm

public static SignatureAndHashAlgorithm getSupportedSignatureAlgorithm(List<SignatureAndHashAlgorithm> supportedSignatureAlgorithms,
                                                       PublicKey key)

Gets a signature and hash algorithm that is compatible with a given public key.

Parameters:

supportedSignatureAlgorithms - list of supported signature and hash algorithms.

key - public key

Returns:

A signature and hash algorithm that can be used with the provided public key, or null, if the public key is not compatible with any of the supported signature and hash algorithms.

Throws:

NullPointerException - if any parameter is null.

Since:

2.3

getEcdsaCompatibleSignatureAlgorithms

public static List<SignatureAndHashAlgorithm> getEcdsaCompatibleSignatureAlgorithms(List<SignatureAndHashAlgorithm> signatureAndHashAlgorithms)

Get ECDSA compatible signature and hash algorithms.

Parameters:

signatureAndHashAlgorithms - list of signature and hash algorithms

Returns:

ECDSA compatible signature and hash algorithms

Since:

2.4

See Also:

SignatureAndHashAlgorithm.SignatureAlgorithm.isEcdsaCompatible()

isSignedWithSupportedAlgorithms

public static boolean isSignedWithSupportedAlgorithms(List<SignatureAndHashAlgorithm> supportedSignatureAlgorithms,
                                      List<X509Certificate> certificateChain)

Checks if all of a given certificates in the chain have been signed using a algorithm supported by the server.

Parameters:

supportedSignatureAlgorithms - list of supported signature and hash algorithms.

certificateChain - The certificate chain to test.

Returns:

true if all certificates have been signed using a supported algorithm.

Since:

2.3

getSignature

public SignatureAndHashAlgorithm.SignatureAlgorithm getSignature()

Gets the signature algorithm in use.

Returns:

The algorithm name.

getHash

public SignatureAndHashAlgorithm.HashAlgorithm getHash()

Gets the hash algorithm in use.

Returns:

The algorithm name.

getJcaName

public String getJcaName()

Gets the JCA standard name corresponding to this combination of hash and signature algorithm.

The name returned by this method can be used to instantiate a java.security.Signature object like this:

 Signature signature = Signature.newInstance(signatureAndHash.jcaName());
 

Returns:

The name, or null, if name is not available/not known by this implementation.

Since:

2.3

jcaName

@Deprecated
public String jcaName()

Deprecated. use getJcaName().

Gets the JCA standard name corresponding to this combination of hash and signature algorithm.

The name returned by this method can be used to instantiate a java.security.Signature object like this:

 Signature signature = Signature.newInstance(signatureAndHash.jcaName());
 

Returns:

The name, or null, if name is not available/not known by this implementation.

isSupported

public boolean isSupported()

Check, if signature and hash algorithm is supported by JRE.

Returns:

true, if supported by JRE, false, otherwise.

Since:

2.3

toString

public String toString()

Returns literal name, if signature or hash algortihm is unknown.

Overrides:

toString in class Object

Since:

2.3

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

Since:

2.3

hashCode

public int hashCode()

Overrides:

hashCode in class Object

Since:

2.3

getThreadLocalSignature

public ThreadLocalSignature getThreadLocalSignature()

Get thread local signature for this signature and hash algorithm.

Returns:

thread local signature.

Since:

2.3