IPWorks Encrypt 2022 ActiveX Edition
Version 22.0 [Build 8515]

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 the EncryptedDataDetail* properties. 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 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:

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:

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

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:

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.

CertEncodedThis is the certificate (PEM/base64 encoded).
CertStoreThis is the name of the certificate store for the client certificate.
CertStorePasswordIf the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
CertStoreTypeThis is the type of certificate store for this certificate.
CertSubjectThis is the subject of the certificate used for client authentication.
EncryptedDataDetailCountThe number of records in the EncryptedDataDetail arrays.
EncryptedDataDetailIdThis property is an optional identifier for the encrypted data.
EncryptedDataDetailMIMETypeThis property specifies the MIME type of the encrypted data.
EncryptedDataDetailScopeThis property specifies the scope of the encryption.
EncryptedDataDetailXMLElementThis property specifies the XPath to the element which will be encrypted.
EncryptingAlgorithmThen encryption algorithm used when encrypting.
InputFileThe XML file to process.
InputXMLThe XML to process.
OutputFileThe output file.
OutputXMLThe output XML after processing.
OverwriteIndicates whether or not the control should overwrite files.
RecipientCertEncodedThis is the certificate (PEM/base64 encoded).
RecipientCertStoreThis is the name of the certificate store for the client certificate.
RecipientCertStorePasswordIf the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
RecipientCertStoreTypeThis is the type of certificate store for this certificate.
RecipientCertSubjectThis is the subject of the certificate used for client authentication.
SymmetricKeyThe symmetric key used to encrypt and decrypt the XML.
UseOAEPWhether to use Optimal Asymmetric Encryption Padding (OAEP).

Method List


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

ConfigSets or retrieves a configuration setting.
DecryptDecrypts the XML.
DoEventsProcesses events from the internal message queue.
EncryptEncrypts the XML.
ResetResets the control.

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.

EncryptedDataInfoFired once for each encrypted element when Decrypt is called.
ErrorInformation about errors during data delivery.
ProgressFired as progress is made.
StatusProvides information about the current operation.

Config Settings


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

DecryptWithCryptoAPIWhether to use the Crypto API for decrypt operations.
EncryptedKeyXPathThe XPath of the EncryptedKey element.
KeyNameThe name of the key used to encrypt the XML.
LogLevelSpecifies the level of detail that is logged.
OAEPMGF1HashAlgorithmThe MGF1 hash algorithm used with OAEP.
OAEPParamsThe hex encoded OAEP parameters.
OAEPRSAHashAlgorithmThe RSA hash algorithm used with OAEP.
OAEPRSAHashAlgorithmThe RSA hash algorithm used when encrypting a key.
ReadFromProgressEventWhether to read input data from inside the progress event.
WriteToProgressEventWhether to write output data so it is accessible from inside the progress event.
CodePageThe system code page used for Unicode to Multibyte translations.
MaskSensitiveWhether sensitive data is masked in log messages.
UseInternalSecurityAPITells the control whether or not to use the system security libraries or an internal implementation.

CertEncoded Property (XMLEncrypt Control)

This is the certificate (PEM/base64 encoded).

Syntax

xmlencryptcontrol.CertEncoded[=string]

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.

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

CertStore Property (XMLEncrypt Control)

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

Syntax

xmlencryptcontrol.CertStore[=string]

Default Value

"MY"

Remarks

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

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

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

Designations of certificate stores are platform-dependent.

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

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

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

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)

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

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

