# SMIME Class The S/MIME class implements the S/MIME standard for encryption and decryption with public key cryptography and X.509 digital certificates. ## Syntax ```text ipworkssmime.SMIME ``` ## 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: - [SetInputStream](#setinputstream-method-smime-class) - [InputFile](#inputfile-property-smime-class) - [InputMessage](#inputmessage-property-smime-class) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [SetOutputStream](#setoutputstream-method-smime-class) - [OutputFile](#outputfile-property-smime-class) - [OutputMessage](#outputmessage-property-smime-class): The output data is written to this property if no other destination is specified. When using streams, you may need to additionally set [CloseInputStreamAfterProcessing](#CloseInputStreamAfterProcessing) or [CloseOutputStreamAfterProcessing](#CloseOutputStreamAfterProcessing). The headers of the input message (if any) will be read from [InputMessageHeaders](#inputmessageheaders-property-smime-class) or [InputMessageHeadersString](#inputmessageheadersstring-property-smime-class). The headers of the resulting message will be available in the [OutputMessageHeaders](#outputmessageheaders-property-smime-class) and [OutputMessageHeadersString](#outputmessageheadersstring-property-smime-class) properties. **Signing** To sign the current data included in the input message with a certificate, the [Certificate](#certificate-property-smime-class) property must be set to a valid [Certificate](#certificate-type) object for the signing certificate. The [IncludeCertificate](#includecertificate-property-smime-class) and [DetachedSignature](#detachedsignature-property-smime-class) properties allow you to specify additional details about the signing process. By setting [IncludeCertificate](#includecertificate-property-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-smime-class). **Encrypting** To encrypt a message with the class in a PKCS envelope, you must first specify the [Certificate](#certificate-type) for each recipient in the [RecipientCerts](#recipientcerts-property-smime-class) collection to encrypt the message with. You can easily add these with the [AddRecipientCert](#addrecipientcert-method-smime-class) method. Once you have done this you can call the [Encrypt](#encrypt-method-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-smime-class) method. You must set all of the properties needed for both [Sign](#sign-method-smime-class) and [Encrypt](#encrypt-method-smime-class) The result of the encrypted or signed data will be replaced in the [OutputMessage](#outputmessage-property-smime-class) property and the [OutputMessageHeaders](#outputmessageheaders-property-smime-class) property will be filled with the appropriate mime headers if applicable. **Decrypting** Decrypting PKCS envelopes is handled with the [Decrypt](#decrypt-method-smime-class) method. When this method is called, the class will attempt to find an appropriate certificate in the [Certificate](#certificate-property-smime-class) 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-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-smime-class) is successful, the [SignerCert](#signercert-property-smime-class) and [SignerCertChain](#signercertchain-property-smime-class) 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-smime-class), [DecryptAndVerifySignature](#decryptandverifysignature-method-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.* | | | | --- | --- | | [Certificate](#certificate-property-smime-class) | This property includes the current selected certificate. | | [DetachedSignature](#detachedsignature-property-smime-class) | This property specifies whether to include a detached signature when signing a message. | | [EncryptingAlgorithm](#encryptingalgorithm-property-smime-class) | The property includes textual description of the encrypting algorithm. | | [IncludeCertificate](#includecertificate-property-smime-class) | This property specifies whether to include the signer's certificate with the signed message. | | [IncludeChain](#includechain-property-smime-class) | This property specifies whether to include the signer's certificate chain with the signed message. | | [IncludeHeaders](#includeheaders-property-smime-class) | This property tells the class whether to include the headers when encoding the message. | | [InputFile](#inputfile-property-smime-class) | This property includes the file to process. | | [InputMessage](#inputmessage-property-smime-class) | This property includes the message to process. | | [InputMessageHeaders](#inputmessageheaders-property-smime-class) | This property includes a collection of headers from the S/MIME message. | | [InputMessageHeadersString](#inputmessageheadersstring-property-smime-class) | This property includes the string version of headers from the S/MIME message. | | [InternalHeaders](#internalheaders-property-smime-class) | This property includes the headers of the MIME entity inside the encrypted or signed message. | | [OutputFile](#outputfile-property-smime-class) | This property specifies the output file. | | [OutputMessage](#outputmessage-property-smime-class) | This property includes the output message after processing. | | [OutputMessageHeaders](#outputmessageheaders-property-smime-class) | This property includes a collection of headers from the S/MIME message. | | [OutputMessageHeadersString](#outputmessageheadersstring-property-smime-class) | This property includes a string version of headers from the S/MIME message. | | [Overwrite](#overwrite-property-smime-class) | This property indicates whether or not the class should overwrite files. | | [RecipientCerts](#recipientcerts-property-smime-class) | This property includes a collection of recipient certificates of the message. | | [SignerCert](#signercert-property-smime-class) | This property contains the certificate of the message signer. | | [SignerCertChain](#signercertchain-property-smime-class) | This property includes the certificate chain of the signing certificate. | | [SigningAlgorithm](#signingalgorithm-property-smime-class) | This property includes a textual description of the signature hash algorithm. | | [UseOAEP](#useoaep-property-smime-class) | This property specifies whether or not to use Optimal Asymmetric Encryption Padding (OAEP). | | [UsePSS](#usepss-property-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-smime-class) | This method is used to add recipient certificates used to encrypt messages. | | [CheckMessageEncrypted](#checkmessageencrypted-method-smime-class) | This method checks whether or not the current message is encrypted. | | [CheckMessageSigned](#checkmessagesigned-method-smime-class) | This method checks whether or not the current message is signed. | | [Config](#config-method-smime-class) | Sets or retrieves a configuration setting. | | [Decrypt](#decrypt-method-smime-class) | This method decrypts the current Message . | | [DecryptAndVerifySignature](#decryptandverifysignature-method-smime-class) | This method decrypts and verifies the signature of the current message. | | [Encrypt](#encrypt-method-smime-class) | This method encrypts the message. | | [GetRecipientInfo](#getrecipientinfo-method-smime-class) | This method gets the recipient information for an encrypted message. | | [GetSignerCertInfo](#getsignercertinfo-method-smime-class) | This method gets the signature information for an signed message. | | [Reset](#reset-method-smime-class) | This method resets the class properties. | | [SetInputStream](#setinputstream-method-smime-class) | This method sets the stream from which the class will read data to encode or decode. | | [SetOutputStream](#setoutputstream-method-smime-class) | This method includes the stream to which the class will write the fully encoded or decoded S/MIME data. | | [Sign](#sign-method-smime-class) | This method signs the current message. | | [SignAndEncrypt](#signandencrypt-method-smime-class) | This method signs and encrypts the current message. | | [VerifySignature](#verifysignature-method-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-smime-class) | Fired when information is available about errors during data delivery. | | [RecipientInfo](#recipientinfo-event-smime-class) | This event is fired for each recipient certificate of the encrypted message. | | [SignerCertInfo](#signercertinfo-event-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. | | [CloseInputStreamAfterProcess](#CloseInputStreamAfterProcess) | Determines whether or not the input stream is closed after processing. | | [CloseOutputStreamAfterProcess](#CloseOutputStreamAfterProcess) | Determines whether or not the output stream is closed after processing. | | [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. | | [VerifyCertChain](#VerifyCertChain) | Whether to verify the certificate chain of the certificate used to sign the message. | | [BuildInfo](#BuildInfo) | Information about the product's build. | | [GUIAvailable](#GUIAvailable) | Whether or not a message loop is available for processing events. | | [LicenseInfo](#LicenseInfo) | Information about the current license. | | [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. | | [UseDaemonThreads](#UseDaemonThreads) | Whether threads created by the class are daemon threads. | | [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. | | [UseVirtualThreads](#UseVirtualThreads) | Whether threads created by the class use virtual threads instead of platform threads. | # Certificate Property ([SMIME](#smime-class) Class) This property includes the current selected certificate. ## Syntax ```text public Certificate getCertificate(); public void setCertificate(Certificate certificate); ``` ## Remarks This property is populated when a specified certificate is found or loaded by the class. This property is used to specify private keys. Set this property to a valid [Certificate](#certificate-type) object to perform different operations, such as [Sign](#sign-method-smime-class), [Decrypt](#decrypt-method-smime-class), [SignAndEncrypt](#signandencrypt-method-smime-class), or [DecryptAndVerifySignature](#decryptandverifysignature-method-smime-class). Please refer to the [Certificate](#certificate-type) type for a complete list of fields. # DetachedSignature Property ([SMIME](#smime-class) Class) This property specifies whether to include a detached signature when signing a message. ## Syntax ```text public boolean isDetachedSignature(); public void setDetachedSignature(boolean detachedSignature); ``` ## 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-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. # EncryptingAlgorithm Property ([SMIME](#smime-class) Class) The property includes textual description of the encrypting algorithm. ## Syntax ```text public String getEncryptingAlgorithm(); public void setEncryptingAlgorithm(String encryptingAlgorithm); ``` ## 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" # IncludeCertificate Property ([SMIME](#smime-class) Class) This property specifies whether to include the signer's certificate with the signed message. ## Syntax ```text public boolean isIncludeCertificate(); public void setIncludeCertificate(boolean includeCertificate); ``` ## 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-smime-class) or [SignAndEncrypt](#signandencrypt-method-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. # IncludeChain Property ([SMIME](#smime-class) Class) This property specifies whether to include the signer's certificate chain with the signed message. ## Syntax ```text public boolean isIncludeChain(); public void setIncludeChain(boolean includeChain); ``` ## 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-smime-class) or [SignAndEncrypt](#signandencrypt-method-smime-class). NOTE: To include the chain, the [IncludeCertificate](#includecertificate-property-smime-class) property must also be set to true. # IncludeHeaders Property ([SMIME](#smime-class) Class) This property tells the class whether to include the headers when encoding the message. ## Syntax ```text public boolean isIncludeHeaders(); public void setIncludeHeaders(boolean includeHeaders); ``` ## Default Value False ## Remarks If True, the class will include the headers when [Sign](#sign-method-smime-class), [Encrypt](#encrypt-method-smime-class), or [SignAndEncrypt](#signandencrypt-method-smime-class) are called. If False, only the message will be encoded. The default value for IncludeHeaders is False. # InputFile Property ([SMIME](#smime-class) Class) This property includes the file to process. ## Syntax ```text public String getInputFile(); public void setInputFile(String inputFile); ``` ## 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: - [SetInputStream](#setinputstream-method-smime-class) - InputFile - [InputMessage](#inputmessage-property-smime-class) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [SetOutputStream](#setoutputstream-method-smime-class) - [OutputFile](#outputfile-property-smime-class) - [OutputMessage](#outputmessage-property-smime-class): The output data is written to this property if no other destination is specified. When using streams, you may need to additionally set [CloseInputStreamAfterProcessing](#CloseInputStreamAfterProcessing) or [CloseOutputStreamAfterProcessing](#CloseOutputStreamAfterProcessing). The headers of the input message (if any) will be read from [InputMessageHeaders](#inputmessageheaders-property-smime-class) or [InputMessageHeadersString](#inputmessageheadersstring-property-smime-class). # InputMessage Property ([SMIME](#smime-class) Class) This property includes the message to process. ## Syntax ```text public byte[] getInputMessage(); public void setInputMessage(byte[] inputMessage); ``` ## 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: - [SetInputStream](#setinputstream-method-smime-class) - [InputFile](#inputfile-property-smime-class) - InputMessage When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [SetOutputStream](#setoutputstream-method-smime-class) - [OutputFile](#outputfile-property-smime-class) - [OutputMessage](#outputmessage-property-smime-class): The output data is written to this property if no other destination is specified. When using streams, you may need to additionally set [CloseInputStreamAfterProcessing](#CloseInputStreamAfterProcessing) or [CloseOutputStreamAfterProcessing](#CloseOutputStreamAfterProcessing). The headers of the input message (if any) will be read from [InputMessageHeaders](#inputmessageheaders-property-smime-class) or [InputMessageHeadersString](#inputmessageheadersstring-property-smime-class). # InputMessageHeaders Property ([SMIME](#smime-class) Class) This property includes a collection of headers from the S/MIME message. ## Syntax ```text public HeaderList getInputMessageHeaders(); ``` ## Remarks This property contains a collection of headers from the S/MIME message. This property may be set to the headers of the message that will be decrypted/verified. This property is not available at design time. Please refer to the [Header](#header-type) type for a complete list of fields. # InputMessageHeadersString Property ([SMIME](#smime-class) Class) This property includes the string version of headers from the S/MIME message. ## Syntax ```text public String getInputMessageHeadersString(); public void setInputMessageHeadersString(String inputMessageHeadersString); ``` ## 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. # InternalHeaders Property ([SMIME](#smime-class) Class) This property includes the headers of the MIME entity inside the encrypted or signed message. ## Syntax ```text public String getInternalHeaders(); public void setInternalHeaders(String internalHeaders); ``` ## 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. # OutputFile Property ([SMIME](#smime-class) Class) This property specifies the output file. ## Syntax ```text public String getOutputFile(); public void setOutputFile(String outputFile); ``` ## 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: - [SetInputStream](#setinputstream-method-smime-class) - [InputFile](#inputfile-property-smime-class) - [InputMessage](#inputmessage-property-smime-class) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [SetOutputStream](#setoutputstream-method-smime-class) - OutputFile - [OutputMessage](#outputmessage-property-smime-class): The output data is written to this property if no other destination is specified. When using streams, you may need to additionally set [CloseInputStreamAfterProcessing](#CloseInputStreamAfterProcessing) or [CloseOutputStreamAfterProcessing](#CloseOutputStreamAfterProcessing). The headers of the resulting message will be available in the [OutputMessageHeaders](#outputmessageheaders-property-smime-class) and [OutputMessageHeadersString](#outputmessageheadersstring-property-smime-class) properties. # OutputMessage Property ([SMIME](#smime-class) Class) This property includes the output message after processing. ## Syntax ```text public byte[] getOutputMessage(); ``` ## Default Value "" ## Remarks This property will be populated with the output of the operation if [OutputFile](#outputfile-property-smime-class) and [SetOutputStream](#setoutputstream-method-smime-class) are 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: - [SetInputStream](#setinputstream-method-smime-class) - [InputFile](#inputfile-property-smime-class) - [InputMessage](#inputmessage-property-smime-class) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [SetOutputStream](#setoutputstream-method-smime-class) - [OutputFile](#outputfile-property-smime-class) - OutputMessage: The output data is written to this property if no other destination is specified. When using streams, you may need to additionally set [CloseInputStreamAfterProcessing](#CloseInputStreamAfterProcessing) or [CloseOutputStreamAfterProcessing](#CloseOutputStreamAfterProcessing). The headers of the resulting message will be available in the [OutputMessageHeaders](#outputmessageheaders-property-smime-class) and [OutputMessageHeadersString](#outputmessageheadersstring-property-smime-class) properties. This property is read-only. # OutputMessageHeaders Property ([SMIME](#smime-class) Class) This property includes a collection of headers from the S/MIME message. ## Syntax ```text public HeaderList getOutputMessageHeaders(); ``` ## Remarks 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-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 and not available at design time. Please refer to the [Header](#header-type) type for a complete list of fields. # OutputMessageHeadersString Property ([SMIME](#smime-class) Class) This property includes a string version of headers from the S/MIME message. ## Syntax ```text public String getOutputMessageHeadersString(); ``` ## 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-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. # Overwrite Property ([SMIME](#smime-class) Class) This property indicates whether or not the class should overwrite files. ## Syntax ```text public boolean isOverwrite(); public void setOverwrite(boolean overwrite); ``` ## Default Value True ## Remarks This property indicates whether or not the class will overwrite [OutputFile](#outputfile-property-smime-class). If Overwrite is False, an error will be thrown whenever [OutputFile](#outputfile-property-smime-class) exists before an operation. The default value is False. # RecipientCerts Property ([SMIME](#smime-class) Class) This property includes a collection of recipient certificates of the message. ## Syntax ```text public CertificateList getRecipientCerts(); ``` ## Remarks This property is used to specify the certificates of the intended recipients of the encrypted message. This property must be set before calling [Encrypt](#encrypt-method-smime-class) or [SignAndEncrypt](#signandencrypt-method-smime-class) methods. This property's collection must be filled out with valid public key [Certificate](#certificate-type) type objects. To set a certificate, you may set the [Encoded](#Certificate_f_Encoded) field to the encoded certificate. To select a certificate, use the [Store](#Certificate_f_Store) and [Subject](#Certificate_f_Subject) fields. This collection is indexed from *0* to *size() - 1*. This property is not available at design time. Please refer to the [Certificate](#certificate-type) type for a complete list of fields. # SignerCert Property ([SMIME](#smime-class) Class) This property contains the certificate of the message signer. ## Syntax ```text public Certificate getSignerCert(); public void setSignerCert(Certificate signerCert); ``` ## Remarks This property contains the certificate of the message signer. When calling [VerifySignature](#verifysignature-method-smime-class) or [DecryptAndVerifySignature](#decryptandverifysignature-method-smime-class), this property will contain the certificate of the sender, if attached. To verify messages without an attached certificate, set this property before calling [VerifySignature](#verifysignature-method-smime-class) or [DecryptAndVerifySignature](#decryptandverifysignature-method-smime-class). Please refer to the [Certificate](#certificate-type) type for a complete list of fields. # SignerCertChain Property ([SMIME](#smime-class) Class) This property includes the certificate chain of the signing certificate. ## Syntax ```text public CertificateList getSignerCertChain(); ``` ## Remarks This property contains the certificate chain of the signing certificate. When calling [VerifySignature](#verifysignature-method-smime-class) or [DecryptAndVerifySignature](#decryptandverifysignature-method-smime-class), this property will be populated with the certificate chain of the sender if attached. NOTE: The [SignerCert](#signercert-property-smime-class) property will contain the signing certificate. The certificates in the signing certificate's chain will be placed in this property's collection. This property is read-only and not available at design time. Please refer to the [Certificate](#certificate-type) type for a complete list of fields. # SigningAlgorithm Property ([SMIME](#smime-class) Class) This property includes a textual description of the signature hash algorithm. ## Syntax ```text public String getSigningAlgorithm(); public void setSigningAlgorithm(String signingAlgorithm); ``` ## 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. # UseOAEP Property ([SMIME](#smime-class) Class) This property specifies whether or not to use Optimal Asymmetric Encryption Padding (OAEP). ## Syntax ```text public boolean isUseOAEP(); public void setUseOAEP(boolean useOAEP); ``` ## 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) # UsePSS Property ([SMIME](#smime-class) Class) This property specifies whether or not RSA-PSS will be used during signing and verification. ## Syntax ```text public boolean isUsePSS(); public void setUsePSS(boolean usePSS); ``` ## 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. # AddRecipientCert Method ([SMIME](#smime-class) Class) This method is used to add recipient certificates used to encrypt messages. ## Syntax ```text public void addRecipientCert(byte[] certEncoded); ``` ## Remarks This method is used to add recipient certificates to the internal MessageRecipients collection 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 ([SMIME](#smime-class) Class) This method checks whether or not the current message is encrypted. ## Syntax ```text public boolean checkMessageEncrypted(); ``` ## 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](#outputmessageheaders-property-smime-class). # CheckMessageSigned Method ([SMIME](#smime-class) Class) This method checks whether or not the current message is signed. ## Syntax ```text public boolean checkMessageSigned(); ``` ## 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](#outputmessageheaders-property-smime-class). NOTE: A message that is both signed and encrypted will not appear to be signed until after it is decrypted. # Config Method ([SMIME](#smime-class) Class) Sets or retrieves a configuration setting. ## Syntax ```text public String config(String 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 ([SMIME](#smime-class) Class) This method decrypts the current Message . ## Syntax ```text public void decrypt(); ``` ## Remarks This method takes attempts to decrypt the encrypted message using the certificate in [Certificate](#certificate-property-smime-class). **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: - [SetInputStream](#setinputstream-method-smime-class) - [InputFile](#inputfile-property-smime-class) - [InputMessage](#inputmessage-property-smime-class) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [SetOutputStream](#setoutputstream-method-smime-class) - [OutputFile](#outputfile-property-smime-class) - [OutputMessage](#outputmessage-property-smime-class): The output data is written to this property if no other destination is specified. When using streams, you may need to additionally set [CloseInputStreamAfterProcessing](#CloseInputStreamAfterProcessing) or [CloseOutputStreamAfterProcessing](#CloseOutputStreamAfterProcessing). The headers of the input message (if any) will be read from [InputMessageHeaders](#inputmessageheaders-property-smime-class) or [InputMessageHeadersString](#inputmessageheadersstring-property-smime-class). The headers of the resulting message will be available in the [OutputMessageHeaders](#outputmessageheaders-property-smime-class) and [OutputMessageHeadersString](#outputmessageheadersstring-property-smime-class) properties. # DecryptAndVerifySignature Method ([SMIME](#smime-class) Class) This method decrypts and verifies the signature of the current message. ## Syntax ```text public void decryptAndVerifySignature(); ``` ## 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-smime-class) and [VerifySignature](#verifysignature-method-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: - [SetInputStream](#setinputstream-method-smime-class) - [InputFile](#inputfile-property-smime-class) - [InputMessage](#inputmessage-property-smime-class) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [SetOutputStream](#setoutputstream-method-smime-class) - [OutputFile](#outputfile-property-smime-class) - [OutputMessage](#outputmessage-property-smime-class): The output data is written to this property if no other destination is specified. When using streams, you may need to additionally set [CloseInputStreamAfterProcessing](#CloseInputStreamAfterProcessing) or [CloseOutputStreamAfterProcessing](#CloseOutputStreamAfterProcessing). The headers of the input message (if any) will be read from [InputMessageHeaders](#inputmessageheaders-property-smime-class) or [InputMessageHeadersString](#inputmessageheadersstring-property-smime-class). The headers of the resulting message will be available in the [OutputMessageHeaders](#outputmessageheaders-property-smime-class) and [OutputMessageHeadersString](#outputmessageheadersstring-property-smime-class) properties. # Encrypt Method ([SMIME](#smime-class) Class) This method encrypts the message. ## Syntax ```text public void encrypt(); ``` ## Remarks This method encrypts the data specified in [SetInputStream](#setinputstream-method-smime-class), [InputFile](#inputfile-property-smime-class) or [InputMessage](#inputmessage-property-smime-class) in a PKCS-encoded envelope with all of the recipient certificates specified in the MessageRecipients collection. The result of the encrypted data will be written to the stream specified by [SetOutputStream](#setoutputstream-method-smime-class), [OutputFile](#outputfile-property-smime-class), or [OutputMessage](#outputmessage-property-smime-class). The [OutputMessageHeaders](#outputmessageheaders-property-smime-class) 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: - [SetInputStream](#setinputstream-method-smime-class) - [InputFile](#inputfile-property-smime-class) - [InputMessage](#inputmessage-property-smime-class) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [SetOutputStream](#setoutputstream-method-smime-class) - [OutputFile](#outputfile-property-smime-class) - [OutputMessage](#outputmessage-property-smime-class): The output data is written to this property if no other destination is specified. When using streams, you may need to additionally set [CloseInputStreamAfterProcessing](#CloseInputStreamAfterProcessing) or [CloseOutputStreamAfterProcessing](#CloseOutputStreamAfterProcessing). The headers of the input message (if any) will be read from [InputMessageHeaders](#inputmessageheaders-property-smime-class) or [InputMessageHeadersString](#inputmessageheadersstring-property-smime-class). The headers of the resulting message will be available in the [OutputMessageHeaders](#outputmessageheaders-property-smime-class) and [OutputMessageHeadersString](#outputmessageheadersstring-property-smime-class) properties. # GetRecipientInfo Method ([SMIME](#smime-class) Class) This method gets the recipient information for an encrypted message. ## Syntax ```text public void getRecipientInfo(); ``` ## Remarks This method will fire a [RecipientInfo](#recipientinfo-event-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 ([SMIME](#smime-class) Class) This method gets the signature information for an signed message. ## Syntax ```text public void getSignerCertInfo(); ``` ## Remarks This method retrieves information about the certificate used to sign the message. This may be called before calling [VerifySignature](#verifysignature-method-smime-class) to determine which certificate should be loaded for verification. When this method is called, the [SignerCertInfo](#signercertinfo-event-smime-class) event fires once for each signer of the message. Use the parameters of the [SignerCertInfo](#signercertinfo-event-smime-class) to determine which certificate to specify before calling [VerifySignature](#verifysignature-method-smime-class). NOTE: Use of this method is optional. If no certificate is specified before calling [VerifySignature](#verifysignature-method-smime-class), the class will fire the [SignerCertInfo](#signercertinfo-event-smime-class) and a certificate may be loaded from within the event at that time (if necessary). # Reset Method ([SMIME](#smime-class) Class) This method resets the class properties. ## Syntax ```text public void reset(); ``` ## 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. # SetInputStream Method ([SMIME](#smime-class) Class) This method sets the stream from which the class will read data to encode or decode. ## Syntax ```text public void setInputStream(java.io.InputStream inputStream); ``` ## Remarks This method sets the stream from which the class will read data to encode or decode. **Encrypt and/or Sign** When encrypting or signing, this may be set to a stream with the content that will be encrypted and/or signed. **Decrypt and/or Verify** When decrypting or verifying a signature, this may be set to a stream with 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: - SetInputStream - [InputFile](#inputfile-property-smime-class) - [InputMessage](#inputmessage-property-smime-class) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [SetOutputStream](#setoutputstream-method-smime-class) - [OutputFile](#outputfile-property-smime-class) - [OutputMessage](#outputmessage-property-smime-class): The output data is written to this property if no other destination is specified. When using streams, you may need to additionally set [CloseInputStreamAfterProcessing](#CloseInputStreamAfterProcessing) or [CloseOutputStreamAfterProcessing](#CloseOutputStreamAfterProcessing). The headers of the input message (if any) will be read from [InputMessageHeaders](#inputmessageheaders-property-smime-class) or [InputMessageHeadersString](#inputmessageheadersstring-property-smime-class). # SetOutputStream Method ([SMIME](#smime-class) Class) This method includes the stream to which the class will write the fully encoded or decoded S/MIME data. ## Syntax ```text public void setOutputStream(java.io.OutputStream outputStream); ``` ## Remarks This method contains the stream to which the class will write the fully encoded or decoded S/MIME data. **Encrypt and/or Sign** When encrypting or signing, this may be set to a stream where the fully encoded S/MIME message will be written. **Decrypt and/or Verify** When decrypting or verifying a signature, this may be set to a stream 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: - [SetInputStream](#setinputstream-method-smime-class) - [InputFile](#inputfile-property-smime-class) - [InputMessage](#inputmessage-property-smime-class) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - SetOutputStream - [OutputFile](#outputfile-property-smime-class) - [OutputMessage](#outputmessage-property-smime-class): The output data is written to this property if no other destination is specified. When using streams, you may need to additionally set [CloseInputStreamAfterProcessing](#CloseInputStreamAfterProcessing) or [CloseOutputStreamAfterProcessing](#CloseOutputStreamAfterProcessing). The headers of the resulting message will be available in the [OutputMessageHeaders](#outputmessageheaders-property-smime-class) and [OutputMessageHeadersString](#outputmessageheadersstring-property-smime-class) properties. # Sign Method ([SMIME](#smime-class) Class) This method signs the current message. ## Syntax ```text public void sign(); ``` ## Remarks This method digitally signs the input data with the the certificate provided. Certificates are provided by specifying the [Certificate](#certificate-property-smime-class) property. The [IncludeCertificate](#includecertificate-property-smime-class) and [DetachedSignature](#detachedsignature-property-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: - [SetInputStream](#setinputstream-method-smime-class) - [InputFile](#inputfile-property-smime-class) - [InputMessage](#inputmessage-property-smime-class) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [SetOutputStream](#setoutputstream-method-smime-class) - [OutputFile](#outputfile-property-smime-class) - [OutputMessage](#outputmessage-property-smime-class): The output data is written to this property if no other destination is specified. When using streams, you may need to additionally set [CloseInputStreamAfterProcessing](#CloseInputStreamAfterProcessing) or [CloseOutputStreamAfterProcessing](#CloseOutputStreamAfterProcessing). The headers of the input message (if any) will be read from [InputMessageHeaders](#inputmessageheaders-property-smime-class) or [InputMessageHeadersString](#inputmessageheadersstring-property-smime-class). The headers of the resulting message will be available in the [OutputMessageHeaders](#outputmessageheaders-property-smime-class) and [OutputMessageHeadersString](#outputmessageheadersstring-property-smime-class) properties. # SignAndEncrypt Method ([SMIME](#smime-class) Class) This method signs and encrypts the current message. ## Syntax ```text public void signAndEncrypt(); ``` ## Remarks This method both signs and encrypts the input message into a single PKCS-encoded envelope. The value in [DetachedSignature](#detachedsignature-property-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-smime-class) and [Encrypt](#encrypt-method-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: - [SetInputStream](#setinputstream-method-smime-class) - [InputFile](#inputfile-property-smime-class) - [InputMessage](#inputmessage-property-smime-class) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [SetOutputStream](#setoutputstream-method-smime-class) - [OutputFile](#outputfile-property-smime-class) - [OutputMessage](#outputmessage-property-smime-class): The output data is written to this property if no other destination is specified. When using streams, you may need to additionally set [CloseInputStreamAfterProcessing](#CloseInputStreamAfterProcessing) or [CloseOutputStreamAfterProcessing](#CloseOutputStreamAfterProcessing). The headers of the input message (if any) will be read from [InputMessageHeaders](#inputmessageheaders-property-smime-class) or [InputMessageHeadersString](#inputmessageheadersstring-property-smime-class). The headers of the resulting message will be available in the [OutputMessageHeaders](#outputmessageheaders-property-smime-class) and [OutputMessageHeadersString](#outputmessageheadersstring-property-smime-class) properties. # VerifySignature Method ([SMIME](#smime-class) Class) This method verifies the signature of the current message. ## Syntax ```text public void verifySignature(); ``` ## 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](#signercert-property-smime-class) (if any). If no certificate is found, the class throws an exception. If this method is successful, the [SignerCert](#signercert-property-smime-class) 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: - [SetInputStream](#setinputstream-method-smime-class) - [InputFile](#inputfile-property-smime-class) - [InputMessage](#inputmessage-property-smime-class) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [SetOutputStream](#setoutputstream-method-smime-class) - [OutputFile](#outputfile-property-smime-class) - [OutputMessage](#outputmessage-property-smime-class): The output data is written to this property if no other destination is specified. When using streams, you may need to additionally set [CloseInputStreamAfterProcessing](#CloseInputStreamAfterProcessing) or [CloseOutputStreamAfterProcessing](#CloseOutputStreamAfterProcessing). The headers of the input message (if any) will be read from [InputMessageHeaders](#inputmessageheaders-property-smime-class) or [InputMessageHeadersString](#inputmessageheadersstring-property-smime-class). The headers of the resulting message will be available in the [OutputMessageHeaders](#outputmessageheaders-property-smime-class) and [OutputMessageHeadersString](#outputmessageheadersstring-property-smime-class) properties. # Error Event ([SMIME](#smime-class) Class) Fired when information is available about errors during data delivery. ## Syntax ```text public class DefaultSMIMEEventListener implements SMIMEEventListener { ... public void error(SMIMEErrorEvent e) {} ... } public class SMIMEErrorEvent { public int errorCode; public String description; } ``` ## Remarks The Error event is fired in case of exceptional conditions during message processing. Normally the class throws an exception. 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 ([SMIME](#smime-class) Class) This event is fired for each recipient certificate of the encrypted message. ## Syntax ```text public class DefaultSMIMEEventListener implements SMIMEEventListener { ... public void recipientInfo(SMIMERecipientInfoEvent e) {} ... } public class SMIMERecipientInfoEvent { public String issuer; public String serialNumber; public String subjectKeyIdentifier; public String encryptionAlgorithm; } ``` ## Remarks When [GetRecipientInfo](#getrecipientinfo-method-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 ([SMIME](#smime-class) Class) This event is fired during verification of the signed message. ## Syntax ```text public class DefaultSMIMEEventListener implements SMIMEEventListener { ... public void signerCertInfo(SMIMESignerCertInfoEvent e) {} ... } public class SMIMESignerCertInfoEvent { public String issuer; public String serialNumber; public String subjectKeyIdentifier; public byte[] 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](#signercert-property-smime-class) 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](#signercert-property-smime-class) 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. # Certificate Type This is the digital certificate being used. ## Remarks This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates. The following fields are available: - [EffectiveDate](#Certificate_f_EffectiveDate) - [ExpirationDate](#Certificate_f_ExpirationDate) - [ExtendedKeyUsage](#Certificate_f_ExtendedKeyUsage) - [Fingerprint](#Certificate_f_Fingerprint) - [FingerprintSHA1](#Certificate_f_FingerprintSHA1) - [FingerprintSHA256](#Certificate_f_FingerprintSHA256) - [Issuer](#Certificate_f_Issuer) - [KeyPassword](#Certificate_f_KeyPassword) - [PrivateKey](#Certificate_f_PrivateKey) - [PrivateKeyAvailable](#Certificate_f_PrivateKeyAvailable) - [PrivateKeyContainer](#Certificate_f_PrivateKeyContainer) - [PublicKey](#Certificate_f_PublicKey) - [PublicKeyAlgorithm](#Certificate_f_PublicKeyAlgorithm) - [PublicKeyLength](#Certificate_f_PublicKeyLength) - [SerialNumber](#Certificate_f_SerialNumber) - [SignatureAlgorithm](#Certificate_f_SignatureAlgorithm) - [Store](#Certificate_f_Store) - [StorePassword](#Certificate_f_StorePassword) - [StoreType](#Certificate_f_StoreType) - [SubjectAltNames](#Certificate_f_SubjectAltNames) - [ThumbprintMD5](#Certificate_f_ThumbprintMD5) - [ThumbprintSHA1](#Certificate_f_ThumbprintSHA1) - [ThumbprintSHA256](#Certificate_f_ThumbprintSHA256) - [Usage](#Certificate_f_Usage) - [UsageFlags](#Certificate_f_UsageFlags) - [Version](#Certificate_f_Version) - [Subject](#Certificate_f_Subject) - [Encoded](#Certificate_f_Encoded) ## Fields **EffectiveDate** *String (read-only)* *Default Value: ""* 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. **ExpirationDate** *String (read-only)* *Default Value: ""* 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. **ExtendedKeyUsage** *String (read-only)* *Default Value: ""* A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). **Fingerprint** *String (read-only)* *Default Value: ""* 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* **FingerprintSHA1** *String (read-only)* *Default Value: ""* 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* **FingerprintSHA256** *String (read-only)* *Default Value: ""* 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* **Issuer** *String (read-only)* *Default Value: ""* The issuer of the certificate. This field contains a string representation of the name of the issuing authority for the certificate. **KeyPassword** *String* *Default Value: ""* The password for the certificate's private key (if any). Some certificate stores may individually protect certificates' private keys, separate from the standard protection offered by the [StorePassword](#Certificate_f_StorePassword). This field can be used to read such password-protected private keys. NOTE: This property defaults to the value of [StorePassword](#Certificate_f_StorePassword). To clear it, you must set the property to the empty string (""). It can be set at any time, but when the private key's password is different from the store's password, then it must be set before calling [PrivateKey](#Certificate_f_PrivateKey). **PrivateKey** *String (read-only)* *Default Value: ""* The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [PrivateKey](#Certificate_f_PrivateKey) may be available but not exportable. In this case, [PrivateKey](#Certificate_f_PrivateKey) returns an empty string. **PrivateKeyAvailable** *boolean (read-only)* *Default Value: False* Whether a [PrivateKey](#Certificate_f_PrivateKey) is available for the selected certificate. If [PrivateKeyAvailable](#Certificate_f_PrivateKeyAvailable) is True, the certificate may be used for authentication purposes (e.g., server authentication). **PrivateKeyContainer** *String (read-only)* *Default Value: ""* The name of the [PrivateKey](#Certificate_f_PrivateKey) container for the certificate (if available). This functionality is available only on Windows platforms. **PublicKey** *String (read-only)* *Default Value: ""* The public key of the certificate. The key is provided as PEM/Base64-encoded data. **PublicKeyAlgorithm** *String (read-only)* *Default Value: ""* 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. **PublicKeyLength** *int (read-only)* *Default Value: 0* The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. **SerialNumber** *String (read-only)* *Default Value: ""* 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. **SignatureAlgorithm** *String (read-only)* *Default Value: ""* 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. **Store** *String* *Default Value: "MY"* The name of the certificate store for the client certificate. The [StoreType](#Certificate_f_StoreType) field denotes the type of the certificate store specified by [Store](#Certificate_f_Store). If the store is password-protected, specify the password in [StorePassword](#Certificate_f_StorePassword). [Store](#Certificate_f_Store) is used in conjunction with the [Subject](#Certificate_f_Subject) field to specify client certificates. If [Store](#Certificate_f_Store) has a value, and [Subject](#Certificate_f_Subject) or [Encoded](#Certificate_f_Encoded) is set, a search for a certificate is initiated. Please see the [Subject](#Certificate_f_Subject) field 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. | In Java, the certificate store normally is a file containing certificates and optional private keys. 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). **StoreB** *byte[]* *Default Value: "MY"* The name of the certificate store for the client certificate. The [StoreType](#Certificate_f_StoreType) field denotes the type of the certificate store specified by [Store](#Certificate_f_Store). If the store is password-protected, specify the password in [StorePassword](#Certificate_f_StorePassword). [Store](#Certificate_f_Store) is used in conjunction with the [Subject](#Certificate_f_Subject) field to specify client certificates. If [Store](#Certificate_f_Store) has a value, and [Subject](#Certificate_f_Subject) or [Encoded](#Certificate_f_Encoded) is set, a search for a certificate is initiated. Please see the [Subject](#Certificate_f_Subject) field 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. | In Java, the certificate store normally is a file containing certificates and optional private keys. 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). **StorePassword** *String* *Default Value: ""* If the type of certificate store requires a password, this field is used to specify the password needed to open the certificate store. **StoreType** *int* *Default Value: 0* 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 field 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](#certificate-type) object and pass cstPKCS11 as the [StoreType](#Certificate_f_StoreType), the full path of the PKCS#11 DLL as the [Store](#Certificate_f_Store), and the PIN as the [StorePassword](#Certificate_f_StorePassword). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](CertMgr.md#CertMgr) class by calling the [ListStoreCertificates](CertMgr.md#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](CertMgr.md#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [Store](#Certificate_f_Store) and set [StorePassword](#Certificate_f_StorePassword) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. | **SubjectAltNames** *String (read-only)* *Default Value: ""* Comma-separated lists of alternative subject names for the certificate. **ThumbprintMD5** *String (read-only)* *Default Value: ""* 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. **ThumbprintSHA1** *String (read-only)* *Default Value: ""* 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. **ThumbprintSHA256** *String (read-only)* *Default Value: ""* 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. **Usage** *String (read-only)* *Default Value: ""* The text description of [UsageFlags](#Certificate_f_UsageFlags). 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. **UsageFlags** *int (read-only)* *Default Value: 0* The flags that show intended use for the certificate. The value of [UsageFlags](#Certificate_f_UsageFlags) 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 [Usage](#Certificate_f_Usage) field for a text representation of [UsageFlags](#Certificate_f_UsageFlags). This functionality currently is not available when the provider is OpenSSL. **Version** *String (read-only)* *Default Value: ""* The certificate's version number. The possible values are the strings "V1", "V2", and "V3". **Subject** *String* *Default Value: ""* The subject of the certificate used for client authentication. This field will be populated with the full subject of the loaded certificate. When loading a certificate, the subject is used to locate the certificate in the store. 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. **Encoded** *String* *Default Value: ""* The certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The [Store](#Certificate_f_Store) and [Subject](#Certificate_f_Subject) fields also may be used to specify a certificate. When [Encoded](#Certificate_f_Encoded) is set, a search is initiated in the current [Store](#Certificate_f_Store) for the private key of the certificate. If the key is found, [Subject](#Certificate_f_Subject) is updated to reflect the full subject of the selected certificate; otherwise, [Subject](#Certificate_f_Subject) is set to an empty string. **EncodedB** *byte[]* *Default Value: ""* The certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The [Store](#Certificate_f_Store) and [Subject](#Certificate_f_Subject) fields also may be used to specify a certificate. When [Encoded](#Certificate_f_Encoded) is set, a search is initiated in the current [Store](#Certificate_f_Store) for the private key of the certificate. If the key is found, [Subject](#Certificate_f_Subject) is updated to reflect the full subject of the selected certificate; otherwise, [Subject](#Certificate_f_Subject) is set to an empty string. ## Constructors ```text public Certificate(); ``` Creates a instance whose properties can be set. ```text public Certificate(String certificateFile); ``` Opens * CertificateFile * and reads out the contents as an X.509 public key. ```text public Certificate(byte[] encoded); ``` Parses * Encoded * as an X.509 public key. ```text public Certificate(int storeType, String store, String storePassword, String subject); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a file containing the certificate store. * StorePassword * is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format. ```text public Certificate(int storeType, String store, String storePassword, String subject, String configurationString); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a file containing the certificate store. * StorePassword * is the password used to protect the store. * ConfigurationString * is a newline-separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CryptoAPI option. The default value is True (the key is persisted). "Thumbprint" - an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to the * cstUser * , * cstMachine * , * cstPublicKeyFile * , and * cstPFXFile * store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations. After the store has been successfully opened, the class will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format. ```text public Certificate(int storeType, String store, String storePassword, byte[] encoded); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a file containing the certificate store. * StorePassword * is the password used to protect the store. After the store has been successfully opened, the class will load * Encoded * as an X.509 certificate and search the opened store for a corresponding private key. ```text public Certificate(int storeType, byte[] store, String storePassword, String subject); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a byte array containing the certificate data. * StorePassword * is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format. ```text public Certificate(int storeType, byte[] store, String storePassword, String subject, String configurationString); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a byte array containing the certificate data. * StorePassword * is the password used to protect the store. After the store has been successfully opened, the class will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format. ```text public Certificate(int storeType, byte[] store, String storePassword, byte[] encoded); ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a byte array containing the certificate data. * StorePassword * is the password used to protect the store. After the store has been successfully opened, the class will load * Encoded * as an X.509 certificate and search the opened store for a corresponding private key. # Header Type This is an HTTP header as it is received from the server. ## Remarks When a header is received through a Header event, it is parsed into a [Header](#header-type) type. This type contains a [Field](#Header_f_Field), and its corresponding [Value](#Header_f_Value). The following fields are available: - [Field](#Header_f_Field) - [Value](#Header_f_Value) ## Fields **Field** *String* *Default Value: ""* This field contains the name of the HTTP [Header](#header-type) (this is the same case as it is delivered). **Value** *String* *Default Value: ""* This field contains the [Header](#header-type) contents. ## Constructors ```text public Header(); ``` ```text public Header(String field, String value); ``` # 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-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-smime-class) is False. **CloseInputStreamAfterProcess**: Determines whether or not the input stream is closed after processing.This configuration setting determines whether or not the input stream set by [SetInputStream](#setinputstream-method-smime-class) is closed after processing is complete. The default value is False. **CloseOutputStreamAfterProcess**: Determines whether or not the output stream is closed after processing.This configuration setting determines whether or not the output stream set by [SetOutputStream](#setoutputstream-method-smime-class) is closed after processing is complete. The default value 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-smime-class), [Encrypt](#encrypt-method-smime-class), or [SignAndEncrypt](#signandencrypt-method-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-smime-class), [Encrypt](#encrypt-method-smime-class), or [SignAndEncrypt](#signandencrypt-method-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-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-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-smime-class) or [SignAndEncrypt](#signandencrypt-method-smime-class) and [DetachedSignature](#detachedsignature-property-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-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-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-smime-class) or [SignAndEncrypt](#signandencrypt-method-smime-class) and [DetachedSignature](#detachedsignature-property-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](#inputmessageheaders-property-smime-class). **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](#inputmessageheaders-property-smime-class). **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-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" **OAEPParams**: The hex encoded OAEP parameters.This configuration setting optionally specifies Optimal Asymmetric Encryption Padding (OAEP) parameters to be used when [UseOAEP](#useoaep-property-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-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-smime-class), or [DecryptAndVerifySignature](#decryptandverifysignature-method-smime-class) are called. These headers will be placed in the [InternalHeaders](#internalheaders-property-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-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. **VerifyCertChain**: Whether to verify the certificate chain of the certificate used to sign the message.This configuration setting specifies whether the signer certificate used to sign the message is validated when [VerifySignature](#verifysignature-method-smime-class) is called. If set to True, the class will verify that the issuer(s) of the signer certificate are valid and trusted on the system. If set to False (default), the certificate chain is not validated. NOTE: This setting does not affect whether the digital signature of the signed message is verified. This setting affects only whether the trust and validity of the signer certificate chain is evaluated. ### 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. **GUIAvailable**: Whether or not a message loop is available for processing events.In a GUI-based application, long-running blocking operations may cause the application to stop responding to input until the operation returns. The class will attempt to discover whether or not the application has a message loop and, if one is discovered, it will process events in that message loop during any such blocking operation. In some non-GUI applications, an invalid message loop may be discovered that will result in errant behavior. In these cases, setting [GUIAvailable](#GUIAvailable) to *false* will ensure that the class does not attempt to process external events. **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*. **UseDaemonThreads**: Whether threads created by the class are daemon threads.If set to True (default), when the class creates a thread, the thread's Daemon property will be explicitly set to True. When set to False, the class will not set the Daemon property on the created thread. The default value is True. **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. This setting is set to *false* by default on all platforms. **UseVirtualThreads**: Whether threads created by the class use virtual threads instead of platform threads.If set to *true*, when the class creates a thread, it will be created as a virtual thread instead of a platform thread. Virtual threads are lightweight threads managed by the JVM that are multiplexed onto a small pool of carrier threads, significantly reducing memory usage and platform thread count under high-concurrency workloads. Requires Java 24 or later. The default value is *false*. # 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. |