AS2Receiver Class

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

class 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 read_request. This will populate as2_from and as2_to, and based on this information, you may then set the appropriate certificates. You may specify your certificate with the certificate property, and your trading partner's (signing) certificate with the signer_cert property.

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

The mdn_receipt may be returned by invoking send_response. 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 log_directory prior to invoking process_request. 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 read_request before processing the request.

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

ADVANCED FUNCTIONALITY

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

Parsing Incoming Data

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

After invoking read_request, the as2_from, as2_to, and message_id properties will contain the appropriate values. mdn_to will contain a nonempty string if an MDN is requested; RequestedSignatureProtocol, RequestedMICAlgorithms, and receipt_delivery_option provide more information about the client's request. Finally, request_headers contains the complete list of HTTP/AS2 headers.

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

parse_request will populate ediedi_type and edi_data.

Error Handling

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

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

Creating an MDN-based Receipt

An MDN-based receipt may be created by invoking create_mdn_receipt. Regardless of the success or failure of process_request, the receipt may be created as specified in RFCs 3335 and 2298. If no errors occurred when process_request 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 process_request and return the receipt in this case as well.

The mdn_receipt 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 create_mdn_receipt and customized further by setting the parameters to create_mdn_receipt.

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 mdn_receipt is regenerated.

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

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

Additional Server-Side Functionality

When used in a server environment such as ASP.NET, the class may be used to interface directly with the underlying HTTP context. If request is not set by the user, parse_request and process_request will first get the request from the underlying HTTP environment, if possible. send_response 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:

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

