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:

• InputFile
• InputMessage

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

• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

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

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.

Method List

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

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.

Config Settings

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

Certificate Property (SMIME Module)

This property includes the current selected certificate.

Syntax

• Swift
• Objective-C

public var certificate: Certificate {
  get {...}
  set {...}
}

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

- (NSString*)certEffectiveDate;

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

- (NSString*)certExpirationDate;

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

- (NSString*)certExtendedKeyUsage;

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

- (NSString*)certFingerprint;

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

- (NSString*)certFingerprintSHA1;

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

- (NSString*)certFingerprintSHA256;

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

- (NSString*)certIssuer;

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

- (NSString*)certPrivateKey;

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

- (BOOL)certPrivateKeyAvailable;

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

- (NSString*)certPrivateKeyContainer;

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

- (NSString*)certPublicKey;

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

- (NSString*)certPublicKeyAlgorithm;

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

- (int)certPublicKeyLength;

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

- (NSString*)certSerialNumber;

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

- (NSString*)certSignatureAlgorithm;

@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;
@property (nonatomic,readwrite,assign,getter=certStorePassword,setter=setCertStorePassword:) NSString* certStorePassword;

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

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

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

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

- (NSString*)certSubjectAltNames;

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

- (NSString*)certThumbprintMD5;

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

- (NSString*)certThumbprintSHA1;

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

- (NSString*)certThumbprintSHA256;

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

- (NSString*)certUsage;

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

- (int)certUsageFlags;

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

- (NSString*)certVersion;

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

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

@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

False

Remarks

This property is populated when a specified certificate is found or loaded by the class. This property is used to specify private keys. Set this property to a valid Certificate object to perform different operations, such as Sign, Decrypt, SignAndEncrypt, or DecryptAndVerifySignature.

DetachedSignature Property (SMIME Module)

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

Syntax

• Swift
• Objective-C

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

• Swift
• Objective-C

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

• Swift
• Objective-C

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

• Swift
• Objective-C

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

• Swift
• Objective-C

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

• Swift
• Objective-C

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:

• InputFile
• InputMessage

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

• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

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

InputMessage Property (SMIME Module)

This property includes the message to process.

Syntax

• Swift
• Objective-C

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:

• InputFile
• InputMessage

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

• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

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

InputMessageHeaders Property (SMIME Module)

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

Syntax

• Swift
• Objective-C

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

• Swift
• Objective-C

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

• Swift
• Objective-C

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.

OutputFile Property (SMIME Module)

This property specifies the output file.

Syntax

• Swift
• Objective-C

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:

• InputFile
• InputMessage

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

• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

The headers of the resulting message will be available in the OutputMessageHeaders and OutputMessageHeadersString properties.

OutputMessage Property (SMIME Module)

This property includes the output message after processing.

Syntax

• Swift
• Objective-C

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:

• InputFile
• InputMessage

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

• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

The headers of the 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

• Swift
• Objective-C

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

• Swift
• Objective-C

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

• Swift
• Objective-C

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.

RecipientCerts Property (SMIME Module)

This property includes a collection of recipient certificates of the message.

Syntax

• Swift
• Objective-C

public var recipientCerts: Array<Certificate> {
  get {...}
}

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

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

- (NSString*)recipientCertEffectiveDate:(int)recipientCertIndex;

- (NSString*)recipientCertExpirationDate:(int)recipientCertIndex;

- (NSString*)recipientCertExtendedKeyUsage:(int)recipientCertIndex;

- (NSString*)recipientCertFingerprint:(int)recipientCertIndex;

- (NSString*)recipientCertFingerprintSHA1:(int)recipientCertIndex;

- (NSString*)recipientCertFingerprintSHA256:(int)recipientCertIndex;

- (NSString*)recipientCertIssuer:(int)recipientCertIndex;

- (NSString*)recipientCertPrivateKey:(int)recipientCertIndex;

- (BOOL)recipientCertPrivateKeyAvailable:(int)recipientCertIndex;

- (NSString*)recipientCertPrivateKeyContainer:(int)recipientCertIndex;

- (NSString*)recipientCertPublicKey:(int)recipientCertIndex;

- (NSString*)recipientCertPublicKeyAlgorithm:(int)recipientCertIndex;

- (int)recipientCertPublicKeyLength:(int)recipientCertIndex;

- (NSString*)recipientCertSerialNumber:(int)recipientCertIndex;

- (NSString*)recipientCertSignatureAlgorithm:(int)recipientCertIndex;

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

- (NSData*)recipientCertStoreB:(int)recipientCertIndex;
- (void)setRecipientCertStoreB:(int)recipientCertIndex :(NSData*)newRecipientCertStore;
- (NSString*)recipientCertStorePassword:(int)recipientCertIndex;
- (void)setRecipientCertStorePassword:(int)recipientCertIndex :(NSString*)newRecipientCertStorePassword;

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

- (NSString*)recipientCertSubjectAltNames:(int)recipientCertIndex;

- (NSString*)recipientCertThumbprintMD5:(int)recipientCertIndex;

- (NSString*)recipientCertThumbprintSHA1:(int)recipientCertIndex;

- (NSString*)recipientCertThumbprintSHA256:(int)recipientCertIndex;

- (NSString*)recipientCertUsage:(int)recipientCertIndex;

