# AS2Receiver Class

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

## Syntax

**ipworksedi.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 class 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](#as2receiverreadrequest-method). This will populate [AS2From](#as2receiveras2from-property) and [AS2To](#as2receiveras2to-property), and based on this information, you may then set the appropriate certificates. You may specify your certificate with the [Certificate](#as2receivercertificate-property) property, and your trading partner's (signing) certificate with the [SignerCert](#as2receiversignercert-property) property.

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

The [MDNReceipt](#as2receivermdnreceipt-property) may be returned by invoking [SendResponse](#as2receiversendresponse-method). 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](#as2receiverlogdirectory-property) prior to invoking [ProcessRequest](#as2receiverprocessrequest-method). This will log all incoming and outgoing data.

The following example illustrates how to use the class from an ASP.NET page. Note that in **Java** it will be necessary to provide an HTTPServletRequest as an argument to [ReadRequest](#as2receiverreadrequest-method) before processing the request.

**EXAMPLE**

```text
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](#as2receiverprocessrequest-method) automates the entire process, additional methods are also provided to handle each step separately.

*Parsing Incoming Data*

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

After invoking [ReadRequest](#as2receiverreadrequest-method), the [AS2From](#as2receiveras2from-property), [AS2To](#as2receiveras2to-property), and [MessageId](#as2receivermessageid-property) properties will contain the appropriate values. [MDNTo](#as2receivermdnto-property) will contain a nonempty string if an MDN is requested; [RequestedSignatureProtocol](#RequestedSignatureProtocol), [RequestedMICAlgorithms](#RequestedMICAlgorithms), and [ReceiptDeliveryOption](#as2receiverreceiptdeliveryoption-property) provide more information about the client's request. Finally, [RequestHeaders](#as2receiverrequestheaders-property) contains the complete list of HTTP/AS2 headers.

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

[ParseRequest](#as2receiverparserequest-method) will populate EDIDataEDIType and EDIDataData.

*Error Handling*

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

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

*Creating an MDN-based Receipt*

An MDN-based receipt may be created by invoking [CreateMDNReceipt](#as2receivercreatemdnreceipt-method). Regardless of the success or failure of [ProcessRequest](#as2receiverprocessrequest-method), the receipt may be created as specified in RFCs 3335 and 2298. If no errors occurred when [ProcessRequest](#as2receiverprocessrequest-method) 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](#as2receiverprocessrequest-method) and return the receipt in this case as well.

The [MDNReceipt](#as2receivermdnreceipt-property) 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](#as2receivercreatemdnreceipt-method) and customized further by setting the parameters to [CreateMDNReceipt](#as2receivercreatemdnreceipt-method).

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](#as2receivermdnreceipt-property) is regenerated.

The receipt will be signed using the protocol specified by [ReceiptSigningProtocol](#ReceiptSigningProtocol), if any. The certificate used to sign the receipt is specified by [Certificate](#as2receivercertificate-property). By default the receipt will be signed if explicitly requested by the client, and unsigned otherwise.

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

*Additional Server-Side Functionality*

When used in a server environment such as ASP.NET, the class may be used to interface directly with the underlying HTTP context. If [Request](#as2receiverrequest-property) is not set by the user, [ParseRequest](#as2receiverparserequest-method) and [ProcessRequest](#as2receiverprocessrequest-method) will first get the request from the underlying HTTP environment, if possible. [SendResponse](#as2receiversendresponse-method) will send the reply in this environment if able; otherwise the reply will be directed to standard out.

**ASP.NET Core Notes**

The class 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 class 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:

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

## Property List

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

|  |  |
| --- | --- |
| [AS2From](#as2receiveras2from-property) | The AS2 Identifier of the sending system. |
| [AS2To](#as2receiveras2to-property) | The AS2 Identifier of the receiving system. |
| [Attachments](#as2receiverattachments-property) | Collection of files attached to the current message. |
| [CEMDetails](#as2receivercemdetails-property) | A collection of Certificate Exchange Messaging (CEM) details. |
| [Certificate](#as2receivercertificate-property) | The decryption and receipt signing certificate. |
| [CompressionFormat](#as2receivercompressionformat-property) | The compression format used on the incoming message. |
| [EDIData](#as2receiveredidata-property) | The EDI data sent in Request . |
| [Firewall](#as2receiverfirewall-property) | A set of properties related to firewall access. |
| [IncomingDirectory](#as2receiverincomingdirectory-property) | The directory to be used to store incoming messages. |
| [LocalHost](#as2receiverlocalhost-property) | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
| [LogDirectory](#as2receiverlogdirectory-property) | The path to a directory for logging. |
| [LogFile](#as2receiverlogfile-property) | The log file written. |
| [MDNReceipt](#as2receivermdnreceipt-property) | The MDN-based receipt generated by the class. |
| [MDNTo](#as2receivermdnto-property) | The recipient for the Message Disposition Notification (MDN). |
| [MessageId](#as2receivermessageid-property) | The message ID of the incoming message. |
| [ReceiptDeliveryOption](#as2receiverreceiptdeliveryoption-property) | A URL indicating how the receipt is to be delivered. |
| [Request](#as2receiverrequest-property) | The HTTP request to be processed. |
| [RequestHeaders](#as2receiverrequestheaders-property) | The HTTP headers in the AS2 request. |
| [RequestHeadersString](#as2receiverrequestheadersstring-property) | The HTTP headers in the AS2 request. |
| [RestartDirectory](#as2receiverrestartdirectory-property) | The directory to log cached files when using AS2 restart functionality. |
| [RolloverCertificate](#as2receiverrollovercertificate-property) | The rollover decryption and receipt signing certificate. |
| [ScanResult](#as2receiverscanresult-property) | The result of invoking ParseRequest . |
| [SignerCert](#as2receiversignercert-property) | Your trading partner's certificate. |
| [SSLAcceptServerCert](#as2receiversslacceptservercert-property) | For sending HTTPS asynchronous MDNs, a server certificate to unconditionally accept. |
| [SSLCert](#as2receiversslcert-property) | The certificate used for client authentication. |
| [UsePSS](#as2receiverusepss-property) | This property specifies whether or not RSA-PSS will be used during signing and verification. |

## Method List

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

|  |  |
| --- | --- |
| [AckRequest](#as2receiverackrequest-method) | Optional. Acknowledges the incoming request. |
| [Config](#as2receiverconfig-method) | Sets or retrieves a configuration setting. |
| [CreateMDNReceipt](#as2receivercreatemdnreceipt-method) | Creates MDNReceipt . |
| [ParseRequest](#as2receiverparserequest-method) | Parses the EDI message and determines the EDIData . |
| [ProcessRequest](#as2receiverprocessrequest-method) | Processes the EDI data, and generates the receipt. |
| [ProcessRestartRequest](#as2receiverprocessrestartrequest-method) | Processes the AS2 restart request, and sends a response to the client. |
| [ReadRequest](#as2receiverreadrequest-method) | Reads the AS2 request from the HTTP session. |
| [Reset](#as2receiverreset-method) | Resets the state of the control. |
| [SendAsyncMDN](#as2receiversendasyncmdn-method) | Sends the MDNReceipt to the RemoteURL specified. |
| [SendResponse](#as2receiversendresponse-method) | In a server environment, responds to the requesting client with MDNReceipt . |
| [SetAttachmentOutputStream](#as2receiversetattachmentoutputstream-method) | Decodes the specified attachment to the output stream. |
| [SetRequestStream](#as2receiversetrequeststream-method) | Sets the stream from which the class will read the AS2 request. |
| [SetTPInfo](#as2receiversettpinfo-method) | A convenient way to set AS2 communication parameters using XML strings. |

## Event List

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

|  |  |
| --- | --- |
| [CEMRequest](#as2receivercemrequest-event) | Fired when a Certificate Exchange Messaging (CEM) request is received. |
| [CEMResponse](#as2receivercemresponse-event) | Fired when a Certificate Exchange Messaging (CEM) response is received. |
| [EDIDataInfo](#as2receiveredidatainfo-event) | Fired when processing an incoming message. |
| [Error](#as2receivererror-event) | Fired when information is available about errors during data delivery. |
| [Log](#as2receiverlog-event) | Fired with log information while processing a message. |
| [RecipientInfo](#as2receiverrecipientinfo-event) | Fired for each recipient certificate of the encrypted message. |
| [SignerCertInfo](#as2receiversignercertinfo-event) | This event is fired during verification of the signed message. |
| [SSLServerAuthentication](#as2receiversslserverauthentication-event) | For asynchronous HTTPS MDNs, fired after the server presents its certificate. |
| [SSLStatus](#as2receiversslstatus-event) | Fired when secure connection progress messages are available. |

## Config Settings

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

|  |  |
| --- | --- |
| [AcceptAnySignerCert](#AcceptAnySignerCert) | Used to accept trust any signing certificate unconditionally. |
| [AS2VersionIncoming](#AS2VersionIncoming) | The version of AS2 that was used in the incoming message. |
| [AS2VersionOutgoing](#AS2VersionOutgoing) | The version of AS2 to be used in the outgoing message. |
| [Authorization](#Authorization) | The Authorization string to be sent to the server. |
| [AuthScheme](#AuthScheme) | The authorization scheme to be used when server authorization is to be performed. |
| [CEMCertDir](#CEMCertDir) | Specifies the directory where certificates are saved when receiving a CEM request. |
| [CloseStreamAfterProcessing](#CloseStreamAfterProcessing) | Specifies whether or not the OutputStream should be closed after processing. |
| [DecodeTempDirectory](#DecodeTempDirectory) | The temp directory the class will use to decode messages. |
| [DetectDuplicates](#DetectDuplicates) | Whether to detect duplicate messages. |
| [EncryptionAlgorithm](#EncryptionAlgorithm) | The encryption algorithm used to encrypt the incoming data. |
| [EncryptionPaddingScheme](#EncryptionPaddingScheme) | The encryption padding scheme used when encrypting the incoming data. |
| [EncryptionType](#EncryptionType) | The MIME type of the encrypted data. |
| [ErrorProcessingFlags](#ErrorProcessingFlags) | Flags controlling how errors affect ProcessRequest. |
| [ErrorReportingFlags](#ErrorReportingFlags) | Flags controlling how errors affect the MDNReceipt. |
| [FileNameSource](#FileNameSource) | The location from which to read the filename. |
| [IgnoreLoggingErrors](#IgnoreLoggingErrors) | Whether to ignore errors that occur when writing to the log. |
| [InvalidFileNameMDNAction](#InvalidFileNameMDNAction) | Instructs MDN disposition on invalid and duplicate filenames. |
| [LogDebug](#LogDebug) | Whether to log debug data. |
| [LogFilename](#LogFilename) | The base name of the log file. |
| [LogOptions](#LogOptions) | The information to be written to log files. |
| [MaxParts](#MaxParts) | The maximum number of MIME parts to process. |
| [MDNDisposition](#MDNDisposition) | Overrides the automatically calculated MDN disposition. |
| [MDNMICAlgorithm](#MDNMICAlgorithm) | The algorithm used to sign the outgoing MDN. |
| [MDNReportingUA](#MDNReportingUA) | The name of the user agent performing the disposition. |
| [MDNSendingMode](#MDNSendingMode) | The level of end user interaction involved in sending the MDN. |
| [MDNWarning](#MDNWarning) | A warning to appear in the MDN. |
| [NormalizeMIC](#NormalizeMIC) | Whether to normalize line endings before calculating the MIC. |
| [OverwriteCEMCerts](#OverwriteCEMCerts) | Whether existing CEM certificates are overwritten when a duplicate is received. |
| [Password](#Password) | A password if authentication is to be used. |
| [ProcessingError](#ProcessingError) | A processing error occurred in the received EDI message. |
| [ProxyAuthorization](#ProxyAuthorization) | The authorization string to be sent to the proxy server. |
| [ProxyPassword](#ProxyPassword) | A password if Basic authentication is to be used for the proxy. |
| [ProxyPort](#ProxyPort) | Port for the proxy server (default 80). |
| [ProxyServer](#ProxyServer) | Name or IP address of a proxy server (optional). |
| [ProxyUser](#ProxyUser) | A user name if Basic authentication is to be used for the proxy. |
| [ReceiptSigningProtocol](#ReceiptSigningProtocol) | The protocol used to sign the outgoing MDN receipt. |
| [RequestedMICAlgorithms](#RequestedMICAlgorithms) | The Message Integrity Check algorithm(s) requested by the client, if any. |
| [RequestedSignatureProtocol](#RequestedSignatureProtocol) | The signing protocol requested by the client, if any. |
| [RequestFile](#RequestFile) | Reads the AS2 message from disk. |
| [RequireAS2To](#RequireAS2To) | Ensure that the received message is intended for the given AS2 identifier. |
| [RequiredSignatureAlgorithms](#RequiredSignatureAlgorithms) | Specifies a list of acceptable signature algorithms. |
| [RequireEncrypt](#RequireEncrypt) | Ensure that the received message is encrypted. |
| [RequireOAEP](#RequireOAEP) | Ensure that the encryption padding mode is RSAES-OAEP. |
| [RequirePSS](#RequirePSS) | Ensure that the signature scheme in the received message is RSASSA-PSS. |
| [RequireSign](#RequireSign) | Ensure that the received message is signed. |
| [ResponseSubject](#ResponseSubject) | The subject to be used for the MDN response. |
| [SenderSignatureAlgorithm](#SenderSignatureAlgorithm) | The algorithm used by the sender to sign the message. |
| [SenderSignatureScheme](#SenderSignatureScheme) | The signature scheme used by the sender to sign the message. |
| [SignatureType](#SignatureType) | The MIME type of the signature (if any). |
| [SignerCACert](#SignerCACert) | CA certificate used to verify signed messages. |
| [SMTPFrom](#SMTPFrom) | The email address of the sender of the message. |
| [SMTPServer](#SMTPServer) | The SMTP server to be used. |
| [User](#User) | A user name if authentication is to be used. |
| [WarnOnMDNFailure](#WarnOnMDNFailure) | Whether to log a .wrn file instead of a .err file when MDN delivery fails. |
| [AcceptEncoding](#AcceptEncoding) | Used to tell the server which types of content encodings the client supports. |
| [AllowHTTPCompression](#AllowHTTPCompression) | This property enables HTTP compression for receiving data. |
| [AllowHTTPFallback](#AllowHTTPFallback) | Whether HTTP/2 connections are permitted to fallback to HTTP/1.1. |
| [Append](#Append) | Whether to append data to LocalFile. |
| [Authorization](#Authorization) | The Authorization string to be sent to the server. |
| [BytesTransferred](#BytesTransferred) | Contains the number of bytes transferred in the response data. |
| [ChunkSize](#ChunkSize) | Specifies the chunk size in bytes when using chunked encoding. |
| [CompressHTTPRequest](#CompressHTTPRequest) | Set to true to compress the body of a PUT or POST request. |
| [EncodeURL](#EncodeURL) | If set to True the URL will be encoded by the class. |
| [FollowRedirects](#FollowRedirects) | Determines what happens when the server issues a redirect. |
| [GetOn302Redirect](#GetOn302Redirect) | If set to True the class will perform a GET on the new location. |
| [HTTP2HeadersWithoutIndexing](#HTTP2HeadersWithoutIndexing) | HTTP2 headers that should not update the dynamic header table with incremental indexing. |
| [HTTPVersion](#HTTPVersion) | The version of HTTP used by the class. |
| [IfModifiedSince](#IfModifiedSince) | A date determining the maximum age of the desired document. |
| [KeepAlive](#KeepAlive) | Determines whether the HTTP connection is closed after completion of the request. |
| [KerberosSPN](#KerberosSPN) | The Service Principal Name for the Kerberos Domain Controller. |
| [LogLevel](#LogLevel) | The level of detail that is logged. |
| [MaxRedirectAttempts](#MaxRedirectAttempts) | Limits the number of redirects that are followed in a request. |
| [NegotiatedHTTPVersion](#NegotiatedHTTPVersion) | The negotiated HTTP version. |
| [OtherHeaders](#OtherHeaders) | Other headers as determined by the user (optional). |
| [ProxyAuthorization](#ProxyAuthorization) | The authorization string to be sent to the proxy server. |
| [ProxyAuthScheme](#ProxyAuthScheme) | The authorization scheme to be used for the proxy. |
| [ProxyPassword](#ProxyPassword) | A password if authentication is to be used for the proxy. |
| [ProxyPort](#ProxyPort) | Port for the proxy server (default 80). |
| [ProxyServer](#ProxyServer) | Name or IP address of a proxy server (optional). |
| [ProxyUser](#ProxyUser) | A user name if authentication is to be used for the proxy. |
| [SentHeaders](#SentHeaders) | The full set of headers as sent by the client. |
| [StatusCode](#StatusCode) | The status code of the last response from the server. |
| [StatusLine](#StatusLine) | The first line of the last response from the server. |
| [TransferredData](#TransferredData) | The contents of the last response from the server. |
| [TransferredDataLimit](#TransferredDataLimit) | The maximum number of incoming bytes to be stored by the class. |
| [TransferredHeaders](#TransferredHeaders) | The full set of headers as received from the server. |
| [TransferredRequest](#TransferredRequest) | The full request as sent by the client. |
| [UseChunkedEncoding](#UseChunkedEncoding) | Enables or Disables HTTP chunked encoding for transfers. |
| [UseIDNs](#UseIDNs) | Whether to encode hostnames to internationalized domain names. |
| [UseProxyAutoConfigURL](#UseProxyAutoConfigURL) | Whether to use a Proxy auto-config file when attempting a connection. |
| [UserAgent](#UserAgent) | Information about the user agent (browser). |
| [ConnectionTimeout](#ConnectionTimeout) | Sets a separate timeout value for establishing a connection. |
| [EnableFallback](#EnableFallback) | Whether to try the other addresses the remote host resolves to when a connection attempt fails. |
| [FallbackTimeout](#FallbackTimeout) | The maximum time in milliseconds to spend on connection attempts when EnableFallback is enabled. |
| [FirewallAutoDetect](#FirewallAutoDetect) | Tells the class whether or not to automatically detect and use firewall system settings, if available. |
| [FirewallHost](#FirewallHost) | Name or IP address of firewall (optional). |
| [FirewallHTTPVersion](#FirewallHTTPVersion) | The HTTP version to be used when connecting through a tunneling proxy. |
| [FirewallPassword](#FirewallPassword) | Password to be used if authentication is to be used when connecting through the firewall. |
| [FirewallPort](#FirewallPort) | The TCP port for the FirewallHost;. |
| [FirewallType](#FirewallType) | Determines the type of firewall to connect through. |
| [FirewallUser](#FirewallUser) | A user name if authentication is to be used connecting through a firewall. |
| [KeepAliveInterval](#KeepAliveInterval) | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. |
| [KeepAliveTime](#KeepAliveTime) | The inactivity time in milliseconds before a TCP keep-alive packet is sent. |
| [Linger](#Linger) | When set to True, connections are terminated gracefully. |
| [LingerTime](#LingerTime) | Time in seconds to have the connection linger. |
| [LocalHost](#LocalHost) | The name of the local host through which connections are initiated or accepted. |
| [LocalPort](#LocalPort) | The port in the local host where the class binds. |
| [MaxLineLength](#MaxLineLength) | The maximum amount of data to accumulate when no EOL is found. |
| [MaxTransferRate](#MaxTransferRate) | The transfer rate limit in bytes per second. |
| [ProxyExceptionsList](#ProxyExceptionsList) | A semicolon separated list of hosts and IPs to bypass when using a proxy. |
| [TCPKeepAlive](#TCPKeepAlive) | Determines whether or not the keep alive socket option is enabled. |
| [TcpNoDelay](#TcpNoDelay) | Whether or not to delay when sending packets. |
| [UseIPv6](#UseIPv6) | Whether to use IPv6. |
| [UseNTLMv2](#UseNTLMv2) | Whether to use NTLM V2. |
| [LogSSLPackets](#LogSSLPackets) | Controls whether SSL packets are logged when using the internal security API. |
| [OpenSSLCADir](#OpenSSLCADir) | The path to a directory containing CA certificates. |
| [OpenSSLCAFile](#OpenSSLCAFile) | Name of the file containing the list of CA's trusted by your application. |
| [OpenSSLCipherList](#OpenSSLCipherList) | A string that controls the ciphers to be used by SSL. |
| [OpenSSLPrngSeedData](#OpenSSLPrngSeedData) | The data to seed the pseudo random number generator (PRNG). |
| [ReuseSSLSession](#ReuseSSLSession) | Determines if the SSL session is reused. |
| [SSLAcceptAnyServerCert](#SSLAcceptAnyServerCert) | Whether to trust any certificate presented by the server. |
| [SSLCACerts](#SSLCACerts) | A newline separated list of CA certificates to be included when performing an SSL handshake. |
| [SSLCipherStrength](#SSLCipherStrength) | The minimum cipher strength used for bulk encryption. |
| [SSLClientCACerts](#SSLClientCACerts) | A newline separated list of CA certificates to use during SSL client certificate validation. |
| [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) | The cipher suite to be used in an SSL negotiation. |
| [SSLEnabledProtocols](#SSLEnabledProtocols) | Used to enable/disable the supported security protocols. |
| [SSLEnableRenegotiation](#SSLEnableRenegotiation) | Whether the renegotiation_info SSL extension is supported. |
| [SSLIncludeCertChain](#SSLIncludeCertChain) | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
| [SSLKeyLogFile](#SSLKeyLogFile) | The location of a file where per-session secrets are written for debugging purposes. |
| [SSLNegotiatedCipher](#SSLNegotiatedCipher) | Returns the negotiated cipher suite. |
| [SSLNegotiatedCipherStrength](#SSLNegotiatedCipherStrength) | Returns the negotiated cipher suite strength. |
| [SSLNegotiatedCipherSuite](#SSLNegotiatedCipherSuite) | Returns the negotiated cipher suite. |
| [SSLNegotiatedKeyExchange](#SSLNegotiatedKeyExchange) | Returns the negotiated key exchange algorithm. |
| [SSLNegotiatedKeyExchangeStrength](#SSLNegotiatedKeyExchangeStrength) | Returns the negotiated key exchange algorithm strength. |
| [SSLNegotiatedVersion](#SSLNegotiatedVersion) | Returns the negotiated protocol version. |
| [SSLSecurityFlags](#SSLSecurityFlags) | Flags that control certificate verification. |
| [SSLServerCACerts](#SSLServerCACerts) | A newline separated list of CA certificates to use during SSL server certificate validation. |
| [TLS12SignatureAlgorithms](#TLS12SignatureAlgorithms) | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. |
| [TLS12SupportedGroups](#TLS12SupportedGroups) | The supported groups for ECC. |
| [TLS13KeyShareGroups](#TLS13KeyShareGroups) | The groups for which to pregenerate key shares. |
| [TLS13SignatureAlgorithms](#TLS13SignatureAlgorithms) | The allowed certificate signature algorithms. |
| [TLS13SupportedGroups](#TLS13SupportedGroups) | The supported groups for (EC)DHE key exchange. |
| [AbsoluteTimeout](#AbsoluteTimeout) | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
| [FirewallData](#FirewallData) | Used to send extra data to the firewall. |
| [InBufferSize](#InBufferSize) | The size in bytes of the incoming queue of the socket. |
| [OutBufferSize](#OutBufferSize) | The size in bytes of the outgoing queue of the socket. |
| [BuildInfo](#BuildInfo) | Information about the product's build. |
| [CodePage](#CodePage) | The system code page used for Unicode to Multibyte translations. |
| [LicenseInfo](#LicenseInfo) | Information about the current license. |
| [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. |
| [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. |

# [AS2Receiver](#as2receiver-class).AS2From Property

The AS2 Identifier of the sending system.

## Syntax

```text
getAS2From(): string;
```

## Default Value

""

## Remarks

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

This property is read-only.

# [AS2Receiver](#as2receiver-class).AS2To Property

The AS2 Identifier of the receiving system.

## Syntax

```text
getAS2To(): string;
```

## Default Value

""

## Remarks

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

This property is read-only.

# [AS2Receiver](#as2receiver-class).Attachments Property

Collection of files attached to the current message.

## Syntax

```text
getAttachments(): EDIAttachmentList;
```

## Default Value

## Remarks

When a message is received, the class will write all of the files attached to the [EDIData](#as2receiveredidata-property) into temp files. These attachments can be retrieved by walking this collection and retrieving their file names.

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

 Please refer to the [EDIAttachment](#ediattachment-type) type for a complete list of fields.

# [AS2Receiver](#as2receiver-class).CEMDetails Property

A collection of Certificate Exchange Messaging (CEM) details.

## Syntax

```text
getCEMDetails(): CEMDetailList;
```

## Default Value

## Remarks

This collection holds Certificate Exchange Messaging (CEM) details. The details define the certificate, respond-by-date, and more.

When using **AS2Sender** see SendCEMResponse and SendCEMRequest for more information.

When using **AS2Receiver** see [CEMRequest](#as2receivercemrequest-event) and [CEMResponse](#as2receivercemresponse-event) for more information.

This property is not available at design time.

 Please refer to the [CEMDetail](#cemdetail-type) type for a complete list of fields.

# [AS2Receiver](#as2receiver-class).Certificate Property

The decryption and receipt signing certificate.

## Syntax

```text
getCertificate(): Certificate;
setCertificate(certificate: Certificate): void;
```

## Default Value

## Remarks

The digital certificate that the class will use to decrypt incoming transmissions and sign the MDN receipt (if requested). If a different certificate is required for decryption than for MDN signing, set the decryption certificate before calling [ParseRequest](#as2receiverparserequest-method), then set the signing certificate before calling [CreateMDNReceipt](#as2receivercreatemdnreceipt-method). Certificate must be set to a private key certificate.

 Please refer to the [Certificate](#certificate-type) type for a complete list of fields.

# [AS2Receiver](#as2receiver-class).CompressionFormat Property

The compression format used on the incoming message.

## Syntax

```text
getCompressionFormat(): AS2ReceiverCompressionFormats;

enum AS2ReceiverCompressionFormats {
  cfNone,
  cfZLIB
}
```

## Default Value

0

## Remarks

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

This property is read-only.

# [AS2Receiver](#as2receiver-class).EDIData Property

The EDI data sent in Request .

## Syntax

```text
getEDIData(): EDIData;
```

## Default Value

## Remarks

This property will only be populated if [ParseRequest](#as2receiverparserequest-method) or [ProcessRequest](#as2receiverprocessrequest-method) finishes without an error, setting [ScanResult](#as2receiverscanresult-property) to 0. If so, EDIData will contain the processed EDI message.

This property is read-only.

 Please refer to the [EDIData](#edidata-type) type for a complete list of fields.

# [AS2Receiver](#as2receiver-class).Firewall Property

A set of properties related to firewall access.

## Syntax

```text
getFirewall(): Firewall;
setFirewall(firewall: Firewall): void;
```

## Default Value

## Remarks

This is a [Firewall](#firewall-type)-type property, which contains fields describing the firewall through which the class will attempt to connect.

 Please refer to the [Firewall](#firewall-type) type for a complete list of fields.

# [AS2Receiver](#as2receiver-class).IncomingDirectory Property

The directory to be used to store incoming messages.

## Syntax

```text
getIncomingDirectory(): string;
setIncomingDirectory(incomingDirectory: string): void;
```

## 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 class 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](#as2receiversettpinfo-method) method, if used, needs to be invoked before setting this property because it overrides the setting for incoming directory.

# [AS2Receiver](#as2receiver-class).LocalHost Property

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

## Syntax

```text
getLocalHost(): string;
setLocalHost(localHost: string): void;
```

## Default Value

""

## Remarks

This 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 multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the class initiate connections (or accept in the case of server classes) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.

If the class 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 multihomed 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.

# [AS2Receiver](#as2receiver-class).LogDirectory Property

The path to a directory for logging.

## Syntax

```text
getLogDirectory(): string;
setLogDirectory(logDirectory: string): void;
```

## 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 class will log the complete text of the outgoing request and the incoming response.

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

|  |  |
| --- | --- |
| Status (.log) | Contains information on applied security options and pass/fail status of transmission |
| Request (.req) | Contains the raw incoming request before processing |
| Payload (.dat) | Contains the EDI payload after processing |
| MDN Receipt (.mdn) | Contains the MDN receipt prepared by the receiver |
| Error (.err) | This is only written in an error is encountered, containing the error. |

One or more of these logs may be disabled by setting the [LogOptions](#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 class will attempt to create the directory. The following macros are supported:

|  |  |
| --- | --- |
| %MessageID% | The MessageID of the AS2 transmission, after it is generated. |
| %AS2From% | The AS2-From field in the transmission |
| %OriginalMessageID% | In MDN Receipts, the MessageID of the transmission that the receipt is for. You can use this to pair asynchronous MDN receipt logs with their transmissions |
| %Date:Format% | %Format% is a platform-specific date/time formatting string. For example: |

The filenames will be chosen automatically by the class. 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](#as2receiverlogfile-property) will contain the name of the files just written, minus the extension.

If logs cannot be written an exception will be thrown.

# [AS2Receiver](#as2receiver-class).LogFile Property

The log file written.

## Syntax

```text
getLogFile(): string;
```

## Default Value

""

## Remarks

In case [LogDirectory](#as2receiverlogdirectory-property) 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 class will write multiple log files for each transmission, with separate extensions for each type of data:

|  |  |
| --- | --- |
| Status (.log) | Contains information on applied security options and pass/fail status of transmission |
| Request (.req) | Contains the raw incoming request before processing |
| Payload (.dat) | Contains the EDI payload after processing |
| MDN Receipt (.mdn) | Contains the MDN receipt prepared by the receiver |
| Error (.err) | This is only written in an error is encountered, containing the error. |

This property is read-only.

# [AS2Receiver](#as2receiver-class).MDNReceipt Property

The MDN-based receipt generated by the class.

## Syntax

```text
getMDNReceipt(): MDNReceipt;
setMDNReceipt(MDNReceipt: MDNReceipt): void;
```

## Default Value

## Remarks

After invoking [CreateMDNReceipt](#as2receivercreatemdnreceipt-method), MDNReceipt will contain the entire text of the receipt to be returned to the client. It will report either success or failure depending on [ScanResult](#as2receiverscanresult-property); in either case it will be RFC-compliant and suitable for returning to the client.

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](#as2receivercreatemdnreceipt-method) and customized further by setting the parameters to [CreateMDNReceipt](#as2receivercreatemdnreceipt-method).

A variety of configuration settings may be used to override the default generation of the outgoing MDN. The MIC algorithm used in the MDN may be set with [MDNMICAlgorithm](#MDNMICAlgorithm);. [MDNReportingUA](#MDNReportingUA) specifies the reporting agent, and [MDNSendingMode](#MDNSendingMode) may be used to specify the "disposition-mode" field in the MDN.

The signature, if any, will use the protocol specified by the [ReceiptSigningProtocol](#ReceiptSigningProtocol) configuration setting, and the certificate specified.

Error reporting may be controlled by configuring [ErrorReportingFlags](#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](#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](#MDNWarning) configuration setting.

MDNReceipt will always be generated by the component; however, if [MDNTo](#as2receivermdnto-property) is empty, an MDN-based receipt has not been requested. One may be sent anyway at the option of the server. If [MDNTo](#as2receivermdnto-property) is nonempty, the receipt MUST be returned according to RFC specifications. In AS2, the MDN should be returned in the body of the HTTP reply, or if [ReceiptDeliveryOption](#as2receiverreceiptdeliveryoption-property) is nonempty, to the URL specified there instead. In AS3, the MDN should be returned to the URL specified in [MDNTo](#as2receivermdnto-property).

 Please refer to the [MDNReceipt](#mdnreceipt-type) type for a complete list of fields.

# [AS2Receiver](#as2receiver-class).MDNTo Property

The recipient for the Message Disposition Notification (MDN).

## Syntax

```text
getMDNTo(): string;
```

## Default Value

""

## Remarks

MDNTo corresponds to the *Disposition-Notification-To* header of [RequestHeaders](#as2receiverrequestheaders-property). 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](#as2receiverprocessrequest-method) or [CreateMDNReceipt](#as2receivercreatemdnreceipt-method), and may be sent by calling [SendResponse](#as2receiversendresponse-method).

The receipt will be contained in [MDNReceipt](#as2receivermdnreceipt-property). If [ReceiptDeliveryOption](#as2receiverreceiptdeliveryoption-property) 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](#as2receiversendresponse-method) will send the response as appropriate.

According to RFC specifications, [MDNReceipt](#as2receivermdnreceipt-property) 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.

# [AS2Receiver](#as2receiver-class).MessageId Property

The message ID of the incoming message.

## Syntax

```text
getMessageId(): string;
```

## Default Value

""

## Remarks

MessageId corresponds to the *Message-Id* header of [Request](#as2receiverrequest-property), and will be used as the *Original-Message-Id* header of [MDNReceipt](#as2receivermdnreceipt-property).

This property is read-only.

# [AS2Receiver](#as2receiver-class).ReceiptDeliveryOption Property

A URL indicating how the receipt is to be delivered.

## Syntax

```text
getReceiptDeliveryOption(): string;
```

## Default Value

""

## Remarks

This property corresponds to the *Receipt-delivery-option* header in [Request](#as2receiverrequest-property). 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](#as2receiversendresponse-method).

ReceiptDeliveryOption does not indicate whether or not a receipt was actually requested. If an MDN was requested, that information is given in [MDNTo](#as2receivermdnto-property).

This property is read-only.

# [AS2Receiver](#as2receiver-class).Request Property

The HTTP request to be processed.

## Syntax

```text
getRequest(): Uint8Array;
setRequest(request: Uint8Array): void;
```

## Default Value

""

## Remarks

The body of the request to be processed. The HTTP headers may be set separately in [RequestHeaders](#as2receiverrequestheaders-property) 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](#as2receiverparserequest-method) or [ProcessRequest](#as2receiverprocessrequest-method) is invoked, the contents of Request are lost and you can read the processed data in [EDIData](#as2receiveredidata-property).

This property is not available at design time.

# [AS2Receiver](#as2receiver-class).RequestHeaders Property

The HTTP headers in the AS2 request.

## Syntax

```text
getRequestHeaders(): HeaderList;
```

## Default Value

## Remarks

A collection of headers. These will include AS2-specific headers as well as general HTTP headers.

When assigning an AS2 request to the class, the headers may be included in [Request](#as2receiverrequest-property) or specified separately in RequestHeaders. If the headers are included in [Request](#as2receiverrequest-property) they will be parsed out whenever [ReadRequest](#as2receiverreadrequest-method), [ParseRequest](#as2receiverparserequest-method), or [ProcessRequest](#as2receiverprocessrequest-method) is invoked.

 Please refer to the [Header](#header-type) type for a complete list of fields.

# [AS2Receiver](#as2receiver-class).RequestHeadersString Property

The HTTP headers in the AS2 request.

## Syntax

```text
getRequestHeadersString(): string;
setRequestHeadersString(requestHeadersString: string): void;
```

## 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](#as2receiverrequestheaders-property).

When assigning an AS2 request to the class, the headers may be included in [Request](#as2receiverrequest-property) or specified separately in [RequestHeaders](#as2receiverrequestheaders-property). If the headers are included in [Request](#as2receiverrequest-property) they will be parsed out whenever [ReadRequest](#as2receiverreadrequest-method), [ParseRequest](#as2receiverparserequest-method), or [ProcessRequest](#as2receiverprocessrequest-method) is invoked.

# [AS2Receiver](#as2receiver-class).RestartDirectory Property

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

## Syntax

```text
getRestartDirectory(): string;
setRestartDirectory(restartDirectory: string): void;
```

## Default Value

""

## Remarks

If this property is set, the class 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](#as2receiverprocessrestartrequest-method) 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.

# [AS2Receiver](#as2receiver-class).RolloverCertificate Property

The rollover decryption and receipt signing certificate.

## Syntax

```text
getRolloverCertificate(): Certificate;
setRolloverCertificate(rolloverCertificate: Certificate): void;
```

## Default Value

## Remarks

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

When specified the class will be able to decrypt messages that were encrypted with the corresponding public certificate of either [Certificate](#as2receivercertificate-property) or RolloverCertificate. MDNs will be signed with both the certificate in [Certificate](#as2receivercertificate-property) and RolloverCertificate.

If a different certificate is required for decryption than for MDN signing, set the decryption certificate before calling [ParseRequest](#as2receiverparserequest-method), then set the rollover signing certificate before calling [CreateMDNReceipt](#as2receivercreatemdnreceipt-method). RolloverCertificate must be set to a private key certificate.

 Please refer to the [Certificate](#certificate-type) type for a complete list of fields.

# [AS2Receiver](#as2receiver-class).ScanResult Property

The result of invoking ParseRequest .

## Syntax

```text
getScanResult(): number;
```

## Default Value

0

## Remarks

**ScanResult** will contain information about any errors that occurred while invoking [ParseRequest](#as2receiverparserequest-method) or [ProcessRequest](#as2receiverprocessrequest-method). **ScanResult** will contain 0 if no errors occurred, otherwise it will contain one or more of the following errors. If multiple errors are reported the results will be OR-ed together.

|  |  |
| --- | --- |
| 0x01 | Unable to decrypt data. |
| 0x02 | Unable to decompress data. |
| 0x04 | Unable to validate integrity of data. |
| 0x08 | Unable to verify the signature. |
| 0x10 | Client requested unsupported signature type. |
| 0x20 | Client requested unsupported MIC algorithm. |
| 0x40 | Insufficient message security, as determined by the [Config](#as2receiverconfig-method) entries [RequireSign](#RequireSign) and [RequireEncrypt](#RequireEncrypt). |
| 0x80 | Unexpected processing error. An exception was encountered outside of message processing, such as configuration issues in the class. |
| 0x100 | Duplicate filename. |
| 0x200 | Illegal filename. |
| 0x400 | Empty filename. |
| 0x800 | Error writing incoming file. |

This property is read-only.

# [AS2Receiver](#as2receiver-class).SignerCert Property

Your trading partner's certificate.

## Syntax

```text
getSignerCert(): Certificate;
setSignerCert(signerCert: Certificate): void;
```

## Default Value

## Remarks

You must set your trading partner's certificate before processing any signed messages. This property should be set to a public key certificate.

If the trading partner's identity is unknown, you should first invoke [ReadRequest](#as2receiverreadrequest-method) and read the value of [AS2To](#as2receiveras2to-property) (or for AS3, AS3To). This will allow you to determine the correct certificate to use.

As a special case, you may set [AcceptAnySignerCert](#AcceptAnySignerCert) to *true*. In this case, the class will attempt to validate the signature without knowing the certificate in advance. This is not recommended for production use, as it poses a security risk.

This property is not available at design time.

 Please refer to the [Certificate](#certificate-type) type for a complete list of fields.

# [AS2Receiver](#as2receiver-class).SSLAcceptServerCert Property

For sending HTTPS asynchronous MDNs, a server certificate to unconditionally accept.

## Syntax

```text
getSSLAcceptServerCert(): Certificate;
setSSLAcceptServerCert(SSLAcceptServerCert: Certificate): void;
```

## Default Value

## Remarks

You must set this property to send asynchronous HTTPS MDNs if your trading partner is using a certificate that is not inherently trusted by your system.

When an asynchronous MDN is requested over HTTPS, the class will create a new secure connection with the URL specified in [ReceiptDeliveryOption](#as2receiverreceiptdeliveryoption-property). By default the class will reject any server certificates not signed by a trusted Certificate Authority (CA).

You may also trap the [SSLServerAuthentication](#as2receiversslserverauthentication-event) event to accept the server certificate.

 Please refer to the [Certificate](#certificate-type) type for a complete list of fields.

# [AS2Receiver](#as2receiver-class).SSLCert Property

The certificate used for client authentication.

## Syntax

```text
getSSLCert(): Certificate;
setSSLCert(SSLCert: Certificate): void;
```

## Default Value

## Remarks

SSLCert is used for specifying a private key certificate for HTTP client authentication.

 Please refer to the [Certificate](#certificate-type) type for a complete list of fields.

# [AS2Receiver](#as2receiver-class).UsePSS Property

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

## Syntax

```text
isUsePSS(): boolean;
setUsePSS(usePSS: boolean): void;
```

## 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.

# [AS2Receiver](#as2receiver-class).ackRequest Method

Optional. Acknowledges the incoming request.

## Syntax

```text
async as2receiver.ackRequest(): Promise< void>
```

## 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](#as2receiverparserequest-method) for both synchronous and asynchronous MDN requests.

# [AS2Receiver](#as2receiver-class).config Method

Sets or retrieves a configuration setting.

## Syntax

```text
async as2receiver.config(configurationString : string): Promise< string>
```

## Remarks

Config is a generic method available in every class. It is used to set and retrieve [configuration settings](#config-settings-class-ipworksedias2receiver) for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, 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](#config-settings-class-ipworksedias2receiver), you must call *Config("PROPERTY")*. The value will be returned as a string.

# [AS2Receiver](#as2receiver-class).createMDNReceipt Method

Creates MDNReceipt .

## Syntax

```text
async as2receiver.createMDNReceipt(headers : string, MDN : string, message : string): Promise< void>
```

## Remarks

**CreateMDNReceipt** may be invoked after [ParseRequest](#as2receiverparserequest-method) to create an MDN-based receipt. The receipt will report success or failure depending on [ErrorReportingFlags](#ErrorReportingFlags) and the success or failure of [ParseRequest](#as2receiverparserequest-method).

This method populates [MDNReceipt](#as2receivermdnreceipt-property) 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 class 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.

# [AS2Receiver](#as2receiver-class).parseRequest Method

Parses the EDI message and determines the EDIData .

## Syntax

```text
async as2receiver.parseRequest(): Promise< void>
```

## Remarks

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

If the message is scanned without difficulty, [EDIData](#as2receiveredidata-property) 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](#as2receiveredidata-property) will not be determined.

The class may be configured to ignore certain errors by setting [ErrorProcessingFlags](#ErrorProcessingFlags). This will allow the message to be processed and [EDIData](#as2receiveredidata-property) to be determined. If any errors occur, an exception will be thrown and the [ScanResult](#as2receiverscanresult-property) property will reflect the error condition.

Whether or not an exception is thrown, an [MDNReceipt](#as2receivermdnreceipt-property) may be generated by invoking [CreateMDNReceipt](#as2receivercreatemdnreceipt-method). In the case of a successful scan [MDNReceipt](#as2receivermdnreceipt-property) will report the success, otherwise the receipt will provide information to the client about the error.

[ProcessRequest](#as2receiverprocessrequest-method) may be used to scan and create the receipt in one step. [ReadRequest](#as2receiverreadrequest-method) may be used to scan the request headers only to obtain details that can be used to configure the correct settings for the partner.

# [AS2Receiver](#as2receiver-class).processRequest Method

Processes the EDI data, and generates the receipt.

## Syntax

```text
async as2receiver.processRequest(): Promise< void>
```

## Remarks

Invoking **ProcessRequest** automates the entire AS2 server process. The method scans the request, determines the [EDIData](#as2receiveredidata-property), and generates the [MDNReceipt](#as2receivermdnreceipt-property). In a server environment the receipt may be returned by invoking [SendResponse](#as2receiversendresponse-method).

The method's functionality is the same as the combined functionality of [ParseRequest](#as2receiverparserequest-method) and [CreateMDNReceipt](#as2receivercreatemdnreceipt-method). The method's operation is controlled by [ErrorProcessingFlags](#ErrorProcessingFlags) and [ErrorReportingFlags](#ErrorReportingFlags), and [ScanResult](#as2receiverscanresult-property) will be populated as in [ParseRequest](#as2receiverparserequest-method).

The method will throw an exception, as [ParseRequest](#as2receiverparserequest-method) does, if a problem is found while processing the request. However, if the problem does not prevent an MDN from being generated, [MDNReceipt](#as2receivermdnreceipt-property) 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](#as2receivermdnreceipt-property) will provide more detail on the cause of the error.

The class will populate [EDIData](#as2receiveredidata-property) if no errors occurred scanning the request, or if [ErrorProcessingFlags](#ErrorProcessingFlags) had been previously configured to allow the error.

# [AS2Receiver](#as2receiver-class).processRestartRequest Method

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

## Syntax

```text
async as2receiver.processRestartRequest(): Promise< void>
```

## Remarks

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

# [AS2Receiver](#as2receiver-class).readRequest Method

Reads the AS2 request from the HTTP session.

## Syntax

```text
async as2receiver.readRequest(): Promise< void>
```

## Remarks

ReadRequest reads the AS2 request from the content of the [Request](#as2receiverrequest-property) (and optionally the [RequestHeadersString](#as2receiverrequestheadersstring-property)) property. The class will parse the request from [Request](#as2receiverrequest-property). The headers will be read into [RequestHeaders](#as2receiverrequestheaders-property). Finally, the class will parse the headers and populate the following properties:

- [AS2From](#as2receiveras2from-property)
- [AS2To](#as2receiveras2to-property)
- [AS2VersionIncoming](#AS2VersionIncoming)
- [MessageId](#as2receivermessageid-property)
- [MDNTo](#as2receivermdnto-property)
- [ReceiptDeliveryOption](#as2receiverreceiptdeliveryoption-property)
- [RequestedSignatureProtocol](#RequestedSignatureProtocol)
- [RequestedMICAlgorithms](#RequestedMICAlgorithms)

[ParseRequest](#as2receiverparserequest-method) may be used to scan the entire message.

# [AS2Receiver](#as2receiver-class).reset Method

Resets the state of the control.

## Syntax

```text
async as2receiver.reset(): Promise< void>
```

## Remarks

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

# [AS2Receiver](#as2receiver-class).sendAsyncMDN Method

Sends the MDNReceipt to the RemoteURL specified.

## Syntax

```text
async as2receiver.sendAsyncMDN(remoteURL : string, MDNReceipt : Uint8Array, MDNReceiptHeaders : string): Promise< void>
```

## Remarks

This method sends the asynchronous [MDNReceipt](#as2receivermdnreceipt-property) to the *RemoteURL* specified. It need not be invoked if the prior call to [SendResponse](#as2receiversendresponse-method) was successful. The *RemoteURL*, *MDNReceipt*, and *MDNReceiptHeaders* parameters should be the ones that were retrieved from [ReceiptDeliveryOption](#as2receiverreceiptdeliveryoption-property) and [MDNReceipt](#as2receivermdnreceipt-property)'s *Content* and *Headers* properties respectively.

If the RemoteURL requires SMTP transfer, the appropriate SMTP settings should be set using [Config](#as2receiverconfig-method).

# [AS2Receiver](#as2receiver-class).sendResponse Method

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

## Syntax

```text
async as2receiver.sendResponse(): Promise< void>
```

## Remarks

When called from within a server environment, SendResponse will respond to the requesting client. If an MDN was requested, then [MDNReceipt](#as2receivermdnreceipt-property) 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](#as2receiverackrequest-method).

The AS2 headers will be taken from [MDNReceipt](#as2receivermdnreceipt-property) and will be merged with HTTP headers as appropriate. Note that if [ReceiptDeliveryOption](#as2receiverreceiptdeliveryoption-property) indicates a "mailto:" URL, the appropriate SMTP settings should be set using [Config](#as2receiverconfig-method).

The exact behavior of the method is specific to the environment. . 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](#as2receivermdnreceipt-property) and [ReceiptDeliveryOption](#as2receiverreceiptdeliveryoption-property) may be saved so that the MDN may be sent later through the [SendAsyncMDN](#as2receiversendasyncmdn-method) method.

This method should only be invoked after [MDNReceipt](#as2receivermdnreceipt-property) has been generated by [CreateMDNReceipt](#as2receivercreatemdnreceipt-method) or [ProcessRequest](#as2receiverprocessrequest-method).

# [AS2Receiver](#as2receiver-class).setAttachmentOutputStream Method

Decodes the specified attachment to the output stream.

## Syntax

```text
async as2receiver.setAttachmentOutputStream(index : number, stream : WriteableStream): Promise< void>
```

## Remarks

This method decodes the attachment specified by *index* to the specified *stream*. When this method is called the attachment is decoded immediately and the decoded data is written to the specified stream.

# [AS2Receiver](#as2receiver-class).setRequestStream Method

Sets the stream from which the class will read the AS2 request.

## Syntax

```text
async as2receiver.setRequestStream(inputStream : ReadableStream): Promise< void>
```

## Remarks

If an input stream is set before the class attempts to process an AS2 request, the data is read from the input stream. Otherwise, the [Request](#as2receiverrequest-property) will be checked.

The content of the stream will be read from the current position all the way to the end and no bytes will be skipped.

# [AS2Receiver](#as2receiver-class).setTPInfo Method

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

## Syntax

```text
async as2receiver.setTPInfo(profile : string): Promise< void>
```

## 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](AS2ProfileMgr.md#AS2ProfileMgr).

An example usage scenario is shown below.

```text
  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();
```

# [AS2Receiver](#as2receiver-class).CEMRequest Event

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

## Syntax

```text
as2receiver.on('CEMRequest', listener: (e: {readonly requestId: string, readonly as2From: string}) => void )
```

## 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](#CEMCertDir) is set the received certificates will be written to the specified location. If [CEMCertDir](#CEMCertDir) is not set the certificates will be held in memory and may be accessed by inspecting [CEMDetails](#as2receivercemdetails-property).

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

When this event fires the following [CEMDetails](#as2receivercemdetails-property) properties are applicable:

- CEMDetailsCertStoreType
- CEMDetailsCertStore
- CEMDetailsCertSubject
- CEMDetailsCertUsage
- CEMDetailsCertIssuer
- CEMDetailsCertSerialNumber
- CEMDetailsCertId
- CEMDetailsRespondByDate
- CEMDetailsResponseURL

To send a CEM response save the [CEMDetails](#as2receivercemdetails-property) values and call SendCEMResponse with the AS2Sender class.

# [AS2Receiver](#as2receiver-class).CEMResponse Event

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

## Syntax

```text
as2receiver.on('CEMResponse', listener: (e: {readonly requestId: string, readonly as2From: string}) => void )
```

## 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](#as2receivercemdetails-property) property will be populated. Inspect the CEMDetailsAccepted property to determine whether each CEM request was accepted. If the request was rejected, check CEMDetailsRejectionReason for details.

When this event fires the following [CEMDetails](#as2receivercemdetails-property) properties are applicable:

- CEMDetailsCertIssuer
- CEMDetailsCertSerialNumber
- CEMDetailsAccepted
- CEMDetailsRejectionReason

# [AS2Receiver](#as2receiver-class).EDIDataInfo Event

Fired when processing an incoming message.

## Syntax

```text
as2receiver.on('EDIDataInfo', listener: (e: {readonly name: string, readonly dataType: string, duplicate: boolean}) => void )
```

## Remarks

When [ParseRequest](#as2receiverparserequest-method) or [ProcessRequest](#as2receiverprocessrequest-method) 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](#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](#as2receiverincomingdirectory-property) 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.

# [AS2Receiver](#as2receiver-class).Error Event

Fired when information is available about errors during data delivery.

## Syntax

```text
as2receiver.on('Error', listener: (e: {readonly errorCode: number, readonly description: string}) => void )
```

## Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class .

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](#trappable-errors-class-ipworksedias2receiver) section.

# [AS2Receiver](#as2receiver-class).Log Event

Fired with log information while processing a message.

## Syntax

```text
as2receiver.on('Log', listener: (e: {readonly logType: string, readonly logMessage: string, readonly logMessageB: Uint8Array}) => void )
```

## Remarks

This event fires once for each log message generated by the class. The verbosity is controlled by the [LogLevel](#LogLevel) setting.

Log messages available through this event correspond to log files written to [LogDirectory](#as2receiverlogdirectory-property). This event provides a way to obtain log messages without relying on files on disk. This event fires regardless of the value of [LogDirectory](#as2receiverlogdirectory-property) (i.e. when [LogDirectory](#as2receiverlogdirectory-property) 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:

|  |  |
| --- | --- |
| "LOG" | Information about the status of the process. |
| "ERR" | An error was encountered. |
| "DAT" | The EDI payload. |
| "REQ" | The raw request |
| "MDN" | The MDN response. |
| "DEBUG" | Debug information. |
| "DAT.INPUT" | Debug information when processing payload. Only applicable when [LogDebug](#LogDebug) is True. |
| "DAT.ENCRYPT" | Debug information when processing payload. Only applicable when [LogDebug](#LogDebug) is True. |
| "DAT.COMPRESS" | Debug information when processing payload. Only applicable when [LogDebug](#LogDebug) is True. |
| "DAT.SIGN" | Debug information when processing payload. Only applicable when [LogDebug](#LogDebug) is True. |
| "DAT.DECRYPT" | Debug information when processing payload. Only applicable when [LogDebug](#LogDebug) is True. |
| "DAT.DECOMPRESS" | Debug information when processing payload. Only applicable when [LogDebug](#LogDebug) is True. |
| "DAT.VERIFY" | Debug information when processing payload. Only applicable when [LogDebug](#LogDebug) is True. |
| "DAT.DEBUG" | Debug information when processing payload. Only applicable when [LogDebug](#LogDebug) is True. |

# [AS2Receiver](#as2receiver-class).RecipientInfo Event

Fired for each recipient certificate of the encrypted message.

## Syntax

```text
as2receiver.on('RecipientInfo', listener: (e: {readonly issuer: string, readonly serialNumber: string, readonly subjectKeyIdentifier: string, readonly encryptionAlgorithm: string}) => void )
```

## Remarks

When [ParseRequest](#as2receiverparserequest-method) or [ProcessRequest](#as2receiverprocessrequest-method) 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"

# [AS2Receiver](#as2receiver-class).SignerCertInfo Event

This event is fired during verification of the signed message.

## Syntax

```text
as2receiver.on('SignerCertInfo', listener: (e: {readonly issuer: string, readonly serialNumber: string, readonly subjectKeyIdentifier: string, readonly certEncoded: string, readonly certEncodedB: Uint8Array}) => void )
```

## 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](#as2receiversignercert-property) 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 class will automatically use this value to perform signature verification.

The [SignerCert](#as2receiversignercert-property) 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.

# [AS2Receiver](#as2receiver-class).SSLServerAuthentication Event

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

## Syntax

```text
as2receiver.on('SSLServerAuthentication', listener: (e: {readonly certEncoded: string, readonly certEncodedB: Uint8Array, readonly certSubject: string, readonly certIssuer: string, readonly status: string, accept: boolean}) => void )
```

## 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 class 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](#as2receiversslacceptservercert-property) property to the value of the expected certificate (if the server certificate is known in advance the latter method is simpler).

# [AS2Receiver](#as2receiver-class).SSLStatus Event

Fired when secure connection progress messages are available.

## Syntax

```text
as2receiver.on('SSLStatus', listener: (e: {readonly message: string}) => void )
```

## Remarks

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

# CEMDetail Type

This type defines details about the CEM request.

## Remarks

This type defines details about the CEM request. Not all fields are applicable for all operations.

The following fields are available:

- [Accepted](#CEMDetail_f_Accepted)

- [CertId](#CEMDetail_f_CertId)

- [CertIssuer](#CEMDetail_f_CertIssuer)

- [CertSerialNumber](#CEMDetail_f_CertSerialNumber)

- [CertStore](#CEMDetail_f_CertStore)

- [CertStorePassword](#CEMDetail_f_CertStorePassword)

- [CertStoreType](#CEMDetail_f_CertStoreType)

- [CertSubject](#CEMDetail_f_CertSubject)

- [CertUsage](#CEMDetail_f_CertUsage)

- [RejectionReason](#CEMDetail_f_RejectionReason)

- [RespondByDate](#CEMDetail_f_RespondByDate)

- [ResponseURL](#CEMDetail_f_ResponseURL)

## Fields

 **Accepted** *boolean*
*Default Value: False*

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.

 **CertId** *string*
*Default Value: ""*

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.

 **CertIssuer** *string*
*Default Value: ""*

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.

 **CertSerialNumber** *string*
*Default Value: ""*

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.

 **CertStore** *string*
*Default Value: "MY"*

The name of the certificate store for the certificate.

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

 Designations of certificate stores are platform dependent.

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

|  |  |
| --- | --- |
| MY | A certificate store holding personal certificates with their associated private keys. |
| CA | Certifying authority certificates. |
| ROOT | Root certificates. |

When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

 **CertStoreB** *Uint8Array*
*Default Value: "MY"*

The name of the certificate store for the certificate.

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

 Designations of certificate stores are platform dependent.

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

|  |  |
| --- | --- |
| MY | A certificate store holding personal certificates with their associated private keys. |
| CA | Certifying authority certificates. |
| ROOT | Root certificates. |

When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

 **CertStorePassword** *string*
*Default Value: ""*

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

 **CertStoreType** *CertStoreTypes*
*Default Value: 0*

The type of certificate store for this certificate.

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

```csharp
sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11,
                               @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll",
                               "123456", // PIN
                               "CN=cert_subject");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);
```

```csharp
certmgr.CertStoreType = CertStoreTypes.cstPKCS11;
certmgr.OnCertList += (s, e) => {
  secKeyBlob = e.CertEncoded;
};
certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll";
certmgr.CertStorePassword = "123456"; // PIN
certmgr.ListStoreCertificates();

sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);
```

|  |  |
| --- | --- |
| 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. |
| 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. |
| 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
| 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
| 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. |
| 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. |
| 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
| 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
| 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
| 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
| 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
| 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
| 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
| 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
| 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
| 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
| 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
| 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
| 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
| 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
| 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. |
| 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. |
| 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#certificate-type) object and pass cstPKCS11 as the [](#f_StoreType), the full path of the PKCS#11 DLL as the [](#f_Store), and the PIN as the [](#f_StorePassword). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](CertMgr.md#CertMgr) class by calling the [ListStoreCertificates](CertMgr.md#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](CertMgr.md#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [](#f_Store) and set [](#f_StorePassword) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): |
| 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |

 **CertSubject** *string*
*Default Value: ""*

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=example@email.com". Common fields and their meanings are as follows:

| Field | Meaning |
| --- | --- |
| CN | Common Name. This is commonly a hostname like www.server.com. |
| O | Organization |
| OU | Organizational Unit |
| L | Locality |
| S | State |
| C | Country |
| E | Email Address |

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

 **CertUsage** *number*
*Default Value: 15*

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 default value is "15", meaning all usages are allowed.

 **RejectionReason** *string*
*Default Value: ""*

If  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.

 **RespondByDate** *string*
*Default Value: ""*

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.

 **ResponseURL** *string*
*Default Value: ""*

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.

## Constructors

```text
public CEMDetail();
```

# Certificate Type

This is the digital certificate being used.

## Remarks

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

The following fields are available:

- [EffectiveDate](#Certificate_f_EffectiveDate)

- [ExpirationDate](#Certificate_f_ExpirationDate)

- [ExtendedKeyUsage](#Certificate_f_ExtendedKeyUsage)

- [Fingerprint](#Certificate_f_Fingerprint)

- [FingerprintSHA1](#Certificate_f_FingerprintSHA1)

- [FingerprintSHA256](#Certificate_f_FingerprintSHA256)

- [Issuer](#Certificate_f_Issuer)

- [KeyPassword](#Certificate_f_KeyPassword)

- [PrivateKey](#Certificate_f_PrivateKey)

- [PrivateKeyAvailable](#Certificate_f_PrivateKeyAvailable)

- [PrivateKeyContainer](#Certificate_f_PrivateKeyContainer)

- [PublicKey](#Certificate_f_PublicKey)

- [PublicKeyAlgorithm](#Certificate_f_PublicKeyAlgorithm)

- [PublicKeyLength](#Certificate_f_PublicKeyLength)

- [SerialNumber](#Certificate_f_SerialNumber)

- [SignatureAlgorithm](#Certificate_f_SignatureAlgorithm)

- [Store](#Certificate_f_Store)

- [StorePassword](#Certificate_f_StorePassword)

- [StoreType](#Certificate_f_StoreType)

- [SubjectAltNames](#Certificate_f_SubjectAltNames)

- [ThumbprintMD5](#Certificate_f_ThumbprintMD5)

- [ThumbprintSHA1](#Certificate_f_ThumbprintSHA1)

- [ThumbprintSHA256](#Certificate_f_ThumbprintSHA256)

- [Usage](#Certificate_f_Usage)

- [UsageFlags](#Certificate_f_UsageFlags)

- [Version](#Certificate_f_Version)

- [Subject](#Certificate_f_Subject)

- [Encoded](#Certificate_f_Encoded)

## Fields

 **EffectiveDate** *string (read-only)*
*Default Value: ""*

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

 **ExpirationDate** *string (read-only)*
*Default Value: ""*

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

 **ExtendedKeyUsage** *string (read-only)*
*Default Value: ""*

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

 **Fingerprint** *string (read-only)*
*Default Value: ""*

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: *bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02*

 **FingerprintSHA1** *string (read-only)*
*Default Value: ""*

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: *30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84*

 **FingerprintSHA256** *string (read-only)*
*Default Value: ""*

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: *6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53*

 **Issuer** *string (read-only)*
*Default Value: ""*

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

 **KeyPassword** *string*
*Default Value: ""*

The password for the certificate's private key (if any).

Some certificate stores may individually protect certificates' private keys, separate from the standard protection offered by the . This property can be used to read such password-protected private keys.

NOTE: This property defaults to the value of . To clear it, you must set the property to the empty string (""). It can be set at any time, but when the private key's password is different from the store's password, then it must be set before calling .

 **PrivateKey** *string (read-only)*
*Default Value: ""*

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

NOTE: The  may be available but not exportable. In this case,  returns an empty string.

 **PrivateKeyAvailable** *boolean (read-only)*
*Default Value: False*

Whether a  is available for the selected certificate. If  is True, the certificate may be used for authentication purposes (e.g., server authentication).

 **PrivateKeyContainer** *string (read-only)*
*Default Value: ""*

The name of the  container for the certificate (if available). This functionality is available only on Windows platforms.

 **PublicKey** *string (read-only)*
*Default Value: ""*

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

 **PublicKeyAlgorithm** *string (read-only)*
*Default Value: ""*

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

 **PublicKeyLength** *number (read-only)*
*Default Value: 0*

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

 **SerialNumber** *string (read-only)*
*Default Value: ""*

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

 **SignatureAlgorithm** *string (read-only)*
*Default Value: ""*

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

 **Store** *string*
*Default Value: "MY"*

The name of the certificate store for the client certificate.

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

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

 Designations of certificate stores are platform dependent.

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

|  |  |
| --- | --- |
| MY | A certificate store holding personal certificates with their associated private keys. |
| CA | Certifying authority certificates. |
| ROOT | Root certificates. |

When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

 **StoreB** *Uint8Array*
*Default Value: "MY"*

The name of the certificate store for the client certificate.

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

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

 Designations of certificate stores are platform dependent.

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

|  |  |
| --- | --- |
| MY | A certificate store holding personal certificates with their associated private keys. |
| CA | Certifying authority certificates. |
| ROOT | Root certificates. |

When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

 **StorePassword** *string*
*Default Value: ""*

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

 **StoreType** *CertStoreTypes*
*Default Value: 0*

The type of certificate store for this certificate.

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

```csharp
sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11,
                               @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll",
                               "123456", // PIN
                               "CN=cert_subject");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);
