Package com.helger.phase4.crypto

Class AS4SigningParams

java.lang.Object

com.helger.phase4.crypto.AS4SigningParams

All Implemented Interfaces:

com.helger.commons.lang.ICloneable<AS4SigningParams>

@NotThreadSafe
public class AS4SigningParams
extends Object
implements com.helger.commons.lang.ICloneable<AS4SigningParams>

AS4 signing parameters

Since:

0.9.0

Author:

Philip Helger

Field Summary

Fields

Modifier and Type	Field	Description
static final ECryptoKeyIdentifierType	DEFAULT_KEY_IDENTIFIER_TYPE
static final boolean	DEFAULT_USE_SINGLE_CERTIFICATE

Constructor Summary

Constructors

Constructor	Description
AS4SigningParams()

Method Summary

Modifier and Type	Method	Description
void	cloneTo(AS4SigningParams aTarget)
static AS4SigningParams	createDefault()
final ECryptoAlgorithmC14N	getAlgorithmC14N()
final ECryptoAlgorithmSign	getAlgorithmSign()
final ECryptoAlgorithmSignDigest	getAlgorithmSignDigest()
AS4SigningParams	getClone()
final ECryptoKeyIdentifierType	getKeyIdentifierType()
final Provider	getSecurityProviderSign()
final Provider	getSecurityProviderVerify()
final IWSSecSignatureCustomizer	getWSSecSignatureCustomizer()
final boolean	hasWSSecSignatureCustomizer()
boolean	isSigningEnabled()
final boolean	isUseSingleCertificate()
final AS4SigningParams	setAlgorithmC14N(ECryptoAlgorithmC14N eAlgorithmC14N)	Set the canonicalization algorithm to be used.
final AS4SigningParams	setAlgorithmSign(ECryptoAlgorithmSign eAlgorithmSign)	A signing algorithm can be set.
final AS4SigningParams	setAlgorithmSignDigest(ECryptoAlgorithmSignDigest eAlgorithmSignDigest)	A signing digest algorithm can be set.
final AS4SigningParams	setFromPMode(PModeLegSecurity aSecurity)	This method calls setAlgorithmSign(ECryptoAlgorithmSign) and setAlgorithmSignDigest(ECryptoAlgorithmSignDigest) based on the PMode parameters.
final AS4SigningParams	setKeyIdentifierType(ECryptoKeyIdentifierType eKeyIdentifierType)	Set the key identifier type to use.
final AS4SigningParams	setSecurityProvider(Provider aSecurityProvider)	Set the security provider to be used for signing and verification.
final AS4SigningParams	setSecurityProviderSign(Provider aSecurityProviderSign)	Set the security provider to be used for signing (not for verification).
final AS4SigningParams	setSecurityProviderVerify(Provider aSecurityProviderVerify)	Set the security provider to be used for verification (not for signing).
final AS4SigningParams	setUseSingleCertificate(boolean bUseSingleCertificate)	Set the Binary Security Token value type.
final AS4SigningParams	setWSSecSignatureCustomizer(IWSSecSignatureCustomizer a)
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_USE_SINGLE_CERTIFICATE

public static final boolean DEFAULT_USE_SINGLE_CERTIFICATE

See Also:

• Constant Field Values

Constructor Details

AS4SigningParams

public AS4SigningParams()

Method Details

isSigningEnabled

public boolean isSigningEnabled()

Returns:

true if signing is enabled, false if not

getKeyIdentifierType

@Nonnull
public final ECryptoKeyIdentifierType getKeyIdentifierType()

Returns:

The key identifier type. May not be null.

Since:

0.11.0

setKeyIdentifierType

@Nonnull
public final AS4SigningParams 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

getAlgorithmSign

@Nullable
public final ECryptoAlgorithmSign getAlgorithmSign()

Returns:

The signing algorithm to use. May be null.

setAlgorithmSign

@Nonnull
public final AS4SigningParams setAlgorithmSign(@Nullable
 ECryptoAlgorithmSign eAlgorithmSign)

A signing algorithm can be set.
MANDATORY if you want to use sign.
Also @see setAlgorithmSignDigest(ECryptoAlgorithmSignDigest)

Parameters:

eAlgorithmSign - the signing algorithm that should be set

Returns:

this for chaining

getAlgorithmSignDigest

@Nullable
public final ECryptoAlgorithmSignDigest getAlgorithmSignDigest()

Returns:

The signing digest algorithm to use. May be null.

setAlgorithmSignDigest

