SMIME Module

Properties   Methods   Events   Config Settings   Errors  

The S/MIME module 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 class implements the S/MIME V3 standard for encryption and decryption using Public Key Cryptography Standards (PKCS). In addition, the class can be used to both generate and verify RSA digital signatures. Using this class for decrypting or signing requires a valid digital certificate with a private key.

Before performing an operation the input and output values should be specified.

Input and Output Properties

The class will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

When a valid source is found the search stops. The order in which the output properties are checked is as follows:

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 class can also generate PKCS #7 formatted detached digital signatures and envelopes by specifying DetachedSignature.

Encrypting

To encrypt a message with the class in a PKCS envelope, you must first specify the Certificate for each recipient in the RecipientCerts properties to encrypt the message with. You can easily add these with the AddRecipientCert method. Once you have done this you can call the Encrypt method to encrypt the message with the recipient certificates.

In addition, the class 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 class will attempt to find an appropriate certificate in the Certificate property that matches the encrypting certificate. If it cannot find an appropriate certificate, an exception will be thrown and the message will not be decrypted.

Verifying Signatures

In addition, the S/MIME class can be used to verify signatures included in signed messages or documents. After specifying the input, VerifySignature can then be used to verify the signature. If the message does not have a certificate attached, more then likely an exception will be thrown and the class will not be able to verify the signature. If VerifySignature 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 module with short descriptions. Click on the links for further details.

CertEncodedThis is the certificate (PEM/base64 encoded).
CertStoreThis is the name of the certificate store for the client certificate.
CertStorePasswordIf the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
CertStoreTypeThis is the type of certificate store for this certificate.
CertSubjectThis is the subject of the certificate used for client authentication.
DetachedSignatureThis property specifies whether to include a detached signature when signing a message.
EncryptingAlgorithmThe property includes textual description of the encrypting algorithm.
IncludeCertificateThis property specifies whether to include the signer's certificate with the signed message.
IncludeChainThis property specifies whether to include the signer's certificate chain with the signed message.
IncludeHeadersThis property tells the module whether to include the headers when encoding the message.
InputFileThis property includes the file to process.
InputMessageThis property includes the message to process.
InputMessageHeadersThis property includes a collection of headers from the S/MIME message.
InputMessageHeadersStringThis property includes the string version of headers from the S/MIME message.
InternalHeadersThis property includes the headers of the MIME entity inside the encrypted or signed message.
MessageEncryptedThis property specifies whether or not the current message is encrypted.
MessageSignedThis property specifies whether or not the current message is signed.
OutputFileThis property specifies the output file.
OutputMessageThis property includes the output message after processing.
OutputMessageHeadersThis property includes a collection of headers from the S/MIME message.
OutputMessageHeadersStringThis property includes a string version of headers from the S/MIME message.
OverwriteThis property indicates whether or not the module should overwrite files.
RecipientCertCountThe number of records in the RecipientCert arrays.
RecipientCertEncodedThis is the certificate (PEM/base64 encoded).
RecipientCertStoreThis is the name of the certificate store for the client certificate.
RecipientCertStorePasswordIf the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
RecipientCertStoreTypeThis is the type of certificate store for this certificate.
RecipientCertSubjectThis is the subject of the certificate used for client authentication.
SignerCertEncodedThis is the certificate (PEM/base64 encoded).
SignerCertIssuerThis is the issuer of the certificate.
SignerCertSerialNumberThis is the serial number of the certificate encoded as a string.
SignerCertStoreThis is the name of the certificate store for the client certificate.
SignerCertStorePasswordIf the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
SignerCertStoreTypeThis is the type of certificate store for this certificate.
SignerCertSubjectThis is the subject of the certificate used for client authentication.
SignerCertChainCountThe number of records in the SignerCertChain arrays.
SignerCertChainEncodedThis is the certificate (PEM/base64 encoded).
SigningAlgorithmThis property includes a textual description of the signature hash algorithm.
UseOAEPThis property specifies whether or not to use Optimal Asymmetric Encryption Padding (OAEP).
UsePSSThis 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 module with short descriptions. Click on the links for further details.

AddRecipientCertThis method is used to add recipient certificates used to encrypt messages.
CheckMessageEncryptedThis method checks whether or not the current message is encrypted.
CheckMessageSignedThis method checks whether or not the current message is signed.
ConfigSets or retrieves a configuration setting.
DecryptThis method decrypts the current Message .
DecryptAndVerifySignatureThis method decrypts and verifies the signature of the current message.
EncryptThis method encrypts the message.
GetRecipientInfoThis method gets the recipient information for an encrypted message.
GetSignerCertInfoThis method gets the signature information for an signed message.
ResetThis method resets the module properties.
SignThis method signs the current message.
SignAndEncryptThis method signs and encrypts the current message.
VerifySignatureThis method verifies the signature of the current message.

Event List


The following is the full list of the events fired by the module with short descriptions. Click on the links for further details.

ErrorInformation about errors during data delivery.
RecipientInfoThis event is fired for each recipient certificate of the encrypted message.
SignerCertInfoThis event is fired during verification of the signed message.

Config Settings


The following is a list of config settings for the module with short descriptions. Click on the links for further details.

ApplyB64EncodingInstructs the module to base64 encode the message when signing or encrypting.
CSPThe Cryptographic Service Provider.
GenerateSignatureTimestampWhether to generate timestamps in signatures.
IncludeHeadersTells the module whether to include the headers when encoding the message.
IncludeInternalHeadersTells the module whether or not to include the internal headers when encoding the message.
InputContentTransferEncodingSets the Content-Transfer-Encoding for the signed message.
InputContentTypeSets the Content-Type for the signed message.
InputMessageEncryptedWhether or not the input message is encrypted.
InputMessageSignedWhether or not the input message is signed.
OAEPMGF1HashAlgorithmThe MGF1 hash algorithm used with OAEP.
OAEPParamsThe hex encoded OAEP parameters.
OAEPRSAHashAlgorithmThe RSA hash algorithm used with OAEP.
ParseInternalHeadersTells the module whether or not to parse the message part headers when decrypting a message.
RecipientCertUsed to specify the public certificate when using a PEM key to decrypt.
RecipientCertFileUsed to specify the public certificate file when using a PEM key to decrypt.
RecipientInfoTypeThe type of signer information to include in the signed message.
SignerInfoTypeThe type of signer information to include in the signed message.
UseAlgorithmOIDsWhether OIDs are used when providing information about the algorithms.
UseCryptoAPIWhether to use the Microsoft Crypto API for cryptographic message generation.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
MaskSensitiveWhether sensitive data is masked in log messages.
UseInternalSecurityAPITells the module whether or not to use the system security libraries or an internal implementation.

CertEncoded Property (SMIME Module)

This is the certificate (PEM/base64 encoded).

Syntax

public var certEncoded: String {
  get {...}
  set {...}
}

