AS2 Connector

The AS2 Component adds AS2 send and receive capabilities to MuleSoft.

Remarks

The AS2 Connector adds AS2 send and receive capabilities to your Mule Project. Built on top of the Drummond/eBusinessReady Certified EDI Integrator / AS2 Engine, the connector allows you to easily incorporate secure EDI (EDI-INT) exchange into your current e-Business process architecture.

AS2 Receive Connector

The AS2 Receive Connector requires another entity to listen for incoming HTTP requests and to send responses back to the client. An HTTP Listener may be used in conjunction with the AS2 Receive Connector to create a fully-functional AS2 server.

In order to use the AS2 Receive Connector, you must set the TradingPartner and ReceivingPartner properties. Optionally set the ReceiveMode property to control whether the connector is configured to process AS2 messages or verify MDN receipts.

By default, the connector sets the required MessageSecurity on incoming AS2 requests to the highest level. If your messages require security, you must set an EncryptionCert and/or SignerCert. It is also recommended that you set an MDNSigningCert in order to provide non-repudiation for your AS2 response.

The connector will populate ResponseHeaders and ResponseBody after processing the request.

HTTP Listener Configuration

In a typical scenario a HTTP listener is used to receive the original request and send the response because the connector does not have a webserver of its own. The connector will process the request and generate the response, but will rely on the HTTP Listener to relay the response back to the client. In order to configure the HTTP Listener to relay the response to the client, follow the below steps.

In the Mule HTTP Listener's Responses section set the Body to #[attributes.ResponseBody]. Then, add a new header with value 'Content-Type' and value attributes.ResponseHeaders.'Content-Type'.

The corresponding Configuration XML may look like:

