org.nhindirect.stagent.options

Class OptionsParameter

java.lang.Object

org.nhindirect.stagent.options.OptionsParameter

public class OptionsParameter
extends Object

Tuning and configuration options for components of the security and trust agent. Options can be set either programmatically, as JVM options, or from a properties file. JVM and/or property based settings can be overridden by setting options programmatically.

Since:

1.4

Author:

Greg Meyer

Field Summary

Fields

Modifier and Type	Field and Description
static String	CACHABLE_PKCS11_CERT_RESOLVER_CACHE_TTL Integer value specifies the time to live in seconds that a certificate can be held in the CacheablePKCS11CertificateStore cache.
static String	CACHABLE_PKCS11_CERT_RESOLVER_MAX_CACHE_SIZE Integer value specifies the maximum number of certificates that can be held in the CacheablePKCS11CertificateStore cache.
static String	CRL_CACHE_LOCATION String value that specifies the directory where CRLs will be cached.
static String	CRYPTOGRAHPER_SMIME_DIGEST_ALGORITHM String value that specifies the digest algorithm used to hash messages by the SMIME cryptographer Valid option values: SHA1 SHA256 SHA384 SHA512
static String	CRYPTOGRAHPER_SMIME_ENCRYPTION_ALGORITHM String value that specifies the encryption algorithm used to encrypt messages by the SMIME cryptographer Valid option values: RSA_3DES AES128 AES192 AES256
static String	DNS_CERT_RESOLVER_CACHE_TTL Integer value specifies the time to live in seconds that a certificate can be held in the DNS certificate cache.
static String	DNS_CERT_RESOLVER_MAX_CACHE_SIZE Integer value specifies the maximum number of certificates that can be held in the DNS certificate cache.
static String	DNS_CERT_RESOLVER_RETRIES Integer value that specifies the number of times the DNS certificate resolvers will retry a query to the DNS server.
static String	DNS_CERT_RESOLVER_TIMEOUT Integer value that specifies the query timeout in seconds for a DNS record.
static String	DNS_CERT_RESOLVER_USE_TCP Boolean value that specifies if the DNS server should use TCP connections for queries.
static String	ENFORCE_STRONG_DIGESTS Boolean value that indicates if strong digests should be enforced.
static String	ENFORCE_STRONG_ENCRYPTION Boolean value that indicates if strong encryption should be enforced.
static String	JCE_PROVIDER String value that specifies the JCE provider that should be used for cryptography and certificate operations.
static String	JCE_PROVIDER_CLASSES String value that specifies a comma delimited list of JCE provider classes that should be registered.
static String	JCE_SENSITIVE_PROVIDER_CLASSES String value that specifies a comma delimited list of JCE provider classes that require access to sensitive cryptographic information such as secret and private keys.
static String	JCE_SENTITIVE_PROVIDER String value that specifies the JCE provider that should be used for cryptography and certificate operations that require access to sensitive cryptographic information such as secret and private keys.
static String	LDAP_CERT_RESOLVER_CACHE_TTL Integer value specifies the time to live in seconds that a certificate can be held in the LDAP certificate cache.
static String	LDAP_CERT_RESOLVER_MAX_CACHE_SIZE Integer value specifies the maximum number of certificates that can be held in the LDAP certificate cache.
static String	REJECT_ON_ROUTING_TAMPER Boolean value that determines if messages should be rejected if a routing header tamper has been detected.
static String	USE_OUTGOING_POLICY_FOR_INCOMING_NOTIFICATIONS Boolean value that determines if the set of outgoing anchors can be used to trust incoming MDN and DSN messages.

Constructor Summary

Constructors

Constructor and Description
OptionsParameter(String name, String value) Constructor

Method Summary

Methods

Modifier and Type	Method and Description
String	getParamName() Gets the parameter name.
String	getParamValue() Gets the parameter value.
static boolean	getParamValueAsBoolean(OptionsParameter param, boolean defaultValue) Gets the value of an options parameter as a boolean.
static int	getParamValueAsInteger(OptionsParameter param, int defaultValue) Gets the value of an options parameter as an integer.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

JCE_PROVIDER

public static final String JCE_PROVIDER

String value that specifies the JCE provider that should be used for cryptography and certificate operations.

JVM Parameter/Options Name: org.nhindirect.stagent.cryptography.JCEProviderName

See Also:

Constant Field Values

JCE_SENTITIVE_PROVIDER

public static final String JCE_SENTITIVE_PROVIDER

