AS2Sender Control
Properties Methods Events Configuration Settings Errors
The AS2Sender control implements an AS2 / EDI-INT client.
Syntax
AS2Sender
Remarks
The AS2Sender component may be used to send EDI or other messages over HTTP/S, using the AS2 protocol. It may also be used to verify synchronous or asynchronous server responses.
A typical AS2 transaction is as follows:
(1) The sender sends an EDI document to the receiver using HTTP or HTTPS. Typically the document will be signed and encrypted (particularly if SSL is not used). A signed receipt will also be requested.
(2) The receiver decrypts the message and verifies the signature.
(3) The receiver sends a signed receipt back to the client. The signature is over the hash of an MDN, which contains a hash of the received message.
When sending an EDI message, the client should specify, at a minimum, AS2From and AS2To, URL, and EDIData. The Post method should then be invoked.
To secure the EDI transmission, the message may be signed and/or encrypted by setting the appropriate certificates. By default, the control will apply message security if the appropriate certificates are specified. To sign the data, set SigningCert. To encrypt, set RecipientCerts. If the recipient uses different certificates for signing and encryption it will also be necessary to set ReceiptSignerCert.
SSL will also be used if the scheme in URL is "https". If your trading partner is using a self-signed certificate, it will be necessary to set SSLAcceptServerCert or trap the SSLServerAuthentication event to accept the certificate.
The message may also be compressed by setting CompressionFormat.
To request a receipt, or Message Disposition Notification (MDN), simply set the MDNTo property. The MDNOptions property may be used to customize the request. By default, the control will request a signed MDN over an SHA1 hash.
The control supports both synchronous and asynchronous MDN receipt delivery. By default, the control requests synchronous MDN receipt delivery, and the MDN will be returned in the HTTP reply. To request asynchronous MDN delivery, set the MDNDeliveryOption to the URL where MDN's are to be delivered.
The HTTP reply will automatically be processed by the control. If an MDN was requested, Post will validate the MDN and (if signed) establish non-repudiation of receipt. Any errors or warnings will cause the control to throw an exception.
In either case, after the EDI transaction is processed successfully, the MDNReceipt will be populated with the appropriate values.
Validating Asynchronous MDNs
The control may also be used to process and verify asynchronous MDNs. To do this, you should invoke ReadAsyncReceipt. This will read the receipt from the current HTTP context (or from MDNReceipt, if set manually), and allow you to determine your trading partner's identity and the message ID. You should then set ReceiptSignerCert and OriginalContentMIC, and finally invoke VerifyReceipt.
Property List
The following is the full list of the properties of the control with short descriptions. Click on the links for further details.
AS2From | The AS2 Identifier of the sending system. |
AS2To | The AS2 Identifier of the receiving system. |
AS2Version | The version of AS2 being used. |
AsyncMDNInfoDir | Path to a directory to store data used in verifying AsyncMDNs. |
AttachmentCount | The number of records in the Attachment arrays. |
AttachmentContentType | The MIME content-type of this ediattachment . |
AttachmentData | This property contains the attachment data. |
AttachmentFilename | The file name of the attachment. |
AttachmentHeaders | The control fills out Headers each time any of the other properties for that ediattachment are changed. |
AttachmentName | Name is the final name to be associated with the contents of either the Data or Filename properties. |
CEMCount | The number of records in the CEM arrays. |
CEMAccepted | Whether the CEM request is accepted. |
CEMCertId | A user defined identifier for the certificate. |
CEMCertIssuer | This property holds the issuer of the certificate. |
CEMCertSerialNumber | This property holds the serial number of the certificate. |
CEMCertStore | The name of the certificate store for the certificate. |
CEMCertStorePassword | 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. |
CEMCertStoreType | The type of certificate store for this certificate. |
CEMCertSubject | The subject of the certificate. |
CEMCertUsage | This property defines which usages are applicable to the certificate. |
CEMRejectionReason | If Accepted is False this property specifies the reason a request was rejected. |
CEMRespondByDate | This property specifies the date by which the other party should respond. |
CEMResponseURL | This property defines the URL to which the response should be sent. |
CompressionFormat | The compression format (if any) to use. |
CookieCount | The number of records in the Cookie arrays. |
CookieDomain | The domain of a received cookie. |
CookieExpiration | This property contains an expiration time for the cookie (if provided by the server). |
CookieName | The name of the cookie. |
CookiePath | This property contains a path name to limit the cookie to (if provided by the server). |
CookieSecure | This property contains the security flag of the received cookie. |
CookieValue | This property contains the value of the cookie. |
EDIData | This property contains the EDI payload of the transmission. |
EDIType | The Content-Type of the EDI message. |
EDIFilename | In a sender, if Filename is specified, the file specified will be used for the EDI payload of the transmission. |
EDIName | Name is the final name to be associated with the contents of either the Data or FileName properties. |
EncryptionAlgorithm | The algorithm used to encrypt the EDI data. |
Etag | The Etag of the file being sent. |
FirewallAutoDetect | This property tells the control whether or not to automatically detect and use firewall system settings, if available. |
FirewallType | This property determines the type of firewall to connect through. |
FirewallHost | This property contains the name or IP address of firewall (optional). |
FirewallPassword | This property contains a password if authentication is to be used when connecting through the firewall. |
FirewallPort | This property contains the TCP port for the firewall Host . |
FirewallUser | This property contains a user name if authentication is to be used connecting through a firewall. |
From | The email address of the HTTP agent (optional). |
LocalHost | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
LogDirectory | The path to a directory for logging. |
LogFile | The log file written. |
MDNDeliveryOption | A URL indicating how the receipt is to be delivered. |
MDNOptions | Used to indicate the options requested for the MDN receipt. |
MDNReceiptContent | This contains the entire content of the MDN Receipt. |
MDNReceiptHeaderCount | The number of headers in the MDN. |
MDNReceiptHeaderField | The property name of the MDN header currently selected by HeaderIndex . |
MDNReceiptHeaderIndex | Which MDN header is currently selected to populate HeaderField and HeaderValue . |
MDNReceiptHeaders | Headers contains all of the headers of the AS2 MDN Receipt as a single string. |
MDNReceiptHeaderValue | The value of the MDN header currently selected by HeaderIndex . |
MDNReceiptMDN | MDN will contain the entire machine readable text of the Message Disposition Notification in the receipt. |
MDNReceiptMessage | The human-readable portion of the MDN receipt. |
MDNReceiptMICValue | The Message Integrity Check(s) (one-way hash) of the original EDI message. |
MDNReceiptSigningProtocol | This property contains the MIME type of the signature used, if any (i. |
MDNTo | Used to indicate that a message disposition notification is requested. |
MessageId | The Id of the message. |
OriginalContentMIC | The Message Integrity Check(s) (one-way hash) of the outgoing message. |
ProxyAuthScheme | This property is used to tell the control which type of authorization to perform when connecting to the proxy. |
ProxyAutoDetect | This property tells the control whether or not to automatically detect and use proxy system settings, if available. |
ProxyPassword | This property contains a password if authentication is to be used for the proxy. |
ProxyPort | This property contains the TCP port for the proxy Server (default 80). |
ProxyServer | If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. |
ProxySSL | This property determines when to use SSL for the connection to the proxy. |
ProxyUser | This property contains a user name, if authentication is to be used for the proxy. |
ReceiptSignerCertEncoded | The certificate (PEM/base64 encoded). |
ReceiptSignerCertStore | The name of the certificate store for the client certificate. |
ReceiptSignerCertStorePassword | 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. |
ReceiptSignerCertStoreType | The type of certificate store for this certificate. |
ReceiptSignerCertSubject | The subject of the certificate used for client authentication. |
RecipientCertCount | The number of records in the RecipientCert arrays. |
RecipientCertEncoded | The certificate (PEM/base64 encoded). |
RecipientCertStore | The name of the certificate store for the client certificate. |
RecipientCertStorePassword | 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. |
RecipientCertStoreType | The type of certificate store for this certificate. |
RecipientCertSubject | The subject of the certificate used for client authentication. |
RestartDirectory | The directory to log cached files when using AS2 restart functionality. |
RolloverSigningCertEncoded | The certificate (PEM/base64 encoded). |
RolloverSigningCertStore | The name of the certificate store for the client certificate. |
RolloverSigningCertStorePassword | 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. |
RolloverSigningCertStoreType | The type of certificate store for this certificate. |
RolloverSigningCertSubject | The subject of the certificate used for client authentication. |
SignatureAlgorithm | Signature algorithm to be used in outgoing messages. |
SigningCertEncoded | The certificate (PEM/base64 encoded). |
SigningCertStore | The name of the certificate store for the client certificate. |
SigningCertStorePassword | 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. |
SigningCertStoreType | The type of certificate store for this certificate. |
SigningCertSubject | The subject of the certificate used for client authentication. |
SSLAcceptServerCertEncoded | The certificate (PEM/base64 encoded). |
SSLCertEncoded | The certificate (PEM/base64 encoded). |
SSLCertStore | The name of the certificate store for the client certificate. |
SSLCertStorePassword | 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. |
SSLCertStoreType | The type of certificate store for this certificate. |
SSLCertSubject | The subject of the certificate used for client authentication. |
SSLServerCertEncoded | The certificate (PEM/base64 encoded). |
Subject | The subject of the message. |
Timeout | A timeout for the control. |
URL | The URL to which the request is made. |
UseOAEP | Whether to use Optimal Asymmetric Encryption Padding (OAEP). |
UsePSS | Whether to use RSA-PSS during signing and verification. |
UserAgent | Information about the user agent. |
Method List
The following is the full list of the methods of the control with short descriptions. Click on the links for further details.
Config | Sets or retrieves a configuration setting. |
DoEvents | Processes events from the internal message queue. |
Interrupt | Interrupt the current method. |
Post | Post data to the AS2 server, and check the receipt. |
ReadAsyncReceipt | Reads an asynchronous MDN receipt from the current HTTP session. |
Reset | Resets the state of the control. |
Restart | Restart sending of the file specified by the Etag property. |
SendCEMRequest | Sends a Certificate Exchange Messaging (CEM) request. |
SendCEMResponse | Sends a Certificate Exchange Messaging (CEM) response. |
SetRequestHeader | Allows the user to set or add arbitrary HTTP request headers. |
SetTPInfo | A convenient way to set AS2 communication parameters using XML strings. |
VerifyReceipt | Verifies an asynchronous MDN receipt. |
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.
Connected | Fired immediately after a connection completes (or fails). |
Disconnected | Fired when a connection is closed. |
EndTransfer | Fired when a document finishes transferring. |
Error | Information about errors during data delivery. |
Header | Fired every time a header line comes in. |
Log | Fired with log information while processing a message. |
SetCookie | Fired for every cookie set by the server. |
SSLServerAuthentication | Fired after the server presents its certificate to the client. |
SSLStatus | Shows the progress of the secure connection. |
StartTransfer | Fired when a document starts transferring (after the headers). |
Transfer | Fired while a document transfers (delivers document). |
Configuration Settings
The following is a list of configuration settings for the control with short descriptions. Click on the links for further details.
AllowMDNWarnings | Whether to fail on MDN warnings. |
Authorization | The Authorization string to be sent to the server. |
AuthScheme | The authorization scheme to be used when server authorization is to be performed. |
EncodeToTempDir | Whether to use temporary files when creating messages. |
IncludeHeaders | Whether headers are included when posting to a file. |
LogDebug | Whether to log debug data. |
LogFilename | The base name of the log file. |
LogOptions | The information to be written to log files. |
MDNDisposition | Returns the Disposition header of the MDN. |
MessageHeaders | Returns the headers of the message. |
NormalizeMIC | Whether to normalize line endings before calculating the MIC. |
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. |
Password | A password if authentication is to be used. |
PostToFile | Creates the message on disk. |
RequiredSignatureAlgorithms | Specifies a list of acceptable signature algorithms. |
User | A user name if authentication is to be used. |
AcceptEncoding | Used to tell the server which types of content encodings the client supports. |
AllowHTTPCompression | This property enables HTTP compression for receiving data. |
AllowHTTPFallback | Whether HTTP/2 connections are permitted to fallback to HTTP/1.1. |
Append | Whether to append data to LocalFile. |
Authorization | The Authorization string to be sent to the server. |
BytesTransferred | Contains the number of bytes transferred in the response data. |
ChunkSize | Specifies the chunk size in bytes when using chunked encoding. |
CompressHTTPRequest | Set to true to compress the body of a PUT or POST request. |
EncodeURL | If set to true the URL will be encoded by the control. |
FollowRedirects | Determines what happens when the server issues a redirect. |
GetOn302Redirect | If set to true the control will perform a GET on the new location. |
HTTP2HeadersWithoutIndexing | HTTP2 headers that should not update the dynamic header table with incremental indexing. |
HTTPVersion | The version of HTTP used by the control. |
IfModifiedSince | A date determining the maximum age of the desired document. |
KeepAlive | Determines whether the HTTP connection is closed after completion of the request. |
KerberosSPN | The Service Principal Name for the Kerberos Domain Controller. |
LogLevel | The level of detail that is logged. |
MaxRedirectAttempts | Limits the number of redirects that are followed in a request. |
NegotiatedHTTPVersion | The negotiated HTTP version. |
OtherHeaders | Other headers as determined by the user (optional). |
ProxyAuthorization | The authorization string to be sent to the proxy server. |
ProxyAuthScheme | The authorization scheme to be used for the proxy. |
ProxyPassword | A password if authentication is to be used for the proxy. |
ProxyPort | Port for the proxy server (default 80). |
ProxyServer | Name or IP address of a proxy server (optional). |
ProxyUser | A user name if authentication is to be used for the proxy. |
SentHeaders | The full set of headers as sent by the client. |
StatusLine | The first line of the last response from the server. |
TransferredData | The contents of the last response from the server. |
TransferredDataLimit | The maximum number of incoming bytes to be stored by the control. |
TransferredHeaders | The full set of headers as received from the server. |
TransferredRequest | The full request as sent by the client. |
UseChunkedEncoding | Enables or Disables HTTP chunked encoding for transfers. |
UseIDNs | Whether to encode hostnames to internationalized domain names. |
UserAgent | Information about the user agent (browser). |
ConnectionTimeout | Sets a separate timeout value for establishing a connection. |
FirewallAutoDetect | Tells the control whether or not to automatically detect and use firewall system settings, if available. |
FirewallHost | Name or IP address of firewall (optional). |
FirewallPassword | Password to be used if authentication is to be used when connecting through the firewall. |
FirewallPort | The TCP port for the FirewallHost;. |
FirewallType | Determines the type of firewall to connect through. |
FirewallUser | A user name if authentication is to be used connecting through a firewall. |
KeepAliveInterval | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
KeepAliveTime | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
Linger | When set to True, connections are terminated gracefully. |
LingerTime | Time in seconds to have the connection linger. |
LocalHost | The name of the local host through which connections are initiated or accepted. |
LocalPort | The port in the local host where the control binds. |
MaxLineLength | The maximum amount of data to accumulate when no EOL is found. |
MaxTransferRate | The transfer rate limit in bytes per second. |
ProxyExceptionsList | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
TCPKeepAlive | Determines whether or not the keep alive socket option is enabled. |
TcpNoDelay | Whether or not to delay when sending packets. |
UseIPv6 | Whether to use IPv6. |
LogSSLPackets | Controls whether SSL packets are logged when using the internal security API. |
OpenSSLCADir | The path to a directory containing CA certificates. |
OpenSSLCAFile | Name of the file containing the list of CA's trusted by your application. |
OpenSSLCipherList | A string that controls the ciphers to be used by SSL. |
OpenSSLPrngSeedData | The data to seed the pseudo random number generator (PRNG). |
ReuseSSLSession | Determines if the SSL session is reused. |
SSLCACerts | A newline separated list of CA certificate to use during SSL client authentication. |
SSLCheckCRL | Whether to check the Certificate Revocation List for the server certificate. |
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. |
SSLEnableRenegotiation | Whether the renegotiation_info SSL extension is supported. |
SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
SSLNegotiatedCipher | Returns the negotiated ciphersuite. |
SSLNegotiatedCipherStrength | Returns the negotiated ciphersuite strength. |
SSLNegotiatedCipherSuite | Returns the negotiated ciphersuite. |
SSLNegotiatedKeyExchange | Returns the negotiated key exchange algorithm. |
SSLNegotiatedKeyExchangeStrength | Returns the negotiated key exchange algorithm strength. |
SSLNegotiatedVersion | Returns the negotiated protocol version. |
SSLProvider | The name of the security provider to use. |
SSLSecurityFlags | Flags that control certificate verification. |
SSLServerCACerts | A newline separated list of CA certificate to use during SSL server certificate validation. |
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. |
FirewallData | Used to send extra data to the firewall. |
InBufferSize | The size in bytes of the incoming queue of the socket. |
OutBufferSize | The size in bytes of the outgoing queue of the socket. |
CodePage | The system code page used for Unicode to Multibyte translations. |
UseInternalSecurityAPI | Tells the control whether or not to use the system security libraries or an internal implementation. |