XMLSig Component

Properties   Methods   Events   Config Settings   Errors  

The XMLSig component is used to sign XML and verify signed XML.

Syntax

TipcXMLSig

Remarks

The XMLSig component provides an easy to use API for signing and verifying signed XML. The Sign method will create signed XML with an enveloped signature. The VerifySignature method will attempt to verify the signature(s) within a XML document.

Sign

Before calling Sign specify the XML to sign by setting InputFile, or InputXML.

The Reference* properties 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 to a certificate with private key.

Optionally set the CanonicalizationMethod. This determines how the signature itself is canonicalized. SigningAlgorithm defines the algorithm used to sign. The SignatureXPath 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
• Certificate (required)
• Reference* (required)
• SignatureXPath
• SigningAlgorithm

Input and Output Properties

The component 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.

Verify a Signature

When VerifySignature is called, the component will scan the XML document and fire the SignatureInfo event for each signature that is found. When the SignatureInfo event fires the Reference* properties will be populated.

Within the SignatureInfo event the ReferenceXMLElement property must be set to the location of the XML element to which the signature applies. The ReferenceURI property may contain data helpful to locating the XML element.

The ReferenceXMLElement property specifies the XPath to the element. For instance:

The signature is verified either using a key parsed from the signed XML, or using the certificate specified by the SignerCert* properties. The component will automatically parse the signer certificate (if present) from the signed XML and populate the SignerCert* properties with the parsed value.

When SignatureInfo fires, if the SignerCertParsed parameter is True the SignerCert* properties may be inspected to see the details of the parsed certificate. If SignerCertParsed is False, then the SignerCert* properties must be set to a valid certificate for signature verification to proceed.

When the SignatureInfo event finishes firing, the certificate present in the SignerCert* properties will be used to verify the signature, whether this is the certificate automatically parsed by the component 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 raises an exception.

Property List

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

Method List

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

Event List

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

Config Settings

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

CanonicalizationMethod Property (XMLSig Component)

The canonicalization method applied to the signature.

Syntax

__property TipcXMLSigCanonicalizationMethods CanonicalizationMethod = { read=FCanonicalizationMethod, write=FSetCanonicalizationMethod };

enum TipcXMLSigCanonicalizationMethods {
  cmC14N=0,
  cmC14NComments=1,
  cmC14N11=2,
  cmC14N11Comments=3,
  cmExcC14N=4,
  cmExcC14NComments=5
};

Default Value

cmC14N

Remarks

This property specifies the canonicalization method that is applied to the signature. This may be set before calling Sign. This will be set automatically after calling VerifySignature. Possible values are:

This property is not available at design time.

Data Type

Integer

CertEncoded Property (XMLSig Component)

This is the certificate (PEM/base64 encoded).

Syntax

__property String CertEncoded = { read=FCertEncoded, write=FSetCertEncoded };
__property DynamicArray<Byte> CertEncodedB = { read=FCertEncodedB, write=FSetCertEncodedB };

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

Byte Array

CertStore Property (XMLSig Component)

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

Syntax

__property String CertStore = { read=FCertStore, write=FSetCertStore };
__property DynamicArray<Byte> CertStoreB = { read=FCertStoreB, write=FSetCertStoreB };

Default Value

"MY"

Remarks

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

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

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

Designations of certificate stores are platform-dependent.

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

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

Data Type

Byte Array

CertStorePassword Property (XMLSig Component)

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

Syntax

__property String CertStorePassword = { read=FCertStorePassword, write=FSetCertStorePassword };

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 (XMLSig Component)

This is the type of certificate store for this certificate.

Syntax

__property TipcXMLSigCertStoreTypes CertStoreType = { read=FCertStoreType, write=FSetCertStoreType };

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

Default Value

cstUser

Remarks

This is the type of certificate store for this certificate.

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

Data Type

Integer

CertSubject Property (XMLSig Component)

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

Syntax

__property String CertSubject = { read=FCertSubject, write=FSetCertSubject };

Default Value

""

Remarks

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

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

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

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

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

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

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

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

Data Type

String

HMACKey Property (XMLSig Component)

The HMAC key used with the 'HMAC-SHA1' signing algorithm.

Syntax

__property String HMACKey = { read=FHMACKey, write=FSetHMACKey };
__property DynamicArray<Byte> HMACKeyB = { read=FHMACKeyB, write=FSetHMACKeyB };

Default Value

""

Remarks

