(PureBasic) Sign XML (XAdES) in the Cloud using AWS KMS

See more Signing in the Cloud Examples

Demonstrates how to sign XML using AWS KMS. The signing of the hash happens in AWK KMS. Everything else involving the updating the XML to add the signature happens locally within Chilkat.

Note: This example requires Chilkat v9.5.0.96 or greater.

Chilkat PureBasic Module Download Chilkat PureBasic Module

IncludeFile "CkXmlDSigGen.pb"
IncludeFile "CkCert.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkJsonObject.pb"

Procedure ChilkatExample()

    ; This example requires the Chilkat API to have been previously unlocked.
    ; See Global Unlock Sample for sample code.

    ; Create the XML to be signed.
    sbXml.i = CkStringBuilder::ckCreate()
    If sbXml.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    bCrlf.i = 1
    CkStringBuilder::ckAppendLine(sbXml,"<?xml version=" + Chr(34) + "1.0" + Chr(34) + " encoding=" + Chr(34) + "UTF-8" + Chr(34) + " standalone=" + Chr(34) + "no" + Chr(34) + " ?>",bCrlf)
    CkStringBuilder::ckAppendLine(sbXml,"<SOAP-ENV:Envelope xmlns:SOAP-ENV=" + Chr(34) + "http://schemas.xmlsoap.org/soap/envelope/" + Chr(34) + ">",bCrlf)
    CkStringBuilder::ckAppendLine(sbXml,"    <SOAP-ENV:Header>",bCrlf)
    CkStringBuilder::ckAppendLine(sbXml,"        <wsse:Security xmlns:wsse=" + Chr(34) + "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" + Chr(34) + " SOAP-ENV:mustUnderstand=" + Chr(34) + "1" + Chr(34) + "></wsse:Security>",bCrlf)
    CkStringBuilder::ckAppendLine(sbXml,"    </SOAP-ENV:Header>",bCrlf)
    CkStringBuilder::ckAppendLine(sbXml,"    <SOAP-ENV:Body xmlns:SOAP-SEC=" + Chr(34) + "http://schemas.xmlsoap.org/soap/security/2000-12" + Chr(34) + " SOAP-SEC:id=" + Chr(34) + "Body" + Chr(34) + ">",bCrlf)
    CkStringBuilder::ckAppendLine(sbXml,"        <z:FooBar xmlns:z=" + Chr(34) + "http://example.com" + Chr(34) + " />",bCrlf)
    CkStringBuilder::ckAppendLine(sbXml,"    </SOAP-ENV:Body>",bCrlf)
    CkStringBuilder::ckAppendLine(sbXml,"</SOAP-ENV:Envelope>",bCrlf)

    ; Load the certificate used for signing.  The certificate's private key is stored in AWS KMS
    ; However, we still need the certificate locally (without private key).
    cert.i = CkCert::ckCreate()
    If cert.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i = CkCert::ckLoadFromFile(cert,"qa_data/certs/myCert.cer")
    If success = 0
        Debug CkCert::ckLastErrorText(cert)
        CkStringBuilder::ckDispose(sbXml)
        CkCert::ckDispose(cert)
        ProcedureReturn
    EndIf

    ; Here's a screenshot of our private key AWS KMS:
    

    ; To sign using AWS KMS, 
    ; add the following lines of code to specify your AWS authentication credentials,
    ; and the ID of the KMS private key.
    jsonAwsKms.i = CkJsonObject::ckCreate()
    If jsonAwsKms.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; Set the "service" equal to "aws_kms" to tell Chilkat to use AWS KMS for signing.
    CkJsonObject::ckUpdateString(jsonAwsKms,"service","aws_kms")
    CkJsonObject::ckUpdateString(jsonAwsKms,"access_key","ACCESS_KEY")
    CkJsonObject::ckUpdateString(jsonAwsKms,"secret_key","SECRET_KEY")
    ; Make sure to specify the correct region for your case.
    CkJsonObject::ckUpdateString(jsonAwsKms,"region","us-west-2")
    ; In the above screenshot, our key ID is "187012e8-008f-4fc7-b100-5efe6146dff2".  You will use your key ID.
    CkJsonObject::ckUpdateString(jsonAwsKms,"key_id","187012e8-008f-4fc7-b100-5efe6146dff2")

    success = CkCert::ckSetCloudSigner(cert,jsonAwsKms)

    ; Prepare for signing...
    gen.i = CkXmlDSigGen::ckCreate()
    If gen.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; Indicate where the Signature will be inserted.
    CkXmlDSigGen::setCkSigLocation(gen, "SOAP-ENV:Envelope|SOAP-ENV:Header|wsse:Security")

    ; Add a reference to the fragment of the XML to be signed.

    ; Note: "Body" refers to the XML element having an "id" equal to "Body", where "id" is case insensitive
    ; and where any namespace might qualify the attribute.  In this case, the SOAP-ENV:Body fragment is signed
    ; NOT because the tag = "Body", but because it has SOAP-SEC:id="Body"
    CkXmlDSigGen::ckAddSameDocRef(gen,"Body","sha1","EXCL_C14N","","")

    ; (You can read about the SignedInfoPrefixList in the online reference documentation.  It's optional..)
    CkXmlDSigGen::setCkSignedInfoPrefixList(gen, "wsse SOAP-ENV")

    CkXmlDSigGen::setCkKeyInfoType(gen, "X509Data")
    CkXmlDSigGen::setCkX509Type(gen, "IssuerSerial")

    bUsePrivateKey.i = 1
    success = CkXmlDSigGen::ckSetX509Cert(gen,cert,bUsePrivateKey)
    If success <> 1
        Debug CkXmlDSigGen::ckLastErrorText(gen)
        CkCert::ckDispose(cert)

        CkStringBuilder::ckDispose(sbXml)
        CkCert::ckDispose(cert)
        CkJsonObject::ckDispose(jsonAwsKms)
        CkXmlDSigGen::ckDispose(gen)
        ProcedureReturn
    EndIf

    ; Everything's specified.  Now create and insert the Signature
    ; (The actual signing of the hash will happen on the AWS KMS server.)
    success = CkXmlDSigGen::ckCreateXmlDSigSb(gen,sbXml)
    If success <> 1
        Debug CkXmlDSigGen::ckLastErrorText(gen)
        CkStringBuilder::ckDispose(sbXml)
        CkCert::ckDispose(cert)
        CkJsonObject::ckDispose(jsonAwsKms)
        CkXmlDSigGen::ckDispose(gen)
        ProcedureReturn
    EndIf

    ; Examine the XML with the digital signature inserted
    Debug CkStringBuilder::ckGetAsString(sbXml)

    ; --------------------------------------------------------------------------------
    ; Also see Chilkat's Online WSDL Code Generator
    ; to generate code and SOAP Request and Response XML for each operation in a WSDL.
    ; --------------------------------------------------------------------------------


    CkStringBuilder::ckDispose(sbXml)
    CkCert::ckDispose(cert)
    CkJsonObject::ckDispose(jsonAwsKms)
    CkXmlDSigGen::ckDispose(gen)


    ProcedureReturn
EndProcedure