- (int)recipientCertUsageFlags:(int)recipientCertIndex;

- (NSString*)recipientCertVersion:(int)recipientCertIndex;

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

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

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

Default Value

False

Remarks

This property is used to specify the certificates of the intended recipients of the encrypted message. This property must be set before calling Encrypt or SignAndEncrypt methods.

This property's collection must be filled out with valid public key Certificate type objects. To set a certificate, you may set the field to the encoded certificate. To select a certificate, use the and fields.

SignerCert Property (SMIME Module)

This property contains the certificate of the message signer.

Syntax

• Swift
• Objective-C

public var signerCert: Certificate {
  get {...}
  set {...}
}

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

- (NSString*)signerCertEffectiveDate;

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

- (NSString*)signerCertExpirationDate;

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

- (NSString*)signerCertExtendedKeyUsage;

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

- (NSString*)signerCertFingerprint;

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

- (NSString*)signerCertFingerprintSHA1;

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

- (NSString*)signerCertFingerprintSHA256;

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

- (NSString*)signerCertIssuer;

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

- (NSString*)signerCertPrivateKey;

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

- (BOOL)signerCertPrivateKeyAvailable;

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

- (NSString*)signerCertPrivateKeyContainer;

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

- (NSString*)signerCertPublicKey;

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

- (NSString*)signerCertPublicKeyAlgorithm;

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

- (int)signerCertPublicKeyLength;

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

- (NSString*)signerCertSerialNumber;

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

- (NSString*)signerCertSignatureAlgorithm;

@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;
@property (nonatomic,readwrite,assign,getter=signerCertStorePassword,setter=setSignerCertStorePassword:) NSString* signerCertStorePassword;

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

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

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

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

- (NSString*)signerCertSubjectAltNames;

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

- (NSString*)signerCertThumbprintMD5;

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

- (NSString*)signerCertThumbprintSHA1;

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

- (NSString*)signerCertThumbprintSHA256;

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

- (NSString*)signerCertUsage;

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

- (int)signerCertUsageFlags;

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

- (NSString*)signerCertVersion;

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

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

@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

False

Remarks

This property contains the certificate of the message signer. When calling VerifySignature or DecryptAndVerifySignature, this property will contain the certificate of the sender, if attached.

To verify messages without an attached certificate, set this property before calling VerifySignature or DecryptAndVerifySignature.

SignerCertChain Property (SMIME Module)

This property includes the certificate chain of the signing certificate.

Syntax

• Swift
• Objective-C

public var signerCertChain: Array<Certificate> {
  get {...}
}

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

- (int)signerCertChainCount;

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

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

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

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

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

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

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

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

- (BOOL)signerCertChainPrivateKeyAvailable:(int)signerCertChainIndex;

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

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

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

- (int)signerCertChainPublicKeyLength:(int)signerCertChainIndex;

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

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

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

- (NSData*)signerCertChainStoreB:(int)signerCertChainIndex;
- (NSString*)signerCertChainStorePassword:(int)signerCertChainIndex;

- (int)signerCertChainStoreType:(int)signerCertChainIndex;

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

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

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

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

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

- (int)signerCertChainUsageFlags:(int)signerCertChainIndex;

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

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

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

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

Default Value

False

Remarks

This property contains the certificate chain of the signing certificate. When calling VerifySignature or DecryptAndVerifySignature, this property will be populated with the certificate chain of the sender if attached.

Note: The SignerCert property will contain the signing certificate. The certificates in the signing certificate's chain will be placed in this property's collection.

SigningAlgorithm Property (SMIME Module)

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

Syntax

• Swift
• Objective-C

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

• Swift
• Objective-C

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

• Swift
• Objective-C

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

• Swift
• Objective-C

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

• Swift
• Objective-C

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

• Swift
• Objective-C

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

• Swift
• Objective-C

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

• Swift
• Objective-C

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:

• InputFile
• InputMessage

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

• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

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

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

• Swift
• Objective-C

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:

• InputFile
• InputMessage

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

• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

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

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

• Swift
• Objective-C

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:

• InputFile
• InputMessage

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

• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

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

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

• Swift
• Objective-C

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

• Swift
• Objective-C

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

• Swift
• Objective-C

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

• Swift
• Objective-C

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:

• InputFile
• InputMessage

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

• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

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

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

• Swift
• Objective-C

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:

• InputFile
• InputMessage

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

• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

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

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

• Swift
• Objective-C

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:

• InputFile
• InputMessage

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

• OutputFile
• OutputMessage: The output data is written to this property if no other destination is specified.

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

The headers of the resulting message will be available in the OutputMessageHeaders and OutputMessageHeadersString properties.

Error Event (SMIME Module)

Fired when information is available about errors during data delivery.

Syntax

• Swift
• Objective-C

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 .

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

RecipientInfo Event (SMIME Module)

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

Syntax

• Swift
• Objective-C

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

• Swift
• Objective-C

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.

Certificate Type

This is the digital certificate being used.

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

Fields

Constructors

public init()

public init(encoded: )

public init(storeType: , store: , storePassword: , subject: )

public init(storeType: , store: , storePassword: , subject: )

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

Constructors

public init()

public init(field: , value: )

Config Settings (SMIME Module)

SMIME Config Settings

Base Config Settings

Trappable Errors (SMIME Module)

SMIME Errors