DataFlex

Sign XML (XAdES) in the Cloud using Azure Key Vault

See more Signing in the Cloud Examples

Demonstrates how to sign XML using Azure Key Vault. The signing of the hash happens in the Cloud on Azure Key Vault. 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.

DataFlex

Use ChilkatAx-win32.pkg

Procedure Test
    Boolean iSuccess
    Variant vSbXml
    Handle hoSbXml
    Boolean iBCrlf
    Variant vCert
    Handle hoCert
    Variant vJsonAzure
    Handle hoJsonAzure
    Handle hoGen
    Boolean iBUsePrivateKey
    String sTemp1

    Move False To iSuccess

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

    // Create the XML to be signed.
    Get Create (RefClass(cComChilkatStringBuilder)) To hoSbXml
    If (Not(IsComObjectCreated(hoSbXml))) Begin
        Send CreateComObject of hoSbXml
    End

    Move True To iBCrlf
    Get ComAppendLine Of hoSbXml '<?xml version="1.0" encoding="UTF-8" standalone="no" ?>' iBCrlf To iSuccess
    Get ComAppendLine Of hoSbXml '<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">' iBCrlf To iSuccess
    Get ComAppendLine Of hoSbXml "    <SOAP-ENV:Header>" iBCrlf To iSuccess
    Get ComAppendLine Of hoSbXml '        <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" SOAP-ENV:mustUnderstand="1"></wsse:Security>' iBCrlf To iSuccess
    Get ComAppendLine Of hoSbXml "    </SOAP-ENV:Header>" iBCrlf To iSuccess
    Get ComAppendLine Of hoSbXml '    <SOAP-ENV:Body xmlns:SOAP-SEC="http://schemas.xmlsoap.org/soap/security/2000-12" SOAP-SEC:id="Body">' iBCrlf To iSuccess
    Get ComAppendLine Of hoSbXml '        <z:FooBar xmlns:z="http://example.com" />' iBCrlf To iSuccess
    Get ComAppendLine Of hoSbXml "    </SOAP-ENV:Body>" iBCrlf To iSuccess
    Get ComAppendLine Of hoSbXml "</SOAP-ENV:Envelope>" iBCrlf To iSuccess

    // Load the certificate used for signing.  The certificate's private key is stored in 
    // the Azure Key Vault.
    // However, we still need the certificate locally (without private key).
    Get Create (RefClass(cComChilkatCert)) To hoCert
    If (Not(IsComObjectCreated(hoCert))) Begin
        Send CreateComObject of hoCert
    End
    Get ComLoadFromFile Of hoCert "qa_data/certs/myCert.cer" To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoCert To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // Here's a screenshot of our certificate with private key on Azure Key Vault:
    // (image:https://example-code.com/images/azure_key_vault.jpg/endImage)

    // To sign using the Azure Key Vault, 
    // add the following lines of code to specify your authentication credentials,
    // and the name of the certificate w/ private key on the Azure server to be used.
    Get Create (RefClass(cComChilkatJsonObject)) To hoJsonAzure
    If (Not(IsComObjectCreated(hoJsonAzure))) Begin
        Send CreateComObject of hoJsonAzure
    End
    // Set the "service" equal to "azure_keyvault" to tell Chilkat to use Azure Key Vault for signing.
    Get ComUpdateString Of hoJsonAzure "service" "azure_keyvault" To iSuccess
    Get ComUpdateString Of hoJsonAzure "client_id" "APP_ID" To iSuccess
    Get ComUpdateString Of hoJsonAzure "client_secret" "APP_PASSWORD" To iSuccess
    Get ComUpdateString Of hoJsonAzure "tenant_id" "TENANT_ID" To iSuccess
    // In the above screenshot, our vault name is "kvchilkat".  You will use your vault name.
    Get ComUpdateString Of hoJsonAzure "vault_name" "VAULT_NAME" To iSuccess
    // In the above screenshot, our cert name is "ChilkatTest1".  You will use your cert name.
    Get ComUpdateString Of hoJsonAzure "cert_name" "CERT_NAME" To iSuccess
    // In the above screenshot, our cert version is "63b94a23389546ecbc8eb6208a1bef37".  You will use your cert version.
    Get ComUpdateString Of hoJsonAzure "cert_version" "CERT_VERSION" To iSuccess
    Get pvComObject of hoJsonAzure to vJsonAzure
    Get ComSetCloudSigner Of hoCert vJsonAzure To iSuccess

    // Prepare for signing...
    Get Create (RefClass(cComChilkatXmlDSigGen)) To hoGen
    If (Not(IsComObjectCreated(hoGen))) Begin
        Send CreateComObject of hoGen
    End

    // Indicate where the Signature will be inserted.
    Set ComSigLocation Of hoGen To "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"
    Get ComAddSameDocRef Of hoGen "Body" "sha1" "EXCL_C14N" "" "" To iSuccess

    // (You can read about the SignedInfoPrefixList in the online reference documentation.  It's optional..)
    Set ComSignedInfoPrefixList Of hoGen To "wsse SOAP-ENV"

    Set ComKeyInfoType Of hoGen To "X509Data"
    Set ComX509Type Of hoGen To "IssuerSerial"

    Move True To iBUsePrivateKey
    Get pvComObject of hoCert to vCert
    Get ComSetX509Cert Of hoGen vCert iBUsePrivateKey To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoGen To sTemp1
        Showln sTemp1
        Send Destroy of hoCert
        Procedure_Return
    End

    // Everything's specified.  Now create and insert the Signature
    // (The actual signing of the hash will happen on the Aruba server.)
    Get pvComObject of hoSbXml to vSbXml
    Get ComCreateXmlDSigSb Of hoGen vSbXml To iSuccess
    If (iSuccess <> True) Begin
        Get ComLastErrorText Of hoGen To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    // Examine the XML with the digital signature inserted
    Get ComGetAsString Of hoSbXml To sTemp1
    Showln sTemp1

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


End_Procedure