AS2Receiver Control

Properties   Methods   Events   Config Settings   Errors  

The AS2Receiver control is used to process EDI messages and generate receipts.

Syntax

AS2Receiver

Remarks

The AS2Receiver implements server-side processing of EDI messages, as specified in [AS2] and RFC 3335. It can be used to decrypt and verify incoming messages and to generate receipts including Message Disposition Notifications (MDNs). The control is designed to be easily incorporated into an HTTP server, and features custom functionality for server environments such as ASP.NET.

BASIC OPERATION

When an AS2 request comes in, you should first invoke ReadRequest. This will populate AS2From and AS2To, and based on this information, you may then set the appropriate certificates. You may specify your certificate with the Certificate property, and your trading partner's (signing) certificate with the SignerCert property.

Then, invoke ProcessRequest to process the request and generate the MDN receipt as specified in [AS2] and RFC 3335. If the request was processed successfully, EDIData will contain the transmitted EDI data. If a problem occurred, EDIData will not be populated and an exception will be thrown. In either case MDNReceipt will contain the RFC-compliant receipt, which should be returned to the client.

The MDNReceipt may be returned by invoking SendResponse. The receipt will be returned either synchronously in the HTTP reply, or asynchronously over a separate HTTP, HTTPS, or SMTP connection, as requested by the client.

To create log files, set LogDirectory prior to invoking ProcessRequest. This will log all incoming and outgoing data.

The following example illustrates how to use the control from an ASP.NET page. Note that in Java it will be necessary to provide an HTTPServletRequest as an argument to ReadRequest before processing the request.

EXAMPLE AS2Receiver1.ReadRequest(); // At this point, you should check the values of AS2From and AS2To. AS2Receiver1.Certificate = new Certificate(CertStoreTypes.cstPFXFile, "c:\\my_server_directory\\my_pfx_file.pfx", "my password", "CN=Me"); AS2Receiver1.SignerCert = new Certificate("c:\\my_server_directory\\my_partner_cer_file.cer"); AS2Receiver1.LogDirectory = "c:\\my_server_directory\\my_log_directory"; AS2Receiver1.ProcessRequest(); AS2Receiver1.SendResponse(); Additional functionality allows the user to examine details of the client's request, to permit certain types of errors, or to customize the outgoing MDN.

ADVANCED FUNCTIONALITY

Advanced functionality is provided to allow the user to break down the AS2 process, and to allow finer control over the operation of the server. Where ProcessRequest automates the entire process, additional methods are also provided to handle each step separately.

Parsing Incoming Data

To process an EDI message, invoke ReadRequest to process the headers from the server, or alternatively, manually set Request to the contents of the HTTP request. It may contain both headers and body, or the headers may be specified separately in RequestHeaders. This will provide more information about the client's request, without attempting to read the underlying EDI data.

After invoking ReadRequest, the AS2From, AS2To, and MessageId properties will contain the appropriate values. MDNTo will contain a nonempty string if an MDN is requested; RequestedSignatureProtocol, RequestedMICAlgorithms, and ReceiptDeliveryOption provide more information about the client's request. Finally, RequestHeaders contains the complete list of HTTP/AS2 headers.

Next, invoke ParseRequest. The certificate used to decrypt and sign should be specified with the Certificate property, and your partner's signing certificate should be specified with SignerCert. This will process the headers, decompress and/or decrypt the message (if applicable), and verify the signature (if present). EncryptionType, SignatureType, and CompressionFormat describe whether and how the data was encrypted, signed, and compressed, respectively.

ParseRequest will populate EDIEDIType and EDIData.

Error Handling

If any errors occur an exception will be thrown and EDIData will not be populated. Information about the exception will be provided through the exception's error code and message and also through ScanResult. An MDN receipt reporting the error may still be generated; it is recommended that server software trap the error and invoke CreateMDNReceipt to report the error to the client.

The ErrorProcessingFlags property may be configured to allow predetermined types of errors. If ErrorProcessingFlags is set when ParseRequest (or ProcessRequest) is invoked, the errors specified will be allowed, an exception will not be thrown, and EDIData will still be determined. However, ScanResult will still report the error, as will the receipt generated by CreateMDNReceipt. To avoid reporting the errors in the receipt, set the ErrorReportingFlags property.

Creating an MDN-based Receipt

An MDN-based receipt may be created by invoking CreateMDNReceipt. Regardless of the success or failure of ProcessRequest, the receipt may be created as specified in RFCs 3335 and 2298. If no errors occurred when ProcessRequest was invoked, the receipt will report success and will be suitable for non-repudiation of receipt (NRR) if signed. If errors occurred, the MDN will report that an error occurred and that the EDI data was not processed. It is strongly recommended that server software trap any errors thrown by ProcessRequest and return the receipt in this case as well.

The MDNReceipt will consist of the MDN itself, a human-readable message, MIME headers and footers, and a signature if applicable. The receipt may be generated by invoking CreateMDNReceipt and customized further by setting the parameters to CreateMDNReceipt.

The Message parameter to CreateMDNReceipt may be used to customize the human-readable message in the receipt. If it is set to an empty string, an appropriate message will automatically be written whenever MDNReceipt is regenerated.

The receipt will be signed using the protocol specified by ReceiptSigningProtocol, if any. The certificate used to sign the receipt is specified by Certificate. By default the receipt will be signed if explicitly requested by the client, and unsigned otherwise.

Error reporting may be controlled by configuring ErrorReportingFlags. By default, any errors will cause MDNReceipt 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 MDNReceipt to overlook the chosen types of errors. If all errors are overlooked, the MDNReceipt will report success and calculate a MIC on the original message as usual. A warning may be reported by setting the MDNWarning configuration setting.

Additional Server-Side Functionality

When used in a server environment such as ASP.NET, the control may be used to interface directly with the underlying HTTP context. If Request is not set by the user, ParseRequest and ProcessRequest will first get the request from the underlying HTTP environment, if possible. SendResponse will send the reply in this environment if able; otherwise the reply will be directed to standard out.

ASP.NET Core Notes

The control may be used within any .NET Standard compatible platform, including .NET Core and ASP.NET Core. When using AS2Receiver within an ASP.NET Core MVC application the control can be configured to automatically read from the request context, and send using the response context. To do so pass the HttpContext to the constructor of the AS2Receiver class. For instance:

//Inside HomeController.cs As2receiver as2 = new As2receiver(HttpContext);

Property List

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

Method List

The following is the full list of the methods of the control with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the control with short descriptions. Click on the links for further details.

Config Settings

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

AS2From Property (AS2Receiver Control)

The AS2 Identifier of the sending system.

Syntax

as2receivercontrol.AS2From

Default Value

""

Remarks

May be company name, DUNS number, or anything agreed on by trading partners.

This property is read-only.

Data Type

String

AS2To Property (AS2Receiver Control)

The AS2 Identifier of the receiving system.

Syntax

as2receivercontrol.AS2To

Default Value

""

Remarks

May be company name, DUNS number, or anything agreed on by trading partners.

This property is read-only.

Data Type

String

AttachmentCount Property (AS2Receiver Control)

The number of records in the Attachment arrays.

Syntax

as2receivercontrol.AttachmentCount

Default Value

0

Remarks

This property controls the size of the following arrays:

• AttachmentContentType
• AttachmentData
• AttachmentFilename
• AttachmentHeaders
• AttachmentName

The array indices start at 0 and end at AttachmentCount - 1.

This property is read-only and not available at design time.

Data Type

Integer

AttachmentContentType Property (AS2Receiver Control)