<http:response > <http:body ><![CDATA[#[attributes.ResponseBody]]]></http:body> <http:headers ><![CDATA[#[output applicaton/java --- { "Content-Type" : attributes.ResponseHeaders.'Content-Type' }]]]></http:headers> </http:response>

AS2 Send Connector

The AS2 Send Connector adds a complete AS2 client within your Mule Project. In order to use it, you must set a minimum of three required properties: AS2To, AS2From and URL. It is also recommended that you set MDNTo, RecipientCert, ReceiptSignerCert, and SigningCert in order to make use of security, reliability, and non-repudiation.

The AS2 Send Connector has support for SSL transport layer security. This may be enabled by setting the SSLCert and SSLAcceptServerCert to appropriate values.

Certification and Interoperability

The AS2 Connector for Mule Project has been built on top of the EDI Integrator / AS2 Engine which has successfully completed the latest Drummond/eBusinessReady Certified program for AS2 interoperability. The product has undergone rigorous compliance testing and QA, demonstrating successful interoperability with all other DGI (UCC) AS2 certified products.

The eBusinessReady program provides neutral third party testing of solutions for interoperability and compliance. eBusinessReady is a joint partnership of the UCC (Uniform Code Council, Inc) and DGI (Drummond Group, Inc).

Receiver Property List

The following is the full list of the properties of the receiver Connector with short descriptions. Click on the links for further details.


AS2From	The identity of the sending system.
AS2MessageId	The Id of the message.
AS2RequestEDIType	The MIME type of the data.
AS2RequestFrom	The identity of the sending system.
AS2RequestLogFile	The file used to log AS2 request information.
AS2RequestScanResult	The result of parsing the request.
AS2RequestSubject	The subject of the received message.
AS2RequestTo	The identity of the receiving system.
AS2To	The identity of the receiving system.
EncryptionCert	The digital id to be used for decryption.
Firewall	A set of properties related to firewall access.
HTTPProxy	A set of properties related to proxy access.
IncomingDirectory	The directory to be used to store incoming messages.
LogDirectory	The path to a directory for logging.
LogFile	The file to write logging information to at runtime.
LogMode	What information gets logged during component execution.
LogType	How information gets logged during component execution.
MDNDisposition	The Disposition header in the MDN receipt.
MDNMICAlgorithm	The algorithm used to sign the outgoing MDN.
MDNMICValue	The Message Integrity Check(s) (one-way hash) of the EDI message.
MDNReceipt	The MDN-based receipt generated by the component.
MDNReceiptDeliveryOption	A URL indicating how the receipt is to be delivered.
MDNReceiptHeaders	The AS2 headers returned with the receipt.
MDNReceiptMessage	The textual message included in the MDN.
MDNReceiptMessageId	The Id of the MDN message.
MDNSignatureStatus	The validity of the signature in the MDN receipt.
MDNSigningCert	The digital id to be used to sign the MDN (optional).
MessageSecurity	Required security level for incoming messages.
Other	Defines a set of configuration settings to be used by the component.
ReceiptHeaders	The AS2 headers that are returned with the receipt.
ReceiptMessage	The textual message that is included in the receipt.
ReceiptSigningProtocol	The protocol used to sign the outgoing MDN receipt.
ReceivedFileName	The name of the file received by the AS2 component.
ReceiveMode	Controls whether the component is configured to process AS2 messages or MDN receipts.
ReceivingPartner	The identity of AS2 receiving entity.
RequestHeaders	The headers included in the AS2 request.
ResponseBody	The response body to be sent to the client.
ResponseHeaders	A collection of response headers.
RolloverCertificate	The rollover decryption and receipt signing certificate.
RuntimeLicense	Specifies the component runtime license key.
SignerCert	The signing certificate of the trading partner.
SSLAcceptServerCert	For sending HTTPS requests, a server certificate to unconditionally accept.
SSLCert	The certificate to use for client authentication during the SSL handshake.
Timeout	A timeout for the component.
TradingPartner	The trading partner that will be communicating with this receive location.

Sender Property List

The following is the full list of the properties of the sender Connector with short descriptions. Click on the links for further details.


AS2From	The identity of the sending system.
AS2MessageId	The Id of the message.
AS2To	The identity of the receiving system.
CompressionFormat	The compression format (if any) to use.
EDIFileName	The name to be used in the Content-Disposition MIME header of the outbound request.
EDIType	The MIME type of the data.
EncryptionAlgorithm	The algorithm, if any, used to encrypt the EDI data.
ErrorCode	TBD.
ErrorMessage	TBD.
Firewall	A set of properties related to firewall access.
HTTPPassword	A password if authentication is to be used.
HTTPProxy	A set of properties related to proxy access.
HTTPUser	A user name if authentication is to be used.
LogDirectory	The path to a directory for logging.
LogFile	The file to write logging information to at runtime.
LogMode	What information gets logged during component execution.
LogType	How information gets logged during component execution.
MDNMICValue	The Message Integrity Check(s) (one-way hash) of the EDI message.
MDNOptions	Used to indicate the options requested for the MDN receipt.
MDNReceiptAS2From	The identity of the sending system.
MDNReceiptAS2To	The identity of the receiving system.
MDNReceiptHeaders	The AS2 headers returned with the receipt.
MDNReceiptLogFile	The file used for logging MDN information.
MDNReceiptMessage	The textual message included in the MDN.
MDNReceiptMessageId	The Id of the MDN message.
MDNTo	Used to indicate that a message disposition notification is requested.
Other	Defines a set of configuration settings to be used by the component.
ReceiptHeaders	The AS2 headers that are returned with the receipt.
ReceiptMDN	The MDN generated by the component.
ReceiptMessage	The textual message that is included in the receipt.
ReceiptSignerCert	The certificate of the receipt signer.
RecipientCert	The certificate of the recipient.
RolloverSigningCert	An additional certificate used to sign the outgoing AS2 request when transitioning certificates.
RuntimeLicense	Specifies the component runtime license key.
SigningCert	The certificate used to sign the outgoing AS2 request.
SSLAcceptServerCert	For sending HTTPS requests, a server certificate to unconditionally accept.
SSLCert	The certificate to use for client authentication during the SSL handshake.
Timeout	A timeout for the component.
URL	The URL to post to.

Config Settings

The following is a list of config settings for the Connector with short descriptions. Click on the links for further details.


AcceptAnySignerCert	Used to accept trust any signing certificate unconditionally.
AS2Subject	The subject of the message.
AsyncMDNInfoDir	The location on disk where MDN information is stored.
ChunkSize	Specifies the chunk size in bytes when using chunked encoding.
ErrorOnNegativeMDN	Whether an exception should be raised when a negative MDN is received.
ErrorProcessingFlags	Flags controlling how errors affect ProcessRequest.
ErrorReportingFlags	Flags controlling how errors affect the MDNReceipt.
From	The email address of the HTTP agent (optional).
IgnoreLoggingErrors	Whether to ignore errors that occur when writing to the log.
LogDebug	Whether to log debug data.
MDNDeliveryOption	A URL indicating how the receipt is to be delivered.
MDNWarning	A warning to appear in the MDN.
OAEPMGF1HashAlgorithm	The MGF1 hash algorithm used when encrypting a key.
OAEPParams	The hex encoded OAEP parameters to be used when encrypting a key.
OAEPRSAHashAlgorithm	The RSA hash algorithm used when encrypting a key.
OtherHeaders	Other headers as determined by the user.
SignatureAlgorithm	Signature algorithm to be used in outgoing messages.
SMTPFrom	The senders address for asynchronous MDN delivery.
SMTPServer	The SMTP server for asynchronous MDN delivery.
SMTPSubject	The SMTP message subject for asynchronous MDN delivery.
UseChunkedEncoding	Whether to chunk outgoing posts.
UseOAEP	Whether to use Optimal Asymmetric Encryption Padding (OAEP) when encrypting the key with RSA.
UsePSS	Whether to use RSA-PSS when signing.
UserAgent	Information about the user agent.
ReuseSSLSession	Determines if the SSL session is reused.
SSLCipherStrength	The minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuites	The cipher suite to be used in an SSL negotiation.
SSLEnabledProtocols	Used to enable/disable the supported security protocols.
SSLIncludeCertChain	Whether the entire certificate chain is included in the SSLServerAuthentication event.
SSLSecurityFlags	Flags that control certificate verification.
TLS12SignatureAlgorithms	Defines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
TLS12SupportedGroups	The supported groups for ECC.
TLS13KeyShareGroups	The groups for which to pregenerate key shares.
TLS13SignatureAlgorithms	The allowed certificate signature algorithms.
TLS13SupportedGroups	The supported groups for (EC)DHE key exchange.
AbsoluteTimeout	Determines whether timeouts are inactivity timeouts or absolute timeouts.
LocalHost	The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
TcpNoDelay	Whether or not to delay when sending packets.
UseInternalSecurityAPI	Tells the component whether or not to use the system security libraries or an internal implementation.

AS2From Property (AS2 Connector)

The identity of the sending system.

Data Type

String

Default Value

Remarks

In the AS2Receiver this is your partner's AS2 identifier, and in the AS2Sender this is your AS2 identifier. It may be company name, DUNS number, or anything agreed on by trading partners. Please note that this property is case-sensitive.

AS2MessageId Property (AS2 Connector)

The Id of the message.

Data Type

String

Default Value

Remarks

The Id format is as in RFC 2822: id-left@id-right .

If you set MessageId to a string of the form "@(id-right)" a unique id-left will be generated. If you set MessageId to an empty string, a new MessageId will be generated with the same id-right.

You may insert the keyword "%MessageId%" anywhere in the value to have the connector generate and insert a globally unique identifier.

The Id format is as in RFC 2822: id-left@id-right.

A unique Id will automatically be generated on startup. Sending a message will reset id-left if the MessageId has been used in the previous message.

If you set MessageId to a string of the form "@(id-right)" a unique id-left will be generated. If you set MessageId to an empty string, a new MessageId will be generated with the same id-right.

The default value is empty string, meaning the connector will generate a unique Id.

This setting is only applicable to the send connector.

AS2RequestEDIType Property (AS2 Connector)

The MIME type of the data.

Data Type

String

Default Value

Remarks

This property corresponds to the Content-Type header in the AS2 request.

This property is not available in the Sender.

AS2RequestFrom Property (AS2 Connector)

The identity of the sending system.

Data Type

String

Default Value

Remarks

This is your partner's AS2 Identifier. It may be company name, DUNS number, or anything agreed on by trading partners. Please note that this property is case-sensitive.

This property is not available in the Sender.

AS2RequestLogFile Property (AS2 Connector)

The file used to log AS2 request information.

Data Type

String

Default Value

Remarks

If LogDirectory is specified, log files will be written in the specified directory and AS2RequestLogFile will contain the path. A diagnostic log will be written with filename LogFile + ".log". In case of an error, an additional file will be written with filename LogFile + ".err". In the Receive Connector, the EDI data will be written with filename LogFile + ".dat".

Since this log file is dynamically generated, this property can be read after the connector has processed the message to determine the exact name of the log file.

This property is not available in the Sender.

AS2RequestScanResult Property (AS2 Connector)

The result of parsing the request.

Data Type

Integer

Default Value

Remarks

ScanResult will contain information about any errors that occurred while parsing the incoming AS2 request. ScanResult will contain 0 if no errors occurred, otherwise it will contain one or more of the following errors. If multiple errors are reported the results will be OR-ed together.


0x01	Unable to decrypt data.
0x02	Unable to decompress data.
0x04	Unable to validate integrity of data.
0x08	Unable to verify the signature.
0x10	Client requested unsupported signature type.
0x20	Client requested unsupported MIC algorithm.
0x40	Insufficient message security, as determined by the MessageSecurity property.

This property is not available in the Sender.

AS2RequestSubject Property (AS2 Connector)

The subject of the received message.

Data Type

String

Default Value

Remarks

The optional human-readable subject of the received message.

This property is not available in the Sender.

AS2RequestTo Property (AS2 Connector)

The identity of the receiving system.

Data Type

String

Default Value

Remarks

This is the AS2 Identifier of your trading partner. It may be company name, DUNS number, or anything agreed on by trading partners. Please note that this property is case-sensitive.

This property is not available in the Sender.

AS2To Property (AS2 Connector)

The identity of the receiving system.

Data Type

String

Default Value

Remarks

In the AS2Receiver this is your AS2 identifier, and in the AS2Sender this is your partner's AS2 identifier. It may be company name, DUNS number, or anything agreed on by trading partners. Please note that this property is case-sensitive.

CompressionFormat Property (AS2 Connector)

The compression format (if any) to use.

Data Type

Enumeration

Possible Values

None (0)
ZLIB (1)

Default Value

Remarks

By default, outgoing data will not be compressed. Setting this property will instruct the connector to compress the outgoing data using the indicated format.

Compression is highly recommended for large messages, as it will reduce network bandwidth and processing time required.

The compression algorithm used is Zlib, as required by RFC 3274 and defined in RFCs 1950 and 1951.

This property is not available in the Receiver.

EDIFileName Property (AS2 Connector)

The name to be used in the Content-Disposition MIME header of the outbound request.

Data Type

String

Default Value

"rfc1767.edi"

Remarks

If set, the value specified will be used when creating the outbound request's Content-Disposition MIME header of the EDI payload.

This property is not available in the Receiver.

EDIType Property (AS2 Connector)

The MIME type of the data.

Data Type

String

Default Value

"application/edi-x12"

Remarks

This property corresponds to the Content-Type header in the AS2 request. This is often used to determine how the message is processed. Suitable MIME types include "application/edi-x12", "application/edifact", or "application/xml".

This property is not available in the Receiver.

EncryptionAlgorithm Property (AS2 Connector)

The algorithm, if any, used to encrypt the EDI data.

Data Type

String

Default Value

"3DES"

Remarks

If RecipientCert is set to a valid certificate, the data will be encrypted using this certificate, with the algorithm specified. If EncryptionAlgorithm is set to the empty string, the data will not be encrypted.

The connector supports "3DES", or industry-standard 168-bit Triple-DES encryption. Use of this algorithm is strongly recommended.

The connector supports "RC2", with a default keysize of 128 bits. You may also set "RC2CBC40" or "RC2CBC64" for 40- or 64-bit keysizes.

The connector also supports single "DES".

In addition, the connector supports "AES" encryption with a default keysize of 128 bits. You may also set "AESCBC192" or "AESCBC256" for 192- and 256-bit keysizes.

This property is not available in the Receiver.

EncryptionCert Property (AS2 Connector)

The digital id to be used for decryption.

Data Type

Certificate

Remarks

This property is used to assign a specific certificate for processing encrypted messages. If MDNSigningCert is not set and a digital signature is required by the incoming AS2 request, EncryptionCert will also be used to generate the digital signature.

This field is used to set a Private Key Certificate.

Private key certificates may be loaded from the registry, from files in PKCS#12 format, or from a PEM file format.

This property is not available in the Sender.

ErrorCode Property (AS2 Connector)

TBD.

Data Type

Integer

Default Value

Remarks

TBD

This property is not available in the Receiver.

ErrorMessage Property (AS2 Connector)

TBD.

Data Type

String

Default Value

Remarks

TBD

This property is not available in the Receiver.

Firewall Property (AS2 Connector)

A set of properties related to firewall access.

Data Type

Firewall

Remarks

This is a Firewall type property which contains fields describing the firewall through which the connector will attempt to connect.

Note: the Firewall property is only applicable in the Receive Connector when sending asynchronous MDNs.

HTTPPassword Property (AS2 Connector)

A password if authentication is to be used.

Data Type

Password

Default Value

Remarks

This property holds the password used for HTTP authentication.

This property is not available in the Receiver.

HTTPProxy Property (AS2 Connector)

A set of properties related to proxy access.

Data Type

Proxy

Remarks

This is a Proxy type property which contains fields describing the proxy through which the connector will attempt to connect.

HTTPUser Property (AS2 Connector)

A user name if authentication is to be used.

Data Type

String

Default Value

Remarks

This property holds the user used for HTTP authentication.

This property is not available in the Receiver.

IncomingDirectory Property (AS2 Connector)

The directory to be used to store incoming messages.

Data Type

String

Default Value

Remarks

If IncomingDirectory is set, the received message is stored as a file in that directory. If a filename is specified in the EDI message, the connector will write to the specified filename, otherwise, a filename will be automatically generated based on a timestamp of the incoming transmission. In either case, if the filename exists on disk, the data will be written to the same name with a "-duplicate?" appended to the filename, where "?" is the number of duplicates.

This property is not available in the Sender.

LogDirectory Property (AS2 Connector)

The path to a directory for logging.

Data Type

String

Default Value

Remarks

Setting LogDirectory will instruct the connector to log the details of each transmission to unique files in the specified directory.

In the Send Connector, the connector will write a single file for each transmission, with extension ".log". In case of error an additional file will be written with extension ".err", and the error will be reported in both files.

In the Receive Connector, two files will be written for each transmission. The diagnostic log will have the extension ".log" and will log the complete text of the incoming request, the EDI data (if it could to be determined), and the outgoing response. The data file will have the extension ".dat" and will store the EDI data only. In the event of an error, an additional file with extension ".err" file will be written, and the error information will also be written to the ".log" file.

In both cases, the filenames will be chosen automatically by the connector. Each filename will be the system time, in the format YYYY-MM-DD-HH-MM-SS-MMMM. The extensions "-2", "-3", etc. will be used in the case of a file conflict.

If either log cannot be written, an error will be reported in the event log. The Mule Project administrator should ensure that the appropriate write permissions are available.

LogFile Property (AS2 Connector)

The file to write logging information to at runtime.

Data Type

String

Default Value

Remarks

If LogDirectory is specified, log files will be written in the specified directory and LogFile will contain the path. A diagnostic log will be written with filename LogFile + ".log". In case of an error, an additional file will be written with filename LogFile + ".err". In the Receive Connector, the EDI data will be written with filename LogFile + ".dat".

Since this log file is dynamically generated, this property can be read after the connector has processed the message to determine the exact name of the log file.

To write logging information to a file instead of using the connector's logging API, set this property to a valid file on disk and set the LogType property to "File".

LogMode Property (AS2 Connector)

What information gets logged during component execution.

Data Type

Enumeration

Possible Values

Verbose (0)
Info (1)
Warning (2)
Error (3)
Fatal (4)

Default Value

Remarks

This property controls what information the connector logs. The possible values have the following affect on the connector's behavior:


Verbose	The connector will report all information regarding the transport.
Info	The connector will report all major operations, as well as all warnings and errors.
Warning	The connector will report any conditions that could result in unpredictable behavior as well as errors.
Error	The connector will report all errors that prevent normal operations from completing.
Fatal	The connector will report only serious errors that cause the connector to completely stop functioning.

LogType Property (AS2 Connector)

How information gets logged during component execution.

Data Type

Enumeration

Possible Values

None (0)
Console (1)
File (2)

Default Value

Remarks

This property controls where the connector will log the information. The possible values have the following affect on the connector's behavior:


None	The connector will not report any logging information.
Console	The connector will report all logging information to the console.
File	The connector will report all logging information to a file. The desired file must be specified in the LogFile when this type has been selected.

MDNDisposition Property (AS2 Connector)

The Disposition header in the MDN receipt.

Data Type

String

Default Value

Remarks

This property is returned in the message context to determine the reported status of the AS2 message delivery. If the message was processed successfully, you should expect a disposition of

automatic-action/MDN-sent-automatically; processed

Other possible, but less likely, successful dispositions include:

manual-action/MDN-sent-automatically; processed manual-action/MDN-sent-manually; processed

Otherwise, the disposition will report the error encountered by the AS2 receiver when the message was processed. It is recommended that you read this values in your orchestration to determine the overall status of the AS2 message delivery.

This property is not available in the Sender.

MDNMICAlgorithm Property (AS2 Connector)

The algorithm used to sign the outgoing MDN.

Data Type

Enumeration

Possible Values

As Requested (0)
As Requested Or SHA1 (1)
SHA1 (2)
MD5 (3)
None (4)
SHA256 (5)
SHA384 (6)
SHA512 (7)
SHA224 (8)
As Requested Or SHA256 (9)

Default Value

Remarks

By default, the connector will honor the request of the client, if possible. The MIC will be calculated using the requested algorithm and reported in the outgoing MDN. If it is not possible to honor the client request, the MDN will not be signed and an error will be generated, unless ErrorProcessingFlags has been configured to prevent this.

The property may be configured in a variety of other ways as well. If set to AsRequestedOrSHA256, the connector will honor requests for a signed receipt as with AsRequested. If unable to comply, or if a signature was not explicitly requested, the MIC will still be calculated using the SHA256 algorithm. The ReceiptSigningProtocol property may then be set to return a signed receipt. Use extreme caution when doing this; it will result in a non-RFC compliant server.

The following options are supported:


0	As Requested
1	As Requested Or SHA1
2	SHA1
3	MD5
4	None
5	SHA-256
6	SHA-384
7	SHA-512
8	SHA-224
9	As Requested Or SHA-256

This property is not available in the Sender.

MDNMICValue Property (AS2 Connector)

The Message Integrity Check(s) (one-way hash) of the EDI message.

Data Type

String

Default Value

Remarks

In the Send Connector, the MDNMICValue is computed using the algorithm expected in the Received-Content-MIC of the signed receipt. This will be the same as the signature algorithm used for signed messages, or SHA1 otherwise.

In the Receive Connector, the MDNMICValue is calculated using the algorithm used on the incoming message's signature, or SHA-1 if the incoming message is not signed.

The MIC will be base64 encoded and reported with the algorithm name as specified in RFC 3335; e.g., "w7AguNJEmhF/qIjJw6LnnA==, md5".

MDNOptions Property (AS2 Connector)

Used to indicate the options requested for the MDN receipt.

Data Type

String

Default Value

"signed-receipt-protocol=optional, pkcs7-signature; signed-receipt-micalg=optional, sha-256, sha1"

Remarks

By default, the connector will request that the MDN be signed with a PKCS#7 signature over an SHA1, SHA-256, or MD5 hash (if these algorithms are supported by the server).

Set MDNOptions to an empty string to request an unsigned receipt.

The string format is that of the Disposition-notification-options HTTP header, as specified in RFC 3335. As a form of shorthand, you may set this property to "sha1", "sha-256", or "md5" to request the indicated hash algorithm.

This property is not available in the Receiver.

MDNReceipt Property (AS2 Connector)

The MDN-based receipt generated by the component.

Data Type

String

Default Value

Remarks

In the Send Connector, this property will contain the receipt after it is received by the server.

In the Receive Connector, this property will contain the receipt that was generated by the connector and delivered to the sender.

The receipt will be a signed or unsigned multipart/report in MIME format. The MDNReceipt will consist of the MDN itself, the human-readable ReceiptMessage, MIME headers and footers, and a signature if applicable. The MDN will automatically be parsed out and stored in the MDN property. It will report either success or failure depending on ScanResult.

A variety of properties may be used to customize the outgoing MDN. The MIC algorithm used in the MDN may be set with MDNMICAlgorithm. MDNReportingUA specifies the reporting agent and MDNSendingMode may be used to specify the level of interaction with the user.

The signature, if any, will use the protocol specified by ReceiptSigningProtocol, and the certificate specified.

Error reporting may be controlled by configuring ErrorReportingFlags. By default, any errors will cause MDN to report a failure to process the message. Either "failed/Failure" or "processed/Error" will be reported, according to the specification and the type of error. Setting ErrorReportingFlags will cause the MDN to overlook the chosen types of errors. If all errors are overlooked, the MDN will report success and calculate a MIC on the original message as usual. A warning may be reported by setting MDNWarning;.

This property is not available in the Sender.

MDNReceiptAS2From Property (AS2 Connector)

The identity of the sending system.

Data Type

String

Default Value

Remarks

Specifies the AS2-From header for the MDN receipt.

This property is not available in the Receiver.

MDNReceiptAS2To Property (AS2 Connector)

The identity of the receiving system.

Data Type

String

Default Value

Remarks

Specifies the AS2-To header for the MDN receipt.

This property is not available in the Receiver.

MDNReceiptDeliveryOption Property (AS2 Connector)

A URL indicating how the receipt is to be delivered.

Data Type

String

Default Value

Remarks

This property corresponds to the Receipt-delivery-option header in the AS2 request. If nonempty, the client has requested that the receipt be sent asynchronously to the URL specified. If empty, the receipt is to be delivered synchronously in the HTTP reply. In either case, the receipt is delivered once the response message has been prepared and returned to the connector.

MDNReceiptDeliveryOption does not indicate whether or not a receipt was actually requested. If an MDN was requested, that information is given in MDNTo.

This property is not available in the Sender.

MDNReceiptHeaders Property (AS2 Connector)

The AS2 headers returned with the receipt.

Data Type

String

Default Value

Remarks

In the Send Connector, this property refers to the MDN receipt after it is received by the server.

In the Receive Connector, this property refers to the MDN receipt that is generated by the connector and delivered to the sender.

Includes headers such as AS2-From, AS2-To, Date, Content-Type, etc.

MDNReceiptLogFile Property (AS2 Connector)

The file used for logging MDN information.

Data Type

String

Default Value

Remarks

If LogDirectory is specified, log files will be written in the specified directory and MDNReceiptLogFile will contain the path. A diagnostic log will be written with filename LogFile + ".log". In case of an error, an additional file will be written with filename LogFile + ".err". In the Receive Connector, the EDI data will be written with filename LogFile + ".dat".

Since this log file is dynamically generated, this property can be read after the connector has processed the message to determine the exact name of the log file.

This property is not available in the Receiver.

MDNReceiptMessage Property (AS2 Connector)

The textual message included in the MDN.

Data Type

String

Default Value

Remarks

In the Send Connector, this property refers to the MDN receipt after it is received by the server.

In the Receive Connector, this property refers to the MDN receipt that is generated by the connector and delivered to the sender.

The human-readable portion of the MDN receipt.

MDNReceiptMessageId Property (AS2 Connector)

The Id of the MDN message.

Data Type

String

Default Value

Remarks

In the Send Connector, this property refers to the MDN receipt after it is received by the server.

In the Receive Connector, this property refers to the MDN receipt that is generated by the connector and delivered to the sender.

This value can be used to identify the MDN. The Id format is as in RFC 2822: id-left@id-right.

MDNSignatureStatus Property (AS2 Connector)

The validity of the signature in the MDN receipt.

Data Type

String

Default Value

"Valid"

Remarks

This property contains the status of the signature verification attempted by the connector. The following values may be returned:


Valid	A valid signature was included in the MDN Receipt.
Invalid	A signature was included in the MDN Receipt, but was either invalid or could not be verified with the provided certificate.
None	No signature was included in the MDN Receipt.

It is recommended that you check this values in your orchestration to ensure that the MDN is signed as expected and contains a valid signature. Ordinarily, only "Valid" results indicate a successful MDN, but if you have requested an unsigned MDN by setting the MDNOptions configuration setting, "None" is also an acceptable value.

This property is not available in the Sender.

MDNSigningCert Property (AS2 Connector)

The digital id to be used to sign the MDN (optional).

Data Type

Certificate

Remarks

This property is used to assign a specific certificate for generating digital signatures. If MDNSigningCert is not set and a digital signature is required by the incoming AS2 request, EncryptionCert will be used in its place.

This field is used to set a Private Key Certificate.

Private key certificates may be loaded from the registry, from files in PKCS#12 format, or from a PEM file format.

This property is not available in the Sender.

MDNTo Property (AS2 Connector)

Used to indicate that a message disposition notification is requested.

Data Type

String

Default Value

Remarks

If this property is set, a Disposition-Notification-To header will be added to the request, and an MDN will be requested. The value may be an email address, URL, etc., and while the presence of this header is necessary for an MDN to be returned, typically the value of the header will be ignored by the server.

By default, the connector will request a PKCS#7 signature and synchronous delivery. You may set MDNDeliveryOption to request an asynchronous MDN, and you may set MDNOptions to request a different type of signature, or no signature at all.

This property is not available in the Receiver.

MessageSecurity Property (AS2 Connector)

Required security level for incoming messages.

Data Type

Enumeration

Possible Values

None (0)
Signed (1)
Encrypted (2)
Signed And Encrypted (3)

Default Value

Remarks

The default value is "Signed And Encrypted", in which case both a valid signature and encryption are required for incoming messages.

Other values include "Signed" and "Encrypted", in which case only a valid signature and/or encryption is required.

Finally, there is a fourth level, "None", which allows all messages. CAUTION: this level is included for debugging purposes only. There is no security with this level.

This property is not available in the Sender.

Other Property (AS2 Connector)

Defines a set of configuration settings to be used by the component.

Data Type

String

Default Value

Remarks

The connector accepts one or more configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the connector, access to these internal properties is provided through the Other property.

The Other property may be set to one or more configuration settings (name/value pairs). Set one setting per line. For example: configname1=value1 configname2=value2

ReceiptHeaders Property (AS2 Connector)

The AS2 headers that are returned with the receipt.

Data Type

String

Default Value

Remarks

ReceiptHeaders should include headers such as AS2-From, AS2-To, Date, Content-Type, etc.

In the Send Connector, this property will be populated after the full receipt is received from the server, if synchronous MDN delivery was requested.

In the Receive Connector, these will be added to the HTTP headers when returning a synchronous reply, or to the SMTP headers when returning an asynchronous reply via email. If any additional headers are supplied in ReceiptHeaders, they will be prepended to the headers generated by the connector.

ReceiptMDN Property (AS2 Connector)

The MDN generated by the component.

Data Type

String

Default Value

Remarks

This property will be populated after the full receipt is received from the server, if synchronous MDN delivery was requested.

The property will be generated and the MDN will be delivered to the sender before it is exposed in the connector.

This property is not available in the Receiver.

ReceiptMessage Property (AS2 Connector)

The textual message that is included in the receipt.

Data Type

String

Default Value

Remarks

The human-readable portion of the receipt generated in MDN.

In the Send Connector, this property will be populated after the full receipt is received from the server, if synchronous MDN delivery was requested.

In the Receive Connector, if ReceiptMessage is not set, an appropriate message will automatically be generated and added to the receipt. The message will differ depending on whether the message was processed successfully, whether the sender's signature was authenticated, etc. If set, the value of ReceiptMessage will override what is generated by the connector. If set to ".", a blank message will be generated.

ReceiptSignerCert Property (AS2 Connector)

The certificate of the receipt signer.

Data Type

Certificate

Remarks

If your trading partner uses different certificates for signing and encryption, it may be necessary to set this property to the signing certificate. However, if your trading partner uses the same certificate for both, it suffices to set RecipientCert.

This property is used to set a Public Key Certificate.

Ordinarily, the system will attempt to locate the public key in trusted certificate stores in the system registry. If a match is found, the certificate is trusted, and the process proceeds without error. If the certificate is not trusted, the connector will report an error.

You may explicitly set a public key, either to accept a key that is not installed on the system, or to ensure that a specific key is presented. Public key certificates may be loaded from the machine registry or from file.

This property is not available in the Receiver.

ReceiptSigningProtocol Property (AS2 Connector)

The protocol used to sign the outgoing MDN receipt.

Data Type

Enumeration

Possible Values

As Requested (0)
PKCS7 (1)
None (2)

Default Value

Remarks

The protocol used to sign the outgoing MDN. By default, the connector will honor the request of the client, if possible. If it is not possible to honor the client request, the MDN will not be signed and an error will be generated, unless ErrorProcessingFlags has been configured to prevent this.

If the client does not request a signature, one will not be provided by default; however, the server may provide one by setting ReceiptSigningProtocol to spPKCS7. If the client requests a signature and the signature protocol is supported by the connector, the request must be honored, per RFC specifications.

This property is not available in the Sender.

ReceivedFileName Property (AS2 Connector)

The name of the file received by the AS2 component.

Data Type

String

Default Value

Remarks

If a file name is included in the AS2 request's message headers, it will be written to this context property.

This property is not available in the Sender.

ReceiveMode Property (AS2 Connector)

Controls whether the component is configured to process AS2 messages or MDN receipts.

Data Type

Enumeration

Possible Values

AS2Message (0)
MDN (1)
Async MDN (2)

Default Value

Remarks

The possible values and their meanings are as follows:


AS2 Message	The connector attempts to process messages as AS2 messages and will attempt to deliver MDN receipts if requested.
MDN	The connector attempts to process messages as MDN receipts and verify their signatures.
AsyncMDN	The connector attempts to parse the input message as MDN receipts and send it to deliveryOptions.

This property is not available in the Sender.

ReceivingPartner Property (AS2 Connector)

The identity of AS2 receiving entity.

Data Type

String

Default Value

Remarks

This is the name of the trading partner that will be receiving AS2 transmissions for this receive location. When data is received, this will value will be checked against the value supplied by the sending entity to ensure that the document received is intended for this receiver.

This property is not available in the Sender.

RecipientCert Property (AS2 Connector)

The certificate of the recipient.

Data Type

Certificate

Remarks

The encryption certificate of the recipient. If this property is specified, the EDI message will be encrypted using the algorithm given by EncryptionAlgorithm.

This property is also used when verifying signed receipts, in cases where the receipt signature does not include the signer's certificate. In case your trading partner uses different certificates for signing and encryption, you should set RecipientCert to the encryption certificate, and ReceiptSignerCert to the signing certificate.

If the connector is unable to verify a signature, make sure RecipientCert is set appropriately.

This property is used to set a Public Key Certificate.

This property is not available in the Receiver.

RequestHeaders Property (AS2 Connector)

The headers included in the AS2 request.

Data Type

String

Default Value

"#[attributes.headers]"

Remarks

This property should be set to the AS2 headers from the request. If the request was received by an HTTP listener and passed to this connector, these headers are available through '#[attributes.headers]' (or '#[message.inboundProperties.headers]' in Mule 3.X). The headers can also be specified as a string.

This property is not available in the Sender.

ResponseBody Property (AS2 Connector)

The response body to be sent to the client.

Data Type

String

Default Value

Remarks

This property holds the response body that may be assigned to the HTTP response.

The corresponding Configuration XML may look like:

This property is not available in the Sender.

ResponseHeaders Property (AS2 Connector)

A collection of response headers.

Data Type

String

Default Value

Remarks

This property holds an object of response headers that may be assigned to the HTTP response.

The corresponding Configuration XML may look like:

This property is not available in the Sender.

RolloverCertificate Property (AS2 Connector)

The rollover decryption and receipt signing certificate.

Data Type

Certificate

Remarks

The rollover digital certificate that the connector will use to decrypt incoming transmissions and sign the MDN receipt (if requested). This may be used to specify an additional decryption and receipt signing certificate during a period of transition between private certificates in the application.

When specified the connector will be able to decrypt messages that were encrypted with the corresponding public certificate of either Certificate or RolloverCertificate. MDNs will be signed with both the certificate in Certificate and RolloverCertificate.

If a different certificate is required for decryption than for MDN signing, set the decryption certificate before calling ParseRequest, then set the rollover certificate before calling CreateMDNReceipt. RolloverCertificate must be set to a private key certificate.

This property is not available in the Sender.

RolloverSigningCert Property (AS2 Connector)

An additional certificate used to sign the outgoing AS2 request when transitioning certificates.

Data Type

Certificate

Remarks

This property specifies a certificate in addition to SigningCert that will be used to sign the AS2 request. This should only be used during a certificate transition when both the old and new certificate need to be supported for the transitional phase.

This property is not available in the Receiver.

RuntimeLicense Property (AS2 Connector)

Specifies the component runtime license key.

Data Type

String

Default Value

Remarks

You can use the RuntimeLicense property to set the runtime key for the connector license.

SignerCert Property (AS2 Connector)

The signing certificate of the trading partner.

Data Type

Certificate

Remarks

You must set your trading partner's certificate before processing any signed messages.

This property is used to set a Public Key Certificate.

This property is not available in the Sender.

SigningCert Property (AS2 Connector)

The certificate used to sign the outgoing AS2 request.

Data Type

Certificate

Remarks

This property is used to assign a specific certificate to be used for digitally signing the outgoing AS2 request.

This field is used to set a Private Key Certificate.

Private key certificates may be loaded from the registry, from files in PKCS#12 format, or from a PEM file format.

This property is not available in the Receiver.

SSLAcceptServerCert Property (AS2 Connector)

For sending HTTPS requests, a server certificate to unconditionally accept.

Data Type

Certificate

Remarks

In the Send Connector, this property is used when communicating with trading partners via HTTPS to the URL specified in URL.

In the Receive Connector, this property is used when an asynchronous MDN is requested by your trading partner to the URL specified in MDNDeliveryOption.

When an HTTPS request is issued by the connector, a new secure connection is created with the trading partner. By default, the connector will reject self-signed certificates and any other server certificates not signed by a trusted Certificate Authority (CA).

This property is used to set a Public Key Certificate.

Note: You may also set the Accept Any field to Yes without opening the certificate selection dialog to force the connector to unilaterally authenticate any server during the security handshake. It is strongly recommended that you use this only for testing purposes. Set the LogMode to Info to cause the connector to report the server's credentials to Location.

SSLCert Property (AS2 Connector)

The certificate to use for client authentication during the SSL handshake.

Data Type

Certificate

Remarks

This property is used to assign a specific certificate for SSL client authentication.

This field is used to set a Private Key Certificate.

Private key certificates may be loaded from the registry, from files in PKCS#12 format, or from a PEM file format.

Timeout Property (AS2 Connector)

A timeout for the component.

Data Type

Integer

Default Value

Remarks

If the Timeout property is set to 0, all operations will run uninterrupted until successful completion, or an error condition is encountered.

If Timeout is set to a positive value, the connector will wait for the operation to complete before returning control.

If Timeout expires, and the operation is not yet complete, the connector fails with an error.

Please note that by default, all timeouts are inactivity timeouts, i.e. the timeout period is extended by Timeout seconds when data is successfully sent or received.

Optionally, the behavior of the connector may be changed to absolute timeouts, i.e. the connector will wait for a maximum of Timeout seconds since the beginning of the operation, without extending the timeout period during communications.

This behavior is controlled by the AbsoluteTimeout configuration setting.

The default value for the Timeout property is 60 (seconds).

TradingPartner Property (AS2 Connector)

The trading partner that will be communicating with this receive location.

Data Type

String

Default Value

Remarks

This is the name of the trading partner that will be communicating with this instance of the AS2 connector.

This property is not available in the Sender.

URL Property (AS2 Connector)

The URL to post to.

Data Type

String

Default Value

Remarks

SSL will be used if and only if the URL scheme is "https". Note that, in general, signed and unencrypted messages would be sent using SSL, as encrypting the message over an SSL channel would be redundant.

This property is not available in the Receiver.

Certificate Type

The digital certificate being used.

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

Fields

Store
String
Default Value: "MY"

The name of the certificate store for the client certificate.

The StoreType field specifies the type of the certificate store specified by Store. If the store is password protected, specify the password in StorePassword.

Store is used in conjunction with the Subject field in order to specify client certificates. If Store has a value, and Subject is set, a search for a certificate is initiated. Please refer to the Subject field for details.

Designations of certificate stores are platform-dependent.

The following are designations of the most common User and Machine certificate stores in Windows:


MY	A certificate store holding personal certificates with their associated private keys.
CA	Certifying authority certificates.
ROOT	Root certificates.
SPC	Software publisher certificates.

In Java, the certificate store normally is a file containing certificates and optional private keys.

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

If the provider is OpenSSL, the certificate store is a file containing a certificate and a private key. This property must be set to the name of the file.

StorePassword
String
Default Value: ""

If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.

StoreType
CertStoreTypes
Default Value: 0

The type of certificate store for this certificate.

The connector supports both public and private keys in a variety of formats. When the cstAuto value is used, the connector will automatically determine the type. This field can take one of the following values:


0 (cstUser - default)	For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: This store type is not available in Java.
1 (cstMachine)	For Windows, this specifies that the certificate store is a machine store. Note: This store type is not available in Java.
2 (cstPFXFile)	The certificate store is the name of a PFX (PKCS#12) file containing certificates.
3 (cstPFXBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format.
4 (cstJKSFile)	The certificate store is the name of a Java Key Store (JKS) file containing certificates. Note: This store type is only available in Java.
5 (cstJKSBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. Note: this store type is only available in Java.
6 (cstPEMKeyFile)	The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
7 (cstPEMKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate.
8 (cstPublicKeyFile)	The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
9 (cstPublicKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate.
10 (cstSSHPublicKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key.
11 (cstP7BFile)	The certificate store is the name of a PKCS#7 file containing certificates.
12 (cstP7BBlob)	The certificate store is a string (binary) representing a certificate store in PKCS#7 format.
13 (cstSSHPublicKeyFile)	The certificate store is the name of a file that contains an SSH-style public key.
14 (cstPPKFile)	The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
15 (cstPPKBlob)	The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
16 (cstXMLFile)	The certificate store is the name of a file that contains a certificate in XML format.
17 (cstXMLBlob)	The certificate store is a string that contains a certificate in XML format.
18 (cstJWKFile)	The certificate store is the name of a file that contains a JWK (JSON Web Key).
19 (cstJWKBlob)	The certificate store is a string that contains a JWK (JSON Web Key).
21 (cstBCFKSFile)	The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). Note: This store type is only available in Java and .NET.
22 (cstBCFKSBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. Note: This store type is only available in Java and .NET.
23 (cstPKCS11)	The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, the necessary data must first be collected using the CERTMGR connector. The ListStoreCertificates method may be called after setting CertStoreType to `cstPKCS11`, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 DLL. The certificate information returned in the CertList event's `CertEncoded` parameter may be saved for later use. When using a certificate, pass the previously saved security key information as the Store and set StorePassword to the PIN. Code Example. SSH Authentication with Security Key: `certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);`
99 (cstAuto)	The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

Subject
String
Default Value: ""

The subject of the certificate used for client authentication.

When this property is set, a search is performed in the current certificate store certificate with matching subject.

If an exact match is not found, the store is searched for subjects containing the value of the property.

When setting the property to a partial subject, CN= should be omitted. For example, the following code would find the certificate with subject CN=Test Certificate, OU=People, C=US

Example (Searching with partial subject)

Control.CertSubject = "Test"

If a match is not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

If a matching certificate is found, Subject is set to the full subject of the matching certificate.

Thumbprint
String (read-only)
Default Value: ""

The thumbprint of the certificate.

This field is used to specify the thumbprint of the certificate. When there are multiple certificates in the store that have the same subject, the thumbprint will be used to distinguish between them.

Firewall Type

The firewall the component will connect through.

Remarks

When connecting through a firewall, this type is used to specify different properties of the firewall such as the firewall Host and the FirewallType.

Fields

AutoDetect
Boolean
Default Value: False

Tells the connector whether or not to automatically detect and use firewall system settings, if available.

FirewallType
FirewallTypes
Default Value: 0

Determines the type of firewall to connect through. The applicable values are the following:


fwNone (0)	No firewall (default setting).
fwTunnel (1)	Connect through a tunneling proxy. Port is set to 80.
fwSOCKS4 (2)	Connect through a SOCKS4 Proxy. Port is set to 1080.
fwSOCKS5 (3)	Connect through a SOCKS5 Proxy. Port is set to 1080.

Host
String
Default Value: ""

Name or IP address of firewall (optional). If a Host is given, requested connections will be authenticated through the specified firewall when connecting.

If the Host field is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the Host field is set to the corresponding address. If the search is not successful, an error is returned.

Password
String
Default Value: ""

A password if authentication is to be used when connecting through the firewall. If Host is specified, the User and Password fields are used to connect and authenticate to the given firewall. If the authentication fails, a trappable error is fired.

Port
Integer
Default Value: 0

The TCP port for the firewall Host. See the description of the Host field for details.

Note that the Port is set automatically when FirewallType is set to a valid value. See the description of the FirewallType field for details.

User
String
Default Value: ""

A user name if authentication is to be used connecting through a firewall. If the Host is specified, the User and Password fields are used to connect and authenticate to the given Firewall. If the authentication fails, a trappable error is fired.

Proxy Type

The proxy the component will connect to.

Remarks

When connecting through a proxy, this type is used to specify different properties of the proxy such as the Server and the AuthScheme.

Fields

AuthScheme
ProxyAuthSchemes
Default Value: 0

Use the AuthScheme field to tell the connector which type of authorization to perform when connecting to the proxy. This is only used when the User and Password fields are set.

AuthScheme should be set to authNone (3) when no authentication is expected.

By default, AuthScheme is authBasic (0), and if the User and Password fields are set, the component will attempt basic authentication. If AuthScheme is set to authDigest (1), digest authentication will be attempted instead.

If AuthScheme is set to authProprietary (2), then the authorization token will not be generated by the connector. Look at the configuration file for the connector being used to find more information about manually setting this token.

If AuthScheme is set to authNtlm (4), NTLM authentication will be used. This option is only available in the SSL package.

For security reasons, setting this property will clear the values of User and Password.

AutoDetect
Boolean
Default Value: False

Tells the connector whether or not to automatically detect and use proxy system settings, if available.

Password
String
Default Value: ""

A password if authentication is to be used for the proxy.

If AuthScheme is set to Basic Authentication, the User and Password are Base64 encoded and the proxy authentication token will be generated in the form "Basic [encoded-user-password]".

If AuthScheme is set to Digest Authentication, the User and Password fields are used to respond to the Digest Authentication challenge from the server.

If AuthScheme is set to NTLM Authentication, the User and Password fields are used to authenticate through NTLM negotiation.

Port
Integer
Default Value: 80

The TCP port for the proxy Server (default 80). See the description of the Server field for details.

Server
String
Default Value: ""

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the Server field is set to a Domain Name, a DNS request is initiated and upon successful termination of the request, the Server field is set to the corresponding address. If the search is not successful, an error is returned.

SSL
ProxySSLTypes
Default Value: 0

Determines when to use SSL for the connection to the proxy. The applicable values are the following:


psAutomatic (0)	Default setting. The connection to the Server is SSL-enabled for 'https' URL-s, and non SSL-enabled for other URL-s.
psAlways (1)	The connection is always SSL-enabled.
psNever (2)	The connection is not SSL-enabled.
psTunnel (3)	The connection is through a tunneling (HTTP) proxy.

User
String
Default Value: ""

A user name, if authentication is to be used for the proxy.

If AuthScheme is set to Basic Authentication, the User and Password are Base64 encoded and the proxy authentication token will be generated in the form "Basic [encoded-user-password]".

If AuthScheme is set to Digest Authentication, the User and Password fields are used to respond to the Digest Authentication challenge from the server.

If AuthScheme is set to NTLM Authentication, the User and Password fields are used to authenticate through NTLM negotiation.

Config Settings (AS2 Connector)

The connector accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the connector, access to these internal properties is provided through the Other property.

AS2 Config Settings

AcceptAnySignerCert: Used to accept trust any signing certificate unconditionally.

If AcceptAnySignerCert is set to true, the connector will accept any signer certificate for the incoming signature. Use of this setting in production is discouraged, as failing to authenticate the sender poses a security risk.

AS2Subject: The subject of the message.

The optional human-readable subject of the message. Some AS2 partners will use this field to send additional information about the transmission at the transport layer.

This setting is only applicable to the send connector.

AsyncMDNInfoDir: The location on disk where MDN information is stored.

Path to a directory to store data used in verifying AsyncMDNs.

This setting is only applicable to the receive connector.

ChunkSize: Specifies the chunk size in bytes when using chunked encoding.

This is only applicable when UseChunkedEncoding is true. This setting specifies the chunk size in bytes to be used when posting data. The default value is 16384.

ErrorOnNegativeMDN: Whether an exception should be raised when a negative MDN is received.

By default this setting is true a negative MDN raises an exception. When set to false, all MDNs will be processed without throwing an error. The contents of a negative MDN will be available in the Mule message payload and the result of parsing will be available in the attributes collection later in the Mule flow. E.g. #[attributes.ErrorCode] #[attributes.ErrorMessage]

Note: In the majority of cases the default behavior of the connector is sufficient. The location specified by LogDirectory will contain the MDN contents whether it is positive or negative. In the few situations when direct disk access may not be desirable, this setting allows granular control over the result of parsing and passes the MDN contents to the application to redirect it elsewhere. This setting applies only to the send connectors.

ErrorProcessingFlags: Flags controlling how errors affect ProcessRequest.

ErrorReportingFlags is bitmask of values controlling how the errors are reported in the MDN. The connector can be configured to not halt for certain types of errors by setting ErrorProcessingFlags to the OR of one or more of the following values:


0x04	Unable to validate integrity of data, or unsupported signing protocol used.
0x08	Unable to authenticate the sender.
0x10	Client requested unsupported signature type.
0x20	Client requested unsupported MIC algorithm.

ErrorReportingFlags: Flags controlling how errors affect the MDNReceipt.

By default, the MDN will report an error if any of the conditions below occur. The MIC will not be calculated and the data will be reported as unprocessed. However, the MDN may be configured to permit one or more of the errors below. A warning will be reported if MDNWarning is set; otherwise the error will silently be ignored.

Multiple errors may be permitted by setting ErrorReportingFlags to the OR of one or more of the following values:


0x04 (4)	Unable to validate integrity of data, or unsupported signing protocol used.
0x08 (8)	Unable to authenticate the sender.
0x10 (16)	Client requested unsupported signature type.
0x20 (32)	Client requested unsupported MIC algorithm.

Note: errors should be ignored only with extreme caution, and only by agreement of both trading parties.

From: The email address of the HTTP agent (optional).

If the From setting contains a non-empty string, an HTTP From header is added to the request. This header generally gives the email address of the requester of the document.

This setting is only applicable to the send connector.

IgnoreLoggingErrors: Whether to ignore errors that occur when writing to the log.

When this setting is enabled (default False), any errors that occur while writing to log files will be ignored, and no exception will be thrown. Note that this may cause logs to be incomplete or missing without any indication that an issue occurred.

LogDebug: Whether to log debug data.

This setting specifies whether to log debug data. When set to True the connector will create additional files in the LogDirectory. The default value is False.

When sending, files with extensions ".input", ".sign", ".compress", and ".encrypt" may be created. When receiving, files with extensions ".input", ".verify", ".decompress", and ".decrypt" may be created.

MDNDeliveryOption: A URL indicating how the receipt is to be delivered.

The default mode of operation is for the receipt to be returned synchronously within the HTTP reply. By specifying a valid URL, the user may request asynchronous delivery instead. The URL indicates the destination for the reply, and may use any appropriate protocol, such as "mailto", "http", or "https".

If this is set to an empty string (default), the receipt will be returned synchronously, and will be processed automatically by the connector. Clients requesting asynchronous delivery should provide their own processing for reading receipts. This is applicable to the send connector only.

MDNWarning: A warning to appear in the MDN.

MDNWarning defines a warning to appear in the outgoing MDN. If any errors are found and not explicitly allowed in ErrorReportingFlags, the errors will take precedence and the warning will not be reported.

MDNWarning should be assigned when allowing errors to be ignored via the ErrorReportingFlags property. The MDN will indicate successful processing of the request, but will contain a warning field. The following warning is defined by the AS2 specifications:

"authentication-failed, processing continued"

Any other warnings are not defined by the specifications and may or may not be understood by the client.

OAEPMGF1HashAlgorithm: The MGF1 hash algorithm used when encrypting a key.

When UseOAEP is True, this algorithm specifies the MGF1 hash algorithm used for the encryption key by RSA OAEP. Possible values are:

"SHA1"
"SHA224"
"SHA256" (default)
"SHA384"
"SHA512"

Note: An empty string value indicates that the algorithm specified by OAEPRSAHashAlgorithm is used as the RSA hash algorithm as well.

OAEPParams: The hex encoded OAEP parameters to be used when encrypting a key.

This setting is optional and should only be specified if OAEP parameters need to be explicitly set. The value specified should be a hex string. By default this setting is unspecified.

OAEPRSAHashAlgorithm: The RSA hash algorithm used when encrypting a key.

When UseOAEP is True, this algorithm specifies the RSA hash algorithm used for the encryption key. This may differ from the hash algorithm used to sign the AS4 message content. Possible values are:

"SHA1"
"SHA224"
"SHA256" (default)
"SHA384"
"SHA512"

OtherHeaders: Other headers as determined by the user.

The headers must be of the format "header: value" as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\n"). Use this property with caution. If this property contains invalid headers, HTTP requests may fail. This property is useful for extending the functionality of the connector beyond what is provided. This is applicable to the transmitter connector only.

SignatureAlgorithm: Signature algorithm to be used in outgoing messages.

The Signature Algorithm can be set to indicate the preferred signing algorithm. Possible values are:

sha1
md5
sha-224
sha-256 (default)
sha-384
sha-512

The default value is "sha1". MDNOptions will need to be updated to reflect the selected algorithm if the MDN receipt is to be signed with the same algorithm. For example:

 signed-receipt-protocol=optional, pkcs7-signature; signed-receipt-micalg=optional, sha-256

This is applicable to the send connector only.

SMTPFrom: The senders address for asynchronous MDN delivery.

If an asynchronous MDN is requested to be sent over SMTP this specifies the sender. This is applicable to the receive connector only.

SMTPServer: The SMTP server for asynchronous MDN delivery.

If an asynchronous MDN is requested to be sent over SMTP this specifies the server. This is applicable to the receive connector only.

SMTPSubject: The SMTP message subject for asynchronous MDN delivery.

If an asynchronous MDN is requested to be sent over SMTP this specifies the subject. This is applicable to the receive connector only.

UseChunkedEncoding: Whether to chunk outgoing posts.

When sending, this setting controls whether data is chunked. Chunking allows data to be streamed as it is available instead of preparing the entire message first. It is recommended to set this to True if sending very large files. The default value is False.

UseOAEP: Whether to use Optimal Asymmetric Encryption Padding (OAEP) when encrypting the key with RSA.

If set to true, OAEP will be used when encrypting the key. By default this value is False and the component will use PKCS1. Only applicable when sending AS2 messages. The following optional settings apply when this is set to True:

OAEPParams
OAEPMGF1HashAlgorithm
OAEPRSAHashAlgorithm

UsePSS: Whether to use RSA-PSS when signing.

If set to true, RSA-PSS will be used when signing messages. The default value is False. Note that the certificate used to sign does not itself need to be signed with RSA-PSS; any valid RSA certificate may be used with this setting.

UserAgent: Information about the user agent.

the default value is "IP*Works! AS2 Transmitter - www.nsoftware.com".

SSL Config Settings

ReuseSSLSession: Determines if the SSL session is reused.

If set to true, the connector will reuse the context if and only if the following criteria are met:

The target host name is the same.
The system cache entry has not expired (default timeout is 10 hours).
The application process that calls the function is the same.
The logon session is the same.
The instance of the connector is the same.

SSLCipherStrength: The minimum cipher strength used for bulk encryption.

This minimum cipher strength largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated.

Please note that this setting contains the minimum cipher strength requested from the security library.

Use this setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application.

SSLEnabledCipherSuites: The cipher suite to be used in an SSL negotiation.

The enabled cipher suites to be used in SSL negotiation.

By default, the enabled cipher suites will include all available ciphers ("*").

The special value "*" means that the connector will pick all of the supported cipher suites. If SSLEnabledCipherSuites is set to any other value, only the specified cipher suites will be considered.

Multiple cipher suites are separated by semicolons.

Example values when UseInternalSecurityAPI is False (default): // The "Other" property could contain ONE of the following lines: SSLEnabledCipherSuites=* SSLEnabledCipherSuites=CALG_AES_256 SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES Possible values when UseInternalSecurityAPI is False (default) include:

CALG_3DES
CALG_3DES_112
CALG_AES
CALG_AES_128
CALG_AES_192
CALG_AES_256
CALG_AGREEDKEY_ANY
CALG_CYLINK_MEK
CALG_DES
CALG_DESX
CALG_DH_EPHEM
CALG_DH_SF
CALG_DSS_SIGN
CALG_ECDH
CALG_ECDH_EPHEM
CALG_ECDSA
CALG_ECMQV
CALG_HASH_REPLACE_OWF
CALG_HUGHES_MD5
CALG_HMAC
CALG_KEA_KEYX
CALG_MAC
CALG_MD2
CALG_MD4
CALG_MD5
CALG_NO_SIGN
CALG_OID_INFO_CNG_ONLY
CALG_OID_INFO_PARAMETERS
CALG_PCT1_MASTER
CALG_RC2
CALG_RC4
CALG_RC5
CALG_RSA_KEYX
CALG_RSA_SIGN
CALG_SCHANNEL_ENC_KEY
CALG_SCHANNEL_MAC_KEY
CALG_SCHANNEL_MASTER_HASH
CALG_SEAL
CALG_SHA
CALG_SHA1
CALG_SHA_256
CALG_SHA_384
CALG_SHA_512
CALG_SKIPJACK
CALG_SSL2_MASTER
CALG_SSL3_MASTER
CALG_SSL3_SHAMD5
CALG_TEK
CALG_TLS1_MASTER
CALG_TLS1PRF

Example values when UseInternalSecurityAPI is True:

// The "Other" property could contain ONE of the following lines:
SSLEnabledCipherSuites=*
SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA
SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_DH_ANON_WITH_AES_128_CBC_SHA

Possible values when UseInternalSecurityAPI is True include:

TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
TLS_DHE_DSS_WITH_AES_128_CBC_SHA
TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
TLS_DHE_DSS_WITH_AES_256_CBC_SHA
TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
TLS_DHE_DSS_WITH_DES_CBC_SHA
TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
TLS_DHE_RSA_WITH_AES_128_CBC_SHA
TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
TLS_DHE_RSA_WITH_AES_256_CBC_SHA
TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
TLS_DHE_RSA_WITH_DES_CBC_SHA
TLS_RSA_WITH_AES_256_GCM_SHA384
TLS_RSA_WITH_AES_128_GCM_SHA256
TLS_RSA_WITH_3DES_EDE_CBC_SHA
TLS_RSA_WITH_AES_128_CBC_SHA
TLS_RSA_WITH_AES_128_CBC_SHA256
TLS_RSA_WITH_AES_256_CBC_SHA
TLS_RSA_WITH_AES_256_CBC_SHA256
TLS_RSA_WITH_DES_CBC_SHA
TLS_RSA_WITH_RC4_128_MD5
TLS_RSA_WITH_RC4_128_SHA

If SSLEnabledProtocols is configured to use TLS 1.3 the following values are supported:

TLS_AES_128_GCM_SHA256
TLS_AES_256_GCM_SHA384

SSLEnabledCipherSuites is used together with SSLCipherStrength.

SSLEnabledProtocols: Used to enable/disable the supported security protocols.

Used to enable/disable the supported security protocols.

Not all supported protocols are enabled by default (the value of this setting is 4032). If you want more granular control over the enabled protocols, you can set this property to the binary 'OR' of one or more of the following values:


TLS1.3	12288 (Hex 3000) (Experimental)
TLS1.2	3072 (Hex C00) (Default)
TLS1.1	768 (Hex 300) (Default)
TLS1	192 (Hex C0) (Default)
SSL3	48 (Hex 30)
SSL2	12 (Hex 0C)

Note: TLS 1.1 and TLS1.2 support are only available starting with Windows 7.

Note: Enabling TLS 1.3 will automatically set UseInternalSecurityAPI to True.

SSLIncludeCertChain: Whether the entire certificate chain is included in the SSLServerAuthentication event.

This setting specifies whether the transport log contains the full certificate chain. By default this value is False and only the leaf certificate will be present.

If set to True all certificates returned by the server will be present in the transport log. This includes the leaf certificate, any intermediate certificate, and the root certificate.

Note: When UseInternalSecurityAPI is set to True this value is automatically set to True. This is needed for proper validation when using the internal provider.

SSLSecurityFlags: Flags that control certificate verification.

The following flags are defined (specified in hexadecimal notation). They can be or-ed together to exclude multiple conditions:


0x00000001	Ignore time validity status of certificate.
0x00000002	Ignore time validity status of CTL.
0x00000004	Ignore non-nested certificate times.
0x00000010	Allow unknown Certificate Authority.
0x00000020	Ignore wrong certificate usage.
0x00000100	Ignore unknown certificate revocation status.
0x00000200	Ignore unknown CTL signer revocation status.
0x00000400	Ignore unknown Certificate Authority revocation status.
0x00000800	Ignore unknown Root revocation status.
0x00008000	Allow test Root certificate.
0x00004000	Trust test Root certificate.
0x80000000	Ignore non-matching CN (certificate CN not-matching server name).

TLS12SignatureAlgorithms: Defines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.

This setting specifies the allowed server certificate signature algorithms when UseInternalSecurityAPI is True and SSLEnabledProtocols is set to allow TLS 1.2.

When specified the connector will verify that the server certificate signature algorithm is among the values specified in this setting. If the server certificate signature algorithm is unsupported the connector will fail with an error.

The format of this value is a comma separated list of hash-signature combinations. For instance: // The "Other" could contain ALL of these lines: UseInternalSecurityAPI=true SSLEnabledProtocols=3072 TLS12SignatureAlgorithms=sha1-rsa,sha1-dsa,sha256-rsa,sha256-dsa The default value for this setting is "sha1-rsa,sha1-dsa,sha224-rsa,sha224-dsa,sha256-rsa,sha256-dsa,sha384-rsa,sha384-dsa,sha512-rsa,sha512-dsa".

In order to not restrict the server's certificate signature algorithm, specify an empty string as the value for this setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent.

TLS12SupportedGroups: The supported groups for ECC.

This setting specifies a comma separated list of named groups used in TLS 1.2 for ECC.

The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.

When using TLS 1.2 and UseInternalSecurityAPI is set to True, the values refer to the supported groups for ECC. The following values are supported:

"ecdhe_secp256r1" (default)
"ecdhe_secp384r1" (default)
"ecdhe_secp521r1" (default)

TLS13KeyShareGroups: The groups for which to pregenerate key shares.

This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional round trip during the handshake if the group is supported by the server.

The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result only some groups are included by default in this setting.

Note: All supported groups can always be used during the handshake even if not listed here, but if a group is used which is not present in this list it will incur an additional round trip and time to generate the key share for that group.

In most cases this setting does not need to be modified. This should only be modified if there is a specific reason to do so.

The default value is ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072

The values are ordered from most preferred to least preferred. The following values are supported:

"ecdhe_x25519" (default)
"ecdhe_x448"
"ecdhe_secp256r1" (default)
"ecdhe_secp384r1" (default)
"ecdhe_secp521r1"
"ffdhe_2048" (default)
"ffdhe_3072" (default)
"ffdhe_4096"
"ffdhe_6144"
"ffdhe_8192"

TLS13SignatureAlgorithms: The allowed certificate signature algorithms.

This setting holds a comma separated list of allowed signature algorithms. Possible values are:

"rsa_pkcs1_sha256" (default)
"rsa_pkcs1_sha384" (default)
"rsa_pkcs1_sha512" (default)

The default value is rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512. This setting is only applicable when SSLEnabledProtocols includes TLS 1.3.

TLS13SupportedGroups: The supported groups for (EC)DHE key exchange.

This setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange. This setting should only be modified if there is a specific reason to do so.

The default value is ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192

The values are ordered from most preferred to least preferred. The following values are supported:

"ecdhe_x25519" (default)
"ecdhe_x448" (default)
"ecdhe_secp256r1" (default)
"ecdhe_secp384r1" (default)
"ecdhe_secp521r1" (default)
"ffdhe_2048" (default)
"ffdhe_3072" (default)
"ffdhe_4096" (default)
"ffdhe_6144" (default)
"ffdhe_8192" (default)

General Config Settings

AbsoluteTimeout: Determines whether timeouts are inactivity timeouts or absolute timeouts.

If AbsoluteTimeout is set to True, any method which does not complete within Timeout seconds will be aborted. By default, AbsoluteTimeout is False, and the timeout is an inactivity timeout.

LocalHost: The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

The LocalHost configuration contains the name of the local host as obtained by the Gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the connector initiate connections (or accept in the case of server connectors) only through that interface.

If the connector is connected, the LocalHost configuration shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

TcpNoDelay: Whether or not to delay when sending packets.

When true, the socket will send all data that is ready to send at once. When false, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm.

By default, this config is set to false.

UseInternalSecurityAPI: Whether or not to use the system security libraries or an internal implementation.

When set to False, the connector will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this configuration setting to True tells the connector to use the internal implementation instead of using the system security libraries.

This setting is set to False by default on all platforms.