as2_fromThe AS2 Identifier of the sending system.
as2_toThe AS2 Identifier of the receiving system.
attachment_countThe number of records in the Attachment arrays.
attachment_content_typeThe MIME content-type of this ediattachment .
attachment_dataThis property contains the attachment data.
attachment_filenameThe file name of the attachment.
attachment_headersThe class fills out Headers each time any of the other properties for that ediattachment are changed.
attachment_nameName is the final name to be associated with the contents of either the Data or Filename properties.
cem_countThe number of records in the CEM arrays.
cem_acceptedWhether the CEM request is accepted.
cem_cert_idA user defined identifier for the certificate.
cem_cert_issuerThis property holds the issuer of the certificate.
cem_cert_serial_numberThis property holds the serial number of the certificate.
cem_cert_storeThe name of the certificate store for the certificate.
cem_cert_store_passwordIf 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.
cem_cert_store_typeThe type of certificate store for this certificate.
cem_cert_subjectThe subject of the certificate.
cem_cert_usageThis property defines which usages are applicable to the certificate.
cem_rejection_reasonIf Accepted is False this property specifies the reason a request was rejected.
cem_respond_by_dateThis property specifies the date by which the other party should respond.
cem_response_urlThis property defines the URL to which the response should be sent.
cert_encodedThis is the certificate (PEM/base64 encoded).
cert_storeThis is the name of the certificate store for the client certificate.
cert_store_passwordIf the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
cert_store_typeThis is the type of certificate store for this certificate.
cert_subjectThis is the subject of the certificate used for client authentication.
compression_formatThe compression format used on the incoming message.
edi_dataThis property contains the EDI payload of the transmission.
edi_typeThe Content-Type of the EDI message.
edi_filenameIn a sender, if Filename is specified, the file specified will be used for the EDI payload of the transmission.
edi_nameName is the final name to be associated with the contents of either the Data or FileName properties.
firewall_auto_detectThis property tells the class whether or not to automatically detect and use firewall system settings, if available.
firewall_typeThis property determines the type of firewall to connect through.
firewall_hostThis property contains the name or IP address of firewall (optional).
firewall_passwordThis property contains a password if authentication is to be used when connecting through the firewall.
firewall_portThis property contains the transmission control protocol (TCP) port for the firewall Host .
firewall_userThis property contains a user name if authentication is to be used connecting through a firewall.
incoming_directoryThe directory to be used to store incoming messages.
local_hostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
log_directoryThe path to a directory for logging.
log_fileThe log file written.
mdn_receipt_contentThis contains the entire content of the MDN Receipt.
mdn_receipt_header_countThe number of headers in the MDN.
mdn_receipt_header_fieldThe property name of the MDN header currently selected by HeaderIndex .
mdn_receipt_header_indexWhich MDN header is currently selected to populate HeaderField and HeaderValue .
mdn_receipt_headersHeaders contains all of the headers of the AS2 MDN Receipt as a single string.
mdn_receipt_header_valueThe value of the MDN header currently selected by HeaderIndex .
mdn_receipt_mdnMDN will contain the entire machine readable text of the Message Disposition Notification in the receipt.
mdn_receipt_messageThe human-readable portion of the MDN receipt.
mdn_receipt_mic_valueThe Message Integrity Check(s) (one-way hash) of the original EDI message.
mdn_receipt_signing_protocolThis property contains the MIME type of the signature used, if any (i.
mdn_toThe recipient for the Message Disposition Notification (MDN).
message_idThe message ID of the incoming message.
receipt_delivery_optionA URL indicating how the receipt is to be delivered.
requestThe HTTP request to be processed.
request_header_countThe number of records in the RequestHeader arrays.
request_header_fieldThis property contains the name of the HTTP header (this is the same case as it is delivered).
request_header_valueThis property contains the header contents.
request_headers_stringThe HTTP headers in the AS2 request.
restart_directoryThe directory to log cached files when using AS2 restart functionality.
rollover_cert_encodedThis is the certificate (PEM/base64 encoded).
rollover_cert_storeThis is the name of the certificate store for the client certificate.
rollover_cert_store_passwordIf the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
rollover_cert_store_typeThis is the type of certificate store for this certificate.
rollover_cert_subjectThis is the subject of the certificate used for client authentication.
scan_resultThe result of invoking ParseRequest .
signer_cert_encodedThis is the certificate (PEM/base64 encoded).
signer_cert_storeThis is the name of the certificate store for the client certificate.
signer_cert_store_passwordIf the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
signer_cert_store_typeThis is the type of certificate store for this certificate.
signer_cert_subjectThis is the subject of the certificate used for client authentication.
ssl_accept_server_cert_encodedThis is the certificate (PEM/base64 encoded).
ssl_accept_server_cert_storeThis is the name of the certificate store for the client certificate.
ssl_accept_server_cert_store_passwordIf the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
ssl_accept_server_cert_store_typeThis is the type of certificate store for this certificate.
ssl_accept_server_cert_subjectThis is the subject of the certificate used for client authentication.
ssl_cert_encodedThis is the certificate (PEM/base64 encoded).
ssl_cert_storeThis is the name of the certificate store for the client certificate.
ssl_cert_store_passwordIf the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
ssl_cert_store_typeThis is the type of certificate store for this certificate.
ssl_cert_subjectThis is the subject of the certificate used for client authentication.
use_pssThis 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.

ack_requestOptional. Acknowledges the incoming request.
configSets or retrieves a configuration setting.
create_mdn_receiptCreates MDNReceipt .
parse_requestParses the EDI message and determines the EDIData .
process_requestProcesses the EDI data, and generates the receipt.
process_restart_requestProcesses the AS2 restart request, and sends a response to the client.
read_requestReads the AS2 request from the HTTP session.
resetResets the state of the control.
send_async_mdnSends the MDNReceipt to the RemoteURL specified.
send_responseIn a server environment, responds to the requesting client with MDNReceipt .
set_tp_infoA 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.

on_cem_requestFired when a Certificate Exchange Messaging (CEM) request is received.
on_cem_responseFired when a Certificate Exchange Messaging (CEM) response is received.
on_edi_data_infoFired when processing an incoming message.
on_errorInformation about errors during data delivery.
on_logFired with log information while processing a message.
on_recipient_infoFired for each recipient certificate of the encrypted message.
on_signer_cert_infoThis event is fired during verification of the signed message.
on_ssl_server_authenticationFor asynchronous HTTPS MDNs, fired after the server presents its certificate.
on_ssl_statusShows the progress of the secure connection.

Config Settings


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

AcceptAnySignerCertUsed to accept trust any signing certificate unconditionally.
AS2VersionIncomingThe version of AS2 that was used in the incoming message.
AS2VersionOutgoingThe version of AS2 to be used in the outgoing message.
AuthorizationThe Authorization string to be sent to the server.
AuthSchemeThe authorization scheme to be used when server authorization is to be performed.
CEMCertDirSpecifies the directory where certificates are saved when receiving a CEM request.
CloseStreamAfterProcessingSpecifies whether or not the OutputStream should be closed after processing.
DecodeTempDirectoryThe temp directory the class will use to decode messages.
DetectDuplicatesWhether to detect duplicate messages.
EncryptionAlgorithmThe encryption algorithm used to encrypt the incoming data.
EncryptionPaddingSchemeThe encryption padding scheme used when encrypting the incoming data.
EncryptionTypeThe MIME type of the encrypted data.
ErrorProcessingFlagsFlags controlling how errors affect ProcessRequest.
ErrorReportingFlagsFlags controlling how errors affect the MDNReceipt.
FilenameSourceThe location from which to read the filename.
IgnoreLoggingErrorsWhether to ignore errors that occur when writing to the log.
InvalidFilenameMDNActionInstructs MDN disposition on invalid and duplicate filenames.
LogDebugWhether to log debug data.
LogFilenameThe base name of the log file.
LogOptionsThe information to be written to log files.
MaxPartsThe maximum number of MIME parts to process.
MDNDispositionOverrides the automatically calculated MDN disposition.
MDNMICAlgorithmThe algorithm used to sign the outgoing MDN.
MDNReportingUAThe name of the user agent performing the disposition.
MDNSendingModeThe level of end user interaction involved in sending the MDN.
MDNWarningA warning to appear in the MDN.
NormalizeMICWhether to normalize line endings before calculating the MIC.
OverwriteCEMCertsWhether existing CEM certificates are overwritten when a duplicate is received.
PasswordA password if authentication is to be used.
ProcessingErrorA processing error occurred in the received EDI message.
ProxyAuthorizationThe authorization string to be sent to the proxy server.
ProxyPasswordA password if Basic authentication is to be used for the proxy.
ProxyPortPort for the proxy server (default 80).
ProxyServerName or IP address of a proxy server (optional).
ProxyUserA user name if Basic authentication is to be used for the proxy.
ReceiptSigningProtocolThe protocol used to sign the outgoing MDN receipt.
RequestedMICAlgorithmsThe Message Integrity Check algorithm(s) requested by the client, if any.
RequestedSignatureProtocolThe signing protocol requested by the client, if any.
RequestFileReads the AS2 message from disk.
RequireAS2ToEnsure that the received message is intended for the given AS2 identifier.
RequiredSignatureAlgorithmsSpecifies a list of acceptable signature algorithms.
RequireEncryptEnsure that the received message is encrypted.
RequireOAEPEnsure that the encryption padding mode is RSAES-OAEP.
RequirePSSEnsure that the signature scheme in the received message is RSASSA-PSS.
RequireSignEnsure that the received message is signed.
ResponseSubjectThe subject to be used for the MDN response.
SenderSignatureAlgorithmThe algorithm used by the sender to sign the message.
SenderSignatureSchemeThe signature scheme used by the sender to sign the message.
SignatureTypeThe MIME type of the signature (if any).
SignerCACertCA certificate used to verify signed messages.
SMTPFromThe email address of the sender of the message.
SMTPServerThe SMTP server to be used.
UserA user name if authentication is to be used.
WarnOnMDNFailureWhether to log a .wrn file instead of a .err file when MDN delivery fails.
AcceptEncodingUsed to tell the server which types of content encodings the client supports.
AllowHTTPCompressionThis property enables HTTP compression for receiving data.
AllowHTTPFallbackWhether HTTP/2 connections are permitted to fallback to HTTP/1.1.
AppendWhether to append data to LocalFile.
AuthorizationThe Authorization string to be sent to the server.
BytesTransferredContains the number of bytes transferred in the response data.
ChunkSizeSpecifies the chunk size in bytes when using chunked encoding.
CompressHTTPRequestSet to true to compress the body of a PUT or POST request.
EncodeURLIf set to True the URL will be encoded by the class.
FollowRedirectsDetermines what happens when the server issues a redirect.
GetOn302RedirectIf set to True the class will perform a GET on the new location.
HTTP2HeadersWithoutIndexingHTTP2 headers that should not update the dynamic header table with incremental indexing.
HTTPVersionThe version of HTTP used by the class.
IfModifiedSinceA date determining the maximum age of the desired document.
KeepAliveDetermines whether the HTTP connection is closed after completion of the request.
KerberosSPNThe Service Principal Name for the Kerberos Domain Controller.
LogLevelThe level of detail that is logged.
MaxRedirectAttemptsLimits the number of redirects that are followed in a request.
NegotiatedHTTPVersionThe negotiated HTTP version.
OtherHeadersOther headers as determined by the user (optional).
ProxyAuthorizationThe authorization string to be sent to the proxy server.
ProxyAuthSchemeThe authorization scheme to be used for the proxy.
ProxyPasswordA password if authentication is to be used for the proxy.
ProxyPortPort for the proxy server (default 80).
ProxyServerName or IP address of a proxy server (optional).
ProxyUserA user name if authentication is to be used for the proxy.
SentHeadersThe full set of headers as sent by the client.
StatusCodeThe status code of the last response from the server.
StatusLineThe first line of the last response from the server.
TransferredDataThe contents of the last response from the server.
TransferredDataLimitThe maximum number of incoming bytes to be stored by the class.
TransferredHeadersThe full set of headers as received from the server.
TransferredRequestThe full request as sent by the client.
UseChunkedEncodingEnables or Disables HTTP chunked encoding for transfers.
UseIDNsWhether to encode hostnames to internationalized domain names.
UsePlatformHTTPClientWhether or not to use the platform HTTP client.
UseProxyAutoConfigURLWhether to use a Proxy auto-config file when attempting a connection.
UserAgentInformation about the user agent (browser).
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the class whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe port in the local host where the class binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
ProxyExceptionsListA semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
TcpNoDelayWhether or not to delay when sending packets.
UseIPv6Whether to use IPv6.
LogSSLPacketsControls whether SSL packets are logged when using the internal security API.
OpenSSLCADirThe path to a directory containing CA certificates.
OpenSSLCAFileName of the file containing the list of CA's trusted by your application.
OpenSSLCipherListA string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedDataThe data to seed the pseudo random number generator (PRNG).
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCACertFilePathsThe paths to CA certificate files on Unix/Linux.
SSLCACertsA newline separated list of CA certificate to use during SSL client authentication.
SSLCheckCRLWhether to check the Certificate Revocation List for the server certificate.
SSLCheckOCSPWhether to use OCSP to check the status of the server certificate.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLEnableRenegotiationWhether the renegotiation_info SSL extension is supported.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLKeyLogFileThe location of a file where per-session secrets are written for debugging purposes.
SSLNegotiatedCipherReturns the negotiated cipher suite.
SSLNegotiatedCipherStrengthReturns the negotiated cipher suite strength.
SSLNegotiatedCipherSuiteReturns the negotiated cipher suite.
SSLNegotiatedKeyExchangeReturns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrengthReturns the negotiated key exchange algorithm strength.
SSLNegotiatedVersionReturns the negotiated protocol version.
SSLSecurityFlagsFlags that control certificate verification.
SSLServerCACertsA newline separated list of CA certificate to use during SSL server certificate validation.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.
TLS12SupportedGroupsThe supported groups for ECC.
TLS13KeyShareGroupsThe groups for which to pregenerate key shares.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
TLS13SupportedGroupsThe supported groups for (EC)DHE key exchange.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
MaskSensitiveWhether sensitive data is masked in log messages.
ProcessIdleEventsWhether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillisThe length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseFIPSCompliantAPITells the class whether or not to use FIPS certified APIs.
UseInternalSecurityAPITells the class whether or not to use the system security libraries or an internal implementation.

as2_from Property

The AS2 Identifier of the sending system.

Syntax

def get_as2_from() -> str: ...

as2_from = property(get_as2_from, None)

Default Value

""

Remarks

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

This property is read-only.

as2_to Property

The AS2 Identifier of the receiving system.

Syntax

def get_as2_to() -> str: ...

as2_to = property(get_as2_to, None)

Default Value

""

Remarks

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

This property is read-only.

attachment_count Property

The number of records in the Attachment arrays.

Syntax

def get_attachment_count() -> int: ...

attachment_count = property(get_attachment_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

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

This property is read-only.

attachment_content_type Property

The MIME content-type of this ediattachment .

Syntax

def get_attachment_content_type(attachment_index: int) -> str: ...

Default Value

""

Remarks

The MIME content-type of this EDIAttachment.

The attachment_index parameter specifies the index of the item in the array. The size of the array is controlled by the attachment_count property.

This property is read-only.

attachment_data Property

This property contains the attachment data.

Syntax

def get_attachment_data(attachment_index: int) -> bytes: ...

Default Value

""

Remarks

This property contains the attachment data.

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

The attachment_index parameter specifies the index of the item in the array. The size of the array is controlled by the attachment_count property.

This property is read-only.

attachment_filename Property

The file name of the attachment.

Syntax

def get_attachment_filename(attachment_index: int) -> str: ...

Default Value

""

Remarks

The file name of the attachment. If incoming_directory 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 attachment_headers.

The attachment_index parameter specifies the index of the item in the array. The size of the array is controlled by the attachment_count property.

This property is read-only.

attachment_headers Property

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

Syntax

def get_attachment_headers(attachment_index: int) -> str: ...

Default Value

""

Remarks

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

The attachment_index parameter specifies the index of the item in the array. The size of the array is controlled by the attachment_count property.

This property is read-only.

attachment_name Property

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

Syntax

def get_attachment_name(attachment_index: int) -> str: ...

Default Value

""

Remarks

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

The attachment_index parameter specifies the index of the item in the array. The size of the array is controlled by the attachment_count property.

This property is read-only.

cem_count Property

The number of records in the CEM arrays.

Syntax

def get_cem_count() -> int: ...
def set_cem_count(value: int) -> None: ...

cem_count = property(get_cem_count, set_cem_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

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

cem_accepted Property

Whether the CEM request is accepted.

Syntax

def get_cem_accepted(cem_index: int) -> bool: ...
def set_cem_accepted(cem_index: int, value: bool) -> None: ...

Default Value

FALSE

Remarks

Whether the CEM request is accepted.

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

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

The cem_index parameter specifies the index of the item in the array. The size of the array is controlled by the cem_count property.

cem_cert_id Property

A user defined identifier for the certificate.

Syntax

def get_cem_cert_id(cem_index: int) -> str: ...
def set_cem_cert_id(cem_index: int, value: str) -> None: ...

Default Value

""

Remarks

A user defined identifier for the certificate.

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

This property may be set before calling send_cem_request or send_cem_response from AS2Sender.

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

The cem_index parameter specifies the index of the item in the array. The size of the array is controlled by the cem_count property.

cem_cert_issuer Property

This property holds the issuer of the certificate.

Syntax

def get_cem_cert_issuer(cem_index: int) -> str: ...
def set_cem_cert_issuer(cem_index: int, value: str) -> None: ...

Default Value

""

Remarks

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

The cem_index parameter specifies the index of the item in the array. The size of the array is controlled by the cem_count property.

cem_cert_serial_number Property

This property holds the serial number of the certificate.

Syntax

def get_cem_cert_serial_number(cem_index: int) -> str: ...
def set_cem_cert_serial_number(cem_index: int, value: str) -> None: ...

Default Value

""

Remarks

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

The cem_index parameter specifies the index of the item in the array. The size of the array is controlled by the cem_count property.

cem_cert_store Property

The name of the certificate store for the certificate.

Syntax

def get_cem_cert_store(cem_index: int) -> bytes: ...
def set_cem_cert_store(cem_index: int, value: bytes) -> None: ...

Default Value

"MY"

Remarks

The name of the certificate store for the certificate.

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

Designations of certificate stores are platform-dependent.

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

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot certificates.

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

The cem_index parameter specifies the index of the item in the array. The size of the array is controlled by the cem_count property.

cem_cert_store_password Property

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

Syntax

def get_cem_cert_store_password(cem_index: int) -> str: ...
def set_cem_cert_store_password(cem_index: int, value: str) -> None: ...

Default Value

""

Remarks

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

The cem_index parameter specifies the index of the item in the array. The size of the array is controlled by the cem_count property.

cem_cert_store_type Property

The type of certificate store for this certificate.

Syntax

def get_cem_cert_store_type(cem_index: int) -> int: ...
def set_cem_cert_store_type(cem_index: int, value: int) -> None: ...

Default Value

0

Remarks

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:

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 (PKCS12) file containing certificates.
3 (cstPFXBlob)The certificate store is a string (binary or base64-encoded) representing a certificate store in PFX (PKCS12) 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 PKCS7 file containing certificates.
12 (cstP7BBlob)The certificate store is a string (binary) representing a certificate store in PKCS7 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 PKCS11 interface.

To use a security key the necessary data must first be collected using the CertMgr class. The list_store_certificates method may be called after setting cert_store_type to cstPKCS11, cert_store_password to the PIN, and cert_store to the full path of the PKCS11 dll. The certificate information returned in the on_cert_list event's CertEncoded parameter may be saved for later use.

When using a certificate, pass the previously saved security key information as the cem_store and set cem_store_password to the PIN.

Code Example: SSH Authentication with Security Key certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);

99 (cstAuto)The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

The cem_index parameter specifies the index of the item in the array. The size of the array is controlled by the cem_count property.

cem_cert_subject Property

The subject of the certificate.

Syntax

def get_cem_cert_subject(cem_index: int) -> str: ...
def set_cem_cert_subject(cem_index: int, value: str) -> None: ...

Default Value

""

Remarks

The subject of the certificate.

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

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

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

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

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

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

FieldMeaning
CNCommon Name. This is commonly a host name like www.server.com.
OOrganization
OUOrganizational Unit
LLocality
SState
CCountry
EEmail Address

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

The cem_index parameter specifies the index of the item in the array. The size of the array is controlled by the cem_count property.

cem_cert_usage Property

This property defines which usages are applicable to the certificate.

Syntax

def get_cem_cert_usage(cem_index: int) -> int: ...
def set_cem_cert_usage(cem_index: int, value: int) -> None: ...

Default Value

15

Remarks

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

  • 1 (TLS Client)
  • 2 (TLS Server)
  • 4 (Encryption)
  • 8 (Signature)
The default value is "15", meaning all usages are allowed.

The cem_index parameter specifies the index of the item in the array. The size of the array is controlled by the cem_count property.

cem_rejection_reason Property

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

Syntax

def get_cem_rejection_reason(cem_index: int) -> str: ...
def set_cem_rejection_reason(cem_index: int, value: str) -> None: ...

Default Value

""

Remarks

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

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

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

The cem_index parameter specifies the index of the item in the array. The size of the array is controlled by the cem_count property.

cem_respond_by_date Property

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

Syntax

def get_cem_respond_by_date(cem_index: int) -> str: ...
def set_cem_respond_by_date(cem_index: int, value: str) -> None: ...

Default Value

""

Remarks

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

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

When using AS2Sender set this before calling send_cem_request.

When using AS2Receiver this property may be queried.

The cem_index parameter specifies the index of the item in the array. The size of the array is controlled by the cem_count property.

cem_response_url Property

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

Syntax

def get_cem_response_url(cem_index: int) -> str: ...
def set_cem_response_url(cem_index: int, value: str) -> None: ...

Default Value

""

Remarks

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

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

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

The cem_index parameter specifies the index of the item in the array. The size of the array is controlled by the cem_count property.

cert_encoded Property

This is the certificate (PEM/base64 encoded).

Syntax

def get_cert_encoded() -> bytes: ...
def set_cert_encoded(value: bytes) -> None: ...

cert_encoded = property(get_cert_encoded, set_cert_encoded)

Default Value

""

Remarks

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

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

cert_store Property

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

Syntax

def get_cert_store() -> bytes: ...
def set_cert_store(value: bytes) -> None: ...

cert_store = property(get_cert_store, set_cert_store)

Default Value

"MY"

Remarks

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

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

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

Designations of certificate stores are platform-dependent.

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

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot certificates.

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

cert_store_password Property

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

Syntax

def get_cert_store_password() -> str: ...
def set_cert_store_password(value: str) -> None: ...

cert_store_password = property(get_cert_store_password, set_cert_store_password)

Default Value

""

Remarks

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

cert_store_type Property

This is the type of certificate store for this certificate.

Syntax

def get_cert_store_type() -> int: ...
def set_cert_store_type(value: int) -> None: ...

cert_store_type = property(get_cert_store_type, set_cert_store_type)

Default Value

0

Remarks

This is 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:

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 (PKCS12) file containing certificates.
3 (cstPFXBlob)The certificate store is a string (binary or base64-encoded) representing a certificate store in PFX (PKCS12) 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 PKCS7 file containing certificates.
12 (cstP7BBlob)The certificate store is a string (binary) representing a certificate store in PKCS7 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 PKCS11 interface.

To use a security key the necessary data must first be collected using the CertMgr class. The list_store_certificates method may be called after setting cert_store_type to cstPKCS11, cert_store_password to the PIN, and cert_store to the full path of the PKCS11 dll. The certificate information returned in the on_cert_list event's CertEncoded parameter may be saved for later use.

When using a certificate, pass the previously saved security key information as the cert_store and set cert_store_password to the PIN.

Code Example: SSH Authentication with Security Key certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);

99 (cstAuto)The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

cert_subject Property

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

Syntax

def get_cert_subject() -> str: ...
def set_cert_subject(value: str) -> None: ...

cert_subject = property(get_cert_subject, set_cert_subject)

Default Value

""

Remarks

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

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

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

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

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

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

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

FieldMeaning
CNCommon Name. This is commonly a host name like www.server.com.
OOrganization
OUOrganizational Unit
LLocality
SState
CCountry
EEmail Address

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

compression_format Property

The compression format used on the incoming message.

Syntax

def get_compression_format() -> int: ...

compression_format = property(get_compression_format, None)

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.

edi_data Property

This property contains the EDI payload of the transmission.

Syntax

def get_edi_data() -> bytes: ...

edi_data = property(get_edi_data, None)

Default Value

""

Remarks

This property contains the EDI payload of the transmission.

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

This property will only be populated if parse_request or process_request finishes without an error, setting scan_result to 0. If so, edi_data will contain the processed EDI message.

This property is read-only.

edi_type Property

The Content-Type of the EDI message.

Syntax

def get_edi_type() -> str: ...

edi_type = property(get_edi_type, None)

Default Value

""

Remarks

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

This property is read-only.

edi_filename Property

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

Syntax

def get_edi_filename() -> str: ...

edi_filename = property(get_edi_filename, None)

Default Value

""

Remarks

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

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

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

This property is read-only.

edi_name Property

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

Syntax

def get_edi_name() -> str: ...

edi_name = property(get_edi_name, None)

Default Value

"rfc1767.edi"

Remarks

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

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

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

This property is read-only.

firewall_auto_detect Property

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

Syntax

def get_firewall_auto_detect() -> bool: ...
def set_firewall_auto_detect(value: bool) -> None: ...

firewall_auto_detect = property(get_firewall_auto_detect, set_firewall_auto_detect)

Default Value

FALSE

Remarks

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

firewall_type Property

This property determines the type of firewall to connect through.

Syntax

def get_firewall_type() -> int: ...
def set_firewall_type(value: int) -> None: ...

firewall_type = property(get_firewall_type, set_firewall_type)

Default Value

0

Remarks

This property determines 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. firewall_port is set to 80.
fwSOCKS4 (2)Connect through a SOCKS4 Proxy. firewall_port is set to 1080.
fwSOCKS5 (3)Connect through a SOCKS5 Proxy. firewall_port is set to 1080.
fwSOCKS4A (10)Connect through a SOCKS4A Proxy. firewall_port is set to 1080.

firewall_host Property

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

Syntax

def get_firewall_host() -> str: ...
def set_firewall_host(value: str) -> None: ...

firewall_host = property(get_firewall_host, set_firewall_host)

Default Value

""

Remarks

This property contains the name or IP address of firewall (optional). If a firewall_host 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 fails with an error.

firewall_password Property

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

Syntax

def get_firewall_password() -> str: ...
def set_firewall_password(value: str) -> None: ...

firewall_password = property(get_firewall_password, set_firewall_password)

Default Value

""

Remarks

This property contains a password if authentication is to be used when connecting through the firewall. If firewall_host is specified, the firewall_user and firewall_password properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

firewall_port Property

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

Syntax

def get_firewall_port() -> int: ...
def set_firewall_port(value: int) -> None: ...

firewall_port = property(get_firewall_port, set_firewall_port)

Default Value

0

Remarks

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

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

firewall_user Property

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

Syntax

def get_firewall_user() -> str: ...
def set_firewall_user(value: str) -> None: ...

firewall_user = property(get_firewall_user, set_firewall_user)

Default Value

""

Remarks

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

incoming_directory Property

The directory to be used to store incoming messages.

Syntax

def get_incoming_directory() -> str: ...
def set_incoming_directory(value: str) -> None: ...

incoming_directory = property(get_incoming_directory, set_incoming_directory)

Default Value

""

Remarks

If incoming_directory 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 set_tp_info method, if used, needs to be invoked before setting this property because it overrides the setting for incoming directory.

local_host Property

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

Syntax

def get_local_host() -> str: ...
def set_local_host(value: str) -> None: ...

local_host = property(get_local_host, set_local_host)

Default Value

""

Remarks

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

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

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

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

log_directory Property

The path to a directory for logging.

Syntax

def get_log_directory() -> str: ...
def set_log_directory(value: str) -> None: ...

log_directory = property(get_log_directory, set_log_directory)

Default Value

""

Remarks

Setting log_directory 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 configuration setting.

log_directory 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 log_file will contain the name of the files just written, minus the extension.

If logs cannot be written an exception will be thrown.

log_file Property

The log file written.

Syntax

def get_log_file() -> str: ...

log_file = property(get_log_file, None)

Default Value

""

Remarks

In case log_directory is specified a log file will be written in the specified directory and log_file 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.

mdn_receipt_content Property

This contains the entire content of the MDN Receipt.

Syntax

def get_mdn_receipt_content() -> bytes: ...
def set_mdn_receipt_content(value: bytes) -> None: ...

mdn_receipt_content = property(get_mdn_receipt_content, set_mdn_receipt_content)

Default Value

""

Remarks

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

mdn_receipt_header_count Property

The number of headers in the MDN.

Syntax

def get_mdn_receipt_header_count() -> int: ...

mdn_receipt_header_count = property(get_mdn_receipt_header_count, None)

Default Value

0

Remarks

The number of headers in the MDN.

This property is read-only.

mdn_receipt_header_field Property

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

Syntax

def get_mdn_receipt_header_field() -> str: ...

mdn_receipt_header_field = property(get_mdn_receipt_header_field, None)

Default Value

""

Remarks

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

This property is read-only.

mdn_receipt_header_index Property

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

Syntax

def get_mdn_receipt_header_index() -> int: ...
def set_mdn_receipt_header_index(value: int) -> None: ...

mdn_receipt_header_index = property(get_mdn_receipt_header_index, set_mdn_receipt_header_index)

Default Value

0

Remarks

Which MDN header is currently selected to populate mdn_receipt_header_field and mdn_receipt_header_value.

Valid values are 0 to mdn_receipt_header_count - 1.

mdn_receipt_headers Property

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

Syntax

def get_mdn_receipt_headers() -> str: ...
def set_mdn_receipt_headers(value: str) -> None: ...

mdn_receipt_headers = property(get_mdn_receipt_headers, set_mdn_receipt_headers)

Default Value

""

Remarks

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

You can also use mdn_receipt_header_count, mdn_receipt_header_index, mdn_receipt_header_field, and mdn_receipt_header_value to easily iterate through each individual header.

mdn_receipt_header_value Property

The value of the MDN header currently selected by HeaderIndex .

Syntax

def get_mdn_receipt_header_value() -> str: ...

mdn_receipt_header_value = property(get_mdn_receipt_header_value, None)

Default Value

""

Remarks

The value of the MDN header currently selected by mdn_receipt_header_index.

This property is read-only.

mdn_receipt_mdn Property

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

Syntax

def get_mdn_receipt_mdn() -> str: ...

mdn_receipt_mdn = property(get_mdn_receipt_mdn, None)

Default Value

""

Remarks

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

This property is read-only.

mdn_receipt_message Property

The human-readable portion of the MDN receipt.

Syntax

def get_mdn_receipt_message() -> str: ...

mdn_receipt_message = property(get_mdn_receipt_message, None)

Default Value

""

Remarks

The human-readable portion of the MDN receipt.

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

This property is read-only.

mdn_receipt_mic_value Property

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

Syntax

def get_mdn_receipt_mic_value() -> str: ...

mdn_receipt_mic_value = property(get_mdn_receipt_mic_value, None)

Default Value

""

Remarks

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

An MDN Receipt contains a MIC calculated over the EDI message that the receipt is in response to, to be matched on the sender side against a saved value for the original request to ensure that the integrity of the data that the receiver reports is preserved. When a signed receipt is requested, the MIC is be calculated using the algorithm used on the incoming message's signature, or SHA-1 if the incoming message is not signed.

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

This property is read-only.

mdn_receipt_signing_protocol Property

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

Syntax

def get_mdn_receipt_signing_protocol() -> str: ...

mdn_receipt_signing_protocol = property(get_mdn_receipt_signing_protocol, None)

Default Value

""

Remarks

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

This property is read-only.

mdn_to Property

The recipient for the Message Disposition Notification (MDN).

Syntax

def get_mdn_to() -> str: ...

mdn_to = property(get_mdn_to, None)

Default Value

""

Remarks

mdn_to corresponds to the Disposition-Notification-To header of request_headers. If nonempty, the client has requested an MDN receipt (typically the actual value is irrelevant). This receipt will be generated in a call to process_request or create_mdn_receipt, and may be sent by calling send_response.

The receipt will be contained in mdn_receipt. If receipt_delivery_option 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, send_response will send the response as appropriate.

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

This property is read-only.

message_id Property

The message ID of the incoming message.

Syntax

def get_message_id() -> str: ...

message_id = property(get_message_id, None)

Default Value

""

Remarks

message_id corresponds to the Message-Id header of request, and will be used as the Original-Message-Id header of mdn_receipt.

This property is read-only.

receipt_delivery_option Property

A URL indicating how the receipt is to be delivered.

Syntax

def get_receipt_delivery_option() -> str: ...

receipt_delivery_option = property(get_receipt_delivery_option, None)

Default Value

""

Remarks

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

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

This property is read-only.

request Property

The HTTP request to be processed.

Syntax

def get_request() -> bytes: ...
def set_request(value: bytes) -> None: ...

request = property(get_request, set_request)

Default Value

""

Remarks

The body of the request to be processed. The HTTP headers may be set separately in request_headers 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 parse_request or process_request is invoked, the contents of request are lost and you can read the processed data in edi_data.

request_header_count Property

The number of records in the RequestHeader arrays.

Syntax

def get_request_header_count() -> int: ...
def set_request_header_count(value: int) -> None: ...

request_header_count = property(get_request_header_count, set_request_header_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

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

request_header_field Property

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

Syntax

def get_request_header_field(request_header_index: int) -> str: ...
def set_request_header_field(request_header_index: int, value: str) -> None: ...

Default Value

""

Remarks

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

The request_header_index parameter specifies the index of the item in the array. The size of the array is controlled by the request_header_count property.

request_header_value Property

This property contains the header contents.

Syntax

def get_request_header_value(request_header_index: int) -> str: ...
def set_request_header_value(request_header_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property contains the Header contents.

The request_header_index parameter specifies the index of the item in the array. The size of the array is controlled by the request_header_count property.

request_headers_string Property

The HTTP headers in the AS2 request.

Syntax

def get_request_headers_string() -> str: ...
def set_request_headers_string(value: str) -> None: ...

request_headers_string = property(get_request_headers_string, set_request_headers_string)

Default Value

""

Remarks

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

When assigning an AS2 request to the class, the headers may be included in request or specified separately in request_headers. If the headers are included in request they will be parsed out whenever read_request, parse_request, or process_request is invoked.

restart_directory Property

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

Syntax

def get_restart_directory() -> str: ...
def set_restart_directory(value: str) -> None: ...

restart_directory = property(get_restart_directory, set_restart_directory)

Default Value

""

Remarks

If this property is set, the class will cache all received files to the restart_directory. 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 process_restart_request 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.

rollover_cert_encoded Property

This is the certificate (PEM/base64 encoded).

Syntax

def get_rollover_cert_encoded() -> bytes: ...
def set_rollover_cert_encoded(value: bytes) -> None: ...

rollover_cert_encoded = property(get_rollover_cert_encoded, set_rollover_cert_encoded)

Default Value

""

Remarks

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

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

rollover_cert_store Property

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

Syntax

def get_rollover_cert_store() -> bytes: ...
def set_rollover_cert_store(value: bytes) -> None: ...

rollover_cert_store = property(get_rollover_cert_store, set_rollover_cert_store)

Default Value

"MY"

Remarks

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

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

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

Designations of certificate stores are platform-dependent.

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

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot certificates.

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

rollover_cert_store_password Property

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

Syntax

def get_rollover_cert_store_password() -> str: ...
def set_rollover_cert_store_password(value: str) -> None: ...

rollover_cert_store_password = property(get_rollover_cert_store_password, set_rollover_cert_store_password)

Default Value

""

Remarks

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

rollover_cert_store_type Property

This is the type of certificate store for this certificate.

Syntax

def get_rollover_cert_store_type() -> int: ...
def set_rollover_cert_store_type(value: int) -> None: ...

rollover_cert_store_type = property(get_rollover_cert_store_type, set_rollover_cert_store_type)

Default Value

0

Remarks

This is 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:

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 (PKCS12) file containing certificates.
3 (cstPFXBlob)The certificate store is a string (binary or base64-encoded) representing a certificate store in PFX (PKCS12) 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 PKCS7 file containing certificates.
12 (cstP7BBlob)The certificate store is a string (binary) representing a certificate store in PKCS7 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 PKCS11 interface.

To use a security key the necessary data must first be collected using the CertMgr class. The list_store_certificates method may be called after setting cert_store_type to cstPKCS11, cert_store_password to the PIN, and cert_store to the full path of the PKCS11 dll. The certificate information returned in the on_cert_list event's CertEncoded parameter may be saved for later use.

When using a certificate, pass the previously saved security key information as the rollover_cert_store and set rollover_cert_store_password to the PIN.

Code Example: SSH Authentication with Security Key certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);

99 (cstAuto)The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

rollover_cert_subject Property

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

Syntax

def get_rollover_cert_subject() -> str: ...
def set_rollover_cert_subject(value: str) -> None: ...

rollover_cert_subject = property(get_rollover_cert_subject, set_rollover_cert_subject)

Default Value

""

Remarks

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

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

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

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

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

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

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

FieldMeaning
CNCommon Name. This is commonly a host name like www.server.com.
OOrganization
OUOrganizational Unit
LLocality
SState
CCountry
EEmail Address

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

scan_result Property

The result of invoking ParseRequest .

Syntax

def get_scan_result() -> int: ...

scan_result = property(get_scan_result, None)

Default Value

0

Remarks

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

0x01 Unable to decrypt data.
0x02 Unable to decompress data.
0x04 Unable to validate integrity of data.
0x08 Unable to verify the signature.
0x10 Client requested unsupported signature type.
0x20 Client requested unsupported MIC algorithm.
0x40 Insufficient message security, as determined by the config entries RequireSign and 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.

signer_cert_encoded Property

This is the certificate (PEM/base64 encoded).

Syntax

def get_signer_cert_encoded() -> bytes: ...
def set_signer_cert_encoded(value: bytes) -> None: ...

signer_cert_encoded = property(get_signer_cert_encoded, set_signer_cert_encoded)

Default Value

""

Remarks

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

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

signer_cert_store Property

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

Syntax

def get_signer_cert_store() -> bytes: ...
def set_signer_cert_store(value: bytes) -> None: ...

signer_cert_store = property(get_signer_cert_store, set_signer_cert_store)

Default Value

"MY"

Remarks

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

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

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

Designations of certificate stores are platform-dependent.

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

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot certificates.

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

signer_cert_store_password Property

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

Syntax

def get_signer_cert_store_password() -> str: ...
def set_signer_cert_store_password(value: str) -> None: ...

signer_cert_store_password = property(get_signer_cert_store_password, set_signer_cert_store_password)

Default Value

""

Remarks

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

signer_cert_store_type Property

This is the type of certificate store for this certificate.

Syntax

def get_signer_cert_store_type() -> int: ...
def set_signer_cert_store_type(value: int) -> None: ...

signer_cert_store_type = property(get_signer_cert_store_type, set_signer_cert_store_type)

Default Value

0

Remarks

This is 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:

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 (PKCS12) file containing certificates.
3 (cstPFXBlob)The certificate store is a string (binary or base64-encoded) representing a certificate store in PFX (PKCS12) 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 PKCS7 file containing certificates.
12 (cstP7BBlob)The certificate store is a string (binary) representing a certificate store in PKCS7 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 PKCS11 interface.

To use a security key the necessary data must first be collected using the CertMgr class. The list_store_certificates method may be called after setting cert_store_type to cstPKCS11, cert_store_password to the PIN, and cert_store to the full path of the PKCS11 dll. The certificate information returned in the on_cert_list event's CertEncoded parameter may be saved for later use.

When using a certificate, pass the previously saved security key information as the signer_cert_store and set signer_cert_store_password to the PIN.

Code Example: SSH Authentication with Security Key certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);

99 (cstAuto)The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

signer_cert_subject Property

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

Syntax

def get_signer_cert_subject() -> str: ...
def set_signer_cert_subject(value: str) -> None: ...

signer_cert_subject = property(get_signer_cert_subject, set_signer_cert_subject)

Default Value

""

Remarks

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

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

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

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

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

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

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

FieldMeaning
CNCommon Name. This is commonly a host name like www.server.com.
OOrganization
OUOrganizational Unit
LLocality
SState
CCountry
EEmail Address

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

ssl_accept_server_cert_encoded Property

This is the certificate (PEM/base64 encoded).

Syntax

def get_ssl_accept_server_cert_encoded() -> bytes: ...
def set_ssl_accept_server_cert_encoded(value: bytes) -> None: ...

ssl_accept_server_cert_encoded = property(get_ssl_accept_server_cert_encoded, set_ssl_accept_server_cert_encoded)

Default Value

""

Remarks

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

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

ssl_accept_server_cert_store Property

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

Syntax

def get_ssl_accept_server_cert_store() -> bytes: ...
def set_ssl_accept_server_cert_store(value: bytes) -> None: ...

ssl_accept_server_cert_store = property(get_ssl_accept_server_cert_store, set_ssl_accept_server_cert_store)

Default Value

"MY"

Remarks

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

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

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

Designations of certificate stores are platform-dependent.

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

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot certificates.

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

ssl_accept_server_cert_store_password Property

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

Syntax

def get_ssl_accept_server_cert_store_password() -> str: ...
def set_ssl_accept_server_cert_store_password(value: str) -> None: ...

ssl_accept_server_cert_store_password = property(get_ssl_accept_server_cert_store_password, set_ssl_accept_server_cert_store_password)

Default Value

""

Remarks

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

ssl_accept_server_cert_store_type Property

This is the type of certificate store for this certificate.

Syntax

def get_ssl_accept_server_cert_store_type() -> int: ...
def set_ssl_accept_server_cert_store_type(value: int) -> None: ...

ssl_accept_server_cert_store_type = property(get_ssl_accept_server_cert_store_type, set_ssl_accept_server_cert_store_type)

Default Value

0

Remarks

This is 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:

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 (PKCS12) file containing certificates.
3 (cstPFXBlob)The certificate store is a string (binary or base64-encoded) representing a certificate store in PFX (PKCS12) 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 PKCS7 file containing certificates.
12 (cstP7BBlob)The certificate store is a string (binary) representing a certificate store in PKCS7 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 PKCS11 interface.

To use a security key the necessary data must first be collected using the CertMgr class. The list_store_certificates method may be called after setting cert_store_type to cstPKCS11, cert_store_password to the PIN, and cert_store to the full path of the PKCS11 dll. The certificate information returned in the on_cert_list event's CertEncoded parameter may be saved for later use.

When using a certificate, pass the previously saved security key information as the ssl_accept_server_cert_store and set ssl_accept_server_cert_store_password to the PIN.

Code Example: SSH Authentication with Security Key certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);

