AS3Sender Class

Properties   Methods   Events   Config Settings   Errors  

The AS3Sender class implements an AS3 / EDI-INT client.

Syntax

class ipworksedi.AS3Sender

Remarks

The AS3Sender component may be used to send EDI or other messages over FTP/S, using the AS3 protocol. It may also be used to verify Message Disposition Notifications (MDNs) returned by the server.

A typical AS3 transaction is as follows:

(1) The sender sends an EDI document to the receiver using FTP. The document may be signed, encrypted, and/or compressed, and a signed or unsigned receipt may be requested.

(2) The receiver decompresses and decrypts the message and verifies the signature.

(3) The receiver sends a signed receipt back to the client. The signature is over the hash of an MDN, which contains a hash of the received message.

When sending an EDI message, the client should specify, at a minimum, as3_from and as3_to, edi_data, and edi_type. You will also need to specify user, password, and remote_host to logon to the FTP server. After doing this you may send the data by calling send.

To secure the EDI transmission, the message may be signed and/or encrypted by setting the appropriate certificates. By default, the class will apply message security if the appropriate certificates are specified. To sign the data set signing_cert. To encrypt, set recipient_certs.

TLS/SSL may be enabled by setting the ssl_start_mode property. In case your trading partner is using a self-signed certificate it will be necessary to set ssl_accept_server_cert or trap the on_ssl_server_authentication event to accept the certificate.

The message may also be compressed by setting compression_format.

To request a receipt, or Message Disposition Notification (MDN), simply set the mdn_to property. The MDN will be returned to the FTP URL specified. The mdn_options property may be used to customize the request. By default, the class will request a signed MDN over an SHA1 hash.

Validating AS3 MDNs

AS3 MDNs will be returned asynchronously over a separate connection. You may verify MDNs by invoking read_receipt. This will read the receipt from the FTP server (or from the mdn_receipt property). It will determine the message_id of the original message and determine the originator and recipient of the MDN.

You should then look up your trading partner's certificates as well as the original_content_mic (which you must store externally to verify signed receipts), and invoke verify_receipt.

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.

as3_from property

The identity of the sending system.

Syntax

def get_as3_from() -> str: ...

def set_as3_from(value: str) -> None: ...


as3_from = property(get_as3_from, set_as3_from)

Default Value

""

Remarks

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

Required.

as3_to property

The identity of the receiving system.

Syntax

def get_as3_to() -> str: ...

def set_as3_to(value: str) -> None: ...


as3_to = property(get_as3_to, set_as3_to)

Default Value

""

Remarks

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

Required.

as3_version property

The version of AS3 being used.

Syntax

def get_as3_version() -> str: ...

def set_as3_version(value: str) -> None: ...


as3_version = property(get_as3_version, set_as3_version)

Default Value

"1.0"

Remarks

The version of AS3 being used. Should be "1.0".

attachment_count property

The number of records in the Attachment arrays.

Syntax

def get_attachment_count() -> int: ...

def set_attachment_count(value: int) -> None: ...


attachment_count = property(get_attachment_count, set_attachment_count)

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.

attachment_content_type property

The MIME content-type of this ediattachment .

Syntax

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

def set_attachment_content_type(attachment_index: int, value: str) -> None: ...

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.

attachment_data property

This property contains the attachment data.

Syntax

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

def set_attachment_data(attachment_index: int, value: bytes) -> None: ...

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.

attachment_file_name property

The file name of the attachment.

Syntax

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

def set_attachment_file_name(attachment_index: int, value: str) -> None: ...

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.

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

def set_attachment_headers(attachment_index: int, value: str) -> None: ...

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

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

def set_attachment_name(attachment_index: int, value: str) -> None: ...

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.

compression_format property

The compression format (if any) to use.

Syntax

def get_compression_format() -> int: ...

def set_compression_format(value: int) -> None: ...


compression_format = property(get_compression_format, set_compression_format)

Possible Values

0 # None
1 # ZLIB

Default Value

0

Remarks

By default, outgoing data will not be compressed. Setting this property will instruct the class to compress the outgoing data using the indicated format.

Compression is highly recommended for large messages, as it will reduce network bandwidth and processing time required.

The compression algorithm used is Zlib, as required by RFC 3274 and defined in RFCs 1950 and 1951.

connected property

Whether the class is connected.

Syntax

def get_connected() -> bool: ...


connected = property(get_connected, None)

Default Value

False

Remarks

This property is used to determine whether or not the class is connected to the remote host. Use the connect and disconnect methods to manage the connection.

This property is read-only.

edi_data property

This property contains the EDI payload of the transmission.

Syntax

def get_edi_data() -> bytes: ...

def set_edi_data(value: bytes) -> None: ...


edi_data = property(get_edi_data, set_edi_data)

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.

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

def set_edi_file_name(value: str) -> None: ...


edi_file_name = property(get_edi_file_name, set_edi_file_name)

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.

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

def set_edi_name(value: str) -> None: ...


edi_name = property(get_edi_name, set_edi_name)

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.

edi_type property

The Content-Type of the EDI message.

Syntax

def get_edi_type() -> str: ...

def set_edi_type(value: str) -> None: ...


edi_type = property(get_edi_type, set_edi_type)

Default Value

""

Remarks

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

encryption_algorithm property

The algorithm used to encrypt the EDI data.

Syntax

def get_encryption_algorithm() -> str: ...

def set_encryption_algorithm(value: str) -> None: ...


encryption_algorithm = property(get_encryption_algorithm, set_encryption_algorithm)

Default Value

"AESCBC256"

Remarks

If recipient_certs contains a valid certificate, the data will be encrypted using this certificate and the algorithm specified in encryption_algorithm. If encryption_algorithm is set to the empty string, the data will not be encrypted.

The class supports "AESCBC256", or industry-standard 256-bit AES-CBC encryption, by default.

The class supports "AES" encryption with a default keysize of 128 bits. You may also set "AESCBC192", "AESCBC256", "AESGCM128", "AESGCM192", or "AESGCM256" for other AES modes and keysizes. 3DES and DES remain available for legacy interoperability.

Possible values are:

• 3DES
• DES
• AESCBC128
• AESCBC192
• AESCBC256 (default)
• AESGCM128
• AESGCM192
• AESGCM256

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

Possible Values

0 # None
1 # Tunnel
2 # SOCKS4
3 # SOCKS5
10 # SOCKS4A

Default Value

0

Remarks

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

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.

ftp_last_reply property

The last reply from the FTP server.

Syntax

def get_ftp_last_reply() -> str: ...


ftp_last_reply = property(get_ftp_last_reply, None)

Default Value

""

Remarks

The last reply from the FTP server.

This property is read-only.

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 classes) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.

If the class is connected, the 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 LogDirectory will instruct the component to log the details of each transmission to unique files in the specified directory. For each request processed, the class will log the original EDI data, the complete text of the outgoing request and the incoming response.

The class will write a file for each transmission, with extension ".log". In case of error an additional file will be written with extension ".err", and the error will be reported in both files. Raw AS3 messages created or downloaded by the class will be written with extension ".as3", and MDNs created or downloaded will be written with extension ".as3-mdn".

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 ".log" or ".err".

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 two log files will be written in the specified directory and log_file will contain the path.

log_file will in fact refer to several files with appropriate extensions. A diagnostic log will be written with filename log_file + ".log", and any EDI data read will be written with filename log_file + ".dat". Raw AS3 messages and MDNs will also be written with extensions ".as3" and ".as3-mdn".

This property is read-only.

mdn_options property

Used to indicate the options requested for the MDN receipt.

Syntax

def get_mdn_options() -> str: ...

def set_mdn_options(value: str) -> None: ...


mdn_options = property(get_mdn_options, set_mdn_options)

Default Value

"signed-receipt-protocol=optional, pkcs7-signature; signed-receipt-micalg=optional, sha-256"

Remarks

By default, the class will request that the MDN be signed with a PKCS#7 signature over a SHA-256 hash, which is the industry standard.

Set mdn_options to an empty string to request an unsigned receipt.

This property will automatically be updated when signature_algorithm is set. Normally you will not need to set this property, however you can set a value here to override the automatically generated value.

The string format is that of the Disposition-Notification-Options HTTP header, as specified in RFC 3335. As a form of shorthand, you may set this property to "sha1", "sha-256", or "md5" to request the indicated hash algorithm.

When as2_version is set to "1.3", MD5, SHA-1, and SHA-224 are not allowed in the requested MIC algorithms. SHA-256, SHA-384, or SHA-512 are recommended instead.

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 system to which an MDN should be directed.

Syntax

def get_mdn_to() -> str: ...

def set_mdn_to(value: str) -> None: ...


mdn_to = property(get_mdn_to, set_mdn_to)

Default Value

""

Remarks

If this property is set, a Disposition-Notification-To header will be added to the request, and an MDN will be requested. You should specify a valid FTP URL for the request, e.g., "ftp://123.0.0.1".

By default, the class will request a PKCS#7 signature signed over SHA-1. You may set mdn_options to customize this.

message_id property

The Id of the message.

Syntax

def get_message_id() -> str: ...

def set_message_id(value: str) -> None: ...


message_id = property(get_message_id, set_message_id)

Default Value

""

Remarks

The Id format is as in RFC 2822: id-left@id-right .

A unique Id will automatically be generated on startup. Sending a message will reset id-left if the MessageId has been used in the previous message.

If you set message_id to a string of the form "@(id-right)" a unique id-left will be generated. If you set message_id to an empty string, a new message_id will be generated with the same id-right.

After an mdn_receipt is returned or set, message_id will contain the Original-Message-ID found in the MDN Receipt.

original_content_mic property

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

Syntax

def get_original_content_mic() -> str: ...