public var certEncodedB: Data { get {...} set {...} }

@property (nonatomic,readwrite,assign,getter=certEncoded,setter=setCertEncoded:) NSString* certEncoded;

- (NSString*)certEncoded;
- (void)setCertEncoded :(NSString*)newCertEncoded;

@property (nonatomic,readwrite,assign,getter=certEncodedB,setter=setCertEncodedB:) NSData* certEncodedB;

- (NSData*)certEncodedB;
- (void)setCertEncodedB :(NSData*)newCertEncoded;

Default Value

""

Remarks

This is 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.

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setCertEncodedB(certEncoded: Data) throws
public func setCertEncoded(certEncoded: String) throws

CertStore Property (SMIME Module)

This is the name of the certificate store for the client certificate.

Syntax

public var certStore: String {
  get {...}
  set {...}
}

public var certStoreB: Data { get {...} set {...} }

@property (nonatomic,readwrite,assign,getter=certStore,setter=setCertStore:) NSString* certStore;

- (NSString*)certStore;
- (void)setCertStore :(NSString*)newCertStore;

@property (nonatomic,readwrite,assign,getter=certStoreB,setter=setCertStoreB:) NSData* certStoreB;

- (NSData*)certStoreB;
- (void)setCertStoreB :(NSData*)newCertStore;

Default Value

"MY"

Remarks

This is 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 are designations of the most common User and Machine certificate stores in Windows:

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot certificates.

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

CertStorePassword Property (SMIME Module)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

public var certStorePassword: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=certStorePassword,setter=setCertStorePassword:) NSString* certStorePassword;

- (NSString*)certStorePassword;
- (void)setCertStorePassword :(NSString*)newCertStorePassword;

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.

CertStoreType Property (SMIME Module)

This is the type of certificate store for this certificate.

Syntax

public var certStoreType: SmimeCertStoreTypes {
  get {...}
  set {...}
}

public enum SmimeCertStoreTypes: Int32 { case cstUser = 0 case cstMachine = 1 case cstPFXFile = 2 case cstPFXBlob = 3 case cstJKSFile = 4 case cstJKSBlob = 5 case cstPEMKeyFile = 6 case cstPEMKeyBlob = 7 case cstPublicKeyFile = 8 case cstPublicKeyBlob = 9 case cstSSHPublicKeyBlob = 10 case cstP7BFile = 11 case cstP7BBlob = 12 case cstSSHPublicKeyFile = 13 case cstPPKFile = 14 case cstPPKBlob = 15 case cstXMLFile = 16 case cstXMLBlob = 17 case cstJWKFile = 18 case cstJWKBlob = 19 case cstSecurityKey = 20 case cstBCFKSFile = 21 case cstBCFKSBlob = 22 case cstPKCS11 = 23 case cstAuto = 99 }

@property (nonatomic,readwrite,assign,getter=certStoreType,setter=setCertStoreType:) int certStoreType;

- (int)certStoreType;
- (void)setCertStoreType :(int)newCertStoreType;

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used the class will automatically determine the type. This property can take one of the following values:

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 (PKCS12) file containing certificates.
3 (cstPFXBlob)The certificate store is a string (binary or base64-encoded) representing a certificate store in PFX (PKCS12) 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 PKCS7 file containing certificates.
12 (cstP7BBlob)The certificate store is a string (binary) representing a certificate store in PKCS7 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 PKCS11 interface.

To use a security key the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS11 dll. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use.

When using a certificate, pass the previously saved security key information as the CertStore and set CertStorePassword to the PIN.

Code Example: SSH Authentication with Security Key certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);

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.

CertSubject Property (SMIME Module)

This is the subject of the certificate used for client authentication.

Syntax

public var certSubject: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=certSubject,setter=setCertSubject:) NSString* certSubject;

- (NSString*)certSubject;
- (void)setCertSubject :(NSString*)newCertSubject;

Default Value

""

Remarks

This is 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=support@nsoftware.com". Common fields and their meanings are displayed below.

FieldMeaning
CNCommon Name. This is commonly a host name like www.server.com.
OOrganization
OUOrganizational Unit
LLocality
SState
CCountry
EEmail Address

If a field value contains a comma it must be quoted.

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setCertSubject(certSubject: String) throws

DetachedSignature Property (SMIME Module)

This property specifies whether to include a detached signature when signing a message.

Syntax

public var detachedSignature: Bool {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=detachedSignature,setter=setDetachedSignature:) BOOL detachedSignature;

- (BOOL)detachedSignature;
- (void)setDetachedSignature :(BOOL)newDetachedSignature;

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.

EncryptingAlgorithm Property (SMIME Module)

The property includes textual description of the encrypting algorithm.

Syntax

public var encryptingAlgorithm: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=encryptingAlgorithm,setter=setEncryptingAlgorithm:) NSString* encryptingAlgorithm;

- (NSString*)encryptingAlgorithm;
- (void)setEncryptingAlgorithm :(NSString*)newEncryptingAlgorithm;

Default Value

"3DES"

Remarks

This property contains either the name of the algorithm (such as 3DES or AES), or an object identifier (OID) string representing the algorithm.

Possible values are as follows:

  • "3DES"
  • "DES"
  • "RC2CBC40"
  • "RC2CBC64"
  • "RC2CBC128" or "RC2"
  • "AESCBC128" or "AES"
  • "AESCBC192"
  • "AESCBC256"
  • "AESGCM128" or "AESGCM"
  • "AESGCM192"
  • "AESGCM256"

IncludeCertificate Property (SMIME Module)

This property specifies whether to include the signer's certificate with the signed message.

Syntax

public var includeCertificate: Bool {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=includeCertificate,setter=setIncludeCertificate:) BOOL includeCertificate;

- (BOOL)includeCertificate;
- (void)setIncludeCertificate :(BOOL)newIncludeCertificate;

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.

IncludeChain Property (SMIME Module)

This property specifies whether to include the signer's certificate chain with the signed message.

Syntax

public var includeChain: Bool {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=includeChain,setter=setIncludeChain:) BOOL includeChain;

- (BOOL)includeChain;
- (void)setIncludeChain :(BOOL)newIncludeChain;

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.

IncludeHeaders Property (SMIME Module)

This property tells the module whether to include the headers when encoding the message.

Syntax

public var includeHeaders: Bool {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=includeHeaders,setter=setIncludeHeaders:) BOOL includeHeaders;

- (BOOL)includeHeaders;
- (void)setIncludeHeaders :(BOOL)newIncludeHeaders;

Default Value

False

Remarks

If True, the class 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.

InputFile Property (SMIME Module)

This property includes the file to process.

Syntax

public var inputFile: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=inputFile,setter=setInputFile:) NSString* inputFile;

- (NSString*)inputFile;
- (void)setInputFile :(NSString*)newInputFile;

Default Value

""

Remarks

This property specifies the file to be processed. Set this property to the full or relative path to the file that will be processed.

