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.

Method List

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

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.

Config Settings

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

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:

• attachment_content_type
• attachment_data
• attachment_file_name
• attachment_headers
• attachment_name

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_file_name Property

The file name of the attachment.

Syntax

def get_attachment_file_name(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_file_name 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:

• cem_accepted
• cem_cert_id
• cem_cert_issuer
• cem_cert_serial_number
• cem_cert_store
• cem_cert_store_password
• cem_cert_store_type
• cem_cert_subject
• cem_cert_usage
• cem_rejection_reason
• cem_respond_by_date
• cem_response_url

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 designations are the most common User and Machine certificate stores in Windows:

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

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:

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 as follows:

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 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_store Property

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

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 designations are the most common User and Machine certificate stores in Windows:

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

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

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

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:

cert_subject Property

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

The subject of the certificate used for client authentication.

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

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

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

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

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

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

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

cert_encoded Property

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

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.

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

edi_file_name 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_file_name() -> str: ...

edi_file_name = property(get_edi_file_name, None)

Default Value

""

Remarks

In a sender, if edi_file_name 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.

firewall_auto_detect Property

Whether 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

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

firewall_type Property

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

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

firewall_host Property

The name or IP address of the 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

The name or IP address of the 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

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

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

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

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

A username if authentication is to be used when 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

A username if authentication is to be used when connecting through a firewall. If firewall_host is specified, this property and the firewall_password property 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

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

In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.

If the class is connected, the 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 multihomed 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:

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:

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:

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:

• request_header_field
• request_header_value

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_store Property

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

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 designations are the most common User and Machine certificate stores in Windows:

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

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

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

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:

rollover_cert_subject Property

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

The subject of the certificate used for client authentication.

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

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

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

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

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

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

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

rollover_cert_encoded Property

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

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.

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.

This property is read-only.

signer_cert_store Property

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

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 designations are the most common User and Machine certificate stores in Windows:

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

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

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

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:

signer_cert_subject Property

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

The subject of the certificate used for client authentication.

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

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

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

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

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

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

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

signer_cert_encoded Property

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

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.

ssl_accept_server_cert_store Property

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

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 designations are the most common User and Machine certificate stores in Windows:

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

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

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

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:

ssl_accept_server_cert_subject Property

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

The subject of the certificate used for client authentication.

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

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

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

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

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

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

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

ssl_accept_server_cert_encoded Property

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

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_cert_store Property

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

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 designations are the most common User and Machine certificate stores in Windows:

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

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

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

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:

ssl_cert_subject Property

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

The subject of the certificate used for client authentication.

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

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

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

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

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

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

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

ssl_cert_encoded Property

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

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.

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:

• as2_from
• as2_to
• AS2VersionIncoming
• message_id
• mdn_to
• receipt_delivery_option
• RequestedSignatureProtocol
• RequestedMICAlgorithms

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

• cem_cert_store_type
• cem_cert_store
• cem_cert_subject
• cem_cert_usage
• cem_cert_issuer
• cem_cert_serial_number
• cem_cert_id
• cem_respond_by_date
• cem_response_url

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 as2_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:

• cem_cert_issuer
• cem_cert_serial_number
• cem_accepted
• cem_rejection_reason

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

Fired when information is available 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.

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

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:

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

Fired when secure connection progress messages are available.

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. This event tracks the progress of the connection.

AS2Receiver Config Settings

AS2Receiver Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

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

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

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

Socket Config Settings

Base Config Settings

AS2Receiver Errors

AS2Receiver Errors

SMIME Errors