Struct ipworksedi::AS1Receiver

Properties Methods Events Config Settings Errors

The AS1Receiver struct is used to process AS1 messages and generate receipts.

Syntax

ipworksedi::AS1Receiver

Remarks

The AS1Receiver struct allows you to receive AS1 messages as specified in RFC 3335. The struct can act as an email client, decrypt and verify incoming messages, generate receipts including Message Disposition Notifications (MDNs), and send them over SMTP/S.

Basic Operation

You should first log in to your mail server by setting mail_server, user, and password, and invoking connect. You may then navigate your mail inbox by setting mail_message_number, and inspecting properties such as mail_message_from, etc. When you find the desired file you may download it by invoking read_request. Alternatively, you may acquire the AS1 data by other means and directly set request and request_headers.

read_request (or parse_headers) will determine information such as from and send_to, which will allow you to set the appropriate certificates. You may specify your certificate with the certificate property, and your trading partner's (signing) certificate with the signer_cert property.

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

The mdn_receipt may be returned over SMTP/S by invoking send_response. In case the server address for incoming mail is different than that for outgoing mail you should use config to configure this.

To create log files, set log_directory prior to invoking process_request. This will log all incoming and outgoing data, and will also write the received EDI files to disk.

Example AS1Receiver1.User = "myusername" AS1Receiver1.Password = "mypassword" AS1Receiver1.MailServer = "1.2.3.4" AS1Receiver1.Connect() // You may need to search the server for received files at this point AS1Receiver1.MessageNumber = 1; // You may check properties such as MailMessageFrom, etc. AS1Receiver1.ReadRequest() AS1Receiver1.Certificate = new Certificate(CertStoreTypes.cstPFXFile, "\\my_server_directory\\my_pfx_file.pfx", "my password", "CN=Me"); AS1Receiver1.SignerCert = (base 64 encoded certificate); AS1Receiver1.LogDirectory = "c:\\my_server_directory\\my_log_directory"; AS1Receiver1.ProcessRequest(); AS1Receiver1.SendResponse(); AS1Receiver1.Disconnect(); Additional functionality allows the user to examine details of the client's request, to permit certain types of errors, or to customize the outgoing MDN. See the property and method list for details.

Object Lifetime

The new() method returns a mutable reference to a struct instance. The object itself is kept in the global list maintained by IPWorksEDI. Due to this, the AS1Receiver struct cannot be disposed of automatically. Please, call the dispose(&mut self) method of AS1Receiver when you have finished using the instance.

Property List

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