99 (cstAuto)The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

ssl_accept_server_cert_subject Property

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

Syntax

def get_ssl_accept_server_cert_subject() -> str: ...
def set_ssl_accept_server_cert_subject(value: str) -> None: ...

ssl_accept_server_cert_subject = property(get_ssl_accept_server_cert_subject, set_ssl_accept_server_cert_subject)

Default Value

""

Remarks

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

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

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

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

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

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

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

FieldMeaning
CNCommon Name. This is commonly a host name like www.server.com.
OOrganization
OUOrganizational Unit
LLocality
SState
CCountry
EEmail Address

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

ssl_cert_encoded Property

This is the certificate (PEM/base64 encoded).

Syntax

def get_ssl_cert_encoded() -> bytes: ...
def set_ssl_cert_encoded(value: bytes) -> None: ...

ssl_cert_encoded = property(get_ssl_cert_encoded, set_ssl_cert_encoded)

Default Value

""

Remarks

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

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

ssl_cert_store Property

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

Syntax

def get_ssl_cert_store() -> bytes: ...
def set_ssl_cert_store(value: bytes) -> None: ...

ssl_cert_store = property(get_ssl_cert_store, set_ssl_cert_store)

Default Value

"MY"

Remarks

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

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

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

Designations of certificate stores are platform-dependent.

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

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot certificates.

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

