Package com.helger.phase4.crypto

Class AS4CryptParams

java.lang.Object

com.helger.phase4.crypto.AS4CryptParams

All Implemented Interfaces:

com.helger.commons.lang.ICloneable<AS4CryptParams>, Serializable

@NotThreadSafe
public class AS4CryptParams
extends Object
implements Serializable, com.helger.commons.lang.ICloneable<AS4CryptParams>

AS4 encrypt/decrypt parameters

Since:

0.9.0

Author:

Philip Helger

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_DIGEST_ALGORITHM
static final String	DEFAULT_KEY_ENC_ALGORITHM
static final ECryptoKeyIdentifierType	DEFAULT_KEY_IDENTIFIER_TYPE
static final String	DEFAULT_MGF_ALGORITHM

Constructor Summary

Constructors

Constructor	Description
AS4CryptParams()	Default constructor using default setKeyIdentifierType(ECryptoKeyIdentifierType), setKeyEncAlgorithm(String), setMGFAlgorithm(String) and setDigestAlgorithm(String)

Method Summary

Modifier and Type	Method	Description
static AS4CryptParams	createDefault()
final ECryptoAlgorithmCrypt	getAlgorithmCrypt()
final String	getAlias()
final X509Certificate	getCertificate()
AS4CryptParams	getClone()
final String	getDigestAlgorithm()
final String	getKeyEncAlgorithm()
final ECryptoKeyIdentifierType	getKeyIdentifierType()
final String	getMGFAlgorithm()
final boolean	hasAlias()
final boolean	hasCertificate()
boolean	isCryptEnabled(Consumer<String> aWarningConsumer)
final AS4CryptParams	setAlgorithmCrypt(ECryptoAlgorithmCrypt eAlgorithmCrypt)	A encryption algorithm can be set.
final AS4CryptParams	setAlias(String sAlias)
final AS4CryptParams	setCertificate(X509Certificate aCert)	Set the X509 certificate be used.
final AS4CryptParams	setDigestAlgorithm(String sDigestAlgorithm)	Set the digest algorithm to use with the RSA-OAEP key transport algorithm.
final AS4CryptParams	setFromPMode(PModeLegSecurity aSecurity)	This method calls setAlgorithmCrypt(ECryptoAlgorithmCrypt) based on the PMode parameters.
final AS4CryptParams	setKeyEncAlgorithm(String sKeyEncAlgorithm)
final AS4CryptParams	setKeyIdentifierType(ECryptoKeyIdentifierType eKeyIdentifierType)	Set the key identifier type to use.
final AS4CryptParams	setMGFAlgorithm(String sMGFAlgorithm)	Set the mask generation function (MGF) algorithm to use with the RSA-OAEP key transport algorithm.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Details

DEFAULT_KEY_IDENTIFIER_TYPE

public static final ECryptoKeyIdentifierType DEFAULT_KEY_IDENTIFIER_TYPE

DEFAULT_KEY_ENC_ALGORITHM

public static final String DEFAULT_KEY_ENC_ALGORITHM

See Also:

• Constant Field Values

DEFAULT_MGF_ALGORITHM

public static final String DEFAULT_MGF_ALGORITHM

See Also:

• Constant Field Values

DEFAULT_DIGEST_ALGORITHM

public static final String DEFAULT_DIGEST_ALGORITHM

See Also:

• Constant Field Values

Constructor Details

AS4CryptParams

public AS4CryptParams()

Default constructor using default setKeyIdentifierType(ECryptoKeyIdentifierType), setKeyEncAlgorithm(String), setMGFAlgorithm(String) and setDigestAlgorithm(String)

Method Details

isCryptEnabled

public boolean isCryptEnabled(@Nullable
 Consumer<String> aWarningConsumer)

getKeyIdentifierType

@Nonnull
public final ECryptoKeyIdentifierType getKeyIdentifierType()

Returns:

The key identifier type. May not be null.

Since:

0.11.0

setKeyIdentifierType