String value that specifies the JCE provider that should be used for cryptography and certificate operations that require access to sensitive cryptographic information such as secret and private keys.

JVM Parameter/Options Name: org.nhindirect.stagent.cryptography.JCESensitiveProviderName

See Also:

Constant Field Values

JCE_PROVIDER_CLASSES

public static final String JCE_PROVIDER_CLASSES

String value that specifies a comma delimited list of JCE provider classes that should be registered. Each class in the list should be fully qualified with the package name.

JVM Parameter/Options Name: org.nhindirect.stagent.cryptography.JCEProviderClassNames

See Also:

Constant Field Values

JCE_SENSITIVE_PROVIDER_CLASSES

public static final String JCE_SENSITIVE_PROVIDER_CLASSES

String value that specifies a comma delimited list of JCE provider classes that require access to sensitive cryptographic information such as secret and private keys. Each class in the list should be fully qualified with the package name. If the provider class requires additional qualifier information, it should be delimited by a semicolon. Example using BouncyCastle and the SunPKCS11 provider:
org.bouncycastle.jce.provider.BouncyCastleProvider,sun.security.pkcs11.SunPKCS11;pkcs11Config/pkcs11.cfg

JVM Parameter/Options Name: org.nhindirect.stagent.cryptography.JCESensitiveProviderClassNames

See Also:

Constant Field Values

CRL_CACHE_LOCATION

public static final String CRL_CACHE_LOCATION

String value that specifies the directory where CRLs will be cached. The directory may a full or relative path.

JVM Parameter/Options Name: org.nhindirect.stagent.cert.CRLCacheLocation

See Also:

Constant Field Values

DNS_CERT_RESOLVER_RETRIES

public static final String DNS_CERT_RESOLVER_RETRIES

Integer value that specifies the number of times the DNS certificate resolvers will retry a query to the DNS server.

JVM Parameter/Options Name: org.nhindirect.stagent.cert.dnsresolver.ServerRetries

See Also:

Constant Field Values

DNS_CERT_RESOLVER_TIMEOUT

public static final String DNS_CERT_RESOLVER_TIMEOUT

Integer value that specifies the query timeout in seconds for a DNS record.

JVM Parameter/Options Name: org.nhindirect.stagent.cert.dnsresolver.ServerTimeout

See Also:

Constant Field Values

DNS_CERT_RESOLVER_USE_TCP

public static final String DNS_CERT_RESOLVER_USE_TCP

Boolean value that specifies if the DNS server should use TCP connections for queries.

JVM Parameter/Options Name: org.nhindirect.stagent.cert.dnsresolver.ServerUseTCP

See Also:

Constant Field Values

DNS_CERT_RESOLVER_MAX_CACHE_SIZE

public static final String DNS_CERT_RESOLVER_MAX_CACHE_SIZE

Integer value specifies the maximum number of certificates that can be held in the DNS certificate cache.

JVM Parameter/Options Name: org.nhindirect.stagent.cert.dnsresolver.MaxCacheSize

See Also:

Constant Field Values

DNS_CERT_RESOLVER_CACHE_TTL

public static final String DNS_CERT_RESOLVER_CACHE_TTL

Integer value specifies the time to live in seconds that a certificate can be held in the DNS certificate cache.

JVM Parameter/Options Name: org.nhindirect.stagent.cert.dnsresolver.CacheTTL

See Also:

Constant Field Values

LDAP_CERT_RESOLVER_MAX_CACHE_SIZE

public static final String LDAP_CERT_RESOLVER_MAX_CACHE_SIZE

Integer value specifies the maximum number of certificates that can be held in the LDAP certificate cache.

JVM Parameter/Options Name: org.nhindirect.stagent.cert.ldapresolver.MaxCacheSize

See Also:

Constant Field Values

LDAP_CERT_RESOLVER_CACHE_TTL

public static final String LDAP_CERT_RESOLVER_CACHE_TTL

Integer value specifies the time to live in seconds that a certificate can be held in the LDAP certificate cache.

JVM Parameter/Options Name: org.nhindirect.stagent.cert.ldapresolver.CacheTTL

See Also:

Constant Field Values

CACHABLE_PKCS11_CERT_RESOLVER_MAX_CACHE_SIZE

public static final String CACHABLE_PKCS11_CERT_RESOLVER_MAX_CACHE_SIZE

Integer value specifies the maximum number of certificates that can be held in the CacheablePKCS11CertificateStore cache.

