Sample code for 30+ languages & platforms
Swift

XML Signature Multiple External References

See more XML Digital Signatures Examples

Demonstrates how to add multiple external references to an XML digital signature.

Chilkat Swift Downloads

Swift

func chilkatTest() {
    var success: Bool = false

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

    success = true
    let gen = CkoXmlDSigGen()!

    gen.sigLocation = ""
    gen.sigLocationMod = 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.
    gen.sigId = "xmldsig-2dde88a8-def0-43e4-8570-b031015a46b4"
    gen.sigNamespacePrefix = "ds"
    gen.sigNamespaceUri = "http://www.w3.org/2000/09/xmldsig#"
    gen.sigValueId = "xmldsig-2dde88a8-def0-43e4-8570-b031015a46b4-sigvalue"
    gen.signedInfoCanonAlg = "C14N"
    gen.signedInfoDigestMethod = "sha256"

    // Create an Object to be added to the Signature.
    let object1 = CkoXml()!
    object1.tag = "xades:QualifyingProperties"
    object1.addAttribute(name: "xmlns:xades", value: "http://uri.etsi.org/01903/v1.3.2#")
    object1.addAttribute(name: "xmlns:xades141", value: "http://uri.etsi.org/01903/v1.4.1#")
    object1.addAttribute(name: "Target", value: "#xmldsig-2dde88a8-def0-43e4-8570-b031015a46b4")
    object1.updateAttrAt(tagPath: "xades:SignedProperties", autoCreate: true, attrName: "Id", attrValue: "xmldsig-2dde88a8-def0-43e4-8570-b031015a46b4-signedprops")
    object1.updateChildContent(tagPath: "xades:SignedProperties|xades:SignedSignatureProperties|xades:SigningTime", value: "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...
    object1.updateAttrAt(tagPath: "xades:SignedProperties|xades:SignedSignatureProperties|xades:SigningCertificateV2|xades:Cert|xades:CertDigest|ds:DigestMethod", autoCreate: true, attrName: "Algorithm", attrValue: "http://www.w3.org/2001/04/xmlenc#sha256")
    object1.updateChildContent(tagPath: "xades:SignedProperties|xades:SignedSignatureProperties|xades:SigningCertificateV2|xades:Cert|xades:CertDigest|ds:DigestValue", value: "TO BE GENERATED BY CHILKAT")
    object1.updateChildContent(tagPath: "xades:SignedProperties|xades:SignedSignatureProperties|xades:SigningCertificateV2|xades:Cert|xades:IssuerSerialV2", value: "TO BE GENERATED BY CHILKAT")

    gen.add(id: "", content: object1.getXml(), mimeType: "", encoding: "")

    let http = CkoHttp()!
    let bd = CkoBinData()!

    var url: String? = "https://isus.ezdrowie.gov.pl/fhir/Patient/123/_history/456"
    success = http.quickGetBd(url: url, binData: bd)
    if success != true {
        print("\(http.lastErrorText!)")
        return
    }

    // -------- Reference 1 --------
    gen.addExternalBinaryRef(uri: url, content: bd, digestMethod: "sha256", refType: "")
    gen.setRefIdAttr(uri_or_id: url, value: "xmldsig-2dde88a8-def0-43e4-8570-b031015a46b4-ref0")

    // -------- Reference 2 --------
    bd.clear()
    url = "https://isus.ezdrowie.gov.pl/fhir/Encounter/789/_history/1"
    success = http.quickGetBd(url: url, binData: bd)
    if success != true {
        print("\(http.lastErrorText!)")
        return
    }

    gen.addExternalBinaryRef(uri: url, content: bd, digestMethod: "sha256", refType: "")
    gen.setRefIdAttr(uri_or_id: url, value: "xmldsig-2dde88a8-def0-43e4-8570-b031015a46b4-ref1")

    // -------- Reference 3 --------
    bd.clear()
    url = "https://isus.ezdrowie.gov.pl/fhir/Condition/123456/_history/1"
    success = http.quickGetBd(url: url, binData: bd)
    if success != true {
        print("\(http.lastErrorText!)")
        return
    }

    gen.addExternalBinaryRef(uri: url, content: bd, digestMethod: "sha256", refType: "")
    gen.setRefIdAttr(uri_or_id: url, value: "xmldsig-2dde88a8-def0-43e4-8570-b031015a46b4-ref2")

    // -------- Reference 4 --------
    bd.clear()
    url = "https://isus.ezdrowie.gov.pl/fhir/Procedure/123456/_history/1"
    success = http.quickGetBd(url: url, binData: bd)
    if success != true {
        print("\(http.lastErrorText!)")
        return
    }

    gen.addExternalBinaryRef(uri: url, content: bd, digestMethod: "sha256", refType: "")
    gen.setRefIdAttr(uri_or_id: url, value: "xmldsig-2dde88a8-def0-43e4-8570-b031015a46b4-ref3")

    // -------- Reference 5 --------
    gen.addObjectRef(id: "xmldsig-2dde88a8-def0-43e4-8570-b031015a46b4-signedprops", digestMethod: "sha256", canonMethod: "C14N", prefixList: "", refType: "http://uri.etsi.org/01903#SignedProperties")

    // Provide a certificate + private key. (PFX password is test123)
    let cert = CkoCert()!
    success = cert.loadPfxFile(path: "qa_data/pfx/cert_test123.pfx", password: "test123")
    if success != true {
        print("\(cert.lastErrorText!)")
        return
    }

    gen.setX509Cert(cert: cert, usePrivateKey: true)

    gen.keyInfoType = "X509Data"
    gen.x509Type = "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.
    let sbXml = CkoStringBuilder()!

    gen.behaviors = "IndentedSignature"

    // Sign the XML...
    success = gen.createXmlDSigSb(sbXml: sbXml)
    if success != true {
        print("\(gen.lastErrorText!)")
        return
    }

    // -----------------------------------------------

    // Save the signed XML to a file.
    success = sbXml.writeFile(path: "qa_output/signedXml.xml", charset: "utf-8", emitBom: false)

    print("\(sbXml.getAsString()!)")

    // ----------------------------------------
    // Verify the signature we just produced...
    let verifier = CkoXmlDSig()!
    success = verifier.loadSignatureSb(sbXmlSig: sbXml)
    if success != true {
        print("\(verifier.lastErrorText!)")
        return
    }

    var verified: Bool = verifier.verifySignature(verifyReferenceDigests: true)
    if verified != true {
        print("\(verifier.lastErrorText!)")
        return
    }

    print("This signature was successfully verified.")

}