def set_original_content_mic(value: str) -> None: ...


original_content_mic = property(get_original_content_mic, set_original_content_mic)

Default Value

""

Remarks

A MIC will be calculated over the outgoing message using the same algorithm in the signature_algorithm configuration used to sign the message. The property will be set when post (in AS3, send) is invoked, and the MIC will automatically be checked against the Original-Content-MIC in the MDN for synchronous MDNs.

The format is in RFC 3335, i.e. w7AguNJEmhF/qIjJw6LnnA==, md5, with a newline at the end.

If you are requesting an asynchronous MDN, you must save this value externally so that it can be loaded when the MDN is received (you may also use async_mdn_info_dir).

passive property

This controls whether or not to direct the server into a passive mode. It is recommended if behind a firewall.

Syntax

def get_passive() -> bool: ...

def set_passive(value: bool) -> None: ...


passive = property(get_passive, set_passive)

Default Value

True

Remarks

This property controls whether or not to direct the server into a passive mode. Many firewalls will not allow the FTP server to open a connection from outside to the higher ports where the FTP client class expects them to be. If passive is set to TRUE, the class will use the PASV command instead of the PORT command and thus will direct the server into a passive mode: connections are initiated only by the client.

password property

This is the password used to log in.

Syntax

def get_password() -> str: ...

def set_password(value: str) -> None: ...


password = property(get_password, set_password)

Default Value

""

Remarks

This property contains the password used to log in. It must be set before the class connects to the FTP server.

receipt_signer_cert_effective_date property

The date on which this certificate becomes valid.

Syntax

def get_receipt_signer_cert_effective_date() -> str: ...


receipt_signer_cert_effective_date = property(get_receipt_signer_cert_effective_date, None)

Default Value

""

Remarks

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

23-Jan-2000 15:00:00.

This property is read-only.

receipt_signer_cert_encoded property

The certificate (PEM/Base64 encoded).

Syntax

def get_receipt_signer_cert_encoded() -> bytes: ...

def set_receipt_signer_cert_encoded(value: bytes) -> None: ...


receipt_signer_cert_encoded = property(get_receipt_signer_cert_encoded, set_receipt_signer_cert_encoded)

Default Value

""

Remarks

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

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

receipt_signer_cert_expiration_date property

The date on which the certificate expires.

Syntax

def get_receipt_signer_cert_expiration_date() -> str: ...


receipt_signer_cert_expiration_date = property(get_receipt_signer_cert_expiration_date, None)

Default Value

""

Remarks

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

23-Jan-2001 15:00:00.

This property is read-only.

receipt_signer_cert_extended_key_usage property

A comma-delimited list of extended key usage identifiers.

Syntax

def get_receipt_signer_cert_extended_key_usage() -> str: ...


receipt_signer_cert_extended_key_usage = property(get_receipt_signer_cert_extended_key_usage, None)

Default Value

""

Remarks

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

This property is read-only.

receipt_signer_cert_fingerprint property

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

def get_receipt_signer_cert_fingerprint() -> str: ...


receipt_signer_cert_fingerprint = property(get_receipt_signer_cert_fingerprint, None)

Default Value

""

Remarks

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

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

This property is read-only.

receipt_signer_cert_fingerprint_sha1 property

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

def get_receipt_signer_cert_fingerprint_sha1() -> str: ...


receipt_signer_cert_fingerprint_sha1 = property(get_receipt_signer_cert_fingerprint_sha1, None)

Default Value

""

Remarks

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

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

This property is read-only.

receipt_signer_cert_fingerprint_sha256 property

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

def get_receipt_signer_cert_fingerprint_sha256() -> str: ...


receipt_signer_cert_fingerprint_sha256 = property(get_receipt_signer_cert_fingerprint_sha256, None)

Default Value

""

Remarks

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

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

This property is read-only.

receipt_signer_cert_issuer property

The issuer of the certificate.

Syntax

def get_receipt_signer_cert_issuer() -> str: ...


receipt_signer_cert_issuer = property(get_receipt_signer_cert_issuer, None)

Default Value

""

Remarks

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

This property is read-only.

receipt_signer_cert_private_key property

The private key of the certificate (if available).

Syntax

def get_receipt_signer_cert_private_key() -> str: ...


receipt_signer_cert_private_key = property(get_receipt_signer_cert_private_key, None)

Default Value

""

Remarks

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

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

This property is read-only.

receipt_signer_cert_private_key_available property

Whether a PrivateKey is available for the selected certificate.

Syntax

def get_receipt_signer_cert_private_key_available() -> bool: ...


receipt_signer_cert_private_key_available = property(get_receipt_signer_cert_private_key_available, None)

Default Value

False

Remarks

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

This property is read-only.

receipt_signer_cert_private_key_container property

The name of the PrivateKey container for the certificate (if available).

Syntax

def get_receipt_signer_cert_private_key_container() -> str: ...


receipt_signer_cert_private_key_container = property(get_receipt_signer_cert_private_key_container, None)

Default Value

""

Remarks

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

This property is read-only.

receipt_signer_cert_public_key property

The public key of the certificate.

Syntax

def get_receipt_signer_cert_public_key() -> str: ...


receipt_signer_cert_public_key = property(get_receipt_signer_cert_public_key, None)

Default Value

""

Remarks

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

This property is read-only.

receipt_signer_cert_public_key_algorithm property

The textual description of the certificate's public key algorithm.

Syntax

def get_receipt_signer_cert_public_key_algorithm() -> str: ...


receipt_signer_cert_public_key_algorithm = property(get_receipt_signer_cert_public_key_algorithm, None)

Default Value

""

Remarks

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

This property is read-only.

receipt_signer_cert_public_key_length property

The length of the certificate's public key (in bits).

Syntax

def get_receipt_signer_cert_public_key_length() -> int: ...


receipt_signer_cert_public_key_length = property(get_receipt_signer_cert_public_key_length, None)

Default Value

0

Remarks

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

This property is read-only.

receipt_signer_cert_serial_number property

The serial number of the certificate encoded as a string.

Syntax

def get_receipt_signer_cert_serial_number() -> str: ...


receipt_signer_cert_serial_number = property(get_receipt_signer_cert_serial_number, None)

Default Value

""

Remarks

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

This property is read-only.

receipt_signer_cert_signature_algorithm property

The text description of the certificate's signature algorithm.

Syntax

def get_receipt_signer_cert_signature_algorithm() -> str: ...


receipt_signer_cert_signature_algorithm = property(get_receipt_signer_cert_signature_algorithm, None)

Default Value

""

Remarks

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

This property is read-only.

receipt_signer_cert_store property

The name of the certificate store for the client certificate.

Syntax

def get_receipt_signer_cert_store() -> bytes: ...

def set_receipt_signer_cert_store(value: bytes) -> None: ...


receipt_signer_cert_store = property(get_receipt_signer_cert_store, set_receipt_signer_cert_store)

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

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

receipt_signer_cert_store is used in conjunction with the receipt_signer_cert_subject property to specify client certificates. If receipt_signer_cert_store has a value, and receipt_signer_cert_subject or receipt_signer_cert_encoded is set, a search for a certificate is initiated. Please see the receipt_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).

receipt_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_receipt_signer_cert_store_password() -> str: ...

def set_receipt_signer_cert_store_password(value: str) -> None: ...


