XMLEncrypt Control

Properties   Methods   Events   Config Settings   Errors  

The XMLEncrypt control is used to encrypt and decrypt XML.

Syntax

XMLEncrypt

Remarks

The XMLEncrypt control 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 EncryptedDataDetails. The Decrypt method will decrypt the XML document.

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

Encrypt

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

The EncryptedDataDetails property 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 property is 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 property is 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
• EncryptedDataDetails
• RecipientCert
• KeyName

Input and Output Properties

The control 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

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

• 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 Certificate property 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 control 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

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

• 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 control with short descriptions. Click on the links for further details.

Method List

---

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

Event List

---

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

Config Settings

---

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

CertEffectiveDate Property (XMLEncrypt Control)

The date on which this certificate becomes valid.

Syntax

xmlencryptcontrol.CertEffectiveDate

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

CertExpirationDate Property (XMLEncrypt Control)

The date on which the certificate expires.

Syntax

xmlencryptcontrol.CertExpirationDate

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

CertExtendedKeyUsage Property (XMLEncrypt Control)

A comma-delimited list of extended key usage identifiers.

Syntax

xmlencryptcontrol.CertExtendedKeyUsage

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

CertFingerprint Property (XMLEncrypt Control)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

xmlencryptcontrol.CertFingerprint

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

CertFingerprintSHA1 Property (XMLEncrypt Control)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

xmlencryptcontrol.CertFingerprintSHA1

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

CertFingerprintSHA256 Property (XMLEncrypt Control)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

xmlencryptcontrol.CertFingerprintSHA256

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

CertIssuer Property (XMLEncrypt Control)

The issuer of the certificate.

Syntax

xmlencryptcontrol.CertIssuer

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

CertPrivateKey Property (XMLEncrypt Control)

The private key of the certificate (if available).

Syntax

xmlencryptcontrol.CertPrivateKey

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The CertPrivateKey may be available but not exportable. In this case, CertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

CertPrivateKeyAvailable Property (XMLEncrypt Control)

Whether a PrivateKey is available for the selected certificate.

Syntax

xmlencryptcontrol.CertPrivateKeyAvailable

Default Value

False

Remarks

Whether a CertPrivateKey is available for the selected certificate. If CertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

CertPrivateKeyContainer Property (XMLEncrypt Control)

The name of the PrivateKey container for the certificate (if available).

Syntax

xmlencryptcontrol.CertPrivateKeyContainer

Default Value

""

Remarks

The name of the CertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

CertPublicKey Property (XMLEncrypt Control)

The public key of the certificate.

Syntax

xmlencryptcontrol.CertPublicKey

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

CertPublicKeyAlgorithm Property (XMLEncrypt Control)

The textual description of the certificate's public key algorithm.

Syntax

xmlencryptcontrol.CertPublicKeyAlgorithm

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

CertPublicKeyLength Property (XMLEncrypt Control)

The length of the certificate's public key (in bits).

Syntax

xmlencryptcontrol.CertPublicKeyLength

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

CertSerialNumber Property (XMLEncrypt Control)

The serial number of the certificate encoded as a string.

Syntax

xmlencryptcontrol.CertSerialNumber

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

CertSignatureAlgorithm Property (XMLEncrypt Control)

The text description of the certificate's signature algorithm.

Syntax

xmlencryptcontrol.CertSignatureAlgorithm

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

CertStore Property (XMLEncrypt Control)

The name of the certificate store for the client certificate.

Syntax

xmlencryptcontrol.CertStore[=string]

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The CertStoreType property denotes the type of the certificate store specified by CertStore. If the store is password-protected, specify the password in CertStorePassword.

CertStore is used in conjunction with the CertSubject property to specify client certificates. If CertStore has a value, and CertSubject or CertEncoded is set, a search for a certificate is initiated. Please see the CertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

To read or write binary data to the property, a Variant (Byte Array) version is provided in .CertStoreB.

Data Type

Binary String

CertStorePassword Property (XMLEncrypt Control)

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

Syntax