Encrypt and/or Sign

When encrypting or signing, this may be set to a file containing content that will be encrypted and/or signed.

Decrypt and/or Verify

When decrypting or verifying a signature, this may be set to a file containing the fully encoded S/MIME message.

Input and Output Properties

The class will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

When a valid source is found the search stops. The order in which the output properties are checked is as follows:

The headers of the input message (if any) will be read from InputMessageHeaders or InputMessageHeadersString.

InputMessage Property (SMIME Module)

This property includes the message to process.

Syntax

public var inputMessage: String {
  get {...}
  set {...}
}

public var inputMessageB: Data { get {...} set {...} }

@property (nonatomic,readwrite,assign,getter=inputMessage,setter=setInputMessage:) NSString* inputMessage;

- (NSString*)inputMessage;
- (void)setInputMessage :(NSString*)newInputMessage;

@property (nonatomic,readwrite,assign,getter=inputMessageB,setter=setInputMessageB:) NSData* inputMessageB;

- (NSData*)inputMessageB;
- (void)setInputMessageB :(NSData*)newInputMessage;

Default Value

""

Remarks

This property specifies the message to be processed.

Encrypt and/or Sign

When encrypting or signing, this may be set to the content that will be encrypted and/or signed.

Decrypt and/or Verify

When decrypting or verifying a signature, this may be set to the fully encoded S/MIME message.

Input and Output Properties

The class will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

When a valid source is found the search stops. The order in which the output properties are checked is as follows:

The headers of the input message (if any) will be read from InputMessageHeaders or InputMessageHeadersString.

InputMessageHeaders Property (SMIME Module)

This property includes a collection of headers from the S/MIME message.

Syntax

public var inputMessageHeaders: Array<Header> {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=inputMessageHeaderCount,setter=setInputMessageHeaderCount:) int inputMessageHeaderCount;

- (int)inputMessageHeaderCount;
- (void)setInputMessageHeaderCount :(int)newInputMessageHeaderCount;

- (NSString*)inputMessageHeaderField:(int)inputMessageHeaderIndex;
- (void)setInputMessageHeaderField:(int)inputMessageHeaderIndex :(NSString*)newInputMessageHeaderField;

- (NSString*)inputMessageHeaderValue:(int)inputMessageHeaderIndex;
- (void)setInputMessageHeaderValue:(int)inputMessageHeaderIndex :(NSString*)newInputMessageHeaderValue;

Default Value

False

Remarks

This property contains a collection of headers from the S/MIME message.

This property may be set to the headers of the message that will be decrypted/verified.

InputMessageHeadersString Property (SMIME Module)

This property includes the string version of headers from the S/MIME message.

Syntax

public var inputMessageHeadersString: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=inputMessageHeadersString,setter=setInputMessageHeadersString:) NSString* inputMessageHeadersString;

- (NSString*)inputMessageHeadersString;
- (void)setInputMessageHeadersString :(NSString*)newInputMessageHeadersString;

Default Value

""

Remarks

This property contains the string version of headers from the S/MIME message.

This property may be set to the headers of the message that will be decrypted/verified.

InternalHeaders Property (SMIME Module)

This property includes the headers of the MIME entity inside the encrypted or signed message.

Syntax

public var internalHeaders: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=internalHeaders,setter=setInternalHeaders:) NSString* internalHeaders;

- (NSString*)internalHeaders;
- (void)setInternalHeaders :(NSString*)newInternalHeaders;

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.

MessageEncrypted Property (SMIME Module)

This property specifies whether or not the current message is encrypted.

Syntax

public var messageEncrypted: Bool {
  get {...}
}

@property (nonatomic,readonly,assign,getter=messageEncrypted) BOOL messageEncrypted;

- (BOOL)messageEncrypted;

Default Value

False

Remarks

This property indicates whether or not the current message is encrypted. This property will return True if the current message appears to be encrypted, according to the value of MessageHeaders.

This property is read-only.

MessageSigned Property (SMIME Module)

This property specifies whether or not the current message is signed.

Syntax

public var messageSigned: Bool {
  get {...}
}

@property (nonatomic,readonly,assign,getter=messageSigned) BOOL messageSigned;

- (BOOL)messageSigned;

Default Value

False

Remarks

This property indicates whether or not the current message is signed. This property will return True if the current message appears to be signed, according to the value of MessageHeaders.

Note: A message that is both signed and encrypted will not appear to be signed until after it is decrypted.

This property is read-only.

OutputFile Property (SMIME Module)

This property specifies the output file.

Syntax

public var outputFile: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=outputFile,setter=setOutputFile:) NSString* outputFile;

- (NSString*)outputFile;
- (void)setOutputFile :(NSString*)newOutputFile;

Default Value

""

Remarks

This property specifies the file to which the output will be written. This may be set to an absolute or relative path.

Encrypt and/or Sign

When encrypting or signing, this specifies a file where the fully encoded S/MIME message will be written.

Decrypt and/or Verify

When decrypting or verifying a signature, this specifies a file where the decrypted/verified content will be written.

Input and Output Properties

The class will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

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.

OutputMessage Property (SMIME Module)

This property includes the output message after processing.

Syntax

public var outputMessage: String {
  get {...}
}

public var outputMessageB: Data { get {...} }

@property (nonatomic,readonly,assign,getter=outputMessage) NSString* outputMessage;

- (NSString*)outputMessage;

@property (nonatomic,readonly,assign,getter=outputMessageB) NSData* outputMessageB;

- (NSData*)outputMessageB;

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 class will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

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.

OutputMessageHeaders Property (SMIME Module)

This property includes a collection of headers from the S/MIME message.

Syntax

public var outputMessageHeaders: Array<Header> {
  get {...}
}

@property (nonatomic,readonly,assign,getter=outputMessageHeaderCount) int outputMessageHeaderCount;

- (int)outputMessageHeaderCount;

- (NSString*)outputMessageHeaderField:(int)outputMessageHeaderIndex;

- (NSString*)outputMessageHeaderValue:(int)outputMessageHeaderIndex;

Default Value

False

Remarks

The class will populate this property after signing and/or encrypting.

The user should use these additional headers when emailing or sending the OutputMessage. This can be done by including these headers in the OtherHeaders property of the class that you wish to send the message with.

After the decryption or verification, this property contains the headers of the verified or decrypted message.

OutputMessageHeadersString Property (SMIME Module)

This property includes a string version of headers from the S/MIME message.

Syntax

public var outputMessageHeadersString: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=outputMessageHeadersString) NSString* outputMessageHeadersString;

- (NSString*)outputMessageHeadersString;

Default Value

""

Remarks

This property contains the string version of headers from the S/MIME message. The class will populate this property after signing and/or encrypting.

The user should use these additional headers when emailing or sending the OutputMessage. This can be done by including these headers in the OtherHeaders property of the class that you wish to send the message with.

After the decryption or verification, this property contains the headers of the verified or decrypted message.