receipt_signer_cert_store_password = property(get_receipt_signer_cert_store_password, set_receipt_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.

receipt_signer_cert_store_type property

The type of certificate store for this certificate.

Syntax

def get_receipt_signer_cert_store_type() -> int: ...

def set_receipt_signer_cert_store_type(value: int) -> None: ...


receipt_signer_cert_store_type = property(get_receipt_signer_cert_store_type, set_receipt_signer_cert_store_type)

Possible Values

0 # User
1 # Machine
2 # PFXFile
3 # PFXBlob
4 # JKSFile
5 # JKSBlob
6 # PEMKeyFile
7 # PEMKeyBlob
8 # PublicKeyFile
9 # PublicKeyBlob
10 # SSHPublicKeyBlob
11 # P7BFile
12 # P7BBlob
13 # SSHPublicKeyFile
14 # PPKFile
15 # PPKBlob
16 # XMLFile
17 # XMLBlob
18 # JWKFile
19 # JWKBlob
20 # SecurityKey
21 # BCFKSFile
22 # BCFKSBlob
23 # PKCS11
99 # Auto

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:

receipt_signer_cert_subject property

The subject of the certificate used for client authentication.

Syntax

def get_receipt_signer_cert_subject() -> str: ...

def set_receipt_signer_cert_subject(value: str) -> None: ...


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

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

receipt_signer_cert_subject_alt_names property

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

Syntax

def get_receipt_signer_cert_subject_alt_names() -> str: ...


receipt_signer_cert_subject_alt_names = property(get_receipt_signer_cert_subject_alt_names, None)

Default Value

""

Remarks

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

This property is read-only.

receipt_signer_cert_thumbprint_md5 property

The MD5 hash of the certificate.

Syntax

def get_receipt_signer_cert_thumbprint_md5() -> str: ...


receipt_signer_cert_thumbprint_md5 = property(get_receipt_signer_cert_thumbprint_md5, None)

Default Value

""

Remarks

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

This property is read-only.

receipt_signer_cert_thumbprint_sha1 property

The SHA-1 hash of the certificate.

Syntax

def get_receipt_signer_cert_thumbprint_sha1() -> str: ...


receipt_signer_cert_thumbprint_sha1 = property(get_receipt_signer_cert_thumbprint_sha1, None)

Default Value

""

Remarks

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

This property is read-only.

receipt_signer_cert_thumbprint_sha256 property

The SHA-256 hash of the certificate.

Syntax

def get_receipt_signer_cert_thumbprint_sha256() -> str: ...


receipt_signer_cert_thumbprint_sha256 = property(get_receipt_signer_cert_thumbprint_sha256, None)

Default Value

""

Remarks

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

This property is read-only.

receipt_signer_cert_usage property

The text description of UsageFlags .

Syntax

def get_receipt_signer_cert_usage() -> str: ...


receipt_signer_cert_usage = property(get_receipt_signer_cert_usage, None)

Default Value

""

Remarks

The text description of receipt_signer_cert_usage_flags.

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

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

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

This property is read-only.

receipt_signer_cert_usage_flags property

The flags that show intended use for the certificate.

Syntax

def get_receipt_signer_cert_usage_flags() -> int: ...


receipt_signer_cert_usage_flags = property(get_receipt_signer_cert_usage_flags, None)

Default Value

0

Remarks

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

Please see the receipt_signer_cert_usage property for a text representation of receipt_signer_cert_usage_flags.

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

This property is read-only.

receipt_signer_cert_version property

The certificate's version number.

Syntax

def get_receipt_signer_cert_version() -> str: ...


receipt_signer_cert_version = property(get_receipt_signer_cert_version, None)

Default Value

""

Remarks

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

This property is read-only.

recipient_cert_count property

The number of records in the RecipientCert arrays.

Syntax

def get_recipient_cert_count() -> int: ...

def set_recipient_cert_count(value: int) -> None: ...


recipient_cert_count = property(get_recipient_cert_count, set_recipient_cert_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• recipient_cert_effective_date
• recipient_cert_encoded
• recipient_cert_expiration_date
• recipient_cert_extended_key_usage
• recipient_cert_fingerprint
• recipient_cert_fingerprint_sha1
• recipient_cert_fingerprint_sha256
• recipient_cert_issuer
• recipient_cert_private_key
• recipient_cert_private_key_available
• recipient_cert_private_key_container
• recipient_cert_public_key
• recipient_cert_public_key_algorithm
• recipient_cert_public_key_length
• recipient_cert_serial_number
• recipient_cert_signature_algorithm
• recipient_cert_store
• recipient_cert_store_password
• recipient_cert_store_type
• recipient_cert_subject
• recipient_cert_subject_alt_names
• recipient_cert_thumbprint_md5
• recipient_cert_thumbprint_sha1
• recipient_cert_thumbprint_sha256
• recipient_cert_usage
• recipient_cert_usage_flags
• recipient_cert_version

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

recipient_cert_effective_date property

The date on which this certificate becomes valid.

Syntax

def get_recipient_cert_effective_date(recipient_cert_index: int) -> str: ...

Default Value

""

Remarks

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

23-Jan-2000 15:00:00.

The recipient_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the recipient_cert_count property.

This property is read-only.

recipient_cert_encoded property

The certificate (PEM/Base64 encoded).

Syntax

def get_recipient_cert_encoded(recipient_cert_index: int) -> bytes: ...

def set_recipient_cert_encoded(recipient_cert_index: int, value: bytes) -> None: ...

Default Value

""

Remarks

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

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

The recipient_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the recipient_cert_count property.

recipient_cert_expiration_date property

The date on which the certificate expires.

Syntax

def get_recipient_cert_expiration_date(recipient_cert_index: int) -> str: ...

Default Value

""

Remarks

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

23-Jan-2001 15:00:00.

The recipient_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the recipient_cert_count property.

This property is read-only.

recipient_cert_extended_key_usage property

A comma-delimited list of extended key usage identifiers.

Syntax

def get_recipient_cert_extended_key_usage(recipient_cert_index: int) -> str: ...

Default Value

""

Remarks

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

The recipient_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the recipient_cert_count property.

This property is read-only.

recipient_cert_fingerprint property

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

def get_recipient_cert_fingerprint(recipient_cert_index: int) -> str: ...

Default Value

""

Remarks

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

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

The recipient_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the recipient_cert_count property.

This property is read-only.

recipient_cert_fingerprint_sha1 property

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

def get_recipient_cert_fingerprint_sha1(recipient_cert_index: int) -> str: ...

Default Value

""

Remarks

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

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

The recipient_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the recipient_cert_count property.

This property is read-only.

recipient_cert_fingerprint_sha256 property

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

def get_recipient_cert_fingerprint_sha256(recipient_cert_index: int) -> str: ...

Default Value

""

Remarks

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

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

The recipient_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the recipient_cert_count property.

This property is read-only.

recipient_cert_issuer property

The issuer of the certificate.

Syntax

def get_recipient_cert_issuer(recipient_cert_index: int) -> str: ...

Default Value

""

Remarks

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

The recipient_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the recipient_cert_count property.

This property is read-only.

recipient_cert_private_key property

The private key of the certificate (if available).

Syntax

def get_recipient_cert_private_key(recipient_cert_index: int) -> str: ...

Default Value

""

Remarks

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

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

The recipient_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the recipient_cert_count property.

This property is read-only.

recipient_cert_private_key_available property

Whether a PrivateKey is available for the selected certificate.

Syntax

def get_recipient_cert_private_key_available(recipient_cert_index: int) -> bool: ...

Default Value

False

Remarks

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

The recipient_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the recipient_cert_count property.

This property is read-only.

recipient_cert_private_key_container property

The name of the PrivateKey container for the certificate (if available).

Syntax

def get_recipient_cert_private_key_container(recipient_cert_index: int) -> str: ...

Default Value

""

Remarks

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

The recipient_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the recipient_cert_count property.

This property is read-only.

recipient_cert_public_key property

The public key of the certificate.

Syntax

def get_recipient_cert_public_key(recipient_cert_index: int) -> str: ...

Default Value

""

Remarks

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

The recipient_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the recipient_cert_count property.

This property is read-only.

recipient_cert_public_key_algorithm property

The textual description of the certificate's public key algorithm.

Syntax

def get_recipient_cert_public_key_algorithm(recipient_cert_index: int) -> str: ...

Default Value

""

Remarks

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

The recipient_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the recipient_cert_count property.

This property is read-only.

recipient_cert_public_key_length property

The length of the certificate's public key (in bits).

Syntax

def get_recipient_cert_public_key_length(recipient_cert_index: int) -> int: ...

Default Value

0

Remarks

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

The recipient_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the recipient_cert_count property.

This property is read-only.

recipient_cert_serial_number property

The serial number of the certificate encoded as a string.

Syntax

def get_recipient_cert_serial_number(recipient_cert_index: int) -> str: ...

Default Value

""

Remarks

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

The recipient_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the recipient_cert_count property.

This property is read-only.

recipient_cert_signature_algorithm property

The text description of the certificate's signature algorithm.

Syntax

def get_recipient_cert_signature_algorithm(recipient_cert_index: int) -> str: ...

Default Value

""

Remarks

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

The recipient_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the recipient_cert_count property.

This property is read-only.

recipient_cert_store property

The name of the certificate store for the client certificate.

Syntax

def get_recipient_cert_store(recipient_cert_index: int) -> bytes: ...

def set_recipient_cert_store(recipient_cert_index: int, value: bytes) -> None: ...

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

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

recipient_cert_store is used in conjunction with the recipient_cert_subject property to specify client certificates. If recipient_cert_store has a value, and recipient_cert_subject or recipient_cert_encoded is set, a search for a certificate is initiated. Please see the recipient_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).

The recipient_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the recipient_cert_count property.

recipient_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_recipient_cert_store_password(recipient_cert_index: int) -> str: ...

def set_recipient_cert_store_password(recipient_cert_index: int, value: str) -> None: ...

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.

The recipient_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the recipient_cert_count property.

recipient_cert_store_type property

The type of certificate store for this certificate.

Syntax

def get_recipient_cert_store_type(recipient_cert_index: int) -> int: ...

def set_recipient_cert_store_type(recipient_cert_index: int, value: int) -> None: ...

Possible Values

0 # User
1 # Machine
2 # PFXFile
3 # PFXBlob
4 # JKSFile
5 # JKSBlob
6 # PEMKeyFile
7 # PEMKeyBlob
8 # PublicKeyFile
9 # PublicKeyBlob
10 # SSHPublicKeyBlob
11 # P7BFile
12 # P7BBlob
13 # SSHPublicKeyFile
14 # PPKFile
15 # PPKBlob
16 # XMLFile
17 # XMLBlob
18 # JWKFile
19 # JWKBlob
20 # SecurityKey
21 # BCFKSFile
22 # BCFKSBlob
23 # PKCS11
99 # Auto

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 recipient_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the recipient_cert_count property.

recipient_cert_subject property

The subject of the certificate used for client authentication.

Syntax

def get_recipient_cert_subject(recipient_cert_index: int) -> str: ...

def set_recipient_cert_subject(recipient_cert_index: int, value: str) -> None: ...

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

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

The recipient_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the recipient_cert_count property.

recipient_cert_subject_alt_names property

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

Syntax

def get_recipient_cert_subject_alt_names(recipient_cert_index: int) -> str: ...

Default Value

""

Remarks

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

The recipient_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the recipient_cert_count property.

This property is read-only.

recipient_cert_thumbprint_md5 property

The MD5 hash of the certificate.

Syntax

def get_recipient_cert_thumbprint_md5(recipient_cert_index: int) -> str: ...

Default Value

""

Remarks

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

The recipient_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the recipient_cert_count property.

This property is read-only.

recipient_cert_thumbprint_sha1 property

The SHA-1 hash of the certificate.

Syntax

def get_recipient_cert_thumbprint_sha1(recipient_cert_index: int) -> str: ...

Default Value

""

Remarks

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

The recipient_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the recipient_cert_count property.

This property is read-only.

recipient_cert_thumbprint_sha256 property

The SHA-256 hash of the certificate.

Syntax

def get_recipient_cert_thumbprint_sha256(recipient_cert_index: int) -> str: ...

Default Value

""

Remarks

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

The recipient_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the recipient_cert_count property.

This property is read-only.

recipient_cert_usage property

The text description of UsageFlags .

Syntax

def get_recipient_cert_usage(recipient_cert_index: int) -> str: ...

Default Value

""

Remarks

The text description of recipient_cert_usage_flags.

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

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

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

The recipient_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the recipient_cert_count property.

This property is read-only.

recipient_cert_usage_flags property

The flags that show intended use for the certificate.

Syntax

def get_recipient_cert_usage_flags(recipient_cert_index: int) -> int: ...

Default Value

0

Remarks

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

Please see the recipient_cert_usage property for a text representation of recipient_cert_usage_flags.

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

The recipient_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the recipient_cert_count property.

This property is read-only.

recipient_cert_version property

The certificate's version number.

Syntax

def get_recipient_cert_version(recipient_cert_index: int) -> str: ...

Default Value

""

Remarks

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

The recipient_cert_index parameter specifies the index of the item in the array. The size of the array is controlled by the recipient_cert_count property.

This property is read-only.

remote_host property

This is the domain name or IP address of the FTP server.

Syntax

def get_remote_host() -> str: ...

def set_remote_host(value: str) -> None: ...


remote_host = property(get_remote_host, set_remote_host)

Default Value

""

Remarks

This property specifies the IP address (IP number in dotted internet format) or the domain name of the FTP server. It is set before a connection is attempted and cannot be changed once a connection is in progress.

If this property is set to a domain name, a DNS request is initiated and upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, an error is returned.

If the class is configured to use a SOCKS firewall, the value assigned to this property may be preceded with an "*". If this is the case, the host name is passed to the firewall unresolved and the firewall performs the DNS resolution.

remote_port property

This is the port for the FTP service (default is 21).

Syntax

def get_remote_port() -> int: ...

def set_remote_port(value: int) -> None: ...


remote_port = property(get_remote_port, set_remote_port)

Default Value

21

Remarks

This property contains the port for the FTP service, which defaults to 21 if not set. A valid port number (a value between 1 and 65535) is required for the connection to take place. The property must be set before a connection is attempted and cannot be changed once a connection is established. Any attempt to change this property while connected will fail with an error.

For an implicit Secure Sockets Layer (SSL), use port 990 (please see the ssl_start_mode property for more information).

signature_algorithm property

Signature algorithm to be used in outgoing messages.

Syntax

def get_signature_algorithm() -> str: ...

def set_signature_algorithm(value: str) -> None: ...


signature_algorithm = property(get_signature_algorithm, set_signature_algorithm)

Default Value

"sha-256"

Remarks

Signature Algorithm can be set to indicate the preferred signing algorithm. Possible values are:

• sha1
• md5
• sha-256 (or sha256) (default)
• sha-384 (or sha384)
• sha-512 (or sha512)
• sha-224 (or sha224)

The default value is "sha-256". When this property is set the mdn_options property is automatically updated to request the MDN receipt be signed with the same algorithm.

When as2_version is set to "1.3", MD5, SHA-1, and SHA-224 are not allowed for generated messages. "sha-256", "sha-384", or "sha-512" are recommended instead.

signing_cert_effective_date property

The date on which this certificate becomes valid.

Syntax

def get_signing_cert_effective_date() -> str: ...


signing_cert_effective_date = property(get_signing_cert_effective_date, None)

Default Value

""

Remarks

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

23-Jan-2000 15:00:00.

This property is read-only.

signing_cert_encoded property

The certificate (PEM/Base64 encoded).

Syntax

def get_signing_cert_encoded() -> bytes: ...

def set_signing_cert_encoded(value: bytes) -> None: ...


signing_cert_encoded = property(get_signing_cert_encoded, set_signing_cert_encoded)

Default Value

""

Remarks

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

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

signing_cert_expiration_date property

The date on which the certificate expires.

Syntax

def get_signing_cert_expiration_date() -> str: ...


signing_cert_expiration_date = property(get_signing_cert_expiration_date, None)

Default Value

""

Remarks

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

23-Jan-2001 15:00:00.

This property is read-only.

signing_cert_extended_key_usage property

A comma-delimited list of extended key usage identifiers.

Syntax

def get_signing_cert_extended_key_usage() -> str: ...


signing_cert_extended_key_usage = property(get_signing_cert_extended_key_usage, None)

Default Value

""

Remarks

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

This property is read-only.

signing_cert_fingerprint property

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

def get_signing_cert_fingerprint() -> str: ...


signing_cert_fingerprint = property(get_signing_cert_fingerprint, None)

Default Value

""

Remarks

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

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

This property is read-only.

signing_cert_fingerprint_sha1 property

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

def get_signing_cert_fingerprint_sha1() -> str: ...


signing_cert_fingerprint_sha1 = property(get_signing_cert_fingerprint_sha1, None)

Default Value

""

Remarks

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

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

This property is read-only.

signing_cert_fingerprint_sha256 property

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

def get_signing_cert_fingerprint_sha256() -> str: ...


signing_cert_fingerprint_sha256 = property(get_signing_cert_fingerprint_sha256, None)

Default Value

""

Remarks

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

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

This property is read-only.

signing_cert_issuer property

The issuer of the certificate.

Syntax

def get_signing_cert_issuer() -> str: ...


signing_cert_issuer = property(get_signing_cert_issuer, None)

Default Value

""

Remarks

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

This property is read-only.

signing_cert_private_key property

The private key of the certificate (if available).

Syntax

def get_signing_cert_private_key() -> str: ...


signing_cert_private_key = property(get_signing_cert_private_key, None)

Default Value

""

Remarks

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

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

This property is read-only.

signing_cert_private_key_available property

Whether a PrivateKey is available for the selected certificate.

Syntax

def get_signing_cert_private_key_available() -> bool: ...


signing_cert_private_key_available = property(get_signing_cert_private_key_available, None)

Default Value

False

Remarks

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

This property is read-only.

signing_cert_private_key_container property

The name of the PrivateKey container for the certificate (if available).

Syntax

def get_signing_cert_private_key_container() -> str: ...


signing_cert_private_key_container = property(get_signing_cert_private_key_container, None)

Default Value

""

Remarks

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

This property is read-only.

signing_cert_public_key property

The public key of the certificate.

Syntax

def get_signing_cert_public_key() -> str: ...


signing_cert_public_key = property(get_signing_cert_public_key, None)

Default Value

""

Remarks

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

This property is read-only.

signing_cert_public_key_algorithm property

The textual description of the certificate's public key algorithm.

Syntax

def get_signing_cert_public_key_algorithm() -> str: ...


signing_cert_public_key_algorithm = property(get_signing_cert_public_key_algorithm, None)

Default Value

""

Remarks

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

This property is read-only.

signing_cert_public_key_length property

The length of the certificate's public key (in bits).

Syntax

def get_signing_cert_public_key_length() -> int: ...


signing_cert_public_key_length = property(get_signing_cert_public_key_length, None)

Default Value

0

Remarks

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

This property is read-only.

signing_cert_serial_number property

The serial number of the certificate encoded as a string.

Syntax

def get_signing_cert_serial_number() -> str: ...


signing_cert_serial_number = property(get_signing_cert_serial_number, None)

Default Value

""

Remarks

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

This property is read-only.

signing_cert_signature_algorithm property

The text description of the certificate's signature algorithm.

Syntax

def get_signing_cert_signature_algorithm() -> str: ...


signing_cert_signature_algorithm = property(get_signing_cert_signature_algorithm, None)

Default Value

""

Remarks

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

This property is read-only.

signing_cert_store property

The name of the certificate store for the client certificate.

Syntax

def get_signing_cert_store() -> bytes: ...

def set_signing_cert_store(value: bytes) -> None: ...


signing_cert_store = property(get_signing_cert_store, set_signing_cert_store)

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

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

signing_cert_store is used in conjunction with the signing_cert_subject property to specify client certificates. If signing_cert_store has a value, and signing_cert_subject or signing_cert_encoded is set, a search for a certificate is initiated. Please see the signing_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).

