org.nhindirect.gateway.smtp.james.mailet

Class SecurityAndTrustMailetOptions

java.lang.Object

org.nhindirect.gateway.smtp.james.mailet.SecurityAndTrustMailetOptions

public class SecurityAndTrustMailetOptions
extends Object

Security and trust mailet options.

Since:

2.0

Author:

Greg Meyer

Field Summary

Fields

Modifier and Type	Field and Description
static String	AUTO_DSN_FAILURE_CREATION_PARAM Mailet configuration parameter that indicates if the mailet should automatically generate a DSN failure messages for outbound messages that do not succeed security and trust processing.
static String	CONFIG_URL_PARAM Mailet configuration parameter for the Direct configuration service URL.
static String	CONSUME_MND_PROCESSED_PARAM Mailet configuration option determining if MDN processed messages should be consumed by the mailet and not forwarded on to the edge protocol.
static String	JCE_PROVIDER_NAME The name of the JCE provider to use for cryptographic operations.
static String	JCE_SENTITIVE_PROVIDER The name of the JCE provider to use for cryptographic operations that utilized sensitive private key material.
static String	KEYSTORE_MGR_KEYSTORE_PASSPHRASE_ALIAS Alias in the key store manager for the KeystorePassPhraseAlias string.
static String	KEYSTORE_MGR_PIN Mailet configuration parameter for providing the pin for a keystore manager.
static String	KEYSTORE_MGR_PKCS11_CONFIG_FILE The sun.security.pkcs11.SunPKCS11 PKCS11 JCE provider requires a configuration file specific to the SunPKCS11 provider.
static String	KEYSTORE_MGR_PKCS11_PROVIDER The PKCS11 JCE provider.
static String	KEYSTORE_MGR_PKCS11_PROVIDER_CUSTOM_CONFIG_FILE Some PKCS11 providers allow for additional configuration via a file that is sent to the Keystore.load() method.
static String	KEYSTORE_MGR_PKCS11_PROVIDER_CUSTOM_CONFIG_STRING Some PKCS11 providers allow for additional configuration via a file that is sent to the Keystore.load() method.
static String	KEYSTORE_MGR_PRIVATE_KEY_PASSPHRASE_ALIAS Alias in the key store manager for the PrivateKeyPassPhraseAlias string.
static String	KEYSTORE_MGR_PROVIDER Mailet configuration parameter for providing a custom Guice provider for the KeystoreManager interface.
static String	KEYSTORE_MGR_STORE_TYPE Type of key store that is manage by the store manager.
static String	MONITORING_SERVICE_URL_PARAM Mailet configuration parameter for the URL of the message monitoring service.
static String	REJECT_ON_ROUTING_TAMPER Mailet configuration option determining if incoming messages should be rejected if the routing headers have been tampered with.
static String	SERVICE_SECURITY_AUTH_SECRET Mailet configuration parameter for providing the secret (i.e.
static String	SERVICE_SECURITY_AUTH_SUBJECT Mailet configuration parameter for providing the subject (i.e.
static String	SERVICE_SECURITY_MANAGER_PROVIDER Mailet configuration parameter for providing a custom Guice provider ServiceSecurityManager interface.
static String	SMTP_AGENT_AUDITOR_CONFIG_LOC Mailet configuration parameter for providing the location of an auditing configuration file.
static String	SMTP_AGENT_AUDITOR_PROVIDER Mailet configuration parameter for providing a custom Guice provider for the Auditor interface.
static String	SMTP_AGENT_CONFIG_PROVIDER Mailet configuration parameter for providing a custom Guice provider for the SmtpAgentConfig interface.
static String	USE_OUTGOING_POLICY_FOR_INCOMING_NOTIFICATIONS Mailet configuration option determining if the outgoing trust policy should be applied for incoming notification messages.

Constructor Summary

Constructors

Constructor and Description
SecurityAndTrustMailetOptions()

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

CONFIG_URL_PARAM

public static final String CONFIG_URL_PARAM

Mailet configuration parameter for the Direct configuration service URL.

This parameter is configured using the ConfigURL element of the NHINDSecurityAndTrustMailet configuration.

See Also:

Constant Field Values

MONITORING_SERVICE_URL_PARAM

public static final String MONITORING_SERVICE_URL_PARAM

Mailet configuration parameter for the URL of the message monitoring service.

This parameter is configured using the MessageMonitoringServiceURL element of the NHINDSecurityAndTrustMailet configuration.

JVM Parameter/Options Name: org.nhindirect.gateway.smtp.james.mailet.TxServiceURL

See Also:

Constant Field Values

AUTO_DSN_FAILURE_CREATION_PARAM

public static final String AUTO_DSN_FAILURE_CREATION_PARAM

Mailet configuration parameter that indicates if the mailet should automatically generate a DSN failure messages for outbound messages that do not succeed security and trust processing. The options are applied to both rejected messages and messages that have rejected recipients.
There are two options for this parameter: one controlling the generation of DSN messages for messages requesting reliable and timely delivery and one for those message not requesting the reliable and timely delivery. The parameter is set using a comma delimited string of options that are request to be turned on.
1. General: If this option is set, the mailet will generate a DSN message for messages not requesting reliable and timely delivery.
2. ReliableAndTimely: If this option is set, the mailet will generate a DSN message for messages requesting reliable and timely delivery. A typical configuration may look like the following: General,ReliableAndTimely
The ReliableAndTimely option is set by default if this parameter does not exist.

This option is configured using the AutoDSNFailueCreation element of the NHINDSecurityAndTrustMailet configuration.

JVM Parameter/Options Name: org.nhindirect.gateway.smtp.james.mailet.AutoDSNFailueCreation

See Also:

Constant Field Values

CONSUME_MND_PROCESSED_PARAM

public static final String CONSUME_MND_PROCESSED_PARAM

Mailet configuration option determining if MDN processed messages should be consumed by the mailet and not forwarded on to the edge protocol. Valid options are "true" or "false". This options defaults to false if not present.

This option is configured using the MessageMonitoringServiceURL element of the NotificationSuppressor configuration.

JVM Parameter/Options Name: org.nhindirect.gateway.smtp.james.mailet.ConsumeMDNProcessed

See Also:

Constant Field Values

USE_OUTGOING_POLICY_FOR_INCOMING_NOTIFICATIONS

public static final String USE_OUTGOING_POLICY_FOR_INCOMING_NOTIFICATIONS

Mailet configuration option determining if the outgoing trust policy should be applied for incoming notification messages. This is recommended to be set to true if your system will be exchanging messages with other Direct instances that are configured to allow outbound messages only. If this parameter is set to false, quality of service cannot be tracked for outbound only destinations. Valid options are "true" or "false".

This option can either be configured by using either the UseOutgoingPolicyForIncomingNotifications element of the NHINDSecurityAndTrustMailet configuration or set using the org.nhindirect.stagent.options.OptionsParameter#USE_OUTGOING_POLICY_FOR_INCOMING_NOTIFICATIONS

JVM Parameter/Options Name: org.nhindirect.gateway.smtp.james.mailet.ConsumeMDNProcessed

See Also:

Constant Field Values

SMTP_AGENT_CONFIG_PROVIDER

public static final String SMTP_AGENT_CONFIG_PROVIDER

Mailet configuration parameter for providing a custom Guice provider for the SmtpAgentConfig interface. This parameter is a string containing the fully qualified class name of the provider. If this parameter is empty or null, the WSSmtpAgentConfigProvider will be used by default.

This option is configured using the SmptAgentConfigProvider element of the NHINDSecurityAndTrustMailet configuration.

JVM Parameter/Options Name: org.nhindirect.gateway.smtp.james.mailet.SmptAgentConfigProvider

See Also:

Constant Field Values

SERVICE_SECURITY_MANAGER_PROVIDER

public static final String SERVICE_SECURITY_MANAGER_PROVIDER

Mailet configuration parameter for providing a custom Guice provider ServiceSecurityManager interface. Security managers are necessary for configuration service clients that use authentication protocols to protect vital configuration data such as anchors and certificates. This parameter is a string containing the fully qualified class name of the provider. If this parameter is empty or null, the OpenServiceSecurityManagerProvider will be used by default.

This option is configured using the ServiceSecurityManagerProvider element of the NHINDSecurityAndTrustMailet configuration.

JVM Parameter/Options Name: org.nhindirect.gateway.smtp.james.mailet.ServiceSecurityManagerProvider

See Also:

Constant Field Values

SERVICE_SECURITY_AUTH_SUBJECT

public static final String SERVICE_SECURITY_AUTH_SUBJECT

Mailet configuration parameter for providing the subject (i.e. user or client id) for authenticating to the configuration service if a protected security manager is configured.

This option is configured using the ServiceSecurityAuthSubject element of the NHINDSecurityAndTrustMailet configuration.

JVM Parameter/Options Name: org.nhindirect.gateway.smtp.james.mailet.ServiceSecurityAuthSubject

See Also:

Constant Field Values

SERVICE_SECURITY_AUTH_SECRET

public static final String SERVICE_SECURITY_AUTH_SECRET

Mailet configuration parameter for providing the secret (i.e. password or client secret) for authenticating to the configuration service if a protected security manager is configured.

This option is configured using the ServiceSecurityAuthSecret element of the NHINDSecurityAndTrustMailet configuration.

JVM Parameter/Options Name: org.nhindirect.gateway.smtp.james.mailet.ServiceSecurityAuthSecret

See Also:

Constant Field Values

SMTP_AGENT_AUDITOR_PROVIDER

public static final String SMTP_AGENT_AUDITOR_PROVIDER

Mailet configuration parameter for providing a custom Guice provider for the Auditor interface. This parameter is a string containing the fully qualified class name of the provider. If this parameter is empty or null, no provider will be configured and the system will use a log file based auditor by default.

This option is configured using the SmptAgentAuditorProvider element of the NHINDSecurityAndTrustMailet configuration.

JVM Parameter/Options Name: org.nhindirect.gateway.smtp.james.mailet.SmptAgentAuditorProvider

See Also:

Constant Field Values

SMTP_AGENT_AUDITOR_CONFIG_LOC

public static final String SMTP_AGENT_AUDITOR_CONFIG_LOC

Mailet configuration parameter for providing the location of an auditing configuration file. This parameter is a string containing the name or relative name of the configuraton file. If this parameter is empty or null, a default configuration location will be selected by the auditor if it support declaractive based configuration.

This option is configured using the SmptAgentAuditorConifgLocation element of the NHINDSecurityAndTrustMailet configuration.

JVM Parameter/Options Name: org.nhindirect.gateway.smtp.james.mailet.SmptAgentAuditorConifgLocation

See Also:

Constant Field Values

KEYSTORE_MGR_PROVIDER

public static final String KEYSTORE_MGR_PROVIDER

Mailet configuration parameter for providing a custom Guice provider for the KeystoreManager interface. This parameter is a string containing the fully qualified class name of the provider. If this parameter is empty or null, no provider will be configured and the system not use a keystore manager.

This option is configured using the KeystoreManagerProvider element of the NHINDSecurityAndTrustMailet configuration.

JVM Parameter/Options Name: org.nhindirect.gateway.smtp.james.mailet.KeystoreManagerProvider

See Also:

Constant Field Values

KEYSTORE_MGR_PIN

public static final String KEYSTORE_MGR_PIN

Mailet configuration parameter for providing the pin for a keystore manager.

This option is configured using the KeystoreManagerPin element of the NHINDSecurityAndTrustMailet configuration.

JVM Parameter/Options Name: org.nhindirect.gateway.smtp.james.mailet.KeystoreManagerPin

See Also:

Constant Field Values

KEYSTORE_MGR_KEYSTORE_PASSPHRASE_ALIAS

public static final String KEYSTORE_MGR_KEYSTORE_PASSPHRASE_ALIAS

Alias in the key store manager for the KeystorePassPhraseAlias string.

This option is configured using the KeystorePassPhraseAlias element of the NHINDSecurityAndTrustMailet configuration.

JVM Parameter/Options Name: org.nhindirect.gateway.smtp.james.mailet.KeystorePassPhraseAlias

See Also:

Constant Field Values

KEYSTORE_MGR_PRIVATE_KEY_PASSPHRASE_ALIAS

public static final String KEYSTORE_MGR_PRIVATE_KEY_PASSPHRASE_ALIAS

Alias in the key store manager for the PrivateKeyPassPhraseAlias string.

This option is configured using the KeystorePassPhraseAlias element of the NHINDSecurityAndTrustMailet configuration.

JVM Parameter/Options Name: org.nhindirect.gateway.smtp.james.mailet.PrivateKeyPassPhraseAlias

See Also:

Constant Field Values

KEYSTORE_MGR_STORE_TYPE

public static final String KEYSTORE_MGR_STORE_TYPE

Type of key store that is manage by the store manager. Default is PKCS11.

This option is configured using the KeyManagerStoreType element of the NHINDSecurityAndTrustMailet configuration.

JVM Parameter/Options Name: org.nhindirect.gateway.smtp.james.mailet.KeystoreManagerStoreType

See Also:

Constant Field Values

KEYSTORE_MGR_PKCS11_PROVIDER

public static final String KEYSTORE_MGR_PKCS11_PROVIDER

The PKCS11 JCE provider. Default is sun.security.pkcs11.SunPKCS11.

This option is configured using the KeystoreManagerPKCS11Provider element of the NHINDSecurityAndTrustMailet configuration.

JVM Parameter/Options Name: org.nhindirect.gateway.smtp.james.mailet.KeystoreManagerPKCS11Provider

See Also:

Constant Field Values

KEYSTORE_MGR_PKCS11_CONFIG_FILE

public static final String KEYSTORE_MGR_PKCS11_CONFIG_FILE

The sun.security.pkcs11.SunPKCS11 PKCS11 JCE provider requires a configuration file specific to the SunPKCS11 provider. This option is the location of that file.

This option is configured using the KeystoreManagerPKCS11ConfigFile element of the NHINDSecurityAndTrustMailet configuration.

JVM Parameter/Options Name: org.nhindirect.gateway.smtp.james.mailet.KeystoreManagerPKCS11ConfigFile

See Also:

Constant Field Values

KEYSTORE_MGR_PKCS11_PROVIDER_CUSTOM_CONFIG_FILE

public static final String KEYSTORE_MGR_PKCS11_PROVIDER_CUSTOM_CONFIG_FILE

Some PKCS11 providers allow for additional configuration via a file that is sent to the Keystore.load() method. This option is the location of that file.

This option is configured using the KeystoreManagerPKCS11ProviderCustomConfigFile element of the NHINDSecurityAndTrustMailet configuration.

JVM Parameter/Options Name: org.nhindirect.gateway.smtp.james.mailet.KeystoreManagerPKCS11ProviderCustomConfigFile

See Also:

Constant Field Values

KEYSTORE_MGR_PKCS11_PROVIDER_CUSTOM_CONFIG_STRING

public static final String KEYSTORE_MGR_PKCS11_PROVIDER_CUSTOM_CONFIG_STRING

Some PKCS11 providers allow for additional configuration via a file that is sent to the Keystore.load() method. This option allows the content of that file to be set as a String configuration parameter instead of referencing an external file.

This option is configured using the KeystoreManagerPKCS11ProviderCustomConfigString element of the NHINDSecurityAndTrustMailet configuration.

JVM Parameter/Options Name: org.nhindirect.gateway.smtp.james.mailet.KeystoreManagerPKCS11ProviderCustomConfigString

See Also:

Constant Field Values

JCE_PROVIDER_NAME

public static final String JCE_PROVIDER_NAME

The name of the JCE provider to use for cryptographic operations. By default, the security and trust agent uses the BouncyCastle library denoted with then provider name "BC".

This option is configured using the JCE_PROVIDER element of the NHINDSecurityAndTrustMailet configuration.

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

See Also:

Constant Field Values

JCE_SENTITIVE_PROVIDER

public static final String JCE_SENTITIVE_PROVIDER

The name of the JCE provider to use for cryptographic operations that utilized sensitive private key material. For systems that require higher level of security specifically those that meet FIPS 140-2 requirement, this string represent a provider that is backed by a PKCS11 compatible security token. By default, the security and trust agent uses the BouncyCastle library denoted with then provider name "BC".

This option is configured using the JCE_SENTITIVE_PROVIDER element of the NHINDSecurityAndTrustMailet configuration.

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

See Also:

Constant Field Values

REJECT_ON_ROUTING_TAMPER

public static final String REJECT_ON_ROUTING_TAMPER

Mailet configuration option determining if incoming messages should be rejected if the routing headers have been tampered with. Valid options are "true" or "false".

This option can either be configured by using either the RejectOnRoutingTamper element of the NHINDSecurityAndTrustMailet configuration or set using the org.nhindirect.stagent.options.OptionsParameter#REJECT_ON_ROUTING_TAMPER

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

See Also:

Constant Field Values

Constructor Detail

SecurityAndTrustMailetOptions

public SecurityAndTrustMailetOptions()