XMLEncrypt Module

Properties   Methods   Events   Config Settings   Errors  

The XMLEncrypt module is used to encrypt and decrypt XML.

Syntax

IPWorksEncrypt.Xmlencrypt

Remarks

The XMLEncrypt class provides a simple API for encrypting and decrypting XML. The Encrypt method will encrypt the XML document, or a specific element. Multiple elements may be encrypted at one time by setting the EncryptedDataDetail* properties. The Decrypt method will decrypt the XML document.

The class supports encrypting and decrypting with a shared SymmetricKey, and also using asymmetric encryption to encrypt the SymmetricKey (session key) via the RecipientCert* and Cer* properties.

Encrypt

To begin first specify a XML document by setting InputFile, or InputXML.

The EncryptedDataDetail* properties specify the XML element to encrypt. By default the entire XML document is encrypted.

The SymmetricKey property specifies the key which will be used to encrypt the data.

If the RecipientCert* properties are set, then the SymmetricKey will be encrypted and included in the encrypted data. This allows for the recipient to decrypt the key, with their certificate. Encrypting the symmetric key is also referred to as using a session key. The benefit of using certificate to encrypt and decrypt a session key (SymmetricKey) is that knowledge of the key value is not needed ahead of time to process the encrypted data. Note that if specified, RecipientCert MUST have a RSA key, not a DSA key.

If the RecipientCert* properties are not set, then the recipient must know the value of SymmetricKey before decrypting the XML. The KeyName setting may be set to provide a key identifier to the recipient.

Optionally set EncryptingAlgorithm, and then call Encrypt to encrypt the XML.

The following properties are applicable when calling this method:

• SymmetricKey (required)
• EncryptingAlgorithm
• EncryptedDataDetail*
• RecipientCert*
• KeyName

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
• InputXML

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

Decrypt

To begin first specify a XML document by setting InputFile, or InputXML.

The SymmetricKey property specifies the key used to decrypt the data. This may be set before calling Decrypt or inside the EncryptedDataInfo event. The EncryptedDataInfo event fires once for each encrypted element when Decrypt is called.

If the data was encrypted using an session key, set the Cert* properties to the certificate with private key before calling Decrypt. The certificate will be used to decrypt the encrypted session key. In this case the SymmetricKey property is ignored.

The following properties are applicable when calling this method:

• SymmetricKey
• 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
• InputXML

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

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.

CertEncoded Property (XMLEncrypt Module)

This is the certificate (PEM/Base64 encoded).

Syntax

• Swift
• Objective-C

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

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

Syntax

• Swift
• Objective-C

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

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., PKCS#12 certificate store).

CertStorePassword Property (XMLEncrypt 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

• Swift
• Objective-C

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

This is the type of certificate store for this certificate.

Syntax

• Swift
• Objective-C

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

public enum XmlencryptCertStoreTypes: 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:

CertSubject Property (XMLEncrypt Module)

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

Syntax

• Swift
• Objective-C

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 as follows:

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

EncryptedDataDetails Property (XMLEncrypt Module)

A collection of encrypted data details.

Syntax

• Swift
• Objective-C

public var encryptedDataDetails: Array<XMLEncryptedDataDetail> {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=encryptedDataDetailCount,setter=setEncryptedDataDetailCount:) int encryptedDataDetailCount;

- (int)encryptedDataDetailCount;
- (void)setEncryptedDataDetailCount :(int)newEncryptedDataDetailCount;

- (NSString*)encryptedDataDetailId:(int)encryptedDataDetailIndex;
- (void)setEncryptedDataDetailId:(int)encryptedDataDetailIndex :(NSString*)newEncryptedDataDetailId;

- (NSString*)encryptedDataDetailMIMEType:(int)encryptedDataDetailIndex;
- (void)setEncryptedDataDetailMIMEType:(int)encryptedDataDetailIndex :(NSString*)newEncryptedDataDetailMIMEType;

- (int)encryptedDataDetailScope:(int)encryptedDataDetailIndex;
- (void)setEncryptedDataDetailScope:(int)encryptedDataDetailIndex :(int)newEncryptedDataDetailScope;

- (NSString*)encryptedDataDetailXMLElement:(int)encryptedDataDetailIndex;
- (void)setEncryptedDataDetailXMLElement:(int)encryptedDataDetailIndex :(NSString*)newEncryptedDataDetailXMLElement;

Default Value

False

Remarks

This property holds a collection of details about the XML elements to be encrypted. This may be populated before calling Encrypt. If this is not populated, then the entire XML document will be encrypted.

EncryptingAlgorithm Property (XMLEncrypt Module)

Then encryption algorithm used when encrypting.

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 specifies the encryption algorithm to use when encrypting. Possible values are:

• "3DES" (default)
• "DES"
• "AES128"
• "AES192"
• "AES256"

InputFile Property (XMLEncrypt Module)

The XML 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 which will be processed.

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
• InputXML

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

InputXML Property (XMLEncrypt Module)

The XML to process.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=inputXML,setter=setInputXML:) NSString* inputXML;