ssl_cert_store_password Property

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

Syntax

def get_ssl_cert_store_password() -> str: ...
def set_ssl_cert_store_password(value: str) -> None: ...

ssl_cert_store_password = property(get_ssl_cert_store_password, set_ssl_cert_store_password)

Default Value

""

Remarks

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

ssl_cert_store_type Property

This is the type of certificate store for this certificate.

Syntax

def get_ssl_cert_store_type() -> int: ...
def set_ssl_cert_store_type(value: int) -> None: ...

ssl_cert_store_type = property(get_ssl_cert_store_type, set_ssl_cert_store_type)

Default Value

0

Remarks

This is 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:

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 (PKCS12) file containing certificates.
3 (cstPFXBlob)The certificate store is a string (binary or base64-encoded) representing a certificate store in PFX (PKCS12) 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 PKCS7 file containing certificates.
12 (cstP7BBlob)The certificate store is a string (binary) representing a certificate store in PKCS7 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 PKCS11 interface.

To use a security key the necessary data must first be collected using the CertMgr class. The list_store_certificates method may be called after setting cert_store_type to cstPKCS11, cert_store_password to the PIN, and cert_store to the full path of the PKCS11 dll. The certificate information returned in the on_cert_list event's CertEncoded parameter may be saved for later use.

