# SMIME Class The S/MIME class implements the S/MIME standard for encryption and decryption with public key cryptography and X.509 digital certificates. ## Class Name **IPWorksSMIME_SMIME** ## Procedural Interface ```text ipworkssmime_smime_open(); ipworkssmime_smime_close($res); ipworkssmime_smime_register_callback($res, $id, $function); ipworkssmime_smime_get_last_error($res); ipworkssmime_smime_get_last_error_code($res); ipworkssmime_smime_set($res, $id, $index, $value); ipworkssmime_smime_get($res, $id, $index); ipworkssmime_smime_do_addrecipientcert($res, $certencoded); ipworkssmime_smime_do_checkmessageencrypted($res); ipworkssmime_smime_do_checkmessagesigned($res); ipworkssmime_smime_do_config($res, $configurationstring); ipworkssmime_smime_do_decrypt($res); ipworkssmime_smime_do_decryptandverifysignature($res); ipworkssmime_smime_do_encrypt($res); ipworkssmime_smime_do_getrecipientinfo($res); ipworkssmime_smime_do_getsignercertinfo($res); ipworkssmime_smime_do_reset($res); ipworkssmime_smime_do_sign($res); ipworkssmime_smime_do_signandencrypt($res); ipworkssmime_smime_do_verifysignature($res); ``` ## Remarks The S/MIME class implements the S/MIME V3 standard for encryption and decryption using Public Key Cryptography Standards (PKCS). In addition, the class can be used to both generate and verify RSA digital signatures. Using this class for decrypting or signing requires a valid digital certificate with a private key. Before performing an operation the input and output values should be specified. **Input and Output Properties** The class 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: - [InputFile](#inputfile-property-ipworkssmime_smime-class) - [InputMessage](#inputmessage-property-ipworkssmime_smime-class) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [OutputFile](#outputfile-property-ipworkssmime_smime-class) - [OutputMessage](#outputmessage-property-ipworkssmime_smime-class): The output data is written to this property if no other destination is specified. The headers of the input message (if any) will be read from InputMessageHeaders or [InputMessageHeadersString](#inputmessageheadersstring-property-ipworkssmime_smime-class). The headers of the resulting message will be available in the OutputMessageHeaders and [OutputMessageHeadersString](#outputmessageheadersstring-property-ipworkssmime_smime-class) properties. **Signing** To sign the current data included in the input message with a certificate, the Certificate property must be set to a valid Certificate object for the signing certificate. The [IncludeCertificate](#includecertificate-property-ipworkssmime_smime-class) and [DetachedSignature](#detachedsignature-property-ipworkssmime_smime-class) properties allow you to specify additional details about the signing process. By setting [IncludeCertificate](#includecertificate-property-ipworkssmime_smime-class) to True, digital certificates can be encoded and included in message signature when signing the document. Including a certificate is the preferred method of building signed messages. In addition the S/MIME class can also generate PKCS #7 formatted detached digital signatures and envelopes by specifying [DetachedSignature](#detachedsignature-property-ipworkssmime_smime-class). **Encrypting** To encrypt a message with the class in a PKCS envelope, you must first specify the Certificate for each recipient in the RecipientCerts properties to encrypt the message with. You can easily add these with the [AddRecipientCert](#addrecipientcert-method-ipworkssmime_smime-class) method. Once you have done this you can call the [Encrypt](#encrypt-method-ipworkssmime_smime-class) method to encrypt the message with the recipient certificates. In addition, the class allows you to sign and encrypt simultaneously with the [SignAndEncrypt](#signandencrypt-method-ipworkssmime_smime-class) method. You must set all of the properties needed for both [Sign](#sign-method-ipworkssmime_smime-class) and [Encrypt](#encrypt-method-ipworkssmime_smime-class) The result of the encrypted or signed data will be replaced in the [OutputMessage](#outputmessage-property-ipworkssmime_smime-class) property and the OutputMessageHeaders property will be filled with the appropriate mime headers if applicable. **Decrypting** Decrypting PKCS envelopes is handled with the [Decrypt](#decrypt-method-ipworkssmime_smime-class) method. When this method is called, the class will attempt to find an appropriate certificate in the Certificate property that matches the encrypting certificate. If it cannot find an appropriate certificate, an exception will be thrown and the message will not be decrypted. **Verifying Signatures** In addition, the S/MIME class can be used to verify signatures included in signed messages or documents. After specifying the input, [VerifySignature](#verifysignature-method-ipworkssmime_smime-class) can then be used to verify the signature. If the message does not have a certificate attached, more then likely an exception will be thrown and the class will not be able to verify the signature. If [VerifySignature](#verifysignature-method-ipworkssmime_smime-class) is successful, the SignerCert and SignerCertChain properties will be filled with the certificate information of the message signer. This information can be used to verify the signing certificates. Similar to [SignAndEncrypt](#signandencrypt-method-ipworkssmime_smime-class), [DecryptAndVerifySignature](#decryptandverifysignature-method-ipworkssmime_smime-class) can be used to both decrypt and verify the message in Message. ## Property List *The following is the full list of the properties of the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [CertEffectiveDate](#certeffectivedate-property-ipworkssmime_smime-class) | The date on which this certificate becomes valid. | | [CertExpirationDate](#certexpirationdate-property-ipworkssmime_smime-class) | The date on which the certificate expires. | | [CertExtendedKeyUsage](#certextendedkeyusage-property-ipworkssmime_smime-class) | A comma-delimited list of extended key usage identifiers. | | [CertFingerprint](#certfingerprint-property-ipworkssmime_smime-class) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [CertFingerprintSHA1](#certfingerprintsha1-property-ipworkssmime_smime-class) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [CertFingerprintSHA256](#certfingerprintsha256-property-ipworkssmime_smime-class) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [CertIssuer](#certissuer-property-ipworkssmime_smime-class) | The issuer of the certificate. | | [CertPrivateKey](#certprivatekey-property-ipworkssmime_smime-class) | The private key of the certificate (if available). | | [CertPrivateKeyAvailable](#certprivatekeyavailable-property-ipworkssmime_smime-class) | Whether a PrivateKey is available for the selected certificate. | | [CertPrivateKeyContainer](#certprivatekeycontainer-property-ipworkssmime_smime-class) | The name of the PrivateKey container for the certificate (if available). | | [CertPublicKey](#certpublickey-property-ipworkssmime_smime-class) | The public key of the certificate. | | [CertPublicKeyAlgorithm](#certpublickeyalgorithm-property-ipworkssmime_smime-class) | The textual description of the certificate's public key algorithm. | | [CertPublicKeyLength](#certpublickeylength-property-ipworkssmime_smime-class) | The length of the certificate's public key (in bits). | | [CertSerialNumber](#certserialnumber-property-ipworkssmime_smime-class) | The serial number of the certificate encoded as a string. | | [CertSignatureAlgorithm](#certsignaturealgorithm-property-ipworkssmime_smime-class) | The text description of the certificate's signature algorithm. | | [CertStore](#certstore-property-ipworkssmime_smime-class) | The name of the certificate store for the client certificate. | | [CertStorePassword](#certstorepassword-property-ipworkssmime_smime-class) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. | | [CertStoreType](#certstoretype-property-ipworkssmime_smime-class) | The type of certificate store for this certificate. | | [CertSubjectAltNames](#certsubjectaltnames-property-ipworkssmime_smime-class) | Comma-separated lists of alternative subject names for the certificate. | | [CertThumbprintMD5](#certthumbprintmd5-property-ipworkssmime_smime-class) | The MD5 hash of the certificate. | | [CertThumbprintSHA1](#certthumbprintsha1-property-ipworkssmime_smime-class) | The SHA-1 hash of the certificate. | | [CertThumbprintSHA256](#certthumbprintsha256-property-ipworkssmime_smime-class) | The SHA-256 hash of the certificate. | | [CertUsage](#certusage-property-ipworkssmime_smime-class) | The text description of UsageFlags . | | [CertUsageFlags](#certusageflags-property-ipworkssmime_smime-class) | The flags that show intended use for the certificate. | | [CertVersion](#certversion-property-ipworkssmime_smime-class) | The certificate's version number. | | [CertSubject](#certsubject-property-ipworkssmime_smime-class) | The subject of the certificate used for client authentication. | | [CertEncoded](#certencoded-property-ipworkssmime_smime-class) | The certificate (PEM/Base64 encoded). | | [DetachedSignature](#detachedsignature-property-ipworkssmime_smime-class) | This property specifies whether to include a detached signature when signing a message. | | [EncryptingAlgorithm](#encryptingalgorithm-property-ipworkssmime_smime-class) | The property includes textual description of the encrypting algorithm. | | [IncludeCertificate](#includecertificate-property-ipworkssmime_smime-class) | This property specifies whether to include the signer's certificate with the signed message. | | [IncludeChain](#includechain-property-ipworkssmime_smime-class) | This property specifies whether to include the signer's certificate chain with the signed message. | | [IncludeHeaders](#includeheaders-property-ipworkssmime_smime-class) | This property tells the class whether to include the headers when encoding the message. | | [InputFile](#inputfile-property-ipworkssmime_smime-class) | This property includes the file to process. | | [InputMessage](#inputmessage-property-ipworkssmime_smime-class) | This property includes the message to process. | | [InputMessageHeaderCount](#inputmessageheadercount-property-ipworkssmime_smime-class) | The number of records in the InputMessageHeader arrays. | | [InputMessageHeaderField](#inputmessageheaderfield-property-ipworkssmime_smime-class) | This property contains the name of the HTTP header (this is the same case as it is delivered). | | [InputMessageHeaderValue](#inputmessageheadervalue-property-ipworkssmime_smime-class) | This property contains the header contents. | | [InputMessageHeadersString](#inputmessageheadersstring-property-ipworkssmime_smime-class) | This property includes the string version of headers from the S/MIME message. | | [InternalHeaders](#internalheaders-property-ipworkssmime_smime-class) | This property includes the headers of the MIME entity inside the encrypted or signed message. | | [OutputFile](#outputfile-property-ipworkssmime_smime-class) | This property specifies the output file. | | [OutputMessage](#outputmessage-property-ipworkssmime_smime-class) | This property includes the output message after processing. | | [OutputMessageHeaderCount](#outputmessageheadercount-property-ipworkssmime_smime-class) | The number of records in the OutputMessageHeader arrays. | | [OutputMessageHeaderField](#outputmessageheaderfield-property-ipworkssmime_smime-class) | This property contains the name of the HTTP header (this is the same case as it is delivered). | | [OutputMessageHeaderValue](#outputmessageheadervalue-property-ipworkssmime_smime-class) | This property contains the header contents. | | [OutputMessageHeadersString](#outputmessageheadersstring-property-ipworkssmime_smime-class) | This property includes a string version of headers from the S/MIME message. | | [Overwrite](#overwrite-property-ipworkssmime_smime-class) | This property indicates whether or not the class should overwrite files. | | [RecipientCertCount](#recipientcertcount-property-ipworkssmime_smime-class) | The number of records in the RecipientCert arrays. | | [RecipientCertEffectiveDate](#recipientcerteffectivedate-property-ipworkssmime_smime-class) | The date on which this certificate becomes valid. | | [RecipientCertExpirationDate](#recipientcertexpirationdate-property-ipworkssmime_smime-class) | The date on which the certificate expires. | | [RecipientCertExtendedKeyUsage](#recipientcertextendedkeyusage-property-ipworkssmime_smime-class) | A comma-delimited list of extended key usage identifiers. | | [RecipientCertFingerprint](#recipientcertfingerprint-property-ipworkssmime_smime-class) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [RecipientCertFingerprintSHA1](#recipientcertfingerprintsha1-property-ipworkssmime_smime-class) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [RecipientCertFingerprintSHA256](#recipientcertfingerprintsha256-property-ipworkssmime_smime-class) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [RecipientCertIssuer](#recipientcertissuer-property-ipworkssmime_smime-class) | The issuer of the certificate. | | [RecipientCertPrivateKey](#recipientcertprivatekey-property-ipworkssmime_smime-class) | The private key of the certificate (if available). | | [RecipientCertPrivateKeyAvailable](#recipientcertprivatekeyavailable-property-ipworkssmime_smime-class) | Whether a PrivateKey is available for the selected certificate. | | [RecipientCertPrivateKeyContainer](#recipientcertprivatekeycontainer-property-ipworkssmime_smime-class) | The name of the PrivateKey container for the certificate (if available). | | [RecipientCertPublicKey](#recipientcertpublickey-property-ipworkssmime_smime-class) | The public key of the certificate. | | [RecipientCertPublicKeyAlgorithm](#recipientcertpublickeyalgorithm-property-ipworkssmime_smime-class) | The textual description of the certificate's public key algorithm. | | [RecipientCertPublicKeyLength](#recipientcertpublickeylength-property-ipworkssmime_smime-class) | The length of the certificate's public key (in bits). | | [RecipientCertSerialNumber](#recipientcertserialnumber-property-ipworkssmime_smime-class) | The serial number of the certificate encoded as a string. | | [RecipientCertSignatureAlgorithm](#recipientcertsignaturealgorithm-property-ipworkssmime_smime-class) | The text description of the certificate's signature algorithm. | | [RecipientCertStore](#recipientcertstore-property-ipworkssmime_smime-class) | The name of the certificate store for the client certificate. | | [RecipientCertStorePassword](#recipientcertstorepassword-property-ipworkssmime_smime-class) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. | | [RecipientCertStoreType](#recipientcertstoretype-property-ipworkssmime_smime-class) | The type of certificate store for this certificate. | | [RecipientCertSubjectAltNames](#recipientcertsubjectaltnames-property-ipworkssmime_smime-class) | Comma-separated lists of alternative subject names for the certificate. | | [RecipientCertThumbprintMD5](#recipientcertthumbprintmd5-property-ipworkssmime_smime-class) | The MD5 hash of the certificate. | | [RecipientCertThumbprintSHA1](#recipientcertthumbprintsha1-property-ipworkssmime_smime-class) | The SHA-1 hash of the certificate. | | [RecipientCertThumbprintSHA256](#recipientcertthumbprintsha256-property-ipworkssmime_smime-class) | The SHA-256 hash of the certificate. | | [RecipientCertUsage](#recipientcertusage-property-ipworkssmime_smime-class) | The text description of UsageFlags . | | [RecipientCertUsageFlags](#recipientcertusageflags-property-ipworkssmime_smime-class) | The flags that show intended use for the certificate. | | [RecipientCertVersion](#recipientcertversion-property-ipworkssmime_smime-class) | The certificate's version number. | | [RecipientCertSubject](#recipientcertsubject-property-ipworkssmime_smime-class) | The subject of the certificate used for client authentication. | | [RecipientCertEncoded](#recipientcertencoded-property-ipworkssmime_smime-class) | The certificate (PEM/Base64 encoded). | | [SignerCertEffectiveDate](#signercerteffectivedate-property-ipworkssmime_smime-class) | The date on which this certificate becomes valid. | | [SignerCertExpirationDate](#signercertexpirationdate-property-ipworkssmime_smime-class) | The date on which the certificate expires. | | [SignerCertExtendedKeyUsage](#signercertextendedkeyusage-property-ipworkssmime_smime-class) | A comma-delimited list of extended key usage identifiers. | | [SignerCertFingerprint](#signercertfingerprint-property-ipworkssmime_smime-class) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [SignerCertFingerprintSHA1](#signercertfingerprintsha1-property-ipworkssmime_smime-class) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [SignerCertFingerprintSHA256](#signercertfingerprintsha256-property-ipworkssmime_smime-class) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [SignerCertIssuer](#signercertissuer-property-ipworkssmime_smime-class) | The issuer of the certificate. | | [SignerCertPrivateKey](#signercertprivatekey-property-ipworkssmime_smime-class) | The private key of the certificate (if available). | | [SignerCertPrivateKeyAvailable](#signercertprivatekeyavailable-property-ipworkssmime_smime-class) | Whether a PrivateKey is available for the selected certificate. | | [SignerCertPrivateKeyContainer](#signercertprivatekeycontainer-property-ipworkssmime_smime-class) | The name of the PrivateKey container for the certificate (if available). | | [SignerCertPublicKey](#signercertpublickey-property-ipworkssmime_smime-class) | The public key of the certificate. | | [SignerCertPublicKeyAlgorithm](#signercertpublickeyalgorithm-property-ipworkssmime_smime-class) | The textual description of the certificate's public key algorithm. | | [SignerCertPublicKeyLength](#signercertpublickeylength-property-ipworkssmime_smime-class) | The length of the certificate's public key (in bits). | | [SignerCertSerialNumber](#signercertserialnumber-property-ipworkssmime_smime-class) | The serial number of the certificate encoded as a string. | | [SignerCertSignatureAlgorithm](#signercertsignaturealgorithm-property-ipworkssmime_smime-class) | The text description of the certificate's signature algorithm. | | [SignerCertStore](#signercertstore-property-ipworkssmime_smime-class) | The name of the certificate store for the client certificate. | | [SignerCertStorePassword](#signercertstorepassword-property-ipworkssmime_smime-class) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. | | [SignerCertStoreType](#signercertstoretype-property-ipworkssmime_smime-class) | The type of certificate store for this certificate. | | [SignerCertSubjectAltNames](#signercertsubjectaltnames-property-ipworkssmime_smime-class) | Comma-separated lists of alternative subject names for the certificate. | | [SignerCertThumbprintMD5](#signercertthumbprintmd5-property-ipworkssmime_smime-class) | The MD5 hash of the certificate. | | [SignerCertThumbprintSHA1](#signercertthumbprintsha1-property-ipworkssmime_smime-class) | The SHA-1 hash of the certificate. | | [SignerCertThumbprintSHA256](#signercertthumbprintsha256-property-ipworkssmime_smime-class) | The SHA-256 hash of the certificate. | | [SignerCertUsage](#signercertusage-property-ipworkssmime_smime-class) | The text description of UsageFlags . | | [SignerCertUsageFlags](#signercertusageflags-property-ipworkssmime_smime-class) | The flags that show intended use for the certificate. | | [SignerCertVersion](#signercertversion-property-ipworkssmime_smime-class) | The certificate's version number. | | [SignerCertSubject](#signercertsubject-property-ipworkssmime_smime-class) | The subject of the certificate used for client authentication. | | [SignerCertEncoded](#signercertencoded-property-ipworkssmime_smime-class) | The certificate (PEM/Base64 encoded). | | [SignerCertChainCount](#signercertchaincount-property-ipworkssmime_smime-class) | The number of records in the SignerCertChain arrays. | | [SignerCertChainEffectiveDate](#signercertchaineffectivedate-property-ipworkssmime_smime-class) | The date on which this certificate becomes valid. | | [SignerCertChainExpirationDate](#signercertchainexpirationdate-property-ipworkssmime_smime-class) | The date on which the certificate expires. | | [SignerCertChainExtendedKeyUsage](#signercertchainextendedkeyusage-property-ipworkssmime_smime-class) | A comma-delimited list of extended key usage identifiers. | | [SignerCertChainFingerprint](#signercertchainfingerprint-property-ipworkssmime_smime-class) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [SignerCertChainFingerprintSHA1](#signercertchainfingerprintsha1-property-ipworkssmime_smime-class) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [SignerCertChainFingerprintSHA256](#signercertchainfingerprintsha256-property-ipworkssmime_smime-class) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [SignerCertChainIssuer](#signercertchainissuer-property-ipworkssmime_smime-class) | The issuer of the certificate. | | [SignerCertChainPrivateKey](#signercertchainprivatekey-property-ipworkssmime_smime-class) | The private key of the certificate (if available). | | [SignerCertChainPrivateKeyAvailable](#signercertchainprivatekeyavailable-property-ipworkssmime_smime-class) | Whether a PrivateKey is available for the selected certificate. | | [SignerCertChainPrivateKeyContainer](#signercertchainprivatekeycontainer-property-ipworkssmime_smime-class) | The name of the PrivateKey container for the certificate (if available). | | [SignerCertChainPublicKey](#signercertchainpublickey-property-ipworkssmime_smime-class) | The public key of the certificate. | | [SignerCertChainPublicKeyAlgorithm](#signercertchainpublickeyalgorithm-property-ipworkssmime_smime-class) | The textual description of the certificate's public key algorithm. | | [SignerCertChainPublicKeyLength](#signercertchainpublickeylength-property-ipworkssmime_smime-class) | The length of the certificate's public key (in bits). | | [SignerCertChainSerialNumber](#signercertchainserialnumber-property-ipworkssmime_smime-class) | The serial number of the certificate encoded as a string. | | [SignerCertChainSignatureAlgorithm](#signercertchainsignaturealgorithm-property-ipworkssmime_smime-class) | The text description of the certificate's signature algorithm. | | [SignerCertChainStore](#signercertchainstore-property-ipworkssmime_smime-class) | The name of the certificate store for the client certificate. | | [SignerCertChainStorePassword](#signercertchainstorepassword-property-ipworkssmime_smime-class) | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. | | [SignerCertChainStoreType](#signercertchainstoretype-property-ipworkssmime_smime-class) | The type of certificate store for this certificate. | | [SignerCertChainSubjectAltNames](#signercertchainsubjectaltnames-property-ipworkssmime_smime-class) | Comma-separated lists of alternative subject names for the certificate. | | [SignerCertChainThumbprintMD5](#signercertchainthumbprintmd5-property-ipworkssmime_smime-class) | The MD5 hash of the certificate. | | [SignerCertChainThumbprintSHA1](#signercertchainthumbprintsha1-property-ipworkssmime_smime-class) | The SHA-1 hash of the certificate. | | [SignerCertChainThumbprintSHA256](#signercertchainthumbprintsha256-property-ipworkssmime_smime-class) | The SHA-256 hash of the certificate. | | [SignerCertChainUsage](#signercertchainusage-property-ipworkssmime_smime-class) | The text description of UsageFlags . | | [SignerCertChainUsageFlags](#signercertchainusageflags-property-ipworkssmime_smime-class) | The flags that show intended use for the certificate. | | [SignerCertChainVersion](#signercertchainversion-property-ipworkssmime_smime-class) | The certificate's version number. | | [SignerCertChainSubject](#signercertchainsubject-property-ipworkssmime_smime-class) | The subject of the certificate used for client authentication. | | [SignerCertChainEncoded](#signercertchainencoded-property-ipworkssmime_smime-class) | The certificate (PEM/Base64 encoded). | | [SigningAlgorithm](#signingalgorithm-property-ipworkssmime_smime-class) | This property includes a textual description of the signature hash algorithm. | | [UseOAEP](#useoaep-property-ipworkssmime_smime-class) | This property specifies whether or not to use Optimal Asymmetric Encryption Padding (OAEP). | | [UsePSS](#usepss-property-ipworkssmime_smime-class) | This property specifies whether or not RSA-PSS will be used during signing and verification. | ## Method List *The following is the full list of the methods of the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [AddRecipientCert](#addrecipientcert-method-ipworkssmime_smime-class) | This method is used to add recipient certificates used to encrypt messages. | | [CheckMessageEncrypted](#checkmessageencrypted-method-ipworkssmime_smime-class) | This method checks whether or not the current message is encrypted. | | [CheckMessageSigned](#checkmessagesigned-method-ipworkssmime_smime-class) | This method checks whether or not the current message is signed. | | [Config](#config-method-ipworkssmime_smime-class) | Sets or retrieves a configuration setting. | | [Decrypt](#decrypt-method-ipworkssmime_smime-class) | This method decrypts the current Message . | | [DecryptAndVerifySignature](#decryptandverifysignature-method-ipworkssmime_smime-class) | This method decrypts and verifies the signature of the current message. | | [Encrypt](#encrypt-method-ipworkssmime_smime-class) | This method encrypts the message. | | [GetRecipientInfo](#getrecipientinfo-method-ipworkssmime_smime-class) | This method gets the recipient information for an encrypted message. | | [GetSignerCertInfo](#getsignercertinfo-method-ipworkssmime_smime-class) | This method gets the signature information for an signed message. | | [Reset](#reset-method-ipworkssmime_smime-class) | This method resets the class properties. | | [Sign](#sign-method-ipworkssmime_smime-class) | This method signs the current message. | | [SignAndEncrypt](#signandencrypt-method-ipworkssmime_smime-class) | This method signs and encrypts the current message. | | [VerifySignature](#verifysignature-method-ipworkssmime_smime-class) | This method verifies the signature of the current message. | ## Event List *The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [Error](#error-event-ipworkssmime_smime-class) | Fired when information is available about errors during data delivery. | | [RecipientInfo](#recipientinfo-event-ipworkssmime_smime-class) | This event is fired for each recipient certificate of the encrypted message. | | [SignerCertInfo](#signercertinfo-event-ipworkssmime_smime-class) | This event is fired during verification of the signed message. | ## Config Settings *The following is a list of config settings for the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [ApplyB64Encoding](#ApplyB64Encoding) | Instructs the class to base64 encode the message when signing or encrypting. | | [CSP](#CSP) | The Cryptographic Service Provider. | | [GenerateSignatureTimestamp](#GenerateSignatureTimestamp) | Whether to generate timestamps in signatures. | | [IncludeHeaders](#IncludeHeaders) | Tells the class whether to include the headers when encoding the message. | | [IncludeInternalHeaders](#IncludeInternalHeaders) | Tells the class 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. | | [InputMessageEncrypted](#InputMessageEncrypted) | Whether or not the input message is encrypted. | | [InputMessageSigned](#InputMessageSigned) | Whether or not the input message is signed. | | [NormalizeCRLF](#NormalizeCRLF) | Whether or not the class will normalize line endings of the input data to CrLf. | | [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. | | [ParseInternalHeaders](#ParseInternalHeaders) | Tells the class whether or not to parse the message part headers when decrypting a message. | | [RecipientCert](#RecipientCert) | Used to specify the public certificate when using a PEM key to decrypt. | | [RecipientCertFile](#RecipientCertFile) | Used to specify the public certificate file when using a PEM key to decrypt. | | [RecipientInfoType](#RecipientInfoType) | The type of signer information to include 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. | | [UseCryptoAPI](#UseCryptoAPI) | Whether to use the Microsoft Crypto API for cryptographic message generation. | | [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. | | [ProcessIdleEvents](#ProcessIdleEvents) | Whether the class uses its internal event loop to process events when the main thread is idle. | | [SelectWaitMillis](#SelectWaitMillis) | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. | | [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. | # CertEffectiveDate Property ([IPWorksSMIME_SMIME](#smime-class) Class) The date on which this certificate becomes valid. ## Object Oriented Interface ```text public function getCertEffectiveDate(); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 1 ); ``` ## Default Value '' ## Remarks The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2000 15:00:00. This property is read-only. ## Data Type String # CertExpirationDate Property ([IPWorksSMIME_SMIME](#smime-class) Class) The date on which the certificate expires. ## Object Oriented Interface ```text public function getCertExpirationDate(); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 2 ); ``` ## Default Value '' ## Remarks The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2001 15:00:00. This property is read-only. ## Data Type String # CertExtendedKeyUsage Property ([IPWorksSMIME_SMIME](#smime-class) Class) A comma-delimited list of extended key usage identifiers. ## Object Oriented Interface ```text public function getCertExtendedKeyUsage(); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 3 ); ``` ## Default Value '' ## Remarks A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). This property is read-only. ## Data Type String # CertFingerprint Property ([IPWorksSMIME_SMIME](#smime-class) Class) The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Object Oriented Interface ```text public function getCertFingerprint(); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 4 ); ``` ## Default Value '' ## Remarks The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02* This property is read-only. ## Data Type String # CertFingerprintSHA1 Property ([IPWorksSMIME_SMIME](#smime-class) Class) The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Object Oriented Interface ```text public function getCertFingerprintSHA1(); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 5 ); ``` ## Default Value '' ## Remarks The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84* This property is read-only. ## Data Type String # CertFingerprintSHA256 Property ([IPWorksSMIME_SMIME](#smime-class) Class) The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Object Oriented Interface ```text public function getCertFingerprintSHA256(); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 6 ); ``` ## Default Value '' ## Remarks The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53* This property is read-only. ## Data Type String # CertIssuer Property ([IPWorksSMIME_SMIME](#smime-class) Class) The issuer of the certificate. ## Object Oriented Interface ```text public function getCertIssuer(); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 7 ); ``` ## Default Value '' ## Remarks The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate. This property is read-only. ## Data Type String # CertPrivateKey Property ([IPWorksSMIME_SMIME](#smime-class) Class) The private key of the certificate (if available). ## Object Oriented Interface ```text public function getCertPrivateKey(); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 8 ); ``` ## Default Value '' ## Remarks The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [CertPrivateKey](#certprivatekey-property-ipworkssmime_smime-class) may be available but not exportable. In this case, [CertPrivateKey](#certprivatekey-property-ipworkssmime_smime-class) returns an empty string. This property is read-only. ## Data Type String # CertPrivateKeyAvailable Property ([IPWorksSMIME_SMIME](#smime-class) Class) Whether a PrivateKey is available for the selected certificate. ## Object Oriented Interface ```text public function getCertPrivateKeyAvailable(); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 9 ); ``` ## Default Value false ## Remarks Whether a [CertPrivateKey](#certprivatekey-property-ipworkssmime_smime-class) is available for the selected certificate. If [CertPrivateKeyAvailable](#certprivatekeyavailable-property-ipworkssmime_smime-class) is True, the certificate may be used for authentication purposes (e.g., server authentication). This property is read-only. ## Data Type Boolean # CertPrivateKeyContainer Property ([IPWorksSMIME_SMIME](#smime-class) Class) The name of the PrivateKey container for the certificate (if available). ## Object Oriented Interface ```text public function getCertPrivateKeyContainer(); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 10 ); ``` ## Default Value '' ## Remarks The name of the [CertPrivateKey](#certprivatekey-property-ipworkssmime_smime-class) container for the certificate (if available). This functionality is available only on Windows platforms. This property is read-only. ## Data Type String # CertPublicKey Property ([IPWorksSMIME_SMIME](#smime-class) Class) The public key of the certificate. ## Object Oriented Interface ```text public function getCertPublicKey(); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 11 ); ``` ## Default Value '' ## Remarks The public key of the certificate. The key is provided as PEM/Base64-encoded data. This property is read-only. ## Data Type String # CertPublicKeyAlgorithm Property ([IPWorksSMIME_SMIME](#smime-class) Class) The textual description of the certificate's public key algorithm. ## Object Oriented Interface ```text public function getCertPublicKeyAlgorithm(); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 12 ); ``` ## Default Value '' ## Remarks The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm. This property is read-only. ## Data Type String # CertPublicKeyLength Property ([IPWorksSMIME_SMIME](#smime-class) Class) The length of the certificate's public key (in bits). ## Object Oriented Interface ```text public function getCertPublicKeyLength(); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 13 ); ``` ## Default Value 0 ## Remarks The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. This property is read-only. ## Data Type Integer # CertSerialNumber Property ([IPWorksSMIME_SMIME](#smime-class) Class) The serial number of the certificate encoded as a string. ## Object Oriented Interface ```text public function getCertSerialNumber(); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 14 ); ``` ## Default Value '' ## Remarks The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number. This property is read-only. ## Data Type String # CertSignatureAlgorithm Property ([IPWorksSMIME_SMIME](#smime-class) Class) The text description of the certificate's signature algorithm. ## Object Oriented Interface ```text public function getCertSignatureAlgorithm(); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 15 ); ``` ## Default Value '' ## Remarks The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm. This property is read-only. ## Data Type String # CertStore Property ([IPWorksSMIME_SMIME](#smime-class) Class) The name of the certificate store for the client certificate. ## Object Oriented Interface ```text public function getCertStore(); public function setCertStore($value); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 16 ); ipworkssmime_smime_set($res, 16, $value ); ``` ## Default Value 'MY' ## Remarks The name of the certificate store for the client certificate. The [CertStoreType](#certstoretype-property-ipworkssmime_smime-class) property denotes the type of the certificate store specified by [CertStore](#certstore-property-ipworkssmime_smime-class). If the store is password-protected, specify the password in [CertStorePassword](#certstorepassword-property-ipworkssmime_smime-class). [CertStore](#certstore-property-ipworkssmime_smime-class) is used in conjunction with the [CertSubject](#certsubject-property-ipworkssmime_smime-class) property to specify client certificates. If [CertStore](#certstore-property-ipworkssmime_smime-class) has a value, and [CertSubject](#certsubject-property-ipworkssmime_smime-class) or [CertEncoded](#certencoded-property-ipworkssmime_smime-class) is set, a search for a certificate is initiated. Please see the [CertSubject](#certsubject-property-ipworkssmime_smime-class) property for details. Designations of certificate stores are platform dependent. The following designations are the most common User and Machine certificate stores in Windows: | | | | --- | --- | | MY | A certificate store holding personal certificates with their associated private keys. | | CA | Certifying authority certificates. | | ROOT | Root certificates. | When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store). ## Data Type Binary String # CertStorePassword Property ([IPWorksSMIME_SMIME](#smime-class) Class) If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Object Oriented Interface ```text public function getCertStorePassword(); public function setCertStorePassword($value); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 17 ); ipworkssmime_smime_set($res, 17, $value ); ``` ## Default Value '' ## Remarks If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Data Type String # CertStoreType Property ([IPWorksSMIME_SMIME](#smime-class) Class) The type of certificate store for this certificate. ## Object Oriented Interface ```text public function getCertStoreType(); public function setCertStoreType($value); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 18 ); ipworkssmime_smime_set($res, 18, $value ); ``` ## Possible Values ```text SMIME_CERTSTORETYPE_USER(0), SMIME_CERTSTORETYPE_MACHINE(1), SMIME_CERTSTORETYPE_PFXFILE(2), SMIME_CERTSTORETYPE_PFXBLOB(3), SMIME_CERTSTORETYPE_JKSFILE(4), SMIME_CERTSTORETYPE_JKSBLOB(5), SMIME_CERTSTORETYPE_PEMKEY_FILE(6), SMIME_CERTSTORETYPE_PEMKEY_BLOB(7), SMIME_CERTSTORETYPE_PUBLIC_KEY_FILE(8), SMIME_CERTSTORETYPE_PUBLIC_KEY_BLOB(9), SMIME_CERTSTORETYPE_SSHPUBLIC_KEY_BLOB(10), SMIME_CERTSTORETYPE_P7BFILE(11), SMIME_CERTSTORETYPE_P7BBLOB(12), SMIME_CERTSTORETYPE_SSHPUBLIC_KEY_FILE(13), SMIME_CERTSTORETYPE_PPKFILE(14), SMIME_CERTSTORETYPE_PPKBLOB(15), SMIME_CERTSTORETYPE_XMLFILE(16), SMIME_CERTSTORETYPE_XMLBLOB(17), SMIME_CERTSTORETYPE_JWKFILE(18), SMIME_CERTSTORETYPE_JWKBLOB(19), SMIME_CERTSTORETYPE_SECURITY_KEY(20), SMIME_CERTSTORETYPE_BCFKSFILE(21), SMIME_CERTSTORETYPE_BCFKSBLOB(22), SMIME_CERTSTORETYPE_PKCS11(23), SMIME_CERTSTORETYPE_AUTO(99) ``` ## Default Value 0 ## Remarks The type of certificate store for this certificate. The class supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the class will automatically determine the type. This property can take one of the following values: ```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 [CertStoreType](#certstoretype-property-ipworkssmime_smime-class), the full path of the PKCS#11 DLL as the [CertStore](#certstore-property-ipworkssmime_smime-class), and the PIN as the [CertStorePassword](#certstorepassword-property-ipworkssmime_smime-class). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) class by calling the [ListStoreCertificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](#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 [CertStore](#certstore-property-ipworkssmime_smime-class) and set [CertStorePassword](#certstorepassword-property-ipworkssmime_smime-class) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. | ## Data Type Integer # CertSubjectAltNames Property ([IPWorksSMIME_SMIME](#smime-class) Class) Comma-separated lists of alternative subject names for the certificate. ## Object Oriented Interface ```text public function getCertSubjectAltNames(); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 19 ); ``` ## Default Value '' ## Remarks Comma-separated lists of alternative subject names for the certificate. This property is read-only. ## Data Type String # CertThumbprintMD5 Property ([IPWorksSMIME_SMIME](#smime-class) Class) The MD5 hash of the certificate. ## Object Oriented Interface ```text public function getCertThumbprintMD5(); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 20 ); ``` ## Default Value '' ## Remarks The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. ## Data Type String # CertThumbprintSHA1 Property ([IPWorksSMIME_SMIME](#smime-class) Class) The SHA-1 hash of the certificate. ## Object Oriented Interface ```text public function getCertThumbprintSHA1(); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 21 ); ``` ## Default Value '' ## Remarks The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. ## Data Type String # CertThumbprintSHA256 Property ([IPWorksSMIME_SMIME](#smime-class) Class) The SHA-256 hash of the certificate. ## Object Oriented Interface ```text public function getCertThumbprintSHA256(); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 22 ); ``` ## Default Value '' ## Remarks The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. ## Data Type String # CertUsage Property ([IPWorksSMIME_SMIME](#smime-class) Class) The text description of UsageFlags . ## Object Oriented Interface ```text public function getCertUsage(); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 23 ); ``` ## Default Value '' ## Remarks The text description of [CertUsageFlags](#certusageflags-property-ipworkssmime_smime-class). This value will be one or more of the following strings and will be separated by commas: - Digital Signature - Non-Repudiation - Key Encipherment - Data Encipherment - Key Agreement - Certificate Signing - CRL Signing - Encipher Only If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names. This property is read-only. ## Data Type String # CertUsageFlags Property ([IPWorksSMIME_SMIME](#smime-class) Class) The flags that show intended use for the certificate. ## Object Oriented Interface ```text public function getCertUsageFlags(); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 24 ); ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [CertUsageFlags](#certusageflags-property-ipworkssmime_smime-class) 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 [CertUsage](#certusage-property-ipworkssmime_smime-class) property for a text representation of [CertUsageFlags](#certusageflags-property-ipworkssmime_smime-class). This functionality currently is not available when the provider is OpenSSL. This property is read-only. ## Data Type Integer # CertVersion Property ([IPWorksSMIME_SMIME](#smime-class) Class) The certificate's version number. ## Object Oriented Interface ```text public function getCertVersion(); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 25 ); ``` ## Default Value '' ## Remarks The certificate's version number. The possible values are the strings "V1", "V2", and "V3". This property is read-only. ## Data Type String # CertSubject Property ([IPWorksSMIME_SMIME](#smime-class) Class) The subject of the certificate used for client authentication. ## Object Oriented Interface ```text public function getCertSubject(); public function setCertSubject($value); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 26 ); ipworkssmime_smime_set($res, 26, $value ); ``` ## Default Value '' ## Remarks The subject of the certificate used for client authentication. This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject. If a matching certificate is found, the property is set to the full subject of the matching certificate. If an exact match is not found, the store is searched for subjects containing the value of the property. If a match is still not found, the property is set to an empty string, and no certificate is selected. The special value "*" picks a random certificate in the certificate store. The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows: | Field | Meaning | | --- | --- | | CN | Common Name. This is commonly a hostname like www.server.com. | | O | Organization | | OU | Organizational Unit | | L | Locality | | S | State | | C | Country | | E | Email Address | If a field value contains a comma, it must be quoted. ## Data Type String # CertEncoded Property ([IPWorksSMIME_SMIME](#smime-class) Class) The certificate (PEM/Base64 encoded). ## Object Oriented Interface ```text public function getCertEncoded(); public function setCertEncoded($value); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 27 ); ipworkssmime_smime_set($res, 27, $value ); ``` ## Default Value '' ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [CertStore](#certstore-property-ipworkssmime_smime-class) and [CertSubject](#certsubject-property-ipworkssmime_smime-class) properties also may be used to specify a certificate. When [CertEncoded](#certencoded-property-ipworkssmime_smime-class) is set, a search is initiated in the current [CertStore](#certstore-property-ipworkssmime_smime-class) for the private key of the certificate. If the key is found, [CertSubject](#certsubject-property-ipworkssmime_smime-class) is updated to reflect the full subject of the selected certificate; otherwise, [CertSubject](#certsubject-property-ipworkssmime_smime-class) is set to an empty string. This property is not available at design time. ## Data Type Binary String # DetachedSignature Property ([IPWorksSMIME_SMIME](#smime-class) Class) This property specifies whether to include a detached signature when signing a message. ## Object Oriented Interface ```text public function getDetachedSignature(); public function setDetachedSignature($value); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 28 ); ipworkssmime_smime_set($res, 28, $value ); ``` ## Default Value true ## Remarks This property specifies whether to include a detached signature when signing a message. If the value of this property is True, Message will be encoded as a multipart/signed MIME message with a detached signature when calling [Sign](#sign-method-ipworkssmime_smime-class). This will create a message with two MIME parts, one with the contents of Message, and another with the detached signature. If this property is False, the current contents of Message will be PKCS encoded and included with the signature in Message. This will create a single-part message with no MIME boundaries. ## Data Type Boolean # EncryptingAlgorithm Property ([IPWorksSMIME_SMIME](#smime-class) Class) The property includes textual description of the encrypting algorithm. ## Object Oriented Interface ```text public function getEncryptingAlgorithm(); public function setEncryptingAlgorithm($value); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 29 ); ipworkssmime_smime_set($res, 29, $value ); ``` ## Default Value '3DES' ## Remarks This property contains either the name of the algorithm (such as *3DES* or *AES*), or an object identifier (OID) string representing the algorithm. Possible values are as follows: - "3DES" - "DES" - "RC2CBC40" - "RC2CBC64" - "RC2CBC128" or "RC2" - "AESCBC128" or "AES" - "AESCBC192" - "AESCBC256" - "AESGCM128" or "AESGCM" - "AESGCM192" - "AESGCM256" ## Data Type String # IncludeCertificate Property ([IPWorksSMIME_SMIME](#smime-class) Class) This property specifies whether to include the signer's certificate with the signed message. ## Object Oriented Interface ```text public function getIncludeCertificate(); public function setIncludeCertificate($value); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 30 ); ipworkssmime_smime_set($res, 30, $value ); ``` ## Default Value true ## Remarks If this property is set to True, the certificate used to sign the message will be encoded and included in a message signature when calling [Sign](#sign-method-ipworkssmime_smime-class) or [SignAndEncrypt](#signandencrypt-method-ipworkssmime_smime-class). Including a certificate is the preferred method of building signed messages. If you do not include a certificate, the message recipient may not be able to verify the sender's signature. ## Data Type Boolean # IncludeChain Property ([IPWorksSMIME_SMIME](#smime-class) Class) This property specifies whether to include the signer's certificate chain with the signed message. ## Object Oriented Interface ```text public function getIncludeChain(); public function setIncludeChain($value); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 31 ); ipworkssmime_smime_set($res, 31, $value ); ``` ## Default Value false ## Remarks If this property is set to True, the entire certificate's chain that was used to sign the message will be encoded and included in the message signature when calling [Sign](#sign-method-ipworkssmime_smime-class) or [SignAndEncrypt](#signandencrypt-method-ipworkssmime_smime-class). NOTE: To include the chain, the [IncludeCertificate](#includecertificate-property-ipworkssmime_smime-class) property must also be set to true. ## Data Type Boolean # IncludeHeaders Property ([IPWorksSMIME_SMIME](#smime-class) Class) This property tells the class whether to include the headers when encoding the message. ## Object Oriented Interface ```text public function getIncludeHeaders(); public function setIncludeHeaders($value); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 32 ); ipworkssmime_smime_set($res, 32, $value ); ``` ## Default Value false ## Remarks If True, the class will include the headers when [Sign](#sign-method-ipworkssmime_smime-class), [Encrypt](#encrypt-method-ipworkssmime_smime-class), or [SignAndEncrypt](#signandencrypt-method-ipworkssmime_smime-class) are called. If False, only the message will be encoded. The default value for IncludeHeaders is False. ## Data Type Boolean # InputFile Property ([IPWorksSMIME_SMIME](#smime-class) Class) This property includes the file to process. ## Object Oriented Interface ```text public function getInputFile(); public function setInputFile($value); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 33 ); ipworkssmime_smime_set($res, 33, $value ); ``` ## Default Value '' ## Remarks This property specifies the file to be processed. Set this property to the full or relative path to the file that 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 fully encoded S/MIME message. **Input and Output Properties** The class 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: - InputFile - [InputMessage](#inputmessage-property-ipworkssmime_smime-class) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [OutputFile](#outputfile-property-ipworkssmime_smime-class) - [OutputMessage](#outputmessage-property-ipworkssmime_smime-class): The output data is written to this property if no other destination is specified. The headers of the input message (if any) will be read from InputMessageHeaders or [InputMessageHeadersString](#inputmessageheadersstring-property-ipworkssmime_smime-class). ## Data Type String # InputMessage Property ([IPWorksSMIME_SMIME](#smime-class) Class) This property includes the message to process. ## Object Oriented Interface ```text public function getInputMessage(); public function setInputMessage($value); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 34 ); ipworkssmime_smime_set($res, 34, $value ); ``` ## 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 fully encoded S/MIME message. **Input and Output Properties** The class 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: - [InputFile](#inputfile-property-ipworkssmime_smime-class) - InputMessage When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [OutputFile](#outputfile-property-ipworkssmime_smime-class) - [OutputMessage](#outputmessage-property-ipworkssmime_smime-class): The output data is written to this property if no other destination is specified. The headers of the input message (if any) will be read from InputMessageHeaders or [InputMessageHeadersString](#inputmessageheadersstring-property-ipworkssmime_smime-class). ## Data Type Binary String # InputMessageHeaderCount Property ([IPWorksSMIME_SMIME](#smime-class) Class) The number of records in the InputMessageHeader arrays. ## Object Oriented Interface ```text public function getInputMessageHeaderCount(); public function setInputMessageHeaderCount($value); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 35 ); ipworkssmime_smime_set($res, 35, $value ); ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [InputMessageHeaderField](#inputmessageheaderfield-property-ipworkssmime_smime-class) - [InputMessageHeaderValue](#inputmessageheadervalue-property-ipworkssmime_smime-class) The array indices start at *0* and end at *InputMessageHeaderCount - 1*. This property is not available at design time. ## Data Type Integer # InputMessageHeaderField Property ([IPWorksSMIME_SMIME](#smime-class) Class) This property contains the name of the HTTP header (this is the same case as it is delivered). ## Object Oriented Interface ```text public function getInputMessageHeaderField($inputmessageheaderindex); public function setInputMessageHeaderField($inputmessageheaderindex, $value); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 36 , $inputmessageheaderindex); ipworkssmime_smime_set($res, 36, $value , $inputmessageheaderindex); ``` ## Default Value '' ## Remarks This property contains the name of the HTTP [Header](#Type_Header) (this is the same case as it is delivered). The *$inputmessageheaderindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [InputMessageHeaderCount](#inputmessageheadercount-property-ipworkssmime_smime-class) property. This property is not available at design time. ## Data Type String # InputMessageHeaderValue Property ([IPWorksSMIME_SMIME](#smime-class) Class) This property contains the header contents. ## Object Oriented Interface ```text public function getInputMessageHeaderValue($inputmessageheaderindex); public function setInputMessageHeaderValue($inputmessageheaderindex, $value); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 37 , $inputmessageheaderindex); ipworkssmime_smime_set($res, 37, $value , $inputmessageheaderindex); ``` ## Default Value '' ## Remarks This property contains the [Header](#Type_Header) contents. The *$inputmessageheaderindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [InputMessageHeaderCount](#inputmessageheadercount-property-ipworkssmime_smime-class) property. This property is not available at design time. ## Data Type String # InputMessageHeadersString Property ([IPWorksSMIME_SMIME](#smime-class) Class) This property includes the string version of headers from the S/MIME message. ## Object Oriented Interface ```text public function getInputMessageHeadersString(); public function setInputMessageHeadersString($value); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 38 ); ipworkssmime_smime_set($res, 38, $value ); ``` ## Default Value '' ## Remarks This property contains the string version of headers from the S/MIME message. This property may be set to the headers of the message that will be decrypted/verified. ## Data Type String # InternalHeaders Property ([IPWorksSMIME_SMIME](#smime-class) Class) This property includes the headers of the MIME entity inside the encrypted or signed message. ## Object Oriented Interface ```text public function getInternalHeaders(); public function setInternalHeaders($value); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 39 ); ipworkssmime_smime_set($res, 39, $value ); ``` ## Default Value '' ## Remarks After an encryption, decryption, signing, or verification operation is completed, this property shows the headers of the encrypted or signed message part. This property is not available at design time. ## Data Type String # OutputFile Property ([IPWorksSMIME_SMIME](#smime-class) Class) This property specifies the output file. ## Object Oriented Interface ```text public function getOutputFile(); public function setOutputFile($value); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 40 ); ipworkssmime_smime_set($res, 40, $value ); ``` ## 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 fully encoded S/MIME 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 class 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: - [InputFile](#inputfile-property-ipworkssmime_smime-class) - [InputMessage](#inputmessage-property-ipworkssmime_smime-class) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - OutputFile - [OutputMessage](#outputmessage-property-ipworkssmime_smime-class): The output data is written to this property if no other destination is specified. The headers of the resulting message will be available in the OutputMessageHeaders and [OutputMessageHeadersString](#outputmessageheadersstring-property-ipworkssmime_smime-class) properties. ## Data Type String # OutputMessage Property ([IPWorksSMIME_SMIME](#smime-class) Class) This property includes the output message after processing. ## Object Oriented Interface ```text public function getOutputMessage(); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 41 ); ``` ## Default Value '' ## Remarks This property will be populated with the output of the operation if [OutputFile](#outputfile-property-ipworkssmime_smime-class) is not set. **Encrypt and/or Sign** When encrypting or signing, this will hold the fully encoded S/MIME message. **Decrypt and/or Verify** When decrypting or verifying a signature, this will hold the decrypted/verified content. **Input and Output Properties** The class 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: - [InputFile](#inputfile-property-ipworkssmime_smime-class) - [InputMessage](#inputmessage-property-ipworkssmime_smime-class) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [OutputFile](#outputfile-property-ipworkssmime_smime-class) - OutputMessage: The output data is written to this property if no other destination is specified. The headers of the resulting message will be available in the OutputMessageHeaders and [OutputMessageHeadersString](#outputmessageheadersstring-property-ipworkssmime_smime-class) properties. This property is read-only. ## Data Type Binary String # OutputMessageHeaderCount Property ([IPWorksSMIME_SMIME](#smime-class) Class) The number of records in the OutputMessageHeader arrays. ## Object Oriented Interface ```text public function getOutputMessageHeaderCount(); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 42 ); ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [OutputMessageHeaderField](#outputmessageheaderfield-property-ipworkssmime_smime-class) - [OutputMessageHeaderValue](#outputmessageheadervalue-property-ipworkssmime_smime-class) The array indices start at *0* and end at *OutputMessageHeaderCount - 1*. This property is read-only and not available at design time. ## Data Type Integer # OutputMessageHeaderField Property ([IPWorksSMIME_SMIME](#smime-class) Class) This property contains the name of the HTTP header (this is the same case as it is delivered). ## Object Oriented Interface ```text public function getOutputMessageHeaderField($outputmessageheaderindex); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 43 , $outputmessageheaderindex); ``` ## Default Value '' ## Remarks This property contains the name of the HTTP [Header](#Type_Header) (this is the same case as it is delivered). The *$outputmessageheaderindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [OutputMessageHeaderCount](#outputmessageheadercount-property-ipworkssmime_smime-class) property. This property is read-only and not available at design time. ## Data Type String # OutputMessageHeaderValue Property ([IPWorksSMIME_SMIME](#smime-class) Class) This property contains the header contents. ## Object Oriented Interface ```text public function getOutputMessageHeaderValue($outputmessageheaderindex); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 44 , $outputmessageheaderindex); ``` ## Default Value '' ## Remarks This property contains the [Header](#Type_Header) contents. The *$outputmessageheaderindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [OutputMessageHeaderCount](#outputmessageheadercount-property-ipworkssmime_smime-class) property. This property is read-only and not available at design time. ## Data Type String # OutputMessageHeadersString Property ([IPWorksSMIME_SMIME](#smime-class) Class) This property includes a string version of headers from the S/MIME message. ## Object Oriented Interface ```text public function getOutputMessageHeadersString(); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 45 ); ``` ## Default Value '' ## Remarks This property contains the string version of headers from the S/MIME message. The class will populate this property after signing and/or encrypting. The user should use these additional headers when emailing or sending the [OutputMessage](#outputmessage-property-ipworkssmime_smime-class). This can be done by including these headers in the *OtherHeaders* property of the class that you wish to send the message with. After the decryption or verification, this property contains the headers of the verified or decrypted message. This property is read-only. ## Data Type String # Overwrite Property ([IPWorksSMIME_SMIME](#smime-class) Class) This property indicates whether or not the class should overwrite files. ## Object Oriented Interface ```text public function getOverwrite(); public function setOverwrite($value); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 46 ); ipworkssmime_smime_set($res, 46, $value ); ``` ## Default Value true ## Remarks This property indicates whether or not the class will overwrite [OutputFile](#outputfile-property-ipworkssmime_smime-class). If Overwrite is False, an error will be thrown whenever [OutputFile](#outputfile-property-ipworkssmime_smime-class) exists before an operation. The default value is False. ## Data Type Boolean # RecipientCertCount Property ([IPWorksSMIME_SMIME](#smime-class) Class) The number of records in the RecipientCert arrays. ## Object Oriented Interface ```text public function getRecipientCertCount(); public function setRecipientCertCount($value); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 47 ); ipworkssmime_smime_set($res, 47, $value ); ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [RecipientCertEffectiveDate](#recipientcerteffectivedate-property-ipworkssmime_smime-class) - [RecipientCertEncoded](#recipientcertencoded-property-ipworkssmime_smime-class) - [RecipientCertExpirationDate](#recipientcertexpirationdate-property-ipworkssmime_smime-class) - [RecipientCertExtendedKeyUsage](#recipientcertextendedkeyusage-property-ipworkssmime_smime-class) - [RecipientCertFingerprint](#recipientcertfingerprint-property-ipworkssmime_smime-class) - [RecipientCertFingerprintSHA1](#recipientcertfingerprintsha1-property-ipworkssmime_smime-class) - [RecipientCertFingerprintSHA256](#recipientcertfingerprintsha256-property-ipworkssmime_smime-class) - [RecipientCertIssuer](#recipientcertissuer-property-ipworkssmime_smime-class) - [RecipientCertPrivateKey](#recipientcertprivatekey-property-ipworkssmime_smime-class) - [RecipientCertPrivateKeyAvailable](#recipientcertprivatekeyavailable-property-ipworkssmime_smime-class) - [RecipientCertPrivateKeyContainer](#recipientcertprivatekeycontainer-property-ipworkssmime_smime-class) - [RecipientCertPublicKey](#recipientcertpublickey-property-ipworkssmime_smime-class) - [RecipientCertPublicKeyAlgorithm](#recipientcertpublickeyalgorithm-property-ipworkssmime_smime-class) - [RecipientCertPublicKeyLength](#recipientcertpublickeylength-property-ipworkssmime_smime-class) - [RecipientCertSerialNumber](#recipientcertserialnumber-property-ipworkssmime_smime-class) - [RecipientCertSignatureAlgorithm](#recipientcertsignaturealgorithm-property-ipworkssmime_smime-class) - [RecipientCertStore](#recipientcertstore-property-ipworkssmime_smime-class) - [RecipientCertStorePassword](#recipientcertstorepassword-property-ipworkssmime_smime-class) - [RecipientCertStoreType](#recipientcertstoretype-property-ipworkssmime_smime-class) - [RecipientCertSubject](#recipientcertsubject-property-ipworkssmime_smime-class) - [RecipientCertSubjectAltNames](#recipientcertsubjectaltnames-property-ipworkssmime_smime-class) - [RecipientCertThumbprintMD5](#recipientcertthumbprintmd5-property-ipworkssmime_smime-class) - [RecipientCertThumbprintSHA1](#recipientcertthumbprintsha1-property-ipworkssmime_smime-class) - [RecipientCertThumbprintSHA256](#recipientcertthumbprintsha256-property-ipworkssmime_smime-class) - [RecipientCertUsage](#recipientcertusage-property-ipworkssmime_smime-class) - [RecipientCertUsageFlags](#recipientcertusageflags-property-ipworkssmime_smime-class) - [RecipientCertVersion](#recipientcertversion-property-ipworkssmime_smime-class) The array indices start at *0* and end at *RecipientCertCount - 1*. This property is not available at design time. ## Data Type Integer # RecipientCertEffectiveDate Property ([IPWorksSMIME_SMIME](#smime-class) Class) The date on which this certificate becomes valid. ## Object Oriented Interface ```text public function getRecipientCertEffectiveDate($recipientcertindex); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 48 , $recipientcertindex); ``` ## 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](#recipientcertcount-property-ipworkssmime_smime-class) property. This property is read-only and not available at design time. ## Data Type String # RecipientCertExpirationDate Property ([IPWorksSMIME_SMIME](#smime-class) Class) The date on which the certificate expires. ## Object Oriented Interface ```text public function getRecipientCertExpirationDate($recipientcertindex); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 49 , $recipientcertindex); ``` ## 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](#recipientcertcount-property-ipworkssmime_smime-class) property. This property is read-only and not available at design time. ## Data Type String # RecipientCertExtendedKeyUsage Property ([IPWorksSMIME_SMIME](#smime-class) Class) A comma-delimited list of extended key usage identifiers. ## Object Oriented Interface ```text public function getRecipientCertExtendedKeyUsage($recipientcertindex); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 50 , $recipientcertindex); ``` ## 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](#recipientcertcount-property-ipworkssmime_smime-class) property. This property is read-only and not available at design time. ## Data Type String # RecipientCertFingerprint Property ([IPWorksSMIME_SMIME](#smime-class) Class) The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Object Oriented Interface ```text public function getRecipientCertFingerprint($recipientcertindex); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 51 , $recipientcertindex); ``` ## 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](#recipientcertcount-property-ipworkssmime_smime-class) property. This property is read-only and not available at design time. ## Data Type String # RecipientCertFingerprintSHA1 Property ([IPWorksSMIME_SMIME](#smime-class) Class) The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Object Oriented Interface ```text public function getRecipientCertFingerprintSHA1($recipientcertindex); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 52 , $recipientcertindex); ``` ## 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](#recipientcertcount-property-ipworkssmime_smime-class) property. This property is read-only and not available at design time. ## Data Type String # RecipientCertFingerprintSHA256 Property ([IPWorksSMIME_SMIME](#smime-class) Class) The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Object Oriented Interface ```text public function getRecipientCertFingerprintSHA256($recipientcertindex); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 53 , $recipientcertindex); ``` ## 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](#recipientcertcount-property-ipworkssmime_smime-class) property. This property is read-only and not available at design time. ## Data Type String # RecipientCertIssuer Property ([IPWorksSMIME_SMIME](#smime-class) Class) The issuer of the certificate. ## Object Oriented Interface ```text public function getRecipientCertIssuer($recipientcertindex); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 54 , $recipientcertindex); ``` ## 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](#recipientcertcount-property-ipworkssmime_smime-class) property. This property is read-only and not available at design time. ## Data Type String # RecipientCertPrivateKey Property ([IPWorksSMIME_SMIME](#smime-class) Class) The private key of the certificate (if available). ## Object Oriented Interface ```text public function getRecipientCertPrivateKey($recipientcertindex); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 55 , $recipientcertindex); ``` ## Default Value '' ## Remarks The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [RecipientCertPrivateKey](#recipientcertprivatekey-property-ipworkssmime_smime-class) may be available but not exportable. In this case, [RecipientCertPrivateKey](#recipientcertprivatekey-property-ipworkssmime_smime-class) 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](#recipientcertcount-property-ipworkssmime_smime-class) property. This property is read-only and not available at design time. ## Data Type String # RecipientCertPrivateKeyAvailable Property ([IPWorksSMIME_SMIME](#smime-class) Class) Whether a PrivateKey is available for the selected certificate. ## Object Oriented Interface ```text public function getRecipientCertPrivateKeyAvailable($recipientcertindex); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 56 , $recipientcertindex); ``` ## Default Value false ## Remarks Whether a [RecipientCertPrivateKey](#recipientcertprivatekey-property-ipworkssmime_smime-class) is available for the selected certificate. If [RecipientCertPrivateKeyAvailable](#recipientcertprivatekeyavailable-property-ipworkssmime_smime-class) 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](#recipientcertcount-property-ipworkssmime_smime-class) property. This property is read-only and not available at design time. ## Data Type Boolean # RecipientCertPrivateKeyContainer Property ([IPWorksSMIME_SMIME](#smime-class) Class) The name of the PrivateKey container for the certificate (if available). ## Object Oriented Interface ```text public function getRecipientCertPrivateKeyContainer($recipientcertindex); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 57 , $recipientcertindex); ``` ## Default Value '' ## Remarks The name of the [RecipientCertPrivateKey](#recipientcertprivatekey-property-ipworkssmime_smime-class) 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](#recipientcertcount-property-ipworkssmime_smime-class) property. This property is read-only and not available at design time. ## Data Type String # RecipientCertPublicKey Property ([IPWorksSMIME_SMIME](#smime-class) Class) The public key of the certificate. ## Object Oriented Interface ```text public function getRecipientCertPublicKey($recipientcertindex); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 58 , $recipientcertindex); ``` ## 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](#recipientcertcount-property-ipworkssmime_smime-class) property. This property is read-only and not available at design time. ## Data Type String # RecipientCertPublicKeyAlgorithm Property ([IPWorksSMIME_SMIME](#smime-class) Class) The textual description of the certificate's public key algorithm. ## Object Oriented Interface ```text public function getRecipientCertPublicKeyAlgorithm($recipientcertindex); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 59 , $recipientcertindex); ``` ## 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](#recipientcertcount-property-ipworkssmime_smime-class) property. This property is read-only and not available at design time. ## Data Type String # RecipientCertPublicKeyLength Property ([IPWorksSMIME_SMIME](#smime-class) Class) The length of the certificate's public key (in bits). ## Object Oriented Interface ```text public function getRecipientCertPublicKeyLength($recipientcertindex); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 60 , $recipientcertindex); ``` ## 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](#recipientcertcount-property-ipworkssmime_smime-class) property. This property is read-only and not available at design time. ## Data Type Integer # RecipientCertSerialNumber Property ([IPWorksSMIME_SMIME](#smime-class) Class) The serial number of the certificate encoded as a string. ## Object Oriented Interface ```text public function getRecipientCertSerialNumber($recipientcertindex); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 61 , $recipientcertindex); ``` ## 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](#recipientcertcount-property-ipworkssmime_smime-class) property. This property is read-only and not available at design time. ## Data Type String # RecipientCertSignatureAlgorithm Property ([IPWorksSMIME_SMIME](#smime-class) Class) The text description of the certificate's signature algorithm. ## Object Oriented Interface ```text public function getRecipientCertSignatureAlgorithm($recipientcertindex); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 62 , $recipientcertindex); ``` ## 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](#recipientcertcount-property-ipworkssmime_smime-class) property. This property is read-only and not available at design time. ## Data Type String # RecipientCertStore Property ([IPWorksSMIME_SMIME](#smime-class) Class) The name of the certificate store for the client certificate. ## Object Oriented Interface ```text public function getRecipientCertStore($recipientcertindex); public function setRecipientCertStore($recipientcertindex, $value); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 63 , $recipientcertindex); ipworkssmime_smime_set($res, 63, $value , $recipientcertindex); ``` ## Default Value 'MY' ## Remarks The name of the certificate store for the client certificate. The [RecipientCertStoreType](#recipientcertstoretype-property-ipworkssmime_smime-class) property denotes the type of the certificate store specified by [RecipientCertStore](#recipientcertstore-property-ipworkssmime_smime-class). If the store is password-protected, specify the password in [RecipientCertStorePassword](#recipientcertstorepassword-property-ipworkssmime_smime-class). [RecipientCertStore](#recipientcertstore-property-ipworkssmime_smime-class) is used in conjunction with the [RecipientCertSubject](#recipientcertsubject-property-ipworkssmime_smime-class) property to specify client certificates. If [RecipientCertStore](#recipientcertstore-property-ipworkssmime_smime-class) has a value, and [RecipientCertSubject](#recipientcertsubject-property-ipworkssmime_smime-class) or [RecipientCertEncoded](#recipientcertencoded-property-ipworkssmime_smime-class) is set, a search for a certificate is initiated. Please see the [RecipientCertSubject](#recipientcertsubject-property-ipworkssmime_smime-class) 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](#recipientcertcount-property-ipworkssmime_smime-class) property. This property is not available at design time. ## Data Type Binary String # RecipientCertStorePassword Property ([IPWorksSMIME_SMIME](#smime-class) Class) If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Object Oriented Interface ```text public function getRecipientCertStorePassword($recipientcertindex); public function setRecipientCertStorePassword($recipientcertindex, $value); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 64 , $recipientcertindex); ipworkssmime_smime_set($res, 64, $value , $recipientcertindex); ``` ## 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](#recipientcertcount-property-ipworkssmime_smime-class) property. This property is not available at design time. ## Data Type String # RecipientCertStoreType Property ([IPWorksSMIME_SMIME](#smime-class) Class) The type of certificate store for this certificate. ## Object Oriented Interface ```text public function getRecipientCertStoreType($recipientcertindex); public function setRecipientCertStoreType($recipientcertindex, $value); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 65 , $recipientcertindex); ipworkssmime_smime_set($res, 65, $value , $recipientcertindex); ``` ## Possible Values ```text SMIME_RECIPIENTCERTSTORETYPE_USER(0), SMIME_RECIPIENTCERTSTORETYPE_MACHINE(1), SMIME_RECIPIENTCERTSTORETYPE_PFXFILE(2), SMIME_RECIPIENTCERTSTORETYPE_PFXBLOB(3), SMIME_RECIPIENTCERTSTORETYPE_JKSFILE(4), SMIME_RECIPIENTCERTSTORETYPE_JKSBLOB(5), SMIME_RECIPIENTCERTSTORETYPE_PEMKEY_FILE(6), SMIME_RECIPIENTCERTSTORETYPE_PEMKEY_BLOB(7), SMIME_RECIPIENTCERTSTORETYPE_PUBLIC_KEY_FILE(8), SMIME_RECIPIENTCERTSTORETYPE_PUBLIC_KEY_BLOB(9), SMIME_RECIPIENTCERTSTORETYPE_SSHPUBLIC_KEY_BLOB(10), SMIME_RECIPIENTCERTSTORETYPE_P7BFILE(11), SMIME_RECIPIENTCERTSTORETYPE_P7BBLOB(12), SMIME_RECIPIENTCERTSTORETYPE_SSHPUBLIC_KEY_FILE(13), SMIME_RECIPIENTCERTSTORETYPE_PPKFILE(14), SMIME_RECIPIENTCERTSTORETYPE_PPKBLOB(15), SMIME_RECIPIENTCERTSTORETYPE_XMLFILE(16), SMIME_RECIPIENTCERTSTORETYPE_XMLBLOB(17), SMIME_RECIPIENTCERTSTORETYPE_JWKFILE(18), SMIME_RECIPIENTCERTSTORETYPE_JWKBLOB(19), SMIME_RECIPIENTCERTSTORETYPE_SECURITY_KEY(20), SMIME_RECIPIENTCERTSTORETYPE_BCFKSFILE(21), SMIME_RECIPIENTCERTSTORETYPE_BCFKSBLOB(22), SMIME_RECIPIENTCERTSTORETYPE_PKCS11(23), SMIME_RECIPIENTCERTSTORETYPE_AUTO(99) ``` ## Default Value 0 ## Remarks The type of certificate store for this certificate. The class supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the class will automatically determine the type. This property can take one of the following values: ```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 [RecipientCertStoreType](#recipientcertstoretype-property-ipworkssmime_smime-class), the full path of the PKCS#11 DLL as the [RecipientCertStore](#recipientcertstore-property-ipworkssmime_smime-class), and the PIN as the [RecipientCertStorePassword](#recipientcertstorepassword-property-ipworkssmime_smime-class). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) class by calling the [ListStoreCertificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](#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 [RecipientCertStore](#recipientcertstore-property-ipworkssmime_smime-class) and set [RecipientCertStorePassword](#recipientcertstorepassword-property-ipworkssmime_smime-class) 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](#recipientcertcount-property-ipworkssmime_smime-class) property. This property is not available at design time. ## Data Type Integer # RecipientCertSubjectAltNames Property ([IPWorksSMIME_SMIME](#smime-class) Class) Comma-separated lists of alternative subject names for the certificate. ## Object Oriented Interface ```text public function getRecipientCertSubjectAltNames($recipientcertindex); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 66 , $recipientcertindex); ``` ## 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](#recipientcertcount-property-ipworkssmime_smime-class) property. This property is read-only and not available at design time. ## Data Type String # RecipientCertThumbprintMD5 Property ([IPWorksSMIME_SMIME](#smime-class) Class) The MD5 hash of the certificate. ## Object Oriented Interface ```text public function getRecipientCertThumbprintMD5($recipientcertindex); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 67 , $recipientcertindex); ``` ## 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](#recipientcertcount-property-ipworkssmime_smime-class) property. This property is read-only and not available at design time. ## Data Type String # RecipientCertThumbprintSHA1 Property ([IPWorksSMIME_SMIME](#smime-class) Class) The SHA-1 hash of the certificate. ## Object Oriented Interface ```text public function getRecipientCertThumbprintSHA1($recipientcertindex); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 68 , $recipientcertindex); ``` ## 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](#recipientcertcount-property-ipworkssmime_smime-class) property. This property is read-only and not available at design time. ## Data Type String # RecipientCertThumbprintSHA256 Property ([IPWorksSMIME_SMIME](#smime-class) Class) The SHA-256 hash of the certificate. ## Object Oriented Interface ```text public function getRecipientCertThumbprintSHA256($recipientcertindex); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 69 , $recipientcertindex); ``` ## 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](#recipientcertcount-property-ipworkssmime_smime-class) property. This property is read-only and not available at design time. ## Data Type String # RecipientCertUsage Property ([IPWorksSMIME_SMIME](#smime-class) Class) The text description of UsageFlags . ## Object Oriented Interface ```text public function getRecipientCertUsage($recipientcertindex); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 70 , $recipientcertindex); ``` ## Default Value '' ## Remarks The text description of [RecipientCertUsageFlags](#recipientcertusageflags-property-ipworkssmime_smime-class). 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](#recipientcertcount-property-ipworkssmime_smime-class) property. This property is read-only and not available at design time. ## Data Type String # RecipientCertUsageFlags Property ([IPWorksSMIME_SMIME](#smime-class) Class) The flags that show intended use for the certificate. ## Object Oriented Interface ```text public function getRecipientCertUsageFlags($recipientcertindex); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 71 , $recipientcertindex); ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [RecipientCertUsageFlags](#recipientcertusageflags-property-ipworkssmime_smime-class) 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 [RecipientCertUsage](#recipientcertusage-property-ipworkssmime_smime-class) property for a text representation of [RecipientCertUsageFlags](#recipientcertusageflags-property-ipworkssmime_smime-class). 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](#recipientcertcount-property-ipworkssmime_smime-class) property. This property is read-only and not available at design time. ## Data Type Integer # RecipientCertVersion Property ([IPWorksSMIME_SMIME](#smime-class) Class) The certificate's version number. ## Object Oriented Interface ```text public function getRecipientCertVersion($recipientcertindex); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 72 , $recipientcertindex); ``` ## 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](#recipientcertcount-property-ipworkssmime_smime-class) property. This property is read-only and not available at design time. ## Data Type String # RecipientCertSubject Property ([IPWorksSMIME_SMIME](#smime-class) Class) The subject of the certificate used for client authentication. ## Object Oriented Interface ```text public function getRecipientCertSubject($recipientcertindex); public function setRecipientCertSubject($recipientcertindex, $value); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 73 , $recipientcertindex); ipworkssmime_smime_set($res, 73, $value , $recipientcertindex); ``` ## 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](#recipientcertcount-property-ipworkssmime_smime-class) property. This property is not available at design time. ## Data Type String # RecipientCertEncoded Property ([IPWorksSMIME_SMIME](#smime-class) Class) The certificate (PEM/Base64 encoded). ## Object Oriented Interface ```text public function getRecipientCertEncoded($recipientcertindex); public function setRecipientCertEncoded($recipientcertindex, $value); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 74 , $recipientcertindex); ipworkssmime_smime_set($res, 74, $value , $recipientcertindex); ``` ## Default Value '' ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [RecipientCertStore](#recipientcertstore-property-ipworkssmime_smime-class) and [RecipientCertSubject](#recipientcertsubject-property-ipworkssmime_smime-class) properties also may be used to specify a certificate. When [RecipientCertEncoded](#recipientcertencoded-property-ipworkssmime_smime-class) is set, a search is initiated in the current [RecipientCertStore](#recipientcertstore-property-ipworkssmime_smime-class) for the private key of the certificate. If the key is found, [RecipientCertSubject](#recipientcertsubject-property-ipworkssmime_smime-class) is updated to reflect the full subject of the selected certificate; otherwise, [RecipientCertSubject](#recipientcertsubject-property-ipworkssmime_smime-class) 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](#recipientcertcount-property-ipworkssmime_smime-class) property. This property is not available at design time. ## Data Type Binary String # SignerCertEffectiveDate Property ([IPWorksSMIME_SMIME](#smime-class) Class) The date on which this certificate becomes valid. ## Object Oriented Interface ```text public function getSignerCertEffectiveDate(); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 75 ); ``` ## Default Value '' ## Remarks The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2000 15:00:00. This property is read-only. ## Data Type String # SignerCertExpirationDate Property ([IPWorksSMIME_SMIME](#smime-class) Class) The date on which the certificate expires. ## Object Oriented Interface ```text public function getSignerCertExpirationDate(); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 76 ); ``` ## Default Value '' ## Remarks The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2001 15:00:00. This property is read-only. ## Data Type String # SignerCertExtendedKeyUsage Property ([IPWorksSMIME_SMIME](#smime-class) Class) A comma-delimited list of extended key usage identifiers. ## Object Oriented Interface ```text public function getSignerCertExtendedKeyUsage(); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 77 ); ``` ## Default Value '' ## Remarks A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). This property is read-only. ## Data Type String # SignerCertFingerprint Property ([IPWorksSMIME_SMIME](#smime-class) Class) The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Object Oriented Interface ```text public function getSignerCertFingerprint(); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 78 ); ``` ## Default Value '' ## Remarks The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02* This property is read-only. ## Data Type String # SignerCertFingerprintSHA1 Property ([IPWorksSMIME_SMIME](#smime-class) Class) The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Object Oriented Interface ```text public function getSignerCertFingerprintSHA1(); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 79 ); ``` ## Default Value '' ## Remarks The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84* This property is read-only. ## Data Type String # SignerCertFingerprintSHA256 Property ([IPWorksSMIME_SMIME](#smime-class) Class) The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Object Oriented Interface ```text public function getSignerCertFingerprintSHA256(); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 80 ); ``` ## Default Value '' ## Remarks The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53* This property is read-only. ## Data Type String # SignerCertIssuer Property ([IPWorksSMIME_SMIME](#smime-class) Class) The issuer of the certificate. ## Object Oriented Interface ```text public function getSignerCertIssuer(); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 81 ); ``` ## Default Value '' ## Remarks The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate. This property is read-only. ## Data Type String # SignerCertPrivateKey Property ([IPWorksSMIME_SMIME](#smime-class) Class) The private key of the certificate (if available). ## Object Oriented Interface ```text public function getSignerCertPrivateKey(); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 82 ); ``` ## Default Value '' ## Remarks The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [SignerCertPrivateKey](#signercertprivatekey-property-ipworkssmime_smime-class) may be available but not exportable. In this case, [SignerCertPrivateKey](#signercertprivatekey-property-ipworkssmime_smime-class) returns an empty string. This property is read-only. ## Data Type String # SignerCertPrivateKeyAvailable Property ([IPWorksSMIME_SMIME](#smime-class) Class) Whether a PrivateKey is available for the selected certificate. ## Object Oriented Interface ```text public function getSignerCertPrivateKeyAvailable(); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 83 ); ``` ## Default Value false ## Remarks Whether a [SignerCertPrivateKey](#signercertprivatekey-property-ipworkssmime_smime-class) is available for the selected certificate. If [SignerCertPrivateKeyAvailable](#signercertprivatekeyavailable-property-ipworkssmime_smime-class) is True, the certificate may be used for authentication purposes (e.g., server authentication). This property is read-only. ## Data Type Boolean # SignerCertPrivateKeyContainer Property ([IPWorksSMIME_SMIME](#smime-class) Class) The name of the PrivateKey container for the certificate (if available). ## Object Oriented Interface ```text public function getSignerCertPrivateKeyContainer(); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 84 ); ``` ## Default Value '' ## Remarks The name of the [SignerCertPrivateKey](#signercertprivatekey-property-ipworkssmime_smime-class) container for the certificate (if available). This functionality is available only on Windows platforms. This property is read-only. ## Data Type String # SignerCertPublicKey Property ([IPWorksSMIME_SMIME](#smime-class) Class) The public key of the certificate. ## Object Oriented Interface ```text public function getSignerCertPublicKey(); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 85 ); ``` ## Default Value '' ## Remarks The public key of the certificate. The key is provided as PEM/Base64-encoded data. This property is read-only. ## Data Type String # SignerCertPublicKeyAlgorithm Property ([IPWorksSMIME_SMIME](#smime-class) Class) The textual description of the certificate's public key algorithm. ## Object Oriented Interface ```text public function getSignerCertPublicKeyAlgorithm(); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 86 ); ``` ## Default Value '' ## Remarks The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm. This property is read-only. ## Data Type String # SignerCertPublicKeyLength Property ([IPWorksSMIME_SMIME](#smime-class) Class) The length of the certificate's public key (in bits). ## Object Oriented Interface ```text public function getSignerCertPublicKeyLength(); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 87 ); ``` ## Default Value 0 ## Remarks The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. This property is read-only. ## Data Type Integer # SignerCertSerialNumber Property ([IPWorksSMIME_SMIME](#smime-class) Class) The serial number of the certificate encoded as a string. ## Object Oriented Interface ```text public function getSignerCertSerialNumber(); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 88 ); ``` ## Default Value '' ## Remarks The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number. This property is read-only. ## Data Type String # SignerCertSignatureAlgorithm Property ([IPWorksSMIME_SMIME](#smime-class) Class) The text description of the certificate's signature algorithm. ## Object Oriented Interface ```text public function getSignerCertSignatureAlgorithm(); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 89 ); ``` ## Default Value '' ## Remarks The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm. This property is read-only. ## Data Type String # SignerCertStore Property ([IPWorksSMIME_SMIME](#smime-class) Class) The name of the certificate store for the client certificate. ## Object Oriented Interface ```text public function getSignerCertStore(); public function setSignerCertStore($value); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 90 ); ipworkssmime_smime_set($res, 90, $value ); ``` ## Default Value 'MY' ## Remarks The name of the certificate store for the client certificate. The [SignerCertStoreType](#signercertstoretype-property-ipworkssmime_smime-class) property denotes the type of the certificate store specified by [SignerCertStore](#signercertstore-property-ipworkssmime_smime-class). If the store is password-protected, specify the password in [SignerCertStorePassword](#signercertstorepassword-property-ipworkssmime_smime-class). [SignerCertStore](#signercertstore-property-ipworkssmime_smime-class) is used in conjunction with the [SignerCertSubject](#signercertsubject-property-ipworkssmime_smime-class) property to specify client certificates. If [SignerCertStore](#signercertstore-property-ipworkssmime_smime-class) has a value, and [SignerCertSubject](#signercertsubject-property-ipworkssmime_smime-class) or [SignerCertEncoded](#signercertencoded-property-ipworkssmime_smime-class) is set, a search for a certificate is initiated. Please see the [SignerCertSubject](#signercertsubject-property-ipworkssmime_smime-class) property for details. Designations of certificate stores are platform dependent. The following designations are the most common User and Machine certificate stores in Windows: | | | | --- | --- | | MY | A certificate store holding personal certificates with their associated private keys. | | CA | Certifying authority certificates. | | ROOT | Root certificates. | When the certificate store type is *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store). ## Data Type Binary String # SignerCertStorePassword Property ([IPWorksSMIME_SMIME](#smime-class) Class) If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Object Oriented Interface ```text public function getSignerCertStorePassword(); public function setSignerCertStorePassword($value); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 91 ); ipworkssmime_smime_set($res, 91, $value ); ``` ## Default Value '' ## Remarks If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Data Type String # SignerCertStoreType Property ([IPWorksSMIME_SMIME](#smime-class) Class) The type of certificate store for this certificate. ## Object Oriented Interface ```text public function getSignerCertStoreType(); public function setSignerCertStoreType($value); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 92 ); ipworkssmime_smime_set($res, 92, $value ); ``` ## Possible Values ```text SMIME_SIGNERCERTSTORETYPE_USER(0), SMIME_SIGNERCERTSTORETYPE_MACHINE(1), SMIME_SIGNERCERTSTORETYPE_PFXFILE(2), SMIME_SIGNERCERTSTORETYPE_PFXBLOB(3), SMIME_SIGNERCERTSTORETYPE_JKSFILE(4), SMIME_SIGNERCERTSTORETYPE_JKSBLOB(5), SMIME_SIGNERCERTSTORETYPE_PEMKEY_FILE(6), SMIME_SIGNERCERTSTORETYPE_PEMKEY_BLOB(7), SMIME_SIGNERCERTSTORETYPE_PUBLIC_KEY_FILE(8), SMIME_SIGNERCERTSTORETYPE_PUBLIC_KEY_BLOB(9), SMIME_SIGNERCERTSTORETYPE_SSHPUBLIC_KEY_BLOB(10), SMIME_SIGNERCERTSTORETYPE_P7BFILE(11), SMIME_SIGNERCERTSTORETYPE_P7BBLOB(12), SMIME_SIGNERCERTSTORETYPE_SSHPUBLIC_KEY_FILE(13), SMIME_SIGNERCERTSTORETYPE_PPKFILE(14), SMIME_SIGNERCERTSTORETYPE_PPKBLOB(15), SMIME_SIGNERCERTSTORETYPE_XMLFILE(16), SMIME_SIGNERCERTSTORETYPE_XMLBLOB(17), SMIME_SIGNERCERTSTORETYPE_JWKFILE(18), SMIME_SIGNERCERTSTORETYPE_JWKBLOB(19), SMIME_SIGNERCERTSTORETYPE_SECURITY_KEY(20), SMIME_SIGNERCERTSTORETYPE_BCFKSFILE(21), SMIME_SIGNERCERTSTORETYPE_BCFKSBLOB(22), SMIME_SIGNERCERTSTORETYPE_PKCS11(23), SMIME_SIGNERCERTSTORETYPE_AUTO(99) ``` ## Default Value 0 ## Remarks The type of certificate store for this certificate. The class supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the class will automatically determine the type. This property can take one of the following values: ```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 [SignerCertStoreType](#signercertstoretype-property-ipworkssmime_smime-class), the full path of the PKCS#11 DLL as the [SignerCertStore](#signercertstore-property-ipworkssmime_smime-class), and the PIN as the [SignerCertStorePassword](#signercertstorepassword-property-ipworkssmime_smime-class). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) class by calling the [ListStoreCertificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](#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 [SignerCertStore](#signercertstore-property-ipworkssmime_smime-class) and set [SignerCertStorePassword](#signercertstorepassword-property-ipworkssmime_smime-class) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. | ## Data Type Integer # SignerCertSubjectAltNames Property ([IPWorksSMIME_SMIME](#smime-class) Class) Comma-separated lists of alternative subject names for the certificate. ## Object Oriented Interface ```text public function getSignerCertSubjectAltNames(); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 93 ); ``` ## Default Value '' ## Remarks Comma-separated lists of alternative subject names for the certificate. This property is read-only. ## Data Type String # SignerCertThumbprintMD5 Property ([IPWorksSMIME_SMIME](#smime-class) Class) The MD5 hash of the certificate. ## Object Oriented Interface ```text public function getSignerCertThumbprintMD5(); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 94 ); ``` ## Default Value '' ## Remarks The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. ## Data Type String # SignerCertThumbprintSHA1 Property ([IPWorksSMIME_SMIME](#smime-class) Class) The SHA-1 hash of the certificate. ## Object Oriented Interface ```text public function getSignerCertThumbprintSHA1(); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 95 ); ``` ## Default Value '' ## Remarks The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. ## Data Type String # SignerCertThumbprintSHA256 Property ([IPWorksSMIME_SMIME](#smime-class) Class) The SHA-256 hash of the certificate. ## Object Oriented Interface ```text public function getSignerCertThumbprintSHA256(); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 96 ); ``` ## Default Value '' ## Remarks The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. ## Data Type String # SignerCertUsage Property ([IPWorksSMIME_SMIME](#smime-class) Class) The text description of UsageFlags . ## Object Oriented Interface ```text public function getSignerCertUsage(); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 97 ); ``` ## Default Value '' ## Remarks The text description of [SignerCertUsageFlags](#signercertusageflags-property-ipworkssmime_smime-class). This value will be one or more of the following strings and will be separated by commas: - Digital Signature - Non-Repudiation - Key Encipherment - Data Encipherment - Key Agreement - Certificate Signing - CRL Signing - Encipher Only If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names. This property is read-only. ## Data Type String # SignerCertUsageFlags Property ([IPWorksSMIME_SMIME](#smime-class) Class) The flags that show intended use for the certificate. ## Object Oriented Interface ```text public function getSignerCertUsageFlags(); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 98 ); ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [SignerCertUsageFlags](#signercertusageflags-property-ipworkssmime_smime-class) 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 [SignerCertUsage](#signercertusage-property-ipworkssmime_smime-class) property for a text representation of [SignerCertUsageFlags](#signercertusageflags-property-ipworkssmime_smime-class). This functionality currently is not available when the provider is OpenSSL. This property is read-only. ## Data Type Integer # SignerCertVersion Property ([IPWorksSMIME_SMIME](#smime-class) Class) The certificate's version number. ## Object Oriented Interface ```text public function getSignerCertVersion(); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 99 ); ``` ## Default Value '' ## Remarks The certificate's version number. The possible values are the strings "V1", "V2", and "V3". This property is read-only. ## Data Type String # SignerCertSubject Property ([IPWorksSMIME_SMIME](#smime-class) Class) The subject of the certificate used for client authentication. ## Object Oriented Interface ```text public function getSignerCertSubject(); public function setSignerCertSubject($value); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 100 ); ipworkssmime_smime_set($res, 100, $value ); ``` ## Default Value '' ## Remarks The subject of the certificate used for client authentication. This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject. If a matching certificate is found, the property is set to the full subject of the matching certificate. If an exact match is not found, the store is searched for subjects containing the value of the property. If a match is still not found, the property is set to an empty string, and no certificate is selected. The special value "*" picks a random certificate in the certificate store. The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows: | Field | Meaning | | --- | --- | | CN | Common Name. This is commonly a hostname like www.server.com. | | O | Organization | | OU | Organizational Unit | | L | Locality | | S | State | | C | Country | | E | Email Address | If a field value contains a comma, it must be quoted. ## Data Type String # SignerCertEncoded Property ([IPWorksSMIME_SMIME](#smime-class) Class) The certificate (PEM/Base64 encoded). ## Object Oriented Interface ```text public function getSignerCertEncoded(); public function setSignerCertEncoded($value); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 101 ); ipworkssmime_smime_set($res, 101, $value ); ``` ## Default Value '' ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [SignerCertStore](#signercertstore-property-ipworkssmime_smime-class) and [SignerCertSubject](#signercertsubject-property-ipworkssmime_smime-class) properties also may be used to specify a certificate. When [SignerCertEncoded](#signercertencoded-property-ipworkssmime_smime-class) is set, a search is initiated in the current [SignerCertStore](#signercertstore-property-ipworkssmime_smime-class) for the private key of the certificate. If the key is found, [SignerCertSubject](#signercertsubject-property-ipworkssmime_smime-class) is updated to reflect the full subject of the selected certificate; otherwise, [SignerCertSubject](#signercertsubject-property-ipworkssmime_smime-class) is set to an empty string. This property is not available at design time. ## Data Type Binary String # SignerCertChainCount Property ([IPWorksSMIME_SMIME](#smime-class) Class) The number of records in the SignerCertChain arrays. ## Object Oriented Interface ```text public function getSignerCertChainCount(); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 102 ); ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [SignerCertChainEffectiveDate](#signercertchaineffectivedate-property-ipworkssmime_smime-class) - [SignerCertChainEncoded](#signercertchainencoded-property-ipworkssmime_smime-class) - [SignerCertChainExpirationDate](#signercertchainexpirationdate-property-ipworkssmime_smime-class) - [SignerCertChainExtendedKeyUsage](#signercertchainextendedkeyusage-property-ipworkssmime_smime-class) - [SignerCertChainFingerprint](#signercertchainfingerprint-property-ipworkssmime_smime-class) - [SignerCertChainFingerprintSHA1](#signercertchainfingerprintsha1-property-ipworkssmime_smime-class) - [SignerCertChainFingerprintSHA256](#signercertchainfingerprintsha256-property-ipworkssmime_smime-class) - [SignerCertChainIssuer](#signercertchainissuer-property-ipworkssmime_smime-class) - [SignerCertChainPrivateKey](#signercertchainprivatekey-property-ipworkssmime_smime-class) - [SignerCertChainPrivateKeyAvailable](#signercertchainprivatekeyavailable-property-ipworkssmime_smime-class) - [SignerCertChainPrivateKeyContainer](#signercertchainprivatekeycontainer-property-ipworkssmime_smime-class) - [SignerCertChainPublicKey](#signercertchainpublickey-property-ipworkssmime_smime-class) - [SignerCertChainPublicKeyAlgorithm](#signercertchainpublickeyalgorithm-property-ipworkssmime_smime-class) - [SignerCertChainPublicKeyLength](#signercertchainpublickeylength-property-ipworkssmime_smime-class) - [SignerCertChainSerialNumber](#signercertchainserialnumber-property-ipworkssmime_smime-class) - [SignerCertChainSignatureAlgorithm](#signercertchainsignaturealgorithm-property-ipworkssmime_smime-class) - [SignerCertChainStore](#signercertchainstore-property-ipworkssmime_smime-class) - [SignerCertChainStorePassword](#signercertchainstorepassword-property-ipworkssmime_smime-class) - [SignerCertChainStoreType](#signercertchainstoretype-property-ipworkssmime_smime-class) - [SignerCertChainSubject](#signercertchainsubject-property-ipworkssmime_smime-class) - [SignerCertChainSubjectAltNames](#signercertchainsubjectaltnames-property-ipworkssmime_smime-class) - [SignerCertChainThumbprintMD5](#signercertchainthumbprintmd5-property-ipworkssmime_smime-class) - [SignerCertChainThumbprintSHA1](#signercertchainthumbprintsha1-property-ipworkssmime_smime-class) - [SignerCertChainThumbprintSHA256](#signercertchainthumbprintsha256-property-ipworkssmime_smime-class) - [SignerCertChainUsage](#signercertchainusage-property-ipworkssmime_smime-class) - [SignerCertChainUsageFlags](#signercertchainusageflags-property-ipworkssmime_smime-class) - [SignerCertChainVersion](#signercertchainversion-property-ipworkssmime_smime-class) The array indices start at *0* and end at *SignerCertChainCount - 1*. This property is read-only and not available at design time. ## Data Type Integer # SignerCertChainEffectiveDate Property ([IPWorksSMIME_SMIME](#smime-class) Class) The date on which this certificate becomes valid. ## Object Oriented Interface ```text public function getSignerCertChainEffectiveDate($signercertchainindex); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 103 , $signercertchainindex); ``` ## 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 *$signercertchainindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertChainCount](#signercertchaincount-property-ipworkssmime_smime-class) property. This property is read-only and not available at design time. ## Data Type String # SignerCertChainExpirationDate Property ([IPWorksSMIME_SMIME](#smime-class) Class) The date on which the certificate expires. ## Object Oriented Interface ```text public function getSignerCertChainExpirationDate($signercertchainindex); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 104 , $signercertchainindex); ``` ## 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 *$signercertchainindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertChainCount](#signercertchaincount-property-ipworkssmime_smime-class) property. This property is read-only and not available at design time. ## Data Type String # SignerCertChainExtendedKeyUsage Property ([IPWorksSMIME_SMIME](#smime-class) Class) A comma-delimited list of extended key usage identifiers. ## Object Oriented Interface ```text public function getSignerCertChainExtendedKeyUsage($signercertchainindex); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 105 , $signercertchainindex); ``` ## Default Value '' ## Remarks A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). The *$signercertchainindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertChainCount](#signercertchaincount-property-ipworkssmime_smime-class) property. This property is read-only and not available at design time. ## Data Type String # SignerCertChainFingerprint Property ([IPWorksSMIME_SMIME](#smime-class) Class) The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Object Oriented Interface ```text public function getSignerCertChainFingerprint($signercertchainindex); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 106 , $signercertchainindex); ``` ## 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 *$signercertchainindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertChainCount](#signercertchaincount-property-ipworkssmime_smime-class) property. This property is read-only and not available at design time. ## Data Type String # SignerCertChainFingerprintSHA1 Property ([IPWorksSMIME_SMIME](#smime-class) Class) The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Object Oriented Interface ```text public function getSignerCertChainFingerprintSHA1($signercertchainindex); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 107 , $signercertchainindex); ``` ## 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 *$signercertchainindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertChainCount](#signercertchaincount-property-ipworkssmime_smime-class) property. This property is read-only and not available at design time. ## Data Type String # SignerCertChainFingerprintSHA256 Property ([IPWorksSMIME_SMIME](#smime-class) Class) The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Object Oriented Interface ```text public function getSignerCertChainFingerprintSHA256($signercertchainindex); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 108 , $signercertchainindex); ``` ## 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 *$signercertchainindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertChainCount](#signercertchaincount-property-ipworkssmime_smime-class) property. This property is read-only and not available at design time. ## Data Type String # SignerCertChainIssuer Property ([IPWorksSMIME_SMIME](#smime-class) Class) The issuer of the certificate. ## Object Oriented Interface ```text public function getSignerCertChainIssuer($signercertchainindex); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 109 , $signercertchainindex); ``` ## 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 *$signercertchainindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertChainCount](#signercertchaincount-property-ipworkssmime_smime-class) property. This property is read-only and not available at design time. ## Data Type String # SignerCertChainPrivateKey Property ([IPWorksSMIME_SMIME](#smime-class) Class) The private key of the certificate (if available). ## Object Oriented Interface ```text public function getSignerCertChainPrivateKey($signercertchainindex); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 110 , $signercertchainindex); ``` ## Default Value '' ## Remarks The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [SignerCertChainPrivateKey](#signercertchainprivatekey-property-ipworkssmime_smime-class) may be available but not exportable. In this case, [SignerCertChainPrivateKey](#signercertchainprivatekey-property-ipworkssmime_smime-class) returns an empty string. The *$signercertchainindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertChainCount](#signercertchaincount-property-ipworkssmime_smime-class) property. This property is read-only and not available at design time. ## Data Type String # SignerCertChainPrivateKeyAvailable Property ([IPWorksSMIME_SMIME](#smime-class) Class) Whether a PrivateKey is available for the selected certificate. ## Object Oriented Interface ```text public function getSignerCertChainPrivateKeyAvailable($signercertchainindex); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 111 , $signercertchainindex); ``` ## Default Value false ## Remarks Whether a [SignerCertChainPrivateKey](#signercertchainprivatekey-property-ipworkssmime_smime-class) is available for the selected certificate. If [SignerCertChainPrivateKeyAvailable](#signercertchainprivatekeyavailable-property-ipworkssmime_smime-class) is True, the certificate may be used for authentication purposes (e.g., server authentication). The *$signercertchainindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertChainCount](#signercertchaincount-property-ipworkssmime_smime-class) property. This property is read-only and not available at design time. ## Data Type Boolean # SignerCertChainPrivateKeyContainer Property ([IPWorksSMIME_SMIME](#smime-class) Class) The name of the PrivateKey container for the certificate (if available). ## Object Oriented Interface ```text public function getSignerCertChainPrivateKeyContainer($signercertchainindex); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 112 , $signercertchainindex); ``` ## Default Value '' ## Remarks The name of the [SignerCertChainPrivateKey](#signercertchainprivatekey-property-ipworkssmime_smime-class) container for the certificate (if available). This functionality is available only on Windows platforms. The *$signercertchainindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertChainCount](#signercertchaincount-property-ipworkssmime_smime-class) property. This property is read-only and not available at design time. ## Data Type String # SignerCertChainPublicKey Property ([IPWorksSMIME_SMIME](#smime-class) Class) The public key of the certificate. ## Object Oriented Interface ```text public function getSignerCertChainPublicKey($signercertchainindex); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 113 , $signercertchainindex); ``` ## Default Value '' ## Remarks The public key of the certificate. The key is provided as PEM/Base64-encoded data. The *$signercertchainindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertChainCount](#signercertchaincount-property-ipworkssmime_smime-class) property. This property is read-only and not available at design time. ## Data Type String # SignerCertChainPublicKeyAlgorithm Property ([IPWorksSMIME_SMIME](#smime-class) Class) The textual description of the certificate's public key algorithm. ## Object Oriented Interface ```text public function getSignerCertChainPublicKeyAlgorithm($signercertchainindex); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 114 , $signercertchainindex); ``` ## 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 *$signercertchainindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertChainCount](#signercertchaincount-property-ipworkssmime_smime-class) property. This property is read-only and not available at design time. ## Data Type String # SignerCertChainPublicKeyLength Property ([IPWorksSMIME_SMIME](#smime-class) Class) The length of the certificate's public key (in bits). ## Object Oriented Interface ```text public function getSignerCertChainPublicKeyLength($signercertchainindex); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 115 , $signercertchainindex); ``` ## Default Value 0 ## Remarks The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. The *$signercertchainindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertChainCount](#signercertchaincount-property-ipworkssmime_smime-class) property. This property is read-only and not available at design time. ## Data Type Integer # SignerCertChainSerialNumber Property ([IPWorksSMIME_SMIME](#smime-class) Class) The serial number of the certificate encoded as a string. ## Object Oriented Interface ```text public function getSignerCertChainSerialNumber($signercertchainindex); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 116 , $signercertchainindex); ``` ## 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 *$signercertchainindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertChainCount](#signercertchaincount-property-ipworkssmime_smime-class) property. This property is read-only and not available at design time. ## Data Type String # SignerCertChainSignatureAlgorithm Property ([IPWorksSMIME_SMIME](#smime-class) Class) The text description of the certificate's signature algorithm. ## Object Oriented Interface ```text public function getSignerCertChainSignatureAlgorithm($signercertchainindex); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 117 , $signercertchainindex); ``` ## 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 *$signercertchainindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertChainCount](#signercertchaincount-property-ipworkssmime_smime-class) property. This property is read-only and not available at design time. ## Data Type String # SignerCertChainStore Property ([IPWorksSMIME_SMIME](#smime-class) Class) The name of the certificate store for the client certificate. ## Object Oriented Interface ```text public function getSignerCertChainStore($signercertchainindex); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 118 , $signercertchainindex); ``` ## Default Value 'MY' ## Remarks The name of the certificate store for the client certificate. The [SignerCertChainStoreType](#signercertchainstoretype-property-ipworkssmime_smime-class) property denotes the type of the certificate store specified by [SignerCertChainStore](#signercertchainstore-property-ipworkssmime_smime-class). If the store is password-protected, specify the password in [SignerCertChainStorePassword](#signercertchainstorepassword-property-ipworkssmime_smime-class). [SignerCertChainStore](#signercertchainstore-property-ipworkssmime_smime-class) is used in conjunction with the [SignerCertChainSubject](#signercertchainsubject-property-ipworkssmime_smime-class) property to specify client certificates. If [SignerCertChainStore](#signercertchainstore-property-ipworkssmime_smime-class) has a value, and [SignerCertChainSubject](#signercertchainsubject-property-ipworkssmime_smime-class) or [SignerCertChainEncoded](#signercertchainencoded-property-ipworkssmime_smime-class) is set, a search for a certificate is initiated. Please see the [SignerCertChainSubject](#signercertchainsubject-property-ipworkssmime_smime-class) 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 *$signercertchainindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertChainCount](#signercertchaincount-property-ipworkssmime_smime-class) property. This property is read-only and not available at design time. ## Data Type Binary String # SignerCertChainStorePassword Property ([IPWorksSMIME_SMIME](#smime-class) Class) If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. ## Object Oriented Interface ```text public function getSignerCertChainStorePassword($signercertchainindex); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 119 , $signercertchainindex); ``` ## 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 *$signercertchainindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertChainCount](#signercertchaincount-property-ipworkssmime_smime-class) property. This property is read-only and not available at design time. ## Data Type String # SignerCertChainStoreType Property ([IPWorksSMIME_SMIME](#smime-class) Class) The type of certificate store for this certificate. ## Object Oriented Interface ```text public function getSignerCertChainStoreType($signercertchainindex); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 120 , $signercertchainindex); ``` ## Possible Values ```text SMIME_SIGNERCERTCHAINSTORETYPE_USER(0), SMIME_SIGNERCERTCHAINSTORETYPE_MACHINE(1), SMIME_SIGNERCERTCHAINSTORETYPE_PFXFILE(2), SMIME_SIGNERCERTCHAINSTORETYPE_PFXBLOB(3), SMIME_SIGNERCERTCHAINSTORETYPE_JKSFILE(4), SMIME_SIGNERCERTCHAINSTORETYPE_JKSBLOB(5), SMIME_SIGNERCERTCHAINSTORETYPE_PEMKEY_FILE(6), SMIME_SIGNERCERTCHAINSTORETYPE_PEMKEY_BLOB(7), SMIME_SIGNERCERTCHAINSTORETYPE_PUBLIC_KEY_FILE(8), SMIME_SIGNERCERTCHAINSTORETYPE_PUBLIC_KEY_BLOB(9), SMIME_SIGNERCERTCHAINSTORETYPE_SSHPUBLIC_KEY_BLOB(10), SMIME_SIGNERCERTCHAINSTORETYPE_P7BFILE(11), SMIME_SIGNERCERTCHAINSTORETYPE_P7BBLOB(12), SMIME_SIGNERCERTCHAINSTORETYPE_SSHPUBLIC_KEY_FILE(13), SMIME_SIGNERCERTCHAINSTORETYPE_PPKFILE(14), SMIME_SIGNERCERTCHAINSTORETYPE_PPKBLOB(15), SMIME_SIGNERCERTCHAINSTORETYPE_XMLFILE(16), SMIME_SIGNERCERTCHAINSTORETYPE_XMLBLOB(17), SMIME_SIGNERCERTCHAINSTORETYPE_JWKFILE(18), SMIME_SIGNERCERTCHAINSTORETYPE_JWKBLOB(19), SMIME_SIGNERCERTCHAINSTORETYPE_SECURITY_KEY(20), SMIME_SIGNERCERTCHAINSTORETYPE_BCFKSFILE(21), SMIME_SIGNERCERTCHAINSTORETYPE_BCFKSBLOB(22), SMIME_SIGNERCERTCHAINSTORETYPE_PKCS11(23), SMIME_SIGNERCERTCHAINSTORETYPE_AUTO(99) ``` ## Default Value 0 ## Remarks The type of certificate store for this certificate. The class supports both public and private keys in a variety of formats. When the *cstAuto* value is used, the class will automatically determine the type. This property can take one of the following values: ```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 [SignerCertChainStoreType](#signercertchainstoretype-property-ipworkssmime_smime-class), the full path of the PKCS#11 DLL as the [SignerCertChainStore](#signercertchainstore-property-ipworkssmime_smime-class), and the PIN as the [SignerCertChainStorePassword](#signercertchainstorepassword-property-ipworkssmime_smime-class). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) class by calling the [ListStoreCertificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](#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 [SignerCertChainStore](#signercertchainstore-property-ipworkssmime_smime-class) and set [SignerCertChainStorePassword](#signercertchainstorepassword-property-ipworkssmime_smime-class) 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 *$signercertchainindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertChainCount](#signercertchaincount-property-ipworkssmime_smime-class) property. This property is read-only and not available at design time. ## Data Type Integer # SignerCertChainSubjectAltNames Property ([IPWorksSMIME_SMIME](#smime-class) Class) Comma-separated lists of alternative subject names for the certificate. ## Object Oriented Interface ```text public function getSignerCertChainSubjectAltNames($signercertchainindex); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 121 , $signercertchainindex); ``` ## Default Value '' ## Remarks Comma-separated lists of alternative subject names for the certificate. The *$signercertchainindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertChainCount](#signercertchaincount-property-ipworkssmime_smime-class) property. This property is read-only and not available at design time. ## Data Type String # SignerCertChainThumbprintMD5 Property ([IPWorksSMIME_SMIME](#smime-class) Class) The MD5 hash of the certificate. ## Object Oriented Interface ```text public function getSignerCertChainThumbprintMD5($signercertchainindex); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 122 , $signercertchainindex); ``` ## 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 *$signercertchainindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertChainCount](#signercertchaincount-property-ipworkssmime_smime-class) property. This property is read-only and not available at design time. ## Data Type String # SignerCertChainThumbprintSHA1 Property ([IPWorksSMIME_SMIME](#smime-class) Class) The SHA-1 hash of the certificate. ## Object Oriented Interface ```text public function getSignerCertChainThumbprintSHA1($signercertchainindex); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 123 , $signercertchainindex); ``` ## 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 *$signercertchainindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertChainCount](#signercertchaincount-property-ipworkssmime_smime-class) property. This property is read-only and not available at design time. ## Data Type String # SignerCertChainThumbprintSHA256 Property ([IPWorksSMIME_SMIME](#smime-class) Class) The SHA-256 hash of the certificate. ## Object Oriented Interface ```text public function getSignerCertChainThumbprintSHA256($signercertchainindex); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 124 , $signercertchainindex); ``` ## 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 *$signercertchainindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertChainCount](#signercertchaincount-property-ipworkssmime_smime-class) property. This property is read-only and not available at design time. ## Data Type String # SignerCertChainUsage Property ([IPWorksSMIME_SMIME](#smime-class) Class) The text description of UsageFlags . ## Object Oriented Interface ```text public function getSignerCertChainUsage($signercertchainindex); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 125 , $signercertchainindex); ``` ## Default Value '' ## Remarks The text description of [SignerCertChainUsageFlags](#signercertchainusageflags-property-ipworkssmime_smime-class). 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 *$signercertchainindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertChainCount](#signercertchaincount-property-ipworkssmime_smime-class) property. This property is read-only and not available at design time. ## Data Type String # SignerCertChainUsageFlags Property ([IPWorksSMIME_SMIME](#smime-class) Class) The flags that show intended use for the certificate. ## Object Oriented Interface ```text public function getSignerCertChainUsageFlags($signercertchainindex); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 126 , $signercertchainindex); ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [SignerCertChainUsageFlags](#signercertchainusageflags-property-ipworkssmime_smime-class) 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 [SignerCertChainUsage](#signercertchainusage-property-ipworkssmime_smime-class) property for a text representation of [SignerCertChainUsageFlags](#signercertchainusageflags-property-ipworkssmime_smime-class). This functionality currently is not available when the provider is OpenSSL. The *$signercertchainindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertChainCount](#signercertchaincount-property-ipworkssmime_smime-class) property. This property is read-only and not available at design time. ## Data Type Integer # SignerCertChainVersion Property ([IPWorksSMIME_SMIME](#smime-class) Class) The certificate's version number. ## Object Oriented Interface ```text public function getSignerCertChainVersion($signercertchainindex); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 127 , $signercertchainindex); ``` ## Default Value '' ## Remarks The certificate's version number. The possible values are the strings "V1", "V2", and "V3". The *$signercertchainindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertChainCount](#signercertchaincount-property-ipworkssmime_smime-class) property. This property is read-only and not available at design time. ## Data Type String # SignerCertChainSubject Property ([IPWorksSMIME_SMIME](#smime-class) Class) The subject of the certificate used for client authentication. ## Object Oriented Interface ```text public function getSignerCertChainSubject($signercertchainindex); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 128 , $signercertchainindex); ``` ## 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 *$signercertchainindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertChainCount](#signercertchaincount-property-ipworkssmime_smime-class) property. This property is read-only and not available at design time. ## Data Type String # SignerCertChainEncoded Property ([IPWorksSMIME_SMIME](#smime-class) Class) The certificate (PEM/Base64 encoded). ## Object Oriented Interface ```text public function getSignerCertChainEncoded($signercertchainindex); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 129 , $signercertchainindex); ``` ## Default Value '' ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [SignerCertChainStore](#signercertchainstore-property-ipworkssmime_smime-class) and [SignerCertChainSubject](#signercertchainsubject-property-ipworkssmime_smime-class) properties also may be used to specify a certificate. When [SignerCertChainEncoded](#signercertchainencoded-property-ipworkssmime_smime-class) is set, a search is initiated in the current [SignerCertChainStore](#signercertchainstore-property-ipworkssmime_smime-class) for the private key of the certificate. If the key is found, [SignerCertChainSubject](#signercertchainsubject-property-ipworkssmime_smime-class) is updated to reflect the full subject of the selected certificate; otherwise, [SignerCertChainSubject](#signercertchainsubject-property-ipworkssmime_smime-class) is set to an empty string. The *$signercertchainindex* parameter specifies the index of the item in the array. The size of the array is controlled by the [SignerCertChainCount](#signercertchaincount-property-ipworkssmime_smime-class) property. This property is read-only and not available at design time. ## Data Type Binary String # SigningAlgorithm Property ([IPWorksSMIME_SMIME](#smime-class) Class) This property includes a textual description of the signature hash algorithm. ## Object Oriented Interface ```text public function getSigningAlgorithm(); public function setSigningAlgorithm($value); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 130 ); ipworkssmime_smime_set($res, 130, $value ); ``` ## Default Value 'SHA256' ## Remarks This property specifies the hash algorithm used to prepare the message digest for signature. This property must contain either the name of the algorithm (such as *MD5* or *SHA1*), or an object Id (OID) string representing the hash algorithm. Possible values are as follows: - sha1 - md5 - sha-256 (default) - sha-384 - sha-512 - sha-224 When read, the value of the property always contains the OID of the algorithm, or an empty string if the algorithm is unknown. ## Data Type String # UseOAEP Property ([IPWorksSMIME_SMIME](#smime-class) Class) This property specifies whether or not to use Optimal Asymmetric Encryption Padding (OAEP). ## Object Oriented Interface ```text public function getUseOAEP(); public function setUseOAEP($value); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 131 ); ipworkssmime_smime_set($res, 131, $value ); ``` ## 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 class will use PKCS1. To specify nondefault OAEP options, please see [OAEPRSAHashAlgorithm](#OAEPRSAHashAlgorithm), [OAEPMGF1HashAlgorithm](#OAEPMGF1HashAlgorithm), and [OAEPParams](#OAEPParams) ## Data Type Boolean # UsePSS Property ([IPWorksSMIME_SMIME](#smime-class) Class) This property specifies whether or not RSA-PSS will be used during signing and verification. ## Object Oriented Interface ```text public function getUsePSS(); public function setUsePSS($value); ``` ## Procedural Interface ```text ipworkssmime_smime_get($res, 132 ); ipworkssmime_smime_set($res, 132, $value ); ``` ## Default Value false ## Remarks This property specifies whether or not RSA-PSS will be used when signing and verifying messages. The default value is False. ## Data Type Boolean # AddRecipientCert Method ([IPWorksSMIME_SMIME](#smime-class) Class) This method is used to add recipient certificates used to encrypt messages. ## Object Oriented Interface ```text public function doAddRecipientCert($certencoded); ``` ## Procedural Interface ```text ipworkssmime_smime_do_addrecipientcert($res, $certencoded); ``` ## Remarks This method is used to add recipient certificates to the internal MessageRecipients properties used to encrypt the Message. The recipient certificate must be a valid PKCS-encoded certificate. If the certificate provided is Base64 encoded, it will be decoded first by the object. The CertMgr class may be used to retrieve the appropriate certificate from the system. # CheckMessageEncrypted Method ([IPWorksSMIME_SMIME](#smime-class) Class) This method checks whether or not the current message is encrypted. ## Object Oriented Interface ```text public function doCheckMessageEncrypted(); ``` ## Procedural Interface ```text ipworkssmime_smime_do_checkmessageencrypted($res); ``` ## Remarks This method is used to check whether or not the current message is encrypted. This method will return True, if the current message appears to be encrypted, according to the value of OutputMessageHeaders. # CheckMessageSigned Method ([IPWorksSMIME_SMIME](#smime-class) Class) This method checks whether or not the current message is signed. ## Object Oriented Interface ```text public function doCheckMessageSigned(); ``` ## Procedural Interface ```text ipworkssmime_smime_do_checkmessagesigned($res); ``` ## Remarks This method is used to check whether or not the current message is signed. This method will return True, if the current message appears to be signed, according to the value of OutputMessageHeaders. NOTE: A message that is both signed and encrypted will not appear to be signed until after it is decrypted. # Config Method ([IPWorksSMIME_SMIME](#smime-class) Class) Sets or retrieves a configuration setting. ## Object Oriented Interface ```text public function doConfig($configurationstring); ``` ## Procedural Interface ```text ipworkssmime_smime_do_config($res, $configurationstring); ``` ## Remarks Config is a generic method available in every class. It is used to set and retrieve [configuration settings](#config-settings-smime-class) for the class. These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these *internal properties* is provided through the Config method. To set a configuration setting named *PROPERTY*, you must call *Config("PROPERTY=VALUE")*, where *VALUE* is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter). To read (query) the value of a [configuration setting](#config-settings-smime-class), you must call *Config("PROPERTY")*. The value will be returned as a string. # Decrypt Method ([IPWorksSMIME_SMIME](#smime-class) Class) This method decrypts the current Message . ## Object Oriented Interface ```text public function doDecrypt(); ``` ## Procedural Interface ```text ipworkssmime_smime_do_decrypt($res); ``` ## Remarks This method takes attempts to decrypt the encrypted message using the certificate in Certificate. **Input and Output Properties** The class 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: - [InputFile](#inputfile-property-ipworkssmime_smime-class) - [InputMessage](#inputmessage-property-ipworkssmime_smime-class) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [OutputFile](#outputfile-property-ipworkssmime_smime-class) - [OutputMessage](#outputmessage-property-ipworkssmime_smime-class): The output data is written to this property if no other destination is specified. The headers of the input message (if any) will be read from InputMessageHeaders or [InputMessageHeadersString](#inputmessageheadersstring-property-ipworkssmime_smime-class). The headers of the resulting message will be available in the OutputMessageHeaders and [OutputMessageHeadersString](#outputmessageheadersstring-property-ipworkssmime_smime-class) properties. # DecryptAndVerifySignature Method ([IPWorksSMIME_SMIME](#smime-class) Class) This method decrypts and verifies the signature of the current message. ## Object Oriented Interface ```text public function doDecryptAndVerifySignature(); ``` ## Procedural Interface ```text ipworkssmime_smime_do_decryptandverifysignature($res); ``` ## Remarks This method attempts to both decrypt and verify the signature of the message. All of the properties affected by calling the [Decrypt](#decrypt-method-ipworkssmime_smime-class) and [VerifySignature](#verifysignature-method-ipworkssmime_smime-class) methods are affected in the same manner. NOTE: This function does not attempt to check the validity of the signing certificate. **Input and Output Properties** The class 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: - [InputFile](#inputfile-property-ipworkssmime_smime-class) - [InputMessage](#inputmessage-property-ipworkssmime_smime-class) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [OutputFile](#outputfile-property-ipworkssmime_smime-class) - [OutputMessage](#outputmessage-property-ipworkssmime_smime-class): The output data is written to this property if no other destination is specified. The headers of the input message (if any) will be read from InputMessageHeaders or [InputMessageHeadersString](#inputmessageheadersstring-property-ipworkssmime_smime-class). The headers of the resulting message will be available in the OutputMessageHeaders and [OutputMessageHeadersString](#outputmessageheadersstring-property-ipworkssmime_smime-class) properties. # Encrypt Method ([IPWorksSMIME_SMIME](#smime-class) Class) This method encrypts the message. ## Object Oriented Interface ```text public function doEncrypt(); ``` ## Procedural Interface ```text ipworkssmime_smime_do_encrypt($res); ``` ## Remarks This method encrypts the data specified in [InputFile](#inputfile-property-ipworkssmime_smime-class) or [InputMessage](#inputmessage-property-ipworkssmime_smime-class) in a PKCS-encoded envelope with all of the recipient certificates specified in the MessageRecipients properties. The result of the encrypted data will be written to [OutputFile](#outputfile-property-ipworkssmime_smime-class), or [OutputMessage](#outputmessage-property-ipworkssmime_smime-class). The OutputMessageHeaders property will be filled with the required S/MIME headers. NOTE: The message headers, including the Sender, Recipient(s), and Subject, are not encrypted. If this is sensitive information, consider including these headers in the message body as a MIME entity and providing other headers for the S/MIME wrapper. **Input and Output Properties** The class 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: - [InputFile](#inputfile-property-ipworkssmime_smime-class) - [InputMessage](#inputmessage-property-ipworkssmime_smime-class) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [OutputFile](#outputfile-property-ipworkssmime_smime-class) - [OutputMessage](#outputmessage-property-ipworkssmime_smime-class): The output data is written to this property if no other destination is specified. The headers of the input message (if any) will be read from InputMessageHeaders or [InputMessageHeadersString](#inputmessageheadersstring-property-ipworkssmime_smime-class). The headers of the resulting message will be available in the OutputMessageHeaders and [OutputMessageHeadersString](#outputmessageheadersstring-property-ipworkssmime_smime-class) properties. # GetRecipientInfo Method ([IPWorksSMIME_SMIME](#smime-class) Class) This method gets the recipient information for an encrypted message. ## Object Oriented Interface ```text public function doGetRecipientInfo(); ``` ## Procedural Interface ```text ipworkssmime_smime_do_getrecipientinfo($res); ``` ## Remarks This method will fire a [RecipientInfo](#recipientinfo-event-ipworkssmime_smime-class) event for every recipient certificate for which the Message has been encrypted. The event will contain information about the *Issuer* and the *SerialNumber* for each recipient of the message. # GetSignerCertInfo Method ([IPWorksSMIME_SMIME](#smime-class) Class) This method gets the signature information for an signed message. ## Object Oriented Interface ```text public function doGetSignerCertInfo(); ``` ## Procedural Interface ```text ipworkssmime_smime_do_getsignercertinfo($res); ``` ## Remarks This method retrieves information about the certificate used to sign the message. This may be called before calling [VerifySignature](#verifysignature-method-ipworkssmime_smime-class) to determine which certificate should be loaded for verification. When this method is called, the [SignerCertInfo](#signercertinfo-event-ipworkssmime_smime-class) event fires once for each signer of the message. Use the parameters of the [SignerCertInfo](#signercertinfo-event-ipworkssmime_smime-class) to determine which certificate to specify before calling [VerifySignature](#verifysignature-method-ipworkssmime_smime-class). NOTE: Use of this method is optional. If no certificate is specified before calling [VerifySignature](#verifysignature-method-ipworkssmime_smime-class), the class will fire the [SignerCertInfo](#signercertinfo-event-ipworkssmime_smime-class) and a certificate may be loaded from within the event at that time (if necessary). # Reset Method ([IPWorksSMIME_SMIME](#smime-class) Class) This method resets the class properties. ## Object Oriented Interface ```text public function doReset(); ``` ## Procedural Interface ```text ipworkssmime_smime_do_reset($res); ``` ## Remarks This method resets the values of all message and certificate properties. It is an easy way to reset the class properties before starting to populate with new values. # Sign Method ([IPWorksSMIME_SMIME](#smime-class) Class) This method signs the current message. ## Object Oriented Interface ```text public function doSign(); ``` ## Procedural Interface ```text ipworkssmime_smime_do_sign($res); ``` ## Remarks This method digitally signs the input data with the the certificate provided. Certificates are provided by specifying the Certificate property. The [IncludeCertificate](#includecertificate-property-ipworkssmime_smime-class) and [DetachedSignature](#detachedsignature-property-ipworkssmime_smime-class) properties allow you to specify addition details about what to include when signing the message. **Input and Output Properties** The class 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: - [InputFile](#inputfile-property-ipworkssmime_smime-class) - [InputMessage](#inputmessage-property-ipworkssmime_smime-class) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [OutputFile](#outputfile-property-ipworkssmime_smime-class) - [OutputMessage](#outputmessage-property-ipworkssmime_smime-class): The output data is written to this property if no other destination is specified. The headers of the input message (if any) will be read from InputMessageHeaders or [InputMessageHeadersString](#inputmessageheadersstring-property-ipworkssmime_smime-class). The headers of the resulting message will be available in the OutputMessageHeaders and [OutputMessageHeadersString](#outputmessageheadersstring-property-ipworkssmime_smime-class) properties. # SignAndEncrypt Method ([IPWorksSMIME_SMIME](#smime-class) Class) This method signs and encrypts the current message. ## Object Oriented Interface ```text public function doSignAndEncrypt(); ``` ## Procedural Interface ```text ipworkssmime_smime_do_signandencrypt($res); ``` ## Remarks This method both signs and encrypts the input message into a single PKCS-encoded envelope. The value in [DetachedSignature](#detachedsignature-property-ipworkssmime_smime-class) is ignored: the class will always generate an attached signature when calling this method. All other properties used by calling the [Sign](#sign-method-ipworkssmime_smime-class) and [Encrypt](#encrypt-method-ipworkssmime_smime-class) methods are used in the same manner. NOTE: The message headers, including the Sender, Recipient(s), and Subject, are not encrypted. If this is sensitive information, consider including these headers in the message body as a MIME entity and providing other headers for the S/MIME wrapper. **Input and Output Properties** The class 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: - [InputFile](#inputfile-property-ipworkssmime_smime-class) - [InputMessage](#inputmessage-property-ipworkssmime_smime-class) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [OutputFile](#outputfile-property-ipworkssmime_smime-class) - [OutputMessage](#outputmessage-property-ipworkssmime_smime-class): The output data is written to this property if no other destination is specified. The headers of the input message (if any) will be read from InputMessageHeaders or [InputMessageHeadersString](#inputmessageheadersstring-property-ipworkssmime_smime-class). The headers of the resulting message will be available in the OutputMessageHeaders and [OutputMessageHeadersString](#outputmessageheadersstring-property-ipworkssmime_smime-class) properties. # VerifySignature Method ([IPWorksSMIME_SMIME](#smime-class) Class) This method verifies the signature of the current message. ## Object Oriented Interface ```text public function doVerifySignature(); ``` ## Procedural Interface ```text ipworkssmime_smime_do_verifysignature($res); ``` ## Remarks This method attempts to verify the signature of the input message. If the message does not have a certificate attached, the class will attempt to verify the signature using the certificate supplied in SignerCert (if any). If no certificate is found, the class fails with an error. If this method is successful, the SignerCert property will contain the certificate information of the message signer. NOTE: This function does not attempt to check the validity of the signing certificate. **Input and Output Properties** The class 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: - [InputFile](#inputfile-property-ipworkssmime_smime-class) - [InputMessage](#inputmessage-property-ipworkssmime_smime-class) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [OutputFile](#outputfile-property-ipworkssmime_smime-class) - [OutputMessage](#outputmessage-property-ipworkssmime_smime-class): The output data is written to this property if no other destination is specified. The headers of the input message (if any) will be read from InputMessageHeaders or [InputMessageHeadersString](#inputmessageheadersstring-property-ipworkssmime_smime-class). The headers of the resulting message will be available in the OutputMessageHeaders and [OutputMessageHeadersString](#outputmessageheadersstring-property-ipworkssmime_smime-class) properties. # Error Event ([IPWorksSMIME_SMIME](#smime-class) Class) Fired when information is available about errors during data delivery. ## Object Oriented Interface ```text public function fireError($param); ``` ## Procedural Interface ```text ipworkssmime_smime_register_callback($res, 1, array($this, 'fireError')); ``` ## Parameter List ```text 'errorcode' 'description' ``` ## Remarks The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error. The *ErrorCode* parameter contains an error code, and the *Description* parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the [Error Codes](#trappable-errors-smime-class) section. # RecipientInfo Event ([IPWorksSMIME_SMIME](#smime-class) Class) This event is fired for each recipient certificate of the encrypted message. ## Object Oriented Interface ```text public function fireRecipientInfo($param); ``` ## Procedural Interface ```text ipworkssmime_smime_register_callback($res, 2, array($this, 'fireRecipientInfo')); ``` ## Parameter List ```text 'issuer' 'serialnumber' 'subjectkeyidentifier' 'encryptionalgorithm' ``` ## Remarks When [GetRecipientInfo](#getrecipientinfo-method-ipworkssmime_smime-class) 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" # SignerCertInfo Event ([IPWorksSMIME_SMIME](#smime-class) Class) This event is fired during verification of the signed message. ## Object Oriented Interface ```text public function fireSignerCertInfo($param); ``` ## Procedural Interface ```text ipworkssmime_smime_register_callback($res, 3, array($this, 'fireSignerCertInfo')); ``` ## Parameter List ```text 'issuer' 'serialnumber' 'subjectkeyidentifier' 'certencoded' ``` ## Remarks During verification, this event will be raised while parsing the signer's certificate information. The parameters that are populated depend on the options used when the message was originally signed. This information may be used to select the correct certificate for SignerCert to verify the signature. The following parameters may be populated: *Issuer* specifies the subject of the issuer of the certificate used to sign the message. *SerialNumber* is the serial number of the certificate used to sign the message. *SubjectKeyIdentifier* is the X.509 subjectKeyIdentifier extension value of the certificate used to sign the message encoded as a hex string. *CertEncoded* is the PEM (Base64 encoded) public certificate needed to verify the signature. NOTE: When this value is present, the class will automatically use this value to perform signature verification. The SignerCert 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 ([SMIME](#smime-class) Class) The class 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 class, access to these *internal properties* is provided through the [Config](#config-method-ipworkssmime_smime-class) method. ### SMIME Config Settings **ApplyB64Encoding**: Instructs the class to base64 encode the message when signing or encrypting.This configuration setting allows you to control the Base64 encoding of the resulting message. By default, this value is True, and the message will be Base64 encoded when signing or encrypting. NOTE: When signing, this configuration setting may be used only when [DetachedSignature](#detachedsignature-property-ipworkssmime_smime-class) is False. **CSP**: The Cryptographic Service Provider.For the Win32 editions, this configuration setting includes the name of the Cryptographic Service Provider used to provide access to encryption/decryption and signature operations. NOTE: This configuration setting may be used only 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 class. The default value is *True*. **IncludeHeaders**: Tells the class whether to include the headers when encoding the message.If set to True, the class will include the headers when [Sign](#sign-method-ipworkssmime_smime-class), [Encrypt](#encrypt-method-ipworkssmime_smime-class), or [SignAndEncrypt](#signandencrypt-method-ipworkssmime_smime-class) are called. If False, only the message will be encoded. The default value for [IncludeHeaders](#IncludeHeaders) is False. **IncludeInternalHeaders**: Tells the class whether or not to include the internal headers when encoding the message.If set to True, the class will include the internal message part headers when [Sign](#sign-method-ipworkssmime_smime-class), [Encrypt](#encrypt-method-ipworkssmime_smime-class), or [SignAndEncrypt](#signandencrypt-method-ipworkssmime_smime-class) are called. When set to False, only the message will be encoded. The default value for [IncludeInternalHeaders](#IncludeInternalHeaders) is True. **InputContentTransferEncoding**: Sets the Content-Transfer-Encoding for the signed message.This configuration setting specifies the Content-Transfer-Encoding header value in signed messages. By default, the class will automatically determine the Content-Transfer-Encoding based on the file extension set in [InputFile](#inputfile-property-ipworkssmime_smime-class). This setting may be set to override the determined value or to specify a value if data are read from [InputMessage](#inputmessage-property-ipworkssmime_smime-class). If no value is specified and a value cannot be automatically determined, the default value *7bit* will be used. NOTE: This setting is applicable only when calling [Sign](#sign-method-ipworkssmime_smime-class) or [SignAndEncrypt](#signandencrypt-method-ipworkssmime_smime-class) and [DetachedSignature](#detachedsignature-property-ipworkssmime_smime-class) is True. **InputContentType**: Sets the Content-Type for the signed message.This configuration setting specifies the Content-Type header value in signed messages. By default, the class will automatically determine the Content-Type based on the file extension set in [InputFile](#inputfile-property-ipworkssmime_smime-class). This setting may be set to override the determined value or to specify a value if data are read from [InputMessage](#inputmessage-property-ipworkssmime_smime-class). 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 applicable only when calling [Sign](#sign-method-ipworkssmime_smime-class) or [SignAndEncrypt](#signandencrypt-method-ipworkssmime_smime-class) and [DetachedSignature](#detachedsignature-property-ipworkssmime_smime-class) is True. **InputMessageEncrypted**: Whether or not the input message is encrypted.This configuration setting will return True if the input message appears to be encrypted according to the value of InputMessageHeaders. **InputMessageSigned**: Whether or not the input message is signed.This will return true if the input message appears to be signed according to the value of InputMessageHeaders. **NormalizeCRLF**: Whether or not the class will normalize line endings of the input data to CrLf.Setting this configuration setting to *True* will instruct the class to normalize the line endings of the input data to CrLf prior to processing. The default value is *False*. **OAEPMGF1HashAlgorithm**: The MGF1 hash algorithm used with OAEP.This configuration setting specifies the MGF1 hash algorithm used when [UseOAEP](#useoaep-property-ipworkssmime_smime-class) 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 [UseOAEP](#useoaep-property-ipworkssmime_smime-class) 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 [UseOAEP](#useoaep-property-ipworkssmime_smime-class) is set to True. The default value is *SHA256*. Possible values are as follows: - "SHA1" - "SHA224" - "SHA256" (default) - "SHA384" - "SHA512" - "RIPEMD160" - "MD2" - "MD5" - "MD5SHA1" **ParseInternalHeaders**: Tells the class whether or not to parse the message part headers when decrypting a message.If set to True, the class will parse the internal message part headers when [Decrypt](#decrypt-method-ipworkssmime_smime-class), or [DecryptAndVerifySignature](#decryptandverifysignature-method-ipworkssmime_smime-class) are called. These headers will be placed in the [InternalHeaders](#internalheaders-property-ipworkssmime_smime-class) property. If False, the entire message will be decoded. The default value for [ParseInternalHeaders](#ParseInternalHeaders) is True. **RecipientCert**: Used to specify the public certificate when using a PEM key to decrypt.When decrypting, the class must search through the Recipient Information collection to find which encrypted key to use for decryption. Because PEM keys do not contain a serial number or any additional information about the key itself, the public key associated with this private key must be supplied. This configuration setting may be set to the entire blob of the public certificate the class should use to select the correct recipient-encrypted key for decryption. **RecipientCertFile**: Used to specify the public certificate file when using a PEM key to decrypt.When decrypting, the class must search through the Recipient Information collection to find which encrypted key to use for decryption. Because PEM keys do not contain a serial number or any additional information about the key itself, the public key associated with this private key must be supplied. This configuration setting may be set to the file that contains the public certificate the class should use to select the correct recipient-encrypted key for decryption. **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. **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 [RecipientInfo](#recipientinfo-event-ipworkssmime_smime-class) 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. **UseCryptoAPI**: Whether to use the Microsoft Crypto API for cryptographic message generation. If [UseCryptoAPI](#UseCryptoAPI) is set to True, the class will use the Microsoft Crypto API to process encrypted and/or signed data. NOTE: Compression will be impossible in this case. If set to False (the default), the class will use its internal S/MIME engine. ### 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 class 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*. **ProcessIdleEvents**: Whether the class uses its internal event loop to process events when the main thread is idle.If set to False, the class will not fire internal idle events. Set this to False to use the class in a background thread on Mac OS. By default, this setting is True. **SelectWaitMillis**: The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.If there are no events to process when DoEvents is called, the class will wait for the amount of time specified here before returning. The default value is 20. **UseInternalSecurityAPI**: Whether or not to use the system security libraries or an internal implementation. When set to *false*, the class will use the system security libraries by default to perform cryptographic functions where applicable. Setting this configuration setting to *true* tells the class 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 ([SMIME](#smime-class) Class) ### SMIME Errors | | | | --- | --- | | 10191 | Invalid index (RecipientIndex). | | 10192 | Message decoding error (code). | | 10193 | Unexpected message type. | | 10194 | Unsupported hashing/signing algorithm. | | 10195 | The message does not have any signers. | | 10196 | The message signature could not be verified. | | 10197 | Could not locate a suitable decryption certificate. | | 10198 | The signer certificate could not be found. | | 10199 | No signing certificate was supplied for signing the message. | | 10201 | The specified certificate was not the one required. | | 10202 | The specified certificate could not be found. | | 10221 | Could not acquire CSP. | | 10222 | Type validation error. | | 10223 | Unsupported key size. | | 10224 | Unrecognized Content-Type object identifier. | | 10225 | Unrecognized public key format. | | 10226 | No choices specified. | | 10228 | Must specify output stream. | | 10280 | Invalid part index. | | 10281 | Unknown MIME type. | | 10283 | No MIME-boundary found. | | 10280 | Error decoding certificate. |