com.helger.as2lib.crypto

Enum ECryptoAlgorithmSign

java.lang.Object

java.lang.Enum<ECryptoAlgorithmSign>

com.helger.as2lib.crypto.ECryptoAlgorithmSign

All Implemented Interfaces:

ICryptoAlgorithm, com.helger.commons.id.IHasID<String>, Serializable, Comparable<ECryptoAlgorithmSign>

public enum ECryptoAlgorithmSign
extends Enum<ECryptoAlgorithmSign>
implements ICryptoAlgorithm

This enum contains all signing supported crypto algorithms. The algorithms contained in here may not be used for encryption of anything. See ECryptoAlgorithmCrypt for encryption algorithms.
Note: Mendelson uses the RFC 5751 identifiers.

Author:

Philip Helger

Enum Constant Summary

Enum Constants

Enum Constant and Description
DIGEST_MD5 Same for RFC 3851 and RFC 5751
DIGEST_RSA_MD5 Deprecated.
DIGEST_RSA_SHA1 Deprecated.
DIGEST_SHA_1 New version as of RFC 5751.
DIGEST_SHA_224 New version as of RFC 5751.
DIGEST_SHA_256 New version as of RFC 5751.
DIGEST_SHA_384 New version as of RFC 5751.
DIGEST_SHA_512 New version as of RFC 5751.
DIGEST_SHA1 Old version as of RFC 3851.
DIGEST_SHA256 Old version as of RFC 3851.
DIGEST_SHA384 Old version as of RFC 3851.
DIGEST_SHA512 Old version as of RFC 3851.
RSASSA_PKCS1_V1_5_WITH_SHA3_256

Field Summary

Fields

Modifier and Type	Field and Description
static ECryptoAlgorithmSign	DEFAULT_RFC_3851
static ECryptoAlgorithmSign	DEFAULT_RFC_5751

Method Summary

Modifier and Type	Method and Description
static ECryptoAlgorithmSign	getFromIDOrDefault(String sID, ECryptoAlgorithmSign eDefault)
static ECryptoAlgorithmSign	getFromIDOrNull(String sID)
static ECryptoAlgorithmSign	getFromIDOrThrow(String sID)
String	getID()
org.bouncycastle.asn1.ASN1ObjectIdentifier	getOID()
String	getSignAlgorithmName()
boolean	isRFC3851Algorithm()
boolean	isRFC5751Algorithm()
static ECryptoAlgorithmSign	valueOf(String name) Returns the enum constant of this type with the specified name.
static ECryptoAlgorithmSign[]	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

Methods inherited from interface com.helger.commons.id.IHasID

getComparatorID

Enum Constant Detail

DIGEST_RSA_MD5

@Deprecated
 @DevelopersNote(value="Use DIGEST_MD5 instead")
public static final ECryptoAlgorithmSign DIGEST_RSA_MD5

Deprecated.

See compatibility note in RFC 5751, section 3.4.3.1

DIGEST_RSA_SHA1

@Deprecated
 @DevelopersNote(value="Use DIGEST_SHA1 or DIGEST_SHA_1 instead")
public static final ECryptoAlgorithmSign DIGEST_RSA_SHA1

Deprecated.

See compatibility note in RFC 5751, section 3.4.3.1

DIGEST_MD5

public static final ECryptoAlgorithmSign DIGEST_MD5

Same for RFC 3851 and RFC 5751

DIGEST_SHA1

@DevelopersNote(value="Use DIGEST_SHA_1 instead")
public static final ECryptoAlgorithmSign DIGEST_SHA1

Old version as of RFC 3851.

DIGEST_SHA256

@DevelopersNote(value="Use DIGEST_SHA_256 instead")
public static final ECryptoAlgorithmSign DIGEST_SHA256

Old version as of RFC 3851.

DIGEST_SHA384

@DevelopersNote(value="Use DIGEST_SHA_384 instead")
public static final ECryptoAlgorithmSign DIGEST_SHA384

Old version as of RFC 3851.

DIGEST_SHA512

@DevelopersNote(value="Use DIGEST_SHA_512 instead")
public static final ECryptoAlgorithmSign DIGEST_SHA512

Old version as of RFC 3851.

DIGEST_SHA_1

public static final ECryptoAlgorithmSign DIGEST_SHA_1

New version as of RFC 5751.

DIGEST_SHA_224

public static final ECryptoAlgorithmSign DIGEST_SHA_224

New version as of RFC 5751.

DIGEST_SHA_256

public static final ECryptoAlgorithmSign DIGEST_SHA_256

New version as of RFC 5751.

DIGEST_SHA_384

public static final ECryptoAlgorithmSign DIGEST_SHA_384

New version as of RFC 5751.

DIGEST_SHA_512

public static final ECryptoAlgorithmSign DIGEST_SHA_512

New version as of RFC 5751.

RSASSA_PKCS1_V1_5_WITH_SHA3_256

public static final ECryptoAlgorithmSign RSASSA_PKCS1_V1_5_WITH_SHA3_256

Field Detail

DEFAULT_RFC_3851

public static final ECryptoAlgorithmSign DEFAULT_RFC_3851

DEFAULT_RFC_5751

public static final ECryptoAlgorithmSign DEFAULT_RFC_5751

Method Detail

values

public static ECryptoAlgorithmSign[] 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 (ECryptoAlgorithmSign c : ECryptoAlgorithmSign.values())
    System.out.println(c);

Returns:

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

valueOf

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

getID

@Nonnull
 @Nonempty
public String getID()

Specified by:

getID in interface com.helger.commons.id.IHasID<String>

getOID

@Nonnull
public org.bouncycastle.asn1.ASN1ObjectIdentifier getOID()

Specified by:

getOID in interface ICryptoAlgorithm

Returns:

The ASN.1 object identifier of the crypto algorithm. Never null.

getSignAlgorithmName

@Nonnull
 @Nonempty
public String getSignAlgorithmName()

Returns:

The algorithm name to be used for BouncyCastle to do the SMIME packaging.

isRFC3851Algorithm

public boolean isRFC3851Algorithm()

Returns:

true if this is an algorithm defined by RFC 3851, false otherwise. Please note that some algorithms are contained in both algorithm sets!

Since:

4.2.0

isRFC5751Algorithm

public boolean isRFC5751Algorithm()

Returns:

true if this is an algorithm defined by RFC 5751, false otherwise. Please note that some algorithms are contained in both algorithm sets!

Since:

4.2.0

getFromIDOrNull

@Nullable
public static ECryptoAlgorithmSign getFromIDOrNull(@Nullable
                                                              String sID)

getFromIDOrThrow

@Nonnull
public static ECryptoAlgorithmSign getFromIDOrThrow(@Nullable
                                                              String sID)

getFromIDOrDefault

@Nullable
public static ECryptoAlgorithmSign getFromIDOrDefault(@Nullable
                                                                 String sID,
                                                                 @Nullable
                                                                 ECryptoAlgorithmSign eDefault)