When using a certificate, pass the previously saved security key information as the ssl_cert_store and set ssl_cert_store_password to the PIN.

Code Example: SSH Authentication with Security Key certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);

99 (cstAuto)The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

ssl_cert_subject Property

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

Syntax

def get_ssl_cert_subject() -> str: ...
def set_ssl_cert_subject(value: str) -> None: ...

ssl_cert_subject = property(get_ssl_cert_subject, set_ssl_cert_subject)

Default Value

""

Remarks

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

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

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

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

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

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

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

FieldMeaning
CNCommon Name. This is commonly a host name like www.server.com.
OOrganization
OUOrganizational Unit
LLocality
SState
CCountry
EEmail Address

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

use_pss Property

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

Syntax

def get_use_pss() -> bool: ...
def set_use_pss(value: bool) -> None: ...

use_pss = property(get_use_pss, set_use_pss)

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.

ack_request Method

Optional. Acknowledges the incoming request.

Syntax

def ack_request() -> None: ...

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 parse_request for both synchronous and asynchronous MDN requests.

config Method

Sets or retrieves a configuration setting.

Syntax

def config(configuration_string: str) -> str: ...

Remarks

config is a generic method available in every class. It is used to set and retrieve configuration settings 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, you must call Config("PROPERTY"). The value will be returned as a string.

create_mdn_receipt Method

Creates MDNReceipt .

Syntax

def create_mdn_receipt(headers: str, mdn: str, message: str) -> None: ...

Remarks

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

This method populates mdn_receipt 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.

parse_request Method

Parses the EDI message and determines the EDIData .

Syntax

def parse_request() -> None: ...

Remarks

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

If the message is scanned without difficulty, edi_data 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, edi_data will not be determined.

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

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

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

process_request Method

Processes the EDI data, and generates the receipt.

Syntax

def process_request() -> None: ...

Remarks

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

The method's functionality is the same as the combined functionality of parse_request and create_mdn_receipt. The method's operation is controlled by ErrorProcessingFlags and ErrorReportingFlags, and scan_result will be populated as in parse_request.

The method will throw an exception, as parse_request does, if a problem is found while processing the request. However, if the problem does not prevent an MDN from being generated, mdn_receipt 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 mdn_receipt will provide more detail on the cause of the error.

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

process_restart_request Method

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

Syntax

def process_restart_request() -> None: ...

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 restart_directory when processing these requests.

read_request Method

Reads the AS2 request from the HTTP session.

Syntax

def read_request() -> None: ...

Remarks

read_request reads the AS2 request from the content of the request (and optionally the request_headers_string) property. The class will parse the request from request. The headers will be read into request_headers. Finally, the class will parse the headers and populate the following properties:

parse_request may be used to scan the entire message.

reset Method

Resets the state of the control.

Syntax

def reset() -> None: ...

Remarks

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

send_async_mdn Method

Sends the MDNReceipt to the RemoteURL specified.

Syntax

def send_async_mdn(remote_url: str, mdn_receipt: bytes, mdn_receipt_headers: str) -> None: ...

Remarks

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

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

send_response Method

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

Syntax

def send_response() -> None: ...

Remarks

When called from within a server environment, send_response will respond to the requesting client. If an MDN was requested, then mdn_receipt 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 ack_request.

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

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

Optionally, if an asynchronous MDN is requested, the mdn_receipt and receipt_delivery_option may be saved so that the MDN may be sent later through the send_async_mdn method.

This method should only be invoked after mdn_receipt has been generated by create_mdn_receipt or process_request.

set_tp_info Method

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

Syntax

def set_tp_info(profile: str) -> None: ...

Remarks

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

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

on_cem_request Event

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

Syntax

class AS2ReceiverCEMRequestEventParams(object):
  @property
  def request_id() -> str: ...

  @property
  def as_2_from() -> str: ...

# In class AS2Receiver:
@property
def on_cem_request() -> Callable[[AS2ReceiverCEMRequestEventParams], None]: ...
@on_cem_request.setter
def on_cem_request(event_hook: Callable[[AS2ReceiverCEMRequestEventParams], None]) -> None: ...

Remarks

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

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

As2From identifies the sender of the CEM request.

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

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

When this event fires the following cem_details properties are applicable:

To send a CEM response save the cem_details values and call send_cem_response with the AS2Sender class.

on_cem_response Event

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

Syntax

class AS2ReceiverCEMResponseEventParams(object):
  @property
  def request_id() -> str: ...

  @property
  def as_2_from() -> str: ...

# In class AS2Receiver:
@property
def on_cem_response() -> Callable[[AS2ReceiverCEMResponseEventParams], None]: ...
@on_cem_response.setter
def on_cem_response(event_hook: Callable[[AS2ReceiverCEMResponseEventParams], None]) -> None: ...

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 cem_details property will be populated. Inspect the cem_accepted property to determine whether each CEM request was accepted. If the request was rejected, check cem_rejection_reason for details.

When this event fires the following cem_details properties are applicable:

on_edi_data_info Event

Fired when processing an incoming message.

Syntax

class AS2ReceiverEDIDataInfoEventParams(object):
  @property
  def name() -> str: ...

  @property
  def data_type() -> str: ...

  @property
  def duplicate() -> bool: ...
  @duplicate.setter
  def duplicate(value) -> None: ...