JVM Parameter/Options Name: org.nhindirect.stagent.cert.cacheablepkcs11certificatestore.MaxCacheSize

See Also:

Constant Field Values

CACHABLE_PKCS11_CERT_RESOLVER_CACHE_TTL

public static final String CACHABLE_PKCS11_CERT_RESOLVER_CACHE_TTL

Integer value specifies the time to live in seconds that a certificate can be held in the CacheablePKCS11CertificateStore cache.

JVM Parameter/Options Name: org.nhindirect.stagent.cert.cacheablepkcs11certificatestore.CacheTTL

See Also:

Constant Field Values

ENFORCE_STRONG_DIGESTS

public static final String ENFORCE_STRONG_DIGESTS

Boolean value that indicates if strong digests should be enforced. By spec, weak digest algorithms such as MD5 are not allowed; setting this parameter will force messages with weak message digests to be rejected.

JVM Parameter/Options Name: org.nhindirect.stagent.cryptographer.smime.EnforceStrongDigests

See Also:

Constant Field Values

ENFORCE_STRONG_ENCRYPTION

public static final String ENFORCE_STRONG_ENCRYPTION

Boolean value that indicates if strong encryption should be enforced. By spec, weak encryption algorithms such as 3DES are not allowed; setting this parameter will force messages with weak message encryption to be rejected.

JVM Parameter/Options Name: org.nhindirect.stagent.cryptographer.smime.EnforceStrongEncryption

See Also:

Constant Field Values

CRYPTOGRAHPER_SMIME_ENCRYPTION_ALGORITHM

public static final String CRYPTOGRAHPER_SMIME_ENCRYPTION_ALGORITHM

String value that specifies the encryption algorithm used to encrypt messages by the SMIME cryptographer
Valid option values:

• RSA_3DES
• AES128
• AES192
• AES256

JVM Parameter/Options Name: org.nhindirect.stagent.cryptographer.smime.EncryptionAlgorithm

See Also:

Constant Field Values

CRYPTOGRAHPER_SMIME_DIGEST_ALGORITHM

public static final String CRYPTOGRAHPER_SMIME_DIGEST_ALGORITHM

String value that specifies the digest algorithm used to hash messages by the SMIME cryptographer
Valid option values:

• SHA1
• SHA256
• SHA384
• SHA512

JVM Parameter/Options Name: org.nhindirect.stagent.cryptographer.smime.DigestAlgorithm

See Also:

Constant Field Values

USE_OUTGOING_POLICY_FOR_INCOMING_NOTIFICATIONS

public static final String USE_OUTGOING_POLICY_FOR_INCOMING_NOTIFICATIONS

Boolean value that determines if the set of outgoing anchors can be used to trust incoming MDN and DSN messages. This is necessary to allow QoS to happen when messages are set to be outgoing only.

JVM Parameter/Options Name: org.nhindirect.stagent.cert.ldapresolver.UseOutgoingPolForNoficiations

See Also:

Constant Field Values

REJECT_ON_ROUTING_TAMPER

public static final String REJECT_ON_ROUTING_TAMPER

Boolean value that determines if messages should be rejected if a routing header tamper has been detected. A tamper condition occurs when the SMTP RCPT TO envelope header or the MIME headers contain an address not found in the internal wrapped message headers.

JVM Parameter/Options Name: org.nhindirect.stagent.RejectOnRoutingTamper

See Also:

Constant Field Values

Constructor Detail

OptionsParameter

public OptionsParameter(String name,
                String value)

Constructor

Parameters:

name - The name of the parameter

value - The String value of the parameter

Method Detail

getParamName

public String getParamName()

Gets the parameter name.

Returns:

The parameter name

getParamValue

public String getParamValue()

Gets the parameter value.

Returns:

The parameter value

getParamValueAsInteger

public static int getParamValueAsInteger(OptionsParameter param,
                         int defaultValue)

Gets the value of an options parameter as an integer.

Parameters:

param - The parameter to retrieve the value from

defaultValue - The default value to return if the parameter is null, the parameter value is null, of if the value cannot be parse.

Returns:

The parameter value as an integer

getParamValueAsBoolean

public static boolean getParamValueAsBoolean(OptionsParameter param,
                             boolean defaultValue)

Gets the value of an options parameter as a boolean.

Parameters:

param - The parameter to retrieve the value from

defaultValue - The default value to return if the parameter is null, the parameter value is null, of if the value cannot be parse.

Returns:

The parameter value as a boolean