```

```csharp
certmgr.CertStoreType = CertStoreTypes.cstPKCS11;
certmgr.OnCertList += (s, e) => {
  secKeyBlob = e.CertEncoded;
};
certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll";
certmgr.CertStorePassword = "123456"; // PIN
certmgr.ListStoreCertificates();

sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);
```

|  |  |
| --- | --- |
| 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. |
| 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. |
| 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
| 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
| 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. |
| 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. |
| 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
| 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
| 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
| 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
| 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
| 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
| 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
| 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
| 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
| 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
| 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
| 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
| 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
| 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
| 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. |
| 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. |
| 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#certificate-type) object and pass cstPKCS11 as the [](#f_StoreType), the full path of the PKCS#11 DLL as the [](#f_Store), and the PIN as the [](#f_StorePassword). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](CertMgr.md#CertMgr) class by calling the [ListStoreCertificates](CertMgr.md#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](CertMgr.md#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [](#f_Store) and set [](#f_StorePassword) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): |
| 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |

 **SubjectAltNames** *string (read-only)*
*Default Value: ""*

Comma-separated lists of alternative subject names for the certificate.

 **ThumbprintMD5** *string (read-only)*
*Default Value: ""*

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

 **ThumbprintSHA1** *string (read-only)*
*Default Value: ""*

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

 **ThumbprintSHA256** *string (read-only)*
*Default Value: ""*

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

 **Usage** *string (read-only)*
*Default Value: ""*

The text description of .

This value will be one or more of the following strings and will be separated by commas:

- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

 **UsageFlags** *number (read-only)*
*Default Value: 0*

The flags that show intended use for the certificate. The value of  is a combination of the following flags:

|  |  |
| --- | --- |
| 0x80 | Digital Signature |
| 0x40 | Non-Repudiation |
| 0x20 | Key Encipherment |
| 0x10 | Data Encipherment |
| 0x08 | Key Agreement |
| 0x04 | Certificate Signing |
| 0x02 | CRL Signing |
| 0x01 | Encipher Only |

Please see the  property for a text representation of .

This functionality currently is not available when the provider is OpenSSL.

 **Version** *string (read-only)*
*Default Value: ""*

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

 **Subject** *string*
*Default Value: ""*

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=example@email.com". Common fields and their meanings are as follows:

| Field | Meaning |
| --- | --- |
| CN | Common Name. This is commonly a hostname like www.server.com. |
| O | Organization |
| OU | Organizational Unit |
| L | Locality |
| S | State |
| C | Country |
| E | Email Address |

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

 **Encoded** *string*
*Default Value: ""*

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

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

 **EncodedB** *Uint8Array*
*Default Value: ""*

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

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

## Constructors

```text
public Certificate();
```

 Creates a instance whose properties can be set.

```text
public Certificate(String certificateFile);
```

 Opens * CertificateFile * and reads out the contents as an X.509 public key.

```text
public Certificate(byte[] encoded);
```

 Parses * Encoded * as an X.509 public key.

```text
public Certificate(int storeType, String store, String storePassword, String subject);
```

 * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a file containing the certificate store. * StorePassword * is the password used to protect the store.

 After the store has been successfully opened, the class will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.

```text
public Certificate(int storeType, String store, String storePassword, String subject, String configurationString);
```

 * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a file containing the certificate store. * StorePassword * is the password used to protect the store.

 * ConfigurationString * is a newline-separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CryptoAPI option. The default value is True (the key is persisted). "Thumbprint" - an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to the * cstUser * , * cstMachine * , * cstPublicKeyFile * , and * cstPFXFile * store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations.

 After the store has been successfully opened, the class will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.

```text
public Certificate(int storeType, String store, String storePassword, byte[] encoded);
```

 * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a file containing the certificate store. * StorePassword * is the password used to protect the store.

 After the store has been successfully opened, the class will load * Encoded * as an X.509 certificate and search the opened store for a corresponding private key.

```text
public Certificate(int storeType, byte[] store, String storePassword, String subject);
```

 * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a byte array containing the certificate data. * StorePassword * is the password used to protect the store.

 After the store has been successfully opened, the class will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.

```text
public Certificate(int storeType, byte[] store, String storePassword, String subject, String configurationString);
```

 * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a byte array containing the certificate data. * StorePassword * is the password used to protect the store.

 After the store has been successfully opened, the class will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.

```text
public Certificate(int storeType, byte[] store, String storePassword, byte[] encoded);
```

 * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a byte array containing the certificate data. * StorePassword * is the password used to protect the store.

 After the store has been successfully opened, the class will load * Encoded * as an X.509 certificate and search the opened store for a corresponding private key.

# EDIAttachment Type

This describes the file being attached.

## Remarks

Information about the file's location that is being attached to the message is contained here.

The following fields are available:

- [ContentType](#EDIAttachment_f_ContentType)

- [Data](#EDIAttachment_f_Data)

- [FileName](#EDIAttachment_f_FileName)

- [Headers](#EDIAttachment_f_Headers)

- [InputStream](#EDIAttachment_f_InputStream)

- [Name](#EDIAttachment_f_Name)

- [OutputStream](#EDIAttachment_f_OutputStream)

## Fields

 **ContentType** *string*
*Default Value: ""*

The MIME content-type of this [EDIAttachment](#ediattachment-type).

 **Data** *string*
*Default Value: ""*

This property contains the attachment data.

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

 **DataB** *Uint8Array*
*Default Value: ""*

This property contains the attachment data.

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

 **FileName** *string*
*Default Value: ""*

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 .

 **Headers** *string*
*Default Value: ""*

The class fills out  each time any of the other properties for that [EDIAttachment](#ediattachment-type) are changed. If additional headers are needed they should be appended after all the other properties for that [EDIAttachment](#ediattachment-type) are set.

 **InputStream** *ReadableStream*
*Default Value: ""*

If  is specified, the data from the stream specified will be used for the EDI attachment.

 **Name** *string*
*Default Value: ""*

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

 **OutputStream** *WriteableStream (read-only)*
*Default Value: ""*

The class decodes the attachment of Message when This property's value is first set, and writes the decoded attachment to the stream.

NOTE: It is recommended to use the SetAttachmentOutputStream method instead of setting this property.

## Constructors

```text
public EDIAttachment();
```

```text
public EDIAttachment(String fileName);
```

```text
public EDIAttachment(String fileName, String contentType);
```

```text
public EDIAttachment(String fileName, String contentType, String headers);
```

# EDIData Type

The EDI payload of the AS2 message.

## Remarks

The EDI payload of the AS2 message.

The following fields are available:

- [Data](#EDIData_f_Data)

- [EDIType](#EDIData_f_EDIType)

- [InputStream](#EDIData_f_InputStream)

- [Name](#EDIData_f_Name)

- [OutputStream](#EDIData_f_OutputStream)

- [FileName](#EDIData_f_FileName)

## Fields

 **Data** *string*
*Default Value: ""*

This property contains the EDI payload of the transmission.

In a receiver, this property will only be populated if IncomingDirectory and  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.

 **DataB** *Uint8Array*
*Default Value: ""*

This property contains the EDI payload of the transmission.

In a receiver, this property will only be populated if IncomingDirectory and  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.

 **EDIType** *string*
*Default Value: ""*

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

 **InputStream** *ReadableStream*
*Default Value: ""*

In a sender, if  is specified, the data from the specified stream will be used for the EDI payload of the transmission.

 **Name** *string*
*Default Value: "rfc1767.edi"*

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

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

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

 **OutputStream** *WriteableStream*
*Default Value: ""*

In a receiver, if this property is set, the EDI payload will be written to this stream if ParseRequest finishes without an error, setting ScanResult to 0. If so, the specified stream will contain the full decrypted text of the EDI message.

NOTE: When  is used and the underlying data contains attachments, the attachments will not be decoded to the output stream. Attachments are accessible via the Attachments collection.

 **FileName** *string*
*Default Value: ""*

In a sender, if  is specified, the file specified will be used for the EDI payload of the transmission.  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  is set, the data will be written to the stream and this property will not be populated.

## Constructors

```text
public EDIData();
```

```text
public EDIData(byte[] data, String EDIType);
```

```text
public EDIData(String fileName, String EDIType);
```

# Firewall Type

The firewall the class will connect through.

## Remarks

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

The following fields are available:

- [AutoDetect](#Firewall_f_AutoDetect)

- [FirewallType](#Firewall_f_FirewallType)

- [Host](#Firewall_f_Host)

- [Password](#Firewall_f_Password)

- [Port](#Firewall_f_Port)

- [User](#Firewall_f_User)

## Fields

 **AutoDetect** *boolean*
*Default Value: False*

Whether to automatically detect and use firewall system settings, if available.

 **FirewallType** *FirewallTypes*
*Default Value: 0*

The type of firewall to connect through. The applicable values are as follows:

|  |  |
| --- | --- |
| fwNone (0) | No firewall (default setting). |
| fwTunnel (1) | Connect through a tunneling proxy. [](#f_Port) is set to 80. |
| fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. [](#f_Port) is set to 1080. |
| fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. [](#f_Port) is set to 1080. |
| fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. [](#f_Port) is set to 1080. |

 **Host** *string*
*Default Value: ""*

The name or IP address of the firewall (optional). If a  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 class .

 **Password** *string*
*Default Value: ""*

A password if authentication is to be used when connecting through the firewall. If  is specified, the  and  properties are used to connect and authenticate to the given firewall. If the authentication fails, the class .

 **Port** *number*
*Default Value: 0*

The Transmission Control Protocol (TCP) port for the firewall . See the description of the  property for details.

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

 **User** *string*
*Default Value: ""*

A username if authentication is to be used when connecting through a firewall. If  is specified, this property and the  property are used to connect and authenticate to the given [Firewall](#firewall-type). If the authentication fails, the class .

## Constructors

```text
public Firewall();
```

# Header Type

This is an HTTP header as it is received from the server.

## Remarks

When a header is received through a Header event, it is parsed into a [Header](#header-type) type. This type contains a , and its corresponding .

The following fields are available:

- [Field](#Header_f_Field)

- [Value](#Header_f_Value)

## Fields

 **Field** *string*
*Default Value: ""*

This property contains the name of the HTTP [Header](#header-type) (this is the same case as it is delivered).

 **Value** *string*
*Default Value: ""*

This property contains the [Header](#header-type) contents.

## Constructors

```text
public Header();
```

```text
public Header(String field, String value);
```

# MDNReceipt Type

The complete MDN Receipt returned by the receiver.

## Remarks

The complete MDN Receipt contains the Message Disposition Notification (MDN) and an optional signature.

The following fields are available:

- [Content](#MDNReceipt_f_Content)

- [HeaderCount](#MDNReceipt_f_HeaderCount)

- [HeaderField](#MDNReceipt_f_HeaderField)

- [HeaderIndex](#MDNReceipt_f_HeaderIndex)

- [Headers](#MDNReceipt_f_Headers)

- [HeaderValue](#MDNReceipt_f_HeaderValue)

- [MDN](#MDNReceipt_f_MDN)

- [Message](#MDNReceipt_f_Message)

- [MICValue](#MDNReceipt_f_MICValue)

- [SigningProtocol](#MDNReceipt_f_SigningProtocol)

## Fields

 **Content** *string*
*Default Value: ""*

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

 **ContentB** *Uint8Array*
*Default Value: ""*

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

 **HeaderCount** *number (read-only)*
*Default Value: 0*

The number of headers in the MDN.

 **HeaderField** *string (read-only)*
*Default Value: ""*

The field name of the MDN header currently selected by .

 **HeaderIndex** *number*
*Default Value: 0*

Which MDN header is currently selected to populate  and .

Valid values are 0 to  - 1.

 **Headers** *string*
*Default Value: ""*

**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 , , , and  to easily iterate through each individual header.

 **HeaderValue** *string (read-only)*
*Default Value: ""*

The value of the MDN header currently selected by .

 **MDN** *string (read-only)*
*Default Value: ""*

**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.

 **Message** *string (read-only)*
*Default Value: ""*

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.

 **MICValue** *string (read-only)*
*Default Value: ""*

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.,

```plaintext
w7AguNJEmhF/qIjJw6LnnA==, md5
```

.

 **SigningProtocol** *string (read-only)*
*Default Value: ""*

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

## Constructors

```text
public MDNReceipt();
```

```text
public MDNReceipt(String headers, byte[] content);
```

# ReadableStream Type

## Syntax

```text
interface ReadableStream {
  read(buffer: Uint8Array, offset: number, length: number): Promise<number>;
  readSync(buffer: Uint8Array, offset: number, length: number): number;
  available(): number;
  close(): void;
  mark():void;
  reset():void;
  markSupported():boolean;
}
```

## Remarks

 The AS2Receiver class includes one or more API methods that accept a stream object as a parameter. To use such API members, create a custom object that implements the ReadableStream interface, and pass an instance of this object to the AS2Receiver class.

 When implementing the ReadableStream interface's properties and methods, they must behave as described below. If the implementation does not behave as expected, undefined behavior may occur.

```text
read(buffer: Uint8Array, offset: number, length: number): Promise <number> { }
```

```text
readSync(buffer: Uint8Array, offset: number, length: number): number { }
```

```text
available(): number { }
```

```text
close(): void { }
```

```text
mark(): void { }
```

```text
reset(): void { }
```

```text
markSupported(): boolean { }
```

|  |  |
| --- | --- |
| Methods |  |
| The following parameters are supported | buffer: The buffer to store the read data. <br> offset: The starting position within the buffer to write data.<br> length: The maximum number of bytes to read.<br> |
| read | Reads data from the stream into the provided buffer. This method must be implemented.<br> Returns a promise resolving to the number of bytes read, -1 if no data is available. |
| readSync | Synchronously reads data from the stream into the buffer. Returns the number of bytes read, -1 if no data is available. |
| available | Returns the number of bytes available for reading. This method must be implemented.<br> |
| close | Closes the stream and releases associated resources. |
| mark | Marks the current position in this stream. |
| reset | Repositions this stream to the position at the time the mark method was last called. |
| markSupported | Tests if this stream supports the mark and reset methods. Returns true if this stream supports the mark and reset methods; false otherwise. |

# WriteableStream Type

## Syntax

```text
interface WriteableStream {
  write(data: Uint8Array, offset: number, length: number): Promise<void>;
  writeSync(data: Uint8Array, offset: number, length: number): void;
  close(): void;
}
```

## Remarks

 The AS2Receiver class includes one or more API methods that accept a stream object as a parameter. To use such API members, create a custom object that implements the WriteableStream interface, and pass an instance of this object to the AS2Receiver class.

 When implementing the WriteableStream interface's properties and methods, they must behave as described below. If the implementation does not behave as expected, undefined behavior may occur.

```text
write(data: Uint8Array, offset: number, length: number): Promise <void> { }
```

```text
writeSync(data: Uint8Array, offset: number, length: number): void { }
```

```text
close(): void { }
```

|  |  |
| --- | --- |
| Methods |  |
| The following parameters are supported | data: The buffer containing the data to write.<br> offset: The starting position in the buffer to read data from.<br> length: The maximum number of bytes to write.<br> |
| write | Asynchronously writes data from the provided buffer to the stream. This method must be implemented.<br> Returns a promise that resolves when the write operation completes. |
| writeSync | Synchronously writes data from the buffer to the stream. |
| close | Closes the stream and releases associated resources. |

# Config Settings (*class *ipworksedi.[as2receiver](#as2receiver-class))

 The class accepts one or more of the following *configuration settings*. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these *internal properties* is provided through the [Config](#as2receiverconfig-method) method.

### AS2Receiver Config Settings

**AcceptAnySignerCert**: Used to accept trust any signing certificate unconditionally.If [AcceptAnySignerCert](#AcceptAnySignerCert) is set to *true*, the class will accept any signer certificate for the incoming signature. Use of this setting in production is discouraged, as failing to authenticate the sender poses a security risk.

**AS2VersionIncoming**: The version of AS2 that was used in the incoming message.The version of AS2 that was used in the incoming message.

**AS2VersionOutgoing**: The version of AS2 to be used in the outgoing message.The version of AS2 to be used in the outgoing message.

**Authorization**: The Authorization string to be sent to the server. If the [Authorization](#Authorization) setting contains a non-empty string, an *Authorization* HTTP request header is added to the request. This header conveys Authorization information to the server.

This setting is provided so that the class can be extended with other security schemes in addition to the authorization schemes already implemented by the class.

The [AuthScheme](#AuthScheme); setting defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time [User](#User) and [Password](#Password) are set, they are Base64 encoded, and the result is put in the **Authorization** setting in the form "Basic [encoded-user-password]".

**AuthScheme**: The authorization scheme to be used when server authorization is to be performed. Use the [AuthScheme](#AuthScheme) property to tell the component which type of authorization to perform when the [User](#User) and [Password](#Password) properties are set. Possible values are:

|  |  |
| --- | --- |
| 0 (default) | Basic |
| 1 | Digest |
| 2 | Proprietary |
| 3 | None |
| 4 | NTLM |
| 5 | Negotiate |
| 6 | OAuth |

 By default, [AuthScheme](#AuthScheme) is Basic (0), and if the [User](#User) and [Password](#Password) configuration settings are set, the component will attempt basic authentication. If AuthScheme is set to Digest (1), digest authentication will be attempted instead.

For security reasons, setting this value will clear the values of [User](#User) and [Password](#Password).

**CEMCertDir**: Specifies the directory where certificates are saved when receiving a CEM request.This setting specifies a relative or absolute path on disk where certificates received from a CEM request will be saved. The filename format is:

```text
CEMRequestId + "_" + CEMDetailsCertId + ".cer"
```

 The CEMRequestId may be retrieved from the [CEMRequest](#as2receivercemrequest-event) event. Any invalid characters will be replaced with "_". If there is an error writing the file to disk the [Error](#as2receivererror-event) event will fire with details. To overwrite existing certificate files set [OverwriteCEMCerts](#OverwriteCEMCerts) to True.

If this is not set, the certificates will be held in memory and can be accessed via [CEMDetails](#as2receivercemdetails-property). See [CEMRequest](#as2receivercemrequest-event) for details.

**CloseStreamAfterProcessing**: Specifies whether or not the OutputStream should be closed after processing.Determines if the stream specified by EDIDataOutputStream is closed after [ParseRequest](#as2receiverparserequest-method) or [ProcessRequest](#as2receiverprocessrequest-method) returns. By default this is True. Setting this to False keeps the stream open for further use.

**DecodeTempDirectory**: The temp directory the class will use to decode messages.This configuration is only necessary when decoding EDI messages that contain attachments. If a value is specified for [DecodeTempDirectory](#DecodeTempDirectory), the class will first decode the S/MIME message to the temp directory, then decode the embedded MIME message containing attachments to the [IncomingDirectory](#as2receiverincomingdirectory-property).

Note: When using this configuration, if [IncomingDirectory](#as2receiverincomingdirectory-property) is not set, the class will not clean up any temp files it creates. These files must be monitored and cleaned manually by the user.

**DetectDuplicates**: Whether to detect duplicate messages.When receiving messages this setting controls whether the class attempts to detect duplicate messages. Consider the following scenario:

A sender transmits a message, it is successfully received but the MDN cannot be delivered due to a network error. The sender does not receive the MDN and retransmits the message.

This results in two messages being received and processed. In most cases this is not an issue as the backend processing done outside of the class will detect duplicate messages. However, this setting may be enabled to have the class check for duplicates to prevent duplicate incoming messages.

When enabled, [LogDirectory](#as2receiverlogdirectory-property) must be set to a value that will resolve to the same location for both received requests. This means the "%Date:Format%" macro must not be used in the [LogDirectory](#as2receiverlogdirectory-property) value. Additionally, this functionality can only work if the sender uses the same MessageId in both requests.

If a duplicate is detected, no exception is thrown, but the class will respond with an MDN including a warning that a duplicate was detected. The message in the duplicate request will not be processed.

The default value is False.

**EncryptionAlgorithm**: The encryption algorithm used to encrypt the incoming data.If the data is encrypted, **EncryptionAlgorithm** will contain the encryption algorithm used to encrypt the data; i.e., "3DES". If the data is not encrypted **EncryptionAlgorithm** will contain an empty string.

**EncryptionPaddingScheme**: The encryption padding scheme used when encrypting the incoming data.If the data is encrypted this setting contains the padding scheme used when the data was originally encrypted. Possible values are:

- RSAES-PKCS1-v1_5
- RSAES-OAEP

**EncryptionType**: The MIME type of the encrypted data.If the data is encrypted, **EncryptionType** will contain the MIME type of the encrypted data; i.e., "application/pkcs7-mime". If the data is not encrypted **EncryptionType** will contain an empty string.

At present only "application/pkcs7-mime" is supported for decryption.

**ErrorProcessingFlags**: Flags controlling how errors affect ProcessRequest.By default, [ParseRequest](#as2receiverparserequest-method) will halt and throw an exception if [Request](#as2receiverrequest-property) contains errors or requests algorithms, protocols, or receipt types not supported by the class. By setting [ErrorProcessingFlags](#ErrorProcessingFlags) the class can be configured to not halt for certain types of errors. The errors will still be reported in [ScanResult](#as2receiverscanresult-property).

Use of this property allows [EDIData](#as2receiveredidata-property) to be determined even if the class is not fully able to respond to the client's request.

[ErrorReportingFlags](#ErrorReportingFlags) control how the errors are reported in the [MDNReceipt](#as2receivermdnreceipt-property).

The value should be set to the OR of one or more of the following values:

0x04 Unable to validate integrity of data, or unsupported signing protocol used.

0x08 Unable to authenticate the sender.

0x10 Client requested unsupported signature type.

0x20 Client requested unsupported MIC algorithm.

**ErrorReportingFlags**: Flags controlling how errors affect the MDNReceipt.By default, [MDNReceipt](#as2receivermdnreceipt-property) will report an error if any of the conditions below occur. The MIC will not be calculated and the data will be reported as unprocessed.

The [MDNReceipt](#as2receivermdnreceipt-property) may be configured to permit one or more of the errors below. A warning will be reported if [MDNWarning](#MDNWarning) is set; otherwise the error will silently be ignored. Note that errors should be ignored only with extreme caution, and only by agreement of both trading parties.

Multiple errors may be permitted by OR-ing the flags together.

The value should be set to the OR of one or more of the following values:

0x04 Unable to validate integrity of data, or unsupported signing protocol used.

0x08 Unable to authenticate the sender.

0x10 Client requested unsupported signature type.

0x20 Client requested unsupported MIC algorithm.

**FileNameSource**: The location from which to read the filename.

This setting specifies whether to read the filename from the MIME part header (default) or the HTTP header.

When processing a request that supports filename preservation the filename will be read from the MIME body part by default. The MIME body part should hold the filename in the Content-Disposition header for that part as per the specification.

Some implementations do not behave according to the specification and specify the filename in the HTTP Content-Disposition header instead of the MIME part headers.

Possible value are:

|  |  |
| --- | --- |
| 0 (default) | MIME part header |
| 1 | HTTP header |
| 2 | Content-Type MIME part header |

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

**InvalidFileNameMDNAction**: Instructs MDN disposition on invalid and duplicate filenames.Used to implement support for Filename Preservation with Associated MDN Response as requested by the Financial Services Technical Consortium (fstc.org). The following options are supported:

|  |  |
| --- | --- |
| 0 | Continue |
| 1 | Warn |
| 2 | Fail |

 By default, the class will return a positive MDN receipt regardless of what value was provided as a filename in the transmission, renaming the filename to a valid value if a file with the filename value provided could not be written to the location specified in [IncomingDirectory](#as2receiverincomingdirectory-property).

If set to 1 (Warn), the class will rename the filename as above to avoid file conflicts, but will issue a MDN warning when the filename provided is missing, contains invalid characters, or is detected as a duplicate (this behavior is governed by the *Duplicate* parameter of the [EDIDataInfo](#as2receiveredidatainfo-event) event).

If set to 2 (Fail), the class will reject transmissions where the filename provided is missing, contains invalid characters, or is detected as a duplicate.

**LogDebug**: Whether to log debug data.This setting specifies whether to log debug data. When set to True the class will create additional files in the [LogDirectory](#as2receiverlogdirectory-property). The default value is False.

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

**LogFilename**: The base name of the log file.If set, this will be used as for the filename of the log file.

Note that only the base name should be specified as the component will append the appropriate file extension.

**LogOptions**: The information to be written to log files. When [LogDirectory](#as2receiverlogdirectory-property) is set, several pieces of information are written to log files in the specified directory. Set *LogOptions* to one or more of the following values to control what information is written to file. When specifying multiple values, include them in the same string (i.e. "LogOptions=Status, Response, Payload"):

|  |  |
| --- | --- |
| Status | Contains information on applied security options and pass/fail status of transmission |
| Request | Contains the raw incoming request before processing |
| Payload | Contains log of processed payload after transmission |
| MDN | Contains the MDN receipt response to a request |
| Errors | This is only written in an error is encountered, containing the error. |
| All | All of the above |

**MaxParts**: The maximum number of MIME parts to process.Messages may contain multiple MIME parts if attachments are present. This setting specifies the maximum number of MIME parts to process. The default value is "100", which means 99 attachments will be processed. Each message contains one MIME part for the body, and one additional MIME part for each attachment. Set this value to "-1" to indicate no restrictions.

**MDNDisposition**: Overrides the automatically calculated MDN disposition.If specified, this setting overrides the MDN disposition that was automatically calculated by the class. In most cases this is not necessary but may be used when specifying a custom Disposition header is required. For instance:

```text
as2receiver.Config("MDNDisposition=message-deemed-invalid-due-to-unknown-from-and.or-to-parties");
```

**MDNMICAlgorithm**: The algorithm used to sign the outgoing MDN.By default, the component will honor the request of the client, if possible. The MIC will be calculated using the requested algorithm, stored in the *MICValue* property of [MDNReceipt](#as2receivermdnreceipt-property), and reported in the outgoing MDN. If not possible, the MDN will not be signed, and [ParseRequest](#as2receiverparserequest-method) will throw an exception unless [ErrorProcessingFlags](#ErrorProcessingFlags) has been configured to prevent this. The following options are supported:

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

 This setting may be configured in a variety of other ways, as well. If set to *As Requested Or SHA-256* (9), the component will honor requests for a signed receipt as with *As Requested* (0). If unable to comply, or if a signature was not explicitly requested, the MIC will still be calculated using the SHA-256 algorithm. The [ReceiptSigningProtocol](#ReceiptSigningProtocol) property may then be set to return a signed receipt.

For incoming AS2-Version 1.3 messages, MD5, SHA-1, and SHA-224 are rejected when requested or used by the sender.

The property may be set to one of the listed values above to override the client's request, and use the specified signing algorithm. Use extreme caution when doing this; it will result in a non-RFC compliant server.

**MDNReportingUA**: The name of the user agent performing the disposition.The name of the user agent performing the disposition. The RFC 2298 recommendation is to use the DNS name of the user agent and the name of the software performing the disposition, for example, "edi-server.nsoftware.com; /n software EDI Server Demo".

**MDNSendingMode**: The level of end user interaction involved in sending the MDN.[MDNSendingMode](#MDNSendingMode) allows the server software to describe the level of user interaction in sending the MDN. [MDNSendingMode](#MDNSendingMode) corresponds to the "disposition-mode" field in the Disposition Header, as described further in RFC 3335. The following values are supported:

|  |  |
| --- | --- |
| 0 | Automatic |
| 1 | User Configurable |
| 2 | Manual |

By default, the disposition-mode value will be "automatic-action/MDN-sent-automatically".

**MDNWarning**: A warning to appear in the MDN.[MDNWarning](#MDNWarning) defines a warning to appear in the outgoing [MDNReceipt](#as2receivermdnreceipt-property). If any errors are returned in [ScanResult](#as2receiverscanresult-property) and not marked as to be allowed in [ErrorReportingFlags](#ErrorReportingFlags) the errors will take precedence and the warning will not be reported.

[MDNWarning](#MDNWarning) should be assigned when allowing the errors returned in [ScanResult](#as2receiverscanresult-property). The [MDNReceipt](#as2receivermdnreceipt-property) will indicate successful processing of [Request](#as2receiverrequest-property), but will contain a *Warning* field. The following warnings are defined by the AS2 specifications:

"authentication-failed, processing continued"

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

**NormalizeMIC**: Whether to normalize line endings before calculating the MIC.This setting determines whether to normalize line endings before signature verification.

In most cases the signature is verified by calculating a Message Integrity Check (MIC) over the exact data that is received. In some cases other software such as Mendelson AS2 may calculate signatures over a version of the data with normalized line endings. During processing attempts to verify a signature that was created in this manner may lead to one of the following errors:

- *Unable to verify content integrity: Message digest mismatch in signature.*
- *The receipt signature could not be verified: Message digest mismatch in signature.*

If one of the errors above is encountered and the received data is expected to be otherwise correct setting this setting to True may resolve the issue by normalizing line endings before verifying the signature.

Note: This should only be set to True if there is a specific reason to do so.

**OverwriteCEMCerts**: Whether existing CEM certificates are overwritten when a duplicate is received.This setting specifies whether CEM certificates are overwritten in [CEMCertDir](#CEMCertDir) when another certificate with the same name and Id is received. The default value is False.

**Password**: A password if authentication is to be used.If [AuthScheme](#AuthScheme) is set to Basic, the [User](#User) and [Password](#Password) are Base64 encoded and the result is put in the [Authorization](#Authorization) configuration setting in the form "Basic [encoded-user-password]".

If [AuthScheme](#AuthScheme) is set to Digest, the [User](#User) and [Password](#Password) properties are used to respond to the HTTP Digest Authentication challenge from the server.

The [User](#User) and [Password](#Password) properties must be set only after the URL property is set. When the URL property is set, for security reasons, [User](#User) and [Password](#Password) are immediately cleared.

**ProcessingError**: A processing error occurred in the received EDI message.If *ProcessingError* is set to "True" before invoking [CreateMDNReceipt](#as2receivercreatemdnreceipt-method), a MDN with the disposition "processed/Error: unexpected-processing-error" is returned.

**ProxyAuthorization**: The authorization string to be sent to the proxy server.This setting is used while sending an asynchronous MDN.

**ProxyPassword**: A password if Basic authentication is to be used for the proxy.This setting is used while sending an asynchronous MDN.

**ProxyPort**: Port for the proxy server (default 80).This setting is used while sending an asynchronous MDN.

**ProxyServer**: Name or IP address of a proxy server (optional).This setting is used while sending an asynchronous MDN.

**ProxyUser**: A user name if Basic authentication is to be used for the proxy.This setting is used while sending an asynchronous MDN.

**ReceiptSigningProtocol**: The protocol used to sign the outgoing MDN receipt.The protocol used to sign the outgoing [MDNReceipt](#as2receivermdnreceipt-property). The following values are supported:

|  |  |
| --- | --- |
| 0 | As Requested |
| 1 | PKCS7 |
| 2 | None |

 By default, the component will honor the request of the client, if possible. If not possible, the [MDNReceipt](#as2receivermdnreceipt-property) will not be signed, and [ParseRequest](#as2receiverparserequest-method) will throw an exception unless [ErrorProcessingFlags](#ErrorProcessingFlags) has been configured to prevent this.

If the client does not request a signature, one will not be provided by default. However, the server may provide one by setting [ReceiptSigningProtocol](#ReceiptSigningProtocol) to PKCS7 (1). If the client requests a signature, and the signature protocol is supported by the component, the request must be honored, per RFC specifications.

**RequestedMICAlgorithms**: The Message Integrity Check algorithm(s) requested by the client, if any.This property will contain the algorithm(s) requested ("sha1", "md5", "sha-256", etc.) as well as the importance ("required" or "optional") specified by the client. If multiple algorithms are specified, precedence is given to the ones on the left. Formatting is as in RFC 3335, e.g., "optional, sha1, md5".

This setting will contain an empty string if a MIC was not requested.

**RequestedSignatureProtocol**: The signing protocol requested by the client, if any.This property will contain the protocol requested ("pkcs7-signature" or "pgp-signature") as well as the importance ("required" or "optional") specified by the client, as formatted in RFC 3335, e.g., "optional, pkcs7-signature".

This setting will contain an empty string if a signature was not requested.

**RequestFile**: Reads the AS2 message from disk.This config allows for the AS2 message to be read from a file at the specified location on disk. The file can contain either just the body of the AS2 request, or it can contain both the headers and the body.

If the file includes the headers, they should be separated from the body by a double CRLF pair. If the file doesn't include the headers, they will need to be set to the [RequestHeadersString](#as2receiverrequestheadersstring-property) property.

**RequireAS2To**: Ensure that the received message is intended for the given AS2 identifier.This setting is used while processing the received message and causes an exception to be thrown if the message is not intended for the receiver specified by *RequireAS2To*.

**RequiredSignatureAlgorithms**: Specifies a list of acceptable signature algorithms.This setting specifies a comma separated list of allowed signature algorithms used in messages verified by the class. By default the setting is empty and any signature algorithm is supported. To restrict the algorithms to one or more values set this setting to a comma separated list. For instance *sha1,sha256*.

**RequireEncrypt**: Ensure that the received message is encrypted.This setting is used while processing the received message and causes an exception to be thrown if the encryption requirement is not met.

**RequireOAEP**: Ensure that the encryption padding mode is RSAES-OAEP.This setting is used while processing the received message and enforces a requirement that the [EncryptionPaddingScheme](#EncryptionPaddingScheme) be RSAES-OAEP. If the message was encrypted with any other padding scheme the class

**RequirePSS**: Ensure that the signature scheme in the received message is RSASSA-PSS.This setting is used while processing the received message and enforces a requirement that the [SenderSignatureScheme](#SenderSignatureScheme) be RSASSA-PSS. If the message was signed with any other scheme the class

**RequireSign**: Ensure that the received message is signed.This setting is used while processing the received message and causes an exception to be thrown if the signature requirement is not met.

**ResponseSubject**: The subject to be used for the MDN response.The human-readable subject to be used for the MDN response.

**SenderSignatureAlgorithm**: The algorithm used by the sender to sign the message.This will contain the name of the algorithm used to sign the incoming message. Possible values are:

- sha1
- md5
- sha-256
- sha-384
- sha-512
- sha-224

**SenderSignatureScheme**: The signature scheme used by the sender to sign the message.This setting returns the signature scheme used when the incoming message was originally signed. Possible values are:

- RSASSA-PKCS1-v1_5
- RSASSA-PSS

**SignatureType**: The MIME type of the signature (if any).This property will contain the protocol requested ("pkcs7-signature" or "pgp-signature") as well as the importance ("required" or "optional") specified by the client, as formatted in RFC 3335, e.g., "optional, pkcs7-signature".

This setting will contain an empty string if a signature was not requested.

**SignerCACert**: CA certificate used to verify signed messages.This setting specifies one or more CA certificates to be used when verifying signed messages.

To support multiple CA signing certificates, add all the certificates in the chain by prepending a '+' character to the PEM formatted certificate data. For example, the code below adds two certs to the RootCertificate property.

```csharp
  as2receiver.RootCertificate = cert1;
  as2receiver.RootCertificate = "+" + cert2;