xmlencryptcontrol.CertStorePassword[=string]

Default Value

""

Remarks

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

Data Type

String

CertStoreType Property (XMLEncrypt Control)

The type of certificate store for this certificate.

Syntax

xmlencryptcontrol.CertStoreType[=integer]

Possible Values

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

Default Value

0

Remarks

The type of certificate store for this certificate.

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

Data Type

Integer

CertSubjectAltNames Property (XMLEncrypt Control)

Comma-separated lists of alternative subject names for the certificate.

Syntax

xmlencryptcontrol.CertSubjectAltNames

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

CertThumbprintMD5 Property (XMLEncrypt Control)

The MD5 hash of the certificate.

Syntax

xmlencryptcontrol.CertThumbprintMD5

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

CertThumbprintSHA1 Property (XMLEncrypt Control)

The SHA-1 hash of the certificate.

Syntax

xmlencryptcontrol.CertThumbprintSHA1

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

CertThumbprintSHA256 Property (XMLEncrypt Control)

The SHA-256 hash of the certificate.

Syntax

xmlencryptcontrol.CertThumbprintSHA256

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

CertUsage Property (XMLEncrypt Control)

The text description of UsageFlags .

Syntax

xmlencryptcontrol.CertUsage

Default Value

""

Remarks

The text description of CertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

CertUsageFlags Property (XMLEncrypt Control)

The flags that show intended use for the certificate.

Syntax

xmlencryptcontrol.CertUsageFlags

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of CertUsageFlags is a combination of the following flags:

Please see the CertUsage property for a text representation of CertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

CertVersion Property (XMLEncrypt Control)

The certificate's version number.

Syntax

xmlencryptcontrol.CertVersion

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

CertSubject Property (XMLEncrypt Control)

The subject of the certificate used for client authentication.

Syntax

xmlencryptcontrol.CertSubject[=string]

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

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

Data Type

String

CertEncoded Property (XMLEncrypt Control)

The certificate (PEM/Base64 encoded).

Syntax

xmlencryptcontrol.CertEncoded[=string]

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The CertStore and CertSubject properties also may be used to specify a certificate.

When CertEncoded is set, a search is initiated in the current CertStore for the private key of the certificate. If the key is found, CertSubject is updated to reflect the full subject of the selected certificate; otherwise, CertSubject is set to an empty string.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .CertEncodedB.

This property is not available at design time.

Data Type

Binary String

EncryptedDataDetailCount Property (XMLEncrypt Control)

The number of records in the EncryptedDataDetail arrays.

Syntax

xmlencryptcontrol.EncryptedDataDetailCount[=integer]

Default Value

0

Remarks

This property controls the size of the following arrays:

• EncryptedDataDetailId
• EncryptedDataDetailMIMEType
• EncryptedDataDetailScope
• EncryptedDataDetailXMLElement

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

This property is not available at design time.

Data Type

Integer

EncryptedDataDetailId Property (XMLEncrypt Control)

This property is an optional identifier for the encrypted data.

Syntax

xmlencryptcontrol.EncryptedDataDetailId(EncryptedDataDetailIndex)[=string]

Default Value

""

Remarks

This property is an optional identifier for the encrypted data.

The EncryptedDataDetailIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EncryptedDataDetailCount property.

This property is not available at design time.

Data Type

String

EncryptedDataDetailMIMEType Property (XMLEncrypt Control)

This property specifies the MIME type of the encrypted data.

Syntax

xmlencryptcontrol.EncryptedDataDetailMIMEType(EncryptedDataDetailIndex)[=string]

Default Value

""

Remarks

This property specifies the MIME type of the encrypted data. For example: "image/png". This property is optional.

The EncryptedDataDetailIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EncryptedDataDetailCount property.

This property is not available at design time.

Data Type

String

EncryptedDataDetailScope Property (XMLEncrypt Control)

This property specifies the scope of the encryption.

Syntax

xmlencryptcontrol.EncryptedDataDetailScope(EncryptedDataDetailIndex)[=integer]

Possible Values