The MIME content-type of this ediattachment .

Syntax

as2receivercontrol.AttachmentContentType(AttachmentIndex)

Default Value

""

Remarks

The MIME content-type of this EDIAttachment.

The AttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.

This property is read-only and not available at design time.

Data Type

String

AttachmentData Property (AS2Receiver Control)

This property contains the attachment data.

Syntax

as2receivercontrol.AttachmentData(AttachmentIndex)

Default Value

""

Remarks

This property contains the attachment data.

In a receiver, the control decodes the attachment to the AttachmentData property when AttachmentData's value is first queried. This property will contain the full decrypted text of the attachment.

The AttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .AttachmentDataB.

This property is read-only and not available at design time.

Data Type

Binary String

AttachmentFilename Property (AS2Receiver Control)

The file name of the attachment.

Syntax

as2receivercontrol.AttachmentFilename(AttachmentIndex)

Default Value

""

Remarks

The file name of the attachment. If IncomingDirectory has been specified, the attachment will be written to the specified directory and the name will be provided by this property. Otherwise, this will contain the name of the attachment as described in the AttachmentHeaders.

The AttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.

This property is read-only and not available at design time.

Data Type

String

AttachmentHeaders Property (AS2Receiver Control)

The control fills out Headers each time any of the other properties for that ediattachment are changed.

Syntax

as2receivercontrol.AttachmentHeaders(AttachmentIndex)

Default Value

""

Remarks

The control fills out AttachmentHeaders each time any of the other properties for that EDIAttachment are changed. If additional headers are needed they should be appended after all the other propertys for that EDIAttachment are set.

The AttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.

This property is read-only and not available at design time.

Data Type

String

AttachmentName Property (AS2Receiver Control)

Name is the final name to be associated with the contents of either the Data or Filename properties.

Syntax

as2receivercontrol.AttachmentName(AttachmentIndex)

Default Value

""

Remarks

AttachmentName is the final name to be associated with the contents of either the AttachmentData or AttachmentFilename properties. This corresponds to the filename attribute of the Content-Disposition header for this attachment.

The AttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.

This property is read-only and not available at design time.

Data Type

String

CEMCount Property (AS2Receiver Control)

The number of records in the CEM arrays.

Syntax

as2receivercontrol.CEMCount[=integer]

Default Value

0

Remarks

This property controls the size of the following arrays:

• CEMAccepted
• CEMCertId
• CEMCertIssuer
• CEMCertSerialNumber
• CEMCertStore
• CEMCertStorePassword
• CEMCertStoreType
• CEMCertSubject
• CEMCertUsage
• CEMRejectionReason
• CEMRespondByDate
• CEMResponseURL

The array indices start at 0 and end at CEMCount - 1.

This property is not available at design time.

Data Type

Integer

CEMAccepted Property (AS2Receiver Control)

Whether the CEM request is accepted.

Syntax

as2receivercontrol.CEMAccepted(CEMIndex)[=boolean]

Default Value

False

Remarks

Whether the CEM request is accepted.

Before calling SendCEMResponse set this to True to accept the CEM request.

When processing a CEM response check this property to determine if the request was accepted.

The CEMIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CEMCount property.

This property is not available at design time.

Data Type

Boolean

CEMCertId Property (AS2Receiver Control)

A user defined identifier for the certificate.

Syntax

as2receivercontrol.CEMCertId(CEMIndex)[=string]

Default Value

""

Remarks

A user defined identifier for the certificate.

This property defines a user specified identifier for the certificate. This may be set to a value which helps the recipient identify the certificate. For instance "CompanyA.Encryption.Cert.2014".

This property may be set before calling SendCEMRequest or SendCEMResponse from AS2Sender.

This property may be queried when received a CEM request or response with AS2Receiver.

The CEMIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CEMCount property.

This property is not available at design time.

Data Type

String

CEMCertIssuer Property (AS2Receiver Control)

This property holds the issuer of the certificate.

Syntax

as2receivercontrol.CEMCertIssuer(CEMIndex)[=string]

Default Value

""

Remarks

This property holds the issuer of the certificate. This may be queried when receiving a CEM request with AS2Receiver. This may be set before calling SendCEMResponse with AS2Sender.

The CEMIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CEMCount property.

This property is not available at design time.

Data Type

String

CEMCertSerialNumber Property (AS2Receiver Control)

This property holds the serial number of the certificate.

Syntax

as2receivercontrol.CEMCertSerialNumber(CEMIndex)[=string]

Default Value

""

Remarks

This property holds the serial number of the certificate. This may be queried when receiving a CEM request with AS2Receiver. This may be set before calling SendCEMResponse with AS2Sender.

The CEMIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CEMCount property.

This property is not available at design time.

Data Type

String

CEMCertStore Property (AS2Receiver Control)

The name of the certificate store for the certificate.

Syntax

as2receivercontrol.CEMCertStore(CEMIndex)[=string]

Default Value

"MY"

Remarks

The name of the certificate store for the certificate.

This property defines the store location for the type specified by CEMCertStoreType.

Designations of certificate stores are platform dependent.

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

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., PKCS#12 certificate store).

The CEMIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CEMCount property.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .CEMCertStoreB.

This property is not available at design time.

Data Type

Binary String

CEMCertStorePassword Property (AS2Receiver Control)

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.

Syntax

as2receivercontrol.CEMCertStorePassword(CEMIndex)[=string]

Default Value

""

Remarks

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.

The CEMIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CEMCount property.

This property is not available at design time.

Data Type

String

CEMCertStoreType Property (AS2Receiver Control)

The type of certificate store for this certificate.

Syntax

as2receivercontrol.CEMCertStoreType(CEMIndex)[=integer]

Possible Values

cstUser(0), 
cstMachine(1), 
cstPFXFile(2), 
cstPFXBlob(3), 
cstJKSFile(4), 
cstJKSBlob(5), 
cstPEMKeyFile(6), 
cstPEMKeyBlob(7), 
cstPublicKeyFile(8), 
cstPublicKeyBlob(9), 
cstSSHPublicKeyBlob(10), 
cstP7BFile(11), 
cstP7BBlob(12), 
cstSSHPublicKeyFile(13), 
cstPPKFile(14), 
cstPPKBlob(15), 
cstXMLFile(16), 
cstXMLBlob(17), 
cstJWKFile(18), 
cstJWKBlob(19), 
cstSecurityKey(20), 
cstBCFKSFile(21), 
cstBCFKSBlob(22), 
cstPKCS11(23), 
cstAuto(99)

Default Value

0

Remarks

The type of certificate store for this certificate.

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

The CEMIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CEMCount property.

This property is not available at design time.

Data Type

Integer

CEMCertSubject Property (AS2Receiver Control)

The subject of the certificate.

Syntax

as2receivercontrol.CEMCertSubject(CEMIndex)[=string]

Default Value

""

Remarks

The subject of the certificate.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

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

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

If a match is still 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.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

The CEMIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CEMCount property.

This property is not available at design time.

Data Type

String

CEMCertUsage Property (AS2Receiver Control)

This property defines which usages are applicable to the certificate.

Syntax

as2receivercontrol.CEMCertUsage(CEMIndex)[=integer]

Default Value

15

Remarks

This property defines which usages are applicable to the certificate. This may be set to a binary 'OR' of one or more of the following values:

• 1 (TLS Client)
• 2 (TLS Server)
• 4 (Encryption)
• 8 (Signature)

The CEMIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CEMCount property.

This property is not available at design time.

Data Type

Integer

CEMRejectionReason Property (AS2Receiver Control)

