XMLEncrypt Class
Properties Methods Events Config Settings Errors
The XMLEncrypt class is used to encrypt and decrypt XML.
Syntax
XMLEncrypt
Remarks
The XMLEncrypt class provides a simple API for encrypting and decrypting XML. The Encrypt method will encrypt the XML document, or a specific element. Multiple elements may be encrypted at one time by setting the EncryptedDataDetail* properties. The Decrypt method will decrypt the XML document.
The class supports encrypting and decrypting with a shared SymmetricKey, and also using asymmetric encryption to encrypt the SymmetricKey (session key) via the RecipientCert* and Cer* properties.
Encrypt
To begin first specify a XML document by setting InputFile, or InputXML.
The EncryptedDataDetail* properties specify the XML element to encrypt. By default the entire XML document is encrypted.
The SymmetricKey property specifies the key which will be used to encrypt the data.
If the RecipientCert* properties are set, then the SymmetricKey will be encrypted and included in the encrypted data. This allows for the recipient to decrypt the key, with their certificate. Encrypting the symmetric key is also referred to as using a session key. The benefit of using certificate to encrypt and decrypt a session key (SymmetricKey) is that knowledge of the key value is not needed ahead of time to process the encrypted data. Note that if specified, RecipientCert MUST have a RSA key, not a DSA key.
If the RecipientCert* properties are not set, then the recipient must know the value of SymmetricKey before decrypting the XML. The KeyName setting may be set to provide a key identifier to the recipient.
Optionally set EncryptingAlgorithm, and then call Encrypt to encrypt the XML.
The following properties are applicable when calling this method:
- SymmetricKey (required)
- EncryptingAlgorithm
- EncryptedDataDetail*
- RecipientCert*
- KeyName
Input and Output Properties
The class will determine the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
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:
- SymmetricKey
- Certificate
Input and Output Properties
The class will determine the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
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 class with short descriptions. Click on the links for further details.
CertEncoded | This is the certificate (PEM/Base64 encoded). |
CertStore | This is the name of the certificate store for the client certificate. |
CertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
CertStoreType | This is the type of certificate store for this certificate. |
CertSubject | This is the subject of the certificate used for client authentication. |
EncryptedDataDetailCount | The number of records in the EncryptedDataDetail arrays. |
EncryptedDataDetailId | This property is an optional identifier for the encrypted data. |
EncryptedDataDetailMIMEType | This property specifies the MIME type of the encrypted data. |
EncryptedDataDetailScope | This property specifies the scope of the encryption. |
EncryptedDataDetailXMLElement | This property specifies the XPath to the element which will be encrypted. |
EncryptingAlgorithm | Then encryption algorithm used when encrypting. |
InputFile | The XML file to process. |
InputXML | The XML to process. |
OutputFile | The output file. |
OutputXML | The output XML after processing. |
Overwrite | Indicates whether or not the class should overwrite files. |
RecipientCertEncoded | This is the certificate (PEM/Base64 encoded). |
RecipientCertStore | This is the name of the certificate store for the client certificate. |
RecipientCertStorePassword | If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store. |
RecipientCertStoreType | This is the type of certificate store for this certificate. |
RecipientCertSubject | This is the subject of the certificate used for client authentication. |
SymmetricKey | The symmetric key used to encrypt and decrypt the XML. |
UseOAEP | Whether to use Optimal Asymmetric Encryption Padding (OAEP). |
Method List
The following is the full list of the methods of the class with short descriptions. Click on the links for further details.
Config | Sets or retrieves a configuration setting. |
Decrypt | Decrypts the XML. |
DoEvents | Processes events from the internal message queue. |
Encrypt | Encrypts the XML. |
Reset | Resets the class. |
SetInputStream | Sets the stream from which the class will read data to encrypt or decrypt. |
SetOutputStream | The stream to which the class will write the encrypted or decrypted XML. |
Event List
The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.
EncryptedDataInfo | Fired once for each encrypted element when Decrypt is called. |
Error | Fired when information is available about errors during data delivery. |
Progress | Fired as progress is made. |
Status | Provides information about the current operation. |
Config Settings
The following is a list of config settings for the class with short descriptions. Click on the links for further details.
DecryptWithCryptoAPI | Whether to use the Crypto API for decrypt operations. |
EncryptedKeyXPath | The XPath of the EncryptedKey element. |
KeyName | The name of the key used to encrypt the XML. |
LogLevel | Specifies the level of detail that is logged. |
OAEPMGF1HashAlgorithm | The MGF1 hash algorithm used with OAEP. |
OAEPParams | The hex encoded OAEP parameters. |
OAEPRSAHashAlgorithm | The RSA hash algorithm used with OAEP. |
OAEPRSAHashAlgorithm | The RSA hash algorithm used when encrypting a key. |
ReadFromProgressEvent | Whether to read input data from inside the progress event. |
WriteToProgressEvent | Whether to write output data so it is accessible from inside the progress event. |
BuildInfo | Information about the product's build. |
CodePage | The system code page used for Unicode to Multibyte translations. |
LicenseInfo | Information about the current license. |
MaskSensitive | Whether sensitive data is masked in log messages. |
ProcessIdleEvents | Whether the class uses its internal event loop to process events when the main thread is idle. |
SelectWaitMillis | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. |
UseInternalSecurityAPI | Whether or not to use the system security libraries or an internal implementation. |
CertEncoded Property (XMLEncrypt Class)
This is the certificate (PEM/Base64 encoded).
Syntax
ANSI (Cross Platform) int GetCertEncoded(char* &lpCertEncoded, int &lenCertEncoded);
int SetCertEncoded(const char* lpCertEncoded, int lenCertEncoded); Unicode (Windows) INT GetCertEncoded(LPSTR &lpCertEncoded, INT &lenCertEncoded);
INT SetCertEncoded(LPCSTR lpCertEncoded, INT lenCertEncoded);
int ipworksencrypt_xmlencrypt_getcertencoded(void* lpObj, char** lpCertEncoded, int* lenCertEncoded);
int ipworksencrypt_xmlencrypt_setcertencoded(void* lpObj, const char* lpCertEncoded, int lenCertEncoded);
QByteArray GetCertEncoded();
int SetCertEncoded(QByteArray qbaCertEncoded);
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.
This property is not available at design time.
Data Type
Binary String
CertStore Property (XMLEncrypt Class)
This is the name of the certificate store for the client certificate.
Syntax
ANSI (Cross Platform) int GetCertStore(char* &lpCertStore, int &lenCertStore);
int SetCertStore(const char* lpCertStore, int lenCertStore); Unicode (Windows) INT GetCertStore(LPSTR &lpCertStore, INT &lenCertStore);
INT SetCertStore(LPCSTR lpCertStore, INT lenCertStore);
int ipworksencrypt_xmlencrypt_getcertstore(void* lpObj, char** lpCertStore, int* lenCertStore);
int ipworksencrypt_xmlencrypt_setcertstore(void* lpObj, const char* lpCertStore, int lenCertStore);
QByteArray GetCertStore();
int SetCertStore(QByteArray qbaCertStore);
Default Value
"MY"
Remarks
This is the name of the certificate store for the client certificate.
The CertStoreType property denotes the type of the certificate store specified by CertStore. If the store is password protected, specify the password in CertStorePassword.
CertStore is used in conjunction with the CertSubject property to specify client certificates. If CertStore has a value, and CertSubject or CertEncoded is set, a search for a certificate is initiated. Please see the CertSubject property for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root 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., PKCS#12 certificate store).
Data Type
Binary String
CertStorePassword Property (XMLEncrypt Class)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
ANSI (Cross Platform) char* GetCertStorePassword();
int SetCertStorePassword(const char* lpszCertStorePassword); Unicode (Windows) LPWSTR GetCertStorePassword();
INT SetCertStorePassword(LPCWSTR lpszCertStorePassword);
char* ipworksencrypt_xmlencrypt_getcertstorepassword(void* lpObj);
int ipworksencrypt_xmlencrypt_setcertstorepassword(void* lpObj, const char* lpszCertStorePassword);
QString GetCertStorePassword();
int SetCertStorePassword(QString qsCertStorePassword);
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 Class)
This is the type of certificate store for this certificate.
Syntax
ANSI (Cross Platform) int GetCertStoreType();
int SetCertStoreType(int iCertStoreType); Unicode (Windows) INT GetCertStoreType();
INT SetCertStoreType(INT iCertStoreType);
Possible Values
CST_USER(0),
CST_MACHINE(1),
CST_PFXFILE(2),
CST_PFXBLOB(3),
CST_JKSFILE(4),
CST_JKSBLOB(5),
CST_PEMKEY_FILE(6),
CST_PEMKEY_BLOB(7),
CST_PUBLIC_KEY_FILE(8),
CST_PUBLIC_KEY_BLOB(9),
CST_SSHPUBLIC_KEY_BLOB(10),
CST_P7BFILE(11),
CST_P7BBLOB(12),
CST_SSHPUBLIC_KEY_FILE(13),
CST_PPKFILE(14),
CST_PPKBLOB(15),
CST_XMLFILE(16),
CST_XMLBLOB(17),
CST_JWKFILE(18),
CST_JWKBLOB(19),
CST_SECURITY_KEY(20),
CST_BCFKSFILE(21),
CST_BCFKSBLOB(22),
CST_PKCS11(23),
CST_AUTO(99)
int ipworksencrypt_xmlencrypt_getcertstoretype(void* lpObj);
int ipworksencrypt_xmlencrypt_setcertstoretype(void* lpObj, int iCertStoreType);
int GetCertStoreType();
int SetCertStoreType(int iCertStoreType);
Default Value
0
Remarks
This is the type of certificate store for this certificate.
The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
Note: This store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
Note: This store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) 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 PKCS#7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 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 PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 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:
|
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 Class)
This is the subject of the certificate used for client authentication.
Syntax
ANSI (Cross Platform) char* GetCertSubject();
int SetCertSubject(const char* lpszCertSubject); Unicode (Windows) LPWSTR GetCertSubject();
INT SetCertSubject(LPCWSTR lpszCertSubject);
char* ipworksencrypt_xmlencrypt_getcertsubject(void* lpObj);
int ipworksencrypt_xmlencrypt_setcertsubject(void* lpObj, const char* lpszCertSubject);
QString GetCertSubject();
int SetCertSubject(QString qsCertSubject);
Default Value
""
Remarks
This is the subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:
Field | Meaning |
CN | Common Name. This is commonly a hostname like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma, it must be quoted.
Data Type
String
EncryptedDataDetailCount Property (XMLEncrypt Class)
The number of records in the EncryptedDataDetail arrays.
Syntax
ANSI (Cross Platform) int GetEncryptedDataDetailCount();
int SetEncryptedDataDetailCount(int iEncryptedDataDetailCount); Unicode (Windows) INT GetEncryptedDataDetailCount();
INT SetEncryptedDataDetailCount(INT iEncryptedDataDetailCount);
int ipworksencrypt_xmlencrypt_getencrypteddatadetailcount(void* lpObj);
int ipworksencrypt_xmlencrypt_setencrypteddatadetailcount(void* lpObj, int iEncryptedDataDetailCount);
int GetEncryptedDataDetailCount();
int SetEncryptedDataDetailCount(int iEncryptedDataDetailCount);
Default Value
0
Remarks
This property controls the size of the following arrays:
- EncryptedDataDetailId
- EncryptedDataDetailMIMEType
- EncryptedDataDetailScope
- EncryptedDataDetailXMLElement
This property is not available at design time.
Data Type
Integer
EncryptedDataDetailId Property (XMLEncrypt Class)
This property is an optional identifier for the encrypted data.
Syntax
ANSI (Cross Platform) char* GetEncryptedDataDetailId(int iEncryptedDataDetailIndex);
int SetEncryptedDataDetailId(int iEncryptedDataDetailIndex, const char* lpszEncryptedDataDetailId); Unicode (Windows) LPWSTR GetEncryptedDataDetailId(INT iEncryptedDataDetailIndex);
INT SetEncryptedDataDetailId(INT iEncryptedDataDetailIndex, LPCWSTR lpszEncryptedDataDetailId);
char* ipworksencrypt_xmlencrypt_getencrypteddatadetailid(void* lpObj, int encrypteddatadetailindex);
int ipworksencrypt_xmlencrypt_setencrypteddatadetailid(void* lpObj, int encrypteddatadetailindex, const char* lpszEncryptedDataDetailId);
QString GetEncryptedDataDetailId(int iEncryptedDataDetailIndex);
int SetEncryptedDataDetailId(int iEncryptedDataDetailIndex, QString qsEncryptedDataDetailId);
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 Class)
This property specifies the MIME type of the encrypted data.
Syntax
ANSI (Cross Platform) char* GetEncryptedDataDetailMIMEType(int iEncryptedDataDetailIndex);
int SetEncryptedDataDetailMIMEType(int iEncryptedDataDetailIndex, const char* lpszEncryptedDataDetailMIMEType); Unicode (Windows) LPWSTR GetEncryptedDataDetailMIMEType(INT iEncryptedDataDetailIndex);
INT SetEncryptedDataDetailMIMEType(INT iEncryptedDataDetailIndex, LPCWSTR lpszEncryptedDataDetailMIMEType);
char* ipworksencrypt_xmlencrypt_getencrypteddatadetailmimetype(void* lpObj, int encrypteddatadetailindex);
int ipworksencrypt_xmlencrypt_setencrypteddatadetailmimetype(void* lpObj, int encrypteddatadetailindex, const char* lpszEncryptedDataDetailMIMEType);
QString GetEncryptedDataDetailMIMEType(int iEncryptedDataDetailIndex);
int SetEncryptedDataDetailMIMEType(int iEncryptedDataDetailIndex, QString qsEncryptedDataDetailMIMEType);
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 Class)
This property specifies the scope of the encryption.
Syntax
ANSI (Cross Platform) int GetEncryptedDataDetailScope(int iEncryptedDataDetailIndex);
int SetEncryptedDataDetailScope(int iEncryptedDataDetailIndex, int iEncryptedDataDetailScope); Unicode (Windows) INT GetEncryptedDataDetailScope(INT iEncryptedDataDetailIndex);
INT SetEncryptedDataDetailScope(INT iEncryptedDataDetailIndex, INT iEncryptedDataDetailScope);
Possible Values
S_ELEMENT(0),
S_CONTENT(1)
int ipworksencrypt_xmlencrypt_getencrypteddatadetailscope(void* lpObj, int encrypteddatadetailindex);
int ipworksencrypt_xmlencrypt_setencrypteddatadetailscope(void* lpObj, int encrypteddatadetailindex, int iEncryptedDataDetailScope);
int GetEncryptedDataDetailScope(int iEncryptedDataDetailIndex);
int SetEncryptedDataDetailScope(int iEncryptedDataDetailIndex, int iEncryptedDataDetailScope);
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 Class)
This property specifies the XPath to the element which will be encrypted.
Syntax
ANSI (Cross Platform) char* GetEncryptedDataDetailXMLElement(int iEncryptedDataDetailIndex);
int SetEncryptedDataDetailXMLElement(int iEncryptedDataDetailIndex, const char* lpszEncryptedDataDetailXMLElement); Unicode (Windows) LPWSTR GetEncryptedDataDetailXMLElement(INT iEncryptedDataDetailIndex);
INT SetEncryptedDataDetailXMLElement(INT iEncryptedDataDetailIndex, LPCWSTR lpszEncryptedDataDetailXMLElement);
char* ipworksencrypt_xmlencrypt_getencrypteddatadetailxmlelement(void* lpObj, int encrypteddatadetailindex);
int ipworksencrypt_xmlencrypt_setencrypteddatadetailxmlelement(void* lpObj, int encrypteddatadetailindex, const char* lpszEncryptedDataDetailXMLElement);
QString GetEncryptedDataDetailXMLElement(int iEncryptedDataDetailIndex);
int SetEncryptedDataDetailXMLElement(int iEncryptedDataDetailIndex, QString qsEncryptedDataDetailXMLElement);
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 Class)
Then encryption algorithm used when encrypting.
Syntax
ANSI (Cross Platform) char* GetEncryptingAlgorithm();
int SetEncryptingAlgorithm(const char* lpszEncryptingAlgorithm); Unicode (Windows) LPWSTR GetEncryptingAlgorithm();
INT SetEncryptingAlgorithm(LPCWSTR lpszEncryptingAlgorithm);
char* ipworksencrypt_xmlencrypt_getencryptingalgorithm(void* lpObj);
int ipworksencrypt_xmlencrypt_setencryptingalgorithm(void* lpObj, const char* lpszEncryptingAlgorithm);
QString GetEncryptingAlgorithm();
int SetEncryptingAlgorithm(QString qsEncryptingAlgorithm);
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 Class)
The XML file to process.
Syntax
ANSI (Cross Platform) char* GetInputFile();
int SetInputFile(const char* lpszInputFile); Unicode (Windows) LPWSTR GetInputFile();
INT SetInputFile(LPCWSTR lpszInputFile);
char* ipworksencrypt_xmlencrypt_getinputfile(void* lpObj);
int ipworksencrypt_xmlencrypt_setinputfile(void* lpObj, const char* lpszInputFile);
QString GetInputFile();
int SetInputFile(QString qsInputFile);
Default Value
""
Remarks
This property specifies the file to be processed. Set this property to the full or relative path to the file which will be processed.
Input and Output Properties
The class will determine the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
- InputFile
- InputXML
- OutputFile
- OutputXML: The output data is written to this property if no other destination is specified.
This property is not available at design time.
Data Type
String
InputXML Property (XMLEncrypt Class)
The XML to process.
Syntax
ANSI (Cross Platform) char* GetInputXML();
int SetInputXML(const char* lpszInputXML); Unicode (Windows) LPWSTR GetInputXML();
INT SetInputXML(LPCWSTR lpszInputXML);
char* ipworksencrypt_xmlencrypt_getinputxml(void* lpObj);
int ipworksencrypt_xmlencrypt_setinputxml(void* lpObj, const char* lpszInputXML);
QString GetInputXML();
int SetInputXML(QString qsInputXML);
Default Value
""
Remarks
This property specifies the XML to be processed.
Input and Output Properties
The class will determine the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
- InputFile
- InputXML
- OutputFile
- OutputXML: The output data is written to this property if no other destination is specified.
This property is not available at design time.
Data Type
String
OutputFile Property (XMLEncrypt Class)
The output file.
Syntax
ANSI (Cross Platform) char* GetOutputFile();
int SetOutputFile(const char* lpszOutputFile); Unicode (Windows) LPWSTR GetOutputFile();
INT SetOutputFile(LPCWSTR lpszOutputFile);
char* ipworksencrypt_xmlencrypt_getoutputfile(void* lpObj);
int ipworksencrypt_xmlencrypt_setoutputfile(void* lpObj, const char* lpszOutputFile);
QString GetOutputFile();
int SetOutputFile(QString qsOutputFile);
Default Value
""
Remarks
This property specifies the file to which the output will be written. This may be set to an absolute or relative path.
Input and Output Properties
The class will determine the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
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 Class)
The output XML after processing.
Syntax
ANSI (Cross Platform) char* GetOutputXML();
int SetOutputXML(const char* lpszOutputXML); Unicode (Windows) LPWSTR GetOutputXML();
INT SetOutputXML(LPCWSTR lpszOutputXML);
char* ipworksencrypt_xmlencrypt_getoutputxml(void* lpObj);
int ipworksencrypt_xmlencrypt_setoutputxml(void* lpObj, const char* lpszOutputXML);
QString GetOutputXML();
int SetOutputXML(QString qsOutputXML);
Default Value
""
Remarks
This property will be populated with the output from the operation if OutputFile is not set.
Input and Output Properties
The class will determine the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
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 Class)
Indicates whether or not the class should overwrite files.
Syntax
ANSI (Cross Platform) int GetOverwrite();
int SetOverwrite(int bOverwrite); Unicode (Windows) BOOL GetOverwrite();
INT SetOverwrite(BOOL bOverwrite);
int ipworksencrypt_xmlencrypt_getoverwrite(void* lpObj);
int ipworksencrypt_xmlencrypt_setoverwrite(void* lpObj, int bOverwrite);
bool GetOverwrite();
int SetOverwrite(bool bOverwrite);
Default Value
FALSE
Remarks
This property indicates whether or not the class will overwrite OutputFile. If Overwrite is False, an error will be thrown whenever OutputFile exists before an operation. The default value is False.
Data Type
Boolean
RecipientCertEncoded Property (XMLEncrypt Class)
This is the certificate (PEM/Base64 encoded).
Syntax
ANSI (Cross Platform) int GetRecipientCertEncoded(char* &lpRecipientCertEncoded, int &lenRecipientCertEncoded);
int SetRecipientCertEncoded(const char* lpRecipientCertEncoded, int lenRecipientCertEncoded); Unicode (Windows) INT GetRecipientCertEncoded(LPSTR &lpRecipientCertEncoded, INT &lenRecipientCertEncoded);
INT SetRecipientCertEncoded(LPCSTR lpRecipientCertEncoded, INT lenRecipientCertEncoded);
int ipworksencrypt_xmlencrypt_getrecipientcertencoded(void* lpObj, char** lpRecipientCertEncoded, int* lenRecipientCertEncoded);
int ipworksencrypt_xmlencrypt_setrecipientcertencoded(void* lpObj, const char* lpRecipientCertEncoded, int lenRecipientCertEncoded);
QByteArray GetRecipientCertEncoded();
int SetRecipientCertEncoded(QByteArray qbaRecipientCertEncoded);
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.
This property is not available at design time.
Data Type
Binary String
RecipientCertStore Property (XMLEncrypt Class)
This is the name of the certificate store for the client certificate.
Syntax
ANSI (Cross Platform) int GetRecipientCertStore(char* &lpRecipientCertStore, int &lenRecipientCertStore);
int SetRecipientCertStore(const char* lpRecipientCertStore, int lenRecipientCertStore); Unicode (Windows) INT GetRecipientCertStore(LPSTR &lpRecipientCertStore, INT &lenRecipientCertStore);
INT SetRecipientCertStore(LPCSTR lpRecipientCertStore, INT lenRecipientCertStore);
int ipworksencrypt_xmlencrypt_getrecipientcertstore(void* lpObj, char** lpRecipientCertStore, int* lenRecipientCertStore);
int ipworksencrypt_xmlencrypt_setrecipientcertstore(void* lpObj, const char* lpRecipientCertStore, int lenRecipientCertStore);
QByteArray GetRecipientCertStore();
int SetRecipientCertStore(QByteArray qbaRecipientCertStore);
Default Value
"MY"
Remarks
This is the name of the certificate store for the client certificate.
The RecipientCertStoreType property denotes the type of the certificate store specified by RecipientCertStore. If the store is password protected, specify the password in RecipientCertStorePassword.
RecipientCertStore is used in conjunction with the RecipientCertSubject property to specify client certificates. If RecipientCertStore has a value, and RecipientCertSubject or RecipientCertEncoded is set, a search for a certificate is initiated. Please see the RecipientCertSubject property for details.
Designations of certificate stores are platform dependent.
The following designations are the most common User and Machine certificate stores in Windows:
MY | A certificate store holding personal certificates with their associated private keys. |
CA | Certifying authority certificates. |
ROOT | Root 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., PKCS#12 certificate store).
Data Type
Binary String
RecipientCertStorePassword Property (XMLEncrypt Class)
If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.
Syntax
ANSI (Cross Platform) char* GetRecipientCertStorePassword();
int SetRecipientCertStorePassword(const char* lpszRecipientCertStorePassword); Unicode (Windows) LPWSTR GetRecipientCertStorePassword();
INT SetRecipientCertStorePassword(LPCWSTR lpszRecipientCertStorePassword);
char* ipworksencrypt_xmlencrypt_getrecipientcertstorepassword(void* lpObj);
int ipworksencrypt_xmlencrypt_setrecipientcertstorepassword(void* lpObj, const char* lpszRecipientCertStorePassword);
QString GetRecipientCertStorePassword();
int SetRecipientCertStorePassword(QString qsRecipientCertStorePassword);
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 Class)
This is the type of certificate store for this certificate.
Syntax
ANSI (Cross Platform) int GetRecipientCertStoreType();
int SetRecipientCertStoreType(int iRecipientCertStoreType); Unicode (Windows) INT GetRecipientCertStoreType();
INT SetRecipientCertStoreType(INT iRecipientCertStoreType);
Possible Values
CST_USER(0),
CST_MACHINE(1),
CST_PFXFILE(2),
CST_PFXBLOB(3),
CST_JKSFILE(4),
CST_JKSBLOB(5),
CST_PEMKEY_FILE(6),
CST_PEMKEY_BLOB(7),
CST_PUBLIC_KEY_FILE(8),
CST_PUBLIC_KEY_BLOB(9),
CST_SSHPUBLIC_KEY_BLOB(10),
CST_P7BFILE(11),
CST_P7BBLOB(12),
CST_SSHPUBLIC_KEY_FILE(13),
CST_PPKFILE(14),
CST_PPKBLOB(15),
CST_XMLFILE(16),
CST_XMLBLOB(17),
CST_JWKFILE(18),
CST_JWKBLOB(19),
CST_SECURITY_KEY(20),
CST_BCFKSFILE(21),
CST_BCFKSBLOB(22),
CST_PKCS11(23),
CST_AUTO(99)
int ipworksencrypt_xmlencrypt_getrecipientcertstoretype(void* lpObj);
int ipworksencrypt_xmlencrypt_setrecipientcertstoretype(void* lpObj, int iRecipientCertStoreType);
int GetRecipientCertStoreType();
int SetRecipientCertStoreType(int iRecipientCertStoreType);
Default Value
0
Remarks
This is the type of certificate store for this certificate.
The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:
0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user.
Note: This store type is not available in Java. |
1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store.
Note: This store type is not available in Java. |
2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) 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 PKCS#7 file containing certificates. |
12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 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 PKCS#11 interface.
To use a security key, the necessary data must first be collected using the CertMgr class. The ListStoreCertificates method may be called after setting CertStoreType to cstPKCS11, CertStorePassword to the PIN, and CertStore to the full path of the PKCS#11 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:
|
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 Class)
This is the subject of the certificate used for client authentication.
Syntax
ANSI (Cross Platform) char* GetRecipientCertSubject();
int SetRecipientCertSubject(const char* lpszRecipientCertSubject); Unicode (Windows) LPWSTR GetRecipientCertSubject();
INT SetRecipientCertSubject(LPCWSTR lpszRecipientCertSubject);
char* ipworksencrypt_xmlencrypt_getrecipientcertsubject(void* lpObj);
int ipworksencrypt_xmlencrypt_setrecipientcertsubject(void* lpObj, const char* lpszRecipientCertSubject);
QString GetRecipientCertSubject();
int SetRecipientCertSubject(QString qsRecipientCertSubject);
Default Value
""
Remarks
This is the subject of the certificate used for client authentication.
This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.
If a matching certificate is found, the property is set to the full subject of the matching certificate.
If an exact match is not found, the store is searched for subjects containing the value of the property.
If a match is still not found, the property is set to an empty string, and no certificate is selected.
The special value "*" picks a random certificate in the certificate store.
The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:
Field | Meaning |
CN | Common Name. This is commonly a hostname like www.server.com. |
O | Organization |
OU | Organizational Unit |
L | Locality |
S | State |
C | Country |
E | Email Address |
If a field value contains a comma, it must be quoted.
Data Type
String
SymmetricKey Property (XMLEncrypt Class)
The symmetric key used to encrypt and decrypt the XML.
Syntax
ANSI (Cross Platform) int GetSymmetricKey(char* &lpSymmetricKey, int &lenSymmetricKey);
int SetSymmetricKey(const char* lpSymmetricKey, int lenSymmetricKey); Unicode (Windows) INT GetSymmetricKey(LPSTR &lpSymmetricKey, INT &lenSymmetricKey);
INT SetSymmetricKey(LPCSTR lpSymmetricKey, INT lenSymmetricKey);
int ipworksencrypt_xmlencrypt_getsymmetrickey(void* lpObj, char** lpSymmetricKey, int* lenSymmetricKey);
int ipworksencrypt_xmlencrypt_setsymmetrickey(void* lpObj, const char* lpSymmetricKey, int lenSymmetricKey);
QByteArray GetSymmetricKey();
int SetSymmetricKey(QByteArray qbaSymmetricKey);
Default Value
""
Remarks
This property specifies the symmetric key used to encrypt and decrypt the XML.
Encrypt Notes
When calling Encrypt if the RecipientCert* properties are set, then the SymmetricKey will be encrypted and included in the XML as an encrypted key. Using asymmetric encryption to encrypt the SymmetricKey allows for secure transmission of the key. This is also referred to as using a session key, as no prior knowledge of the SymmetricKey is required by the recipient.
If the RecipientCert* properties are set and SymmetricKey is left empty, then a SymmetricKey value will automatically be generated by the class when Encrypt is called.
When calling Encrypt if the RecipientCert* properties are are not set, then the SymmetricKey value must be known by the recipient before the message can be decrypted.
Decrypt Notes
When calling Decrypt if the data contains an encrypted key the class will attempt to use the certificate specified by the Cert* properties to decrypt the encrypted key and this property is ignored.
When calling Decrypt if the data does not contain an encrypted key then SymmetricKey must be set either before calling Decrypt, or within the EncryptedDataInfo event.
Legal Key and Block Sizes (in bits)
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 |
This property is not available at design time.
Data Type
Binary String
UseOAEP Property (XMLEncrypt Class)
Whether to use Optimal Asymmetric Encryption Padding (OAEP).
Syntax
ANSI (Cross Platform) int GetUseOAEP();
int SetUseOAEP(int bUseOAEP); Unicode (Windows) BOOL GetUseOAEP();
INT SetUseOAEP(BOOL bUseOAEP);
int ipworksencrypt_xmlencrypt_getuseoaep(void* lpObj);
int ipworksencrypt_xmlencrypt_setuseoaep(void* lpObj, int bUseOAEP);
bool GetUseOAEP();
int SetUseOAEP(bool bUseOAEP);
Default Value
FALSE
Remarks
This setting specifies whether to use Optimal Asymmetric Encryption Padding (OAEP) when encrypting the SymmetricKey with the certificate specified by RecipientCert. It is only applicable when calling Encrypt and RecipientCert is specified.
By default this value is False and the class will use PKCS1.
Data Type
Boolean
Config Method (XMLEncrypt Class)
Sets or retrieves a configuration setting.
Syntax
ANSI (Cross Platform) char* Config(const char* lpszConfigurationString); Unicode (Windows) LPWSTR Config(LPCWSTR lpszConfigurationString);
char* ipworksencrypt_xmlencrypt_config(void* lpObj, const char* lpszConfigurationString);
QString Config(const QString& qsConfigurationString);
Remarks
Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.
These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.
To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).
To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.
Error Handling (C++)
This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
Decrypt Method (XMLEncrypt Class)
Decrypts the XML.
Syntax
ANSI (Cross Platform) int Decrypt(); Unicode (Windows) INT Decrypt();
int ipworksencrypt_xmlencrypt_decrypt(void* lpObj);
int Decrypt();
Remarks
This method decrypts the specified XML.
To begin first specify a XML document by setting InputFile, or InputXML.
The SymmetricKey property specifies the key used to decrypt the data. This may be set before calling Decrypt or inside the EncryptedDataInfo event. The EncryptedDataInfo event fires once for each encrypted element when Decrypt is called.
If the data was encrypted using an session key, set the Cert* properties to the certificate with private key before calling Decrypt. The certificate will be used to decrypt the encrypted session key. In this case the SymmetricKey property is ignored.
The following properties are applicable when calling this method:
- SymmetricKey
- Certificate
Input and Output Properties
The class will determine the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
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.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
DoEvents Method (XMLEncrypt Class)
Processes events from the internal message queue.
Syntax
ANSI (Cross Platform) int DoEvents(); Unicode (Windows) INT DoEvents();
int ipworksencrypt_xmlencrypt_doevents(void* lpObj);
int DoEvents();
Remarks
When DoEvents is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Encrypt Method (XMLEncrypt Class)
Encrypts the XML.
Syntax
ANSI (Cross Platform) int Encrypt(); Unicode (Windows) INT Encrypt();
int ipworksencrypt_xmlencrypt_encrypt(void* lpObj);
int Encrypt();
Remarks
This method encrypts the specified XML.
To begin first specify a XML document by setting InputFile, or InputXML.
The EncryptedDataDetail* properties specify the XML element to encrypt. By default the entire XML document is encrypted.
The SymmetricKey property specifies the key which will be used to encrypt the data.
If the RecipientCert* properties are set, then the SymmetricKey will be encrypted and included in the encrypted data. This allows for the recipient to decrypt the key, with their certificate. Encrypting the symmetric key is also referred to as using a session key. The benefit of using certificate to encrypt and decrypt a session key (SymmetricKey) is that knowledge of the key value is not needed ahead of time to process the encrypted data. Note that if specified, RecipientCert MUST have a RSA key, not a DSA key.
If the RecipientCert* properties are not set, then the recipient must know the value of SymmetricKey before decrypting the XML. The KeyName setting may be set to provide a key identifier to the recipient.
Optionally set EncryptingAlgorithm, and then call Encrypt to encrypt the XML.
The following properties are applicable when calling this method:
- SymmetricKey (required)
- EncryptingAlgorithm
- EncryptedDataDetail*
- RecipientCert*
- KeyName
Input and Output Properties
The class will determine the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
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.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
Reset Method (XMLEncrypt Class)
Resets the class.
Syntax
ANSI (Cross Platform) int Reset(); Unicode (Windows) INT Reset();
int ipworksencrypt_xmlencrypt_reset(void* lpObj);
int Reset();
Remarks
When called, the component will reset all of its properties to their default values.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
SetInputStream Method (XMLEncrypt Class)
Sets the stream from which the class will read data to encrypt or decrypt.
Syntax
ANSI (Cross Platform) int SetInputStream(IPWorksEncryptStream* sInputStream); Unicode (Windows) INT SetInputStream(IPWorksEncryptStream* sInputStream);
int ipworksencrypt_xmlencrypt_setinputstream(void* lpObj, IPWorksEncryptStream* sInputStream);
int SetInputStream(IPWorksEncryptStream* sInputStream);
Remarks
This method sets the stream from which the class will read data to encrypt or decrypt. If an input stream is set before calling Encrypt or Decrypt, the data is read from the input stream instead of from the InputFile or InputXML properties.
The content of the stream will be read from the current position all the way to the end and no bytes will be skipped.
Input and Output Properties
The class will determine the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
When a valid source is found the search stops. The order in which the output properties are checked is as follows:- OutputFile
- OutputXML: The output data is written to this property if no other destination is specified.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
SetOutputStream Method (XMLEncrypt Class)
The stream to which the class will write the encrypted or decrypted XML.
Syntax
ANSI (Cross Platform) int SetOutputStream(IPWorksEncryptStream* sOutputStream); Unicode (Windows) INT SetOutputStream(IPWorksEncryptStream* sOutputStream);
int ipworksencrypt_xmlencrypt_setoutputstream(void* lpObj, IPWorksEncryptStream* sOutputStream);
int SetOutputStream(IPWorksEncryptStream* sOutputStream);
Remarks
This method sets the stream to which the class will write the encrypted or decrypted XML. If an output stream is set before calling Encrypt or Decrypt, the class will write the data to the output stream instead of populating OutputXML or writing to OutputFile.
Input and Output Properties
The class will determine the source and destination of the input and output based on which properties are set.
The order in which the input properties are checked is as follows:
When a valid source is found the search stops. The order in which the output properties are checked is as follows:- OutputFile
- OutputXML: The output data is written to this property if no other destination is specified.
Error Handling (C++)
This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)
EncryptedDataInfo Event (XMLEncrypt Class)
Fired once for each encrypted element when Decrypt is called.
Syntax
ANSI (Cross Platform) virtual int FireEncryptedDataInfo(XMLEncryptEncryptedDataInfoEventParams *e);
typedef struct {
const char *EncryptedDataId;
int Scope;
const char *MIMEType; int reserved; } XMLEncryptEncryptedDataInfoEventParams;
Unicode (Windows) virtual INT FireEncryptedDataInfo(XMLEncryptEncryptedDataInfoEventParams *e);
typedef struct {
LPCWSTR EncryptedDataId;
INT Scope;
LPCWSTR MIMEType; INT reserved; } XMLEncryptEncryptedDataInfoEventParams;
#define EID_XMLENCRYPT_ENCRYPTEDDATAINFO 1 virtual INT IPWORKSENCRYPT_CALL FireEncryptedDataInfo(LPSTR &lpszEncryptedDataId, INT &iScope, LPSTR &lpszMIMEType);
class XMLEncryptEncryptedDataInfoEventParams { public: const QString &EncryptedDataId(); int Scope(); const QString &MIMEType(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void EncryptedDataInfo(XMLEncryptEncryptedDataInfoEventParams *e);
// Or, subclass XMLEncrypt and override this emitter function. virtual int FireEncryptedDataInfo(XMLEncryptEncryptedDataInfoEventParams *e) {...}
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:
0 | Element |
1 | Content |
MIMEType holds the MIME type of the encrypted data (if any). For example: "image/png".
Error Event (XMLEncrypt Class)
Fired when information is available about errors during data delivery.
Syntax
ANSI (Cross Platform) virtual int FireError(XMLEncryptErrorEventParams *e);
typedef struct {
int ErrorCode;
const char *Description; int reserved; } XMLEncryptErrorEventParams;
Unicode (Windows) virtual INT FireError(XMLEncryptErrorEventParams *e);
typedef struct {
INT ErrorCode;
LPCWSTR Description; INT reserved; } XMLEncryptErrorEventParams;
#define EID_XMLENCRYPT_ERROR 2 virtual INT IPWORKSENCRYPT_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);
class XMLEncryptErrorEventParams { public: int ErrorCode(); const QString &Description(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Error(XMLEncryptErrorEventParams *e);
// Or, subclass XMLEncrypt and override this emitter function. virtual int FireError(XMLEncryptErrorEventParams *e) {...}
Remarks
The Error event is fired in case of exceptional conditions during message processing. Normally the class 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 Class)
Fired as progress is made.
Syntax
ANSI (Cross Platform) virtual int FireProgress(XMLEncryptProgressEventParams *e);
typedef struct {
int64 BytesProcessed;
int PercentProcessed;
int Operation;
int IsEOF; int reserved; } XMLEncryptProgressEventParams;
Unicode (Windows) virtual INT FireProgress(XMLEncryptProgressEventParams *e);
typedef struct {
LONG64 BytesProcessed;
INT PercentProcessed;
INT Operation;
BOOL IsEOF; INT reserved; } XMLEncryptProgressEventParams;
#define EID_XMLENCRYPT_PROGRESS 3 virtual INT IPWORKSENCRYPT_CALL FireProgress(LONG64 &lBytesProcessed, INT &iPercentProcessed, INT &iOperation, BOOL &bIsEOF);
class XMLEncryptProgressEventParams { public: qint64 BytesProcessed(); int PercentProcessed(); int Operation(); bool IsEOF(); void SetIsEOF(bool bIsEOF); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Progress(XMLEncryptProgressEventParams *e);
// Or, subclass XMLEncrypt and override this emitter function. virtual int FireProgress(XMLEncryptProgressEventParams *e) {...}
Remarks
This event is fired automatically as data is processed by the class.
The PercentProcessed parameter indicates the current status of the operation.
The BytesProcessed parameter holds the total number of bytes processed so far.
The Operation parameter is only applicable when either ReadFromProgressEvent or WriteToProgressEvent is set to True. This parameter defines whether a Read or Write operation is required. If the configuration settings are not set this parameter will always return 0. Possible values are:
0 | None |
1 | Read |
2 | Write |
The IsEOF parameter is only applicable when either ReadFromProgressEvent or WriteToProgressEvent is set to True. This parameter defines whether the Read or Write operation is complete. When the Operation is Read (1) this parameter must be set to indicate that all data has been supplied to the class. When the Operation is Write (2) this value may be queried to determine when all data has been processed.
Status Event (XMLEncrypt Class)
Provides information about the current operation.
Syntax
ANSI (Cross Platform) virtual int FireStatus(XMLEncryptStatusEventParams *e);
typedef struct {
const char *Message; int reserved; } XMLEncryptStatusEventParams;
Unicode (Windows) virtual INT FireStatus(XMLEncryptStatusEventParams *e);
typedef struct {
LPCWSTR Message; INT reserved; } XMLEncryptStatusEventParams;
#define EID_XMLENCRYPT_STATUS 4 virtual INT IPWORKSENCRYPT_CALL FireStatus(LPSTR &lpszMessage);
class XMLEncryptStatusEventParams { public: const QString &Message(); int EventRetVal(); void SetEventRetVal(int iRetVal); };
// To handle, connect one or more slots to this signal. void Status(XMLEncryptStatusEventParams *e);
// Or, subclass XMLEncrypt and override this emitter function. virtual int FireStatus(XMLEncryptStatusEventParams *e) {...}
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.
IPWorksEncryptStream Type
Syntax
IPWorksEncryptStream (declared in ipworksencrypt.h)
Remarks
The XMLEncrypt class includes one or more API members that take a stream object as a parameter. To use such API members, create a concrete class that implements the IPWorksEncryptStream interface and pass the XMLEncrypt class an instance of that concrete class.
When implementing the IPWorksEncryptStream interface's properties and methods, they must behave as described below. If the concrete class's implementation does not behave as expected, undefined behavior may occur.
Properties | |
CanRead |
Whether the stream supports reading.
bool CanRead() { return true; } |
CanSeek |
Whether the stream supports seeking.
bool CanSeek() { return true; } |
CanWrite |
Whether the stream supports writing.
bool CanWrite() { return true; } |
Length |
Gets the length of the stream, in bytes.
int64 GetLength() = 0; |
Methods | |
Close |
Closes the stream, releasing all resources currently allocated for it.
void Close() {} This method is called automatically when an IPWorksEncryptStream object is deleted. |
Flush |
Forces all data held by the stream's buffers to be written out to storage.
int Flush() { return 0; } Must return 0 if flushing is successful; or -1 if an error occurs or the stream is closed. If the stream does not support writing, this method must do nothing and return 0. |
Read |
Reads a sequence of bytes from the stream and advances the current position within the stream by the number of bytes read.
int Read(void* buffer, int count) = 0; Buffer specifies the buffer to populate with data from the stream. Count specifies the number of bytes that should be read from the stream. Must return the total number of bytes read into Buffer; this may be less than Count if that many bytes are not currently available, or 0 if the end of the stream has been reached. Must return -1 if an error occurs, if reading is not supported, or if the stream is closed. |
Seek |
Sets the current position within the stream based on a particular point of origin.
int64 Seek(int64 offset, int seekOrigin) = 0; Offset specifies the offset in the stream to seek to, relative to SeekOrigin. Valid values for SeekOrigin are:
Must return the new position within the stream; or -1 if an error occurs, if seeking is not supported, or if the stream is closed (however, see note below). If -1 is returned, the current position within the stream must remain unchanged. Note: If the stream is not closed, it must always be possible to call this method with an Offset of 0 and a SeekOrigin of 1 to obtain the current position within the stream, even if seeking is not otherwise supported. |
Write |
Writes a sequence of bytes to the stream and advances the current position within the stream by the number of bytes written.
int Write(const void* buffer, int count) = 0; Buffer specifies the buffer with data to write to the stream. Count specifies the number of bytes that should be written to the stream. Must return the total number of bytes written to the stream; this may be less than Count if that many bytes could not be written. Must return -1 if an error occurs, if writing is not supported, or if the stream is closed. |
Config Settings (XMLEncrypt Class)
The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.XMLEnc Config Settings
Note: This functionality is only available on Windows.
Note that this value is only informative, it does not affect processing.
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. |
- "SHA1"
- "SHA224"
- "SHA256" (default)
- "SHA384"
- "SHA512"
- "RIPEMD160"
- "MD2"
- "MD5"
- "MD5SHA1"
Note: This setting is not applicable when UseFIPSCompliantAPI is set to true or when the private key of the signing certificate is not exportable since the underlying system implementation does not support separate OAEPRSAHashAlgorithm and OAEPMGF1HashAlgorithm values. In this case the OAEPRSAHashAlgorithm is also used for MGF1.
- "SHA1"
- "SHA224"
- "SHA256" (default)
- "SHA384"
- "SHA512"
- "RIPEMD160"
- "MD2"
- "MD5"
- "MD5SHA1"
- "SHA1" (default)
- "SHA224"
- "SHA256"
- "SHA384"
- "SHA512"
- "SHA1"
- "SHA224"
- "SHA256" (default)
- "SHA384"
- "SHA512"
- "RIPEMD160"
- "MD2"
- "MD5"
- "MD5SHA1"
- "SHA1" (default)
- "SHA224"
- "SHA256"
- "SHA384"
- "SHA512"
Base Config Settings
The following is a list of valid code page identifiers:
Identifier | Name |
037 | IBM EBCDIC - U.S./Canada |
437 | OEM - United States |
500 | IBM EBCDIC - International |
708 | Arabic - ASMO 708 |
709 | Arabic - ASMO 449+, BCON V4 |
710 | Arabic - Transparent Arabic |
720 | Arabic - Transparent ASMO |
737 | OEM - Greek (formerly 437G) |
775 | OEM - Baltic |
850 | OEM - Multilingual Latin I |
852 | OEM - Latin II |
855 | OEM - Cyrillic (primarily Russian) |
857 | OEM - Turkish |
858 | OEM - Multilingual Latin I + Euro symbol |
860 | OEM - Portuguese |
861 | OEM - Icelandic |
862 | OEM - Hebrew |
863 | OEM - Canadian-French |
864 | OEM - Arabic |
865 | OEM - Nordic |
866 | OEM - Russian |
869 | OEM - Modern Greek |
870 | IBM EBCDIC - Multilingual/ROECE (Latin-2) |
874 | ANSI/OEM - Thai (same as 28605, ISO 8859-15) |
875 | IBM EBCDIC - Modern Greek |
932 | ANSI/OEM - Japanese, Shift-JIS |
936 | ANSI/OEM - Simplified Chinese (PRC, Singapore) |
949 | ANSI/OEM - Korean (Unified Hangul Code) |
950 | ANSI/OEM - Traditional Chinese (Taiwan; Hong Kong SAR, PRC) |
1026 | IBM EBCDIC - Turkish (Latin-5) |
1047 | IBM EBCDIC - Latin 1/Open System |
1140 | IBM EBCDIC - U.S./Canada (037 + Euro symbol) |
1141 | IBM EBCDIC - Germany (20273 + Euro symbol) |
1142 | IBM EBCDIC - Denmark/Norway (20277 + Euro symbol) |
1143 | IBM EBCDIC - Finland/Sweden (20278 + Euro symbol) |
1144 | IBM EBCDIC - Italy (20280 + Euro symbol) |
1145 | IBM EBCDIC - Latin America/Spain (20284 + Euro symbol) |
1146 | IBM EBCDIC - United Kingdom (20285 + Euro symbol) |
1147 | IBM EBCDIC - France (20297 + Euro symbol) |
1148 | IBM EBCDIC - International (500 + Euro symbol) |
1149 | IBM EBCDIC - Icelandic (20871 + Euro symbol) |
1200 | Unicode UCS-2 Little-Endian (BMP of ISO 10646) |
1201 | Unicode UCS-2 Big-Endian |
1250 | ANSI - Central European |
1251 | ANSI - Cyrillic |
1252 | ANSI - Latin I |
1253 | ANSI - Greek |
1254 | ANSI - Turkish |
1255 | ANSI - Hebrew |
1256 | ANSI - Arabic |
1257 | ANSI - Baltic |
1258 | ANSI/OEM - Vietnamese |
1361 | Korean (Johab) |
10000 | MAC - Roman |
10001 | MAC - Japanese |
10002 | MAC - Traditional Chinese (Big5) |
10003 | MAC - Korean |
10004 | MAC - Arabic |
10005 | MAC - Hebrew |
10006 | MAC - Greek I |
10007 | MAC - Cyrillic |
10008 | MAC - Simplified Chinese (GB 2312) |
10010 | MAC - Romania |
10017 | MAC - Ukraine |
10021 | MAC - Thai |
10029 | MAC - Latin II |
10079 | MAC - Icelandic |
10081 | MAC - Turkish |
10082 | MAC - Croatia |
12000 | Unicode UCS-4 Little-Endian |
12001 | Unicode UCS-4 Big-Endian |
20000 | CNS - Taiwan |
20001 | TCA - Taiwan |
20002 | Eten - Taiwan |
20003 | IBM5550 - Taiwan |
20004 | TeleText - Taiwan |
20005 | Wang - Taiwan |
20105 | IA5 IRV International Alphabet No. 5 (7-bit) |
20106 | IA5 German (7-bit) |
20107 | IA5 Swedish (7-bit) |
20108 | IA5 Norwegian (7-bit) |
20127 | US-ASCII (7-bit) |
20261 | T.61 |
20269 | ISO 6937 Non-Spacing Accent |
20273 | IBM EBCDIC - Germany |
20277 | IBM EBCDIC - Denmark/Norway |
20278 | IBM EBCDIC - Finland/Sweden |
20280 | IBM EBCDIC - Italy |
20284 | IBM EBCDIC - Latin America/Spain |
20285 | IBM EBCDIC - United Kingdom |
20290 | IBM EBCDIC - Japanese Katakana Extended |
20297 | IBM EBCDIC - France |
20420 | IBM EBCDIC - Arabic |
20423 | IBM EBCDIC - Greek |
20424 | IBM EBCDIC - Hebrew |
20833 | IBM EBCDIC - Korean Extended |
20838 | IBM EBCDIC - Thai |
20866 | Russian - KOI8-R |
20871 | IBM EBCDIC - Icelandic |
20880 | IBM EBCDIC - Cyrillic (Russian) |
20905 | IBM EBCDIC - Turkish |
20924 | IBM EBCDIC - Latin-1/Open System (1047 + Euro symbol) |
20932 | JIS X 0208-1990 & 0121-1990 |
20936 | Simplified Chinese (GB2312) |
21025 | IBM EBCDIC - Cyrillic (Serbian, Bulgarian) |
21027 | Extended Alpha Lowercase |
21866 | Ukrainian (KOI8-U) |
28591 | ISO 8859-1 Latin I |
28592 | ISO 8859-2 Central Europe |
28593 | ISO 8859-3 Latin 3 |
28594 | ISO 8859-4 Baltic |
28595 | ISO 8859-5 Cyrillic |
28596 | ISO 8859-6 Arabic |
28597 | ISO 8859-7 Greek |
28598 | ISO 8859-8 Hebrew |
28599 | ISO 8859-9 Latin 5 |
28605 | ISO 8859-15 Latin 9 |
29001 | Europa 3 |
38598 | ISO 8859-8 Hebrew |
50220 | ISO 2022 Japanese with no halfwidth Katakana |
50221 | ISO 2022 Japanese with halfwidth Katakana |
50222 | ISO 2022 Japanese JIS X 0201-1989 |
50225 | ISO 2022 Korean |
50227 | ISO 2022 Simplified Chinese |
50229 | ISO 2022 Traditional Chinese |
50930 | Japanese (Katakana) Extended |
50931 | US/Canada and Japanese |
50933 | Korean Extended and Korean |
50935 | Simplified Chinese Extended and Simplified Chinese |
50936 | Simplified Chinese |
50937 | US/Canada and Traditional Chinese |
50939 | Japanese (Latin) Extended and Japanese |
51932 | EUC - Japanese |
51936 | EUC - Simplified Chinese |
51949 | EUC - Korean |
51950 | EUC - Traditional Chinese |
52936 | HZ-GB2312 Simplified Chinese |
54936 | Windows XP: GB18030 Simplified Chinese (4 Byte) |
57002 | ISCII Devanagari |
57003 | ISCII Bengali |
57004 | ISCII Tamil |
57005 | ISCII Telugu |
57006 | ISCII Assamese |
57007 | ISCII Oriya |
57008 | ISCII Kannada |
57009 | ISCII Malayalam |
57010 | ISCII Gujarati |
57011 | ISCII Punjabi |
65000 | Unicode UTF-7 |
65001 | Unicode UTF-8 |
Identifier | Name |
1 | ASCII |
2 | NEXTSTEP |
3 | JapaneseEUC |
4 | UTF8 |
5 | ISOLatin1 |
6 | Symbol |
7 | NonLossyASCII |
8 | ShiftJIS |
9 | ISOLatin2 |
10 | Unicode |
11 | WindowsCP1251 |
12 | WindowsCP1252 |
13 | WindowsCP1253 |
14 | WindowsCP1254 |
15 | WindowsCP1250 |
21 | ISO2022JP |
30 | MacOSRoman |
10 | UTF16String |
0x90000100 | UTF16BigEndian |
0x94000100 | UTF16LittleEndian |
0x8c000100 | UTF32String |
0x98000100 | UTF32BigEndian |
0x9c000100 | UTF32LittleEndian |
65536 | Proprietary |
- Product: The product the license is for.
- Product Key: The key the license was generated from.
- License Source: Where the license was found (e.g., RuntimeLicense, License File).
- License Type: The type of license installed (e.g., Royalty Free, Single Server).
- Last Valid Build: The last valid build number for which the license will work.
This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.
Setting this configuration setting to true tells the class to use the internal implementation instead of using the system security libraries.
On Windows, this setting is set to false by default. On Linux/macOS, this setting is set to true by default.
To use the system security libraries for Linux, OpenSSL support must be enabled. For more information on how to enable OpenSSL, please refer to the OpenSSL Notes section.
Trappable Errors (XMLEncrypt Class)
Error Handling (C++)
Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.
XMLEnc Errors
607 Failed to write output. | |
609 Could not find encrypted data. | |
610 Invalid encrypted data. | |
611 Failed parsing certificate data. | |
612 SymmetricKey or RecipientCert must be set. |
XML Errors
101 Invalid attribute index. | |
102 No attributes available. | |
103 Invalid namespace index. | |
104 No namespaces available. | |
105 Invalid element index. | |
106 No elements available. | |
107 Attribute does not exist. | |
201 Unbalanced element tag. | |
202 Unknown element prefix (can't find namespace). | |
203 Unknown attribute prefix (can't find namespace). | |
204 Invalid XML markup. | |
205 Invalid end state for parser. | |
206 Document contains unbalanced elements. | |
207 Invalid XPath. | |
208 No such child. | |
209 Top element does not match start of path. | |
210 DOM tree unavailable (set BuildDOM to true and reparse). | |
302 Can't open file. | |
401 Invalid XML would be generated. | |
402 An invalid XML name has been specified. |