sElement(0), 
sContent(1)

Default Value

0

Remarks

This property specifies the scope of the encryption. When calling Encrypt the entire XML element specified by EncryptedDataDetailXMLElement may be encrypted, or only the content may be encrypted. This setting controls the scope of the encryption. Possible values are:

The EncryptedDataDetailIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EncryptedDataDetailCount property.

This property is not available at design time.

Data Type

Integer

EncryptedDataDetailXMLElement Property (XMLEncrypt Control)

This property specifies the XPath to the element which will be encrypted.

Syntax

xmlencryptcontrol.EncryptedDataDetailXMLElement(EncryptedDataDetailIndex)[=string]

Default Value

"/"

Remarks

This property specifies the XPath to the element which will be encrypted. For instance:

The EncryptedDataDetailIndex parameter specifies the index of the item in the array. The size of the array is controlled by the EncryptedDataDetailCount property.

This property is not available at design time.

Data Type

String

EncryptingAlgorithm Property (XMLEncrypt Control)

Then encryption algorithm used when encrypting.

Syntax

xmlencryptcontrol.EncryptingAlgorithm[=string]

Default Value

"3DES"

Remarks

This property specifies the encryption algorithm to use when encrypting. Possible values are:

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

Data Type

String

InputFile Property (XMLEncrypt Control)

The XML file to process.

Syntax

xmlencryptcontrol.InputFile[=string]

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 control 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

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

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

This property is not available at design time.

Data Type

String

InputXML Property (XMLEncrypt Control)

The XML to process.

Syntax

xmlencryptcontrol.InputXML[=string]

Default Value

""

Remarks

This property specifies the XML to be processed.

Input and Output Properties

The control 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

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

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

This property is not available at design time.

Data Type

String

OutputFile Property (XMLEncrypt Control)

The output file.

Syntax

xmlencryptcontrol.OutputFile[=string]

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 control 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

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

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

This property is not available at design time.

Data Type

String

OutputXML Property (XMLEncrypt Control)

The output XML after processing.

Syntax

xmlencryptcontrol.OutputXML[=string]

Default Value

""

Remarks

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

Input and Output Properties

The control 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

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

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

This property is not available at design time.

Data Type

String

Overwrite Property (XMLEncrypt Control)

Indicates whether or not the control should overwrite files.

Syntax

xmlencryptcontrol.Overwrite[=boolean]

Default Value

False

Remarks

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

Data Type

Boolean

RecipientCertEffectiveDate Property (XMLEncrypt Control)

The date on which this certificate becomes valid.

Syntax

xmlencryptcontrol.RecipientCertEffectiveDate

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

RecipientCertExpirationDate Property (XMLEncrypt Control)

The date on which the certificate expires.

Syntax

xmlencryptcontrol.RecipientCertExpirationDate

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

RecipientCertExtendedKeyUsage Property (XMLEncrypt Control)

A comma-delimited list of extended key usage identifiers.

Syntax

xmlencryptcontrol.RecipientCertExtendedKeyUsage

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

RecipientCertFingerprint Property (XMLEncrypt Control)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

xmlencryptcontrol.RecipientCertFingerprint

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

RecipientCertFingerprintSHA1 Property (XMLEncrypt Control)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

xmlencryptcontrol.RecipientCertFingerprintSHA1

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

RecipientCertFingerprintSHA256 Property (XMLEncrypt Control)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

xmlencryptcontrol.RecipientCertFingerprintSHA256

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

RecipientCertIssuer Property (XMLEncrypt Control)

The issuer of the certificate.

Syntax

xmlencryptcontrol.RecipientCertIssuer

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

RecipientCertPrivateKey Property (XMLEncrypt Control)

The private key of the certificate (if available).

Syntax

xmlencryptcontrol.RecipientCertPrivateKey

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The RecipientCertPrivateKey may be available but not exportable. In this case, RecipientCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

RecipientCertPrivateKeyAvailable Property (XMLEncrypt Control)

Whether a PrivateKey is available for the selected certificate.

Syntax