```

**SMTPFrom**: The email address of the sender of the message. In case an asynchronous MDN is requested over SMTP, the sender; i.e., the value of "From".

**SMTPServer**: The SMTP server to be used.In case an asynchronous MDN is delivered over SMTP, the address of the server to be used to send it.

**User**: A user name if authentication is to be used.If [AuthScheme](#AuthScheme) is set to Basic, the [User](#User) and [Password](#Password) are Base64 encoded and the result is put in the [Authorization](#Authorization) configuration setting in the form "Basic [encoded-user-password]".

If [AuthScheme](#AuthScheme) is set to Digest, the [User](#User) and [Password](#Password) properties are used to respond to the HTTP Digest Authentication challenge from the server.

The [User](#User) and [Password](#Password) properties must be set only after the URL property is set. When the URL property is set, for security reasons, [User](#User) and [Password](#Password) are immediately cleared.

**WarnOnMDNFailure**: Whether to log a .wrn file instead of a .err file when MDN delivery fails.This setting controls whether to log a .wrn file or a .err file in the [LogDirectory](#as2receiverlogdirectory-property) when MDN delivery fails. When set to True and MDN delivery fails a .wrn file is created in the [LogDirectory](#as2receiverlogdirectory-property). This allows an application to treat MDN failures as warnings when monitoring log files. When set to False and MDN delivery fails a .err file is created. The default value is False.

Note: This setting is not applicable when calling [SendAsyncMDN](#as2receiversendasyncmdn-method).

### HTTP Config Settings

**AcceptEncoding**: Used to tell the server which types of content encodings the client supports.When [AllowHTTPCompression](#AllowHTTPCompression) is True, the class adds an *Accept-Encoding* header to the request being sent to the server. By default, this header's value is "gzip, deflate". This configuration setting allows you to change the value of the *Accept-Encoding* header. NOTE: The class only supports gzip and deflate decompression algorithms.

**AllowHTTPCompression**: This property enables HTTP compression for receiving data.This configuration setting enables HTTP compression for receiving data. When set to True (default), the class will accept compressed data. It then will uncompress the data it has received. The class will handle data compressed by both gzip and deflate compression algorithms.

When True, the class adds an *Accept-Encoding* header to the outgoing request. The value for this header can be controlled by the [AcceptEncoding](#AcceptEncoding) configuration setting. The default value for this header is "gzip, deflate".

The default value is True.

**AllowHTTPFallback**: Whether HTTP/2 connections are permitted to fallback to HTTP/1.1.This configuration setting controls whether HTTP/2 connections are permitted to fall back to HTTP/1.1 when the server does not support HTTP/2. This setting is applicable only when HTTPVersion is set to "2.0".

If set to True (default), the class will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False, the class if the server does not support HTTP/2.

The default value is True.

**Append**: Whether to append data to LocalFile.This configuration setting determines whether data will be appended when writing to LocalFile. When set to True, downloaded data will be appended to LocalFile. This may be used in conjunction with Range to resume a failed download. This is applicable only when LocalFile is set. The default value is False.

**Authorization**: The Authorization string to be sent to the server.If the [Authorization](#Authorization) property contains a nonempty string, an *Authorization* HTTP request header is added to the request. This header conveys Authorization information to the server.

This property is provided so that the HTTP class can be extended with other security schemes in addition to the authorization schemes already implemented by the class.

The AuthScheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time User and Password are set, they are Base64 encoded, and the result is put in the Authorization property in the form "Basic [encoded-user-password]".

**BytesTransferred**: Contains the number of bytes transferred in the response data.This configuration setting returns the raw number of bytes from the HTTP response data, before the component processes the data, whether it is chunked or compressed. This returns the same value as the Transfer event, by [BytesTransferred](#BytesTransferred).

**ChunkSize**: Specifies the chunk size in bytes when using chunked encoding.This is applicable only when [UseChunkedEncoding](#UseChunkedEncoding) is True. This setting specifies the chunk size in bytes to be used when posting data. The default value is 16384.

**CompressHTTPRequest**: Set to true to compress the body of a PUT or POST request.If set to True, the body of a *PUT* or *POST* request will be compressed into gzip format before sending the request. The "Content-Encoding" header is also added to the outgoing request.

The default value is False.

**EncodeURL**: If set to True the URL will be encoded by the class.If set to True, the URL passed to the class will be URL encoded. The default value is False.

**FollowRedirects**: Determines what happens when the server issues a redirect.This option determines what happens when the server issues a redirect. Normally, the class returns an error if the server responds with an "Object Moved" message. If this property is set to 1 (always), the new URL for the object is retrieved automatically every time.

If this property is set to 2 (Same Scheme), the new URL is retrieved automatically only if the URL Scheme is the same; otherwise, the class .

**Note:** Following the HTTP specification, unless this option is set to 1 (Always), automatic redirects will be performed only for *GET* or *HEAD* requests. Other methods potentially could change the conditions of the initial request and create security vulnerabilities.

Furthermore, if either the new URL server or port are different from the existing one, User and Password are also reset to empty, unless this property is set to 1 (Always), in which case the same credentials are used to connect to the new server.

A Redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the Redirect event is a good place to set properties related to the new connection (e.g., new authentication parameters).

The default value is 0 (Never). In this case, redirects are never followed, and the class instead.

Following are the valid options:

- 0 - Never
- 1 - Always
- 2 - Same Scheme

**GetOn302Redirect**: If set to True the class will perform a GET on the new location.The default value is False. If set to True, the class will perform a *GET* on the new location. Otherwise, it will use the same HTTP method again.

**HTTP2HeadersWithoutIndexing**: HTTP2 headers that should not update the dynamic header table with incremental indexing.HTTP/2 servers maintain a dynamic table of headers and values seen over the course of a connection. Typically, these headers are inserted into the table through incremental indexing (also known as HPACK, defined in RFC 7541). To tell the component not to use incremental indexing for certain headers, and thus not update the dynamic table, set this configuration option to a comma-delimited list of the header names.

**HTTPVersion**: The version of HTTP used by the class.This property specifies the HTTP version used by the class. Possible values are as follows:

- "1.0"
- "1.1" (default)
- "2.0"
- "3.0"

When using HTTP/2 ("2.0") or HTTP/3 ("3.0"), additional restrictions apply. Please see the following notes for details.

**HTTP/2 Notes**

When using HTTP/2, a secure Secure Sockets Layer/Transport Layer Security (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/2 will result in an error.

If the server does not support HTTP/2, the class will automatically use HTTP/1.1 instead. This is done to provide compatibility without the need for any additional settings. To see which version was used, check [NegotiatedHTTPVersion](#NegotiatedHTTPVersion) after calling a method. The [AllowHTTPFallback](#AllowHTTPFallback) setting controls whether this behavior is allowed (default) or disallowed.

**HTTP/3 Notes**

HTTP/3 is supported only in .NET and Java.

When using HTTP/3, a secure (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/3 will result in an error.

**IfModifiedSince**: A date determining the maximum age of the desired document.If this setting contains a nonempty string, an If-Modified-Since HTTP header is added to the request. The value of this header is used to make the HTTP request conditional: if the requested documented has not been modified since the time specified in the field, a copy of the document will not be returned from the server; instead, a 304 (not modified) response will be returned by the server and the component throws an exception

The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example:

```text
Sat, 29 Oct 2017 19:43:31 GMT.
```

**KeepAlive**: Determines whether the HTTP connection is closed after completion of the request.If *true*, the component will not send the *Connection: Close* header. The absence of the Connection header indicates to the server that HTTP persistent connections should be used if supported. NOTE: Not all servers support persistent connections. If *false*, the connection will be closed immediately after the server response is received.

 The default value for [KeepAlive](#KeepAlive) is *false*.

**KerberosSPN**: The Service Principal Name for the Kerberos Domain Controller.If the Service Principal Name on the Kerberos Domain Controller is not the same as the URL that you are authenticating to, the Service Principal Name should be set here.

**LogLevel**: The level of detail that is logged.This configuration setting controls the level of detail that is logged through the [Log](#as2receiverlog-event) event. Possible values are as follows:

|  |  |
| --- | --- |
| 0 (None) | No events are logged. |
| 1 (Info - default) | Informational events are logged. |
| 2 (Verbose) | Detailed data are logged. |
| 3 (Debug) | Debug data are logged. |

The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.

The value 2 (Verbose) logs additional information about the request and response.

The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).

**MaxRedirectAttempts**: Limits the number of redirects that are followed in a request.When FollowRedirects is set to any value other than frNever, the class will follow redirects until this maximum number of redirect attempts are made. The default value is 20.

**NegotiatedHTTPVersion**: The negotiated HTTP version.This configuration setting may be queried after the request is complete to indicate the HTTP version used. When HTTPVersion is set to "2.0" (if the server does not support "2.0"), then the class will fall back to using "1.1" automatically. This setting will indicate which version was used.

**OtherHeaders**: Other headers as determined by the user (optional).This configuration setting can be set to a string of headers to be appended to the HTTP request headers.

The headers must follow the format "header: value" as described in the HTTP specifications. Header lines should be separated by .

Use this configuration setting with caution. If this configuration setting contains invalid headers, HTTP requests may fail.

This configuration setting is useful for extending the functionality of the class beyond what is provided.

**ProxyAuthorization**: The authorization string to be sent to the proxy server.This is similar to the [Authorization](#Authorization) configuration setting, but is used for proxy authorization. If this configuration setting contains a nonempty string, a *Proxy-Authorization* HTTP request header is added to the request. This header conveys proxy Authorization information to the server. If ProxyUser and ProxyPassword are specified, this value is calculated using the algorithm specified by ProxyAuthScheme.

**ProxyAuthScheme**: The authorization scheme to be used for the proxy.This configuration setting is provided for use by classes that do not directly expose Proxy properties.

**ProxyPassword**: A password if authentication is to be used for the proxy.This configuration setting is provided for use by classes that do not directly expose Proxy properties.

**ProxyPort**: Port for the proxy server (default 80).This configuration setting is provided for use by classes that do not directly expose Proxy properties.

**ProxyServer**: Name or IP address of a proxy server (optional).This configuration setting is provided for use by classes that do not directly expose Proxy properties.

**ProxyUser**: A user name if authentication is to be used for the proxy.This configuration setting is provided for use by classes that do not directly expose Proxy properties.

**SentHeaders**: The full set of headers as sent by the client.This configuration setting returns the complete set of raw headers as sent by the client.

**StatusCode**: The status code of the last response from the server.This configuration setting contains the result code of the last response from the server.

**StatusLine**: The first line of the last response from the server.This setting contains the first line of the last response from the server. The format of the line will be *[HTTP version] [Result Code] [Description]*.

**TransferredData**: The contents of the last response from the server.This configuration setting contains the contents of the last response from the server.

**TransferredDataLimit**: The maximum number of incoming bytes to be stored by the class.If [TransferredDataLimit](#TransferredDataLimit) is set to 0 (default), no limits are imposed. Otherwise, this reflects the maximum number of incoming bytes that can be stored by the class.

**TransferredHeaders**: The full set of headers as received from the server.This configuration setting returns the complete set of raw headers as received from the server.

**TransferredRequest**: The full request as sent by the client.This configuration setting returns the full request as sent by the client. For performance reasons, the request is not normally saved. Set this configuration setting to ON before making a request to enable it. Following are examples of this request:

 .NET

```text
Http http = new Http();
http.Config("TransferredRequest=on");
http.PostData = "body";
http.Post("http://someserver.com");
Console.WriteLine(http.Config("TransferredRequest"));
```

 C++

```text
HTTP http;
http.Config("TransferredRequest=on");
http.SetPostData("body", 5);
http.Post("http://someserver.com");
printf("%s\r\n", http.Config("TransferredRequest"));
```

**UseChunkedEncoding**: Enables or Disables HTTP chunked encoding for transfers.If [UseChunkedEncoding](#UseChunkedEncoding) is set to True, the class will use HTTP-chunked encoding when posting, if possible. HTTP-chunked encoding allows large files to be sent in chunks instead of all at once. If set to False, the class will not use HTTP-chunked encoding. The default value is False.

NOTE: Some servers (such as the ASP.NET Development Server) may not support chunked encoding.

**UseIDNs**: Whether to encode hostnames to internationalized domain names.This configuration setting specifies whether hostnames containing non-ASCII characters are encoded to internationalized domain names. When set to True, if a hostname contains non-ASCII characters, it is encoded using Punycode to an IDN (internationalized domain name).

The default value is False and the hostname will always be used exactly as specified. NOTE: The [CodePage](#CodePage) setting must be set to a value capable of interpreting the specified host name. For instance, to specify UTF-8, set [CodePage](#CodePage) to *65001*.

**UseProxyAutoConfigURL**: Whether to use a Proxy auto-config file when attempting a connection.This configuration specifies whether the class will attempt to use the Proxy auto-config URL when establishing a connection and ProxyAutoDetect is set to *True*.

When *True* (default), the class will check for the existence of a Proxy auto-config URL, and if found, will determine the appropriate proxy to use.

**UserAgent**: Information about the user agent (browser).This is the value supplied in the HTTP User-Agent header. The default setting is "IPWorks HTTP Component - www.nsoftware.com".

Override the default with the name and version of your software.

### TCPClient Config Settings

**ConnectionTimeout**: Sets a separate timeout value for establishing a connection.When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the class will use Timeout for establishing a connection and transmitting/receiving data.

**EnableFallback**: Whether to try the other addresses the remote host resolves to when a connection attempt fails.When set to True and RemoteHost resolves to more than one address, the class will try the remaining addresses in turn if the connection to the first one fails, and only once every address has been tried. The error reported is the one from the last attempt. Use [FallbackTimeout](#FallbackTimeout) to limit the total time spent.

NOTE: Only addresses of the same IP version as the first one are tried, this setting does not fall back from IPv6 to IPv4. Selecting between IPv6 and IPv4 is done by [UseIPv6](#UseIPv6) when the host is resolved.

This setting must be set before the connection is established. The default value for this setting is False.

**FallbackTimeout**: The maximum time in milliseconds to spend on connection attempts when EnableFallback is enabled.This setting limits the total time that the class will spend on all of the connection attempts made when [EnableFallback](#EnableFallback) is enabled. The default value is 0, in which case each attempt uses the operating system's own connection timeout.

NOTE: This setting only applies when [EnableFallback](#EnableFallback) is True. It is unrelated to [ConnectionTimeout](#ConnectionTimeout), which is specified in seconds and applies to the Connected operation as a whole.

**FirewallAutoDetect**: Tells the class whether or not to automatically detect and use firewall system settings, if available.This configuration setting is provided for use by classes that do not directly expose Firewall properties.

**FirewallHost**: Name or IP address of firewall (optional).If a [FirewallHost](#FirewallHost) is given, requested connections will be authenticated through the specified firewall when connecting.

If the [FirewallHost](#FirewallHost) setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the [FirewallHost](#FirewallHost) setting is set to the corresponding address. If the search is not successful, an error is returned.

NOTE: This setting is provided for use by classes that do not directly expose Firewall properties.

**FirewallHTTPVersion**: The HTTP version to be used when connecting through a tunneling proxy.When [FirewallType](#FirewallType) is set to a tunneling proxy, this setting dictates which HTTP version is used when connecting.

**FirewallPassword**: Password to be used if authentication is to be used when connecting through the firewall.If [FirewallHost](#FirewallHost) is specified, the [FirewallUser](#FirewallUser) and [FirewallPassword](#FirewallPassword) settings are used to connect and authenticate to the given firewall. If the authentication fails, the class .

NOTE: This setting is provided for use by classes that do not directly expose Firewall properties.

**FirewallPort**: The TCP port for the FirewallHost;.The [FirewallPort](#FirewallPort) is set automatically when [FirewallType](#FirewallType) is set to a valid value.

NOTE: This configuration setting is provided for use by classes that do not directly expose Firewall properties.

**FirewallType**: Determines the type of firewall to connect through.Possible values are as follows:

|  |  |
| --- | --- |
| 0 | No firewall (default setting). |
| 1 | Connect through a tunneling proxy. [FirewallPort](#FirewallPort) is set to 80. |
| 2 | Connect through a SOCKS4 Proxy. [FirewallPort](#FirewallPort) is set to 1080. |
| 3 | Connect through a SOCKS5 Proxy. [FirewallPort](#FirewallPort) is set to 1080. |
| 10 | Connect through a SOCKS4A Proxy. [FirewallPort](#FirewallPort) is set to 1080. |

NOTE: This setting is provided for use by classes that do not directly expose Firewall properties.

**FirewallUser**: A user name if authentication is to be used connecting through a firewall.If the [FirewallHost](#FirewallHost) is specified, the [FirewallUser](#FirewallUser) and [FirewallPassword](#FirewallPassword) settings are used to connect and authenticate to the Firewall. If the authentication fails, the class .

NOTE: This setting is provided for use by classes that do not directly expose Firewall properties.

**KeepAliveInterval**: The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.When set, [TCPKeepAlive](#TCPKeepAlive) will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by [KeepAliveTime](#KeepAliveTime). If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second.

NOTE: This value is not applicable in macOS.

**KeepAliveTime**: The inactivity time in milliseconds before a TCP keep-alive packet is sent.When set, [TCPKeepAlive](#TCPKeepAlive) will automatically be set to True. By default, the operating system will determine the time a connection is idle before a Transmission Control Protocol (TCP) keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds.

**Linger**: When set to True, connections are terminated gracefully.This property controls how a connection is closed. The default is True.

In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if [LingerTime](#LingerTime) is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires.

In the second scenario, if [LingerTime](#LingerTime) is a positive value, the system will attempt to send pending data until the specified [LingerTime](#LingerTime) is reached. If this attempt fails, then the system will reset the connection.

The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the class returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes).

Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action.

**LingerTime**: Time in seconds to have the connection linger. LingerTime is the time, in seconds, the socket connection will linger. This value is 0 by default, which means it will use the default IP timeout.

**LocalHost**: The name of the local host through which connections are initiated or accepted. The [LocalHost](#as2receiverlocalhost-property) setting contains the name of the local host as obtained by the *gethostname()* system call, or if the user has assigned an IP address, the value of that address.

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

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

**LocalPort**: The port in the local host where the class binds. This configuration setting must be set before a connection is attempted. It instructs the class to bind to a specific port (or communication endpoint) in the local machine.

Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by LocalPort after the connection is established.

LocalPort cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error.

This configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems.

**MaxLineLength**: The maximum amount of data to accumulate when no EOL is found.[MaxLineLength](#MaxLineLength) is the size of an internal buffer, which holds received data while waiting for an EOL string.

If an EOL string is found in the input stream before [MaxLineLength](#MaxLineLength) bytes are received, the DataIn event is fired with the *EOL* parameter set to True, and the buffer is reset.

If no EOL is found, and [MaxLineLength](#MaxLineLength) bytes are accumulated in the buffer, the DataIn event is fired with the *EOL* parameter set to False, and the buffer is reset.

The minimum value for [MaxLineLength](#MaxLineLength) is 256 bytes. The default value is 2048 bytes.

**MaxTransferRate**: The transfer rate limit in bytes per second.This configuration setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default, this is not set and there is no limit.

**ProxyExceptionsList**: A semicolon separated list of hosts and IPs to bypass when using a proxy.This configuration setting optionally specifies a semicolon-separated list of hostnames or IP addresses to bypass when a proxy is in use. When requests are made to hosts specified in this property, the proxy will not be used. For instance:

*www.google.com;www.example.com*

**TCPKeepAlive**: Determines whether or not the keep alive socket option is enabled.If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set [KeepAliveTime](#KeepAliveTime) and [KeepAliveInterval](#KeepAliveInterval) to configure the timing of the keep-alive packets.

NOTE: This value is not applicable in Java.

**TcpNoDelay**: Whether or not to delay when sending packets. When set to True, the socket will send all data that are ready to send at once. When set to False, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm.

By default, this configuration setting is set to False.

**UseIPv6**: Whether to use IPv6.When set to *0* (default), the class will use IPv4 exclusively. When set to *1*, the class will use IPv6 exclusively. To instruct the class to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to *2*. The default value is *0*. Possible values are as follows:

|  |  |
| --- | --- |
| 0 | IPv4 only |
| 1 | IPv6 only |
| 2 | IPv6 with IPv4 fallback |

**UseNTLMv2**: Whether to use NTLM V2.When authenticating with NTLM, this setting specifies whether NTLM V2 is used. By default this value is True and NTLM V2 will be used. Set this to False to use NTLM V1.

### SSL Config Settings

**LogSSLPackets**: Controls whether SSL packets are logged when using the internal security API.When SSLProvider is set to *Internal*, this configuration setting controls whether Secure Sockets Layer (SSL) packets should be logged. By default, this configuration setting is *False*, as it is useful only for debugging purposes.

When enabled, SSL packet logs are output using the [SSLStatus](#as2receiversslstatus-event) event, which will fire each time an SSL packet is sent or received.

Enabling this configuration setting has no effect if SSLProvider is set to *Platform*.

**OpenSSLCADir**: The path to a directory containing CA certificates.This functionality is available only when the provider is OpenSSL.

The path set by this property should point to a directory containing CA certificates in PEM format. The files each contain one CA certificate. The files are looked up by the CA subject name hash value, which must hence be available. If more than one CA certificate with the same name hash value exist, the extension must be different (e.g., 9d66eef0.0, 9d66eef0.1). OpenSSL recommends the use of the c_rehash utility to create the necessary links. Please refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

**OpenSSLCAFile**: Name of the file containing the list of CA's trusted by your application.This functionality is available only when the provider is OpenSSL.

The file set by this property should contain a list of CA certificates in PEM format. The file can contain several CA certificates identified by the following sequences:

 -----BEGIN CERTIFICATE-----

 ... (CA certificate in base64 encoding) ...

 -----END CERTIFICATE-----

 Before, between, and after the certificate text is allowed, which can be used, for example, for descriptions of the certificates. Refer to the OpenSSL man page SSL_CTX_load_verify_locations(3) for details.

**OpenSSLCipherList**: A string that controls the ciphers to be used by SSL.This functionality is available only when the provider is OpenSSL.

The format of this string is described in the OpenSSL man page ciphers(1) section "CIPHER LIST FORMAT". Please refer to it for details. The default string "DEFAULT" is determined at compile time and is normally equivalent to "ALL:!ADH:RC4+RSA:+SSLv2:@STRENGTH".

**OpenSSLPrngSeedData**: The data to seed the pseudo random number generator (PRNG).This functionality is available only when the provider is OpenSSL.

By default, OpenSSL uses the device file "/dev/urandom" to seed the PRNG, and setting OpenSSLPrngSeedData is not required. If set, the string specified is used to seed the PRNG.

**ReuseSSLSession**: Determines if the SSL session is reused.

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

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

**SSLAcceptAnyServerCert**: Whether to trust any certificate presented by the server.This configuration setting disables all certificate verification when set to *True*. This configuration setting must be enabled to trust a self-signed certificate. It is not recommended to enable this configuration setting in a production environment. The default value is False.

**SSLCACerts**: A newline separated list of CA certificates to be included when performing an SSL handshake.When SSLProvider is set to *Internal*, this configuration setting specifies one or more CA certificates to be included with the [SSLCert](#as2receiversslcert-property) property. Some servers or clients require the entire chain, including CA certificates, to be presented when performing SSL authentication. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:

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

**SSLCipherStrength**: The minimum cipher strength used for bulk encryption. This minimum cipher strength is largely dependent on the security modules installed on the system. If the cipher strength specified is not supported, an error will be returned when connections are initiated.

NOTE: This configuration setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the [SSLStatus](#as2receiversslstatus-event) event.

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

When the provider is OpenSSL, [SSLCipherStrength](#SSLCipherStrength) is currently not supported. This functionality is instead made available through the [OpenSSLCipherList](#OpenSSLCipherList) configuration setting.

**SSLClientCACerts**: A newline separated list of CA certificates to use during SSL client certificate validation.This configuration setting is only applicable to server components (e.g., TCPServer) see [SSLServerCACerts](#SSLServerCACerts) for client components (e.g., TCPClient). This setting can be used to optionally specify one or more CA certificates to be used when verifying the client certificate that is presented by the client during the SSL handshake when SSLAuthenticateClients is enabled. When verifying the client's certificate, the certificates trusted by the system will be used as part of the verification process. If the client's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the client's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.

The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:

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

**SSLEnabledCipherSuites**: The cipher suite to be used in an SSL negotiation.This configuration setting enables the cipher suites to be used in SSL negotiation.

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

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

Multiple cipher suites are separated by semicolons.

Example values when SSLProvider is set to *Platform* include the following:

```text
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=CALG_AES_256");
obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES");
```

 Possible values when SSLProvider is set to *Platform* include the following:

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

 Example values when SSLProvider is set to *Internal*include the following:

```text
obj.config("SSLEnabledCipherSuites=*");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA");
obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_ECDH_RSA_WITH_AES_128_CBC_SHA");
```

 Possible values when SSLProvider is set to *Internal* include the following:

- TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_256_GCM_SHA384
- TLS_RSA_WITH_AES_128_GCM_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_256_GCM_SHA384
- TLS_DHE_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384
- TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_RSA_WITH_AES_128_GCM_SHA256
- TLS_DHE_DSS_WITH_AES_128_GCM_SHA256
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA256
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA256
- TLS_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA
- TLS_DHE_RSA_WITH_AES_256_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_256_CBC_SHA
- TLS_DHE_DSS_WITH_AES_256_CBC_SHA
- TLS_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA
- TLS_ECDH_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_RSA_WITH_AES_128_CBC_SHA
- TLS_DHE_DSS_WITH_AES_128_CBC_SHA
- TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA
- TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_3DES_EDE_CBC_SHA
- TLS_RSA_WITH_DES_CBC_SHA
- TLS_DHE_RSA_WITH_DES_CBC_SHA
- TLS_DHE_DSS_WITH_DES_CBC_SHA
- TLS_RSA_WITH_RC4_128_MD5
- TLS_RSA_WITH_RC4_128_SHA

When TLS 1.3 is negotiated (see [SSLEnabledProtocols](#SSLEnabledProtocols)), only the following cipher suites are supported:

- TLS_AES_256_GCM_SHA384
- TLS_CHACHA20_POLY1305_SHA256
- TLS_AES_128_GCM_SHA256

[SSLEnabledCipherSuites](#SSLEnabledCipherSuites) is used together with [SSLCipherStrength](#SSLCipherStrength).

**SSLEnabledProtocols**: Used to enable/disable the supported security protocols.This configuration setting is used to enable or disable the supported security protocols.

Not all supported protocols are enabled by default. The default value is *4032* for client components, and *3072* for server components. To specify a combination of enabled protocol versions set this config to the binary *OR* of one or more of the following values:

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

Note that only TLS 1.2 is enabled for server components that accept incoming connections. This adheres to industry standards to ensure a secure connection. Client components enable TLS 1.0, TLS 1.1, and TLS 1.2 by default and will negotiate the highest mutually supported version when connecting to a server, which should be TLS 1.2 in most cases.

**SSLEnabledProtocols: Transport Layer Security (TLS) 1.3 Notes:**

In the JavaScript edition, the platform implementation is used when TLS 1.3 is enabled and [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) and other similar SSL configuration settings are not supported.

**SSLEnabledProtocols: SSL2 and SSL3 Notes: **

SSL 2.0 and 3.0 are not supported by the class when the SSLProvider is set to internal. To use SSL 2.0 or SSL 3.0, the platform security API must have the protocols enabled and SSLProvider needs to be set to platform.

**SSLEnableRenegotiation**: Whether the renegotiation_info SSL extension is supported.This configuration setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API. This configuration setting is *false* by default, but it can be set to *true* to enable the extension.

This configuration setting is applicable only when SSLProvider is set to *Internal*.

**SSLIncludeCertChain**: Whether the entire certificate chain is included in the SSLServerAuthentication event.This configuration setting specifies whether the Encoded parameter of the [SSLServerAuthentication](#as2receiversslserverauthentication-event) event contains the full certificate chain. By default this value is False and only the leaf certificate will be present in the Encoded parameter of the [SSLServerAuthentication](#as2receiversslserverauthentication-event) event.

If set to True, all certificates returned by the server will be present in the Encoded parameter of the [SSLServerAuthentication](#as2receiversslserverauthentication-event) event. This includes the leaf certificate, any intermediate certificate, and the root certificate.

**SSLKeyLogFile**: The location of a file where per-session secrets are written for debugging purposes.This configuration setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes.

When set, the class will save the session secrets in the same format as the SSLKEYLOGFILE environment variable functionality used by most major browsers and tools, such as Chrome, Firefox, and cURL. This file can then be used in tools such as Wireshark to decrypt TLS traffic for debugging purposes. When writing to this file, the class will only append, it will not overwrite previous values.

NOTE: This configuration setting is applicable only when SSLProvider is set to *Internal*.

**SSLNegotiatedCipher**: Returns the negotiated cipher suite.This configuration setting returns the cipher suite negotiated during the SSL handshake.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:

```csharp
server.Config("SSLNegotiatedCipher[connId]");
```

**SSLNegotiatedCipherStrength**: Returns the negotiated cipher suite strength.This configuration setting returns the strength of the cipher suite negotiated during the SSL handshake.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:

```csharp
server.Config("SSLNegotiatedCipherStrength[connId]");
```

**SSLNegotiatedCipherSuite**: Returns the negotiated cipher suite.This configuration setting returns the cipher suite negotiated during the SSL handshake represented as a single string.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:

```csharp
server.Config("SSLNegotiatedCipherSuite[connId]");
```

**SSLNegotiatedKeyExchange**: Returns the negotiated key exchange algorithm.This configuration setting returns the key exchange algorithm negotiated during the SSL handshake.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:

```csharp
server.Config("SSLNegotiatedKeyExchange[connId]");
```

**SSLNegotiatedKeyExchangeStrength**: Returns the negotiated key exchange algorithm strength.This configuration setting returns the strength of the key exchange algorithm negotiated during the SSL handshake.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:

```csharp
server.Config("SSLNegotiatedKeyExchangeStrength[connId]");
```

**SSLNegotiatedVersion**: Returns the negotiated protocol version.This configuration setting returns the protocol version negotiated during the SSL handshake.

NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example:

```csharp
server.Config("SSLNegotiatedVersion[connId]");
```

**SSLSecurityFlags**: Flags that control certificate verification.The following flags are defined (specified in hexadecimal notation). They can be ORed together to exclude multiple conditions:

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

This functionality is currently not available when the provider is OpenSSL.

**SSLServerCACerts**: A newline separated list of CA certificates to use during SSL server certificate validation.This configuration setting is only used by client components (e.g., TCPClient) see [SSLClientCACerts](#SSLClientCACerts) for server components (e.g., TCPServer). This configuration setting can be used to optionally specify one or more CA certificates to be used when connecting to the server and verifying the server certificate. When verifying the server's certificate, the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.

The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:

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

**TLS12SignatureAlgorithms**: Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.This configuration setting specifies the allowed server certificate signature algorithms when SSLProvider is set to *Internal* and [SSLEnabledProtocols](#SSLEnabledProtocols) is set to allow TLS 1.2.

When specified the class will verify that the server certificate signature algorithm is among the values specified in this configuration setting. If the server certificate signature algorithm is unsupported, the class .

The format of this value is a comma-separated list of hash-signature combinations. For instance:

```csharp
component.SSLProvider = TCPClientSSLProviders.sslpInternal;
component.Config("SSLEnabledProtocols=3072"); //TLS 1.2
component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa");
```

 The default value for this configuration setting is *sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa*.

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

**TLS12SupportedGroups**: The supported groups for ECC.This configuration setting specifies a comma-separated list of named groups used in TLS 1.2 for ECC.

The default value is *ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1*.

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

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

**TLS13KeyShareGroups**: The groups for which to pregenerate key shares.This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional roundtrip during the handshake if the group is supported by the server.

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

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

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

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

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

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

**TLS13SignatureAlgorithms**: The allowed certificate signature algorithms.This configuration setting holds a comma-separated list of allowed signature algorithms. Possible values include the following:

- "ed25519" (default)
- "ed448" (default)
- "ecdsa_secp256r1_sha256" (default)
- "ecdsa_secp384r1_sha384" (default)
- "ecdsa_secp521r1_sha512" (default)
- "rsa_pkcs1_sha256" (default)
- "rsa_pkcs1_sha384" (default)
- "rsa_pkcs1_sha512" (default)
- "rsa_pss_sha256" (default)
- "rsa_pss_sha384" (default)
- "rsa_pss_sha512" (default)

 The default value is *rsa_pss_sha256,rsa_pss_sha384,rsa_pss_sha512,rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512,ecdsa_secp256r1_sha256,ecdsa_secp384r1_sha384,ecdsa_secp521r1_sha512,ed25519,ed448*. This configuration setting is applicable only when [SSLEnabledProtocols](#SSLEnabledProtocols) includes TLS 1.3.

**TLS13SupportedGroups**: The supported groups for (EC)DHE key exchange.This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. This configuration setting should be modified only if there is a specific reason to do so.

The default value is *ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192,mlkem_512,mlkem_768,mlkem_1024,x25519_mlkem_768,secp256r1_mlkem_768*

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

- "ecdhe_x25519" (default)
- "ecdhe_x448" (default)
- "ecdhe_secp256r1" (default)
- "ecdhe_secp384r1" (default)
- "ecdhe_secp521r1" (default)
- "ffdhe_2048" (default)
- "ffdhe_3072" (default)
- "ffdhe_4096" (default)
- "ffdhe_6144" (default)
- "ffdhe_8192" (default)
- "mlkem_512" (default)
- "mlkem_768" (default)
- "mlkem_1024" (default)
- "x25519_mlkem_768" (default)
- "secp256r1_mlkem_768" (default)

Post-quantum algorithms (*mlkem_512,mlkem_768,mlkem_1024,x25519_mlkem_768,secp256r1_mlkem_768*) in our components rely on the operating system's underlying cryptographic primitives. The following platforms are currently supported:

-  Windows Server 2025
-  Windows 11 24H2
-  Windows 11 25H2

### Socket Config Settings

**AbsoluteTimeout**: Determines whether timeouts are inactivity timeouts or absolute timeouts.If [AbsoluteTimeout](#AbsoluteTimeout) is set to True, any method that does not complete within Timeout seconds will be aborted. By default, *AbsoluteTimeout* is False, and the timeout is an inactivity timeout.

NOTE: This option is not valid for User Datagram Protocol (UDP) ports.

**FirewallData**: Used to send extra data to the firewall.When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g., headers for custom authentication schemes).

**InBufferSize**: The size in bytes of the incoming queue of the socket.This is the size of an internal queue in the Transmission Control Protocol (TCP)/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. In some cases, increasing the value of the *InBufferSize* setting can provide significant improvements in performance.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the *InBufferSize* reverts to its defined size. The same happens if you attempt to make it too large or too small.

**OutBufferSize**: The size in bytes of the outgoing queue of the socket.This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. In some cases, increasing the value of the *OutBufferSize* setting can provide significant improvements in performance.

Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the class is activated the *OutBufferSize* reverts to its defined size. The same happens if you attempt to make it too large or too small.

### Base Config Settings

**BuildInfo**: Information about the product's build.When queried, this setting will return a string containing information about the product's build.

**CodePage**: The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:

|  |  |
| --- | --- |
| Identifier | Name |
| 037 | IBM EBCDIC - U.S./Canada |
| 437 | OEM - United States |
| 500 | IBM EBCDIC - International |
| 708 | Arabic - ASMO 708 |
| 709 | Arabic - ASMO 449+, BCON V4 |
| 710 | Arabic - Transparent Arabic |
| 720 | Arabic - Transparent ASMO |
| 737 | OEM - Greek (formerly 437G) |
| 775 | OEM - Baltic |
| 850 | OEM - Multilingual Latin I |
| 852 | OEM - Latin II |
| 855 | OEM - Cyrillic (primarily Russian) |
| 857 | OEM - Turkish |
| 858 | OEM - Multilingual Latin I + Euro symbol |
| 860 | OEM - Portuguese |
| 861 | OEM - Icelandic |
| 862 | OEM - Hebrew |
| 863 | OEM - Canadian-French |
| 864 | OEM - Arabic |
| 865 | OEM - Nordic |
| 866 | OEM - Russian |
| 869 | OEM - Modern Greek |
| 870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) |
| 874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) |
| 875 | IBM EBCDIC - Modern Greek |
| 932 | ANSI/OEM - Japanese, Shift-JIS |
| 936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) |
| 949 | ANSI/OEM - Korean (Unified Hangul Code) |
| 950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) |
| 1026 | IBM EBCDIC - Turkish (Latin-5) |
| 1047 | IBM EBCDIC - Latin 1/Open System |
| 1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) |
| 1141 | IBM EBCDIC - Germany (20273 + Euro symbol) |
| 1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) |
| 1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) |
| 1144 | IBM EBCDIC - Italy (20280 + Euro symbol) |
| 1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) |
| 1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) |
| 1147 | IBM EBCDIC - France (20297 + Euro symbol) |
| 1148 | IBM EBCDIC - International (500 + Euro symbol) |
| 1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) |
| 1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) |
| 1201 | Unicode UCS-2 Big-Endian |
| 1250 | ANSI - Central European |
| 1251 | ANSI - Cyrillic |
| 1252 | ANSI - Latin I |
| 1253 | ANSI - Greek |
| 1254 | ANSI - Turkish |
| 1255 | ANSI - Hebrew |
| 1256 | ANSI - Arabic |
| 1257 | ANSI - Baltic |
| 1258 | ANSI/OEM - Vietnamese |
| 1361 | Korean (Johab) |
| 10000 | MAC - Roman |
| 10001 | MAC - Japanese |
| 10002 | MAC - Traditional Chinese (Big5) |
| 10003 | MAC - Korean |
| 10004 | MAC - Arabic |
| 10005 | MAC - Hebrew |
| 10006 | MAC - Greek I |
| 10007 | MAC - Cyrillic |
| 10008 | MAC - Simplified Chinese (GB 2312) |
| 10010 | MAC - Romania |
| 10017 | MAC - Ukraine |
| 10021 | MAC - Thai |
| 10029 | MAC - Latin II |
| 10079 | MAC - Icelandic |
| 10081 | MAC - Turkish |
| 10082 | MAC - Croatia |
| 12000 | Unicode UCS-4 Little-Endian |
| 12001 | Unicode UCS-4 Big-Endian |
| 20000 | CNS - Taiwan |
| 20001 | TCA - Taiwan |
| 20002 | Eten - Taiwan |
| 20003 | IBM5550 - Taiwan |
| 20004 | TeleText - Taiwan |
| 20005 | Wang - Taiwan |
| 20105 | IA5 IRV International Alphabet No. 5 (7-bit) |
| 20106 | IA5 German (7-bit) |
| 20107 | IA5 Swedish (7-bit) |
| 20108 | IA5 Norwegian (7-bit) |
| 20127 | US-ASCII (7-bit) |
| 20261 | T.61 |
| 20269 | ISO 6937 Non-Spacing Accent |
| 20273 | IBM EBCDIC - Germany |
| 20277 | IBM EBCDIC - Denmark/Norway |
| 20278 | IBM EBCDIC - Finland/Sweden |
| 20280 | IBM EBCDIC - Italy |
| 20284 | IBM EBCDIC - Latin America/Spain |
| 20285 | IBM EBCDIC - United Kingdom |
| 20290 | IBM EBCDIC - Japanese Katakana Extended |
| 20297 | IBM EBCDIC - France |
| 20420 | IBM EBCDIC - Arabic |
| 20423 | IBM EBCDIC - Greek |
| 20424 | IBM EBCDIC - Hebrew |
| 20833 | IBM EBCDIC - Korean Extended |
| 20838 | IBM EBCDIC - Thai |
| 20866 | Russian - KOI8-R |
| 20871 | IBM EBCDIC - Icelandic |
| 20880 | IBM EBCDIC - Cyrillic (Russian) |
| 20905 | IBM EBCDIC - Turkish |
| 20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) |
| 20932 | JIS X 0208-1990 & 0121-1990 |
| 20936 | Simplified Chinese (GB2312) |
| 21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) |
| 21027 | Extended Alpha Lowercase |
| 21866 | Ukrainian (KOI8-U) |
| 28591 | ISO 8859-1 Latin I |
| 28592 | ISO 8859-2 Central Europe |
| 28593 | ISO 8859-3 Latin 3 |
| 28594 | ISO 8859-4 Baltic |
| 28595 | ISO 8859-5 Cyrillic |
| 28596 | ISO 8859-6 Arabic |
| 28597 | ISO 8859-7 Greek |
| 28598 | ISO 8859-8 Hebrew |
| 28599 | ISO 8859-9 Latin 5 |
| 28605 | ISO 8859-15 Latin 9 |
| 29001 | Europa 3 |
| 38598 | ISO 8859-8 Hebrew |
| 50220 | ISO 2022 Japanese with no halfwidth Katakana |
| 50221 | ISO 2022 Japanese with halfwidth Katakana |
| 50222 | ISO 2022 Japanese JIS X 0201-1989 |
| 50225 | ISO 2022 Korean |
| 50227 | ISO 2022 Simplified Chinese |
| 50229 | ISO 2022 Traditional Chinese |
| 50930 | Japanese (Katakana) Extended |
| 50931 | US/Canada and Japanese |
| 50933 | Korean Extended and Korean |
| 50935 | Simplified Chinese Extended and Simplified Chinese |
| 50936 | Simplified Chinese |
| 50937 | US/Canada and Traditional Chinese |
| 50939 | Japanese (Latin) Extended and Japanese |
| 51932 | EUC - Japanese |
| 51936 | EUC - Simplified Chinese |
| 51949 | EUC - Korean |
| 51950 | EUC - Traditional Chinese |
| 52936 | HZ-GB2312 Simplified Chinese |
| 54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) |
| 57002 | ISCII Devanagari |
| 57003 | ISCII Bengali |
| 57004 | ISCII Tamil |
| 57005 | ISCII Telugu |
| 57006 | ISCII Assamese |
| 57007 | ISCII Oriya |
| 57008 | ISCII Kannada |
| 57009 | ISCII Malayalam |
| 57010 | ISCII Gujarati |
| 57011 | ISCII Punjabi |
| 65000 | Unicode UTF-7 |
| 65001 | Unicode UTF-8 |

 The following is a list of valid code page identifiers for Mac OS only:

|  |  |
| --- | --- |
| Identifier | Name |
| 1 | ASCII |
| 2 | NEXTSTEP |
| 3 | JapaneseEUC |
| 4 | UTF8 |
| 5 | ISOLatin1 |
| 6 | Symbol |
| 7 | NonLossyASCII |
| 8 | ShiftJIS |
| 9 | ISOLatin2 |
| 10 | Unicode |
| 11 | WindowsCP1251 |
| 12 | WindowsCP1252 |
| 13 | WindowsCP1253 |
| 14 | WindowsCP1254 |
| 15 | WindowsCP1250 |
| 21 | ISO2022JP |
| 30 | MacOSRoman |
| 10 | UTF16String |
| 0x90000100 | UTF16BigEndian |
| 0x94000100 | UTF16LittleEndian |
| 0x8c000100 | UTF32String |
| 0x98000100 | UTF32BigEndian |
| 0x9c000100 | UTF32LittleEndian |
| 65536 | Proprietary |

**LicenseInfo**: Information about the current license.When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:

- Product: The product the license is for.
- Product Key: The key the license was generated from.
- License Source: Where the license was found (e.g., RuntimeLicense, License File).
- License Type: The type of license installed (e.g., Royalty Free, Single Server).
- Last Valid Build: The last valid build number for which the license will work.

**MaskSensitiveData**: Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to *true* to mask sensitive data. The default is *true*.

**UseInternalSecurityAPI**: Whether or not to use the system security libraries or an internal implementation. When set to *false*, the class will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this configuration setting to *true* tells the class to use the internal implementation instead of using the system security libraries.

 This setting is set to *false* by default on all platforms.

# Trappable Errors (*class *ipworksedi.[as2receiver](#as2receiver-class))

 *Note: The starred errors may be ignored by configuring the [ErrorProcessingFlags](#ErrorProcessingFlags) and [ErrorReportingFlags](#ErrorReportingFlags) of the class.*

### AS2Receiver Errors

|  |  |
| --- | --- |
| 701 | Unable to write log file. |
| 702 | Unable to read HTTP headers. |
| 703 | Unable to read HTTP message body. |
| 704 | No message to process. |
| 705 | No response to send. |
| 711 | The incoming message was encrypted with an unknown protocol. |
| 712 | Unable to decrypt message. |
| 713 | Unable to decompress message. |
| 721 | An HTTP environment is required to perform this operation. |
| 731 | *Unable to authenticate the sender. |
| 732 | *Unable to verify content integrity. |
| 733 | *Unsupported signature type was requested. |
| 734 | *Unsupported MIC algorithm(s) were requested. |
| 741 | You must specify an [Certificate](#as2receivercertificate-property). |
| 751 | I/O error writing log file. |
| 761 | Unable to mail asynchronous MDN. |
| 762 | Unable to post asynchronous MDN. |
| 801 | System error (details follow). |

### SMIME Errors

|  |  |
| --- | --- |
| 10191 | Invalid index (RecipientIndex). |
| 10192 | Message decoding error (code). |
| 10193 | Unexpected message type. |
| 10194 | Unsupported hashing/signing algorithm. |
| 10195 | The message does not have any signers. |
| 10196 | The message signature could not be verified. |
| 10197 | Could not locate a suitable decryption certificate. |
| 10198 | The signer certificate could not be found. |
| 10199 | No signing certificate was supplied for signing the message. |
| 10201 | The specified certificate was not the one required. |
| 10202 | The specified certificate could not be found. |
| 10221 | Could not acquire CSP. |
| 10222 | Type validation error. |
| 10223 | Unsupported key size. |
| 10224 | Unrecognized Content-Type object identifier. |
| 10225 | Unrecognized public key format. |
| 10226 | No choices specified. |
| 10228 | Must specify output stream. |
| 10280 | Invalid part index. |
| 10281 | Unknown MIME type. |
| 10283 | No MIME-boundary found. |
| 10280 | Error decoding certificate. |