If Accepted is False this property specifies the reason a request was rejected.

Syntax

as2receivercontrol.CEMRejectionReason(CEMIndex)[=string]

Default Value

""

Remarks

If CEMAccepted is False this property specifies the reason a request was rejected.

When using AS2Sender this may be set to a string value which the recipient will see.

When using AS2Receiver query this property for details on why the request was rejected.

The CEMIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CEMCount property.

This property is not available at design time.

Data Type

String

CEMRespondByDate Property (AS2Receiver Control)

This property specifies the date by which the other party should respond.

Syntax

as2receivercontrol.CEMRespondByDate(CEMIndex)[=string]

Default Value

""

Remarks

This property specifies the date by which the other party should respond. If the other party does not respond the new certificate may be used without any further notice. This property exists to assist the recipient in knowing when they should respond by. It does not guarantee a response by the specified date.

The format is of the XML standard dateTime type expressed in local time with UTC offset. For instance: "2005-08-31T00:21:00-05:00".

When using AS2Sender set this before calling SendCEMRequest.

When using AS2Receiver this property may be queried.

The CEMIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CEMCount property.

This property is not available at design time.

Data Type

String

CEMResponseURL Property (AS2Receiver Control)

This property defines the URL to which the response should be sent.

Syntax

as2receivercontrol.CEMResponseURL(CEMIndex)[=string]

Default Value

""

Remarks

This property defines the URL to which the response should be sent.

When using AS2Sender set this property before calling SendCEMRequest. This tells the recipient where to send the response.

When using AS2Receiver query this property to determine the URL where the response should be sent.

The CEMIndex parameter specifies the index of the item in the array. The size of the array is controlled by the CEMCount property.

This property is not available at design time.

Data Type

String

CertEncoded Property (AS2Receiver Control)

This is the certificate (PEM/Base64 encoded).

Syntax

as2receivercontrol.CertEncoded[=string]

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The CertStore and CertSubject properties also may be used to specify a certificate.

When CertEncoded is set, a search is initiated in the current CertStore for the private key of the certificate. If the key is found, CertSubject is updated to reflect the full subject of the selected certificate; otherwise, CertSubject is set to an empty string.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .CertEncodedB.

This property is not available at design time.

Data Type

Binary String

CertStore Property (AS2Receiver Control)

This is the name of the certificate store for the client certificate.

Syntax

as2receivercontrol.CertStore[=string]

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The CertStoreType property denotes the type of the certificate store specified by CertStore. If the store is password protected, specify the password in CertStorePassword.

CertStore is used in conjunction with the CertSubject property to specify client certificates. If CertStore has a value, and CertSubject or CertEncoded is set, a search for a certificate is initiated. Please see the CertSubject property for details.

Designations of certificate stores are platform dependent.

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

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., PKCS#12 certificate store).

To read or write binary data to the property, a Variant (Byte Array) version is provided in .CertStoreB.

Data Type

Binary String

CertStorePassword Property (AS2Receiver Control)

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

Syntax

as2receivercontrol.CertStorePassword[=string]

Default Value

""

Remarks

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

Data Type

String

CertStoreType Property (AS2Receiver Control)

This is the type of certificate store for this certificate.

Syntax

as2receivercontrol.CertStoreType[=integer]

Possible Values

cstUser(0), 
cstMachine(1), 
cstPFXFile(2), 
cstPFXBlob(3), 
cstJKSFile(4), 
cstJKSBlob(5), 
cstPEMKeyFile(6), 
cstPEMKeyBlob(7), 
cstPublicKeyFile(8), 
cstPublicKeyBlob(9), 
cstSSHPublicKeyBlob(10), 
cstP7BFile(11), 
cstP7BBlob(12), 
cstSSHPublicKeyFile(13), 
cstPPKFile(14), 
cstPPKBlob(15), 
cstXMLFile(16), 
cstXMLBlob(17), 
cstJWKFile(18), 
cstJWKBlob(19), 
cstSecurityKey(20), 
cstBCFKSFile(21), 
cstBCFKSBlob(22), 
cstPKCS11(23), 
cstAuto(99)

Default Value

0

Remarks

This is the type of certificate store for this certificate.

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

Data Type

Integer

CertSubject Property (AS2Receiver Control)

This is the subject of the certificate used for client authentication.

Syntax

as2receivercontrol.CertSubject[=string]

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

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

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

If a match is still 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.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

CompressionFormat Property (AS2Receiver Control)

The compression format used on the incoming message.

Syntax

as2receivercontrol.CompressionFormat

Possible Values

tcfNone(0), 
tcfZLIB(1)

Default Value

0

Remarks

The compression format used on the incoming message, if any. Compressed messages will automatically be decompressed by the control.

This property is read-only.

Data Type

Integer

EDIData Property (AS2Receiver Control)

This property contains the EDI payload of the transmission.

Syntax

as2receivercontrol.EDIData

Default Value

""

Remarks

This property contains the EDI payload of the transmission.

In a receiver, this property will only be populated if IncomingDirectory and EDIOutputStream have not been specified and ParseRequest finishes without an error, setting ScanResult to 0. If so, Data will contain the full decrypted text of the EDI message.

This property will only be populated if ParseRequest or ProcessRequest finishes without an error, setting ScanResult to 0. If so, EDIData will contain the processed EDI message.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .EDIDataB.

This property is read-only.

Data Type

Binary String

EDIType Property (AS2Receiver Control)

The Content-Type of the EDI message.

Syntax

as2receivercontrol.EDIType

Default Value

""

Remarks

The Content-Type of the EDI message. Sample values might be "application/edi-x12", "application/edifact" or "application/xml".

This property is read-only.

Data Type

String

EDIFilename Property (AS2Receiver Control)

In a sender, if Filename is specified, the file specified will be used for the EDI payload of the transmission.

Syntax

as2receivercontrol.EDIFilename

Default Value

""

Remarks

In a sender, if EDIFilename is specified, the file specified will be used for the EDI payload of the transmission. EDIName will be populated with the name of the file.

In a receiver, when IncomingDirectory is set, this will be populated with the absolute path of the file which contains the processed message contents.

Note: When EDIOutputStream is set, the data will be written to the stream and this property will not be populated.

This property is read-only.

Data Type

String

EDIName Property (AS2Receiver Control)

Name is the final name to be associated with the contents of either the Data or FileName properties.

Syntax

as2receivercontrol.EDIName

Default Value

"rfc1767.edi"

Remarks

EDIName is the final name to be associated with the contents of either the EDIData or EDIFileName properties. This corresponds to the filename attribute of the Content-Disposition header for the EDI payload.

When constructing EDI data to be sent, EDIName will be set to the same value as EDIFileName, but can be overridden after setting EDIFileName to indicate that another name should be used in the outbound request's Content-Disposition MIME header.

When receiving EDI data, EDIName will be read out of the "filename" attribute of the inbound request's Content-Disposition MIME header.

This property is read-only.

Data Type

String

FirewallAutoDetect Property (AS2Receiver Control)

This property tells the control whether or not to automatically detect and use firewall system settings, if available.

Syntax

as2receivercontrol.FirewallAutoDetect[=boolean]

Default Value

False

Remarks

This property tells the control whether or not to automatically detect and use firewall system settings, if available.

Data Type

Boolean

FirewallType Property (AS2Receiver Control)

This property determines the type of firewall to connect through.

Syntax

as2receivercontrol.FirewallType[=integer]

Possible Values

fwNone(0), 
fwTunnel(1), 
fwSOCKS4(2), 
fwSOCKS5(3), 
fwSOCKS4A(10)

