# Struct ipworksedi::AS4Client The AS4Client struct connects to a server to send or receive files. ## Syntax ```text ipworksedi::AS4Client ``` ## Remarks The AS4Client component may be used to send or receive files from a server. The component will connect to a server and either send files (push), or request files to download (pull). **Sending Files** [send_files](#send_files-method-as4client-struct) sends the files specified by [edi_data](#edi_data-property-as4client-struct) to [url](#url-property-as4client-struct). Before calling this method set [agreement_ref](#agreement_ref-property-as4client-struct) to the agreement identifier used by both parties. Set as4_from and as4_to. Set [edi_data](#edi_data-property-as4client-struct) specifies the file(s) to be sent. To encrypt the data set recipient_certs. To sign the data set signing_cert. The signer_cert property should be set to verify the signed receipt. When this method is called the file(s) will be sent and any returned receipts will be verified. To indicate a synchronous receipt is expected set [receipt_reply_mode](#receipt_reply_mode-property-as4client-struct) to rrmSync. The following properties are applicable when calling this method with an agreement specifying a synchronous receipt (a receipt provided in the response): - [agreement_ref](#agreement_ref-property-as4client-struct) - as4_from - as4_to - [edi_data](#edi_data-property-as4client-struct) - [url](#url-property-as4client-struct) - recipient_certs (required to encrypt) - signer_cert (required to verify signed receipts) - signing_cert (required to sign files) - [conversation_id](#conversation_id-property-as4client-struct) (optional) - [encryption_algorithm](#encryption_algorithm-property-as4client-struct) (optional) - [log_directory](#log_directory-property-as4client-struct) (optional) - [message_id](#message_id-property-as4client-struct) (optional) - message_properties (optional) - [profile](#profile-property-as4client-struct) (optional) - [receipt_reply_mode](#receipt_reply_mode-property-as4client-struct) - [service](#service-property-as4client-struct) (optional) - [service_type](#service_type-property-as4client-struct) (optional) - [signature_algorithm](#signature_algorithm-property-as4client-struct) (optional) **SendFiles Example (synchronous receipt):** ```text client.Profile = As4clientProfiles.ebpfENTSOG; //Specify the agreement and party information client.AgreementRef = "http://agreements.company.com/sign_and_encrypt"; client.AS4From.Role = "Sender"; client.AS4From.Id = "org:b2b:example:company:A"; client.AS4To.Role = "Receiver"; client.AS4To.Id = "org:b2b:example:company:B"; //Configure the component to expect a synchronous receipt. client.ReceiptReplyMode = As4clientReceiptReplyModes.rrmSync; //Company A's private certificate. Used to sign the outgoing message and files. client.SigningCert = new Certificate(CertStoreTypes.cstPFXFile, "C:\\files\\CompanyA.pfx", "password", "*"); //Company B's public certificate. Used to encrypt the outgoing file. client.RecipientCerts.Add(new Certificate("C:\\files\\as4\\CompanyB.cer")); //Company B's public certificate. Used to verify the signed receipt. client.SignerCert = new Certificate("C:\\files\\as4\\CompanyB.cer"); client.URL = "http://www.company.com:9090/msh"; EBData data = new EBData(); data.EDIType = "application/edi-x12"; data.Filename = "C:\\files\\myfile.x12"; data.Name = "myfile.x12"; client.EDIData.Add(data); //Send file(s) and verify the receipt. client.SendFiles(); ``` The struct also supports asynchronous receipts. In this configuration a file is sent from the struct to another party, but the receipt is not returned in the response. Instead the other party sends the receipt at a later time. The [AS4Server](AS4Server.md#AS4Server) struct may be used inside a web page to receive the asynchronous receipt. After receiving the receipt either [AS4Server](AS4Server.md#AS4Server) or [AS4Client](#struct-ipworksedias4client) may be used to verify the receipt. Details about the original message must be stored so that the receipt can be correlated with the message and properly verified. The easiest way to do this is to set [async_receipt_info_dir](#async_receipt_info_dir-property-as4client-struct) before calling [send_files](#send_files-method-as4client-struct). The struct will automatically store the required information. See the [verify_receipt](AS4Server.md#AS4Server_m_VerifyReceipt) method of [AS4Server](AS4Server.md#AS4Server) for details about verifying asynchronous receipts. To indicate an asynchronous receipt is expected set [receipt_reply_mode](#receipt_reply_mode-property-as4client-struct) to rrmAsync. The following properties are applicable when calling this method with an agreement specifying a synchronous receipt (a receipt provided in the response): - [agreement_ref](#agreement_ref-property-as4client-struct) - as4_from - as4_to - [async_receipt_info_dir](#async_receipt_info_dir-property-as4client-struct) - [edi_data](#edi_data-property-as4client-struct) - [url](#url-property-as4client-struct) - recipient_certs (required to encrypt) - signer_cert (required to verify signed receipts) - signing_cert (required to sign files) - [conversation_id](#conversation_id-property-as4client-struct) (optional) - [encryption_algorithm](#encryption_algorithm-property-as4client-struct) (optional) - [log_directory](#log_directory-property-as4client-struct) (optional) - [message_id](#message_id-property-as4client-struct) (optional) - message_properties (optional) - [original_soap_message](#original_soap_message-property-as4client-struct) (optional) - [original_soap_message_id](#original_soap_message_id-property-as4client-struct) (optional) - [profile](#profile-property-as4client-struct) (optional) - [receipt_reply_mode](#receipt_reply_mode-property-as4client-struct) - [service](#service-property-as4client-struct) (optional) - [service_type](#service_type-property-as4client-struct) (optional) - [signature_algorithm](#signature_algorithm-property-as4client-struct) (optional) **SendFiles Example (asynchronous receipt):** ```text client.Profile = As4clientProfiles.ebpfENTSOG; //Specify the agreement and party information client.AgreementRef = "http://agreements.company.com/sign_and_encrypt_async"; client.AS4From.Role = "Sender"; client.AS4From.Id = "org:b2b:example:company:A"; client.AS4To.Role = "Receiver"; client.AS4To.Id = "org:b2b:example:company:B"; //Configure the component to expect a synchronous receipt. client.ReceiptReplyMode = As4clientReceiptReplyModes.rrmAsync; client.AsyncReceiptInfoDir = "C:\\async_info"; //Company A's private certificate. Used to sign the outgoing message and files. client.SigningCert = new Certificate(CertStoreTypes.cstPFXFile, "C:\\files\\CompanyA.pfx", "password", "*"); //Company B's public certificate. Used to encrypt the outgoing files. client.RecipientCerts.Add(new Certificate("C:\\files\\as4\\CompanyB.cer")); //Company B's public certificate. Used to verify the signed receipt. client.SignerCert = new Certificate("C:\\files\\as4\\CompanyB.cer"); client.URL = "http://www.company.com:9090/msh"; EBData data = new EBData(); data.EDIType = "application/edi-x12"; data.Filename = "C:\\files\\myfile.x12"; data.Name = "myfile.x12"; client.EDIData.Add(data); //Send file(s). client.SendFiles(); ``` At this point the file(s) have been sent, but a receipt has not yet been received. [AS4Server](AS4Server.md#AS4Server) can be used within a web site to listen for the receipt. ```text //**** Inside a web site **** As4server server = new As4server; server.ReadRequest(); if (!String.IsNullOrEmpty(server.IncomingReceipt.Content)) { server.AsyncReceiptInfoDir = "C:\\async_info"; server.VerifyReceipt(); //The receipt is now verified } ``` **Receiving Files** [receive_files](#receive_files-method-as4client-struct) establishes a connection to the server specified by [url](#url-property-as4client-struct) and receives files. The [mpc](#mpc-property-as4client-struct) specifies the Message Partition Channel from which messages will be received. The server will reply with files from this channel. If [incoming_directory](#incoming_directory-property-as4client-struct) is set before calling this method the files will be written to the specified folder, otherwise inspect [edi_data](#edi_data-property-as4client-struct) to obtain the received file data. The following properties are applicable when calling this method: - signing_cert (required to sign the request) - certificate (required for decryption) - signer_cert (required for signature verification) - [url](#url-property-as4client-struct) - [incoming_directory](#incoming_directory-property-as4client-struct) (optional) - [log_directory](#log_directory-property-as4client-struct) - [mpc](#mpc-property-as4client-struct) - [token_user](#token_user-property-as4client-struct) - [token_password](#token_password-property-as4client-struct) - [token_password_type](#token_password_type-property-as4client-struct) After calling this method the following properties will be populated and may be inspected: - as4_from - as4_to - [agreement_ref](#agreement_ref-property-as4client-struct) - [conversation_id](#conversation_id-property-as4client-struct) - [service](#service-property-as4client-struct) - [service_action](#service_action-property-as4client-struct) - [service_type](#service_type-property-as4client-struct) - [message_id](#message_id-property-as4client-struct) - receipt The receipt property will be populated with the receipt corresponding to the received message, but it is not yet delivered. The receipt may be delivered by bundling it with another request to receive files, or by calling [send_receipt](#send_receipt-method-as4client-struct). To bundle the receipt with a subsequent [receive_files](#receive_files-method-as4client-struct) call the receipt property must hold the receipt. If the same instance of the struct is being used this is already true since receipt is populated automatically after receiving the file. To use another instance of the struct for multiple calls to [receive_files](#receive_files-method-as4client-struct) be sure to save the Receipt's [receipt_content](#receipt_content-property-as4client-struct) and [receipt_ref_to_message_id](#receipt_ref_to_message_id-property-as4client-struct) values for later use. **ReceiveFiles Example:** ```text client.Profile = As4clientProfiles.ebpfENTSOG; //Company A's private certificate. Used for signing the request. client.SigningCert = new Certificate(CertStoreTypes.cstPFXFile, "C:\\files\\as4\\CompanyA.pfx", "password", "*"); //Company A's private certificate. Used for decrypting the file. client.Certificate = new Certificate(CertStoreTypes.cstPFXFile, "C:\\files\\as4\\CompanyA.pfx", "password", "*"); //Company B's public certificate. Used for signature verification. client.SignerCert = new Certificate("C:\\files\\as4\\CompanyB.cer"); client.URL = "http://www.company.com:9090/msh"; //Message Channel id client.MPC = "mpc_a"; client.IncomingDirectory = "C:\\incoming_dir"; client.ReceiveFiles(); //Inspect client.AgreementRef and other properties for information about the received files Console.WriteLine(client.AgreementRef); Console.WriteLine(client.AS4From.Id); Console.WriteLine(client.AS4To.Id); Console.WriteLine(client.ConversationId); //Save the receipt for later use string receiptContent = client.Receipt.Content; string receiptRefId = client.Receipt.RefToMessageId; ``` At this stage the receipt data is saved. Later when making another call to ReceiveFiles and populate the Receipt property with this receipt data. When ReceiveFiles is called again, the receipt for the previous message will be included with the request. ```text client.Receipt = new EBReceipt(receiptRefId, receiptContent); client.ReceiveFiles(); //This will now include the bundled receipt ``` **Sending Asynchronous Receipts** [send_receipt](#send_receipt-method-as4client-struct) sends an asynchronous receipt to the [url](#url-property-as4client-struct). This method is typically used in conjunction with [AS4Server](AS4Server.md#AS4Server) to send an asynchronous receipt after receiving a message. The receipt will be created at the time of the incoming request, then saved for later use. When the receipt is to be sent populate receipt and call this method. ```text //Send an asynchronous receipt client.URL = ""http://www.company.com:9090/msh""; client.Receipt = new EBReceipt(server.Receipt.RefToMessageId, server.Receipt.Content); client.ReceiptReplyMode = As4clientReceiptReplyModes.rrmAsync; client.SendReceipt(); ``` ### 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 AS4Client struct cannot be disposed of automatically. Please, call the *dispose(&mut; self)* method of AS4Client 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.* | | | | --- | --- | | [agreement_ref](#agreement_ref-property-as4client-struct) | The agreement reference. | | [as4_from_id](#as4_from_id-property-as4client-struct) | The Id of the party. | | [as4_from_id_type](#as4_from_id_type-property-as4client-struct) | The optional type of the Id. | | [as4_from_role](#as4_from_role-property-as4client-struct) | This property specifies the role of the party. | | [as4_to_id](#as4_to_id-property-as4client-struct) | The Id of the party. | | [as4_to_id_type](#as4_to_id_type-property-as4client-struct) | The optional type of the Id. | | [as4_to_role](#as4_to_role-property-as4client-struct) | This property specifies the role of the party. | | [async_receipt_info_dir](#async_receipt_info_dir-property-as4client-struct) | A directory to hold information used for asynchronous receipt verification. | | [cert_effective_date](#cert_effective_date-property-as4client-struct) | The date on which this certificate becomes valid. | | [cert_expiration_date](#cert_expiration_date-property-as4client-struct) | The date on which the certificate expires. | | [cert_extended_key_usage](#cert_extended_key_usage-property-as4client-struct) | A comma-delimited list of extended key usage identifiers. | | [cert_fingerprint](#cert_fingerprint-property-as4client-struct) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [cert_fingerprint_sha1](#cert_fingerprint_sha1-property-as4client-struct) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [cert_fingerprint_sha256](#cert_fingerprint_sha256-property-as4client-struct) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [cert_issuer](#cert_issuer-property-as4client-struct) | The issuer of the certificate. | | [cert_private_key](#cert_private_key-property-as4client-struct) | The private key of the certificate (if available). | | [cert_private_key_available](#cert_private_key_available-property-as4client-struct) | Whether a PrivateKey is available for the selected certificate. | | [cert_private_key_container](#cert_private_key_container-property-as4client-struct) | The name of the PrivateKey container for the certificate (if available). | | [cert_public_key](#cert_public_key-property-as4client-struct) | The public key of the certificate. | | [cert_public_key_algorithm](#cert_public_key_algorithm-property-as4client-struct) | The textual description of the certificate's public key algorithm. | | [cert_public_key_length](#cert_public_key_length-property-as4client-struct) | The length of the certificate's public key (in bits). | | [cert_serial_number](#cert_serial_number-property-as4client-struct) | The serial number of the certificate encoded as a string. | | [cert_signature_algorithm](#cert_signature_algorithm-property-as4client-struct) | The text description of the certificate's signature algorithm. | | [cert_store](#cert_store-property-as4client-struct) | The name of the certificate store for the client certificate. | | [cert_store_password](#cert_store_password-property-as4client-struct) | 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](#cert_store_type-property-as4client-struct) | The type of certificate store for this certificate. | | [cert_subject_alt_names](#cert_subject_alt_names-property-as4client-struct) | Comma-separated lists of alternative subject names for the certificate. | | [cert_thumbprint_md5](#cert_thumbprint_md5-property-as4client-struct) | The MD5 hash of the certificate. | | [cert_thumbprint_sha1](#cert_thumbprint_sha1-property-as4client-struct) | The SHA-1 hash of the certificate. | | [cert_thumbprint_sha256](#cert_thumbprint_sha256-property-as4client-struct) | The SHA-256 hash of the certificate. | | [cert_usage](#cert_usage-property-as4client-struct) | The text description of UsageFlags . | | [cert_usage_flags](#cert_usage_flags-property-as4client-struct) | The flags that show intended use for the certificate. | | [cert_version](#cert_version-property-as4client-struct) | The certificate's version number. | | [cert_subject](#cert_subject-property-as4client-struct) | The subject of the certificate used for client authentication. | | [cert_encoded](#cert_encoded-property-as4client-struct) | The certificate (PEM/Base64 encoded). | | [compression_format](#compression_format-property-as4client-struct) | The compression format (if any) to use. | | [conversation_id](#conversation_id-property-as4client-struct) | The Conversation Id of the message. | | [cookie_count](#cookie_count-property-as4client-struct) | The number of records in the Cookie arrays. | | [cookie_domain](#cookie_domain-property-as4client-struct) | The domain of a received cookie. | | [cookie_expiration](#cookie_expiration-property-as4client-struct) | An expiration time for the cookie (if provided by the server). | | [cookie_name](#cookie_name-property-as4client-struct) | The name of the cookie. | | [cookie_path](#cookie_path-property-as4client-struct) | A path name to limit the cookie to (if provided by the server). | | [cookie_secure](#cookie_secure-property-as4client-struct) | The security flag of the received cookie. | | [cookie_value](#cookie_value-property-as4client-struct) | The value of the cookie. | | [edi_data_count](#edi_data_count-property-as4client-struct) | The number of records in the EDI arrays. | | [edi_data](#edi_data-property-as4client-struct) | This property contains the EDI payload of the transmission. | | [edi_type](#edi_type-property-as4client-struct) | The Content-Type of the EDI message. | | [edi_file_name](#edi_file_name-property-as4client-struct) | When sending, if FileName is specified, the file specified will be used for the EDI payload of the transmission. | | [edi_name](#edi_name-property-as4client-struct) | Name is the final name to be associated with the contents of either the Data or FileName properties. | | [edi_property_count](#edi_property_count-property-as4client-struct) | The number of properties for this file. | | [edi_property_index](#edi_property_index-property-as4client-struct) | Selects a property at the specified index. | | [edi_property_name](#edi_property_name-property-as4client-struct) | The name of the property. | | [edi_property_value](#edi_property_value-property-as4client-struct) | The value of the property. | | [edi_schema_location](#edi_schema_location-property-as4client-struct) | The SchemaLocation , SchemaNamespace , and SchemaVersion optionally define the schema that applies to this particular file. | | [edi_schema_namespace](#edi_schema_namespace-property-as4client-struct) | The namespace of the schema. | | [edi_schema_version](#edi_schema_version-property-as4client-struct) | The version of the schema. | | [encryption_algorithm](#encryption_algorithm-property-as4client-struct) | The algorithm used to encrypt the EDI data. | | [error_count](#error_count-property-as4client-struct) | The number of records in the Error arrays. | | [error_category](#error_category-property-as4client-struct) | The category of error. | | [error_code](#error_code-property-as4client-struct) | The error code. | | [error_description](#error_description-property-as4client-struct) | The description of the error. | | [error_detail](#error_detail-property-as4client-struct) | Additional details about the error. | | [error_origin](#error_origin-property-as4client-struct) | The module within which the error occurred. | | [error_ref_message_id](#error_ref_message_id-property-as4client-struct) | The MessageId to which the error applies. | | [error_severity](#error_severity-property-as4client-struct) | The severity of the error. | | [error_short_description](#error_short_description-property-as4client-struct) | A short description of the error. | | [firewall_auto_detect](#firewall_auto_detect-property-as4client-struct) | Whether to automatically detect and use firewall system settings, if available. | | [firewall_type](#firewall_type-property-as4client-struct) | The type of firewall to connect through. | | [firewall_host](#firewall_host-property-as4client-struct) | The name or IP address of the firewall (optional). | | [firewall_password](#firewall_password-property-as4client-struct) | A password if authentication is to be used when connecting through the firewall. | | [firewall_port](#firewall_port-property-as4client-struct) | The Transmission Control Protocol (TCP) port for the firewall Host . | | [firewall_user](#firewall_user-property-as4client-struct) | A username if authentication is to be used when connecting through a firewall. | | [incoming_directory](#incoming_directory-property-as4client-struct) | The directory to which incoming files are saved. | | [local_host](#local_host-property-as4client-struct) | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. | | [log_directory](#log_directory-property-as4client-struct) | The path to a directory for logging. | | [log_file](#log_file-property-as4client-struct) | The log file written. | | [message_id](#message_id-property-as4client-struct) | The unique Id of the message. | | [message_property_count](#message_property_count-property-as4client-struct) | The number of records in the MessageProperty arrays. | | [message_property_name](#message_property_name-property-as4client-struct) | This property defines the name of the message property. | | [message_property_property_type](#message_property_property_type-property-as4client-struct) | The optional type of the message property. | | [message_property_value](#message_property_value-property-as4client-struct) | The value of the message property. | | [mpc](#mpc-property-as4client-struct) | The MPC (Message Partition Channel) from which to receive files. | | [original_soap_message](#original_soap_message-property-as4client-struct) | The original SOAP message used to verify the receipt. | | [original_soap_message_id](#original_soap_message_id-property-as4client-struct) | The original SOAP message Id used to verify the receipt. | | [profile](#profile-property-as4client-struct) | The AS4 profile. | | [proxy_auth_scheme](#proxy_auth_scheme-property-as4client-struct) | The type of authorization to perform when connecting to the proxy. | | [proxy_auto_detect](#proxy_auto_detect-property-as4client-struct) | Whether to automatically detect and use proxy system settings, if available. | | [proxy_password](#proxy_password-property-as4client-struct) | A password if authentication is to be used for the proxy. | | [proxy_port](#proxy_port-property-as4client-struct) | The Transmission Control Protocol (TCP) port for the proxy Server (default 80). | | [proxy_server](#proxy_server-property-as4client-struct) | If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. | | [proxy_ssl](#proxy_ssl-property-as4client-struct) | When to use a Secure Sockets Layer (SSL) for the connection to the proxy. | | [proxy_user](#proxy_user-property-as4client-struct) | A username if authentication is to be used for the proxy. | | [receipt_content](#receipt_content-property-as4client-struct) | The content of the receipt. | | [receipt_ref_to_message_id](#receipt_ref_to_message_id-property-as4client-struct) | The Message Id to which this receipt applies. | | [receipt_reply_mode](#receipt_reply_mode-property-as4client-struct) | The expected receipt reply mode. | | [recipient_cert_count](#recipient_cert_count-property-as4client-struct) | The number of records in the RecipientCert arrays. | | [recipient_cert_effective_date](#recipient_cert_effective_date-property-as4client-struct) | The date on which this certificate becomes valid. | | [recipient_cert_expiration_date](#recipient_cert_expiration_date-property-as4client-struct) | The date on which the certificate expires. | | [recipient_cert_extended_key_usage](#recipient_cert_extended_key_usage-property-as4client-struct) | A comma-delimited list of extended key usage identifiers. | | [recipient_cert_fingerprint](#recipient_cert_fingerprint-property-as4client-struct) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [recipient_cert_fingerprint_sha1](#recipient_cert_fingerprint_sha1-property-as4client-struct) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [recipient_cert_fingerprint_sha256](#recipient_cert_fingerprint_sha256-property-as4client-struct) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [recipient_cert_issuer](#recipient_cert_issuer-property-as4client-struct) | The issuer of the certificate. | | [recipient_cert_private_key](#recipient_cert_private_key-property-as4client-struct) | The private key of the certificate (if available). | | [recipient_cert_private_key_available](#recipient_cert_private_key_available-property-as4client-struct) | Whether a PrivateKey is available for the selected certificate. | | [recipient_cert_private_key_container](#recipient_cert_private_key_container-property-as4client-struct) | The name of the PrivateKey container for the certificate (if available). | | [recipient_cert_public_key](#recipient_cert_public_key-property-as4client-struct) | The public key of the certificate. | | [recipient_cert_public_key_algorithm](#recipient_cert_public_key_algorithm-property-as4client-struct) | The textual description of the certificate's public key algorithm. | | [recipient_cert_public_key_length](#recipient_cert_public_key_length-property-as4client-struct) | The length of the certificate's public key (in bits). | | [recipient_cert_serial_number](#recipient_cert_serial_number-property-as4client-struct) | The serial number of the certificate encoded as a string. | | [recipient_cert_signature_algorithm](#recipient_cert_signature_algorithm-property-as4client-struct) | The text description of the certificate's signature algorithm. | | [recipient_cert_store](#recipient_cert_store-property-as4client-struct) | The name of the certificate store for the client certificate. | | [recipient_cert_store_password](#recipient_cert_store_password-property-as4client-struct) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. | | [recipient_cert_store_type](#recipient_cert_store_type-property-as4client-struct) | The type of certificate store for this certificate. | | [recipient_cert_subject_alt_names](#recipient_cert_subject_alt_names-property-as4client-struct) | Comma-separated lists of alternative subject names for the certificate. | | [recipient_cert_thumbprint_md5](#recipient_cert_thumbprint_md5-property-as4client-struct) | The MD5 hash of the certificate. | | [recipient_cert_thumbprint_sha1](#recipient_cert_thumbprint_sha1-property-as4client-struct) | The SHA-1 hash of the certificate. | | [recipient_cert_thumbprint_sha256](#recipient_cert_thumbprint_sha256-property-as4client-struct) | The SHA-256 hash of the certificate. | | [recipient_cert_usage](#recipient_cert_usage-property-as4client-struct) | The text description of UsageFlags . | | [recipient_cert_usage_flags](#recipient_cert_usage_flags-property-as4client-struct) | The flags that show intended use for the certificate. | | [recipient_cert_version](#recipient_cert_version-property-as4client-struct) | The certificate's version number. | | [recipient_cert_subject](#recipient_cert_subject-property-as4client-struct) | The subject of the certificate used for client authentication. | | [recipient_cert_encoded](#recipient_cert_encoded-property-as4client-struct) | The certificate (PEM/Base64 encoded). | | [ref_to_message_id](#ref_to_message_id-property-as4client-struct) | Specifies the RefToMessageId in the message. | | [rollover_cert_effective_date](#rollover_cert_effective_date-property-as4client-struct) | The date on which this certificate becomes valid. | | [rollover_cert_expiration_date](#rollover_cert_expiration_date-property-as4client-struct) | The date on which the certificate expires. | | [rollover_cert_extended_key_usage](#rollover_cert_extended_key_usage-property-as4client-struct) | A comma-delimited list of extended key usage identifiers. | | [rollover_cert_fingerprint](#rollover_cert_fingerprint-property-as4client-struct) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [rollover_cert_fingerprint_sha1](#rollover_cert_fingerprint_sha1-property-as4client-struct) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [rollover_cert_fingerprint_sha256](#rollover_cert_fingerprint_sha256-property-as4client-struct) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [rollover_cert_issuer](#rollover_cert_issuer-property-as4client-struct) | The issuer of the certificate. | | [rollover_cert_private_key](#rollover_cert_private_key-property-as4client-struct) | The private key of the certificate (if available). | | [rollover_cert_private_key_available](#rollover_cert_private_key_available-property-as4client-struct) | Whether a PrivateKey is available for the selected certificate. | | [rollover_cert_private_key_container](#rollover_cert_private_key_container-property-as4client-struct) | The name of the PrivateKey container for the certificate (if available). | | [rollover_cert_public_key](#rollover_cert_public_key-property-as4client-struct) | The public key of the certificate. | | [rollover_cert_public_key_algorithm](#rollover_cert_public_key_algorithm-property-as4client-struct) | The textual description of the certificate's public key algorithm. | | [rollover_cert_public_key_length](#rollover_cert_public_key_length-property-as4client-struct) | The length of the certificate's public key (in bits). | | [rollover_cert_serial_number](#rollover_cert_serial_number-property-as4client-struct) | The serial number of the certificate encoded as a string. | | [rollover_cert_signature_algorithm](#rollover_cert_signature_algorithm-property-as4client-struct) | The text description of the certificate's signature algorithm. | | [rollover_cert_store](#rollover_cert_store-property-as4client-struct) | The name of the certificate store for the client certificate. | | [rollover_cert_store_password](#rollover_cert_store_password-property-as4client-struct) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. | | [rollover_cert_store_type](#rollover_cert_store_type-property-as4client-struct) | The type of certificate store for this certificate. | | [rollover_cert_subject_alt_names](#rollover_cert_subject_alt_names-property-as4client-struct) | Comma-separated lists of alternative subject names for the certificate. | | [rollover_cert_thumbprint_md5](#rollover_cert_thumbprint_md5-property-as4client-struct) | The MD5 hash of the certificate. | | [rollover_cert_thumbprint_sha1](#rollover_cert_thumbprint_sha1-property-as4client-struct) | The SHA-1 hash of the certificate. | | [rollover_cert_thumbprint_sha256](#rollover_cert_thumbprint_sha256-property-as4client-struct) | The SHA-256 hash of the certificate. | | [rollover_cert_usage](#rollover_cert_usage-property-as4client-struct) | The text description of UsageFlags . | | [rollover_cert_usage_flags](#rollover_cert_usage_flags-property-as4client-struct) | The flags that show intended use for the certificate. | | [rollover_cert_version](#rollover_cert_version-property-as4client-struct) | The certificate's version number. | | [rollover_cert_subject](#rollover_cert_subject-property-as4client-struct) | The subject of the certificate used for client authentication. | | [rollover_cert_encoded](#rollover_cert_encoded-property-as4client-struct) | The certificate (PEM/Base64 encoded). | | [rollover_signing_cert_effective_date](#rollover_signing_cert_effective_date-property-as4client-struct) | The date on which this certificate becomes valid. | | [rollover_signing_cert_expiration_date](#rollover_signing_cert_expiration_date-property-as4client-struct) | The date on which the certificate expires. | | [rollover_signing_cert_extended_key_usage](#rollover_signing_cert_extended_key_usage-property-as4client-struct) | A comma-delimited list of extended key usage identifiers. | | [rollover_signing_cert_fingerprint](#rollover_signing_cert_fingerprint-property-as4client-struct) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [rollover_signing_cert_fingerprint_sha1](#rollover_signing_cert_fingerprint_sha1-property-as4client-struct) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [rollover_signing_cert_fingerprint_sha256](#rollover_signing_cert_fingerprint_sha256-property-as4client-struct) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [rollover_signing_cert_issuer](#rollover_signing_cert_issuer-property-as4client-struct) | The issuer of the certificate. | | [rollover_signing_cert_private_key](#rollover_signing_cert_private_key-property-as4client-struct) | The private key of the certificate (if available). | | [rollover_signing_cert_private_key_available](#rollover_signing_cert_private_key_available-property-as4client-struct) | Whether a PrivateKey is available for the selected certificate. | | [rollover_signing_cert_private_key_container](#rollover_signing_cert_private_key_container-property-as4client-struct) | The name of the PrivateKey container for the certificate (if available). | | [rollover_signing_cert_public_key](#rollover_signing_cert_public_key-property-as4client-struct) | The public key of the certificate. | | [rollover_signing_cert_public_key_algorithm](#rollover_signing_cert_public_key_algorithm-property-as4client-struct) | The textual description of the certificate's public key algorithm. | | [rollover_signing_cert_public_key_length](#rollover_signing_cert_public_key_length-property-as4client-struct) | The length of the certificate's public key (in bits). | | [rollover_signing_cert_serial_number](#rollover_signing_cert_serial_number-property-as4client-struct) | The serial number of the certificate encoded as a string. | | [rollover_signing_cert_signature_algorithm](#rollover_signing_cert_signature_algorithm-property-as4client-struct) | The text description of the certificate's signature algorithm. | | [rollover_signing_cert_store](#rollover_signing_cert_store-property-as4client-struct) | The name of the certificate store for the client certificate. | | [rollover_signing_cert_store_password](#rollover_signing_cert_store_password-property-as4client-struct) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. | | [rollover_signing_cert_store_type](#rollover_signing_cert_store_type-property-as4client-struct) | The type of certificate store for this certificate. | | [rollover_signing_cert_subject_alt_names](#rollover_signing_cert_subject_alt_names-property-as4client-struct) | Comma-separated lists of alternative subject names for the certificate. | | [rollover_signing_cert_thumbprint_md5](#rollover_signing_cert_thumbprint_md5-property-as4client-struct) | The MD5 hash of the certificate. | | [rollover_signing_cert_thumbprint_sha1](#rollover_signing_cert_thumbprint_sha1-property-as4client-struct) | The SHA-1 hash of the certificate. | | [rollover_signing_cert_thumbprint_sha256](#rollover_signing_cert_thumbprint_sha256-property-as4client-struct) | The SHA-256 hash of the certificate. | | [rollover_signing_cert_usage](#rollover_signing_cert_usage-property-as4client-struct) | The text description of UsageFlags . | | [rollover_signing_cert_usage_flags](#rollover_signing_cert_usage_flags-property-as4client-struct) | The flags that show intended use for the certificate. | | [rollover_signing_cert_version](#rollover_signing_cert_version-property-as4client-struct) | The certificate's version number. | | [rollover_signing_cert_subject](#rollover_signing_cert_subject-property-as4client-struct) | The subject of the certificate used for client authentication. | | [rollover_signing_cert_encoded](#rollover_signing_cert_encoded-property-as4client-struct) | The certificate (PEM/Base64 encoded). | | [service](#service-property-as4client-struct) | The service which acts on the message. | | [service_action](#service_action-property-as4client-struct) | The action within a service that acts on the message. | | [service_type](#service_type-property-as4client-struct) | The type of service. | | [signature_algorithm](#signature_algorithm-property-as4client-struct) | Signature algorithm to be used in the message. | | [signer_cert_effective_date](#signer_cert_effective_date-property-as4client-struct) | The date on which this certificate becomes valid. | | [signer_cert_expiration_date](#signer_cert_expiration_date-property-as4client-struct) | The date on which the certificate expires. | | [signer_cert_extended_key_usage](#signer_cert_extended_key_usage-property-as4client-struct) | A comma-delimited list of extended key usage identifiers. | | [signer_cert_fingerprint](#signer_cert_fingerprint-property-as4client-struct) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [signer_cert_fingerprint_sha1](#signer_cert_fingerprint_sha1-property-as4client-struct) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [signer_cert_fingerprint_sha256](#signer_cert_fingerprint_sha256-property-as4client-struct) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [signer_cert_issuer](#signer_cert_issuer-property-as4client-struct) | The issuer of the certificate. | | [signer_cert_private_key](#signer_cert_private_key-property-as4client-struct) | The private key of the certificate (if available). | | [signer_cert_private_key_available](#signer_cert_private_key_available-property-as4client-struct) | Whether a PrivateKey is available for the selected certificate. | | [signer_cert_private_key_container](#signer_cert_private_key_container-property-as4client-struct) | The name of the PrivateKey container for the certificate (if available). | | [signer_cert_public_key](#signer_cert_public_key-property-as4client-struct) | The public key of the certificate. | | [signer_cert_public_key_algorithm](#signer_cert_public_key_algorithm-property-as4client-struct) | The textual description of the certificate's public key algorithm. | | [signer_cert_public_key_length](#signer_cert_public_key_length-property-as4client-struct) | The length of the certificate's public key (in bits). | | [signer_cert_serial_number](#signer_cert_serial_number-property-as4client-struct) | The serial number of the certificate encoded as a string. | | [signer_cert_signature_algorithm](#signer_cert_signature_algorithm-property-as4client-struct) | The text description of the certificate's signature algorithm. | | [signer_cert_store](#signer_cert_store-property-as4client-struct) | The name of the certificate store for the client certificate. | | [signer_cert_store_password](#signer_cert_store_password-property-as4client-struct) | 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](#signer_cert_store_type-property-as4client-struct) | The type of certificate store for this certificate. | | [signer_cert_subject_alt_names](#signer_cert_subject_alt_names-property-as4client-struct) | Comma-separated lists of alternative subject names for the certificate. | | [signer_cert_thumbprint_md5](#signer_cert_thumbprint_md5-property-as4client-struct) | The MD5 hash of the certificate. | | [signer_cert_thumbprint_sha1](#signer_cert_thumbprint_sha1-property-as4client-struct) | The SHA-1 hash of the certificate. | | [signer_cert_thumbprint_sha256](#signer_cert_thumbprint_sha256-property-as4client-struct) | The SHA-256 hash of the certificate. | | [signer_cert_usage](#signer_cert_usage-property-as4client-struct) | The text description of UsageFlags . | | [signer_cert_usage_flags](#signer_cert_usage_flags-property-as4client-struct) | The flags that show intended use for the certificate. | | [signer_cert_version](#signer_cert_version-property-as4client-struct) | The certificate's version number. | | [signer_cert_subject](#signer_cert_subject-property-as4client-struct) | The subject of the certificate used for client authentication. | | [signer_cert_encoded](#signer_cert_encoded-property-as4client-struct) | The certificate (PEM/Base64 encoded). | | [signing_cert_effective_date](#signing_cert_effective_date-property-as4client-struct) | The date on which this certificate becomes valid. | | [signing_cert_expiration_date](#signing_cert_expiration_date-property-as4client-struct) | The date on which the certificate expires. | | [signing_cert_extended_key_usage](#signing_cert_extended_key_usage-property-as4client-struct) | A comma-delimited list of extended key usage identifiers. | | [signing_cert_fingerprint](#signing_cert_fingerprint-property-as4client-struct) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [signing_cert_fingerprint_sha1](#signing_cert_fingerprint_sha1-property-as4client-struct) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [signing_cert_fingerprint_sha256](#signing_cert_fingerprint_sha256-property-as4client-struct) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [signing_cert_issuer](#signing_cert_issuer-property-as4client-struct) | The issuer of the certificate. | | [signing_cert_private_key](#signing_cert_private_key-property-as4client-struct) | The private key of the certificate (if available). | | [signing_cert_private_key_available](#signing_cert_private_key_available-property-as4client-struct) | Whether a PrivateKey is available for the selected certificate. | | [signing_cert_private_key_container](#signing_cert_private_key_container-property-as4client-struct) | The name of the PrivateKey container for the certificate (if available). | | [signing_cert_public_key](#signing_cert_public_key-property-as4client-struct) | The public key of the certificate. | | [signing_cert_public_key_algorithm](#signing_cert_public_key_algorithm-property-as4client-struct) | The textual description of the certificate's public key algorithm. | | [signing_cert_public_key_length](#signing_cert_public_key_length-property-as4client-struct) | The length of the certificate's public key (in bits). | | [signing_cert_serial_number](#signing_cert_serial_number-property-as4client-struct) | The serial number of the certificate encoded as a string. | | [signing_cert_signature_algorithm](#signing_cert_signature_algorithm-property-as4client-struct) | The text description of the certificate's signature algorithm. | | [signing_cert_store](#signing_cert_store-property-as4client-struct) | The name of the certificate store for the client certificate. | | [signing_cert_store_password](#signing_cert_store_password-property-as4client-struct) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. | | [signing_cert_store_type](#signing_cert_store_type-property-as4client-struct) | The type of certificate store for this certificate. | | [signing_cert_subject_alt_names](#signing_cert_subject_alt_names-property-as4client-struct) | Comma-separated lists of alternative subject names for the certificate. | | [signing_cert_thumbprint_md5](#signing_cert_thumbprint_md5-property-as4client-struct) | The MD5 hash of the certificate. | | [signing_cert_thumbprint_sha1](#signing_cert_thumbprint_sha1-property-as4client-struct) | The SHA-1 hash of the certificate. | | [signing_cert_thumbprint_sha256](#signing_cert_thumbprint_sha256-property-as4client-struct) | The SHA-256 hash of the certificate. | | [signing_cert_usage](#signing_cert_usage-property-as4client-struct) | The text description of UsageFlags . | | [signing_cert_usage_flags](#signing_cert_usage_flags-property-as4client-struct) | The flags that show intended use for the certificate. | | [signing_cert_version](#signing_cert_version-property-as4client-struct) | The certificate's version number. | | [signing_cert_subject](#signing_cert_subject-property-as4client-struct) | The subject of the certificate used for client authentication. | | [signing_cert_encoded](#signing_cert_encoded-property-as4client-struct) | The certificate (PEM/Base64 encoded). | | [ssl_accept_server_cert_effective_date](#ssl_accept_server_cert_effective_date-property-as4client-struct) | The date on which this certificate becomes valid. | | [ssl_accept_server_cert_expiration_date](#ssl_accept_server_cert_expiration_date-property-as4client-struct) | The date on which the certificate expires. | | [ssl_accept_server_cert_extended_key_usage](#ssl_accept_server_cert_extended_key_usage-property-as4client-struct) | A comma-delimited list of extended key usage identifiers. | | [ssl_accept_server_cert_fingerprint](#ssl_accept_server_cert_fingerprint-property-as4client-struct) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [ssl_accept_server_cert_fingerprint_sha1](#ssl_accept_server_cert_fingerprint_sha1-property-as4client-struct) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [ssl_accept_server_cert_fingerprint_sha256](#ssl_accept_server_cert_fingerprint_sha256-property-as4client-struct) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [ssl_accept_server_cert_issuer](#ssl_accept_server_cert_issuer-property-as4client-struct) | The issuer of the certificate. | | [ssl_accept_server_cert_private_key](#ssl_accept_server_cert_private_key-property-as4client-struct) | The private key of the certificate (if available). | | [ssl_accept_server_cert_private_key_available](#ssl_accept_server_cert_private_key_available-property-as4client-struct) | Whether a PrivateKey is available for the selected certificate. | | [ssl_accept_server_cert_private_key_container](#ssl_accept_server_cert_private_key_container-property-as4client-struct) | The name of the PrivateKey container for the certificate (if available). | | [ssl_accept_server_cert_public_key](#ssl_accept_server_cert_public_key-property-as4client-struct) | The public key of the certificate. | | [ssl_accept_server_cert_public_key_algorithm](#ssl_accept_server_cert_public_key_algorithm-property-as4client-struct) | The textual description of the certificate's public key algorithm. | | [ssl_accept_server_cert_public_key_length](#ssl_accept_server_cert_public_key_length-property-as4client-struct) | The length of the certificate's public key (in bits). | | [ssl_accept_server_cert_serial_number](#ssl_accept_server_cert_serial_number-property-as4client-struct) | The serial number of the certificate encoded as a string. | | [ssl_accept_server_cert_signature_algorithm](#ssl_accept_server_cert_signature_algorithm-property-as4client-struct) | The text description of the certificate's signature algorithm. | | [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property-as4client-struct) | The name of the certificate store for the client certificate. | | [ssl_accept_server_cert_store_password](#ssl_accept_server_cert_store_password-property-as4client-struct) | 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](#ssl_accept_server_cert_store_type-property-as4client-struct) | The type of certificate store for this certificate. | | [ssl_accept_server_cert_subject_alt_names](#ssl_accept_server_cert_subject_alt_names-property-as4client-struct) | Comma-separated lists of alternative subject names for the certificate. | | [ssl_accept_server_cert_thumbprint_md5](#ssl_accept_server_cert_thumbprint_md5-property-as4client-struct) | The MD5 hash of the certificate. | | [ssl_accept_server_cert_thumbprint_sha1](#ssl_accept_server_cert_thumbprint_sha1-property-as4client-struct) | The SHA-1 hash of the certificate. | | [ssl_accept_server_cert_thumbprint_sha256](#ssl_accept_server_cert_thumbprint_sha256-property-as4client-struct) | The SHA-256 hash of the certificate. | | [ssl_accept_server_cert_usage](#ssl_accept_server_cert_usage-property-as4client-struct) | The text description of UsageFlags . | | [ssl_accept_server_cert_usage_flags](#ssl_accept_server_cert_usage_flags-property-as4client-struct) | The flags that show intended use for the certificate. | | [ssl_accept_server_cert_version](#ssl_accept_server_cert_version-property-as4client-struct) | The certificate's version number. | | [ssl_accept_server_cert_subject](#ssl_accept_server_cert_subject-property-as4client-struct) | The subject of the certificate used for client authentication. | | [ssl_accept_server_cert_encoded](#ssl_accept_server_cert_encoded-property-as4client-struct) | The certificate (PEM/Base64 encoded). | | [ssl_cert_effective_date](#ssl_cert_effective_date-property-as4client-struct) | The date on which this certificate becomes valid. | | [ssl_cert_expiration_date](#ssl_cert_expiration_date-property-as4client-struct) | The date on which the certificate expires. | | [ssl_cert_extended_key_usage](#ssl_cert_extended_key_usage-property-as4client-struct) | A comma-delimited list of extended key usage identifiers. | | [ssl_cert_fingerprint](#ssl_cert_fingerprint-property-as4client-struct) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [ssl_cert_fingerprint_sha1](#ssl_cert_fingerprint_sha1-property-as4client-struct) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [ssl_cert_fingerprint_sha256](#ssl_cert_fingerprint_sha256-property-as4client-struct) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [ssl_cert_issuer](#ssl_cert_issuer-property-as4client-struct) | The issuer of the certificate. | | [ssl_cert_private_key](#ssl_cert_private_key-property-as4client-struct) | The private key of the certificate (if available). | | [ssl_cert_private_key_available](#ssl_cert_private_key_available-property-as4client-struct) | Whether a PrivateKey is available for the selected certificate. | | [ssl_cert_private_key_container](#ssl_cert_private_key_container-property-as4client-struct) | The name of the PrivateKey container for the certificate (if available). | | [ssl_cert_public_key](#ssl_cert_public_key-property-as4client-struct) | The public key of the certificate. | | [ssl_cert_public_key_algorithm](#ssl_cert_public_key_algorithm-property-as4client-struct) | The textual description of the certificate's public key algorithm. | | [ssl_cert_public_key_length](#ssl_cert_public_key_length-property-as4client-struct) | The length of the certificate's public key (in bits). | | [ssl_cert_serial_number](#ssl_cert_serial_number-property-as4client-struct) | The serial number of the certificate encoded as a string. | | [ssl_cert_signature_algorithm](#ssl_cert_signature_algorithm-property-as4client-struct) | The text description of the certificate's signature algorithm. | | [ssl_cert_store](#ssl_cert_store-property-as4client-struct) | The name of the certificate store for the client certificate. | | [ssl_cert_store_password](#ssl_cert_store_password-property-as4client-struct) | 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](#ssl_cert_store_type-property-as4client-struct) | The type of certificate store for this certificate. | | [ssl_cert_subject_alt_names](#ssl_cert_subject_alt_names-property-as4client-struct) | Comma-separated lists of alternative subject names for the certificate. | | [ssl_cert_thumbprint_md5](#ssl_cert_thumbprint_md5-property-as4client-struct) | The MD5 hash of the certificate. | | [ssl_cert_thumbprint_sha1](#ssl_cert_thumbprint_sha1-property-as4client-struct) | The SHA-1 hash of the certificate. | | [ssl_cert_thumbprint_sha256](#ssl_cert_thumbprint_sha256-property-as4client-struct) | The SHA-256 hash of the certificate. | | [ssl_cert_usage](#ssl_cert_usage-property-as4client-struct) | The text description of UsageFlags . | | [ssl_cert_usage_flags](#ssl_cert_usage_flags-property-as4client-struct) | The flags that show intended use for the certificate. | | [ssl_cert_version](#ssl_cert_version-property-as4client-struct) | The certificate's version number. | | [ssl_cert_subject](#ssl_cert_subject-property-as4client-struct) | The subject of the certificate used for client authentication. | | [ssl_cert_encoded](#ssl_cert_encoded-property-as4client-struct) | The certificate (PEM/Base64 encoded). | | [ssl_provider](#ssl_provider-property-as4client-struct) | The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. | | [ssl_server_cert_effective_date](#ssl_server_cert_effective_date-property-as4client-struct) | The date on which this certificate becomes valid. | | [ssl_server_cert_expiration_date](#ssl_server_cert_expiration_date-property-as4client-struct) | The date on which the certificate expires. | | [ssl_server_cert_extended_key_usage](#ssl_server_cert_extended_key_usage-property-as4client-struct) | A comma-delimited list of extended key usage identifiers. | | [ssl_server_cert_fingerprint](#ssl_server_cert_fingerprint-property-as4client-struct) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [ssl_server_cert_fingerprint_sha1](#ssl_server_cert_fingerprint_sha1-property-as4client-struct) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [ssl_server_cert_fingerprint_sha256](#ssl_server_cert_fingerprint_sha256-property-as4client-struct) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [ssl_server_cert_issuer](#ssl_server_cert_issuer-property-as4client-struct) | The issuer of the certificate. | | [ssl_server_cert_private_key](#ssl_server_cert_private_key-property-as4client-struct) | The private key of the certificate (if available). | | [ssl_server_cert_private_key_available](#ssl_server_cert_private_key_available-property-as4client-struct) | Whether a PrivateKey is available for the selected certificate. | | [ssl_server_cert_private_key_container](#ssl_server_cert_private_key_container-property-as4client-struct) | The name of the PrivateKey container for the certificate (if available). | | [ssl_server_cert_public_key](#ssl_server_cert_public_key-property-as4client-struct) | The public key of the certificate. | | [ssl_server_cert_public_key_algorithm](#ssl_server_cert_public_key_algorithm-property-as4client-struct) | The textual description of the certificate's public key algorithm. | | [ssl_server_cert_public_key_length](#ssl_server_cert_public_key_length-property-as4client-struct) | The length of the certificate's public key (in bits). | | [ssl_server_cert_serial_number](#ssl_server_cert_serial_number-property-as4client-struct) | The serial number of the certificate encoded as a string. | | [ssl_server_cert_signature_algorithm](#ssl_server_cert_signature_algorithm-property-as4client-struct) | The text description of the certificate's signature algorithm. | | [ssl_server_cert_store](#ssl_server_cert_store-property-as4client-struct) | The name of the certificate store for the client certificate. | | [ssl_server_cert_store_password](#ssl_server_cert_store_password-property-as4client-struct) | 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](#ssl_server_cert_store_type-property-as4client-struct) | The type of certificate store for this certificate. | | [ssl_server_cert_subject_alt_names](#ssl_server_cert_subject_alt_names-property-as4client-struct) | Comma-separated lists of alternative subject names for the certificate. | | [ssl_server_cert_thumbprint_md5](#ssl_server_cert_thumbprint_md5-property-as4client-struct) | The MD5 hash of the certificate. | | [ssl_server_cert_thumbprint_sha1](#ssl_server_cert_thumbprint_sha1-property-as4client-struct) | The SHA-1 hash of the certificate. | | [ssl_server_cert_thumbprint_sha256](#ssl_server_cert_thumbprint_sha256-property-as4client-struct) | The SHA-256 hash of the certificate. | | [ssl_server_cert_usage](#ssl_server_cert_usage-property-as4client-struct) | The text description of UsageFlags . | | [ssl_server_cert_usage_flags](#ssl_server_cert_usage_flags-property-as4client-struct) | The flags that show intended use for the certificate. | | [ssl_server_cert_version](#ssl_server_cert_version-property-as4client-struct) | The certificate's version number. | | [ssl_server_cert_subject](#ssl_server_cert_subject-property-as4client-struct) | The subject of the certificate used for client authentication. | | [ssl_server_cert_encoded](#ssl_server_cert_encoded-property-as4client-struct) | The certificate (PEM/Base64 encoded). | | [timeout](#timeout-property-as4client-struct) | The timeout for the struct. | | [token_password](#token_password-property-as4client-struct) | The password used in UsernameToken authentication. | | [token_password_type](#token_password_type-property-as4client-struct) | The password type used in UsernameToken authentication. | | [token_user](#token_user-property-as4client-struct) | The username used in UsernameToken authentication. | | [url](#url-property-as4client-struct) | The URL to which the request is made. | ## 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](#config-method-as4client-struct) | Sets or retrieves a configuration setting. | | [do_events](#do_events-method-as4client-struct) | This method processes events from the internal message queue. | | [interrupt](#interrupt-method-as4client-struct) | This method interrupts the current method. | | [receive_files](#receive_files-method-as4client-struct) | Connects to a server to receive files. | | [reset](#reset-method-as4client-struct) | Resets the state of the control. | | [send_files](#send_files-method-as4client-struct) | Sends file(s) to the specified server and verify the receipt (if present). | | [send_receipt](#send_receipt-method-as4client-struct) | Sends an asynchronous 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_connected](#on_connected-event-as4client-struct) | Fired immediately after a connection completes (or fails). | | [on_disconnected](#on_disconnected-event-as4client-struct) | Fired when a connection is closed. | | [on_end_transfer](#on_end_transfer-event-as4client-struct) | Fired when a document finishes transferring. | | [on_error](#on_error-event-as4client-struct) | Fired when information is available about errors during data delivery. | | [on_header](#on_header-event-as4client-struct) | Fired every time a header line comes in. | | [on_log](#on_log-event-as4client-struct) | Fired with log information while processing a message. | | [on_recipient_info](#on_recipient_info-event-as4client-struct) | Fired for each recipient certificate of the encrypted message. | | [on_set_cookie](#on_set_cookie-event-as4client-struct) | Fired for every cookie set by the server. | | [on_signer_cert_info](#on_signer_cert_info-event-as4client-struct) | This event is fired during verification of the signed message. | | [on_ssl_server_authentication](#on_ssl_server_authentication-event-as4client-struct) | Fired after the server presents its certificate to the client. | | [on_ssl_status](#on_ssl_status-event-as4client-struct) | Fired when secure connection progress messages are available. | | [on_start_transfer](#on_start_transfer-event-as4client-struct) | Fired when a document starts transferring (after the headers). | | [on_token_authentication](#on_token_authentication-event-as4client-struct) | Fired when the server makes use of UsernameToken authentication. | | [on_transfer](#on_transfer-event-as4client-struct) | Fired while a document transfers (delivers document). | ## Config Settings *The following is a list of config settings for the struct with short descriptions. Click on the links for further details.* | | | | --- | --- | | [AgreementRefPMode](#AgreementRefPMode) | AgreementRef PMode of message. | | [AgreementRefType](#AgreementRefType) | The type of AgreementRef. | | [AllowWarnings](#AllowWarnings) | Whether warnings are interpreted as fatal errors. | | [AttachXMLFiles](#AttachXMLFiles) | Whether to send XML files as attachments or within the SOAP body. | | [Authorization](#Authorization) | The Authorization string to be sent to the server. | | [AuthScheme](#AuthScheme) | The authorization scheme to be used when server authorization is to be performed. | | [CloseStreamAfterProcessing](#CloseStreamAfterProcessing) | Whether to close the input or output stream after processing. | | [CompressXMLPayloads](#CompressXMLPayloads) | Whether to compress XML data. | | [ContentTransferEncoding](#ContentTransferEncoding) | The content encoding of the payload data. | | [DetectDuplicates](#DetectDuplicates) | Whether to detect duplicate messages when receiving. | | [EBPrefix](#EBPrefix) | Specifies the prefix to use for messaging. | | [EDIDataPartId\[i\]](#EDIDataPartId[i]) | Specified the part Id at the given index. | | [EnableTokenReferenceTokenType](#EnableTokenReferenceTokenType) | Whether to include the TokenType attribute in a SecurityTokenReference element. | | [EncryptionSecurityTokenFormat](#EncryptionSecurityTokenFormat) | The format to use for the security token when encryption. | | [FilenameProperty](#FilenameProperty) | Defines a part property to hold the filename. | | [ForceSigningCert](#ForceSigningCert) | Whether to force only the SigningCert to be used for signing. | | [FromId\[i\]](#FromId[i]) | The Id of the party specified by AS4From. | | [FromIdCount](#FromIdCount) | The number of Ids for the party specified by AS4From. | | [FromIdType\[i\]](#FromIdType[i]) | The Id type of the party specified by AS4From. | | [IdRight](#IdRight) | A custom Id for the right side of the MessageId. | | [IncludeEBPrefixList](#IncludeEBPrefixList) | Whether the eb3 namespace prefix is included in the signature's InclusiveNamespaces list. | | [IncludeHeaders](#IncludeHeaders) | Whether headers are included when posting to a file. | | [KeyAgreementMethod](#KeyAgreementMethod) | The agreement method used for KeyWrap encryption algorithms. | | [KeyDerivationConcatKDFDigestMethod](#KeyDerivationConcatKDFDigestMethod) | The digest method used for the ConcatKDF key derivation method. | | [KeyDerivationMethod](#KeyDerivationMethod) | The key derivation method used for KeyWrap encryption algorithms. | | [KeyEncryptionAlgorithm](#KeyEncryptionAlgorithm) | The algorithm used to encrypt the key. | | [LogOptions](#LogOptions) | The information to be written to log files. | | [MessageHeaders](#MessageHeaders) | Returns the headers of the message. | | [MessageType](#MessageType) | Indicates the type of message received. | | [NormalizeIssuerSubject](#NormalizeIssuerSubject) | Whether to normalize the certificate subject within the X509Data element. | | [OAEPMGF1HashAlgorithm](#OAEPMGF1HashAlgorithm) | The MGF1 hash algorithm used when encrypting a key. | | [OAEPParams](#OAEPParams) | The hex encoded OAEP parameters to be used when encrypting a key. | | [OAEPRSAHashAlgorithm](#OAEPRSAHashAlgorithm) | The RSA hash algorithm used when encrypting a key. | | [Password](#Password) | A password if authentication is to be used. | | [PostToFile](#PostToFile) | Creates the message on disk. | | [PullAction](#PullAction) | The Action to use with selective message pulling. | | [PullAgreementRef](#PullAgreementRef) | The AgreementRef to use with selective message pulling. | | [PullRefToMessageId](#PullRefToMessageId) | The RefToMessageId to use with selective message pulling. | | [PullService](#PullService) | The Service to use with selective message pulling. | | [PullServiceType](#PullServiceType) | The ServiceType to use with selective message pulling. | | [ReferenceHashAlgorithm](#ReferenceHashAlgorithm) | The hash algorithm used to hash the data specified in the reference of a signature. | | [RequireEncryption](#RequireEncryption) | Whether encryption is required when processing received messages. | | [RequireSignature](#RequireSignature) | Whether a signature is required when processing received messages. | | [ResponseFile](#ResponseFile) | A file from which to read the response. | | [ResponseHeaders](#ResponseHeaders) | The headers for the AS4 response message. | | [RolloverCertStore](#RolloverCertStore) | The certificate store for the rollover certificate. | | [RolloverCertStorePassword](#RolloverCertStorePassword) | The certificate store for the rollover certificate. | | [RolloverCertStoreType](#RolloverCertStoreType) | The certificate store for the rollover certificate. | | [RolloverCertSubject](#RolloverCertSubject) | The certificate store for the rollover certificate. | | [SignatureHash](#SignatureHash) | The hash algorithm used to hash the data specified in signature. | | [SignerCACert](#SignerCACert) | The CA certificates that issued the signer certificate. | | [SigningSecurityTokenFormat](#SigningSecurityTokenFormat) | The format to use for the security token when signing. | | [TempPath](#TempPath) | Where temporary files are optionally written. | | [ToId\[i\]](#ToId[i]) | The Id of the party specified by AS4To. | | [ToIdCount](#ToIdCount) | The number of Ids for the party specified by AS4To. | | [ToIdType\[i\]](#ToIdType[i]) | The Id type of the party specified by AS4To. | | [TransformReceipt](#TransformReceipt) | Whether to canonicalize the received receipt. | | [UseNonce](#UseNonce) | Whether to use a nonce in UsernameToken authentication. | | [User](#User) | A user name if authentication is to be used. | | [UseTransformedXMLAttachment](#UseTransformedXMLAttachment) | Whether to send the canonicalized XML. | | [AcceptEncoding](#AcceptEncoding) | Used to tell the server which types of content encodings the client supports. | | [AllowHTTPCompression](#AllowHTTPCompression) | This property enables HTTP compression for receiving data. | | [AllowHTTPFallback](#AllowHTTPFallback) | Whether HTTP/2 connections are permitted to fallback to HTTP/1.1. | | [Append](#Append) | Whether to append data to LocalFile. | | [Authorization](#Authorization) | The Authorization string to be sent to the server. | | [BytesTransferred](#BytesTransferred) | Contains the number of bytes transferred in the response data. | | [ChunkSize](#ChunkSize) | Specifies the chunk size in bytes when using chunked encoding. | | [CompressHTTPRequest](#CompressHTTPRequest) | Set to true to compress the body of a PUT or POST request. | | [EncodeURL](#EncodeURL) | If set to True the URL will be encoded by the struct. | | [FollowRedirects](#FollowRedirects) | Determines what happens when the server issues a redirect. | | [GetOn302Redirect](#GetOn302Redirect) | If set to True the struct will perform a GET on the new location. | | [HTTP2HeadersWithoutIndexing](#HTTP2HeadersWithoutIndexing) | HTTP2 headers that should not update the dynamic header table with incremental indexing. | | [HTTPVersion](#HTTPVersion) | The version of HTTP used by the struct. | | [IfModifiedSince](#IfModifiedSince) | A date determining the maximum age of the desired document. | | [KeepAlive](#KeepAlive) | Determines whether the HTTP connection is closed after completion of the request. | | [KerberosSPN](#KerberosSPN) | The Service Principal Name for the Kerberos Domain Controller. | | [LogLevel](#LogLevel) | The level of detail that is logged. | | [MaxRedirectAttempts](#MaxRedirectAttempts) | Limits the number of redirects that are followed in a request. | | [NegotiatedHTTPVersion](#NegotiatedHTTPVersion) | The negotiated HTTP version. | | [OtherHeaders](#OtherHeaders) | Other headers as determined by the user (optional). | | [ProxyAuthorization](#ProxyAuthorization) | The authorization string to be sent to the proxy server. | | [ProxyAuthScheme](#ProxyAuthScheme) | The authorization scheme to be used for the proxy. | | [ProxyPassword](#ProxyPassword) | A password if authentication is to be used for the proxy. | | [ProxyPort](#ProxyPort) | Port for the proxy server (default 80). | | [ProxyServer](#ProxyServer) | Name or IP address of a proxy server (optional). | | [ProxyUser](#ProxyUser) | A user name if authentication is to be used for the proxy. | | [SentHeaders](#SentHeaders) | The full set of headers as sent by the client. | | [StatusCode](#StatusCode) | The status code of the last response from the server. | | [StatusLine](#StatusLine) | The first line of the last response from the server. | | [TransferredData](#TransferredData) | The contents of the last response from the server. | | [TransferredDataLimit](#TransferredDataLimit) | The maximum number of incoming bytes to be stored by the struct. | | [TransferredHeaders](#TransferredHeaders) | The full set of headers as received from the server. | | [TransferredRequest](#TransferredRequest) | The full request as sent by the client. | | [UseChunkedEncoding](#UseChunkedEncoding) | Enables or Disables HTTP chunked encoding for transfers. | | [UseIDNs](#UseIDNs) | Whether to encode hostnames to internationalized domain names. | | [UseProxyAutoConfigURL](#UseProxyAutoConfigURL) | Whether to use a Proxy auto-config file when attempting a connection. | | [UserAgent](#UserAgent) | Information about the user agent (browser). | | [ConnectionTimeout](#ConnectionTimeout) | Sets a separate timeout value for establishing a connection. | | [EnableFallback](#EnableFallback) | Whether to try the other addresses the remote host resolves to when a connection attempt fails. | | [FallbackTimeout](#FallbackTimeout) | The maximum time in milliseconds to spend on connection attempts when EnableFallback is enabled. | | [FirewallAutoDetect](#FirewallAutoDetect) | Tells the struct whether or not to automatically detect and use firewall system settings, if available. | | [FirewallHost](#FirewallHost) | Name or IP address of firewall (optional). | | [FirewallHTTPVersion](#FirewallHTTPVersion) | The HTTP version to be used when connecting through a tunneling proxy. | | [FirewallPassword](#FirewallPassword) | Password to be used if authentication is to be used when connecting through the firewall. | | [FirewallPort](#FirewallPort) | The TCP port for the FirewallHost;. | | [FirewallType](#FirewallType) | Determines the type of firewall to connect through. | | [FirewallUser](#FirewallUser) | A user name if authentication is to be used connecting through a firewall. | | [KeepAliveInterval](#KeepAliveInterval) | The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received. | | [KeepAliveTime](#KeepAliveTime) | The inactivity time in milliseconds before a TCP keep-alive packet is sent. | | [Linger](#Linger) | When set to True, connections are terminated gracefully. | | [LingerTime](#LingerTime) | Time in seconds to have the connection linger. | | [LocalHost](#LocalHost) | The name of the local host through which connections are initiated or accepted. | | [LocalPort](#LocalPort) | The port in the local host where the struct binds. | | [MaxLineLength](#MaxLineLength) | The maximum amount of data to accumulate when no EOL is found. | | [MaxTransferRate](#MaxTransferRate) | The transfer rate limit in bytes per second. | | [ProxyExceptionsList](#ProxyExceptionsList) | A semicolon separated list of hosts and IPs to bypass when using a proxy. | | [TCPKeepAlive](#TCPKeepAlive) | Determines whether or not the keep alive socket option is enabled. | | [TcpNoDelay](#TcpNoDelay) | Whether or not to delay when sending packets. | | [UseIPv6](#UseIPv6) | Whether to use IPv6. | | [UseNTLMv2](#UseNTLMv2) | Whether to use NTLM V2. | | [LogSSLPackets](#LogSSLPackets) | Controls whether SSL packets are logged when using the internal security API. | | [OpenSSLCADir](#OpenSSLCADir) | The path to a directory containing CA certificates. | | [OpenSSLCAFile](#OpenSSLCAFile) | Name of the file containing the list of CA's trusted by your application. | | [OpenSSLCipherList](#OpenSSLCipherList) | A string that controls the ciphers to be used by SSL. | | [OpenSSLPrngSeedData](#OpenSSLPrngSeedData) | The data to seed the pseudo random number generator (PRNG). | | [ReuseSSLSession](#ReuseSSLSession) | Determines if the SSL session is reused. | | [SSLCACerts](#SSLCACerts) | A newline separated list of CA certificates to be included when performing an SSL handshake. | | [SSLCheckCRL](#SSLCheckCRL) | Whether to check the Certificate Revocation List for the server certificate. | | [SSLCheckOCSP](#SSLCheckOCSP) | Whether to use OCSP to check the status of the server certificate. | | [SSLCipherStrength](#SSLCipherStrength) | The minimum cipher strength used for bulk encryption. | | [SSLClientCACerts](#SSLClientCACerts) | A newline separated list of CA certificates to use during SSL client certificate validation. | | [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) | The cipher suite to be used in an SSL negotiation. | | [SSLEnabledProtocols](#SSLEnabledProtocols) | Used to enable/disable the supported security protocols. | | [SSLEnableRenegotiation](#SSLEnableRenegotiation) | Whether the renegotiation_info SSL extension is supported. | | [SSLIncludeCertChain](#SSLIncludeCertChain) | Whether the entire certificate chain is included in the SSLServerAuthentication event. | | [SSLKeyLogFile](#SSLKeyLogFile) | The location of a file where per-session secrets are written for debugging purposes. | | [SSLNegotiatedCipher](#SSLNegotiatedCipher) | Returns the negotiated cipher suite. | | [SSLNegotiatedCipherStrength](#SSLNegotiatedCipherStrength) | Returns the negotiated cipher suite strength. | | [SSLNegotiatedCipherSuite](#SSLNegotiatedCipherSuite) | Returns the negotiated cipher suite. | | [SSLNegotiatedKeyExchange](#SSLNegotiatedKeyExchange) | Returns the negotiated key exchange algorithm. | | [SSLNegotiatedKeyExchangeStrength](#SSLNegotiatedKeyExchangeStrength) | Returns the negotiated key exchange algorithm strength. | | [SSLNegotiatedVersion](#SSLNegotiatedVersion) | Returns the negotiated protocol version. | | [SSLSecurityFlags](#SSLSecurityFlags) | Flags that control certificate verification. | | [SSLServerCACerts](#SSLServerCACerts) | A newline separated list of CA certificates to use during SSL server certificate validation. | | [TLS12SignatureAlgorithms](#TLS12SignatureAlgorithms) | Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal. | | [TLS12SupportedGroups](#TLS12SupportedGroups) | The supported groups for ECC. | | [TLS13KeyShareGroups](#TLS13KeyShareGroups) | The groups for which to pregenerate key shares. | | [TLS13SignatureAlgorithms](#TLS13SignatureAlgorithms) | The allowed certificate signature algorithms. | | [TLS13SupportedGroups](#TLS13SupportedGroups) | The supported groups for (EC)DHE key exchange. | | [AbsoluteTimeout](#AbsoluteTimeout) | Determines whether timeouts are inactivity timeouts or absolute timeouts. | | [FirewallData](#FirewallData) | Used to send extra data to the firewall. | | [InBufferSize](#InBufferSize) | The size in bytes of the incoming queue of the socket. | | [OutBufferSize](#OutBufferSize) | The size in bytes of the outgoing queue of the socket. | | [BuildInfo](#BuildInfo) | Information about the product's build. | | [CodePage](#CodePage) | The system code page used for Unicode to Multibyte translations. | | [LicenseInfo](#LicenseInfo) | Information about the current license. | | [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. | | [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. | # agreement_ref property ([AS4Client](#struct-ipworksedias4client) Struct) The agreement reference. ## Syntax *Rust Syntax* ```text fn agreement_ref(&self ) -> Result fn set_agreement_ref(&self, value : &str) -> Option fn set_agreement_ref_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks This property holds a value identifying the agreement between the two parties. The agreement is made outside the scope of the request and response and governs details about the interaction including reply mode, signing and encryption options, etc. The value of this property should be set to a mutually agreed upon identifier. Both parties will use this value know what the expected requirements are for a particular request or response. The format of this value is typically a URI, such as "http://mycompany.com/agreement_01" but can be any unique string that both parties are configured to accept. Another common format is the concatenation of the as4_from and as4_to values. This value corresponds to the ebMS element "eb:Messaging/eb:UserMessage/eb:CollaborationInfo/eb:AgreementRef" ## Data Type String # as4_from_id property ([AS4Client](#struct-ipworksedias4client) Struct) The Id of the party. ## Syntax *Rust Syntax* ```text fn as4_from_id(&self ) -> Result fn set_as4_from_id(&self, value : &str) -> Option fn set_as4_from_id_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks The Id of the party. This value is required. This value corresponds to the ebMS element "eb:Messaging/eb:UserMessage/eb:PartyInfo/eb:From/eb:PartyId" ## Data Type String # as4_from_id_type property ([AS4Client](#struct-ipworksedias4client) Struct) The optional type of the Id. ## Syntax *Rust Syntax* ```text fn as4_from_id_type(&self ) -> Result fn set_as4_from_id_type(&self, value : &str) -> Option fn set_as4_from_id_type_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks The optional type of the Id. If specified this value should be the domain to which the Id belongs. This value corresponds to the ebMS element "eb:Messaging/eb:UserMessage/eb:PartyInfo/eb:From/eb:PartyId@type" ## Data Type String # as4_from_role property ([AS4Client](#struct-ipworksedias4client) Struct) This property specifies the role of the party. ## Syntax *Rust Syntax* ```text fn as4_from_role(&self ) -> Result fn set_as4_from_role(&self, value : &str) -> Option fn set_as4_from_role_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks This property specifies the role of the party. This may be any value agreed upon by the trading partners. In as4_from this specified the role of the party sending the document. The default value is "http://docs.oasis-open.org/ebxml-msg/ebms/v3.0/ns/core/200704/initiator". In as4_to this specifies the role of the party receiving the document. The default value is "http://docs.oasis-open.org/ebxml-msg/ebms/v3.0/ns/core/200704/responder". This value corresponds to the ebMS element "eb:Messaging/eb:UserMessage/eb:PartyInfo/eb:From/eb:Role" ## Data Type String # as4_to_id property ([AS4Client](#struct-ipworksedias4client) Struct) The Id of the party. ## Syntax *Rust Syntax* ```text fn as4_to_id(&self ) -> Result fn set_as4_to_id(&self, value : &str) -> Option fn set_as4_to_id_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks The Id of the party. This value is required. This value corresponds to the ebMS element "eb:Messaging/eb:UserMessage/eb:PartyInfo/eb:From/eb:PartyId" ## Data Type String # as4_to_id_type property ([AS4Client](#struct-ipworksedias4client) Struct) The optional type of the Id. ## Syntax *Rust Syntax* ```text fn as4_to_id_type(&self ) -> Result fn set_as4_to_id_type(&self, value : &str) -> Option fn set_as4_to_id_type_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks The optional type of the Id. If specified this value should be the domain to which the Id belongs. This value corresponds to the ebMS element "eb:Messaging/eb:UserMessage/eb:PartyInfo/eb:From/eb:PartyId@type" ## Data Type String # as4_to_role property ([AS4Client](#struct-ipworksedias4client) Struct) This property specifies the role of the party. ## Syntax *Rust Syntax* ```text fn as4_to_role(&self ) -> Result fn set_as4_to_role(&self, value : &str) -> Option fn set_as4_to_role_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks This property specifies the role of the party. This may be any value agreed upon by the trading partners. In as4_from this specified the role of the party sending the document. The default value is "http://docs.oasis-open.org/ebxml-msg/ebms/v3.0/ns/core/200704/initiator". In as4_to this specifies the role of the party receiving the document. The default value is "http://docs.oasis-open.org/ebxml-msg/ebms/v3.0/ns/core/200704/responder". This value corresponds to the ebMS element "eb:Messaging/eb:UserMessage/eb:PartyInfo/eb:From/eb:Role" ## Data Type String # async_receipt_info_dir property ([AS4Client](#struct-ipworksedias4client) Struct) A directory to hold information used for asynchronous receipt verification. ## Syntax *Rust Syntax* ```text fn async_receipt_info_dir(&self ) -> Result fn set_async_receipt_info_dir(&self, value : &str) -> Option fn set_async_receipt_info_dir_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks This setting specifies a directory which holds information about the original message that was sent. When sending files and requesting asynchronous receipts set this directory to a location where data can be stored. When the receipt is later received this property should be set so original message information can be read in order to verify the receipt. As an alternative the original message information may be manually stored by saving the values of [original_soap_message](#original_soap_message-property-as4client-struct) and [original_soap_message_id](#original_soap_message_id-property-as4client-struct) after sending a file. In this case [original_soap_message](#original_soap_message-property-as4client-struct) and [original_soap_message_id](#original_soap_message_id-property-as4client-struct) should be populated before verifying the receipt. See the [verify_receipt](AS4Server.md#AS4Server_m_VerifyReceipt) method of [AS4Server](AS4Server.md#AS4Server) for more details about verifying asynchronous receipts. ## Data Type String # cert_effective_date property ([AS4Client](#struct-ipworksedias4client) Struct) The date on which this certificate becomes valid. ## Syntax *Rust Syntax* ```text fn cert_effective_date(&self ) -> Result ``` ## 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 ([AS4Client](#struct-ipworksedias4client) Struct) The date on which the certificate expires. ## Syntax *Rust Syntax* ```text fn cert_expiration_date(&self ) -> Result ``` ## 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 ([AS4Client](#struct-ipworksedias4client) Struct) A comma-delimited list of extended key usage identifiers. ## Syntax *Rust Syntax* ```text fn cert_extended_key_usage(&self ) -> Result ``` ## 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 ([AS4Client](#struct-ipworksedias4client) Struct) The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax *Rust Syntax* ```text fn cert_fingerprint(&self ) -> Result ``` ## 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 ([AS4Client](#struct-ipworksedias4client) Struct) The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax *Rust Syntax* ```text fn cert_fingerprint_sha1(&self ) -> Result ``` ## 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 ([AS4Client](#struct-ipworksedias4client) Struct) The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax *Rust Syntax* ```text fn cert_fingerprint_sha256(&self ) -> Result ``` ## 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 ([AS4Client](#struct-ipworksedias4client) Struct) The issuer of the certificate. ## Syntax *Rust Syntax* ```text fn cert_issuer(&self ) -> Result ``` ## 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 ([AS4Client](#struct-ipworksedias4client) Struct) The private key of the certificate (if available). ## Syntax *Rust Syntax* ```text fn cert_private_key(&self ) -> Result ``` ## 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](#cert_private_key-property-as4client-struct) may be available but not exportable. In this case, [cert_private_key](#cert_private_key-property-as4client-struct) returns an empty string. This property is read-only. ## Data Type String # cert_private_key_available property ([AS4Client](#struct-ipworksedias4client) Struct) Whether a PrivateKey is available for the selected certificate. ## Syntax *Rust Syntax* ```text fn cert_private_key_available(&self ) -> Result ``` ## Default Value false ## Remarks Whether a [cert_private_key](#cert_private_key-property-as4client-struct) is available for the selected certificate. If [cert_private_key_available](#cert_private_key_available-property-as4client-struct) 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 ([AS4Client](#struct-ipworksedias4client) Struct) The name of the PrivateKey container for the certificate (if available). ## Syntax *Rust Syntax* ```text fn cert_private_key_container(&self ) -> Result ``` ## Default Value "" ## Remarks The name of the [cert_private_key](#cert_private_key-property-as4client-struct) 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 ([AS4Client](#struct-ipworksedias4client) Struct) The public key of the certificate. ## Syntax *Rust Syntax* ```text fn cert_public_key(&self ) -> Result ``` ## 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 ([AS4Client](#struct-ipworksedias4client) Struct) The textual description of the certificate's public key algorithm. ## Syntax *Rust Syntax* ```text fn cert_public_key_algorithm(&self ) -> Result ``` ## 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 ([AS4Client](#struct-ipworksedias4client) Struct) The length of the certificate's public key (in bits). ## Syntax *Rust Syntax* ```text fn cert_public_key_length(&self ) -> Result ``` ## Default Value 0 ## Remarks The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. This property is read-only. ## Data Type i32 # cert_serial_number property ([AS4Client](#struct-ipworksedias4client) Struct) The serial number of the certificate encoded as a string. ## Syntax *Rust Syntax* ```text fn cert_serial_number(&self ) -> Result ``` ## 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 ([AS4Client](#struct-ipworksedias4client) Struct) The text description of the certificate's signature algorithm. ## Syntax *Rust Syntax* ```text fn cert_signature_algorithm(&self ) -> Result ``` ## 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 ([AS4Client](#struct-ipworksedias4client) Struct) The name of the certificate store for the client certificate. ## Syntax *Rust Syntax* ```text fn cert_store(&self ) -> Result, IPWorksEDIError> fn set_cert_store(&self, value : Vec) -> Option fn set_cert_store_ref(&self, value : &[u8]) -> Option ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [cert_store_type](#cert_store_type-property-as4client-struct) property denotes the type of the certificate store specified by [cert_store](#cert_store-property-as4client-struct). If the store is password-protected, specify the password in [cert_store_password](#cert_store_password-property-as4client-struct). [cert_store](#cert_store-property-as4client-struct) is used in conjunction with the [cert_subject](#cert_subject-property-as4client-struct) property to specify client certificates. If [cert_store](#cert_store-property-as4client-struct) has a value, and [cert_subject](#cert_subject-property-as4client-struct) or [cert_encoded](#cert_encoded-property-as4client-struct) is set, a search for a certificate is initiated. Please see the [cert_subject](#cert_subject-property-as4client-struct) 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 ([AS4Client](#struct-ipworksedias4client) 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 *Rust Syntax* ```text fn cert_store_password(&self ) -> Result fn set_cert_store_password(&self, value : &str) -> Option fn set_cert_store_password_ref(&self, value : &String) -> Option ``` ## 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 ([AS4Client](#struct-ipworksedias4client) Struct) The type of certificate store for this certificate. ## Syntax *Rust Syntax* ```text fn cert_store_type(&self ) -> Result fn set_cert_store_type(&self, value : i32) -> Option ``` ## Possible Values ```text 0 // User1 // Machine2 // PFXFile3 // PFXBlob4 // JKSFile5 // JKSBlob6 // PEMKeyFile7 // PEMKeyBlob8 // PublicKeyFile9 // PublicKeyBlob10 // SSHPublicKeyBlob11 // P7BFile12 // P7BBlob13 // SSHPublicKeyFile14 // PPKFile15 // PPKBlob16 // XMLFile17 // XMLBlob18 // JWKFile19 // JWKBlob20 // SecurityKey21 // BCFKSFile22 // BCFKSBlob23 // PKCS1199 // Auto ``` ## Default Value 0 ## 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: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. | | 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. | | 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. | | 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. | | 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. | | 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. | | 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. | | 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. | | 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. | | 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. | | 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. | | 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. | | 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. | | 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. | | 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). | | 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). | | 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. | | 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. | | 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). | | 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). | | 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. | | 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. | | 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [cert_store_type](#cert_store_type-property-as4client-struct), the full path of the PKCS#11 DLL as the [cert_store](#cert_store-property-as4client-struct), and the PIN as the [cert_store_password](#cert_store_password-property-as4client-struct). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) struct by calling the [list_store_certificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [on_cert_list](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [cert_store](#cert_store-property-as4client-struct) and set [cert_store_password](#cert_store_password-property-as4client-struct) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. | ## Data Type i32 # cert_subject_alt_names property ([AS4Client](#struct-ipworksedias4client) Struct) Comma-separated lists of alternative subject names for the certificate. ## Syntax *Rust Syntax* ```text fn cert_subject_alt_names(&self ) -> Result ``` ## 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 ([AS4Client](#struct-ipworksedias4client) Struct) The MD5 hash of the certificate. ## Syntax *Rust Syntax* ```text fn cert_thumbprint_md5(&self ) -> Result ``` ## 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 ([AS4Client](#struct-ipworksedias4client) Struct) The SHA-1 hash of the certificate. ## Syntax *Rust Syntax* ```text fn cert_thumbprint_sha1(&self ) -> Result ``` ## 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 ([AS4Client](#struct-ipworksedias4client) Struct) The SHA-256 hash of the certificate. ## Syntax *Rust Syntax* ```text fn cert_thumbprint_sha256(&self ) -> Result ``` ## 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 ([AS4Client](#struct-ipworksedias4client) Struct) The text description of UsageFlags . ## Syntax *Rust Syntax* ```text fn cert_usage(&self ) -> Result ``` ## Default Value "" ## Remarks The text description of [cert_usage_flags](#cert_usage_flags-property-as4client-struct). 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 ([AS4Client](#struct-ipworksedias4client) Struct) The flags that show intended use for the certificate. ## Syntax *Rust Syntax* ```text fn cert_usage_flags(&self ) -> Result ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [cert_usage_flags](#cert_usage_flags-property-as4client-struct) 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](#cert_usage-property-as4client-struct) property for a text representation of [cert_usage_flags](#cert_usage_flags-property-as4client-struct). This functionality currently is not available when the provider is OpenSSL. This property is read-only. ## Data Type i32 # cert_version property ([AS4Client](#struct-ipworksedias4client) Struct) The certificate's version number. ## Syntax *Rust Syntax* ```text fn cert_version(&self ) -> Result ``` ## 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 ([AS4Client](#struct-ipworksedias4client) Struct) The subject of the certificate used for client authentication. ## Syntax *Rust Syntax* ```text fn cert_subject(&self ) -> Result fn set_cert_subject(&self, value : &str) -> Option fn set_cert_subject_ref(&self, value : &String) -> Option ``` ## 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 ([AS4Client](#struct-ipworksedias4client) Struct) The certificate (PEM/Base64 encoded). ## Syntax *Rust Syntax* ```text fn cert_encoded(&self ) -> Result, IPWorksEDIError> fn set_cert_encoded(&self, value : Vec) -> Option fn set_cert_encoded_ref(&self, value : &[u8]) -> Option ``` ## Default Value "" ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [cert_store](#cert_store-property-as4client-struct) and [cert_subject](#cert_subject-property-as4client-struct) properties also may be used to specify a certificate. When [cert_encoded](#cert_encoded-property-as4client-struct) is set, a search is initiated in the current [cert_store](#cert_store-property-as4client-struct) for the private key of the certificate. If the key is found, [cert_subject](#cert_subject-property-as4client-struct) is updated to reflect the full subject of the selected certificate; otherwise, [cert_subject](#cert_subject-property-as4client-struct) is set to an empty string. ## Data Type Vec # compression_format property ([AS4Client](#struct-ipworksedias4client) Struct) The compression format (if any) to use. ## Syntax *Rust Syntax* ```text fn compression_format(&self ) -> Result fn set_compression_format(&self, value : i32) -> Option ``` ## Possible Values ```text 0 // None1 // GZIP ``` ## Default Value 0 ## Remarks This setting specifies the compression format to be applied to the parts specified by [edi_data](#edi_data-property-as4client-struct). When [profile](#profile-property-as4client-struct) is set to Standard the default value is 0 (ebcfNone). When [profile](#profile-property-as4client-struct) is set to ENTSOG or eDelivery the default value is 1 (ebcfGZIP). Possible values are: - 0 (ebcfNone - default for Standard) - 1 (ebcfGZIP - default for ENTSOG and eDelivery) Note: When [profile](#profile-property-as4client-struct) is set to Standard the first [edi_data](#edi_data-property-as4client-struct) part will be included in the SOAP body if the [edi_type](#edi_type-property-as4client-struct) is "text/xml" or "application/xml". In that case since the data is included in the SOAP body it will not be compressed. When [profile](#profile-property-as4client-struct) is set to ENTSOG all [edi_data](#edi_data-property-as4client-struct) parts are compressed. ## Data Type i32 # conversation_id property ([AS4Client](#struct-ipworksedias4client) Struct) The Conversation Id of the message. ## Syntax *Rust Syntax* ```text fn conversation_id(&self ) -> Result fn set_conversation_id(&self, value : &str) -> Option fn set_conversation_id_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks This property specifies an Id that may be used to identify a set of related messages. This is required and if a value is not specified one will automatically be created. Note: When [profile](#profile-property-as4client-struct) is set to ebpfENTSOG this value will always be empty. This value corresponds to the ebMS element "eb:Messaging/eb:UserMessage/eb:CollaborationInfo/eb:ConversationId" ## Data Type String # cookie_count property ([AS4Client](#struct-ipworksedias4client) Struct) The number of records in the Cookie arrays. ## Syntax *Rust Syntax* ```text fn cookie_count(&self ) -> Result fn set_cookie_count(&self, value : i32) -> Option ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [cookie_domain](#cookie_domain-property-as4client-struct) - [cookie_expiration](#cookie_expiration-property-as4client-struct) - [cookie_name](#cookie_name-property-as4client-struct) - [cookie_path](#cookie_path-property-as4client-struct) - [cookie_secure](#cookie_secure-property-as4client-struct) - [cookie_value](#cookie_value-property-as4client-struct) The array indices start at *0* and end at *cookie_count - 1*. ## Data Type i32 # cookie_domain property ([AS4Client](#struct-ipworksedias4client) Struct) The domain of a received cookie. ## Syntax *Rust Syntax* ```text fn cookie_domain(&self , CookieIndex : i32) -> Result ``` ## Default Value "" ## Remarks The domain of a received cookie. This property contains a domain name to limit the cookie to (if provided by the server). If the server does not provide a domain name, this property will contain an empty string. The convention in this case is to use the server name specified by url_server as the cookie domain. The *CookieIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CookieCount](#cookie_count-property-as4client-struct) property. This property is read-only. ## Data Type String # cookie_expiration property ([AS4Client](#struct-ipworksedias4client) Struct) An expiration time for the cookie (if provided by the server). ## Syntax *Rust Syntax* ```text fn cookie_expiration(&self , CookieIndex : i32) -> Result ``` ## Default Value "" ## Remarks An expiration time for the cookie (if provided by the server). The time format used is "Weekday, DD-Mon-YY HH:MM:SS GMT". If the server does not provide an expiration time, this property will contain an empty string. The convention is to drop the cookie at the end of the session. The *CookieIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CookieCount](#cookie_count-property-as4client-struct) property. This property is read-only. ## Data Type String # cookie_name property ([AS4Client](#struct-ipworksedias4client) Struct) The name of the cookie. ## Syntax *Rust Syntax* ```text fn cookie_name(&self , CookieIndex : i32) -> Result fn set_cookie_name(&self, CookieIndex : i32, value : &str) -> Option fn set_cookie_name_ref(&self, CookieIndex : i32, value : &String) -> Option ``` ## Default Value "" ## Remarks The name of the cookie. This property, along with [cookie_value](#cookie_value-property-as4client-struct), stores the cookie that is to be sent to the server. The on_set_cookie event displays the cookies sent by the server and their properties. The *CookieIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CookieCount](#cookie_count-property-as4client-struct) property. ## Data Type String # cookie_path property ([AS4Client](#struct-ipworksedias4client) Struct) A path name to limit the cookie to (if provided by the server). ## Syntax *Rust Syntax* ```text fn cookie_path(&self , CookieIndex : i32) -> Result ``` ## Default Value "" ## Remarks A path name to limit the cookie to (if provided by the server). If the server does not provide a cookie path, the path property will be an empty string. The convention in this case is to use the path specified by url_path as the cookie path. The *CookieIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CookieCount](#cookie_count-property-as4client-struct) property. This property is read-only. ## Data Type String # cookie_secure property ([AS4Client](#struct-ipworksedias4client) Struct) The security flag of the received cookie. ## Syntax *Rust Syntax* ```text fn cookie_secure(&self , CookieIndex : i32) -> Result ``` ## Default Value false ## Remarks The security flag of the received cookie. This property specifies whether the cookie is secure. If the value of this property is True, the cookie value must be submitted only through a secure (HTTPS) connection. The *CookieIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CookieCount](#cookie_count-property-as4client-struct) property. This property is read-only. ## Data Type bool # cookie_value property ([AS4Client](#struct-ipworksedias4client) Struct) The value of the cookie. ## Syntax *Rust Syntax* ```text fn cookie_value(&self , CookieIndex : i32) -> Result fn set_cookie_value(&self, CookieIndex : i32, value : &str) -> Option fn set_cookie_value_ref(&self, CookieIndex : i32, value : &String) -> Option ``` ## Default Value "" ## Remarks The value of the cookie. A corresponding value is associated with the cookie specified by [cookie_name](#cookie_name-property-as4client-struct). This property holds that value. The on_set_cookie event provides the cookies set by the server. The *CookieIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CookieCount](#cookie_count-property-as4client-struct) property. ## Data Type String # edi_data_count property ([AS4Client](#struct-ipworksedias4client) Struct) The number of records in the EDI arrays. ## Syntax *Rust Syntax* ```text fn edi_data_count(&self ) -> Result fn set_edi_data_count(&self, value : i32) -> Option ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [edi_data](#edi_data-property-as4client-struct) - [edi_file_name](#edi_file_name-property-as4client-struct) - [edi_name](#edi_name-property-as4client-struct) - [edi_property_count](#edi_property_count-property-as4client-struct) - [edi_property_index](#edi_property_index-property-as4client-struct) - [edi_property_name](#edi_property_name-property-as4client-struct) - [edi_property_value](#edi_property_value-property-as4client-struct) - [edi_schema_location](#edi_schema_location-property-as4client-struct) - [edi_schema_namespace](#edi_schema_namespace-property-as4client-struct) - [edi_schema_version](#edi_schema_version-property-as4client-struct) - [edi_type](#edi_type-property-as4client-struct) The array indices start at *0* and end at *edi_data_count - 1*. ## Data Type i32 # edi_data property ([AS4Client](#struct-ipworksedias4client) Struct) This property contains the EDI payload of the transmission. ## Syntax *Rust Syntax* ```text fn edi_data(&self , EDIDataIndex : i32) -> Result, IPWorksEDIError> fn set_edi_data(&self, EDIDataIndex : i32, value : Vec) -> Option fn set_edi_data_ref(&self, EDIDataIndex : i32, value : &[u8]) -> Option ``` ## Default Value "" ## Remarks This property contains the EDI payload of the transmission. When sending files this may be specified to the data to be sent. This can be used as an alternative to setting [edi_file_name](#edi_file_name-property-as4client-struct). When receiving files this will only be populated if incoming_directory and [edi_output_stream](#AS4Client_p_EDIOutputStream) have not been specified and parse_request finishes without an error. If so, **Data** will contain the full decrypted text of the EDI message. This property defines the EDI data to be sent. This may include multiple files. The *EDIDataIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [EDIDataCount](#edi_data_count-property-as4client-struct) property. ## Data Type Vec # edi_type property ([AS4Client](#struct-ipworksedias4client) Struct) The Content-Type of the EDI message. ## Syntax *Rust Syntax* ```text fn edi_type(&self , EDIDataIndex : i32) -> Result fn set_edi_type(&self, EDIDataIndex : i32, value : &str) -> Option fn set_edi_type_ref(&self, EDIDataIndex : i32, value : &String) -> Option ``` ## Default Value "" ## Remarks The Content-Type of the EDI message. Sample values are "application/edi-x12", "application/edifact" or "application/xml". The *EDIDataIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [EDIDataCount](#edi_data_count-property-as4client-struct) property. ## Data Type String # edi_file_name property ([AS4Client](#struct-ipworksedias4client) Struct) When sending, if FileName is specified, the file specified will be used for the EDI payload of the transmission. ## Syntax *Rust Syntax* ```text fn edi_file_name(&self , EDIDataIndex : i32) -> Result fn set_edi_file_name(&self, EDIDataIndex : i32, value : &str) -> Option fn set_edi_file_name_ref(&self, EDIDataIndex : i32, value : &String) -> Option ``` ## Default Value "" ## Remarks When sending, if [edi_file_name](#edi_file_name-property-as4client-struct) is specified, the file specified will be used for the EDI payload of the transmission. [edi_name](#edi_name-property-as4client-struct) will be populated with the name of the file. When receiving, if incoming_directory is set, this will be populated with the name of the file which contains the processed message contents. Note: When [edi_output_stream](#AS4Client_p_EDIOutputStream) is set, the data will be written to the stream and this property will not be populated. The *EDIDataIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [EDIDataCount](#edi_data_count-property-as4client-struct) property. ## Data Type String # edi_name property ([AS4Client](#struct-ipworksedias4client) Struct) Name is the final name to be associated with the contents of either the Data or FileName properties. ## Syntax *Rust Syntax* ```text fn edi_name(&self , EDIDataIndex : i32) -> Result fn set_edi_name(&self, EDIDataIndex : i32, value : &str) -> Option fn set_edi_name_ref(&self, EDIDataIndex : i32, value : &String) -> Option ``` ## Default Value "rfc1767.edi" ## Remarks [edi_name](#edi_name-property-as4client-struct) is the final name to be associated with the contents of either the [edi_data](#edi_data-property-as4client-struct) or [edi_file_name](#edi_file_name-property-as4client-struct) 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](#edi_name-property-as4client-struct) will be set to the same value as [edi_file_name](#edi_file_name-property-as4client-struct), but can be overridden after setting [edi_file_name](#edi_file_name-property-as4client-struct) to indicate that another name should be used in the outbound request's Content-Disposition MIME header. When receiving EDI data, [edi_name](#edi_name-property-as4client-struct) will be read out of the "filename" attribute of the inbound request's Content-Disposition MIME header. The *EDIDataIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [EDIDataCount](#edi_data_count-property-as4client-struct) property. ## Data Type String # edi_property_count property ([AS4Client](#struct-ipworksedias4client) Struct) The number of properties for this file. ## Syntax *Rust Syntax* ```text fn edi_property_count(&self , EDIDataIndex : i32) -> Result fn set_edi_property_count(&self, EDIDataIndex : i32, value : i32) -> Option ``` ## Default Value 0 ## Remarks The number of properties for this file. Each file may contain zero or more properties associated with it. This property, in conjunction with [edi_property_index](#edi_property_index-property-as4client-struct), [edi_property_name](#edi_property_name-property-as4client-struct), and [edi_property_value](#edi_property_value-property-as4client-struct) can be used to specify properties when sending and read properties when receiving. **Sending** When sending files to add properties set [edi_property_count](#edi_property_count-property-as4client-struct) to specify the number of properties. Then set [edi_property_index](#edi_property_index-property-as4client-struct) to select the property. Set [edi_property_name](#edi_property_name-property-as4client-struct) and [edi_property_value](#edi_property_value-property-as4client-struct) to define the values for the property at [edi_property_index](#edi_property_index-property-as4client-struct). For instance: ```text data = new EBData(); data.EDIType = "image/jpeg"; data.FileName = "..\\1.jpg"; data.Name = "1.jpg"; data.PropertyCount = 2; //Define two properties data.PropertyIndex = 0; //Select the first property data.PropertyName = "name1"; data.PropertyValue = "value1"; data.PropertyIndex = 1; //Select the second property data.PropertyName = "name2"; data.PropertyValue = "value2"; ``` **Receiving** When receiving files these properties may be queried to retrieve the values set by the sender. Inspect [edi_property_count](#edi_property_count-property-as4client-struct) to obtain the number of properties. Next set [edi_property_index](#edi_property_index-property-as4client-struct) to select a property and query [edi_property_name](#edi_property_name-property-as4client-struct) and [edi_property_value](#edi_property_value-property-as4client-struct). For instance: ```text for (int i = 0; i < server.EDIData[0].PropertyCount;i++) { server.EDIData[0].PropertyIndex = i; Console.WriteLine(server.EDIData[0].PropertyName + ": " + server.EDIData[0].PropertyValue); } ``` The *EDIDataIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [EDIDataCount](#edi_data_count-property-as4client-struct) property. ## Data Type i32 # edi_property_index property ([AS4Client](#struct-ipworksedias4client) Struct) Selects a property at the specified index. ## Syntax *Rust Syntax* ```text fn edi_property_index(&self , EDIDataIndex : i32) -> Result fn set_edi_property_index(&self, EDIDataIndex : i32, value : i32) -> Option ``` ## Default Value 0 ## Remarks Selects a property at the specified index. The *EDIDataIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [EDIDataCount](#edi_data_count-property-as4client-struct) property. ## Data Type i32 # edi_property_name property ([AS4Client](#struct-ipworksedias4client) Struct) The name of the property. ## Syntax *Rust Syntax* ```text fn edi_property_name(&self , EDIDataIndex : i32) -> Result fn set_edi_property_name(&self, EDIDataIndex : i32, value : &str) -> Option fn set_edi_property_name_ref(&self, EDIDataIndex : i32, value : &String) -> Option ``` ## Default Value "" ## Remarks The name of the property. The *EDIDataIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [EDIDataCount](#edi_data_count-property-as4client-struct) property. ## Data Type String # edi_property_value property ([AS4Client](#struct-ipworksedias4client) Struct) The value of the property. ## Syntax *Rust Syntax* ```text fn edi_property_value(&self , EDIDataIndex : i32) -> Result fn set_edi_property_value(&self, EDIDataIndex : i32, value : &str) -> Option fn set_edi_property_value_ref(&self, EDIDataIndex : i32, value : &String) -> Option ``` ## Default Value "" ## Remarks The value of the property. The *EDIDataIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [EDIDataCount](#edi_data_count-property-as4client-struct) property. ## Data Type String # edi_schema_location property ([AS4Client](#struct-ipworksedias4client) Struct) The SchemaLocation , SchemaNamespace , and SchemaVersion optionally define the schema that applies to this particular file. ## Syntax *Rust Syntax* ```text fn edi_schema_location(&self , EDIDataIndex : i32) -> Result fn set_edi_schema_location(&self, EDIDataIndex : i32, value : &str) -> Option fn set_edi_schema_location_ref(&self, EDIDataIndex : i32, value : &String) -> Option ``` ## Default Value "" ## Remarks The [edi_schema_location](#edi_schema_location-property-as4client-struct), [edi_schema_namespace](#edi_schema_namespace-property-as4client-struct), and [edi_schema_version](#edi_schema_version-property-as4client-struct) optionally define the schema that applies to this particular file. This may be used by the receiving party to properly interpret the file data. Schema information is not required, but if schema information is included [edi_schema_location](#edi_schema_location-property-as4client-struct) is required and must be set to the URI of the schema. This value corresponds to the ebMS element "eb:Messaging/eb:UserMessage/eb:PayloadInfo/eb:PartInfo/eb:Schema@location" The *EDIDataIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [EDIDataCount](#edi_data_count-property-as4client-struct) property. ## Data Type String # edi_schema_namespace property ([AS4Client](#struct-ipworksedias4client) Struct) The namespace of the schema. ## Syntax *Rust Syntax* ```text fn edi_schema_namespace(&self , EDIDataIndex : i32) -> Result fn set_edi_schema_namespace(&self, EDIDataIndex : i32, value : &str) -> Option fn set_edi_schema_namespace_ref(&self, EDIDataIndex : i32, value : &String) -> Option ``` ## Default Value "" ## Remarks The namespace of the schema. This property is optional. Refer to [edi_schema_location](#edi_schema_location-property-as4client-struct) for details. This value corresponds to the ebMS element "eb:Messaging/eb:UserMessage/eb:PayloadInfo/eb:PartInfo/eb:Schema@namespace" The *EDIDataIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [EDIDataCount](#edi_data_count-property-as4client-struct) property. ## Data Type String # edi_schema_version property ([AS4Client](#struct-ipworksedias4client) Struct) The version of the schema. ## Syntax *Rust Syntax* ```text fn edi_schema_version(&self , EDIDataIndex : i32) -> Result fn set_edi_schema_version(&self, EDIDataIndex : i32, value : &str) -> Option fn set_edi_schema_version_ref(&self, EDIDataIndex : i32, value : &String) -> Option ``` ## Default Value "" ## Remarks The version of the schema. This property is optional. Refer to [edi_schema_location](#edi_schema_location-property-as4client-struct) for details. This value corresponds to the ebMS element "eb:Messaging/eb:UserMessage/eb:PayloadInfo/eb:PartInfo/eb:Schema@namespace" The *EDIDataIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [EDIDataCount](#edi_data_count-property-as4client-struct) property. ## Data Type String # encryption_algorithm property ([AS4Client](#struct-ipworksedias4client) Struct) The algorithm used to encrypt the EDI data. ## Syntax *Rust Syntax* ```text fn encryption_algorithm(&self ) -> Result fn set_encryption_algorithm(&self, value : &str) -> Option fn set_encryption_algorithm_ref(&self, value : &String) -> Option ``` ## Default Value "AES128GCM" ## Remarks If recipient_certs contains a valid certificate, the data will be encrypted using this certificate and the algorithm specified in encryption_algorithm. If encryption_algorithm is set to the empty string, the data will not be encrypted. The struct supports **"3DES"**, or industry-standard 168-bit Triple-DES encryption. The struct supports **"AES"** encryption with a default keysize of 128 bits. You may also set "AESCBC192" or "AESCBC256" for 192- and 256-bit keysizes. Possible values are: - 3DES - DES - AESCBC128 - AESCBC192 - AESCBC256 - AES128GCM (default) - AES192GCM - AES256GCM ## Data Type String # error_count property ([AS4Client](#struct-ipworksedias4client) Struct) The number of records in the Error arrays. ## Syntax *Rust Syntax* ```text fn error_count(&self ) -> Result fn set_error_count(&self, value : i32) -> Option ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [error_category](#error_category-property-as4client-struct) - [error_code](#error_code-property-as4client-struct) - [error_description](#error_description-property-as4client-struct) - [error_detail](#error_detail-property-as4client-struct) - [error_origin](#error_origin-property-as4client-struct) - [error_ref_message_id](#error_ref_message_id-property-as4client-struct) - [error_severity](#error_severity-property-as4client-struct) - [error_short_description](#error_short_description-property-as4client-struct) The array indices start at *0* and end at *error_count - 1*. ## Data Type i32 # error_category property ([AS4Client](#struct-ipworksedias4client) Struct) The category of error. ## Syntax *Rust Syntax* ```text fn error_category(&self , ErrorIndex : i32) -> Result fn set_error_category(&self, ErrorIndex : i32, value : &str) -> Option fn set_error_category_ref(&self, ErrorIndex : i32, value : &String) -> Option ``` ## Default Value "" ## Remarks The category of error. Typical values include "Content", "Packaging", "UnPackaging", "Communication", and "InternalProcess". This value is optional. The *ErrorIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ErrorCount](#error_count-property-as4client-struct) property. ## Data Type String # error_code property ([AS4Client](#struct-ipworksedias4client) Struct) The error code. ## Syntax *Rust Syntax* ```text fn error_code(&self , ErrorIndex : i32) -> Result fn set_error_code(&self, ErrorIndex : i32, value : &str) -> Option fn set_error_code_ref(&self, ErrorIndex : i32, value : &String) -> Option ``` ## Default Value "" ## Remarks The error code. This value is required. The standard format is "EBMS:0001", where "0001" is the numeric code portion. The *ErrorIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ErrorCount](#error_count-property-as4client-struct) property. ## Data Type String # error_description property ([AS4Client](#struct-ipworksedias4client) Struct) The description of the error. ## Syntax *Rust Syntax* ```text fn error_description(&self , ErrorIndex : i32) -> Result fn set_error_description(&self, ErrorIndex : i32, value : &str) -> Option fn set_error_description_ref(&self, ErrorIndex : i32, value : &String) -> Option ``` ## Default Value "" ## Remarks The description of the error. This value is optional. The *ErrorIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ErrorCount](#error_count-property-as4client-struct) property. ## Data Type String # error_detail property ([AS4Client](#struct-ipworksedias4client) Struct) Additional details about the error. ## Syntax *Rust Syntax* ```text fn error_detail(&self , ErrorIndex : i32) -> Result fn set_error_detail(&self, ErrorIndex : i32, value : &str) -> Option fn set_error_detail_ref(&self, ErrorIndex : i32, value : &String) -> Option ``` ## Default Value "" ## Remarks Additional details about the error. This may include other helpful information such as a stack trace. This value is optional. The *ErrorIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ErrorCount](#error_count-property-as4client-struct) property. ## Data Type String # error_origin property ([AS4Client](#struct-ipworksedias4client) Struct) The module within which the error occurred. ## Syntax *Rust Syntax* ```text fn error_origin(&self , ErrorIndex : i32) -> Result fn set_error_origin(&self, ErrorIndex : i32, value : &str) -> Option fn set_error_origin_ref(&self, ErrorIndex : i32, value : &String) -> Option ``` ## Default Value "" ## Remarks The module within which the error occurred. Typical values include "ebMS", "reliability", and "security". This value is optional. The *ErrorIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ErrorCount](#error_count-property-as4client-struct) property. ## Data Type String # error_ref_message_id property ([AS4Client](#struct-ipworksedias4client) Struct) The MessageId to which the error applies. ## Syntax *Rust Syntax* ```text fn error_ref_message_id(&self , ErrorIndex : i32) -> Result fn set_error_ref_message_id(&self, ErrorIndex : i32, value : &str) -> Option fn set_error_ref_message_id_ref(&self, ErrorIndex : i32, value : &String) -> Option ``` ## Default Value "" ## Remarks The MessageId to which the error applies. This is optional but should be supplied if possible. The *ErrorIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ErrorCount](#error_count-property-as4client-struct) property. ## Data Type String # error_severity property ([AS4Client](#struct-ipworksedias4client) Struct) The severity of the error. ## Syntax *Rust Syntax* ```text fn error_severity(&self , ErrorIndex : i32) -> Result fn set_error_severity(&self, ErrorIndex : i32, value : i32) -> Option ``` ## Possible Values ```text 0 // Warning1 // Failure ``` ## Default Value 0 ## Remarks The severity of the error. Possible values are: - 0 (ebstWarning - default) - 1 (ebstFailure) This value is required. The *ErrorIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ErrorCount](#error_count-property-as4client-struct) property. ## Data Type i32 # error_short_description property ([AS4Client](#struct-ipworksedias4client) Struct) A short description of the error. ## Syntax *Rust Syntax* ```text fn error_short_description(&self , ErrorIndex : i32) -> Result fn set_error_short_description(&self, ErrorIndex : i32, value : &str) -> Option fn set_error_short_description_ref(&self, ErrorIndex : i32, value : &String) -> Option ``` ## Default Value "" ## Remarks A short description of the error. This may be helpful for logging or readability. This value is optional. The *ErrorIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ErrorCount](#error_count-property-as4client-struct) property. ## Data Type String # firewall_auto_detect property ([AS4Client](#struct-ipworksedias4client) Struct) Whether to automatically detect and use firewall system settings, if available. ## Syntax *Rust Syntax* ```text fn firewall_auto_detect(&self ) -> Result fn set_firewall_auto_detect(&self, value : bool) -> Option ``` ## Default Value false ## Remarks Whether to automatically detect and use firewall system settings, if available. ## Data Type bool # firewall_type property ([AS4Client](#struct-ipworksedias4client) Struct) The type of firewall to connect through. ## Syntax *Rust Syntax* ```text fn firewall_type(&self ) -> Result fn set_firewall_type(&self, value : i32) -> Option ``` ## Possible Values ```text 0 // None1 // Tunnel2 // SOCKS43 // SOCKS510 // SOCKS4A ``` ## Default Value 0 ## 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](#firewall_port-property-as4client-struct) is set to 80. | | fwSOCKS4 (2) | Connect through a SOCKS4 Proxy. [firewall_port](#firewall_port-property-as4client-struct) is set to 1080. | | fwSOCKS5 (3) | Connect through a SOCKS5 Proxy. [firewall_port](#firewall_port-property-as4client-struct) is set to 1080. | | fwSOCKS4A (10) | Connect through a SOCKS4A Proxy. [firewall_port](#firewall_port-property-as4client-struct) is set to 1080. | ## Data Type i32 # firewall_host property ([AS4Client](#struct-ipworksedias4client) Struct) The name or IP address of the firewall (optional). ## Syntax *Rust Syntax* ```text fn firewall_host(&self ) -> Result fn set_firewall_host(&self, value : &str) -> Option fn set_firewall_host_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks The name or IP address of the firewall (optional). If a [firewall_host](#firewall_host-property-as4client-struct) 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 ([AS4Client](#struct-ipworksedias4client) Struct) A password if authentication is to be used when connecting through the firewall. ## Syntax *Rust Syntax* ```text fn firewall_password(&self ) -> Result fn set_firewall_password(&self, value : &str) -> Option fn set_firewall_password_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks A password if authentication is to be used when connecting through the firewall. If [firewall_host](#firewall_host-property-as4client-struct) is specified, the [firewall_user](#firewall_user-property-as4client-struct) and [firewall_password](#firewall_password-property-as4client-struct) 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 ([AS4Client](#struct-ipworksedias4client) Struct) The Transmission Control Protocol (TCP) port for the firewall Host . ## Syntax *Rust Syntax* ```text fn firewall_port(&self ) -> Result fn set_firewall_port(&self, value : i32) -> Option ``` ## Default Value 0 ## Remarks The Transmission Control Protocol (TCP) port for the firewall [firewall_host](#firewall_host-property-as4client-struct). See the description of the [firewall_host](#firewall_host-property-as4client-struct) property for details. NOTE: This property is set automatically when [firewall_firewall_type](#AS4Client_p_FirewallFirewallType) is set to a valid value. See the description of the [firewall_firewall_type](#AS4Client_p_FirewallFirewallType) property for details. ## Data Type i32 # firewall_user property ([AS4Client](#struct-ipworksedias4client) Struct) A username if authentication is to be used when connecting through a firewall. ## Syntax *Rust Syntax* ```text fn firewall_user(&self ) -> Result fn set_firewall_user(&self, value : &str) -> Option fn set_firewall_user_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks A username if authentication is to be used when connecting through a firewall. If [firewall_host](#firewall_host-property-as4client-struct) is specified, this property and the [firewall_password](#firewall_password-property-as4client-struct) property are used to connect and authenticate to the given [Firewall](#Type_Firewall). If the authentication fails, the struct fails with an error. ## Data Type String # incoming_directory property ([AS4Client](#struct-ipworksedias4client) Struct) The directory to which incoming files are saved. ## Syntax *Rust Syntax* ```text fn incoming_directory(&self ) -> Result fn set_incoming_directory(&self, value : &str) -> Option fn set_incoming_directory_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks If incoming_directory is set, the received files will be stored in the specified directory. If a filename is specified in the EDI message, the component will write to the specified filename, otherwise, a filename will be automatically generated based on a timestamp of the incoming transmission. In either case, if the filename exists on disk, the data will be written to the same name with a "-duplicate?" appended to the filename, where "?" is the number of duplicates. This property is optional, if not set file data will be stored in [edi_data](#edi_data-property-as4client-struct). ## Data Type String # local_host property ([AS4Client](#struct-ipworksedias4client) Struct) The name of the local host or user-assigned IP interface through which connections are initiated or accepted. ## Syntax *Rust Syntax* ```text fn local_host(&self ) -> Result fn set_local_host(&self, value : &str) -> Option fn set_local_host_ref(&self, value : &String) -> Option ``` ## 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 ([AS4Client](#struct-ipworksedias4client) Struct) The path to a directory for logging. ## Syntax *Rust Syntax* ```text fn log_directory(&self ) -> Result fn set_log_directory(&self, value : &str) -> Option fn set_log_directory_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks Setting log_directory will instruct the component to log the details of each transmission to unique files in the specified directory. For each request processed, the struct will log the complete text of the outgoing request and the incoming response. The struct will write multiple log files for each transmission, with separate extensions for each type of data: | | | | --- | --- | | Status (.log) | Contains information about the steps taken during processing. | | Request (.out) | Contains the raw request/response that is sent by the struct. | | Response (.in) | Contains the raw request/response that is received by the struct. | | Incoming ebXML (.ieb) | Contains the incoming ebXML message. | | Outgoing ebXML (.oeb) | Contains the outgoing ebXML message. | One or more of these log files may be disabled by setting the [LogOptions](#LogOptions) configuration setting. log_directory supports several macros that can be used to specify a unique directory path. If the path specified does not already exist, the struct will attempt to create the directory. The following macros are supported: | | | | --- | --- | | %AS4From% | The AS4From value in the message. Note that invalid filename characters will be replaced with the _ character. | | %MessageId% | The MessageId of the transmission, after it is generated. | | %Date:format% | Format is a platform-specific date/time formatting string. For example: | 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](#log_file-property-as4client-struct) will contain the name of the files just written, minus the extension. If logs cannot be written an exception will be thrown. ## Data Type String # log_file property ([AS4Client](#struct-ipworksedias4client) Struct) The log file written. ## Syntax *Rust Syntax* ```text fn log_file(&self ) -> Result ``` ## Default Value "" ## Remarks If [log_directory](#log_directory-property-as4client-struct) is specified a log file will be written in the specified directory and log_file will contain the full path and name of the files written, minus the extension. The struct will write multiple log files for each transmission, with separate extensions for each type of data: | | | | --- | --- | | Status (.log) | Contains information about the steps taken during processing. | | Request (.out) | Contains the raw request/response that is sent by the struct. | | Response (.in) | Contains the raw request/response that is received by the struct. | | Incoming ebXML (.ieb) | Contains the incoming ebXML message. | | Outgoing ebXML (.oeb) | Contains the outgoing ebXML message. | One or more of these log files may be disabled by setting the [LogOptions](#LogOptions) configuration setting. [log_directory](#log_directory-property-as4client-struct) supports several macros that can be used to specify a unique directory path. If the path specified does not already exist, the struct will attempt to create the directory. The following macros are supported: | | | | --- | --- | | %AS4From% | The AS4From value in the message. Note that invalid filename characters will be replaced with the _ character. | | %MessageId% | The MessageId of the transmission, after it is generated. | | %Date:format% | Format is a platform-specific date/time formatting string. For example: | 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. If logs cannot be written an exception will be thrown. This property is read-only. ## Data Type String # message_id property ([AS4Client](#struct-ipworksedias4client) Struct) The unique Id of the message. ## Syntax *Rust Syntax* ```text fn message_id(&self ) -> Result fn set_message_id(&self, value : &str) -> Option fn set_message_id_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks This property defines the unique Id of the message. When sending files the struct will automatically generate a value in the format "GUID@nsoftware". When receiving files the Id will be populated with the value read from the message. In most cases there is no need to set this value, however if a file needs to be retransmitted using the same message Id for reliability this may be set. In [AS4Client](#struct-ipworksedias4client) this may be set before calling [send_files](#send_files-method-as4client-struct). In [AS4Server](AS4Server.md#AS4Server) this may be set after calling [read_request](AS4Server.md#AS4Server_m_ReadRequest) and before calling [send_response](AS4Server.md#AS4Server_m_SendResponse). ## Data Type String # message_property_count property ([AS4Client](#struct-ipworksedias4client) Struct) The number of records in the MessageProperty arrays. ## Syntax *Rust Syntax* ```text fn message_property_count(&self ) -> Result fn set_message_property_count(&self, value : i32) -> Option ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [message_property_name](#message_property_name-property-as4client-struct) - [message_property_property_type](#message_property_property_type-property-as4client-struct) - [message_property_value](#message_property_value-property-as4client-struct) The array indices start at *0* and end at *message_property_count - 1*. ## Data Type i32 # message_property_name property ([AS4Client](#struct-ipworksedias4client) Struct) This property defines the name of the message property. ## Syntax *Rust Syntax* ```text fn message_property_name(&self , MessagePropertyIndex : i32) -> Result fn set_message_property_name(&self, MessagePropertyIndex : i32, value : &str) -> Option fn set_message_property_name_ref(&self, MessagePropertyIndex : i32, value : &String) -> Option ``` ## Default Value "" ## Remarks This property defines the name of the message property. This is required. This value corresponds to the ebMS element "eb:Messaging/eb:UserMessage/eb:MessageProperties/eb:Property/@Name" The *MessagePropertyIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [MessagePropertyCount](#message_property_count-property-as4client-struct) property. ## Data Type String # message_property_property_type property ([AS4Client](#struct-ipworksedias4client) Struct) The optional type of the message property. ## Syntax *Rust Syntax* ```text fn message_property_property_type(&self , MessagePropertyIndex : i32) -> Result fn set_message_property_property_type(&self, MessagePropertyIndex : i32, value : &str) -> Option fn set_message_property_property_type_ref(&self, MessagePropertyIndex : i32, value : &String) -> Option ``` ## Default Value "" ## Remarks The optional type of the message property. This value corresponds to the ebMS element "eb:Messaging/eb:UserMessage/eb:MessageProperties/eb:Property/@Type" The *MessagePropertyIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [MessagePropertyCount](#message_property_count-property-as4client-struct) property. ## Data Type String # message_property_value property ([AS4Client](#struct-ipworksedias4client) Struct) The value of the message property. ## Syntax *Rust Syntax* ```text fn message_property_value(&self , MessagePropertyIndex : i32) -> Result fn set_message_property_value(&self, MessagePropertyIndex : i32, value : &str) -> Option fn set_message_property_value_ref(&self, MessagePropertyIndex : i32, value : &String) -> Option ``` ## Default Value "" ## Remarks The value of the message property. This value corresponds to the ebMS element "eb:Messaging/eb:UserMessage/eb:MessageProperties/eb:Property/" The *MessagePropertyIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [MessagePropertyCount](#message_property_count-property-as4client-struct) property. ## Data Type String # mpc property ([AS4Client](#struct-ipworksedias4client) Struct) The MPC (Message Partition Channel) from which to receive files. ## Syntax *Rust Syntax* ```text fn mpc(&self ) -> Result fn set_mpc(&self, value : &str) -> Option fn set_mpc_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks This property specifies the MPC (Message Partition Channel) from which to receive files. This must be set before calling [receive_files](#receive_files-method-as4client-struct). The value specified here must be known to the other party. When left unspecified this indicates the default MPC. This value corresponds to the ebMS element "eb:Messaging/eb:SignalMessage/eb:PullRequest/@mpc" ## Data Type String # original_soap_message property ([AS4Client](#struct-ipworksedias4client) Struct) The original SOAP message used to verify the receipt. ## Syntax *Rust Syntax* ```text fn original_soap_message(&self ) -> Result fn set_original_soap_message(&self, value : &str) -> Option fn set_original_soap_message_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks original_soap_message and [original_soap_message_id](#original_soap_message_id-property-as4client-struct) may be used as an alternative to [async_receipt_info_dir](#async_receipt_info_dir-property-as4client-struct) when verifying receipts. If [async_receipt_info_dir](#async_receipt_info_dir-property-as4client-struct) is not set when the original message is sent, these values will be populated after the send and the values should be saved. Before verifying the receipt set these properties to their original values. ## Data Type String # original_soap_message_id property ([AS4Client](#struct-ipworksedias4client) Struct) The original SOAP message Id used to verify the receipt. ## Syntax *Rust Syntax* ```text fn original_soap_message_id(&self ) -> Result fn set_original_soap_message_id(&self, value : &str) -> Option fn set_original_soap_message_id_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks [original_soap_message](#original_soap_message-property-as4client-struct) and original_soap_message_id may be used as an alternative to [async_receipt_info_dir](#async_receipt_info_dir-property-as4client-struct) when verifying receipts. If [async_receipt_info_dir](#async_receipt_info_dir-property-as4client-struct) is not set when the original message is sent, these values will be populated after the send and the values should be saved. Before verifying the receipt set these properties to their original values. ## Data Type String # profile property ([AS4Client](#struct-ipworksedias4client) Struct) The AS4 profile. ## Syntax *Rust Syntax* ```text fn profile(&self ) -> Result fn set_profile(&self, value : i32) -> Option ``` ## Possible Values ```text 0 // Standard1 // ENTSOG2 // EDelivery3 // BDEW4 // ENTSOG_V45 // EDelivery_V2 ``` ## Default Value 0 ## Remarks This property specifies the AS4 profile to use. Different profiles may have different requirements and default options. Setting this property to the correct value ensures that the right options are selected in order to conform to the profile. Possible values are: | | | | --- | --- | | 0 (ebpfStandard - default) | The AS4 Profile of ebMS 3.0 Version 1.0 OASIS Standard | | 1 (ebpfENTSOG) | The ENTSOG AS4 Profile | | 2 (ebpfEDelivery) | The eDelivery AS4 Profile | | 3 (ebpfBDEW) | The BDEW AS4 Profile | | 4 (ebpfENTSOG_V4) | The ENTSOG Version 4 AS4 Profile | | 5 (ebpfEDelivery_V2) | The eDelivery Version 2 AS4 Profile | When profile is set to ebpfENTSOG the following settings are automatically applied: | | | | --- | --- | | Property | Value | | [compression_format](#compression_format-property-as4client-struct) | ebcfGZIP | | [encryption_algorithm](#encryption_algorithm-property-as4client-struct) | "AES128GCM" | | [conversation_id](#conversation_id-property-as4client-struct) | Remains empty | | [signature_algorithm](#signature_algorithm-property-as4client-struct) | "SHA256" | | [AttachXMLFiles](#AttachXMLFiles) | true | | [DetectDuplicates](#DetectDuplicates) | true | | [OAEPRSAHashAlgorithm](#OAEPRSAHashAlgorithm) | "SHA256" | | [OAEPMGF1HashAlgorithm](#OAEPMGF1HashAlgorithm) | "SHA256" | | [ReferenceHashAlgorithm](#ReferenceHashAlgorithm) | "SHA256" | When profile is set to ebpfENTSOG_V4, version 4 of the ENTSOG profile is used and the following settings are automatically applied: | | | | --- | --- | | Property | Value | | [compression_format](#compression_format-property-as4client-struct) | ebcfGZIP | | [encryption_algorithm](#encryption_algorithm-property-as4client-struct) | "AES128GCM" | | [signature_algorithm](#signature_algorithm-property-as4client-struct) | "EDDSA-ED25519" | | [AttachXMLFiles](#AttachXMLFiles) | true | | [DetectDuplicates](#DetectDuplicates) | true | | [ReferenceHashAlgorithm](#ReferenceHashAlgorithm) | "SHA256" | | [SignatureHash](#SignatureHash) | "SHA256" | | [KeyAgreementMethod](#KeyAgreementMethod) | "X25519" | | [KeyDerivationMethod](#KeyDerivationMethod) | "HKDF" | | [KeyEncryptionAlgorithm](#KeyEncryptionAlgorithm) | "KW-AES128" | | [SSLEnabledProtocols](#SSLEnabledProtocols) | "0x3C00" (TLS 1.2 and TLS 1.3) | When profile is set to ebpfEDelivery the following settings are automatically applied: | | | | --- | --- | | Property | Value | | [compression_format](#compression_format-property-as4client-struct) | ebcfGZIP | | [encryption_algorithm](#encryption_algorithm-property-as4client-struct) | "AES128GCM" | | [RequireEncryption](#RequireEncryption) | true | | [RequireSignature](#RequireSignature) | true | | [signature_algorithm](#signature_algorithm-property-as4client-struct) | "SHA256" | | [OAEPRSAHashAlgorithm](#OAEPRSAHashAlgorithm) | "SHA256" | | [OAEPMGF1HashAlgorithm](#OAEPMGF1HashAlgorithm) | "SHA256" | | [EncryptionSecurityTokenFormat](#EncryptionSecurityTokenFormat) | 1 (Binary) | | [SigningSecurityTokenFormat](#SigningSecurityTokenFormat) | 1 (Binary) | When profile is set to ebpfEDelivery_V2, version 2 of the eDelivery profile is used and the following settings are automatically applied: | | | | --- | --- | | Property | Value | | [compression_format](#compression_format-property-as4client-struct) | ebcfGZIP | | [encryption_algorithm](#encryption_algorithm-property-as4client-struct) | "AES128GCM" | | [signature_algorithm](#signature_algorithm-property-as4client-struct) | "EDDSA-ED25519" | | [AttachXMLFiles](#AttachXMLFiles) | true | | [DetectDuplicates](#DetectDuplicates) | true | | [ReferenceHashAlgorithm](#ReferenceHashAlgorithm) | "SHA256" | | [SignatureHash](#SignatureHash) | "SHA256" | | [KeyAgreementMethod](#KeyAgreementMethod) | "X25519" | | [KeyDerivationMethod](#KeyDerivationMethod) | "HKDF" | | [KeyEncryptionAlgorithm](#KeyEncryptionAlgorithm) | "KW-AES128" | | [SSLEnabledProtocols](#SSLEnabledProtocols) | "0x3C00" (TLS 1.2 and TLS 1.3) | When profile is set to ebpfBDEW the following settings are automatically applied: | | | | --- | --- | | Property | Value | | [compression_format](#compression_format-property-as4client-struct) | ebcfGZIP | | [encryption_algorithm](#encryption_algorithm-property-as4client-struct) | "AES128GCM" | | [RequireEncryption](#RequireEncryption) | true | | [RequireSignature](#RequireSignature) | true | | [signature_algorithm](#signature_algorithm-property-as4client-struct) | "ECDSASHA256" | | [EncryptionSecurityTokenFormat](#EncryptionSecurityTokenFormat) | 0 (X509) | | [SigningSecurityTokenFormat](#SigningSecurityTokenFormat) | 3 (X509PKIPathv1) | | [ForceSigningCert](#ForceSigningCert) | true | | [KeyEncryptionAlgorithm](#KeyEncryptionAlgorithm) | KW-AES128 | | [KeyAgreementMethod](#KeyAgreementMethod) | ECDH-ES | | [KeyDerivationMethod](#KeyDerivationMethod) | ConcatKDF | | [KeyDerivationConcatKDFDigestMethod](#KeyDerivationConcatKDFDigestMethod) | SHA256 | Note: When ebpfBDEW is selected, both the SigningCert and Encryption Cert(recipientCert) MUST use ECDSA with the BrainpoolP256r1 curve. ## Data Type i32 # proxy_auth_scheme property ([AS4Client](#struct-ipworksedias4client) Struct) The type of authorization to perform when connecting to the proxy. ## Syntax *Rust Syntax* ```text fn proxy_auth_scheme(&self ) -> Result fn set_proxy_auth_scheme(&self, value : i32) -> Option ``` ## Possible Values ```text 0 // Basic1 // Digest2 // Proprietary3 // None4 // Ntlm5 // Negotiate ``` ## Default Value 0 ## Remarks The type of authorization to perform when connecting to the proxy. This is used only when the [proxy_user](#proxy_user-property-as4client-struct) and [proxy_password](#proxy_password-property-as4client-struct) properties are set. [proxy_auth_scheme](#proxy_auth_scheme-property-as4client-struct) should be set to authNone (3) when no authentication is expected. By default, [proxy_auth_scheme](#proxy_auth_scheme-property-as4client-struct) is authBasic (0), and if the [proxy_user](#proxy_user-property-as4client-struct) and [proxy_password](#proxy_password-property-as4client-struct) properties are set, the struct will attempt basic authentication. If [proxy_auth_scheme](#proxy_auth_scheme-property-as4client-struct) is set to authDigest (1), digest authentication will be attempted instead. If [proxy_auth_scheme](#proxy_auth_scheme-property-as4client-struct) is set to authProprietary (2), then the authorization token will not be generated by the struct. Look at the configuration file for the struct being used to find more information about manually setting this token. If [proxy_auth_scheme](#proxy_auth_scheme-property-as4client-struct) is set to authNtlm (4), NTLM authentication will be used. For security reasons, setting this property will clear the values of [proxy_user](#proxy_user-property-as4client-struct) and [proxy_password](#proxy_password-property-as4client-struct). ## Data Type i32 # proxy_auto_detect property ([AS4Client](#struct-ipworksedias4client) Struct) Whether to automatically detect and use proxy system settings, if available. ## Syntax *Rust Syntax* ```text fn proxy_auto_detect(&self ) -> Result fn set_proxy_auto_detect(&self, value : bool) -> Option ``` ## Default Value false ## Remarks Whether to automatically detect and use proxy system settings, if available. The default value is *false*. ## Data Type bool # proxy_password property ([AS4Client](#struct-ipworksedias4client) Struct) A password if authentication is to be used for the proxy. ## Syntax *Rust Syntax* ```text fn proxy_password(&self ) -> Result fn set_proxy_password(&self, value : &str) -> Option fn set_proxy_password_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks A password if authentication is to be used for the proxy. If [proxy_auth_scheme](#proxy_auth_scheme-property-as4client-struct) is set to Basic Authentication, the [proxy_user](#proxy_user-property-as4client-struct) and [proxy_password](#proxy_password-property-as4client-struct) properties are Base64 encoded and the proxy authentication token will be generated in the form *Basic [encoded-user-password]*. If [proxy_auth_scheme](#proxy_auth_scheme-property-as4client-struct) is set to Digest Authentication, the [proxy_user](#proxy_user-property-as4client-struct) and [proxy_password](#proxy_password-property-as4client-struct) properties are used to respond to the Digest Authentication challenge from the server. If [proxy_auth_scheme](#proxy_auth_scheme-property-as4client-struct) is set to NTLM Authentication, the [proxy_user](#proxy_user-property-as4client-struct) and [proxy_password](#proxy_password-property-as4client-struct) properties are used to authenticate through NTLM negotiation. ## Data Type String # proxy_port property ([AS4Client](#struct-ipworksedias4client) Struct) The Transmission Control Protocol (TCP) port for the proxy Server (default 80). ## Syntax *Rust Syntax* ```text fn proxy_port(&self ) -> Result fn set_proxy_port(&self, value : i32) -> Option ``` ## Default Value 80 ## Remarks The Transmission Control Protocol (TCP) port for the proxy [proxy_server](#proxy_server-property-as4client-struct) (default 80). See the description of the [proxy_server](#proxy_server-property-as4client-struct) property for details. ## Data Type i32 # proxy_server property ([AS4Client](#struct-ipworksedias4client) Struct) If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. ## Syntax *Rust Syntax* ```text fn proxy_server(&self ) -> Result fn set_proxy_server(&self, value : &str) -> Option fn set_proxy_server_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks If a proxy [proxy_server](#proxy_server-property-as4client-struct) is given, then the HTTP request is sent to the proxy instead of the server otherwise specified. If the [proxy_server](#proxy_server-property-as4client-struct) property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the [proxy_server](#proxy_server-property-as4client-struct) property is set to the corresponding address. If the search is not successful, an error is returned. ## Data Type String # proxy_ssl property ([AS4Client](#struct-ipworksedias4client) Struct) When to use a Secure Sockets Layer (SSL) for the connection to the proxy. ## Syntax *Rust Syntax* ```text fn proxy_ssl(&self ) -> Result fn set_proxy_ssl(&self, value : i32) -> Option ``` ## Possible Values ```text 0 // Automatic1 // Always2 // Never3 // Tunnel ``` ## Default Value 0 ## Remarks When to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows: | | | | --- | --- | | psAutomatic (0) | Default setting. If the URL is an https URL, the struct will use the psTunnel option. If the URL is an http URL, the struct will use the psNever option. | | psAlways (1) | The connection is always SSL-enabled. | | psNever (2) | The connection is not SSL-enabled. | | psTunnel (3) | The connection is made through a tunneling (HTTP) proxy. | ## Data Type i32 # proxy_user property ([AS4Client](#struct-ipworksedias4client) Struct) A username if authentication is to be used for the proxy. ## Syntax *Rust Syntax* ```text fn proxy_user(&self ) -> Result fn set_proxy_user(&self, value : &str) -> Option fn set_proxy_user_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks A username if authentication is to be used for the proxy. If [proxy_auth_scheme](#proxy_auth_scheme-property-as4client-struct) is set to Basic Authentication, the [proxy_user](#proxy_user-property-as4client-struct) and [proxy_password](#proxy_password-property-as4client-struct) properties are Base64 encoded and the proxy authentication token will be generated in the form *Basic [encoded-user-password]*. If [proxy_auth_scheme](#proxy_auth_scheme-property-as4client-struct) is set to Digest Authentication, the [proxy_user](#proxy_user-property-as4client-struct) and [proxy_password](#proxy_password-property-as4client-struct) properties are used to respond to the Digest Authentication challenge from the server. If [proxy_auth_scheme](#proxy_auth_scheme-property-as4client-struct) is set to NTLM Authentication, the [proxy_user](#proxy_user-property-as4client-struct) and [proxy_password](#proxy_password-property-as4client-struct) properties are used to authenticate through NTLM negotiation. ## Data Type String # receipt_content property ([AS4Client](#struct-ipworksedias4client) Struct) The content of the receipt. ## Syntax *Rust Syntax* ```text fn receipt_content(&self ) -> Result fn set_receipt_content(&self, value : &str) -> Option fn set_receipt_content_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks The content of the receipt. This is the raw XML of the receipt. The struct will automatically create the receipt, and verify the receipt, depending on the method called. In most cases this is simply informational and may be stored for logging purposes if desired. ## Data Type String # receipt_ref_to_message_id property ([AS4Client](#struct-ipworksedias4client) Struct) The Message Id to which this receipt applies. ## Syntax *Rust Syntax* ```text fn receipt_ref_to_message_id(&self ) -> Result fn set_receipt_ref_to_message_id(&self, value : &str) -> Option fn set_receipt_ref_to_message_id_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks The Message Id to which this receipt applies. This is the original Message Id from the initial transmission of the file. This allows the receipt to be correlated with the original transmission. The struct will automatically create the receipt, and verify the receipt, depending on the method called. In most cases this is simply informational and may be stored for logging purposes if desired. ## Data Type String # receipt_reply_mode property ([AS4Client](#struct-ipworksedias4client) Struct) The expected receipt reply mode. ## Syntax *Rust Syntax* ```text fn receipt_reply_mode(&self ) -> Result fn set_receipt_reply_mode(&self, value : i32) -> Option ``` ## Possible Values ```text 0 // Sync1 // Async2 // None ``` ## Default Value 0 ## Remarks This setting tells the struct how to expect or deliver a receipt. Possible values are: | | | | --- | --- | | 0 (rrmSync - default) | The receipt is expected in the response to the request. This is only valid when sending files from a client to a server (push). This is a synchronous receipt (the receipt is returned in the same HTTP connection). | | 1 (rrmAsync) | The receipt is returned at a later time. The receipt may be returned by itself in a separate connection, or may be bundled with a subsequent request. This is the only available mode when receiving files from a server (pull). | | 2 (rrmNone) | No receipt is expected. | It is important to always set this property to the correct value in both [AS4Client](#struct-ipworksedias4client) and [AS4Server](AS4Server.md#AS4Server), whether sending or receiving, so the struct can build a valid message. This should be set to the previously agreed upon value between the parties in the agreement identified by [agreement_ref](#agreement_ref-property-as4client-struct) ## Data Type i32 # recipient_cert_count property ([AS4Client](#struct-ipworksedias4client) Struct) The number of records in the RecipientCert arrays. ## Syntax *Rust Syntax* ```text fn recipient_cert_count(&self ) -> Result fn set_recipient_cert_count(&self, value : i32) -> Option ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [recipient_cert_effective_date](#recipient_cert_effective_date-property-as4client-struct) - [recipient_cert_encoded](#recipient_cert_encoded-property-as4client-struct) - [recipient_cert_expiration_date](#recipient_cert_expiration_date-property-as4client-struct) - [recipient_cert_extended_key_usage](#recipient_cert_extended_key_usage-property-as4client-struct) - [recipient_cert_fingerprint](#recipient_cert_fingerprint-property-as4client-struct) - [recipient_cert_fingerprint_sha1](#recipient_cert_fingerprint_sha1-property-as4client-struct) - [recipient_cert_fingerprint_sha256](#recipient_cert_fingerprint_sha256-property-as4client-struct) - [recipient_cert_issuer](#recipient_cert_issuer-property-as4client-struct) - [recipient_cert_private_key](#recipient_cert_private_key-property-as4client-struct) - [recipient_cert_private_key_available](#recipient_cert_private_key_available-property-as4client-struct) - [recipient_cert_private_key_container](#recipient_cert_private_key_container-property-as4client-struct) - [recipient_cert_public_key](#recipient_cert_public_key-property-as4client-struct) - [recipient_cert_public_key_algorithm](#recipient_cert_public_key_algorithm-property-as4client-struct) - [recipient_cert_public_key_length](#recipient_cert_public_key_length-property-as4client-struct) - [recipient_cert_serial_number](#recipient_cert_serial_number-property-as4client-struct) - [recipient_cert_signature_algorithm](#recipient_cert_signature_algorithm-property-as4client-struct) - [recipient_cert_store](#recipient_cert_store-property-as4client-struct) - [recipient_cert_store_password](#recipient_cert_store_password-property-as4client-struct) - [recipient_cert_store_type](#recipient_cert_store_type-property-as4client-struct) - [recipient_cert_subject](#recipient_cert_subject-property-as4client-struct) - [recipient_cert_subject_alt_names](#recipient_cert_subject_alt_names-property-as4client-struct) - [recipient_cert_thumbprint_md5](#recipient_cert_thumbprint_md5-property-as4client-struct) - [recipient_cert_thumbprint_sha1](#recipient_cert_thumbprint_sha1-property-as4client-struct) - [recipient_cert_thumbprint_sha256](#recipient_cert_thumbprint_sha256-property-as4client-struct) - [recipient_cert_usage](#recipient_cert_usage-property-as4client-struct) - [recipient_cert_usage_flags](#recipient_cert_usage_flags-property-as4client-struct) - [recipient_cert_version](#recipient_cert_version-property-as4client-struct) The array indices start at *0* and end at *recipient_cert_count - 1*. ## Data Type i32 # recipient_cert_effective_date property ([AS4Client](#struct-ipworksedias4client) Struct) The date on which this certificate becomes valid. ## Syntax *Rust Syntax* ```text fn recipient_cert_effective_date(&self , RecipientCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2000 15:00:00. The *RecipientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipient_cert_count-property-as4client-struct) property. This property is read-only. ## Data Type String # recipient_cert_expiration_date property ([AS4Client](#struct-ipworksedias4client) Struct) The date on which the certificate expires. ## Syntax *Rust Syntax* ```text fn recipient_cert_expiration_date(&self , RecipientCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2001 15:00:00. The *RecipientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipient_cert_count-property-as4client-struct) property. This property is read-only. ## Data Type String # recipient_cert_extended_key_usage property ([AS4Client](#struct-ipworksedias4client) Struct) A comma-delimited list of extended key usage identifiers. ## Syntax *Rust Syntax* ```text fn recipient_cert_extended_key_usage(&self , RecipientCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). The *RecipientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipient_cert_count-property-as4client-struct) property. This property is read-only. ## Data Type String # recipient_cert_fingerprint property ([AS4Client](#struct-ipworksedias4client) Struct) The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax *Rust Syntax* ```text fn recipient_cert_fingerprint(&self , RecipientCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02* The *RecipientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipient_cert_count-property-as4client-struct) property. This property is read-only. ## Data Type String # recipient_cert_fingerprint_sha1 property ([AS4Client](#struct-ipworksedias4client) Struct) The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax *Rust Syntax* ```text fn recipient_cert_fingerprint_sha1(&self , RecipientCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84* The *RecipientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipient_cert_count-property-as4client-struct) property. This property is read-only. ## Data Type String # recipient_cert_fingerprint_sha256 property ([AS4Client](#struct-ipworksedias4client) Struct) The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax *Rust Syntax* ```text fn recipient_cert_fingerprint_sha256(&self , RecipientCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53* The *RecipientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipient_cert_count-property-as4client-struct) property. This property is read-only. ## Data Type String # recipient_cert_issuer property ([AS4Client](#struct-ipworksedias4client) Struct) The issuer of the certificate. ## Syntax *Rust Syntax* ```text fn recipient_cert_issuer(&self , RecipientCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate. The *RecipientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipient_cert_count-property-as4client-struct) property. This property is read-only. ## Data Type String # recipient_cert_private_key property ([AS4Client](#struct-ipworksedias4client) Struct) The private key of the certificate (if available). ## Syntax *Rust Syntax* ```text fn recipient_cert_private_key(&self , RecipientCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [recipient_cert_private_key](#recipient_cert_private_key-property-as4client-struct) may be available but not exportable. In this case, [recipient_cert_private_key](#recipient_cert_private_key-property-as4client-struct) returns an empty string. The *RecipientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipient_cert_count-property-as4client-struct) property. This property is read-only. ## Data Type String # recipient_cert_private_key_available property ([AS4Client](#struct-ipworksedias4client) Struct) Whether a PrivateKey is available for the selected certificate. ## Syntax *Rust Syntax* ```text fn recipient_cert_private_key_available(&self , RecipientCertIndex : i32) -> Result ``` ## Default Value false ## Remarks Whether a [recipient_cert_private_key](#recipient_cert_private_key-property-as4client-struct) is available for the selected certificate. If [recipient_cert_private_key_available](#recipient_cert_private_key_available-property-as4client-struct) is True, the certificate may be used for authentication purposes (e.g., server authentication). The *RecipientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipient_cert_count-property-as4client-struct) property. This property is read-only. ## Data Type bool # recipient_cert_private_key_container property ([AS4Client](#struct-ipworksedias4client) Struct) The name of the PrivateKey container for the certificate (if available). ## Syntax *Rust Syntax* ```text fn recipient_cert_private_key_container(&self , RecipientCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The name of the [recipient_cert_private_key](#recipient_cert_private_key-property-as4client-struct) container for the certificate (if available). This functionality is available only on Windows platforms. The *RecipientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipient_cert_count-property-as4client-struct) property. This property is read-only. ## Data Type String # recipient_cert_public_key property ([AS4Client](#struct-ipworksedias4client) Struct) The public key of the certificate. ## Syntax *Rust Syntax* ```text fn recipient_cert_public_key(&self , RecipientCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The public key of the certificate. The key is provided as PEM/Base64-encoded data. The *RecipientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipient_cert_count-property-as4client-struct) property. This property is read-only. ## Data Type String # recipient_cert_public_key_algorithm property ([AS4Client](#struct-ipworksedias4client) Struct) The textual description of the certificate's public key algorithm. ## Syntax *Rust Syntax* ```text fn recipient_cert_public_key_algorithm(&self , RecipientCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm. The *RecipientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipient_cert_count-property-as4client-struct) property. This property is read-only. ## Data Type String # recipient_cert_public_key_length property ([AS4Client](#struct-ipworksedias4client) Struct) The length of the certificate's public key (in bits). ## Syntax *Rust Syntax* ```text fn recipient_cert_public_key_length(&self , RecipientCertIndex : i32) -> Result ``` ## Default Value 0 ## Remarks The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. The *RecipientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipient_cert_count-property-as4client-struct) property. This property is read-only. ## Data Type i32 # recipient_cert_serial_number property ([AS4Client](#struct-ipworksedias4client) Struct) The serial number of the certificate encoded as a string. ## Syntax *Rust Syntax* ```text fn recipient_cert_serial_number(&self , RecipientCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number. The *RecipientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipient_cert_count-property-as4client-struct) property. This property is read-only. ## Data Type String # recipient_cert_signature_algorithm property ([AS4Client](#struct-ipworksedias4client) Struct) The text description of the certificate's signature algorithm. ## Syntax *Rust Syntax* ```text fn recipient_cert_signature_algorithm(&self , RecipientCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm. The *RecipientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipient_cert_count-property-as4client-struct) property. This property is read-only. ## Data Type String # recipient_cert_store property ([AS4Client](#struct-ipworksedias4client) Struct) The name of the certificate store for the client certificate. ## Syntax *Rust Syntax* ```text fn recipient_cert_store(&self , RecipientCertIndex : i32) -> Result, IPWorksEDIError> fn set_recipient_cert_store(&self, RecipientCertIndex : i32, value : Vec) -> Option fn set_recipient_cert_store_ref(&self, RecipientCertIndex : i32, value : &[u8]) -> Option ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [recipient_cert_store_type](#recipient_cert_store_type-property-as4client-struct) property denotes the type of the certificate store specified by [recipient_cert_store](#recipient_cert_store-property-as4client-struct). If the store is password-protected, specify the password in [recipient_cert_store_password](#recipient_cert_store_password-property-as4client-struct). [recipient_cert_store](#recipient_cert_store-property-as4client-struct) is used in conjunction with the [recipient_cert_subject](#recipient_cert_subject-property-as4client-struct) property to specify client certificates. If [recipient_cert_store](#recipient_cert_store-property-as4client-struct) has a value, and [recipient_cert_subject](#recipient_cert_subject-property-as4client-struct) or [recipient_cert_encoded](#recipient_cert_encoded-property-as4client-struct) is set, a search for a certificate is initiated. Please see the [recipient_cert_subject](#recipient_cert_subject-property-as4client-struct) 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). The *RecipientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipient_cert_count-property-as4client-struct) property. ## Data Type Vec # recipient_cert_store_password property ([AS4Client](#struct-ipworksedias4client) 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 *Rust Syntax* ```text fn recipient_cert_store_password(&self , RecipientCertIndex : i32) -> Result fn set_recipient_cert_store_password(&self, RecipientCertIndex : i32, value : &str) -> Option fn set_recipient_cert_store_password_ref(&self, RecipientCertIndex : i32, value : &String) -> Option ``` ## Default Value "" ## Remarks If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. The *RecipientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipient_cert_count-property-as4client-struct) property. ## Data Type String # recipient_cert_store_type property ([AS4Client](#struct-ipworksedias4client) Struct) The type of certificate store for this certificate. ## Syntax *Rust Syntax* ```text fn recipient_cert_store_type(&self , RecipientCertIndex : i32) -> Result fn set_recipient_cert_store_type(&self, RecipientCertIndex : i32, value : i32) -> Option ``` ## Possible Values ```text 0 // User1 // Machine2 // PFXFile3 // PFXBlob4 // JKSFile5 // JKSBlob6 // PEMKeyFile7 // PEMKeyBlob8 // PublicKeyFile9 // PublicKeyBlob10 // SSHPublicKeyBlob11 // P7BFile12 // P7BBlob13 // SSHPublicKeyFile14 // PPKFile15 // PPKBlob16 // XMLFile17 // XMLBlob18 // JWKFile19 // JWKBlob20 // SecurityKey21 // BCFKSFile22 // BCFKSBlob23 // PKCS1199 // Auto ``` ## Default Value 0 ## 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: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. | | 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. | | 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. | | 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. | | 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. | | 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. | | 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. | | 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. | | 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. | | 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. | | 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. | | 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. | | 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. | | 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. | | 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). | | 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). | | 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. | | 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. | | 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). | | 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). | | 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. | | 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. | | 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [recipient_cert_store_type](#recipient_cert_store_type-property-as4client-struct), the full path of the PKCS#11 DLL as the [recipient_cert_store](#recipient_cert_store-property-as4client-struct), and the PIN as the [recipient_cert_store_password](#recipient_cert_store_password-property-as4client-struct). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) struct by calling the [list_store_certificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [on_cert_list](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [recipient_cert_store](#recipient_cert_store-property-as4client-struct) and set [recipient_cert_store_password](#recipient_cert_store_password-property-as4client-struct) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. | The *RecipientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipient_cert_count-property-as4client-struct) property. ## Data Type i32 # recipient_cert_subject_alt_names property ([AS4Client](#struct-ipworksedias4client) Struct) Comma-separated lists of alternative subject names for the certificate. ## Syntax *Rust Syntax* ```text fn recipient_cert_subject_alt_names(&self , RecipientCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks Comma-separated lists of alternative subject names for the certificate. The *RecipientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipient_cert_count-property-as4client-struct) property. This property is read-only. ## Data Type String # recipient_cert_thumbprint_md5 property ([AS4Client](#struct-ipworksedias4client) Struct) The MD5 hash of the certificate. ## Syntax *Rust Syntax* ```text fn recipient_cert_thumbprint_md5(&self , RecipientCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. The *RecipientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipient_cert_count-property-as4client-struct) property. This property is read-only. ## Data Type String # recipient_cert_thumbprint_sha1 property ([AS4Client](#struct-ipworksedias4client) Struct) The SHA-1 hash of the certificate. ## Syntax *Rust Syntax* ```text fn recipient_cert_thumbprint_sha1(&self , RecipientCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. The *RecipientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipient_cert_count-property-as4client-struct) property. This property is read-only. ## Data Type String # recipient_cert_thumbprint_sha256 property ([AS4Client](#struct-ipworksedias4client) Struct) The SHA-256 hash of the certificate. ## Syntax *Rust Syntax* ```text fn recipient_cert_thumbprint_sha256(&self , RecipientCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. The *RecipientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipient_cert_count-property-as4client-struct) property. This property is read-only. ## Data Type String # recipient_cert_usage property ([AS4Client](#struct-ipworksedias4client) Struct) The text description of UsageFlags . ## Syntax *Rust Syntax* ```text fn recipient_cert_usage(&self , RecipientCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The text description of [recipient_cert_usage_flags](#recipient_cert_usage_flags-property-as4client-struct). This value will be one or more of the following strings and will be separated by commas: - Digital Signature - Non-Repudiation - Key Encipherment - Data Encipherment - Key Agreement - Certificate Signing - CRL Signing - Encipher Only If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names. The *RecipientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipient_cert_count-property-as4client-struct) property. This property is read-only. ## Data Type String # recipient_cert_usage_flags property ([AS4Client](#struct-ipworksedias4client) Struct) The flags that show intended use for the certificate. ## Syntax *Rust Syntax* ```text fn recipient_cert_usage_flags(&self , RecipientCertIndex : i32) -> Result ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [recipient_cert_usage_flags](#recipient_cert_usage_flags-property-as4client-struct) 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 [recipient_cert_usage](#recipient_cert_usage-property-as4client-struct) property for a text representation of [recipient_cert_usage_flags](#recipient_cert_usage_flags-property-as4client-struct). This functionality currently is not available when the provider is OpenSSL. The *RecipientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipient_cert_count-property-as4client-struct) property. This property is read-only. ## Data Type i32 # recipient_cert_version property ([AS4Client](#struct-ipworksedias4client) Struct) The certificate's version number. ## Syntax *Rust Syntax* ```text fn recipient_cert_version(&self , RecipientCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The certificate's version number. The possible values are the strings "V1", "V2", and "V3". The *RecipientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipient_cert_count-property-as4client-struct) property. This property is read-only. ## Data Type String # recipient_cert_subject property ([AS4Client](#struct-ipworksedias4client) Struct) The subject of the certificate used for client authentication. ## Syntax *Rust Syntax* ```text fn recipient_cert_subject(&self , RecipientCertIndex : i32) -> Result fn set_recipient_cert_subject(&self, RecipientCertIndex : i32, value : &str) -> Option fn set_recipient_cert_subject_ref(&self, RecipientCertIndex : i32, value : &String) -> Option ``` ## 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. The *RecipientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipient_cert_count-property-as4client-struct) property. ## Data Type String # recipient_cert_encoded property ([AS4Client](#struct-ipworksedias4client) Struct) The certificate (PEM/Base64 encoded). ## Syntax *Rust Syntax* ```text fn recipient_cert_encoded(&self , RecipientCertIndex : i32) -> Result, IPWorksEDIError> fn set_recipient_cert_encoded(&self, RecipientCertIndex : i32, value : Vec) -> Option fn set_recipient_cert_encoded_ref(&self, RecipientCertIndex : i32, value : &[u8]) -> Option ``` ## Default Value "" ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [recipient_cert_store](#recipient_cert_store-property-as4client-struct) and [recipient_cert_subject](#recipient_cert_subject-property-as4client-struct) properties also may be used to specify a certificate. When [recipient_cert_encoded](#recipient_cert_encoded-property-as4client-struct) is set, a search is initiated in the current [recipient_cert_store](#recipient_cert_store-property-as4client-struct) for the private key of the certificate. If the key is found, [recipient_cert_subject](#recipient_cert_subject-property-as4client-struct) is updated to reflect the full subject of the selected certificate; otherwise, [recipient_cert_subject](#recipient_cert_subject-property-as4client-struct) is set to an empty string. The *RecipientCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [RecipientCertCount](#recipient_cert_count-property-as4client-struct) property. ## Data Type Vec # ref_to_message_id property ([AS4Client](#struct-ipworksedias4client) Struct) Specifies the RefToMessageId in the message. ## Syntax *Rust Syntax* ```text fn ref_to_message_id(&self ) -> Result fn set_ref_to_message_id(&self, value : &str) -> Option fn set_ref_to_message_id_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks This property specifies the RefToMessageId value in the message being sent. This property is only applicable when [profile](#profile-property-as4client-struct) is set to ebpfEDelivery. The eDelivery profile supports the Two-Way/Push-and-Push MEP (Message Exchange Pattern), where sending a file can be in reference to a previously received file. In this case ref_to_message_id specifies the Id of the previously received message to which this send is in reference. When sending with [AS4Client](#struct-ipworksedias4client) this should only be set when using the eDelivery profile and need to explicitly specify the RefToMessageId value as per the Two-Way/Push-And-Push MEP. When receiving with [AS4Server](AS4Server.md#AS4Server) this may be read after receiving a message. ## Data Type String # rollover_cert_effective_date property ([AS4Client](#struct-ipworksedias4client) Struct) The date on which this certificate becomes valid. ## Syntax *Rust Syntax* ```text fn rollover_cert_effective_date(&self ) -> Result ``` ## 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 # rollover_cert_expiration_date property ([AS4Client](#struct-ipworksedias4client) Struct) The date on which the certificate expires. ## Syntax *Rust Syntax* ```text fn rollover_cert_expiration_date(&self ) -> Result ``` ## 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 # rollover_cert_extended_key_usage property ([AS4Client](#struct-ipworksedias4client) Struct) A comma-delimited list of extended key usage identifiers. ## Syntax *Rust Syntax* ```text fn rollover_cert_extended_key_usage(&self ) -> Result ``` ## 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 # rollover_cert_fingerprint property ([AS4Client](#struct-ipworksedias4client) Struct) The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax *Rust Syntax* ```text fn rollover_cert_fingerprint(&self ) -> Result ``` ## 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 # rollover_cert_fingerprint_sha1 property ([AS4Client](#struct-ipworksedias4client) Struct) The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax *Rust Syntax* ```text fn rollover_cert_fingerprint_sha1(&self ) -> Result ``` ## 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 # rollover_cert_fingerprint_sha256 property ([AS4Client](#struct-ipworksedias4client) Struct) The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax *Rust Syntax* ```text fn rollover_cert_fingerprint_sha256(&self ) -> Result ``` ## 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 # rollover_cert_issuer property ([AS4Client](#struct-ipworksedias4client) Struct) The issuer of the certificate. ## Syntax *Rust Syntax* ```text fn rollover_cert_issuer(&self ) -> Result ``` ## 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 # rollover_cert_private_key property ([AS4Client](#struct-ipworksedias4client) Struct) The private key of the certificate (if available). ## Syntax *Rust Syntax* ```text fn rollover_cert_private_key(&self ) -> Result ``` ## Default Value "" ## Remarks The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [rollover_cert_private_key](#rollover_cert_private_key-property-as4client-struct) may be available but not exportable. In this case, [rollover_cert_private_key](#rollover_cert_private_key-property-as4client-struct) returns an empty string. This property is read-only. ## Data Type String # rollover_cert_private_key_available property ([AS4Client](#struct-ipworksedias4client) Struct) Whether a PrivateKey is available for the selected certificate. ## Syntax *Rust Syntax* ```text fn rollover_cert_private_key_available(&self ) -> Result ``` ## Default Value false ## Remarks Whether a [rollover_cert_private_key](#rollover_cert_private_key-property-as4client-struct) is available for the selected certificate. If [rollover_cert_private_key_available](#rollover_cert_private_key_available-property-as4client-struct) is True, the certificate may be used for authentication purposes (e.g., server authentication). This property is read-only. ## Data Type bool # rollover_cert_private_key_container property ([AS4Client](#struct-ipworksedias4client) Struct) The name of the PrivateKey container for the certificate (if available). ## Syntax *Rust Syntax* ```text fn rollover_cert_private_key_container(&self ) -> Result ``` ## Default Value "" ## Remarks The name of the [rollover_cert_private_key](#rollover_cert_private_key-property-as4client-struct) container for the certificate (if available). This functionality is available only on Windows platforms. This property is read-only. ## Data Type String # rollover_cert_public_key property ([AS4Client](#struct-ipworksedias4client) Struct) The public key of the certificate. ## Syntax *Rust Syntax* ```text fn rollover_cert_public_key(&self ) -> Result ``` ## 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 # rollover_cert_public_key_algorithm property ([AS4Client](#struct-ipworksedias4client) Struct) The textual description of the certificate's public key algorithm. ## Syntax *Rust Syntax* ```text fn rollover_cert_public_key_algorithm(&self ) -> Result ``` ## 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 # rollover_cert_public_key_length property ([AS4Client](#struct-ipworksedias4client) Struct) The length of the certificate's public key (in bits). ## Syntax *Rust Syntax* ```text fn rollover_cert_public_key_length(&self ) -> Result ``` ## Default Value 0 ## Remarks The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. This property is read-only. ## Data Type i32 # rollover_cert_serial_number property ([AS4Client](#struct-ipworksedias4client) Struct) The serial number of the certificate encoded as a string. ## Syntax *Rust Syntax* ```text fn rollover_cert_serial_number(&self ) -> Result ``` ## 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 # rollover_cert_signature_algorithm property ([AS4Client](#struct-ipworksedias4client) Struct) The text description of the certificate's signature algorithm. ## Syntax *Rust Syntax* ```text fn rollover_cert_signature_algorithm(&self ) -> Result ``` ## 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 # rollover_cert_store property ([AS4Client](#struct-ipworksedias4client) Struct) The name of the certificate store for the client certificate. ## Syntax *Rust Syntax* ```text fn rollover_cert_store(&self ) -> Result, IPWorksEDIError> fn set_rollover_cert_store(&self, value : Vec) -> Option fn set_rollover_cert_store_ref(&self, value : &[u8]) -> Option ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [rollover_cert_store_type](#rollover_cert_store_type-property-as4client-struct) property denotes the type of the certificate store specified by [rollover_cert_store](#rollover_cert_store-property-as4client-struct). If the store is password-protected, specify the password in [rollover_cert_store_password](#rollover_cert_store_password-property-as4client-struct). [rollover_cert_store](#rollover_cert_store-property-as4client-struct) is used in conjunction with the [rollover_cert_subject](#rollover_cert_subject-property-as4client-struct) property to specify client certificates. If [rollover_cert_store](#rollover_cert_store-property-as4client-struct) has a value, and [rollover_cert_subject](#rollover_cert_subject-property-as4client-struct) or [rollover_cert_encoded](#rollover_cert_encoded-property-as4client-struct) is set, a search for a certificate is initiated. Please see the [rollover_cert_subject](#rollover_cert_subject-property-as4client-struct) 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 # rollover_cert_store_password property ([AS4Client](#struct-ipworksedias4client) 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 *Rust Syntax* ```text fn rollover_cert_store_password(&self ) -> Result fn set_rollover_cert_store_password(&self, value : &str) -> Option fn set_rollover_cert_store_password_ref(&self, value : &String) -> Option ``` ## 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 # rollover_cert_store_type property ([AS4Client](#struct-ipworksedias4client) Struct) The type of certificate store for this certificate. ## Syntax *Rust Syntax* ```text fn rollover_cert_store_type(&self ) -> Result fn set_rollover_cert_store_type(&self, value : i32) -> Option ``` ## Possible Values ```text 0 // User1 // Machine2 // PFXFile3 // PFXBlob4 // JKSFile5 // JKSBlob6 // PEMKeyFile7 // PEMKeyBlob8 // PublicKeyFile9 // PublicKeyBlob10 // SSHPublicKeyBlob11 // P7BFile12 // P7BBlob13 // SSHPublicKeyFile14 // PPKFile15 // PPKBlob16 // XMLFile17 // XMLBlob18 // JWKFile19 // JWKBlob20 // SecurityKey21 // BCFKSFile22 // BCFKSBlob23 // PKCS1199 // Auto ``` ## Default Value 0 ## 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: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. | | 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. | | 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. | | 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. | | 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. | | 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. | | 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. | | 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. | | 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. | | 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. | | 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. | | 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. | | 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. | | 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. | | 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). | | 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). | | 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. | | 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. | | 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). | | 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). | | 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. | | 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. | | 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [rollover_cert_store_type](#rollover_cert_store_type-property-as4client-struct), the full path of the PKCS#11 DLL as the [rollover_cert_store](#rollover_cert_store-property-as4client-struct), and the PIN as the [rollover_cert_store_password](#rollover_cert_store_password-property-as4client-struct). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) struct by calling the [list_store_certificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [on_cert_list](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [rollover_cert_store](#rollover_cert_store-property-as4client-struct) and set [rollover_cert_store_password](#rollover_cert_store_password-property-as4client-struct) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. | ## Data Type i32 # rollover_cert_subject_alt_names property ([AS4Client](#struct-ipworksedias4client) Struct) Comma-separated lists of alternative subject names for the certificate. ## Syntax *Rust Syntax* ```text fn rollover_cert_subject_alt_names(&self ) -> Result ``` ## Default Value "" ## Remarks Comma-separated lists of alternative subject names for the certificate. This property is read-only. ## Data Type String # rollover_cert_thumbprint_md5 property ([AS4Client](#struct-ipworksedias4client) Struct) The MD5 hash of the certificate. ## Syntax *Rust Syntax* ```text fn rollover_cert_thumbprint_md5(&self ) -> Result ``` ## 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 # rollover_cert_thumbprint_sha1 property ([AS4Client](#struct-ipworksedias4client) Struct) The SHA-1 hash of the certificate. ## Syntax *Rust Syntax* ```text fn rollover_cert_thumbprint_sha1(&self ) -> Result ``` ## 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 # rollover_cert_thumbprint_sha256 property ([AS4Client](#struct-ipworksedias4client) Struct) The SHA-256 hash of the certificate. ## Syntax *Rust Syntax* ```text fn rollover_cert_thumbprint_sha256(&self ) -> Result ``` ## 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 # rollover_cert_usage property ([AS4Client](#struct-ipworksedias4client) Struct) The text description of UsageFlags . ## Syntax *Rust Syntax* ```text fn rollover_cert_usage(&self ) -> Result ``` ## Default Value "" ## Remarks The text description of [rollover_cert_usage_flags](#rollover_cert_usage_flags-property-as4client-struct). 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 # rollover_cert_usage_flags property ([AS4Client](#struct-ipworksedias4client) Struct) The flags that show intended use for the certificate. ## Syntax *Rust Syntax* ```text fn rollover_cert_usage_flags(&self ) -> Result ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [rollover_cert_usage_flags](#rollover_cert_usage_flags-property-as4client-struct) 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 [rollover_cert_usage](#rollover_cert_usage-property-as4client-struct) property for a text representation of [rollover_cert_usage_flags](#rollover_cert_usage_flags-property-as4client-struct). This functionality currently is not available when the provider is OpenSSL. This property is read-only. ## Data Type i32 # rollover_cert_version property ([AS4Client](#struct-ipworksedias4client) Struct) The certificate's version number. ## Syntax *Rust Syntax* ```text fn rollover_cert_version(&self ) -> Result ``` ## 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 # rollover_cert_subject property ([AS4Client](#struct-ipworksedias4client) Struct) The subject of the certificate used for client authentication. ## Syntax *Rust Syntax* ```text fn rollover_cert_subject(&self ) -> Result fn set_rollover_cert_subject(&self, value : &str) -> Option fn set_rollover_cert_subject_ref(&self, value : &String) -> Option ``` ## 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 # rollover_cert_encoded property ([AS4Client](#struct-ipworksedias4client) Struct) The certificate (PEM/Base64 encoded). ## Syntax *Rust Syntax* ```text fn rollover_cert_encoded(&self ) -> Result, IPWorksEDIError> fn set_rollover_cert_encoded(&self, value : Vec) -> Option fn set_rollover_cert_encoded_ref(&self, value : &[u8]) -> Option ``` ## Default Value "" ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [rollover_cert_store](#rollover_cert_store-property-as4client-struct) and [rollover_cert_subject](#rollover_cert_subject-property-as4client-struct) properties also may be used to specify a certificate. When [rollover_cert_encoded](#rollover_cert_encoded-property-as4client-struct) is set, a search is initiated in the current [rollover_cert_store](#rollover_cert_store-property-as4client-struct) for the private key of the certificate. If the key is found, [rollover_cert_subject](#rollover_cert_subject-property-as4client-struct) is updated to reflect the full subject of the selected certificate; otherwise, [rollover_cert_subject](#rollover_cert_subject-property-as4client-struct) is set to an empty string. ## Data Type Vec # rollover_signing_cert_effective_date property ([AS4Client](#struct-ipworksedias4client) Struct) The date on which this certificate becomes valid. ## Syntax *Rust Syntax* ```text fn rollover_signing_cert_effective_date(&self ) -> Result ``` ## 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 # rollover_signing_cert_expiration_date property ([AS4Client](#struct-ipworksedias4client) Struct) The date on which the certificate expires. ## Syntax *Rust Syntax* ```text fn rollover_signing_cert_expiration_date(&self ) -> Result ``` ## 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 # rollover_signing_cert_extended_key_usage property ([AS4Client](#struct-ipworksedias4client) Struct) A comma-delimited list of extended key usage identifiers. ## Syntax *Rust Syntax* ```text fn rollover_signing_cert_extended_key_usage(&self ) -> Result ``` ## 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 # rollover_signing_cert_fingerprint property ([AS4Client](#struct-ipworksedias4client) Struct) The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax *Rust Syntax* ```text fn rollover_signing_cert_fingerprint(&self ) -> Result ``` ## 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 # rollover_signing_cert_fingerprint_sha1 property ([AS4Client](#struct-ipworksedias4client) Struct) The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax *Rust Syntax* ```text fn rollover_signing_cert_fingerprint_sha1(&self ) -> Result ``` ## 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 # rollover_signing_cert_fingerprint_sha256 property ([AS4Client](#struct-ipworksedias4client) Struct) The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax *Rust Syntax* ```text fn rollover_signing_cert_fingerprint_sha256(&self ) -> Result ``` ## 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 # rollover_signing_cert_issuer property ([AS4Client](#struct-ipworksedias4client) Struct) The issuer of the certificate. ## Syntax *Rust Syntax* ```text fn rollover_signing_cert_issuer(&self ) -> Result ``` ## 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 # rollover_signing_cert_private_key property ([AS4Client](#struct-ipworksedias4client) Struct) The private key of the certificate (if available). ## Syntax *Rust Syntax* ```text fn rollover_signing_cert_private_key(&self ) -> Result ``` ## Default Value "" ## Remarks The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [rollover_signing_cert_private_key](#rollover_signing_cert_private_key-property-as4client-struct) may be available but not exportable. In this case, [rollover_signing_cert_private_key](#rollover_signing_cert_private_key-property-as4client-struct) returns an empty string. This property is read-only. ## Data Type String # rollover_signing_cert_private_key_available property ([AS4Client](#struct-ipworksedias4client) Struct) Whether a PrivateKey is available for the selected certificate. ## Syntax *Rust Syntax* ```text fn rollover_signing_cert_private_key_available(&self ) -> Result ``` ## Default Value false ## Remarks Whether a [rollover_signing_cert_private_key](#rollover_signing_cert_private_key-property-as4client-struct) is available for the selected certificate. If [rollover_signing_cert_private_key_available](#rollover_signing_cert_private_key_available-property-as4client-struct) is True, the certificate may be used for authentication purposes (e.g., server authentication). This property is read-only. ## Data Type bool # rollover_signing_cert_private_key_container property ([AS4Client](#struct-ipworksedias4client) Struct) The name of the PrivateKey container for the certificate (if available). ## Syntax *Rust Syntax* ```text fn rollover_signing_cert_private_key_container(&self ) -> Result ``` ## Default Value "" ## Remarks The name of the [rollover_signing_cert_private_key](#rollover_signing_cert_private_key-property-as4client-struct) container for the certificate (if available). This functionality is available only on Windows platforms. This property is read-only. ## Data Type String # rollover_signing_cert_public_key property ([AS4Client](#struct-ipworksedias4client) Struct) The public key of the certificate. ## Syntax *Rust Syntax* ```text fn rollover_signing_cert_public_key(&self ) -> Result ``` ## 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 # rollover_signing_cert_public_key_algorithm property ([AS4Client](#struct-ipworksedias4client) Struct) The textual description of the certificate's public key algorithm. ## Syntax *Rust Syntax* ```text fn rollover_signing_cert_public_key_algorithm(&self ) -> Result ``` ## 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 # rollover_signing_cert_public_key_length property ([AS4Client](#struct-ipworksedias4client) Struct) The length of the certificate's public key (in bits). ## Syntax *Rust Syntax* ```text fn rollover_signing_cert_public_key_length(&self ) -> Result ``` ## Default Value 0 ## Remarks The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. This property is read-only. ## Data Type i32 # rollover_signing_cert_serial_number property ([AS4Client](#struct-ipworksedias4client) Struct) The serial number of the certificate encoded as a string. ## Syntax *Rust Syntax* ```text fn rollover_signing_cert_serial_number(&self ) -> Result ``` ## 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 # rollover_signing_cert_signature_algorithm property ([AS4Client](#struct-ipworksedias4client) Struct) The text description of the certificate's signature algorithm. ## Syntax *Rust Syntax* ```text fn rollover_signing_cert_signature_algorithm(&self ) -> Result ``` ## 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 # rollover_signing_cert_store property ([AS4Client](#struct-ipworksedias4client) Struct) The name of the certificate store for the client certificate. ## Syntax *Rust Syntax* ```text fn rollover_signing_cert_store(&self ) -> Result, IPWorksEDIError> fn set_rollover_signing_cert_store(&self, value : Vec) -> Option fn set_rollover_signing_cert_store_ref(&self, value : &[u8]) -> Option ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [rollover_signing_cert_store_type](#rollover_signing_cert_store_type-property-as4client-struct) property denotes the type of the certificate store specified by [rollover_signing_cert_store](#rollover_signing_cert_store-property-as4client-struct). If the store is password-protected, specify the password in [rollover_signing_cert_store_password](#rollover_signing_cert_store_password-property-as4client-struct). [rollover_signing_cert_store](#rollover_signing_cert_store-property-as4client-struct) is used in conjunction with the [rollover_signing_cert_subject](#rollover_signing_cert_subject-property-as4client-struct) property to specify client certificates. If [rollover_signing_cert_store](#rollover_signing_cert_store-property-as4client-struct) has a value, and [rollover_signing_cert_subject](#rollover_signing_cert_subject-property-as4client-struct) or [rollover_signing_cert_encoded](#rollover_signing_cert_encoded-property-as4client-struct) is set, a search for a certificate is initiated. Please see the [rollover_signing_cert_subject](#rollover_signing_cert_subject-property-as4client-struct) 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 # rollover_signing_cert_store_password property ([AS4Client](#struct-ipworksedias4client) 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 *Rust Syntax* ```text fn rollover_signing_cert_store_password(&self ) -> Result fn set_rollover_signing_cert_store_password(&self, value : &str) -> Option fn set_rollover_signing_cert_store_password_ref(&self, value : &String) -> Option ``` ## 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 # rollover_signing_cert_store_type property ([AS4Client](#struct-ipworksedias4client) Struct) The type of certificate store for this certificate. ## Syntax *Rust Syntax* ```text fn rollover_signing_cert_store_type(&self ) -> Result fn set_rollover_signing_cert_store_type(&self, value : i32) -> Option ``` ## Possible Values ```text 0 // User1 // Machine2 // PFXFile3 // PFXBlob4 // JKSFile5 // JKSBlob6 // PEMKeyFile7 // PEMKeyBlob8 // PublicKeyFile9 // PublicKeyBlob10 // SSHPublicKeyBlob11 // P7BFile12 // P7BBlob13 // SSHPublicKeyFile14 // PPKFile15 // PPKBlob16 // XMLFile17 // XMLBlob18 // JWKFile19 // JWKBlob20 // SecurityKey21 // BCFKSFile22 // BCFKSBlob23 // PKCS1199 // Auto ``` ## Default Value 0 ## 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: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. | | 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. | | 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. | | 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. | | 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. | | 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. | | 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. | | 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. | | 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. | | 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. | | 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. | | 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. | | 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. | | 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. | | 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). | | 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). | | 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. | | 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. | | 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). | | 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). | | 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. | | 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. | | 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [rollover_signing_cert_store_type](#rollover_signing_cert_store_type-property-as4client-struct), the full path of the PKCS#11 DLL as the [rollover_signing_cert_store](#rollover_signing_cert_store-property-as4client-struct), and the PIN as the [rollover_signing_cert_store_password](#rollover_signing_cert_store_password-property-as4client-struct). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) struct by calling the [list_store_certificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [on_cert_list](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [rollover_signing_cert_store](#rollover_signing_cert_store-property-as4client-struct) and set [rollover_signing_cert_store_password](#rollover_signing_cert_store_password-property-as4client-struct) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. | ## Data Type i32 # rollover_signing_cert_subject_alt_names property ([AS4Client](#struct-ipworksedias4client) Struct) Comma-separated lists of alternative subject names for the certificate. ## Syntax *Rust Syntax* ```text fn rollover_signing_cert_subject_alt_names(&self ) -> Result ``` ## Default Value "" ## Remarks Comma-separated lists of alternative subject names for the certificate. This property is read-only. ## Data Type String # rollover_signing_cert_thumbprint_md5 property ([AS4Client](#struct-ipworksedias4client) Struct) The MD5 hash of the certificate. ## Syntax *Rust Syntax* ```text fn rollover_signing_cert_thumbprint_md5(&self ) -> Result ``` ## 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 # rollover_signing_cert_thumbprint_sha1 property ([AS4Client](#struct-ipworksedias4client) Struct) The SHA-1 hash of the certificate. ## Syntax *Rust Syntax* ```text fn rollover_signing_cert_thumbprint_sha1(&self ) -> Result ``` ## 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 # rollover_signing_cert_thumbprint_sha256 property ([AS4Client](#struct-ipworksedias4client) Struct) The SHA-256 hash of the certificate. ## Syntax *Rust Syntax* ```text fn rollover_signing_cert_thumbprint_sha256(&self ) -> Result ``` ## 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 # rollover_signing_cert_usage property ([AS4Client](#struct-ipworksedias4client) Struct) The text description of UsageFlags . ## Syntax *Rust Syntax* ```text fn rollover_signing_cert_usage(&self ) -> Result ``` ## Default Value "" ## Remarks The text description of [rollover_signing_cert_usage_flags](#rollover_signing_cert_usage_flags-property-as4client-struct). 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 # rollover_signing_cert_usage_flags property ([AS4Client](#struct-ipworksedias4client) Struct) The flags that show intended use for the certificate. ## Syntax *Rust Syntax* ```text fn rollover_signing_cert_usage_flags(&self ) -> Result ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [rollover_signing_cert_usage_flags](#rollover_signing_cert_usage_flags-property-as4client-struct) 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 [rollover_signing_cert_usage](#rollover_signing_cert_usage-property-as4client-struct) property for a text representation of [rollover_signing_cert_usage_flags](#rollover_signing_cert_usage_flags-property-as4client-struct). This functionality currently is not available when the provider is OpenSSL. This property is read-only. ## Data Type i32 # rollover_signing_cert_version property ([AS4Client](#struct-ipworksedias4client) Struct) The certificate's version number. ## Syntax *Rust Syntax* ```text fn rollover_signing_cert_version(&self ) -> Result ``` ## 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 # rollover_signing_cert_subject property ([AS4Client](#struct-ipworksedias4client) Struct) The subject of the certificate used for client authentication. ## Syntax *Rust Syntax* ```text fn rollover_signing_cert_subject(&self ) -> Result fn set_rollover_signing_cert_subject(&self, value : &str) -> Option fn set_rollover_signing_cert_subject_ref(&self, value : &String) -> Option ``` ## 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 # rollover_signing_cert_encoded property ([AS4Client](#struct-ipworksedias4client) Struct) The certificate (PEM/Base64 encoded). ## Syntax *Rust Syntax* ```text fn rollover_signing_cert_encoded(&self ) -> Result, IPWorksEDIError> fn set_rollover_signing_cert_encoded(&self, value : Vec) -> Option fn set_rollover_signing_cert_encoded_ref(&self, value : &[u8]) -> Option ``` ## Default Value "" ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [rollover_signing_cert_store](#rollover_signing_cert_store-property-as4client-struct) and [rollover_signing_cert_subject](#rollover_signing_cert_subject-property-as4client-struct) properties also may be used to specify a certificate. When [rollover_signing_cert_encoded](#rollover_signing_cert_encoded-property-as4client-struct) is set, a search is initiated in the current [rollover_signing_cert_store](#rollover_signing_cert_store-property-as4client-struct) for the private key of the certificate. If the key is found, [rollover_signing_cert_subject](#rollover_signing_cert_subject-property-as4client-struct) is updated to reflect the full subject of the selected certificate; otherwise, [rollover_signing_cert_subject](#rollover_signing_cert_subject-property-as4client-struct) is set to an empty string. ## Data Type Vec # service property ([AS4Client](#struct-ipworksedias4client) Struct) The service which acts on the message. ## Syntax *Rust Syntax* ```text fn service(&self ) -> Result fn set_service(&self, value : &str) -> Option fn set_service_ref(&self, value : &String) -> Option ``` ## Default Value "http://docs.oasis-open.org/ebxml-msg/as4/200902/service" ## Remarks This property specifies the service which acts on the message. This should only be changed from the default value if there is a specific reason to do so. This value corresponds to the ebMS element "eb:Messaging/eb:UserMessage/eb:CollaborationInfo/eb:Service" ## Data Type String # service_action property ([AS4Client](#struct-ipworksedias4client) Struct) The action within a service that acts on the message. ## Syntax *Rust Syntax* ```text fn service_action(&self ) -> Result fn set_service_action(&self, value : &str) -> Option fn set_service_action_ref(&self, value : &String) -> Option ``` ## Default Value "http://docs.oasis-open.org/ebxml-msg/as4/200902/action" ## Remarks This property defines the action within a service that acts upon a message. This should only be changed from the default value if there is a specific reason to do so. This value corresponds to the ebMS element "eb:Messaging/eb:UserMessage/eb:CollaborationInfo/eb:Action". ## Data Type String # service_type property ([AS4Client](#struct-ipworksedias4client) Struct) The type of service. ## Syntax *Rust Syntax* ```text fn service_type(&self ) -> Result fn set_service_type(&self, value : &str) -> Option fn set_service_type_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks This optionally specifies the type of the service. The semantics of this value should be agreed upon by both parties ahead of time. It may be used to tell the other party how to interpret the [service](#service-property-as4client-struct) value. This value corresponds to the ebMS element "eb:Messaging/eb:UserMessage/eb:CollaborationInfo/eb:Service@type" ## Data Type String # signature_algorithm property ([AS4Client](#struct-ipworksedias4client) Struct) Signature algorithm to be used in the message. ## Syntax *Rust Syntax* ```text fn signature_algorithm(&self ) -> Result fn set_signature_algorithm(&self, value : &str) -> Option fn set_signature_algorithm_ref(&self, value : &String) -> Option ``` ## Default Value "sha-256" ## Remarks *Signature Algorithm* can be set to indicate the preferred signing algorithm. Possible values are: - SHA1 - MD5 - SHA-256 (or SHA256) (default) - SHA-384 (or SHA384) - SHA-512 (or SHA512) - SHA-224 (or SHA224) - ECDSA-SHA1 - ECDSA-SHA224 - ECDSA-SHA256 - ECDSA-SHA384 - ECDSA-SHA512 - EDDSA-ED25519 - EDDSA-ED448 The default value is "SHA-256". ## Data Type String # signer_cert_effective_date property ([AS4Client](#struct-ipworksedias4client) Struct) The date on which this certificate becomes valid. ## Syntax *Rust Syntax* ```text fn signer_cert_effective_date(&self ) -> Result ``` ## 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 ([AS4Client](#struct-ipworksedias4client) Struct) The date on which the certificate expires. ## Syntax *Rust Syntax* ```text fn signer_cert_expiration_date(&self ) -> Result ``` ## 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 # signer_cert_extended_key_usage property ([AS4Client](#struct-ipworksedias4client) Struct) A comma-delimited list of extended key usage identifiers. ## Syntax *Rust Syntax* ```text fn signer_cert_extended_key_usage(&self ) -> Result ``` ## 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 ([AS4Client](#struct-ipworksedias4client) Struct) The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax *Rust Syntax* ```text fn signer_cert_fingerprint(&self ) -> Result ``` ## 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 # signer_cert_fingerprint_sha1 property ([AS4Client](#struct-ipworksedias4client) Struct) The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax *Rust Syntax* ```text fn signer_cert_fingerprint_sha1(&self ) -> Result ``` ## 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 # signer_cert_fingerprint_sha256 property ([AS4Client](#struct-ipworksedias4client) Struct) The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax *Rust Syntax* ```text fn signer_cert_fingerprint_sha256(&self ) -> Result ``` ## 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 # signer_cert_issuer property ([AS4Client](#struct-ipworksedias4client) Struct) The issuer of the certificate. ## Syntax *Rust Syntax* ```text fn signer_cert_issuer(&self ) -> Result ``` ## 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 ([AS4Client](#struct-ipworksedias4client) Struct) The private key of the certificate (if available). ## Syntax *Rust Syntax* ```text fn signer_cert_private_key(&self ) -> Result ``` ## 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](#signer_cert_private_key-property-as4client-struct) may be available but not exportable. In this case, [signer_cert_private_key](#signer_cert_private_key-property-as4client-struct) returns an empty string. This property is read-only. ## Data Type String # signer_cert_private_key_available property ([AS4Client](#struct-ipworksedias4client) Struct) Whether a PrivateKey is available for the selected certificate. ## Syntax *Rust Syntax* ```text fn signer_cert_private_key_available(&self ) -> Result ``` ## Default Value false ## Remarks Whether a [signer_cert_private_key](#signer_cert_private_key-property-as4client-struct) is available for the selected certificate. If [signer_cert_private_key_available](#signer_cert_private_key_available-property-as4client-struct) 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 ([AS4Client](#struct-ipworksedias4client) Struct) The name of the PrivateKey container for the certificate (if available). ## Syntax *Rust Syntax* ```text fn signer_cert_private_key_container(&self ) -> Result ``` ## Default Value "" ## Remarks The name of the [signer_cert_private_key](#signer_cert_private_key-property-as4client-struct) 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 ([AS4Client](#struct-ipworksedias4client) Struct) The public key of the certificate. ## Syntax *Rust Syntax* ```text fn signer_cert_public_key(&self ) -> Result ``` ## 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 ([AS4Client](#struct-ipworksedias4client) Struct) The textual description of the certificate's public key algorithm. ## Syntax *Rust Syntax* ```text fn signer_cert_public_key_algorithm(&self ) -> Result ``` ## 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 # signer_cert_public_key_length property ([AS4Client](#struct-ipworksedias4client) Struct) The length of the certificate's public key (in bits). ## Syntax *Rust Syntax* ```text fn signer_cert_public_key_length(&self ) -> Result ``` ## Default Value 0 ## Remarks The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. This property is read-only. ## Data Type i32 # signer_cert_serial_number property ([AS4Client](#struct-ipworksedias4client) Struct) The serial number of the certificate encoded as a string. ## Syntax *Rust Syntax* ```text fn signer_cert_serial_number(&self ) -> Result ``` ## 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 ([AS4Client](#struct-ipworksedias4client) Struct) The text description of the certificate's signature algorithm. ## Syntax *Rust Syntax* ```text fn signer_cert_signature_algorithm(&self ) -> Result ``` ## 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 # signer_cert_store property ([AS4Client](#struct-ipworksedias4client) Struct) The name of the certificate store for the client certificate. ## Syntax *Rust Syntax* ```text fn signer_cert_store(&self ) -> Result, IPWorksEDIError> fn set_signer_cert_store(&self, value : Vec) -> Option fn set_signer_cert_store_ref(&self, value : &[u8]) -> Option ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [signer_cert_store_type](#signer_cert_store_type-property-as4client-struct) property denotes the type of the certificate store specified by [signer_cert_store](#signer_cert_store-property-as4client-struct). If the store is password-protected, specify the password in [signer_cert_store_password](#signer_cert_store_password-property-as4client-struct). [signer_cert_store](#signer_cert_store-property-as4client-struct) is used in conjunction with the [signer_cert_subject](#signer_cert_subject-property-as4client-struct) property to specify client certificates. If [signer_cert_store](#signer_cert_store-property-as4client-struct) has a value, and [signer_cert_subject](#signer_cert_subject-property-as4client-struct) or [signer_cert_encoded](#signer_cert_encoded-property-as4client-struct) is set, a search for a certificate is initiated. Please see the [signer_cert_subject](#signer_cert_subject-property-as4client-struct) 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 # signer_cert_store_password property ([AS4Client](#struct-ipworksedias4client) 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 *Rust Syntax* ```text fn signer_cert_store_password(&self ) -> Result fn set_signer_cert_store_password(&self, value : &str) -> Option fn set_signer_cert_store_password_ref(&self, value : &String) -> Option ``` ## 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 ([AS4Client](#struct-ipworksedias4client) Struct) The type of certificate store for this certificate. ## Syntax *Rust Syntax* ```text fn signer_cert_store_type(&self ) -> Result fn set_signer_cert_store_type(&self, value : i32) -> Option ``` ## Possible Values ```text 0 // User1 // Machine2 // PFXFile3 // PFXBlob4 // JKSFile5 // JKSBlob6 // PEMKeyFile7 // PEMKeyBlob8 // PublicKeyFile9 // PublicKeyBlob10 // SSHPublicKeyBlob11 // P7BFile12 // P7BBlob13 // SSHPublicKeyFile14 // PPKFile15 // PPKBlob16 // XMLFile17 // XMLBlob18 // JWKFile19 // JWKBlob20 // SecurityKey21 // BCFKSFile22 // BCFKSBlob23 // PKCS1199 // Auto ``` ## Default Value 0 ## 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: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. | | 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. | | 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. | | 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. | | 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. | | 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. | | 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. | | 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. | | 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. | | 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. | | 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. | | 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. | | 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. | | 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. | | 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). | | 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). | | 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. | | 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. | | 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). | | 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). | | 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. | | 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. | | 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [signer_cert_store_type](#signer_cert_store_type-property-as4client-struct), the full path of the PKCS#11 DLL as the [signer_cert_store](#signer_cert_store-property-as4client-struct), and the PIN as the [signer_cert_store_password](#signer_cert_store_password-property-as4client-struct). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) struct by calling the [list_store_certificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [on_cert_list](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [signer_cert_store](#signer_cert_store-property-as4client-struct) and set [signer_cert_store_password](#signer_cert_store_password-property-as4client-struct) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. | ## Data Type i32 # signer_cert_subject_alt_names property ([AS4Client](#struct-ipworksedias4client) Struct) Comma-separated lists of alternative subject names for the certificate. ## Syntax *Rust Syntax* ```text fn signer_cert_subject_alt_names(&self ) -> Result ``` ## 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 ([AS4Client](#struct-ipworksedias4client) Struct) The MD5 hash of the certificate. ## Syntax *Rust Syntax* ```text fn signer_cert_thumbprint_md5(&self ) -> Result ``` ## 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 ([AS4Client](#struct-ipworksedias4client) Struct) The SHA-1 hash of the certificate. ## Syntax *Rust Syntax* ```text fn signer_cert_thumbprint_sha1(&self ) -> Result ``` ## 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 ([AS4Client](#struct-ipworksedias4client) Struct) The SHA-256 hash of the certificate. ## Syntax *Rust Syntax* ```text fn signer_cert_thumbprint_sha256(&self ) -> Result ``` ## 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 ([AS4Client](#struct-ipworksedias4client) Struct) The text description of UsageFlags . ## Syntax *Rust Syntax* ```text fn signer_cert_usage(&self ) -> Result ``` ## Default Value "" ## Remarks The text description of [signer_cert_usage_flags](#signer_cert_usage_flags-property-as4client-struct). 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 ([AS4Client](#struct-ipworksedias4client) Struct) The flags that show intended use for the certificate. ## Syntax *Rust Syntax* ```text fn signer_cert_usage_flags(&self ) -> Result ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [signer_cert_usage_flags](#signer_cert_usage_flags-property-as4client-struct) 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](#signer_cert_usage-property-as4client-struct) property for a text representation of [signer_cert_usage_flags](#signer_cert_usage_flags-property-as4client-struct). This functionality currently is not available when the provider is OpenSSL. This property is read-only. ## Data Type i32 # signer_cert_version property ([AS4Client](#struct-ipworksedias4client) Struct) The certificate's version number. ## Syntax *Rust Syntax* ```text fn signer_cert_version(&self ) -> Result ``` ## 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 ([AS4Client](#struct-ipworksedias4client) Struct) The subject of the certificate used for client authentication. ## Syntax *Rust Syntax* ```text fn signer_cert_subject(&self ) -> Result fn set_signer_cert_subject(&self, value : &str) -> Option fn set_signer_cert_subject_ref(&self, value : &String) -> Option ``` ## 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 # signer_cert_encoded property ([AS4Client](#struct-ipworksedias4client) Struct) The certificate (PEM/Base64 encoded). ## Syntax *Rust Syntax* ```text fn signer_cert_encoded(&self ) -> Result, IPWorksEDIError> fn set_signer_cert_encoded(&self, value : Vec) -> Option fn set_signer_cert_encoded_ref(&self, value : &[u8]) -> Option ``` ## Default Value "" ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [signer_cert_store](#signer_cert_store-property-as4client-struct) and [signer_cert_subject](#signer_cert_subject-property-as4client-struct) properties also may be used to specify a certificate. When [signer_cert_encoded](#signer_cert_encoded-property-as4client-struct) is set, a search is initiated in the current [signer_cert_store](#signer_cert_store-property-as4client-struct) for the private key of the certificate. If the key is found, [signer_cert_subject](#signer_cert_subject-property-as4client-struct) is updated to reflect the full subject of the selected certificate; otherwise, [signer_cert_subject](#signer_cert_subject-property-as4client-struct) is set to an empty string. ## Data Type Vec # signing_cert_effective_date property ([AS4Client](#struct-ipworksedias4client) Struct) The date on which this certificate becomes valid. ## Syntax *Rust Syntax* ```text fn signing_cert_effective_date(&self ) -> Result ``` ## 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 # signing_cert_expiration_date property ([AS4Client](#struct-ipworksedias4client) Struct) The date on which the certificate expires. ## Syntax *Rust Syntax* ```text fn signing_cert_expiration_date(&self ) -> Result ``` ## 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 # signing_cert_extended_key_usage property ([AS4Client](#struct-ipworksedias4client) Struct) A comma-delimited list of extended key usage identifiers. ## Syntax *Rust Syntax* ```text fn signing_cert_extended_key_usage(&self ) -> Result ``` ## 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 # signing_cert_fingerprint property ([AS4Client](#struct-ipworksedias4client) Struct) The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax *Rust Syntax* ```text fn signing_cert_fingerprint(&self ) -> Result ``` ## 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 # signing_cert_fingerprint_sha1 property ([AS4Client](#struct-ipworksedias4client) Struct) The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax *Rust Syntax* ```text fn signing_cert_fingerprint_sha1(&self ) -> Result ``` ## 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 # signing_cert_fingerprint_sha256 property ([AS4Client](#struct-ipworksedias4client) Struct) The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax *Rust Syntax* ```text fn signing_cert_fingerprint_sha256(&self ) -> Result ``` ## 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 # signing_cert_issuer property ([AS4Client](#struct-ipworksedias4client) Struct) The issuer of the certificate. ## Syntax *Rust Syntax* ```text fn signing_cert_issuer(&self ) -> Result ``` ## 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 # signing_cert_private_key property ([AS4Client](#struct-ipworksedias4client) Struct) The private key of the certificate (if available). ## Syntax *Rust Syntax* ```text fn signing_cert_private_key(&self ) -> Result ``` ## Default Value "" ## Remarks The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [signing_cert_private_key](#signing_cert_private_key-property-as4client-struct) may be available but not exportable. In this case, [signing_cert_private_key](#signing_cert_private_key-property-as4client-struct) returns an empty string. This property is read-only. ## Data Type String # signing_cert_private_key_available property ([AS4Client](#struct-ipworksedias4client) Struct) Whether a PrivateKey is available for the selected certificate. ## Syntax *Rust Syntax* ```text fn signing_cert_private_key_available(&self ) -> Result ``` ## Default Value false ## Remarks Whether a [signing_cert_private_key](#signing_cert_private_key-property-as4client-struct) is available for the selected certificate. If [signing_cert_private_key_available](#signing_cert_private_key_available-property-as4client-struct) is True, the certificate may be used for authentication purposes (e.g., server authentication). This property is read-only. ## Data Type bool # signing_cert_private_key_container property ([AS4Client](#struct-ipworksedias4client) Struct) The name of the PrivateKey container for the certificate (if available). ## Syntax *Rust Syntax* ```text fn signing_cert_private_key_container(&self ) -> Result ``` ## Default Value "" ## Remarks The name of the [signing_cert_private_key](#signing_cert_private_key-property-as4client-struct) container for the certificate (if available). This functionality is available only on Windows platforms. This property is read-only. ## Data Type String # signing_cert_public_key property ([AS4Client](#struct-ipworksedias4client) Struct) The public key of the certificate. ## Syntax *Rust Syntax* ```text fn signing_cert_public_key(&self ) -> Result ``` ## 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 # signing_cert_public_key_algorithm property ([AS4Client](#struct-ipworksedias4client) Struct) The textual description of the certificate's public key algorithm. ## Syntax *Rust Syntax* ```text fn signing_cert_public_key_algorithm(&self ) -> Result ``` ## 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 # signing_cert_public_key_length property ([AS4Client](#struct-ipworksedias4client) Struct) The length of the certificate's public key (in bits). ## Syntax *Rust Syntax* ```text fn signing_cert_public_key_length(&self ) -> Result ``` ## Default Value 0 ## Remarks The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. This property is read-only. ## Data Type i32 # signing_cert_serial_number property ([AS4Client](#struct-ipworksedias4client) Struct) The serial number of the certificate encoded as a string. ## Syntax *Rust Syntax* ```text fn signing_cert_serial_number(&self ) -> Result ``` ## 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 # signing_cert_signature_algorithm property ([AS4Client](#struct-ipworksedias4client) Struct) The text description of the certificate's signature algorithm. ## Syntax *Rust Syntax* ```text fn signing_cert_signature_algorithm(&self ) -> Result ``` ## 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 # signing_cert_store property ([AS4Client](#struct-ipworksedias4client) Struct) The name of the certificate store for the client certificate. ## Syntax *Rust Syntax* ```text fn signing_cert_store(&self ) -> Result, IPWorksEDIError> fn set_signing_cert_store(&self, value : Vec) -> Option fn set_signing_cert_store_ref(&self, value : &[u8]) -> Option ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [signing_cert_store_type](#signing_cert_store_type-property-as4client-struct) property denotes the type of the certificate store specified by [signing_cert_store](#signing_cert_store-property-as4client-struct). If the store is password-protected, specify the password in [signing_cert_store_password](#signing_cert_store_password-property-as4client-struct). [signing_cert_store](#signing_cert_store-property-as4client-struct) is used in conjunction with the [signing_cert_subject](#signing_cert_subject-property-as4client-struct) property to specify client certificates. If [signing_cert_store](#signing_cert_store-property-as4client-struct) has a value, and [signing_cert_subject](#signing_cert_subject-property-as4client-struct) or [signing_cert_encoded](#signing_cert_encoded-property-as4client-struct) is set, a search for a certificate is initiated. Please see the [signing_cert_subject](#signing_cert_subject-property-as4client-struct) 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 # signing_cert_store_password property ([AS4Client](#struct-ipworksedias4client) 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 *Rust Syntax* ```text fn signing_cert_store_password(&self ) -> Result fn set_signing_cert_store_password(&self, value : &str) -> Option fn set_signing_cert_store_password_ref(&self, value : &String) -> Option ``` ## 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 # signing_cert_store_type property ([AS4Client](#struct-ipworksedias4client) Struct) The type of certificate store for this certificate. ## Syntax *Rust Syntax* ```text fn signing_cert_store_type(&self ) -> Result fn set_signing_cert_store_type(&self, value : i32) -> Option ``` ## Possible Values ```text 0 // User1 // Machine2 // PFXFile3 // PFXBlob4 // JKSFile5 // JKSBlob6 // PEMKeyFile7 // PEMKeyBlob8 // PublicKeyFile9 // PublicKeyBlob10 // SSHPublicKeyBlob11 // P7BFile12 // P7BBlob13 // SSHPublicKeyFile14 // PPKFile15 // PPKBlob16 // XMLFile17 // XMLBlob18 // JWKFile19 // JWKBlob20 // SecurityKey21 // BCFKSFile22 // BCFKSBlob23 // PKCS1199 // Auto ``` ## Default Value 0 ## 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: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. | | 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. | | 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. | | 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. | | 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. | | 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. | | 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. | | 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. | | 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. | | 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. | | 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. | | 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. | | 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. | | 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. | | 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). | | 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). | | 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. | | 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. | | 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). | | 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). | | 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. | | 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. | | 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [signing_cert_store_type](#signing_cert_store_type-property-as4client-struct), the full path of the PKCS#11 DLL as the [signing_cert_store](#signing_cert_store-property-as4client-struct), and the PIN as the [signing_cert_store_password](#signing_cert_store_password-property-as4client-struct). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) struct by calling the [list_store_certificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [on_cert_list](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [signing_cert_store](#signing_cert_store-property-as4client-struct) and set [signing_cert_store_password](#signing_cert_store_password-property-as4client-struct) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. | ## Data Type i32 # signing_cert_subject_alt_names property ([AS4Client](#struct-ipworksedias4client) Struct) Comma-separated lists of alternative subject names for the certificate. ## Syntax *Rust Syntax* ```text fn signing_cert_subject_alt_names(&self ) -> Result ``` ## Default Value "" ## Remarks Comma-separated lists of alternative subject names for the certificate. This property is read-only. ## Data Type String # signing_cert_thumbprint_md5 property ([AS4Client](#struct-ipworksedias4client) Struct) The MD5 hash of the certificate. ## Syntax *Rust Syntax* ```text fn signing_cert_thumbprint_md5(&self ) -> Result ``` ## 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 # signing_cert_thumbprint_sha1 property ([AS4Client](#struct-ipworksedias4client) Struct) The SHA-1 hash of the certificate. ## Syntax *Rust Syntax* ```text fn signing_cert_thumbprint_sha1(&self ) -> Result ``` ## 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 # signing_cert_thumbprint_sha256 property ([AS4Client](#struct-ipworksedias4client) Struct) The SHA-256 hash of the certificate. ## Syntax *Rust Syntax* ```text fn signing_cert_thumbprint_sha256(&self ) -> Result ``` ## 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 # signing_cert_usage property ([AS4Client](#struct-ipworksedias4client) Struct) The text description of UsageFlags . ## Syntax *Rust Syntax* ```text fn signing_cert_usage(&self ) -> Result ``` ## Default Value "" ## Remarks The text description of [signing_cert_usage_flags](#signing_cert_usage_flags-property-as4client-struct). 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 # signing_cert_usage_flags property ([AS4Client](#struct-ipworksedias4client) Struct) The flags that show intended use for the certificate. ## Syntax *Rust Syntax* ```text fn signing_cert_usage_flags(&self ) -> Result ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [signing_cert_usage_flags](#signing_cert_usage_flags-property-as4client-struct) 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 [signing_cert_usage](#signing_cert_usage-property-as4client-struct) property for a text representation of [signing_cert_usage_flags](#signing_cert_usage_flags-property-as4client-struct). This functionality currently is not available when the provider is OpenSSL. This property is read-only. ## Data Type i32 # signing_cert_version property ([AS4Client](#struct-ipworksedias4client) Struct) The certificate's version number. ## Syntax *Rust Syntax* ```text fn signing_cert_version(&self ) -> Result ``` ## 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 # signing_cert_subject property ([AS4Client](#struct-ipworksedias4client) Struct) The subject of the certificate used for client authentication. ## Syntax *Rust Syntax* ```text fn signing_cert_subject(&self ) -> Result fn set_signing_cert_subject(&self, value : &str) -> Option fn set_signing_cert_subject_ref(&self, value : &String) -> Option ``` ## 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 # signing_cert_encoded property ([AS4Client](#struct-ipworksedias4client) Struct) The certificate (PEM/Base64 encoded). ## Syntax *Rust Syntax* ```text fn signing_cert_encoded(&self ) -> Result, IPWorksEDIError> fn set_signing_cert_encoded(&self, value : Vec) -> Option fn set_signing_cert_encoded_ref(&self, value : &[u8]) -> Option ``` ## Default Value "" ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [signing_cert_store](#signing_cert_store-property-as4client-struct) and [signing_cert_subject](#signing_cert_subject-property-as4client-struct) properties also may be used to specify a certificate. When [signing_cert_encoded](#signing_cert_encoded-property-as4client-struct) is set, a search is initiated in the current [signing_cert_store](#signing_cert_store-property-as4client-struct) for the private key of the certificate. If the key is found, [signing_cert_subject](#signing_cert_subject-property-as4client-struct) is updated to reflect the full subject of the selected certificate; otherwise, [signing_cert_subject](#signing_cert_subject-property-as4client-struct) is set to an empty string. ## Data Type Vec # ssl_accept_server_cert_effective_date property ([AS4Client](#struct-ipworksedias4client) Struct) The date on which this certificate becomes valid. ## Syntax *Rust Syntax* ```text fn ssl_accept_server_cert_effective_date(&self ) -> Result ``` ## 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 ([AS4Client](#struct-ipworksedias4client) Struct) The date on which the certificate expires. ## Syntax *Rust Syntax* ```text fn ssl_accept_server_cert_expiration_date(&self ) -> Result ``` ## 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 # ssl_accept_server_cert_extended_key_usage property ([AS4Client](#struct-ipworksedias4client) Struct) A comma-delimited list of extended key usage identifiers. ## Syntax *Rust Syntax* ```text fn ssl_accept_server_cert_extended_key_usage(&self ) -> Result ``` ## 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 ([AS4Client](#struct-ipworksedias4client) Struct) The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax *Rust Syntax* ```text fn ssl_accept_server_cert_fingerprint(&self ) -> Result ``` ## 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 # ssl_accept_server_cert_fingerprint_sha1 property ([AS4Client](#struct-ipworksedias4client) Struct) The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax *Rust Syntax* ```text fn ssl_accept_server_cert_fingerprint_sha1(&self ) -> Result ``` ## 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 # ssl_accept_server_cert_fingerprint_sha256 property ([AS4Client](#struct-ipworksedias4client) Struct) The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax *Rust Syntax* ```text fn ssl_accept_server_cert_fingerprint_sha256(&self ) -> Result ``` ## 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 # ssl_accept_server_cert_issuer property ([AS4Client](#struct-ipworksedias4client) Struct) The issuer of the certificate. ## Syntax *Rust Syntax* ```text fn ssl_accept_server_cert_issuer(&self ) -> Result ``` ## 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 ([AS4Client](#struct-ipworksedias4client) Struct) The private key of the certificate (if available). ## Syntax *Rust Syntax* ```text fn ssl_accept_server_cert_private_key(&self ) -> Result ``` ## 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](#ssl_accept_server_cert_private_key-property-as4client-struct) may be available but not exportable. In this case, [ssl_accept_server_cert_private_key](#ssl_accept_server_cert_private_key-property-as4client-struct) returns an empty string. This property is read-only. ## Data Type String # ssl_accept_server_cert_private_key_available property ([AS4Client](#struct-ipworksedias4client) Struct) Whether a PrivateKey is available for the selected certificate. ## Syntax *Rust Syntax* ```text fn ssl_accept_server_cert_private_key_available(&self ) -> Result ``` ## Default Value false ## Remarks Whether a [ssl_accept_server_cert_private_key](#ssl_accept_server_cert_private_key-property-as4client-struct) is available for the selected certificate. If [ssl_accept_server_cert_private_key_available](#ssl_accept_server_cert_private_key_available-property-as4client-struct) 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 ([AS4Client](#struct-ipworksedias4client) Struct) The name of the PrivateKey container for the certificate (if available). ## Syntax *Rust Syntax* ```text fn ssl_accept_server_cert_private_key_container(&self ) -> Result ``` ## Default Value "" ## Remarks The name of the [ssl_accept_server_cert_private_key](#ssl_accept_server_cert_private_key-property-as4client-struct) 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 ([AS4Client](#struct-ipworksedias4client) Struct) The public key of the certificate. ## Syntax *Rust Syntax* ```text fn ssl_accept_server_cert_public_key(&self ) -> Result ``` ## 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 ([AS4Client](#struct-ipworksedias4client) Struct) The textual description of the certificate's public key algorithm. ## Syntax *Rust Syntax* ```text fn ssl_accept_server_cert_public_key_algorithm(&self ) -> Result ``` ## 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 # ssl_accept_server_cert_public_key_length property ([AS4Client](#struct-ipworksedias4client) Struct) The length of the certificate's public key (in bits). ## Syntax *Rust Syntax* ```text fn ssl_accept_server_cert_public_key_length(&self ) -> Result ``` ## Default Value 0 ## Remarks The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. This property is read-only. ## Data Type i32 # ssl_accept_server_cert_serial_number property ([AS4Client](#struct-ipworksedias4client) Struct) The serial number of the certificate encoded as a string. ## Syntax *Rust Syntax* ```text fn ssl_accept_server_cert_serial_number(&self ) -> Result ``` ## 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 ([AS4Client](#struct-ipworksedias4client) Struct) The text description of the certificate's signature algorithm. ## Syntax *Rust Syntax* ```text fn ssl_accept_server_cert_signature_algorithm(&self ) -> Result ``` ## 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 # ssl_accept_server_cert_store property ([AS4Client](#struct-ipworksedias4client) Struct) The name of the certificate store for the client certificate. ## Syntax *Rust Syntax* ```text fn ssl_accept_server_cert_store(&self ) -> Result, IPWorksEDIError> fn set_ssl_accept_server_cert_store(&self, value : Vec) -> Option fn set_ssl_accept_server_cert_store_ref(&self, value : &[u8]) -> Option ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [ssl_accept_server_cert_store_type](#ssl_accept_server_cert_store_type-property-as4client-struct) property denotes the type of the certificate store specified by [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property-as4client-struct). If the store is password-protected, specify the password in [ssl_accept_server_cert_store_password](#ssl_accept_server_cert_store_password-property-as4client-struct). [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property-as4client-struct) is used in conjunction with the [ssl_accept_server_cert_subject](#ssl_accept_server_cert_subject-property-as4client-struct) property to specify client certificates. If [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property-as4client-struct) has a value, and [ssl_accept_server_cert_subject](#ssl_accept_server_cert_subject-property-as4client-struct) or [ssl_accept_server_cert_encoded](#ssl_accept_server_cert_encoded-property-as4client-struct) is set, a search for a certificate is initiated. Please see the [ssl_accept_server_cert_subject](#ssl_accept_server_cert_subject-property-as4client-struct) 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 # ssl_accept_server_cert_store_password property ([AS4Client](#struct-ipworksedias4client) 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 *Rust Syntax* ```text fn ssl_accept_server_cert_store_password(&self ) -> Result fn set_ssl_accept_server_cert_store_password(&self, value : &str) -> Option fn set_ssl_accept_server_cert_store_password_ref(&self, value : &String) -> Option ``` ## 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 ([AS4Client](#struct-ipworksedias4client) Struct) The type of certificate store for this certificate. ## Syntax *Rust Syntax* ```text fn ssl_accept_server_cert_store_type(&self ) -> Result fn set_ssl_accept_server_cert_store_type(&self, value : i32) -> Option ``` ## Possible Values ```text 0 // User1 // Machine2 // PFXFile3 // PFXBlob4 // JKSFile5 // JKSBlob6 // PEMKeyFile7 // PEMKeyBlob8 // PublicKeyFile9 // PublicKeyBlob10 // SSHPublicKeyBlob11 // P7BFile12 // P7BBlob13 // SSHPublicKeyFile14 // PPKFile15 // PPKBlob16 // XMLFile17 // XMLBlob18 // JWKFile19 // JWKBlob20 // SecurityKey21 // BCFKSFile22 // BCFKSBlob23 // PKCS1199 // Auto ``` ## Default Value 0 ## 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: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. | | 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. | | 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. | | 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. | | 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. | | 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. | | 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. | | 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. | | 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. | | 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. | | 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. | | 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. | | 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. | | 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. | | 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). | | 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). | | 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. | | 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. | | 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). | | 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). | | 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. | | 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. | | 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [ssl_accept_server_cert_store_type](#ssl_accept_server_cert_store_type-property-as4client-struct), the full path of the PKCS#11 DLL as the [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property-as4client-struct), and the PIN as the [ssl_accept_server_cert_store_password](#ssl_accept_server_cert_store_password-property-as4client-struct). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) struct by calling the [list_store_certificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [on_cert_list](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property-as4client-struct) and set [ssl_accept_server_cert_store_password](#ssl_accept_server_cert_store_password-property-as4client-struct) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. | ## Data Type i32 # ssl_accept_server_cert_subject_alt_names property ([AS4Client](#struct-ipworksedias4client) Struct) Comma-separated lists of alternative subject names for the certificate. ## Syntax *Rust Syntax* ```text fn ssl_accept_server_cert_subject_alt_names(&self ) -> Result ``` ## 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 ([AS4Client](#struct-ipworksedias4client) Struct) The MD5 hash of the certificate. ## Syntax *Rust Syntax* ```text fn ssl_accept_server_cert_thumbprint_md5(&self ) -> Result ``` ## 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 ([AS4Client](#struct-ipworksedias4client) Struct) The SHA-1 hash of the certificate. ## Syntax *Rust Syntax* ```text fn ssl_accept_server_cert_thumbprint_sha1(&self ) -> Result ``` ## 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 ([AS4Client](#struct-ipworksedias4client) Struct) The SHA-256 hash of the certificate. ## Syntax *Rust Syntax* ```text fn ssl_accept_server_cert_thumbprint_sha256(&self ) -> Result ``` ## 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 ([AS4Client](#struct-ipworksedias4client) Struct) The text description of UsageFlags . ## Syntax *Rust Syntax* ```text fn ssl_accept_server_cert_usage(&self ) -> Result ``` ## Default Value "" ## Remarks The text description of [ssl_accept_server_cert_usage_flags](#ssl_accept_server_cert_usage_flags-property-as4client-struct). 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 ([AS4Client](#struct-ipworksedias4client) Struct) The flags that show intended use for the certificate. ## Syntax *Rust Syntax* ```text fn ssl_accept_server_cert_usage_flags(&self ) -> Result ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [ssl_accept_server_cert_usage_flags](#ssl_accept_server_cert_usage_flags-property-as4client-struct) 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](#ssl_accept_server_cert_usage-property-as4client-struct) property for a text representation of [ssl_accept_server_cert_usage_flags](#ssl_accept_server_cert_usage_flags-property-as4client-struct). 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 ([AS4Client](#struct-ipworksedias4client) Struct) The certificate's version number. ## Syntax *Rust Syntax* ```text fn ssl_accept_server_cert_version(&self ) -> Result ``` ## 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 ([AS4Client](#struct-ipworksedias4client) Struct) The subject of the certificate used for client authentication. ## Syntax *Rust Syntax* ```text fn ssl_accept_server_cert_subject(&self ) -> Result fn set_ssl_accept_server_cert_subject(&self, value : &str) -> Option fn set_ssl_accept_server_cert_subject_ref(&self, value : &String) -> Option ``` ## 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 # ssl_accept_server_cert_encoded property ([AS4Client](#struct-ipworksedias4client) Struct) The certificate (PEM/Base64 encoded). ## Syntax *Rust Syntax* ```text fn ssl_accept_server_cert_encoded(&self ) -> Result, IPWorksEDIError> fn set_ssl_accept_server_cert_encoded(&self, value : Vec) -> Option fn set_ssl_accept_server_cert_encoded_ref(&self, value : &[u8]) -> Option ``` ## Default Value "" ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property-as4client-struct) and [ssl_accept_server_cert_subject](#ssl_accept_server_cert_subject-property-as4client-struct) properties also may be used to specify a certificate. When [ssl_accept_server_cert_encoded](#ssl_accept_server_cert_encoded-property-as4client-struct) is set, a search is initiated in the current [ssl_accept_server_cert_store](#ssl_accept_server_cert_store-property-as4client-struct) for the private key of the certificate. If the key is found, [ssl_accept_server_cert_subject](#ssl_accept_server_cert_subject-property-as4client-struct) is updated to reflect the full subject of the selected certificate; otherwise, [ssl_accept_server_cert_subject](#ssl_accept_server_cert_subject-property-as4client-struct) is set to an empty string. ## Data Type Vec # ssl_cert_effective_date property ([AS4Client](#struct-ipworksedias4client) Struct) The date on which this certificate becomes valid. ## Syntax *Rust Syntax* ```text fn ssl_cert_effective_date(&self ) -> Result ``` ## 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 ([AS4Client](#struct-ipworksedias4client) Struct) The date on which the certificate expires. ## Syntax *Rust Syntax* ```text fn ssl_cert_expiration_date(&self ) -> Result ``` ## 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 # ssl_cert_extended_key_usage property ([AS4Client](#struct-ipworksedias4client) Struct) A comma-delimited list of extended key usage identifiers. ## Syntax *Rust Syntax* ```text fn ssl_cert_extended_key_usage(&self ) -> Result ``` ## 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 ([AS4Client](#struct-ipworksedias4client) Struct) The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax *Rust Syntax* ```text fn ssl_cert_fingerprint(&self ) -> Result ``` ## 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 # ssl_cert_fingerprint_sha1 property ([AS4Client](#struct-ipworksedias4client) Struct) The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax *Rust Syntax* ```text fn ssl_cert_fingerprint_sha1(&self ) -> Result ``` ## 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 # ssl_cert_fingerprint_sha256 property ([AS4Client](#struct-ipworksedias4client) Struct) The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax *Rust Syntax* ```text fn ssl_cert_fingerprint_sha256(&self ) -> Result ``` ## 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 # ssl_cert_issuer property ([AS4Client](#struct-ipworksedias4client) Struct) The issuer of the certificate. ## Syntax *Rust Syntax* ```text fn ssl_cert_issuer(&self ) -> Result ``` ## 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 ([AS4Client](#struct-ipworksedias4client) Struct) The private key of the certificate (if available). ## Syntax *Rust Syntax* ```text fn ssl_cert_private_key(&self ) -> Result ``` ## 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](#ssl_cert_private_key-property-as4client-struct) may be available but not exportable. In this case, [ssl_cert_private_key](#ssl_cert_private_key-property-as4client-struct) returns an empty string. This property is read-only. ## Data Type String # ssl_cert_private_key_available property ([AS4Client](#struct-ipworksedias4client) Struct) Whether a PrivateKey is available for the selected certificate. ## Syntax *Rust Syntax* ```text fn ssl_cert_private_key_available(&self ) -> Result ``` ## Default Value false ## Remarks Whether a [ssl_cert_private_key](#ssl_cert_private_key-property-as4client-struct) is available for the selected certificate. If [ssl_cert_private_key_available](#ssl_cert_private_key_available-property-as4client-struct) 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 ([AS4Client](#struct-ipworksedias4client) Struct) The name of the PrivateKey container for the certificate (if available). ## Syntax *Rust Syntax* ```text fn ssl_cert_private_key_container(&self ) -> Result ``` ## Default Value "" ## Remarks The name of the [ssl_cert_private_key](#ssl_cert_private_key-property-as4client-struct) 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 ([AS4Client](#struct-ipworksedias4client) Struct) The public key of the certificate. ## Syntax *Rust Syntax* ```text fn ssl_cert_public_key(&self ) -> Result ``` ## 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 ([AS4Client](#struct-ipworksedias4client) Struct) The textual description of the certificate's public key algorithm. ## Syntax *Rust Syntax* ```text fn ssl_cert_public_key_algorithm(&self ) -> Result ``` ## 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 # ssl_cert_public_key_length property ([AS4Client](#struct-ipworksedias4client) Struct) The length of the certificate's public key (in bits). ## Syntax *Rust Syntax* ```text fn ssl_cert_public_key_length(&self ) -> Result ``` ## Default Value 0 ## Remarks The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. This property is read-only. ## Data Type i32 # ssl_cert_serial_number property ([AS4Client](#struct-ipworksedias4client) Struct) The serial number of the certificate encoded as a string. ## Syntax *Rust Syntax* ```text fn ssl_cert_serial_number(&self ) -> Result ``` ## 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 ([AS4Client](#struct-ipworksedias4client) Struct) The text description of the certificate's signature algorithm. ## Syntax *Rust Syntax* ```text fn ssl_cert_signature_algorithm(&self ) -> Result ``` ## 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 # ssl_cert_store property ([AS4Client](#struct-ipworksedias4client) Struct) The name of the certificate store for the client certificate. ## Syntax *Rust Syntax* ```text fn ssl_cert_store(&self ) -> Result, IPWorksEDIError> fn set_ssl_cert_store(&self, value : Vec) -> Option fn set_ssl_cert_store_ref(&self, value : &[u8]) -> Option ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [ssl_cert_store_type](#ssl_cert_store_type-property-as4client-struct) property denotes the type of the certificate store specified by [ssl_cert_store](#ssl_cert_store-property-as4client-struct). If the store is password-protected, specify the password in [ssl_cert_store_password](#ssl_cert_store_password-property-as4client-struct). [ssl_cert_store](#ssl_cert_store-property-as4client-struct) is used in conjunction with the [ssl_cert_subject](#ssl_cert_subject-property-as4client-struct) property to specify client certificates. If [ssl_cert_store](#ssl_cert_store-property-as4client-struct) has a value, and [ssl_cert_subject](#ssl_cert_subject-property-as4client-struct) or [ssl_cert_encoded](#ssl_cert_encoded-property-as4client-struct) is set, a search for a certificate is initiated. Please see the [ssl_cert_subject](#ssl_cert_subject-property-as4client-struct) 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 # ssl_cert_store_password property ([AS4Client](#struct-ipworksedias4client) 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 *Rust Syntax* ```text fn ssl_cert_store_password(&self ) -> Result fn set_ssl_cert_store_password(&self, value : &str) -> Option fn set_ssl_cert_store_password_ref(&self, value : &String) -> Option ``` ## 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 ([AS4Client](#struct-ipworksedias4client) Struct) The type of certificate store for this certificate. ## Syntax *Rust Syntax* ```text fn ssl_cert_store_type(&self ) -> Result fn set_ssl_cert_store_type(&self, value : i32) -> Option ``` ## Possible Values ```text 0 // User1 // Machine2 // PFXFile3 // PFXBlob4 // JKSFile5 // JKSBlob6 // PEMKeyFile7 // PEMKeyBlob8 // PublicKeyFile9 // PublicKeyBlob10 // SSHPublicKeyBlob11 // P7BFile12 // P7BBlob13 // SSHPublicKeyFile14 // PPKFile15 // PPKBlob16 // XMLFile17 // XMLBlob18 // JWKFile19 // JWKBlob20 // SecurityKey21 // BCFKSFile22 // BCFKSBlob23 // PKCS1199 // Auto ``` ## Default Value 0 ## 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: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. | | 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. | | 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. | | 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. | | 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. | | 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. | | 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. | | 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. | | 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. | | 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. | | 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. | | 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. | | 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. | | 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. | | 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). | | 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). | | 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. | | 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. | | 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). | | 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). | | 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. | | 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. | | 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [ssl_cert_store_type](#ssl_cert_store_type-property-as4client-struct), the full path of the PKCS#11 DLL as the [ssl_cert_store](#ssl_cert_store-property-as4client-struct), and the PIN as the [ssl_cert_store_password](#ssl_cert_store_password-property-as4client-struct). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) struct by calling the [list_store_certificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [on_cert_list](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [ssl_cert_store](#ssl_cert_store-property-as4client-struct) and set [ssl_cert_store_password](#ssl_cert_store_password-property-as4client-struct) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. | ## Data Type i32 # ssl_cert_subject_alt_names property ([AS4Client](#struct-ipworksedias4client) Struct) Comma-separated lists of alternative subject names for the certificate. ## Syntax *Rust Syntax* ```text fn ssl_cert_subject_alt_names(&self ) -> Result ``` ## 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 ([AS4Client](#struct-ipworksedias4client) Struct) The MD5 hash of the certificate. ## Syntax *Rust Syntax* ```text fn ssl_cert_thumbprint_md5(&self ) -> Result ``` ## 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 ([AS4Client](#struct-ipworksedias4client) Struct) The SHA-1 hash of the certificate. ## Syntax *Rust Syntax* ```text fn ssl_cert_thumbprint_sha1(&self ) -> Result ``` ## 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 ([AS4Client](#struct-ipworksedias4client) Struct) The SHA-256 hash of the certificate. ## Syntax *Rust Syntax* ```text fn ssl_cert_thumbprint_sha256(&self ) -> Result ``` ## 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 ([AS4Client](#struct-ipworksedias4client) Struct) The text description of UsageFlags . ## Syntax *Rust Syntax* ```text fn ssl_cert_usage(&self ) -> Result ``` ## Default Value "" ## Remarks The text description of [ssl_cert_usage_flags](#ssl_cert_usage_flags-property-as4client-struct). 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 ([AS4Client](#struct-ipworksedias4client) Struct) The flags that show intended use for the certificate. ## Syntax *Rust Syntax* ```text fn ssl_cert_usage_flags(&self ) -> Result ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [ssl_cert_usage_flags](#ssl_cert_usage_flags-property-as4client-struct) 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](#ssl_cert_usage-property-as4client-struct) property for a text representation of [ssl_cert_usage_flags](#ssl_cert_usage_flags-property-as4client-struct). This functionality currently is not available when the provider is OpenSSL. This property is read-only. ## Data Type i32 # ssl_cert_version property ([AS4Client](#struct-ipworksedias4client) Struct) The certificate's version number. ## Syntax *Rust Syntax* ```text fn ssl_cert_version(&self ) -> Result ``` ## 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 ([AS4Client](#struct-ipworksedias4client) Struct) The subject of the certificate used for client authentication. ## Syntax *Rust Syntax* ```text fn ssl_cert_subject(&self ) -> Result fn set_ssl_cert_subject(&self, value : &str) -> Option fn set_ssl_cert_subject_ref(&self, value : &String) -> Option ``` ## 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 # ssl_cert_encoded property ([AS4Client](#struct-ipworksedias4client) Struct) The certificate (PEM/Base64 encoded). ## Syntax *Rust Syntax* ```text fn ssl_cert_encoded(&self ) -> Result, IPWorksEDIError> fn set_ssl_cert_encoded(&self, value : Vec) -> Option fn set_ssl_cert_encoded_ref(&self, value : &[u8]) -> Option ``` ## Default Value "" ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [ssl_cert_store](#ssl_cert_store-property-as4client-struct) and [ssl_cert_subject](#ssl_cert_subject-property-as4client-struct) properties also may be used to specify a certificate. When [ssl_cert_encoded](#ssl_cert_encoded-property-as4client-struct) is set, a search is initiated in the current [ssl_cert_store](#ssl_cert_store-property-as4client-struct) for the private key of the certificate. If the key is found, [ssl_cert_subject](#ssl_cert_subject-property-as4client-struct) is updated to reflect the full subject of the selected certificate; otherwise, [ssl_cert_subject](#ssl_cert_subject-property-as4client-struct) is set to an empty string. ## Data Type Vec # ssl_provider property ([AS4Client](#struct-ipworksedias4client) Struct) The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use. ## Syntax *Rust Syntax* ```text fn ssl_provider(&self ) -> Result fn set_ssl_provider(&self, value : i32) -> Option ``` ## Possible Values ```text 0 // Automatic1 // Platform2 // Internal ``` ## Default Value 0 ## Remarks This property specifies the SSL/TLS implementation to use. In most cases the default value of *0* (Automatic) is recommended and should not be changed. When set to *0* (Automatic), the 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](#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 ([AS4Client](#struct-ipworksedias4client) Struct) The date on which this certificate becomes valid. ## Syntax *Rust Syntax* ```text fn ssl_server_cert_effective_date(&self ) -> Result ``` ## 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 ([AS4Client](#struct-ipworksedias4client) Struct) The date on which the certificate expires. ## Syntax *Rust Syntax* ```text fn ssl_server_cert_expiration_date(&self ) -> Result ``` ## 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 # ssl_server_cert_extended_key_usage property ([AS4Client](#struct-ipworksedias4client) Struct) A comma-delimited list of extended key usage identifiers. ## Syntax *Rust Syntax* ```text fn ssl_server_cert_extended_key_usage(&self ) -> Result ``` ## 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 ([AS4Client](#struct-ipworksedias4client) Struct) The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax *Rust Syntax* ```text fn ssl_server_cert_fingerprint(&self ) -> Result ``` ## 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 # ssl_server_cert_fingerprint_sha1 property ([AS4Client](#struct-ipworksedias4client) Struct) The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax *Rust Syntax* ```text fn ssl_server_cert_fingerprint_sha1(&self ) -> Result ``` ## 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 # ssl_server_cert_fingerprint_sha256 property ([AS4Client](#struct-ipworksedias4client) Struct) The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax *Rust Syntax* ```text fn ssl_server_cert_fingerprint_sha256(&self ) -> Result ``` ## 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 # ssl_server_cert_issuer property ([AS4Client](#struct-ipworksedias4client) Struct) The issuer of the certificate. ## Syntax *Rust Syntax* ```text fn ssl_server_cert_issuer(&self ) -> Result ``` ## 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 ([AS4Client](#struct-ipworksedias4client) Struct) The private key of the certificate (if available). ## Syntax *Rust Syntax* ```text fn ssl_server_cert_private_key(&self ) -> Result ``` ## 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](#ssl_server_cert_private_key-property-as4client-struct) may be available but not exportable. In this case, [ssl_server_cert_private_key](#ssl_server_cert_private_key-property-as4client-struct) returns an empty string. This property is read-only. ## Data Type String # ssl_server_cert_private_key_available property ([AS4Client](#struct-ipworksedias4client) Struct) Whether a PrivateKey is available for the selected certificate. ## Syntax *Rust Syntax* ```text fn ssl_server_cert_private_key_available(&self ) -> Result ``` ## Default Value false ## Remarks Whether a [ssl_server_cert_private_key](#ssl_server_cert_private_key-property-as4client-struct) is available for the selected certificate. If [ssl_server_cert_private_key_available](#ssl_server_cert_private_key_available-property-as4client-struct) 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 ([AS4Client](#struct-ipworksedias4client) Struct) The name of the PrivateKey container for the certificate (if available). ## Syntax *Rust Syntax* ```text fn ssl_server_cert_private_key_container(&self ) -> Result ``` ## Default Value "" ## Remarks The name of the [ssl_server_cert_private_key](#ssl_server_cert_private_key-property-as4client-struct) 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 ([AS4Client](#struct-ipworksedias4client) Struct) The public key of the certificate. ## Syntax *Rust Syntax* ```text fn ssl_server_cert_public_key(&self ) -> Result ``` ## 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 ([AS4Client](#struct-ipworksedias4client) Struct) The textual description of the certificate's public key algorithm. ## Syntax *Rust Syntax* ```text fn ssl_server_cert_public_key_algorithm(&self ) -> Result ``` ## 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 # ssl_server_cert_public_key_length property ([AS4Client](#struct-ipworksedias4client) Struct) The length of the certificate's public key (in bits). ## Syntax *Rust Syntax* ```text fn ssl_server_cert_public_key_length(&self ) -> Result ``` ## Default Value 0 ## Remarks The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. This property is read-only. ## Data Type i32 # ssl_server_cert_serial_number property ([AS4Client](#struct-ipworksedias4client) Struct) The serial number of the certificate encoded as a string. ## Syntax *Rust Syntax* ```text fn ssl_server_cert_serial_number(&self ) -> Result ``` ## 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 ([AS4Client](#struct-ipworksedias4client) Struct) The text description of the certificate's signature algorithm. ## Syntax *Rust Syntax* ```text fn ssl_server_cert_signature_algorithm(&self ) -> Result ``` ## 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 # ssl_server_cert_store property ([AS4Client](#struct-ipworksedias4client) Struct) The name of the certificate store for the client certificate. ## Syntax *Rust Syntax* ```text fn ssl_server_cert_store(&self ) -> Result, IPWorksEDIError> ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [ssl_server_cert_store_type](#ssl_server_cert_store_type-property-as4client-struct) property denotes the type of the certificate store specified by [ssl_server_cert_store](#ssl_server_cert_store-property-as4client-struct). If the store is password-protected, specify the password in [ssl_server_cert_store_password](#ssl_server_cert_store_password-property-as4client-struct). [ssl_server_cert_store](#ssl_server_cert_store-property-as4client-struct) is used in conjunction with the [ssl_server_cert_subject](#ssl_server_cert_subject-property-as4client-struct) property to specify client certificates. If [ssl_server_cert_store](#ssl_server_cert_store-property-as4client-struct) has a value, and [ssl_server_cert_subject](#ssl_server_cert_subject-property-as4client-struct) or [ssl_server_cert_encoded](#ssl_server_cert_encoded-property-as4client-struct) is set, a search for a certificate is initiated. Please see the [ssl_server_cert_subject](#ssl_server_cert_subject-property-as4client-struct) 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). This property is read-only. ## Data Type Vec # ssl_server_cert_store_password property ([AS4Client](#struct-ipworksedias4client) 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 *Rust Syntax* ```text fn ssl_server_cert_store_password(&self ) -> Result ``` ## 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 ([AS4Client](#struct-ipworksedias4client) Struct) The type of certificate store for this certificate. ## Syntax *Rust Syntax* ```text fn ssl_server_cert_store_type(&self ) -> Result ``` ## Possible Values ```text 0 // User1 // Machine2 // PFXFile3 // PFXBlob4 // JKSFile5 // JKSBlob6 // PEMKeyFile7 // PEMKeyBlob8 // PublicKeyFile9 // PublicKeyBlob10 // SSHPublicKeyBlob11 // P7BFile12 // P7BBlob13 // SSHPublicKeyFile14 // PPKFile15 // PPKBlob16 // XMLFile17 // XMLBlob18 // JWKFile19 // JWKBlob20 // SecurityKey21 // BCFKSFile22 // BCFKSBlob23 // PKCS1199 // Auto ``` ## Default Value 0 ## 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: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; // PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` | | | | --- | --- | | 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. | | 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. | | 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. | | 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. | | 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. | | 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. | | 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. | | 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. | | 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. | | 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. | | 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. | | 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. | | 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. | | 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. | | 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). | | 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). | | 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. | | 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. | | 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). | | 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). | | 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. | | 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. | | 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#Type_Certificate) object and pass cstPKCS11 as the [ssl_server_cert_store_type](#ssl_server_cert_store_type-property-as4client-struct), the full path of the PKCS#11 DLL as the [ssl_server_cert_store](#ssl_server_cert_store-property-as4client-struct), and the PIN as the [ssl_server_cert_store_password](#ssl_server_cert_store_password-property-as4client-struct). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) struct by calling the [list_store_certificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [on_cert_list](#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [ssl_server_cert_store](#ssl_server_cert_store-property-as4client-struct) and set [ssl_server_cert_store_password](#ssl_server_cert_store_password-property-as4client-struct) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. | This property is read-only. ## Data Type i32 # ssl_server_cert_subject_alt_names property ([AS4Client](#struct-ipworksedias4client) Struct) Comma-separated lists of alternative subject names for the certificate. ## Syntax *Rust Syntax* ```text fn ssl_server_cert_subject_alt_names(&self ) -> Result ``` ## 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 ([AS4Client](#struct-ipworksedias4client) Struct) The MD5 hash of the certificate. ## Syntax *Rust Syntax* ```text fn ssl_server_cert_thumbprint_md5(&self ) -> Result ``` ## 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 ([AS4Client](#struct-ipworksedias4client) Struct) The SHA-1 hash of the certificate. ## Syntax *Rust Syntax* ```text fn ssl_server_cert_thumbprint_sha1(&self ) -> Result ``` ## 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 ([AS4Client](#struct-ipworksedias4client) Struct) The SHA-256 hash of the certificate. ## Syntax *Rust Syntax* ```text fn ssl_server_cert_thumbprint_sha256(&self ) -> Result ``` ## 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 ([AS4Client](#struct-ipworksedias4client) Struct) The text description of UsageFlags . ## Syntax *Rust Syntax* ```text fn ssl_server_cert_usage(&self ) -> Result ``` ## Default Value "" ## Remarks The text description of [ssl_server_cert_usage_flags](#ssl_server_cert_usage_flags-property-as4client-struct). 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 ([AS4Client](#struct-ipworksedias4client) Struct) The flags that show intended use for the certificate. ## Syntax *Rust Syntax* ```text fn ssl_server_cert_usage_flags(&self ) -> Result ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [ssl_server_cert_usage_flags](#ssl_server_cert_usage_flags-property-as4client-struct) 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](#ssl_server_cert_usage-property-as4client-struct) property for a text representation of [ssl_server_cert_usage_flags](#ssl_server_cert_usage_flags-property-as4client-struct). This functionality currently is not available when the provider is OpenSSL. This property is read-only. ## Data Type i32 # ssl_server_cert_version property ([AS4Client](#struct-ipworksedias4client) Struct) The certificate's version number. ## Syntax *Rust Syntax* ```text fn ssl_server_cert_version(&self ) -> Result ``` ## 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 ([AS4Client](#struct-ipworksedias4client) Struct) The subject of the certificate used for client authentication. ## Syntax *Rust Syntax* ```text fn ssl_server_cert_subject(&self ) -> Result ``` ## 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. This property is read-only. ## Data Type String # ssl_server_cert_encoded property ([AS4Client](#struct-ipworksedias4client) Struct) The certificate (PEM/Base64 encoded). ## Syntax *Rust Syntax* ```text fn ssl_server_cert_encoded(&self ) -> Result, IPWorksEDIError> ``` ## Default Value "" ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [ssl_server_cert_store](#ssl_server_cert_store-property-as4client-struct) and [ssl_server_cert_subject](#ssl_server_cert_subject-property-as4client-struct) properties also may be used to specify a certificate. When [ssl_server_cert_encoded](#ssl_server_cert_encoded-property-as4client-struct) is set, a search is initiated in the current [ssl_server_cert_store](#ssl_server_cert_store-property-as4client-struct) for the private key of the certificate. If the key is found, [ssl_server_cert_subject](#ssl_server_cert_subject-property-as4client-struct) is updated to reflect the full subject of the selected certificate; otherwise, [ssl_server_cert_subject](#ssl_server_cert_subject-property-as4client-struct) is set to an empty string. This property is read-only. ## Data Type Vec # timeout property ([AS4Client](#struct-ipworksedias4client) Struct) The timeout for the struct. ## Syntax *Rust Syntax* ```text fn timeout(&self ) -> Result fn set_timeout(&self, value : i32) -> Option ``` ## Default Value 60 ## Remarks If the timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered. If timeout is set to a positive value, the struct will wait for the operation to complete before returning control. The struct will use [do_events](#do_events-method-as4client-struct) to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive. If timeout expires, and the operation is not yet complete, the struct fails with an error. NOTE: By default, all timeouts are *inactivity timeouts*, that is, the timeout period is extended by timeout seconds when any amount of data is successfully sent or received. The default value for the timeout property is 60 seconds. ## Data Type i32 # token_password property ([AS4Client](#struct-ipworksedias4client) Struct) The password used in UsernameToken authentication. ## Syntax *Rust Syntax* ```text fn token_password(&self ) -> Result fn set_token_password(&self, value : &str) -> Option fn set_token_password_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks This property specifies the password used in UsernameToken authentication. **UsernameToken Authentication Notes** If [token_user](#token_user-property-as4client-struct) and token_password are specified the struct will include UsernameToken authentication when [receive_files](#receive_files-method-as4client-struct) is called. This functionality is only applicable when calling [receive_files](#receive_files-method-as4client-struct). token_password should normally be set to the plaintext password that both the client and server know. The struct will automatically use SHA-1 to create a hash of the password when [token_password_type](#token_password_type-property-as4client-struct) is set to tptDigest (default). The hashed password is sent in the request, along with a creation date and nonce. The server will validate these values when receiving the request. ```text client.TokenUser = "User"; client.TokenPassword = "MyPassword"; client.TokenPasswordType = As4clientTokenPasswordTypes.tptDigest; client.ReceiveFiles(); ``` A creation date element is always sent in the request. A nonce is sent by default but can be disabled by setting [UseNonce](#UseNonce) to False. If [token_password_type](#token_password_type-property-as4client-struct) is set to tptText the struct will transmit value provided in token_password exactly as it is provided. The value will not be hashed. This may be useful in cases where an alternative credential mechanism is used between the client and server. ## Data Type String # token_password_type property ([AS4Client](#struct-ipworksedias4client) Struct) The password type used in UsernameToken authentication. ## Syntax *Rust Syntax* ```text fn token_password_type(&self ) -> Result fn set_token_password_type(&self, value : i32) -> Option ``` ## Possible Values ```text 0 // Digest1 // Text ``` ## Default Value 0 ## Remarks The type of password to send in the request. Possible values are: | | | | --- | --- | | 0 (tptDigest - default) | [token_password](#token_password-property-as4client-struct) holds the plaintext password and the struct hashes it. | | 1 (tptText) | [token_password](#token_password-property-as4client-struct) is transmitted exactly as provided. | **UsernameToken Authentication Notes** If [token_user](#token_user-property-as4client-struct) and [token_password](#token_password-property-as4client-struct) are specified the struct will include UsernameToken authentication when [receive_files](#receive_files-method-as4client-struct) is called. This functionality is only applicable when calling [receive_files](#receive_files-method-as4client-struct). [token_password](#token_password-property-as4client-struct) should normally be set to the plaintext password that both the client and server know. The struct will automatically use SHA-1 to create a hash of the password when token_password_type is set to tptDigest (default). The hashed password is sent in the request, along with a creation date and nonce. The server will validate these values when receiving the request. ```text client.TokenUser = "User"; client.TokenPassword = "MyPassword"; client.TokenPasswordType = As4clientTokenPasswordTypes.tptDigest; client.ReceiveFiles(); ``` A creation date element is always sent in the request. A nonce is sent by default but can be disabled by setting [UseNonce](#UseNonce) to False. If token_password_type is set to tptText the struct will transmit value provided in [token_password](#token_password-property-as4client-struct) exactly as it is provided. The value will not be hashed. This may be useful in cases where an alternative credential mechanism is used between the client and server. ## Data Type i32 # token_user property ([AS4Client](#struct-ipworksedias4client) Struct) The username used in UsernameToken authentication. ## Syntax *Rust Syntax* ```text fn token_user(&self ) -> Result fn set_token_user(&self, value : &str) -> Option fn set_token_user_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks This property specifies the username to be sent for UsernameToken authentication. **UsernameToken Authentication Notes** If token_user and [token_password](#token_password-property-as4client-struct) are specified the struct will include UsernameToken authentication when [receive_files](#receive_files-method-as4client-struct) is called. This functionality is only applicable when calling [receive_files](#receive_files-method-as4client-struct). [token_password](#token_password-property-as4client-struct) should normally be set to the plaintext password that both the client and server know. The struct will automatically use SHA-1 to create a hash of the password when [token_password_type](#token_password_type-property-as4client-struct) is set to tptDigest (default). The hashed password is sent in the request, along with a creation date and nonce. The server will validate these values when receiving the request. ```text client.TokenUser = "User"; client.TokenPassword = "MyPassword"; client.TokenPasswordType = As4clientTokenPasswordTypes.tptDigest; client.ReceiveFiles(); ``` A creation date element is always sent in the request. A nonce is sent by default but can be disabled by setting [UseNonce](#UseNonce) to False. If [token_password_type](#token_password_type-property-as4client-struct) is set to tptText the struct will transmit value provided in [token_password](#token_password-property-as4client-struct) exactly as it is provided. The value will not be hashed. This may be useful in cases where an alternative credential mechanism is used between the client and server. ## Data Type String # url property ([AS4Client](#struct-ipworksedias4client) Struct) The URL to which the request is made. ## Syntax *Rust Syntax* ```text fn url(&self ) -> Result fn set_url(&self, value : &str) -> Option fn set_url_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks This property specifies the URL to which the request is made. SSL will be used if and only if the URL scheme is "https". ## Data Type String # config method ([AS4Client](#struct-ipworksedias4client) Struct) Sets or retrieves a configuration setting. ## Syntax *Rust Syntax* ```text fn config(&self, configuration_string : &str) -> Result ``` ## Remarks config is a generic method available in every struct. It is used to set and retrieve [configuration settings](#config-settings-as4client-struct) 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](#config-settings-as4client-struct), you must call *Config("PROPERTY")*. The value will be returned as a string. # do_events method ([AS4Client](#struct-ipworksedias4client) Struct) This method processes events from the internal message queue. ## Syntax *Rust Syntax* ```text fn do_events(&self) -> Result<(), IPWorksEDIError> ``` ## Remarks When do_events is called, the struct processes any available events. If no events are available, it waits for a preset period of time, and then returns. # interrupt method ([AS4Client](#struct-ipworksedias4client) Struct) This method interrupts the current method. ## Syntax *Rust Syntax* ```text fn interrupt(&self) -> Result<(), IPWorksEDIError> ``` ## Remarks If there is no method in progress, interrupt simply returns, doing nothing. # receive_files method ([AS4Client](#struct-ipworksedias4client) Struct) Connects to a server to receive files. ## Syntax *Rust Syntax* ```text fn receive_files(&self) -> Result<(), IPWorksEDIError> ``` ## Remarks receive_files establishes a connection to the server specified by [url](#url-property-as4client-struct) and receives files. The [mpc](#mpc-property-as4client-struct) specifies the Message Partition Channel from which messages will be received. The server will reply with files from this channel. If [incoming_directory](#incoming_directory-property-as4client-struct) is set before calling this method the files will be written to the specified folder, otherwise inspect [edi_data](#edi_data-property-as4client-struct) to obtain the received file data. The following properties are applicable when calling this method: - signing_cert (required to sign the request) - certificate (required for decryption) - signer_cert (required for signature verification) - [url](#url-property-as4client-struct) - [incoming_directory](#incoming_directory-property-as4client-struct) (optional) - [log_directory](#log_directory-property-as4client-struct) - [mpc](#mpc-property-as4client-struct) - [token_user](#token_user-property-as4client-struct) - [token_password](#token_password-property-as4client-struct) - [token_password_type](#token_password_type-property-as4client-struct) After calling this method the following properties will be populated and may be inspected: - as4_from - as4_to - [agreement_ref](#agreement_ref-property-as4client-struct) - [conversation_id](#conversation_id-property-as4client-struct) - [service](#service-property-as4client-struct) - [service_action](#service_action-property-as4client-struct) - [service_type](#service_type-property-as4client-struct) - [message_id](#message_id-property-as4client-struct) - receipt The receipt property will be populated with the receipt corresponding to the received message, but it is not yet delivered. The receipt may be delivered by bundling it with another request to receive files, or by calling [send_receipt](#send_receipt-method-as4client-struct). To bundle the receipt with a subsequent receive_files call the receipt property must hold the receipt. If the same instance of the struct is being used this is already true since receipt is populated automatically after receiving the file. To use another instance of the struct for multiple calls to receive_files be sure to save the Receipt's [receipt_content](#receipt_content-property-as4client-struct) and [receipt_ref_to_message_id](#receipt_ref_to_message_id-property-as4client-struct) values for later use. **ReceiveFiles Example:** ```text client.Profile = As4clientProfiles.ebpfENTSOG; //Company A's private certificate. Used for signing the request. client.SigningCert = new Certificate(CertStoreTypes.cstPFXFile, "C:\\files\\as4\\CompanyA.pfx", "password", "*"); //Company A's private certificate. Used for decrypting the file. client.Certificate = new Certificate(CertStoreTypes.cstPFXFile, "C:\\files\\as4\\CompanyA.pfx", "password", "*"); //Company B's public certificate. Used for signature verification. client.SignerCert = new Certificate("C:\\files\\as4\\CompanyB.cer"); client.URL = "http://www.company.com:9090/msh"; //Message Channel id client.MPC = "mpc_a"; client.IncomingDirectory = "C:\\incoming_dir"; client.ReceiveFiles(); //Inspect client.AgreementRef and other properties for information about the received files Console.WriteLine(client.AgreementRef); Console.WriteLine(client.AS4From.Id); Console.WriteLine(client.AS4To.Id); Console.WriteLine(client.ConversationId); //Save the receipt for later use string receiptContent = client.Receipt.Content; string receiptRefId = client.Receipt.RefToMessageId; ``` At this stage the receipt data is saved. Later when making another call to ReceiveFiles and populate the Receipt property with this receipt data. When ReceiveFiles is called again, the receipt for the previous message will be included with the request. ```text client.Receipt = new EBReceipt(receiptRefId, receiptContent); client.ReceiveFiles(); //This will now include the bundled receipt ``` # reset method ([AS4Client](#struct-ipworksedias4client) Struct) Resets the state of the control. ## Syntax *Rust Syntax* ```text fn reset(&self) -> Result<(), IPWorksEDIError> ``` ## Remarks **Reset** resets the state of the struct. All properties will be set to their default values. # send_files method ([AS4Client](#struct-ipworksedias4client) Struct) Sends file(s) to the specified server and verify the receipt (if present). ## Syntax *Rust Syntax* ```text fn send_files(&self) -> Result<(), IPWorksEDIError> ``` ## Remarks send_files sends the files specified by [edi_data](#edi_data-property-as4client-struct) to [url](#url-property-as4client-struct). Before calling this method set [agreement_ref](#agreement_ref-property-as4client-struct) to the agreement identifier used by both parties. Set as4_from and as4_to. Set [edi_data](#edi_data-property-as4client-struct) specifies the file(s) to be sent. To encrypt the data set recipient_certs. To sign the data set signing_cert. The signer_cert property should be set to verify the signed receipt. When this method is called the file(s) will be sent and any returned receipts will be verified. To indicate a synchronous receipt is expected set [receipt_reply_mode](#receipt_reply_mode-property-as4client-struct) to rrmSync. The following properties are applicable when calling this method with an agreement specifying a synchronous receipt (a receipt provided in the response): - [agreement_ref](#agreement_ref-property-as4client-struct) - as4_from - as4_to - [edi_data](#edi_data-property-as4client-struct) - [url](#url-property-as4client-struct) - recipient_certs (required to encrypt) - signer_cert (required to verify signed receipts) - signing_cert (required to sign files) - [conversation_id](#conversation_id-property-as4client-struct) (optional) - [encryption_algorithm](#encryption_algorithm-property-as4client-struct) (optional) - [log_directory](#log_directory-property-as4client-struct) (optional) - [message_id](#message_id-property-as4client-struct) (optional) - message_properties (optional) - [profile](#profile-property-as4client-struct) (optional) - [receipt_reply_mode](#receipt_reply_mode-property-as4client-struct) - [service](#service-property-as4client-struct) (optional) - [service_type](#service_type-property-as4client-struct) (optional) - [signature_algorithm](#signature_algorithm-property-as4client-struct) (optional) **SendFiles Example (synchronous receipt):** ```text client.Profile = As4clientProfiles.ebpfENTSOG; //Specify the agreement and party information client.AgreementRef = "http://agreements.company.com/sign_and_encrypt"; client.AS4From.Role = "Sender"; client.AS4From.Id = "org:b2b:example:company:A"; client.AS4To.Role = "Receiver"; client.AS4To.Id = "org:b2b:example:company:B"; //Configure the component to expect a synchronous receipt. client.ReceiptReplyMode = As4clientReceiptReplyModes.rrmSync; //Company A's private certificate. Used to sign the outgoing message and files. client.SigningCert = new Certificate(CertStoreTypes.cstPFXFile, "C:\\files\\CompanyA.pfx", "password", "*"); //Company B's public certificate. Used to encrypt the outgoing file. client.RecipientCerts.Add(new Certificate("C:\\files\\as4\\CompanyB.cer")); //Company B's public certificate. Used to verify the signed receipt. client.SignerCert = new Certificate("C:\\files\\as4\\CompanyB.cer"); client.URL = "http://www.company.com:9090/msh"; EBData data = new EBData(); data.EDIType = "application/edi-x12"; data.Filename = "C:\\files\\myfile.x12"; data.Name = "myfile.x12"; client.EDIData.Add(data); //Send file(s) and verify the receipt. client.SendFiles(); ``` The struct also supports asynchronous receipts. In this configuration a file is sent from the struct to another party, but the receipt is not returned in the response. Instead the other party sends the receipt at a later time. The [AS4Server](AS4Server.md#AS4Server) struct may be used inside a web page to receive the asynchronous receipt. After receiving the receipt either [AS4Server](AS4Server.md#AS4Server) or [AS4Client](#struct-ipworksedias4client) may be used to verify the receipt. Details about the original message must be stored so that the receipt can be correlated with the message and properly verified. The easiest way to do this is to set [async_receipt_info_dir](#async_receipt_info_dir-property-as4client-struct) before calling send_files. The struct will automatically store the required information. See the [verify_receipt](AS4Server.md#AS4Server_m_VerifyReceipt) method of [AS4Server](AS4Server.md#AS4Server) for details about verifying asynchronous receipts. To indicate an asynchronous receipt is expected set [receipt_reply_mode](#receipt_reply_mode-property-as4client-struct) to rrmAsync. The following properties are applicable when calling this method with an agreement specifying a synchronous receipt (a receipt provided in the response): - [agreement_ref](#agreement_ref-property-as4client-struct) - as4_from - as4_to - [async_receipt_info_dir](#async_receipt_info_dir-property-as4client-struct) - [edi_data](#edi_data-property-as4client-struct) - [url](#url-property-as4client-struct) - recipient_certs (required to encrypt) - signer_cert (required to verify signed receipts) - signing_cert (required to sign files) - [conversation_id](#conversation_id-property-as4client-struct) (optional) - [encryption_algorithm](#encryption_algorithm-property-as4client-struct) (optional) - [log_directory](#log_directory-property-as4client-struct) (optional) - [message_id](#message_id-property-as4client-struct) (optional) - message_properties (optional) - [original_soap_message](#original_soap_message-property-as4client-struct) (optional) - [original_soap_message_id](#original_soap_message_id-property-as4client-struct) (optional) - [profile](#profile-property-as4client-struct) (optional) - [receipt_reply_mode](#receipt_reply_mode-property-as4client-struct) - [service](#service-property-as4client-struct) (optional) - [service_type](#service_type-property-as4client-struct) (optional) - [signature_algorithm](#signature_algorithm-property-as4client-struct) (optional) **SendFiles Example (asynchronous receipt):** ```text client.Profile = As4clientProfiles.ebpfENTSOG; //Specify the agreement and party information client.AgreementRef = "http://agreements.company.com/sign_and_encrypt_async"; client.AS4From.Role = "Sender"; client.AS4From.Id = "org:b2b:example:company:A"; client.AS4To.Role = "Receiver"; client.AS4To.Id = "org:b2b:example:company:B"; //Configure the component to expect a synchronous receipt. client.ReceiptReplyMode = As4clientReceiptReplyModes.rrmAsync; client.AsyncReceiptInfoDir = "C:\\async_info"; //Company A's private certificate. Used to sign the outgoing message and files. client.SigningCert = new Certificate(CertStoreTypes.cstPFXFile, "C:\\files\\CompanyA.pfx", "password", "*"); //Company B's public certificate. Used to encrypt the outgoing files. client.RecipientCerts.Add(new Certificate("C:\\files\\as4\\CompanyB.cer")); //Company B's public certificate. Used to verify the signed receipt. client.SignerCert = new Certificate("C:\\files\\as4\\CompanyB.cer"); client.URL = "http://www.company.com:9090/msh"; EBData data = new EBData(); data.EDIType = "application/edi-x12"; data.Filename = "C:\\files\\myfile.x12"; data.Name = "myfile.x12"; client.EDIData.Add(data); //Send file(s). client.SendFiles(); ``` At this point the file(s) have been sent, but a receipt has not yet been received. [AS4Server](AS4Server.md#AS4Server) can be used within a web site to listen for the receipt. ```text //**** Inside a web site **** As4server server = new As4server; server.ReadRequest(); if (!String.IsNullOrEmpty(server.IncomingReceipt.Content)) { server.AsyncReceiptInfoDir = "C:\\async_info"; server.VerifyReceipt(); //The receipt is now verified } ``` # send_receipt method ([AS4Client](#struct-ipworksedias4client) Struct) Sends an asynchronous receipt. ## Syntax *Rust Syntax* ```text fn send_receipt(&self) -> Result<(), IPWorksEDIError> ``` ## Remarks send_receipt sends an asynchronous receipt to the [url](#url-property-as4client-struct). This method is typically used in conjunction with [AS4Server](AS4Server.md#AS4Server) to send an asynchronous receipt after receiving a message. The receipt will be created at the time of the incoming request, then saved for later use. When the receipt is to be sent populate receipt and call this method. ```text //Send an asynchronous receipt client.URL = ""http://www.company.com:9090/msh""; client.Receipt = new EBReceipt(server.Receipt.RefToMessageId, server.Receipt.Content); client.ReceiptReplyMode = As4clientReceiptReplyModes.rrmAsync; client.SendReceipt(); ``` # on_connected event ([AS4Client](#struct-ipworksedias4client) Struct) Fired immediately after a connection completes (or fails). ## Syntax *Rust Syntax* ```text // AS4ClientConnectedEventArgs carries the AS4Client Connected event's parameters. pub struct AS4ClientConnectedEventArgs { fn status_code(&self) -> i32 fn description(&self) -> &String } // AS4ClientConnectedEvent defines the signature of the AS4Client Connected event's handler function. pub trait AS4ClientConnectedEvent { fn on_connected(&self, sender : AS4Client, e : &mut AS4ClientConnectedEventArgs); } impl <'a> AS4Client<'a> { pub fn on_connected(&self) -> &'a dyn AS4ClientConnectedEvent; pub fn set_on_connected(&mut self, value : &'a dyn AS4ClientConnectedEvent); ... } ``` ## Remarks If the connection is made normally, *status_code* is 0 and *description* is "OK". If the connection fails, *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. Please refer to the [Error Codes](#trappable-errors-as4client-struct) section for more information. # on_disconnected event ([AS4Client](#struct-ipworksedias4client) Struct) Fired when a connection is closed. ## Syntax *Rust Syntax* ```text // AS4ClientDisconnectedEventArgs carries the AS4Client Disconnected event's parameters. pub struct AS4ClientDisconnectedEventArgs { fn status_code(&self) -> i32 fn description(&self) -> &String } // AS4ClientDisconnectedEvent defines the signature of the AS4Client Disconnected event's handler function. pub trait AS4ClientDisconnectedEvent { fn on_disconnected(&self, sender : AS4Client, e : &mut AS4ClientDisconnectedEventArgs); } impl <'a> AS4Client<'a> { pub fn on_disconnected(&self) -> &'a dyn AS4ClientDisconnectedEvent; pub fn set_on_disconnected(&mut self, value : &'a dyn AS4ClientDisconnectedEvent); ... } ``` ## Remarks If the connection is broken normally, *status_code* is 0 and *description* is "OK". If the connection is broken for any other reason, *status_code* has the error code returned by the Transmission Control Protocol (TCP/IP) subsystem. *description* contains a description of this code. The value of *status_code* is equal to the value of the TCP/IP error. Please refer to the [Error Codes](#trappable-errors-as4client-struct) section for more information. # on_end_transfer event ([AS4Client](#struct-ipworksedias4client) Struct) Fired when a document finishes transferring. ## Syntax *Rust Syntax* ```text // AS4ClientEndTransferEventArgs carries the AS4Client EndTransfer event's parameters. pub struct AS4ClientEndTransferEventArgs { fn direction(&self) -> i32 } // AS4ClientEndTransferEvent defines the signature of the AS4Client EndTransfer event's handler function. pub trait AS4ClientEndTransferEvent { fn on_end_transfer(&self, sender : AS4Client, e : &mut AS4ClientEndTransferEventArgs); } impl <'a> AS4Client<'a> { pub fn on_end_transfer(&self) -> &'a dyn AS4ClientEndTransferEvent; pub fn set_on_end_transfer(&mut self, value : &'a dyn AS4ClientEndTransferEvent); ... } ``` ## Remarks This event is fired first when the client finishes sending data to the server (in a *POST* or *PUT* request) and then when the document text finishes transferring from the server to the local host. The *Direction* parameter shows whether the client (0) or the server (1) is sending the data. # on_error event ([AS4Client](#struct-ipworksedias4client) Struct) Fired when information is available about errors during data delivery. ## Syntax *Rust Syntax* ```text // AS4ClientErrorEventArgs carries the AS4Client Error event's parameters. pub struct AS4ClientErrorEventArgs { fn error_code(&self) -> i32 fn description(&self) -> &String } // AS4ClientErrorEvent defines the signature of the AS4Client Error event's handler function. pub trait AS4ClientErrorEvent { fn on_error(&self, sender : AS4Client, e : &mut AS4ClientErrorEventArgs); } impl <'a> AS4Client<'a> { pub fn on_error(&self) -> &'a dyn AS4ClientErrorEvent; pub fn set_on_error(&mut self, value : &'a dyn AS4ClientErrorEvent); ... } ``` ## 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](#trappable-errors-as4client-struct) section. 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](#trappable-errors-as4client-struct) section. # on_header event ([AS4Client](#struct-ipworksedias4client) Struct) Fired every time a header line comes in. ## Syntax *Rust Syntax* ```text // AS4ClientHeaderEventArgs carries the AS4Client Header event's parameters. pub struct AS4ClientHeaderEventArgs { fn field(&self) -> &String fn value(&self) -> &String } // AS4ClientHeaderEvent defines the signature of the AS4Client Header event's handler function. pub trait AS4ClientHeaderEvent { fn on_header(&self, sender : AS4Client, e : &mut AS4ClientHeaderEventArgs); } impl <'a> AS4Client<'a> { pub fn on_header(&self) -> &'a dyn AS4ClientHeaderEvent; pub fn set_on_header(&mut self, value : &'a dyn AS4ClientHeaderEvent); ... } ``` ## Remarks The *field* parameter contains the name of the HTTP header (which is the same 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_log event ([AS4Client](#struct-ipworksedias4client) Struct) Fired with log information while processing a message. ## Syntax *Rust Syntax* ```text // AS4ClientLogEventArgs carries the AS4Client Log event's parameters. pub struct AS4ClientLogEventArgs { fn log_type(&self) -> &String fn log_message(&self) -> &String } // AS4ClientLogEvent defines the signature of the AS4Client Log event's handler function. pub trait AS4ClientLogEvent { fn on_log(&self, sender : AS4Client, e : &mut AS4ClientLogEventArgs); } impl <'a> AS4Client<'a> { pub fn on_log(&self) -> &'a dyn AS4ClientLogEvent; pub fn set_on_log(&mut self, value : &'a dyn AS4ClientLogEvent); ... } ``` ## Remarks This event fires once for each log message generated by the struct. The verbosity is controlled by the [LogLevel](#LogLevel) setting. Log messages available through this event correspond to log files written to [log_directory](#log_directory-property-as4client-struct). 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](#log_directory-property-as4client-struct) (i.e. when [log_directory](#log_directory-property-as4client-struct) 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: | | | | --- | --- | | "INFO" | Information about the status of the process. | | "ERROR" | An error was encountered. | | "DEBUG" | Debug information. | # on_recipient_info event ([AS4Client](#struct-ipworksedias4client) Struct) Fired for each recipient certificate of the encrypted message. ## Syntax *Rust Syntax* ```text // AS4ClientRecipientInfoEventArgs carries the AS4Client RecipientInfo event's parameters. pub struct AS4ClientRecipientInfoEventArgs { fn issuer(&self) -> &String fn serial_number(&self) -> &String fn subject_key_identifier(&self) -> &String fn encryption_algorithm(&self) -> &String } // AS4ClientRecipientInfoEvent defines the signature of the AS4Client RecipientInfo event's handler function. pub trait AS4ClientRecipientInfoEvent { fn on_recipient_info(&self, sender : AS4Client, e : &mut AS4ClientRecipientInfoEventArgs); } impl <'a> AS4Client<'a> { pub fn on_recipient_info(&self) -> &'a dyn AS4ClientRecipientInfoEvent; pub fn set_on_recipient_info(&mut self, value : &'a dyn AS4ClientRecipientInfoEvent); ... } ``` ## Remarks When parse_request is called and the file is encrypted, this event will fire for each recipient certificate for which the file was encrypted. *Issuer* is the subject of the issuer certificate. *SerialNumber* is the serial number of the encryption certificate. *SubjectKeyIdentifier* is the X.509 subjectKeyIdentifier extension value of the certificate used to sign the message encoded as a hex string. *EncryptionAlgorithm* is the encryption algorithm used to encrypt the message. Possible values are as follows: - "3DES" - "DES" - "RC2CBC40" - "RC2CBC64" - "RC2CBC128" or "RC2" - "AESCBC128" or "AES" - "AESCBC192" - "AESCBC256" - "AESGCM128" or "AESGCM" - "AESGCM192" - "AESGCM256" # on_set_cookie event ([AS4Client](#struct-ipworksedias4client) Struct) Fired for every cookie set by the server. ## Syntax *Rust Syntax* ```text // AS4ClientSetCookieEventArgs carries the AS4Client SetCookie event's parameters. pub struct AS4ClientSetCookieEventArgs { fn name(&self) -> &String fn value(&self) -> &String fn expires(&self) -> &String fn domain(&self) -> &String fn path(&self) -> &String fn secure(&self) -> bool } // AS4ClientSetCookieEvent defines the signature of the AS4Client SetCookie event's handler function. pub trait AS4ClientSetCookieEvent { fn on_set_cookie(&self, sender : AS4Client, e : &mut AS4ClientSetCookieEventArgs); } impl <'a> AS4Client<'a> { pub fn on_set_cookie(&self) -> &'a dyn AS4ClientSetCookieEvent; pub fn set_on_set_cookie(&mut self, value : &'a dyn AS4ClientSetCookieEvent); ... } ``` ## Remarks This event is fired for every *Set-Cookie:* header received from the HTTP server. The *name* parameter contains the name of the cookie, with the corresponding value supplied in the *value* parameter. The *expires* parameter contains an expiration time for the cookie (if provided by the server). The time format used is "Weekday, DD-Mon-YY HH:MM:SS GMT". If the server does not provide an expiration time, the *expires* parameter will be an empty string. In this case, the convention is to drop the cookie at the end of the session. The *domain* parameter contains a domain name to limit the cookie to (if provided by the server). If the server does not provide a domain name, the *domain* parameter will be an empty string. The convention in this case is to use the server specified in the URL (url_server) as the cookie domain. The *path* parameter contains a path name to limit the cookie to (if provided by the server). If the server does not provide a cookie path, the *path* parameter will be an empty string. The convention in this case is to use the path specified in the URL (url_path) as the cookie path. The *secure* parameter specifies whether the cookie is secure. If the value of this parameter is True, the cookie value must be submitted only through a secure (HTTPS) connection. # on_signer_cert_info event ([AS4Client](#struct-ipworksedias4client) Struct) This event is fired during verification of the signed message. ## Syntax *Rust Syntax* ```text // AS4ClientSignerCertInfoEventArgs carries the AS4Client SignerCertInfo event's parameters. pub struct AS4ClientSignerCertInfoEventArgs { fn issuer(&self) -> &String fn serial_number(&self) -> &String fn subject_key_identifier(&self) -> &String fn cert_encoded(&self) -> &[u8] } // AS4ClientSignerCertInfoEvent defines the signature of the AS4Client SignerCertInfo event's handler function. pub trait AS4ClientSignerCertInfoEvent { fn on_signer_cert_info(&self, sender : AS4Client, e : &mut AS4ClientSignerCertInfoEventArgs); } impl <'a> AS4Client<'a> { pub fn on_signer_cert_info(&self) -> &'a dyn AS4ClientSignerCertInfoEvent; pub fn set_on_signer_cert_info(&mut self, value : &'a dyn AS4ClientSignerCertInfoEvent); ... } ``` ## 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 ([AS4Client](#struct-ipworksedias4client) Struct) Fired after the server presents its certificate to the client. ## Syntax *Rust Syntax* ```text // AS4ClientSSLServerAuthenticationEventArgs carries the AS4Client SSLServerAuthentication event's parameters. pub struct AS4ClientSSLServerAuthenticationEventArgs { 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) } // AS4ClientSSLServerAuthenticationEvent defines the signature of the AS4Client SSLServerAuthentication event's handler function. pub trait AS4ClientSSLServerAuthenticationEvent { fn on_ssl_server_authentication(&self, sender : AS4Client, e : &mut AS4ClientSSLServerAuthenticationEventArgs); } impl <'a> AS4Client<'a> { pub fn on_ssl_server_authentication(&self) -> &'a dyn AS4ClientSSLServerAuthenticationEvent; pub fn set_on_ssl_server_authentication(&mut self, value : &'a dyn AS4ClientSSLServerAuthenticationEvent); ... } ``` ## 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 ([AS4Client](#struct-ipworksedias4client) Struct) Fired when secure connection progress messages are available. ## Syntax *Rust Syntax* ```text // AS4ClientSSLStatusEventArgs carries the AS4Client SSLStatus event's parameters. pub struct AS4ClientSSLStatusEventArgs { fn message(&self) -> &String } // AS4ClientSSLStatusEvent defines the signature of the AS4Client SSLStatus event's handler function. pub trait AS4ClientSSLStatusEvent { fn on_ssl_status(&self, sender : AS4Client, e : &mut AS4ClientSSLStatusEventArgs); } impl <'a> AS4Client<'a> { pub fn on_ssl_status(&self) -> &'a dyn AS4ClientSSLStatusEvent; pub fn set_on_ssl_status(&mut self, value : &'a dyn AS4ClientSSLStatusEvent); ... } ``` ## Remarks The event is fired for informational and logging purposes only. This event tracks the progress of the connection. # on_start_transfer event ([AS4Client](#struct-ipworksedias4client) Struct) Fired when a document starts transferring (after the headers). ## Syntax *Rust Syntax* ```text // AS4ClientStartTransferEventArgs carries the AS4Client StartTransfer event's parameters. pub struct AS4ClientStartTransferEventArgs { fn direction(&self) -> i32 } // AS4ClientStartTransferEvent defines the signature of the AS4Client StartTransfer event's handler function. pub trait AS4ClientStartTransferEvent { fn on_start_transfer(&self, sender : AS4Client, e : &mut AS4ClientStartTransferEventArgs); } impl <'a> AS4Client<'a> { pub fn on_start_transfer(&self) -> &'a dyn AS4ClientStartTransferEvent; pub fn set_on_start_transfer(&mut self, value : &'a dyn AS4ClientStartTransferEvent); ... } ``` ## Remarks This event is fired first when the client starts sending data to the server (in a *POST* or *PUT* request) and then when the document text starts transferring from the server to the local host. The *Direction* parameter shows whether the client (0) or the server (1) is sending the data. # on_token_authentication event ([AS4Client](#struct-ipworksedias4client) Struct) Fired when the server makes use of UsernameToken authentication. ## Syntax *Rust Syntax* ```text // AS4ClientTokenAuthenticationEventArgs carries the AS4Client TokenAuthentication event's parameters. pub struct AS4ClientTokenAuthenticationEventArgs { fn user(&self) -> &String fn password(&self) -> &String fn set_password(&self, value : &str) fn set_password_ref(&self, value : &String) fn password_type(&self) -> &String fn accept(&self) -> bool fn set_accept(&self, value : bool) } // AS4ClientTokenAuthenticationEvent defines the signature of the AS4Client TokenAuthentication event's handler function. pub trait AS4ClientTokenAuthenticationEvent { fn on_token_authentication(&self, sender : AS4Client, e : &mut AS4ClientTokenAuthenticationEventArgs); } impl <'a> AS4Client<'a> { pub fn on_token_authentication(&self) -> &'a dyn AS4ClientTokenAuthenticationEvent; pub fn set_on_token_authentication(&mut self, value : &'a dyn AS4ClientTokenAuthenticationEvent); ... } ``` ## Remarks This event fires when a server sends a response that includes UsernameToken authentication. This is typically only used by servers when sending a pull response. **User** identifies the user. **Password** should be set from within the event if PasswordType is 0 (digest). This parameter can be read when PasswordType is 1 (text). **PasswordType** specifies the type of password. Possible values are: - 0 (Digest) - 1 (Text) **Accept** may be set to manually accept the request. When *PasswordType* is 0 (Digest) set the *Password* parameter to the plaintext password. Do not set *Accept* The struct will hash the provided password value and compare it to the value in the request. If it matched the struct will accept the request. If it does not match the struct will populate errors with an error indicating authentication has failed. When *PasswordType* is 1 (Text) the *Password* parameter will hold the exact value received in the request. Inspect *Password* and determine whether to accept the request. To accept the request set *Accept* to True. After this event fires if authentication failed errors will contain an appropriate error. Send the errors back to the server by calling send_response. # on_transfer event ([AS4Client](#struct-ipworksedias4client) Struct) Fired while a document transfers (delivers document). ## Syntax *Rust Syntax* ```text // AS4ClientTransferEventArgs carries the AS4Client Transfer event's parameters. pub struct AS4ClientTransferEventArgs { fn direction(&self) -> i32 fn bytes_transferred(&self) -> i64 fn percent_done(&self) -> i32 fn text(&self) -> &[u8] } // AS4ClientTransferEvent defines the signature of the AS4Client Transfer event's handler function. pub trait AS4ClientTransferEvent { fn on_transfer(&self, sender : AS4Client, e : &mut AS4ClientTransferEventArgs); } impl <'a> AS4Client<'a> { pub fn on_transfer(&self) -> &'a dyn AS4ClientTransferEvent; pub fn set_on_transfer(&mut self, value : &'a dyn AS4ClientTransferEvent); ... } ``` ## Remarks The *text* parameter contains the portion of the document text being received. It is empty if data are being posted to the server. The *bytes_transferred* parameter contains the number of bytes transferred in this *direction* since the beginning of the document text (excluding HTTP response headers). The *Direction* parameter shows whether the client (0) or the server (1) is sending the data. The *PercentDone* parameter shows the progress of the transfer in the corresponding direction. If *PercentDone* can not be calculated the value will be -1. NOTE: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance. # Config Settings ([AS4Client](#struct-ipworksedias4client) 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](#config-method-as4client-struct) method. ### AS4Client Config Settings **AgreementRefPMode**: AgreementRef PMode of message.This optional setting allows for the association of a message with a particular P-Mode. If specified it should be the PMode.ID parameter. This value corresponds to the ebMS element "eb:Messaging/eb:UserMessage/eb:CollaborationInfo/eb:AgreementRef/@pmode" **AgreementRefType**: The type of AgreementRef.This optional setting indicates how parties should interpret the value of [agreement_ref](#agreement_ref-property-as4client-struct). The semantics of this value should be decided upon between the parties. This value corresponds to the ebMS element "eb:Messaging/eb:UserMessage/eb:CollaborationInfo/eb:AgreementRef/@type" **AllowWarnings**: Whether warnings are interpreted as fatal errors.When set to False (default) any ebMS level error returned by the other party will be considered an error and cause an exception. When set to True the severity of the ebMS error will be inspected. If the severity is "warning" it will not cause an exception. In this case errors will still be populated with the error details. **AttachXMLFiles**: Whether to send XML files as attachments or within the SOAP body.This setting specifies whether XML files are included as attachments or within the SOAP body. This setting is only applicable when the first file specified in [edi_data](#edi_data-property-as4client-struct) is of type "text/xml" or "application/xml". In addition this is only applicable when [profile](#profile-property-as4client-struct) is set to Standard. If set to True (default), the file will be sent as an attachment. This allows the filename to be preserved and the file is sent as a separate MIME part. If set to False and the criteria above are met then the file will be sent within the SOAP body. In this case the filename cannot be preserved normally. The default value is True. **Authorization**: The Authorization string to be sent to the server. If the [Authorization](#Authorization) setting contains a non-empty string, an *Authorization* HTTP request header is added to the request. This header conveys Authorization information to the server. This setting is provided so that the struct can be extended with other security schemes in addition to the authorization schemes already implemented by the struct. The [AuthScheme](#AuthScheme); setting defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time [User](#User) and [Password](#Password) are set, they are Base64 encoded, and the result is put in the **Authorization** setting in the form "Basic [encoded-user-password]". **AuthScheme**: The authorization scheme to be used when server authorization is to be performed. Use the [AuthScheme](#AuthScheme) property to tell the component which type of authorization to perform when the [User](#User) and [Password](#Password) properties are set. Possible values are: | | | | --- | --- | | 0 (default) | Basic | | 1 | Digest | | 2 | Proprietary | | 3 | None | | 4 | NTLM | | 5 | Negotiate | | 6 | OAuth | By default, [AuthScheme](#AuthScheme) is Basic (0), and if the [User](#User) and [Password](#Password) configuration settings are set, the component will attempt basic authentication. If AuthScheme is set to Digest (1), digest authentication will be attempted instead. For security reasons, setting this value will clear the values of [User](#User) and [Password](#Password). **CloseStreamAfterProcessing**: Whether to close the input or output stream after processing.This setting specifies whether the input or output stream will be closed after processing. This may be set to False to leave the stream open for further operations. The default value is True and the stream will be by the struct. **CompressXMLPayloads**: Whether to compress XML data.When [compression_format](#compression_format-property-as4client-struct) is set to GZIP all [edi_data](#edi_data-property-as4client-struct) parts will be compressed. To exclude XML payloads with [edi_type](#edi_type-property-as4client-struct) values of "text/xml" or "application/xml" from being compressed set this value to False. By default this is True and all attachments will be compressed. Note: When [profile](#profile-property-as4client-struct) is set to Standard the first [edi_data](#edi_data-property-as4client-struct) part will be included in the SOAP body if the [edi_type](#edi_type-property-as4client-struct) is "text/xml" or "application/xml". In that case since the data is included in the SOAP body it will not be compressed. When [profile](#profile-property-as4client-struct) is set to ENTSOG all [edi_data](#edi_data-property-as4client-struct) parts are compressed. **ContentTransferEncoding**: The content encoding of the payload data.This setting can be used to specify the content encoding of the payload data of the AS4 message. This is set to binary (4) by default. Possible values for the this field are: | | | | --- | --- | | Base64 (2) | Base64 encoding of binary data. | | Binary (4) | Binary data without any encoding. | **DetectDuplicates**: Whether to detect duplicate messages when receiving.Whether to detect duplicate messages. If set to True [log_directory](#log_directory-property-as4client-struct) must be set. When a file is received the struct will store a file containing the MessageId of the received file. When additional files are received the struct will scan the [log_directory](#log_directory-property-as4client-struct) to see if a file with the same MessageId has already been received. If a duplicate is detected an entry is added to the .log file and [on_log](#on_log-event-as4client-struct) fires. The default value depends on the [profile](#profile-property-as4client-struct). For the Standard profile the default value is False. When [profile](#profile-property-as4client-struct) is set to ENTSOG this value is set to True. **EBPrefix**: Specifies the prefix to use for messaging.This setting specified the prefix to use for messaging. The default value is "eb3" and will result in values such as: *eb3:Messaging* It may be desirable to set this to another value such as "eb" so client and server sides both use the same prefix. **EDIDataPartId[i]**: Specified the part Id at the given index.This setting may be used to specify the value for each [edi_data](#edi_data-property-as4client-struct) part that is present in the message. By default the struct will generate a unique value. For instance: ```text ``` In some cases it may be desired or necessary to specify a user-defined value. For instance: ```text ``` After adding the part to [edi_data](#edi_data-property-as4client-struct) the Id may be specified by setting: ```text AS4Component.Config("EDIDataPartId[0]=mypart@myhost"); ``` This setting is also populated with the parsed Ids after receiving a message. **EnableTokenReferenceTokenType**: Whether to include the TokenType attribute in a SecurityTokenReference element.When this configuration setting is enabled, messages will include the TokenType attribute in any SecurityTokenReference elements. It will also add a namespace declaration for Web Services Security Version 1.1 (http://docs.oasis-open.org/wss/oasis-wss-wssecurity-secext-1.1.xsd). When encrypting, this setting also applies to the SecurityTokenReference inside the KeyInfo of each EncryptedData element, which refers to the EncryptedKey element. In that case the TokenType attribute is set to: ```text http://docs.oasis-open.org/wss/oasis-wss-soap-message-security-1.1#EncryptedKey ``` as defined by Web Services Security: SOAP Message Security 1.1 (Sections 7.1 and 7.7) and required by the WS-I Basic Security Profile 1.1 (Rule R3069). Some receivers (for example WSS4J-based AS4 implementations such as phase4) reject encrypted messages when this attribute is missing. The default value is True. Set this to False only when a legacy trading partner cannot process the TokenType attribute. Note: This setting is not compatible with the X509 (issuer and serial number) security token format of [SigningSecurityTokenFormat](#SigningSecurityTokenFormat) and [EncryptionSecurityTokenFormat](#EncryptionSecurityTokenFormat). The EncryptedKey reference described above is not affected by the token format and is always written when this setting is enabled. **EncryptionSecurityTokenFormat**: The format to use for the security token when encryption.This setting specifies the security token format that is included in the message when encrypting. This setting should only be set if there is a specific reason to do so. This specifies the reference type in the SecurityTokenReference element applicable to the encrypted data. Possible values are: | | | | --- | --- | | 0 (X509 - default) | X509 data including the certificate's issuer name and issuer serial number is included in the X509Data element. | | 1 (Binary) | A binary security token holds the base64 encoded contents of the public certificate and is referenced from within the Reference element. | | 2 (Subject Key Identifier) | The X509 subject key identifier is included in the KeyIdentifier element. | | 3 (X509PKIPathv1) | A binary security token holds the base64 encoded ordered list of X509 public certificates and is referenced from within the Reference element. | The default value is 0 (X509) and should not be changed unless there is a specific reason to do so. Note: The default value when [profile](#profile-property-as4client-struct) is set to eDelivery is 1 (Binary). **FilenameProperty**: Defines a part property to hold the filename.This setting specifies the [edi_property_name](#edi_property_name-property-as4client-struct) that will hold the name of the file. This may be used to preserve filenames. Both the client and server must agree on the name of the property that will be used to hold the filename. This is helpful in the case where [profile](#profile-property-as4client-struct) is set to ebpfStandard and the first file being sent is of type "text/xml" or "application/xml". In that case the file content is included in the SOAP body and there is no standard mechanism for preserving the filename. When set the struct will automatically populate the property when sending files and will read the filename from this property when receiving files. By default this is not specified. Note: The filenames will always be preserved within the MIME header attributes whenever possible regardless of whether this setting is specified. **ForceSigningCert**: Whether to force only the SigningCert to be used for signing.When set to *False* the struct will first check signing_cert for a certificate to use for signing operations. If signing_cert is not specified it will use the certificate specified in certificate. If set to *True* (default) the struct will only attempt to use the certificate specified by signing_cert. If signing_cert is not specified signing will not be attempted. **FromId[i]**: The Id of the party specified by AS4From.This setting sets the Id of the party specified by as4_from at the index specified here. This is only used when multiple Ids are set. See [FromIdCount](#FromIdCount) for more details. **FromIdCount**: The number of Ids for the party specified by AS4From.Multiple Ids may be specified for the as4_from party. This setting defines the total number of Ids. This is used in conjunction with [FromId](#FromId) and [FromIdType](#FromIdType). For instance: ```text component.Config("FromIdCount=2"); component.Config("FromId[0]=id1"); component.Config("FromIdType[0]=mytype"); component.Config("FromId[1]=id2"); ``` When receiving a message with multiple Ids, query these settings to read the values. By default this value is unspecified and only a single Id is used as specified in the [as4_from_id](#as4_from_id-property-as4client-struct) property of as4_from. **FromIdType[i]**: The Id type of the party specified by AS4From.This setting sets the Id type of the party specified by as4_from at the index specified here. This is only used when multiple Ids are set. See [FromIdCount](#FromIdCount) for more details. **IdRight**: A custom Id for the right side of the MessageId.This setting may be used to specify a custom value for the right side of the [message_id](#message_id-property-as4client-struct) that is generated by the struct. By default the struct will automatically generate message Ids in the format: *2a1546bd-d623-4e7f-bb8d-ddecfb4de51c@nsoftware* This setting provides a way to replace the "nsoftware" value after the "@" symbol with another value. **IncludeEBPrefixList**: Whether the eb3 namespace prefix is included in the signature's InclusiveNamespaces list.This setting controls whether the "eb3" namespace prefix (used by the eb3:Messaging element) is added to the InclusiveNamespaces PrefixList when canonicalizing the signature's SignedInfo element. If set to False (default), the prefix is not force-included. If set to True, "eb3" is added to the list. **IncludeHeaders**: Whether headers are included when posting to a file.This setting determines if headers are included in the file when using [PostToFile](#PostToFile). By default this value is true. When set to False headers are not included in the content written to the file. When set to False this also allows data to be streamed directly to the file specified by [PostToFile](#PostToFile) without any substantial memory overhead or the use of [EncodeToTempDir](#EncodeToTempDir). After posting to a file check the [MessageHeaders](#MessageHeaders) to obtain the headers. This setting should only be used when [PostToFile](#PostToFile) is set. **KeyAgreementMethod**: The agreement method used for KeyWrap encryption algorithms.This setting specifies the agreement method used for KeyWrap encryption algorithms (KW-AES). The default is ECDH-ES, and other methods are not currently supported. Possible values are: | Value | Algorithm | Notes | | --- | --- | --- | | DH | http://www.w3.org/2009/xmlenc11#dh | Not currently implemented. | | DH-ES | http://www.w3.org/2009/xmlenc11#dh-es | Not currently implemented. | | ECDH-ES | http://www.w3.org/2009/xmlenc11#ECDH-ES | Default when [profile](#profile-property-as4client-struct) is ebpfBDEW. | | X25519 | http://www.w3.org/2001/04/xmldsig-more#x25519 | Default when [profile](#profile-property-as4client-struct) is ebpfENTSOG_V4 or ebpgEDelivery_V24. | | X448 | http://www.w3.org/2001/04/xmldsig-more#x448 | | **KeyDerivationConcatKDFDigestMethod**: The digest method used for the ConcatKDF key derivation method.This is the digest method used when the ConcatKDF key derivation method is selected. In most cases this should not be changed. Only change this value if there is a specific reason to do so. Possible values are: - SHA512 - SHA384 - SHA256 (Default) - SHA224 - SHA1 **KeyDerivationMethod**: The key derivation method used for KeyWrap encryption algorithms.This setting specifies the derivation method used for KeyWrap encryption algorithms (KW-AES). Possible values are: | Value | Algorithm | | --- | --- | | ConcatKDF (Default) | http://www.w3.org/2009/xmlenc11#ConcatKDF | | PBKDF2 | http://www.w3.org/2009/xmlenc11#pbkdf2 | | HKDF | http://www.w3.org/2021/04/xmldsig-more#hkdf | **KeyEncryptionAlgorithm**: The algorithm used to encrypt the key.This setting specifies the algorithm used to encrypt the key for this message. In most cases this should not be changed. Only change this value if there is a specific reason to do so. Possible values are: | Value | Algorithm | Notes | | --- | --- | --- | | RSA-OAEP-XMLENC11 | http://www.w3.org/2009/xmlenc11#rsa-oaep | This is used in the default configuration. Additionally if RSA-OAEP is specified this will be automatically used instead if [OAEPMGF1HashAlgorithm](#OAEPMGF1HashAlgorithm) is set to any value except SHA1 or [OAEPRSAHashAlgorithm](#OAEPRSAHashAlgorithm) is set to SHA384 or SHA512. | | RSA-v1.5 | http://www.w3.org/2001/04/xmlenc#rsa-1_5 | There are no conditions for the use of this algorithm. If specified it will be used regardless of other settings. | | RSA-OAEP | http://www.w3.org/2001/04/xmlenc#rsa-oaep-mgf1p | This is used by default when [OAEPMGF1HashAlgorithm](#OAEPMGF1HashAlgorithm) is set to SHA1 and [OAEPRSAHashAlgorithm](#OAEPRSAHashAlgorithm) is set to SHA1 or SHA256. This is only applicable under these conditions, it cannot override when RSA-OAEP-XMLENC11 is used based on the [OAEPMGF1HashAlgorithm](#OAEPMGF1HashAlgorithm) and [OAEPRSAHashAlgorithm](#OAEPRSAHashAlgorithm) values. | | KW-AES128 | http://www.w3.org/2001/04/xmlenc#kw-aes128 | This is used by default if [profile](#profile-property-as4client-struct) is set to ebpfBDEW. | | KW-AES192 | http://www.w3.org/2001/04/xmlenc#kw-aes192 | | | KW-AES256 | http://www.w3.org/2001/04/xmlenc#kw-aes256 | | **LogOptions**: The information to be written to log files.When [log_directory](#log_directory-property-as4client-struct) is set, several pieces of information are written to log files in the specified directory. Set *LogOptions* to one or more of the following values to control what information is written to file. When specifying multiple values, include them in the same string (i.e. "LogOptions=Incoming, Outgoing, Log"). The default value is All. Possible values are: | | | | --- | --- | | Log | Contains information about the steps taken during processing. Also see [LogLevel](#LogLevel). | | Incoming | Contains the raw request/response that is received by the struct. | | Outgoing | Contains the raw request/response that is sent by the struct. | | IncomingMessage | Contains the incoming ebXML message. | | OutgoingMessage | Contains the outgoing ebXML message. | | All (default) | All of the above | **MessageHeaders**: Returns the headers of the message.This setting returns the headers of the generated message when [IncludeHeaders](#IncludeHeaders) is False and [PostToFile](#PostToFile) is set. It should not be used in any other cases. **MessageType**: Indicates the type of message received.This property may be used to determine what type of message was received in a request. Requests may be used for multiple functions. For instance a request may contain a pull request and a receipt. This setting may be used as a bitmask to determine which combination of types are present. To inspect the message perform a binary 'AND' with one or more of the following values: | | | | --- | --- | | 1 | Pull Request (Receive Files) | | 2 | User Message (Send Files) | | 4 | Receipt | | 8 | Error Message | For instance: ```text int requestType = Int32.Parse(AS4Server.Config("MessageType")); if((requestType & 1) != 0) //The request contains a pull request ``` **NormalizeIssuerSubject**: Whether to normalize the certificate subject within the X509Data element.If set to True (default) the struct will normalize the X509IssuerName element within the request to conform to RFC 2253. If set to False the struct will use a standard format used by other components within the toolkit, which may not be compatible with all other AS4 software. The default value is True to maximize interoperability with other AS4 software. **OAEPMGF1HashAlgorithm**: The MGF1 hash algorithm used when encrypting a key.When encryption is enabled, this algorithm specifies the MGF1 hash algorithm used for the encryption key by RSA OAEP. Possible values are: - "SHA1" - "SHA224" - "SHA256" (default) - "SHA384" - "SHA512" Note: If [profile](#profile-property-as4client-struct) is set to ENTSOG the MGF1HashAlgorithm will be set to "SHA256" by default. **OAEPParams**: The hex encoded OAEP parameters to be used when encrypting a key.This setting is optional and should only be specified if OAEP parameters need to be explicitly set. The value specified should be a hex string. By default this setting is unspecified. **OAEPRSAHashAlgorithm**: The RSA hash algorithm used when encrypting a key.When encryption is enabled, this algorithm specifies the RSA hash algorithm used for the encryption key. This may differ from the hash algorithm used to sign the AS4 message content. Possible values are: - "SHA1" - "SHA224" - "SHA256" (default) - "SHA384" - "SHA512" **Password**: A password if authentication is to be used.If [AuthScheme](#AuthScheme) is set to Basic, the [User](#User) and [Password](#Password) are Base64 encoded and the result is put in the [Authorization](#Authorization) configuration setting in the form "Basic [encoded-user-password]". If [AuthScheme](#AuthScheme) is set to Digest, the [User](#User) and [Password](#Password) properties are used to respond to the HTTP Digest Authentication challenge from the server. The [User](#User) and [Password](#Password) properties must be set only after the [url](#url-property-as4client-struct) property is set. When the [url](#url-property-as4client-struct) property is set, for security reasons, [User](#User) and [Password](#Password) are immediately cleared. **PostToFile**: Creates the message on disk.This setting allows for the message to be created on disk without actually being sent. This is useful in certain situations to prepare the message where it is sent by a different transport mechanism at a later time. This should be set to a relative or absolute file path including the filename. When this is set the struct will immediately start processing the message and writing to the specified file. **PullAction**: The Action to use with selective message pulling.When calling [receive_files](#receive_files-method-as4client-struct) this setting may be used to selectively download files from the server. If the server supports this functionality, only messages matching the criteria specified will be downloaded. **PullAgreementRef**: The AgreementRef to use with selective message pulling.When calling [receive_files](#receive_files-method-as4client-struct) this setting may be used to selectively download files from the server. If the server supports this functionality, only messages matching the criteria specified will be downloaded. **PullRefToMessageId**: The RefToMessageId to use with selective message pulling.When calling [receive_files](#receive_files-method-as4client-struct) this setting may be used to selectively download files from the server. If the server supports this functionality, only messages matching the criteria specified will be downloaded. **PullService**: The Service to use with selective message pulling.When calling [receive_files](#receive_files-method-as4client-struct) this setting may be used to selectively download files from the server. If the server supports this functionality, only messages matching the criteria specified will be downloaded. **PullServiceType**: The ServiceType to use with selective message pulling.When calling [receive_files](#receive_files-method-as4client-struct) this setting may be used to selectively download files from the server. If the server supports this functionality, only messages matching the criteria specified will be downloaded. **ReferenceHashAlgorithm**: The hash algorithm used to hash the data specified in the reference of a signature.When signing the content being signed is referred to by a reference in the Signature element. This setting specifies the hash algorithm used when computing the reference digest. Possible values are: - "SHA1" - "SHA224" - "SHA256" (default) - "SHA384" - "SHA512" **RequireEncryption**: Whether encryption is required when processing received messages.This setting may be set to True to require that received messages are encrypted. When True if a message is received that is not encrypted the struct will throw an exception. The default value is False. **RequireSignature**: Whether a signature is required when processing received messages.This setting may be set to True to require that received messages are signed. When True if a message is received that is not signed the struct will throw an exception. The default value is False. **ResponseFile**: A file from which to read the response.This setting specifies a file from which the response is read. This may be useful in cases where the response is not received directly by the struct. For instance it may be useful in debugging. If [ResponseHeaders](#ResponseHeaders) is not specified they will be read from file. **ResponseHeaders**: The headers for the AS4 response message.This setting specifies the headers to be used in conjunction with [ResponseFile](#ResponseFile) to provide the request to the struct. See [ResponseFile](#ResponseFile) for details. **RolloverCertStore**: The certificate store for the rollover certificate.The *RolloverCert** configuration settings may be used to specify an additional certificate to use for decryption during a period of transition between private certificates in the application. This setting specifies the certificate store. When specified the struct will be able to decrypt messages that were encrypted with the corresponding public certificate of either certificate or the *RolloverCert** configuration settings. **RolloverCertStorePassword**: The certificate store for the rollover certificate.The *RolloverCert** configuration settings may be used to specify an additional certificate to use for decryption during a period of transition between private certificates in the application. This setting specifies the certificate store's password. When specified the struct will be able to decrypt messages that were encrypted with the corresponding public certificate of either certificate or the *RolloverCert** configuration settings. **RolloverCertStoreType**: The certificate store for the rollover certificate.The *RolloverCert** configuration settings may be used to specify an additional certificate to use for decryption during a period of transition between private certificates in the application. This setting specifies the type of certificate store. When specified the struct will be able to decrypt messages that were encrypted with the corresponding public certificate of either certificate or the *RolloverCert** configuration settings. **RolloverCertSubject**: The certificate store for the rollover certificate.The *RolloverCert** configuration settings may be used to specify an additional certificate to use for decryption during a period of transition between private certificates in the application. This setting specifies the certificate's subject. When specified the struct will be able to decrypt messages that were encrypted with the corresponding public certificate of either certificate or the *RolloverCert** configuration settings. The certificate will be loaded after this setting is set, so it should be set after the other *RolloverCert** settings. **SignatureHash**: The hash algorithm used to hash the data specified in signature.This setting is used to specify the signature hash algorithm. This is only applicable when [profile](#profile-property-as4client-struct) is set to ENTSOG v4 or eDelivery V2. Possible values are: - "SHA256" (default) **SignerCACert**: The CA certificates that issued the signer certificate.This setting may be set prior to signature verification when receiving messages that are signed using a certificate specified in the message itself as a BinarySecurityToken. If this setting is specified, the struct will verify the chain of the signer certificate against the CA list set in this setting. To specify one or more CA certificate prior to signature verification set this to the base64 encoded public certificate of each CA certificate. Each additional certificate can be added by prepending the data with a *+* character. If the value begins with a *+* the struct will add the following value to an internal store of CA certificates. For instance: ```csharp //Add the first CA certificate as4.Config("SignerCACert=MIICFDCCAX2g..."); //Add another CA certificate (Note the leading '+') as4.Config("SignerCACert=+MIICHDCCAYW..."); ``` If the chain validation fails during signature verification the struct fails with an error. If this setting is not specified no chain validation is performed. **SigningSecurityTokenFormat**: The format to use for the security token when signing.This setting specifies the security token format that is included in the message when signing. This setting should only be set if there is a specific reason to do so. This specifies the reference type in the SecurityTokenReference element applicable to the signed data. Possible values are: | | | | --- | --- | | 0 (X509 - default) | X509 data including the certificate's issuer name and issuer serial number is included in the X509Data element. | | 1 (Binary) | A binary security token holds the base64 encoded contents of the public certificate and is referenced from within the Reference element. | | 2 (Subject Key Identifier) | The X509 subject key identifier is included in the KeyIdentifier element. | | 3 (X509PKIPathv1) | A binary security token holds the base64 encoded ordered list of X509 public certificates and is referenced from within the Reference element. | The default value is 0 (X509) and should not be changed unless there is a specific reason to do so. Note: The default value when [profile](#profile-property-as4client-struct) is set to eDelivery is 1 (Binary). **TempPath**: Where temporary files are optionally written.When processing large files an excessive amount of memory may be used, leading to out-of-memory exceptions. To reduce the amount of memory used, partially encoded files can be written to a temporary directory. Set this to a folder on disk where temporary files may be written. **ToId[i]**: The Id of the party specified by AS4To.This setting sets the Id of the party specified by as4_to at the index specified here. This is only used when multiple Ids are set. See [ToIdCount](#ToIdCount) for more details. **ToIdCount**: The number of Ids for the party specified by AS4To.Multiple Ids may be specified for the as4_to party. This setting defines the total number of Ids. This is used in conjunction with [ToId](#ToId) and [ToIdType](#ToIdType). For instance: ```text component.Config("ToIdCount=2"); component.Config("ToId[0]=id1"); component.Config("ToIdType[0]=mytype"); component.Config("ToId[1]=id2"); ``` When receiving a message with multiple Ids, query these settings to read the values. By default this value is unspecified and only a single Id is used as specified in the [as4_to_id](#as4_to_id-property-as4client-struct) property of as4_to. **ToIdType[i]**: The Id type of the party specified by AS4To.This setting sets the Id type of the party specified by as4_to at the index specified here. This is only used when multiple Ids are set. See [ToIdCount](#ToIdCount) for more details. **TransformReceipt**: Whether to canonicalize the received receipt.When a receipt is received this setting controls whether the value in [receipt_content](#receipt_content-property-as4client-struct) is transformed. When set to True (default) the struct will perform canonicalize the receipt when it is received. This may be helpful if the value of [receipt_content](#receipt_content-property-as4client-struct) is to be used in a later process where a valid XML document is required. When set to true (false by default), the component will transform the receipt content made available in the component using Exclusive XML Canonicalization. If False the struct will not alter the received receipt. The value of [receipt_content](#receipt_content-property-as4client-struct) will not itself be a well formed XML document. **UseNonce**: Whether to use a nonce in UsernameToken authentication.This setting specifies whether a nonce is included in the UsernameToken authentication when [receive_files](#receive_files-method-as4client-struct) is called. If True (default) the struct will generate and include a nonce. This is recommended for security purposes. If set to False the struct will not include a nonce in the request. See [token_user](#token_user-property-as4client-struct) and [token_password](#token_password-property-as4client-struct) for more details. **User**: A user name if authentication is to be used.If [AuthScheme](#AuthScheme) is set to Basic, the [User](#User) and [Password](#Password) are Base64 encoded and the result is put in the [Authorization](#Authorization) configuration setting in the form "Basic [encoded-user-password]". If [AuthScheme](#AuthScheme) is set to Digest, the [User](#User) and [Password](#Password) properties are used to respond to the HTTP Digest Authentication challenge from the server. The [User](#User) and [Password](#Password) properties must be set only after the [url](#url-property-as4client-struct) property is set. When the [url](#url-property-as4client-struct) property is set, for security reasons, [User](#User) and [Password](#Password) are immediately cleared. **UseTransformedXMLAttachment**: Whether to send the canonicalized XML.By default, when an XML document is specified in the [edi_data](#edi_data-property-as4client-struct), it will be canonicalized (c14n) in order to calculate the hash value. When the XML attachment is transmitted, this canonicalized data is used by default (True). When set to False, the struct will transmit the original data instead. ### HTTP Config Settings **AcceptEncoding**: Used to tell the server which types of content encodings the client supports.When [AllowHTTPCompression](#AllowHTTPCompression) is True, the struct adds an *Accept-Encoding* header to the request being sent to the server. By default, this header's value is "gzip, deflate". This configuration setting allows you to change the value of the *Accept-Encoding* header. NOTE: The struct only supports gzip and deflate decompression algorithms. **AllowHTTPCompression**: This property enables HTTP compression for receiving data.This configuration setting enables HTTP compression for receiving data. When set to True (default), the struct will accept compressed data. It then will uncompress the data it has received. The struct will handle data compressed by both gzip and deflate compression algorithms. When True, the struct adds an *Accept-Encoding* header to the outgoing request. The value for this header can be controlled by the [AcceptEncoding](#AcceptEncoding) configuration setting. The default value for this header is "gzip, deflate". The default value is True. **AllowHTTPFallback**: Whether HTTP/2 connections are permitted to fallback to HTTP/1.1.This configuration setting controls whether HTTP/2 connections are permitted to fall back to HTTP/1.1 when the server does not support HTTP/2. This setting is applicable only when http_version is set to "2.0". If set to True (default), the struct will automatically use HTTP/1.1 if the server does not support HTTP/2. If set to False, the struct fails with an error if the server does not support HTTP/2. The default value is True. **Append**: Whether to append data to LocalFile.This configuration setting determines whether data will be appended when writing to local_file. When set to True, downloaded data will be appended to local_file. This may be used in conjunction with range to resume a failed download. This is applicable only when local_file is set. The default value is False. **Authorization**: The Authorization string to be sent to the server.If the [Authorization](#Authorization) property contains a nonempty string, an *Authorization* HTTP request header is added to the request. This header conveys Authorization information to the server. This property is provided so that the HTTP struct can be extended with other security schemes in addition to the authorization schemes already implemented by the struct. The auth_scheme property defines the authentication scheme used. In the case of HTTP Basic Authentication (default), every time user and password are set, they are Base64 encoded, and the result is put in the authorization property in the form "Basic [encoded-user-password]". **BytesTransferred**: Contains the number of bytes transferred in the response data.This configuration setting returns the raw number of bytes from the HTTP response data, before the component processes the data, whether it is chunked or compressed. This returns the same value as the [on_transfer](#on_transfer-event-as4client-struct) event, by [BytesTransferred](#BytesTransferred). **ChunkSize**: Specifies the chunk size in bytes when using chunked encoding.This is applicable only when [UseChunkedEncoding](#UseChunkedEncoding) is True. This setting specifies the chunk size in bytes to be used when posting data. The default value is 16384. **CompressHTTPRequest**: Set to true to compress the body of a PUT or POST request.If set to True, the body of a *PUT* or *POST* request will be compressed into gzip format before sending the request. The "Content-Encoding" header is also added to the outgoing request. The default value is False. **EncodeURL**: If set to True the URL will be encoded by the struct.If set to True, the URL passed to the struct will be URL encoded. The default value is False. **FollowRedirects**: Determines what happens when the server issues a redirect.This option determines what happens when the server issues a redirect. Normally, the struct returns an error if the server responds with an "Object Moved" message. If this property is set to 1 (always), the new [url](#url-property-as4client-struct) for the object is retrieved automatically every time. If this property is set to 2 (Same Scheme), the new [url](#url-property-as4client-struct) is retrieved automatically only if the URL Scheme is the same; otherwise, the struct fails with an error. **Note:** Following the HTTP specification, unless this option is set to 1 (Always), automatic redirects will be performed only for *GET* or *HEAD* requests. Other methods potentially could change the conditions of the initial request and create security vulnerabilities. Furthermore, if either the new URL server or port are different from the existing one, user and password are also reset to empty, unless this property is set to 1 (Always), in which case the same credentials are used to connect to the new server. A on_redirect event is fired for every URL the product is redirected to. In the case of automatic redirections, the on_redirect event is a good place to set properties related to the new connection (e.g., new authentication parameters). The default value is 0 (Never). In this case, redirects are never followed, and the struct fails with an error instead. Following are the valid options: - 0 - Never - 1 - Always - 2 - Same Scheme **GetOn302Redirect**: If set to True the struct will perform a GET on the new location.The default value is False. If set to True, the struct will perform a *GET* on the new location. Otherwise, it will use the same HTTP method again. **HTTP2HeadersWithoutIndexing**: HTTP2 headers that should not update the dynamic header table with incremental indexing.HTTP/2 servers maintain a dynamic table of headers and values seen over the course of a connection. Typically, these headers are inserted into the table through incremental indexing (also known as HPACK, defined in RFC 7541). To tell the component not to use incremental indexing for certain headers, and thus not update the dynamic table, set this configuration option to a comma-delimited list of the header names. **HTTPVersion**: The version of HTTP used by the struct.This property specifies the HTTP version used by the struct. Possible values are as follows: - "1.0" - "1.1" (default) - "2.0" - "3.0" When using HTTP/2 ("2.0") or HTTP/3 ("3.0"), additional restrictions apply. Please see the following notes for details. **HTTP/2 Notes** When using HTTP/2, a secure Secure Sockets Layer/Transport Layer Security (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/2 will result in an error. If the server does not support HTTP/2, the struct will automatically use HTTP/1.1 instead. This is done to provide compatibility without the need for any additional settings. To see which version was used, check [NegotiatedHTTPVersion](#NegotiatedHTTPVersion) after calling a method. The [AllowHTTPFallback](#AllowHTTPFallback) setting controls whether this behavior is allowed (default) or disallowed. **HTTP/3 Notes** HTTP/3 is supported only in .NET and Java. When using HTTP/3, a secure (TLS/SSL) connection is required. Attempting to use a plaintext URL with HTTP/3 will result in an error. **IfModifiedSince**: A date determining the maximum age of the desired document.If this setting contains a nonempty string, an If-Modified-Since HTTP header is added to the request. The value of this header is used to make the HTTP request conditional: if the requested documented has not been modified since the time specified in the field, a copy of the document will not be returned from the server; instead, a 304 (not modified) response will be returned by the server and the component throws an exception The format of the date value for IfModifiedSince is detailed in the HTTP specs. For example: ```text Sat, 29 Oct 2017 19:43:31 GMT. ``` **KeepAlive**: Determines whether the HTTP connection is closed after completion of the request.If *true*, the component will not send the *Connection: Close* header. The absence of the Connection header indicates to the server that HTTP persistent connections should be used if supported. NOTE: Not all servers support persistent connections. If *false*, the connection will be closed immediately after the server response is received. The default value for [KeepAlive](#KeepAlive) is *false*. **KerberosSPN**: The Service Principal Name for the Kerberos Domain Controller.If the Service Principal Name on the Kerberos Domain Controller is not the same as the URL that you are authenticating to, the Service Principal Name should be set here. **LogLevel**: The level of detail that is logged.This configuration setting controls the level of detail that is logged through the [on_log](#on_log-event-as4client-struct) event. Possible values are as follows: | | | | --- | --- | | 0 (None) | No events are logged. | | 1 (Info - default) | Informational events are logged. | | 2 (Verbose) | Detailed data are logged. | | 3 (Debug) | Debug data are logged. | The value 1 (Info) logs basic information, including the URL, HTTP version, and status details. The value 2 (Verbose) logs additional information about the request and response. The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any). **MaxRedirectAttempts**: Limits the number of redirects that are followed in a request.When follow_redirects is set to any value other than frNever, the struct will follow redirects until this maximum number of redirect attempts are made. The default value is 20. **NegotiatedHTTPVersion**: The negotiated HTTP version.This configuration setting may be queried after the request is complete to indicate the HTTP version used. When http_version is set to "2.0" (if the server does not support "2.0"), then the struct will fall back to using "1.1" automatically. This setting will indicate which version was used. **OtherHeaders**: Other headers as determined by the user (optional).This configuration setting can be set to a string of headers to be appended to the HTTP request headers. The headers must follow the format "header: value" as described in the HTTP specifications. Header lines should be separated by CRLF (*"\r\n"*) . Use this configuration setting with caution. If this configuration setting contains invalid headers, HTTP requests may fail. This configuration setting is useful for extending the functionality of the struct beyond what is provided. **ProxyAuthorization**: The authorization string to be sent to the proxy server.This is similar to the [Authorization](#Authorization) configuration setting, but is used for proxy authorization. If this configuration setting contains a nonempty string, a *Proxy-Authorization* HTTP request header is added to the request. This header conveys proxy Authorization information to the server. If [proxy_user](#proxy_user-property-as4client-struct) and [proxy_password](#proxy_password-property-as4client-struct) are specified, this value is calculated using the algorithm specified by [proxy_auth_scheme](#proxy_auth_scheme-property-as4client-struct). **ProxyAuthScheme**: The authorization scheme to be used for the proxy.This configuration setting is provided for use by structs that do not directly expose Proxy properties. **ProxyPassword**: A password if authentication is to be used for the proxy.This configuration setting is provided for use by structs that do not directly expose Proxy properties. **ProxyPort**: Port for the proxy server (default 80).This configuration setting is provided for use by structs that do not directly expose Proxy properties. **ProxyServer**: Name or IP address of a proxy server (optional).This configuration setting is provided for use by structs that do not directly expose Proxy properties. **ProxyUser**: A user name if authentication is to be used for the proxy.This configuration setting is provided for use by structs that do not directly expose Proxy properties. **SentHeaders**: The full set of headers as sent by the client.This configuration setting returns the complete set of raw headers as sent by the client. **StatusCode**: The status code of the last response from the server.This configuration setting contains the result code of the last response from the server. **StatusLine**: The first line of the last response from the server.This setting contains the first line of the last response from the server. The format of the line will be *[HTTP version] [Result Code] [Description]*. **TransferredData**: The contents of the last response from the server.This configuration setting contains the contents of the last response from the server. **TransferredDataLimit**: The maximum number of incoming bytes to be stored by the struct.If [TransferredDataLimit](#TransferredDataLimit) is set to 0 (default), no limits are imposed. Otherwise, this reflects the maximum number of incoming bytes that can be stored by the struct. **TransferredHeaders**: The full set of headers as received from the server.This configuration setting returns the complete set of raw headers as received from the server. **TransferredRequest**: The full request as sent by the client.This configuration setting returns the full request as sent by the client. For performance reasons, the request is not normally saved. Set this configuration setting to ON before making a request to enable it. Following are examples of this request: .NET ```text Http http = new Http(); http.Config("TransferredRequest=on"); http.PostData = "body"; http.Post("http://someserver.com"); Console.WriteLine(http.Config("TransferredRequest")); ``` C++ ```text HTTP http; http.Config("TransferredRequest=on"); http.SetPostData("body", 5); http.Post("http://someserver.com"); printf("%s\r\n", http.Config("TransferredRequest")); ``` **UseChunkedEncoding**: Enables or Disables HTTP chunked encoding for transfers.If [UseChunkedEncoding](#UseChunkedEncoding) is set to True, the struct will use HTTP-chunked encoding when posting, if possible. HTTP-chunked encoding allows large files to be sent in chunks instead of all at once. If set to False, the struct will not use HTTP-chunked encoding. The default value is False. NOTE: Some servers (such as the ASP.NET Development Server) may not support chunked encoding. **UseIDNs**: Whether to encode hostnames to internationalized domain names.This configuration setting specifies whether hostnames containing non-ASCII characters are encoded to internationalized domain names. When set to True, if a hostname contains non-ASCII characters, it is encoded using Punycode to an IDN (internationalized domain name). The default value is False and the hostname will always be used exactly as specified. NOTE: The [CodePage](#CodePage) setting must be set to a value capable of interpreting the specified host name. For instance, to specify UTF-8, set [CodePage](#CodePage) to *65001*. In the C++ Edition for Windows, the *W version of the class must be used. For instance, *DNSW* or *HTTPW*. **UseProxyAutoConfigURL**: Whether to use a Proxy auto-config file when attempting a connection.This configuration specifies whether the struct will attempt to use the Proxy auto-config URL when establishing a connection and [proxy_auto_detect](#proxy_auto_detect-property-as4client-struct) is set to *True*. When *True* (default), the struct will check for the existence of a Proxy auto-config URL, and if found, will determine the appropriate proxy to use. **UserAgent**: Information about the user agent (browser).This is the value supplied in the HTTP User-Agent header. The default setting is "IPWorks HTTP Component - www.nsoftware.com". Override the default with the name and version of your software. ### TCPClient Config Settings **ConnectionTimeout**: Sets a separate timeout value for establishing a connection.When set, this configuration setting allows you to specify a different timeout value for establishing a connection. Otherwise, the struct will use [timeout](#timeout-property-as4client-struct) for establishing a connection and transmitting/receiving data. **EnableFallback**: Whether to try the other addresses the remote host resolves to when a connection attempt fails.When set to True and remote_host resolves to more than one address, the struct will try the remaining addresses in turn if the connection to the first one fails, and only fails with an error once every address has been tried. The error reported is the one from the last attempt. Use [FallbackTimeout](#FallbackTimeout) to limit the total time spent. NOTE: Only addresses of the same IP version as the first one are tried, this setting does not fall back from IPv6 to IPv4. Selecting between IPv6 and IPv4 is done by [UseIPv6](#UseIPv6) when the host is resolved. This setting must be set before the connection is established. The default value for this setting is False. **FallbackTimeout**: The maximum time in milliseconds to spend on connection attempts when EnableFallback is enabled.This setting limits the total time that the struct will spend on all of the connection attempts made when [EnableFallback](#EnableFallback) is enabled. The default value is 0, in which case each attempt uses the operating system's own connection timeout. NOTE: This setting only applies when [EnableFallback](#EnableFallback) is True. It is unrelated to [ConnectionTimeout](#ConnectionTimeout), which is specified in seconds and applies to the connected operation as a whole. **FirewallAutoDetect**: Tells the struct whether or not to automatically detect and use firewall system settings, if available.This configuration setting is provided for use by structs that do not directly expose Firewall properties. **FirewallHost**: Name or IP address of firewall (optional).If a [FirewallHost](#FirewallHost) is given, requested connections will be authenticated through the specified firewall when connecting. If the [FirewallHost](#FirewallHost) setting is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, the [FirewallHost](#FirewallHost) setting is set to the corresponding address. If the search is not successful, an error is returned. NOTE: This setting is provided for use by structs that do not directly expose Firewall properties. **FirewallHTTPVersion**: The HTTP version to be used when connecting through a tunneling proxy.When [FirewallType](#FirewallType) is set to a tunneling proxy, this setting dictates which HTTP version is used when connecting. **FirewallPassword**: Password to be used if authentication is to be used when connecting through the firewall.If [FirewallHost](#FirewallHost) is specified, the [FirewallUser](#FirewallUser) and [FirewallPassword](#FirewallPassword) settings are used to connect and authenticate to the given firewall. If the authentication fails, the struct fails with an error. NOTE: This setting is provided for use by structs that do not directly expose Firewall properties. **FirewallPort**: The TCP port for the FirewallHost;.The [FirewallPort](#FirewallPort) is set automatically when [FirewallType](#FirewallType) is set to a valid value. NOTE: This configuration setting is provided for use by structs that do not directly expose Firewall properties. **FirewallType**: Determines the type of firewall to connect through.Possible values are as follows: | | | | --- | --- | | 0 | No firewall (default setting). | | 1 | Connect through a tunneling proxy. [FirewallPort](#FirewallPort) is set to 80. | | 2 | Connect through a SOCKS4 Proxy. [FirewallPort](#FirewallPort) is set to 1080. | | 3 | Connect through a SOCKS5 Proxy. [FirewallPort](#FirewallPort) is set to 1080. | | 10 | Connect through a SOCKS4A Proxy. [FirewallPort](#FirewallPort) is set to 1080. | NOTE: This setting is provided for use by structs that do not directly expose Firewall properties. **FirewallUser**: A user name if authentication is to be used connecting through a firewall.If the [FirewallHost](#FirewallHost) is specified, the [FirewallUser](#FirewallUser) and [FirewallPassword](#FirewallPassword) settings are used to connect and authenticate to the Firewall. If the authentication fails, the struct fails with an error. NOTE: This setting is provided for use by structs that do not directly expose Firewall properties. **KeepAliveInterval**: The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.When set, [TCPKeepAlive](#TCPKeepAlive) will automatically be set to True. A TCP keep-alive packet will be sent after a period of inactivity as defined by [KeepAliveTime](#KeepAliveTime). If no acknowledgment is received from the remote host, the keep-alive packet will be sent again. This configuration setting specifies the interval at which the successive keep-alive packets are sent in milliseconds. This system default if this value is not specified here is 1 second. NOTE: This value is not applicable in macOS. **KeepAliveTime**: The inactivity time in milliseconds before a TCP keep-alive packet is sent.When set, [TCPKeepAlive](#TCPKeepAlive) will automatically be set to True. By default, the operating system will determine the time a connection is idle before a Transmission Control Protocol (TCP) keep-alive packet is sent. This system default if this value is not specified here is 2 hours. In many cases, a shorter interval is more useful. Set this value to the desired interval in milliseconds. **Linger**: When set to True, connections are terminated gracefully.This property controls how a connection is closed. The default is True. In the case that Linger is True (default), two scenarios determine how long the connection will linger. In the first, if [LingerTime](#LingerTime) is 0 (default), the system will attempt to send pending data for a connection until the default IP timeout expires. In the second scenario, if [LingerTime](#LingerTime) is a positive value, the system will attempt to send pending data until the specified [LingerTime](#LingerTime) is reached. If this attempt fails, then the system will reset the connection. The default behavior (which is also the default mode for stream sockets) might result in a long delay in closing the connection. Although the struct returns control immediately, the system could hold system resources until all pending data are sent (even after your application closes). Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you sent (e.g., by a client acknowledgment), setting this property to False might be the appropriate course of action. **LingerTime**: Time in seconds to have the connection linger. LingerTime is the time, in seconds, the socket connection will linger. This value is 0 by default, which means it will use the default IP timeout. **LocalHost**: The name of the local host through which connections are initiated or accepted. The [local_host](#local_host-property-as4client-struct) setting contains the name of the local host as obtained by the *gethostname()* system call, or if the user has assigned an IP address, the value of that address. In multihomed hosts (machines with more than one IP interface), setting LocalHost to the value of an interface will make the struct initiate connections (or accept in the case of server structs) only through that interface. If the struct is connected, the [local_host](#local_host-property-as4client-struct) setting shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface). **LocalPort**: The port in the local host where the struct binds. This configuration setting must be set before a connection is attempted. It instructs the struct to bind to a specific port (or communication endpoint) in the local machine. Setting this to 0 (default) enables the system to choose a port at random. The chosen port will be shown by local_port after the connection is established. local_port cannot be changed once a connection is made. Any attempt to set this when a connection is active will generate an error. This configuration setting is useful when trying to connect to services that require a trusted port on the client side. An example is the remote shell (rsh) service in UNIX systems. **MaxLineLength**: The maximum amount of data to accumulate when no EOL is found.[MaxLineLength](#MaxLineLength) is the size of an internal buffer, which holds received data while waiting for an eol string. If an eol string is found in the input stream before [MaxLineLength](#MaxLineLength) bytes are received, the on_data_in event is fired with the *EOL* parameter set to True, and the buffer is reset. If no eol is found, and [MaxLineLength](#MaxLineLength) bytes are accumulated in the buffer, the on_data_in event is fired with the *EOL* parameter set to False, and the buffer is reset. The minimum value for [MaxLineLength](#MaxLineLength) is 256 bytes. The default value is 2048 bytes. **MaxTransferRate**: The transfer rate limit in bytes per second.This configuration setting can be used to throttle outbound TCP traffic. Set this to the number of bytes to be sent per second. By default, this is not set and there is no limit. **ProxyExceptionsList**: A semicolon separated list of hosts and IPs to bypass when using a proxy.This configuration setting optionally specifies a semicolon-separated list of hostnames or IP addresses to bypass when a proxy is in use. When requests are made to hosts specified in this property, the proxy will not be used. For instance: *www.google.com;www.example.com* **TCPKeepAlive**: Determines whether or not the keep alive socket option is enabled.If set to True, the socket's keep-alive option is enabled and keep-alive packets will be sent periodically to maintain the connection. Set [KeepAliveTime](#KeepAliveTime) and [KeepAliveInterval](#KeepAliveInterval) to configure the timing of the keep-alive packets. NOTE: This value is not applicable in Java. **TcpNoDelay**: Whether or not to delay when sending packets. When set to True, the socket will send all data that are ready to send at once. When set to False, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm. By default, this configuration setting is set to False. **UseIPv6**: Whether to use IPv6.When set to *0* (default), the struct will use IPv4 exclusively. When set to *1*, the struct will use IPv6 exclusively. To instruct the struct to prefer IPv6 addresses, but use IPv4 if IPv6 is not supported on the system, this setting should be set to *2*. The default value is *0*. Possible values are as follows: | | | | --- | --- | | 0 | IPv4 only | | 1 | IPv6 only | | 2 | IPv6 with IPv4 fallback | **UseNTLMv2**: Whether to use NTLM V2.When authenticating with NTLM, this setting specifies whether NTLM V2 is used. By default this value is True and NTLM V2 will be used. Set this to False to use NTLM V1. ### SSL Config Settings **LogSSLPackets**: Controls whether SSL packets are logged when using the internal security API.When [ssl_provider](#ssl_provider-property-as4client-struct) 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](#on_ssl_status-event-as4client-struct) event, which will fire each time an SSL packet is sent or received. Enabling this configuration setting has no effect if [ssl_provider](#ssl_provider-property-as4client-struct) 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](#ssl_provider-property-as4client-struct) 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: ```text -----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE----- ``` **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](#on_ssl_status-event-as4client-struct) event. Use this configuration setting with caution. Requesting a lower cipher strength than necessary could potentially cause serious security vulnerabilities in your application. When the provider is OpenSSL, [SSLCipherStrength](#SSLCipherStrength) is currently not supported. This functionality is instead made available through the [OpenSSLCipherList](#OpenSSLCipherList) configuration setting. **SSLClientCACerts**: A newline separated list of CA certificates to use during SSL client certificate validation.This configuration setting is only applicable to server components (e.g., TCPServer) see [SSLServerCACerts](#SSLServerCACerts) for client components (e.g., TCPClient). This setting can be used to optionally specify one or more CA certificates to be used when verifying the client certificate that is presented by the client during the SSL handshake when 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: ```text -----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert ... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert ... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE----- ``` **SSLEnabledCipherSuites**: The cipher suite to be used in an SSL negotiation.This configuration setting enables the cipher suites to be used in SSL negotiation. By default, the enabled cipher suites will include all available ciphers ("*"). The special value "*" means that the struct will pick all of the supported cipher suites. If [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) is set to any other value, only the specified cipher suites will be considered. Multiple cipher suites are separated by semicolons. Example values when [ssl_provider](#ssl_provider-property-as4client-struct) is set to *Platform* include the following: ```text obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=CALG_AES_256"); obj.config("SSLEnabledCipherSuites=CALG_AES_256;CALG_3DES"); ``` Possible values when [ssl_provider](#ssl_provider-property-as4client-struct) 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](#ssl_provider-property-as4client-struct) is set to *Internal*include the following: ```text obj.config("SSLEnabledCipherSuites=*"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA"); obj.config("SSLEnabledCipherSuites=TLS_DHE_DSS_WITH_AES_128_CBC_SHA;TLS_ECDH_RSA_WITH_AES_128_CBC_SHA"); ``` Possible values when [ssl_provider](#ssl_provider-property-as4client-struct) is set to *Internal* include the following: - TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 - TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 - TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 - TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 - TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384 - TLS_RSA_WITH_AES_256_GCM_SHA384 - TLS_RSA_WITH_AES_128_GCM_SHA256 - TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256 - TLS_DHE_DSS_WITH_AES_256_GCM_SHA384 - TLS_DHE_RSA_WITH_AES_256_GCM_SHA384 - TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384 - TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256 - TLS_DHE_RSA_WITH_AES_128_GCM_SHA256 - TLS_DHE_DSS_WITH_AES_128_GCM_SHA256 - TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 - TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 - TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384 - TLS_DHE_DSS_WITH_AES_256_CBC_SHA256 - TLS_RSA_WITH_AES_256_CBC_SHA256 - TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384 - TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384 - TLS_DHE_RSA_WITH_AES_256_CBC_SHA256 - TLS_DHE_RSA_WITH_AES_128_CBC_SHA256 - TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 - TLS_RSA_WITH_AES_128_CBC_SHA256 - TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256 - TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256 - TLS_DHE_DSS_WITH_AES_128_CBC_SHA256 - TLS_RSA_WITH_AES_256_CBC_SHA - TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA - TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA - TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA - TLS_DHE_RSA_WITH_AES_256_CBC_SHA - TLS_ECDH_RSA_WITH_AES_256_CBC_SHA - TLS_DHE_DSS_WITH_AES_256_CBC_SHA - TLS_RSA_WITH_AES_128_CBC_SHA - TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA - TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA - TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA - TLS_ECDH_RSA_WITH_AES_128_CBC_SHA - TLS_DHE_RSA_WITH_AES_128_CBC_SHA - TLS_DHE_DSS_WITH_AES_128_CBC_SHA - TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA - TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA - TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA - TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA - TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA - TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA - TLS_RSA_WITH_3DES_EDE_CBC_SHA - TLS_RSA_WITH_DES_CBC_SHA - TLS_DHE_RSA_WITH_DES_CBC_SHA - TLS_DHE_DSS_WITH_DES_CBC_SHA - TLS_RSA_WITH_RC4_128_MD5 - TLS_RSA_WITH_RC4_128_SHA When TLS 1.3 is negotiated (see [SSLEnabledProtocols](#SSLEnabledProtocols)), only the following cipher suites are supported: - TLS_AES_256_GCM_SHA384 - TLS_CHACHA20_POLY1305_SHA256 - TLS_AES_128_GCM_SHA256 [SSLEnabledCipherSuites](#SSLEnabledCipherSuites) is used together with [SSLCipherStrength](#SSLCipherStrength). **SSLEnabledProtocols**: Used to enable/disable the supported security protocols.This configuration setting is used to enable or disable the supported security protocols. Not all supported protocols are enabled by default. The default value is *4032* for client components, and *3072* for server components. To specify a combination of enabled protocol versions set this config to the binary *OR* of one or more of the following values: | | | | --- | --- | | TLS1.3 | 12288 (Hex 3000) | | TLS1.2 | 3072 (Hex C00) (Default - Client and Server) | | TLS1.1 | 768 (Hex 300) (Default - Client) | | TLS1 | 192 (Hex C0) (Default - Client) | | SSL3 | 48 (Hex 30) | | SSL2 | 12 (Hex 0C) | Note that only TLS 1.2 is enabled for server components that accept incoming connections. This adheres to industry standards to ensure a secure connection. Client components enable TLS 1.0, TLS 1.1, and TLS 1.2 by default and will negotiate the highest mutually supported version when connecting to a server, which should be TLS 1.2 in most cases. **SSLEnabledProtocols: Transport Layer Security (TLS) 1.3 Notes:** 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](#ssl_provider-property-as4client-struct) 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](#ssl_provider-property-as4client-struct) 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](#SSLEnabledCipherSuites) and other similar SSL configuration settings are not supported. - If [SSLEnabledProtocols](#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](#ssl_provider-property-as4client-struct) 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](#ssl_provider-property-as4client-struct) 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](#ssl_provider-property-as4client-struct) 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](#on_ssl_server_authentication-event-as4client-struct) 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](#on_ssl_server_authentication-event-as4client-struct) event. If set to True, all certificates returned by the server will be present in the Encoded parameter of the [on_ssl_server_authentication](#on_ssl_server_authentication-event-as4client-struct) 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](#ssl_provider-property-as4client-struct) is set to *Internal*. **SSLNegotiatedCipher**: Returns the negotiated cipher suite.This configuration setting returns the cipher suite negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedCipher[connId]"); ``` **SSLNegotiatedCipherStrength**: Returns the negotiated cipher suite strength.This configuration setting returns the strength of the cipher suite negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedCipherStrength[connId]"); ``` **SSLNegotiatedCipherSuite**: Returns the negotiated cipher suite.This configuration setting returns the cipher suite negotiated during the SSL handshake represented as a single string. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedCipherSuite[connId]"); ``` **SSLNegotiatedKeyExchange**: Returns the negotiated key exchange algorithm.This configuration setting returns the key exchange algorithm negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedKeyExchange[connId]"); ``` **SSLNegotiatedKeyExchangeStrength**: Returns the negotiated key exchange algorithm strength.This configuration setting returns the strength of the key exchange algorithm negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedKeyExchangeStrength[connId]"); ``` **SSLNegotiatedVersion**: Returns the negotiated protocol version.This configuration setting returns the protocol version negotiated during the SSL handshake. NOTE: For server components (e.g., TCPServer), this is a per-connection configuration setting accessed by passing the ConnectionId. For example: ```csharp server.Config("SSLNegotiatedVersion[connId]"); ``` **SSLSecurityFlags**: Flags that control certificate verification.The following flags are defined (specified in hexadecimal notation). They can be ORed together to exclude multiple conditions: | | | | --- | --- | | 0x00000001 | Ignore time validity status of certificate. | | 0x00000002 | Ignore time validity status of CTL. | | 0x00000004 | Ignore non-nested certificate times. | | 0x00000010 | Allow unknown certificate authority. | | 0x00000020 | Ignore wrong certificate usage. | | 0x00000100 | Ignore unknown certificate revocation status. | | 0x00000200 | Ignore unknown CTL signer revocation status. | | 0x00000400 | Ignore unknown certificate authority revocation status. | | 0x00000800 | Ignore unknown root revocation status. | | 0x00008000 | Allow test root certificate. | | 0x00004000 | Trust test root certificate. | | 0x80000000 | Ignore non-matching CN (certificate CN non-matching server name). | This functionality is currently not available when the provider is OpenSSL. **SSLServerCACerts**: A newline separated list of CA certificates to use during SSL server certificate validation.This configuration setting is only used by client components (e.g., TCPClient) see [SSLClientCACerts](#SSLClientCACerts) for server components (e.g., TCPServer). This configuration setting can be used to optionally specify one or more CA certificates to be used when connecting to the server and verifying the server certificate. When verifying the server's certificate, the certificates trusted by the system will be used as part of the verification process. If the server's CA certificates are not installed to the trusted system store, they may be specified here so they are included when performing the verification process. This configuration setting should be set only if the server's CA certificates are not already trusted on the system and cannot be installed to the trusted system store. The value of this configuration setting is a newline-separated (CR/LF) list of certificates. For instance: ```text -----BEGIN CERTIFICATE----- MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw ... Intermediate Cert... eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w F0I1XhM+pKj7FjDr+XNj -----END CERTIFICATE----- \r \n -----BEGIN CERTIFICATE----- MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp ... Root Cert... d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA -----END CERTIFICATE----- ``` **TLS12SignatureAlgorithms**: Defines the allowed TLS 1.2 signature algorithms when SSLProvider is set to Internal.This configuration setting specifies the allowed server certificate signature algorithms when [ssl_provider](#ssl_provider-property-as4client-struct) is set to *Internal* and [SSLEnabledProtocols](#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: ```csharp component.SSLProvider = TCPClientSSLProviders.sslpInternal; component.Config("SSLEnabledProtocols=3072"); //TLS 1.2 component.Config("TLS12SignatureAlgorithms=sha256-rsa,sha256-dsa,sha1-rsa,sha1-dsa"); ``` The default value for this configuration setting is *sha512-ecdsa,sha512-rsa,sha512-dsa,sha384-ecdsa,sha384-rsa,sha384-dsa,sha256-ecdsa,sha256-rsa,sha256-dsa,sha224-ecdsa,sha224-rsa,sha224-dsa,sha1-ecdsa,sha1-rsa,sha1-dsa*. To not restrict the server's certificate signature algorithm, specify an empty string as the value for this configuration setting, which will cause the signature_algorithms TLS 1.2 extension to not be sent. **TLS12SupportedGroups**: The supported groups for ECC.This configuration setting specifies a comma-separated list of named groups used in TLS 1.2 for ECC. The default value is *ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1*. When using TLS 1.2 and [ssl_provider](#ssl_provider-property-as4client-struct) is set to *Internal*, the values refer to the supported groups for ECC. The following values are supported: - "ecdhe_secp256r1" (default) - "ecdhe_secp384r1" (default) - "ecdhe_secp521r1" (default) **TLS13KeyShareGroups**: The groups for which to pregenerate key shares.This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. The groups specified here will have key share data pregenerated locally before establishing a connection. This can prevent an additional roundtrip during the handshake if the group is supported by the server. The default value is set to balance common supported groups and the computational resources required to generate key shares. As a result, only some groups are included by default in this configuration setting. NOTE: All supported groups can always be used during the handshake even if not listed here, but if a group is used that is not present in this list, it will incur an additional roundtrip and time to generate the key share for that group. In most cases, this configuration setting does not need to be modified. This should be modified only if there is a specific reason to do so. The default value is *ecdhe_x25519,ecdhe_secp256r1,ecdhe_secp384r1,ffdhe_2048,ffdhe_3072* The values are ordered from most preferred to least preferred. The following values are supported: - "ecdhe_x25519" (default) - "ecdhe_x448" - "ecdhe_secp256r1" (default) - "ecdhe_secp384r1" (default) - "ecdhe_secp521r1" - "ffdhe_2048" (default) - "ffdhe_3072" (default) - "ffdhe_4096" - "ffdhe_6144" - "ffdhe_8192" **TLS13SignatureAlgorithms**: The allowed certificate signature algorithms.This configuration setting holds a comma-separated list of allowed signature algorithms. Possible values include the following: - "ed25519" (default) - "ed448" (default) - "ecdsa_secp256r1_sha256" (default) - "ecdsa_secp384r1_sha384" (default) - "ecdsa_secp521r1_sha512" (default) - "rsa_pkcs1_sha256" (default) - "rsa_pkcs1_sha384" (default) - "rsa_pkcs1_sha512" (default) - "rsa_pss_sha256" (default) - "rsa_pss_sha384" (default) - "rsa_pss_sha512" (default) The default value is *rsa_pss_sha256,rsa_pss_sha384,rsa_pss_sha512,rsa_pkcs1_sha256,rsa_pkcs1_sha384,rsa_pkcs1_sha512,ecdsa_secp256r1_sha256,ecdsa_secp384r1_sha384,ecdsa_secp521r1_sha512,ed25519,ed448*. This configuration setting is applicable only when [SSLEnabledProtocols](#SSLEnabledProtocols) includes TLS 1.3. **TLS13SupportedGroups**: The supported groups for (EC)DHE key exchange.This configuration setting specifies a comma-separated list of named groups used in TLS 1.3 for key exchange. This configuration setting should be modified only if there is a specific reason to do so. The default value is *ecdhe_x25519,ecdhe_x448,ecdhe_secp256r1,ecdhe_secp384r1,ecdhe_secp521r1,ffdhe_2048,ffdhe_3072,ffdhe_4096,ffdhe_6144,ffdhe_8192,mlkem_512,mlkem_768,mlkem_1024,x25519_mlkem_768,secp256r1_mlkem_768* The values are ordered from most preferred to least preferred. The following values are supported: - "ecdhe_x25519" (default) - "ecdhe_x448" (default) - "ecdhe_secp256r1" (default) - "ecdhe_secp384r1" (default) - "ecdhe_secp521r1" (default) - "ffdhe_2048" (default) - "ffdhe_3072" (default) - "ffdhe_4096" (default) - "ffdhe_6144" (default) - "ffdhe_8192" (default) - "mlkem_512" (default) - "mlkem_768" (default) - "mlkem_1024" (default) - "x25519_mlkem_768" (default) - "secp256r1_mlkem_768" (default) Post-quantum algorithms (*mlkem_512,mlkem_768,mlkem_1024,x25519_mlkem_768,secp256r1_mlkem_768*) in our components rely on the operating system's underlying cryptographic primitives. The following platforms are currently supported: - Windows Server 2025 - Windows 11 24H2 - Windows 11 25H2 ### Socket Config Settings **AbsoluteTimeout**: Determines whether timeouts are inactivity timeouts or absolute timeouts.If [AbsoluteTimeout](#AbsoluteTimeout) is set to True, any method that does not complete within [timeout](#timeout-property-as4client-struct) seconds will be aborted. By default, *AbsoluteTimeout* is False, and the timeout is an inactivity timeout. NOTE: This option is not valid for User Datagram Protocol (UDP) ports. **FirewallData**: Used to send extra data to the firewall.When the firewall is a tunneling proxy, use this property to send custom (additional) headers to the firewall (e.g., headers for custom authentication schemes). **InBufferSize**: The size in bytes of the incoming queue of the socket.This is the size of an internal queue in the Transmission Control Protocol (TCP)/IP stack. You can increase or decrease its size depending on the amount of data that you will be receiving. In some cases, increasing the value of the *InBufferSize* setting can provide significant improvements in performance. Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the struct is activated the *InBufferSize* reverts to its defined size. The same happens if you attempt to make it too large or too small. **OutBufferSize**: The size in bytes of the outgoing queue of the socket.This is the size of an internal queue in the TCP/IP stack. You can increase or decrease its size depending on the amount of data that you will be sending. In some cases, increasing the value of the *OutBufferSize* setting can provide significant improvements in performance. Some TCP/IP implementations do not support variable buffer sizes. If that is the case, when the struct is activated the *OutBufferSize* reverts to its defined size. The same happens if you attempt to make it too large or too small. ### Base Config Settings **BuildInfo**: Information about the product's build.When queried, this setting will return a string containing information about the product's build. **CodePage**: The system code page used for Unicode to Multibyte translations.The default code page is Unicode UTF-8 (65001). The following is a list of valid code page identifiers: | | | | --- | --- | | Identifier | Name | | 037 | IBM EBCDIC - U.S./Canada | | 437 | OEM - United States | | 500 | IBM EBCDIC - International | | 708 | Arabic - ASMO 708 | | 709 | Arabic - ASMO 449+, BCON V4 | | 710 | Arabic - Transparent Arabic | | 720 | Arabic - Transparent ASMO | | 737 | OEM - Greek (formerly 437G) | | 775 | OEM - Baltic | | 850 | OEM - Multilingual Latin I | | 852 | OEM - Latin II | | 855 | OEM - Cyrillic (primarily Russian) | | 857 | OEM - Turkish | | 858 | OEM - Multilingual Latin I + Euro symbol | | 860 | OEM - Portuguese | | 861 | OEM - Icelandic | | 862 | OEM - Hebrew | | 863 | OEM - Canadian-French | | 864 | OEM - Arabic | | 865 | OEM - Nordic | | 866 | OEM - Russian | | 869 | OEM - Modern Greek | | 870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) | | 874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) | | 875 | IBM EBCDIC - Modern Greek | | 932 | ANSI/OEM - Japanese, Shift-JIS | | 936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) | | 949 | ANSI/OEM - Korean (Unified Hangul Code) | | 950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) | | 1026 | IBM EBCDIC - Turkish (Latin-5) | | 1047 | IBM EBCDIC - Latin 1/Open System | | 1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) | | 1141 | IBM EBCDIC - Germany (20273 + Euro symbol) | | 1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) | | 1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) | | 1144 | IBM EBCDIC - Italy (20280 + Euro symbol) | | 1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) | | 1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) | | 1147 | IBM EBCDIC - France (20297 + Euro symbol) | | 1148 | IBM EBCDIC - International (500 + Euro symbol) | | 1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) | | 1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) | | 1201 | Unicode UCS-2 Big-Endian | | 1250 | ANSI - Central European | | 1251 | ANSI - Cyrillic | | 1252 | ANSI - Latin I | | 1253 | ANSI - Greek | | 1254 | ANSI - Turkish | | 1255 | ANSI - Hebrew | | 1256 | ANSI - Arabic | | 1257 | ANSI - Baltic | | 1258 | ANSI/OEM - Vietnamese | | 1361 | Korean (Johab) | | 10000 | MAC - Roman | | 10001 | MAC - Japanese | | 10002 | MAC - Traditional Chinese (Big5) | | 10003 | MAC - Korean | | 10004 | MAC - Arabic | | 10005 | MAC - Hebrew | | 10006 | MAC - Greek I | | 10007 | MAC - Cyrillic | | 10008 | MAC - Simplified Chinese (GB 2312) | | 10010 | MAC - Romania | | 10017 | MAC - Ukraine | | 10021 | MAC - Thai | | 10029 | MAC - Latin II | | 10079 | MAC - Icelandic | | 10081 | MAC - Turkish | | 10082 | MAC - Croatia | | 12000 | Unicode UCS-4 Little-Endian | | 12001 | Unicode UCS-4 Big-Endian | | 20000 | CNS - Taiwan | | 20001 | TCA - Taiwan | | 20002 | Eten - Taiwan | | 20003 | IBM5550 - Taiwan | | 20004 | TeleText - Taiwan | | 20005 | Wang - Taiwan | | 20105 | IA5 IRV International Alphabet No. 5 (7-bit) | | 20106 | IA5 German (7-bit) | | 20107 | IA5 Swedish (7-bit) | | 20108 | IA5 Norwegian (7-bit) | | 20127 | US-ASCII (7-bit) | | 20261 | T.61 | | 20269 | ISO 6937 Non-Spacing Accent | | 20273 | IBM EBCDIC - Germany | | 20277 | IBM EBCDIC - Denmark/Norway | | 20278 | IBM EBCDIC - Finland/Sweden | | 20280 | IBM EBCDIC - Italy | | 20284 | IBM EBCDIC - Latin America/Spain | | 20285 | IBM EBCDIC - United Kingdom | | 20290 | IBM EBCDIC - Japanese Katakana Extended | | 20297 | IBM EBCDIC - France | | 20420 | IBM EBCDIC - Arabic | | 20423 | IBM EBCDIC - Greek | | 20424 | IBM EBCDIC - Hebrew | | 20833 | IBM EBCDIC - Korean Extended | | 20838 | IBM EBCDIC - Thai | | 20866 | Russian - KOI8-R | | 20871 | IBM EBCDIC - Icelandic | | 20880 | IBM EBCDIC - Cyrillic (Russian) | | 20905 | IBM EBCDIC - Turkish | | 20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) | | 20932 | JIS X 0208-1990 & 0121-1990 | | 20936 | Simplified Chinese (GB2312) | | 21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) | | 21027 | Extended Alpha Lowercase | | 21866 | Ukrainian (KOI8-U) | | 28591 | ISO 8859-1 Latin I | | 28592 | ISO 8859-2 Central Europe | | 28593 | ISO 8859-3 Latin 3 | | 28594 | ISO 8859-4 Baltic | | 28595 | ISO 8859-5 Cyrillic | | 28596 | ISO 8859-6 Arabic | | 28597 | ISO 8859-7 Greek | | 28598 | ISO 8859-8 Hebrew | | 28599 | ISO 8859-9 Latin 5 | | 28605 | ISO 8859-15 Latin 9 | | 29001 | Europa 3 | | 38598 | ISO 8859-8 Hebrew | | 50220 | ISO 2022 Japanese with no halfwidth Katakana | | 50221 | ISO 2022 Japanese with halfwidth Katakana | | 50222 | ISO 2022 Japanese JIS X 0201-1989 | | 50225 | ISO 2022 Korean | | 50227 | ISO 2022 Simplified Chinese | | 50229 | ISO 2022 Traditional Chinese | | 50930 | Japanese (Katakana) Extended | | 50931 | US/Canada and Japanese | | 50933 | Korean Extended and Korean | | 50935 | Simplified Chinese Extended and Simplified Chinese | | 50936 | Simplified Chinese | | 50937 | US/Canada and Traditional Chinese | | 50939 | Japanese (Latin) Extended and Japanese | | 51932 | EUC - Japanese | | 51936 | EUC - Simplified Chinese | | 51949 | EUC - Korean | | 51950 | EUC - Traditional Chinese | | 52936 | HZ-GB2312 Simplified Chinese | | 54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) | | 57002 | ISCII Devanagari | | 57003 | ISCII Bengali | | 57004 | ISCII Tamil | | 57005 | ISCII Telugu | | 57006 | ISCII Assamese | | 57007 | ISCII Oriya | | 57008 | ISCII Kannada | | 57009 | ISCII Malayalam | | 57010 | ISCII Gujarati | | 57011 | ISCII Punjabi | | 65000 | Unicode UTF-7 | | 65001 | Unicode UTF-8 | The following is a list of valid code page identifiers for Mac OS only: | | | | --- | --- | | Identifier | Name | | 1 | ASCII | | 2 | NEXTSTEP | | 3 | JapaneseEUC | | 4 | UTF8 | | 5 | ISOLatin1 | | 6 | Symbol | | 7 | NonLossyASCII | | 8 | ShiftJIS | | 9 | ISOLatin2 | | 10 | Unicode | | 11 | WindowsCP1251 | | 12 | WindowsCP1252 | | 13 | WindowsCP1253 | | 14 | WindowsCP1254 | | 15 | WindowsCP1250 | | 21 | ISO2022JP | | 30 | MacOSRoman | | 10 | UTF16String | | 0x90000100 | UTF16BigEndian | | 0x94000100 | UTF16LittleEndian | | 0x8c000100 | UTF32String | | 0x98000100 | UTF32BigEndian | | 0x9c000100 | UTF32LittleEndian | | 65536 | Proprietary | **LicenseInfo**: Information about the current license.When queried, this setting will return a string containing information about the license this instance of a 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](platforms.md) section. # Trappable Errors ([AS4Client](#struct-ipworksedias4client) Struct) ### AS4Client Errors | | | | --- | --- | | 601 | Unsupported signature algorithm. | | 705 | No response to deliver. | | 774 | Error writing to stream. | | 1201 | Invalid ebXML. | | 1204 | Invalid part href value. | | 1205 | Unknown original message when creating receipt. | | 1206 | Could not build user message. | | 1207 | MPC value is missing. | | 1210 | A required property is not set, check the message for details. | | 1211 | Invalid or missing URL. | | 1212 | Unable to send request. | | 1213 | The other party returned an error. Check the errors property for details. | | 1214 | Error processing receipt. | | 1215 | Error saving data to AsyncReceiptInfoDir. | | 1216 | Error reading data from AsyncReceiptInfoDir. | | 1217 | MPC in the response does not match the MPC in the request. | | 1218 | Duplicate message detected. | | 1219 | Invalid profile value. | | 1220 | Unsupported compression type | | 1221 | Input file not found. | | 1222 | Error compressing file. | | 1223 | Invalid LogLevel value. | | 1224 | Error setting EDI content when building message. | | 1225 | Could not find a required message part. | | 1226 | Invalid SOAP message. | | 1227 | Invalid signature. | | 1228 | Unknown XML reference. | | 1229 | Digest verification failed. | | 1230 | Could not find the required key. | | 1231 | No CipherReference of CipherValue found. | | 1232 | Only cid references are supported. | | 1233 | Error signing message. | | 1234 | Cannot find subject identifier. | | 1235 | Error creating encryption key. | | 1236 | Error decrypting part. | | 1237 | Error calculating digest. | | 1238 | The specified certificate cannot be used to decrypt this message. | | 1239 | A signature is required, but is not present. | | 1240 | Encryption is required, but the message is not encrypted. | ### HTTP Errors | | | | --- | --- | | 118 | Firewall error. The error description contains the detailed message. | | 143 | Busy executing current method. | | 151 | HTTP protocol error. The error message has the server response. | | 152 | No server specified in [url](#url-property-as4client-struct). | | 153 | Specified url_scheme is invalid. | | 155 | Range operation is not supported by server. | | 156 | Invalid cookie index (out of range). | | 301 | 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](#local_host-property-as4client-struct) at this time. A connection is in progress. | | 112 | You cannot change [MaxLineLength](#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). |