This property is read-only.

Overwrite Property (SMIME Module)

This property indicates whether or not the module should overwrite files.

Syntax

public var overwrite: Bool {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=overwrite,setter=setOverwrite:) BOOL overwrite;

- (BOOL)overwrite;
- (void)setOverwrite :(BOOL)newOverwrite;

Default Value

True

Remarks

This property indicates whether or not the class will overwrite OutputFile. If Overwrite is False, an error will be thrown whenever OutputFile exists before an operation. The default value is False.

RecipientCertCount Property (SMIME Module)

The number of records in the RecipientCert arrays.

Syntax

public var recipientCertCount: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=recipientCertCount,setter=setRecipientCertCount:) int recipientCertCount;

- (int)recipientCertCount;
- (void)setRecipientCertCount :(int)newRecipientCertCount;

Default Value

0

Remarks

This property controls the size of the following arrays:

The array indices start at 0 and end at RecipientCertCount - 1.

RecipientCertEncoded Property (SMIME Module)

This is the certificate (PEM/base64 encoded).

Syntax

public var recipientCertEncoded: String {
  get {...}
  set {...}
}

public var recipientCertEncodedB: Data { get {...} set {...} }

- (NSString*)recipientCertEncoded:(int)recipientCertIndex;
- (void)setRecipientCertEncoded:(int)recipientCertIndex :(NSString*)newRecipientCertEncoded;

- (NSData*)recipientCertEncodedB:(int)recipientCertIndex;
- (void)setRecipientCertEncodedB:(int)recipientCertIndex :(NSData*)newRecipientCertEncoded;

Default Value

""

Remarks

This is 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.

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setRecipientCertEncodedB(recipientCertEncoded: Data) throws
public func setRecipientCertEncoded(recipientCertEncoded: String) throws

RecipientCertStore Property (SMIME Module)

This is the name of the certificate store for the client certificate.

Syntax

public var recipientCertStore: String {
  get {...}
  set {...}
}

public var recipientCertStoreB: Data { get {...} set {...} }

- (NSString*)recipientCertStore:(int)recipientCertIndex;
- (void)setRecipientCertStore:(int)recipientCertIndex :(NSString*)newRecipientCertStore;

- (NSData*)recipientCertStoreB:(int)recipientCertIndex;
- (void)setRecipientCertStoreB:(int)recipientCertIndex :(NSData*)newRecipientCertStore;

Default Value

"MY"

Remarks

This is 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 are designations of the most common User and Machine certificate stores in Windows:

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot certificates.

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

RecipientCertStorePassword Property (SMIME Module)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

public var recipientCertStorePassword: String {
  get {...}
  set {...}
}

- (NSString*)recipientCertStorePassword:(int)recipientCertIndex;
- (void)setRecipientCertStorePassword:(int)recipientCertIndex :(NSString*)newRecipientCertStorePassword;

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.

RecipientCertStoreType Property (SMIME Module)

This is the type of certificate store for this certificate.

Syntax

public var recipientCertStoreType: SmimeRecipientCertStoreTypes {
  get {...}
  set {...}
}

public enum SmimeRecipientCertStoreTypes: Int32 { case cstUser = 0 case cstMachine = 1 case cstPFXFile = 2 case cstPFXBlob = 3 case cstJKSFile = 4 case cstJKSBlob = 5 case cstPEMKeyFile = 6 case cstPEMKeyBlob = 7 case cstPublicKeyFile = 8 case cstPublicKeyBlob = 9 case cstSSHPublicKeyBlob = 10 case cstP7BFile = 11 case cstP7BBlob = 12 case cstSSHPublicKeyFile = 13 case cstPPKFile = 14 case cstPPKBlob = 15 case cstXMLFile = 16 case cstXMLBlob = 17 case cstJWKFile = 18 case cstJWKBlob = 19 case cstSecurityKey = 20 case cstBCFKSFile = 21 case cstBCFKSBlob = 22 case cstPKCS11 = 23 case cstAuto = 99 }

- (int)recipientCertStoreType:(int)recipientCertIndex;
- (void)setRecipientCertStoreType:(int)recipientCertIndex :(int)newRecipientCertStoreType;

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used the class will automatically determine the type. This property can take one of the following values:

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 (PKCS12) file containing certificates.
3 (cstPFXBlob)The certificate store is a string (binary or base64-encoded) representing a certificate store in PFX (PKCS12) 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 PKCS7 file containing certificates.
12 (cstP7BBlob)The certificate store is a string (binary) representing a certificate store in PKCS7 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 PKCS11 interface.

To use a security key the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS11 dll. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use.

When using a certificate, pass the previously saved security key information as the RecipientCertStore and set RecipientCertStorePassword to the PIN.

Code Example: SSH Authentication with Security Key certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);

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.

RecipientCertSubject Property (SMIME Module)

This is the subject of the certificate used for client authentication.

Syntax

public var recipientCertSubject: String {
  get {...}
  set {...}
}

- (NSString*)recipientCertSubject:(int)recipientCertIndex;
- (void)setRecipientCertSubject:(int)recipientCertIndex :(NSString*)newRecipientCertSubject;

Default Value

""

Remarks

This is 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=support@nsoftware.com". Common fields and their meanings are displayed below.

FieldMeaning
CNCommon Name. This is commonly a host name like www.server.com.
OOrganization
OUOrganizational Unit
LLocality
SState
CCountry
EEmail Address

If a field value contains a comma it must be quoted.

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setRecipientCertSubject(recipientCertSubject: String) throws

SignerCertEncoded Property (SMIME Module)

This is the certificate (PEM/base64 encoded).

Syntax

public var signerCertEncoded: String {
  get {...}
  set {...}
}

public var signerCertEncodedB: Data { get {...} set {...} }

@property (nonatomic,readwrite,assign,getter=signerCertEncoded,setter=setSignerCertEncoded:) NSString* signerCertEncoded;

- (NSString*)signerCertEncoded;
- (void)setSignerCertEncoded :(NSString*)newSignerCertEncoded;

@property (nonatomic,readwrite,assign,getter=signerCertEncodedB,setter=setSignerCertEncodedB:) NSData* signerCertEncodedB;

- (NSData*)signerCertEncodedB;
- (void)setSignerCertEncodedB :(NSData*)newSignerCertEncoded;

Default Value

""

Remarks

This is 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.

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setSignerCertEncodedB(signerCertEncoded: Data) throws
public func setSignerCertEncoded(signerCertEncoded: String) throws

SignerCertIssuer Property (SMIME Module)

This is the issuer of the certificate.

Syntax

public var signerCertIssuer: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=signerCertIssuer) NSString* signerCertIssuer;

- (NSString*)signerCertIssuer;

Default Value

""

Remarks

This is 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.

SignerCertSerialNumber Property (SMIME Module)

This is the serial number of the certificate encoded as a string.

Syntax