xmlencryptcontrol.RecipientCertPrivateKeyAvailable

Default Value

False

Remarks

Whether a RecipientCertPrivateKey is available for the selected certificate. If RecipientCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

RecipientCertPrivateKeyContainer Property (XMLEncrypt Control)

The name of the PrivateKey container for the certificate (if available).

Syntax

xmlencryptcontrol.RecipientCertPrivateKeyContainer

Default Value

""

Remarks

The name of the RecipientCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

RecipientCertPublicKey Property (XMLEncrypt Control)

The public key of the certificate.

Syntax

xmlencryptcontrol.RecipientCertPublicKey

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

RecipientCertPublicKeyAlgorithm Property (XMLEncrypt Control)

The textual description of the certificate's public key algorithm.

Syntax

xmlencryptcontrol.RecipientCertPublicKeyAlgorithm

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

RecipientCertPublicKeyLength Property (XMLEncrypt Control)

The length of the certificate's public key (in bits).

Syntax

xmlencryptcontrol.RecipientCertPublicKeyLength

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

RecipientCertSerialNumber Property (XMLEncrypt Control)

The serial number of the certificate encoded as a string.

Syntax

xmlencryptcontrol.RecipientCertSerialNumber

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

RecipientCertSignatureAlgorithm Property (XMLEncrypt Control)

The text description of the certificate's signature algorithm.

Syntax

xmlencryptcontrol.RecipientCertSignatureAlgorithm

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

RecipientCertStore Property (XMLEncrypt Control)

The name of the certificate store for the client certificate.

Syntax

xmlencryptcontrol.RecipientCertStore[=string]

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The RecipientCertStoreType property denotes the type of the certificate store specified by RecipientCertStore. If the store is password-protected, specify the password in RecipientCertStorePassword.

RecipientCertStore is used in conjunction with the RecipientCertSubject property to specify client certificates. If RecipientCertStore has a value, and RecipientCertSubject or RecipientCertEncoded is set, a search for a certificate is initiated. Please see the RecipientCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

To read or write binary data to the property, a Variant (Byte Array) version is provided in .RecipientCertStoreB.

Data Type

Binary String

RecipientCertStorePassword Property (XMLEncrypt Control)

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

Syntax

xmlencryptcontrol.RecipientCertStorePassword[=string]

Default Value

""

Remarks

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

Data Type

String

RecipientCertStoreType Property (XMLEncrypt Control)

The type of certificate store for this certificate.

Syntax

xmlencryptcontrol.RecipientCertStoreType[=integer]

Possible Values

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

Default Value

0

Remarks

The type of certificate store for this certificate.

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

Data Type

Integer

RecipientCertSubjectAltNames Property (XMLEncrypt Control)

Comma-separated lists of alternative subject names for the certificate.

Syntax

xmlencryptcontrol.RecipientCertSubjectAltNames

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

RecipientCertThumbprintMD5 Property (XMLEncrypt Control)

The MD5 hash of the certificate.

Syntax

xmlencryptcontrol.RecipientCertThumbprintMD5

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

RecipientCertThumbprintSHA1 Property (XMLEncrypt Control)

The SHA-1 hash of the certificate.

Syntax

xmlencryptcontrol.RecipientCertThumbprintSHA1

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

RecipientCertThumbprintSHA256 Property (XMLEncrypt Control)

The SHA-256 hash of the certificate.

Syntax

xmlencryptcontrol.RecipientCertThumbprintSHA256

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

RecipientCertUsage Property (XMLEncrypt Control)

The text description of UsageFlags .

Syntax

xmlencryptcontrol.RecipientCertUsage

Default Value

""

Remarks

The text description of RecipientCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

RecipientCertUsageFlags Property (XMLEncrypt Control)

The flags that show intended use for the certificate.

Syntax

xmlencryptcontrol.RecipientCertUsageFlags

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of RecipientCertUsageFlags is a combination of the following flags:

Please see the RecipientCertUsage property for a text representation of RecipientCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

RecipientCertVersion Property (XMLEncrypt Control)