@Nonnull
public final AS4CryptParams setKeyIdentifierType(@Nonnull
 ECryptoKeyIdentifierType eKeyIdentifierType)

Set the key identifier type to use. That defines how the information about the signing certificate is transmitted.

Parameters:

eKeyIdentifierType - The key identifier type to use. May not be null.

Returns:

this for chaining

Since:

0.11.0

getAlgorithmCrypt

@Nullable
public final ECryptoAlgorithmCrypt getAlgorithmCrypt()

Returns:

The encryption algorithm to use. May be null.

setAlgorithmCrypt

@Nonnull
public final AS4CryptParams setAlgorithmCrypt(@Nullable
 ECryptoAlgorithmCrypt eAlgorithmCrypt)

A encryption algorithm can be set.
MANDATORY if you want to use encryption.

Parameters:

eAlgorithmCrypt - the encryption algorithm that should be set

Returns:

this for chaining

getKeyEncAlgorithm

@Nonnull
@Nonempty
public final String getKeyEncAlgorithm()

setKeyEncAlgorithm

@Nonnull
public final AS4CryptParams setKeyEncAlgorithm(@Nonnull @Nonempty
 String sKeyEncAlgorithm)

getMGFAlgorithm

@Nonnull
@Nonempty
public final String getMGFAlgorithm()

Returns:

The mask generation function (MGF) algorithm to use with the RSA-OAEP key transport algorithm. The default is DEFAULT_MGF_ALGORITHM

setMGFAlgorithm

@Nonnull
public final AS4CryptParams setMGFAlgorithm(@Nonnull @Nonempty
 String sMGFAlgorithm)

Set the mask generation function (MGF) algorithm to use with the RSA-OAEP key transport algorithm.

Parameters:

sMGFAlgorithm - The MFG algorithm to use. May neither be null nor empty.

Returns:

this for chaining

getDigestAlgorithm

@Nonnull
@Nonempty
public final String getDigestAlgorithm()

Returns:

The digest algorithm to use with the RSA-OAEP key transport algorithm. The default is DEFAULT_DIGEST_ALGORITHM

setDigestAlgorithm

@Nonnull
public final AS4CryptParams setDigestAlgorithm(@Nonnull @Nonempty
 String sDigestAlgorithm)

Set the digest algorithm to use with the RSA-OAEP key transport algorithm.

Parameters:

sDigestAlgorithm - The digest algorithm to use. May neither be null nor empty.

Returns:

this for chaining

getCertificate

@Nullable
public final X509Certificate getCertificate()

Returns:

The currently set X509 certificate. May be null.

hasCertificate

public final boolean hasCertificate()

Returns:

true if an X509 certificate is present, false if not.

setCertificate

@Nonnull
public final AS4CryptParams setCertificate(@Nullable
 X509Certificate aCert)

Set the X509 certificate be used. The provided certificate is not checked for validity. If it is expired only a warning is logged but the certificate will still be used.

Parameters:

aCert - The certificate to be used. May be null.

Returns:

this for chaining

getAlias

@Nullable
public final String getAlias()

hasAlias

public final boolean hasAlias()

setAlias

@Nonnull
public final AS4CryptParams setAlias(@Nullable
 String sAlias)

setFromPMode

@Nonnull
public final AS4CryptParams setFromPMode(@Nullable
 PModeLegSecurity aSecurity)

This method calls setAlgorithmCrypt(ECryptoAlgorithmCrypt) based on the PMode parameters. If the PMode parameter is null the value will be set to null.

Parameters:

aSecurity - The PMode security stuff to use. May be null.

Returns:

this for chaining

getClone

@Nonnull
@ReturnsMutableCopy
public AS4CryptParams getClone()

Specified by:

getClone in interface com.helger.commons.lang.ICloneable<AS4CryptParams>

toString

public String toString()

Overrides:

toString in class Object

createDefault

@Nonnull
@ReturnsMutableObject
public static AS4CryptParams createDefault()

Returns:

A non-null default instance.

See Also:

• setAlgorithmCrypt(ECryptoAlgorithmCrypt)