- (NSString*)inputXML;
- (void)setInputXML :(NSString*)newInputXML;

Default Value

""

Remarks

This property specifies the XML to be processed.

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
• InputXML

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

OutputFile Property (XMLEncrypt Module)

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.

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
• InputXML

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

OutputXML Property (XMLEncrypt Module)

The output XML after processing.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=outputXML,setter=setOutputXML:) NSString* outputXML;

- (NSString*)outputXML;
- (void)setOutputXML :(NSString*)newOutputXML;

Default Value

""

Remarks

This property will be populated with the output from the operation if OutputFile is not set.

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
• InputXML

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

Overwrite Property (XMLEncrypt Module)

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

False

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.

RecipientCertEncoded Property (XMLEncrypt Module)

This is the certificate (PEM/Base64 encoded).

Syntax

• Swift
• Objective-C

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

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

@property (nonatomic,readwrite,assign,getter=recipientCertEncoded,setter=setRecipientCertEncoded:) NSString* recipientCertEncoded;

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

@property (nonatomic,readwrite,assign,getter=recipientCertEncodedB,setter=setRecipientCertEncodedB:) NSData* recipientCertEncodedB;

- (NSData*)recipientCertEncodedB;
- (void)setRecipientCertEncodedB :(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 (XMLEncrypt Module)

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

Syntax

• Swift
• Objective-C

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

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

@property (nonatomic,readwrite,assign,getter=recipientCertStore,setter=setRecipientCertStore:) NSString* recipientCertStore;

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

@property (nonatomic,readwrite,assign,getter=recipientCertStoreB,setter=setRecipientCertStoreB:) NSData* recipientCertStoreB;

- (NSData*)recipientCertStoreB;
- (void)setRecipientCertStoreB :(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 designations are the most common User and Machine certificate stores in Windows:

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., PKCS#12 certificate store).

RecipientCertStorePassword Property (XMLEncrypt 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

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=recipientCertStorePassword,setter=setRecipientCertStorePassword:) NSString* recipientCertStorePassword;

- (NSString*)recipientCertStorePassword;
- (void)setRecipientCertStorePassword :(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 (XMLEncrypt Module)

This is the type of certificate store for this certificate.

Syntax

• Swift
• Objective-C

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

public enum XmlencryptRecipientCertStoreTypes: 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=recipientCertStoreType,setter=setRecipientCertStoreType:) int recipientCertStoreType;

- (int)recipientCertStoreType;
- (void)setRecipientCertStoreType :(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:

RecipientCertSubject Property (XMLEncrypt Module)

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

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=recipientCertSubject,setter=setRecipientCertSubject:) NSString* recipientCertSubject;

- (NSString*)recipientCertSubject;
- (void)setRecipientCertSubject :(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 as follows:

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

SymmetricKey Property (XMLEncrypt Module)

The symmetric key used to encrypt and decrypt the XML.

Syntax

• Swift
• Objective-C

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

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

@property (nonatomic,readwrite,assign,getter=symmetricKey,setter=setSymmetricKey:) NSString* symmetricKey;

- (NSString*)symmetricKey;
- (void)setSymmetricKey :(NSString*)newSymmetricKey;

@property (nonatomic,readwrite,assign,getter=symmetricKeyB,setter=setSymmetricKeyB:) NSData* symmetricKeyB;

- (NSData*)symmetricKeyB;
- (void)setSymmetricKeyB :(NSData*)newSymmetricKey;

Default Value

""

Remarks

This property specifies the symmetric key used to encrypt and decrypt the XML.

Encrypt Notes

When calling Encrypt if the RecipientCert* properties are set, then the SymmetricKey will be encrypted and included in the XML as an encrypted key. Using asymmetric encryption to encrypt the SymmetricKey allows for secure transmission of the key. This is also referred to as using a session key, as no prior knowledge of the SymmetricKey is required by the recipient.

If the RecipientCert* properties are set and SymmetricKey is left empty, then a SymmetricKey value will automatically be generated by the class when Encrypt is called.

When calling Encrypt if the RecipientCert* properties are are not set, then the SymmetricKey value must be known by the recipient before the message can be decrypted.

Decrypt Notes

When calling Decrypt if the data contains an encrypted key the class will attempt to use the certificate specified by the Cert* properties to decrypt the encrypted key and this property is ignored.

When calling Decrypt if the data does not contain an encrypted key then SymmetricKey must be set either before calling Decrypt, or within the EncryptedDataInfo event.

Legal Key and Block Sizes (in bits)

UseOAEP Property (XMLEncrypt Module)

Whether 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 setting specifies whether to use Optimal Asymmetric Encryption Padding (OAEP) when encrypting the SymmetricKey with the certificate specified by RecipientCert. It is only applicable when calling Encrypt and RecipientCert is specified.

By default this value is False and the class will use PKCS1.

Config Method (XMLEncrypt 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 (XMLEncrypt Module)

Decrypts the XML.

Syntax

• Swift
• Objective-C

public func decrypt() throws -> Void

- (void)decrypt;

Remarks

This method decrypts the specified XML.

To begin first specify a XML document by setting InputFile, or InputXML.

The SymmetricKey property specifies the key used to decrypt the data. This may be set before calling Decrypt or inside the EncryptedDataInfo event. The EncryptedDataInfo event fires once for each encrypted element when Decrypt is called.

If the data was encrypted using an session key, set the Cert* properties to the certificate with private key before calling Decrypt. The certificate will be used to decrypt the encrypted session key. In this case the SymmetricKey property is ignored.

The following properties are applicable when calling this method:

• SymmetricKey
• 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
• InputXML

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

DoEvents Method (XMLEncrypt Module)

Processes events from the internal message queue.

Syntax

• Swift
• Objective-C

public func doEvents() throws -> Void

- (void)doEvents;

Remarks

When DoEvents is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.

Encrypt Method (XMLEncrypt Module)

Encrypts the XML.

Syntax

• Swift
• Objective-C

public func encrypt() throws -> Void

- (void)encrypt;

Remarks

This method encrypts the specified XML.

To begin first specify a XML document by setting InputFile, or InputXML.

The EncryptedDataDetail* properties specify the XML element to encrypt. By default the entire XML document is encrypted.

The SymmetricKey property specifies the key which will be used to encrypt the data.

If the RecipientCert* properties are set, then the SymmetricKey will be encrypted and included in the encrypted data. This allows for the recipient to decrypt the key, with their certificate. Encrypting the symmetric key is also referred to as using a session key. The benefit of using certificate to encrypt and decrypt a session key (SymmetricKey) is that knowledge of the key value is not needed ahead of time to process the encrypted data. Note that if specified, RecipientCert MUST have a RSA key, not a DSA key.

If the RecipientCert* properties are not set, then the recipient must know the value of SymmetricKey before decrypting the XML. The KeyName setting may be set to provide a key identifier to the recipient.

Optionally set EncryptingAlgorithm, and then call Encrypt to encrypt the XML.

The following properties are applicable when calling this method:

• SymmetricKey (required)
• EncryptingAlgorithm
• EncryptedDataDetail*
• RecipientCert*
• KeyName

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
• InputXML

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

Reset Method (XMLEncrypt Module)

Resets the component.

Syntax

• Swift
• Objective-C

public func reset() throws -> Void

- (void)reset;

Remarks

When called, the component will reset all of its properties to their default values.

EncryptedDataInfo Event (XMLEncrypt Module)

Fired once for each encrypted element when Decrypt is called.

Syntax

• Swift
• Objective-C

func onEncryptedDataInfo(encryptedDataId: String, scope: Int32, mimeType: String)

- (void)onEncryptedDataInfo:(NSString*)encryptedDataId :(int)scope :(NSString*)MIMEType;

Remarks

This event fires once for each encrypted element in the XML document when Decrypt is called. The parameters of this event provide information about the encrypted data. Additionally, the KeyName setting may be queried to identify the encryption key. SymmetricKey may be set from within this event.

EncryptedDataId is the Id of the encrypted data (if any).

Scope indicates the scope of the encrypted data. This defines whether the entire XML element was encrypted, or only the content. Possible values are:

MIMEType holds the MIME type of the encrypted data (if any). For example: "image/png".

Error Event (XMLEncrypt 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.

Progress Event (XMLEncrypt Module)

Fired as progress is made.

Syntax

• Swift
• Objective-C

func onProgress(bytesProcessed: Int64, percentProcessed: Int32, operation: Int32, isEOF: inout Bool)

- (void)onProgress:(long long)bytesProcessed :(int)percentProcessed :(int)operation :(int*)isEOF;

Remarks

This event is fired automatically as data is processed by the class.

The PercentProcessed parameter indicates the current status of the operation.

The BytesProcessed parameter holds the total number of bytes processed so far.

The Operation parameter is only applicable when either ReadFromProgressEvent or WriteToProgressEvent is set to True. This parameter defines whether a Read or Write operation is required. If the configuration settings are not set this parameter will always return 0. Possible values are:

The IsEOF parameter is only applicable when either ReadFromProgressEvent or WriteToProgressEvent is set to True. This parameter defines whether the Read or Write operation is complete. When the Operation is Read (1) this parameter must be set to indicate that all data has been supplied to the class. When the Operation is Write (2) this value may be queried to determine when all data has been processed.

Status Event (XMLEncrypt Module)

Provides information about the current operation.

Syntax

• Swift
• Objective-C

func onStatus(message: String)

- (void)onStatus:(NSString*)message;

Remarks

The event is fired for informational and logging purposes only. It may be used to track the progress of an operation.

The level of detail is controlled by the LogLevel setting.

XMLEncryptedDataDetail Type

This type defines details about the data to be encrypted.

Remarks

This type defines details about the data to be encrypted. The element to encrypt is defined by .

Fields

Constructors

public init()

Config Settings (XMLEncrypt Module)

XMLEnc Config Settings

Base Config Settings

Trappable Errors (XMLEncrypt Module)

XMLEnc Errors

XML Errors