signing_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_signing_cert_store_password() -> str: ...

def set_signing_cert_store_password(value: str) -> None: ...


signing_cert_store_password = property(get_signing_cert_store_password, set_signing_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.

signing_cert_store_type property

The type of certificate store for this certificate.

Syntax

def get_signing_cert_store_type() -> int: ...

def set_signing_cert_store_type(value: int) -> None: ...


signing_cert_store_type = property(get_signing_cert_store_type, set_signing_cert_store_type)

Possible Values

0 # User
1 # Machine
2 # PFXFile
3 # PFXBlob
4 # JKSFile
5 # JKSBlob
6 # PEMKeyFile
7 # PEMKeyBlob
8 # PublicKeyFile
9 # PublicKeyBlob
10 # SSHPublicKeyBlob
11 # P7BFile
12 # P7BBlob
13 # SSHPublicKeyFile
14 # PPKFile
15 # PPKBlob
16 # XMLFile
17 # XMLBlob
18 # JWKFile
19 # JWKBlob
20 # SecurityKey
21 # BCFKSFile
22 # BCFKSBlob
23 # PKCS11
99 # Auto

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:

signing_cert_subject property

The subject of the certificate used for client authentication.

Syntax

def get_signing_cert_subject() -> str: ...

def set_signing_cert_subject(value: str) -> None: ...


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

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

signing_cert_subject_alt_names property

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

Syntax

def get_signing_cert_subject_alt_names() -> str: ...


signing_cert_subject_alt_names = property(get_signing_cert_subject_alt_names, None)

Default Value

""

Remarks

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

This property is read-only.

signing_cert_thumbprint_md5 property

The MD5 hash of the certificate.

Syntax

def get_signing_cert_thumbprint_md5() -> str: ...


signing_cert_thumbprint_md5 = property(get_signing_cert_thumbprint_md5, None)

Default Value

""

Remarks

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

This property is read-only.

signing_cert_thumbprint_sha1 property

The SHA-1 hash of the certificate.

Syntax

def get_signing_cert_thumbprint_sha1() -> str: ...


signing_cert_thumbprint_sha1 = property(get_signing_cert_thumbprint_sha1, None)

Default Value

""

Remarks

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

This property is read-only.

signing_cert_thumbprint_sha256 property

The SHA-256 hash of the certificate.

Syntax

def get_signing_cert_thumbprint_sha256() -> str: ...


signing_cert_thumbprint_sha256 = property(get_signing_cert_thumbprint_sha256, None)

Default Value

""

Remarks

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

This property is read-only.

signing_cert_usage property

The text description of UsageFlags .

Syntax

def get_signing_cert_usage() -> str: ...


signing_cert_usage = property(get_signing_cert_usage, None)

Default Value

""

Remarks

The text description of signing_cert_usage_flags.

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

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

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

This property is read-only.

signing_cert_usage_flags property

The flags that show intended use for the certificate.

Syntax

def get_signing_cert_usage_flags() -> int: ...


signing_cert_usage_flags = property(get_signing_cert_usage_flags, None)

Default Value

0

Remarks

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

Please see the signing_cert_usage property for a text representation of signing_cert_usage_flags.

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

This property is read-only.

signing_cert_version property

The certificate's version number.

Syntax

def get_signing_cert_version() -> str: ...


signing_cert_version = property(get_signing_cert_version, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_accept_server_cert_effective_date property

The date on which this certificate becomes valid.

Syntax

def get_ssl_accept_server_cert_effective_date() -> str: ...


ssl_accept_server_cert_effective_date = property(get_ssl_accept_server_cert_effective_date, None)

Default Value

""

Remarks

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

23-Jan-2000 15:00:00.

This property is read-only.

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_accept_server_cert_expiration_date property

The date on which the certificate expires.

Syntax

def get_ssl_accept_server_cert_expiration_date() -> str: ...


ssl_accept_server_cert_expiration_date = property(get_ssl_accept_server_cert_expiration_date, None)

Default Value

""

Remarks

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

23-Jan-2001 15:00:00.

This property is read-only.

ssl_accept_server_cert_extended_key_usage property

A comma-delimited list of extended key usage identifiers.

Syntax

def get_ssl_accept_server_cert_extended_key_usage() -> str: ...


ssl_accept_server_cert_extended_key_usage = property(get_ssl_accept_server_cert_extended_key_usage, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_accept_server_cert_fingerprint property

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

def get_ssl_accept_server_cert_fingerprint() -> str: ...


ssl_accept_server_cert_fingerprint = property(get_ssl_accept_server_cert_fingerprint, None)

Default Value

""

Remarks

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

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

This property is read-only.

ssl_accept_server_cert_fingerprint_sha1 property

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

def get_ssl_accept_server_cert_fingerprint_sha1() -> str: ...


ssl_accept_server_cert_fingerprint_sha1 = property(get_ssl_accept_server_cert_fingerprint_sha1, None)

Default Value

""

Remarks

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

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

This property is read-only.

ssl_accept_server_cert_fingerprint_sha256 property

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

def get_ssl_accept_server_cert_fingerprint_sha256() -> str: ...


ssl_accept_server_cert_fingerprint_sha256 = property(get_ssl_accept_server_cert_fingerprint_sha256, None)

Default Value

""

Remarks

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

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

This property is read-only.

ssl_accept_server_cert_issuer property

The issuer of the certificate.

Syntax

def get_ssl_accept_server_cert_issuer() -> str: ...


ssl_accept_server_cert_issuer = property(get_ssl_accept_server_cert_issuer, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_accept_server_cert_private_key property

The private key of the certificate (if available).

Syntax

def get_ssl_accept_server_cert_private_key() -> str: ...


ssl_accept_server_cert_private_key = property(get_ssl_accept_server_cert_private_key, None)

Default Value

""

Remarks

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

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

This property is read-only.

ssl_accept_server_cert_private_key_available property

Whether a PrivateKey is available for the selected certificate.

Syntax

def get_ssl_accept_server_cert_private_key_available() -> bool: ...


ssl_accept_server_cert_private_key_available = property(get_ssl_accept_server_cert_private_key_available, None)

Default Value

False

Remarks

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

This property is read-only.

ssl_accept_server_cert_private_key_container property

The name of the PrivateKey container for the certificate (if available).

Syntax

def get_ssl_accept_server_cert_private_key_container() -> str: ...


ssl_accept_server_cert_private_key_container = property(get_ssl_accept_server_cert_private_key_container, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_accept_server_cert_public_key property

The public key of the certificate.

Syntax

def get_ssl_accept_server_cert_public_key() -> str: ...


ssl_accept_server_cert_public_key = property(get_ssl_accept_server_cert_public_key, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_accept_server_cert_public_key_algorithm property

The textual description of the certificate's public key algorithm.

Syntax

def get_ssl_accept_server_cert_public_key_algorithm() -> str: ...


ssl_accept_server_cert_public_key_algorithm = property(get_ssl_accept_server_cert_public_key_algorithm, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_accept_server_cert_public_key_length property

The length of the certificate's public key (in bits).

Syntax

def get_ssl_accept_server_cert_public_key_length() -> int: ...


ssl_accept_server_cert_public_key_length = property(get_ssl_accept_server_cert_public_key_length, None)

Default Value

0

Remarks

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

This property is read-only.

ssl_accept_server_cert_serial_number property

The serial number of the certificate encoded as a string.

Syntax

def get_ssl_accept_server_cert_serial_number() -> str: ...


ssl_accept_server_cert_serial_number = property(get_ssl_accept_server_cert_serial_number, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_accept_server_cert_signature_algorithm property

The text description of the certificate's signature algorithm.

Syntax

def get_ssl_accept_server_cert_signature_algorithm() -> str: ...


ssl_accept_server_cert_signature_algorithm = property(get_ssl_accept_server_cert_signature_algorithm, None)

Default Value

""

Remarks

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

This property is read-only.

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)

Possible Values

0 # User
1 # Machine
2 # PFXFile
3 # PFXBlob
4 # JKSFile
5 # JKSBlob
6 # PEMKeyFile
7 # PEMKeyBlob
8 # PublicKeyFile
9 # PublicKeyBlob
10 # SSHPublicKeyBlob
11 # P7BFile
12 # P7BBlob
13 # SSHPublicKeyFile
14 # PPKFile
15 # PPKBlob
16 # XMLFile
17 # XMLBlob
18 # JWKFile
19 # JWKBlob
20 # SecurityKey
21 # BCFKSFile
22 # BCFKSBlob
23 # PKCS11
99 # Auto

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

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

ssl_accept_server_cert_subject_alt_names property

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

Syntax

def get_ssl_accept_server_cert_subject_alt_names() -> str: ...


ssl_accept_server_cert_subject_alt_names = property(get_ssl_accept_server_cert_subject_alt_names, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_accept_server_cert_thumbprint_md5 property

The MD5 hash of the certificate.

Syntax

def get_ssl_accept_server_cert_thumbprint_md5() -> str: ...


ssl_accept_server_cert_thumbprint_md5 = property(get_ssl_accept_server_cert_thumbprint_md5, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_accept_server_cert_thumbprint_sha1 property

The SHA-1 hash of the certificate.

Syntax

def get_ssl_accept_server_cert_thumbprint_sha1() -> str: ...


ssl_accept_server_cert_thumbprint_sha1 = property(get_ssl_accept_server_cert_thumbprint_sha1, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_accept_server_cert_thumbprint_sha256 property

The SHA-256 hash of the certificate.

Syntax

def get_ssl_accept_server_cert_thumbprint_sha256() -> str: ...


ssl_accept_server_cert_thumbprint_sha256 = property(get_ssl_accept_server_cert_thumbprint_sha256, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_accept_server_cert_usage property

The text description of UsageFlags .

Syntax

def get_ssl_accept_server_cert_usage() -> str: ...


ssl_accept_server_cert_usage = property(get_ssl_accept_server_cert_usage, None)

Default Value

""

Remarks

The text description of ssl_accept_server_cert_usage_flags.

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

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

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

This property is read-only.

ssl_accept_server_cert_usage_flags property

The flags that show intended use for the certificate.

Syntax

def get_ssl_accept_server_cert_usage_flags() -> int: ...


ssl_accept_server_cert_usage_flags = property(get_ssl_accept_server_cert_usage_flags, None)

Default Value

0

Remarks

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

Please see the ssl_accept_server_cert_usage property for a text representation of ssl_accept_server_cert_usage_flags.

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

This property is read-only.

ssl_accept_server_cert_version property

The certificate's version number.

Syntax

def get_ssl_accept_server_cert_version() -> str: ...


ssl_accept_server_cert_version = property(get_ssl_accept_server_cert_version, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_cert_effective_date property

The date on which this certificate becomes valid.

Syntax

def get_ssl_cert_effective_date() -> str: ...


ssl_cert_effective_date = property(get_ssl_cert_effective_date, None)

Default Value

""

Remarks

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

23-Jan-2000 15:00:00.

This property is read-only.

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.

ssl_cert_expiration_date property

The date on which the certificate expires.

Syntax

def get_ssl_cert_expiration_date() -> str: ...


ssl_cert_expiration_date = property(get_ssl_cert_expiration_date, None)

Default Value

""

Remarks

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

23-Jan-2001 15:00:00.

This property is read-only.

ssl_cert_extended_key_usage property

A comma-delimited list of extended key usage identifiers.

Syntax

def get_ssl_cert_extended_key_usage() -> str: ...


ssl_cert_extended_key_usage = property(get_ssl_cert_extended_key_usage, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_cert_fingerprint property

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

def get_ssl_cert_fingerprint() -> str: ...


ssl_cert_fingerprint = property(get_ssl_cert_fingerprint, None)

Default Value

""

Remarks

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

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

This property is read-only.

ssl_cert_fingerprint_sha1 property

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

def get_ssl_cert_fingerprint_sha1() -> str: ...


ssl_cert_fingerprint_sha1 = property(get_ssl_cert_fingerprint_sha1, None)

Default Value

""

Remarks

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

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

This property is read-only.

ssl_cert_fingerprint_sha256 property

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

def get_ssl_cert_fingerprint_sha256() -> str: ...


ssl_cert_fingerprint_sha256 = property(get_ssl_cert_fingerprint_sha256, None)

Default Value

""

Remarks

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

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

This property is read-only.

ssl_cert_issuer property

The issuer of the certificate.

Syntax

def get_ssl_cert_issuer() -> str: ...


ssl_cert_issuer = property(get_ssl_cert_issuer, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_cert_private_key property

The private key of the certificate (if available).

Syntax

def get_ssl_cert_private_key() -> str: ...


ssl_cert_private_key = property(get_ssl_cert_private_key, None)

Default Value

""

Remarks

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

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

This property is read-only.

ssl_cert_private_key_available property

Whether a PrivateKey is available for the selected certificate.

Syntax

def get_ssl_cert_private_key_available() -> bool: ...


ssl_cert_private_key_available = property(get_ssl_cert_private_key_available, None)

Default Value

False

Remarks

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

This property is read-only.

ssl_cert_private_key_container property

The name of the PrivateKey container for the certificate (if available).

Syntax

def get_ssl_cert_private_key_container() -> str: ...


ssl_cert_private_key_container = property(get_ssl_cert_private_key_container, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_cert_public_key property

The public key of the certificate.

Syntax

def get_ssl_cert_public_key() -> str: ...


ssl_cert_public_key = property(get_ssl_cert_public_key, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_cert_public_key_algorithm property

The textual description of the certificate's public key algorithm.

Syntax

def get_ssl_cert_public_key_algorithm() -> str: ...


ssl_cert_public_key_algorithm = property(get_ssl_cert_public_key_algorithm, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_cert_public_key_length property

The length of the certificate's public key (in bits).

Syntax

def get_ssl_cert_public_key_length() -> int: ...


ssl_cert_public_key_length = property(get_ssl_cert_public_key_length, None)

Default Value

0

Remarks

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

This property is read-only.

ssl_cert_serial_number property

The serial number of the certificate encoded as a string.

Syntax

def get_ssl_cert_serial_number() -> str: ...


ssl_cert_serial_number = property(get_ssl_cert_serial_number, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_cert_signature_algorithm property

The text description of the certificate's signature algorithm.

Syntax

def get_ssl_cert_signature_algorithm() -> str: ...


ssl_cert_signature_algorithm = property(get_ssl_cert_signature_algorithm, None)

Default Value

""

Remarks

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

This property is read-only.

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)

Possible Values

0 # User
1 # Machine
2 # PFXFile
3 # PFXBlob
4 # JKSFile
5 # JKSBlob
6 # PEMKeyFile
7 # PEMKeyBlob
8 # PublicKeyFile
9 # PublicKeyBlob
10 # SSHPublicKeyBlob
11 # P7BFile
12 # P7BBlob
13 # SSHPublicKeyFile
14 # PPKFile
15 # PPKBlob
16 # XMLFile
17 # XMLBlob
18 # JWKFile
19 # JWKBlob
20 # SecurityKey
21 # BCFKSFile
22 # BCFKSBlob
23 # PKCS11
99 # Auto

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

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

ssl_cert_subject_alt_names property

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

Syntax

def get_ssl_cert_subject_alt_names() -> str: ...


ssl_cert_subject_alt_names = property(get_ssl_cert_subject_alt_names, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_cert_thumbprint_md5 property

The MD5 hash of the certificate.

Syntax

def get_ssl_cert_thumbprint_md5() -> str: ...


ssl_cert_thumbprint_md5 = property(get_ssl_cert_thumbprint_md5, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_cert_thumbprint_sha1 property

The SHA-1 hash of the certificate.

Syntax

def get_ssl_cert_thumbprint_sha1() -> str: ...


ssl_cert_thumbprint_sha1 = property(get_ssl_cert_thumbprint_sha1, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_cert_thumbprint_sha256 property

The SHA-256 hash of the certificate.

Syntax

def get_ssl_cert_thumbprint_sha256() -> str: ...


ssl_cert_thumbprint_sha256 = property(get_ssl_cert_thumbprint_sha256, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_cert_usage property

The text description of UsageFlags .

Syntax

def get_ssl_cert_usage() -> str: ...


ssl_cert_usage = property(get_ssl_cert_usage, None)

Default Value

""

Remarks

The text description of ssl_cert_usage_flags.

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

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

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

This property is read-only.

ssl_cert_usage_flags property

The flags that show intended use for the certificate.

Syntax

def get_ssl_cert_usage_flags() -> int: ...


ssl_cert_usage_flags = property(get_ssl_cert_usage_flags, None)

Default Value

0

Remarks

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

Please see the ssl_cert_usage property for a text representation of ssl_cert_usage_flags.

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

This property is read-only.

ssl_cert_version property

The certificate's version number.

Syntax

def get_ssl_cert_version() -> str: ...


ssl_cert_version = property(get_ssl_cert_version, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_provider property

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Syntax

def get_ssl_provider() -> int: ...

def set_ssl_provider(value: int) -> None: ...


ssl_provider = property(get_ssl_provider, set_ssl_provider)

Possible Values

0 # Automatic
1 # Platform
2 # Internal

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic), the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are as follows:

In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.

When Automatic is selected, on Windows, the class will use the platform implementation. On Linux/macOS, the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the class will always try and use the platform implementation. If the platform TLS 1.3 implementation is not available, the internal implementation will be used.

ssl_server_cert_effective_date property

The date on which this certificate becomes valid.

Syntax

def get_ssl_server_cert_effective_date() -> str: ...


ssl_server_cert_effective_date = property(get_ssl_server_cert_effective_date, None)

Default Value

""

Remarks

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

23-Jan-2000 15:00:00.

This property is read-only.

ssl_server_cert_encoded property

The certificate (PEM/Base64 encoded).

Syntax

def get_ssl_server_cert_encoded() -> bytes: ...


ssl_server_cert_encoded = property(get_ssl_server_cert_encoded, None)

Default Value

""

Remarks

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

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

This property is read-only.

ssl_server_cert_expiration_date property

The date on which the certificate expires.

Syntax

def get_ssl_server_cert_expiration_date() -> str: ...


ssl_server_cert_expiration_date = property(get_ssl_server_cert_expiration_date, None)

Default Value

""

Remarks

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

23-Jan-2001 15:00:00.

This property is read-only.

ssl_server_cert_extended_key_usage property

A comma-delimited list of extended key usage identifiers.

Syntax

def get_ssl_server_cert_extended_key_usage() -> str: ...


ssl_server_cert_extended_key_usage = property(get_ssl_server_cert_extended_key_usage, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_server_cert_fingerprint property

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

def get_ssl_server_cert_fingerprint() -> str: ...


ssl_server_cert_fingerprint = property(get_ssl_server_cert_fingerprint, None)

Default Value

""

Remarks

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

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

This property is read-only.

ssl_server_cert_fingerprint_sha1 property

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

def get_ssl_server_cert_fingerprint_sha1() -> str: ...


ssl_server_cert_fingerprint_sha1 = property(get_ssl_server_cert_fingerprint_sha1, None)

Default Value

""

Remarks

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

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

This property is read-only.

ssl_server_cert_fingerprint_sha256 property

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

def get_ssl_server_cert_fingerprint_sha256() -> str: ...


ssl_server_cert_fingerprint_sha256 = property(get_ssl_server_cert_fingerprint_sha256, None)

Default Value

""

Remarks

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

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

This property is read-only.

ssl_server_cert_issuer property

The issuer of the certificate.

Syntax

def get_ssl_server_cert_issuer() -> str: ...


ssl_server_cert_issuer = property(get_ssl_server_cert_issuer, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_server_cert_private_key property

The private key of the certificate (if available).

Syntax

def get_ssl_server_cert_private_key() -> str: ...


ssl_server_cert_private_key = property(get_ssl_server_cert_private_key, None)

Default Value

""

Remarks

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

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

This property is read-only.

ssl_server_cert_private_key_available property

Whether a PrivateKey is available for the selected certificate.

Syntax

def get_ssl_server_cert_private_key_available() -> bool: ...


ssl_server_cert_private_key_available = property(get_ssl_server_cert_private_key_available, None)

Default Value

False

Remarks

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

This property is read-only.

ssl_server_cert_private_key_container property

The name of the PrivateKey container for the certificate (if available).

Syntax

def get_ssl_server_cert_private_key_container() -> str: ...


ssl_server_cert_private_key_container = property(get_ssl_server_cert_private_key_container, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_server_cert_public_key property

The public key of the certificate.

Syntax

def get_ssl_server_cert_public_key() -> str: ...


ssl_server_cert_public_key = property(get_ssl_server_cert_public_key, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_server_cert_public_key_algorithm property

The textual description of the certificate's public key algorithm.

Syntax

def get_ssl_server_cert_public_key_algorithm() -> str: ...


ssl_server_cert_public_key_algorithm = property(get_ssl_server_cert_public_key_algorithm, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_server_cert_public_key_length property

The length of the certificate's public key (in bits).

Syntax

def get_ssl_server_cert_public_key_length() -> int: ...


ssl_server_cert_public_key_length = property(get_ssl_server_cert_public_key_length, None)

Default Value

0

Remarks

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

This property is read-only.

ssl_server_cert_serial_number property

The serial number of the certificate encoded as a string.

Syntax

def get_ssl_server_cert_serial_number() -> str: ...


ssl_server_cert_serial_number = property(get_ssl_server_cert_serial_number, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_server_cert_signature_algorithm property

The text description of the certificate's signature algorithm.

Syntax

def get_ssl_server_cert_signature_algorithm() -> str: ...


ssl_server_cert_signature_algorithm = property(get_ssl_server_cert_signature_algorithm, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_server_cert_store property

The name of the certificate store for the client certificate.

Syntax

def get_ssl_server_cert_store() -> bytes: ...


ssl_server_cert_store = property(get_ssl_server_cert_store, None)

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

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

ssl_server_cert_store is used in conjunction with the ssl_server_cert_subject property to specify client certificates. If ssl_server_cert_store has a value, and ssl_server_cert_subject or ssl_server_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_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).

This property is read-only.

ssl_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_server_cert_store_password() -> str: ...


ssl_server_cert_store_password = property(get_ssl_server_cert_store_password, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_server_cert_store_type property

The type of certificate store for this certificate.

Syntax

def get_ssl_server_cert_store_type() -> int: ...


ssl_server_cert_store_type = property(get_ssl_server_cert_store_type, None)

Possible Values

0 # User
1 # Machine
2 # PFXFile
3 # PFXBlob
4 # JKSFile
5 # JKSBlob
6 # PEMKeyFile
7 # PEMKeyBlob
8 # PublicKeyFile
9 # PublicKeyBlob
10 # SSHPublicKeyBlob
11 # P7BFile
12 # P7BBlob
13 # SSHPublicKeyFile
14 # PPKFile
15 # PPKBlob
16 # XMLFile
17 # XMLBlob
18 # JWKFile
19 # JWKBlob
20 # SecurityKey
21 # BCFKSFile
22 # BCFKSBlob
23 # PKCS11
99 # Auto

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:

This property is read-only.

ssl_server_cert_subject property

The subject of the certificate used for client authentication.

Syntax

def get_ssl_server_cert_subject() -> str: ...


ssl_server_cert_subject = property(get_ssl_server_cert_subject, None)

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

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

This property is read-only.

ssl_server_cert_subject_alt_names property

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

Syntax

def get_ssl_server_cert_subject_alt_names() -> str: ...


ssl_server_cert_subject_alt_names = property(get_ssl_server_cert_subject_alt_names, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_server_cert_thumbprint_md5 property

The MD5 hash of the certificate.

Syntax

def get_ssl_server_cert_thumbprint_md5() -> str: ...


ssl_server_cert_thumbprint_md5 = property(get_ssl_server_cert_thumbprint_md5, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_server_cert_thumbprint_sha1 property

The SHA-1 hash of the certificate.

Syntax

def get_ssl_server_cert_thumbprint_sha1() -> str: ...


ssl_server_cert_thumbprint_sha1 = property(get_ssl_server_cert_thumbprint_sha1, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_server_cert_thumbprint_sha256 property

The SHA-256 hash of the certificate.

Syntax

def get_ssl_server_cert_thumbprint_sha256() -> str: ...


ssl_server_cert_thumbprint_sha256 = property(get_ssl_server_cert_thumbprint_sha256, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_server_cert_usage property

The text description of UsageFlags .

Syntax

def get_ssl_server_cert_usage() -> str: ...


ssl_server_cert_usage = property(get_ssl_server_cert_usage, None)

Default Value

""

Remarks

The text description of ssl_server_cert_usage_flags.

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

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

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

This property is read-only.

ssl_server_cert_usage_flags property

The flags that show intended use for the certificate.

Syntax

def get_ssl_server_cert_usage_flags() -> int: ...


ssl_server_cert_usage_flags = property(get_ssl_server_cert_usage_flags, None)

Default Value

0

Remarks

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

Please see the ssl_server_cert_usage property for a text representation of ssl_server_cert_usage_flags.

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

This property is read-only.

ssl_server_cert_version property

The certificate's version number.

Syntax

def get_ssl_server_cert_version() -> str: ...


ssl_server_cert_version = property(get_ssl_server_cert_version, None)

Default Value

""

Remarks

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

This property is read-only.

ssl_start_mode property

Determines how the class starts the SSL negotiation. By default, SSL will not be used.

Syntax

def get_ssl_start_mode() -> int: ...

def set_ssl_start_mode(value: int) -> None: ...


ssl_start_mode = property(get_ssl_start_mode, set_ssl_start_mode)

Possible Values

0 # Automatic
1 # Implicit
2 # Explicit
3 # None

Default Value

3

Remarks

The ssl_start_mode property may have one of the following values:

subject property

The subject of the message.

Syntax

def get_subject() -> str: ...

def set_subject(value: str) -> None: ...


subject = property(get_subject, set_subject)

Default Value

""

Remarks

The optional human-readable subject of the message. Some AS2 partners will use this field to send additional information about the transmission at the transport layer.

timeout property

The timeout for the class.

Syntax

def get_timeout() -> int: ...

def set_timeout(value: int) -> None: ...


timeout = property(get_timeout, set_timeout)

Default Value

60

Remarks

If the timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If timeout is set to a positive value, the class will wait for the operation to complete before returning control.

The class will use do_events to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive.

If timeout expires, and the operation is not yet complete, the class fails with an error.

NOTE: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by timeout seconds when any amount of data is successfully sent or received.

The default value for the timeout property is 60 seconds.

user property

This property contains the user identifier to use to log in.

Syntax

def get_user() -> str: ...

def set_user(value: str) -> None: ...


user = property(get_user, set_user)

Default Value

""

Remarks

This property contains the user identifier to be used when logging in. It must be set before the class connects to the FTP server.

abort method

The method aborts the current upload or download.

Syntax

def abort() -> None: ...

Remarks

This method sends an ABOR command to the FTP server. It is used to interrupt file uploads and downloads.

change_remote_path method

This method changes the current path on the FTP server.

Syntax

def change_remote_path(remote_path: str) -> None: ...

Remarks

This method changes the current path on the FTP server to the specified remote_path. When called, the class will issue a command to the server to change the directory. The remote_path parameter may hold an absolute or relative path.

Absolute Paths

If the path begins with a /, it is considered an absolute path and must specify the entire path from the root of the server. For instance:

component.ChangeRemotePath("/home/testuser/myfolder");

Relative Paths

If the path does not begin with a /, it is considered a relative path and is resolved in relation to the current directory. For instance, a value of myfolder will indicate a subfolder of the current directory. The special value .. refers to the parent directory of the current path. For instance:

//Change to the 'myfolder' sub-directory component.ChangeRemotePath("myfolder"); //Navigate up two levels and then into the 'another/folder' path. component.ChangeRemotePath("../../another/folder");

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.

delete_file method

This method removes a file specified by FileName from an FTP server.

Syntax

def delete_file(file_name: str) -> None: ...

Remarks

This method is used to remove a file specified by file_name from an FTP server. The remote file or directory specified by file_name is deleted. file_name is either an absolute path on the server, or a path relative to remote path set by change_remote_path. If no FTP session is in place, one is automatically created by first calling the logon method.

get_file_size method

Gets the size of a file on the FTP server.

Syntax

def get_file_size(file_name: str) -> None: ...

Remarks

Gets the size of the file specified by FileName and remote_path on the FTP server.

get_file_time method

Gets the last modification time of a file on the FTP server.

Syntax

def get_file_time(file_name: str) -> None: ...

Remarks

Gets the last modification time of the file specified by FileName and remote_path on the FTP server.

list_directory method

List the current directory on an FTP server.

Syntax

def list_directory(files_to_list: str) -> None: ...

Remarks

A listing is requested for the directory or file mask specified in FilesToList. This can be an absolute path on the server, a path relative to remote_path, or a file mask. The file listing is received through the on_dir_list event.

Similar to list_directory_long, except only file names are returned. If no FTP session is in place, one is automatically created by first calling the logon method.

list_directory_long method

List the current directory on an FTP server.

Syntax

def list_directory_long(files_to_list: str) -> None: ...

Remarks

A listing is requested for the directory or file mask specified in FilesToList. This can be an absolute path on the server, a path relative to remote_path, or a file mask. The file listing is received through the on_dir_list event. Extended file information is returned.

If no FTP session is in place, one is automatically created by first calling the logon method.

logoff method

This method is used to log off from the FTP server by posting a QUIT command.

Syntax

def logoff() -> None: ...

Remarks

This method is used to log off from the FTP server by posting a QUIT command. If that fails, the connection is terminated by the local host.

logon method

Logon to the FTP remote_host using the current user and password .

Syntax

def logon() -> None: ...

Remarks

Logon to the FTP server using the current user and password. If an SSL (TLS) connection is required, you should first set ssl_start_mode.

Example (Logging On)

FTPControl.RemoteHost = "ftpserver" FTPControl.User = "username" FTPControl.Password = "password" FTPControl.Logon()

query_remote_path method

This queries the server for the current path.

Syntax

def query_remote_path() -> str: ...

Remarks

This method queries the server for the current path. When called, the class will issue a command to the server to retrieve the current path value. The return value of this method is the path returned by the server. For instance:

string remotePath = component.QueryRemotePath();

read_receipt method

Reads and parses (but does not verify) an MDN receipt.

Syntax

def read_receipt(file_name: str) -> None: ...

Remarks

read_receipt will retrieve the file specified by FileName from the FTP server, and attempt to parse it as an MDN receipt. If the file is a valid MDN receipt, the class will determine the originator of the receipt and the message_id of the original message. The originator of the receipt will be stored in as3_to, the intended recipient (presumably your system) will be stored in as3_from, and the original message Id will be stored in message_id.

Pass in an empty string to skip the FTP transfer, and process the receipt specified by the mdn_receipt property instead.

You should then look up the original message and set original_content_mic to the value of original_content_mic originally computed when the message was sent (you will need to save this information externally). You should also set recipient_cert based on the value of as3_to if necessary. Also, set mdn_options to the value used when making the original request.

Finally, verify_receipt should be used to verify the receipt.

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 method

Prepares and sends the AS3 message.

Syntax

def send(file_name: str) -> None: ...

Remarks

Invoking send will prepare and send the AS3 message. It will be signed if signing_cert is set, encrypted if recipient_cert is set, and compressed if compression_format is set. A receipt will be requested if mdn_to is set.

Prior to sending, you may logon to the FTP server and navigate to the desired remote_path. If you have not created an FTP connection already then send will attempt to establish one.

FileName should contain the name of the file that will be written on the AS3/FTP server. You may leave FileName blank to allow the class to determine an appropriate name.

send_ftp_command method

Sends the exact command directly to the server.

Syntax

def send_ftp_command(command: str) -> None: ...

Remarks

This method sends the command specified by command to the server exactly as it is provided. Use this method to send additional or custom commands directly to the server.

After calling this method check the ftp_last_reply property and/or monitor the on_pi_trail event to obtain the server's response.

verify_receipt method

Verifies an MDN receipt.

Syntax

def verify_receipt() -> None: ...

Remarks

VerifyReceipt verifies the receipt in mdn_receipt against the values of original_content_mic and message_id and the preferences specified in mdn_options. The method operates similarly to post: After the method finishes, the mdn_receipt, ReceiptSigningProtocol, and receipt_signer_cert properties will be populated with the appropriate values.

The method operates synchronously, and will throw an exception if any errors or warnings occur. Errors might include a failure to decrypt or authenticate the receipt, the absence of an MDN when one was requested, TCP/IP errors, or any errors reported by the server in the MDN. Warnings might include the return of an unsigned receipt when a signed receipt was requested, or other warnings reported by the server in the MDN.

If an exception is thrown the error code will correspond to the severity of the warning or error, allowing client software to determine whether or not to accept the reply. If multiple errors occur, the exception will return a special error code, and the error message will contain a line for each error's code and description; i.e. "423: Failed to authenticate sender". If the error(s) is/are not fatal processing will not be interrupted, and the relevant properties will be populated as normal.

You should first invoke read_receipt when it is not known which message the receipt is in response to. This will allow you to determine the original message_id and originator of the receipt before trying to verify it.

on_connection_status event

Fired to indicate changes in the connection state.

Syntax

class AS3SenderConnectionStatusEventParams(object):
  @property
  def connection_event() -> str: ...
  @property
  def status_code() -> int: ...
  @property
  def description() -> str: ...
# In class AS3Sender:
@property
def on_connection_status() -> Callable[[AS3SenderConnectionStatusEventParams], None]: ...
@on_connection_status.setter
def on_connection_status(event_hook: Callable[[AS3SenderConnectionStatusEventParams], None]) -> None: ...

Remarks

This event is fired when the connection state changes: for example, completion of a firewall or proxy connection or completion of a security handshake.

The connection_event parameter indicates the type of connection event. Values may include the following:

on_dir_list event

This event is fired when a directory entry is received.

Syntax

class AS3SenderDirListEventParams(object):
  @property
  def dir_entry() -> str: ...
  @property
  def file_name() -> str: ...
  @property
  def is_dir() -> bool: ...
  @property
  def file_size() -> int: ...
  @property
  def file_time() -> str: ...
# In class AS3Sender:
@property
def on_dir_list() -> Callable[[AS3SenderDirListEventParams], None]: ...
@on_dir_list.setter
def on_dir_list(event_hook: Callable[[AS3SenderDirListEventParams], None]) -> None: ...

Remarks

The on_dir_list events are fired when a directory listing is received as a response to a list_directory or list_directory_long call.

The on_start_transfer and on_end_transfer events mark the beginning and end of the event stream.

The dir_entry parameter contains the filename when list_directory is called and includes extended file information when list_directory_long is called.

The class tries to fill out the file_name, is_dir, file_size, and file_time parameters when calling the list_directory_long method. Except for file_name, these parameters are empty when a short "List Directory" is performed.

In Unix systems, the date is given in two types of formats: If the date is in the past 12 months the exact time is specified and the year is omitted. Otherwise, only the date and the year, but not hours or minutes, are given.

on_end_transfer event

This event is fired when a file finishes downloading or uploading.

Syntax

class AS3SenderEndTransferEventParams(object):
  @property
  def direction() -> int: ...
# In class AS3Sender:
@property
def on_end_transfer() -> Callable[[AS3SenderEndTransferEventParams], None]: ...
@on_end_transfer.setter
def on_end_transfer(event_hook: Callable[[AS3SenderEndTransferEventParams], None]) -> None: ...

Remarks

The on_end_transfer event fires when a Data Interface connection is closed. This occurs when the file finishes transferring or a directory listing is finished.

The direction parameter shows whether the client (0) or the server (1) is sending the data.

on_error event

Fired when information is available about errors during data delivery.

Syntax

class AS3SenderErrorEventParams(object):
  @property
  def error_code() -> int: ...
  @property
  def description() -> str: ...
# In class AS3Sender:
@property
def on_error() -> Callable[[AS3SenderErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[AS3SenderErrorEventParams], 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 error_code 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 AS3SenderLogEventParams(object):
  @property
  def log_type() -> str: ...
  @property
  def log_message() -> bytes: ...
# In class AS3Sender:
@property
def on_log() -> Callable[[AS3SenderLogEventParams], None]: ...
@on_log.setter
def on_log(event_hook: Callable[[AS3SenderLogEventParams], 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 log_message event parameter holds the raw log data.

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

on_pi_trail event

This event traces the commands sent to the server, and the respective replies.

Syntax

class AS3SenderPITrailEventParams(object):
  @property
  def direction() -> int: ...
  @property
  def message() -> str: ...
# In class AS3Sender:
@property
def on_pi_trail() -> Callable[[AS3SenderPITrailEventParams], None]: ...
@on_pi_trail.setter
def on_pi_trail(event_hook: Callable[[AS3SenderPITrailEventParams], None]) -> None: ...

Remarks

The on_pi_trail event is useful for debugging purposes. It shows all of the interactions between the client and the server, line by line.

The message parameter contains the full text of the message. The direction parameter shows the originator of the message:

on_ssl_server_authentication event

Fired after the server presents its certificate to the client.

Syntax

class AS3SenderSSLServerAuthenticationEventParams(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 AS3Sender:
@property
def on_ssl_server_authentication() -> Callable[[AS3SenderSSLServerAuthenticationEventParams], None]: ...
@on_ssl_server_authentication.setter
def on_ssl_server_authentication(event_hook: Callable[[AS3SenderSSLServerAuthenticationEventParams], None]) -> None: ...

Remarks

During this event, the client can decide whether or not to continue with the connection process. The accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When accept is False, status shows why the verification failed (otherwise, status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the accept parameter to True.

on_ssl_status event

Fired when secure connection progress messages are available.

Syntax

class AS3SenderSSLStatusEventParams(object):
  @property
  def message() -> str: ...
# In class AS3Sender:
@property
def on_ssl_status() -> Callable[[AS3SenderSSLStatusEventParams], None]: ...
@on_ssl_status.setter
def on_ssl_status(event_hook: Callable[[AS3SenderSSLStatusEventParams], None]) -> None: ...

Remarks

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

on_start_transfer event

This event fires when a file starts downloading or uploading.

Syntax

class AS3SenderStartTransferEventParams(object):
  @property
  def direction() -> int: ...
# In class AS3Sender:
@property
def on_start_transfer() -> Callable[[AS3SenderStartTransferEventParams], None]: ...
@on_start_transfer.setter
def on_start_transfer(event_hook: Callable[[AS3SenderStartTransferEventParams], None]) -> None: ...

Remarks

The on_start_transfer event fires when a Data Interface connection is created. This is when the file starts transferring or a directory listing is started.

The direction parameter shows whether the client (0) or the server (1) is sending the data.

on_transfer event

This event is fired during the file download or upload.

Syntax

class AS3SenderTransferEventParams(object):
  @property
  def direction() -> int: ...
  @property
  def bytes_transferred() -> int: ...
  @property
  def percent_done() -> int: ...
  @property
  def text() -> bytes: ...
# In class AS3Sender:
@property
def on_transfer() -> Callable[[AS3SenderTransferEventParams], None]: ...
@on_transfer.setter
def on_transfer(event_hook: Callable[[AS3SenderTransferEventParams], None]) -> None: ...

Remarks

One or more on_transfer events are fired during file transfer. The bytes_transferred parameter shows the number of bytes transferred since the beginning of the transfer.

text contains the portion of the file data being delivered.

The direction parameter shows whether the client (0) or the server (1) is sending the data.

The percent_done parameter shows the progress of the transfer in the corresponding direction. If percent_done can not be calculated the value will be -1.

NOTE: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.

AS3Sender Config Settings

AS3Sender Config Settings

FTP 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