SMIME Component
Properties Methods Events Config Settings Errors
The S/MIME class implements the S/MIME standard for encryption and decryption with public key cryptography and X.509 digital certificates.
Syntax
ipworkssmime.SMIME
Remarks
The S/MIME struct implements the S/MIME V3 standard for encryption and decryption using Public Key Cryptography Standards (PKCS). In addition, the struct can be used to both generate and verify RSA digital signatures. Using this struct 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 struct will determine the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
When a valid source is found, the search stops. The order in which the output properties are checked is as follows:
- OutputFile
- OutputMessage: The output data is written to this property if no other destination is specified.
The headers of the input message (if any) will be read from InputMessageHeaders or InputMessageHeadersString.
The headers of the resulting message will be available in the OutputMessageHeaders and OutputMessageHeadersString properties.
Signing
To sign the current data included in the input message with a certificate, the Certificate property must be set to a valid Certificate object for the signing certificate. The IncludeCertificate and DetachedSignature properties allow you to specify additional details about the signing process. By setting IncludeCertificate 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 struct can also generate PKCS #7 formatted detached digital signatures and envelopes by specifying DetachedSignature.
Encrypting
To encrypt a message with the struct in a PKCS envelope, you must first specify the Certificate for each recipient in the RecipientCerts properties to encrypt the message with. You can easily add these with the AddRecipientCert method. Once you have done this you can call the Encrypt method to encrypt the message with the recipient certificates.
In addition, the struct allows you to sign and encrypt simultaneously with the SignAndEncrypt method. You must set all of the properties needed for both Sign and Encrypt
The result of the encrypted or signed data will be replaced in the OutputMessage property and the OutputMessageHeaders property will be filled with the appropriate mime headers if applicable.
Decrypting
Decrypting PKCS envelopes is handled with the Decrypt method. When this method is called, the struct will attempt to find an appropriate certificate in the Certificate property that matches the encrypting certificate. If it cannot find an appropriate certificate, an exception will be thrown and the message will not be decrypted.
Verifying Signatures
In addition, the S/MIME struct can be used to verify signatures included in signed messages or documents. After specifying the input, VerifySignature 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 struct will not be able to verify the signature. If VerifySignature is successful, the SignerCert and SignerCertChain properties will be filled with the certificate information of the message signer. This information can be used to verify the signing certificates.
Similar to SignAndEncrypt, DecryptAndVerifySignature 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 component with short descriptions. Click on the links for further details.
| CertEffectiveDate | The date on which this certificate becomes valid. |
| CertExpirationDate | The date on which the certificate expires. |
| CertExtendedKeyUsage | A comma-delimited list of extended key usage identifiers. |
| CertFingerprint | The hex-encoded, 16-byte MD5 fingerprint of the certificate. |
| CertFingerprintSHA1 | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
| CertFingerprintSHA256 | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
| CertIssuer | The issuer of the certificate. |
| CertPrivateKey | The private key of the certificate (if available). |
| CertPrivateKeyAvailable | Whether a PrivateKey is available for the selected certificate. |
| CertPrivateKeyContainer | The name of the PrivateKey container for the certificate (if available). |
| CertPublicKey | The public key of the certificate. |
| CertPublicKeyAlgorithm | The textual description of the certificate's public key algorithm. |
| CertPublicKeyLength | The length of the certificate's public key (in bits). |
| CertSerialNumber | The serial number of the certificate encoded as a string. |
| CertSignatureAlgorithm | The text description of the certificate's signature algorithm. |
| CertStore | The name of the certificate store for the client certificate. |
| CertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
| CertStoreType | The type of certificate store for this certificate. |
| CertSubjectAltNames | Comma-separated lists of alternative subject names for the certificate. |
| CertThumbprintMD5 | The MD5 hash of the certificate. |
| CertThumbprintSHA1 | The SHA-1 hash of the certificate. |
| CertThumbprintSHA256 | The SHA-256 hash of the certificate. |
| CertUsage | The text description of UsageFlags . |
| CertUsageFlags | The flags that show intended use for the certificate. |
| CertVersion | The certificate's version number. |
| CertSubject | The subject of the certificate used for client authentication. |
| CertEncoded | The certificate (PEM/Base64 encoded). |
| DetachedSignature | This property specifies whether to include a detached signature when signing a message. |
| EncryptingAlgorithm | The property includes textual description of the encrypting algorithm. |
| IncludeCertificate | This property specifies whether to include the signer's certificate with the signed message. |
| IncludeChain | This property specifies whether to include the signer's certificate chain with the signed message. |
| IncludeHeaders | This property tells the class whether to include the headers when encoding the message. |
| InputFile | This property includes the file to process. |
| InputMessage | This property includes the message to process. |
| InputMessageHeaderCount | The number of records in the InputMessageHeader arrays. |
| InputMessageHeaderField | This property contains the name of the HTTP header (this is the same case as it is delivered). |
| InputMessageHeaderValue | This property contains the header contents. |
| InputMessageHeadersString | This property includes the string version of headers from the S/MIME message. |
| InternalHeaders | This property includes the headers of the MIME entity inside the encrypted or signed message. |
| OutputFile | This property specifies the output file. |
| OutputMessage | This property includes the output message after processing. |
| OutputMessageHeaderCount | The number of records in the OutputMessageHeader arrays. |
| OutputMessageHeaderField | This property contains the name of the HTTP header (this is the same case as it is delivered). |
| OutputMessageHeaderValue | This property contains the header contents. |
| OutputMessageHeadersString | This property includes a string version of headers from the S/MIME message. |
| Overwrite | This property indicates whether or not the class should overwrite files. |
| RecipientCertCount | The number of records in the RecipientCert arrays. |
| RecipientCertEffectiveDate | The date on which this certificate becomes valid. |
| RecipientCertExpirationDate | The date on which the certificate expires. |
| RecipientCertExtendedKeyUsage | A comma-delimited list of extended key usage identifiers. |
| RecipientCertFingerprint | The hex-encoded, 16-byte MD5 fingerprint of the certificate. |
| RecipientCertFingerprintSHA1 | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
| RecipientCertFingerprintSHA256 | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
| RecipientCertIssuer | The issuer of the certificate. |
| RecipientCertPrivateKey | The private key of the certificate (if available). |
| RecipientCertPrivateKeyAvailable | Whether a PrivateKey is available for the selected certificate. |
| RecipientCertPrivateKeyContainer | The name of the PrivateKey container for the certificate (if available). |
| RecipientCertPublicKey | The public key of the certificate. |
| RecipientCertPublicKeyAlgorithm | The textual description of the certificate's public key algorithm. |
| RecipientCertPublicKeyLength | The length of the certificate's public key (in bits). |
| RecipientCertSerialNumber | The serial number of the certificate encoded as a string. |
| RecipientCertSignatureAlgorithm | The text description of the certificate's signature algorithm. |
| RecipientCertStore | The name of the certificate store for the client certificate. |
| RecipientCertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
| RecipientCertStoreType | The type of certificate store for this certificate. |
| RecipientCertSubjectAltNames | Comma-separated lists of alternative subject names for the certificate. |
| RecipientCertThumbprintMD5 | The MD5 hash of the certificate. |
| RecipientCertThumbprintSHA1 | The SHA-1 hash of the certificate. |
| RecipientCertThumbprintSHA256 | The SHA-256 hash of the certificate. |
| RecipientCertUsage | The text description of UsageFlags . |
| RecipientCertUsageFlags | The flags that show intended use for the certificate. |
| RecipientCertVersion | The certificate's version number. |
| RecipientCertSubject | The subject of the certificate used for client authentication. |
| RecipientCertEncoded | The certificate (PEM/Base64 encoded). |
| SignerCertEffectiveDate | The date on which this certificate becomes valid. |
| SignerCertExpirationDate | The date on which the certificate expires. |
| SignerCertExtendedKeyUsage | A comma-delimited list of extended key usage identifiers. |
| SignerCertFingerprint | The hex-encoded, 16-byte MD5 fingerprint of the certificate. |
| SignerCertFingerprintSHA1 | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
| SignerCertFingerprintSHA256 | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
| SignerCertIssuer | The issuer of the certificate. |
| SignerCertPrivateKey | The private key of the certificate (if available). |
| SignerCertPrivateKeyAvailable | Whether a PrivateKey is available for the selected certificate. |
| SignerCertPrivateKeyContainer | The name of the PrivateKey container for the certificate (if available). |
| SignerCertPublicKey | The public key of the certificate. |
| SignerCertPublicKeyAlgorithm | The textual description of the certificate's public key algorithm. |
| SignerCertPublicKeyLength | The length of the certificate's public key (in bits). |
| SignerCertSerialNumber | The serial number of the certificate encoded as a string. |
| SignerCertSignatureAlgorithm | The text description of the certificate's signature algorithm. |
| SignerCertStore | The name of the certificate store for the client certificate. |
| SignerCertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
| SignerCertStoreType | The type of certificate store for this certificate. |
| SignerCertSubjectAltNames | Comma-separated lists of alternative subject names for the certificate. |
| SignerCertThumbprintMD5 | The MD5 hash of the certificate. |
| SignerCertThumbprintSHA1 | The SHA-1 hash of the certificate. |
| SignerCertThumbprintSHA256 | The SHA-256 hash of the certificate. |
| SignerCertUsage | The text description of UsageFlags . |
| SignerCertUsageFlags | The flags that show intended use for the certificate. |
| SignerCertVersion | The certificate's version number. |
| SignerCertSubject | The subject of the certificate used for client authentication. |
| SignerCertEncoded | The certificate (PEM/Base64 encoded). |
| SignerCertChainCount | The number of records in the SignerCertChain arrays. |
| SignerCertChainEffectiveDate | The date on which this certificate becomes valid. |
| SignerCertChainExpirationDate | The date on which the certificate expires. |
| SignerCertChainExtendedKeyUsage | A comma-delimited list of extended key usage identifiers. |
| SignerCertChainFingerprint | The hex-encoded, 16-byte MD5 fingerprint of the certificate. |
| SignerCertChainFingerprintSHA1 | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. |
| SignerCertChainFingerprintSHA256 | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. |
| SignerCertChainIssuer | The issuer of the certificate. |
| SignerCertChainPrivateKey | The private key of the certificate (if available). |
| SignerCertChainPrivateKeyAvailable | Whether a PrivateKey is available for the selected certificate. |
| SignerCertChainPrivateKeyContainer | The name of the PrivateKey container for the certificate (if available). |
| SignerCertChainPublicKey | The public key of the certificate. |
| SignerCertChainPublicKeyAlgorithm | The textual description of the certificate's public key algorithm. |
| SignerCertChainPublicKeyLength | The length of the certificate's public key (in bits). |
| SignerCertChainSerialNumber | The serial number of the certificate encoded as a string. |
| SignerCertChainSignatureAlgorithm | The text description of the certificate's signature algorithm. |
| SignerCertChainStore | The name of the certificate store for the client certificate. |
| SignerCertChainStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
| SignerCertChainStoreType | The type of certificate store for this certificate. |
| SignerCertChainSubjectAltNames | Comma-separated lists of alternative subject names for the certificate. |
| SignerCertChainThumbprintMD5 | The MD5 hash of the certificate. |
| SignerCertChainThumbprintSHA1 | The SHA-1 hash of the certificate. |
| SignerCertChainThumbprintSHA256 | The SHA-256 hash of the certificate. |
| SignerCertChainUsage | The text description of UsageFlags . |
| SignerCertChainUsageFlags | The flags that show intended use for the certificate. |
| SignerCertChainVersion | The certificate's version number. |
| SignerCertChainSubject | The subject of the certificate used for client authentication. |
| SignerCertChainEncoded | The certificate (PEM/Base64 encoded). |
| SigningAlgorithm | This property includes a textual description of the signature hash algorithm. |
| UseOAEP | This property specifies whether or not to use Optimal Asymmetric Encryption Padding (OAEP). |
| UsePSS | 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 component with short descriptions. Click on the links for further details.
| AddRecipientCert | This method is used to add recipient certificates used to encrypt messages. |
| CheckMessageEncrypted | This method checks whether or not the current message is encrypted. |
| CheckMessageSigned | This method checks whether or not the current message is signed. |
| Config | Sets or retrieves a configuration setting. |
| Decrypt | This method decrypts the current Message . |
| DecryptAndVerifySignature | This method decrypts and verifies the signature of the current message. |
| Encrypt | This method encrypts the message. |
| GetRecipientInfo | This method gets the recipient information for an encrypted message. |
| GetSignerCertInfo | This method gets the signature information for an signed message. |
| Reset | This method resets the class properties. |
| Sign | This method signs the current message. |
| SignAndEncrypt | This method signs and encrypts the current message. |
| VerifySignature | This method verifies the signature of the current message. |
Event List
The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.
| Error | Fired when information is available about errors during data delivery. |
| RecipientInfo | This event is fired for each recipient certificate of the encrypted message. |
| SignerCertInfo | This event is fired during verification of the signed message. |
Config Settings
The following is a list of config settings for the component with short descriptions. Click on the links for further details.
| ApplyB64Encoding | Instructs the class to base64 encode the message when signing or encrypting. |
| CSP | The Cryptographic Service Provider. |
| GenerateSignatureTimestamp | Whether to generate timestamps in signatures. |
| IncludeHeaders | Tells the class whether to include the headers when encoding the message. |
| IncludeInternalHeaders | Tells the class whether or not to include the internal headers when encoding the message. |
| InputContentTransferEncoding | Sets the Content-Transfer-Encoding for the signed message. |
| InputContentType | Sets the Content-Type for the signed message. |
| InputMessageEncrypted | Whether or not the input message is encrypted. |
| InputMessageSigned | Whether or not the input message is signed. |
| NormalizeCRLF | Whether or not the class will normalize line endings of the input data to CrLf. |
| OAEPMGF1HashAlgorithm | The MGF1 hash algorithm used with OAEP. |
| OAEPParams | The hex encoded OAEP parameters. |
| OAEPRSAHashAlgorithm | The RSA hash algorithm used with OAEP. |
| ParseInternalHeaders | Tells the class whether or not to parse the message part headers when decrypting a message. |
| RecipientCert | Used to specify the public certificate when using a PEM key to decrypt. |
| RecipientCertFile | Used to specify the public certificate file when using a PEM key to decrypt. |
| RecipientInfoType | The type of signer information to include in the signed message. |
| SignerInfoType | The type of signer information to include in the signed message. |
| UseAlgorithmOIDs | Whether OIDs are used when providing information about the algorithms. |
| UseCryptoAPI | Whether to use the Microsoft Crypto API for cryptographic message generation. |
| BuildInfo | Information about the product's build. |
| CodePage | The system code page used for Unicode to Multibyte translations. |
| LicenseInfo | Information about the current license. |
| MaskSensitiveData | Whether sensitive data is masked in log messages. |
| UseInternalSecurityAPI | Whether or not to use the system security libraries or an internal implementation. |
CertEffectiveDate Property (SMIME Component)
The date on which this certificate becomes valid.
Syntax
func (obj *SMIME) CertEffectiveDate() (string, error)
Default Value
""
Remarks
The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2000 15:00:00.
This property is read-only.
Data Type
string
CertExpirationDate Property (SMIME Component)
The date on which the certificate expires.
Syntax
func (obj *SMIME) CertExpirationDate() (string, error)
Default Value
""
Remarks
The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2001 15:00:00.
This property is read-only.
Data Type
string
CertExtendedKeyUsage Property (SMIME Component)
A comma-delimited list of extended key usage identifiers.
Syntax
func (obj *SMIME) CertExtendedKeyUsage() (string, error)
Default Value
""
Remarks
A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
This property is read-only.
Data Type
string
CertFingerprint Property (SMIME Component)
The hex-encoded, 16-byte MD5 fingerprint of the certificate.
Syntax
func (obj *SMIME) CertFingerprint() (string, error)
Default Value
""
Remarks
The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02
This property is read-only.
Data Type
string
CertFingerprintSHA1 Property (SMIME Component)
The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
Syntax
func (obj *SMIME) CertFingerprintSHA1() (string, error)
Default Value
""
Remarks
The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84
This property is read-only.
Data Type
string
CertFingerprintSHA256 Property (SMIME Component)
The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
Syntax
func (obj *SMIME) CertFingerprintSHA256() (string, error)
Default Value
""
Remarks
The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53
This property is read-only.
Data Type
string
CertIssuer Property (SMIME Component)
The issuer of the certificate.
Syntax
func (obj *SMIME) CertIssuer() (string, error)
Default Value
""
Remarks
The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.
This property is read-only.
Data Type
string
CertPrivateKey Property (SMIME Component)
The private key of the certificate (if available).
Syntax
func (obj *SMIME) CertPrivateKey() (string, error)
Default Value
""
Remarks
The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
NOTE: The CertPrivateKey may be available but not exportable. In this case, CertPrivateKey returns an empty string.
This property is read-only.
Data Type
string
CertPrivateKeyAvailable Property (SMIME Component)
Whether a PrivateKey is available for the selected certificate.
Syntax
func (obj *SMIME) CertPrivateKeyAvailable() (bool, error)
Default Value
false
Remarks
Whether a CertPrivateKey is available for the selected certificate. If CertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).
This property is read-only.
Data Type
bool
CertPrivateKeyContainer Property (SMIME Component)
The name of the PrivateKey container for the certificate (if available).
Syntax
func (obj *SMIME) CertPrivateKeyContainer() (string, error)
Default Value
""
Remarks
The name of the CertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.
This property is read-only.
Data Type
string
CertPublicKey Property (SMIME Component)
The public key of the certificate.
Syntax
func (obj *SMIME) CertPublicKey() (string, error)
Default Value
""
Remarks
The public key of the certificate. The key is provided as PEM/Base64-encoded data.
This property is read-only.
Data Type
string
CertPublicKeyAlgorithm Property (SMIME Component)
The textual description of the certificate's public key algorithm.
Syntax
func (obj *SMIME) CertPublicKeyAlgorithm() (string, error)
Default Value
""
Remarks
The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.
This property is read-only.
Data Type
string
CertPublicKeyLength Property (SMIME Component)
The length of the certificate's public key (in bits).
Syntax
func (obj *SMIME) CertPublicKeyLength() (int32, error)
Default Value
0
Remarks
The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
This property is read-only.
Data Type
int32
CertSerialNumber Property (SMIME Component)
The serial number of the certificate encoded as a string.
Syntax
func (obj *SMIME) CertSerialNumber() (string, error)
Default Value
""
Remarks
The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.
This property is read-only.
Data Type
string
CertSignatureAlgorithm Property (SMIME Component)
The text description of the certificate's signature algorithm.
Syntax
func (obj *SMIME) CertSignatureAlgorithm() (string, error)
Default Value
""
Remarks
The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.
This property is read-only.
Data Type
string
CertStore Property (SMIME Component)
The name of the certificate store for the client certificate.
Syntax
func (obj *SMIME) CertStore() ([]byte, error)
func (obj *SMIME) SetCertStore(value []byte) error
Default Value
"MY"
Remarks
The name of the certificate store for the client certificate.
The CertStoreType property denotes the type of the certificate store specified by CertStore. If the store is password-protected, specify the password in CertStorePassword.
CertStore is used in conjunction with the CertSubject property to specify client certificates. If CertStore has a value, and CertSubject or CertEncoded is set, a search for a certificate is initiated. Please see the CertSubject property for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
| MY | A certificate store holding personal certificates with their associated private keys. |
| CA | Certifying authority certificates. |
| ROOT | Root certificates. |
When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
Data Type
[]byte
CertStorePassword Property (SMIME Component)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
func (obj *SMIME) CertStorePassword() (string, error)
func (obj *SMIME) SetCertStorePassword(value string) error
Default Value
""
Remarks
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Data Type
string
CertStoreType Property (SMIME Component)
The type of certificate store for this certificate.
Syntax
func (obj *SMIME) CertStoreType() (int32, error)
func (obj *SMIME) SetCertStoreType(value int32) error
Possible Values
0 // User
1 // Machine
2 // PFXFile
3 // PFXBlob
4 // JKSFile
5 // JKSBlob
6 // PEMKeyFile
7 // PEMKeyBlob
8 // PublicKeyFile
9 // PublicKeyBlob
10 // SSHPublicKeyBlob
11 // P7BFile
12 // P7BBlob
13 // SSHPublicKeyFile
14 // PPKFile
15 // PPKBlob
16 // XMLFile
17 // XMLBlob
18 // JWKFile
19 // JWKBlob
20 // SecurityKey
21 // BCFKSFile
22 // BCFKSBlob
23 // PKCS11
99 // Auto
Default Value
0
Remarks
The type of certificate store for this certificate.
The struct supports both public and private keys in a variety of formats. When the cstAuto value is used, the struct will automatically determine the type. This property can take one of the following values:
| 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
NOTE: This store type is not available in Java. |
| 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
NOTE: This store type is not available in Java. |
| 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
| 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
| 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
NOTE: This store type is only available in Java. |
| 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
NOTE: This store type is only available in Java. |
| 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
| 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
| 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
| 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
| 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
| 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
| 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
| 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
| 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
| 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
| 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
| 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
| 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
| 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
| 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
NOTE: This store type is only available in Java and .NET. |
| 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
NOTE: This store type is only available in Java and .NET. |
| 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, create a new Certificate object and pass cstPKCS11 as the CertStoreType, the full path of the PKCS#11 DLL as the CertStore, and the PIN as the CertStorePassword. Code Example. SSH Authentication with Security Key (without CertMgr):
Alternatively, collect the necessary data using the CertMgr struct by calling the ListStoreCertificates method after setting the corresponding properties accordingly. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the CertStore and set CertStorePassword to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr):
|
| 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
Data Type
int32
CertSubjectAltNames Property (SMIME Component)
Comma-separated lists of alternative subject names for the certificate.
Syntax
func (obj *SMIME) CertSubjectAltNames() (string, error)
Default Value
""
Remarks
Comma-separated lists of alternative subject names for the certificate.
This property is read-only.
Data Type
string
CertThumbprintMD5 Property (SMIME Component)
The MD5 hash of the certificate.
Syntax
func (obj *SMIME) CertThumbprintMD5() (string, error)
Default Value
""
Remarks
The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
string
CertThumbprintSHA1 Property (SMIME Component)
The SHA-1 hash of the certificate.
Syntax
func (obj *SMIME) CertThumbprintSHA1() (string, error)
Default Value
""
Remarks
The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
string
CertThumbprintSHA256 Property (SMIME Component)
The SHA-256 hash of the certificate.
Syntax
func (obj *SMIME) CertThumbprintSHA256() (string, error)
Default Value
""
Remarks
The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
string
CertUsage Property (SMIME Component)
The text description of UsageFlags .
Syntax
func (obj *SMIME) CertUsage() (string, error)
Default Value
""
Remarks
The text description of CertUsageFlags.
This value will be one or more of the following strings and will be separated by commas:
- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only
If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.
This property is read-only.
Data Type
string
CertUsageFlags Property (SMIME Component)
The flags that show intended use for the certificate.
Syntax
func (obj *SMIME) CertUsageFlags() (int32, error)
Default Value
0
Remarks
The flags that show intended use for the certificate. The value of CertUsageFlags is a combination of the following flags:
| 0x80 | Digital Signature |
| 0x40 | Non-Repudiation |
| 0x20 | Key Encipherment |
| 0x10 | Data Encipherment |
| 0x08 | Key Agreement |
| 0x04 | Certificate Signing |
| 0x02 | CRL Signing |
| 0x01 | Encipher Only |
Please see the CertUsage property for a text representation of CertUsageFlags.
This functionality currently is not available when the provider is OpenSSL.
This property is read-only.
Data Type
int32
CertVersion Property (SMIME Component)
The certificate's version number.
Syntax
func (obj *SMIME) CertVersion() (string, error)
Default Value
""
Remarks
The certificate's version number. The possible values are the strings "V1", "V2", and "V3".
This property is read-only.
Data Type
string
CertSubject Property (SMIME Component)
The subject of the certificate used for client authentication.
Syntax
func (obj *SMIME) CertSubject() (string, error)
func (obj *SMIME) SetCertSubject(value string) error
Default Value
""
Remarks
The subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:
| Field | Meaning |
| CN | Common Name. This is commonly a hostname like www.server.com. |
| O | Organization |
| OU | Organizational Unit |
| L | Locality |
| S | State |
| C | Country |
| E | Email Address |
If a field value contains a comma, it must be quoted.
Data Type
string
CertEncoded Property (SMIME Component)
The certificate (PEM/Base64 encoded).
Syntax
func (obj *SMIME) CertEncoded() ([]byte, error)
func (obj *SMIME) SetCertEncoded(value []byte) error
Default Value
""
Remarks
The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The CertStore and CertSubject properties also may be used to specify a certificate.
When CertEncoded is set, a search is initiated in the current CertStore for the private key of the certificate. If the key is found, CertSubject is updated to reflect the full subject of the selected certificate; otherwise, CertSubject is set to an empty string.
Data Type
[]byte
DetachedSignature Property (SMIME Component)
This property specifies whether to include a detached signature when signing a message.
Syntax
func (obj *SMIME) DetachedSignature() (bool, error)
func (obj *SMIME) SetDetachedSignature(value bool) error
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. This will create a message with two MIME parts, one with the contents of Message, and another with the detached signature.
If this property is False, the current contents of Message will be PKCS encoded and included with the signature in Message. This will create a single-part message with no MIME boundaries.
Data Type
bool
EncryptingAlgorithm Property (SMIME Component)
The property includes textual description of the encrypting algorithm.
Syntax
func (obj *SMIME) EncryptingAlgorithm() (string, error)
func (obj *SMIME) SetEncryptingAlgorithm(value string) error
Default Value
"3DES"
Remarks
This property contains either the name of the algorithm (such as 3DES or AES), or an object identifier (OID) string representing the algorithm.
Possible values are as follows:
- "3DES"
- "DES"
- "RC2CBC40"
- "RC2CBC64"
- "RC2CBC128" or "RC2"
- "AESCBC128" or "AES"
- "AESCBC192"
- "AESCBC256"
- "AESGCM128" or "AESGCM"
- "AESGCM192"
- "AESGCM256"
Data Type
string
IncludeCertificate Property (SMIME Component)
This property specifies whether to include the signer's certificate with the signed message.
Syntax
func (obj *SMIME) IncludeCertificate() (bool, error)
func (obj *SMIME) SetIncludeCertificate(value bool) error
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 or SignAndEncrypt.
Including a certificate is the preferred method of building signed messages. If you do not include a certificate, the message recipient may not be able to verify the sender's signature.
Data Type
bool
IncludeChain Property (SMIME Component)
This property specifies whether to include the signer's certificate chain with the signed message.
Syntax
func (obj *SMIME) IncludeChain() (bool, error)
func (obj *SMIME) SetIncludeChain(value bool) error
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 or SignAndEncrypt.
NOTE: To include the chain, the IncludeCertificate property must also be set to true.
Data Type
bool
IncludeHeaders Property (SMIME Component)
This property tells the class whether to include the headers when encoding the message.
Syntax
func (obj *SMIME) IncludeHeaders() (bool, error)
func (obj *SMIME) SetIncludeHeaders(value bool) error
Default Value
false
Remarks
If True, the struct will include the headers when Sign, Encrypt, or SignAndEncrypt are called. If False, only the message will be encoded.
The default value for IncludeHeaders is False.
Data Type
bool
InputFile Property (SMIME Component)
This property includes the file to process.
Syntax
func (obj *SMIME) InputFile() (string, error)
func (obj *SMIME) SetInputFile(value string) error
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 struct will determine the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
- InputFile
- InputMessage
When a valid source is found, the search stops. The order in which the output properties are checked is as follows:
- OutputFile
- OutputMessage: The output data is written to this property if no other destination is specified.
The headers of the input message (if any) will be read from InputMessageHeaders or InputMessageHeadersString.
Data Type
string
InputMessage Property (SMIME Component)
This property includes the message to process.
Syntax
func (obj *SMIME) InputMessage() ([]byte, error)
func (obj *SMIME) SetInputMessage(value []byte) error
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 struct will determine the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
- InputFile
- InputMessage
When a valid source is found, the search stops. The order in which the output properties are checked is as follows:
- OutputFile
- OutputMessage: The output data is written to this property if no other destination is specified.
The headers of the input message (if any) will be read from InputMessageHeaders or InputMessageHeadersString.
Data Type
[]byte
InputMessageHeaderCount Property (SMIME Component)
The number of records in the InputMessageHeader arrays.
Syntax
func (obj *SMIME) InputMessageHeaderCount() (int32, error)
func (obj *SMIME) SetInputMessageHeaderCount(value int32) error
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at InputMessageHeaderCount - 1.Data Type
int32
InputMessageHeaderField Property (SMIME Component)
This property contains the name of the HTTP header (this is the same case as it is delivered).
Syntax
func (obj *SMIME) InputMessageHeaderField(InputMessageHeaderIndex int32) (string, error)
func (obj *SMIME) SetInputMessageHeaderField(InputMessageHeaderIndex int32, value string) error
Default Value
""
Remarks
This property contains the name of the HTTP Header (this is the same case as it is delivered).
The InputMessageHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the InputMessageHeaderCount property.
Data Type
string
InputMessageHeaderValue Property (SMIME Component)
This property contains the header contents.
Syntax
func (obj *SMIME) InputMessageHeaderValue(InputMessageHeaderIndex int32) (string, error)
func (obj *SMIME) SetInputMessageHeaderValue(InputMessageHeaderIndex int32, value string) error
Default Value
""
Remarks
This property contains the Header contents.
The InputMessageHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the InputMessageHeaderCount property.
Data Type
string
InputMessageHeadersString Property (SMIME Component)
This property includes the string version of headers from the S/MIME message.
Syntax
func (obj *SMIME) InputMessageHeadersString() (string, error)
func (obj *SMIME) SetInputMessageHeadersString(value string) error
Default Value
""
Remarks
This property contains the string version of headers from the S/MIME message.
This property may be set to the headers of the message that will be decrypted/verified.
Data Type
string
InternalHeaders Property (SMIME Component)
This property includes the headers of the MIME entity inside the encrypted or signed message.
Syntax
func (obj *SMIME) InternalHeaders() (string, error)
func (obj *SMIME) SetInternalHeaders(value string) error
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.
Data Type
string
OutputFile Property (SMIME Component)
This property specifies the output file.
Syntax
func (obj *SMIME) OutputFile() (string, error)
func (obj *SMIME) SetOutputFile(value string) error
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 struct will determine the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
When a valid source is found, the search stops. The order in which the output properties are checked is as follows:
- OutputFile
- OutputMessage: The output data is written to this property if no other destination is specified.
The headers of the resulting message will be available in the OutputMessageHeaders and OutputMessageHeadersString properties.
Data Type
string
OutputMessage Property (SMIME Component)
This property includes the output message after processing.
Syntax
func (obj *SMIME) OutputMessage() ([]byte, error)
Default Value
""
Remarks
This property will be populated with the output of the operation if OutputFile is not set.
Encrypt and/or Sign
When encrypting or signing, this will hold the fully encoded S/MIME message.
Decrypt and/or Verify
When decrypting or verifying a signature, this will hold the decrypted/verified content.
Input and Output Properties
The struct will determine the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
When a valid source is found, the search stops. The order in which the output properties are checked is as follows:
- OutputFile
- OutputMessage: The output data is written to this property if no other destination is specified.
The headers of the resulting message will be available in the OutputMessageHeaders and OutputMessageHeadersString properties.
This property is read-only.
Data Type
[]byte
OutputMessageHeaderCount Property (SMIME Component)
The number of records in the OutputMessageHeader arrays.
Syntax
func (obj *SMIME) OutputMessageHeaderCount() (int32, error)
Default Value
0
Remarks
This property controls the size of the following arrays:
The array indices start at 0 and end at OutputMessageHeaderCount - 1.This property is read-only.
Data Type
int32
OutputMessageHeaderField Property (SMIME Component)
This property contains the name of the HTTP header (this is the same case as it is delivered).
Syntax
func (obj *SMIME) OutputMessageHeaderField(OutputMessageHeaderIndex int32) (string, error)
Default Value
""
Remarks
This property contains the name of the HTTP Header (this is the same case as it is delivered).
The OutputMessageHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OutputMessageHeaderCount property.
This property is read-only.
Data Type
string
OutputMessageHeaderValue Property (SMIME Component)
This property contains the header contents.
Syntax
func (obj *SMIME) OutputMessageHeaderValue(OutputMessageHeaderIndex int32) (string, error)
Default Value
""
Remarks
This property contains the Header contents.
The OutputMessageHeaderIndex parameter specifies the index of the item in the array. The size of the array is controlled by the OutputMessageHeaderCount property.
This property is read-only.
Data Type
string
OutputMessageHeadersString Property (SMIME Component)
This property includes a string version of headers from the S/MIME message.
Syntax
func (obj *SMIME) OutputMessageHeadersString() (string, error)
Default Value
""
Remarks
This property contains the string version of headers from the S/MIME message. The struct will populate this property after signing and/or encrypting.
The user should use these additional headers when emailing or sending the OutputMessage. This can be done by including these headers in the OtherHeaders property of the struct that you wish to send the message with.
After the decryption or verification, this property contains the headers of the verified or decrypted message.
This property is read-only.
Data Type
string
Overwrite Property (SMIME Component)
This property indicates whether or not the class should overwrite files.
Syntax
func (obj *SMIME) Overwrite() (bool, error)
func (obj *SMIME) SetOverwrite(value bool) error
Default Value
true
Remarks
This property indicates whether or not the struct will overwrite OutputFile. If Overwrite is False, an error will be thrown whenever OutputFile exists before an operation. The default value is False.
Data Type
bool
RecipientCertCount Property (SMIME Component)
The number of records in the RecipientCert arrays.
Syntax
func (obj *SMIME) RecipientCertCount() (int32, error)
func (obj *SMIME) SetRecipientCertCount(value int32) error
Default Value
0
Remarks
This property controls the size of the following arrays:
- RecipientCertEffectiveDate
- RecipientCertEncoded
- RecipientCertExpirationDate
- RecipientCertExtendedKeyUsage
- RecipientCertFingerprint
- RecipientCertFingerprintSHA1
- RecipientCertFingerprintSHA256
- RecipientCertIssuer
- RecipientCertPrivateKey
- RecipientCertPrivateKeyAvailable
- RecipientCertPrivateKeyContainer
- RecipientCertPublicKey
- RecipientCertPublicKeyAlgorithm
- RecipientCertPublicKeyLength
- RecipientCertSerialNumber
- RecipientCertSignatureAlgorithm
- RecipientCertStore
- RecipientCertStorePassword
- RecipientCertStoreType
- RecipientCertSubject
- RecipientCertSubjectAltNames
- RecipientCertThumbprintMD5
- RecipientCertThumbprintSHA1
- RecipientCertThumbprintSHA256
- RecipientCertUsage
- RecipientCertUsageFlags
- RecipientCertVersion
Data Type
int32
RecipientCertEffectiveDate Property (SMIME Component)
The date on which this certificate becomes valid.
Syntax
func (obj *SMIME) RecipientCertEffectiveDate(RecipientCertIndex int32) (string, error)
Default Value
""
Remarks
The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2000 15:00:00.
The RecipientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientCertCount property.
This property is read-only.
Data Type
string
RecipientCertExpirationDate Property (SMIME Component)
The date on which the certificate expires.
Syntax
func (obj *SMIME) RecipientCertExpirationDate(RecipientCertIndex int32) (string, error)
Default Value
""
Remarks
The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2001 15:00:00.
The RecipientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientCertCount property.
This property is read-only.
Data Type
string
RecipientCertExtendedKeyUsage Property (SMIME Component)
A comma-delimited list of extended key usage identifiers.
Syntax
func (obj *SMIME) RecipientCertExtendedKeyUsage(RecipientCertIndex int32) (string, error)
Default Value
""
Remarks
A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
The RecipientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientCertCount property.
This property is read-only.
Data Type
string
RecipientCertFingerprint Property (SMIME Component)
The hex-encoded, 16-byte MD5 fingerprint of the certificate.
Syntax
func (obj *SMIME) RecipientCertFingerprint(RecipientCertIndex int32) (string, error)
Default Value
""
Remarks
The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02
The RecipientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientCertCount property.
This property is read-only.
Data Type
string
RecipientCertFingerprintSHA1 Property (SMIME Component)
The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
Syntax
func (obj *SMIME) RecipientCertFingerprintSHA1(RecipientCertIndex int32) (string, error)
Default Value
""
Remarks
The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84
The RecipientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientCertCount property.
This property is read-only.
Data Type
string
RecipientCertFingerprintSHA256 Property (SMIME Component)
The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
Syntax
func (obj *SMIME) RecipientCertFingerprintSHA256(RecipientCertIndex int32) (string, error)
Default Value
""
Remarks
The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53
The RecipientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientCertCount property.
This property is read-only.
Data Type
string
RecipientCertIssuer Property (SMIME Component)
The issuer of the certificate.
Syntax
func (obj *SMIME) RecipientCertIssuer(RecipientCertIndex int32) (string, error)
Default Value
""
Remarks
The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.
The RecipientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientCertCount property.
This property is read-only.
Data Type
string
RecipientCertPrivateKey Property (SMIME Component)
The private key of the certificate (if available).
Syntax
func (obj *SMIME) RecipientCertPrivateKey(RecipientCertIndex int32) (string, error)
Default Value
""
Remarks
The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
NOTE: The RecipientCertPrivateKey may be available but not exportable. In this case, RecipientCertPrivateKey returns an empty string.
The RecipientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientCertCount property.
This property is read-only.
Data Type
string
RecipientCertPrivateKeyAvailable Property (SMIME Component)
Whether a PrivateKey is available for the selected certificate.
Syntax
func (obj *SMIME) RecipientCertPrivateKeyAvailable(RecipientCertIndex int32) (bool, error)
Default Value
false
Remarks
Whether a RecipientCertPrivateKey is available for the selected certificate. If RecipientCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).
The RecipientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientCertCount property.
This property is read-only.
Data Type
bool
RecipientCertPrivateKeyContainer Property (SMIME Component)
The name of the PrivateKey container for the certificate (if available).
Syntax
func (obj *SMIME) RecipientCertPrivateKeyContainer(RecipientCertIndex int32) (string, error)
Default Value
""
Remarks
The name of the RecipientCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.
The RecipientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientCertCount property.
This property is read-only.
Data Type
string
RecipientCertPublicKey Property (SMIME Component)
The public key of the certificate.
Syntax
func (obj *SMIME) RecipientCertPublicKey(RecipientCertIndex int32) (string, error)
Default Value
""
Remarks
The public key of the certificate. The key is provided as PEM/Base64-encoded data.
The RecipientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientCertCount property.
This property is read-only.
Data Type
string
RecipientCertPublicKeyAlgorithm Property (SMIME Component)
The textual description of the certificate's public key algorithm.
Syntax
func (obj *SMIME) RecipientCertPublicKeyAlgorithm(RecipientCertIndex int32) (string, error)
Default Value
""
Remarks
The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.
The RecipientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientCertCount property.
This property is read-only.
Data Type
string
RecipientCertPublicKeyLength Property (SMIME Component)
The length of the certificate's public key (in bits).
Syntax
func (obj *SMIME) RecipientCertPublicKeyLength(RecipientCertIndex int32) (int32, error)
Default Value
0
Remarks
The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
The RecipientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientCertCount property.
This property is read-only.
Data Type
int32
RecipientCertSerialNumber Property (SMIME Component)
The serial number of the certificate encoded as a string.
Syntax
func (obj *SMIME) RecipientCertSerialNumber(RecipientCertIndex int32) (string, error)
Default Value
""
Remarks
The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.
The RecipientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientCertCount property.
This property is read-only.
Data Type
string
RecipientCertSignatureAlgorithm Property (SMIME Component)
The text description of the certificate's signature algorithm.
Syntax
func (obj *SMIME) RecipientCertSignatureAlgorithm(RecipientCertIndex int32) (string, error)
Default Value
""
Remarks
The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.
The RecipientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientCertCount property.
This property is read-only.
Data Type
string
RecipientCertStore Property (SMIME Component)
The name of the certificate store for the client certificate.
Syntax
func (obj *SMIME) RecipientCertStore(RecipientCertIndex int32) ([]byte, error)
func (obj *SMIME) SetRecipientCertStore(RecipientCertIndex int32, value []byte) error
Default Value
"MY"
Remarks
The name of the certificate store for the client certificate.
The RecipientCertStoreType property denotes the type of the certificate store specified by RecipientCertStore. If the store is password-protected, specify the password in RecipientCertStorePassword.
RecipientCertStore is used in conjunction with the RecipientCertSubject property to specify client certificates. If RecipientCertStore has a value, and RecipientCertSubject or RecipientCertEncoded is set, a search for a certificate is initiated. Please see the RecipientCertSubject property for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
| MY | A certificate store holding personal certificates with their associated private keys. |
| CA | Certifying authority certificates. |
| ROOT | Root certificates. |
When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
The RecipientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientCertCount property.
Data Type
[]byte
RecipientCertStorePassword Property (SMIME Component)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
func (obj *SMIME) RecipientCertStorePassword(RecipientCertIndex int32) (string, error)
func (obj *SMIME) SetRecipientCertStorePassword(RecipientCertIndex int32, value string) error
Default Value
""
Remarks
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
The RecipientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientCertCount property.
Data Type
string
RecipientCertStoreType Property (SMIME Component)
The type of certificate store for this certificate.
Syntax
func (obj *SMIME) RecipientCertStoreType(RecipientCertIndex int32) (int32, error)
func (obj *SMIME) SetRecipientCertStoreType(RecipientCertIndex int32, value int32) error
Possible Values
0 // User
1 // Machine
2 // PFXFile
3 // PFXBlob
4 // JKSFile
5 // JKSBlob
6 // PEMKeyFile
7 // PEMKeyBlob
8 // PublicKeyFile
9 // PublicKeyBlob
10 // SSHPublicKeyBlob
11 // P7BFile
12 // P7BBlob
13 // SSHPublicKeyFile
14 // PPKFile
15 // PPKBlob
16 // XMLFile
17 // XMLBlob
18 // JWKFile
19 // JWKBlob
20 // SecurityKey
21 // BCFKSFile
22 // BCFKSBlob
23 // PKCS11
99 // Auto
Default Value
0
Remarks
The type of certificate store for this certificate.
The struct supports both public and private keys in a variety of formats. When the cstAuto value is used, the struct will automatically determine the type. This property can take one of the following values:
| 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
NOTE: This store type is not available in Java. |
| 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
NOTE: This store type is not available in Java. |
| 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
| 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
| 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
NOTE: This store type is only available in Java. |
| 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
NOTE: This store type is only available in Java. |
| 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
| 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
| 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
| 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
| 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
| 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
| 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
| 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
| 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
| 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
| 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
| 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
| 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
| 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
| 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
NOTE: This store type is only available in Java and .NET. |
| 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
NOTE: This store type is only available in Java and .NET. |
| 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, create a new Certificate object and pass cstPKCS11 as the RecipientCertStoreType, the full path of the PKCS#11 DLL as the RecipientCertStore, and the PIN as the RecipientCertStorePassword. Code Example. SSH Authentication with Security Key (without CertMgr):
Alternatively, collect the necessary data using the CertMgr struct by calling the ListStoreCertificates method after setting the corresponding properties accordingly. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the RecipientCertStore and set RecipientCertStorePassword to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr):
|
| 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
The RecipientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientCertCount property.
Data Type
int32
RecipientCertSubjectAltNames Property (SMIME Component)
Comma-separated lists of alternative subject names for the certificate.
Syntax
func (obj *SMIME) RecipientCertSubjectAltNames(RecipientCertIndex int32) (string, error)
Default Value
""
Remarks
Comma-separated lists of alternative subject names for the certificate.
The RecipientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientCertCount property.
This property is read-only.
Data Type
string
RecipientCertThumbprintMD5 Property (SMIME Component)
The MD5 hash of the certificate.
Syntax
func (obj *SMIME) RecipientCertThumbprintMD5(RecipientCertIndex int32) (string, error)
Default Value
""
Remarks
The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
The RecipientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientCertCount property.
This property is read-only.
Data Type
string
RecipientCertThumbprintSHA1 Property (SMIME Component)
The SHA-1 hash of the certificate.
Syntax
func (obj *SMIME) RecipientCertThumbprintSHA1(RecipientCertIndex int32) (string, error)
Default Value
""
Remarks
The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
The RecipientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientCertCount property.
This property is read-only.
Data Type
string
RecipientCertThumbprintSHA256 Property (SMIME Component)
The SHA-256 hash of the certificate.
Syntax
func (obj *SMIME) RecipientCertThumbprintSHA256(RecipientCertIndex int32) (string, error)
Default Value
""
Remarks
The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
The RecipientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientCertCount property.
This property is read-only.
Data Type
string
RecipientCertUsage Property (SMIME Component)
The text description of UsageFlags .
Syntax
func (obj *SMIME) RecipientCertUsage(RecipientCertIndex int32) (string, error)
Default Value
""
Remarks
The text description of RecipientCertUsageFlags.
This value will be one or more of the following strings and will be separated by commas:
- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only
If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.
The RecipientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientCertCount property.
This property is read-only.
Data Type
string
RecipientCertUsageFlags Property (SMIME Component)
The flags that show intended use for the certificate.
Syntax
func (obj *SMIME) RecipientCertUsageFlags(RecipientCertIndex int32) (int32, error)
Default Value
0
Remarks
The flags that show intended use for the certificate. The value of RecipientCertUsageFlags is a combination of the following flags:
| 0x80 | Digital Signature |
| 0x40 | Non-Repudiation |
| 0x20 | Key Encipherment |
| 0x10 | Data Encipherment |
| 0x08 | Key Agreement |
| 0x04 | Certificate Signing |
| 0x02 | CRL Signing |
| 0x01 | Encipher Only |
Please see the RecipientCertUsage property for a text representation of RecipientCertUsageFlags.
This functionality currently is not available when the provider is OpenSSL.
The RecipientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientCertCount property.
This property is read-only.
Data Type
int32
RecipientCertVersion Property (SMIME Component)
The certificate's version number.
Syntax
func (obj *SMIME) RecipientCertVersion(RecipientCertIndex int32) (string, error)
Default Value
""
Remarks
The certificate's version number. The possible values are the strings "V1", "V2", and "V3".
The RecipientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientCertCount property.
This property is read-only.
Data Type
string
RecipientCertSubject Property (SMIME Component)
The subject of the certificate used for client authentication.
Syntax
func (obj *SMIME) RecipientCertSubject(RecipientCertIndex int32) (string, error)
func (obj *SMIME) SetRecipientCertSubject(RecipientCertIndex int32, value string) error
Default Value
""
Remarks
The subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:
| Field | Meaning |
| CN | Common Name. This is commonly a hostname like www.server.com. |
| O | Organization |
| OU | Organizational Unit |
| L | Locality |
| S | State |
| C | Country |
| E | Email Address |
If a field value contains a comma, it must be quoted.
The RecipientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientCertCount property.
Data Type
string
RecipientCertEncoded Property (SMIME Component)
The certificate (PEM/Base64 encoded).
Syntax
func (obj *SMIME) RecipientCertEncoded(RecipientCertIndex int32) ([]byte, error)
func (obj *SMIME) SetRecipientCertEncoded(RecipientCertIndex int32, value []byte) error
Default Value
""
Remarks
The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The RecipientCertStore and RecipientCertSubject properties also may be used to specify a certificate.
When RecipientCertEncoded is set, a search is initiated in the current RecipientCertStore for the private key of the certificate. If the key is found, RecipientCertSubject is updated to reflect the full subject of the selected certificate; otherwise, RecipientCertSubject is set to an empty string.
The RecipientCertIndex parameter specifies the index of the item in the array. The size of the array is controlled by the RecipientCertCount property.
Data Type
[]byte
SignerCertEffectiveDate Property (SMIME Component)
The date on which this certificate becomes valid.
Syntax
func (obj *SMIME) SignerCertEffectiveDate() (string, error)
Default Value
""
Remarks
The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2000 15:00:00.
This property is read-only.
Data Type
string
SignerCertExpirationDate Property (SMIME Component)
The date on which the certificate expires.
Syntax
func (obj *SMIME) SignerCertExpirationDate() (string, error)
Default Value
""
Remarks
The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2001 15:00:00.
This property is read-only.
Data Type
string
SignerCertExtendedKeyUsage Property (SMIME Component)
A comma-delimited list of extended key usage identifiers.
Syntax
func (obj *SMIME) SignerCertExtendedKeyUsage() (string, error)
Default Value
""
Remarks
A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
This property is read-only.
Data Type
string
SignerCertFingerprint Property (SMIME Component)
The hex-encoded, 16-byte MD5 fingerprint of the certificate.
Syntax
func (obj *SMIME) SignerCertFingerprint() (string, error)
Default Value
""
Remarks
The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02
This property is read-only.
Data Type
string
SignerCertFingerprintSHA1 Property (SMIME Component)
The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
Syntax
func (obj *SMIME) SignerCertFingerprintSHA1() (string, error)
Default Value
""
Remarks
The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84
This property is read-only.
Data Type
string
SignerCertFingerprintSHA256 Property (SMIME Component)
The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
Syntax
func (obj *SMIME) SignerCertFingerprintSHA256() (string, error)
Default Value
""
Remarks
The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53
This property is read-only.
Data Type
string
SignerCertIssuer Property (SMIME Component)
The issuer of the certificate.
Syntax
func (obj *SMIME) SignerCertIssuer() (string, error)
Default Value
""
Remarks
The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.
This property is read-only.
Data Type
string
SignerCertPrivateKey Property (SMIME Component)
The private key of the certificate (if available).
Syntax
func (obj *SMIME) SignerCertPrivateKey() (string, error)
Default Value
""
Remarks
The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
NOTE: The SignerCertPrivateKey may be available but not exportable. In this case, SignerCertPrivateKey returns an empty string.
This property is read-only.
Data Type
string
SignerCertPrivateKeyAvailable Property (SMIME Component)
Whether a PrivateKey is available for the selected certificate.
Syntax
func (obj *SMIME) SignerCertPrivateKeyAvailable() (bool, error)
Default Value
false
Remarks
Whether a SignerCertPrivateKey is available for the selected certificate. If SignerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).
This property is read-only.
Data Type
bool
SignerCertPrivateKeyContainer Property (SMIME Component)
The name of the PrivateKey container for the certificate (if available).
Syntax
func (obj *SMIME) SignerCertPrivateKeyContainer() (string, error)
Default Value
""
Remarks
The name of the SignerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.
This property is read-only.
Data Type
string
SignerCertPublicKey Property (SMIME Component)
The public key of the certificate.
Syntax
func (obj *SMIME) SignerCertPublicKey() (string, error)
Default Value
""
Remarks
The public key of the certificate. The key is provided as PEM/Base64-encoded data.
This property is read-only.
Data Type
string
SignerCertPublicKeyAlgorithm Property (SMIME Component)
The textual description of the certificate's public key algorithm.
Syntax
func (obj *SMIME) SignerCertPublicKeyAlgorithm() (string, error)
Default Value
""
Remarks
The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.
This property is read-only.
Data Type
string
SignerCertPublicKeyLength Property (SMIME Component)
The length of the certificate's public key (in bits).
Syntax
func (obj *SMIME) SignerCertPublicKeyLength() (int32, error)
Default Value
0
Remarks
The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
This property is read-only.
Data Type
int32
SignerCertSerialNumber Property (SMIME Component)
The serial number of the certificate encoded as a string.
Syntax
func (obj *SMIME) SignerCertSerialNumber() (string, error)
Default Value
""
Remarks
The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.
This property is read-only.
Data Type
string
SignerCertSignatureAlgorithm Property (SMIME Component)
The text description of the certificate's signature algorithm.
Syntax
func (obj *SMIME) SignerCertSignatureAlgorithm() (string, error)
Default Value
""
Remarks
The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.
This property is read-only.
Data Type
string
SignerCertStore Property (SMIME Component)
The name of the certificate store for the client certificate.
Syntax
func (obj *SMIME) SignerCertStore() ([]byte, error)
func (obj *SMIME) SetSignerCertStore(value []byte) error
Default Value
"MY"
Remarks
The name of the certificate store for the client certificate.
The SignerCertStoreType property denotes the type of the certificate store specified by SignerCertStore. If the store is password-protected, specify the password in SignerCertStorePassword.
SignerCertStore is used in conjunction with the SignerCertSubject property to specify client certificates. If SignerCertStore has a value, and SignerCertSubject or SignerCertEncoded is set, a search for a certificate is initiated. Please see the SignerCertSubject property for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
| MY | A certificate store holding personal certificates with their associated private keys. |
| CA | Certifying authority certificates. |
| ROOT | Root certificates. |
When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
Data Type
[]byte
SignerCertStorePassword Property (SMIME Component)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
func (obj *SMIME) SignerCertStorePassword() (string, error)
func (obj *SMIME) SetSignerCertStorePassword(value string) error
Default Value
""
Remarks
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Data Type
string
SignerCertStoreType Property (SMIME Component)
The type of certificate store for this certificate.
Syntax
func (obj *SMIME) SignerCertStoreType() (int32, error)
func (obj *SMIME) SetSignerCertStoreType(value int32) error
Possible Values
0 // User
1 // Machine
2 // PFXFile
3 // PFXBlob
4 // JKSFile
5 // JKSBlob
6 // PEMKeyFile
7 // PEMKeyBlob
8 // PublicKeyFile
9 // PublicKeyBlob
10 // SSHPublicKeyBlob
11 // P7BFile
12 // P7BBlob
13 // SSHPublicKeyFile
14 // PPKFile
15 // PPKBlob
16 // XMLFile
17 // XMLBlob
18 // JWKFile
19 // JWKBlob
20 // SecurityKey
21 // BCFKSFile
22 // BCFKSBlob
23 // PKCS11
99 // Auto
Default Value
0
Remarks
The type of certificate store for this certificate.
The struct supports both public and private keys in a variety of formats. When the cstAuto value is used, the struct will automatically determine the type. This property can take one of the following values:
| 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
NOTE: This store type is not available in Java. |
| 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
NOTE: This store type is not available in Java. |
| 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
| 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
| 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
NOTE: This store type is only available in Java. |
| 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
NOTE: This store type is only available in Java. |
| 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
| 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
| 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
| 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
| 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
| 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
| 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
| 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
| 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
| 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
| 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
| 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
| 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
| 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
| 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
NOTE: This store type is only available in Java and .NET. |
| 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
NOTE: This store type is only available in Java and .NET. |
| 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, create a new Certificate object and pass cstPKCS11 as the SignerCertStoreType, the full path of the PKCS#11 DLL as the SignerCertStore, and the PIN as the SignerCertStorePassword. Code Example. SSH Authentication with Security Key (without CertMgr):
Alternatively, collect the necessary data using the CertMgr struct by calling the ListStoreCertificates method after setting the corresponding properties accordingly. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the SignerCertStore and set SignerCertStorePassword to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr):
|
| 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
Data Type
int32
SignerCertSubjectAltNames Property (SMIME Component)
Comma-separated lists of alternative subject names for the certificate.
Syntax
func (obj *SMIME) SignerCertSubjectAltNames() (string, error)
Default Value
""
Remarks
Comma-separated lists of alternative subject names for the certificate.
This property is read-only.
Data Type
string
SignerCertThumbprintMD5 Property (SMIME Component)
The MD5 hash of the certificate.
Syntax
func (obj *SMIME) SignerCertThumbprintMD5() (string, error)
Default Value
""
Remarks
The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
string
SignerCertThumbprintSHA1 Property (SMIME Component)
The SHA-1 hash of the certificate.
Syntax
func (obj *SMIME) SignerCertThumbprintSHA1() (string, error)
Default Value
""
Remarks
The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
string
SignerCertThumbprintSHA256 Property (SMIME Component)
The SHA-256 hash of the certificate.
Syntax
func (obj *SMIME) SignerCertThumbprintSHA256() (string, error)
Default Value
""
Remarks
The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
This property is read-only.
Data Type
string
SignerCertUsage Property (SMIME Component)
The text description of UsageFlags .
Syntax
func (obj *SMIME) SignerCertUsage() (string, error)
Default Value
""
Remarks
The text description of SignerCertUsageFlags.
This value will be one or more of the following strings and will be separated by commas:
- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only
If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.
This property is read-only.
Data Type
string
SignerCertUsageFlags Property (SMIME Component)
The flags that show intended use for the certificate.
Syntax
func (obj *SMIME) SignerCertUsageFlags() (int32, error)
Default Value
0
Remarks
The flags that show intended use for the certificate. The value of SignerCertUsageFlags is a combination of the following flags:
| 0x80 | Digital Signature |
| 0x40 | Non-Repudiation |
| 0x20 | Key Encipherment |
| 0x10 | Data Encipherment |
| 0x08 | Key Agreement |
| 0x04 | Certificate Signing |
| 0x02 | CRL Signing |
| 0x01 | Encipher Only |
Please see the SignerCertUsage property for a text representation of SignerCertUsageFlags.
This functionality currently is not available when the provider is OpenSSL.
This property is read-only.
Data Type
int32
SignerCertVersion Property (SMIME Component)
The certificate's version number.
Syntax
func (obj *SMIME) SignerCertVersion() (string, error)
Default Value
""
Remarks
The certificate's version number. The possible values are the strings "V1", "V2", and "V3".
This property is read-only.
Data Type
string
SignerCertSubject Property (SMIME Component)
The subject of the certificate used for client authentication.
Syntax
func (obj *SMIME) SignerCertSubject() (string, error)
func (obj *SMIME) SetSignerCertSubject(value string) error
Default Value
""
Remarks
The subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:
| Field | Meaning |
| CN | Common Name. This is commonly a hostname like www.server.com. |
| O | Organization |
| OU | Organizational Unit |
| L | Locality |
| S | State |
| C | Country |
| E | Email Address |
If a field value contains a comma, it must be quoted.
Data Type
string
SignerCertEncoded Property (SMIME Component)
The certificate (PEM/Base64 encoded).
Syntax
func (obj *SMIME) SignerCertEncoded() ([]byte, error)
func (obj *SMIME) SetSignerCertEncoded(value []byte) error
Default Value
""
Remarks
The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SignerCertStore and SignerCertSubject properties also may be used to specify a certificate.
When SignerCertEncoded is set, a search is initiated in the current SignerCertStore for the private key of the certificate. If the key is found, SignerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SignerCertSubject is set to an empty string.
Data Type
[]byte
SignerCertChainCount Property (SMIME Component)
The number of records in the SignerCertChain arrays.
Syntax
func (obj *SMIME) SignerCertChainCount() (int32, error)
Default Value
0
Remarks
This property controls the size of the following arrays:
- SignerCertChainEffectiveDate
- SignerCertChainEncoded
- SignerCertChainExpirationDate
- SignerCertChainExtendedKeyUsage
- SignerCertChainFingerprint
- SignerCertChainFingerprintSHA1
- SignerCertChainFingerprintSHA256
- SignerCertChainIssuer
- SignerCertChainPrivateKey
- SignerCertChainPrivateKeyAvailable
- SignerCertChainPrivateKeyContainer
- SignerCertChainPublicKey
- SignerCertChainPublicKeyAlgorithm
- SignerCertChainPublicKeyLength
- SignerCertChainSerialNumber
- SignerCertChainSignatureAlgorithm
- SignerCertChainStore
- SignerCertChainStorePassword
- SignerCertChainStoreType
- SignerCertChainSubject
- SignerCertChainSubjectAltNames
- SignerCertChainThumbprintMD5
- SignerCertChainThumbprintSHA1
- SignerCertChainThumbprintSHA256
- SignerCertChainUsage
- SignerCertChainUsageFlags
- SignerCertChainVersion
This property is read-only.
Data Type
int32
SignerCertChainEffectiveDate Property (SMIME Component)
The date on which this certificate becomes valid.
Syntax
func (obj *SMIME) SignerCertChainEffectiveDate(SignerCertChainIndex int32) (string, error)
Default Value
""
Remarks
The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2000 15:00:00.
The SignerCertChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerCertChainCount property.
This property is read-only.
Data Type
string
SignerCertChainExpirationDate Property (SMIME Component)
The date on which the certificate expires.
Syntax
func (obj *SMIME) SignerCertChainExpirationDate(SignerCertChainIndex int32) (string, error)
Default Value
""
Remarks
The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:
23-Jan-2001 15:00:00.
The SignerCertChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerCertChainCount property.
This property is read-only.
Data Type
string
SignerCertChainExtendedKeyUsage Property (SMIME Component)
A comma-delimited list of extended key usage identifiers.
Syntax
func (obj *SMIME) SignerCertChainExtendedKeyUsage(SignerCertChainIndex int32) (string, error)
Default Value
""
Remarks
A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).
The SignerCertChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerCertChainCount property.
This property is read-only.
Data Type
string
SignerCertChainFingerprint Property (SMIME Component)
The hex-encoded, 16-byte MD5 fingerprint of the certificate.
Syntax
func (obj *SMIME) SignerCertChainFingerprint(SignerCertChainIndex int32) (string, error)
Default Value
""
Remarks
The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02
The SignerCertChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerCertChainCount property.
This property is read-only.
Data Type
string
SignerCertChainFingerprintSHA1 Property (SMIME Component)
The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.
Syntax
func (obj *SMIME) SignerCertChainFingerprintSHA1(SignerCertChainIndex int32) (string, error)
Default Value
""
Remarks
The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84
The SignerCertChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerCertChainCount property.
This property is read-only.
Data Type
string
SignerCertChainFingerprintSHA256 Property (SMIME Component)
The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.
Syntax
func (obj *SMIME) SignerCertChainFingerprintSHA256(SignerCertChainIndex int32) (string, error)
Default Value
""
Remarks
The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.
The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53
The SignerCertChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerCertChainCount property.
This property is read-only.
Data Type
string
SignerCertChainIssuer Property (SMIME Component)
The issuer of the certificate.
Syntax
func (obj *SMIME) SignerCertChainIssuer(SignerCertChainIndex int32) (string, error)
Default Value
""
Remarks
The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.
The SignerCertChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerCertChainCount property.
This property is read-only.
Data Type
string
SignerCertChainPrivateKey Property (SMIME Component)
The private key of the certificate (if available).
Syntax
func (obj *SMIME) SignerCertChainPrivateKey(SignerCertChainIndex int32) (string, error)
Default Value
""
Remarks
The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.
NOTE: The SignerCertChainPrivateKey may be available but not exportable. In this case, SignerCertChainPrivateKey returns an empty string.
The SignerCertChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerCertChainCount property.
This property is read-only.
Data Type
string
SignerCertChainPrivateKeyAvailable Property (SMIME Component)
Whether a PrivateKey is available for the selected certificate.
Syntax
func (obj *SMIME) SignerCertChainPrivateKeyAvailable(SignerCertChainIndex int32) (bool, error)
Default Value
false
Remarks
Whether a SignerCertChainPrivateKey is available for the selected certificate. If SignerCertChainPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).
The SignerCertChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerCertChainCount property.
This property is read-only.
Data Type
bool
SignerCertChainPrivateKeyContainer Property (SMIME Component)
The name of the PrivateKey container for the certificate (if available).
Syntax
func (obj *SMIME) SignerCertChainPrivateKeyContainer(SignerCertChainIndex int32) (string, error)
Default Value
""
Remarks
The name of the SignerCertChainPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.
The SignerCertChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerCertChainCount property.
This property is read-only.
Data Type
string
SignerCertChainPublicKey Property (SMIME Component)
The public key of the certificate.
Syntax
func (obj *SMIME) SignerCertChainPublicKey(SignerCertChainIndex int32) (string, error)
Default Value
""
Remarks
The public key of the certificate. The key is provided as PEM/Base64-encoded data.
The SignerCertChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerCertChainCount property.
This property is read-only.
Data Type
string
SignerCertChainPublicKeyAlgorithm Property (SMIME Component)
The textual description of the certificate's public key algorithm.
Syntax
func (obj *SMIME) SignerCertChainPublicKeyAlgorithm(SignerCertChainIndex int32) (string, error)
Default Value
""
Remarks
The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.
The SignerCertChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerCertChainCount property.
This property is read-only.
Data Type
string
SignerCertChainPublicKeyLength Property (SMIME Component)
The length of the certificate's public key (in bits).
Syntax
func (obj *SMIME) SignerCertChainPublicKeyLength(SignerCertChainIndex int32) (int32, error)
Default Value
0
Remarks
The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.
The SignerCertChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerCertChainCount property.
This property is read-only.
Data Type
int32
SignerCertChainSerialNumber Property (SMIME Component)
The serial number of the certificate encoded as a string.
Syntax
func (obj *SMIME) SignerCertChainSerialNumber(SignerCertChainIndex int32) (string, error)
Default Value
""
Remarks
The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.
The SignerCertChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerCertChainCount property.
This property is read-only.
Data Type
string
SignerCertChainSignatureAlgorithm Property (SMIME Component)
The text description of the certificate's signature algorithm.
Syntax
func (obj *SMIME) SignerCertChainSignatureAlgorithm(SignerCertChainIndex int32) (string, error)
Default Value
""
Remarks
The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.
The SignerCertChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerCertChainCount property.
This property is read-only.
Data Type
string
SignerCertChainStore Property (SMIME Component)
The name of the certificate store for the client certificate.
Syntax
func (obj *SMIME) SignerCertChainStore(SignerCertChainIndex int32) ([]byte, error)
Default Value
"MY"
Remarks
The name of the certificate store for the client certificate.
The SignerCertChainStoreType property denotes the type of the certificate store specified by SignerCertChainStore. If the store is password-protected, specify the password in SignerCertChainStorePassword.
SignerCertChainStore is used in conjunction with the SignerCertChainSubject property to specify client certificates. If SignerCertChainStore has a value, and SignerCertChainSubject or SignerCertChainEncoded is set, a search for a certificate is initiated. Please see the SignerCertChainSubject property for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
| MY | A certificate store holding personal certificates with their associated private keys. |
| CA | Certifying authority certificates. |
| ROOT | Root certificates. |
When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).
The SignerCertChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerCertChainCount property.
This property is read-only.
Data Type
[]byte
SignerCertChainStorePassword Property (SMIME Component)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
func (obj *SMIME) SignerCertChainStorePassword(SignerCertChainIndex int32) (string, error)
Default Value
""
Remarks
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
The SignerCertChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerCertChainCount property.
This property is read-only.
Data Type
string
SignerCertChainStoreType Property (SMIME Component)
The type of certificate store for this certificate.
Syntax
func (obj *SMIME) SignerCertChainStoreType(SignerCertChainIndex int32) (int32, error)
Possible Values
0 // User
1 // Machine
2 // PFXFile
3 // PFXBlob
4 // JKSFile
5 // JKSBlob
6 // PEMKeyFile
7 // PEMKeyBlob
8 // PublicKeyFile
9 // PublicKeyBlob
10 // SSHPublicKeyBlob
11 // P7BFile
12 // P7BBlob
13 // SSHPublicKeyFile
14 // PPKFile
15 // PPKBlob
16 // XMLFile
17 // XMLBlob
18 // JWKFile
19 // JWKBlob
20 // SecurityKey
21 // BCFKSFile
22 // BCFKSBlob
23 // PKCS11
99 // Auto
Default Value
0
Remarks
The type of certificate store for this certificate.
The struct supports both public and private keys in a variety of formats. When the cstAuto value is used, the struct will automatically determine the type. This property can take one of the following values:
| 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
NOTE: This store type is not available in Java. |
| 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
NOTE: This store type is not available in Java. |
| 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
| 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
| 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates.
NOTE: This store type is only available in Java. |
| 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format.
NOTE: This store type is only available in Java. |
| 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
| 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
| 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
| 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
| 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
| 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
| 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
| 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
| 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
| 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
| 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
| 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
| 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
| 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
| 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store).
NOTE: This store type is only available in Java and .NET. |
| 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format.
NOTE: This store type is only available in Java and .NET. |
| 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface.
To use a security key, create a new Certificate object and pass cstPKCS11 as the SignerCertChainStoreType, the full path of the PKCS#11 DLL as the SignerCertChainStore, and the PIN as the SignerCertChainStorePassword. Code Example. SSH Authentication with Security Key (without CertMgr):
Alternatively, collect the necessary data using the CertMgr struct by calling the ListStoreCertificates method after setting the corresponding properties accordingly. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the SignerCertChainStore and set SignerCertChainStorePassword to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr):
|
| 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |
The SignerCertChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerCertChainCount property.
This property is read-only.
Data Type
int32
SignerCertChainSubjectAltNames Property (SMIME Component)
Comma-separated lists of alternative subject names for the certificate.
Syntax
func (obj *SMIME) SignerCertChainSubjectAltNames(SignerCertChainIndex int32) (string, error)
Default Value
""
Remarks
Comma-separated lists of alternative subject names for the certificate.
The SignerCertChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerCertChainCount property.
This property is read-only.
Data Type
string
SignerCertChainThumbprintMD5 Property (SMIME Component)
The MD5 hash of the certificate.
Syntax
func (obj *SMIME) SignerCertChainThumbprintMD5(SignerCertChainIndex int32) (string, error)
Default Value
""
Remarks
The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
The SignerCertChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerCertChainCount property.
This property is read-only.
Data Type
string
SignerCertChainThumbprintSHA1 Property (SMIME Component)
The SHA-1 hash of the certificate.
Syntax
func (obj *SMIME) SignerCertChainThumbprintSHA1(SignerCertChainIndex int32) (string, error)
Default Value
""
Remarks
The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
The SignerCertChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerCertChainCount property.
This property is read-only.
Data Type
string
SignerCertChainThumbprintSHA256 Property (SMIME Component)
The SHA-256 hash of the certificate.
Syntax
func (obj *SMIME) SignerCertChainThumbprintSHA256(SignerCertChainIndex int32) (string, error)
Default Value
""
Remarks
The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.
The SignerCertChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerCertChainCount property.
This property is read-only.
Data Type
string
SignerCertChainUsage Property (SMIME Component)
The text description of UsageFlags .
Syntax
func (obj *SMIME) SignerCertChainUsage(SignerCertChainIndex int32) (string, error)
Default Value
""
Remarks
The text description of SignerCertChainUsageFlags.
This value will be one or more of the following strings and will be separated by commas:
- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only
If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.
The SignerCertChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerCertChainCount property.
This property is read-only.
Data Type
string
SignerCertChainUsageFlags Property (SMIME Component)
The flags that show intended use for the certificate.
Syntax
func (obj *SMIME) SignerCertChainUsageFlags(SignerCertChainIndex int32) (int32, error)
Default Value
0
Remarks
The flags that show intended use for the certificate. The value of SignerCertChainUsageFlags is a combination of the following flags:
| 0x80 | Digital Signature |
| 0x40 | Non-Repudiation |
| 0x20 | Key Encipherment |
| 0x10 | Data Encipherment |
| 0x08 | Key Agreement |
| 0x04 | Certificate Signing |
| 0x02 | CRL Signing |
| 0x01 | Encipher Only |
Please see the SignerCertChainUsage property for a text representation of SignerCertChainUsageFlags.
This functionality currently is not available when the provider is OpenSSL.
The SignerCertChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerCertChainCount property.
This property is read-only.
Data Type
int32
SignerCertChainVersion Property (SMIME Component)
The certificate's version number.
Syntax
func (obj *SMIME) SignerCertChainVersion(SignerCertChainIndex int32) (string, error)
Default Value
""
Remarks
The certificate's version number. The possible values are the strings "V1", "V2", and "V3".
The SignerCertChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerCertChainCount property.
This property is read-only.
Data Type
string
SignerCertChainSubject Property (SMIME Component)
The subject of the certificate used for client authentication.
Syntax
func (obj *SMIME) SignerCertChainSubject(SignerCertChainIndex int32) (string, error)
Default Value
""
Remarks
The subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=example@email.com". Common fields and their meanings are as follows:
| Field | Meaning |
| CN | Common Name. This is commonly a hostname like www.server.com. |
| O | Organization |
| OU | Organizational Unit |
| L | Locality |
| S | State |
| C | Country |
| E | Email Address |
If a field value contains a comma, it must be quoted.
The SignerCertChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerCertChainCount property.
This property is read-only.
Data Type
string
SignerCertChainEncoded Property (SMIME Component)
The certificate (PEM/Base64 encoded).
Syntax
func (obj *SMIME) SignerCertChainEncoded(SignerCertChainIndex int32) ([]byte, error)
Default Value
""
Remarks
The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SignerCertChainStore and SignerCertChainSubject properties also may be used to specify a certificate.
When SignerCertChainEncoded is set, a search is initiated in the current SignerCertChainStore for the private key of the certificate. If the key is found, SignerCertChainSubject is updated to reflect the full subject of the selected certificate; otherwise, SignerCertChainSubject is set to an empty string.
The SignerCertChainIndex parameter specifies the index of the item in the array. The size of the array is controlled by the SignerCertChainCount property.
This property is read-only.
Data Type
[]byte
SigningAlgorithm Property (SMIME Component)
This property includes a textual description of the signature hash algorithm.
Syntax
func (obj *SMIME) SigningAlgorithm() (string, error)
func (obj *SMIME) SetSigningAlgorithm(value string) error
Default Value
"SHA256"
Remarks
This property specifies the hash algorithm used to prepare the message digest for signature.
This property must contain either the name of the algorithm (such as MD5 or SHA1), or an object Id (OID) string representing the hash algorithm. Possible values are as follows:
- sha1
- md5
- sha-256 (default)
- sha-384
- sha-512
- sha-224
When read, the value of the property always contains the OID of the algorithm, or an empty string if the algorithm is unknown.
Data Type
string
UseOAEP Property (SMIME Component)
This property specifies whether or not to use Optimal Asymmetric Encryption Padding (OAEP).
Syntax
func (obj *SMIME) UseOAEP() (bool, error)
func (obj *SMIME) SetUseOAEP(value bool) error
Default Value
false
Remarks
This property specifies whether or not to use Optimal Asymmetric Encryption Padding (OAEP). By default, this value is False and the struct will use PKCS1.
To specify nondefault OAEP options, please see OAEPRSAHashAlgorithm, OAEPMGF1HashAlgorithm, and OAEPParams
Data Type
bool
UsePSS Property (SMIME Component)
This property specifies whether or not RSA-PSS will be used during signing and verification.
Syntax
func (obj *SMIME) UsePSS() (bool, error)
func (obj *SMIME) SetUsePSS(value bool) error
Default Value
false
Remarks
This property specifies whether or not RSA-PSS will be used when signing and verifying messages. The default value is False.
Data Type
bool
AddRecipientCert Method (SMIME Component)
This method is used to add recipient certificates used to encrypt messages.
Syntax
func (obj *SMIME) AddRecipientCert(CertEncoded []byte) error
Remarks
This method is used to add recipient certificates to the internal MessageRecipients properties used to encrypt the Message. The recipient certificate must be a valid PKCS-encoded certificate. If the certificate provided is Base64 encoded, it will be decoded first by the object.
The CertMgr struct may be used to retrieve the appropriate certificate from the system.
CheckMessageEncrypted Method (SMIME Component)
This method checks whether or not the current message is encrypted.
Syntax
func (obj *SMIME) CheckMessageEncrypted() (bool, error)
Remarks
This method is used to check whether or not the current message is encrypted. This method will return True, if the current message appears to be encrypted, according to the value of OutputMessageHeaders.
CheckMessageSigned Method (SMIME Component)
This method checks whether or not the current message is signed.
Syntax
func (obj *SMIME) CheckMessageSigned() (bool, error)
Remarks
This method is used to check whether or not the current message is signed. This method will return True, if the current message appears to be signed, according to the value of OutputMessageHeaders.
NOTE: A message that is both signed and encrypted will not appear to be signed until after it is decrypted.
Config Method (SMIME Component)
Sets or retrieves a configuration setting.
Syntax
func (obj *SMIME) Config(ConfigurationString string) (string, error)
Remarks
Config is a generic method available in every struct. It is used to set and retrieve configuration settings for the struct.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, access to these internal properties is provided through the Config method.
To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).
To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.
Decrypt Method (SMIME Component)
This method decrypts the current Message .
Syntax
func (obj *SMIME) Decrypt() error
Remarks
This method takes attempts to decrypt the encrypted message using the certificate in Certificate.
Input and Output Properties
The struct will determine the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
When a valid source is found, the search stops. The order in which the output properties are checked is as follows:
- OutputFile
- OutputMessage: The output data is written to this property if no other destination is specified.
The headers of the input message (if any) will be read from InputMessageHeaders or InputMessageHeadersString.
The headers of the resulting message will be available in the OutputMessageHeaders and OutputMessageHeadersString properties.
DecryptAndVerifySignature Method (SMIME Component)
This method decrypts and verifies the signature of the current message.
Syntax
func (obj *SMIME) DecryptAndVerifySignature() error
Remarks
This method attempts to both decrypt and verify the signature of the message. All of the properties affected by calling the Decrypt and VerifySignature 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 struct will determine the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
When a valid source is found, the search stops. The order in which the output properties are checked is as follows:
- OutputFile
- OutputMessage: The output data is written to this property if no other destination is specified.
The headers of the input message (if any) will be read from InputMessageHeaders or InputMessageHeadersString.
The headers of the resulting message will be available in the OutputMessageHeaders and OutputMessageHeadersString properties.
Encrypt Method (SMIME Component)
This method encrypts the message.
Syntax
func (obj *SMIME) Encrypt() error
Remarks
This method encrypts the data specified in InputFile or InputMessage in a PKCS-encoded envelope with all of the recipient certificates specified in the MessageRecipients properties.
The result of the encrypted data will be written to OutputFile, or OutputMessage. The OutputMessageHeaders property will be filled with the required S/MIME headers.
NOTE: The message headers, including the Sender, Recipient(s), and Subject, are not encrypted. If this is sensitive information, consider including these headers in the message body as a MIME entity and providing other headers for the S/MIME wrapper.
Input and Output Properties
The struct will determine the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
When a valid source is found, the search stops. The order in which the output properties are checked is as follows:
- OutputFile
- OutputMessage: The output data is written to this property if no other destination is specified.
The headers of the input message (if any) will be read from InputMessageHeaders or InputMessageHeadersString.
The headers of the resulting message will be available in the OutputMessageHeaders and OutputMessageHeadersString properties.
GetRecipientInfo Method (SMIME Component)
This method gets the recipient information for an encrypted message.
Syntax
func (obj *SMIME) GetRecipientInfo() error
Remarks
This method will fire a RecipientInfo 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 Component)
This method gets the signature information for an signed message.
Syntax
func (obj *SMIME) GetSignerCertInfo() error
Remarks
This method retrieves information about the certificate used to sign the message. This may be called before calling VerifySignature to determine which certificate should be loaded for verification.
When this method is called, the SignerCertInfo event fires once for each signer of the message. Use the parameters of the SignerCertInfo to determine which certificate to specify before calling VerifySignature.
NOTE: Use of this method is optional. If no certificate is specified before calling VerifySignature, the struct will fire the SignerCertInfo and a certificate may be loaded from within the event at that time (if necessary).
Reset Method (SMIME Component)
This method resets the class properties.
Syntax
func (obj *SMIME) Reset() error
Remarks
This method resets the values of all message and certificate properties. It is an easy way to reset the struct properties before starting to populate with new values.
Sign Method (SMIME Component)
This method signs the current message.
Syntax
func (obj *SMIME) Sign() error
Remarks
This method digitally signs the input data with the the certificate provided. Certificates are provided by specifying the Certificate property. The IncludeCertificate and DetachedSignature properties allow you to specify addition details about what to include when signing the message.
Input and Output Properties
The struct will determine the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
When a valid source is found, the search stops. The order in which the output properties are checked is as follows:
- OutputFile
- OutputMessage: The output data is written to this property if no other destination is specified.
The headers of the input message (if any) will be read from InputMessageHeaders or InputMessageHeadersString.
The headers of the resulting message will be available in the OutputMessageHeaders and OutputMessageHeadersString properties.
SignAndEncrypt Method (SMIME Component)
This method signs and encrypts the current message.
Syntax
func (obj *SMIME) SignAndEncrypt() error
Remarks
This method both signs and encrypts the input message into a single PKCS-encoded envelope. The value in DetachedSignature is ignored: the struct will always generate an attached signature when calling this method. All other properties used by calling the Sign and Encrypt 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 struct will determine the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
When a valid source is found, the search stops. The order in which the output properties are checked is as follows:
- OutputFile
- OutputMessage: The output data is written to this property if no other destination is specified.
The headers of the input message (if any) will be read from InputMessageHeaders or InputMessageHeadersString.
The headers of the resulting message will be available in the OutputMessageHeaders and OutputMessageHeadersString properties.
VerifySignature Method (SMIME Component)
This method verifies the signature of the current message.
Syntax
func (obj *SMIME) VerifySignature() error
Remarks
This method attempts to verify the signature of the input message. If the message does not have a certificate attached, the struct will attempt to verify the signature using the certificate supplied in SignerCert (if any). If no certificate is found, the struct fails with an error.
If this method is successful, the SignerCert property will contain the certificate information of the message signer.
NOTE: This function does not attempt to check the validity of the signing certificate.
Input and Output Properties
The struct will determine the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
When a valid source is found, the search stops. The order in which the output properties are checked is as follows:
- OutputFile
- OutputMessage: The output data is written to this property if no other destination is specified.
The headers of the input message (if any) will be read from InputMessageHeaders or InputMessageHeadersString.
The headers of the resulting message will be available in the OutputMessageHeaders and OutputMessageHeadersString properties.
Error Event (SMIME Component)
Fired when information is available about errors during data delivery.
Syntax
// SMIMEErrorEventArgs carries the SMIME Error event's parameters.
type SMIMEErrorEventArgs struct {...}
func (args *SMIMEErrorEventArgs) ErrorCode() int32
func (args *SMIMEErrorEventArgs) Description() string
// SMIMEErrorEvent defines the signature of the SMIME Error event's handler function.
type SMIMEErrorEvent func(sender *SMIME, args *SMIMEErrorEventArgs)
func (obj *SMIME) GetOnErrorHandler() SMIMEErrorEvent
func (obj *SMIME) SetOnErrorHandler(handlerFunc SMIMEErrorEvent)
Remarks
The Error event is fired in case of exceptional conditions during message processing. Normally the struct fails with an error.
The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.
RecipientInfo Event (SMIME Component)
This event is fired for each recipient certificate of the encrypted message.
Syntax
// SMIMERecipientInfoEventArgs carries the SMIME RecipientInfo event's parameters.
type SMIMERecipientInfoEventArgs struct {...}
func (args *SMIMERecipientInfoEventArgs) Issuer() string
func (args *SMIMERecipientInfoEventArgs) SerialNumber() string
func (args *SMIMERecipientInfoEventArgs) SubjectKeyIdentifier() string
func (args *SMIMERecipientInfoEventArgs) EncryptionAlgorithm() string
// SMIMERecipientInfoEvent defines the signature of the SMIME RecipientInfo event's handler function.
type SMIMERecipientInfoEvent func(sender *SMIME, args *SMIMERecipientInfoEventArgs)
func (obj *SMIME) GetOnRecipientInfoHandler() SMIMERecipientInfoEvent
func (obj *SMIME) SetOnRecipientInfoHandler(handlerFunc SMIMERecipientInfoEvent)
Remarks
When GetRecipientInfo 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 Component)
This event is fired during verification of the signed message.
Syntax
// SMIMESignerCertInfoEventArgs carries the SMIME SignerCertInfo event's parameters.
type SMIMESignerCertInfoEventArgs struct {...}
func (args *SMIMESignerCertInfoEventArgs) Issuer() string
func (args *SMIMESignerCertInfoEventArgs) SerialNumber() string
func (args *SMIMESignerCertInfoEventArgs) SubjectKeyIdentifier() string
func (args *SMIMESignerCertInfoEventArgs) CertEncoded() []byte
// SMIMESignerCertInfoEvent defines the signature of the SMIME SignerCertInfo event's handler function.
type SMIMESignerCertInfoEvent func(sender *SMIME, args *SMIMESignerCertInfoEventArgs)
func (obj *SMIME) GetOnSignerCertInfoHandler() SMIMESignerCertInfoEvent
func (obj *SMIME) SetOnSignerCertInfoHandler(handlerFunc SMIMESignerCertInfoEvent)
Remarks
During verification, this event will be raised while parsing the signer's certificate information. The parameters that are populated depend on the options used when the message was originally signed. This information may be used to select the correct certificate for SignerCert to verify the signature. The following parameters may be populated:
Issuer specifies the subject of the issuer of the certificate used to sign the message.
SerialNumber is the serial number of the certificate used to sign the message.
SubjectKeyIdentifier is the X.509 subjectKeyIdentifier extension value of the certificate used to sign the message encoded as a hex string.
CertEncoded is the PEM (Base64 encoded) public certificate needed to verify the signature.
NOTE: When this value is present, the struct will automatically use this value to perform signature verification.
The SignerCert property may be set from within this event. In this manner, the decision of which signer certificate to load may be delayed until the parameters of this event are inspected and the correct certificate can be located and loaded.
Config Settings (SMIME Component)
The struct accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, access to these internal properties is provided through the Config method.SMIME Config Settings
NOTE: When signing, this configuration setting may be used only when DetachedSignature is False.
NOTE: This configuration setting may be used only when the UseCryptoAPI is True.
The default value is True.
The default value for IncludeHeaders is False.
The default value for IncludeInternalHeaders is True.
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 or SignAndEncrypt and DetachedSignature is True.
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 or SignAndEncrypt and DetachedSignature is True.
- "SHA1"
- "SHA224"
- "SHA256" (default)
- "SHA384"
- "SHA512"
- "RIPEMD160"
- "MD2"
- "MD5"
- "MD5SHA1"
Note: This setting is not applicable when UseFIPSCompliantAPI is set to true or when the private key of the signing certificate is not exportable since the underlying system implementation does not support separate OAEPRSAHashAlgorithm and OAEPMGF1HashAlgorithm values. In this case the OAEPRSAHashAlgorithm is also used for MGF1.
- "SHA1"
- "SHA224"
- "SHA256" (default)
- "SHA384"
- "SHA512"
- "RIPEMD160"
- "MD2"
- "MD5"
- "MD5SHA1"
The default value for ParseInternalHeaders is True.
This configuration setting may be set to the entire blob of the public certificate the struct should use to select the correct recipient-encrypted key for decryption.
This configuration setting may be set to the file that contains the public certificate the struct should use to select the correct recipient-encrypted key for decryption.
- 0 (issuerAndSerialNumber - default)
- 1 (subjectKeyIdentifier)
NOTE: When subjectKeyIdentifier is selected, the recipient's encryption certificate must contain the subjectKeyIdentifier extension.
- 0 (issuerAndSerialNumber - default)
- 1 (subjectKeyIdentifier)
NOTE: When subjectKeyIdentifier is selected, the signing certificate must contain the subjectKeyIdentifier extension.
The default value is False, and the name of the algorithm is used. Set this to True to use the object identifiers instead.
NOTE: Compression will be impossible in this case.
If set to False (the default), the struct will use its internal S/MIME engine.
Base Config Settings
The following is a list of valid code page identifiers:
| Identifier | Name |
| 037 | IBM EBCDIC - U.S./Canada |
| 437 | OEM - United States |
| 500 | IBM EBCDIC - International |
| 708 | Arabic - ASMO 708 |
| 709 | Arabic - ASMO 449+, BCON V4 |
| 710 | Arabic - Transparent Arabic |
| 720 | Arabic - Transparent ASMO |
| 737 | OEM - Greek (formerly 437G) |
| 775 | OEM - Baltic |
| 850 | OEM - Multilingual Latin I |
| 852 | OEM - Latin II |
| 855 | OEM - Cyrillic (primarily Russian) |
| 857 | OEM - Turkish |
| 858 | OEM - Multilingual Latin I + Euro symbol |
| 860 | OEM - Portuguese |
| 861 | OEM - Icelandic |
| 862 | OEM - Hebrew |
| 863 | OEM - Canadian-French |
| 864 | OEM - Arabic |
| 865 | OEM - Nordic |
| 866 | OEM - Russian |
| 869 | OEM - Modern Greek |
| 870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) |
| 874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) |
| 875 | IBM EBCDIC - Modern Greek |
| 932 | ANSI/OEM - Japanese, Shift-JIS |
| 936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) |
| 949 | ANSI/OEM - Korean (Unified Hangul Code) |
| 950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) |
| 1026 | IBM EBCDIC - Turkish (Latin-5) |
| 1047 | IBM EBCDIC - Latin 1/Open System |
| 1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) |
| 1141 | IBM EBCDIC - Germany (20273 + Euro symbol) |
| 1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) |
| 1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) |
| 1144 | IBM EBCDIC - Italy (20280 + Euro symbol) |
| 1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) |
| 1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) |
| 1147 | IBM EBCDIC - France (20297 + Euro symbol) |
| 1148 | IBM EBCDIC - International (500 + Euro symbol) |
| 1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) |
| 1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) |
| 1201 | Unicode UCS-2 Big-Endian |
| 1250 | ANSI - Central European |
| 1251 | ANSI - Cyrillic |
| 1252 | ANSI - Latin I |
| 1253 | ANSI - Greek |
| 1254 | ANSI - Turkish |
| 1255 | ANSI - Hebrew |
| 1256 | ANSI - Arabic |
| 1257 | ANSI - Baltic |
| 1258 | ANSI/OEM - Vietnamese |
| 1361 | Korean (Johab) |
| 10000 | MAC - Roman |
| 10001 | MAC - Japanese |
| 10002 | MAC - Traditional Chinese (Big5) |
| 10003 | MAC - Korean |
| 10004 | MAC - Arabic |
| 10005 | MAC - Hebrew |
| 10006 | MAC - Greek I |
| 10007 | MAC - Cyrillic |
| 10008 | MAC - Simplified Chinese (GB 2312) |
| 10010 | MAC - Romania |
| 10017 | MAC - Ukraine |
| 10021 | MAC - Thai |
| 10029 | MAC - Latin II |
| 10079 | MAC - Icelandic |
| 10081 | MAC - Turkish |
| 10082 | MAC - Croatia |
| 12000 | Unicode UCS-4 Little-Endian |
| 12001 | Unicode UCS-4 Big-Endian |
| 20000 | CNS - Taiwan |
| 20001 | TCA - Taiwan |
| 20002 | Eten - Taiwan |
| 20003 | IBM5550 - Taiwan |
| 20004 | TeleText - Taiwan |
| 20005 | Wang - Taiwan |
| 20105 | IA5 IRV International Alphabet No. 5 (7-bit) |
| 20106 | IA5 German (7-bit) |
| 20107 | IA5 Swedish (7-bit) |
| 20108 | IA5 Norwegian (7-bit) |
| 20127 | US-ASCII (7-bit) |
| 20261 | T.61 |
| 20269 | ISO 6937 Non-Spacing Accent |
| 20273 | IBM EBCDIC - Germany |
| 20277 | IBM EBCDIC - Denmark/Norway |
| 20278 | IBM EBCDIC - Finland/Sweden |
| 20280 | IBM EBCDIC - Italy |
| 20284 | IBM EBCDIC - Latin America/Spain |
| 20285 | IBM EBCDIC - United Kingdom |
| 20290 | IBM EBCDIC - Japanese Katakana Extended |
| 20297 | IBM EBCDIC - France |
| 20420 | IBM EBCDIC - Arabic |
| 20423 | IBM EBCDIC - Greek |
| 20424 | IBM EBCDIC - Hebrew |
| 20833 | IBM EBCDIC - Korean Extended |
| 20838 | IBM EBCDIC - Thai |
| 20866 | Russian - KOI8-R |
| 20871 | IBM EBCDIC - Icelandic |
| 20880 | IBM EBCDIC - Cyrillic (Russian) |
| 20905 | IBM EBCDIC - Turkish |
| 20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) |
| 20932 | JIS X 0208-1990 & 0121-1990 |
| 20936 | Simplified Chinese (GB2312) |
| 21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) |
| 21027 | Extended Alpha Lowercase |
| 21866 | Ukrainian (KOI8-U) |
| 28591 | ISO 8859-1 Latin I |
| 28592 | ISO 8859-2 Central Europe |
| 28593 | ISO 8859-3 Latin 3 |
| 28594 | ISO 8859-4 Baltic |
| 28595 | ISO 8859-5 Cyrillic |
| 28596 | ISO 8859-6 Arabic |
| 28597 | ISO 8859-7 Greek |
| 28598 | ISO 8859-8 Hebrew |
| 28599 | ISO 8859-9 Latin 5 |
| 28605 | ISO 8859-15 Latin 9 |
| 29001 | Europa 3 |
| 38598 | ISO 8859-8 Hebrew |
| 50220 | ISO 2022 Japanese with no halfwidth Katakana |
| 50221 | ISO 2022 Japanese with halfwidth Katakana |
| 50222 | ISO 2022 Japanese JIS X 0201-1989 |
| 50225 | ISO 2022 Korean |
| 50227 | ISO 2022 Simplified Chinese |
| 50229 | ISO 2022 Traditional Chinese |
| 50930 | Japanese (Katakana) Extended |
| 50931 | US/Canada and Japanese |
| 50933 | Korean Extended and Korean |
| 50935 | Simplified Chinese Extended and Simplified Chinese |
| 50936 | Simplified Chinese |
| 50937 | US/Canada and Traditional Chinese |
| 50939 | Japanese (Latin) Extended and Japanese |
| 51932 | EUC - Japanese |
| 51936 | EUC - Simplified Chinese |
| 51949 | EUC - Korean |
| 51950 | EUC - Traditional Chinese |
| 52936 | HZ-GB2312 Simplified Chinese |
| 54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) |
| 57002 | ISCII Devanagari |
| 57003 | ISCII Bengali |
| 57004 | ISCII Tamil |
| 57005 | ISCII Telugu |
| 57006 | ISCII Assamese |
| 57007 | ISCII Oriya |
| 57008 | ISCII Kannada |
| 57009 | ISCII Malayalam |
| 57010 | ISCII Gujarati |
| 57011 | ISCII Punjabi |
| 65000 | Unicode UTF-7 |
| 65001 | Unicode UTF-8 |
| Identifier | Name |
| 1 | ASCII |
| 2 | NEXTSTEP |
| 3 | JapaneseEUC |
| 4 | UTF8 |
| 5 | ISOLatin1 |
| 6 | Symbol |
| 7 | NonLossyASCII |
| 8 | ShiftJIS |
| 9 | ISOLatin2 |
| 10 | Unicode |
| 11 | WindowsCP1251 |
| 12 | WindowsCP1252 |
| 13 | WindowsCP1253 |
| 14 | WindowsCP1254 |
| 15 | WindowsCP1250 |
| 21 | ISO2022JP |
| 30 | MacOSRoman |
| 10 | UTF16String |
| 0x90000100 | UTF16BigEndian |
| 0x94000100 | UTF16LittleEndian |
| 0x8c000100 | UTF32String |
| 0x98000100 | UTF32BigEndian |
| 0x9c000100 | UTF32LittleEndian |
| 65536 | Proprietary |
- 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.
Setting this configuration setting to true tells the struct to use the internal implementation instead of using the system security libraries.
On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default.
To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section.
Trappable Errors (SMIME Component)
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. |