This property defines the HMAC key to be used when SigningAlgorithm is set to "HMAC-SHA1". This must be set before calling before calling Sign.

This property is also applicable when calling VerifySignature. This may be set before calling VerifySignature or from within the SignatureInfo event.

This property is not available at design time.

Data Type

Byte Array

InputFile Property (XMLSig Component)

The XML file to process.

Syntax

__property String InputFile = { read=FInputFile, write=FSetInputFile };

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 component 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 (XMLSig Component)

The XML to process.

Syntax

__property String InputXML = { read=FInputXML, write=FSetInputXML };

Default Value

""

Remarks

This property specifies the XML to be processed.

Input and Output Properties

The component 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 (XMLSig Component)

The output file.

Syntax

__property String OutputFile = { read=FOutputFile, write=FSetOutputFile };

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

OutputXML Property (XMLSig Component)

The output XML after processing.

Syntax

__property String OutputXML = { read=FOutputXML, write=FSetOutputXML };

Default Value

""

Remarks

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

Input and Output Properties

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

Overwrite Property (XMLSig Component)

Indicates whether or not the component should overwrite files.

Syntax

__property bool Overwrite = { read=FOverwrite, write=FSetOverwrite };

Default Value

false

Remarks

This property indicates whether or not the component 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

ReferenceCount Property (XMLSig Component)

The number of records in the Reference arrays.

Syntax

__property int ReferenceCount = { read=FReferenceCount, write=FSetReferenceCount };

Default Value

0

Remarks

This property controls the size of the following arrays:

• ReferenceHashAlgorithm
• ReferenceHashValue
• ReferenceTransformAlgorithms
• ReferenceURI
• ReferenceXMLElement

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

This property is not available at design time.

Data Type

Integer

ReferenceHashAlgorithm Property (XMLSig Component)

This property defines the hash algorithm to apply to the element specified by XMLElement .

Syntax

__property String ReferenceHashAlgorithm[int ReferenceIndex] = { read=FReferenceHashAlgorithm, write=FSetReferenceHashAlgorithm };

Default Value

"SHA1"

Remarks

This property defines the hash algorithm to apply to the element specified by ReferenceXMLElement. Possible values are:

• "SHA1" (default)
• "SHA256"
• "SHA512"

The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

This property is not available at design time.

Data Type

String

ReferenceHashValue Property (XMLSig Component)

This property holds the calculated hash value for the specified XMLElement .

Syntax

__property String ReferenceHashValue[int ReferenceIndex] = { read=FReferenceHashValue };

Default Value

""

Remarks

This property holds the calculated hash value for the specified ReferenceXMLElement.

The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

This property is read-only and not available at design time.

Data Type

String

ReferenceTransformAlgorithms Property (XMLSig Component)

This property specifies a comma separated list of canonicalization algorithms to be applied to XMLElement .

Syntax

__property String ReferenceTransformAlgorithms[int ReferenceIndex] = { read=FReferenceTransformAlgorithms, write=FSetReferenceTransformAlgorithms };

Default Value

"C14N"

Remarks

This property specifies a comma separated list of canonicalization algorithms to be applied to ReferenceXMLElement. The XML data specified by ReferenceXMLElement will be transformed using the specified algorithm(s) before the HashAlgorithm is applied. The default value is "C14N". Possible values are:

The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

This property is not available at design time.

Data Type

String

ReferenceURI Property (XMLSig Component)

This property is the URI of the reference.

Syntax

__property String ReferenceURI[int ReferenceIndex] = { read=FReferenceURI, write=FSetReferenceURI };

Default Value

""

Remarks

This property 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 ReferenceXMLElement. ReferenceXMLElement must be set separately.

When verifying, this value may be checked within the SignatureInfo event to identify the location of ReferenceXMLElement. ReferenceXMLElement must be set separately.

The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

This property is not available at design time.

Data Type

String

ReferenceXMLElement Property (XMLSig Component)

This property specifies XML element to sign or verify using XPath notation.

Syntax

__property String ReferenceXMLElement[int ReferenceIndex] = { read=FReferenceXMLElement, write=FSetReferenceXMLElement };

Default Value

"/"

Remarks

This property specifies XML element to sign or verify using XPath notation. When signing, this must be set before calling Sign. When verifying, this must be set from within the SignatureInfo event. The ReferenceURI property may be used to help identify the correct XML element.

The ReferenceIndex parameter specifies the index of the item in the array. The size of the array is controlled by the ReferenceCount property.