Default Value

0

Remarks

This property determines the type of firewall to connect through. The applicable values are as follows:

Data Type

Integer

FirewallHost Property (AS2Receiver Control)

This property contains the name or IP address of firewall (optional).

Syntax

as2receivercontrol.FirewallHost[=string]

Default Value

""

Remarks

This property contains the name or IP address of firewall (optional). If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the control fails with an error.

Data Type

String

FirewallPassword Property (AS2Receiver Control)

This property contains a password if authentication is to be used when connecting through the firewall.

Syntax

as2receivercontrol.FirewallPassword[=string]

Default Value

""

Remarks

This property contains a password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the control fails with an error.

Data Type

String

FirewallPort Property (AS2Receiver Control)

This property contains the transmission control protocol (TCP) port for the firewall Host .

Syntax

as2receivercontrol.FirewallPort[=integer]

Default Value

0

Remarks

This property contains the transmission control protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.

Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.

Data Type

Integer

FirewallUser Property (AS2Receiver Control)

This property contains a user name if authentication is to be used connecting through a firewall.

Syntax

as2receivercontrol.FirewallUser[=string]

Default Value

""

Remarks

This property contains a user name if authentication is to be used connecting through a firewall. If the FirewallHost is specified, this property and FirewallPassword properties are used to connect and authenticate to the given Firewall. If the authentication fails, the control fails with an error.

Data Type

String

IncomingDirectory Property (AS2Receiver Control)

The directory to be used to store incoming messages.

Syntax