public var signerCertSerialNumber: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=signerCertSerialNumber) NSString* signerCertSerialNumber;

- (NSString*)signerCertSerialNumber;

Default Value

""

Remarks

This is 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.

SignerCertStore Property (SMIME Module)

This is the name of the certificate store for the client certificate.

Syntax

public var signerCertStore: String {
  get {...}
  set {...}
}

public var signerCertStoreB: Data { get {...} set {...} }

@property (nonatomic,readwrite,assign,getter=signerCertStore,setter=setSignerCertStore:) NSString* signerCertStore;

- (NSString*)signerCertStore;
- (void)setSignerCertStore :(NSString*)newSignerCertStore;

@property (nonatomic,readwrite,assign,getter=signerCertStoreB,setter=setSignerCertStoreB:) NSData* signerCertStoreB;

- (NSData*)signerCertStoreB;
- (void)setSignerCertStoreB :(NSData*)newSignerCertStore;

Default Value

"MY"

Remarks

This is 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 are designations of the most common User and Machine certificate stores in Windows:

MYA certificate store holding personal certificates with their associated private keys.
CACertifying authority certificates.
ROOTRoot certificates.

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

SignerCertStorePassword Property (SMIME Module)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

public var signerCertStorePassword: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=signerCertStorePassword,setter=setSignerCertStorePassword:) NSString* signerCertStorePassword;

- (NSString*)signerCertStorePassword;
- (void)setSignerCertStorePassword :(NSString*)newSignerCertStorePassword;

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.

SignerCertStoreType Property (SMIME Module)

This is the type of certificate store for this certificate.

Syntax

public var signerCertStoreType: SmimeSignerCertStoreTypes {
  get {...}
  set {...}
}

public enum SmimeSignerCertStoreTypes: Int32 { case cstUser = 0 case cstMachine = 1 case cstPFXFile = 2 case cstPFXBlob = 3 case cstJKSFile = 4 case cstJKSBlob = 5 case cstPEMKeyFile = 6 case cstPEMKeyBlob = 7 case cstPublicKeyFile = 8 case cstPublicKeyBlob = 9 case cstSSHPublicKeyBlob = 10 case cstP7BFile = 11 case cstP7BBlob = 12 case cstSSHPublicKeyFile = 13 case cstPPKFile = 14 case cstPPKBlob = 15 case cstXMLFile = 16 case cstXMLBlob = 17 case cstJWKFile = 18 case cstJWKBlob = 19 case cstSecurityKey = 20 case cstBCFKSFile = 21 case cstBCFKSBlob = 22 case cstPKCS11 = 23 case cstAuto = 99 }

@property (nonatomic,readwrite,assign,getter=signerCertStoreType,setter=setSignerCertStoreType:) int signerCertStoreType;

- (int)signerCertStoreType;
- (void)setSignerCertStoreType :(int)newSignerCertStoreType;

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used the class will automatically determine the type. This property can take one of the following values:

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 (PKCS12) file containing certificates.
3 (cstPFXBlob)The certificate store is a string (binary or base64-encoded) representing a certificate store in PFX (PKCS12) 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 PKCS7 file containing certificates.
12 (cstP7BBlob)The certificate store is a string (binary) representing a certificate store in PKCS7 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 PKCS11 interface.

To use a security key the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS11 dll. The certificate information returned in the CertList event's CertEncoded parameter may be saved for later use.

When using a certificate, pass the previously saved security key information as the SignerCertStore and set SignerCertStorePassword to the PIN.

Code Example: SSH Authentication with Security Key certmgr.CertStoreType = CertStoreTypes.cstPKCS11; certmgr.OnCertList += (s, e) => { secKeyBlob = e.CertEncoded; }; certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll"; certmgr.CertStorePassword = "123456"; //PIN certmgr.ListStoreCertificates(); sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22);

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.

SignerCertSubject Property (SMIME Module)

This is the subject of the certificate used for client authentication.

Syntax

public var signerCertSubject: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=signerCertSubject,setter=setSignerCertSubject:) NSString* signerCertSubject;

- (NSString*)signerCertSubject;
- (void)setSignerCertSubject :(NSString*)newSignerCertSubject;

Default Value

""

Remarks

This is 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=support@nsoftware.com". Common fields and their meanings are displayed below.

FieldMeaning
CNCommon Name. This is commonly a host name like www.server.com.
OOrganization
OUOrganizational Unit
LLocality
SState
CCountry
EEmail Address

If a field value contains a comma it must be quoted.

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setSignerCertSubject(signerCertSubject: String) throws

SignerCertChainCount Property (SMIME Module)

The number of records in the SignerCertChain arrays.

Syntax

public var signerCertChainCount: Int32 {
  get {...}
}

@property (nonatomic,readonly,assign,getter=signerCertChainCount) int signerCertChainCount;

- (int)signerCertChainCount;

Default Value

0

Remarks

This property controls the size of the following arrays:

The array indices start at 0 and end at SignerCertChainCount - 1.

This property is read-only.

SignerCertChainEncoded Property (SMIME Module)

This is the certificate (PEM/base64 encoded).

Syntax

public var signerCertChainEncoded: String {
  get {...}
}

public var signerCertChainEncodedB: Data { get {...} }

- (NSString*)signerCertChainEncoded:(int)signerCertChainIndex;

- (NSData*)signerCertChainEncodedB:(int)signerCertChainIndex;

Default Value

""

Remarks

This is 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.

This property is read-only.

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setSignerCertChainEncodedB(signerCertChainEncoded: Data) throws
public func setSignerCertChainEncoded(signerCertChainEncoded: String) throws

SigningAlgorithm Property (SMIME Module)

This property includes a textual description of the signature hash algorithm.

Syntax

public var signingAlgorithm: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=signingAlgorithm,setter=setSigningAlgorithm:) NSString* signingAlgorithm;

- (NSString*)signingAlgorithm;
- (void)setSigningAlgorithm :(NSString*)newSigningAlgorithm;

Default Value

"SHA256"

Remarks

This property specifies the hash algorithm used to prepare the message digest for signature.

This property must contain either the name of the algorithm (such as MD5 or SHA1), or an object Id (OID) string representing the hash algorithm. Possible values are as follows:

  • sha1
  • md5
  • sha-256 (default)
  • sha-384
  • sha-512
  • sha-224

When read, the value of the property always contains the OID of the algorithm, or an empty string if the algorithm is unknown.

UseOAEP Property (SMIME Module)

This property specifies whether or not to use Optimal Asymmetric Encryption Padding (OAEP).

Syntax

public var useOAEP: Bool {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=useOAEP,setter=setUseOAEP:) BOOL useOAEP;

- (BOOL)useOAEP;
- (void)setUseOAEP :(BOOL)newUseOAEP;

Default Value

False

Remarks

This property specifies whether or not to use Optimal Asymmetric Encryption Padding (OAEP). By default, this value is False and the class will use PKCS1.