0 (cstUser - default)For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: this store type is not available in Java.
1 (cstMachine)For Windows, this specifies that the certificate store is a machine store. Note: this store type is not available in Java.
2 (cstPFXFile)The certificate store is the name of a PFX (PKCS12) file containing certificates.
3 (cstPFXBlob)The certificate store is a string (binary or base64-encoded) representing a certificate store in PFX (PKCS12) format.
4 (cstJKSFile)The certificate store is the name of a Java Key Store (JKS) file containing certificates. Note: this store type is only available in Java.
5 (cstJKSBlob)The certificate store is a string (binary or base64-encoded) representing a certificate store in Java Key Store (JKS) format. Note: this store type is only available in Java.
6 (cstPEMKeyFile)The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
7 (cstPEMKeyBlob)The certificate store is a string (binary or base64-encoded) that contains a private key and an optional certificate.
8 (cstPublicKeyFile)The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
9 (cstPublicKeyBlob)The certificate store is a string (binary or base64-encoded) that contains a PEM- or DER-encoded public key certificate.
10 (cstSSHPublicKeyBlob)The certificate store is a string (binary or base64-encoded) that contains an SSH-style public key.
11 (cstP7BFile)The certificate store is the name of a PKCS7 file containing certificates.
12 (cstP7BBlob)The certificate store is a string (binary) representing a certificate store in PKCS7 format.
13 (cstSSHPublicKeyFile)The certificate store is the name of a file that contains an SSH-style public key.
14 (cstPPKFile)The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
15 (cstPPKBlob)The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
16 (cstXMLFile)The certificate store is the name of a file that contains a certificate in XML format.
17 (cstXMLBlob)The certificate store is a string that contains a certificate in XML format.
18 (cstJWKFile)The certificate store is the name of a file that contains a JWK (JSON Web Key).
19 (cstJWKBlob)The certificate store is a string that contains a JWK (JSON Web Key).
21 (cstBCFKSFile)The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). Note: this store type is only available in Java and .NET.
22 (cstBCFKSBlob)The certificate store is a string (binary or base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. Note: this store type is only available in Java and .NET.
23 (cstPKCS11)The certificate is present on a physical security key accessible via a PKCS11 interface.

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

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

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

99 (cstAuto)The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

Data Type

Integer

CertSubject Property (XMLEncrypt Control)

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

Syntax

xmlencryptcontrol.CertSubject[=string]

Default Value

""

Remarks

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

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

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

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

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

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

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

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

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

Data Type

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:

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:

0 (sElement - default) The entire XML element is encrypted.
1 (sContent) Only the content of the XML element is encrypted.

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:

/root/myElement XPath syntax
/root/[1] XPath syntax using an index
/root/ns:myElement XPath syntax where the element has a namespace
myElement Just the element name
@id=myid Attribute selector: This will select an element with an attribute "id" whose value is "myid".
/root/myElement[1]/ns:name2[@attr=attrValue] XPath syntax using an index and attribute selector

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:

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:

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:

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:

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

RecipientCertEncoded Property (XMLEncrypt Control)

This is the certificate (PEM/base64 encoded).

Syntax

xmlencryptcontrol.RecipientCertEncoded[=string]

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.

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

RecipientCertStore Property (XMLEncrypt Control)

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

Syntax

xmlencryptcontrol.RecipientCertStore[=string]

Default Value

"MY"

Remarks

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

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

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

Designations of certificate stores are platform-dependent.

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

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

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

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)

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

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

0 (cstUser - default)For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: this store type is not available in Java.
1 (cstMachine)For Windows, this specifies that the certificate store is a machine store. Note: this store type is not available in Java.
2 (cstPFXFile)The certificate store is the name of a PFX (PKCS12) file containing certificates.
3 (cstPFXBlob)The certificate store is a string (binary or base64-encoded) representing a certificate store in PFX (PKCS12) format.
4 (cstJKSFile)The certificate store is the name of a Java Key Store (JKS) file containing certificates. Note: this store type is only available in Java.
5 (cstJKSBlob)The certificate store is a string (binary or base64-encoded) representing a certificate store in Java Key Store (JKS) format. Note: this store type is only available in Java.
6 (cstPEMKeyFile)The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
7 (cstPEMKeyBlob)The certificate store is a string (binary or base64-encoded) that contains a private key and an optional certificate.
8 (cstPublicKeyFile)The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
9 (cstPublicKeyBlob)The certificate store is a string (binary or base64-encoded) that contains a PEM- or DER-encoded public key certificate.
10 (cstSSHPublicKeyBlob)The certificate store is a string (binary or base64-encoded) that contains an SSH-style public key.
11 (cstP7BFile)The certificate store is the name of a PKCS7 file containing certificates.
12 (cstP7BBlob)The certificate store is a string (binary) representing a certificate store in PKCS7 format.
13 (cstSSHPublicKeyFile)The certificate store is the name of a file that contains an SSH-style public key.
14 (cstPPKFile)The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
15 (cstPPKBlob)The certificate store is a string (binary) that contains a PPK (PuTTY Private Key).
16 (cstXMLFile)The certificate store is the name of a file that contains a certificate in XML format.
17 (cstXMLBlob)The certificate store is a string that contains a certificate in XML format.
18 (cstJWKFile)The certificate store is the name of a file that contains a JWK (JSON Web Key).
19 (cstJWKBlob)The certificate store is a string that contains a JWK (JSON Web Key).
21 (cstBCFKSFile)The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). Note: this store type is only available in Java and .NET.
22 (cstBCFKSBlob)The certificate store is a string (binary or base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. Note: this store type is only available in Java and .NET.
23 (cstPKCS11)The certificate is present on a physical security key accessible via a PKCS11 interface.

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

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

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

99 (cstAuto)The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically.

Data Type

Integer

RecipientCertSubject Property (XMLEncrypt Control)

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

Syntax

xmlencryptcontrol.RecipientCertSubject[=string]

Default Value

""

Remarks

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

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

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

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

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

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

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

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

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

Data Type

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

AES DES 3DES
Minimum Key Size 128 64 128
Maximum Key Size 256 64 192
Key Size Step 64 0 64
Block Size 128 64 64

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

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:

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)

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

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:

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:

0Element
1Content

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

Error Event (XMLEncrypt Control)

Information 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.

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

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:

0None
1Read
2Write

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

DecryptWithCryptoAPI:   Whether to use the Crypto API for decrypt operations.

This setting determines whether to use the Microsoft Crypto API to decrypt. This is helpful in cases where the certificate is present in the Windows Certificate Store but the private key is not marked as exportable. For instance when using a USB security key. The default value is False.

Note: This functionality is only available on Windows.

EncryptedKeyXPath:   The XPath of the EncryptedKey element.