# In class AS2Receiver:
@property
def on_edi_data_info() -> Callable[[AS2ReceiverEDIDataInfoEventParams], None]: ...
@on_edi_data_info.setter
def on_edi_data_info(event_hook: Callable[[AS2ReceiverEDIDataInfoEventParams], None]) -> None: ...

Remarks

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

Duplicate is used in conjunction with the InvalidFilenameMDNAction configuration setting when Filename Preservation with an Associated MDN Response is implemented in the receiving agent to support MDN responses for duplicate filenames. If incoming_directory 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.

on_error Event

Information about errors during data delivery.

Syntax

class AS2ReceiverErrorEventParams(object):
  @property
  def error_code() -> int: ...

  @property
  def description() -> str: ...

# In class AS2Receiver:
@property
def on_error() -> Callable[[AS2ReceiverErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[AS2ReceiverErrorEventParams], None]) -> None: ...

Remarks

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

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

on_log Event

Fired with log information while processing a message.

Syntax

class AS2ReceiverLogEventParams(object):
  @property
  def log_type() -> str: ...

  @property
  def log_message() -> bytes: ...

# In class AS2Receiver:
@property
def on_log() -> Callable[[AS2ReceiverLogEventParams], None]: ...
@on_log.setter
def on_log(event_hook: Callable[[AS2ReceiverLogEventParams], None]) -> None: ...

Remarks

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

Log messages available through this event correspond to log files written to log_directory. This event provides a way to obtain log messages without relying on files on disk. This event fires regardless of the value of log_directory (i.e. when log_directory 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 is True.
"DAT.ENCRYPT" Debug information when processing payload. Only applicable when LogDebug is True.
"DAT.COMPRESS" Debug information when processing payload. Only applicable when LogDebug is True.
"DAT.SIGN" Debug information when processing payload. Only applicable when LogDebug is True.
"DAT.DECRYPT" Debug information when processing payload. Only applicable when LogDebug is True.
"DAT.DECOMPRESS" Debug information when processing payload. Only applicable when LogDebug is True.
"DAT.VERIFY" Debug information when processing payload. Only applicable when LogDebug is True.
"DAT.DEBUG" Debug information when processing payload. Only applicable when LogDebug is True.

on_recipient_info Event

Fired for each recipient certificate of the encrypted message.

Syntax

class AS2ReceiverRecipientInfoEventParams(object):
  @property
  def issuer() -> str: ...

  @property
  def serial_number() -> str: ...

  @property
  def subject_key_identifier() -> str: ...

  @property
  def encryption_algorithm() -> str: ...

# In class AS2Receiver:
@property
def on_recipient_info() -> Callable[[AS2ReceiverRecipientInfoEventParams], None]: ...
@on_recipient_info.setter
def on_recipient_info(event_hook: Callable[[AS2ReceiverRecipientInfoEventParams], None]) -> None: ...

Remarks

When parse_request or process_request 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"

on_signer_cert_info Event

This event is fired during verification of the signed message.

Syntax

class AS2ReceiverSignerCertInfoEventParams(object):
  @property
  def issuer() -> str: ...

  @property
  def serial_number() -> str: ...

  @property
  def subject_key_identifier() -> str: ...

  @property
  def cert_encoded() -> bytes: ...

# In class AS2Receiver:
@property
def on_signer_cert_info() -> Callable[[AS2ReceiverSignerCertInfoEventParams], None]: ...
@on_signer_cert_info.setter
def on_signer_cert_info(event_hook: Callable[[AS2ReceiverSignerCertInfoEventParams], None]) -> None: ...

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

on_ssl_server_authentication Event

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

Syntax

class AS2ReceiverSSLServerAuthenticationEventParams(object):
  @property
  def cert_encoded() -> bytes: ...

  @property
  def cert_subject() -> str: ...

  @property
  def cert_issuer() -> str: ...

  @property
  def status() -> str: ...

  @property
  def accept() -> bool: ...
  @accept.setter
  def accept(value) -> None: ...

# In class AS2Receiver:
@property
def on_ssl_server_authentication() -> Callable[[AS2ReceiverSSLServerAuthenticationEventParams], None]: ...
@on_ssl_server_authentication.setter
def on_ssl_server_authentication(event_hook: Callable[[AS2ReceiverSSLServerAuthenticationEventParams], None]) -> None: ...

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 on_ssl_server_authentication event and set Accept to true based on the values of CertSubject, CertEncoded, etc., or set the ssl_accept_server_cert property to the value of the expected certificate (if the server certificate is known in advance the latter method is simpler).

on_ssl_status Event

Shows the progress of the secure connection.

Syntax

class AS2ReceiverSSLStatusEventParams(object):
  @property
  def message() -> str: ...

# In class AS2Receiver:
@property
def on_ssl_status() -> Callable[[AS2ReceiverSSLStatusEventParams], None]: ...
@on_ssl_status.setter
def on_ssl_status(event_hook: Callable[[AS2ReceiverSSLStatusEventParams], None]) -> None: ...

Remarks

The event is fired for informational and logging purposes only. Used to track the progress of the connection.

AS2Receiver Config Settings

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

AS2Receiver Config Settings

AcceptAnySignerCert:   Used to accept trust any signing certificate unconditionally.

If 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 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; setting 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 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 property to tell the component which type of authorization to perform when the User and Password properties are set. Possible values are:

0 (default)Basic
1Digest
2Proprietary
3None
4NTLM
5Negotiate
6OAuth
By default, AuthScheme is Basic (0), and if the User and 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 and 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: CEMRequestId + "_" + cem_cert_id + ".cer" The CEMRequestId may be retrieved from the on_cem_request event. Any invalid characters will be replaced with "_". If there is an error writing the file to disk the on_error event will fire with details. To overwrite existing certificate files set OverwriteCEMCerts to True.

If this is not set, the certificates will be held in memory and can be accessed via cem_details. See on_cem_request for details.

CloseStreamAfterProcessing:   Specifies whether or not the OutputStream should be closed after processing.

Determines if the stream specified by edi_data_output_stream is closed after parse_request or process_request 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, the class will first decode the S/MIME message to the temp directory, then decode the embedded MIME message containing attachments to the incoming_directory.

Note: When using this configuration, if incoming_directory 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, log_directory 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 log_directory 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, parse_request will halt and throw an exception if request contains errors or requests algorithms, protocols, or receipt types not supported by the class. By setting ErrorProcessingFlags the class can be configured to not halt for certain types of errors. The errors will still be reported in scan_result.

Use of this property allows edi_data to be determined even if the class is not fully able to respond to the client's request.

ErrorReportingFlags control how the errors are reported in the mdn_receipt.

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, mdn_receipt 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 mdn_receipt may be configured to permit one or more of the errors below. A warning will be reported if MDNWarning is set; otherwise the error will silently be ignored. 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:

0Continue
1Warn
2Fail
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 incoming_directory.

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 on_edi_data_info 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 log_directory. 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 log_directory 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"):

StatusContains information on applied security options and pass/fail status of transmission
RequestContains the raw incoming request before processing
PayloadContains log of processed payload after transmission
MDNContains the MDN receipt response to a request
ErrorsThis is only written in an error is encountered, containing the error.
AllAll 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: 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 mdn_receipt, and reported in the outgoing MDN. If not possible, the MDN will not be signed, and parse_request will throw an exception unless ErrorProcessingFlags has been configured to prevent this. The following options are supported:

0As Requested
1As Requested Or SHA1
2SHA1
3MD5
4None
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 property may then be set to return a signed receipt.

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 allows the server software to describe the level of user interaction in sending the MDN. MDNSendingMode corresponds to the "disposition-mode" field in the Disposition Header, as described further in RFC 3335. The following values are supported:

0Automatic
1User Configurable
2Manual

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

MDNWarning:   A warning to appear in the MDN.

MDNWarning defines a warning to appear in the outgoing mdn_receipt. If any errors are returned in scan_result and not marked as to be allowed in ErrorReportingFlags the errors will take precedence and the warning will not be reported.

MDNWarning should be assigned when allowing the errors returned in scan_result. The mdn_receipt will indicate successful processing of request, 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 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 is set to Basic, the User and Password are Base64 encoded and the result is put in the Authorization configuration setting in the form "Basic [encoded-user-password]".

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

The User and Password properties must be set only after the url property is set. When the url property is set, for security reasons, User and Password are immediately cleared.

ProcessingError:   A processing error occurred in the received EDI message.

If ProcessingError is set to "True" before invoking create_mdn_receipt, 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 mdn_receipt. The following values are supported:

0As Requested
1PKCS7
2None
By default, the component will honor the request of the client, if possible. If not possible, the mdn_receipt will not be signed, and parse_request will throw an exception unless ErrorProcessingFlags has been configured to prevent this.

If the client does not request a signature, one will not be provided by default. However, the server may provide one by setting ReceiptSigningProtocol to 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 request_headers_string 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 be RSAES-OAEP. If the message was encrypted with any other padding scheme the class fails with an error

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 be RSASSA-PSS. If the message was signed with any other scheme the class fails with an error

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. 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 is set to Basic, the User and Password are Base64 encoded and the result is put in the Authorization configuration setting in the form "Basic [encoded-user-password]".

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

The User and Password properties must be set only after the url property is set. When the url property is set, for security reasons, User and 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 log_directory when MDN delivery fails. When set to True and MDN delivery fails a .wrn file is created in the log_directory. 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 send_async_mdn.

HTTP Config Settings

AcceptEncoding:   Used to tell the server which types of content encodings the client supports.

When 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 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 http_version 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 fails with an error 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 local_file. When set to True, downloaded data will be appended to local_file. This may be used in conjunction with range to resume a failed download. This is applicable only when local_file is set. The default value is False.

Authorization:   The Authorization string to be sent to the server.

If the 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 auth_scheme 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 on_transfer event, by BytesTransferred.

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

This is applicable only when 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 fails with an error.

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 on_redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the on_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 fails with an error 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"), 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 after calling a method. The 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: 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 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 on_log 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 follow_redirects 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 http_version 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 CRLF ("\r\n") .

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 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 proxy_user and proxy_password are specified, this value is calculated using the algorithm specified by proxy_auth_scheme.

ProxyAuthScheme:   The authorization scheme to be used for the proxy.

This configuration setting is provided for use by classs 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 classs that do not directly expose Proxy properties.

ProxyPort:   Port for the proxy server (default 80).

This configuration setting is provided for use by classs 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 classs 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 classs 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 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 Http http = new Http(); http.Config("TransferredRequest=on"); http.PostData = "body"; http.Post("http://someserver.com"); Console.WriteLine(http.Config("TransferredRequest")); C++ 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 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 setting must be set to a value capable of interpreting the specified host name. For instance, to specify UTF-8, set CodePage to 65001. In the C++ Edition for Windows, the *W version of the class must be used. For instance, DNSW or HTTPW.

UsePlatformHTTPClient:   Whether or not to use the platform HTTP client.

When using this configuration setting, if True, the component will use the default HTTP client for the platform (URLConnection in Java, WebRequest in .NET, or CFHTTPMessage in Mac/iOS) instead of the internal HTTP implementation. This is important for environments in which direct access to sockets is limited or not allowed (e.g., in the Google AppEngine).

Note: This setting is applicable only to Mac/iOS editions.

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

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 classs that do not directly expose Firewall properties.

FirewallHost:   Name or IP address of firewall (optional).

If a FirewallHost is given, requested connections will be authenticated through the specified firewall when connecting.

If the FirewallHost setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the 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 classs that do not directly expose Firewall properties.

FirewallPassword:   Password to be used if authentication is to be used when connecting through the firewall.

If FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

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

FirewallPort:   The TCP port for the FirewallHost;.

The FirewallPort is set automatically when FirewallType is set to a valid value.

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

FirewallType:   Determines the type of firewall to connect through.

The appropriate values are as follows:

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

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

FirewallUser:   A user name if authentication is to be used connecting through a firewall.

If the FirewallHost is specified, the FirewallUser and FirewallPassword settings are used to connect and authenticate to the Firewall. If the authentication fails, the class fails with an error.

Note: This setting is provided for use by classs 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 will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by 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 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 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 is a positive value, the system will attempt to send pending data until the specified 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 local_host 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 multi-homed 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 classs) only through that interface.

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