To specify nondefault OAEP options, please see OAEPRSAHashAlgorithm, OAEPMGF1HashAlgorithm, and OAEPParams

UsePSS Property (SMIME Module)

This property specifies whether or not RSA-PSS will be used during signing and verification.

Syntax

public var usePSS: Bool {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=usePSS,setter=setUsePSS:) BOOL usePSS;

- (BOOL)usePSS;
- (void)setUsePSS :(BOOL)newUsePSS;

Default Value

False

Remarks

This property specifies whether or not RSA-PSS will be used when signing and verifying messages. The default value is False.

AddRecipientCert Method (SMIME Module)

This method is used to add recipient certificates used to encrypt messages.

Syntax

public func addRecipientCert(certEncoded: Data) throws -> Void
- (void)addRecipientCert:(NSData*)certEncoded;

Remarks

This method is used to add recipient certificates to the internal MessageRecipients properties used to encrypt the Message. The recipient certificate must be a valid PKCS-encoded certificate. If the certificate provided is Base64 encoded, it will be decoded first by the object.

The CertMgr class may be used to retrieve the appropriate certificate from the system.

CheckMessageEncrypted Method (SMIME Module)

This method checks whether or not the current message is encrypted.

Syntax

public func checkMessageEncrypted() throws -> Bool
- (BOOL)checkMessageEncrypted;

Remarks

This method is used to check whether or not the current message is encrypted. This method will return True, if the current message appears to be encrypted, according to the value of OutputMessageHeaders.

CheckMessageSigned Method (SMIME Module)

This method checks whether or not the current message is signed.

Syntax

public func checkMessageSigned() throws -> Bool
- (BOOL)checkMessageSigned;

Remarks

This method is used to check whether or not the current message is signed. This method will return True, if the current message appears to be signed, according to the value of OutputMessageHeaders.

Note: A message that is both signed and encrypted will not appear to be signed until after it is decrypted.

Config Method (SMIME Module)

Sets or retrieves a configuration setting.

Syntax

public func config(configurationString: String) throws -> String
- (NSString*)config:(NSString*)configurationString;

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Decrypt Method (SMIME Module)

This method decrypts the current Message .

Syntax

public func decrypt() throws -> Void
- (void)decrypt;

Remarks

This method takes attempts to decrypt the encrypted message using the certificate in Certificate.

Input and Output Properties

The class will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

When a valid source is found the search stops. The order in which the output properties are checked is as follows:

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 Module)

This method decrypts and verifies the signature of the current message.

Syntax

public func decryptAndVerifySignature() throws -> Void
- (void)decryptAndVerifySignature;

Remarks

This method attempts to both decrypt and verify the signature of the message. All of the properties affected by calling the Decrypt 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 class will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

When a valid source is found the search stops. The order in which the output properties are checked is as follows:

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 Module)

This method encrypts the message.

Syntax

public func encrypt() throws -> Void
- (void)encrypt;

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 class will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

When a valid source is found the search stops. The order in which the output properties are checked is as follows:

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 Module)

This method gets the recipient information for an encrypted message.

Syntax

public func getRecipientInfo() throws -> Void
- (void)getRecipientInfo;

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 Module)

This method gets the signature information for an signed message.

Syntax

public func getSignerCertInfo() throws -> Void
- (void)getSignerCertInfo;

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 class will fire the SignerCertInfo and a certificate may be loaded from within the event at that time (if necessary).

Reset Method (SMIME Module)

This method resets the component properties.

Syntax

public func reset() throws -> Void
- (void)reset;

Remarks

This method resets the values of all message and certificate properties. It is an easy way to reset the class properties before starting to populate with new values.

Sign Method (SMIME Module)

This method signs the current message.

Syntax

public func sign() throws -> Void
- (void)sign;

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 class will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

When a valid source is found the search stops. The order in which the output properties are checked is as follows:

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 Module)

This method signs and encrypts the current message.

Syntax

public func signAndEncrypt() throws -> Void
- (void)signAndEncrypt;

Remarks

This method both signs and encrypts the input message into a single PKCS-encoded envelope. The value in DetachedSignature is ignored: the class 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 class will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

When a valid source is found the search stops. The order in which the output properties are checked is as follows:

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 Module)

This method verifies the signature of the current message.

Syntax

public func verifySignature() throws -> Void
- (void)verifySignature;

Remarks

This method attempts to verify the signature of the input message. If the message does not have a certificate attached, the class will attempt to verify the signature using the certificate supplied in SignerCert (if any). If no certificate is found, the class .

If this method is successful, the SignerCert property will contain the certificate information of the message signer.

Note: This function does not attempt to check the validity of the signing certificate.

Input and Output Properties

The class will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

When a valid source is found the search stops. The order in which the output properties are checked is as follows:

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 Module)

Information about errors during data delivery.

Syntax

func onError(errorCode: Int32, description: String)
- (void)onError:(int)errorCode :(NSString*)description;

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class .

ErrorCode contains an error code and Description 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 Module)

This event is fired for each recipient certificate of the encrypted message.

Syntax

func onRecipientInfo(issuer: String, serialNumber: String, subjectKeyIdentifier: String, encryptionAlgorithm: String)
- (void)onRecipientInfo:(NSString*)issuer :(NSString*)serialNumber :(NSString*)subjectKeyIdentifier :(NSString*)encryptionAlgorithm;

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 Module)

This event is fired during verification of the signed message.

Syntax

func onSignerCertInfo(issuer: String, serialNumber: String, subjectKeyIdentifier: String, certEncoded: Data)
- (void)onSignerCertInfo:(NSString*)issuer :(NSString*)serialNumber :(NSString*)subjectKeyIdentifier :(NSData*)certEncoded;

Remarks

During verification, this event will be raised while parsing the signer's certificate information. The parameters that are populated depend on the options used when the message was originally signed. This information may be used to select the correct certificate for SignerCert to verify the signature. The following parameters may be populated:

Issuer specifies the subject of the issuer of the certificate used to sign the message.

SerialNumber is the serial number of the certificate used to sign the message.

SubjectKeyIdentifier is the X.509 subjectKeyIdentifier extension value of the certificate used to sign the message encoded as a hex string.

CertEncoded is the PEM (Base64 encoded) public certificate needed to verify the signature.

Note: When this value is present, the class will automatically use this value to perform signature verification.

The SignerCert property may be set from within this event. In this manner, the decision of which signer certificate to load may be delayed until the parameters of this event are inspected and the correct certificate can be located and loaded.

Header Type

This is an HTTP header as it is received from the server.

Remarks

When a header is received through a Header event, it is parsed into a Header type. This type contains a , and its corresponding .

Fields

field
String

This property contains the name of the HTTP Header (this is the same case as it is delivered).

value
String

This property contains the Header contents.

Constructors

public init()
public init(field: , value: )

Config Settings (SMIME Module)

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