This property is not available at design time.

Data Type

String

SignatureXPath Property (XMLSig Component)

The XPath of the signature.

Syntax

__property String SignatureXPath = { read=FSignatureXPath, write=FSetSignatureXPath };

Default Value

"/"

Remarks

This property specifies the XPath in the XML where the signature will be placed.

This may be set before calling Sign. This property will be populated when calling VerifySignature.

The default value is "/".

This property is not available at design time.

Data Type

String

SignerCertEncoded Property (XMLSig Component)

This is the certificate (PEM/base64 encoded).

Syntax

__property String SignerCertEncoded = { read=FSignerCertEncoded, write=FSetSignerCertEncoded };
__property DynamicArray<Byte> SignerCertEncodedB = { read=FSignerCertEncodedB, write=FSetSignerCertEncodedB };

Default Value

""

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SignerCertStore and SignerCertSubject properties also may be used to specify a certificate.

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

This property is not available at design time.

Data Type

Byte Array

SignerCertStore Property (XMLSig Component)

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

Syntax

__property String SignerCertStore = { read=FSignerCertStore, write=FSetSignerCertStore };
__property DynamicArray<Byte> SignerCertStoreB = { read=FSignerCertStoreB, write=FSetSignerCertStoreB };

Default Value

"MY"

Remarks

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

The SignerCertStoreType property denotes the type of the certificate store specified by SignerCertStore. If the store is password protected, specify the password in SignerCertStorePassword.

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

Designations of certificate stores are platform-dependent.

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

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

Data Type

Byte Array

SignerCertStorePassword Property (XMLSig Component)

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

Syntax

__property String SignerCertStorePassword = { read=FSignerCertStorePassword, write=FSetSignerCertStorePassword };

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

SignerCertStoreType Property (XMLSig Component)

This is the type of certificate store for this certificate.

Syntax

__property TipcXMLSigSignerCertStoreTypes SignerCertStoreType = { read=FSignerCertStoreType, write=FSetSignerCertStoreType };

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

Default Value

cstUser

Remarks

This is the type of certificate store for this certificate.

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

Data Type

Integer

SignerCertSubject Property (XMLSig Component)

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

Syntax

__property String SignerCertSubject = { read=FSignerCertSubject, write=FSetSignerCertSubject };

Default Value

""

Remarks

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

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

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

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

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

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

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

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

Data Type

String

SigningAlgorithm Property (XMLSig Component)

The signing algorithm.

Syntax

__property String SigningAlgorithm = { read=FSigningAlgorithm, write=FSetSigningAlgorithm };

Default Value

""

Remarks

This property specifies the signing algorithm.

This may be set before calling Sign. This value will be set after calling VerifySignature. Possible values are:

• "RSA-SHA1" (default)
• "RSA-SHA256"
• "DSA-SHA1"
• "HMAC-SHA1"

This property is not available at design time.

Data Type

String

Config Method (XMLSig Component)

Sets or retrieves a configuration setting.

Syntax

String __fastcall Config(String ConfigurationString);

Remarks

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

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

DoEvents Method (XMLSig Component)

Processes events from the internal message queue.

Syntax

void __fastcall DoEvents();

Remarks

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

Reset Method (XMLSig Component)

Resets the component.

Syntax

void __fastcall Reset();

Remarks

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

Sign Method (XMLSig Component)

Signs the XML.

Syntax

void __fastcall Sign();

Remarks

This methods signs the XML.

Before calling Sign specify the XML to sign by setting InputFile, or InputXML.

The Reference* properties 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 to a certificate with private key.

Optionally set the CanonicalizationMethod. This determines how the signature itself is canonicalized. SigningAlgorithm defines the algorithm used to sign. The SignatureXPath 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
• Certificate (required)
• Reference* (required)
• SignatureXPath
• SigningAlgorithm

Input and Output Properties

The component 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.

VerifySignature Method (XMLSig Component)

Verifies signed XML.

Syntax

void __fastcall VerifySignature();

Remarks

This method verifies signatures contained in the XML.

When VerifySignature is called, the component will scan the XML document and fire the SignatureInfo event for each signature that is found. When the SignatureInfo event fires the Reference* properties will be populated.

Within the SignatureInfo event the ReferenceXMLElement property must be set to the location of the XML element to which the signature applies. The ReferenceURI property may contain data helpful to locating the XML element.

The ReferenceXMLElement property specifies the XPath to the element. For instance:

The signature is verified either using a key parsed from the signed XML, or using the certificate specified by the SignerCert* properties. The component will automatically parse the signer certificate (if present) from the signed XML and populate the SignerCert* properties with the parsed value.

When SignatureInfo fires, if the SignerCertParsed parameter is True the SignerCert* properties may be inspected to see the details of the parsed certificate. If SignerCertParsed is False, then the SignerCert* properties must be set to a valid certificate for signature verification to proceed.

When the SignatureInfo event finishes firing, the certificate present in the SignerCert* properties will be used to verify the signature, whether this is the certificate automatically parsed by the component 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 raises an exception.

Error Event (XMLSig Component)

Information about errors during data delivery.

Syntax

typedef struct {
  int ErrorCode;
  String Description;
} TipcXMLSigErrorEventParams;
typedef void __fastcall (__closure *TipcXMLSigErrorEvent)(System::TObject* Sender, TipcXMLSigErrorEventParams *e);
__property TipcXMLSigErrorEvent OnError = { read=FOnError, write=FOnError };

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component raises an exception.

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

Progress Event (XMLSig Component)

Fired as progress is made.

Syntax

typedef struct {
  __int64 BytesProcessed;
  int PercentProcessed;
  int Operation;
  bool IsEOF;
} TipcXMLSigProgressEventParams;
typedef void __fastcall (__closure *TipcXMLSigProgressEvent)(System::TObject* Sender, TipcXMLSigProgressEventParams *e);
__property TipcXMLSigProgressEvent OnProgress = { read=FOnProgress, write=FOnProgress };

Remarks

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

The PercentProcessed parameter indicates the current status of the operation.

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

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

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

SignatureInfo Event (XMLSig Component)

Fired when a signature is found.

Syntax

typedef struct {
  String SignatureId;
  bool SignerCertParsed;
} TipcXMLSigSignatureInfoEventParams;
typedef void __fastcall (__closure *TipcXMLSigSignatureInfoEvent)(System::TObject* Sender, TipcXMLSigSignatureInfoEventParams *e);
__property TipcXMLSigSignatureInfoEvent OnSignatureInfo = { read=FOnSignatureInfo, write=FOnSignatureInfo };

Remarks

This event fires when calling VerifySignature 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 is called, the component will scan the XML document and fire the SignatureInfo event for each signature that is found. When the SignatureInfo event fires the Reference* properties will be populated.

Within the SignatureInfo event the ReferenceXMLElement property must be set to the location of the XML element to which the signature applies. The ReferenceURI property may contain data helpful to locating the XML element.

The ReferenceXMLElement property specifies the XPath to the element. For instance:

The signature is verified either using a key parsed from the signed XML, or using the certificate specified by the SignerCert* properties. The component will automatically parse the signer certificate (if present) from the signed XML and populate the SignerCert* properties with the parsed value.

When SignatureInfo fires, if the SignerCertParsed parameter is True the SignerCert* properties may be inspected to see the details of the parsed certificate. If SignerCertParsed is False, then the SignerCert* properties must be set to a valid certificate for signature verification to proceed.

When the SignatureInfo event finishes firing, the certificate present in the SignerCert* properties will be used to verify the signature, whether this is the certificate automatically parsed by the component 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 raises an exception.

Status Event (XMLSig Component)

Provides information about the current operation.

Syntax

typedef struct {
  String Message;
} TipcXMLSigStatusEventParams;
typedef void __fastcall (__closure *TipcXMLSigStatusEvent)(System::TObject* Sender, TipcXMLSigStatusEventParams *e);
__property TipcXMLSigStatusEvent OnStatus = { read=FOnStatus, write=FOnStatus };

Remarks

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

The level of detail is controlled by the LogLevel setting.

Config Settings (XMLSig Component)

<root>
  <node1>
    <ds:Signature>...</ds:Signature>
  </node1>
  <node2></node2>
  <node3></node3>
</root>

<root>
  <node1></node1>
  <ds:Signature>...</ds:Signature>
  <node2></node2>
  <node3></node3>
</root>

Trappable Errors (XMLSig Component)

XMLSig Errors

	602   Unsupported value. Check the description for details.
	603   Failed to match the digest value during signature verification.
	604   Signature verification failed.
	605   Could not find the referenced element.
	606   No valid signature was found in the document.
	607   Failed to write output.
	608   Invalid SignatureXPath value.
	611   Failed parsing certificate data.

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.