This setting specifies the XPath where the EncryptedKey element will be written. In most cases this does not need to be changed. By default it is included in the EncryptedData element.

KeyName:   The name of the key used to encrypt the XML.

This setting optionally holds the key name which may be useful to the recipient to help identify the key used to encrypt the data. This may be set before calling Encrypt. When calling Decrypt this may be queried inside the EncryptedDataInfo event.

Note that this value is only informative, it does not affect processing.

LogLevel:   Specifies the level of detail that is logged.

This setting controls the level of detail that is logged through the Status event. Possible values are:

0 (None)No events are logged.
1 (Info - default)Informational events are logged.
2 (Verbose)Detailed data is logged.
3 (Debug)Debug data is logged.

OAEPMGF1HashAlgorithm:   The MGF1 hash algorithm used with OAEP.

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

  • "SHA1"
  • "SHA224"
  • "SHA256" (default)
  • "SHA384"
  • "SHA512"
  • "RIPEMD160"
  • "MD2"
  • "MD5"
  • "MD5SHA1"
OAEPParams:   The hex encoded OAEP parameters.

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

OAEPRSAHashAlgorithm:   The RSA hash algorithm used with OAEP.

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

  • "SHA1"
  • "SHA224"
  • "SHA256" (default)
  • "SHA384"
  • "SHA512"
  • "RIPEMD160"
  • "MD2"
  • "MD5"
  • "MD5SHA1"
The RSA hash algorithm used when encrypting a key.

When encryption is enabled, this algorithm specifies the RSA hash algorithm used for the encryption key. This may differ from the hash algorithm used to sign the message content. Possible values are:

  • "SHA1" (default)
  • "SHA224"
  • "SHA256"
  • "SHA384"
  • "SHA512"
OAEPRSAHashAlgorithm:   The RSA hash algorithm used with OAEP.

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

  • "SHA1"
  • "SHA224"
  • "SHA256" (default)
  • "SHA384"
  • "SHA512"
  • "RIPEMD160"
  • "MD2"
  • "MD5"
  • "MD5SHA1"
The RSA hash algorithm used when encrypting a key.

When encryption is enabled, this algorithm specifies the RSA hash algorithm used for the encryption key. This may differ from the hash algorithm used to sign the message content. Possible values are:

  • "SHA1" (default)
  • "SHA224"
  • "SHA256"
  • "SHA384"
  • "SHA512"
ReadFromProgressEvent:   Whether to read input data from inside the progress event.

When set to True this setting allows input data to be specified from within the Progress event. The control will repeatedly fire the Progress event to ask for data. Inside the event set InputXML when the Operation parameter of the event is 1 (Read). When all data has been provided set the IsEOF parameter of the event to True. This allows input data to be chunked and provided piece by piece. The default value is False.

WriteToProgressEvent:   Whether to write output data so it is accessible from inside the progress event.

When set to True this setting allows output data to be obtained from within the Progress event. The control will repeatedly fire the Progress event to provide output data. Inside the event check OutputXML when the Operation parameter of the event is 2 (Write). The IsEOF parameter should be checked inside the event to determine when all output data has been provided. This allows output data to be chunked and obtained piece by piece. The default value is False.

Base Config Settings

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

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

The following is a list of valid code page identifiers:

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

The following is a list of valid code page identifiers for Mac OS only:

IdentifierName
1ASCII
2NEXTSTEP
3JapaneseEUC
4UTF8
5ISOLatin1
6Symbol
7NonLossyASCII
8ShiftJIS
9ISOLatin2
10Unicode
11WindowsCP1251
12WindowsCP1252
13WindowsCP1253
14WindowsCP1254
15WindowsCP1250
21ISO2022JP
30MacOSRoman
10UTF16String
0x90000100UTF16BigEndian
0x94000100UTF16LittleEndian
0x8c000100UTF32String
0x98000100UTF32BigEndian
0x9c000100UTF32LittleEndian
65536Proprietary

MaskSensitive:   Whether sensitive data is masked in log messages.

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

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

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

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

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

This setting is set to by default on all platforms.

Trappable Errors (XMLEncrypt Control)

XMLEnc Errors

20608    Failed to write output.
20610    Could not find encrypted data.
20611    Invalid encrypted data.
20612    Failed parsing certificate data.
20613    SymmetricKey or RecipientCert must be set.

XML Errors

20102    Invalid attribute index.
20103    No attributes available.
20104    Invalid namespace index.
20105    No namespaces available.
20106    Invalid element index.
20107    No elements available.
20108    Attribute does not exist.
20202    Unbalanced element tag.
20203    Unknown element prefix (can't find namespace).
20204    Unknown attribute prefix (can't find namespace).
20205    Invalid XML markup.
20206    Invalid end state for parser.
20207    Document contains unbalanced elements.
20208    Invalid XPath.
20209    No such child.
20210    Top element does not match start of path.
20211    DOM tree unavailable (set BuildDOM to true and reparse).
20303    Can't open file.
20402    Invalid XML would be generated.
20403    An invalid XML name has been specified.

Copyright (c) 2023 /n software inc. - All rights reserved.
IPWorks Encrypt 2022 ActiveX Edition - Version 22.0 [Build 8515]