SMIME Config Settings

ApplyB64Encoding:   Instructs the class to base64 encode the message when signing or encrypting.

This configuration setting allows you to control the Base64 encoding of the resulting message. By default, this value is True, and the message will be Base64 encoded when signing or encrypting.

Note: When signing, this configuration setting may be used only when DetachedSignature is False.

CSP:   The Cryptographic Service Provider.

For the Win32 editions, this configuration setting includes the name of the Cryptographic Service Provider used to provide access to encryption/decryption and signature operations.

Note: This configuration setting may be used only when the UseCryptoAPI is True.

GenerateSignatureTimestamp:   Whether to generate timestamps in signatures.

If GenerateSignatureTimestamp is True, a timestamp will be generated and added to all signatures created by the class.

The default value is True.

IncludeHeaders:   Tells the class whether to include the headers when encoding the message.

If set to True, the class will include the headers when Sign, Encrypt, or SignAndEncrypt are called. If False, only the message will be encoded.

The default value for IncludeHeaders is False.

IncludeInternalHeaders:   Tells the class whether or not to include the internal headers when encoding the message.

If set to True, the class will include the internal message part headers when Sign, Encrypt, or SignAndEncrypt are called. When set to False, only the message will be encoded.

The default value for IncludeInternalHeaders is True.

InputContentTransferEncoding:   Sets the Content-Transfer-Encoding for the signed message.

This configuration setting specifies the Content-Transfer-Encoding header value in signed messages. By default, the class will automatically determine the Content-Transfer-Encoding based on the file extension set in InputFile. This setting may be set to override the determined value or to specify a value if data are read from InputMessage.

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.

InputContentType:   Sets the Content-Type for the signed message.

This configuration setting specifies the Content-Type header value in signed messages. By default, the class will automatically determine the Content-Type based on the file extension set in InputFile. This setting may be set to override the determined value or to specify a value if data are read from InputMessage.

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.

InputMessageEncrypted:   Whether or not the input message is encrypted.

This configuration setting will return True if the input message appears to be encrypted according to the value of InputMessageHeaders.

InputMessageSigned:   Whether or not the input message is signed.

This will return true if the input message appears to be signed according to the value of InputMessageHeaders.

OAEPMGF1HashAlgorithm:   The MGF1 hash algorithm used with OAEP.

This configuration setting specifies the MGF1 hash algorithm used when UseOAEP is set to True. The default value is SHA256. Possible values are as follows:

  • "SHA1"
  • "SHA224"
  • "SHA256" (default)
  • "SHA384"
  • "SHA512"
  • "RIPEMD160"
  • "MD2"
  • "MD5"
  • "MD5SHA1"

Note: This setting is not applicable when UseFIPSCompliantAPI is set to 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.

OAEPParams:   The hex encoded OAEP parameters.

This configuration setting optionally specifies Optimal Asymmetric Encryption Padding (OAEP) parameters to be used when UseOAEP is set to True. The specified value should be hex encoded.

OAEPRSAHashAlgorithm:   The RSA hash algorithm used with OAEP.

This configuration setting specifies that RSA hash algorithm used when UseOAEP is set to True. The default value is SHA256. Possible values are as follows:

  • "SHA1"
  • "SHA224"
  • "SHA256" (default)
  • "SHA384"
  • "SHA512"
  • "RIPEMD160"
  • "MD2"
  • "MD5"
  • "MD5SHA1"
ParseInternalHeaders:   Tells the class whether or not to parse the message part headers when decrypting a message.

If set to True, the class will parse the internal message part headers when Decrypt, or DecryptAndVerifySignature are called. These headers will be placed in the InternalHeaders property. If False, the entire message will be decoded.

The default value for ParseInternalHeaders is True.

RecipientCert:   Used to specify the public certificate when using a PEM key to decrypt.

When decrypting, the class must search through the Recipient Information collection to find which encrypted key to use for decryption. Because PEM keys do not contain a serial number or any additional information about the key itself, the public key associated with this private key must be supplied.

This configuration setting may be set to the entire blob of the public certificate the class should use to select the correct recipient-encrypted key for decryption.

RecipientCertFile:   Used to specify the public certificate file when using a PEM key to decrypt.

When decrypting, the class must search through the Recipient Information collection to find which encrypted key to use for decryption. Because PEM keys do not contain a serial number or any additional information about the key itself, the public key associated with this private key must be supplied.

This configuration setting may be set to the file that contains the public certificate the class should use to select the correct recipient-encrypted key for decryption.

RecipientInfoType:   The type of signer information to include in the signed message.

This configuration setting specifies which type of information about the recipient's encryption certificate is included in the encrypted message. Possible values are as follows:

  • 0 (issuerAndSerialNumber - default)
  • 1 (subjectKeyIdentifier)

Note: When subjectKeyIdentifier is selected, the recipient's encryption certificate must contain the subjectKeyIdentifier extension.

SignerInfoType:   The type of signer information to include in the signed message.

This configuration setting specifies which type of information about the signer certificate is included in the signed message. Possible values are as follows:

  • 0 (issuerAndSerialNumber - default)
  • 1 (subjectKeyIdentifier)

Note: When subjectKeyIdentifier is selected, the signing certificate must contain the subjectKeyIdentifier extension.

UseAlgorithmOIDs:   Whether OIDs are used when providing information about the algorithms.

This configuration setting controls whether the EncryptionAlgorithm parameter of the RecipientInfo event is populated with the name of the algorithm, such as 3DES or the corresponding OID such as 1.2.840.113549.3.7.

The default value is False, and the name of the algorithm is used. Set this to True to use the object identifiers instead.

UseCryptoAPI:   Whether to use the Microsoft Crypto API for cryptographic message generation.

If UseCryptoAPI is set to True, the class will use the Microsoft Crypto API to process encrypted and/or signed data.

Note: Compression will be impossible in this case.

If set to False (the default), the class will use its internal S/MIME engine.

Base Config Settings

BuildInfo:   Information about the product's build.

When queried, this setting will return a string containing information about the product's build.

CodePage:   The system code page used for Unicode to Multibyte translations.

The default code page is Unicode UTF-8 (65001).

The following is a list of valid code page identifiers:

IdentifierName
037IBM EBCDIC - U.S./Canada
437OEM - United States
500IBM EBCDIC - International
708Arabic - ASMO 708
709Arabic - ASMO 449+, BCON V4
710Arabic - Transparent Arabic
720Arabic - Transparent ASMO
737OEM - Greek (formerly 437G)
775OEM - Baltic
850OEM - Multilingual Latin I
852OEM - Latin II
855OEM - Cyrillic (primarily Russian)
857OEM - Turkish
858OEM - Multilingual Latin I + Euro symbol
860OEM - Portuguese
861OEM - Icelandic
862OEM - Hebrew
863OEM - Canadian-French
864OEM - Arabic
865OEM - Nordic
866OEM - Russian
869OEM - Modern Greek
870IBM EBCDIC - Multilingual/ROECE (Latin-2)
874ANSI/OEM - Thai (same as 28605, ISO 8859-15)
875IBM EBCDIC - Modern Greek
932ANSI/OEM - Japanese, Shift-JIS
936ANSI/OEM - Simplified Chinese (PRC, Singapore)
949ANSI/OEM - Korean (Unified Hangul Code)
950ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC)
1026IBM EBCDIC - Turkish (Latin-5)
1047IBM EBCDIC - Latin 1/Open System
1140IBM EBCDIC - U.S./Canada (037 + Euro symbol)
1141IBM EBCDIC - Germany (20273 + Euro symbol)
1142IBM EBCDIC - Denmark/Norway (20277 + Euro symbol)
1143IBM EBCDIC - Finland/Sweden (20278 + Euro symbol)
1144IBM EBCDIC - Italy (20280 + Euro symbol)
1145IBM EBCDIC - Latin America/Spain (20284 + Euro symbol)
1146IBM EBCDIC - United Kingdom (20285 + Euro symbol)
1147IBM EBCDIC - France (20297 + Euro symbol)
1148IBM EBCDIC - International (500 + Euro symbol)
1149IBM EBCDIC - Icelandic (20871 + Euro symbol)
1200Unicode UCS-2 Little-Endian (BMP of ISO 10646)
1201Unicode UCS-2 Big-Endian
1250ANSI - Central European
1251ANSI - Cyrillic
1252ANSI - Latin I
1253ANSI - Greek
1254ANSI - Turkish
1255ANSI - Hebrew
1256ANSI - Arabic
1257ANSI - Baltic
1258ANSI/OEM - Vietnamese
1361Korean (Johab)
10000MAC - Roman
10001MAC - Japanese
10002MAC - Traditional Chinese (Big5)
10003MAC - Korean
10004MAC - Arabic
10005MAC - Hebrew
10006MAC - Greek I
10007MAC - Cyrillic
10008MAC - Simplified Chinese (GB 2312)
10010MAC - Romania
10017MAC - Ukraine
10021MAC - Thai
10029MAC - Latin II
10079MAC - Icelandic
10081MAC - Turkish
10082MAC - Croatia
12000Unicode UCS-4 Little-Endian
12001Unicode UCS-4 Big-Endian
20000CNS - Taiwan
20001TCA - Taiwan
20002Eten - Taiwan
20003IBM5550 - Taiwan
20004TeleText - Taiwan
20005Wang - Taiwan
20105IA5 IRV International Alphabet No. 5 (7-bit)
20106IA5 German (7-bit)
20107IA5 Swedish (7-bit)
20108IA5 Norwegian (7-bit)
20127US-ASCII (7-bit)
20261T.61
20269ISO 6937 Non-Spacing Accent
20273IBM EBCDIC - Germany
20277IBM EBCDIC - Denmark/Norway
20278IBM EBCDIC - Finland/Sweden
20280IBM EBCDIC - Italy
20284IBM EBCDIC - Latin America/Spain
20285IBM EBCDIC - United Kingdom
20290IBM EBCDIC - Japanese Katakana Extended
20297IBM EBCDIC - France
20420IBM EBCDIC - Arabic
20423IBM EBCDIC - Greek
20424IBM EBCDIC - Hebrew
20833IBM EBCDIC - Korean Extended
20838IBM EBCDIC - Thai
20866Russian - KOI8-R
20871IBM EBCDIC - Icelandic
20880IBM EBCDIC - Cyrillic (Russian)
20905IBM EBCDIC - Turkish
20924IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol)
20932JIS X 0208-1990 & 0121-1990
20936Simplified Chinese (GB2312)
21025IBM EBCDIC - Cyrillic (Serbian, Bulgarian)
21027Extended Alpha Lowercase
21866Ukrainian (KOI8-U)
28591ISO 8859-1 Latin I
28592ISO 8859-2 Central Europe
28593ISO 8859-3 Latin 3
28594ISO 8859-4 Baltic
28595ISO 8859-5 Cyrillic
28596ISO 8859-6 Arabic
28597ISO 8859-7 Greek
28598ISO 8859-8 Hebrew
28599ISO 8859-9 Latin 5
28605ISO 8859-15 Latin 9
29001Europa 3
38598ISO 8859-8 Hebrew
50220ISO 2022 Japanese with no halfwidth Katakana
50221ISO 2022 Japanese with halfwidth Katakana
50222ISO 2022 Japanese JIS X 0201-1989
50225ISO 2022 Korean
50227ISO 2022 Simplified Chinese
50229ISO 2022 Traditional Chinese
50930Japanese (Katakana) Extended
50931US/Canada and Japanese
50933Korean Extended and Korean
50935Simplified Chinese Extended and Simplified Chinese
50936Simplified Chinese
50937US/Canada and Traditional Chinese
50939Japanese (Latin) Extended and Japanese
51932EUC - Japanese
51936EUC - Simplified Chinese
51949EUC - Korean
51950EUC - Traditional Chinese
52936HZ-GB2312 Simplified Chinese
54936Windows XP: GB18030 Simplified Chinese (4 Byte)
57002ISCII Devanagari
57003ISCII Bengali
57004ISCII Tamil
57005ISCII Telugu
57006ISCII Assamese
57007ISCII Oriya
57008ISCII Kannada
57009ISCII Malayalam
57010ISCII Gujarati
57011ISCII Punjabi
65000Unicode UTF-7
65001Unicode UTF-8
The following is a list of valid code page identifiers for Mac OS only:
IdentifierName
1ASCII
2NEXTSTEP
3JapaneseEUC
4UTF8
5ISOLatin1
6Symbol
7NonLossyASCII
8ShiftJIS
9ISOLatin2
10Unicode
11WindowsCP1251
12WindowsCP1252
13WindowsCP1253
14WindowsCP1254
15WindowsCP1250
21ISO2022JP
30MacOSRoman
10UTF16String
0x90000100UTF16BigEndian
0x94000100UTF16LittleEndian
0x8c000100UTF32String
0x98000100UTF32BigEndian
0x9c000100UTF32LittleEndian
65536Proprietary

LicenseInfo:   Information about the current license.

When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:

  • Product: The product the license is for.
  • Product Key: The key the license was generated from.
  • License Source: Where the license was found (e.g., RuntimeLicense, License File).
  • License Type: The type of license installed (e.g., Royalty Free, Single Server).
  • Last Valid Build: The last valid build number for which the license will work.
MaskSensitive:   Whether sensitive data is masked in log messages.

In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to to mask sensitive data. The default is .

This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

UseInternalSecurityAPI:   Tells the class whether or not to use the system security libraries or an internal implementation.

When set to , the class will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this setting to tells the class to use the internal implementation instead of using the system security libraries.

This setting is set to by default on all platforms.

Trappable Errors (SMIME Module)

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.