as2receivercontrol.IncomingDirectory[=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 control 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.

Please note that the SetTPInfo method, if used, needs to be invoked before setting this property because it overrides the setting for incoming directory.

Data Type

String

LocalHost Property (AS2Receiver Control)

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

Syntax

as2receivercontrol.LocalHost[=string]

Default Value

""

Remarks

The LocalHost property 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 multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the control initiate connections (or accept in the case of server controls) only through that interface.

If the control is connected, the LocalHost property 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 multi-homed hosts (machines with more than one IP interface).

NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window.

Data Type

String

LogDirectory Property (AS2Receiver Control)

The path to a directory for logging.

Syntax

as2receivercontrol.LogDirectory[=string]

Default Value

""

Remarks

Setting LogDirectory will instruct the component to log the details of each transmission to unique files in the specified directory. For each request processed, the control will log the complete text of the outgoing request and the incoming response.

The control will write multiple log file for each transmission, with separate extensions for each type of data:

One or more of these logs may be disabled by setting the LogOptions configuration setting.

LogDirectory supports several macros that can be used to specify a unique directory path. If the path specified does not already exist, the control will attempt to create the directory. The following macros are supported:

The filenames will be chosen automatically by the control. Each filename will be the system time, in the format YYYY-MM-DD-HH-MM-SS-MMMM, with extensions "-2", "-3", used in case files of those names already exist. After each transaction is processed LogFile will contain the name of the files just written, minus the extension.

If logs cannot be written an exception will be thrown.

Data Type

String

LogFile Property (AS2Receiver Control)

The log file written.

Syntax

as2receivercontrol.LogFile

Default Value

""

Remarks

In case LogDirectory is specified a log file will be written in the specified directory and LogFile will contain the full path and name of the files just written, minus the extension.

The control will write multiple log files for each transmission, with separate extensions for each type of data:

This property is read-only.

Data Type

String

MDNReceiptContent Property (AS2Receiver Control)

This contains the entire content of the MDN Receipt.

Syntax

as2receivercontrol.MDNReceiptContent[=string]

Default Value

""

Remarks

This contains the entire content of the MDN Receipt. This is a multipart/report entity consisting of a machine readable MDNReceiptMDN (Message Disposition Notification) and a human readable MDNReceiptMessage, which itself may be embedded in a multipart/signed entity if requested by the AS2 sender.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .MDNReceiptContentB.

Data Type

Binary String

MDNReceiptHeaderCount Property (AS2Receiver Control)

The number of headers in the MDN.

Syntax

as2receivercontrol.MDNReceiptHeaderCount

Default Value

0

Remarks

The number of headers in the MDN.

This property is read-only and not available at design time.

Data Type

Integer

MDNReceiptHeaderField Property (AS2Receiver Control)

The property name of the MDN header currently selected by HeaderIndex .

Syntax

as2receivercontrol.MDNReceiptHeaderField

Default Value

""

Remarks

The field name of the MDN header currently selected by MDNReceiptHeaderIndex.

This property is read-only and not available at design time.

Data Type

String

MDNReceiptHeaderIndex Property (AS2Receiver Control)

Which MDN header is currently selected to populate HeaderField and HeaderValue .

Syntax

as2receivercontrol.MDNReceiptHeaderIndex[=integer]

Default Value

0

Remarks

Which MDN header is currently selected to populate MDNReceiptHeaderField and MDNReceiptHeaderValue.

Valid values are 0 to MDNReceiptHeaderCount - 1.

This property is not available at design time.

Data Type

Integer

MDNReceiptHeaders Property (AS2Receiver Control)

Headers contains all of the headers of the AS2 MDN Receipt as a single string.

Syntax

as2receivercontrol.MDNReceiptHeaders[=string]

Default Value

""

Remarks

Headers contains all of the headers of the AS2 MDN Receipt as a single string. This will include headers such as AS2-From, AS2-To, Date, Content-Type, etc. In an AS2Sender, these will also contain the transport headers of the MDN Receipt (HTTP or SMTP headers, depending on the delivery option).

You can also use MDNReceiptHeaderCount, MDNReceiptHeaderIndex, MDNReceiptHeaderField, and MDNReceiptHeaderValue to easily iterate through each individual header.

Data Type

String

MDNReceiptHeaderValue Property (AS2Receiver Control)

The value of the MDN header currently selected by HeaderIndex .

Syntax

as2receivercontrol.MDNReceiptHeaderValue

Default Value

""

Remarks

The value of the MDN header currently selected by MDNReceiptHeaderIndex.

This property is read-only and not available at design time.

Data Type

String

MDNReceiptMDN Property (AS2Receiver Control)

MDN will contain the entire machine readable text of the Message Disposition Notification in the receipt.

Syntax

as2receivercontrol.MDNReceiptMDN

Default Value

""

Remarks

MDN will contain the entire machine readable text of the Message Disposition Notification in the receipt. It will report either success or failure depending on the processing status of the receiver. In either case, it will be RFC-compliant.

This property is read-only.

Data Type

String

MDNReceiptMessage Property (AS2Receiver Control)

The human-readable portion of the MDN receipt.

Syntax

as2receivercontrol.MDNReceiptMessage

Default Value

""

Remarks

The human-readable portion of the MDN receipt.

The human-readable portion of the MDN receipt that indicates the status of the message processing. This can be used to provide the user with a helpful message in the event that an error is encountered.

This property is read-only.

Data Type

String

MDNReceiptMICValue Property (AS2Receiver Control)

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

Syntax

as2receivercontrol.MDNReceiptMICValue

Default Value

""

Remarks

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

An MDN Receipt contains a MIC calculated over the EDI message that the receipt is in response to, to be matched on the sender side against a saved value for the original request to ensure that the integrity of the data that the receiver reports is preserved. When a signed receipt is requested, the MIC is be 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".

This property is read-only.

Data Type

String

MDNReceiptSigningProtocol Property (AS2Receiver Control)

This property contains the MIME type of the signature used, if any (i.

Syntax

as2receivercontrol.MDNReceiptSigningProtocol

Default Value

""

Remarks

This property contains the MIME type of the signature used, if any (i.e., "application/pkcs7-signature"), to create this MDNReceipt. It will contain an empty string if the receipt is unsigned.

This property is read-only.

Data Type

String

MDNTo Property (AS2Receiver Control)

The recipient for the Message Disposition Notification (MDN).

Syntax

as2receivercontrol.MDNTo

Default Value

""

Remarks

MDNTo corresponds to the Disposition-Notification-To header of RequestHeaders. If nonempty, the client has requested an MDN receipt (typically the actual value is irrelevant). This receipt will be generated in a call to ProcessRequest or CreateMDNReceipt, and may be sent by calling SendResponse.

The receipt will be contained in MDNReceipt. If ReceiptDeliveryOption is empty, the receipt should be synchronously delivered in the HTTP response; otherwise, it should be delivered asynchronously to the URL specified. In either case, SendResponse will send the response as appropriate.

According to RFC specifications, MDNReceipt must be sent if requested by the client. If MDNTo is empty the MDN may be sent or not at the option of the server.

This property is read-only.

Data Type

String

MessageId Property (AS2Receiver Control)

The message ID of the incoming message.

Syntax

as2receivercontrol.MessageId

Default Value

""

Remarks

MessageId corresponds to the Message-Id header of Request, and will be used as the Original-Message-Id header of MDNReceipt.

This property is read-only.

Data Type

String

ReceiptDeliveryOption Property (AS2Receiver Control)

A URL indicating how the receipt is to be delivered.

Syntax

as2receivercontrol.ReceiptDeliveryOption

Default Value

""

Remarks

This property corresponds to the Receipt-delivery-option header in Request. If nonempty, the client has requested that the receipt be sent to the URL specified asynchronously. If empty, the receipt is to be delivered synchronously in the HTTP reply. In either case the receipt may be delivered by invoking SendResponse.

ReceiptDeliveryOption 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 read-only.

Data Type

String

Request Property (AS2Receiver Control)

The HTTP request to be processed.

Syntax

as2receivercontrol.Request[=string]

Default Value

""

Remarks

The body of the request to be processed. The HTTP headers may be set separately in RequestHeaders or may be included in Request. If they are included, a double CRLF pair should be used to separate the headers from the body.

When ParseRequest or ProcessRequest is invoked, the contents of Request are lost and you can read the processed data in EDIData.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .RequestB.

This property is not available at design time.

Data Type

Binary String

RequestHeaderCount Property (AS2Receiver Control)

The number of records in the RequestHeader arrays.

Syntax

as2receivercontrol.RequestHeaderCount[=integer]

Default Value

0

Remarks

This property controls the size of the following arrays:

• RequestHeaderField
• RequestHeaderValue

The array indices start at 0 and end at RequestHeaderCount - 1.

This property is not available at design time.

Data Type

Integer

RequestHeaderField Property (AS2Receiver Control)

This property contains the name of the HTTP header (this is the same case as it is delivered).

Syntax

as2receivercontrol.RequestHeaderField(RequestHeaderIndex)[=string]

Default Value

""

Remarks

This property contains the name of the HTTP Header (this is the same case as it is delivered).

The RequestHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RequestHeaderCount property.

This property is not available at design time.

Data Type

String

RequestHeaderValue Property (AS2Receiver Control)

This property contains the header contents.

Syntax

as2receivercontrol.RequestHeaderValue(RequestHeaderIndex)[=string]

Default Value

""

Remarks

This property contains the Header contents.

The RequestHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RequestHeaderCount property.

This property is not available at design time.

Data Type

String

RequestHeadersString Property (AS2Receiver Control)

The HTTP headers in the AS2 request.

Syntax

as2receivercontrol.RequestHeadersString[=string]

Default Value

""

Remarks

The entire list of headers, concatenated into a single string. These will include AS2- specific headers as well as general HTTP headers. You may access specific headers through RequestHeaders.

When assigning an AS2 request to the control, the headers may be included in Request or specified separately in RequestHeaders. If the headers are included in Request they will be parsed out whenever ReadRequest, ParseRequest, or ProcessRequest is invoked.

Data Type

String

RestartDirectory Property (AS2Receiver Control)

The directory to log cached files when using AS2 restart functionality.

Syntax

as2receivercontrol.RestartDirectory[=string]

Default Value

""

Remarks

If this property is set, the control will cache all received files to the RestartDirectory. Thus, when receiving a file is interrupted, the client can restart the transmission of the file starting where it was interrupted.

To use this functionality, HTTP HEAD requests must be processed using the ProcessRestartRequest method.

When using restart functionality, the data is processed after the entire file contents are received.

NOTE: This directory will not automatically be cleaned up.

Data Type

String

RolloverCertEncoded Property (AS2Receiver Control)

This is the certificate (PEM/Base64 encoded).

Syntax

as2receivercontrol.RolloverCertEncoded[=string]

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The RolloverCertStore and RolloverCertSubject properties also may be used to specify a certificate.

When RolloverCertEncoded is set, a search is initiated in the current RolloverCertStore for the private key of the certificate. If the key is found, RolloverCertSubject is updated to reflect the full subject of the selected certificate; otherwise, RolloverCertSubject is set to an empty string.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .RolloverCertEncodedB.

This property is not available at design time.

Data Type

Binary String

RolloverCertStore Property (AS2Receiver Control)

This is the name of the certificate store for the client certificate.

Syntax

as2receivercontrol.RolloverCertStore[=string]

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The RolloverCertStoreType property denotes the type of the certificate store specified by RolloverCertStore. If the store is password protected, specify the password in RolloverCertStorePassword.

RolloverCertStore is used in conjunction with the RolloverCertSubject property to specify client certificates. If RolloverCertStore has a value, and RolloverCertSubject or RolloverCertEncoded is set, a search for a certificate is initiated. Please see the RolloverCertSubject property for details.

Designations of certificate stores are platform dependent.

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

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., PKCS#12 certificate store).

To read or write binary data to the property, a Variant (Byte Array) version is provided in .RolloverCertStoreB.

Data Type

Binary String

RolloverCertStorePassword Property (AS2Receiver Control)

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

Syntax

as2receivercontrol.RolloverCertStorePassword[=string]

Default Value

""

Remarks

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

Data Type

String

RolloverCertStoreType Property (AS2Receiver Control)

This is the type of certificate store for this certificate.

Syntax

as2receivercontrol.RolloverCertStoreType[=integer]

Possible Values

cstUser(0), 
cstMachine(1), 
cstPFXFile(2), 
cstPFXBlob(3), 
cstJKSFile(4), 
cstJKSBlob(5), 
cstPEMKeyFile(6), 
cstPEMKeyBlob(7), 
cstPublicKeyFile(8), 
cstPublicKeyBlob(9), 
cstSSHPublicKeyBlob(10), 
cstP7BFile(11), 
cstP7BBlob(12), 
cstSSHPublicKeyFile(13), 
cstPPKFile(14), 
cstPPKBlob(15), 
cstXMLFile(16), 
cstXMLBlob(17), 
cstJWKFile(18), 
cstJWKBlob(19), 
cstSecurityKey(20), 
cstBCFKSFile(21), 
cstBCFKSBlob(22), 
cstPKCS11(23), 
cstAuto(99)

Default Value

0

Remarks

This is the type of certificate store for this certificate.

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

Data Type

Integer

RolloverCertSubject Property (AS2Receiver Control)

This is the subject of the certificate used for client authentication.

Syntax

as2receivercontrol.RolloverCertSubject[=string]

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

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

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

If a match is still 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.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

ScanResult Property (AS2Receiver Control)

The result of invoking ParseRequest .

Syntax

as2receivercontrol.ScanResult

Default Value

0

Remarks

ScanResult will contain information about any errors that occurred while invoking ParseRequest or ProcessRequest. 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.

This property is read-only.

Data Type

Integer

SignerCertEncoded Property (AS2Receiver Control)

This is the certificate (PEM/Base64 encoded).

Syntax

as2receivercontrol.SignerCertEncoded[=string]

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SignerCertStore and SignerCertSubject properties also may be used to specify a certificate.

When SignerCertEncoded is set, a search is initiated in the current SignerCertStore for the private key of the certificate. If the key is found, SignerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SignerCertSubject is set to an empty string.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SignerCertEncodedB.

This property is not available at design time.

Data Type

Binary String

SignerCertStore Property (AS2Receiver Control)

This is the name of the certificate store for the client certificate.

Syntax

as2receivercontrol.SignerCertStore[=string]

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The SignerCertStoreType property denotes the type of the certificate store specified by SignerCertStore. If the store is password protected, specify the password in SignerCertStorePassword.

SignerCertStore is used in conjunction with the SignerCertSubject property to specify client certificates. If SignerCertStore has a value, and SignerCertSubject or SignerCertEncoded is set, a search for a certificate is initiated. Please see the SignerCertSubject property for details.

Designations of certificate stores are platform dependent.

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

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., PKCS#12 certificate store).

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SignerCertStoreB.

This property is not available at design time.

Data Type

Binary String

SignerCertStorePassword Property (AS2Receiver Control)

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

Syntax

as2receivercontrol.SignerCertStorePassword[=string]

Default Value

""

Remarks

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

This property is not available at design time.

Data Type

String

SignerCertStoreType Property (AS2Receiver Control)

This is the type of certificate store for this certificate.

Syntax

as2receivercontrol.SignerCertStoreType[=integer]

Possible Values

cstUser(0), 
cstMachine(1), 
cstPFXFile(2), 
cstPFXBlob(3), 
cstJKSFile(4), 
cstJKSBlob(5), 
cstPEMKeyFile(6), 
cstPEMKeyBlob(7), 
cstPublicKeyFile(8), 
cstPublicKeyBlob(9), 
cstSSHPublicKeyBlob(10), 
cstP7BFile(11), 
cstP7BBlob(12), 
cstSSHPublicKeyFile(13), 
cstPPKFile(14), 
cstPPKBlob(15), 
cstXMLFile(16), 
cstXMLBlob(17), 
cstJWKFile(18), 
cstJWKBlob(19), 
cstSecurityKey(20), 
cstBCFKSFile(21), 
cstBCFKSBlob(22), 
cstPKCS11(23), 
cstAuto(99)

Default Value

0

Remarks

This is the type of certificate store for this certificate.

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

This property is not available at design time.

Data Type

Integer

SignerCertSubject Property (AS2Receiver Control)

This is the subject of the certificate used for client authentication.

Syntax

as2receivercontrol.SignerCertSubject[=string]

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

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

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

If a match is still 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.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

This property is not available at design time.

Data Type

String

SSLAcceptServerCertEncoded Property (AS2Receiver Control)

This is the certificate (PEM/Base64 encoded).

Syntax

as2receivercontrol.SSLAcceptServerCertEncoded[=string]

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.

When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLAcceptServerCertEncodedB.

This property is not available at design time.

Data Type

Binary String

SSLAcceptServerCertStore Property (AS2Receiver Control)

This is the name of the certificate store for the client certificate.

Syntax

as2receivercontrol.SSLAcceptServerCertStore[=string]

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The SSLAcceptServerCertStoreType property denotes the type of the certificate store specified by SSLAcceptServerCertStore. If the store is password protected, specify the password in SSLAcceptServerCertStorePassword.

SSLAcceptServerCertStore is used in conjunction with the SSLAcceptServerCertSubject property to specify client certificates. If SSLAcceptServerCertStore has a value, and SSLAcceptServerCertSubject or SSLAcceptServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLAcceptServerCertSubject property for details.

Designations of certificate stores are platform dependent.

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

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., PKCS#12 certificate store).

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLAcceptServerCertStoreB.

Data Type

Binary String

SSLAcceptServerCertStorePassword Property (AS2Receiver Control)

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

Syntax

as2receivercontrol.SSLAcceptServerCertStorePassword[=string]

Default Value

""

Remarks

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

Data Type

String

SSLAcceptServerCertStoreType Property (AS2Receiver Control)

This is the type of certificate store for this certificate.

Syntax

as2receivercontrol.SSLAcceptServerCertStoreType[=integer]

Possible Values

cstUser(0), 
cstMachine(1), 
cstPFXFile(2), 
cstPFXBlob(3), 
cstJKSFile(4), 
cstJKSBlob(5), 
cstPEMKeyFile(6), 
cstPEMKeyBlob(7), 
cstPublicKeyFile(8), 
cstPublicKeyBlob(9), 
cstSSHPublicKeyBlob(10), 
cstP7BFile(11), 
cstP7BBlob(12), 
cstSSHPublicKeyFile(13), 
cstPPKFile(14), 
cstPPKBlob(15), 
cstXMLFile(16), 
cstXMLBlob(17), 
cstJWKFile(18), 
cstJWKBlob(19), 
cstSecurityKey(20), 
cstBCFKSFile(21), 
cstBCFKSBlob(22), 
cstPKCS11(23), 
cstAuto(99)

Default Value

0

Remarks

This is the type of certificate store for this certificate.

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

Data Type

Integer

SSLAcceptServerCertSubject Property (AS2Receiver Control)

This is the subject of the certificate used for client authentication.

Syntax

as2receivercontrol.SSLAcceptServerCertSubject[=string]

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

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

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

If a match is still 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.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

SSLCertEncoded Property (AS2Receiver Control)

This is the certificate (PEM/Base64 encoded).

Syntax

as2receivercontrol.SSLCertEncoded[=string]

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLCertEncodedB.

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (AS2Receiver Control)

This is the name of the certificate store for the client certificate.

Syntax

as2receivercontrol.SSLCertStore[=string]

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform dependent.

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

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., PKCS#12 certificate store).

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SSLCertStoreB.

Data Type

Binary String

SSLCertStorePassword Property (AS2Receiver Control)

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

Syntax

as2receivercontrol.SSLCertStorePassword[=string]

Default Value

""

Remarks

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

Data Type

String

SSLCertStoreType Property (AS2Receiver Control)

This is the type of certificate store for this certificate.

Syntax

as2receivercontrol.SSLCertStoreType[=integer]

Possible Values

cstUser(0), 
cstMachine(1), 
cstPFXFile(2), 
cstPFXBlob(3), 
cstJKSFile(4), 
cstJKSBlob(5), 
cstPEMKeyFile(6), 
cstPEMKeyBlob(7), 
cstPublicKeyFile(8), 
cstPublicKeyBlob(9), 
cstSSHPublicKeyBlob(10), 
cstP7BFile(11), 
cstP7BBlob(12), 
cstSSHPublicKeyFile(13), 
cstPPKFile(14), 
cstPPKBlob(15), 
cstXMLFile(16), 
cstXMLBlob(17), 
cstJWKFile(18), 
cstJWKBlob(19), 
cstSecurityKey(20), 
cstBCFKSFile(21), 
cstBCFKSBlob(22), 
cstPKCS11(23), 
cstAuto(99)

Default Value

0

Remarks

This is the type of certificate store for this certificate.

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

Data Type

Integer

SSLCertSubject Property (AS2Receiver Control)

This is the subject of the certificate used for client authentication.

Syntax

as2receivercontrol.SSLCertSubject[=string]

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

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

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

If a match is still 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.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

UsePSS Property (AS2Receiver Control)

This property specifies whether or not RSA-PSS will be used during signing and verification.

Syntax

as2receivercontrol.UsePSS[=boolean]

Default Value

False

Remarks

This property specifies whether or not RSA-PSS will be used when signing and verifying messages. The default value is False.

Data Type

Boolean

AckRequest Method (AS2Receiver Control)

Optional. Acknowledges the incoming request.

Syntax

as2receivercontrol.AckRequest 

Remarks

When called from within a server environment, AckRequest will acknowledge the client request with a 200 OK. This may be useful if the client has posted a lot of data, and has requested an asynchronous receipt.

If an acknowledgement is not expected (i.e., the client is expecting an MDN in the response), then invoking this method will do nothing. Servers may safely call this method immediately after ParseRequest for both synchronous and asynchronous MDN requests.

Config Method (AS2Receiver Control)

Sets or retrieves a configuration setting.

Syntax

as2receivercontrol.Config ConfigurationString

Remarks

Config is a generic method available in every control. It is used to set and retrieve configuration settings for the control.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the control, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

CreateMDNReceipt Method (AS2Receiver Control)

Creates MDNReceipt .

Syntax

as2receivercontrol.CreateMDNReceipt Headers, MDN, Message

Remarks

CreateMDNReceipt may be invoked after ParseRequest to create an MDN-based receipt. The receipt will report success or failure depending on ErrorReportingFlags and the success or failure of ParseRequest.

This method populates MDNReceipt with a new MDNReceipt. The Headers, MDN, and Message parameters can be used to further customize the receipt, or empty string ("") parameters may be set to use the control generated defaults. Headers will set additional transport headers to be sent with the receipt (in the HTTP or SMTP headers of the signed receipt). MDN can be used to append additional headers to the Message Disposition Notification portion of the MDN Receipt. If MDN is set to a value prefixed with an at sign ("@"), the at sign will be removed and the specified MDN will be used in the receipt in place of the component generated value. Message will set the human-readable portion of the receipt, and should describe any error conditions that may have occurred.

ParseRequest Method (AS2Receiver Control)

Parses the EDI message and determines the EDIData .

Syntax

as2receivercontrol.ParseRequest 

Remarks

Processes the EDI message in the request (either from the HTTP context, or as given by Request and possibly RequestHeadersString). If the message is encrypted, it will be decrypted with the certificate specified in Certificate. If it is signed, the signature will be verified against the certificate specified in SignerCert.

If the message is scanned without difficulty, EDIData will be populated. If a problem occurs, an exception will be thrown. This might occur if the client used or requested unsupported algorithms or data formats. In this case, EDIData will not be determined.

The control may be configured to ignore certain errors by setting ErrorProcessingFlags. This will allow the message to be processed and EDIData to be determined. If any errors occur, an exception will be thrown and the ScanResult property will reflect the error condition.

Whether or not an exception is thrown, an MDNReceipt may be generated by invoking CreateMDNReceipt. In the case of a successful scan MDNReceipt will report the success, otherwise the receipt will provide information to the client about the error.

ProcessRequest may be used to scan and create the receipt in one step. ReadRequest may be used to scan the request headers only to obtain details that can be used to configure the correct settings for the partner.

ProcessRequest Method (AS2Receiver Control)

Processes the EDI data, and generates the receipt.

Syntax

as2receivercontrol.ProcessRequest 

Remarks

Invoking ProcessRequest automates the entire AS2 server process. The method scans the request, determines the EDIData, and generates the MDNReceipt. In a server environment the receipt may be returned by invoking SendResponse.

The method's functionality is the same as the combined functionality of ParseRequest and CreateMDNReceipt. The method's operation is controlled by ErrorProcessingFlags and ErrorReportingFlags, and ScanResult will be populated as in ParseRequest.

The method will throw an exception, as ParseRequest does, if a problem is found while processing the request. However, if the problem does not prevent an MDN from being generated, MDNReceipt will still be generated before the exception is thrown. In all cases, the receipt will be suitable for returning to the client. If an exception is thrown, the MDNReceipt will provide more detail on the cause of the error.

The control will populate EDIData if no errors occurred scanning the request, or if ErrorProcessingFlags had been previously configured to allow the error.

ProcessRestartRequest Method (AS2Receiver Control)

Processes the AS2 restart request, and sends a response to the client.

Syntax

as2receivercontrol.ProcessRestartRequest 

Remarks

Invoking ProcessRestartRequest automates the restart AS2 server process. The method should be invoked when the HTTP HEAD request is received. The control will then parse the request, and respond to the client with the number of bytes (if any) the control received during a previous connection. The control will look for unfinished files in the RestartDirectory when processing these requests.

ReadRequest Method (AS2Receiver Control)

Reads the AS2 request from the HTTP session.

Syntax

as2receivercontrol.ReadRequest 

Remarks

ReadRequest reads the AS2 request from the content of the Request (and optionally the RequestHeadersString) property. The control will parse the request from Request. The headers will be read into RequestHeaders. Finally, the control will parse the headers and populate the following properties:

• AS2From
• AS2To
• AS2VersionIncoming
• MessageId
• MDNTo
• ReceiptDeliveryOption
• RequestedSignatureProtocol
• RequestedMICAlgorithms

ParseRequest may be used to scan the entire message.

Reset Method (AS2Receiver Control)

Resets the state of the control.

Syntax

as2receivercontrol.Reset 

Remarks

Reset resets the state of the control. All properties will be set to their default values.

SendAsyncMDN Method (AS2Receiver Control)

Sends the MDNReceipt to the RemoteURL specified.

Syntax

as2receivercontrol.SendAsyncMDN RemoteURL, MDNReceipt, MDNReceiptHeaders

Remarks

This method sends the asynchronous MDNReceipt to the RemoteURL specified. It need not be invoked if the prior call to SendResponse was successful. The RemoteURL, MDNReceipt, and MDNReceiptHeaders parameters should be the ones that were retrieved from ReceiptDeliveryOption and MDNReceipt's Content and Headers properties respectively.

If the RemoteURL requires SMTP transfer, the appropriate SMTP settings should be set using Config.

SendResponse Method (AS2Receiver Control)

In a server environment, responds to the requesting client with MDNReceipt .

Syntax

as2receivercontrol.SendResponse 

Remarks

When called from within a server environment, SendResponse will respond to the requesting client. If an MDN was requested, then MDNReceipt will be returned to the client, either in the HTTP response or in a separate transmission, depending on the client request. In case it is returned in a separate transmission, a simple acknowledgement of "200 OK" will also be sent in the HTTP response, unless this was sent previously using AckRequest.

The AS2 headers will be taken from MDNReceipt and will be merged with HTTP headers as appropriate. Note that if ReceiptDeliveryOption indicates a "mailto:" URL, the appropriate SMTP settings should be set using Config.

The exact behavior of the method is specific to the environment. In ASP.NET, the receipt will be sent within the current HTTP context. In Java, the receipt will be sent within the provided HttpServletResponse. Otherwise, the receipt will be directed to stdout. If this is impossible, an exception will be thrown.

Optionally, if an asynchronous MDN is requested, the MDNReceipt and ReceiptDeliveryOption may be saved so that the MDN may be sent later through the SendAsyncMDN method.

This method should only be invoked after MDNReceipt has been generated by CreateMDNReceipt or ProcessRequest.

SetTPInfo Method (AS2Receiver Control)

A convenient way to set AS2 communication parameters using XML strings.

Syntax

as2receivercontrol.SetTPInfo Profile

Remarks

SetTPInfo offers a convenient way to set AS2 communication parameters using XML strings. The format of the XML is the same as provided by the method GetTPInfo of AS2ProfileMgr.

An example usage scenario is shown below. AS2Receiver as2receiver = new AS2Receiver(); AS2Profilemgr mgr = new AS2Profilemgr(); mgr.DataDir = "C:\as2data"; as2receiver.setTPInfo(mgr.getTPInfo("self")); as2receiver.readRequest(); as2sender.setTPInfo(mgr.getTPInfo(as2receiver.getAS2From())); as2receiver.processRequest(); as2receiver.sendResponse();

CEMRequest Event (AS2Receiver Control)

Fired when a Certificate Exchange Messaging (CEM) request is received.

Syntax

Sub as2receivercontrol_CEMRequest(RequestId As String, As2From As String)

Remarks

This event fires when a Certificate Exchange Messaging (CEM) request is received.

RequestId is the CEM request Id. This must be saved and will be used when sending the CEM response.

As2From identifies the sender of the CEM request.

If CEMCertDir is set the received certificates will be written to the specified location. If CEMCertDir is not set the certificates will be held in memory and may be accessed by inspecting CEMDetails.

The CEM request also populates CEMRespondByDate and CEMResponseURL. CEMRespondByDate specifies the date by which the sender expects a response. CEMResponseURL specifies the URL to which the CEM response should be sent.

When this event fires the following CEMDetails properties are applicable:

• CEMCertStoreType
• CEMCertStore
• CEMCertSubject
• CEMCertUsage
• CEMCertIssuer
• CEMCertSerialNumber
• CEMCertId
• CEMRespondByDate
• CEMResponseURL

To send a CEM response save the CEMDetails values and call SendCEMResponse with the AS2Sender control.

CEMResponse Event (AS2Receiver Control)

Fired when a Certificate Exchange Messaging (CEM) response is received.

Syntax

Sub as2receivercontrol_CEMResponse(RequestId As String, As2From As String)

Remarks

This event fires when a Certificate Exchange Messaging (CEM) response is received.

RequestId is the CEM request Id. Match this to the request Id from the original request.

As2From identifies the sender of the CEM request.

When this event fires the CEMDetails property will be populated. Inspect the CEMAccepted property to determine whether each CEM request was accepted. If the request was rejected, check CEMRejectionReason for details.

When this event fires the following CEMDetails properties are applicable:

• CEMCertIssuer
• CEMCertSerialNumber
• CEMAccepted
• CEMRejectionReason

EDIDataInfo Event (AS2Receiver Control)

Fired when processing an incoming message.

Syntax

Sub as2receivercontrol_EDIDataInfo(Name As String, DataType As String, Duplicate As Boolean)

Remarks

When ParseRequest or ProcessRequest has been called this event will fire and provide the filename of the incoming data via the Name parameter. DataType will be the EDI type specified in the message, such as "application/edi-x12".

Duplicate is used in conjunction with the InvalidFilenameMDNAction configuration setting when Filename Preservation with an Associated MDN Response is implemented in the receiving agent to support MDN responses for duplicate filenames. If IncomingDirectory is specified, the Duplicate parameter will return True if the filename specified in the request exists on disk. Additionally, the Duplicate parameter may be set to True before the event exits so that checking for duplicate filenames may be extended to the application logic.

Error Event (AS2Receiver Control)

Fired when information is available about errors during data delivery.

Syntax

Sub as2receivercontrol_Error(ErrorCode As Integer, Description As String)

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the control fails with an error.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

Log Event (AS2Receiver Control)

Fired with log information while processing a message.

Syntax

Sub as2receivercontrol_Log(LogType As String, LogMessage As String)

Remarks

This event fires once for each log message generated by the control. The verbosity is controlled by the LogLevel setting.

Log messages available through this event correspond to log files written to LogDirectory. This event provides a way to obtain log messages without relying on files on disk. This event fires regardless of the value of LogDirectory (i.e. when LogDirectory is empty the event will still fire).

The LogMessage event parameter holds the raw log data.

The LogType event parameter indicates the type of log. Possible values are:

RecipientInfo Event (AS2Receiver Control)

Fired for each recipient certificate of the encrypted message.

Syntax

Sub as2receivercontrol_RecipientInfo(Issuer As String, SerialNumber As String, SubjectKeyIdentifier As String, EncryptionAlgorithm As String)

Remarks

When ParseRequest or ProcessRequest has been called on a valid encrypted message, this event will fire for each recipient certificate that the message has been encrypted for.

Issuer is the subject of the issuer certificate.

SerialNumber is the serial number of the encryption certificate.

SubjectKeyIdentifier is the X.509 subjectKeyIdentifier extension value of the certificate used to sign the message encoded as a hex string.

EncryptionAlgorithm is the encryption algorithm used to encrypt the message. Possible values are as follows:

• "3DES"
• "DES"
• "RC2CBC40"
• "RC2CBC64"
• "RC2CBC128" or "RC2"
• "AESCBC128" or "AES"
• "AESCBC192"
• "AESCBC256"
• "AESGCM128" or "AESGCM"
• "AESGCM192"
• "AESGCM256"

SignerCertInfo Event (AS2Receiver Control)

This event is fired during verification of the signed message.

Syntax

Sub as2receivercontrol_SignerCertInfo(Issuer As String, SerialNumber As String, SubjectKeyIdentifier As String, CertEncoded As String)

Remarks

During verification, this event will be raised while parsing the signer's certificate information. The parameters that are populated depend on the options used when the message was originally signed. This information may be used to select the correct certificate for SignerCert to verify the signature. The following parameters may be populated:

Issuer specifies the subject of the issuer of the certificate used to sign the message.

SerialNumber is the serial number of the certificate used to sign the message.

SubjectKeyIdentifier is the X.509 subjectKeyIdentifier extension value of the certificate used to sign the message encoded as a hex string.

CertEncoded is the PEM (Base64 encoded) public certificate needed to verify the signature.

Note: When this value is present, the control will automatically use this value to perform signature verification.

The SignerCert property may be set from within this event. In this manner, the decision of which signer certificate to load may be delayed until the parameters of this event are inspected and the correct certificate can be located and loaded.

SSLServerAuthentication Event (AS2Receiver Control)

For asynchronous HTTPS MDNs, fired after the server presents its certificate.

Syntax

Sub as2receivercontrol_SSLServerAuthentication(CertEncoded As String, CertSubject As String, CertIssuer As String, Status As String, Accept As Boolean)

Remarks

This event is fired when returning asynchronous MDNs over HTTPS to the client, and allows the client can decide whether to continue with the connection process or not. In general, the control will allow self-signed certs only if explicitly specified.

To accept a self-signed certificate, either trap the SSLServerAuthentication event and set Accept to true based on the values of CertSubject, CertEncoded, etc., or set the SSLAcceptServerCert property to the value of the expected certificate (if the server certificate is known in advance the latter method is simpler).

SSLStatus Event (AS2Receiver Control)

Fired when secure connection progress messages are available.

Syntax

Sub as2receivercontrol_SSLStatus(Message As String)

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

Config Settings (AS2Receiver Control)

AS2Receiver Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

Socket Config Settings

Base Config Settings

Trappable Errors (AS2Receiver Control)

AS2Receiver Errors

SMIME Errors