# XMLSig Component The XMLSig component is used to sign XML and verify signed XML. ## Syntax ```text TipcXMLSig ``` ## Remarks The XMLSig component provides an easy to use API for signing and verifying signed XML. The [Sign](#sign-method-xmlsig-component) method will create signed XML with an enveloped signature. The [VerifySignature](#verifysignature-method-xmlsig-component) method will attempt to verify the signature(s) within a XML document. **Sign** Before calling [Sign](#sign-method-xmlsig-component) specify the XML to sign by setting [InputFile](#inputfile-property-xmlsig-component), or [InputXML](#inputxml-property-xmlsig-component). The References 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 to a certificate with private key. Optionally set the [CanonicalizationMethod](#canonicalizationmethod-property-xmlsig-component). This determines how the signature itself is canonicalized. [SigningAlgorithm](#signingalgorithm-property-xmlsig-component) defines the algorithm used to sign. The [SignatureXPath](#signaturexpath-property-xmlsig-component) property may be set to specify the location in the XML document where the signature will be placed. Lastly, call [Sign](#sign-method-xmlsig-component) to sign the XML. The following properties are applicable when calling this method: - [CanonicalizationMethod](#canonicalizationmethod-property-xmlsig-component) - Certificate (required) - References (required) - [SignatureXPath](#signaturexpath-property-xmlsig-component) - [SigningAlgorithm](#signingalgorithm-property-xmlsig-component) **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](#inputfile-property-xmlsig-component) - [InputXML](#inputxml-property-xmlsig-component) 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-component) - [OutputXML](#outputxml-property-xmlsig-component): The output data is written to this property if no other destination is specified. **Verify a Signature** When [VerifySignature](#verifysignature-method-xmlsig-component) is called, the component will scan the XML document and fire the [SignatureInfo](#signatureinfo-event-xmlsig-component) event for each signature that is found. When the [SignatureInfo](#signatureinfo-event-xmlsig-component) event fires the References collection will be populated. Within the [SignatureInfo](#signatureinfo-event-xmlsig-component) event the [ReferenceXMLElement](#referencexmlelement-property-xmlsig-component) property must be set to the location of the XML element to which the signature applies. The [ReferenceURI](#referenceuri-property-xmlsig-component) property may contain data helpful to locating the XML element. The [ReferenceXMLElement](#referencexmlelement-property-xmlsig-component) property 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 property. The component will automatically parse the signer certificate (if present) from the signed XML and populate the SignerCert property with the parsed value. When [SignatureInfo](#signatureinfo-event-xmlsig-component) fires, if the *SignerCertParsed* parameter is True the SignerCert property may be inspected to see the details of the parsed certificate. If *SignerCertParsed* is False, then the SignerCert property must be set to a valid certificate for signature verification to proceed. When the [SignatureInfo](#signatureinfo-event-xmlsig-component) event finishes firing, the certificate present in the SignerCert property 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.* | | | | --- | --- | | [CanonicalizationMethod](#canonicalizationmethod-property-xmlsig-component) | The canonicalization method applied to the signature. | | [CertEffectiveDate](#certeffectivedate-property-xmlsig-component) | The date on which this certificate becomes valid. | | [CertExpirationDate](#certexpirationdate-property-xmlsig-component) | The date on which the certificate expires. | | [CertExtendedKeyUsage](#certextendedkeyusage-property-xmlsig-component) | A comma-delimited list of extended key usage identifiers. | | [CertFingerprint](#certfingerprint-property-xmlsig-component) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [CertFingerprintSHA1](#certfingerprintsha1-property-xmlsig-component) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [CertFingerprintSHA256](#certfingerprintsha256-property-xmlsig-component) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [CertIssuer](#certissuer-property-xmlsig-component) | The issuer of the certificate. | | [CertPrivateKey](#certprivatekey-property-xmlsig-component) | The private key of the certificate (if available). | | [CertPrivateKeyAvailable](#certprivatekeyavailable-property-xmlsig-component) | Whether a PrivateKey is available for the selected certificate. | | [CertPrivateKeyContainer](#certprivatekeycontainer-property-xmlsig-component) | The name of the PrivateKey container for the certificate (if available). | | [CertPublicKey](#certpublickey-property-xmlsig-component) | The public key of the certificate. | | [CertPublicKeyAlgorithm](#certpublickeyalgorithm-property-xmlsig-component) | The textual description of the certificate's public key algorithm. | | [CertPublicKeyLength](#certpublickeylength-property-xmlsig-component) | The length of the certificate's public key (in bits). | | [CertSerialNumber](#certserialnumber-property-xmlsig-component) | The serial number of the certificate encoded as a string. | | [CertSignatureAlgorithm](#certsignaturealgorithm-property-xmlsig-component) | The text description of the certificate's signature algorithm. | | [CertStore](#certstore-property-xmlsig-component) | The name of the certificate store for the client certificate. | | [CertStorePassword](#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. | | [CertStoreType](#certstoretype-property-xmlsig-component) | The type of certificate store for this certificate. | | [CertSubjectAltNames](#certsubjectaltnames-property-xmlsig-component) | Comma-separated lists of alternative subject names for the certificate. | | [CertThumbprintMD5](#certthumbprintmd5-property-xmlsig-component) | The MD5 hash of the certificate. | | [CertThumbprintSHA1](#certthumbprintsha1-property-xmlsig-component) | The SHA-1 hash of the certificate. | | [CertThumbprintSHA256](#certthumbprintsha256-property-xmlsig-component) | The SHA-256 hash of the certificate. | | [CertUsage](#certusage-property-xmlsig-component) | The text description of UsageFlags . | | [CertUsageFlags](#certusageflags-property-xmlsig-component) | The flags that show intended use for the certificate. | | [CertVersion](#certversion-property-xmlsig-component) | The certificate's version number. | | [CertSubject](#certsubject-property-xmlsig-component) | The subject of the certificate used for client authentication. | | [CertEncoded](#certencoded-property-xmlsig-component) | The certificate (PEM/Base64 encoded). | | [HMACKey](#hmackey-property-xmlsig-component) | The HMAC key used with the 'HMAC-SHA1' signing algorithm. | | [InputFile](#inputfile-property-xmlsig-component) | The XML file to process. | | [InputXML](#inputxml-property-xmlsig-component) | The XML to process. | | [OutputFile](#outputfile-property-xmlsig-component) | The output file. | | [OutputXML](#outputxml-property-xmlsig-component) | The output XML after processing. | | [Overwrite](#overwrite-property-xmlsig-component) | Indicates whether or not the component should overwrite files. | | [ReferenceCount](#referencecount-property-xmlsig-component) | The number of records in the Reference arrays. | | [ReferenceHashAlgorithm](#referencehashalgorithm-property-xmlsig-component) | This property defines the hash algorithm to apply to the element specified by XMLElement . | | [ReferenceHashValue](#referencehashvalue-property-xmlsig-component) | This property holds the calculated hash value for the specified XMLElement . | | [ReferenceTransformAlgorithms](#referencetransformalgorithms-property-xmlsig-component) | This property specifies a comma separated list of canonicalization algorithms to be applied to XMLElement . | | [ReferenceURI](#referenceuri-property-xmlsig-component) | This property is the URI of the reference. | | [ReferenceXMLElement](#referencexmlelement-property-xmlsig-component) | This property specifies XML element to sign or verify using XPath notation. | | [SignatureXPath](#signaturexpath-property-xmlsig-component) | The XPath of the signature. | | [SignerCertEffectiveDate](#signercerteffectivedate-property-xmlsig-component) | The date on which this certificate becomes valid. | | [SignerCertExpirationDate](#signercertexpirationdate-property-xmlsig-component) | The date on which the certificate expires. | | [SignerCertExtendedKeyUsage](#signercertextendedkeyusage-property-xmlsig-component) | A comma-delimited list of extended key usage identifiers. | | [SignerCertFingerprint](#signercertfingerprint-property-xmlsig-component) | The hex-encoded, 16-byte MD5 fingerprint of the certificate. | | [SignerCertFingerprintSHA1](#signercertfingerprintsha1-property-xmlsig-component) | The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. | | [SignerCertFingerprintSHA256](#signercertfingerprintsha256-property-xmlsig-component) | The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. | | [SignerCertIssuer](#signercertissuer-property-xmlsig-component) | The issuer of the certificate. | | [SignerCertPrivateKey](#signercertprivatekey-property-xmlsig-component) | The private key of the certificate (if available). | | [SignerCertPrivateKeyAvailable](#signercertprivatekeyavailable-property-xmlsig-component) | Whether a PrivateKey is available for the selected certificate. | | [SignerCertPrivateKeyContainer](#signercertprivatekeycontainer-property-xmlsig-component) | The name of the PrivateKey container for the certificate (if available). | | [SignerCertPublicKey](#signercertpublickey-property-xmlsig-component) | The public key of the certificate. | | [SignerCertPublicKeyAlgorithm](#signercertpublickeyalgorithm-property-xmlsig-component) | The textual description of the certificate's public key algorithm. | | [SignerCertPublicKeyLength](#signercertpublickeylength-property-xmlsig-component) | The length of the certificate's public key (in bits). | | [SignerCertSerialNumber](#signercertserialnumber-property-xmlsig-component) | The serial number of the certificate encoded as a string. | | [SignerCertSignatureAlgorithm](#signercertsignaturealgorithm-property-xmlsig-component) | The text description of the certificate's signature algorithm. | | [SignerCertStore](#signercertstore-property-xmlsig-component) | The name of the certificate store for the client certificate. | | [SignerCertStorePassword](#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. | | [SignerCertStoreType](#signercertstoretype-property-xmlsig-component) | The type of certificate store for this certificate. | | [SignerCertSubjectAltNames](#signercertsubjectaltnames-property-xmlsig-component) | Comma-separated lists of alternative subject names for the certificate. | | [SignerCertThumbprintMD5](#signercertthumbprintmd5-property-xmlsig-component) | The MD5 hash of the certificate. | | [SignerCertThumbprintSHA1](#signercertthumbprintsha1-property-xmlsig-component) | The SHA-1 hash of the certificate. | | [SignerCertThumbprintSHA256](#signercertthumbprintsha256-property-xmlsig-component) | The SHA-256 hash of the certificate. | | [SignerCertUsage](#signercertusage-property-xmlsig-component) | The text description of UsageFlags . | | [SignerCertUsageFlags](#signercertusageflags-property-xmlsig-component) | The flags that show intended use for the certificate. | | [SignerCertVersion](#signercertversion-property-xmlsig-component) | The certificate's version number. | | [SignerCertSubject](#signercertsubject-property-xmlsig-component) | The subject of the certificate used for client authentication. | | [SignerCertEncoded](#signercertencoded-property-xmlsig-component) | The certificate (PEM/Base64 encoded). | | [SigningAlgorithm](#signingalgorithm-property-xmlsig-component) | The signing algorithm. | ## Method List *The following is the full list of the methods of the component with short descriptions. Click on the links for further details.* | | | | --- | --- | | [Config](#config-method-xmlsig-component) | Sets or retrieves a configuration setting. | | [DoEvents](#doevents-method-xmlsig-component) | This method processes events from the internal message queue. | | [Reset](#reset-method-xmlsig-component) | Resets the component. | | [Sign](#sign-method-xmlsig-component) | Signs the XML. | | [VerifySignature](#verifysignature-method-xmlsig-component) | Verifies signed XML. | ## 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.* | | | | --- | --- | | [Error](#error-event-xmlsig-component) | Fired when information is available about errors during data delivery. | | [Progress](#progress-event-xmlsig-component) | Fired as progress is made. | | [SignatureInfo](#signatureinfo-event-xmlsig-component) | Fired when a signature is found. | | [Status](#status-event-xmlsig-component) | Provides information about the current operation. | ## Config Settings *The following is a list of config settings for the component 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. | | [UseFIPSCompliantAPI](#UseFIPSCompliantAPI) | Tells the component 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-component) Component) The canonicalization method applied to the signature. ## Syntax *C++ Builder Syntax* ```text __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](#sign-method-xmlsig-component). This will be set automatically after calling [VerifySignature](#verifysignature-method-xmlsig-component). 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 # CertEffectiveDate Property ([XMLSig](#xmlsig-component) Component) The date on which this certificate becomes valid. ## Syntax *C++ Builder Syntax* ```text __property String CertEffectiveDate = { read=FCertEffectiveDate }; ``` ## Default Value "" ## Remarks The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2000 15:00:00. This property is read-only. ## Data Type String # CertExpirationDate Property ([XMLSig](#xmlsig-component) Component) The date on which the certificate expires. ## Syntax *C++ Builder Syntax* ```text __property String CertExpirationDate = { read=FCertExpirationDate }; ``` ## Default Value "" ## Remarks The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2001 15:00:00. This property is read-only. ## Data Type String # CertExtendedKeyUsage Property ([XMLSig](#xmlsig-component) Component) A comma-delimited list of extended key usage identifiers. ## Syntax *C++ Builder Syntax* ```text __property String CertExtendedKeyUsage = { read=FCertExtendedKeyUsage }; ``` ## Default Value "" ## Remarks A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). This property is read-only. ## Data Type String # CertFingerprint Property ([XMLSig](#xmlsig-component) Component) The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax *C++ Builder Syntax* ```text __property String CertFingerprint = { read=FCertFingerprint }; ``` ## Default Value "" ## Remarks The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02* This property is read-only. ## Data Type String # CertFingerprintSHA1 Property ([XMLSig](#xmlsig-component) Component) The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax *C++ Builder Syntax* ```text __property String CertFingerprintSHA1 = { read=FCertFingerprintSHA1 }; ``` ## Default Value "" ## Remarks The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84* This property is read-only. ## Data Type String # CertFingerprintSHA256 Property ([XMLSig](#xmlsig-component) Component) The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax *C++ Builder Syntax* ```text __property String CertFingerprintSHA256 = { read=FCertFingerprintSHA256 }; ``` ## Default Value "" ## Remarks The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53* This property is read-only. ## Data Type String # CertIssuer Property ([XMLSig](#xmlsig-component) Component) The issuer of the certificate. ## Syntax *C++ Builder Syntax* ```text __property String CertIssuer = { read=FCertIssuer }; ``` ## Default Value "" ## Remarks The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate. This property is read-only. ## Data Type String # CertPrivateKey Property ([XMLSig](#xmlsig-component) Component) The private key of the certificate (if available). ## Syntax *C++ Builder Syntax* ```text __property String CertPrivateKey = { read=FCertPrivateKey }; ``` ## Default Value "" ## Remarks The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [CertPrivateKey](#certprivatekey-property-xmlsig-component) may be available but not exportable. In this case, [CertPrivateKey](#certprivatekey-property-xmlsig-component) returns an empty string. This property is read-only. ## Data Type String # CertPrivateKeyAvailable Property ([XMLSig](#xmlsig-component) Component) Whether a PrivateKey is available for the selected certificate. ## Syntax *C++ Builder Syntax* ```text __property bool CertPrivateKeyAvailable = { read=FCertPrivateKeyAvailable }; ``` ## Default Value false ## Remarks Whether a [CertPrivateKey](#certprivatekey-property-xmlsig-component) is available for the selected certificate. If [CertPrivateKeyAvailable](#certprivatekeyavailable-property-xmlsig-component) is True, the certificate may be used for authentication purposes (e.g., server authentication). This property is read-only. ## Data Type Boolean # CertPrivateKeyContainer Property ([XMLSig](#xmlsig-component) Component) The name of the PrivateKey container for the certificate (if available). ## Syntax *C++ Builder Syntax* ```text __property String CertPrivateKeyContainer = { read=FCertPrivateKeyContainer }; ``` ## Default Value "" ## Remarks The name of the [CertPrivateKey](#certprivatekey-property-xmlsig-component) container for the certificate (if available). This functionality is available only on Windows platforms. This property is read-only. ## Data Type String # CertPublicKey Property ([XMLSig](#xmlsig-component) Component) The public key of the certificate. ## Syntax *C++ Builder Syntax* ```text __property String CertPublicKey = { read=FCertPublicKey }; ``` ## Default Value "" ## Remarks The public key of the certificate. The key is provided as PEM/Base64-encoded data. This property is read-only. ## Data Type String # CertPublicKeyAlgorithm Property ([XMLSig](#xmlsig-component) Component) The textual description of the certificate's public key algorithm. ## Syntax *C++ Builder Syntax* ```text __property String CertPublicKeyAlgorithm = { read=FCertPublicKeyAlgorithm }; ``` ## Default Value "" ## Remarks The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm. This property is read-only. ## Data Type String # CertPublicKeyLength Property ([XMLSig](#xmlsig-component) Component) The length of the certificate's public key (in bits). ## Syntax *C++ Builder Syntax* ```text __property int CertPublicKeyLength = { read=FCertPublicKeyLength }; ``` ## Default Value 0 ## Remarks The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. This property is read-only. ## Data Type Integer # CertSerialNumber Property ([XMLSig](#xmlsig-component) Component) The serial number of the certificate encoded as a string. ## Syntax *C++ Builder Syntax* ```text __property String CertSerialNumber = { read=FCertSerialNumber }; ``` ## Default Value "" ## Remarks The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number. This property is read-only. ## Data Type String # CertSignatureAlgorithm Property ([XMLSig](#xmlsig-component) Component) The text description of the certificate's signature algorithm. ## Syntax *C++ Builder Syntax* ```text __property String CertSignatureAlgorithm = { read=FCertSignatureAlgorithm }; ``` ## Default Value "" ## Remarks The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm. This property is read-only. ## Data Type String # CertStore Property ([XMLSig](#xmlsig-component) Component) The name of the certificate store for the client certificate. ## Syntax *C++ Builder Syntax* ```text __property String CertStore = { read=FCertStore, write=FSetCertStore }; __property DynamicArray CertStoreB = { read=FCertStoreB, write=FSetCertStoreB }; ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [CertStoreType](#certstoretype-property-xmlsig-component) property denotes the type of the certificate store specified by [CertStore](#certstore-property-xmlsig-component). If the store is password-protected, specify the password in [CertStorePassword](#certstorepassword-property-xmlsig-component). [CertStore](#certstore-property-xmlsig-component) is used in conjunction with the [CertSubject](#certsubject-property-xmlsig-component) property to specify client certificates. If [CertStore](#certstore-property-xmlsig-component) has a value, and [CertSubject](#certsubject-property-xmlsig-component) or [CertEncoded](#certencoded-property-xmlsig-component) is set, a search for a certificate is initiated. Please see the [CertSubject](#certsubject-property-xmlsig-component) property for details. Designations of certificate stores are platform dependent. The following designations are the most common User and Machine certificate stores in Windows: | | | | --- | --- | | MY | A certificate store holding personal certificates with their associated private keys. | | CA | Certifying authority certificates. | | ROOT | Root certificates. | When the certificate store type is *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). ## Data Type Byte Array # CertStorePassword Property ([XMLSig](#xmlsig-component) 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 *C++ Builder Syntax* ```text __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](#xmlsig-component) Component) The type of certificate store for this certificate. ## Syntax *C++ Builder Syntax* ```text __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 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: ```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](#Type_Certificate) object and pass cstPKCS11 as the [CertStoreType](#certstoretype-property-xmlsig-component), the full path of the PKCS#11 DLL as the [CertStore](#certstore-property-xmlsig-component), and the PIN as the [CertStorePassword](#certstorepassword-property-xmlsig-component). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) component by calling the [ListStoreCertificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](#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 [CertStore](#certstore-property-xmlsig-component) and set [CertStorePassword](#certstorepassword-property-xmlsig-component) 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. | ## Data Type Integer # CertSubjectAltNames Property ([XMLSig](#xmlsig-component) Component) Comma-separated lists of alternative subject names for the certificate. ## Syntax *C++ Builder Syntax* ```text __property String CertSubjectAltNames = { read=FCertSubjectAltNames }; ``` ## Default Value "" ## Remarks Comma-separated lists of alternative subject names for the certificate. This property is read-only. ## Data Type String # CertThumbprintMD5 Property ([XMLSig](#xmlsig-component) Component) The MD5 hash of the certificate. ## Syntax *C++ Builder Syntax* ```text __property String CertThumbprintMD5 = { read=FCertThumbprintMD5 }; ``` ## Default Value "" ## Remarks The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. ## Data Type String # CertThumbprintSHA1 Property ([XMLSig](#xmlsig-component) Component) The SHA-1 hash of the certificate. ## Syntax *C++ Builder Syntax* ```text __property String CertThumbprintSHA1 = { read=FCertThumbprintSHA1 }; ``` ## Default Value "" ## Remarks The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. ## Data Type String # CertThumbprintSHA256 Property ([XMLSig](#xmlsig-component) Component) The SHA-256 hash of the certificate. ## Syntax *C++ Builder Syntax* ```text __property String CertThumbprintSHA256 = { read=FCertThumbprintSHA256 }; ``` ## Default Value "" ## Remarks The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. ## Data Type String # CertUsage Property ([XMLSig](#xmlsig-component) Component) The text description of UsageFlags . ## Syntax *C++ Builder Syntax* ```text __property String CertUsage = { read=FCertUsage }; ``` ## Default Value "" ## Remarks The text description of [CertUsageFlags](#certusageflags-property-xmlsig-component). This value will be one or more of the following strings and will be separated by commas: - Digital Signature - Non-Repudiation - Key Encipherment - Data Encipherment - Key Agreement - Certificate Signing - CRL Signing - Encipher Only If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names. This property is read-only. ## Data Type String # CertUsageFlags Property ([XMLSig](#xmlsig-component) Component) The flags that show intended use for the certificate. ## Syntax *C++ Builder Syntax* ```text __property int CertUsageFlags = { read=FCertUsageFlags }; ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [CertUsageFlags](#certusageflags-property-xmlsig-component) 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 [CertUsage](#certusage-property-xmlsig-component) property for a text representation of [CertUsageFlags](#certusageflags-property-xmlsig-component). This functionality currently is not available when the provider is OpenSSL. This property is read-only. ## Data Type Integer # CertVersion Property ([XMLSig](#xmlsig-component) Component) The certificate's version number. ## Syntax *C++ Builder Syntax* ```text __property String CertVersion = { read=FCertVersion }; ``` ## Default Value "" ## Remarks The certificate's version number. The possible values are the strings "V1", "V2", and "V3". This property is read-only. ## Data Type String # CertSubject Property ([XMLSig](#xmlsig-component) Component) The subject of the certificate used for client authentication. ## Syntax *C++ Builder Syntax* ```text __property String CertSubject = { read=FCertSubject, write=FSetCertSubject }; ``` ## Default Value "" ## Remarks The subject of the certificate used for client authentication. This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject. If a matching certificate is found, the property is set to the full subject of the matching certificate. If an exact match is not found, the store is searched for subjects containing the value of the property. If a match is still not found, the property is set to an empty string, and no certificate is selected. The special value "*" picks a random certificate in the certificate store. The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=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. ## Data Type String # CertEncoded Property ([XMLSig](#xmlsig-component) Component) The certificate (PEM/Base64 encoded). ## Syntax *C++ Builder Syntax* ```text __property String CertEncoded = { read=FCertEncoded, write=FSetCertEncoded }; __property DynamicArray CertEncodedB = { read=FCertEncodedB, write=FSetCertEncodedB }; ``` ## Default Value "" ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [CertStore](#certstore-property-xmlsig-component) and [CertSubject](#certsubject-property-xmlsig-component) properties also may be used to specify a certificate. When [CertEncoded](#certencoded-property-xmlsig-component) is set, a search is initiated in the current [CertStore](#certstore-property-xmlsig-component) for the private key of the certificate. If the key is found, [CertSubject](#certsubject-property-xmlsig-component) is updated to reflect the full subject of the selected certificate; otherwise, [CertSubject](#certsubject-property-xmlsig-component) is set to an empty string. This property is not available at design time. ## Data Type Byte Array # HMACKey Property ([XMLSig](#xmlsig-component) Component) The HMAC key used with the 'HMAC-SHA1' signing algorithm. ## Syntax *C++ Builder Syntax* ```text __property String HMACKey = { read=FHMACKey, write=FSetHMACKey }; __property DynamicArray HMACKeyB = { read=FHMACKeyB, write=FSetHMACKeyB }; ``` ## Default Value "" ## Remarks This property defines the HMAC key to be used when [SigningAlgorithm](#signingalgorithm-property-xmlsig-component) is set to "HMAC-SHA1". This must be set before calling before calling [Sign](#sign-method-xmlsig-component). This property is also applicable when calling [VerifySignature](#verifysignature-method-xmlsig-component). This may be set before calling [VerifySignature](#verifysignature-method-xmlsig-component) or from within the [SignatureInfo](#signatureinfo-event-xmlsig-component) event. This property is not available at design time. ## Data Type Byte Array # InputFile Property ([XMLSig](#xmlsig-component) Component) The XML file to process. ## Syntax *C++ Builder Syntax* ```text __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](#inputxml-property-xmlsig-component) 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-component) - [OutputXML](#outputxml-property-xmlsig-component): 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-component) Component) The XML to process. ## Syntax *C++ Builder Syntax* ```text __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](#inputfile-property-xmlsig-component) - 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-component) - [OutputXML](#outputxml-property-xmlsig-component): 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-component) Component) The output file. ## Syntax *C++ Builder Syntax* ```text __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](#inputfile-property-xmlsig-component) - [InputXML](#inputxml-property-xmlsig-component) 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-component): 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-component) Component) The output XML after processing. ## Syntax *C++ Builder Syntax* ```text __property String OutputXML = { read=FOutputXML, write=FSetOutputXML }; ``` ## Default Value "" ## Remarks This property will be populated with the output from the operation if [OutputFile](#outputfile-property-xmlsig-component) 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](#inputfile-property-xmlsig-component) - [InputXML](#inputxml-property-xmlsig-component) 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-component) - 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-component) Component) Indicates whether or not the component should overwrite files. ## Syntax *C++ Builder Syntax* ```text __property bool Overwrite = { read=FOverwrite, write=FSetOverwrite }; ``` ## Default Value false ## Remarks This property indicates whether or not the component will overwrite [OutputFile](#outputfile-property-xmlsig-component). If Overwrite is False, an error will be thrown whenever [OutputFile](#outputfile-property-xmlsig-component) exists before an operation. The default value is False. ## Data Type Boolean # ReferenceCount Property ([XMLSig](#xmlsig-component) Component) The number of records in the Reference arrays. ## Syntax *C++ Builder Syntax* ```text __property int ReferenceCount = { read=FReferenceCount, write=FSetReferenceCount }; ``` ## Default Value 0 ## Remarks This property controls the size of the following arrays: - [ReferenceHashAlgorithm](#referencehashalgorithm-property-xmlsig-component) - [ReferenceHashValue](#referencehashvalue-property-xmlsig-component) - [ReferenceTransformAlgorithms](#referencetransformalgorithms-property-xmlsig-component) - [ReferenceURI](#referenceuri-property-xmlsig-component) - [ReferenceXMLElement](#referencexmlelement-property-xmlsig-component) 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](#xmlsig-component) Component) This property defines the hash algorithm to apply to the element specified by XMLElement . ## Syntax *C++ Builder Syntax* ```text __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](#referencexmlelement-property-xmlsig-component). 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](#referencecount-property-xmlsig-component) property. This property is not available at design time. ## Data Type String # ReferenceHashValue Property ([XMLSig](#xmlsig-component) Component) This property holds the calculated hash value for the specified XMLElement . ## Syntax *C++ Builder Syntax* ```text __property String ReferenceHashValue[int ReferenceIndex] = { read=FReferenceHashValue }; ``` ## Default Value "" ## Remarks This property holds the calculated hash value for the specified [ReferenceXMLElement](#referencexmlelement-property-xmlsig-component). The *ReferenceIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ReferenceCount](#referencecount-property-xmlsig-component) property. This property is read-only and not available at design time. ## Data Type String # ReferenceTransformAlgorithms Property ([XMLSig](#xmlsig-component) Component) This property specifies a comma separated list of canonicalization algorithms to be applied to XMLElement . ## Syntax *C++ Builder Syntax* ```text __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](#referencexmlelement-property-xmlsig-component). The XML data specified by [ReferenceXMLElement](#referencexmlelement-property-xmlsig-component) will be transformed using the specified algorithm(s) before the [ReferenceHashAlgorithm](#referencehashalgorithm-property-xmlsig-component) 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 | The *ReferenceIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ReferenceCount](#referencecount-property-xmlsig-component) property. This property is not available at design time. ## Data Type String # ReferenceURI Property ([XMLSig](#xmlsig-component) Component) This property is the URI of the reference. ## Syntax *C++ Builder Syntax* ```text __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-property-xmlsig-component). [ReferenceXMLElement](#referencexmlelement-property-xmlsig-component) must be set separately. When verifying, this value may be checked within the [SignatureInfo](#signatureinfo-event-xmlsig-component) event to identify the location of [ReferenceXMLElement](#referencexmlelement-property-xmlsig-component). [ReferenceXMLElement](#referencexmlelement-property-xmlsig-component) 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](#referencecount-property-xmlsig-component) property. This property is not available at design time. ## Data Type String # ReferenceXMLElement Property ([XMLSig](#xmlsig-component) Component) This property specifies XML element to sign or verify using XPath notation. ## Syntax *C++ Builder Syntax* ```text __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](#sign-method-xmlsig-component). When verifying, this must be set from within the [SignatureInfo](#signatureinfo-event-xmlsig-component) event. The [ReferenceURI](#referenceuri-property-xmlsig-component) property 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 | The *ReferenceIndex* parameter specifies the index of the item in the array. The size of the array is controlled by the [ReferenceCount](#referencecount-property-xmlsig-component) property. This property is not available at design time. ## Data Type String # SignatureXPath Property ([XMLSig](#xmlsig-component) Component) The XPath of the signature. ## Syntax *C++ Builder Syntax* ```text __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](#sign-method-xmlsig-component). This property will be populated when calling [VerifySignature](#verifysignature-method-xmlsig-component). The default value is "/". This property is not available at design time. ## Data Type String # SignerCertEffectiveDate Property ([XMLSig](#xmlsig-component) Component) The date on which this certificate becomes valid. ## Syntax *C++ Builder Syntax* ```text __property String SignerCertEffectiveDate = { read=FSignerCertEffectiveDate }; ``` ## Default Value "" ## Remarks The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2000 15:00:00. This property is read-only. ## Data Type String # SignerCertExpirationDate Property ([XMLSig](#xmlsig-component) Component) The date on which the certificate expires. ## Syntax *C++ Builder Syntax* ```text __property String SignerCertExpirationDate = { read=FSignerCertExpirationDate }; ``` ## Default Value "" ## Remarks The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date: 23-Jan-2001 15:00:00. This property is read-only. ## Data Type String # SignerCertExtendedKeyUsage Property ([XMLSig](#xmlsig-component) Component) A comma-delimited list of extended key usage identifiers. ## Syntax *C++ Builder Syntax* ```text __property String SignerCertExtendedKeyUsage = { read=FSignerCertExtendedKeyUsage }; ``` ## Default Value "" ## Remarks A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs). This property is read-only. ## Data Type String # SignerCertFingerprint Property ([XMLSig](#xmlsig-component) Component) The hex-encoded, 16-byte MD5 fingerprint of the certificate. ## Syntax *C++ Builder Syntax* ```text __property String SignerCertFingerprint = { read=FSignerCertFingerprint }; ``` ## Default Value "" ## Remarks The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02* This property is read-only. ## Data Type String # SignerCertFingerprintSHA1 Property ([XMLSig](#xmlsig-component) Component) The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. ## Syntax *C++ Builder Syntax* ```text __property String SignerCertFingerprintSHA1 = { read=FSignerCertFingerprintSHA1 }; ``` ## Default Value "" ## Remarks The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84* This property is read-only. ## Data Type String # SignerCertFingerprintSHA256 Property ([XMLSig](#xmlsig-component) Component) The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. ## Syntax *C++ Builder Syntax* ```text __property String SignerCertFingerprintSHA256 = { read=FSignerCertFingerprintSHA256 }; ``` ## Default Value "" ## Remarks The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys. The following example illustrates the format: *6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53* This property is read-only. ## Data Type String # SignerCertIssuer Property ([XMLSig](#xmlsig-component) Component) The issuer of the certificate. ## Syntax *C++ Builder Syntax* ```text __property String SignerCertIssuer = { read=FSignerCertIssuer }; ``` ## Default Value "" ## Remarks The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate. This property is read-only. ## Data Type String # SignerCertPrivateKey Property ([XMLSig](#xmlsig-component) Component) The private key of the certificate (if available). ## Syntax *C++ Builder Syntax* ```text __property String SignerCertPrivateKey = { read=FSignerCertPrivateKey }; ``` ## Default Value "" ## Remarks The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data. NOTE: The [SignerCertPrivateKey](#signercertprivatekey-property-xmlsig-component) may be available but not exportable. In this case, [SignerCertPrivateKey](#signercertprivatekey-property-xmlsig-component) returns an empty string. This property is read-only. ## Data Type String # SignerCertPrivateKeyAvailable Property ([XMLSig](#xmlsig-component) Component) Whether a PrivateKey is available for the selected certificate. ## Syntax *C++ Builder Syntax* ```text __property bool SignerCertPrivateKeyAvailable = { read=FSignerCertPrivateKeyAvailable }; ``` ## Default Value false ## Remarks Whether a [SignerCertPrivateKey](#signercertprivatekey-property-xmlsig-component) is available for the selected certificate. If [SignerCertPrivateKeyAvailable](#signercertprivatekeyavailable-property-xmlsig-component) is True, the certificate may be used for authentication purposes (e.g., server authentication). This property is read-only. ## Data Type Boolean # SignerCertPrivateKeyContainer Property ([XMLSig](#xmlsig-component) Component) The name of the PrivateKey container for the certificate (if available). ## Syntax *C++ Builder Syntax* ```text __property String SignerCertPrivateKeyContainer = { read=FSignerCertPrivateKeyContainer }; ``` ## Default Value "" ## Remarks The name of the [SignerCertPrivateKey](#signercertprivatekey-property-xmlsig-component) container for the certificate (if available). This functionality is available only on Windows platforms. This property is read-only. ## Data Type String # SignerCertPublicKey Property ([XMLSig](#xmlsig-component) Component) The public key of the certificate. ## Syntax *C++ Builder Syntax* ```text __property String SignerCertPublicKey = { read=FSignerCertPublicKey }; ``` ## Default Value "" ## Remarks The public key of the certificate. The key is provided as PEM/Base64-encoded data. This property is read-only. ## Data Type String # SignerCertPublicKeyAlgorithm Property ([XMLSig](#xmlsig-component) Component) The textual description of the certificate's public key algorithm. ## Syntax *C++ Builder Syntax* ```text __property String SignerCertPublicKeyAlgorithm = { read=FSignerCertPublicKeyAlgorithm }; ``` ## Default Value "" ## Remarks The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm. This property is read-only. ## Data Type String # SignerCertPublicKeyLength Property ([XMLSig](#xmlsig-component) Component) The length of the certificate's public key (in bits). ## Syntax *C++ Builder Syntax* ```text __property int SignerCertPublicKeyLength = { read=FSignerCertPublicKeyLength }; ``` ## Default Value 0 ## Remarks The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048. This property is read-only. ## Data Type Integer # SignerCertSerialNumber Property ([XMLSig](#xmlsig-component) Component) The serial number of the certificate encoded as a string. ## Syntax *C++ Builder Syntax* ```text __property String SignerCertSerialNumber = { read=FSignerCertSerialNumber }; ``` ## Default Value "" ## Remarks The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number. This property is read-only. ## Data Type String # SignerCertSignatureAlgorithm Property ([XMLSig](#xmlsig-component) Component) The text description of the certificate's signature algorithm. ## Syntax *C++ Builder Syntax* ```text __property String SignerCertSignatureAlgorithm = { read=FSignerCertSignatureAlgorithm }; ``` ## Default Value "" ## Remarks The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm. This property is read-only. ## Data Type String # SignerCertStore Property ([XMLSig](#xmlsig-component) Component) The name of the certificate store for the client certificate. ## Syntax *C++ Builder Syntax* ```text __property String SignerCertStore = { read=FSignerCertStore, write=FSetSignerCertStore }; __property DynamicArray SignerCertStoreB = { read=FSignerCertStoreB, write=FSetSignerCertStoreB }; ``` ## Default Value "MY" ## Remarks The name of the certificate store for the client certificate. The [SignerCertStoreType](#signercertstoretype-property-xmlsig-component) property denotes the type of the certificate store specified by [SignerCertStore](#signercertstore-property-xmlsig-component). If the store is password-protected, specify the password in [SignerCertStorePassword](#signercertstorepassword-property-xmlsig-component). [SignerCertStore](#signercertstore-property-xmlsig-component) is used in conjunction with the [SignerCertSubject](#signercertsubject-property-xmlsig-component) property to specify client certificates. If [SignerCertStore](#signercertstore-property-xmlsig-component) has a value, and [SignerCertSubject](#signercertsubject-property-xmlsig-component) or [SignerCertEncoded](#signercertencoded-property-xmlsig-component) is set, a search for a certificate is initiated. Please see the [SignerCertSubject](#signercertsubject-property-xmlsig-component) property for details. Designations of certificate stores are platform dependent. The following designations are the most common User and Machine certificate stores in Windows: | | | | --- | --- | | MY | A certificate store holding personal certificates with their associated private keys. | | CA | Certifying authority certificates. | | ROOT | Root certificates. | When the certificate store type is *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). ## Data Type Byte Array # SignerCertStorePassword Property ([XMLSig](#xmlsig-component) 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 *C++ Builder Syntax* ```text __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](#xmlsig-component) Component) The type of certificate store for this certificate. ## Syntax *C++ Builder Syntax* ```text __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 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: ```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](#Type_Certificate) object and pass cstPKCS11 as the [SignerCertStoreType](#signercertstoretype-property-xmlsig-component), the full path of the PKCS#11 DLL as the [SignerCertStore](#signercertstore-property-xmlsig-component), and the PIN as the [SignerCertStorePassword](#signercertstorepassword-property-xmlsig-component). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](#CertMgr) component by calling the [ListStoreCertificates](#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](#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 [SignerCertStore](#signercertstore-property-xmlsig-component) and set [SignerCertStorePassword](#signercertstorepassword-property-xmlsig-component) 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. | ## Data Type Integer # SignerCertSubjectAltNames Property ([XMLSig](#xmlsig-component) Component) Comma-separated lists of alternative subject names for the certificate. ## Syntax *C++ Builder Syntax* ```text __property String SignerCertSubjectAltNames = { read=FSignerCertSubjectAltNames }; ``` ## Default Value "" ## Remarks Comma-separated lists of alternative subject names for the certificate. This property is read-only. ## Data Type String # SignerCertThumbprintMD5 Property ([XMLSig](#xmlsig-component) Component) The MD5 hash of the certificate. ## Syntax *C++ Builder Syntax* ```text __property String SignerCertThumbprintMD5 = { read=FSignerCertThumbprintMD5 }; ``` ## Default Value "" ## Remarks The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. ## Data Type String # SignerCertThumbprintSHA1 Property ([XMLSig](#xmlsig-component) Component) The SHA-1 hash of the certificate. ## Syntax *C++ Builder Syntax* ```text __property String SignerCertThumbprintSHA1 = { read=FSignerCertThumbprintSHA1 }; ``` ## Default Value "" ## Remarks The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. ## Data Type String # SignerCertThumbprintSHA256 Property ([XMLSig](#xmlsig-component) Component) The SHA-256 hash of the certificate. ## Syntax *C++ Builder Syntax* ```text __property String SignerCertThumbprintSHA256 = { read=FSignerCertThumbprintSHA256 }; ``` ## Default Value "" ## Remarks The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed. This property is read-only. ## Data Type String # SignerCertUsage Property ([XMLSig](#xmlsig-component) Component) The text description of UsageFlags . ## Syntax *C++ Builder Syntax* ```text __property String SignerCertUsage = { read=FSignerCertUsage }; ``` ## Default Value "" ## Remarks The text description of [SignerCertUsageFlags](#signercertusageflags-property-xmlsig-component). This value will be one or more of the following strings and will be separated by commas: - Digital Signature - Non-Repudiation - Key Encipherment - Data Encipherment - Key Agreement - Certificate Signing - CRL Signing - Encipher Only If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names. This property is read-only. ## Data Type String # SignerCertUsageFlags Property ([XMLSig](#xmlsig-component) Component) The flags that show intended use for the certificate. ## Syntax *C++ Builder Syntax* ```text __property int SignerCertUsageFlags = { read=FSignerCertUsageFlags }; ``` ## Default Value 0 ## Remarks The flags that show intended use for the certificate. The value of [SignerCertUsageFlags](#signercertusageflags-property-xmlsig-component) 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 [SignerCertUsage](#signercertusage-property-xmlsig-component) property for a text representation of [SignerCertUsageFlags](#signercertusageflags-property-xmlsig-component). This functionality currently is not available when the provider is OpenSSL. This property is read-only. ## Data Type Integer # SignerCertVersion Property ([XMLSig](#xmlsig-component) Component) The certificate's version number. ## Syntax *C++ Builder Syntax* ```text __property String SignerCertVersion = { read=FSignerCertVersion }; ``` ## Default Value "" ## Remarks The certificate's version number. The possible values are the strings "V1", "V2", and "V3". This property is read-only. ## Data Type String # SignerCertSubject Property ([XMLSig](#xmlsig-component) Component) The subject of the certificate used for client authentication. ## Syntax *C++ Builder Syntax* ```text __property String SignerCertSubject = { read=FSignerCertSubject, write=FSetSignerCertSubject }; ``` ## Default Value "" ## Remarks The subject of the certificate used for client authentication. This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject. If a matching certificate is found, the property is set to the full subject of the matching certificate. If an exact match is not found, the store is searched for subjects containing the value of the property. If a match is still not found, the property is set to an empty string, and no certificate is selected. The special value "*" picks a random certificate in the certificate store. The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=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. ## Data Type String # SignerCertEncoded Property ([XMLSig](#xmlsig-component) Component) The certificate (PEM/Base64 encoded). ## Syntax *C++ Builder Syntax* ```text __property String SignerCertEncoded = { read=FSignerCertEncoded, write=FSetSignerCertEncoded }; __property DynamicArray SignerCertEncodedB = { read=FSignerCertEncodedB, write=FSetSignerCertEncodedB }; ``` ## Default Value "" ## Remarks The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The [SignerCertStore](#signercertstore-property-xmlsig-component) and [SignerCertSubject](#signercertsubject-property-xmlsig-component) properties also may be used to specify a certificate. When [SignerCertEncoded](#signercertencoded-property-xmlsig-component) is set, a search is initiated in the current [SignerCertStore](#signercertstore-property-xmlsig-component) for the private key of the certificate. If the key is found, [SignerCertSubject](#signercertsubject-property-xmlsig-component) is updated to reflect the full subject of the selected certificate; otherwise, [SignerCertSubject](#signercertsubject-property-xmlsig-component) is set to an empty string. This property is not available at design time. ## Data Type Byte Array # SigningAlgorithm Property ([XMLSig](#xmlsig-component) Component) The signing algorithm. ## Syntax *C++ Builder Syntax* ```text __property String SigningAlgorithm = { read=FSigningAlgorithm, write=FSetSigningAlgorithm }; ``` ## Default Value "" ## Remarks This property specifies the signing algorithm. This may be set before calling [Sign](#sign-method-xmlsig-component). This value will be set after calling [VerifySignature](#verifysignature-method-xmlsig-component). Possible values are: - "RSA-SHA1" (default) - "RSA-SHA256" - "DSA-SHA1" - "HMAC-SHA1" Note: When set to "HMAC-SHA1" [HMACKey](#hmackey-property-xmlsig-component) must also be set. This property is not available at design time. ## Data Type String # Config Method ([XMLSig](#xmlsig-component) Component) Sets or retrieves a configuration setting. ## Syntax *C++ Builder Syntax* ```text String __fastcall Config(String ConfigurationString); ``` ## Remarks Config is a generic method available in every component. It is used to set and retrieve [configuration settings](#config-settings-xmlsig-component) 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](#config-settings-xmlsig-component), you must call *Config("PROPERTY")*. The value will be returned as a string. # DoEvents Method ([XMLSig](#xmlsig-component) Component) This method processes events from the internal message queue. ## Syntax *C++ Builder Syntax* ```text 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](#xmlsig-component) Component) Resets the component. ## Syntax *C++ Builder Syntax* ```text void __fastcall Reset(); ``` ## Remarks When called, the component will reset all of its properties to their default values. # Sign Method ([XMLSig](#xmlsig-component) Component) Signs the XML. ## Syntax *C++ Builder Syntax* ```text void __fastcall Sign(); ``` ## Remarks This methods signs the XML. Before calling Sign specify the XML to sign by setting [InputFile](#inputfile-property-xmlsig-component), or [InputXML](#inputxml-property-xmlsig-component). The References 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 to a certificate with private key. Optionally set the [CanonicalizationMethod](#canonicalizationmethod-property-xmlsig-component). This determines how the signature itself is canonicalized. [SigningAlgorithm](#signingalgorithm-property-xmlsig-component) defines the algorithm used to sign. The [SignatureXPath](#signaturexpath-property-xmlsig-component) 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-component) - Certificate (required) - References (required) - [SignatureXPath](#signaturexpath-property-xmlsig-component) - [SigningAlgorithm](#signingalgorithm-property-xmlsig-component) **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](#inputfile-property-xmlsig-component) - [InputXML](#inputxml-property-xmlsig-component) 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-component) - [OutputXML](#outputxml-property-xmlsig-component): The output data is written to this property if no other destination is specified. # VerifySignature Method ([XMLSig](#xmlsig-component) Component) Verifies signed XML. ## Syntax *C++ Builder Syntax* ```text 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](#signatureinfo-event-xmlsig-component) event for each signature that is found. When the [SignatureInfo](#signatureinfo-event-xmlsig-component) event fires the References collection will be populated. Within the [SignatureInfo](#signatureinfo-event-xmlsig-component) event the [ReferenceXMLElement](#referencexmlelement-property-xmlsig-component) property must be set to the location of the XML element to which the signature applies. The [ReferenceURI](#referenceuri-property-xmlsig-component) property may contain data helpful to locating the XML element. The [ReferenceXMLElement](#referencexmlelement-property-xmlsig-component) property 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 property. The component will automatically parse the signer certificate (if present) from the signed XML and populate the SignerCert property with the parsed value. When [SignatureInfo](#signatureinfo-event-xmlsig-component) fires, if the *SignerCertParsed* parameter is True the SignerCert property may be inspected to see the details of the parsed certificate. If *SignerCertParsed* is False, then the SignerCert property must be set to a valid certificate for signature verification to proceed. When the [SignatureInfo](#signatureinfo-event-xmlsig-component) event finishes firing, the certificate present in the SignerCert property 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](#xmlsig-component) Component) Fired when information is available about errors during data delivery. ## Syntax *C++ Builder Syntax* ```text 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. 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-component) section. # Progress Event ([XMLSig](#xmlsig-component) Component) Fired as progress is made. ## Syntax *C++ Builder Syntax* ```text 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](#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 component. When the *Operation* is Write (2) this value may be queried to determine when all data has been processed. # SignatureInfo Event ([XMLSig](#xmlsig-component) Component) Fired when a signature is found. ## Syntax *C++ Builder Syntax* ```text 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](#verifysignature-method-xmlsig-component) 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-component) 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 References collection will be populated. Within the SignatureInfo event the [ReferenceXMLElement](#referencexmlelement-property-xmlsig-component) property must be set to the location of the XML element to which the signature applies. The [ReferenceURI](#referenceuri-property-xmlsig-component) property may contain data helpful to locating the XML element. The [ReferenceXMLElement](#referencexmlelement-property-xmlsig-component) property 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 property. The component will automatically parse the signer certificate (if present) from the signed XML and populate the SignerCert property with the parsed value. When SignatureInfo fires, if the *SignerCertParsed* parameter is True the SignerCert property may be inspected to see the details of the parsed certificate. If *SignerCertParsed* is False, then the SignerCert 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 property 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](#xmlsig-component) Component) Provides information about the current operation. ## Syntax *C++ Builder Syntax* ```text 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](#LogLevel) setting. # Config Settings ([XMLSig](#xmlsig-component) Component) The component 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 component, access to these *internal properties* is provided through the [Config](#config-method-xmlsig-component) 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-component). When calling [VerifySignature](#verifysignature-method-xmlsig-component) this may be queried inside the [SignatureInfo](#signatureinfo-event-xmlsig-component) 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-component) 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-component) event. The component will repeatedly fire the [Progress](#progress-event-xmlsig-component) event to ask for data. Inside the event set [InputXML](#inputxml-property-xmlsig-component) 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-component). 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-component). It holds the number of signer certificates that were parsed from the message. In most cases a single certificate is present and SignerCert 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