# Struct ipworksencrypt::CMS The CMS struct is used to digitally sign, encrypt, verify, and decrypt data. ## Syntax ```text ipworksencrypt::CMS ``` ## Remarks The CMS struct implements the Cryptographic Message Syntax and allow for various cryptographic operations to be performed on data including: - [sign](#sign-method-cms-struct) - [verify_signature](#verify_signature-method-cms-struct) - [encrypt](#encrypt-method-cms-struct) - [decrypt](#decrypt-method-cms-struct) - [sign_and_encrypt](#sign_and_encrypt-method-cms-struct) - [decrypt_and_verify_signature](#decrypt_and_verify_signature-method-cms-struct) The struct can generate and consume message in a variety of formats including *PEM*, *DER* (Binary), and *SMIME*. The [encryption_algorithm](#encryption_algorithm-property-cms-struct) and [signature_hash_algorithm](#signature_hash_algorithm-property-cms-struct) are fully configurable and support a variety of industry standard encryption and hash algorithms. The struct supports additional functionality such as Compression, OAEP, and PSS. The [get_recipient_info](#get_recipient_info-method-cms-struct) and [get_signer_cert_info](#get_signer_cert_info-method-cms-struct) methods as well as the [on_recipient_info](#on_recipient_info-event-cms-struct) and [on_signer_cert_info](#on_signer_cert_info-event-cms-struct) events allow for a dynamic and flexible approach to message processing. Certificate may be loaded ahead of time or as-needed from the events. ### Signing Notes [sign](#sign-method-cms-struct) digitally signs the input data with the the specified certificate(s). Certificates are specified by calling [add_certificate](#add_certificate-method-cms-struct) or setting the certificates property. [output_format](#output_format-property-cms-struct) specifies the encoding of the output message. Valid values are *PEM*, *DER*, and *SMIME*. [include_certificates](#include_certificates-property-cms-struct) specifies whether the public certificate is included in the signed message. Additional settings allow further configuration. The following properties are applicable when calling this method: - certificates (required) - [detached_signature](#detached_signature-property-cms-struct) - [enable_compression](#enable_compression-property-cms-struct) - [GenerateSignatureTimestamp](#GenerateSignatureTimestamp) - [include_certificates](#include_certificates-property-cms-struct) - [output_format](#output_format-property-cms-struct) - [signature_hash_algorithm](#signature_hash_algorithm-property-cms-struct) - [use_pss](#use_pss-property-cms-struct) **Input and Output Properties** The struct will determine the source and destination of the input and output based on which properties are set. The order in which the input properties are checked is as follows: - [input_file](#input_file-property-cms-struct) - [input_message](#input_message-property-cms-struct) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [output_file](#output_file-property-cms-struct) - [output_message](#output_message-property-cms-struct): The output data is written to this property if no other destination is specified. **Sign and Verify a message** ```csharp Cms cms = new Cms(); cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*")); cms.InputMessage = "My Data"; cms.Sign(); string signedMessage = cms.OutputMessage; cms = new Cms(); cms.InputMessage = signedMessage; cms.VerifySignature(); string plaintextMessage = cms.OutputMessage; ``` **Sign and Verify a message - DER Output Format** ```csharp Cms cms = new Cms(); cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*")); cms.InputMessage = "My Data"; cms.OutputFormat = "DER"; cms.Sign(); byte[] signedMessage = cms.OutputMessageB; //Binary output cms = new Cms(); cms.InputMessageB = signedMessage; cms.VerifySignature(); string plaintextMessage = cms.OutputMessage; ``` **Sign and Verify a message - Detached Signature** ```csharp Cms cms = new Cms(); cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*")); cms.InputMessage = "My Data"; cms.DetachedSignature = true; cms.Sign(); string signature = cms.OutputMessage; cms = new Cms(); cms.InputMessage = "My Data"; cms.DetachedSignatureData = signature; cms.DetachedSignature = true; cms.VerifySignature(); ``` **Sign and Verify a message - Multiple Signatures** ```csharp Cms cms = new Cms(); cms.InputMessage = "My Data"; cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*")); cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test2.pfx", "password2", "*")); cms.Sign(); string signedMessage = cms.OutputMessage; cms = new Cms(); cms.InputMessage = signedMessage; cms.VerifySignature(); string plaintextMessage = cms.OutputMessage; ``` **Sign and Verify a message - No Included Certificate** ```csharp Cms cms = new Cms(); cms.InputMessage = "My Data"; cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*")); cms.IncludeCertificates = CmsIncludeCertificates.icsNone; cms.Sign(); string signedMessage = cms.OutputMessage; cms = new Cms(); cms.OnSignerCertInfo += (s, e) => { Console.WriteLine(e.Issuer); Console.WriteLine(e.SerialNumber); if (e.Issuer == "CN=100") //Identify the certificate to load based on event params { //Load the correct signer certificate. cms.SignerCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test.cer", "", "*")); } }; cms.InputMessage = signedMessage; cms.VerifySignature(); string plaintextMessage = cms.OutputMessage; ``` ### Encryption Notes [encrypt](#encrypt-method-cms-struct) encrypts the input data with the the specified certificate(s). Certificates are specified by calling [add_recipient_cert](#add_recipient_cert-method-cms-struct) or setting the recipient_certs property. [output_format](#output_format-property-cms-struct) specifies the encoding of the output message. Valid values are *PEM*, *DER*, and *SMIME*. Additional settings allow further configuration. The following properties are applicable when calling this method: - recipient_certs (required) - [encryption_algorithm](#encryption_algorithm-property-cms-struct) - [output_format](#output_format-property-cms-struct) - [use_oaep](#use_oaep-property-cms-struct) **Input and Output Properties** The struct will determine the source and destination of the input and output based on which properties are set. The order in which the input properties are checked is as follows: - [input_file](#input_file-property-cms-struct) - [input_message](#input_message-property-cms-struct) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [output_file](#output_file-property-cms-struct) - [output_message](#output_message-property-cms-struct): The output data is written to this property if no other destination is specified. **Encrypt and Decrypt a message** ```csharp Cms cms = new Cms(); cms.RecipientCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test.cer", "", "*")); cms.InputMessage = "My Data"; cms.Encrypt(); string encryptedMessage = cms.OutputMessage; cms = new Cms(); cms.InputMessage = encryptedMessage; cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*")); cms.Decrypt(); string plaintextMessage = cms.OutputMessage; ``` **Encrypt and Decrypt a message - DER Output Format** ```csharp Cms cms = new Cms(); cms.RecipientCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test.cer", "", "*")); cms.InputMessage = "My Data"; cms.OutputFormat = "DER"; cms.Encrypt(); byte[] encryptedMessage = cms.OutputMessageB; //Binary output cms = new Cms(); cms.InputMessageB = encryptedMessage; cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*")); cms.Decrypt(); string plaintextMessage = cms.OutputMessage; ``` **Encrypt and Decrypt - Multiple Recipients** ```csharp Cms cms = new Cms(); cms.RecipientCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test.cer", "", "*")); cms.RecipientCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test2.cer", "", "*")); cms.InputMessage = "My Data"; cms.Encrypt(); string encryptedMessage = cms.OutputMessage; cms = new Cms(); cms.InputMessage = encryptedMessage; cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*")); cms.Decrypt(); string plaintextMessage = cms.OutputMessage; ``` **Encrypt and Decrypt - Get Recipient Info** ```csharp Cms cms = new Cms(); cms.RecipientCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test.cer", "", "*")); cms.InputMessage = "My Data"; cms.Encrypt(); string encryptedMessage = cms.OutputMessage; //If the recipient certificate is not known ahead of time the GetRecipientInfo method may be called //to find information about the certificate. cms = new Cms(); cms.InputMessage = encryptedMessage; cms.OnRecipientInfo += (s, e) => { Console.WriteLine(e.SerialNumber); Console.WriteLine(e.Issuer); if (e.Issuer == "CN=100") //Identify the certificate to load based on event params { cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*")); } }; cms.GetRecipientInfo(); cms.Decrypt(); string plaintextMessage = cms.OutputMessage; ``` ### Signature Verification Notes [verify_signature](#verify_signature-method-cms-struct) verifies the signature of the input message. In order to perform signature verification the public signer's certificate must be present or explicitly specified. In many cases the certificate itself is included in the input message and a certificate does not need to explicitly be set. If a certificate does need to be set for signature verification the certificate may be specified by calling [add_recipient_cert](#add_recipient_cert-method-cms-struct) or setting recipient_certs. When this method is called the [on_signer_cert_info](#on_signer_cert_info-event-cms-struct) event fires once for each signature on the message. This event provides details about the signer certificate, as well as the signer certificate itself (if present). The information provided via [on_signer_cert_info](#on_signer_cert_info-event-cms-struct) may be used to load an appropriate certificate for verification from within the event. If the *CertEncoded* parameter of [on_signer_cert_info](#on_signer_cert_info-event-cms-struct) is populated the certificate required for verification is already present in the message. The following property are applicable when calling this method: - [detached_signature](#detached_signature-property-cms-struct) - [detached_signature_data](#detached_signature_data-property-cms-struct) - [enable_compression](#enable_compression-property-cms-struct) - signer_certs If the input message is a detached signature, the original data that was signed must be specified in [detached_signature_data](#detached_signature_data-property-cms-struct). In addition the [detached_signature](#detached_signature-property-cms-struct) property must be set to *True* to instruct the struct to treat the input message as a detached signature. If the input message is compressed [enable_compression](#enable_compression-property-cms-struct) must be set to *True* before calling this method. **Input and Output Properties** The struct will determine the source and destination of the input and output based on which properties are set. The order in which the input properties are checked is as follows: - [input_file](#input_file-property-cms-struct) - [input_message](#input_message-property-cms-struct) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [output_file](#output_file-property-cms-struct) - [output_message](#output_message-property-cms-struct): The output data is written to this property if no other destination is specified. **Sign and Verify a message** ```csharp Cms cms = new Cms(); cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*")); cms.InputMessage = "My Data"; cms.Sign(); string signedMessage = cms.OutputMessage; cms = new Cms(); cms.InputMessage = signedMessage; cms.VerifySignature(); string plaintextMessage = cms.OutputMessage; ``` **Sign and Verify a message - DER Output Format** ```csharp Cms cms = new Cms(); cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*")); cms.InputMessage = "My Data"; cms.OutputFormat = "DER"; cms.Sign(); byte[] signedMessage = cms.OutputMessageB; //Binary output cms = new Cms(); cms.InputMessageB = signedMessage; cms.VerifySignature(); string plaintextMessage = cms.OutputMessage; ``` **Sign and Verify a message - Detached Signature** ```csharp Cms cms = new Cms(); cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*")); cms.InputMessage = "My Data"; cms.DetachedSignature = true; cms.Sign(); string signature = cms.OutputMessage; cms = new Cms(); cms.InputMessage = "My Data"; cms.DetachedSignatureData = signature; cms.DetachedSignature = true; cms.VerifySignature(); ``` **Sign and Verify a message - Multiple Signatures** ```csharp Cms cms = new Cms(); cms.InputMessage = "My Data"; cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*")); cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test2.pfx", "password2", "*")); cms.Sign(); string signedMessage = cms.OutputMessage; cms = new Cms(); cms.InputMessage = signedMessage; cms.VerifySignature(); string plaintextMessage = cms.OutputMessage; ``` **Sign and Verify a message - No Included Certificate** ```csharp Cms cms = new Cms(); cms.InputMessage = "My Data"; cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*")); cms.IncludeCertificates = CmsIncludeCertificates.icsNone; cms.Sign(); string signedMessage = cms.OutputMessage; cms = new Cms(); cms.OnSignerCertInfo += (s, e) => { Console.WriteLine(e.Issuer); Console.WriteLine(e.SerialNumber); if (e.Issuer == "CN=100") //Identify the certificate to load based on event params { //Load the correct signer certificate. cms.SignerCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test.cer", "", "*")); } }; cms.InputMessage = signedMessage; cms.VerifySignature(); string plaintextMessage = cms.OutputMessage; ``` ### Decryption Notes [decrypt](#decrypt-method-cms-struct) decrypts the input data with the specified certificate. Certificates are specified by calling [add_certificate](#add_certificate-method-cms-struct) or setting the certificates property. If the certificate used to encrypt the message is not known ahead of time [get_recipient_info](#get_recipient_info-method-cms-struct) may be called prior to calling [decrypt](#decrypt-method-cms-struct) to obtain information about the recipient (the entity the for which the message was encrypted). If [get_recipient_info](#get_recipient_info-method-cms-struct) is called, the [on_recipient_info](#on_recipient_info-event-cms-struct) event is fired with information about the recipient which may be used to load an appropriate decryption certificate. The following properties are applicable when calling this method: - certificates (Required) **Input and Output Properties** The struct will determine the source and destination of the input and output based on which properties are set. The order in which the input properties are checked is as follows: - [input_file](#input_file-property-cms-struct) - [input_message](#input_message-property-cms-struct) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [output_file](#output_file-property-cms-struct) - [output_message](#output_message-property-cms-struct): The output data is written to this property if no other destination is specified. **Encrypt and Decrypt a message** ```csharp Cms cms = new Cms(); cms.RecipientCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test.cer", "", "*")); cms.InputMessage = "My Data"; cms.Encrypt(); string encryptedMessage = cms.OutputMessage; cms = new Cms(); cms.InputMessage = encryptedMessage; cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*")); cms.Decrypt(); string plaintextMessage = cms.OutputMessage; ``` **Encrypt and Decrypt a message - DER Output Format** ```csharp Cms cms = new Cms(); cms.RecipientCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test.cer", "", "*")); cms.InputMessage = "My Data"; cms.OutputFormat = "DER"; cms.Encrypt(); byte[] encryptedMessage = cms.OutputMessageB; //Binary output cms = new Cms(); cms.InputMessageB = encryptedMessage; cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*")); cms.Decrypt(); string plaintextMessage = cms.OutputMessage; ``` **Encrypt and Decrypt - Multiple Recipients** ```csharp Cms cms = new Cms(); cms.RecipientCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test.cer", "", "*")); cms.RecipientCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test2.cer", "", "*")); cms.InputMessage = "My Data"; cms.Encrypt(); string encryptedMessage = cms.OutputMessage; cms = new Cms(); cms.InputMessage = encryptedMessage; cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*")); cms.Decrypt(); string plaintextMessage = cms.OutputMessage; ``` **Encrypt and Decrypt - Get Recipient Info** ```csharp Cms cms = new Cms(); cms.RecipientCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test.cer", "", "*")); cms.InputMessage = "My Data"; cms.Encrypt(); string encryptedMessage = cms.OutputMessage; //If the recipient certificate is not known ahead of time the GetRecipientInfo method may be called //to find information about the certificate. cms = new Cms(); cms.InputMessage = encryptedMessage; cms.OnRecipientInfo += (s, e) => { Console.WriteLine(e.SerialNumber); Console.WriteLine(e.Issuer); if (e.Issuer == "CN=100") //Identify the certificate to load based on event params { cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*")); } }; cms.GetRecipientInfo(); cms.Decrypt(); string plaintextMessage = cms.OutputMessage; ``` ### Object Lifetime The *new()* method returns a mutable reference to a struct instance. The object itself is kept in the global list maintained by IPWorksEncrypt. Due to this, the CMS struct cannot be disposed of automatically. Please, call the *dispose(&mut; self)* method of CMS 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.* | | | | --- | --- | | [cert_count](#cert_count-property-cms-struct) | The number of records in the Cert arrays. | | [cert_effective_date](#cert_effective_date-property-cms-struct) | The date on which this certificate becomes valid. | | [cert_expiration_date](#cert_expiration_date-property-cms-struct) | The date on which the certificate expires. | | [cert_extended_key_usage](#cert_extended_key_usage-property-cms-struct) | A comma-delimited list of extended key usage identifiers. | | [cert_fingerprint](#cert_fingerprint-property-cms-struct) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [cert_fingerprint_sha1](#cert_fingerprint_sha1-property-cms-struct) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [cert_fingerprint_sha256](#cert_fingerprint_sha256-property-cms-struct) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [cert_issuer](#cert_issuer-property-cms-struct) | The issuer of the certificate. | | [cert_private_key](#cert_private_key-property-cms-struct) | The private key of the certificate (if available). | | [cert_private_key_available](#cert_private_key_available-property-cms-struct) | Whether a PrivateKey is available for the selected certificate. | | [cert_private_key_container](#cert_private_key_container-property-cms-struct) | The name of the PrivateKey container for the certificate (if available). | | [cert_public_key](#cert_public_key-property-cms-struct) | The public key of the certificate. | | [cert_public_key_algorithm](#cert_public_key_algorithm-property-cms-struct) | The textual description of the certificate's public key algorithm. | | [cert_public_key_length](#cert_public_key_length-property-cms-struct) | The length of the certificate's public key (in bits). | | [cert_serial_number](#cert_serial_number-property-cms-struct) | The serial number of the certificate encoded as a string. | | [cert_signature_algorithm](#cert_signature_algorithm-property-cms-struct) | The text description of the certificate's signature algorithm. | | [cert_store](#cert_store-property-cms-struct) | The name of the certificate store for the client certificate. | | [cert_store_password](#cert_store_password-property-cms-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-cms-struct) | The type of certificate store for this certificate. | | [cert_subject_alt_names](#cert_subject_alt_names-property-cms-struct) | Comma-separated lists of alternative subject names for the certificate. | | [cert_thumbprint_md5](#cert_thumbprint_md5-property-cms-struct) | The MD5 hash of the certificate. | | [cert_thumbprint_sha1](#cert_thumbprint_sha1-property-cms-struct) | The SHA-1 hash of the certificate. | | [cert_thumbprint_sha256](#cert_thumbprint_sha256-property-cms-struct) | The SHA-256 hash of the certificate. | | [cert_usage](#cert_usage-property-cms-struct) | The text description of UsageFlags . | | [cert_usage_flags](#cert_usage_flags-property-cms-struct) | The flags that show intended use for the certificate. | | [cert_version](#cert_version-property-cms-struct) | The certificate's version number. | | [cert_subject](#cert_subject-property-cms-struct) | The subject of the certificate used for client authentication. | | [cert_encoded](#cert_encoded-property-cms-struct) | The certificate (PEM/Base64 encoded). | | [detached_signature](#detached_signature-property-cms-struct) | Specifies whether to include a detached signature when signing a message. | | [detached_signature_data](#detached_signature_data-property-cms-struct) | The detached signature. | | [enable_compression](#enable_compression-property-cms-struct) | Specifies whether to compress the message. | | [encryption_algorithm](#encryption_algorithm-property-cms-struct) | The algorithm used for encryption. | | [include_certificates](#include_certificates-property-cms-struct) | Specifies whether to include the signer's certificate with the signed message. | | [input_file](#input_file-property-cms-struct) | The file to process. | | [input_message](#input_message-property-cms-struct) | The message to process. | | [output_file](#output_file-property-cms-struct) | The output file. | | [output_format](#output_format-property-cms-struct) | Specifies the output format. | | [output_message](#output_message-property-cms-struct) | The output message after processing. | | [recipient_cert_count](#recipient_cert_count-property-cms-struct) | The number of records in the RecipientCert arrays. | | [recipient_cert_effective_date](#recipient_cert_effective_date-property-cms-struct) | The date on which this certificate becomes valid. | | [recipient_cert_expiration_date](#recipient_cert_expiration_date-property-cms-struct) | The date on which the certificate expires. | | [recipient_cert_extended_key_usage](#recipient_cert_extended_key_usage-property-cms-struct) | A comma-delimited list of extended key usage identifiers. | | [recipient_cert_fingerprint](#recipient_cert_fingerprint-property-cms-struct) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [recipient_cert_fingerprint_sha1](#recipient_cert_fingerprint_sha1-property-cms-struct) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [recipient_cert_fingerprint_sha256](#recipient_cert_fingerprint_sha256-property-cms-struct) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [recipient_cert_issuer](#recipient_cert_issuer-property-cms-struct) | The issuer of the certificate. | | [recipient_cert_private_key](#recipient_cert_private_key-property-cms-struct) | The private key of the certificate (if available). | | [recipient_cert_private_key_available](#recipient_cert_private_key_available-property-cms-struct) | Whether a PrivateKey is available for the selected certificate. | | [recipient_cert_private_key_container](#recipient_cert_private_key_container-property-cms-struct) | The name of the PrivateKey container for the certificate (if available). | | [recipient_cert_public_key](#recipient_cert_public_key-property-cms-struct) | The public key of the certificate. | | [recipient_cert_public_key_algorithm](#recipient_cert_public_key_algorithm-property-cms-struct) | The textual description of the certificate's public key algorithm. | | [recipient_cert_public_key_length](#recipient_cert_public_key_length-property-cms-struct) | The length of the certificate's public key (in bits). | | [recipient_cert_serial_number](#recipient_cert_serial_number-property-cms-struct) | The serial number of the certificate encoded as a string. | | [recipient_cert_signature_algorithm](#recipient_cert_signature_algorithm-property-cms-struct) | The text description of the certificate's signature algorithm. | | [recipient_cert_store](#recipient_cert_store-property-cms-struct) | The name of the certificate store for the client certificate. | | [recipient_cert_store_password](#recipient_cert_store_password-property-cms-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-cms-struct) | The type of certificate store for this certificate. | | [recipient_cert_subject_alt_names](#recipient_cert_subject_alt_names-property-cms-struct) | Comma-separated lists of alternative subject names for the certificate. | | [recipient_cert_thumbprint_md5](#recipient_cert_thumbprint_md5-property-cms-struct) | The MD5 hash of the certificate. | | [recipient_cert_thumbprint_sha1](#recipient_cert_thumbprint_sha1-property-cms-struct) | The SHA-1 hash of the certificate. | | [recipient_cert_thumbprint_sha256](#recipient_cert_thumbprint_sha256-property-cms-struct) | The SHA-256 hash of the certificate. | | [recipient_cert_usage](#recipient_cert_usage-property-cms-struct) | The text description of UsageFlags . | | [recipient_cert_usage_flags](#recipient_cert_usage_flags-property-cms-struct) | The flags that show intended use for the certificate. | | [recipient_cert_version](#recipient_cert_version-property-cms-struct) | The certificate's version number. | | [recipient_cert_subject](#recipient_cert_subject-property-cms-struct) | The subject of the certificate used for client authentication. | | [recipient_cert_encoded](#recipient_cert_encoded-property-cms-struct) | The certificate (PEM/Base64 encoded). | | [signature_hash_algorithm](#signature_hash_algorithm-property-cms-struct) | The signature hash algorithm used during signing. | | [signer_cert_count](#signer_cert_count-property-cms-struct) | The number of records in the SignerCert arrays. | | [signer_cert_effective_date](#signer_cert_effective_date-property-cms-struct) | The date on which this certificate becomes valid. | | [signer_cert_expiration_date](#signer_cert_expiration_date-property-cms-struct) | The date on which the certificate expires. | | [signer_cert_extended_key_usage](#signer_cert_extended_key_usage-property-cms-struct) | A comma-delimited list of extended key usage identifiers. | | [signer_cert_fingerprint](#signer_cert_fingerprint-property-cms-struct) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [signer_cert_fingerprint_sha1](#signer_cert_fingerprint_sha1-property-cms-struct) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [signer_cert_fingerprint_sha256](#signer_cert_fingerprint_sha256-property-cms-struct) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [signer_cert_issuer](#signer_cert_issuer-property-cms-struct) | The issuer of the certificate. | | [signer_cert_private_key](#signer_cert_private_key-property-cms-struct) | The private key of the certificate (if available). | | [signer_cert_private_key_available](#signer_cert_private_key_available-property-cms-struct) | Whether a PrivateKey is available for the selected certificate. | | [signer_cert_private_key_container](#signer_cert_private_key_container-property-cms-struct) | The name of the PrivateKey container for the certificate (if available). | | [signer_cert_public_key](#signer_cert_public_key-property-cms-struct) | The public key of the certificate. | | [signer_cert_public_key_algorithm](#signer_cert_public_key_algorithm-property-cms-struct) | The textual description of the certificate's public key algorithm. | | [signer_cert_public_key_length](#signer_cert_public_key_length-property-cms-struct) | The length of the certificate's public key (in bits). | | [signer_cert_serial_number](#signer_cert_serial_number-property-cms-struct) | The serial number of the certificate encoded as a string. | | [signer_cert_signature_algorithm](#signer_cert_signature_algorithm-property-cms-struct) | The text description of the certificate's signature algorithm. | | [signer_cert_store](#signer_cert_store-property-cms-struct) | The name of the certificate store for the client certificate. | | [signer_cert_store_password](#signer_cert_store_password-property-cms-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-cms-struct) | The type of certificate store for this certificate. | | [signer_cert_subject_alt_names](#signer_cert_subject_alt_names-property-cms-struct) | Comma-separated lists of alternative subject names for the certificate. | | [signer_cert_thumbprint_md5](#signer_cert_thumbprint_md5-property-cms-struct) | The MD5 hash of the certificate. | | [signer_cert_thumbprint_sha1](#signer_cert_thumbprint_sha1-property-cms-struct) | The SHA-1 hash of the certificate. | | [signer_cert_thumbprint_sha256](#signer_cert_thumbprint_sha256-property-cms-struct) | The SHA-256 hash of the certificate. | | [signer_cert_usage](#signer_cert_usage-property-cms-struct) | The text description of UsageFlags . | | [signer_cert_usage_flags](#signer_cert_usage_flags-property-cms-struct) | The flags that show intended use for the certificate. | | [signer_cert_version](#signer_cert_version-property-cms-struct) | The certificate's version number. | | [signer_cert_subject](#signer_cert_subject-property-cms-struct) | The subject of the certificate used for client authentication. | | [signer_cert_encoded](#signer_cert_encoded-property-cms-struct) | The certificate (PEM/Base64 encoded). | | [use_oaep](#use_oaep-property-cms-struct) | This property specifies whether or not to use Optimal Asymmetric Encryption Padding (OAEP). | | [use_pss](#use_pss-property-cms-struct) | Whether to use RSA-PSS during signing and verification. | ## Method List *The following is the full list of the methods of the struct with short descriptions. Click on the links for further details.* | | | | --- | --- | | [add_certificate](#add_certificate-method-cms-struct) | Used to add certificates for signing. | | [add_recipient_cert](#add_recipient_cert-method-cms-struct) | Used to add recipient certificates used to encrypt messages. | | [config](#config-method-cms-struct) | Sets or retrieves a configuration setting. | | [decrypt](#decrypt-method-cms-struct) | Decrypts the current message. | | [decrypt_and_verify_signature](#decrypt_and_verify_signature-method-cms-struct) | Decrypts and verifies the signature of the current message. | | [encrypt](#encrypt-method-cms-struct) | Encrypts the current message. | | [get_recipient_info](#get_recipient_info-method-cms-struct) | Gets the recipient certificate information for an encrypted message. | | [get_signer_cert_info](#get_signer_cert_info-method-cms-struct) | This method gets the signature information for an signed message. | | [reset](#reset-method-cms-struct) | This method resets the struct properties. | | [sign](#sign-method-cms-struct) | Signs the current message. | | [sign_and_encrypt](#sign_and_encrypt-method-cms-struct) | Signs and encrypts the current message. | | [verify_signature](#verify_signature-method-cms-struct) | Verifies the signature of the current message. | ## 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_error](#on_error-event-cms-struct) | Fired when information is available about errors during data delivery. | | [on_log](#on_log-event-cms-struct) | Fires with log information during processing. | | [on_recipient_info](#on_recipient_info-event-cms-struct) | This event is fired for each recipient certificate of the encrypted message. | | [on_signer_cert_info](#on_signer_cert_info-event-cms-struct) | Fired during verification of the signed message. | ## Config Settings *The following is a list of config settings for the struct with short descriptions. Click on the links for further details.* | | | | --- | --- | | [CompressBeforeSign](#CompressBeforeSign) | Specifies whether to compress before signing. | | [ContentTypeOID](#ContentTypeOID) | Specifies the oid for content type. | | [CSP](#CSP) | The Cryptographic Service Provider. | | [GenerateSignatureTimestamp](#GenerateSignatureTimestamp) | Whether to generate timestamps in signatures. | | [IncludeHeaders](#IncludeHeaders) | Tells the struct whether to include the headers when encoding the message. | | [IncludeInternalHeaders](#IncludeInternalHeaders) | Tells the struct whether or not to include the internal headers when encoding the message. | | [InputContentTransferEncoding](#InputContentTransferEncoding) | Sets the Content-Transfer-Encoding for the signed message. | | [InputContentType](#InputContentType) | Sets the Content-Type for the signed message. | | [InputMessageHeaders](#InputMessageHeaders) | Message headers. | | [LogDirectory](#LogDirectory) | The directory on disk where debug logs are written. | | [LogFileName](#LogFileName) | The base filename to use with LogDirectory. | | [LogLevel](#LogLevel) | The level of detail for log messages. | | [OAEPMGF1HashAlgorithm](#OAEPMGF1HashAlgorithm) | The MGF1 hash algorithm used with OAEP. | | [OAEPParams](#OAEPParams) | The hex encoded OAEP parameters. | | [OAEPRSAHashAlgorithm](#OAEPRSAHashAlgorithm) | The RSA hash algorithm used with OAEP. | | [OutputMessageHeaders](#OutputMessageHeaders) | The SMIME headers of the output message. | | [RecipientInfoType](#RecipientInfoType) | The type of signer information to include in the signed message. | | [SignatureTimestamp](#SignatureTimestamp) | The signature timestamp in the signed message. | | [SignerInfoType](#SignerInfoType) | The type of signer information to include in the signed message. | | [UseAlgorithmOIDs](#UseAlgorithmOIDs) | Whether OIDs are used when providing information about the algorithms. | | [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. | # cert_count property ([CMS](#struct-ipworksencryptcms) Struct) The number of records in the Cert arrays. ## Syntax *Rust Syntax* ```text fn cert_count(&self ) -> Result fn set_cert_count(&self, value : i32) -> Option ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [cert_effective_date](#cert_effective_date-property-cms-struct) - [cert_encoded](#cert_encoded-property-cms-struct) - [cert_expiration_date](#cert_expiration_date-property-cms-struct) - [cert_extended_key_usage](#cert_extended_key_usage-property-cms-struct) - [cert_fingerprint](#cert_fingerprint-property-cms-struct) - [cert_fingerprint_sha1](#cert_fingerprint_sha1-property-cms-struct) - [cert_fingerprint_sha256](#cert_fingerprint_sha256-property-cms-struct) - [cert_issuer](#cert_issuer-property-cms-struct) - [cert_private_key](#cert_private_key-property-cms-struct) - [cert_private_key_available](#cert_private_key_available-property-cms-struct) - [cert_private_key_container](#cert_private_key_container-property-cms-struct) - [cert_public_key](#cert_public_key-property-cms-struct) - [cert_public_key_algorithm](#cert_public_key_algorithm-property-cms-struct) - [cert_public_key_length](#cert_public_key_length-property-cms-struct) - [cert_serial_number](#cert_serial_number-property-cms-struct) - [cert_signature_algorithm](#cert_signature_algorithm-property-cms-struct) - [cert_store](#cert_store-property-cms-struct) - [cert_store_password](#cert_store_password-property-cms-struct) - [cert_store_type](#cert_store_type-property-cms-struct) - [cert_subject](#cert_subject-property-cms-struct) - [cert_subject_alt_names](#cert_subject_alt_names-property-cms-struct) - [cert_thumbprint_md5](#cert_thumbprint_md5-property-cms-struct) - [cert_thumbprint_sha1](#cert_thumbprint_sha1-property-cms-struct) - [cert_thumbprint_sha256](#cert_thumbprint_sha256-property-cms-struct) - [cert_usage](#cert_usage-property-cms-struct) - [cert_usage_flags](#cert_usage_flags-property-cms-struct) - [cert_version](#cert_version-property-cms-struct) The array indices start at *0* and end at *cert_count - 1*. ## Data Type i32 # cert_effective_date property ([CMS](#struct-ipworksencryptcms) Struct) The date on which this certificate becomes valid. ## Syntax *Rust Syntax* ```text fn cert_effective_date(&self , CertIndex : 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 *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#cert_count-property-cms-struct) property. This property is read-only. ## Data Type String # cert_expiration_date property ([CMS](#struct-ipworksencryptcms) Struct) The date on which the certificate expires. ## Syntax *Rust Syntax* ```text fn cert_expiration_date(&self , CertIndex : 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 *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#cert_count-property-cms-struct) property. This property is read-only. ## Data Type String # cert_extended_key_usage property ([CMS](#struct-ipworksencryptcms) Struct) A comma-delimited list of extended key usage identifiers. ## Syntax *Rust Syntax* ```text fn cert_extended_key_usage(&self , CertIndex : 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 *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#cert_count-property-cms-struct) property. This property is read-only. ## Data Type String # cert_fingerprint property ([CMS](#struct-ipworksencryptcms) Struct) The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax *Rust Syntax* ```text fn cert_fingerprint(&self , CertIndex : 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 *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#cert_count-property-cms-struct) property. This property is read-only. ## Data Type String # cert_fingerprint_sha1 property ([CMS](#struct-ipworksencryptcms) Struct) The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax *Rust Syntax* ```text fn cert_fingerprint_sha1(&self , CertIndex : 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 *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#cert_count-property-cms-struct) property. This property is read-only. ## Data Type String # cert_fingerprint_sha256 property ([CMS](#struct-ipworksencryptcms) Struct) The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax *Rust Syntax* ```text fn cert_fingerprint_sha256(&self , CertIndex : 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 *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#cert_count-property-cms-struct) property. This property is read-only. ## Data Type String # cert_issuer property ([CMS](#struct-ipworksencryptcms) Struct) The issuer of the certificate. ## Syntax *Rust Syntax* ```text fn cert_issuer(&self , CertIndex : 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 *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#cert_count-property-cms-struct) property. This property is read-only. ## Data Type String # cert_private_key property ([CMS](#struct-ipworksencryptcms) Struct) The private key of the certificate (if available). ## Syntax *Rust Syntax* ```text fn cert_private_key(&self , CertIndex : i32) -> 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-cms-struct) may be available but not exportable. In this case, [cert_private_key](#cert_private_key-property-cms-struct) returns an empty string. The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#cert_count-property-cms-struct) property. This property is read-only. ## Data Type String # cert_private_key_available property ([CMS](#struct-ipworksencryptcms) Struct) Whether a PrivateKey is available for the selected certificate. ## Syntax *Rust Syntax* ```text fn cert_private_key_available(&self , CertIndex : i32) -> Result ``` ## Default Value false ## Remarks Whether a [cert_private_key](#cert_private_key-property-cms-struct) is available for the selected certificate. If [cert_private_key_available](#cert_private_key_available-property-cms-struct) is True, the certificate may be used for authentication purposes (e.g., server authentication). The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#cert_count-property-cms-struct) property. This property is read-only. ## Data Type bool # cert_private_key_container property ([CMS](#struct-ipworksencryptcms) Struct) The name of the PrivateKey container for the certificate (if available). ## Syntax *Rust Syntax* ```text fn cert_private_key_container(&self , CertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The name of the [cert_private_key](#cert_private_key-property-cms-struct) container for the certificate (if available). This functionality is available only on Windows platforms. The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#cert_count-property-cms-struct) property. This property is read-only. ## Data Type String # cert_public_key property ([CMS](#struct-ipworksencryptcms) Struct) The public key of the certificate. ## Syntax *Rust Syntax* ```text fn cert_public_key(&self , CertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The public key of the certificate. The key is provided as PEM/Base64-encoded data. The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#cert_count-property-cms-struct) property. This property is read-only. ## Data Type String # cert_public_key_algorithm property ([CMS](#struct-ipworksencryptcms) Struct) The textual description of the certificate's public key algorithm. ## Syntax *Rust Syntax* ```text fn cert_public_key_algorithm(&self , CertIndex : 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 *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#cert_count-property-cms-struct) property. This property is read-only. ## Data Type String # cert_public_key_length property ([CMS](#struct-ipworksencryptcms) Struct) The length of the certificate's public key (in bits). ## Syntax *Rust Syntax* ```text fn cert_public_key_length(&self , CertIndex : i32) -> Result ``` ## Default Value 0 ## Remarks The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#cert_count-property-cms-struct) property. This property is read-only. ## Data Type i32 # cert_serial_number property ([CMS](#struct-ipworksencryptcms) Struct) The serial number of the certificate encoded as a string. ## Syntax *Rust Syntax* ```text fn cert_serial_number(&self , CertIndex : 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 *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#cert_count-property-cms-struct) property. This property is read-only. ## Data Type String # cert_signature_algorithm property ([CMS](#struct-ipworksencryptcms) Struct) The text description of the certificate's signature algorithm. ## Syntax *Rust Syntax* ```text fn cert_signature_algorithm(&self , CertIndex : 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 *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#cert_count-property-cms-struct) property. This property is read-only. ## Data Type String # cert_store property ([CMS](#struct-ipworksencryptcms) Struct) The name of the certificate store for the client certificate. ## Syntax *Rust Syntax* ```text fn cert_store(&self , CertIndex : i32) -> Result, IPWorksEncryptError> fn set_cert_store(&self, CertIndex : i32, value : Vec) -> Option fn set_cert_store_ref(&self, CertIndex : i32, 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-cms-struct) property denotes the type of the certificate store specified by [cert_store](#cert_store-property-cms-struct). If the store is password-protected, specify the password in [cert_store_password](#cert_store_password-property-cms-struct). [cert_store](#cert_store-property-cms-struct) is used in conjunction with the [cert_subject](#cert_subject-property-cms-struct) property to specify client certificates. If [cert_store](#cert_store-property-cms-struct) has a value, and [cert_subject](#cert_subject-property-cms-struct) or [cert_encoded](#cert_encoded-property-cms-struct) is set, a search for a certificate is initiated. Please see the [cert_subject](#cert_subject-property-cms-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 *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#cert_count-property-cms-struct) property. ## Data Type Vec # cert_store_password property ([CMS](#struct-ipworksencryptcms) 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 , CertIndex : i32) -> Result fn set_cert_store_password(&self, CertIndex : i32, value : &str) -> Option fn set_cert_store_password_ref(&self, CertIndex : 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 *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#cert_count-property-cms-struct) property. ## Data Type String # cert_store_type property ([CMS](#struct-ipworksencryptcms) Struct) The type of certificate store for this certificate. ## Syntax *Rust Syntax* ```text fn cert_store_type(&self , CertIndex : i32) -> Result fn set_cert_store_type(&self, CertIndex : 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 [cert_store_type](#cert_store_type-property-cms-struct), the full path of the PKCS#11 DLL as the [cert_store](#cert_store-property-cms-struct), and the PIN as the [cert_store_password](#cert_store_password-property-cms-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-cms-struct) and set [cert_store_password](#cert_store_password-property-cms-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 *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#cert_count-property-cms-struct) property. ## Data Type i32 # cert_subject_alt_names property ([CMS](#struct-ipworksencryptcms) Struct) Comma-separated lists of alternative subject names for the certificate. ## Syntax *Rust Syntax* ```text fn cert_subject_alt_names(&self , CertIndex : i32) -> Result ``` ## Default Value "" ## Remarks Comma-separated lists of alternative subject names for the certificate. The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#cert_count-property-cms-struct) property. This property is read-only. ## Data Type String # cert_thumbprint_md5 property ([CMS](#struct-ipworksencryptcms) Struct) The MD5 hash of the certificate. ## Syntax *Rust Syntax* ```text fn cert_thumbprint_md5(&self , CertIndex : 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 *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#cert_count-property-cms-struct) property. This property is read-only. ## Data Type String # cert_thumbprint_sha1 property ([CMS](#struct-ipworksencryptcms) Struct) The SHA-1 hash of the certificate. ## Syntax *Rust Syntax* ```text fn cert_thumbprint_sha1(&self , CertIndex : 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 *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#cert_count-property-cms-struct) property. This property is read-only. ## Data Type String # cert_thumbprint_sha256 property ([CMS](#struct-ipworksencryptcms) Struct) The SHA-256 hash of the certificate. ## Syntax *Rust Syntax* ```text fn cert_thumbprint_sha256(&self , CertIndex : 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 *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#cert_count-property-cms-struct) property. This property is read-only. ## Data Type String # cert_usage property ([CMS](#struct-ipworksencryptcms) Struct) The text description of UsageFlags . ## Syntax *Rust Syntax* ```text fn cert_usage(&self , CertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The text description of [cert_usage_flags](#cert_usage_flags-property-cms-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 *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#cert_count-property-cms-struct) property. This property is read-only. ## Data Type String # cert_usage_flags property ([CMS](#struct-ipworksencryptcms) Struct) The flags that show intended use for the certificate. ## Syntax *Rust Syntax* ```text fn cert_usage_flags(&self , CertIndex : i32) -> Result ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [cert_usage_flags](#cert_usage_flags-property-cms-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-cms-struct) property for a text representation of [cert_usage_flags](#cert_usage_flags-property-cms-struct). This functionality currently is not available when the provider is OpenSSL. The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#cert_count-property-cms-struct) property. This property is read-only. ## Data Type i32 # cert_version property ([CMS](#struct-ipworksencryptcms) Struct) The certificate's version number. ## Syntax *Rust Syntax* ```text fn cert_version(&self , CertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The certificate's version number. The possible values are the strings "V1", "V2", and "V3". The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#cert_count-property-cms-struct) property. This property is read-only. ## Data Type String # cert_subject property ([CMS](#struct-ipworksencryptcms) Struct) The subject of the certificate used for client authentication. ## Syntax *Rust Syntax* ```text fn cert_subject(&self , CertIndex : i32) -> Result fn set_cert_subject(&self, CertIndex : i32, value : &str) -> Option fn set_cert_subject_ref(&self, CertIndex : 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 *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#cert_count-property-cms-struct) property. ## Data Type String # cert_encoded property ([CMS](#struct-ipworksencryptcms) Struct) The certificate (PEM/Base64 encoded). ## Syntax *Rust Syntax* ```text fn cert_encoded(&self , CertIndex : i32) -> Result, IPWorksEncryptError> fn set_cert_encoded(&self, CertIndex : i32, value : Vec) -> Option fn set_cert_encoded_ref(&self, CertIndex : i32, 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-cms-struct) and [cert_subject](#cert_subject-property-cms-struct) properties also may be used to specify a certificate. When [cert_encoded](#cert_encoded-property-cms-struct) is set, a search is initiated in the current [cert_store](#cert_store-property-cms-struct) for the private key of the certificate. If the key is found, [cert_subject](#cert_subject-property-cms-struct) is updated to reflect the full subject of the selected certificate; otherwise, [cert_subject](#cert_subject-property-cms-struct) is set to an empty string. The *CertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [CertCount](#cert_count-property-cms-struct) property. ## Data Type Vec # detached_signature property ([CMS](#struct-ipworksencryptcms) Struct) Specifies whether to include a detached signature when signing a message. ## Syntax *Rust Syntax* ```text fn detached_signature(&self ) -> Result fn set_detached_signature(&self, value : bool) -> Option ``` ## Default Value false ## Remarks This property specifies whether the [sign](#sign-method-cms-struct) operation products a message that includes both a signature and the message data, or just a signature. When set to *False* default the output message holds the data and signature in one CMS message. This may be passed in its entirety to the receiving party for signature verification. When set to *True* the output message holds only a signature in the CMS message. Both the original input data and the signature in the output message produced by the [sign](#sign-method-cms-struct) operation must be passed to the receiving party for signature verification. ## Data Type bool # detached_signature_data property ([CMS](#struct-ipworksencryptcms) Struct) The detached signature. ## Syntax *Rust Syntax* ```text fn detached_signature_data(&self ) -> Result, IPWorksEncryptError> fn set_detached_signature_data(&self, value : Vec) -> Option fn set_detached_signature_data_ref(&self, value : &[u8]) -> Option ``` ## Default Value "" ## Remarks This setting is used to specify the detached signature before calling [verify_signature](#verify_signature-method-cms-struct). The message data should be specified normally and this property should be set to the detached signature data. This may be set to the PEM, DER, or SMIME encoded signature message. ## Data Type Vec # enable_compression property ([CMS](#struct-ipworksencryptcms) Struct) Specifies whether to compress the message. ## Syntax *Rust Syntax* ```text fn enable_compression(&self ) -> Result fn set_enable_compression(&self, value : bool) -> Option ``` ## Default Value false ## Remarks This property specifies whether the input data will be compressed during the signing process. If set to *True* the data will be compressed. If set to *False* (default) the data will not be compressed. When compression is enabled the input will first be signed, and then compressed. To compress the data before signing set [CompressBeforeSign](#CompressBeforeSign). ## Data Type bool # encryption_algorithm property ([CMS](#struct-ipworksencryptcms) Struct) The algorithm used for encryption. ## 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 "3DES" ## Remarks This property specifies the encryption algorithm used when [encrypt](#encrypt-method-cms-struct) is called. This may be the name of the algorithm, or the corresponding OID of the algorithm. The default value is *3DES*. Possible values are: - "3DES" - "DES" - "RC2CBC40" - "RC2CBC64" - "RC2CBC128" or "RC2" - "AESCBC128" or "AES" - "AESCBC192" - "AESCBC256" - "AESGCM128" or "AESGCM" - "AESGCM192" - "AESGCM256" ## Data Type String # include_certificates property ([CMS](#struct-ipworksencryptcms) Struct) Specifies whether to include the signer's certificate with the signed message. ## Syntax *Rust Syntax* ```text fn include_certificates(&self ) -> Result fn set_include_certificates(&self, value : i32) -> Option ``` ## Possible Values ```text 0 // None1 // SignerCerts2 // SignerCertsAndChain ``` ## Default Value 1 ## Remarks This setting specifies which certificates (if any) are included in the signed message. By default the public certificate of the certificate used to sign the message is included. This allows the receiving party to verify the signature without any additional knowledge. If this is set to *icsNone* the recipient must obtain and specify the public certificate to be used for signature verification. Possible values are: | Value | Description | | --- | --- | | 0 (icsNone) | No signer certificates are included. | | 1 (icsSignerCerts - default) | The certificates specified in certificates are included. | | 2 (icsSignerCertsAndChain) | The certificates specified in certificates and the full chain of each certificate are included. | ## Data Type i32 # input_file property ([CMS](#struct-ipworksencryptcms) Struct) The file to process. ## Syntax *Rust Syntax* ```text fn input_file(&self ) -> Result fn set_input_file(&self, value : &str) -> Option fn set_input_file_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks This property specifies the file to be processed. Set this property to the full or relative path to the file which will be processed. **Encrypt and/or Sign** When encrypting or signing this may be set to a file containing content that will be encrypted and/or signed. **Decrypt and/or Verify** When decrypting or verifying a signature this may be set to a file containing the PEM, DER, or SMIME encoded message. **Input and Output Properties** The struct will determine the source and destination of the input and output based on which properties are set. The order in which the input properties are checked is as follows: - input_file - [input_message](#input_message-property-cms-struct) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [output_file](#output_file-property-cms-struct) - [output_message](#output_message-property-cms-struct): The output data is written to this property if no other destination is specified. ## Data Type String # input_message property ([CMS](#struct-ipworksencryptcms) Struct) The message to process. ## Syntax *Rust Syntax* ```text fn input_message(&self ) -> Result, IPWorksEncryptError> fn set_input_message(&self, value : Vec) -> Option fn set_input_message_ref(&self, value : &[u8]) -> Option ``` ## Default Value "" ## Remarks This property specifies the message to be processed. **Encrypt and/or Sign** When encrypting or signing this may be set to the content that will be encrypted and/or signed. **Decrypt and/or Verify** When decrypting or verifying a signature this may be set to the PEM, DER, or SMIME encoded message. **Input and Output Properties** The struct will determine the source and destination of the input and output based on which properties are set. The order in which the input properties are checked is as follows: - [input_file](#input_file-property-cms-struct) - input_message When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [output_file](#output_file-property-cms-struct) - [output_message](#output_message-property-cms-struct): The output data is written to this property if no other destination is specified. ## Data Type Vec # output_file property ([CMS](#struct-ipworksencryptcms) Struct) The output file. ## Syntax *Rust Syntax* ```text fn output_file(&self ) -> Result fn set_output_file(&self, value : &str) -> Option fn set_output_file_ref(&self, value : &String) -> Option ``` ## Default Value "" ## Remarks This property specifies the file to which the output will be written. This may be set to an absolute or relative path. **Encrypt and/or Sign** When encrypting or signing this specifies a file where the message will be written. **Decrypt and/or Verify** When decrypting or verifying a signature this specifies a file where the decrypted/verified content will be written. **Input and Output Properties** The struct will determine the source and destination of the input and output based on which properties are set. The order in which the input properties are checked is as follows: - [input_file](#input_file-property-cms-struct) - [input_message](#input_message-property-cms-struct) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - output_file - [output_message](#output_message-property-cms-struct): The output data is written to this property if no other destination is specified. ## Data Type String # output_format property ([CMS](#struct-ipworksencryptcms) Struct) Specifies the output format. ## Syntax *Rust Syntax* ```text fn output_format(&self ) -> Result fn set_output_format(&self, value : &str) -> Option fn set_output_format_ref(&self, value : &String) -> Option ``` ## Default Value "PEM" ## Remarks This property specifies the format of the output message created when calling [sign](#sign-method-cms-struct), [encrypt](#encrypt-method-cms-struct), or [sign_and_encrypt](#sign_and_encrypt-method-cms-struct). The various formats allow for easier transport of the signed or encrypted message, as well as interoperability with other utilities. Possible values are: ```text -----BEGIN CMS----- MIAGCSqGSIb3DQEHAqCAMIACAQExDzANBglghkgBZQMEAgEFADCABgkqhkiG9w0BBwGggCSABGFD b250ZW50LVR5cGU6IHRleHQvcGxhaW47IGNoYXJzZXQ9Imlzby04ODU5LTEiDQpDb250ZW50LVRy ... mlJLPoCw5pf3Cjae56oXs29IZMcDXKersNjFGYSaG0o9k3lAcj9llLFh54Xr1ljx7K0VpVvlrmgu kNHAf7cUvvilW/KrDa+T2n+sOFAAAAAAAAA= -----END CMS----- ``` ```text MIME-Version: 1.0 Content-Type: application/pkcs7-mime; smime-type=signed-data; name="smime.p7m" Content-Transfer-Encoding: base64 Content-Disposition: attachment; filename="smime.p7m" MIAGCSqGSIb3DQEHAqCAMIACAQExDzANBglghkgBZQMEAgEFADCABgkqhkiG9w0BBwGggCSABGFD b250ZW50LVR5cGU6IHRleHQvcGxhaW47IGNoYXJzZXQ9Imlzby04ODU5LTEiDQpDb250ZW50LVRy ... Mpc/PtPNeHA3CCFGRFnHju/yb9CsQWpgf8TTWytjP7O1hFUecW0yiuGSDeeNlQ4ZcX0TOm6haRMT lqYIrHUNMn4tYaREevNBL9CQB8MAAAAAAAA= ``` | Value | Description | | --- | --- | | PEM (default) | A PEM formatted message. For instance: | | DER | The message is binary (raw bytes). | | SMIME | The message is S/MIME encoded. For instance: | ## Data Type String # output_message property ([CMS](#struct-ipworksencryptcms) Struct) The output message after processing. ## Syntax *Rust Syntax* ```text fn output_message(&self ) -> Result, IPWorksEncryptError> ``` ## Default Value "" ## Remarks This property will be populated with the output of the operation if [output_file](#output_file-property-cms-struct) is not set. **Encrypt and/or Sign** When encrypting or signing this will hold the fully encoded message. **Decrypt and/or Verify** When decrypting or verifying a signature this will hold the decrypted/verified content. **Input and Output Properties** The struct will determine the source and destination of the input and output based on which properties are set. The order in which the input properties are checked is as follows: - [input_file](#input_file-property-cms-struct) - [input_message](#input_message-property-cms-struct) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [output_file](#output_file-property-cms-struct) - output_message: The output data is written to this property if no other destination is specified. This property is read-only. ## Data Type Vec # recipient_cert_count property ([CMS](#struct-ipworksencryptcms) 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-cms-struct) - [recipient_cert_encoded](#recipient_cert_encoded-property-cms-struct) - [recipient_cert_expiration_date](#recipient_cert_expiration_date-property-cms-struct) - [recipient_cert_extended_key_usage](#recipient_cert_extended_key_usage-property-cms-struct) - [recipient_cert_fingerprint](#recipient_cert_fingerprint-property-cms-struct) - [recipient_cert_fingerprint_sha1](#recipient_cert_fingerprint_sha1-property-cms-struct) - [recipient_cert_fingerprint_sha256](#recipient_cert_fingerprint_sha256-property-cms-struct) - [recipient_cert_issuer](#recipient_cert_issuer-property-cms-struct) - [recipient_cert_private_key](#recipient_cert_private_key-property-cms-struct) - [recipient_cert_private_key_available](#recipient_cert_private_key_available-property-cms-struct) - [recipient_cert_private_key_container](#recipient_cert_private_key_container-property-cms-struct) - [recipient_cert_public_key](#recipient_cert_public_key-property-cms-struct) - [recipient_cert_public_key_algorithm](#recipient_cert_public_key_algorithm-property-cms-struct) - [recipient_cert_public_key_length](#recipient_cert_public_key_length-property-cms-struct) - [recipient_cert_serial_number](#recipient_cert_serial_number-property-cms-struct) - [recipient_cert_signature_algorithm](#recipient_cert_signature_algorithm-property-cms-struct) - [recipient_cert_store](#recipient_cert_store-property-cms-struct) - [recipient_cert_store_password](#recipient_cert_store_password-property-cms-struct) - [recipient_cert_store_type](#recipient_cert_store_type-property-cms-struct) - [recipient_cert_subject](#recipient_cert_subject-property-cms-struct) - [recipient_cert_subject_alt_names](#recipient_cert_subject_alt_names-property-cms-struct) - [recipient_cert_thumbprint_md5](#recipient_cert_thumbprint_md5-property-cms-struct) - [recipient_cert_thumbprint_sha1](#recipient_cert_thumbprint_sha1-property-cms-struct) - [recipient_cert_thumbprint_sha256](#recipient_cert_thumbprint_sha256-property-cms-struct) - [recipient_cert_usage](#recipient_cert_usage-property-cms-struct) - [recipient_cert_usage_flags](#recipient_cert_usage_flags-property-cms-struct) - [recipient_cert_version](#recipient_cert_version-property-cms-struct) The array indices start at *0* and end at *recipient_cert_count - 1*. ## Data Type i32 # recipient_cert_effective_date property ([CMS](#struct-ipworksencryptcms) 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-cms-struct) property. This property is read-only. ## Data Type String # recipient_cert_expiration_date property ([CMS](#struct-ipworksencryptcms) 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-cms-struct) property. This property is read-only. ## Data Type String # recipient_cert_extended_key_usage property ([CMS](#struct-ipworksencryptcms) 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-cms-struct) property. This property is read-only. ## Data Type String # recipient_cert_fingerprint property ([CMS](#struct-ipworksencryptcms) 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-cms-struct) property. This property is read-only. ## Data Type String # recipient_cert_fingerprint_sha1 property ([CMS](#struct-ipworksencryptcms) 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-cms-struct) property. This property is read-only. ## Data Type String # recipient_cert_fingerprint_sha256 property ([CMS](#struct-ipworksencryptcms) 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-cms-struct) property. This property is read-only. ## Data Type String # recipient_cert_issuer property ([CMS](#struct-ipworksencryptcms) 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-cms-struct) property. This property is read-only. ## Data Type String # recipient_cert_private_key property ([CMS](#struct-ipworksencryptcms) 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-cms-struct) may be available but not exportable. In this case, [recipient_cert_private_key](#recipient_cert_private_key-property-cms-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-cms-struct) property. This property is read-only. ## Data Type String # recipient_cert_private_key_available property ([CMS](#struct-ipworksencryptcms) 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-cms-struct) is available for the selected certificate. If [recipient_cert_private_key_available](#recipient_cert_private_key_available-property-cms-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-cms-struct) property. This property is read-only. ## Data Type bool # recipient_cert_private_key_container property ([CMS](#struct-ipworksencryptcms) 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-cms-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-cms-struct) property. This property is read-only. ## Data Type String # recipient_cert_public_key property ([CMS](#struct-ipworksencryptcms) 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-cms-struct) property. This property is read-only. ## Data Type String # recipient_cert_public_key_algorithm property ([CMS](#struct-ipworksencryptcms) 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-cms-struct) property. This property is read-only. ## Data Type String # recipient_cert_public_key_length property ([CMS](#struct-ipworksencryptcms) 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-cms-struct) property. This property is read-only. ## Data Type i32 # recipient_cert_serial_number property ([CMS](#struct-ipworksencryptcms) 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-cms-struct) property. This property is read-only. ## Data Type String # recipient_cert_signature_algorithm property ([CMS](#struct-ipworksencryptcms) 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-cms-struct) property. This property is read-only. ## Data Type String # recipient_cert_store property ([CMS](#struct-ipworksencryptcms) Struct) The name of the certificate store for the client certificate. ## Syntax *Rust Syntax* ```text fn recipient_cert_store(&self , RecipientCertIndex : i32) -> Result, IPWorksEncryptError> 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-cms-struct) property denotes the type of the certificate store specified by [recipient_cert_store](#recipient_cert_store-property-cms-struct). If the store is password-protected, specify the password in [recipient_cert_store_password](#recipient_cert_store_password-property-cms-struct). [recipient_cert_store](#recipient_cert_store-property-cms-struct) is used in conjunction with the [recipient_cert_subject](#recipient_cert_subject-property-cms-struct) property to specify client certificates. If [recipient_cert_store](#recipient_cert_store-property-cms-struct) has a value, and [recipient_cert_subject](#recipient_cert_subject-property-cms-struct) or [recipient_cert_encoded](#recipient_cert_encoded-property-cms-struct) is set, a search for a certificate is initiated. Please see the [recipient_cert_subject](#recipient_cert_subject-property-cms-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-cms-struct) property. ## Data Type Vec # recipient_cert_store_password property ([CMS](#struct-ipworksencryptcms) 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-cms-struct) property. ## Data Type String # recipient_cert_store_type property ([CMS](#struct-ipworksencryptcms) 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-cms-struct), the full path of the PKCS#11 DLL as the [recipient_cert_store](#recipient_cert_store-property-cms-struct), and the PIN as the [recipient_cert_store_password](#recipient_cert_store_password-property-cms-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-cms-struct) and set [recipient_cert_store_password](#recipient_cert_store_password-property-cms-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-cms-struct) property. ## Data Type i32 # recipient_cert_subject_alt_names property ([CMS](#struct-ipworksencryptcms) 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-cms-struct) property. This property is read-only. ## Data Type String # recipient_cert_thumbprint_md5 property ([CMS](#struct-ipworksencryptcms) 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-cms-struct) property. This property is read-only. ## Data Type String # recipient_cert_thumbprint_sha1 property ([CMS](#struct-ipworksencryptcms) 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-cms-struct) property. This property is read-only. ## Data Type String # recipient_cert_thumbprint_sha256 property ([CMS](#struct-ipworksencryptcms) 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-cms-struct) property. This property is read-only. ## Data Type String # recipient_cert_usage property ([CMS](#struct-ipworksencryptcms) 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-cms-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-cms-struct) property. This property is read-only. ## Data Type String # recipient_cert_usage_flags property ([CMS](#struct-ipworksencryptcms) 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-cms-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-cms-struct) property for a text representation of [recipient_cert_usage_flags](#recipient_cert_usage_flags-property-cms-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-cms-struct) property. This property is read-only. ## Data Type i32 # recipient_cert_version property ([CMS](#struct-ipworksencryptcms) 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-cms-struct) property. This property is read-only. ## Data Type String # recipient_cert_subject property ([CMS](#struct-ipworksencryptcms) 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-cms-struct) property. ## Data Type String # recipient_cert_encoded property ([CMS](#struct-ipworksencryptcms) Struct) The certificate (PEM/Base64 encoded). ## Syntax *Rust Syntax* ```text fn recipient_cert_encoded(&self , RecipientCertIndex : i32) -> Result, IPWorksEncryptError> 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-cms-struct) and [recipient_cert_subject](#recipient_cert_subject-property-cms-struct) properties also may be used to specify a certificate. When [recipient_cert_encoded](#recipient_cert_encoded-property-cms-struct) is set, a search is initiated in the current [recipient_cert_store](#recipient_cert_store-property-cms-struct) for the private key of the certificate. If the key is found, [recipient_cert_subject](#recipient_cert_subject-property-cms-struct) is updated to reflect the full subject of the selected certificate; otherwise, [recipient_cert_subject](#recipient_cert_subject-property-cms-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-cms-struct) property. ## Data Type Vec # signature_hash_algorithm property ([CMS](#struct-ipworksencryptcms) Struct) The signature hash algorithm used during signing. ## Syntax *Rust Syntax* ```text fn signature_hash_algorithm(&self ) -> Result fn set_signature_hash_algorithm(&self, value : &str) -> Option fn set_signature_hash_algorithm_ref(&self, value : &String) -> Option ``` ## Default Value "SHA256" ## Remarks This property specifies the signature hash algorithm used when [sign](#sign-method-cms-struct) is called. When [sign](#sign-method-cms-struct) is called the input data is first hashed with the algorithm specified by this property to produce a message digest. The computed digest is then digitally signed with the certificates specified in certificates. The value specified here may be the name of the algorithm or the corresponding OID. Possible values are: - "SHA-256" (default) - "SHA-384" - "SHA-512" - "SHA-224" - "SHA1" - "MD5" ## Data Type String # signer_cert_count property ([CMS](#struct-ipworksencryptcms) Struct) The number of records in the SignerCert arrays. ## Syntax *Rust Syntax* ```text fn signer_cert_count(&self ) -> Result fn set_signer_cert_count(&self, value : i32) -> Option ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [signer_cert_effective_date](#signer_cert_effective_date-property-cms-struct) - [signer_cert_encoded](#signer_cert_encoded-property-cms-struct) - [signer_cert_expiration_date](#signer_cert_expiration_date-property-cms-struct) - [signer_cert_extended_key_usage](#signer_cert_extended_key_usage-property-cms-struct) - [signer_cert_fingerprint](#signer_cert_fingerprint-property-cms-struct) - [signer_cert_fingerprint_sha1](#signer_cert_fingerprint_sha1-property-cms-struct) - [signer_cert_fingerprint_sha256](#signer_cert_fingerprint_sha256-property-cms-struct) - [signer_cert_issuer](#signer_cert_issuer-property-cms-struct) - [signer_cert_private_key](#signer_cert_private_key-property-cms-struct) - [signer_cert_private_key_available](#signer_cert_private_key_available-property-cms-struct) - [signer_cert_private_key_container](#signer_cert_private_key_container-property-cms-struct) - [signer_cert_public_key](#signer_cert_public_key-property-cms-struct) - [signer_cert_public_key_algorithm](#signer_cert_public_key_algorithm-property-cms-struct) - [signer_cert_public_key_length](#signer_cert_public_key_length-property-cms-struct) - [signer_cert_serial_number](#signer_cert_serial_number-property-cms-struct) - [signer_cert_signature_algorithm](#signer_cert_signature_algorithm-property-cms-struct) - [signer_cert_store](#signer_cert_store-property-cms-struct) - [signer_cert_store_password](#signer_cert_store_password-property-cms-struct) - [signer_cert_store_type](#signer_cert_store_type-property-cms-struct) - [signer_cert_subject](#signer_cert_subject-property-cms-struct) - [signer_cert_subject_alt_names](#signer_cert_subject_alt_names-property-cms-struct) - [signer_cert_thumbprint_md5](#signer_cert_thumbprint_md5-property-cms-struct) - [signer_cert_thumbprint_sha1](#signer_cert_thumbprint_sha1-property-cms-struct) - [signer_cert_thumbprint_sha256](#signer_cert_thumbprint_sha256-property-cms-struct) - [signer_cert_usage](#signer_cert_usage-property-cms-struct) - [signer_cert_usage_flags](#signer_cert_usage_flags-property-cms-struct) - [signer_cert_version](#signer_cert_version-property-cms-struct) The array indices start at *0* and end at *signer_cert_count - 1*. ## Data Type i32 # signer_cert_effective_date property ([CMS](#struct-ipworksencryptcms) Struct) The date on which this certificate becomes valid. ## Syntax *Rust Syntax* ```text fn signer_cert_effective_date(&self , SignerCertIndex : 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 *SignerCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertCount](#signer_cert_count-property-cms-struct) property. This property is read-only. ## Data Type String # signer_cert_expiration_date property ([CMS](#struct-ipworksencryptcms) Struct) The date on which the certificate expires. ## Syntax *Rust Syntax* ```text fn signer_cert_expiration_date(&self , SignerCertIndex : 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 *SignerCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertCount](#signer_cert_count-property-cms-struct) property. This property is read-only. ## Data Type String # signer_cert_extended_key_usage property ([CMS](#struct-ipworksencryptcms) Struct) A comma-delimited list of extended key usage identifiers. ## Syntax *Rust Syntax* ```text fn signer_cert_extended_key_usage(&self , SignerCertIndex : 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 *SignerCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertCount](#signer_cert_count-property-cms-struct) property. This property is read-only. ## Data Type String # signer_cert_fingerprint property ([CMS](#struct-ipworksencryptcms) Struct) The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax *Rust Syntax* ```text fn signer_cert_fingerprint(&self , SignerCertIndex : 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 *SignerCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertCount](#signer_cert_count-property-cms-struct) property. This property is read-only. ## Data Type String # signer_cert_fingerprint_sha1 property ([CMS](#struct-ipworksencryptcms) Struct) The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax *Rust Syntax* ```text fn signer_cert_fingerprint_sha1(&self , SignerCertIndex : 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 *SignerCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertCount](#signer_cert_count-property-cms-struct) property. This property is read-only. ## Data Type String # signer_cert_fingerprint_sha256 property ([CMS](#struct-ipworksencryptcms) Struct) The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax *Rust Syntax* ```text fn signer_cert_fingerprint_sha256(&self , SignerCertIndex : 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 *SignerCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertCount](#signer_cert_count-property-cms-struct) property. This property is read-only. ## Data Type String # signer_cert_issuer property ([CMS](#struct-ipworksencryptcms) Struct) The issuer of the certificate. ## Syntax *Rust Syntax* ```text fn signer_cert_issuer(&self , SignerCertIndex : 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 *SignerCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertCount](#signer_cert_count-property-cms-struct) property. This property is read-only. ## Data Type String # signer_cert_private_key property ([CMS](#struct-ipworksencryptcms) Struct) The private key of the certificate (if available). ## Syntax *Rust Syntax* ```text fn signer_cert_private_key(&self , SignerCertIndex : i32) -> 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-cms-struct) may be available but not exportable. In this case, [signer_cert_private_key](#signer_cert_private_key-property-cms-struct) returns an empty string. The *SignerCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertCount](#signer_cert_count-property-cms-struct) property. This property is read-only. ## Data Type String # signer_cert_private_key_available property ([CMS](#struct-ipworksencryptcms) Struct) Whether a PrivateKey is available for the selected certificate. ## Syntax *Rust Syntax* ```text fn signer_cert_private_key_available(&self , SignerCertIndex : i32) -> Result ``` ## Default Value false ## Remarks Whether a [signer_cert_private_key](#signer_cert_private_key-property-cms-struct) is available for the selected certificate. If [signer_cert_private_key_available](#signer_cert_private_key_available-property-cms-struct) is True, the certificate may be used for authentication purposes (e.g., server authentication). The *SignerCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertCount](#signer_cert_count-property-cms-struct) property. This property is read-only. ## Data Type bool # signer_cert_private_key_container property ([CMS](#struct-ipworksencryptcms) Struct) The name of the PrivateKey container for the certificate (if available). ## Syntax *Rust Syntax* ```text fn signer_cert_private_key_container(&self , SignerCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The name of the [signer_cert_private_key](#signer_cert_private_key-property-cms-struct) container for the certificate (if available). This functionality is available only on Windows platforms. The *SignerCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertCount](#signer_cert_count-property-cms-struct) property. This property is read-only. ## Data Type String # signer_cert_public_key property ([CMS](#struct-ipworksencryptcms) Struct) The public key of the certificate. ## Syntax *Rust Syntax* ```text fn signer_cert_public_key(&self , SignerCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The public key of the certificate. The key is provided as PEM/Base64-encoded data. The *SignerCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertCount](#signer_cert_count-property-cms-struct) property. This property is read-only. ## Data Type String # signer_cert_public_key_algorithm property ([CMS](#struct-ipworksencryptcms) Struct) The textual description of the certificate's public key algorithm. ## Syntax *Rust Syntax* ```text fn signer_cert_public_key_algorithm(&self , SignerCertIndex : 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 *SignerCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertCount](#signer_cert_count-property-cms-struct) property. This property is read-only. ## Data Type String # signer_cert_public_key_length property ([CMS](#struct-ipworksencryptcms) Struct) The length of the certificate's public key (in bits). ## Syntax *Rust Syntax* ```text fn signer_cert_public_key_length(&self , SignerCertIndex : i32) -> Result ``` ## Default Value 0 ## Remarks The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. The *SignerCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertCount](#signer_cert_count-property-cms-struct) property. This property is read-only. ## Data Type i32 # signer_cert_serial_number property ([CMS](#struct-ipworksencryptcms) Struct) The serial number of the certificate encoded as a string. ## Syntax *Rust Syntax* ```text fn signer_cert_serial_number(&self , SignerCertIndex : 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 *SignerCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertCount](#signer_cert_count-property-cms-struct) property. This property is read-only. ## Data Type String # signer_cert_signature_algorithm property ([CMS](#struct-ipworksencryptcms) Struct) The text description of the certificate's signature algorithm. ## Syntax *Rust Syntax* ```text fn signer_cert_signature_algorithm(&self , SignerCertIndex : 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 *SignerCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertCount](#signer_cert_count-property-cms-struct) property. This property is read-only. ## Data Type String # signer_cert_store property ([CMS](#struct-ipworksencryptcms) Struct) The name of the certificate store for the client certificate. ## Syntax *Rust Syntax* ```text fn signer_cert_store(&self , SignerCertIndex : i32) -> Result, IPWorksEncryptError> fn set_signer_cert_store(&self, SignerCertIndex : i32, value : Vec) -> Option fn set_signer_cert_store_ref(&self, SignerCertIndex : i32, 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-cms-struct) property denotes the type of the certificate store specified by [signer_cert_store](#signer_cert_store-property-cms-struct). If the store is password-protected, specify the password in [signer_cert_store_password](#signer_cert_store_password-property-cms-struct). [signer_cert_store](#signer_cert_store-property-cms-struct) is used in conjunction with the [signer_cert_subject](#signer_cert_subject-property-cms-struct) property to specify client certificates. If [signer_cert_store](#signer_cert_store-property-cms-struct) has a value, and [signer_cert_subject](#signer_cert_subject-property-cms-struct) or [signer_cert_encoded](#signer_cert_encoded-property-cms-struct) is set, a search for a certificate is initiated. Please see the [signer_cert_subject](#signer_cert_subject-property-cms-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 *SignerCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertCount](#signer_cert_count-property-cms-struct) property. ## Data Type Vec # signer_cert_store_password property ([CMS](#struct-ipworksencryptcms) 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 , SignerCertIndex : i32) -> Result fn set_signer_cert_store_password(&self, SignerCertIndex : i32, value : &str) -> Option fn set_signer_cert_store_password_ref(&self, SignerCertIndex : 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 *SignerCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertCount](#signer_cert_count-property-cms-struct) property. ## Data Type String # signer_cert_store_type property ([CMS](#struct-ipworksencryptcms) Struct) The type of certificate store for this certificate. ## Syntax *Rust Syntax* ```text fn signer_cert_store_type(&self , SignerCertIndex : i32) -> Result fn set_signer_cert_store_type(&self, SignerCertIndex : 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 [signer_cert_store_type](#signer_cert_store_type-property-cms-struct), the full path of the PKCS#11 DLL as the [signer_cert_store](#signer_cert_store-property-cms-struct), and the PIN as the [signer_cert_store_password](#signer_cert_store_password-property-cms-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-cms-struct) and set [signer_cert_store_password](#signer_cert_store_password-property-cms-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 *SignerCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertCount](#signer_cert_count-property-cms-struct) property. ## Data Type i32 # signer_cert_subject_alt_names property ([CMS](#struct-ipworksencryptcms) Struct) Comma-separated lists of alternative subject names for the certificate. ## Syntax *Rust Syntax* ```text fn signer_cert_subject_alt_names(&self , SignerCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks Comma-separated lists of alternative subject names for the certificate. The *SignerCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertCount](#signer_cert_count-property-cms-struct) property. This property is read-only. ## Data Type String # signer_cert_thumbprint_md5 property ([CMS](#struct-ipworksencryptcms) Struct) The MD5 hash of the certificate. ## Syntax *Rust Syntax* ```text fn signer_cert_thumbprint_md5(&self , SignerCertIndex : 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 *SignerCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertCount](#signer_cert_count-property-cms-struct) property. This property is read-only. ## Data Type String # signer_cert_thumbprint_sha1 property ([CMS](#struct-ipworksencryptcms) Struct) The SHA-1 hash of the certificate. ## Syntax *Rust Syntax* ```text fn signer_cert_thumbprint_sha1(&self , SignerCertIndex : 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 *SignerCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertCount](#signer_cert_count-property-cms-struct) property. This property is read-only. ## Data Type String # signer_cert_thumbprint_sha256 property ([CMS](#struct-ipworksencryptcms) Struct) The SHA-256 hash of the certificate. ## Syntax *Rust Syntax* ```text fn signer_cert_thumbprint_sha256(&self , SignerCertIndex : 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 *SignerCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertCount](#signer_cert_count-property-cms-struct) property. This property is read-only. ## Data Type String # signer_cert_usage property ([CMS](#struct-ipworksencryptcms) Struct) The text description of UsageFlags . ## Syntax *Rust Syntax* ```text fn signer_cert_usage(&self , SignerCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The text description of [signer_cert_usage_flags](#signer_cert_usage_flags-property-cms-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 *SignerCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertCount](#signer_cert_count-property-cms-struct) property. This property is read-only. ## Data Type String # signer_cert_usage_flags property ([CMS](#struct-ipworksencryptcms) Struct) The flags that show intended use for the certificate. ## Syntax *Rust Syntax* ```text fn signer_cert_usage_flags(&self , SignerCertIndex : i32) -> 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-cms-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-cms-struct) property for a text representation of [signer_cert_usage_flags](#signer_cert_usage_flags-property-cms-struct). This functionality currently is not available when the provider is OpenSSL. The *SignerCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertCount](#signer_cert_count-property-cms-struct) property. This property is read-only. ## Data Type i32 # signer_cert_version property ([CMS](#struct-ipworksencryptcms) Struct) The certificate's version number. ## Syntax *Rust Syntax* ```text fn signer_cert_version(&self , SignerCertIndex : i32) -> Result ``` ## Default Value "" ## Remarks The certificate's version number. The possible values are the strings "V1", "V2", and "V3". The *SignerCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertCount](#signer_cert_count-property-cms-struct) property. This property is read-only. ## Data Type String # signer_cert_subject property ([CMS](#struct-ipworksencryptcms) Struct) The subject of the certificate used for client authentication. ## Syntax *Rust Syntax* ```text fn signer_cert_subject(&self , SignerCertIndex : i32) -> Result fn set_signer_cert_subject(&self, SignerCertIndex : i32, value : &str) -> Option fn set_signer_cert_subject_ref(&self, SignerCertIndex : 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 *SignerCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertCount](#signer_cert_count-property-cms-struct) property. ## Data Type String # signer_cert_encoded property ([CMS](#struct-ipworksencryptcms) Struct) The certificate (PEM/Base64 encoded). ## Syntax *Rust Syntax* ```text fn signer_cert_encoded(&self , SignerCertIndex : i32) -> Result, IPWorksEncryptError> fn set_signer_cert_encoded(&self, SignerCertIndex : i32, value : Vec) -> Option fn set_signer_cert_encoded_ref(&self, SignerCertIndex : i32, 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-cms-struct) and [signer_cert_subject](#signer_cert_subject-property-cms-struct) properties also may be used to specify a certificate. When [signer_cert_encoded](#signer_cert_encoded-property-cms-struct) is set, a search is initiated in the current [signer_cert_store](#signer_cert_store-property-cms-struct) for the private key of the certificate. If the key is found, [signer_cert_subject](#signer_cert_subject-property-cms-struct) is updated to reflect the full subject of the selected certificate; otherwise, [signer_cert_subject](#signer_cert_subject-property-cms-struct) is set to an empty string. The *SignerCertIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertCount](#signer_cert_count-property-cms-struct) property. ## Data Type Vec # use_oaep property ([CMS](#struct-ipworksencryptcms) Struct) This property specifies whether or not to use Optimal Asymmetric Encryption Padding (OAEP). ## Syntax *Rust Syntax* ```text fn use_oaep(&self ) -> Result fn set_use_oaep(&self, value : bool) -> Option ``` ## Default Value false ## Remarks This property specifies whether or not to use Optimal Asymmetric Encryption Padding (OAEP). By default, this value is False and the struct will use PKCS1. To specify nondefault OAEP options, please see [OAEPRSAHashAlgorithm](#OAEPRSAHashAlgorithm), [OAEPMGF1HashAlgorithm](#OAEPMGF1HashAlgorithm), and [OAEPParams](#OAEPParams) ## Data Type bool # use_pss property ([CMS](#struct-ipworksencryptcms) Struct) Whether to use RSA-PSS during signing and verification. ## Syntax *Rust Syntax* ```text fn use_pss(&self ) -> Result fn set_use_pss(&self, value : bool) -> Option ``` ## Default Value false ## Remarks This property specifies whether RSA-PSS will be used when signing and verifying messages. The default value is False. ## Data Type bool # add_certificate method ([CMS](#struct-ipworksencryptcms) Struct) Used to add certificates for signing. ## Syntax *Rust Syntax* ```text fn add_certificate(&self, cert_store_type : i32, cert_store : &str, cert_store_password : &str, cert_subject : &str) -> Result<(), IPWorksEncryptError> ``` ## Remarks This method adds a signing certificate. Signing certificates may be added using this method or by adding a certificate directly to certificates. The added certificate(s) will be used to sign the message when [sign](#sign-method-cms-struct) is called. *CertStoreType* specifies the type of certificate store. 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 object and pass cstPKCS11 as the [](#f_StoreType), the full path of the PKCS#11 DLL as the [](#f_Store), and the PIN as the [](#f_StorePassword). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](CertMgr.md#CertMgr) struct by calling the [list_store_certificates](CertMgr.md#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [on_cert_list](CertMgr.md#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 [](#f_Store) and set [](#f_StorePassword) 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. | *CertStore* specifies the path to the certificate file. If the CertStoreType is a blob, this specifies the certificate content. See certificates for details. *CertStorePassword* is the password for the certificate (if any). *CertSubject* specified the subject of the certificate to load. 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. # add_recipient_cert method ([CMS](#struct-ipworksencryptcms) Struct) Used to add recipient certificates used to encrypt messages. ## Syntax *Rust Syntax* ```text fn add_recipient_cert(&self, cert_encoded : &[u8]) -> Result<(), IPWorksEncryptError> ``` ## Remarks This method adds a public certificate used when [encrypt](#encrypt-method-cms-struct) is called. Public certificates of recipients may be added using this method or by adding a certificate directly to the recipient_certs property. *CertEncoded* must contain the PEM or Base64 encoded public certificate. # config method ([CMS](#struct-ipworksencryptcms) 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-cms-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-cms-struct), you must call *Config("PROPERTY")*. The value will be returned as a string. # decrypt method ([CMS](#struct-ipworksencryptcms) Struct) Decrypts the current message. ## Syntax *Rust Syntax* ```text fn decrypt(&self) -> Result<(), IPWorksEncryptError> ``` ## Remarks decrypt decrypts the input data with the specified certificate. Certificates are specified by calling [add_certificate](#add_certificate-method-cms-struct) or setting the certificates property. If the certificate used to encrypt the message is not known ahead of time [get_recipient_info](#get_recipient_info-method-cms-struct) may be called prior to calling decrypt to obtain information about the recipient (the entity the for which the message was encrypted). If [get_recipient_info](#get_recipient_info-method-cms-struct) is called, the [on_recipient_info](#on_recipient_info-event-cms-struct) event is fired with information about the recipient which may be used to load an appropriate decryption certificate. The following properties are applicable when calling this method: - certificates (Required) **Input and Output Properties** The struct will determine the source and destination of the input and output based on which properties are set. The order in which the input properties are checked is as follows: - [input_file](#input_file-property-cms-struct) - [input_message](#input_message-property-cms-struct) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [output_file](#output_file-property-cms-struct) - [output_message](#output_message-property-cms-struct): The output data is written to this property if no other destination is specified. **Encrypt and Decrypt a message** ```csharp Cms cms = new Cms(); cms.RecipientCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test.cer", "", "*")); cms.InputMessage = "My Data"; cms.Encrypt(); string encryptedMessage = cms.OutputMessage; cms = new Cms(); cms.InputMessage = encryptedMessage; cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*")); cms.Decrypt(); string plaintextMessage = cms.OutputMessage; ``` **Encrypt and Decrypt a message - DER Output Format** ```csharp Cms cms = new Cms(); cms.RecipientCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test.cer", "", "*")); cms.InputMessage = "My Data"; cms.OutputFormat = "DER"; cms.Encrypt(); byte[] encryptedMessage = cms.OutputMessageB; //Binary output cms = new Cms(); cms.InputMessageB = encryptedMessage; cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*")); cms.Decrypt(); string plaintextMessage = cms.OutputMessage; ``` **Encrypt and Decrypt - Multiple Recipients** ```csharp Cms cms = new Cms(); cms.RecipientCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test.cer", "", "*")); cms.RecipientCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test2.cer", "", "*")); cms.InputMessage = "My Data"; cms.Encrypt(); string encryptedMessage = cms.OutputMessage; cms = new Cms(); cms.InputMessage = encryptedMessage; cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*")); cms.Decrypt(); string plaintextMessage = cms.OutputMessage; ``` **Encrypt and Decrypt - Get Recipient Info** ```csharp Cms cms = new Cms(); cms.RecipientCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test.cer", "", "*")); cms.InputMessage = "My Data"; cms.Encrypt(); string encryptedMessage = cms.OutputMessage; //If the recipient certificate is not known ahead of time the GetRecipientInfo method may be called //to find information about the certificate. cms = new Cms(); cms.InputMessage = encryptedMessage; cms.OnRecipientInfo += (s, e) => { Console.WriteLine(e.SerialNumber); Console.WriteLine(e.Issuer); if (e.Issuer == "CN=100") //Identify the certificate to load based on event params { cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*")); } }; cms.GetRecipientInfo(); cms.Decrypt(); string plaintextMessage = cms.OutputMessage; ``` # decrypt_and_verify_signature method ([CMS](#struct-ipworksencryptcms) Struct) Decrypts and verifies the signature of the current message. ## Syntax *Rust Syntax* ```text fn decrypt_and_verify_signature(&self) -> Result<(), IPWorksEncryptError> ``` ## Remarks This method decrypts the input data and verifies the signature. Decryption certificates are specified by calling [add_certificate](#add_certificate-method-cms-struct) or setting the certificates property. Certificates used to verify the signature will be taken from the message itself if included, or from the signer_certs property. If the certificate used to encrypt the message is not known ahead of time [get_recipient_info](#get_recipient_info-method-cms-struct) may be called prior to calling [decrypt](#decrypt-method-cms-struct) to obtain information about the recipient (the entity the for which the message was encrypted). If [get_recipient_info](#get_recipient_info-method-cms-struct) is called, the [on_recipient_info](#on_recipient_info-event-cms-struct) event is fired with information about the recipient which may be used to load an appropriate decryption certificate. In order to perform signature verification the public signer's certificate must be present or explicitly specified. In many cases the certificate itself is included in the input message and a certificate does not need to explicitly be set. If a certificate does need to be set for signature verification the certificate may be specified by calling [add_recipient_cert](#add_recipient_cert-method-cms-struct) or setting recipient_certs. When this method is called the [on_signer_cert_info](#on_signer_cert_info-event-cms-struct) event fires once for each signature on the message. This event provides details about the signer certificate, as well as the signer certificate itself (if present). The information provided via [on_signer_cert_info](#on_signer_cert_info-event-cms-struct) may be used to load an appropriate certificate for verification from within the event. If the *CertEncoded* parameter of [on_signer_cert_info](#on_signer_cert_info-event-cms-struct) is populated the certificate required for verification is already present in the message. The following properties are applicable when calling this method: - certificates (Required) - [detached_signature](#detached_signature-property-cms-struct) - [detached_signature_data](#detached_signature_data-property-cms-struct) - [enable_compression](#enable_compression-property-cms-struct) - signer_certs If the input message is a detached signature, the original data that was signed must be specified in [detached_signature_data](#detached_signature_data-property-cms-struct). In addition the [detached_signature](#detached_signature-property-cms-struct) property must be set to *True* to instruct the struct to treat the input message as a detached signature. If the input message is compressed [enable_compression](#enable_compression-property-cms-struct) must be set to *True* before calling this method. **Input and Output Properties** The struct will determine the source and destination of the input and output based on which properties are set. The order in which the input properties are checked is as follows: - [input_file](#input_file-property-cms-struct) - [input_message](#input_message-property-cms-struct) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [output_file](#output_file-property-cms-struct) - [output_message](#output_message-property-cms-struct): The output data is written to this property if no other destination is specified. # encrypt method ([CMS](#struct-ipworksencryptcms) Struct) Encrypts the current message. ## Syntax *Rust Syntax* ```text fn encrypt(&self) -> Result<(), IPWorksEncryptError> ``` ## Remarks encrypt encrypts the input data with the the specified certificate(s). Certificates are specified by calling [add_recipient_cert](#add_recipient_cert-method-cms-struct) or setting the recipient_certs property. [output_format](#output_format-property-cms-struct) specifies the encoding of the output message. Valid values are *PEM*, *DER*, and *SMIME*. Additional settings allow further configuration. The following properties are applicable when calling this method: - recipient_certs (required) - [encryption_algorithm](#encryption_algorithm-property-cms-struct) - [output_format](#output_format-property-cms-struct) - [use_oaep](#use_oaep-property-cms-struct) **Input and Output Properties** The struct will determine the source and destination of the input and output based on which properties are set. The order in which the input properties are checked is as follows: - [input_file](#input_file-property-cms-struct) - [input_message](#input_message-property-cms-struct) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [output_file](#output_file-property-cms-struct) - [output_message](#output_message-property-cms-struct): The output data is written to this property if no other destination is specified. **Encrypt and Decrypt a message** ```csharp Cms cms = new Cms(); cms.RecipientCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test.cer", "", "*")); cms.InputMessage = "My Data"; cms.Encrypt(); string encryptedMessage = cms.OutputMessage; cms = new Cms(); cms.InputMessage = encryptedMessage; cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*")); cms.Decrypt(); string plaintextMessage = cms.OutputMessage; ``` **Encrypt and Decrypt a message - DER Output Format** ```csharp Cms cms = new Cms(); cms.RecipientCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test.cer", "", "*")); cms.InputMessage = "My Data"; cms.OutputFormat = "DER"; cms.Encrypt(); byte[] encryptedMessage = cms.OutputMessageB; //Binary output cms = new Cms(); cms.InputMessageB = encryptedMessage; cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*")); cms.Decrypt(); string plaintextMessage = cms.OutputMessage; ``` **Encrypt and Decrypt - Multiple Recipients** ```csharp Cms cms = new Cms(); cms.RecipientCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test.cer", "", "*")); cms.RecipientCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test2.cer", "", "*")); cms.InputMessage = "My Data"; cms.Encrypt(); string encryptedMessage = cms.OutputMessage; cms = new Cms(); cms.InputMessage = encryptedMessage; cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*")); cms.Decrypt(); string plaintextMessage = cms.OutputMessage; ``` **Encrypt and Decrypt - Get Recipient Info** ```csharp Cms cms = new Cms(); cms.RecipientCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test.cer", "", "*")); cms.InputMessage = "My Data"; cms.Encrypt(); string encryptedMessage = cms.OutputMessage; //If the recipient certificate is not known ahead of time the GetRecipientInfo method may be called //to find information about the certificate. cms = new Cms(); cms.InputMessage = encryptedMessage; cms.OnRecipientInfo += (s, e) => { Console.WriteLine(e.SerialNumber); Console.WriteLine(e.Issuer); if (e.Issuer == "CN=100") //Identify the certificate to load based on event params { cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*")); } }; cms.GetRecipientInfo(); cms.Decrypt(); string plaintextMessage = cms.OutputMessage; ``` # get_recipient_info method ([CMS](#struct-ipworksencryptcms) Struct) Gets the recipient certificate information for an encrypted message. ## Syntax *Rust Syntax* ```text fn get_recipient_info(&self) -> Result<(), IPWorksEncryptError> ``` ## Remarks This method retrieves information about the recipient(s) of the encrypted message. This may be called prior to calling [decrypt](#decrypt-method-cms-struct) to determine which certificate should be loaded for decryption. When this method is called the [on_recipient_info](#on_recipient_info-event-cms-struct) event fires once for each recipient found within the message. Use the parameters of the [on_recipient_info](#on_recipient_info-event-cms-struct) to determine which certificate to specify via [add_certificate](#add_certificate-method-cms-struct) or certificates before calling [decrypt](#decrypt-method-cms-struct). # get_signer_cert_info method ([CMS](#struct-ipworksencryptcms) Struct) This method gets the signature information for an signed message. ## Syntax *Rust Syntax* ```text fn get_signer_cert_info(&self) -> Result<(), IPWorksEncryptError> ``` ## Remarks This method retrieves information about the certificate used to sign the message. This may be called before calling [verify_signature](#verify_signature-method-cms-struct) to determine which certificate should be loaded for verification. When this method is called, the [on_signer_cert_info](#on_signer_cert_info-event-cms-struct) event fires once for each signer of the message. Use the parameters of the [on_signer_cert_info](#on_signer_cert_info-event-cms-struct) to determine which certificate to specify before calling [verify_signature](#verify_signature-method-cms-struct). NOTE: Use of this method is optional. If no certificate is specified before calling [verify_signature](#verify_signature-method-cms-struct), the struct will fire the [on_signer_cert_info](#on_signer_cert_info-event-cms-struct) and a certificate may be loaded from within the event at that time (if necessary). # reset method ([CMS](#struct-ipworksencryptcms) Struct) This method resets the struct properties. ## Syntax *Rust Syntax* ```text fn reset(&self) -> Result<(), IPWorksEncryptError> ``` ## Remarks This method resets the values of all message and certificate properties. It is an easy way to reset the struct properties before starting to populate with new values. # sign method ([CMS](#struct-ipworksencryptcms) Struct) Signs the current message. ## Syntax *Rust Syntax* ```text fn sign(&self) -> Result<(), IPWorksEncryptError> ``` ## Remarks sign digitally signs the input data with the the specified certificate(s). Certificates are specified by calling [add_certificate](#add_certificate-method-cms-struct) or setting the certificates property. [output_format](#output_format-property-cms-struct) specifies the encoding of the output message. Valid values are *PEM*, *DER*, and *SMIME*. [include_certificates](#include_certificates-property-cms-struct) specifies whether the public certificate is included in the signed message. Additional settings allow further configuration. The following properties are applicable when calling this method: - certificates (required) - [detached_signature](#detached_signature-property-cms-struct) - [enable_compression](#enable_compression-property-cms-struct) - [GenerateSignatureTimestamp](#GenerateSignatureTimestamp) - [include_certificates](#include_certificates-property-cms-struct) - [output_format](#output_format-property-cms-struct) - [signature_hash_algorithm](#signature_hash_algorithm-property-cms-struct) - [use_pss](#use_pss-property-cms-struct) **Input and Output Properties** The struct will determine the source and destination of the input and output based on which properties are set. The order in which the input properties are checked is as follows: - [input_file](#input_file-property-cms-struct) - [input_message](#input_message-property-cms-struct) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [output_file](#output_file-property-cms-struct) - [output_message](#output_message-property-cms-struct): The output data is written to this property if no other destination is specified. **Sign and Verify a message** ```csharp Cms cms = new Cms(); cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*")); cms.InputMessage = "My Data"; cms.Sign(); string signedMessage = cms.OutputMessage; cms = new Cms(); cms.InputMessage = signedMessage; cms.VerifySignature(); string plaintextMessage = cms.OutputMessage; ``` **Sign and Verify a message - DER Output Format** ```csharp Cms cms = new Cms(); cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*")); cms.InputMessage = "My Data"; cms.OutputFormat = "DER"; cms.Sign(); byte[] signedMessage = cms.OutputMessageB; //Binary output cms = new Cms(); cms.InputMessageB = signedMessage; cms.VerifySignature(); string plaintextMessage = cms.OutputMessage; ``` **Sign and Verify a message - Detached Signature** ```csharp Cms cms = new Cms(); cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*")); cms.InputMessage = "My Data"; cms.DetachedSignature = true; cms.Sign(); string signature = cms.OutputMessage; cms = new Cms(); cms.InputMessage = "My Data"; cms.DetachedSignatureData = signature; cms.DetachedSignature = true; cms.VerifySignature(); ``` **Sign and Verify a message - Multiple Signatures** ```csharp Cms cms = new Cms(); cms.InputMessage = "My Data"; cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*")); cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test2.pfx", "password2", "*")); cms.Sign(); string signedMessage = cms.OutputMessage; cms = new Cms(); cms.InputMessage = signedMessage; cms.VerifySignature(); string plaintextMessage = cms.OutputMessage; ``` **Sign and Verify a message - No Included Certificate** ```csharp Cms cms = new Cms(); cms.InputMessage = "My Data"; cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*")); cms.IncludeCertificates = CmsIncludeCertificates.icsNone; cms.Sign(); string signedMessage = cms.OutputMessage; cms = new Cms(); cms.OnSignerCertInfo += (s, e) => { Console.WriteLine(e.Issuer); Console.WriteLine(e.SerialNumber); if (e.Issuer == "CN=100") //Identify the certificate to load based on event params { //Load the correct signer certificate. cms.SignerCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test.cer", "", "*")); } }; cms.InputMessage = signedMessage; cms.VerifySignature(); string plaintextMessage = cms.OutputMessage; ``` # sign_and_encrypt method ([CMS](#struct-ipworksencryptcms) Struct) Signs and encrypts the current message. ## Syntax *Rust Syntax* ```text fn sign_and_encrypt(&self) -> Result<(), IPWorksEncryptError> ``` ## Remarks This method signs encrypts the input data with the the specified certificate(s). Encryption certificates are specified by calling [add_recipient_cert](#add_recipient_cert-method-cms-struct) or setting the recipient_certs property. Signing certificates are set via the certificates property. [output_format](#output_format-property-cms-struct) specifies the encoding of the output message. Valid values are *PEM*, *DER*, and *SMIME*. Additional settings allow further configuration. [include_certificates](#include_certificates-property-cms-struct) specifies whether the public certificate is included in the signed message. The following properties are applicable when calling this method: - certificates (required) - recipient_certs (required) - [detached_signature](#detached_signature-property-cms-struct) - [enable_compression](#enable_compression-property-cms-struct) - [encryption_algorithm](#encryption_algorithm-property-cms-struct) - [GenerateSignatureTimestamp](#GenerateSignatureTimestamp) - [include_certificates](#include_certificates-property-cms-struct) - [output_format](#output_format-property-cms-struct) - [signature_hash_algorithm](#signature_hash_algorithm-property-cms-struct) - [use_oaep](#use_oaep-property-cms-struct) - [use_pss](#use_pss-property-cms-struct) **Input and Output Properties** The struct will determine the source and destination of the input and output based on which properties are set. The order in which the input properties are checked is as follows: - [input_file](#input_file-property-cms-struct) - [input_message](#input_message-property-cms-struct) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [output_file](#output_file-property-cms-struct) - [output_message](#output_message-property-cms-struct): The output data is written to this property if no other destination is specified. # verify_signature method ([CMS](#struct-ipworksencryptcms) Struct) Verifies the signature of the current message. ## Syntax *Rust Syntax* ```text fn verify_signature(&self) -> Result<(), IPWorksEncryptError> ``` ## Remarks verify_signature verifies the signature of the input message. In order to perform signature verification the public signer's certificate must be present or explicitly specified. In many cases the certificate itself is included in the input message and a certificate does not need to explicitly be set. If a certificate does need to be set for signature verification the certificate may be specified by calling [add_recipient_cert](#add_recipient_cert-method-cms-struct) or setting recipient_certs. When this method is called the [on_signer_cert_info](#on_signer_cert_info-event-cms-struct) event fires once for each signature on the message. This event provides details about the signer certificate, as well as the signer certificate itself (if present). The information provided via [on_signer_cert_info](#on_signer_cert_info-event-cms-struct) may be used to load an appropriate certificate for verification from within the event. If the *CertEncoded* parameter of [on_signer_cert_info](#on_signer_cert_info-event-cms-struct) is populated the certificate required for verification is already present in the message. The following property are applicable when calling this method: - [detached_signature](#detached_signature-property-cms-struct) - [detached_signature_data](#detached_signature_data-property-cms-struct) - [enable_compression](#enable_compression-property-cms-struct) - signer_certs If the input message is a detached signature, the original data that was signed must be specified in [detached_signature_data](#detached_signature_data-property-cms-struct). In addition the [detached_signature](#detached_signature-property-cms-struct) property must be set to *True* to instruct the struct to treat the input message as a detached signature. If the input message is compressed [enable_compression](#enable_compression-property-cms-struct) must be set to *True* before calling this method. **Input and Output Properties** The struct will determine the source and destination of the input and output based on which properties are set. The order in which the input properties are checked is as follows: - [input_file](#input_file-property-cms-struct) - [input_message](#input_message-property-cms-struct) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [output_file](#output_file-property-cms-struct) - [output_message](#output_message-property-cms-struct): The output data is written to this property if no other destination is specified. **Sign and Verify a message** ```csharp Cms cms = new Cms(); cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*")); cms.InputMessage = "My Data"; cms.Sign(); string signedMessage = cms.OutputMessage; cms = new Cms(); cms.InputMessage = signedMessage; cms.VerifySignature(); string plaintextMessage = cms.OutputMessage; ``` **Sign and Verify a message - DER Output Format** ```csharp Cms cms = new Cms(); cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*")); cms.InputMessage = "My Data"; cms.OutputFormat = "DER"; cms.Sign(); byte[] signedMessage = cms.OutputMessageB; //Binary output cms = new Cms(); cms.InputMessageB = signedMessage; cms.VerifySignature(); string plaintextMessage = cms.OutputMessage; ``` **Sign and Verify a message - Detached Signature** ```csharp Cms cms = new Cms(); cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*")); cms.InputMessage = "My Data"; cms.DetachedSignature = true; cms.Sign(); string signature = cms.OutputMessage; cms = new Cms(); cms.InputMessage = "My Data"; cms.DetachedSignatureData = signature; cms.DetachedSignature = true; cms.VerifySignature(); ``` **Sign and Verify a message - Multiple Signatures** ```csharp Cms cms = new Cms(); cms.InputMessage = "My Data"; cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*")); cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test2.pfx", "password2", "*")); cms.Sign(); string signedMessage = cms.OutputMessage; cms = new Cms(); cms.InputMessage = signedMessage; cms.VerifySignature(); string plaintextMessage = cms.OutputMessage; ``` **Sign and Verify a message - No Included Certificate** ```csharp Cms cms = new Cms(); cms.InputMessage = "My Data"; cms.Certificates.Add(new Certificate(CertStoreTypes.cstPFXFile, @"C:\temp\test.pfx", "password", "*")); cms.IncludeCertificates = CmsIncludeCertificates.icsNone; cms.Sign(); string signedMessage = cms.OutputMessage; cms = new Cms(); cms.OnSignerCertInfo += (s, e) => { Console.WriteLine(e.Issuer); Console.WriteLine(e.SerialNumber); if (e.Issuer == "CN=100") //Identify the certificate to load based on event params { //Load the correct signer certificate. cms.SignerCerts.Add(new Certificate(CertStoreTypes.cstPublicKeyFile, @"C:\temp\test.cer", "", "*")); } }; cms.InputMessage = signedMessage; cms.VerifySignature(); string plaintextMessage = cms.OutputMessage; ``` # on_error event ([CMS](#struct-ipworksencryptcms) Struct) Fired when information is available about errors during data delivery. ## Syntax *Rust Syntax* ```text // CMSErrorEventArgs carries the CMS Error event's parameters. pub struct CMSErrorEventArgs { fn error_code(&self) -> i32 fn description(&self) -> &String } // CMSErrorEvent defines the signature of the CMS Error event's handler function. pub trait CMSErrorEvent { fn on_error(&self, sender : CMS, e : &mut CMSErrorEventArgs); } impl <'a> CMS<'a> { pub fn on_error(&self) -> &'a dyn CMSErrorEvent; pub fn set_on_error(&mut self, value : &'a dyn CMSErrorEvent); ... } ``` ## 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-cms-struct) section. # on_log event ([CMS](#struct-ipworksencryptcms) Struct) Fires with log information during processing. ## Syntax *Rust Syntax* ```text // CMSLogEventArgs carries the CMS Log event's parameters. pub struct CMSLogEventArgs { fn log_level(&self) -> i32 fn message(&self) -> &String fn log_type(&self) -> &String } // CMSLogEvent defines the signature of the CMS Log event's handler function. pub trait CMSLogEvent { fn on_log(&self, sender : CMS, e : &mut CMSLogEventArgs); } impl <'a> CMS<'a> { pub fn on_log(&self) -> &'a dyn CMSLogEvent; pub fn set_on_log(&mut self, value : &'a dyn CMSLogEvent); ... } ``` ## Remarks This event fires during processing with log information. The level of detail that is logged is controlled via the [LogLevel](#LogLevel). *LogLevel* indicates the level of message. Possible values are: | | | | --- | --- | | 0 (None) | No events are logged. | | 1 (Info - default) | Informational events are logged. | | 2 (Verbose) | Detailed data is logged. | | 3 (Debug) | Debug data is logged. | *LogMessage* is the log entry. *LogType* indicates the type of log. Possible values are: - "INFO" - "ENCRYPT" - "COMPRESS" - "SIGN" - "DECRYPT" - "DECOMPRESS" - "VERIFY" - "DEBUG" # on_recipient_info event ([CMS](#struct-ipworksencryptcms) Struct) This event is fired for each recipient certificate of the encrypted message. ## Syntax *Rust Syntax* ```text // CMSRecipientInfoEventArgs carries the CMS RecipientInfo event's parameters. pub struct CMSRecipientInfoEventArgs { fn issuer(&self) -> &String fn serial_number(&self) -> &String fn subject_key_identifier(&self) -> &String fn encryption_algorithm(&self) -> &String } // CMSRecipientInfoEvent defines the signature of the CMS RecipientInfo event's handler function. pub trait CMSRecipientInfoEvent { fn on_recipient_info(&self, sender : CMS, e : &mut CMSRecipientInfoEventArgs); } impl <'a> CMS<'a> { pub fn on_recipient_info(&self) -> &'a dyn CMSRecipientInfoEvent; pub fn set_on_recipient_info(&mut self, value : &'a dyn CMSRecipientInfoEvent); ... } ``` ## Remarks When [get_recipient_info](#get_recipient_info-method-cms-struct) is called on a valid encrypted message, this event will fire once for each recipient certificate that the message has been encrypted for. This may be used to identify the certificate to load. *Issuer* is the subject of the issuer certificate. *SerialNumber* is the serial number of the encryption certificate. *SubjectKeyIdentifier* is the X.509 subjectKeyIdentifier extension value of the certificate used to sign the message encoded as a hex string. *EncryptionAlgorithm* is the encryption algorithm used to encrypt the message. Possible values are as follows: - "3DES" - "DES" - "RC2CBC40" - "RC2CBC64" - "RC2CBC128" or "RC2" - "AESCBC128" or "AES" - "AESCBC192" - "AESCBC256" - "AESGCM128" or "AESGCM" - "AESGCM192" - "AESGCM256" # on_signer_cert_info event ([CMS](#struct-ipworksencryptcms) Struct) Fired during verification of the signed message. ## Syntax *Rust Syntax* ```text // CMSSignerCertInfoEventArgs carries the CMS SignerCertInfo event's parameters. pub struct CMSSignerCertInfoEventArgs { fn issuer(&self) -> &String fn serial_number(&self) -> &String fn subject_key_identifier(&self) -> &String fn cert_encoded(&self) -> &[u8] } // CMSSignerCertInfoEvent defines the signature of the CMS SignerCertInfo event's handler function. pub trait CMSSignerCertInfoEvent { fn on_signer_cert_info(&self, sender : CMS, e : &mut CMSSignerCertInfoEventArgs); } impl <'a> CMS<'a> { pub fn on_signer_cert_info(&self) -> &'a dyn CMSSignerCertInfoEvent; pub fn set_on_signer_cert_info(&mut self, value : &'a dyn CMSSignerCertInfoEvent); ... } ``` ## Remarks During verification, this event will be raised while parsing the signer's certificate information. The parameters which are populated depends on the options used when the message was originally signed. This information may be used to select the correct certificate for signer_certs in order 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_certs 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. # Config Settings ([CMS](#struct-ipworksencryptcms) 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-cms-struct) method. ### CMS Config Settings **CompressBeforeSign**: Specifies whether to compress before signing.When [enable_compression](#enable_compression-property-cms-struct) is set to *True* this property controls whether compression happens before or after signing. If set to *True* the input data will be compressed before signing. If set to *False* (default) the input data will be signed and then compressed. **ContentTypeOID**: Specifies the oid for content type.This setting optionally specifies an OID defining the data content type for the data being processed. This may be set before calling [encrypt](#encrypt-method-cms-struct), [sign](#sign-method-cms-struct), or [sign_and_encrypt](#sign_and_encrypt-method-cms-struct). The default value is *1.2.840.113549.1.7.1* which is the OID for id-data. **CSP**: The Cryptographic Service Provider.For the Win32 editions, the name of the Cryptographic Service Provider used to provide access to encryption/decryption and signature operations. NOTE: This config may only be used when the [UseCryptoAPI](#UseCryptoAPI) is true. **GenerateSignatureTimestamp**: Whether to generate timestamps in signatures.If [GenerateSignatureTimestamp](#GenerateSignatureTimestamp) is True, a timestamp will be generated and added to all signatures created by the struct. The default value is *True*. **IncludeHeaders**: Tells the struct whether to include the headers when encoding the message.If True (default), the struct will include MIME headers when [sign](#sign-method-cms-struct), [encrypt](#encrypt-method-cms-struct), or [sign_and_encrypt](#sign_and_encrypt-method-cms-struct) are called. If False, only the message will be encoded. The default value for [IncludeHeaders](#IncludeHeaders) is true. Note: This setting is only applicable to when [output_format](#output_format-property-cms-struct) is set to *SMIME*. **IncludeInternalHeaders**: Tells the struct whether or not to include the internal headers when encoding the message.If True, the struct will generate and include MIME part headers when [sign](#sign-method-cms-struct), [encrypt](#encrypt-method-cms-struct), or [sign_and_encrypt](#sign_and_encrypt-method-cms-struct) are called. When [verify_signature](#verify_signature-method-cms-struct), [decrypt](#decrypt-method-cms-struct), or [decrypt_and_verify_signature](#decrypt_and_verify_signature-method-cms-struct) are called the MIME part headers will be stripped. When set to *False*, only the message will be processed, MIME part headers will not be generated or stripped. The default value for [IncludeInternalHeaders](#IncludeInternalHeaders) is False. Note: This setting is only applicable to when [output_format](#output_format-property-cms-struct) is set to *SMIME*. **InputContentTransferEncoding**: Sets the Content-Transfer-Encoding for the signed message.This setting specifies the Content-Transfer-Encoding header value in signed messages. By default the struct will automatically determine the Content-Transfer-Encoding based on the file extension set in [input_file](#input_file-property-cms-struct), however this setting may be set to override the determined value or to specify a value if data is read from [input_message](#input_message-property-cms-struct). If no value is specified and a value cannot be automatically determined the default value *7bit* will be used. Note: This setting is only applicable when [output_format](#output_format-property-cms-struct) is set to *SMIME* and when calling [sign](#sign-method-cms-struct) or [sign_and_encrypt](#sign_and_encrypt-method-cms-struct) and [detached_signature](#detached_signature-property-cms-struct) is True. **InputContentType**: Sets the Content-Type for the signed message.This setting specifies the Content-Type header value in signed messages. By default the struct will automatically determine the Content-Type based on the file extension set in [input_file](#input_file-property-cms-struct), however this setting may be set to override the determined value or to specify a value if data is read from [input_message](#input_message-property-cms-struct). If no value is specified and a value cannot be automatically determined the default value *text/plain; charset="iso-8859-1"* will be used. Note: This setting is only applicable when [output_format](#output_format-property-cms-struct) is set to *SMIME* and when calling [sign](#sign-method-cms-struct) or [sign_and_encrypt](#sign_and_encrypt-method-cms-struct) and [detached_signature](#detached_signature-property-cms-struct) is True. **InputMessageHeaders**: Message headers.This setting specifies the headers of the SMIME message if they are not already present in the input message. In most cases the input message itself will contain the necessary headers, however if the headers are and body of the SMIME message are separate, the headers may be specified in this setting before calling [decrypt](#decrypt-method-cms-struct), [decrypt_and_verify_signature](#decrypt_and_verify_signature-method-cms-struct), or [verify_signature](#verify_signature-method-cms-struct). **LogDirectory**: The directory on disk where debug logs are written.This setting specifies a directory on disk to which debug logs will be written during operation. This should only be set for debugging purposes. Files with various extensions will be written to disk at the location specified with debug data for the operation being performed. If [LogFileName](#LogFileName) is not specified the filenames will be in the format *yyyy-MM-dd-HH-mm-ss-fff*. **LogFileName**: The base filename to use with LogDirectory.This setting specifies the base filename to use when [LogDirectory](#LogDirectory) is set. If specified the name should be a filename without extension. Various files will be logged with different extensions during operation. This setting defines only the base filename. If unspecified the files will be named with a timestamp in the format *yyyy-MM-dd-HH-mm-ss-fff*. **LogLevel**: The level of detail for log messages.This setting specifies the level of detail that is logged via the [on_log](#on_log-event-cms-struct) event. Possible values are: | | | | --- | --- | | 0 (None) | No events are logged. | | 1 (Info - default) | Informational events are logged. | | 2 (Verbose) | Detailed data is logged. | | 3 (Debug) | Debug data is logged. | **OAEPMGF1HashAlgorithm**: The MGF1 hash algorithm used with OAEP.This configuration setting specifies the MGF1 hash algorithm used when [use_oaep](#use_oaep-property-cms-struct) is set to True. The default value is *SHA256*. Possible values are as follows: - "SHA1" - "SHA224" - "SHA256" (default) - "SHA384" - "SHA512" - "RIPEMD160" - "MD2" - "MD5" - "MD5SHA1" Note: This setting is not applicable when [UseFIPSCompliantAPI](#UseFIPSCompliantAPI) is set to *true* or when the private key of the signing certificate is not exportable since the underlying system implementation does not support separate [OAEPRSAHashAlgorithm](#OAEPRSAHashAlgorithm) and [OAEPMGF1HashAlgorithm](#OAEPMGF1HashAlgorithm) values. In this case the [OAEPRSAHashAlgorithm](#OAEPRSAHashAlgorithm) is also used for MGF1. **OAEPParams**: The hex encoded OAEP parameters.This configuration setting optionally specifies Optimal Asymmetric Encryption Padding (OAEP) parameters to be used when [use_oaep](#use_oaep-property-cms-struct) is set to True. The specified value should be hex encoded. **OAEPRSAHashAlgorithm**: The RSA hash algorithm used with OAEP.This configuration setting specifies that RSA hash algorithm used when [use_oaep](#use_oaep-property-cms-struct) is set to True. The default value is *SHA256*. Possible values are as follows: - "SHA1" - "SHA224" - "SHA256" (default) - "SHA384" - "SHA512" - "RIPEMD160" - "MD2" - "MD5" - "MD5SHA1" **OutputMessageHeaders**: The SMIME headers of the output message.When [IncludeHeaders](#IncludeHeaders) is set to *False* the SMIME headers are not included in the output message itself when [sign](#sign-method-cms-struct), [encrypt](#encrypt-method-cms-struct), or [sign_and_encrypt](#sign_and_encrypt-method-cms-struct) are called. This setting may be used to obtain the SMIME headers separately. This setting is only applicable when [output_format](#output_format-property-cms-struct) is set to *SMIME*. **RecipientInfoType**: The type of signer information to include in the signed message.This configuration setting specifies which type of information about the recipient's encryption certificate is included in the encrypted message. Possible values are as follows: - 0 (issuerAndSerialNumber - default) - 1 (subjectKeyIdentifier) NOTE: When subjectKeyIdentifier is selected, the recipient's encryption certificate must contain the subjectKeyIdentifier extension. **SignatureTimestamp**: The signature timestamp in the signed message.This setting holds the timestamp of the signature. After calling [verify_signature](#verify_signature-method-cms-struct) this setting will hold the timestamp identifying when the signature was created. The timestamp is in UTC time with the format *yyyyMMddHHmmss*. For instance *20181130223821*. **SignerInfoType**: The type of signer information to include in the signed message.This configuration setting specifies which type of information about the signer certificate is included in the signed message. Possible values are as follows: - 0 (issuerAndSerialNumber - default) - 1 (subjectKeyIdentifier) NOTE: When subjectKeyIdentifier is selected, the signing certificate must contain the subjectKeyIdentifier extension. **UseAlgorithmOIDs**: Whether OIDs are used when providing information about the algorithms.This configuration setting controls whether the *EncryptionAlgorithm* parameter of the [on_recipient_info](#on_recipient_info-event-cms-struct) event is populated with the name of the algorithm, such as *3DES* or the corresponding OID such as *1.2.840.113549.3.7*. The default value is *False*, and the name of the algorithm is used. Set this to *True* to use the object identifiers instead. ### 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 ([CMS](#struct-ipworksencryptcms) Struct) ### CMS Errors | | | | --- | --- | | 10191 | Invalid index (RecipientIndex). | | 10192 | Message decoding error (code). | | 10193 | Unexpected message type. | | 10194 | Unsupported hashing/signing algorithm. | | 10195 | The message does not have any signers. | | 10196 | The message signature could not be verified. | | 10197 | Could not locate a suitable decryption certificate. | | 10198 | The signer certificate could not be found. | | 10199 | No signing certificate was supplied for signing the message. | | 10201 | The specified certificate was not the one required. | | 10202 | The specified certificate could not be found. | | 10221 | Could not acquire CSP. | | 10222 | Type validation error. | | 10223 | Unsupported key size. | | 10224 | Unrecognized Content-Type object identifier. | | 10225 | Unrecognized public key format. | | 10226 | No choices specified. | | 10228 | Must specify output stream. | | 10280 | Invalid part index. | | 10281 | Unknown MIME type. | | 10283 | No MIME-boundary found. | | 10280 | Error decoding certificate. |