@Nonnull
public final AS4SigningParams setAlgorithmSignDigest(@Nullable
 ECryptoAlgorithmSignDigest eAlgorithmSignDigest)

A signing digest algorithm can be set.
MANDATORY if you want to use sign.
Also @see setAlgorithmSign(ECryptoAlgorithmSign)

Parameters:

eAlgorithmSignDigest - the signing digest algorithm that should be set

Returns:

this for chaining

getAlgorithmC14N

@Nonnull
public final ECryptoAlgorithmC14N getAlgorithmC14N()

Returns:

The canonicalization algorithm to use. Never null.

Since:

0.10.6

setAlgorithmC14N

@Nonnull
public final AS4SigningParams setAlgorithmC14N(@Nonnull
 ECryptoAlgorithmC14N eAlgorithmC14N)

Set the canonicalization algorithm to be used. By default "Exclusive without comments" is used as suggested by the WS Security SOAP Message Security Version 1.1.1 spec, chapter 8.1.
Source: http://docs.oasis-open.org/wss-m/wss/v1.1.1/wss-SOAPMessageSecurity-v1.1.1.doc

Parameters:

eAlgorithmC14N - the canonicalization algorithm that should be set. May not be null.

Returns:

this for chaining

Since:

0.10.6

getSecurityProviderSign

@Nullable
public final Provider getSecurityProviderSign()

Returns:

The security provider for signing (not for verification) to be used. May be null.

Since:

2.4.0

setSecurityProviderSign

@Nonnull
public final AS4SigningParams setSecurityProviderSign(@Nullable
 Provider aSecurityProviderSign)

Set the security provider to be used for signing (not for verification).

Parameters:

aSecurityProviderSign - The security provider to be used. May be null.

Returns:

this for chaining

Since:

2.4.0

getSecurityProviderVerify

@Nullable
public final Provider getSecurityProviderVerify()

Returns:

The security provider for verification (not for signing) to be used. May be null.

Since:

2.4.0

setSecurityProviderVerify

@Nonnull
public final AS4SigningParams setSecurityProviderVerify(@Nullable
 Provider aSecurityProviderVerify)

Set the security provider to be used for verification (not for signing).

Parameters:

aSecurityProviderVerify - The security provider to be used. May be null.

Returns:

this for chaining

Since:

2.4.0

setSecurityProvider

@Nonnull
public final AS4SigningParams setSecurityProvider(@Nullable
 Provider aSecurityProvider)

Set the security provider to be used for signing and verification.

Parameters:

aSecurityProvider - The security provider to be used. May be null.

Returns:

this for chaining

Since:

2.1.3

isUseSingleCertificate

public final boolean isUseSingleCertificate()

Returns:

true to use the BST ValueType "#X509v3", false to use the BST value type "#X509PKIPathv1".

Since:

2.1.5

setUseSingleCertificate

@Nonnull
public final AS4SigningParams setUseSingleCertificate(boolean bUseSingleCertificate)

Set the Binary Security Token value type. The default is true.

Parameters:

bUseSingleCertificate - true maps to "#X509v3" (e.g. for Peppol) and false maps to "#X509PKIPathv1".

Returns:

this for chaining

Since:

2.1.5

getWSSecSignatureCustomizer

@Nullable
public final IWSSecSignatureCustomizer getWSSecSignatureCustomizer()

hasWSSecSignatureCustomizer

public final boolean hasWSSecSignatureCustomizer()

setWSSecSignatureCustomizer

@Nonnull
public final AS4SigningParams setWSSecSignatureCustomizer(@Nullable
 IWSSecSignatureCustomizer a)

setFromPMode

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

This method calls setAlgorithmSign(ECryptoAlgorithmSign) and setAlgorithmSignDigest(ECryptoAlgorithmSignDigest) based on the PMode parameters. If the PMode parameter is null both values will be set to null.

Parameters:

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

Returns:

this for chaining

cloneTo

@OverridingMethodsMustInvokeSuper
public void cloneTo(@Nonnull
 AS4SigningParams aTarget)

getClone

@Nonnull
@ReturnsMutableCopy
public AS4SigningParams getClone()

Specified by:

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

toString

public String toString()

Overrides:

toString in class Object

createDefault

@Nonnull
@ReturnsMutableObject
public static AS4SigningParams createDefault()

Returns:

A non-null AS4SigningParams object with default values assigned.

See Also:

• setAlgorithmSign(ECryptoAlgorithmSign)
• setAlgorithmSignDigest(ECryptoAlgorithmSignDigest)
• setAlgorithmC14N(ECryptoAlgorithmC14N)