attachment_count	The number of records in the Attachment arrays.
attachment_content_type	The MIME content-type of this ediattachment .
attachment_data	This property contains the attachment data.
attachment_file_name	The file name of the attachment.
attachment_headers	The struct fills out Headers each time any of the other properties for that ediattachment are changed.
attachment_name	Name is the final name to be associated with the contents of either the Data or FileName properties.
cert_effective_date	The date on which this certificate becomes valid.
cert_expiration_date	The date on which the certificate expires.
cert_extended_key_usage	A comma-delimited list of extended key usage identifiers.
cert_fingerprint	The hex-encoded, 16-byte MD5 fingerprint of the certificate.
cert_fingerprint_sha1	The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
cert_fingerprint_sha256	The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
cert_issuer	The issuer of the certificate.
cert_private_key	The private key of the certificate (if available).
cert_private_key_available	Whether a PrivateKey is available for the selected certificate.
cert_private_key_container	The name of the PrivateKey container for the certificate (if available).
cert_public_key	The public key of the certificate.
cert_public_key_algorithm	The textual description of the certificate's public key algorithm.
cert_public_key_length	The length of the certificate's public key (in bits).
cert_serial_number	The serial number of the certificate encoded as a string.
cert_signature_algorithm	The text description of the certificate's signature algorithm.
cert_store	The name of the certificate store for the client certificate.
cert_store_password	If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
cert_store_type	The type of certificate store for this certificate.
cert_subject_alt_names	Comma-separated lists of alternative subject names for the certificate.
cert_thumbprint_md5	The MD5 hash of the certificate.
cert_thumbprint_sha1	The SHA-1 hash of the certificate.
cert_thumbprint_sha256	The SHA-256 hash of the certificate.
cert_usage	The text description of UsageFlags .
cert_usage_flags	The flags that show intended use for the certificate.
cert_version	The certificate's version number.
cert_subject	The subject of the certificate used for client authentication.
cert_encoded	The certificate (PEM/Base64 encoded).
compression_format	The compression format used on the incoming message.
connected	Whether the struct is connected.
edi_data	This property contains the EDI payload of the transmission.
edi_type	The Content-Type of the EDI message.
edi_name	Name is the final name to be associated with the contents of either the Data or FileName properties.
edi_file_name	In a sender, if FileName is specified, the file specified will be used for the EDI payload of the transmission.
firewall_auto_detect	Whether to automatically detect and use firewall system settings, if available.
firewall_type	The type of firewall to connect through.
firewall_host	The name or IP address of the firewall (optional).
firewall_password	A password if authentication is to be used when connecting through the firewall.
firewall_port	The Transmission Control Protocol (TCP) port for the firewall Host .
firewall_user	A username if authentication is to be used when connecting through a firewall.
from	The sender of the original message.
local_host	The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
log_directory	The path to a directory for logging.
log_file	The log file written.
mail_message_cc	The value of the Cc header of the mail message.
mail_message_count	The number of messages waiting in the mailbox.
mail_message_date	The message date for the currently selected message.
mail_message_from	The sender of the mail message.
mail_message_headers	The message headers for the currently selected message.
mail_message_number	The message number on the incoming mail server.
mail_message_reply_to	The value of the ReplyTo header of the mail message.
mail_message_subject	The subject of the mail message.
mail_message_text	The text of the mail message.
mail_message_to	The recipient of the mail message.
mail_server	The address of your mail server.
mdn_receipt_content	This contains the entire content of the MDN Receipt.
mdn_receipt_header_count	The number of headers in the MDN.
mdn_receipt_header_field	The property name of the MDN header currently selected by HeaderIndex .
mdn_receipt_header_index	Which MDN header is currently selected to populate HeaderField and HeaderValue .
mdn_receipt_headers	Headers contains all of the headers of the AS2 MDN Receipt as a single string.
mdn_receipt_header_value	The value of the MDN header currently selected by HeaderIndex .
mdn_receipt_mdn	MDN will contain the entire machine readable text of the Message Disposition Notification in the receipt.
mdn_receipt_message	The human-readable portion of the MDN receipt.
mdn_receipt_mic_value	The Message Integrity Check(s) (one-way hash) of the original EDI message.
mdn_receipt_signing_protocol	This property contains the MIME type of the signature used, if any (i.
mdn_to	The recipient for the Message Disposition Notification (MDN).
message_id	The message ID of the incoming message.
o_auth_access_token	The access token returned by the authorization server.
o_auth_authorization_scope	The scope request or response parameter used during authorization.
o_auth_client_id	The id of the client assigned when registering the application.
o_auth_client_secret	The secret value for the client assigned when registering the application.
o_auth_refresh_token	Specifies the refresh token received from or sent to the authorization server.
o_auth_return_url	The URL where the user (browser) returns after authenticating.
o_auth_server_auth_url	The URL of the authorization server.
o_auth_server_token_url	The URL of the token server used to obtain the access token.
password	The password for your incoming mail server.
request	The AS1 request to be processed.
request_header_count	The number of records in the RequestHeader arrays.
request_header_field	This property contains the name of the HTTP header (this is the same case as it is delivered).
request_header_value	This property contains the header contents.
request_headers_string	The headers in the AS1 request.
scan_result	The result of invoking ParseRequest .
send_to	The recipient of the original message.
signer_cert_effective_date	The date on which this certificate becomes valid.
signer_cert_expiration_date	The date on which the certificate expires.
signer_cert_extended_key_usage	A comma-delimited list of extended key usage identifiers.
signer_cert_fingerprint	The hex-encoded, 16-byte MD5 fingerprint of the certificate.
signer_cert_fingerprint_sha1	The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
signer_cert_fingerprint_sha256	The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
signer_cert_issuer	The issuer of the certificate.
signer_cert_private_key	The private key of the certificate (if available).
signer_cert_private_key_available	Whether a PrivateKey is available for the selected certificate.
signer_cert_private_key_container	The name of the PrivateKey container for the certificate (if available).
signer_cert_public_key	The public key of the certificate.
signer_cert_public_key_algorithm	The textual description of the certificate's public key algorithm.
signer_cert_public_key_length	The length of the certificate's public key (in bits).
signer_cert_serial_number	The serial number of the certificate encoded as a string.
signer_cert_signature_algorithm	The text description of the certificate's signature algorithm.
signer_cert_store	The name of the certificate store for the client certificate.
signer_cert_store_password	If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
signer_cert_store_type	The type of certificate store for this certificate.
signer_cert_subject_alt_names	Comma-separated lists of alternative subject names for the certificate.
signer_cert_thumbprint_md5	The MD5 hash of the certificate.
signer_cert_thumbprint_sha1	The SHA-1 hash of the certificate.
signer_cert_thumbprint_sha256	The SHA-256 hash of the certificate.
signer_cert_usage	The text description of UsageFlags .
signer_cert_usage_flags	The flags that show intended use for the certificate.
signer_cert_version	The certificate's version number.
signer_cert_subject	The subject of the certificate used for client authentication.
signer_cert_encoded	The certificate (PEM/Base64 encoded).
ssl_accept_server_cert_effective_date	The date on which this certificate becomes valid.
ssl_accept_server_cert_expiration_date	The date on which the certificate expires.
ssl_accept_server_cert_extended_key_usage	A comma-delimited list of extended key usage identifiers.
ssl_accept_server_cert_fingerprint	The hex-encoded, 16-byte MD5 fingerprint of the certificate.
ssl_accept_server_cert_fingerprint_sha1	The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
ssl_accept_server_cert_fingerprint_sha256	The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
ssl_accept_server_cert_issuer	The issuer of the certificate.
ssl_accept_server_cert_private_key	The private key of the certificate (if available).
ssl_accept_server_cert_private_key_available	Whether a PrivateKey is available for the selected certificate.
ssl_accept_server_cert_private_key_container	The name of the PrivateKey container for the certificate (if available).
ssl_accept_server_cert_public_key	The public key of the certificate.
ssl_accept_server_cert_public_key_algorithm	The textual description of the certificate's public key algorithm.
ssl_accept_server_cert_public_key_length	The length of the certificate's public key (in bits).
ssl_accept_server_cert_serial_number	The serial number of the certificate encoded as a string.
ssl_accept_server_cert_signature_algorithm	The text description of the certificate's signature algorithm.
ssl_accept_server_cert_store	The name of the certificate store for the client certificate.
ssl_accept_server_cert_store_password	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	The type of certificate store for this certificate.
ssl_accept_server_cert_subject_alt_names	Comma-separated lists of alternative subject names for the certificate.
ssl_accept_server_cert_thumbprint_md5	The MD5 hash of the certificate.
ssl_accept_server_cert_thumbprint_sha1	The SHA-1 hash of the certificate.
ssl_accept_server_cert_thumbprint_sha256	The SHA-256 hash of the certificate.
ssl_accept_server_cert_usage	The text description of UsageFlags .
ssl_accept_server_cert_usage_flags	The flags that show intended use for the certificate.
ssl_accept_server_cert_version	The certificate's version number.
ssl_accept_server_cert_subject	The subject of the certificate used for client authentication.
ssl_accept_server_cert_encoded	The certificate (PEM/Base64 encoded).
ssl_cert_effective_date	The date on which this certificate becomes valid.
ssl_cert_expiration_date	The date on which the certificate expires.
ssl_cert_extended_key_usage	A comma-delimited list of extended key usage identifiers.
ssl_cert_fingerprint	The hex-encoded, 16-byte MD5 fingerprint of the certificate.
ssl_cert_fingerprint_sha1	The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
ssl_cert_fingerprint_sha256	The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
ssl_cert_issuer	The issuer of the certificate.
ssl_cert_private_key	The private key of the certificate (if available).
ssl_cert_private_key_available	Whether a PrivateKey is available for the selected certificate.
ssl_cert_private_key_container	The name of the PrivateKey container for the certificate (if available).
ssl_cert_public_key	The public key of the certificate.
ssl_cert_public_key_algorithm	The textual description of the certificate's public key algorithm.
ssl_cert_public_key_length	The length of the certificate's public key (in bits).
ssl_cert_serial_number	The serial number of the certificate encoded as a string.
ssl_cert_signature_algorithm	The text description of the certificate's signature algorithm.
ssl_cert_store	The name of the certificate store for the client certificate.
ssl_cert_store_password	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	The type of certificate store for this certificate.
ssl_cert_subject_alt_names	Comma-separated lists of alternative subject names for the certificate.
ssl_cert_thumbprint_md5	The MD5 hash of the certificate.
ssl_cert_thumbprint_sha1	The SHA-1 hash of the certificate.
ssl_cert_thumbprint_sha256	The SHA-256 hash of the certificate.
ssl_cert_usage	The text description of UsageFlags .
ssl_cert_usage_flags	The flags that show intended use for the certificate.
ssl_cert_version	The certificate's version number.
ssl_cert_subject	The subject of the certificate used for client authentication.
ssl_cert_encoded	The certificate (PEM/Base64 encoded).
ssl_provider	The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.
ssl_server_cert_effective_date	The date on which this certificate becomes valid.
ssl_server_cert_expiration_date	The date on which the certificate expires.
ssl_server_cert_extended_key_usage	A comma-delimited list of extended key usage identifiers.
ssl_server_cert_fingerprint	The hex-encoded, 16-byte MD5 fingerprint of the certificate.
ssl_server_cert_fingerprint_sha1	The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
ssl_server_cert_fingerprint_sha256	The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
ssl_server_cert_issuer	The issuer of the certificate.
ssl_server_cert_private_key	The private key of the certificate (if available).
ssl_server_cert_private_key_available	Whether a PrivateKey is available for the selected certificate.
ssl_server_cert_private_key_container	The name of the PrivateKey container for the certificate (if available).
ssl_server_cert_public_key	The public key of the certificate.
ssl_server_cert_public_key_algorithm	The textual description of the certificate's public key algorithm.
ssl_server_cert_public_key_length	The length of the certificate's public key (in bits).
ssl_server_cert_serial_number	The serial number of the certificate encoded as a string.
ssl_server_cert_signature_algorithm	The text description of the certificate's signature algorithm.
ssl_server_cert_store	The name of the certificate store for the client certificate.
ssl_server_cert_store_password	If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
ssl_server_cert_store_type	The type of certificate store for this certificate.
ssl_server_cert_subject_alt_names	Comma-separated lists of alternative subject names for the certificate.
ssl_server_cert_thumbprint_md5	The MD5 hash of the certificate.
ssl_server_cert_thumbprint_sha1	The SHA-1 hash of the certificate.
ssl_server_cert_thumbprint_sha256	The SHA-256 hash of the certificate.
ssl_server_cert_usage	The text description of UsageFlags .
ssl_server_cert_usage_flags	The flags that show intended use for the certificate.
ssl_server_cert_version	The certificate's version number.
ssl_server_cert_subject	The subject of the certificate used for client authentication.
ssl_server_cert_encoded	The certificate (PEM/Base64 encoded).
ssl_start_mode	Determines how the struct starts the SSL negotiation. By default, SSL will not be used.
user	The username for your incoming mail server.

Method List

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


config	Sets or retrieves a configuration setting.
connect	Connects to the incoming mail server.
create_mdn_receipt	Creates MDNReceipt .
delete_message	Deletes the message specified by MailMessageNumber .
disconnect	Disconnects from the incoming mail server.
parse_request	Parses the EDI message and determines the EDIData .
process_queue	Send the messages queued for sending.
process_request	Processes the EDI data, and generates the receipt.
query_message_size	Returns the size in bytes of the current message.
query_message_uid	Returns the unique identifier of the message as specified by the server.
queue	Prepares and queues the message to the specified directory.
read_request	Reads the AS1 request from the mail server.
reset	Resets the state of the control.
select_mail_message	Selects and obtains information about the specified message.
send_response	Sends the MDN receipt.

Event List

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


on_connection_status	Fired to indicate changes in the connection state.
on_end_transfer	Fired when the message text completes transferring.
on_error	Fired when information is available about errors during data delivery.
on_header	This event is fired for every message header being retrieved.
on_launch_browser	Fires before launching a browser with the authorization URL.
on_log	Fired with log information while processing a message.
on_pi_trail	This event traces the commands sent to the mail server, and the respective replies.
on_signer_cert_info	This event is fired during verification of the signed message.
on_ssl_server_authentication	Fired after the server presents its certificate to the client.
on_ssl_status	Fired when secure connection progress messages are available.
on_start_transfer	Fired when the message text starts transferring (on either a send or receive).
on_transfer	Fired while the message text gets transferred to or from MailServer .

Config Settings

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


FileName	The filename of the EDI Data.
LogFilename	The base name of the log file.
POPPort	The POP mail port to be used, if different than MailServer.
POPServer	The POP server to be used, if different than MailServer.
SMTPAuthMechanism	The authentication mechanism used to connect to the SMTP server.
SMTPPassword	The password used for authentication.
SMTPPort	The SMTP mail port to be used, if different than MailServer.
SMTPServer	The SMTP server to be used, if different than MailServer.
SMTPSSLStartMode	Determines how SSL negotiation starts with the SMTP server.
SMTPUser	The user name used for authentication.
LogSSLPackets	Controls whether SSL packets are logged when using the internal security API.
OpenSSLCADir	The path to a directory containing CA certificates.
OpenSSLCAFile	Name of the file containing the list of CA's trusted by your application.
OpenSSLCipherList	A string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedData	The data to seed the pseudo random number generator (PRNG).
ReuseSSLSession	Determines if the SSL session is reused.
SSLCACerts	A newline separated list of CA certificates to be included when performing an SSL handshake.
SSLCheckCRL	Whether to check the Certificate Revocation List for the server certificate.
SSLCheckOCSP	Whether to use OCSP to check the status of the server certificate.
SSLCipherStrength	The minimum cipher strength used for bulk encryption.
SSLClientCACerts	A newline separated list of CA certificates to use during SSL client certificate validation.
SSLEnabledCipherSuites	The cipher suite to be used in an SSL negotiation.
SSLEnabledProtocols	Used to enable/disable the supported security protocols.
SSLEnableRenegotiation	Whether the renegotiation_info SSL extension is supported.
SSLIncludeCertChain	Whether the entire certificate chain is included in the SSLServerAuthentication event.
SSLKeyLogFile	The location of a file where per-session secrets are written for debugging purposes.
SSLNegotiatedCipher	Returns the negotiated cipher suite.
SSLNegotiatedCipherStrength	Returns the negotiated cipher suite strength.
SSLNegotiatedCipherSuite	Returns the negotiated cipher suite.
SSLNegotiatedKeyExchange	Returns the negotiated key exchange algorithm.
SSLNegotiatedKeyExchangeStrength	Returns the negotiated key exchange algorithm strength.
SSLNegotiatedVersion	Returns the negotiated protocol version.
SSLSecurityFlags	Flags that control certificate verification.
SSLServerCACerts	A newline separated list of CA certificates to use during SSL server certificate validation.
TLS12SignatureAlgorithms	Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.
TLS12SupportedGroups	The supported groups for ECC.
TLS13KeyShareGroups	The groups for which to pregenerate key shares.
TLS13SignatureAlgorithms	The allowed certificate signature algorithms.
TLS13SupportedGroups	The supported groups for (EC)DHE key exchange.
BuildInfo	Information about the product's build.
CodePage	The system code page used for Unicode to Multibyte translations.
LicenseInfo	Information about the current license.
MaskSensitiveData	Whether sensitive data is masked in log messages.
UseInternalSecurityAPI	Whether or not to use the system security libraries or an internal implementation.

attachment_count property (AS1Receiver Struct)

The number of records in the Attachment arrays.

Syntax

fn attachment_count(&self ) -> Result<i32, IPWorksEDIError>

Default Value

Remarks

This property controls the size of the following arrays:

attachment_content_type
attachment_data
attachment_file_name
attachment_headers
attachment_name

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

This property is read-only.

Data Type

i32

attachment_content_type property (AS1Receiver Struct)

The MIME content-type of this ediattachment .

Syntax

fn attachment_content_type(&self , AttachmentIndex : i32) -> Result<String, IPWorksEDIError>

Default Value

Remarks

The MIME content-type of this EDIAttachment.

The AttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.

This property is read-only.

Data Type

String

attachment_data property (AS1Receiver Struct)

This property contains the attachment data.

Syntax

fn attachment_data(&self , AttachmentIndex : i32) -> Result<Vec<u8>, IPWorksEDIError>

Default Value

Remarks

This property contains the attachment data.

In a receiver, the struct 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 AttachmentIndex parameter specifies the index of the item in the array. The size of the array is controlled by the AttachmentCount property.

This property is read-only.

Data Type

Vec

attachment_file_name property (AS1Receiver Struct)

The file name of the attachment.

Syntax

fn attachment_file_name(&self , AttachmentIndex : i32) -> Result<String, IPWorksEDIError>

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

This property is read-only.

Data Type

String

attachment_headers property (AS1Receiver Struct)

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

Syntax

fn attachment_headers(&self , AttachmentIndex : i32) -> Result<String, IPWorksEDIError>

Default Value

Remarks

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

This property is read-only.

Data Type

String

attachment_name property (AS1Receiver Struct)

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

Syntax

fn attachment_name(&self , AttachmentIndex : i32) -> Result<String, IPWorksEDIError>

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

This property is read-only.

Data Type

String

cert_effective_date property (AS1Receiver Struct)

The date on which this certificate becomes valid.

Syntax

fn cert_effective_date(&self ) -> Result<String, IPWorksEDIError>

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.

Data Type

String

cert_expiration_date property (AS1Receiver Struct)

The date on which the certificate expires.

Syntax

fn cert_expiration_date(&self ) -> Result<String, IPWorksEDIError>

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.

Data Type

String

cert_extended_key_usage property (AS1Receiver Struct)

A comma-delimited list of extended key usage identifiers.

Syntax

fn cert_extended_key_usage(&self ) -> Result<String, IPWorksEDIError>

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.

Data Type

String

cert_fingerprint property (AS1Receiver Struct)

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

Syntax

fn cert_fingerprint(&self ) -> Result<String, IPWorksEDIError>

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.

Data Type

String

cert_fingerprint_sha1 property (AS1Receiver Struct)

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

Syntax

fn cert_fingerprint_sha1(&self ) -> Result<String, IPWorksEDIError>

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.

Data Type

String

cert_fingerprint_sha256 property (AS1Receiver Struct)

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

Syntax

fn cert_fingerprint_sha256(&self ) -> Result<String, IPWorksEDIError>

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.

Data Type

String

cert_issuer property (AS1Receiver Struct)

The issuer of the certificate.

Syntax

fn cert_issuer(&self ) -> Result<String, IPWorksEDIError>

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.

Data Type

String

cert_private_key property (AS1Receiver Struct)

The private key of the certificate (if available).

Syntax

fn cert_private_key(&self ) -> Result<String, IPWorksEDIError>

Default Value

Remarks

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

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

This property is read-only.

Data Type

String

cert_private_key_available property (AS1Receiver Struct)

Whether a PrivateKey is available for the selected certificate.

Syntax

fn cert_private_key_available(&self ) -> Result<bool, IPWorksEDIError>

Default Value

false

Remarks

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

This property is read-only.

Data Type

bool

cert_private_key_container property (AS1Receiver Struct)

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

Syntax

fn cert_private_key_container(&self ) -> Result<String, IPWorksEDIError>

Default Value

Remarks

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

This property is read-only.

Data Type

String

cert_public_key property (AS1Receiver Struct)

The public key of the certificate.

Syntax

fn cert_public_key(&self ) -> Result<String, IPWorksEDIError>

Default Value

Remarks

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

This property is read-only.

Data Type

String

cert_public_key_algorithm property (AS1Receiver Struct)

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

Syntax

fn cert_public_key_algorithm(&self ) -> Result<String, IPWorksEDIError>

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.

Data Type

String

cert_public_key_length property (AS1Receiver Struct)

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

Syntax

fn cert_public_key_length(&self ) -> Result<i32, IPWorksEDIError>

Default Value

Remarks

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

This property is read-only.

Data Type

i32

cert_serial_number property (AS1Receiver Struct)

The serial number of the certificate encoded as a string.

Syntax

fn cert_serial_number(&self ) -> Result<String, IPWorksEDIError>

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.

Data Type

String

cert_signature_algorithm property (AS1Receiver Struct)

The text description of the certificate's signature algorithm.

Syntax

fn cert_signature_algorithm(&self ) -> Result<String, IPWorksEDIError>

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.

Data Type

String

cert_store property (AS1Receiver Struct)

The name of the certificate store for the client certificate.

Syntax

fn cert_store(&self ) -> Result<Vec<u8>, IPWorksEDIError> 
fn set_cert_store(&self, value : Vec<u8>) ->  Option<IPWorksEDIError> 
fn set_cert_store_ref(&self, value : &[u8]) ->  Option<IPWorksEDIError>

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

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

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

Designations of certificate stores are platform dependent.

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


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

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

Data Type

Vec

cert_store_password property (AS1Receiver Struct)

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

Syntax

fn cert_store_password(&self ) -> Result<String, IPWorksEDIError> 
fn set_cert_store_password(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_cert_store_password_ref(&self, value : &String) ->  Option<IPWorksEDIError>

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.

Data Type

String

cert_store_type property (AS1Receiver Struct)

The type of certificate store for this certificate.

Syntax

fn cert_store_type(&self ) -> Result<i32, IPWorksEDIError> 
fn set_cert_store_type(&self, value : i32) ->  Option<IPWorksEDIError>

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

Remarks

The type of certificate store for this certificate.

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


0 (cstUser - default)	For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java.
1 (cstMachine)	For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java.
2 (cstPFXFile)	The certificate store is the name of a PFX (PKCS#12) file containing certificates.
3 (cstPFXBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format.
4 (cstJKSFile)	The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java.
5 (cstJKSBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java.
6 (cstPEMKeyFile)	The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
7 (cstPEMKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate.
8 (cstPublicKeyFile)	The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
9 (cstPublicKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate.
10 (cstSSHPublicKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key.
11 (cstP7BFile)	The certificate store is the name of a PKCS#7 file containing certificates.
12 (cstP7BBlob)	The certificate store is a string (binary) representing a certificate store in PKCS#7 format.
13 (cstSSHPublicKeyFile)	The certificate store is the name of a file that contains an SSH-style public key.
14 (cstPPKFile)	The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
15 (cstPPKBlob)	The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
16 (cstXMLFile)	The certificate store is the name of a file that contains a certificate in XML format.
17 (cstXMLBlob)	The certificate store is a string that contains a certificate in XML format.
18 (cstJWKFile)	The certificate store is the name of a file that contains a JWK (JSON Web Key).
19 (cstJWKBlob)	The certificate store is a string that contains a JWK (JSON Web Key).
21 (cstBCFKSFile)	The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET.
22 (cstBCFKSBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET.
23 (cstPKCS11)	The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new Certificate object and pass `cstPKCS11` as the cert_store_type, the full path of the PKCS#11 DLL as the cert_store, and the PIN as the cert_store_password. Code Example. SSH Authentication with Security Key (without CertMgr): `sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);` Alternatively, collect the necessary data using the CertMgr struct by calling the list_store_certificates method after setting the corresponding properties accordingly. The certificate information returned in the on_cert_list event's `CertEncoded` parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the cert_store and set cert_store_password to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): `certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);`
99 (cstAuto)	The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

Data Type

i32

cert_subject_alt_names property (AS1Receiver Struct)

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

Syntax

fn cert_subject_alt_names(&self ) -> Result<String, IPWorksEDIError>

Default Value

Remarks

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

This property is read-only.

Data Type

String

cert_thumbprint_md5 property (AS1Receiver Struct)

The MD5 hash of the certificate.

Syntax

fn cert_thumbprint_md5(&self ) -> Result<String, IPWorksEDIError>

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.

Data Type

String

cert_thumbprint_sha1 property (AS1Receiver Struct)

The SHA-1 hash of the certificate.

Syntax

fn cert_thumbprint_sha1(&self ) -> Result<String, IPWorksEDIError>

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.

Data Type

String

cert_thumbprint_sha256 property (AS1Receiver Struct)

The SHA-256 hash of the certificate.

Syntax

fn cert_thumbprint_sha256(&self ) -> Result<String, IPWorksEDIError>

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.

Data Type

String

cert_usage property (AS1Receiver Struct)

The text description of UsageFlags .

Syntax

fn cert_usage(&self ) -> Result<String, IPWorksEDIError>

Default Value

Remarks

The text description of 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.

Data Type

String

cert_usage_flags property (AS1Receiver Struct)

The flags that show intended use for the certificate.

Syntax

fn cert_usage_flags(&self ) -> Result<i32, IPWorksEDIError>

Default Value

Remarks

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


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

Please see the cert_usage property for a text representation of cert_usage_flags.

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

This property is read-only.

Data Type

i32

cert_version property (AS1Receiver Struct)

The certificate's version number.

Syntax

fn cert_version(&self ) -> Result<String, IPWorksEDIError>

Default Value

Remarks

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

This property is read-only.

Data Type

String

cert_subject property (AS1Receiver Struct)

The subject of the certificate used for client authentication.

Syntax

fn cert_subject(&self ) -> Result<String, IPWorksEDIError> 
fn set_cert_subject(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_cert_subject_ref(&self, value : &String) ->  Option<IPWorksEDIError>

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:


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

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

Data Type

String

cert_encoded property (AS1Receiver Struct)

The certificate (PEM/Base64 encoded).

Syntax

fn cert_encoded(&self ) -> Result<Vec<u8>, IPWorksEDIError> 
fn set_cert_encoded(&self, value : Vec<u8>) ->  Option<IPWorksEDIError> 
fn set_cert_encoded_ref(&self, value : &[u8]) ->  Option<IPWorksEDIError>

Default Value

Remarks

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

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

Data Type

Vec

compression_format property (AS1Receiver Struct)

The compression format used on the incoming message.

Syntax

fn compression_format(&self ) -> Result<i32, IPWorksEDIError>

Possible Values

0   // None
1   // ZLIB

Default Value

Remarks

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

This property is read-only.

Data Type

i32

connected property (AS1Receiver Struct)

Whether the struct is connected.

Syntax

fn connected(&self ) -> Result<bool, IPWorksEDIError>

Default Value

false

Remarks

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

This property is read-only.

Data Type

bool

edi_data property (AS1Receiver Struct)

This property contains the EDI payload of the transmission.

Syntax

fn edi_data(&self ) -> Result<Vec<u8>, IPWorksEDIError>

Default Value

Remarks

This property contains the EDI payload of the transmission.

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

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

This property is read-only.

Data Type

Vec

edi_type property (AS1Receiver Struct)

The Content-Type of the EDI message.

Syntax

fn edi_type(&self ) -> Result<String, IPWorksEDIError>

Default Value

Remarks

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

This property is read-only.

Data Type

String

edi_name property (AS1Receiver Struct)

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

Syntax

fn edi_name(&self ) -> Result<String, IPWorksEDIError>

Default Value

"rfc1767.edi"

Remarks

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

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

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

This property is read-only.

Data Type

String

edi_file_name property (AS1Receiver Struct)

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

Syntax

fn edi_file_name(&self ) -> Result<String, IPWorksEDIError>

Default Value

Remarks

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

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

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

This property is read-only.

Data Type

String

firewall_auto_detect property (AS1Receiver Struct)

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

Syntax

fn firewall_auto_detect(&self ) -> Result<bool, IPWorksEDIError> 
fn set_firewall_auto_detect(&self, value : bool) ->  Option<IPWorksEDIError>

Default Value

false

Remarks

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

Data Type

bool

firewall_type property (AS1Receiver Struct)

The type of firewall to connect through.

Syntax

fn firewall_type(&self ) -> Result<i32, IPWorksEDIError> 
fn set_firewall_type(&self, value : i32) ->  Option<IPWorksEDIError>

Possible Values

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

Default Value

Remarks

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


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

Data Type

i32

firewall_host property (AS1Receiver Struct)

The name or IP address of the firewall (optional).

Syntax

fn firewall_host(&self ) -> Result<String, IPWorksEDIError> 
fn set_firewall_host(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_firewall_host_ref(&self, value : &String) ->  Option<IPWorksEDIError>

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 struct fails with an error.

Data Type

String

firewall_password property (AS1Receiver Struct)

A password if authentication is to be used when connecting through the firewall.

Syntax

fn firewall_password(&self ) -> Result<String, IPWorksEDIError> 
fn set_firewall_password(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_firewall_password_ref(&self, value : &String) ->  Option<IPWorksEDIError>

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 struct fails with an error.

Data Type

String

firewall_port property (AS1Receiver Struct)

The Transmission Control Protocol (TCP) port for the firewall Host .

Syntax

fn firewall_port(&self ) -> Result<i32, IPWorksEDIError> 
fn set_firewall_port(&self, value : i32) ->  Option<IPWorksEDIError>

Default Value

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_firewall_type is set to a valid value. See the description of the firewall_firewall_type property for details.

Data Type

i32

firewall_user property (AS1Receiver Struct)

A username if authentication is to be used when connecting through a firewall.

Syntax

fn firewall_user(&self ) -> Result<String, IPWorksEDIError> 
fn set_firewall_user(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_firewall_user_ref(&self, value : &String) ->  Option<IPWorksEDIError>

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 struct fails with an error.

Data Type

String

from property (AS1Receiver Struct)

The sender of the original message.

Syntax

fn from(&self ) -> Result<String, IPWorksEDIError> 
fn set_from(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_from_ref(&self, value : &String) ->  Option<IPWorksEDIError>

Default Value

Remarks

The sender of the original message. The recipient is given by send_to.

Note that from and send_to correspond to the sender and recipient of the original message. For MDNs the roles are reversed, so that from indicates the recipient, and send_to indicates the sender of the MDN.

Data Type

String

local_host property (AS1Receiver Struct)

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

Syntax

fn local_host(&self ) -> Result<String, IPWorksEDIError> 
fn set_local_host(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_local_host_ref(&self, value : &String) ->  Option<IPWorksEDIError>

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 struct initiate connections (or accept in the case of server structs) 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 struct 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.

Data Type

String

log_directory property (AS1Receiver Struct)

The path to a directory for logging.

Syntax

fn log_directory(&self ) -> Result<String, IPWorksEDIError> 
fn set_log_directory(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_log_directory_ref(&self, value : &String) ->  Option<IPWorksEDIError>

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 struct will log the original EDI data, the complete text of the outgoing request and the incoming response.

The struct 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 AS1 messages created or downloaded by the struct will be written with extension ".as1", and MDNs created or downloaded will be written with extension ".as1-mdn".

The filenames will be chosen automatically by the struct. 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.

Data Type

String

log_file property (AS1Receiver Struct)

The log file written.

Syntax

fn log_file(&self ) -> Result<String, IPWorksEDIError>

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 AS1 messages and MDNs will also be written with extensions ".as1" and ".as1-mdn".

This property is read-only.

Data Type

String

mail_message_cc property (AS1Receiver Struct)

The value of the Cc header of the mail message.

Syntax

fn mail_message_cc(&self ) -> Result<String, IPWorksEDIError>

Default Value

Remarks

After calling select_mail_message this property will be populated with the value of the Cc header of the mail message.

This property is read-only.

Data Type

String

mail_message_count property (AS1Receiver Struct)

The number of messages waiting in the mailbox.

Syntax

fn mail_message_count(&self ) -> Result<i32, IPWorksEDIError>

Default Value

Remarks

When the struct is not connected to the mail server, the value of the mail_message_count property is 0. When connected, it contains the number of messages in the mailbox. You may set mail_message_number to any value between 1 and mail_message_count to inspect a given message.

This property is read-only.

Data Type

i32

mail_message_date property (AS1Receiver Struct)

The message date for the currently selected message.

Syntax

fn mail_message_date(&self ) -> Result<String, IPWorksEDIError>

Default Value

Remarks

The date will be formatted like the following example:

Wed, 29 Dec 2004 11:58:02 +0700

This property is read-only.

Data Type

String

mail_message_from property (AS1Receiver Struct)

The sender of the mail message.

Syntax

fn mail_message_from(&self ) -> Result<String, IPWorksEDIError>

Default Value

Remarks

After calling select_mail_message this property will be populated. When processing AS1 transmissions, this will correspond to from. When processing MDNs, this will correspond to send_to.

This property is read-only.

Data Type

String

mail_message_headers property (AS1Receiver Struct)

The message headers for the currently selected message.

Syntax

fn mail_message_headers(&self ) -> Result<String, IPWorksEDIError>

Default Value

Remarks

After calling select_mail_message this property will contain the full headers of the mail message as reported by the mail server.

This property is read-only.

Data Type

String

mail_message_number property (AS1Receiver Struct)

The message number on the incoming mail server.

Syntax

fn mail_message_number(&self ) -> Result<i32, IPWorksEDIError> 
fn set_mail_message_number(&self, value : i32) ->  Option<IPWorksEDIError>

Default Value

Remarks

mail_message_number specifies a number between 1 and mail_message_count, and serves as a message pointer to an incoming mail message.

Set this property before calling select_mail_message

Data Type

i32

mail_message_reply_to property (AS1Receiver Struct)

The value of the ReplyTo header of the mail message.

Syntax

fn mail_message_reply_to(&self ) -> Result<String, IPWorksEDIError>

Default Value

Remarks

After calling select_mail_message this property will be populated with the value of the ReplyTo header of the mail message.

This property is read-only.

Data Type

String

mail_message_subject property (AS1Receiver Struct)

The subject of the mail message.

Syntax

fn mail_message_subject(&self ) -> Result<String, IPWorksEDIError>

Default Value

Remarks

After calling select_mail_message this property will be populated with the subject of the mail message.

This property is read-only.

Data Type

String

mail_message_text property (AS1Receiver Struct)

The text of the mail message.

Syntax

fn mail_message_text(&self ) -> Result<String, IPWorksEDIError>

Default Value

Remarks

The text of the mail message identified by mail_message_number, if it has been downloaded from the server. To read the message, invoke read_request (receiver) or read_receipt (sender). In case the message is not as AS1 message this will throw an exception, but you may catch it and then read the value of mail_message_text.

This property is read-only.

Data Type

String

mail_message_to property (AS1Receiver Struct)

The recipient of the mail message.

Syntax

fn mail_message_to(&self ) -> Result<String, IPWorksEDIError>

Default Value

Remarks

After calling select_mail_message this property will be populated with the recipient of the mail message.

This property is read-only.

Data Type

String

mail_server property (AS1Receiver Struct)

The address of your mail server.

Syntax

fn mail_server(&self ) -> Result<String, IPWorksEDIError> 
fn set_mail_server(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_mail_server_ref(&self, value : &String) ->  Option<IPWorksEDIError>

Default Value

Remarks

The address of your mail server. By default, the struct will send outgoing mail via SMTP, and receive incoming mail via POP. Moreover, the struct will assume that both servers are located at the address specified by mail_server.

In case you use different addresses for incoming and outgoing mail you should set the POPServer and SMTPServer configuration settings appropriately. You may also set POPPort and SMTPPort in case you use nonstandard ports.

To configure SSL you should set ssl_start_mode. Note that if SSL is used for sending but not receiving, or vice versa, you should set ssl_start_mode each time you send or receive a file.

Data Type

String

mdn_receipt_content property (AS1Receiver Struct)

This contains the entire content of the MDN Receipt.

Syntax

fn mdn_receipt_content(&self ) -> Result<Vec<u8>, IPWorksEDIError> 
fn set_mdn_receipt_content(&self, value : Vec<u8>) ->  Option<IPWorksEDIError> 
fn set_mdn_receipt_content_ref(&self, value : &[u8]) ->  Option<IPWorksEDIError>

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.

Data Type

Vec

mdn_receipt_header_count property (AS1Receiver Struct)

The number of headers in the MDN.

Syntax

fn mdn_receipt_header_count(&self ) -> Result<i32, IPWorksEDIError>

Default Value

Remarks

The number of headers in the MDN.

This property is read-only.

Data Type

i32

mdn_receipt_header_field property (AS1Receiver Struct)

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

Syntax

fn mdn_receipt_header_field(&self ) -> Result<String, IPWorksEDIError>

Default Value

Remarks

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

This property is read-only.

Data Type

String

mdn_receipt_header_index property (AS1Receiver Struct)

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

Syntax

fn mdn_receipt_header_index(&self ) -> Result<i32, IPWorksEDIError> 
fn set_mdn_receipt_header_index(&self, value : i32) ->  Option<IPWorksEDIError>

Default Value

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.

Data Type

i32

mdn_receipt_headers property (AS1Receiver Struct)

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

Syntax

fn mdn_receipt_headers(&self ) -> Result<String, IPWorksEDIError> 
fn set_mdn_receipt_headers(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_mdn_receipt_headers_ref(&self, value : &String) ->  Option<IPWorksEDIError>

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.

Data Type

String

mdn_receipt_header_value property (AS1Receiver Struct)

The value of the MDN header currently selected by HeaderIndex .

Syntax

fn mdn_receipt_header_value(&self ) -> Result<String, IPWorksEDIError>

Default Value

Remarks

The value of the MDN header currently selected by mdn_receipt_header_index.

This property is read-only.

Data Type

String

mdn_receipt_mdn property (AS1Receiver Struct)

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

Syntax

fn mdn_receipt_mdn(&self ) -> Result<String, IPWorksEDIError>

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.

Data Type

String

mdn_receipt_message property (AS1Receiver Struct)

The human-readable portion of the MDN receipt.

Syntax

fn mdn_receipt_message(&self ) -> Result<String, IPWorksEDIError>

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.

Data Type

String

mdn_receipt_mic_value property (AS1Receiver Struct)

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

Syntax

fn mdn_receipt_mic_value(&self ) -> Result<String, IPWorksEDIError>

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.

Data Type

String

mdn_receipt_signing_protocol property (AS1Receiver Struct)

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

Syntax

fn mdn_receipt_signing_protocol(&self ) -> Result<String, IPWorksEDIError>

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.

Data Type

String

mdn_to property (AS1Receiver Struct)

The recipient for the Message Disposition Notification (MDN).

Syntax

fn mdn_to(&self ) -> Result<String, IPWorksEDIError>

Default Value

Remarks

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

The receipt will be contained in mdn_receipt. If receipt_delivery_option is empty, the receipt should be synchronously delivered in the HTTP response; otherwise, it should be delivered asynchronously to the URL specified. In either case, send_response will send the response as appropriate.

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

This property is read-only.

Data Type

String

message_id property (AS1Receiver Struct)

The message ID of the incoming message.

Syntax

fn message_id(&self ) -> Result<String, IPWorksEDIError>

Default Value

Remarks

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

This property is read-only.

Data Type

String

o_auth_access_token property (AS1Receiver Struct)

The access token returned by the authorization server.

Syntax

fn o_auth_access_token(&self ) -> Result<String, IPWorksEDIError> 
fn set_o_auth_access_token(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_o_auth_access_token_ref(&self, value : &String) ->  Option<IPWorksEDIError>

Default Value

Remarks

The access token returned by the authorization server. This is set when the struct makes a request to the token server.

Data Type

String

o_auth_authorization_scope property (AS1Receiver Struct)

The scope request or response parameter used during authorization.

Syntax

fn o_auth_authorization_scope(&self ) -> Result<String, IPWorksEDIError> 
fn set_o_auth_authorization_scope(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_o_auth_authorization_scope_ref(&self, value : &String) ->  Option<IPWorksEDIError>

Default Value

Remarks

The scope request or response parameter used during authorization.

Data Type

String

o_auth_client_id property (AS1Receiver Struct)

The id of the client assigned when registering the application.

Syntax

fn o_auth_client_id(&self ) -> Result<String, IPWorksEDIError> 
fn set_o_auth_client_id(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_o_auth_client_id_ref(&self, value : &String) ->  Option<IPWorksEDIError>

Default Value

Remarks

The id of the client assigned when registering the application.

Data Type

String

o_auth_client_secret property (AS1Receiver Struct)

The secret value for the client assigned when registering the application.

Syntax

fn o_auth_client_secret(&self ) -> Result<String, IPWorksEDIError> 
fn set_o_auth_client_secret(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_o_auth_client_secret_ref(&self, value : &String) ->  Option<IPWorksEDIError>

Default Value

Remarks

The secret value for the client assigned when registering the application.

Data Type

String

o_auth_refresh_token property (AS1Receiver Struct)

Specifies the refresh token received from or sent to the authorization server.

Syntax

fn o_auth_refresh_token(&self ) -> Result<String, IPWorksEDIError> 
fn set_o_auth_refresh_token(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_o_auth_refresh_token_ref(&self, value : &String) ->  Option<IPWorksEDIError>

Default Value

Remarks

Specifies the refresh token received from or sent to the authorization server. This property is set automatically if a refresh token is retrieved from the token server. If the OAuthAutomaticRefresh configuration setting is set to true, and the o_auth_grant_type property is set to a grant that can use refresh tokens.

Data Type

String

o_auth_return_url property (AS1Receiver Struct)

The URL where the user (browser) returns after authenticating.

Syntax

fn o_auth_return_url(&self ) -> Result<String, IPWorksEDIError> 
fn set_o_auth_return_url(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_o_auth_return_url_ref(&self, value : &String) ->  Option<IPWorksEDIError>

Default Value

Remarks

The URL where the user (browser) returns after authenticating. This property is mapped to the redirect_uri parameter when making a request to the authorization server. Typically, this is automatically set by the struct when using the embedded web server. If the OAuthWebServerPort or OAuthWebServerHost configuration settings is set, then this property should be set to match. If using the Web client profile, this should be set to the place where the authorization code will be parsed out of the response after the user finishes authorizing.

Data Type

String

o_auth_server_auth_url property (AS1Receiver Struct)

The URL of the authorization server.

Syntax

fn o_auth_server_auth_url(&self ) -> Result<String, IPWorksEDIError> 
fn set_o_auth_server_auth_url(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_o_auth_server_auth_url_ref(&self, value : &String) ->  Option<IPWorksEDIError>

Default Value

Remarks

The URL of the authorization server.

Data Type

String

o_auth_server_token_url property (AS1Receiver Struct)

The URL of the token server used to obtain the access token.

Syntax

fn o_auth_server_token_url(&self ) -> Result<String, IPWorksEDIError> 
fn set_o_auth_server_token_url(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_o_auth_server_token_url_ref(&self, value : &String) ->  Option<IPWorksEDIError>

Default Value

Remarks

The URL of the token server used to obtain the access token.

Data Type

String

password property (AS1Receiver Struct)

The password for your incoming mail server.

Syntax

fn password(&self ) -> Result<String, IPWorksEDIError> 
fn set_password(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_password_ref(&self, value : &String) ->  Option<IPWorksEDIError>

Default Value

Remarks

The password for your incoming mail server. Set this before invoking connect.

Data Type

String

request property (AS1Receiver Struct)

The AS1 request to be processed.

Syntax

fn request(&self ) -> Result<Vec<u8>, IPWorksEDIError> 
fn set_request(&self, value : Vec<u8>) ->  Option<IPWorksEDIError> 
fn set_request_ref(&self, value : &[u8]) ->  Option<IPWorksEDIError>

Default Value

Remarks

You may specify the request manually, or you may load the request from the mail server by invoking read_request.

The headers generally should be specified separately in request_headers.

Data Type

Vec

request_header_count property (AS1Receiver Struct)

The number of records in the RequestHeader arrays.

Syntax

fn request_header_count(&self ) -> Result<i32, IPWorksEDIError> 
fn set_request_header_count(&self, value : i32) ->  Option<IPWorksEDIError>

Default Value

Remarks

This property controls the size of the following arrays:

request_header_field
request_header_value

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

Data Type

i32

request_header_field property (AS1Receiver Struct)

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

Syntax

fn request_header_field(&self , RequestHeaderIndex : i32) -> Result<String, IPWorksEDIError> 
fn set_request_header_field(&self, RequestHeaderIndex : i32, value : &str) ->  Option<IPWorksEDIError> 
fn set_request_header_field_ref(&self, RequestHeaderIndex : i32, value : &String) ->  Option<IPWorksEDIError>

Default Value

Remarks

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

The RequestHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RequestHeaderCount property.

Data Type

String

request_header_value property (AS1Receiver Struct)

This property contains the header contents.

Syntax

fn request_header_value(&self , RequestHeaderIndex : i32) -> Result<String, IPWorksEDIError> 
fn set_request_header_value(&self, RequestHeaderIndex : i32, value : &str) ->  Option<IPWorksEDIError> 
fn set_request_header_value_ref(&self, RequestHeaderIndex : i32, value : &String) ->  Option<IPWorksEDIError>

Default Value

Remarks

This property contains the Header contents.

The RequestHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RequestHeaderCount property.

Data Type

String

request_headers_string property (AS1Receiver Struct)

The headers in the AS1 request.

Syntax

fn request_headers_string(&self ) -> Result<String, IPWorksEDIError> 
fn set_request_headers_string(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_request_headers_string_ref(&self, value : &String) ->  Option<IPWorksEDIError>

Default Value

Remarks

The headers will include any and all headers attached by the mail server(s).

Data Type

String

scan_result property (AS1Receiver Struct)

The result of invoking ParseRequest .

Syntax

fn scan_result(&self ) -> Result<i32, IPWorksEDIError>

Default Value

Remarks

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


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

This property is read-only.

Data Type

i32

send_to property (AS1Receiver Struct)

The recipient of the original message.

Syntax

fn send_to(&self ) -> Result<String, IPWorksEDIError> 
fn set_send_to(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_send_to_ref(&self, value : &String) ->  Option<IPWorksEDIError>

Default Value

Remarks

The recipient of the original message. The originator is given by from.

Data Type

String

signer_cert_effective_date property (AS1Receiver Struct)

The date on which this certificate becomes valid.

Syntax

fn signer_cert_effective_date(&self ) -> Result<String, IPWorksEDIError>

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.

Data Type

String

signer_cert_expiration_date property (AS1Receiver Struct)

The date on which the certificate expires.

Syntax

fn signer_cert_expiration_date(&self ) -> Result<String, IPWorksEDIError>

Default Value

Remarks

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

signer_cert_extended_key_usage property (AS1Receiver Struct)

A comma-delimited list of extended key usage identifiers.

Syntax

fn signer_cert_extended_key_usage(&self ) -> Result<String, IPWorksEDIError>

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.

Data Type

String

signer_cert_fingerprint property (AS1Receiver Struct)

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

Syntax

fn signer_cert_fingerprint(&self ) -> Result<String, IPWorksEDIError>

Default Value

Remarks

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.

Data Type

String

signer_cert_fingerprint_sha1 property (AS1Receiver Struct)

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

Syntax

fn signer_cert_fingerprint_sha1(&self ) -> Result<String, IPWorksEDIError>

Default Value

Remarks

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.

Data Type

String

signer_cert_fingerprint_sha256 property (AS1Receiver Struct)

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

Syntax

fn signer_cert_fingerprint_sha256(&self ) -> Result<String, IPWorksEDIError>

Default Value

Remarks

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.

Data Type

String

signer_cert_issuer property (AS1Receiver Struct)

The issuer of the certificate.

Syntax

fn signer_cert_issuer(&self ) -> Result<String, IPWorksEDIError>

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.

Data Type

String

signer_cert_private_key property (AS1Receiver Struct)

The private key of the certificate (if available).

Syntax

fn signer_cert_private_key(&self ) -> Result<String, IPWorksEDIError>

Default Value

Remarks

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

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

This property is read-only.

Data Type

String

signer_cert_private_key_available property (AS1Receiver Struct)

Whether a PrivateKey is available for the selected certificate.

Syntax

fn signer_cert_private_key_available(&self ) -> Result<bool, IPWorksEDIError>

Default Value

false

Remarks

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

This property is read-only.

Data Type

bool

signer_cert_private_key_container property (AS1Receiver Struct)

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

Syntax

fn signer_cert_private_key_container(&self ) -> Result<String, IPWorksEDIError>

Default Value

Remarks

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

This property is read-only.

Data Type

String

signer_cert_public_key property (AS1Receiver Struct)

The public key of the certificate.

Syntax

fn signer_cert_public_key(&self ) -> Result<String, IPWorksEDIError>

Default Value

Remarks

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

This property is read-only.

Data Type

String

signer_cert_public_key_algorithm property (AS1Receiver Struct)

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

Syntax

fn signer_cert_public_key_algorithm(&self ) -> Result<String, IPWorksEDIError>

Default Value

Remarks

This property is read-only.

Data Type

String

signer_cert_public_key_length property (AS1Receiver Struct)

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

Syntax

fn signer_cert_public_key_length(&self ) -> Result<i32, IPWorksEDIError>

Default Value

Remarks

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

This property is read-only.

Data Type

i32

signer_cert_serial_number property (AS1Receiver Struct)

The serial number of the certificate encoded as a string.

Syntax

fn signer_cert_serial_number(&self ) -> Result<String, IPWorksEDIError>

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.

Data Type

String

signer_cert_signature_algorithm property (AS1Receiver Struct)

The text description of the certificate's signature algorithm.

Syntax

fn signer_cert_signature_algorithm(&self ) -> Result<String, IPWorksEDIError>

Default Value

Remarks

This property is read-only.

Data Type

String

signer_cert_store property (AS1Receiver Struct)

The name of the certificate store for the client certificate.

Syntax

fn signer_cert_store(&self ) -> Result<Vec<u8>, IPWorksEDIError> 
fn set_signer_cert_store(&self, value : Vec<u8>) ->  Option<IPWorksEDIError> 
fn set_signer_cert_store_ref(&self, value : &[u8]) ->  Option<IPWorksEDIError>

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

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

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

Designations of certificate stores are platform dependent.

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


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

Data Type

Vec

signer_cert_store_password property (AS1Receiver Struct)

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

Syntax

fn signer_cert_store_password(&self ) -> Result<String, IPWorksEDIError> 
fn set_signer_cert_store_password(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_signer_cert_store_password_ref(&self, value : &String) ->  Option<IPWorksEDIError>

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.

Data Type

String

signer_cert_store_type property (AS1Receiver Struct)

The type of certificate store for this certificate.

Syntax

fn signer_cert_store_type(&self ) -> Result<i32, IPWorksEDIError> 
fn set_signer_cert_store_type(&self, value : i32) ->  Option<IPWorksEDIError>

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

Remarks

The type of certificate store for this certificate.


0 (cstUser - default)	For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java.
1 (cstMachine)	For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java.
2 (cstPFXFile)	The certificate store is the name of a PFX (PKCS#12) file containing certificates.
3 (cstPFXBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format.
4 (cstJKSFile)	The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java.
5 (cstJKSBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java.
6 (cstPEMKeyFile)	The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
7 (cstPEMKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate.
8 (cstPublicKeyFile)	The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
9 (cstPublicKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate.
10 (cstSSHPublicKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key.
11 (cstP7BFile)	The certificate store is the name of a PKCS#7 file containing certificates.
12 (cstP7BBlob)	The certificate store is a string (binary) representing a certificate store in PKCS#7 format.
13 (cstSSHPublicKeyFile)	The certificate store is the name of a file that contains an SSH-style public key.
14 (cstPPKFile)	The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
15 (cstPPKBlob)	The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
16 (cstXMLFile)	The certificate store is the name of a file that contains a certificate in XML format.
17 (cstXMLBlob)	The certificate store is a string that contains a certificate in XML format.
18 (cstJWKFile)	The certificate store is the name of a file that contains a JWK (JSON Web Key).
19 (cstJWKBlob)	The certificate store is a string that contains a JWK (JSON Web Key).
21 (cstBCFKSFile)	The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET.
22 (cstBCFKSBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET.
23 (cstPKCS11)	The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new Certificate object and pass `cstPKCS11` as the signer_cert_store_type, the full path of the PKCS#11 DLL as the signer_cert_store, and the PIN as the signer_cert_store_password. Code Example. SSH Authentication with Security Key (without CertMgr): `sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);` Alternatively, collect the necessary data using the CertMgr struct by calling the list_store_certificates method after setting the corresponding properties accordingly. The certificate information returned in the on_cert_list event's `CertEncoded` parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the signer_cert_store and set signer_cert_store_password to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): `certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);`
99 (cstAuto)	The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

Data Type

i32

signer_cert_subject_alt_names property (AS1Receiver Struct)

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

Syntax

fn signer_cert_subject_alt_names(&self ) -> Result<String, IPWorksEDIError>

Default Value

Remarks

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

This property is read-only.

Data Type

String

signer_cert_thumbprint_md5 property (AS1Receiver Struct)

The MD5 hash of the certificate.

Syntax

fn signer_cert_thumbprint_md5(&self ) -> Result<String, IPWorksEDIError>

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.

Data Type

String

signer_cert_thumbprint_sha1 property (AS1Receiver Struct)

The SHA-1 hash of the certificate.

Syntax

fn signer_cert_thumbprint_sha1(&self ) -> Result<String, IPWorksEDIError>

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.

Data Type

String

signer_cert_thumbprint_sha256 property (AS1Receiver Struct)

The SHA-256 hash of the certificate.

Syntax

fn signer_cert_thumbprint_sha256(&self ) -> Result<String, IPWorksEDIError>

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.

Data Type

String

signer_cert_usage property (AS1Receiver Struct)

The text description of UsageFlags .

Syntax

fn signer_cert_usage(&self ) -> Result<String, IPWorksEDIError>

Default Value

Remarks

The text description of 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.

Data Type

String

signer_cert_usage_flags property (AS1Receiver Struct)

The flags that show intended use for the certificate.

Syntax

fn signer_cert_usage_flags(&self ) -> Result<i32, IPWorksEDIError>

Default Value

Remarks

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


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

Please see the signer_cert_usage property for a text representation of signer_cert_usage_flags.

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

This property is read-only.

Data Type

i32

signer_cert_version property (AS1Receiver Struct)

The certificate's version number.

Syntax

fn signer_cert_version(&self ) -> Result<String, IPWorksEDIError>

Default Value

Remarks

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

This property is read-only.

Data Type

String

signer_cert_subject property (AS1Receiver Struct)

The subject of the certificate used for client authentication.

Syntax

fn signer_cert_subject(&self ) -> Result<String, IPWorksEDIError> 
fn set_signer_cert_subject(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_signer_cert_subject_ref(&self, value : &String) ->  Option<IPWorksEDIError>

Default Value

Remarks

The subject of the certificate used for client authentication.

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.


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

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

Data Type

String

signer_cert_encoded property (AS1Receiver Struct)

The certificate (PEM/Base64 encoded).

Syntax

fn signer_cert_encoded(&self ) -> Result<Vec<u8>, IPWorksEDIError> 
fn set_signer_cert_encoded(&self, value : Vec<u8>) ->  Option<IPWorksEDIError> 
fn set_signer_cert_encoded_ref(&self, value : &[u8]) ->  Option<IPWorksEDIError>

Default Value

Remarks

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

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

Data Type

Vec

ssl_accept_server_cert_effective_date property (AS1Receiver Struct)

The date on which this certificate becomes valid.

Syntax

fn ssl_accept_server_cert_effective_date(&self ) -> Result<String, IPWorksEDIError>

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.

Data Type

String

ssl_accept_server_cert_expiration_date property (AS1Receiver Struct)

The date on which the certificate expires.

Syntax

fn ssl_accept_server_cert_expiration_date(&self ) -> Result<String, IPWorksEDIError>

Default Value

Remarks

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

ssl_accept_server_cert_extended_key_usage property (AS1Receiver Struct)

A comma-delimited list of extended key usage identifiers.

Syntax

fn ssl_accept_server_cert_extended_key_usage(&self ) -> Result<String, IPWorksEDIError>

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.

Data Type

String

ssl_accept_server_cert_fingerprint property (AS1Receiver Struct)

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

Syntax

fn ssl_accept_server_cert_fingerprint(&self ) -> Result<String, IPWorksEDIError>

Default Value

Remarks

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.

Data Type

String

ssl_accept_server_cert_fingerprint_sha1 property (AS1Receiver Struct)

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

Syntax

fn ssl_accept_server_cert_fingerprint_sha1(&self ) -> Result<String, IPWorksEDIError>

Default Value

Remarks

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.

Data Type

String

ssl_accept_server_cert_fingerprint_sha256 property (AS1Receiver Struct)

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

Syntax

fn ssl_accept_server_cert_fingerprint_sha256(&self ) -> Result<String, IPWorksEDIError>

Default Value

Remarks

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.

Data Type

String

ssl_accept_server_cert_issuer property (AS1Receiver Struct)

The issuer of the certificate.

Syntax

fn ssl_accept_server_cert_issuer(&self ) -> Result<String, IPWorksEDIError>

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.

Data Type

String

ssl_accept_server_cert_private_key property (AS1Receiver Struct)

The private key of the certificate (if available).

Syntax

fn ssl_accept_server_cert_private_key(&self ) -> Result<String, IPWorksEDIError>

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.

Data Type

String

ssl_accept_server_cert_private_key_available property (AS1Receiver Struct)

Whether a PrivateKey is available for the selected certificate.

Syntax

fn ssl_accept_server_cert_private_key_available(&self ) -> Result<bool, IPWorksEDIError>

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.

Data Type

bool

ssl_accept_server_cert_private_key_container property (AS1Receiver Struct)

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

Syntax

fn ssl_accept_server_cert_private_key_container(&self ) -> Result<String, IPWorksEDIError>

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.

Data Type

String

ssl_accept_server_cert_public_key property (AS1Receiver Struct)

The public key of the certificate.

Syntax

fn ssl_accept_server_cert_public_key(&self ) -> Result<String, IPWorksEDIError>

Default Value

Remarks

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

This property is read-only.

Data Type

String

ssl_accept_server_cert_public_key_algorithm property (AS1Receiver Struct)

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

Syntax

fn ssl_accept_server_cert_public_key_algorithm(&self ) -> Result<String, IPWorksEDIError>

Default Value

Remarks

This property is read-only.

Data Type

String

ssl_accept_server_cert_public_key_length property (AS1Receiver Struct)

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

Syntax

fn ssl_accept_server_cert_public_key_length(&self ) -> Result<i32, IPWorksEDIError>

Default Value

Remarks

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

This property is read-only.

Data Type

i32

ssl_accept_server_cert_serial_number property (AS1Receiver Struct)

The serial number of the certificate encoded as a string.

Syntax

fn ssl_accept_server_cert_serial_number(&self ) -> Result<String, IPWorksEDIError>

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.

Data Type

String

ssl_accept_server_cert_signature_algorithm property (AS1Receiver Struct)

The text description of the certificate's signature algorithm.

Syntax

fn ssl_accept_server_cert_signature_algorithm(&self ) -> Result<String, IPWorksEDIError>

Default Value

Remarks

This property is read-only.

Data Type

String

ssl_accept_server_cert_store property (AS1Receiver Struct)

The name of the certificate store for the client certificate.

Syntax

fn ssl_accept_server_cert_store(&self ) -> Result<Vec<u8>, IPWorksEDIError> 
fn set_ssl_accept_server_cert_store(&self, value : Vec<u8>) ->  Option<IPWorksEDIError> 
fn set_ssl_accept_server_cert_store_ref(&self, value : &[u8]) ->  Option<IPWorksEDIError>

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:


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

Data Type

Vec

ssl_accept_server_cert_store_password property (AS1Receiver Struct)

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

Syntax

fn ssl_accept_server_cert_store_password(&self ) -> Result<String, IPWorksEDIError> 
fn set_ssl_accept_server_cert_store_password(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_ssl_accept_server_cert_store_password_ref(&self, value : &String) ->  Option<IPWorksEDIError>

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.

Data Type

String

ssl_accept_server_cert_store_type property (AS1Receiver Struct)

The type of certificate store for this certificate.

Syntax

fn ssl_accept_server_cert_store_type(&self ) -> Result<i32, IPWorksEDIError> 
fn set_ssl_accept_server_cert_store_type(&self, value : i32) ->  Option<IPWorksEDIError>

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

Remarks

The type of certificate store for this certificate.


0 (cstUser - default)	For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java.
1 (cstMachine)	For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java.
2 (cstPFXFile)	The certificate store is the name of a PFX (PKCS#12) file containing certificates.
3 (cstPFXBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format.
4 (cstJKSFile)	The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java.
5 (cstJKSBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java.
6 (cstPEMKeyFile)	The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
7 (cstPEMKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate.
8 (cstPublicKeyFile)	The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
9 (cstPublicKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate.
10 (cstSSHPublicKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key.
11 (cstP7BFile)	The certificate store is the name of a PKCS#7 file containing certificates.
12 (cstP7BBlob)	The certificate store is a string (binary) representing a certificate store in PKCS#7 format.
13 (cstSSHPublicKeyFile)	The certificate store is the name of a file that contains an SSH-style public key.
14 (cstPPKFile)	The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
15 (cstPPKBlob)	The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
16 (cstXMLFile)	The certificate store is the name of a file that contains a certificate in XML format.
17 (cstXMLBlob)	The certificate store is a string that contains a certificate in XML format.
18 (cstJWKFile)	The certificate store is the name of a file that contains a JWK (JSON Web Key).
19 (cstJWKBlob)	The certificate store is a string that contains a JWK (JSON Web Key).
21 (cstBCFKSFile)	The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET.
22 (cstBCFKSBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET.
23 (cstPKCS11)	The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new Certificate object and pass `cstPKCS11` as the ssl_accept_server_cert_store_type, the full path of the PKCS#11 DLL as the ssl_accept_server_cert_store, and the PIN as the ssl_accept_server_cert_store_password. Code Example. SSH Authentication with Security Key (without CertMgr): `sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);` Alternatively, collect the necessary data using the CertMgr struct by calling the list_store_certificates method after setting the corresponding properties accordingly. The certificate information returned in the on_cert_list event's `CertEncoded` parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the ssl_accept_server_cert_store and set ssl_accept_server_cert_store_password to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): `certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);`
99 (cstAuto)	The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

Data Type

i32

ssl_accept_server_cert_subject_alt_names property (AS1Receiver Struct)

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

Syntax

fn ssl_accept_server_cert_subject_alt_names(&self ) -> Result<String, IPWorksEDIError>

Default Value

Remarks

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

This property is read-only.

Data Type

String

ssl_accept_server_cert_thumbprint_md5 property (AS1Receiver Struct)

The MD5 hash of the certificate.

Syntax

fn ssl_accept_server_cert_thumbprint_md5(&self ) -> Result<String, IPWorksEDIError>

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.

Data Type

String

ssl_accept_server_cert_thumbprint_sha1 property (AS1Receiver Struct)

The SHA-1 hash of the certificate.

Syntax

fn ssl_accept_server_cert_thumbprint_sha1(&self ) -> Result<String, IPWorksEDIError>

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.

Data Type

String

ssl_accept_server_cert_thumbprint_sha256 property (AS1Receiver Struct)

The SHA-256 hash of the certificate.

Syntax

fn ssl_accept_server_cert_thumbprint_sha256(&self ) -> Result<String, IPWorksEDIError>

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.

Data Type

String

ssl_accept_server_cert_usage property (AS1Receiver Struct)

The text description of UsageFlags .

Syntax

fn ssl_accept_server_cert_usage(&self ) -> Result<String, IPWorksEDIError>

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.

Data Type

String

ssl_accept_server_cert_usage_flags property (AS1Receiver Struct)

The flags that show intended use for the certificate.

Syntax

fn ssl_accept_server_cert_usage_flags(&self ) -> Result<i32, IPWorksEDIError>

Default Value

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:


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

Please see the 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.

Data Type

i32

ssl_accept_server_cert_version property (AS1Receiver Struct)

The certificate's version number.

Syntax

fn ssl_accept_server_cert_version(&self ) -> Result<String, IPWorksEDIError>

Default Value

Remarks

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

This property is read-only.

Data Type

String

ssl_accept_server_cert_subject property (AS1Receiver Struct)

The subject of the certificate used for client authentication.

Syntax

fn ssl_accept_server_cert_subject(&self ) -> Result<String, IPWorksEDIError> 
fn set_ssl_accept_server_cert_subject(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_ssl_accept_server_cert_subject_ref(&self, value : &String) ->  Option<IPWorksEDIError>

Default Value

Remarks

The subject of the certificate used for client authentication.

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.


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

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

Data Type

String

ssl_accept_server_cert_encoded property (AS1Receiver Struct)

The certificate (PEM/Base64 encoded).

Syntax

fn ssl_accept_server_cert_encoded(&self ) -> Result<Vec<u8>, IPWorksEDIError> 
fn set_ssl_accept_server_cert_encoded(&self, value : Vec<u8>) ->  Option<IPWorksEDIError> 
fn set_ssl_accept_server_cert_encoded_ref(&self, value : &[u8]) ->  Option<IPWorksEDIError>

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.

Data Type

Vec

ssl_cert_effective_date property (AS1Receiver Struct)

The date on which this certificate becomes valid.

Syntax

fn ssl_cert_effective_date(&self ) -> Result<String, IPWorksEDIError>

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.

Data Type

String

ssl_cert_expiration_date property (AS1Receiver Struct)

The date on which the certificate expires.

Syntax

fn ssl_cert_expiration_date(&self ) -> Result<String, IPWorksEDIError>

Default Value

Remarks

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

ssl_cert_extended_key_usage property (AS1Receiver Struct)

A comma-delimited list of extended key usage identifiers.

Syntax

fn ssl_cert_extended_key_usage(&self ) -> Result<String, IPWorksEDIError>

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.

Data Type

String

ssl_cert_fingerprint property (AS1Receiver Struct)

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

Syntax

fn ssl_cert_fingerprint(&self ) -> Result<String, IPWorksEDIError>

Default Value

Remarks

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.

Data Type

String

ssl_cert_fingerprint_sha1 property (AS1Receiver Struct)

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

Syntax

fn ssl_cert_fingerprint_sha1(&self ) -> Result<String, IPWorksEDIError>

Default Value

Remarks

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.

Data Type

String

ssl_cert_fingerprint_sha256 property (AS1Receiver Struct)

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

Syntax

fn ssl_cert_fingerprint_sha256(&self ) -> Result<String, IPWorksEDIError>

Default Value

Remarks

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.

Data Type

String

ssl_cert_issuer property (AS1Receiver Struct)

The issuer of the certificate.

Syntax

fn ssl_cert_issuer(&self ) -> Result<String, IPWorksEDIError>

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.

Data Type

String

ssl_cert_private_key property (AS1Receiver Struct)

The private key of the certificate (if available).

Syntax

fn ssl_cert_private_key(&self ) -> Result<String, IPWorksEDIError>

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.

Data Type

String

ssl_cert_private_key_available property (AS1Receiver Struct)

Whether a PrivateKey is available for the selected certificate.

Syntax

fn ssl_cert_private_key_available(&self ) -> Result<bool, IPWorksEDIError>

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.

Data Type

bool

ssl_cert_private_key_container property (AS1Receiver Struct)

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

Syntax

fn ssl_cert_private_key_container(&self ) -> Result<String, IPWorksEDIError>

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.

Data Type

String

ssl_cert_public_key property (AS1Receiver Struct)

The public key of the certificate.

Syntax

fn ssl_cert_public_key(&self ) -> Result<String, IPWorksEDIError>

Default Value

Remarks

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

This property is read-only.

Data Type

String

ssl_cert_public_key_algorithm property (AS1Receiver Struct)

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

Syntax

fn ssl_cert_public_key_algorithm(&self ) -> Result<String, IPWorksEDIError>

Default Value

Remarks

This property is read-only.

Data Type

String

ssl_cert_public_key_length property (AS1Receiver Struct)

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

Syntax

fn ssl_cert_public_key_length(&self ) -> Result<i32, IPWorksEDIError>

Default Value

Remarks

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

This property is read-only.

Data Type

i32

ssl_cert_serial_number property (AS1Receiver Struct)

The serial number of the certificate encoded as a string.

Syntax

fn ssl_cert_serial_number(&self ) -> Result<String, IPWorksEDIError>

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.

Data Type

String

ssl_cert_signature_algorithm property (AS1Receiver Struct)

The text description of the certificate's signature algorithm.

Syntax

fn ssl_cert_signature_algorithm(&self ) -> Result<String, IPWorksEDIError>

Default Value

Remarks

This property is read-only.

Data Type

String

ssl_cert_store property (AS1Receiver Struct)

The name of the certificate store for the client certificate.

Syntax

fn ssl_cert_store(&self ) -> Result<Vec<u8>, IPWorksEDIError> 
fn set_ssl_cert_store(&self, value : Vec<u8>) ->  Option<IPWorksEDIError> 
fn set_ssl_cert_store_ref(&self, value : &[u8]) ->  Option<IPWorksEDIError>

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:


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

Data Type

Vec

ssl_cert_store_password property (AS1Receiver Struct)

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

Syntax

fn ssl_cert_store_password(&self ) -> Result<String, IPWorksEDIError> 
fn set_ssl_cert_store_password(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_ssl_cert_store_password_ref(&self, value : &String) ->  Option<IPWorksEDIError>

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.

Data Type

String

ssl_cert_store_type property (AS1Receiver Struct)

The type of certificate store for this certificate.

Syntax

fn ssl_cert_store_type(&self ) -> Result<i32, IPWorksEDIError> 
fn set_ssl_cert_store_type(&self, value : i32) ->  Option<IPWorksEDIError>

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

Remarks

The type of certificate store for this certificate.


0 (cstUser - default)	For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java.
1 (cstMachine)	For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java.
2 (cstPFXFile)	The certificate store is the name of a PFX (PKCS#12) file containing certificates.
3 (cstPFXBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format.
4 (cstJKSFile)	The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java.
5 (cstJKSBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java.
6 (cstPEMKeyFile)	The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
7 (cstPEMKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate.
8 (cstPublicKeyFile)	The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
9 (cstPublicKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate.
10 (cstSSHPublicKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key.
11 (cstP7BFile)	The certificate store is the name of a PKCS#7 file containing certificates.
12 (cstP7BBlob)	The certificate store is a string (binary) representing a certificate store in PKCS#7 format.
13 (cstSSHPublicKeyFile)	The certificate store is the name of a file that contains an SSH-style public key.
14 (cstPPKFile)	The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
15 (cstPPKBlob)	The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
16 (cstXMLFile)	The certificate store is the name of a file that contains a certificate in XML format.
17 (cstXMLBlob)	The certificate store is a string that contains a certificate in XML format.
18 (cstJWKFile)	The certificate store is the name of a file that contains a JWK (JSON Web Key).
19 (cstJWKBlob)	The certificate store is a string that contains a JWK (JSON Web Key).
21 (cstBCFKSFile)	The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET.
22 (cstBCFKSBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET.
23 (cstPKCS11)	The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new Certificate object and pass `cstPKCS11` as the ssl_cert_store_type, the full path of the PKCS#11 DLL as the ssl_cert_store, and the PIN as the ssl_cert_store_password. Code Example. SSH Authentication with Security Key (without CertMgr): `sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);` Alternatively, collect the necessary data using the CertMgr struct by calling the list_store_certificates method after setting the corresponding properties accordingly. The certificate information returned in the on_cert_list event's `CertEncoded` parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the ssl_cert_store and set ssl_cert_store_password to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): `certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);`
99 (cstAuto)	The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

Data Type

i32

ssl_cert_subject_alt_names property (AS1Receiver Struct)

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

Syntax

fn ssl_cert_subject_alt_names(&self ) -> Result<String, IPWorksEDIError>

Default Value

Remarks

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

This property is read-only.

Data Type

String

ssl_cert_thumbprint_md5 property (AS1Receiver Struct)

The MD5 hash of the certificate.

Syntax

fn ssl_cert_thumbprint_md5(&self ) -> Result<String, IPWorksEDIError>

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.

Data Type

String

ssl_cert_thumbprint_sha1 property (AS1Receiver Struct)

The SHA-1 hash of the certificate.

Syntax

fn ssl_cert_thumbprint_sha1(&self ) -> Result<String, IPWorksEDIError>

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.

Data Type

String

ssl_cert_thumbprint_sha256 property (AS1Receiver Struct)

The SHA-256 hash of the certificate.

Syntax

fn ssl_cert_thumbprint_sha256(&self ) -> Result<String, IPWorksEDIError>

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.

Data Type

String

ssl_cert_usage property (AS1Receiver Struct)

The text description of UsageFlags .

Syntax

fn ssl_cert_usage(&self ) -> Result<String, IPWorksEDIError>

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.

Data Type

String

ssl_cert_usage_flags property (AS1Receiver Struct)

The flags that show intended use for the certificate.

Syntax

fn ssl_cert_usage_flags(&self ) -> Result<i32, IPWorksEDIError>

Default Value

Remarks

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


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

Please see the 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.

Data Type

i32

ssl_cert_version property (AS1Receiver Struct)

The certificate's version number.

Syntax

fn ssl_cert_version(&self ) -> Result<String, IPWorksEDIError>

Default Value

Remarks

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

This property is read-only.

Data Type

String

ssl_cert_subject property (AS1Receiver Struct)

The subject of the certificate used for client authentication.

Syntax

fn ssl_cert_subject(&self ) -> Result<String, IPWorksEDIError> 
fn set_ssl_cert_subject(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_ssl_cert_subject_ref(&self, value : &String) ->  Option<IPWorksEDIError>

Default Value

Remarks

The subject of the certificate used for client authentication.

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.


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

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

Data Type

String

ssl_cert_encoded property (AS1Receiver Struct)

The certificate (PEM/Base64 encoded).

Syntax

fn ssl_cert_encoded(&self ) -> Result<Vec<u8>, IPWorksEDIError> 
fn set_ssl_cert_encoded(&self, value : Vec<u8>) ->  Option<IPWorksEDIError> 
fn set_ssl_cert_encoded_ref(&self, value : &[u8]) ->  Option<IPWorksEDIError>

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.

Data Type

Vec

ssl_provider property (AS1Receiver Struct)

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

Syntax

fn ssl_provider(&self ) -> Result<i32, IPWorksEDIError> 
fn set_ssl_provider(&self, value : i32) ->  Option<IPWorksEDIError>

Possible Values

0   // Automatic
1   // Platform
2   // Internal

Default Value

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


0 (sslpAutomatic - default)	Automatically selects the appropriate implementation.
1 (sslpPlatform)	Uses the platform/system implementation.
2 (sslpInternal)	Uses the internal implementation.

Additional Notes

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

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

Data Type

i32

ssl_server_cert_effective_date property (AS1Receiver Struct)

The date on which this certificate becomes valid.

Syntax

fn ssl_server_cert_effective_date(&self ) -> Result<String, IPWorksEDIError>

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.

Data Type

String

ssl_server_cert_expiration_date property (AS1Receiver Struct)

The date on which the certificate expires.

Syntax

fn ssl_server_cert_expiration_date(&self ) -> Result<String, IPWorksEDIError>

Default Value

Remarks

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

ssl_server_cert_extended_key_usage property (AS1Receiver Struct)

A comma-delimited list of extended key usage identifiers.

Syntax

fn ssl_server_cert_extended_key_usage(&self ) -> Result<String, IPWorksEDIError>

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.

Data Type

String

ssl_server_cert_fingerprint property (AS1Receiver Struct)

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

Syntax

fn ssl_server_cert_fingerprint(&self ) -> Result<String, IPWorksEDIError>

Default Value

Remarks

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.

Data Type

String

ssl_server_cert_fingerprint_sha1 property (AS1Receiver Struct)

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

Syntax

fn ssl_server_cert_fingerprint_sha1(&self ) -> Result<String, IPWorksEDIError>

Default Value

Remarks

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.

Data Type

String

ssl_server_cert_fingerprint_sha256 property (AS1Receiver Struct)

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

Syntax

fn ssl_server_cert_fingerprint_sha256(&self ) -> Result<String, IPWorksEDIError>

Default Value

Remarks

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.

Data Type

String

ssl_server_cert_issuer property (AS1Receiver Struct)

The issuer of the certificate.

Syntax

fn ssl_server_cert_issuer(&self ) -> Result<String, IPWorksEDIError>

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.

Data Type

String

ssl_server_cert_private_key property (AS1Receiver Struct)

The private key of the certificate (if available).

Syntax

fn ssl_server_cert_private_key(&self ) -> Result<String, IPWorksEDIError>

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.

Data Type

String

ssl_server_cert_private_key_available property (AS1Receiver Struct)

Whether a PrivateKey is available for the selected certificate.

Syntax

fn ssl_server_cert_private_key_available(&self ) -> Result<bool, IPWorksEDIError>

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.

Data Type

bool

ssl_server_cert_private_key_container property (AS1Receiver Struct)

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

Syntax

fn ssl_server_cert_private_key_container(&self ) -> Result<String, IPWorksEDIError>

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.

Data Type

String

ssl_server_cert_public_key property (AS1Receiver Struct)

The public key of the certificate.

Syntax

fn ssl_server_cert_public_key(&self ) -> Result<String, IPWorksEDIError>

Default Value

Remarks

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

This property is read-only.

Data Type

String

ssl_server_cert_public_key_algorithm property (AS1Receiver Struct)

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

Syntax

fn ssl_server_cert_public_key_algorithm(&self ) -> Result<String, IPWorksEDIError>

Default Value

Remarks

This property is read-only.

Data Type

String

ssl_server_cert_public_key_length property (AS1Receiver Struct)

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

Syntax

fn ssl_server_cert_public_key_length(&self ) -> Result<i32, IPWorksEDIError>

Default Value

Remarks

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

This property is read-only.

Data Type

i32

ssl_server_cert_serial_number property (AS1Receiver Struct)

The serial number of the certificate encoded as a string.

Syntax

fn ssl_server_cert_serial_number(&self ) -> Result<String, IPWorksEDIError>

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.

Data Type

String

ssl_server_cert_signature_algorithm property (AS1Receiver Struct)

The text description of the certificate's signature algorithm.

Syntax

fn ssl_server_cert_signature_algorithm(&self ) -> Result<String, IPWorksEDIError>

Default Value

Remarks

This property is read-only.

Data Type

String

ssl_server_cert_store property (AS1Receiver Struct)

The name of the certificate store for the client certificate.

Syntax

fn ssl_server_cert_store(&self ) -> Result<Vec<u8>, IPWorksEDIError>

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:


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

This property is read-only.

Data Type

Vec

ssl_server_cert_store_password property (AS1Receiver Struct)

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

Syntax

fn ssl_server_cert_store_password(&self ) -> Result<String, IPWorksEDIError>

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.

Data Type

String

ssl_server_cert_store_type property (AS1Receiver Struct)

The type of certificate store for this certificate.

Syntax

fn ssl_server_cert_store_type(&self ) -> Result<i32, IPWorksEDIError>

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

Remarks

The type of certificate store for this certificate.


0 (cstUser - default)	For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java.
1 (cstMachine)	For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java.
2 (cstPFXFile)	The certificate store is the name of a PFX (PKCS#12) file containing certificates.
3 (cstPFXBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format.
4 (cstJKSFile)	The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java.
5 (cstJKSBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java.
6 (cstPEMKeyFile)	The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
7 (cstPEMKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate.
8 (cstPublicKeyFile)	The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
9 (cstPublicKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate.
10 (cstSSHPublicKeyBlob)	The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key.
11 (cstP7BFile)	The certificate store is the name of a PKCS#7 file containing certificates.
12 (cstP7BBlob)	The certificate store is a string (binary) representing a certificate store in PKCS#7 format.
13 (cstSSHPublicKeyFile)	The certificate store is the name of a file that contains an SSH-style public key.
14 (cstPPKFile)	The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
15 (cstPPKBlob)	The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
16 (cstXMLFile)	The certificate store is the name of a file that contains a certificate in XML format.
17 (cstXMLBlob)	The certificate store is a string that contains a certificate in XML format.
18 (cstJWKFile)	The certificate store is the name of a file that contains a JWK (JSON Web Key).
19 (cstJWKBlob)	The certificate store is a string that contains a JWK (JSON Web Key).
21 (cstBCFKSFile)	The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET.
22 (cstBCFKSBlob)	The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET.
23 (cstPKCS11)	The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new Certificate object and pass `cstPKCS11` as the ssl_server_cert_store_type, the full path of the PKCS#11 DLL as the ssl_server_cert_store, and the PIN as the ssl_server_cert_store_password. Code Example. SSH Authentication with Security Key (without CertMgr): `sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);` Alternatively, collect the necessary data using the CertMgr struct by calling the list_store_certificates method after setting the corresponding properties accordingly. The certificate information returned in the on_cert_list event's `CertEncoded` parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the ssl_server_cert_store and set ssl_server_cert_store_password to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): `certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);`
99 (cstAuto)	The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

This property is read-only.

Data Type

i32

ssl_server_cert_subject_alt_names property (AS1Receiver Struct)

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

Syntax

fn ssl_server_cert_subject_alt_names(&self ) -> Result<String, IPWorksEDIError>

Default Value

Remarks

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

This property is read-only.

Data Type

String

ssl_server_cert_thumbprint_md5 property (AS1Receiver Struct)

The MD5 hash of the certificate.

Syntax

fn ssl_server_cert_thumbprint_md5(&self ) -> Result<String, IPWorksEDIError>

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.

Data Type

String

ssl_server_cert_thumbprint_sha1 property (AS1Receiver Struct)

The SHA-1 hash of the certificate.

Syntax

fn ssl_server_cert_thumbprint_sha1(&self ) -> Result<String, IPWorksEDIError>

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.

Data Type

String

ssl_server_cert_thumbprint_sha256 property (AS1Receiver Struct)

The SHA-256 hash of the certificate.

Syntax

fn ssl_server_cert_thumbprint_sha256(&self ) -> Result<String, IPWorksEDIError>

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.

Data Type

String

ssl_server_cert_usage property (AS1Receiver Struct)

The text description of UsageFlags .

Syntax

fn ssl_server_cert_usage(&self ) -> Result<String, IPWorksEDIError>

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.

Data Type

String

ssl_server_cert_usage_flags property (AS1Receiver Struct)

The flags that show intended use for the certificate.

Syntax

fn ssl_server_cert_usage_flags(&self ) -> Result<i32, IPWorksEDIError>

Default Value

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:


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

Please see the 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.

Data Type

i32

ssl_server_cert_version property (AS1Receiver Struct)

The certificate's version number.

Syntax

fn ssl_server_cert_version(&self ) -> Result<String, IPWorksEDIError>

Default Value

Remarks

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

This property is read-only.

Data Type

String

ssl_server_cert_subject property (AS1Receiver Struct)

The subject of the certificate used for client authentication.

Syntax

fn ssl_server_cert_subject(&self ) -> Result<String, IPWorksEDIError>

Default Value

Remarks

The subject of the certificate used for client authentication.

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.


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

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

This property is read-only.

Data Type

String

ssl_server_cert_encoded property (AS1Receiver Struct)

The certificate (PEM/Base64 encoded).

Syntax

fn ssl_server_cert_encoded(&self ) -> Result<Vec<u8>, IPWorksEDIError>

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.

Data Type

Vec

ssl_start_mode property (AS1Receiver Struct)

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

Syntax

fn ssl_start_mode(&self ) -> Result<i32, IPWorksEDIError> 
fn set_ssl_start_mode(&self, value : i32) ->  Option<IPWorksEDIError>

Possible Values

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

Default Value

Remarks

The ssl_start_mode property may have one of the following values:


0 (sslAutomatic - default)	If the remote port is set to the standard plaintext port of the protocol (where applicable), the struct will behave the same as if ssl_start_mode is set to sslExplicit. In all other cases, SSL negotiation will be implicit (sslImplicit).
1 (sslImplicit)	The SSL negotiation will start immediately after the connection is established.
2 (sslExplicit)	The struct will first connect in plaintext, and then explicitly start SSL negotiation through a protocol command such as STARTTLS.
3 (sslNone)	No SSL negotiation, no SSL security. All communication will be in plaintext mode.

Data Type

i32

user property (AS1Receiver Struct)

The username for your incoming mail server.

Syntax

fn user(&self ) -> Result<String, IPWorksEDIError> 
fn set_user(&self, value : &str) ->  Option<IPWorksEDIError> 
fn set_user_ref(&self, value : &String) ->  Option<IPWorksEDIError>

Default Value

Remarks

The username for your incoming mail server. Set this before invoking connect.

Data Type

String

config method (AS1Receiver Struct)

Sets or retrieves a configuration setting.

Syntax

fn config(&self, configuration_string : &str) ->  Result<String, IPWorksEDIError>

Remarks

config is a generic method available in every struct. It is used to set and retrieve configuration settings for the struct.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, 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.

connect method (AS1Receiver Struct)

Connects to the incoming mail server.

Syntax

fn connect(&self) -> Result<(), IPWorksEDIError>

Remarks

Connects to the incoming mail server specified by mail_server. You must set user and password prior to calling connect. The connection will be maintained until you call disconnect.

If you wish to connect in SSL you should first set the ssl_start_mode property. Note that it is not necessary to explicitly connect to an SMTP server for outgoing mail; a connection will be created and destroyed each time a mail is sent.

create_mdn_receipt method (AS1Receiver Struct)

Creates MDNReceipt .

Syntax

fn create_mdn_receipt(&self, headers : &str, mdn : &str, message : &str) -> Result<(), IPWorksEDIError>

Remarks

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

This method populates mdn_receipt with a new MDNReceipt. The Headers, MDN, and Message parameters can be used to further customize the receipt, or empty string ("") parameters may be set to use the struct generated defaults. Headers will set additional transport headers to be sent with the receipt (in the HTTP or SMTP headers of the signed receipt). MDN can be used to append additional headers to the Message Disposition Notification portion of the MDN Receipt. If MDN is set to a value prefixed with an at sign ("@"), the at sign will be removed and the specified MDN will be used in the receipt in place of the component generated value. Message will set the human-readable portion of the receipt, and should describe any error conditions that may have occurred.

delete_message method (AS1Receiver Struct)

Deletes the message specified by MailMessageNumber .

Syntax

fn delete_message(&self) -> Result<(), IPWorksEDIError>

Remarks

Requests that the mail_server delete the message specified by mail_message_number. The message will not actually be deleted until the connection is closed.

disconnect method (AS1Receiver Struct)

Disconnects from the incoming mail server.

Syntax

fn disconnect(&self) -> Result<(), IPWorksEDIError>

Remarks

Disconnects from the incoming mail server specified by mail_server.

parse_request method (AS1Receiver Struct)

Parses the EDI message and determines the EDIData .

Syntax

fn parse_request(&self) -> Result<(), IPWorksEDIError>

Remarks

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

If the message is scanned without difficulty, edi_data will be populated. If a problem occurs, an exception will be thrown. This might occur if the client used or requested unsupported algorithms or data formats. In this case, edi_data will not be determined.

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

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

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

process_queue method (AS1Receiver Struct)

Send the messages queued for sending.

Syntax

fn process_queue(&self, directory : &str) -> Result<(), IPWorksEDIError>

Remarks

Invoking process_queue sends the messages that have been queued by queue.

process_request method (AS1Receiver Struct)

Processes the EDI data, and generates the receipt.

Syntax

fn process_request(&self) -> Result<(), IPWorksEDIError>

Remarks

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

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

The method will throw an exception, as parse_request does, if a problem is found while processing the request. However, if the problem does not prevent an MDN from being generated, mdn_receipt will still be generated before the exception is thrown. In all cases, the receipt will be suitable for returning to the client. If an exception is thrown, the mdn_receipt will provide more detail on the cause of the error.

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

query_message_size method (AS1Receiver Struct)

Returns the size in bytes of the current message.

Syntax

fn query_message_size(&self) ->  Result<i32, IPWorksEDIError>

Remarks

This method queries the server for the size in bytes of the message specified by mail_message_number. The method returns the size (in bytes) of the message.

query_message_uid method (AS1Receiver Struct)

Returns the unique identifier of the message as specified by the server.

Syntax

fn query_message_uid(&self) ->  Result<String, IPWorksEDIError>

Remarks

This method returns the unique identifier of the message specified by mail_message_number.

queue method (AS1Receiver Struct)

Prepares and queues the message to the specified directory.

Syntax

fn queue(&self, directory : &str) -> Result<(), IPWorksEDIError>

Remarks

Invoking queue will prepare and queue the AS1 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. The queued message can then be sent by invoking process_queue.

read_request method (AS1Receiver Struct)

Reads the AS1 request from the mail server.

Syntax

fn read_request(&self) -> Result<(), IPWorksEDIError>

Remarks

In the Java edition, read_request will retrieve the file specified by mail_message_number from the mail server. The request will be stored in request and the headers in request_headers. The headers will also be parsed as in parse_headers, and the appropriate values of from, send_to, etc., will be populated. After looking up and setting your trading partner information (such as certificates) you may then call process_request.

reset method (AS1Receiver Struct)

Resets the state of the control.

Syntax

fn reset(&self) -> Result<(), IPWorksEDIError>

Remarks

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

select_mail_message method (AS1Receiver Struct)

Selects and obtains information about the specified message.

Syntax

fn select_mail_message(&self) -> Result<(), IPWorksEDIError>

Remarks

This method selects the message specified by mail_message_number and retrieves information about it.

After calling this method properties such as mail_message_headers, mail_message_date, mail_message_from, etc., allow you to determine if this message is an AS1 message. Additional properties are exposed via the config method.

If this message is an AS1 transmission, you may use read_request to read it. The request and request_headers properties will contain the request and request headers, and from will be populated with the originator of the request. You may then set trading partner information and invoke process_request to process the request.

send_response method (AS1Receiver Struct)

Sends the MDN receipt.

Syntax

fn send_response(&self) -> Result<(), IPWorksEDIError>

Remarks

Sends the MDN receipt specified by mdn_receipt. The receipt will be created when invoking process_request or create_mdn_receipt.

By default, the struct will assume that the SMTP server is located at the same address as the incoming mail server. The SMTPServer and SMTPPort settings can be used to set a different address or to use a non default port.

A response will only be sent if requested by the client. The MDN will be directed to the from address that sent the request, regardless of the mdn_to value. If mdn_to is empty, this method will do nothing.

on_connection_status event (AS1Receiver Struct)

Fired to indicate changes in the connection state.

Syntax

// AS1ReceiverConnectionStatusEventArgs carries the AS1Receiver ConnectionStatus event's parameters.
pub struct AS1ReceiverConnectionStatusEventArgs {
  fn connection_event(&self) -> &String
  fn status_code(&self) -> i32
  fn description(&self) -> &String
}

// AS1ReceiverConnectionStatusEvent defines the signature of the AS1Receiver ConnectionStatus event's handler function.
pub trait AS1ReceiverConnectionStatusEvent {
  fn on_connection_status(&self, sender : AS1Receiver, e : &mut AS1ReceiverConnectionStatusEventArgs);
}

impl <'a> AS1Receiver<'a> {
  pub fn on_connection_status(&self) -> &'a dyn AS1ReceiverConnectionStatusEvent;
  pub fn set_on_connection_status(&mut self, value : &'a dyn AS1ReceiverConnectionStatusEvent);
  ...
}

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:


	Firewall connection complete.
	Secure Sockets Layer (SSL) or S/Shell handshake complete (where applicable).
	Remote host connection complete.
	Remote host disconnected.
	SSL or S/Shell connection broken.
	Firewall host disconnected.

status_code has the error code returned by the Transmission Control Protocol (TCP)/IP stack. description contains a description of this code. The value of status_code is equal to the value of the error.

on_end_transfer event (AS1Receiver Struct)

Fired when the message text completes transferring.

Syntax

// AS1ReceiverEndTransferEventArgs carries the AS1Receiver EndTransfer event's parameters.
pub struct AS1ReceiverEndTransferEventArgs {
}

// AS1ReceiverEndTransferEvent defines the signature of the AS1Receiver EndTransfer event's handler function.
pub trait AS1ReceiverEndTransferEvent {
  fn on_end_transfer(&self, sender : AS1Receiver, e : &mut AS1ReceiverEndTransferEventArgs);
}

impl <'a> AS1Receiver<'a> {
  pub fn on_end_transfer(&self) -> &'a dyn AS1ReceiverEndTransferEvent;
  pub fn set_on_end_transfer(&mut self, value : &'a dyn AS1ReceiverEndTransferEvent);
  ...
}

Remarks

Fired when the message text completes transferring (on either a send or receive).

on_error event (AS1Receiver Struct)

Fired when information is available about errors during data delivery.

Syntax

// AS1ReceiverErrorEventArgs carries the AS1Receiver Error event's parameters.
pub struct AS1ReceiverErrorEventArgs {
  fn error_code(&self) -> i32
  fn description(&self) -> &String
}

// AS1ReceiverErrorEvent defines the signature of the AS1Receiver Error event's handler function.
pub trait AS1ReceiverErrorEvent {
  fn on_error(&self, sender : AS1Receiver, e : &mut AS1ReceiverErrorEventArgs);
}

impl <'a> AS1Receiver<'a> {
  pub fn on_error(&self) -> &'a dyn AS1ReceiverErrorEvent;
  pub fn set_on_error(&mut self, value : &'a dyn AS1ReceiverErrorEvent);
  ...
}

Remarks

The on_error event is fired in case of exceptional conditions during message processing. Normally the struct 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_header event (AS1Receiver Struct)

This event is fired for every message header being retrieved.

Syntax

// AS1ReceiverHeaderEventArgs carries the AS1Receiver Header event's parameters.
pub struct AS1ReceiverHeaderEventArgs {
  fn field(&self) -> &String
  fn value(&self) -> &String
}

// AS1ReceiverHeaderEvent defines the signature of the AS1Receiver Header event's handler function.
pub trait AS1ReceiverHeaderEvent {
  fn on_header(&self, sender : AS1Receiver, e : &mut AS1ReceiverHeaderEventArgs);
}

impl <'a> AS1Receiver<'a> {
  pub fn on_header(&self) -> &'a dyn AS1ReceiverHeaderEvent;
  pub fn set_on_header(&mut self, value : &'a dyn AS1ReceiverHeaderEvent);
  ...
}

Remarks

The field parameter contains the name of the header (in the same case as it is delivered). The value parameter contains the header contents.

If the header line being retrieved is a continuation header line, then the field parameter contains "" (empty string).

on_launch_browser event (AS1Receiver Struct)

Fires before launching a browser with the authorization URL.

Syntax

// AS1ReceiverLaunchBrowserEventArgs carries the AS1Receiver LaunchBrowser event's parameters.
pub struct AS1ReceiverLaunchBrowserEventArgs {
  fn url(&self) -> &String
  fn set_url(&self, value : &str)
  fn set_url_ref(&self, value : &String)
  fn command(&self) -> &String
  fn set_command(&self, value : &str)
  fn set_command_ref(&self, value : &String)
}

// AS1ReceiverLaunchBrowserEvent defines the signature of the AS1Receiver LaunchBrowser event's handler function.
pub trait AS1ReceiverLaunchBrowserEvent {
  fn on_launch_browser(&self, sender : AS1Receiver, e : &mut AS1ReceiverLaunchBrowserEventArgs);
}

impl <'a> AS1Receiver<'a> {
  pub fn on_launch_browser(&self) -> &'a dyn AS1ReceiverLaunchBrowserEvent;
  pub fn set_on_launch_browser(&mut self, value : &'a dyn AS1ReceiverLaunchBrowserEvent);
  ...
}

Remarks

When the client_profile property is set to ocpApplication and get_authorization is called, the struct will fire this event with the command, which will be executed by the struct. The url parameter will be the authorization URL that the user will be directed to authenticate.

Within this event, you may override the current value of either command or url and provide your own value. If command is set to an empty string, the struct will not attempt to launch the browser and instead you will be responsible for directing the user to the authorization URL specified by the URL parameter. If command is not empty, the URL will be appended to the end.

In Windows, ShellExecute is used to execute command, which limits the verbs available for use in command to:

edit
explore
find
open
print

on_log event (AS1Receiver Struct)

Fired with log information while processing a message.

Syntax

// AS1ReceiverLogEventArgs carries the AS1Receiver Log event's parameters.
pub struct AS1ReceiverLogEventArgs {
  fn log_type(&self) -> &String
  fn log_message(&self) -> &[u8]
}

// AS1ReceiverLogEvent defines the signature of the AS1Receiver Log event's handler function.
pub trait AS1ReceiverLogEvent {
  fn on_log(&self, sender : AS1Receiver, e : &mut AS1ReceiverLogEventArgs);
}

impl <'a> AS1Receiver<'a> {
  pub fn on_log(&self) -> &'a dyn AS1ReceiverLogEvent;
  pub fn set_on_log(&mut self, value : &'a dyn AS1ReceiverLogEvent);
  ...
}

Remarks

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

log_level indicates the level of message. Possible values are as follows:


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

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

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

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

message is the log entry.

log_type identifies the type of log entry. Possible values are as follows:

"Info"
"RequestHeaders"
"ResponseHeaders"
"RequestBody"
"ResponseBody"
"ProxyRequest"
"ProxyResponse"
"FirewallRequest"
"FirewallResponse"

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

Log messages available through this event correspond to log files written to log_directory. This event provides a way to obtain log messages without relying on files on disk. This event fires regardless of the value of log_directory (i.e. when log_directory is empty the event will still fire).

The LogMessage event parameter holds the raw log data.

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


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

on_pi_trail event (AS1Receiver Struct)

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

Syntax

// AS1ReceiverPITrailEventArgs carries the AS1Receiver PITrail event's parameters.
pub struct AS1ReceiverPITrailEventArgs {
  fn direction(&self) -> i32
  fn message(&self) -> &String
}

// AS1ReceiverPITrailEvent defines the signature of the AS1Receiver PITrail event's handler function.
pub trait AS1ReceiverPITrailEvent {
  fn on_pi_trail(&self, sender : AS1Receiver, e : &mut AS1ReceiverPITrailEventArgs);
}

impl <'a> AS1Receiver<'a> {
  pub fn on_pi_trail(&self) -> &'a dyn AS1ReceiverPITrailEvent;
  pub fn set_on_pi_trail(&mut self, value : &'a dyn AS1ReceiverPITrailEvent);
  ...
}

Remarks

The on_pi_trail event is useful for debugging purposes. It shows all of the interaction between the client and the server, line by line, except for message header and body transfers.

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


0 (Client)	The `message` originates from the client.
1 (Server)	The `message` originates from the server.
2 (Info)	The `message` is an informative message originating from the client software (the struct code).

on_signer_cert_info event (AS1Receiver Struct)

This event is fired during verification of the signed message.

Syntax

// AS1ReceiverSignerCertInfoEventArgs carries the AS1Receiver SignerCertInfo event's parameters.
pub struct AS1ReceiverSignerCertInfoEventArgs {
  fn issuer(&self) -> &String
  fn serial_number(&self) -> &String
  fn subject_key_identifier(&self) -> &String
  fn cert_encoded(&self) -> &[u8]
}

// AS1ReceiverSignerCertInfoEvent defines the signature of the AS1Receiver SignerCertInfo event's handler function.
pub trait AS1ReceiverSignerCertInfoEvent {
  fn on_signer_cert_info(&self, sender : AS1Receiver, e : &mut AS1ReceiverSignerCertInfoEventArgs);
}

impl <'a> AS1Receiver<'a> {
  pub fn on_signer_cert_info(&self) -> &'a dyn AS1ReceiverSignerCertInfoEvent;
  pub fn set_on_signer_cert_info(&mut self, value : &'a dyn AS1ReceiverSignerCertInfoEvent);
  ...
}

Remarks

During verification, this event will be raised while parsing the signer's certificate information. The parameters that are populated depend on the options used when the message was originally signed. This information may be used to select the correct certificate for signer_cert to verify the signature. The following parameters may be populated:

Issuer specifies the subject of the issuer of the certificate used to sign the message.

SerialNumber is the serial number of the certificate used to sign the message.

SubjectKeyIdentifier is the X.509 subjectKeyIdentifier extension value of the certificate used to sign the message encoded as a hex string.

CertEncoded is the PEM (Base64 encoded) public certificate needed to verify the signature.

NOTE: When this value is present, the struct will automatically use this value to perform signature verification.

The signer_cert property may be set from within this event. In this manner, the decision of which signer certificate to load may be delayed until the parameters of this event are inspected and the correct certificate can be located and loaded.

on_ssl_server_authentication event (AS1Receiver Struct)

Fired after the server presents its certificate to the client.

Syntax

// AS1ReceiverSSLServerAuthenticationEventArgs carries the AS1Receiver SSLServerAuthentication event's parameters.
pub struct AS1ReceiverSSLServerAuthenticationEventArgs {
  fn cert_encoded(&self) -> &[u8]
  fn cert_subject(&self) -> &String
  fn cert_issuer(&self) -> &String
  fn status(&self) -> &String
  fn accept(&self) -> bool
  fn set_accept(&self, value : bool)
}

// AS1ReceiverSSLServerAuthenticationEvent defines the signature of the AS1Receiver SSLServerAuthentication event's handler function.
pub trait AS1ReceiverSSLServerAuthenticationEvent {
  fn on_ssl_server_authentication(&self, sender : AS1Receiver, e : &mut AS1ReceiverSSLServerAuthenticationEventArgs);
}

impl <'a> AS1Receiver<'a> {
  pub fn on_ssl_server_authentication(&self) -> &'a dyn AS1ReceiverSSLServerAuthenticationEvent;
  pub fn set_on_ssl_server_authentication(&mut self, value : &'a dyn AS1ReceiverSSLServerAuthenticationEvent);
  ...
}

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 (AS1Receiver Struct)

Fired when secure connection progress messages are available.

Syntax

// AS1ReceiverSSLStatusEventArgs carries the AS1Receiver SSLStatus event's parameters.
pub struct AS1ReceiverSSLStatusEventArgs {
  fn message(&self) -> &String
}

// AS1ReceiverSSLStatusEvent defines the signature of the AS1Receiver SSLStatus event's handler function.
pub trait AS1ReceiverSSLStatusEvent {
  fn on_ssl_status(&self, sender : AS1Receiver, e : &mut AS1ReceiverSSLStatusEventArgs);
}

impl <'a> AS1Receiver<'a> {
  pub fn on_ssl_status(&self) -> &'a dyn AS1ReceiverSSLStatusEvent;
  pub fn set_on_ssl_status(&mut self, value : &'a dyn AS1ReceiverSSLStatusEvent);
  ...
}

Remarks

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

on_start_transfer event (AS1Receiver Struct)

Fired when the message text starts transferring (on either a send or receive).

Syntax

// AS1ReceiverStartTransferEventArgs carries the AS1Receiver StartTransfer event's parameters.
pub struct AS1ReceiverStartTransferEventArgs {
}

// AS1ReceiverStartTransferEvent defines the signature of the AS1Receiver StartTransfer event's handler function.
pub trait AS1ReceiverStartTransferEvent {
  fn on_start_transfer(&self, sender : AS1Receiver, e : &mut AS1ReceiverStartTransferEventArgs);
}

impl <'a> AS1Receiver<'a> {
  pub fn on_start_transfer(&self) -> &'a dyn AS1ReceiverStartTransferEvent;
  pub fn set_on_start_transfer(&mut self, value : &'a dyn AS1ReceiverStartTransferEvent);
  ...
}

Remarks

Fired when the message text starts transferring (on either a send or receive).

on_transfer event (AS1Receiver Struct)

Fired while the message text gets transferred to or from MailServer .

Syntax

// AS1ReceiverTransferEventArgs carries the AS1Receiver Transfer event's parameters.
pub struct AS1ReceiverTransferEventArgs {
  fn bytes_transferred(&self) -> i64
}

// AS1ReceiverTransferEvent defines the signature of the AS1Receiver Transfer event's handler function.
pub trait AS1ReceiverTransferEvent {
  fn on_transfer(&self, sender : AS1Receiver, e : &mut AS1ReceiverTransferEventArgs);
}

impl <'a> AS1Receiver<'a> {
  pub fn on_transfer(&self) -> &'a dyn AS1ReceiverTransferEvent;
  pub fn set_on_transfer(&mut self, value : &'a dyn AS1ReceiverTransferEvent);
  ...
}

Remarks

Fired while the message text gets transferred to or from mail_server.

Config Settings (AS1Receiver Struct)

The struct accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, access to these internal properties is provided through the config method.

AS1Receiver Config Settings

FileName: The filename of the EDI Data.

This is a read only setting that gives the filename of the content received.

AS1 Config Settings

LogFilename: The base name of the log file.

If set, this will be used as for the filename of the log file.

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

POPPort: The POP mail port to be used, if different than MailServer.

The mail port to be used for POP (or POP/S). For implicit SSL, use port 995.

POPServer: The POP server to be used, if different than MailServer.

The mail server to be used for POP (or POP/S), in case different than MailServer.

SMTPAuthMechanism: The authentication mechanism used to connect to the SMTP server.

By default, SMTPAuthMechanism is set to 0, which sends the AUTH command is SMTPUser and SMTPPassword are set. SMTPAuthMechanism can be set to 1 to use the more secure CRAM-MD5 authentication command.

SMTPPassword: The password used for authentication.

If SMTPPassword is set to a non empty string, then when connecting to the SMTPServer an AUTH or CRAM-MD5 (depending on SMTPAuthMechanism) command is sent for user authentication.

SMTPPort: The SMTP mail port to be used, if different than MailServer.

The mail port to be used for SMTP (or POP/S). For implicit SSL, use port 465.

SMTPServer: The SMTP server to be used, if different than MailServer.

The mail server to be used for SMTP (or SMTP/S), in case different than MailServer.

SMTPSSLStartMode: Determines how SSL negotiation starts with the SMTP server.

0 ssl Automatic 1 ssl Implicit 2 ssl Explicit 3 ssl None Default These modes have the same interpretation as defined by the property SSLStartMode.

SMTPUser: The user name used for authentication.

If SMTPUser is set to a non empty string, then when connecting to the SMTPServer an AUTH or CRAM-MD5 (depending on SMTPAuthMechanism) command is sent for user authentication.

SSL Config Settings

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

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

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

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

OpenSSLCADir: The path to a directory containing CA certificates.

This functionality is available only when the provider is OpenSSL.

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

OpenSSLCAFile: Name of the file containing the list of CA's trusted by your application.

This functionality is available only when the provider is OpenSSL.

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

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

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

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

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

OpenSSLCipherList: A string that controls the ciphers to be used by SSL.

This functionality is available only when the provider is OpenSSL.

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

OpenSSLPrngSeedData: The data to seed the pseudo random number generator (PRNG).

This functionality is available only when the provider is OpenSSL.

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

ReuseSSLSession: Determines if the SSL session is reused.

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

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

SSLCACerts: A newline separated list of CA certificates to be included when performing an SSL handshake.

When ssl_provider is set to Internal, this configuration setting specifies one or more CA certificates to be included with the ssl_cert property. Some servers or clients require the entire chain, including CA certificates, to be presented when performing SSL authentication. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance:

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

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

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

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

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

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

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

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

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

SSLCipherStrength: The minimum cipher strength used for bulk encryption.

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

NOTE: This configuration setting contains the minimum cipher strength requested from the security library. The actual cipher strength used for the connection is shown by the on_ssl_status event.

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

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

SSLClientCACerts: A newline separated list of CA certificates to use during SSL client certificate validation.

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

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

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

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

This configuration setting enables the cipher suites to be used in SSL negotiation.

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

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

Multiple cipher suites are separated by semicolons.

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

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

Example values when ssl_provider is set to Internalinclude the following:

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

Possible values when ssl_provider is set to Internal include the following:

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

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

TLS_AES_256_GCM_SHA384
TLS_CHACHA20_POLY1305_SHA256
TLS_AES_128_GCM_SHA256

SSLEnabledCipherSuites is used together with SSLCipherStrength.

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

This configuration setting is used to enable or disable the supported security protocols.

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


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

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

SSLEnabledProtocols: Transport Layer Security (TLS) 1.3 Notes:

By default when TLS 1.3 is enabled, the struct will first try to use the platform TLS 1.3 implementation when the ssl_provider is set to Automatic for all editions. If the platform TLS 1.3 implementation is not available, the internal implementation will be used.

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

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

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

SSLEnabledProtocols: SSL2 and SSL3 Notes:

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

SSLEnableRenegotiation: Whether the renegotiation_info SSL extension is supported.

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

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

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

This configuration setting specifies whether the Encoded parameter of the on_ssl_server_authentication event contains the full certificate chain. By default this value is False and only the leaf certificate will be present in the Encoded parameter of the on_ssl_server_authentication event.

If set to True, all certificates returned by the server will be present in the Encoded parameter of the on_ssl_server_authentication event. This includes the leaf certificate, any intermediate certificate, and the root certificate.

SSLKeyLogFile: The location of a file where per-session secrets are written for debugging purposes.

This configuration setting optionally specifies the full path to a file on disk where per-session secrets are stored for debugging purposes.

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

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

SSLNegotiatedCipher: Returns the negotiated cipher suite.

This configuration setting returns the cipher suite negotiated during the SSL handshake.

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

SSLNegotiatedCipherStrength: Returns the negotiated cipher suite strength.

This configuration setting returns the strength of the cipher suite negotiated during the SSL handshake.

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

SSLNegotiatedCipherSuite: Returns the negotiated cipher suite.

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

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

SSLNegotiatedKeyExchange: Returns the negotiated key exchange algorithm.

This configuration setting returns the key exchange algorithm negotiated during the SSL handshake.

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

SSLNegotiatedKeyExchangeStrength: Returns the negotiated key exchange algorithm strength.

This configuration setting returns the strength of the key exchange algorithm negotiated during the SSL handshake.

SSLNegotiatedVersion: Returns the negotiated protocol version.

This configuration setting returns the protocol version negotiated during the SSL handshake.

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

SSLSecurityFlags: Flags that control certificate verification.

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


0x00000001	Ignore time validity status of certificate.
0x00000002	Ignore time validity status of CTL.
0x00000004	Ignore non-nested certificate times.
0x00000010	Allow unknown certificate authority.
0x00000020	Ignore wrong certificate usage.
0x00000100	Ignore unknown certificate revocation status.
0x00000200	Ignore unknown CTL signer revocation status.
0x00000400	Ignore unknown certificate authority revocation status.
0x00000800	Ignore unknown root revocation status.
0x00008000	Allow test root certificate.
0x00004000	Trust test root certificate.
0x80000000	Ignore non-matching CN (certificate CN non-matching server name).

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

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

This configuration setting is only used by client components (e.g., TCPClient) see SSLClientCACerts for server components (e.g., TCPServer). This configuration setting can be used to optionally specify one or more CA certificates to be used when connecting to the server and verifying the server certificate. When verifying the server's certificate, the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store.

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

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

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

This configuration setting specifies the allowed server certificate signature algorithms when ssl_provider is set to Internal and SSLEnabledProtocols is set to allow TLS 1.2.

When specified the struct will verify that the server certificate signature algorithm is among the values specified in this configuration setting. If the server certificate signature algorithm is unsupported, the struct fails with an error.

The format of this value is a comma-separated list of hash-signature combinations. For instance: component.SSLProvider = TCPClientSSLProviders.sslpInternal; component.Config("SSLEnabledProtocols=3072"); //TLS 1.2 component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa"); The default value for this configuration setting is sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa.

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

TLS12SupportedGroups: The supported groups for ECC.

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

The default value is ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1.

When using TLS 1.2 and ssl_provider is set to Internal, the values refer to the supported groups for ECC. The following values are supported:

"ecdhe_secp256r1" (default)
"ecdhe_secp384r1" (default)
"ecdhe_secp521r1" (default)

TLS13KeyShareGroups: The groups for which to pregenerate key shares.

This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional roundtrip during the handshake if the group is supported by the server.

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

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

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

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

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

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

TLS13SignatureAlgorithms: The allowed certificate signature algorithms.

This configuration setting holds a comma-separated list of allowed signature algorithms. Possible values include the following:

"ed25519" (default)
"ed448" (default)
"ecdsa_secp256r1_sha256" (default)
"ecdsa_secp384r1_sha384" (default)
"ecdsa_secp521r1_sha512" (default)
"rsa_pkcs1_sha256" (default)
"rsa_pkcs1_sha384" (default)
"rsa_pkcs1_sha512" (default)
"rsa_pss_sha256" (default)
"rsa_pss_sha384" (default)
"rsa_pss_sha512" (default)

The default value is rsa_pss_sha256,rsa_pss_sha384,rsa_pss_sha512,rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512,ecdsa_secp256r1_sha256,ecdsa_secp384r1_sha384,ecdsa_secp521r1_sha512,ed25519,ed448. This configuration setting is applicable only when SSLEnabledProtocols includes TLS 1.3.

TLS13SupportedGroups: The supported groups for (EC)DHE key exchange.

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

The default value is ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192,mlkem_512,mlkem_768,mlkem_1024,x25519_mlkem_768,secp256r1_mlkem_768

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

"ecdhe_x25519" (default)
"ecdhe_x448" (default)
"ecdhe_secp256r1" (default)
"ecdhe_secp384r1" (default)
"ecdhe_secp521r1" (default)
"ffdhe_2048" (default)
"ffdhe_3072" (default)
"ffdhe_4096" (default)
"ffdhe_6144" (default)
"ffdhe_8192" (default)
"mlkem_512" (default)
"mlkem_768" (default)
"mlkem_1024" (default)
"x25519_mlkem_768" (default)
"secp256r1_mlkem_768" (default)

Post-quantum algorithms (mlkem_512,mlkem_768,mlkem_1024,x25519_mlkem_768,secp256r1_mlkem_768) in our components rely on the operating system's underlying cryptographic primitives. The following platforms are currently supported:

Windows Server 2025
Windows 11 24H2
Windows 11 25H2

Base Config Settings

BuildInfo: Information about the product's build.

When queried, this setting will return a string containing information about the product's build.

CodePage: The system code page used for Unicode to Multibyte translations.

The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:


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

The following is a list of valid code page identifiers for Mac OS only:


Identifier	Name
1	ASCII
2	NEXTSTEP
3	JapaneseEUC
4	UTF8
5	ISOLatin1
6	Symbol
7	NonLossyASCII
8	ShiftJIS
9	ISOLatin2
10	Unicode
11	WindowsCP1251
12	WindowsCP1252
13	WindowsCP1253
14	WindowsCP1254
15	WindowsCP1250
21	ISO2022JP
30	MacOSRoman
10	UTF16String
0x90000100	UTF16BigEndian
0x94000100	UTF16LittleEndian
0x8c000100	UTF32String
0x98000100	UTF32BigEndian
0x9c000100	UTF32LittleEndian
65536	Proprietary

LicenseInfo: Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a struct is using. It will return the following information:

Product: The product the license is for.
Product Key: The key the license was generated from.
License Source: Where the license was found (e.g., RuntimeLicense, License File).
License Type: The type of license installed (e.g., Royalty Free, Single Server).
Last Valid Build: The last valid build number for which the license will work.

MaskSensitiveData: Whether sensitive data is masked in log messages.

In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to true to mask sensitive data. The default is true.

UseInternalSecurityAPI: Whether or not to use the system security libraries or an internal implementation.

When set to false, the struct will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this configuration setting to true tells the struct to use the internal implementation instead of using the system security libraries.

On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default.

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

Trappable Errors (AS1Receiver Struct)

Note: The starred errors may be ignored by configuring the ErrorProcessingFlags and ErrorReportingFlags of the struct.

AS1Receiver Errors

701	Unable to write log file.
711	The incoming message was encrypted with an unknown protocol.
712	Unable to decrypt message.
713	Unable to decompress message.
732	*Unable to verify content integrity.
733	*Unsupported signature type was requested.
734	*Unsupported MIC algorithm(s) were requested.

POP Errors

116	mail_port cannot be zero. Please specify a valid service port number.
118	Firewall error. Error message contains detailed description.
171	POP protocol error. Description contains the server reply.
172	Error communicating with server. Error text is attached.
173	Please specify a valid mail_server.
174	Busy executing current method.

The class may also return one of the following error codes, which are inherited from other classes.

TCPClient Errors

100	You cannot change the remote_port at this time. A connection is in progress.
101	You cannot change the remote_host (Server) at this time. A connection is in progress.
102	The remote_host address is invalid (0.0.0.0).
104	Already connected. If you want to reconnect, close the current connection first.
106	You cannot change the local_port at this time. A connection is in progress.
107	You cannot change the local_host at this time. A connection is in progress.
112	You cannot change MaxLineLength at this time. A connection is in progress.
116	remote_port cannot be zero. Please specify a valid service port number.
117	You cannot change the UseConnection option while the struct is active.
135	Operation would block.
201	Timeout.
211	Action impossible in control's present state.
212	Action impossible while not connected.
213	Action impossible while listening.
301	Timeout.
302	Could not open file.
434	Unable to convert string to selected CodePage.
1105	Already connecting. If you want to reconnect, close the current connection first.
1117	You need to connect first.
1119	You cannot change the LocalHost at this time. A connection is in progress.
1120	Connection dropped by remote host.

TCP/IP Errors

10004	[10004] Interrupted system call.
10009	[10009] Bad file number.
10013	[10013] Access denied.
10014	[10014] Bad address.
10022	[10022] Invalid argument.
10024	[10024] Too many open files.
10035	[10035] Operation would block.
10036	[10036] Operation now in progress.
10037	[10037] Operation already in progress.
10038	[10038] Socket operation on nonsocket.
10039	[10039] Destination address required.
10040	[10040] Message is too long.
10041	[10041] Protocol wrong type for socket.
10042	[10042] Bad protocol option.
10043	[10043] Protocol is not supported.
10044	[10044] Socket type is not supported.
10045	[10045] Operation is not supported on socket.
10046	[10046] Protocol family is not supported.
10047	[10047] Address family is not supported by protocol family.
10048	[10048] Address already in use.
10049	[10049] Cannot assign requested address.
10050	[10050] Network is down.
10051	[10051] Network is unreachable.
10052	[10052] Net dropped connection or reset.
10053	[10053] Software caused connection abort.
10054	[10054] Connection reset by peer.
10055	[10055] No buffer space available.
10056	[10056] Socket is already connected.
10057	[10057] Socket is not connected.
10058	[10058] Cannot send after socket shutdown.
10059	[10059] Too many references, cannot splice.
10060	[10060] Connection timed out.
10061	[10061] Connection refused.
10062	[10062] Too many levels of symbolic links.
10063	[10063] File name is too long.
10064	[10064] Host is down.
10065	[10065] No route to host.
10066	[10066] Directory is not empty
10067	[10067] Too many processes.
10068	[10068] Too many users.
10069	[10069] Disc Quota Exceeded.
10070	[10070] Stale NFS file handle.
10071	[10071] Too many levels of remote in path.
10091	[10091] Network subsystem is unavailable.
10092	[10092] WINSOCK DLL Version out of range.
10093	[10093] Winsock is not loaded yet.
11001	[11001] Host not found.
11002	[11002] Nonauthoritative 'Host not found' (try again or check DNS setup).
11003	[11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP.
11004	[11004] Valid name, no data record (check DNS setup).

SMTP Errors

118	Firewall Error. Error message contains detailed description.
161	SMTP protocol error. Description contains the server reply.
162	Error communicating with server. Error text is attached.
163	Please specify a mail_server.
164	Please specify a sender (from).
165	Please specify a recipient.
166	Busy executing current method.
301	Operation interrupted.
302	Cannot open attached_file.

The class may also return one of the following error codes, which are inherited from other classes.

TCPClient Errors

100	You cannot change the remote_port at this time. A connection is in progress.
101	You cannot change the remote_host (Server) at this time. A connection is in progress.
102	The remote_host address is invalid (0.0.0.0).
104	Already connected. If you want to reconnect, close the current connection first.
106	You cannot change the local_port at this time. A connection is in progress.
107	You cannot change the local_host at this time. A connection is in progress.
112	You cannot change MaxLineLength at this time. A connection is in progress.
116	remote_port cannot be zero. Please specify a valid service port number.
117	You cannot change the UseConnection option while the struct is active.
135	Operation would block.
201	Timeout.
211	Action impossible in control's present state.
212	Action impossible while not connected.
213	Action impossible while listening.
301	Timeout.
302	Could not open file.
434	Unable to convert string to selected CodePage.
1105	Already connecting. If you want to reconnect, close the current connection first.
1117	You need to connect first.
1119	You cannot change the LocalHost at this time. A connection is in progress.
1120	Connection dropped by remote host.

TCP/IP Errors

10004	[10004] Interrupted system call.
10009	[10009] Bad file number.
10013	[10013] Access denied.
10014	[10014] Bad address.
10022	[10022] Invalid argument.
10024	[10024] Too many open files.
10035	[10035] Operation would block.
10036	[10036] Operation now in progress.
10037	[10037] Operation already in progress.
10038	[10038] Socket operation on nonsocket.
10039	[10039] Destination address required.
10040	[10040] Message is too long.
10041	[10041] Protocol wrong type for socket.
10042	[10042] Bad protocol option.
10043	[10043] Protocol is not supported.
10044	[10044] Socket type is not supported.
10045	[10045] Operation is not supported on socket.
10046	[10046] Protocol family is not supported.
10047	[10047] Address family is not supported by protocol family.
10048	[10048] Address already in use.
10049	[10049] Cannot assign requested address.
10050	[10050] Network is down.
10051	[10051] Network is unreachable.
10052	[10052] Net dropped connection or reset.
10053	[10053] Software caused connection abort.
10054	[10054] Connection reset by peer.
10055	[10055] No buffer space available.
10056	[10056] Socket is already connected.
10057	[10057] Socket is not connected.
10058	[10058] Cannot send after socket shutdown.
10059	[10059] Too many references, cannot splice.
10060	[10060] Connection timed out.
10061	[10061] Connection refused.
10062	[10062] Too many levels of symbolic links.
10063	[10063] File name is too long.
10064	[10064] Host is down.
10065	[10065] No route to host.
10066	[10066] Directory is not empty
10067	[10067] Too many processes.
10068	[10068] Too many users.
10069	[10069] Disc Quota Exceeded.
10070	[10070] Stale NFS file handle.
10071	[10071] Too many levels of remote in path.
10091	[10091] Network subsystem is unavailable.
10092	[10092] WINSOCK DLL Version out of range.
10093	[10093] Winsock is not loaded yet.
11001	[11001] Host not found.
11002	[11002] Nonauthoritative 'Host not found' (try again or check DNS setup).
11003	[11003] Nonrecoverable errors: FORMERR, REFUSED, NOTIMP.
11004	[11004] Valid name, no data record (check DNS setup).

SMIME Errors

10191	Invalid index (RecipientIndex).
10192	Message decoding error (code).
10193	Unexpected message type.
10194	Unsupported hashing/signing algorithm.
10195	The message does not have any signers.
10196	The message signature could not be verified.
10197	Could not locate a suitable decryption certificate.
10198	The signer certificate could not be found.
10199	No signing certificate was supplied for signing the message.
10201	The specified certificate was not the one required.
10202	The specified certificate could not be found.
10221	Could not acquire CSP.
10222	Type validation error.
10223	Unsupported key size.
10224	Unrecognized Content-Type object identifier.
10225	Unrecognized public key format.
10226	No choices specified.
10228	Must specify output stream.
10280	Invalid part index.
10281	Unknown MIME type.
10283	No MIME-boundary found.
10280	Error decoding certificate.