LocalPort:   The port in the local host where the class binds.

This 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 local_port after the connection is established.

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

This; setting is useful when trying to connect to services that require a trusted port in 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 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 bytes are received, the on_data_in event is fired with the EOL parameter set to True, and the buffer is reset.

If no eol is found, and MaxLineLength bytes are accumulated in the buffer, the on_data_in event is fired with the EOL parameter set to False, and the buffer is reset.

The minimum value for 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.nsoftware.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 and 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 true, the socket will send all data that is ready to send at once. When false, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm.

By default, this config is set to false.

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:

0 IPv4 Only
1 IPv6 Only
2 IPv6 with IPv4 fallback

SSL Config Settings

LogSSLPackets:   Controls whether SSL packets are logged when using the internal security API.

When ssl_provider is set to Internal, this setting controls whether SSL packets should be logged. By default, this setting is False, as it is only useful for debugging purposes.

When enabled, SSL packet logs are output using the on_ssl_status event, which will fire each time an SSL packet is sent or received.

Enabling this setting has no effect if ssl_provider 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 etc). OpenSSL recommends to use 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

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

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

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

sequences. Before, between, and after the certificates text is allowed which can be used e.g. for descriptions of the certificates. Please 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.

SSLCACertFilePaths:   The paths to CA certificate files on Unix/Linux.

This setting specifies the paths on disk to CA certificate files on Unix/Linux.

The value is formatted as a list of paths separated by semicolons. The class will check for the existence of each file in the order specified. When a file is found the CA certificates within the file will be loaded and used to determine the validity of server or client certificates.

The default value is:

/etc/ssl/ca-bundle.pem;/etc/pki/tls/certs/ca-bundle.crt;/etc/ssl/certs/ca-certificates.crt;/etc/pki/tls/cacert.pem

SSLCACerts:   A newline separated list of CA certificate to use during SSL client authentication.

This setting specifies one or more CA certificates to be included in the request when performing SSL client authentication. Some servers require the entire chain, including CA certificates, to be presented when performing SSL client authentication. The value of this setting is a newline (CrLf) separated list of certificates. For instance:

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

SSLCheckCRL:   Whether to check the Certificate Revocation List for the server certificate.

This setting specifies whether the class will check the Certificate Revocation List specified by the server certificate. If set to 1 or 2, the class will first obtain the list of CRL URLs from the server certificate's CRL distribution points extension. The class will then make HTTP requests to each CRL endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the class fails with an error.

When set to 0 (default) the CRL check will not be performed by the class. When set to 1, it will attempt to perform the CRL check, but will continue without an error if the server's certificate does not support CRL. When set to 2, it will perform the CRL check and will throw an error if CRL is not supported.

This configuration setting is only supported in the Java, C#, and C++ editions. In the C++ edition, it is only supported on Windows operating systems.

SSLCheckOCSP:   Whether to use OCSP to check the status of the server certificate.

This setting specifies whether the class will use OCSP to check the validity of the server certificate. If set to 1 or 2, the class will first obtain the OCSP URL from the server certificate's OCSP extension. The class will then locate the issuing certificate and make an HTTP request to the OCSP endpoint to check the validity of the server's certificate. If the certificate has been revoked or any other issues are found during validation the class fails with an error.

When set to 0 (default) the class will not perform an OCSP check. When set to 1, it will attempt to perform the OCSP check, but will continue without an error if the server's certificate does not support OCSP. When set to 2, it will perform the OCSP check and will throw an error if OCSP is not supported.

This configuration setting is only supported in the Java, C#, and C++ editions. In the C++ edition, it is only supported on Windows operating systems.

SSLCipherStrength:   The minimum cipher strength used for bulk encryption.

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

Please note that this setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the on_ssl_status event.

Use this 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 is currently not supported. This functionality is instead made available through the OpenSSLCipherList config setting.

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

The enabled cipher suites to be used in SSL negotiation.

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

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

Multiple cipher suites are separated by semicolons.

Example values when ssl_provider is set to Platform: obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=CALG_AES_256"); obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES"); Possible values when ssl_provider is set to Platform include:

  • CALG_3DES
  • CALG_3DES_112
  • CALG_AES
  • CALG_AES_128
  • CALG_AES_192
  • CALG_AES_256
  • CALG_AGREEDKEY_ANY
  • CALG_CYLINK_MEK
  • CALG_DES
  • CALG_DESX
  • CALG_DH_EPHEM
  • CALG_DH_SF
  • CALG_DSS_SIGN
  • CALG_ECDH
  • CALG_ECDH_EPHEM
  • CALG_ECDSA
  • CALG_ECMQV
  • CALG_HASH_REPLACE_OWF
  • CALG_HUGHES_MD5
  • CALG_HMAC
  • CALG_KEA_KEYX
  • CALG_MAC
  • CALG_MD2
  • CALG_MD4
  • CALG_MD5
  • CALG_NO_SIGN
  • CALG_OID_INFO_CNG_ONLY
  • CALG_OID_INFO_PARAMETERS
  • CALG_PCT1_MASTER
  • CALG_RC2
  • CALG_RC4
  • CALG_RC5
  • CALG_RSA_KEYX
  • CALG_RSA_SIGN
  • CALG_SCHANNEL_ENC_KEY
  • CALG_SCHANNEL_MAC_KEY
  • CALG_SCHANNEL_MASTER_HASH
  • CALG_SEAL
  • CALG_SHA
  • CALG_SHA1
  • CALG_SHA_256
  • CALG_SHA_384
  • CALG_SHA_512
  • CALG_SKIPJACK
  • CALG_SSL2_MASTER
  • CALG_SSL3_MASTER
  • CALG_SSL3_SHAMD5
  • CALG_TEK
  • CALG_TLS1_MASTER
  • CALG_TLS1PRF
Example values when ssl_provider is set to Internal: 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_DH_ANON_WITH_AES_128_CBC_SHA"); Possible values when ssl_provider is set to Internal include:
  • 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_DH_RSA_WITH_AES_128_GCM_SHA256 (Not Recommended)
  • TLS_DH_RSA_WITH_AES_256_GCM_SHA384 (Not Recommended)
  • TLS_DH_DSS_WITH_AES_128_GCM_SHA256 (Not Recommended)
  • TLS_DH_DSS_WITH_AES_256_GCM_SHA384 (Not Recommended)
  • 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) only the following cipher suites are supported:

  • TLS_AES_256_GCM_SHA384
  • TLS_CHACHA20_POLY1305_SHA256
  • TLS_AES_128_GCM_SHA256

SSLEnabledCipherSuites is used together with SSLCipherStrength.

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

Used to enable/disable the supported security protocols.

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

TLS1.312288 (Hex 3000)
TLS1.23072 (Hex C00) (Default)
TLS1.1768 (Hex 300) (Default)
TLS1 192 (Hex C0) (Default)
SSL3 48 (Hex 30)
SSL2 12 (Hex 0C)

SSLEnabledProtocols - TLS 1.3 Notes

By default when TLS 1.3 is enabled the class will use the internal TLS implementation when the ssl_provider is set to Automatic for all editions.

In editions which are designed to run on Windows ssl_provider can be set to Platform to use the platform implementation instead of the internal implementation. When configured in this manner, please note that the platform provider is only supported on Windows 11 / Windows Server 2022 and up. The default internal provider is available on all platforms and is not restricted to any specific OS version.

If set to 1 (Platform provider) please be aware of the following notes:

  • The platform provider is only available on Windows 11 / Windows Server 2022 and up.
  • SSLEnabledCipherSuites and other similar SSL configuration settings are not supported.
  • If SSLEnabledProtocols includes both TLS 1.3 and TLS 1.2 the above restrictions are still applicable even if TLS 1.2 is negotiated. Enabling TLS 1.3 with the platform provider changes the implementation used for all TLS versions.

SSLEnableRenegotiation:   Whether the renegotiation_info SSL extension is supported.

This setting specifies whether the renegotiation_info SSL extension will be used in the request when using the internal security API. This setting is True by default, but can be set to False to disable the extension.

This setting is only applicable when ssl_provider is set to Internal.

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

This setting specifies whether the Encoded parameter of the on_ssl_server_authentication 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 on_ssl_server_authentication event.

If set to True all certificates returned by the server will be present in the Encoded parameter of the on_ssl_server_authentication 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 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 traffice for debugging purposes. When writing to this file the class will only append, it will not overwrite previous values.

Note: This setting is only applicable when ssl_provider is set to Internal.

SSLNegotiatedCipher:   Returns the negotiated cipher suite.

Returns the cipher suite negotiated during the SSL handshake.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipher[connId]");

SSLNegotiatedCipherStrength:   Returns the negotiated cipher suite strength.

Returns the strength of the cipher suite negotiated during the SSL handshake.

