Tcl
Tcl
XML Signature Multiple External References
See more XML Digital Signatures Examples
Demonstrates how to add multiple external references to an XML digital signature.Chilkat Tcl Downloads
load ./chilkat.dll
set success 0
# This example requires the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
# This example creates the following signed XML with multiple external references:
# <?xml version="1.0" encoding="UTF-8"?>
# <ds:Signature xmlns:ds="http://www.w3.org/2000/09/xmldsig#" Id="xmldsig-2dde88a8-def0-43e4-8570-b031015a46b4">
# <ds:SignedInfo>
# <ds:CanonicalizationMethod Algorithm="http://www.w3.org/TR/2001/REC-xml-c14n-20010315"/>
# <ds:SignatureMethod Algorithm="http://www.w3.org/2001/04/xmldsig-more#rsa-sha256"/>
# <ds:Reference Id="xmldsig-2dde88a8-def0-43e4-8570-b031015a46b4-ref0" URI="https://isus.ezdrowie.gov.pl/fhir/Patient/123/_history/456">
# <ds:DigestMethod Algorithm="http://www.w3.org/2001/04/xmlenc#sha256"/>
# <ds:DigestValue>...</ds:DigestValue>
# </ds:Reference>
# <ds:Reference Id="xmldsig-2dde88a8-def0-43e4-8570-b031015a46b4-ref1" URI="https://isus.ezdrowie.gov.pl/fhir/Encounter/124/_history/22">
# <ds:DigestMethod Algorithm="http://www.w3.org/2001/04/xmlenc#sha256"/>
# <ds:DigestValue>...</ds:DigestValue>
# </ds:Reference>
# <ds:Reference Id="xmldsig-2dde88a8-def0-43e4-8570-b031015a46b4-ref2" URI="https://isus.ezdrowie.gov.pl/fhir/Condition/125/_history/1">
# <ds:DigestMethod Algorithm="http://www.w3.org/2001/04/xmlenc#sha256"/>
# <ds:DigestValue>...</ds:DigestValue>
# </ds:Reference>
# <ds:Reference Id="xmldsig-2dde88a8-def0-43e4-8570-b031015a46b4-ref3" URI="https://isus.ezdrowie.gov.pl/fhir/Procedure/126/_history/1">
# <ds:DigestMethod Algorithm="http://www.w3.org/2001/04/xmlenc#sha256"/>
# <ds:DigestValue>...</ds:DigestValue>
# </ds:Reference>
# <ds:Reference Type="http://uri.etsi.org/01903#SignedProperties" URI="#xmldsig-2dde88a8-def0-43e4-8570-b031015a46b4-signedprops">
# <ds:Transforms>
# <ds:Transform Algorithm="http://www.w3.org/TR/2001/REC-xml-c14n-20010315"/>
# </ds:Transforms>
# <ds:DigestMethod Algorithm="http://www.w3.org/2001/04/xmlenc#sha256"/>
# <ds:DigestValue>...</ds:DigestValue>
# </ds:Reference>
# </ds:SignedInfo>
# <ds:SignatureValue Id="xmldsig-2dde88a8-def0-43e4-8570-b031015a46b4-sigvalue">...</ds:SignatureValue>
# <ds:KeyInfo>
# <ds:X509Data>
# <ds:X509Certificate>...</ds:X509Certificate>
# <ds:X509SubjectName>...</ds:X509SubjectName>
# <ds:X509IssuerSerial>
# <ds:X509IssuerName>...</ds:X509IssuerName>
# <ds:X509SerialNumber>...</ds:X509SerialNumber>
# </ds:X509IssuerSerial>
# </ds:X509Data>
# </ds:KeyInfo>
# <ds:Object>
# <xades:QualifyingProperties xmlns:xades="http://uri.etsi.org/01903/v1.3.2#" xmlns:xades141="http://uri.etsi.org/01903/v1.4.1#" Target="#xmldsig-2dde88a8-def0-43e4-8570-b031015a46b4">
# <xades:SignedProperties Id="xmldsig-2dde88a8-def0-43e4-8570-b031015a46b4-signedprops">
# <xades:SignedSignatureProperties>
# <xades:SigningTime>2021-06-02T07:10:13.306+02:00</xades:SigningTime>
# <xades:SigningCertificate>
# <xades:Cert>
# <xades:CertDigest>
# <ds:DigestMethod Algorithm="http://www.w3.org/2001/04/xmlenc#sha256"/>
# <ds:DigestValue>...</ds:DigestValue>
# </xades:CertDigest>
# <xades:IssuerSerial>
# <ds:X509IssuerName>...</ds:X509IssuerName>
# <ds:X509SerialNumber>...</ds:X509SerialNumber>
# </xades:IssuerSerial>
# </xades:Cert>
# <xades:Cert>
# <xades:CertDigest>
# <ds:DigestMethod Algorithm="http://www.w3.org/2001/04/xmlenc#sha256"/>
# <ds:DigestValue>...</ds:DigestValue>
# </xades:CertDigest>
# <xades:IssuerSerial>
# <ds:X509IssuerName>...</ds:X509IssuerName>
# <ds:X509SerialNumber>...</ds:X509SerialNumber>
# </xades:IssuerSerial>
# </xades:Cert>
# <xades:Cert>
# <xades:CertDigest>
# <ds:DigestMethod Algorithm="http://www.w3.org/2001/04/xmlenc#sha256"/>
# <ds:DigestValue>...</ds:DigestValue>
# </xades:CertDigest>
# <xades:IssuerSerial>
# <ds:X509IssuerName>...</ds:X509IssuerName>
# <ds:X509SerialNumber>...</ds:X509SerialNumber>
# </xades:IssuerSerial>
# </xades:Cert>
# </xades:SigningCertificate>
# </xades:SignedSignatureProperties>
# </xades:SignedProperties>
# </xades:QualifyingProperties>
# </ds:Object>
# </ds:Signature>
#
set success 1
set gen [new_CkXmlDSigGen]
CkXmlDSigGen_put_SigLocation $gen ""
CkXmlDSigGen_put_SigLocationMod $gen 0
# Note: ID's simply need to be unique values in the signed XML document. They don't necessarily need to be GUID/UUID formatted.
CkXmlDSigGen_put_SigId $gen "xmldsig-2dde88a8-def0-43e4-8570-b031015a46b4"
CkXmlDSigGen_put_SigNamespacePrefix $gen "ds"
CkXmlDSigGen_put_SigNamespaceUri $gen "http://www.w3.org/2000/09/xmldsig#"
CkXmlDSigGen_put_SigValueId $gen "xmldsig-2dde88a8-def0-43e4-8570-b031015a46b4-sigvalue"
CkXmlDSigGen_put_SignedInfoCanonAlg $gen "C14N"
CkXmlDSigGen_put_SignedInfoDigestMethod $gen "sha256"
# Create an Object to be added to the Signature.
set object1 [new_CkXml]
CkXml_put_Tag $object1 "xades:QualifyingProperties"
CkXml_AddAttribute $object1 "xmlns:xades" "http://uri.etsi.org/01903/v1.3.2#"
CkXml_AddAttribute $object1 "xmlns:xades141" "http://uri.etsi.org/01903/v1.4.1#"
CkXml_AddAttribute $object1 "Target" "#xmldsig-2dde88a8-def0-43e4-8570-b031015a46b4"
CkXml_UpdateAttrAt $object1 "xades:SignedProperties" 1 "Id" "xmldsig-2dde88a8-def0-43e4-8570-b031015a46b4-signedprops"
CkXml_UpdateChildContent $object1 "xades:SignedProperties|xades:SignedSignatureProperties|xades:SigningTime" "TO BE GENERATED BY CHILKAT"
# This assumes there are 3 certs in the certificate chain: The signing certificate, an intermediate root, and the root CA.
# Remove the lines with "Cert[2]" if there is no intermediate root...
CkXml_UpdateAttrAt $object1 "xades:SignedProperties|xades:SignedSignatureProperties|xades:SigningCertificateV2|xades:Cert|xades:CertDigest|ds:DigestMethod" 1 "Algorithm" "http://www.w3.org/2001/04/xmlenc#sha256"
CkXml_UpdateChildContent $object1 "xades:SignedProperties|xades:SignedSignatureProperties|xades:SigningCertificateV2|xades:Cert|xades:CertDigest|ds:DigestValue" "TO BE GENERATED BY CHILKAT"
CkXml_UpdateChildContent $object1 "xades:SignedProperties|xades:SignedSignatureProperties|xades:SigningCertificateV2|xades:Cert|xades:IssuerSerialV2" "TO BE GENERATED BY CHILKAT"
CkXmlDSigGen_AddObject $gen "" [CkXml_getXml $object1] "" ""
set http [new_CkHttp]
set bd [new_CkBinData]
set url "https://isus.ezdrowie.gov.pl/fhir/Patient/123/_history/456"
set success [CkHttp_QuickGetBd $http $url $bd]
if {$success != 1} then {
puts [CkHttp_lastErrorText $http]
delete_CkXmlDSigGen $gen
delete_CkXml $object1
delete_CkHttp $http
delete_CkBinData $bd
exit
}
# -------- Reference 1 --------
CkXmlDSigGen_AddExternalBinaryRef $gen $url $bd "sha256" ""
CkXmlDSigGen_SetRefIdAttr $gen $url "xmldsig-2dde88a8-def0-43e4-8570-b031015a46b4-ref0"
# -------- Reference 2 --------
CkBinData_Clear $bd
set url "https://isus.ezdrowie.gov.pl/fhir/Encounter/789/_history/1"
set success [CkHttp_QuickGetBd $http $url $bd]
if {$success != 1} then {
puts [CkHttp_lastErrorText $http]
delete_CkXmlDSigGen $gen
delete_CkXml $object1
delete_CkHttp $http
delete_CkBinData $bd
exit
}
CkXmlDSigGen_AddExternalBinaryRef $gen $url $bd "sha256" ""
CkXmlDSigGen_SetRefIdAttr $gen $url "xmldsig-2dde88a8-def0-43e4-8570-b031015a46b4-ref1"
# -------- Reference 3 --------
CkBinData_Clear $bd
set url "https://isus.ezdrowie.gov.pl/fhir/Condition/123456/_history/1"
set success [CkHttp_QuickGetBd $http $url $bd]
if {$success != 1} then {
puts [CkHttp_lastErrorText $http]
delete_CkXmlDSigGen $gen
delete_CkXml $object1
delete_CkHttp $http
delete_CkBinData $bd
exit
}
CkXmlDSigGen_AddExternalBinaryRef $gen $url $bd "sha256" ""
CkXmlDSigGen_SetRefIdAttr $gen $url "xmldsig-2dde88a8-def0-43e4-8570-b031015a46b4-ref2"
# -------- Reference 4 --------
CkBinData_Clear $bd
set url "https://isus.ezdrowie.gov.pl/fhir/Procedure/123456/_history/1"
set success [CkHttp_QuickGetBd $http $url $bd]
if {$success != 1} then {
puts [CkHttp_lastErrorText $http]
delete_CkXmlDSigGen $gen
delete_CkXml $object1
delete_CkHttp $http
delete_CkBinData $bd
exit
}
CkXmlDSigGen_AddExternalBinaryRef $gen $url $bd "sha256" ""
CkXmlDSigGen_SetRefIdAttr $gen $url "xmldsig-2dde88a8-def0-43e4-8570-b031015a46b4-ref3"
# -------- Reference 5 --------
CkXmlDSigGen_AddObjectRef $gen "xmldsig-2dde88a8-def0-43e4-8570-b031015a46b4-signedprops" "sha256" "C14N" "" "http://uri.etsi.org/01903#SignedProperties"
# Provide a certificate + private key. (PFX password is test123)
set cert [new_CkCert]
set success [CkCert_LoadPfxFile $cert "qa_data/pfx/cert_test123.pfx" "test123"]
if {$success != 1} then {
puts [CkCert_lastErrorText $cert]
delete_CkXmlDSigGen $gen
delete_CkXml $object1
delete_CkHttp $http
delete_CkBinData $bd
delete_CkCert $cert
exit
}
CkXmlDSigGen_SetX509Cert $gen $cert 1
CkXmlDSigGen_put_KeyInfoType $gen "X509Data"
CkXmlDSigGen_put_X509Type $gen "IssuerSerial,SubjectName,Certificate"
# This will be an enveloping signature where the Signature element
# is the XML document root, the signed data is contained within Object
# tag(s) within the Signature.
# Therefore, pass an empty sbXml to CreateXmlDsigSb.
set sbXml [new_CkStringBuilder]
CkXmlDSigGen_put_Behaviors $gen "IndentedSignature"
# Sign the XML...
set success [CkXmlDSigGen_CreateXmlDSigSb $gen $sbXml]
if {$success != 1} then {
puts [CkXmlDSigGen_lastErrorText $gen]
delete_CkXmlDSigGen $gen
delete_CkXml $object1
delete_CkHttp $http
delete_CkBinData $bd
delete_CkCert $cert
delete_CkStringBuilder $sbXml
exit
}
# -----------------------------------------------
# Save the signed XML to a file.
set success [CkStringBuilder_WriteFile $sbXml "qa_output/signedXml.xml" "utf-8" 0]
puts [CkStringBuilder_getAsString $sbXml]
# ----------------------------------------
# Verify the signature we just produced...
set verifier [new_CkXmlDSig]
set success [CkXmlDSig_LoadSignatureSb $verifier $sbXml]
if {$success != 1} then {
puts [CkXmlDSig_lastErrorText $verifier]
delete_CkXmlDSigGen $gen
delete_CkXml $object1
delete_CkHttp $http
delete_CkBinData $bd
delete_CkCert $cert
delete_CkStringBuilder $sbXml
delete_CkXmlDSig $verifier
exit
}
set verified [CkXmlDSig_VerifySignature $verifier 1]
if {$verified != 1} then {
puts [CkXmlDSig_lastErrorText $verifier]
delete_CkXmlDSigGen $gen
delete_CkXml $object1
delete_CkHttp $http
delete_CkBinData $bd
delete_CkCert $cert
delete_CkStringBuilder $sbXml
delete_CkXmlDSig $verifier
exit
}
puts "This signature was successfully verified."
delete_CkXmlDSigGen $gen
delete_CkXml $object1
delete_CkHttp $http
delete_CkBinData $bd
delete_CkCert $cert
delete_CkStringBuilder $sbXml
delete_CkXmlDSig $verifier