# XMLSig Class The XMLSig class is used to sign XML and verify signed XML. ## Syntax ```text XMLSig ``` ## Remarks The XMLSig component provides an easy to use API for signing and verifying signed XML. The [Sign](#sign-method-xmlsig-class) method will create signed XML with an enveloped signature. The [VerifySignature](#verifysignature-method-xmlsig-class) method will attempt to verify the signature(s) within a XML document. **Sign** Before calling [Sign](#sign-method-xmlsig-class) specify the XML to sign by setting [InputFile](#inputfile-property-xmlsig-class), or [InputXML](#inputxml-property-xmlsig-class). The [References](#references-property-xmlsig-class) property must be set. At least one reference must be set. A reference defines the XML element to sign, and the options that specify how it is transformed and hashed during the signing process. Set [Certificate](#certificate-property-xmlsig-class) to a certificate with private key. Optionally set the [CanonicalizationMethod](#canonicalizationmethod-property-xmlsig-class). This determines how the signature itself is canonicalized. [SigningAlgorithm](#signingalgorithm-property-xmlsig-class) defines the algorithm used to sign. The [SignatureXPath](#signaturexpath-property-xmlsig-class) property may be set to specify the location in the XML document where the signature will be placed. Lastly, call [Sign](#sign-method-xmlsig-class) to sign the XML. The following properties are applicable when calling this method: - [CanonicalizationMethod](#canonicalizationmethod-property-xmlsig-class) - [Certificate](#certificate-property-xmlsig-class) (required) - [References](#references-property-xmlsig-class) (required) - [SignatureXPath](#signaturexpath-property-xmlsig-class) - [SigningAlgorithm](#signingalgorithm-property-xmlsig-class) **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](#inputfile-property-xmlsig-class) - [InputXML](#inputxml-property-xmlsig-class) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [OutputFile](#outputfile-property-xmlsig-class) - [OutputXML](#outputxml-property-xmlsig-class): The output data is written to this property if no other destination is specified. **Verify a Signature** When [VerifySignature](#verifysignature-method-xmlsig-class) is called, the class will scan the XML document and fire the [SignatureInfo](#signatureinfo-event-xmlsig-class) event for each signature that is found. When the [SignatureInfo](#signatureinfo-event-xmlsig-class) event fires the [References](#references-property-xmlsig-class) collection will be populated. Within the [SignatureInfo](#signatureinfo-event-xmlsig-class) event the [XMLElement](#XMLSigReference_f_XMLElement) field must be set to the location of the XML element to which the signature applies. The [URI](#XMLSigReference_f_URI) field may contain data helpful to locating the XML element. The [XMLElement](#XMLSigReference_f_XMLElement) field specifies the XPath to the element. 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 signature is verified either using a key parsed from the signed XML, or using the certificate specified by the [SignerCert](#signercert-property-xmlsig-class) property. The class will automatically parse the signer certificate (if present) from the signed XML and populate the [SignerCert](#signercert-property-xmlsig-class) property with the parsed value. When [SignatureInfo](#signatureinfo-event-xmlsig-class) fires, if the *SignerCertParsed* parameter is True the [SignerCert](#signercert-property-xmlsig-class) property may be inspected to see the details of the parsed certificate. If *SignerCertParsed* is False, then the [SignerCert](#signercert-property-xmlsig-class) property must be set to a valid certificate for signature verification to proceed. When the [SignatureInfo](#signatureinfo-event-xmlsig-class) event finishes firing, the certificate present in the [SignerCert](#signercert-property-xmlsig-class) property will be used to verify the signature, whether this is the certificate automatically parsed by the class or a different certificate specified within the event. If the signature was successfully verified the method will return without error. If the signature was not verified the method fails with an error. ## Property List *The following is the full list of the properties of the class with short descriptions. Click on the links for further details.* | | | | --- | --- | | [CanonicalizationMethod](#canonicalizationmethod-property-xmlsig-class) | The canonicalization method applied to the signature. | | [Certificate](#certificate-property-xmlsig-class) | The certificate used for signing. | | [HMACKey](#hmackey-property-xmlsig-class) | The HMAC key used with the 'HMAC-SHA1' signing algorithm. | | [InputFile](#inputfile-property-xmlsig-class) | The XML file to process. | | [InputXML](#inputxml-property-xmlsig-class) | The XML to process. | | [OutputFile](#outputfile-property-xmlsig-class) | The output file. | | [OutputXML](#outputxml-property-xmlsig-class) | The output XML after processing. | | [Overwrite](#overwrite-property-xmlsig-class) | Indicates whether or not the class should overwrite files. | | [References](#references-property-xmlsig-class) | A collection of references. | | [SignatureXPath](#signaturexpath-property-xmlsig-class) | The XPath of the signature. | | [SignerCert](#signercert-property-xmlsig-class) | The certificate used for signature verification. | | [SigningAlgorithm](#signingalgorithm-property-xmlsig-class) | The signing algorithm. | ## 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](#config-method-xmlsig-class) | Sets or retrieves a configuration setting. | | [DoEvents](#doevents-method-xmlsig-class) | This method processes events from the internal message queue. | | [Reset](#reset-method-xmlsig-class) | Resets the class. | | [SetInputStream](#setinputstream-method-xmlsig-class) | Sets the stream from which the class will read data to sign or verify. | | [SetOutputStream](#setoutputstream-method-xmlsig-class) | The stream to which the class will write the signed or verified XML. | | [Sign](#sign-method-xmlsig-class) | Signs the XML. | | [VerifySignature](#verifysignature-method-xmlsig-class) | Verifies signed 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.* | | | | --- | --- | | [Error](#error-event-xmlsig-class) | Fired when information is available about errors during data delivery. | | [Progress](#progress-event-xmlsig-class) | Fired as progress is made. | | [SignatureInfo](#signatureinfo-event-xmlsig-class) | Fired when a signature is found. | | [Status](#status-event-xmlsig-class) | 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.* | | | | --- | --- | | [KeyName](#KeyName) | The name of the key used to sign the XML. | | [LogLevel](#LogLevel) | Specifies the level of detail that is logged. | | [NormalizeLineEndings](#NormalizeLineEndings) | Whether to normalize line endings when calculating the reference digest. | | [PreserveWhitespace](#PreserveWhitespace) | Whether to preserve whitespace in the signature. | | [ReadFromProgressEvent](#ReadFromProgressEvent) | Whether to read input data from inside the progress event. | | [SignatureRelationship](#SignatureRelationship) | Whether the signature is a child or sibling of the SignatureXPath. | | [SignerCertCount](#SignerCertCount) | The number of parsed signer certificates when verifying a signature. | | [SignerCertEncoded\[i\]](#SignerCertEncoded[i]) | The parsed signer certificate. | | [SignWithCryptoAPI](#SignWithCryptoAPI) | Whether to use the Crypto API for signing operations. | | [WriteToProgressEvent](#WriteToProgressEvent) | Whether to write output data so it is accessible from inside the progress event. | | [BuildInfo](#BuildInfo) | Information about the product's build. | | [CodePage](#CodePage) | The system code page used for Unicode to Multibyte translations. | | [LicenseInfo](#LicenseInfo) | Information about the current license. | | [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. | | [ProcessIdleEvents](#ProcessIdleEvents) | Whether the class uses its internal event loop to process events when the main thread is idle. | | [SelectWaitMillis](#SelectWaitMillis) | The length of time in milliseconds the class will wait when DoEvents is called if there are no events to process. | | [UseFIPSCompliantAPI](#UseFIPSCompliantAPI) | Tells the class whether or not to use FIPS certified APIs. | | [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. | # CanonicalizationMethod Property ([XMLSig](#xmlsig-class) Class) The canonicalization method applied to the signature. ## Syntax ```text ANSI (Cross Platform) int GetCanonicalizationMethod();int SetCanonicalizationMethod(int iCanonicalizationMethod); Unicode (Windows) INT GetCanonicalizationMethod();INT SetCanonicalizationMethod(INT iCanonicalizationMethod); ``` ## Possible Values ```text CM_C14N(0), CM_C14NCOMMENTS(1), CM_C14N11(2), CM_C14N11COMMENTS(3), CM_EXC_C14N(4), CM_EXC_C14NCOMMENTS(5) ``` ## Default Value 0 ## Remarks This property specifies the canonicalization method that is applied to the signature. This may be set before calling [Sign](#sign-method-xmlsig-class). This will be set automatically after calling [VerifySignature](#verifysignature-method-xmlsig-class). Possible values are: | | | | --- | --- | | 0 (cmC14N - default) | Canonical XML version 1.0 | | 1 (cmC14NComments) | Canonical XML version 1.0 with comments | | 2 (cmC14N11) | Canonical XML version 1.1 | | 3 (cmC14N11) | Canonical XML version 1.1 with comments | | 4 (cmExcC14N) | Exclusive XML canonicalization version 1.0 | | 5 (cmExcC14NComments) | Exclusive XML canonicalization version 1.0 with comments | This property is not available at design time. ## Data Type Integer # Certificate Property ([XMLSig](#xmlsig-class) Class) The certificate used for signing. ## Syntax ```text IPWorksEncryptCertificate* GetCertificate(); int SetCertificate(IPWorksEncryptCertificate* val); ``` ## Remarks This property specifies a certificate with private key. This must be set before calling [Sign](#sign-method-xmlsig-class). ## Data Type [IPWorksEncryptCertificate](#certificate-type) # HMACKey Property ([XMLSig](#xmlsig-class) Class) The HMAC key used with the 'HMAC-SHA1' signing algorithm. ## Syntax ```text ANSI (Cross Platform) int GetHMACKey(char* &lpHMACKey, int &lenHMACKey);int SetHMACKey(const char* lpHMACKey, int lenHMACKey); Unicode (Windows) INT GetHMACKey(LPSTR &lpHMACKey, INT &lenHMACKey);INT SetHMACKey(LPCSTR lpHMACKey, INT lenHMACKey); ``` ## Default Value "" ## Remarks This property defines the HMAC key to be used when [SigningAlgorithm](#signingalgorithm-property-xmlsig-class) is set to "HMAC-SHA1". This must be set before calling before calling [Sign](#sign-method-xmlsig-class). This property is also applicable when calling [VerifySignature](#verifysignature-method-xmlsig-class). This may be set before calling [VerifySignature](#verifysignature-method-xmlsig-class) or from within the [SignatureInfo](#signatureinfo-event-xmlsig-class) event. This property is not available at design time. ## Data Type Binary String # InputFile Property ([XMLSig](#xmlsig-class) Class) The XML file to process. ## Syntax ```text ANSI (Cross Platform) char* GetInputFile();int SetInputFile(const char* lpszInputFile); Unicode (Windows) LPWSTR GetInputFile();INT SetInputFile(LPCWSTR lpszInputFile); ``` ## 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](#inputxml-property-xmlsig-class) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [OutputFile](#outputfile-property-xmlsig-class) - [OutputXML](#outputxml-property-xmlsig-class): 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 ([XMLSig](#xmlsig-class) Class) The XML to process. ## Syntax ```text ANSI (Cross Platform) char* GetInputXML();int SetInputXML(const char* lpszInputXML); Unicode (Windows) LPWSTR GetInputXML();INT SetInputXML(LPCWSTR lpszInputXML); ``` ## 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](#inputfile-property-xmlsig-class) - InputXML When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [OutputFile](#outputfile-property-xmlsig-class) - [OutputXML](#outputxml-property-xmlsig-class): 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 ([XMLSig](#xmlsig-class) Class) The output file. ## Syntax ```text ANSI (Cross Platform) char* GetOutputFile();int SetOutputFile(const char* lpszOutputFile); Unicode (Windows) LPWSTR GetOutputFile();INT SetOutputFile(LPCWSTR lpszOutputFile); ``` ## Default Value "" ## Remarks This property specifies the file to which the output will be written. This may be set to an absolute or relative path. **Input and Output Properties** The class will determine the source and destination of the input and output based on which properties are set. The order in which the input properties are checked is as follows: - [InputFile](#inputfile-property-xmlsig-class) - [InputXML](#inputxml-property-xmlsig-class) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - OutputFile - [OutputXML](#outputxml-property-xmlsig-class): 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 ([XMLSig](#xmlsig-class) Class) The output XML after processing. ## Syntax ```text ANSI (Cross Platform) char* GetOutputXML();int SetOutputXML(const char* lpszOutputXML); Unicode (Windows) LPWSTR GetOutputXML();INT SetOutputXML(LPCWSTR lpszOutputXML); ``` ## Default Value "" ## Remarks This property will be populated with the output from the operation if [OutputFile](#outputfile-property-xmlsig-class) is not set. **Input and Output Properties** The class will determine the source and destination of the input and output based on which properties are set. The order in which the input properties are checked is as follows: - [InputFile](#inputfile-property-xmlsig-class) - [InputXML](#inputxml-property-xmlsig-class) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [OutputFile](#outputfile-property-xmlsig-class) - 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 ([XMLSig](#xmlsig-class) Class) Indicates whether or not the class should overwrite files. ## Syntax ```text ANSI (Cross Platform) int GetOverwrite();int SetOverwrite(int bOverwrite); Unicode (Windows) BOOL GetOverwrite();INT SetOverwrite(BOOL bOverwrite); ``` ## Default Value FALSE ## Remarks This property indicates whether or not the class will overwrite [OutputFile](#outputfile-property-xmlsig-class). If Overwrite is False, an error will be thrown whenever [OutputFile](#outputfile-property-xmlsig-class) exists before an operation. The default value is False. ## Data Type Boolean # References Property ([XMLSig](#xmlsig-class) Class) A collection of references. ## Syntax ```text IPWorksEncryptList* GetReferences(); int SetReferences(IPWorksEncryptList* val); ``` ## Remarks This property holds a collection of reference to sign or verify. This must be populated before calling [Sign](#sign-method-xmlsig-class). This will be populated by the class when calling [VerifySignature](#verifysignature-method-xmlsig-class) and is accessible from within the [SignatureInfo](#signatureinfo-event-xmlsig-class) event. This property is not available at design time. ## Data Type [IPWorksEncryptXMLSigReference](#xmlsigreference-type) # SignatureXPath Property ([XMLSig](#xmlsig-class) Class) The XPath of the signature. ## Syntax ```text ANSI (Cross Platform) char* GetSignatureXPath();int SetSignatureXPath(const char* lpszSignatureXPath); Unicode (Windows) LPWSTR GetSignatureXPath();INT SetSignatureXPath(LPCWSTR lpszSignatureXPath); ``` ## Default Value "/" ## Remarks This property specifies the XPath in the XML where the signature will be placed. This may be set before calling [Sign](#sign-method-xmlsig-class). This property will be populated when calling [VerifySignature](#verifysignature-method-xmlsig-class). The default value is "/". This property is not available at design time. ## Data Type String # SignerCert Property ([XMLSig](#xmlsig-class) Class) The certificate used for signature verification. ## Syntax ```text IPWorksEncryptCertificate* GetSignerCert(); int SetSignerCert(IPWorksEncryptCertificate* val); ``` ## Remarks This property specifies a certificate for signature verification. This may be set from within the [SignatureInfo](#signatureinfo-event-xmlsig-class) event after calling [VerifySignature](#verifysignature-method-xmlsig-class). If the signed XML already includes a public key to use for verification, then this property will be automatically populated and does not need to be set. Check the [SignatureInfo](#signatureinfo-event-xmlsig-class) event to determine if a public key was parsed from the signed XML. If a public key was not automatically parsed, set this property to the signer's certificate from within the event. ## Data Type [IPWorksEncryptCertificate](#certificate-type) # SigningAlgorithm Property ([XMLSig](#xmlsig-class) Class) The signing algorithm. ## Syntax ```text ANSI (Cross Platform) char* GetSigningAlgorithm();int SetSigningAlgorithm(const char* lpszSigningAlgorithm); Unicode (Windows) LPWSTR GetSigningAlgorithm();INT SetSigningAlgorithm(LPCWSTR lpszSigningAlgorithm); ``` ## Default Value "" ## Remarks This property specifies the signing algorithm. This may be set before calling [Sign](#sign-method-xmlsig-class). This value will be set after calling [VerifySignature](#verifysignature-method-xmlsig-class). Possible values are: - "RSA-SHA1" (default) - "RSA-SHA256" - "DSA-SHA1" - "HMAC-SHA1" Note: When set to "HMAC-SHA1" [HMACKey](#hmackey-property-xmlsig-class) must also be set. This property is not available at design time. ## Data Type String # Config Method ([XMLSig](#xmlsig-class) Class) Sets or retrieves a configuration setting. ## Syntax ```text ANSI (Cross Platform) char* Config(const char* lpszConfigurationString); Unicode (Windows) LPWSTR Config(LPCWSTR lpszConfigurationString); ``` ## Remarks Config is a generic method available in every class. It is used to set and retrieve [configuration settings](#config-settings-xmlsig-class) 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](#config-settings-xmlsig-class), 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. # DoEvents Method ([XMLSig](#xmlsig-class) Class) This method processes events from the internal message queue. ## Syntax ```text ANSI (Cross Platform) int DoEvents(); Unicode (Windows) 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.) # Reset Method ([XMLSig](#xmlsig-class) Class) Resets the class. ## Syntax ```text ANSI (Cross Platform) int Reset(); Unicode (Windows) 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 ([XMLSig](#xmlsig-class) Class) Sets the stream from which the class will read data to sign or verify. ## Syntax ```text ANSI (Cross Platform) int SetInputStream(IPWorksEncryptStream* sInputStream); Unicode (Windows) INT SetInputStream(IPWorksEncryptStream* sInputStream); ``` ## Remarks This method sets the stream from which the class will read data to sign or verify. If an input stream is set before calling [Sign](#sign-method-xmlsig-class) or [VerifySignature](#verifysignature-method-xmlsig-class), the data is read from the input stream instead of from the [InputFile](#inputfile-property-xmlsig-class) or [InputXML](#inputxml-property-xmlsig-class) 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: - [InputFile](#inputfile-property-xmlsig-class) - [InputXML](#inputxml-property-xmlsig-class) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [OutputFile](#outputfile-property-xmlsig-class) - [OutputXML](#outputxml-property-xmlsig-class): 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 ([XMLSig](#xmlsig-class) Class) The stream to which the class will write the signed or verified XML. ## Syntax ```text ANSI (Cross Platform) int SetOutputStream(IPWorksEncryptStream* sOutputStream); Unicode (Windows) INT SetOutputStream(IPWorksEncryptStream* sOutputStream); ``` ## Remarks This method sets the stream to which the class will write the signed or verified XML. If an output stream is set before calling [Sign](#sign-method-xmlsig-class) or [VerifySignature](#verifysignature-method-xmlsig-class), the class will write the data to the output stream instead of populating [OutputXML](#outputxml-property-xmlsig-class) or writing to [OutputFile](#outputfile-property-xmlsig-class). **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](#inputfile-property-xmlsig-class) - [InputXML](#inputxml-property-xmlsig-class) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [OutputFile](#outputfile-property-xmlsig-class) - [OutputXML](#outputxml-property-xmlsig-class): 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.) # Sign Method ([XMLSig](#xmlsig-class) Class) Signs the XML. ## Syntax ```text ANSI (Cross Platform) int Sign(); Unicode (Windows) INT Sign(); ``` ## Remarks This methods signs the XML. Before calling Sign specify the XML to sign by setting [InputFile](#inputfile-property-xmlsig-class), or [InputXML](#inputxml-property-xmlsig-class). The [References](#references-property-xmlsig-class) property must be set. At least one reference must be set. A reference defines the XML element to sign, and the options that specify how it is transformed and hashed during the signing process. Set [Certificate](#certificate-property-xmlsig-class) to a certificate with private key. Optionally set the [CanonicalizationMethod](#canonicalizationmethod-property-xmlsig-class). This determines how the signature itself is canonicalized. [SigningAlgorithm](#signingalgorithm-property-xmlsig-class) defines the algorithm used to sign. The [SignatureXPath](#signaturexpath-property-xmlsig-class) property may be set to specify the location in the XML document where the signature will be placed. Lastly, call Sign to sign the XML. The following properties are applicable when calling this method: - [CanonicalizationMethod](#canonicalizationmethod-property-xmlsig-class) - [Certificate](#certificate-property-xmlsig-class) (required) - [References](#references-property-xmlsig-class) (required) - [SignatureXPath](#signaturexpath-property-xmlsig-class) - [SigningAlgorithm](#signingalgorithm-property-xmlsig-class) **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](#inputfile-property-xmlsig-class) - [InputXML](#inputxml-property-xmlsig-class) When a valid source is found, the search stops. The order in which the output properties are checked is as follows: - [OutputFile](#outputfile-property-xmlsig-class) - [OutputXML](#outputxml-property-xmlsig-class): 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.) # VerifySignature Method ([XMLSig](#xmlsig-class) Class) Verifies signed XML. ## Syntax ```text ANSI (Cross Platform) int VerifySignature(); Unicode (Windows) INT VerifySignature(); ``` ## Remarks This method verifies signatures contained in the XML. When VerifySignature is called, the class will scan the XML document and fire the [SignatureInfo](#signatureinfo-event-xmlsig-class) event for each signature that is found. When the [SignatureInfo](#signatureinfo-event-xmlsig-class) event fires the [References](#references-property-xmlsig-class) collection will be populated. Within the [SignatureInfo](#signatureinfo-event-xmlsig-class) event the [XMLElement](#XMLSigReference_f_XMLElement) field must be set to the location of the XML element to which the signature applies. The [URI](#XMLSigReference_f_URI) field may contain data helpful to locating the XML element. The [XMLElement](#XMLSigReference_f_XMLElement) field specifies the XPath to the element. 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 signature is verified either using a key parsed from the signed XML, or using the certificate specified by the [SignerCert](#signercert-property-xmlsig-class) property. The class will automatically parse the signer certificate (if present) from the signed XML and populate the [SignerCert](#signercert-property-xmlsig-class) property with the parsed value. When [SignatureInfo](#signatureinfo-event-xmlsig-class) fires, if the *SignerCertParsed* parameter is True the [SignerCert](#signercert-property-xmlsig-class) property may be inspected to see the details of the parsed certificate. If *SignerCertParsed* is False, then the [SignerCert](#signercert-property-xmlsig-class) property must be set to a valid certificate for signature verification to proceed. When the [SignatureInfo](#signatureinfo-event-xmlsig-class) event finishes firing, the certificate present in the [SignerCert](#signercert-property-xmlsig-class) property will be used to verify the signature, whether this is the certificate automatically parsed by the class or a different certificate specified within the event. If the signature was successfully verified the method will return without error. If the signature was not verified the method fails with an error. ## 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.) # Error Event ([XMLSig](#xmlsig-class) Class) Fired when information is available about errors during data delivery. ## Syntax ```text ANSI (Cross Platform) virtual int FireError(XMLSigErrorEventParams *e); typedef struct { int ErrorCode; const char *Description; int reserved; } XMLSigErrorEventParams; Unicode (Windows) virtual INT FireError(XMLSigErrorEventParams *e); typedef struct { INT ErrorCode; LPCWSTR Description; INT reserved; } XMLSigErrorEventParams; ``` ## 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](#trappable-errors-xmlsig-class) section. # Progress Event ([XMLSig](#xmlsig-class) Class) Fired as progress is made. ## Syntax ```text ANSI (Cross Platform) virtual int FireProgress(XMLSigProgressEventParams *e); typedef struct { int64 BytesProcessed; int PercentProcessed; int Operation; int IsEOF; int reserved; } XMLSigProgressEventParams; Unicode (Windows) virtual INT FireProgress(XMLSigProgressEventParams *e); typedef struct { LONG64 BytesProcessed; INT PercentProcessed; INT Operation; BOOL IsEOF; INT reserved; } XMLSigProgressEventParams; ``` ## 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](#ReadFromProgressEvent) or [WriteToProgressEvent](#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](#ReadFromProgressEvent) or [WriteToProgressEvent](#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. # SignatureInfo Event ([XMLSig](#xmlsig-class) Class) Fired when a signature is found. ## Syntax ```text ANSI (Cross Platform) virtual int FireSignatureInfo(XMLSigSignatureInfoEventParams *e); typedef struct { const char *SignatureId; int SignerCertParsed; int reserved; } XMLSigSignatureInfoEventParams; Unicode (Windows) virtual INT FireSignatureInfo(XMLSigSignatureInfoEventParams *e); typedef struct { LPCWSTR SignatureId; BOOL SignerCertParsed; INT reserved; } XMLSigSignatureInfoEventParams; ``` ## Remarks This event fires when calling [VerifySignature](#verifysignature-method-xmlsig-class) for each signature found within the XML document. *SignatureId* is the id of the signature. *SignerCertParsed* indicates whether the signer's certificate was automatically parsed from the signed XML. **Verification Notes** When [VerifySignature](#verifysignature-method-xmlsig-class) is called, the class will scan the XML document and fire the SignatureInfo event for each signature that is found. When the SignatureInfo event fires the [References](#references-property-xmlsig-class) collection will be populated. Within the SignatureInfo event the [XMLElement](#XMLSigReference_f_XMLElement) field must be set to the location of the XML element to which the signature applies. The [URI](#XMLSigReference_f_URI) field may contain data helpful to locating the XML element. The [XMLElement](#XMLSigReference_f_XMLElement) field specifies the XPath to the element. 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 signature is verified either using a key parsed from the signed XML, or using the certificate specified by the [SignerCert](#signercert-property-xmlsig-class) property. The class will automatically parse the signer certificate (if present) from the signed XML and populate the [SignerCert](#signercert-property-xmlsig-class) property with the parsed value. When SignatureInfo fires, if the *SignerCertParsed* parameter is True the [SignerCert](#signercert-property-xmlsig-class) property may be inspected to see the details of the parsed certificate. If *SignerCertParsed* is False, then the [SignerCert](#signercert-property-xmlsig-class) property must be set to a valid certificate for signature verification to proceed. When the SignatureInfo event finishes firing, the certificate present in the [SignerCert](#signercert-property-xmlsig-class) property will be used to verify the signature, whether this is the certificate automatically parsed by the class or a different certificate specified within the event. If the signature was successfully verified the method will return without error. If the signature was not verified the method fails with an error. # Status Event ([XMLSig](#xmlsig-class) Class) Provides information about the current operation. ## Syntax ```text ANSI (Cross Platform) virtual int FireStatus(XMLSigStatusEventParams *e); typedef struct { const char *Message; int reserved; } XMLSigStatusEventParams; Unicode (Windows) virtual INT FireStatus(XMLSigStatusEventParams *e); typedef struct { LPCWSTR Message; INT reserved; } XMLSigStatusEventParams; ``` ## 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](#LogLevel) setting. # Certificate Type This is the digital certificate being used. ## Syntax *IPWorksEncryptCertificate* (declared in *ipworksencrypt.h*) ## Remarks This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates. The following fields are available: - [EffectiveDate](#Certificate_f_EffectiveDate) - [ExpirationDate](#Certificate_f_ExpirationDate) - [ExtendedKeyUsage](#Certificate_f_ExtendedKeyUsage) - [Fingerprint](#Certificate_f_Fingerprint) - [FingerprintSHA1](#Certificate_f_FingerprintSHA1) - [FingerprintSHA256](#Certificate_f_FingerprintSHA256) - [Issuer](#Certificate_f_Issuer) - [PrivateKey](#Certificate_f_PrivateKey) - [PrivateKeyAvailable](#Certificate_f_PrivateKeyAvailable) - [PrivateKeyContainer](#Certificate_f_PrivateKeyContainer) - [PublicKey](#Certificate_f_PublicKey) - [PublicKeyAlgorithm](#Certificate_f_PublicKeyAlgorithm) - [PublicKeyLength](#Certificate_f_PublicKeyLength) - [SerialNumber](#Certificate_f_SerialNumber) - [SignatureAlgorithm](#Certificate_f_SignatureAlgorithm) - [Store](#Certificate_f_Store) - [StorePassword](#Certificate_f_StorePassword) - [StoreType](#Certificate_f_StoreType) - [SubjectAltNames](#Certificate_f_SubjectAltNames) - [ThumbprintMD5](#Certificate_f_ThumbprintMD5) - [ThumbprintSHA1](#Certificate_f_ThumbprintSHA1) - [ThumbprintSHA256](#Certificate_f_ThumbprintSHA256) - [Usage](#Certificate_f_Usage) - [UsageFlags](#Certificate_f_UsageFlags) - [Version](#Certificate_f_Version) - [Subject](#Certificate_f_Subject) - [Encoded](#Certificate_f_Encoded) ## Fields **EffectiveDate** *char* (read-only)* *Default Value: ""* The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2000 15:00:00. **ExpirationDate** *char* (read-only)* *Default Value: ""* The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2001 15:00:00. **ExtendedKeyUsage** *char* (read-only)* *Default Value: ""* A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). **Fingerprint** *char* (read-only)* *Default Value: ""* The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02* **FingerprintSHA1** *char* (read-only)* *Default Value: ""* The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84* **FingerprintSHA256** *char* (read-only)* *Default Value: ""* The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53* **Issuer** *char* (read-only)* *Default Value: ""* The issuer of the certificate. This field contains a string representation of the name of the issuing authority for the certificate. **PrivateKey** *char* (read-only)* *Default Value: ""* The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [PrivateKey](#Certificate_f_PrivateKey) may be available but not exportable. In this case, [PrivateKey](#Certificate_f_PrivateKey) returns an empty string. **PrivateKeyAvailable** *int (read-only)* *Default Value: FALSE* Whether a [PrivateKey](#Certificate_f_PrivateKey) is available for the selected certificate. If [PrivateKeyAvailable](#Certificate_f_PrivateKeyAvailable) is True, the certificate may be used for authentication purposes (e.g., server authentication). **PrivateKeyContainer** *char* (read-only)* *Default Value: ""* The name of the [PrivateKey](#Certificate_f_PrivateKey) container for the certificate (if available). This functionality is available only on Windows platforms. **PublicKey** *char* (read-only)* *Default Value: ""* The public key of the certificate. The key is provided as PEM/Base64-encoded data. **PublicKeyAlgorithm** *char* (read-only)* *Default Value: ""* The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm. **PublicKeyLength** *int (read-only)* *Default Value: 0* The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. **SerialNumber** *char* (read-only)* *Default Value: ""* The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number. **SignatureAlgorithm** *char* (read-only)* *Default Value: ""* The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm. **Store** *char** *Default Value: "MY"* The name of the certificate store for the client certificate. The [StoreType](#Certificate_f_StoreType) field denotes the type of the certificate store specified by [Store](#Certificate_f_Store). If the store is password-protected, specify the password in [StorePassword](#Certificate_f_StorePassword). [Store](#Certificate_f_Store) is used in conjunction with the [Subject](#Certificate_f_Subject) field to specify client certificates. If [Store](#Certificate_f_Store) has a value, and [Subject](#Certificate_f_Subject) or [Encoded](#Certificate_f_Encoded) is set, a search for a certificate is initiated. Please see the [Subject](#Certificate_f_Subject) field 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 *cstPFXFile*, this property must be set to the name of the file. When the type is *cstPFXBlob*, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store). **StorePassword** *char** *Default Value: ""* If the type of certificate store requires a password, this field is used to specify the password needed to open the certificate store. **StoreType** *int* *Default Value: 0* 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 field can take one of the following values: ```csharp sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll", "123456", // PIN "CN=cert_subject"); sftp.SSHUser = "test"; sftp.SSHLogon("myhost", 22); ``` ```csharp 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); ``` | | | | --- | --- | | 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, create a new [Certificate](#certificate-type) object and pass cstPKCS11 as the [StoreType](#Certificate_f_StoreType), the full path of the PKCS#11 DLL as the [Store](#Certificate_f_Store), and the PIN as the [StorePassword](#Certificate_f_StorePassword). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](CertMgr.md#CertMgr) class by calling the [ListStoreCertificates](CertMgr.md#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](CertMgr.md#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [Store](#Certificate_f_Store) and set [StorePassword](#Certificate_f_StorePassword) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): | | 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. | **SubjectAltNames** *char* (read-only)* *Default Value: ""* Comma-separated lists of alternative subject names for the certificate. **ThumbprintMD5** *char* (read-only)* *Default Value: ""* The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. **ThumbprintSHA1** *char* (read-only)* *Default Value: ""* The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. **ThumbprintSHA256** *char* (read-only)* *Default Value: ""* The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. **Usage** *char* (read-only)* *Default Value: ""* The text description of [UsageFlags](#Certificate_f_UsageFlags). This value will be one or more of the following strings and will be separated by commas: - Digital Signature - Non-Repudiation - Key Encipherment - Data Encipherment - Key Agreement - Certificate Signing - CRL Signing - Encipher Only If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names. **UsageFlags** *int (read-only)* *Default Value: 0* The flags that show intended use for the certificate. The value of [UsageFlags](#Certificate_f_UsageFlags) is a combination of the following flags: | | | | --- | --- | | 0x80 | Digital Signature | | 0x40 | Non-Repudiation | | 0x20 | Key Encipherment | | 0x10 | Data Encipherment | | 0x08 | Key Agreement | | 0x04 | Certificate Signing | | 0x02 | CRL Signing | | 0x01 | Encipher Only | Please see the [Usage](#Certificate_f_Usage) field for a text representation of [UsageFlags](#Certificate_f_UsageFlags). This functionality currently is not available when the provider is OpenSSL. **Version** *char* (read-only)* *Default Value: ""* The certificate's version number. The possible values are the strings "V1", "V2", and "V3". **Subject** *char** *Default Value: ""* 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 field 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=example@email.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. **Encoded** *char** *Default Value: ""* The certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The [Store](#Certificate_f_Store) and [Subject](#Certificate_f_Subject) fields also may be used to specify a certificate. When [Encoded](#Certificate_f_Encoded) is set, a search is initiated in the current [Store](#Certificate_f_Store) for the private key of the certificate. If the key is found, [Subject](#Certificate_f_Subject) is updated to reflect the full subject of the selected certificate; otherwise, [Subject](#Certificate_f_Subject) is set to an empty string. ## Constructors ```text Certificate() ``` Creates a instance whose properties can be set. ```text Certificate(const char* lpEncoded, int lenEncoded) ``` Parses * Encoded * as an X.509 public key. ```text Certificate(int iStoreType, const char* lpStore, int lenStore, const char* lpszStorePassword, const char* lpszSubject) ``` * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a byte array containing the certificate data. * StorePassword * is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format. # XMLSigReference Type This type defines information about the reference. ## Syntax *IPWorksEncryptXMLSigReference* (declared in *ipworksencrypt.h*) ## Remarks This type defines information about the reference including the location within the document ([XMLElement](#XMLSigReference_f_XMLElement)), [TransformAlgorithms](#XMLSigReference_f_TransformAlgorithms), [HashAlgorithm](#XMLSigReference_f_HashAlgorithm), and [URI](#XMLSigReference_f_URI). The following fields are available: - [HashAlgorithm](#XMLSigReference_f_HashAlgorithm) - [HashValue](#XMLSigReference_f_HashValue) - [TransformAlgorithms](#XMLSigReference_f_TransformAlgorithms) - [URI](#XMLSigReference_f_URI) - [XMLElement](#XMLSigReference_f_XMLElement) ## Fields **HashAlgorithm** *char** *Default Value: "SHA1"* This field defines the hash algorithm to apply to the element specified by [XMLElement](#XMLSigReference_f_XMLElement). Possible values are: - "SHA1" (default) - "SHA256" - "SHA512" **HashValue** *char* (read-only)* *Default Value: ""* This field holds the calculated hash value for the specified [XMLElement](#XMLSigReference_f_XMLElement). **TransformAlgorithms** *char** *Default Value: "C14N"* This field specifies a comma separated list of canonicalization algorithms to be applied to [XMLElement](#XMLSigReference_f_XMLElement). The XML data specified by [XMLElement](#XMLSigReference_f_XMLElement) will be transformed using the specified algorithm(s) before the [HashAlgorithm](#XMLSigReference_f_HashAlgorithm) is applied. The default value is "C14N". Possible values are: | | | | --- | --- | | "C14N" | Canonical XML version 1.0 | | "C14N_COMMENTS" | Canonical XML version 1.0 with comments | | "C14N11" | Canonical XML version 1.1 | | "C14N11_COMMENTS" | Canonical XML version 1.1 with comments | | "EXC_C14N" | Exclusive XML canonicalization version 1.0 | | "EXC_C14N_COMMENTS" | Exclusive XML canonicalization version 1.0 with comments | **URI** *char** *Default Value: ""* This field is the URI of the reference. The value specified here identifies the data within the document. When signing, this value may be set to a URI reference which identifies [XMLElement](#XMLSigReference_f_XMLElement). [XMLElement](#XMLSigReference_f_XMLElement) must be set separately. When verifying, this value may be checked within the [SignatureInfo](#signatureinfo-event-xmlsig-class) event to identify the location of [XMLElement](#XMLSigReference_f_XMLElement). [XMLElement](#XMLSigReference_f_XMLElement) must be set separately. **XMLElement** *char** *Default Value: "/"* This field specifies XML element to sign or verify using XPath notation. When signing, this must be set before calling [Sign](#sign-method-xmlsig-class). When verifying, this must be set from within the [SignatureInfo](#signatureinfo-event-xmlsig-class) event. The [URI](#XMLSigReference_f_URI) field may be used to help identify the correct XML element. | | | | --- | --- | | /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 | ## Constructors ```text XMLSigReference() ``` ```text XMLSigReference(const char* lpszXMLElement, const char* lpszURI, const char* lpszHashAlgorithm, const char* lpszTransformAlgorithms, const char* lpszHashValue) ``` # IPWorksEncryptList Type ## Syntax *IPWorksEncryptList* (declared in *ipworksencrypt.h*) ## Remarks *IPWorksEncryptList* is a generic class that is used to hold a collection of objects of type *T*, where *T* is one of the custom types supported by the XMLSig class. ```text int GetCount() {} ``` ```text int SetCount(int count) {} ``` ```text T* Get(int index) {} ``` ```text T* Set(int index, T* value) {} ``` | | | | --- | --- | | Methods | | | GetCount | This method returns the current size of the collection. | | SetCount | This method sets the size of the collection. This method returns 0 if setting the size was successful; or -1 if the collection is ReadOnly. When adding additional objects to a collection call this method to specify the new size. Increasing the size of the collection preserves existing objects in the collection. | | Get | This method gets the item at the specified position. The index parameter specifies the index of the item in the collection. This method returns NULL if an invalid index is specified. | | Set | This method sets the item at the specified position. The index parameter specifies the index of the item in the collection that is being set. This method returns -1 if an invalid index is specified. Note: Objects created using the new operator must be freed using the delete operator; they will not be automatically freed by the class. | # IPWorksEncryptStream Type ## Syntax *IPWorksEncryptStream* (declared in *ipworksencrypt.h*) ## Remarks The XMLSig 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 XMLSig 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. ```text bool CanRead() { return true; } ``` ```text bool CanSeek() { return true; } ``` ```text bool CanWrite() { return true; } ``` ```text int64 GetLength() = 0; ``` ```text void Close() {} ``` ```text int Flush() { return 0; } ``` ```text int Read(void* buffer, int count) = 0; ``` ```text int64 Seek(int64 offset, int seekOrigin) = 0; ``` ```text int Write(const void* buffer, int count) = 0; ``` | | | | --- | --- | | Properties | | | CanRead | Whether the stream supports reading. | | CanSeek | Whether the stream supports seeking. | | CanWrite | Whether the stream supports writing. | | Length | Gets the length of the stream, in bytes. | | Methods | | | Close | Closes the stream, releasing all resources currently allocated for it. 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. 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. 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. Offset specifies the offset in the stream to seek to, relative to SeekOrigin. Valid values for SeekOrigin are: 0: Seek from beginning. 1: Seek from current position. 2: Seek from end. 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. 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 ([XMLSig](#xmlsig-class) 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](#config-method-xmlsig-class) method. ### XMLSig Config Settings **KeyName**: The name of the key used to sign the XML.This setting optionally holds the key name which may be useful to the recipient to help identify the key used to create the signature. This may be set before calling [Sign](#sign-method-xmlsig-class). When calling [VerifySignature](#verifysignature-method-xmlsig-class) this may be queried inside the [SignatureInfo](#signatureinfo-event-xmlsig-class) 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](#status-event-xmlsig-class) 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. | **NormalizeLineEndings**: Whether to normalize line endings when calculating the reference digest.This setting specifies whether to normalize line endings when calculating the reference digest. When set to True all line endings will be converted to LF. The default value is True. **PreserveWhitespace**: Whether to preserve whitespace in the signature.This setting specifies whether whitespace is preserved when canonicalizing XML. The default value is False. **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](#progress-event-xmlsig-class) event. The class will repeatedly fire the [Progress](#progress-event-xmlsig-class) event to ask for data. Inside the event set [InputXML](#inputxml-property-xmlsig-class) 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. **SignatureRelationship**: Whether the signature is a child or sibling of the SignatureXPath. This setting specifies whether the created signature is included as a child or sibling of the element specified by [SignatureXPath](#signaturexpath-property-xmlsig-class). If this is set to 0 (default), the signature is inserted as a child of the element. If this is set to 1, the signature is inserted as a sibling after the element. The default value is 0 (child). Example: SignatureRelationship is set to 0 (child - default) ```text xmlsig1.SignatureXPath = "/root/node1"; ``` Produces XML like: ```text ... ``` Example: SignatureRelationship is set to 1 (sibling) ```text xmlsig1.SignatureXPath = "/root/node1"; xmlsig1.Config("SignatureRelationship=1"); ``` Produces XML like: ```text ... ``` **SignerCertCount**: The number of parsed signer certificates when verifying a signature.This setting is populated when calling [VerifySignature](#verifysignature-method-xmlsig-class). It holds the number of signer certificates that were parsed from the message. In most cases a single certificate is present and [SignerCert](#signercert-property-xmlsig-class) is populated. In some cases, multiple certificates in a chain may be present, in that case each parsed certificate can be accessed via this property and [SignerCertEncoded](#SignerCertEncoded). For instance: ```text int certCount = Int32.Parse(xmlsig.Config("SignerCertCount")); for(int i=0;i