The certificate's version number.

Syntax

xmlencryptcontrol.RecipientCertVersion

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

RecipientCertSubject Property (XMLEncrypt Control)

The subject of the certificate used for client authentication.

Syntax

xmlencryptcontrol.RecipientCertSubject[=string]

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

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

Data Type

String

RecipientCertEncoded Property (XMLEncrypt Control)

The certificate (PEM/Base64 encoded).

Syntax

xmlencryptcontrol.RecipientCertEncoded[=string]

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The RecipientCertStore and RecipientCertSubject properties also may be used to specify a certificate.

When RecipientCertEncoded is set, a search is initiated in the current RecipientCertStore for the private key of the certificate. If the key is found, RecipientCertSubject is updated to reflect the full subject of the selected certificate; otherwise, RecipientCertSubject is set to an empty string.

To read or write binary data to the property, a Variant (Byte Array) version is provided in .RecipientCertEncodedB.

This property is not available at design time.

Data Type

Binary String

SymmetricKey Property (XMLEncrypt Control)

The symmetric key used to encrypt and decrypt the XML.

Syntax

xmlencryptcontrol.SymmetricKey[=string]

Default Value

""

Remarks

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

Encrypt Notes

When calling Encrypt if the RecipientCert property is 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 property is set and SymmetricKey is left empty, then a SymmetricKey value will automatically be generated by the control when Encrypt is called.

When calling Encrypt if the RecipientCert property is 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 control will attempt to use the certificate specified by the Certificate property 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)

To read or write binary data to the property, a Variant (Byte Array) version is provided in .SymmetricKeyB.

This property is not available at design time.

Data Type

Binary String

UseOAEP Property (XMLEncrypt Control)

Whether to use Optimal Asymmetric Encryption Padding (OAEP).

Syntax

xmlencryptcontrol.UseOAEP[=boolean]

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 control will use PKCS1.

Data Type

Boolean

Config Method (XMLEncrypt Control)

Sets or retrieves a configuration setting.

Syntax

xmlencryptcontrol.Config ConfigurationString

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the control, 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 Control)

Decrypts the XML.

Syntax

xmlencryptcontrol.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 Certificate property 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 control 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

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

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

DoEvents Method (XMLEncrypt Control)

This method processes events from the internal message queue.

Syntax

xmlencryptcontrol.DoEvents 

Remarks

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

Encrypt Method (XMLEncrypt Control)

Encrypts the XML.

Syntax

xmlencryptcontrol.Encrypt 

Remarks

This method encrypts the specified XML.

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

The EncryptedDataDetails property 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 property is 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 property is 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
• EncryptedDataDetails
• RecipientCert
• KeyName

Input and Output Properties

The control 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

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

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

Reset Method (XMLEncrypt Control)

Resets the control.

Syntax

xmlencryptcontrol.Reset 

Remarks

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

EncryptedDataInfo Event (XMLEncrypt Control)

Fired once for each encrypted element when Decrypt is called.

Syntax

Sub xmlencryptcontrol_EncryptedDataInfo(EncryptedDataId As String, Scope As Integer, MIMEType As String)

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

Fired when information is available about errors during data delivery.

Syntax

Sub xmlencryptcontrol_Error(ErrorCode As Integer, Description As String)

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the control fails with an error.

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

Progress Event (XMLEncrypt Control)

Fired as progress is made.

Syntax

Sub xmlencryptcontrol_Progress(BytesProcessed As Long64, PercentProcessed As Integer, Operation As Integer, IsEOF As Boolean)

Remarks

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

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 control. When the Operation is Write (2) this value may be queried to determine when all data has been processed.

Status Event (XMLEncrypt Control)

Provides information about the current operation.

Syntax

Sub xmlencryptcontrol_Status(Message As String)

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.

Config Settings (XMLEncrypt Control)

The control 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 control, access to these internal properties is provided through the Config method.

XMLEnc Config Settings

Base Config Settings

Trappable Errors (XMLEncrypt Control)

XMLEnc Errors

XML Errors