Note: For server components (e.g.TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipherStrength[connId]");

SSLNegotiatedCipherSuite:   Returns the negotiated cipher suite.

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 setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedCipherSuite[connId]");

SSLNegotiatedKeyExchange:   Returns the negotiated key exchange algorithm.

Returns the key exchange algorithm negotiated during the SSL handshake.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedKeyExchange[connId]");

SSLNegotiatedKeyExchangeStrength:   Returns the negotiated key exchange algorithm strength.

Returns the strenghth of the key exchange algorithm negotiated during the SSL handshake.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedKeyExchangeStrength[connId]");

SSLNegotiatedVersion:   Returns the negotiated protocol version.

Returns the protocol version negotiated during the SSL handshake.

Note: For server components (e.g. TCPServer) this is a per-connection setting accessed by passing the ConnectionId. For example: server.Config("SSLNegotiatedVersion[connId]");

SSLSecurityFlags:   Flags that control certificate verification.

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

0x00000001Ignore time validity status of certificate.
0x00000002Ignore time validity status of CTL.
0x00000004Ignore non-nested certificate times.
0x00000010Allow unknown Certificate Authority.
0x00000020Ignore wrong certificate usage.
0x00000100Ignore unknown certificate revocation status.
0x00000200Ignore unknown CTL signer revocation status.
0x00000400Ignore unknown Certificate Authority revocation status.
0x00000800Ignore unknown Root revocation status.
0x00008000Allow test Root certificate.
0x00004000Trust test Root certificate.
0x80000000Ignore non-matching CN (certificate CN not-matching server name).

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

SSLServerCACerts:   A newline separated list of CA certificate to use during SSL server certificate validation.

This setting optionally specifies one or more CA certificates to be used when 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 setting should only be set 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 setting is a newline (CrLf) separated list of certificates. For instance:

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

TLS12SignatureAlgorithms:   Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.

This setting specifies the allowed server certificate signature algorithms when ssl_provider is set to Internal and 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 setting. If the server certificate signature algorithm is unsupported the class fails with an error.

The format of this value is a comma separated list of hash-signature combinations. For instance: 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 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.

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

TLS12SupportedGroups:   The supported groups for ECC.

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

The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.

When using TLS 1.2 and ssl_provider 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 setting specifies a comma separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional round trip during the handshake if the group is supported by the server.

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

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

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

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

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

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

TLS13SignatureAlgorithms:   The allowed certificate signature algorithms.

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

  • "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 setting is only applicable when SSLEnabledProtocols includes TLS 1.3.
TLS13SupportedGroups:   The supported groups for (EC)DHE key exchange.

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

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

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

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

Socket Config Settings

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

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

Note: This option is not valid for 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 TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. Increasing the value of the InBufferSize setting can provide significant improvements in performance in some cases.

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. Increasing the value of the OutBufferSize setting can provide significant improvements in performance in some cases.

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:

IdentifierName
037IBM EBCDIC - U.S./Canada
437OEM - United States
500IBM EBCDIC - International
708Arabic - ASMO 708
709Arabic - ASMO 449+, BCON V4
710Arabic - Transparent Arabic
720Arabic - Transparent ASMO
737OEM - Greek (formerly 437G)
775OEM - Baltic
850OEM - Multilingual Latin I
852OEM - Latin II
855OEM - Cyrillic (primarily Russian)
857OEM - Turkish
858OEM - Multilingual Latin I + Euro symbol
860OEM - Portuguese
861OEM - Icelandic
862OEM - Hebrew
863OEM - Canadian-French
864OEM - Arabic
865OEM - Nordic
866OEM - Russian
869OEM - Modern Greek
870IBM EBCDIC - Multilingual/ROECE (Latin-2)
874ANSI/OEM - Thai (same as 28605, ISO 8859-15)
875IBM EBCDIC - Modern Greek
932ANSI/OEM - Japanese, Shift-JIS
936ANSI/OEM - Simplified Chinese (PRC, Singapore)
949ANSI/OEM - Korean (Unified Hangul Code)
950ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)
1026IBM EBCDIC - Turkish (Latin-5)
1047IBM EBCDIC - Latin 1/Open System
1140IBM EBCDIC - U.S./Canada (037 + Euro symbol)
1141IBM EBCDIC - Germany (20273 + Euro symbol)
1142IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)
1143IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)
1144IBM EBCDIC - Italy (20280 + Euro symbol)
1145IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)
1146IBM EBCDIC - United Kingdom (20285 + Euro symbol)
1147IBM EBCDIC - France (20297 + Euro symbol)
1148IBM EBCDIC - International (500 + Euro symbol)
1149IBM EBCDIC - Icelandic (20871 + Euro symbol)
1200Unicode UCS-2 Little-Endian (BMP of ISO 10646)
1201Unicode UCS-2 Big-Endian
1250ANSI - Central European
1251ANSI - Cyrillic
1252ANSI - Latin I
1253ANSI - Greek
1254ANSI - Turkish
1255ANSI - Hebrew
1256ANSI - Arabic
1257ANSI - Baltic
1258ANSI/OEM - Vietnamese
1361Korean (Johab)
10000MAC - Roman
10001MAC - Japanese
10002MAC - Traditional Chinese (Big5)
10003MAC - Korean
10004MAC - Arabic
10005MAC - Hebrew
10006MAC - Greek I
10007MAC - Cyrillic
10008MAC - Simplified Chinese (GB 2312)
10010MAC - Romania
10017MAC - Ukraine
10021MAC - Thai
10029MAC - Latin II
10079MAC - Icelandic
10081MAC - Turkish
10082MAC - Croatia
12000Unicode UCS-4 Little-Endian
12001Unicode UCS-4 Big-Endian
20000CNS - Taiwan
20001TCA - Taiwan
20002Eten - Taiwan
20003IBM5550 - Taiwan
20004TeleText - Taiwan
20005Wang - Taiwan
20105IA5 IRV International Alphabet No. 5 (7-bit)
20106IA5 German (7-bit)
20107IA5 Swedish (7-bit)
20108IA5 Norwegian (7-bit)
20127US-ASCII (7-bit)
20261T.61
20269ISO 6937 Non-Spacing Accent
20273IBM EBCDIC - Germany
20277IBM EBCDIC - Denmark/Norway
20278IBM EBCDIC - Finland/Sweden
20280IBM EBCDIC - Italy
20284IBM EBCDIC - Latin America/Spain
20285IBM EBCDIC - United Kingdom
20290IBM EBCDIC - Japanese Katakana Extended
20297IBM EBCDIC - France
20420IBM EBCDIC - Arabic
20423IBM EBCDIC - Greek
20424IBM EBCDIC - Hebrew
20833IBM EBCDIC - Korean Extended
20838IBM EBCDIC - Thai
20866Russian - KOI8-R
20871IBM EBCDIC - Icelandic
20880IBM EBCDIC - Cyrillic (Russian)
20905IBM EBCDIC - Turkish
20924IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)
20932JIS X 0208-1990 & 0121-1990
20936Simplified Chinese (GB2312)
21025IBM EBCDIC - Cyrillic (Serbian, Bulgarian)
21027Extended Alpha Lowercase
21866Ukrainian (KOI8-U)
28591ISO 8859-1 Latin I
28592ISO 8859-2 Central Europe
28593ISO 8859-3 Latin 3
28594ISO 8859-4 Baltic
28595ISO 8859-5 Cyrillic
28596ISO 8859-6 Arabic
28597ISO 8859-7 Greek
28598ISO 8859-8 Hebrew
28599ISO 8859-9 Latin 5
28605ISO 8859-15 Latin 9
29001Europa 3
38598ISO 8859-8 Hebrew
50220ISO 2022 Japanese with no halfwidth Katakana
50221ISO 2022 Japanese with halfwidth Katakana
50222ISO 2022 Japanese JIS X 0201-1989
50225ISO 2022 Korean
50227ISO 2022 Simplified Chinese
50229ISO 2022 Traditional Chinese
50930Japanese (Katakana) Extended
50931US/Canada and Japanese
50933Korean Extended and Korean
50935Simplified Chinese Extended and Simplified Chinese
50936Simplified Chinese
50937US/Canada and Traditional Chinese
50939Japanese (Latin) Extended and Japanese
51932EUC - Japanese
51936EUC - Simplified Chinese
51949EUC - Korean
51950EUC - Traditional Chinese
52936HZ-GB2312 Simplified Chinese
54936Windows XP: GB18030 Simplified Chinese (4 Byte)
57002ISCII Devanagari
57003ISCII Bengali
57004ISCII Tamil
57005ISCII Telugu
57006ISCII Assamese
57007ISCII Oriya
57008ISCII Kannada
57009ISCII Malayalam
57010ISCII Gujarati
57011ISCII Punjabi
65000Unicode UTF-7
65001Unicode UTF-8
The following is a list of valid code page identifiers for Mac OS only:
IdentifierName
1ASCII
2NEXTSTEP
3JapaneseEUC
4UTF8
5ISOLatin1
6Symbol
7NonLossyASCII
8ShiftJIS
9ISOLatin2
10Unicode
11WindowsCP1251
12WindowsCP1252
13WindowsCP1253
14WindowsCP1254
15WindowsCP1250
21ISO2022JP
30MacOSRoman
10UTF16String
0x90000100UTF16BigEndian
0x94000100UTF16LittleEndian
0x8c000100UTF32String
0x98000100UTF32BigEndian
0x9c000100UTF32LittleEndian
65536Proprietary

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.
MaskSensitive:   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.

This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

ProcessIdleEvents:   Whether the class uses its internal event loop to process events when the main thread is idle.

If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True.

SelectWaitMillis:   The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.

If there are no events to process when do_events is called, the class will wait for the amount of time specified here before returning. The default value is 20.

UseFIPSCompliantAPI:   Tells the class whether or not to use FIPS certified APIs.

When set to True, the class will utilize the underlying operating system's certified APIs. Java editions, regardless of OS, utilize Bouncy Castle FIPS, while all the other Windows editions make use of Microsoft security libraries.

FIPS mode can be enabled by setting the UseFIPSCompliantAPI configuration setting to True. This is a static setting which applies to all instances of all classes of the toolkit within the process. It is recommended to enable or disable this setting once before the component has been used to establish a connection. Enabling FIPS while an instance of the component is active and connected may result in unexpected behavior.

For more details please see the FIPS 140-2 Compliance article.

Note: This setting is only applicable on Windows.

Note: Enabling FIPS-compliance requires a special license; please contact sales@nsoftware.com for details.

UseInternalSecurityAPI:   Tells the class 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 setting to True tells the class to use the internal implementation instead of using the system security libraries.

On Windows, this setting is set to False by default. On Linux/macOS, this setting is set to True by default.

To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section.

AS2Receiver Errors

Note: The starred errors may be ignored by configuring the ErrorProcessingFlags and 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.
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.