PureBasic

Create XML Digital Signature using HMAC Key

See more XML Digital Signatures Examples

Demonstrates how to create an XML digital signature using an HMAC key. PureBasic

IncludeFile "CkXmlDSigGen.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkStringBuilder.pb"

Procedure ChilkatExample()

    success.i = 0

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

    ; Signs the following XML using an HMAC key.

    ; <?xml version="1.0" encoding="UTF-8" standalone="no"?>
    ; <collection Id="root">
    ; 	<album>
    ; 		<title>Questions, unanswered</title>
    ; 		<artist>Steve and the flubberblubs</artist>
    ; 		<year>1989</year>
    ; 		<t:tracks xmlns:t="http://test.xades4j/tracks">
    ; 			<t:song length="4:05" tracknumber="1">
    ; 				<t:title>What do you know?</t:title>
    ; 				<t:artist>Steve and the flubberblubs</t:artist>
    ; 				<t:lastplayed>2006-10-17-08:31</t:lastplayed>
    ; 			</t:song>
    ; 			<t:song length="3:45" tracknumber="2">
    ; 				<t:title>Who do you know?</t:title>
    ; 				<t:artist>Steve and the flubberblubs</t:artist>
    ; 				<t:lastplayed>2006-10-17-08:35</t:lastplayed>
    ; 			</t:song>
    ; 			<t:song length="5:14" tracknumber="3">
    ; 				<t:title>When do you know?</t:title>
    ; 				<t:artist>Steve and the flubberblubs</t:artist>
    ; 				<t:lastplayed>2006-10-17-08:39</t:lastplayed>
    ; 			</t:song>
    ; 			<t:song length="4:19" tracknumber="4">
    ; 				<t:title>Do you know?</t:title>
    ; 				<t:artist>Steve and the flubberblubs</t:artist>
    ; 				<t:lastplayed>2006-10-17-08:44</t:lastplayed>
    ; 			</t:song>
    ; 		</t:tracks>
    ; 	</album>
    ; </collection>
    ; 

    ; The above XML is available at https://www.chilkatsoft.com/exampleData/flubberblub.xml
    ; Fetch the XML and then sign it..

    url.s = "https://www.chilkatsoft.com/exampleData/flubberblub.xml"
    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    sbXml.i = CkStringBuilder::ckCreate()
    If sbXml.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success = CkHttp::ckQuickGetSb(http,url,sbXml)
    If success <> 1
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkStringBuilder::ckDispose(sbXml)
        ProcedureReturn
    EndIf

    xmlSigGen.i = CkXmlDSigGen::ckCreate()
    If xmlSigGen.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    ; The Signature will be inserted under the "collection" element.
    CkXmlDSigGen::setCkSigLocation(xmlSigGen, "collection")

    ; Sign everything in <collection Id="root"> ... </collection>
    CkXmlDSigGen::ckAddSameDocRef(xmlSigGen,"root","sha256","C14N","","")

    ; Specify the HMAC key.
    ; For example, if the HMAC key is to be the us-ascii bytes of the string "secret",
    ; the HMAC key can be set in any of the following ways (and also more ways not shown here..)
    CkXmlDSigGen::ckSetHmacKey(xmlSigGen,"secret","ascii")
    ; or
    CkXmlDSigGen::ckSetHmacKey(xmlSigGen,"c2VjcmV0","base64")
    ; or
    CkXmlDSigGen::ckSetHmacKey(xmlSigGen,"736563726574","hex")

    ; Sign the XML..
    success = CkXmlDSigGen::ckCreateXmlDSigSb(xmlSigGen,sbXml)
    If success <> 1
        Debug CkXmlDSigGen::ckLastErrorText(xmlSigGen)
        CkHttp::ckDispose(http)
        CkStringBuilder::ckDispose(sbXml)
        CkXmlDSigGen::ckDispose(xmlSigGen)
        ProcedureReturn
    EndIf

    ; Examine the signed XML:
    Debug CkStringBuilder::ckGetAsString(sbXml)

    ; The output is:
    ; 
    ; <?xml version="1.0" encoding="UTF-8" standalone="no"?>
    ; <collection Id="root">
    ; 	<album>
    ; 		<title>Questions, unanswered</title>
    ; 		<artist>Steve and the flubberblubs</artist>
    ; 		<year>1989</year>
    ; 		<t:tracks xmlns:t="http://test.xades4j/tracks">
    ; 			<t:song length="4:05" tracknumber="1">
    ; 				<t:title>What do you know?</t:title>
    ; 				<t:artist>Steve and the flubberblubs</t:artist>
    ; 				<t:lastplayed>2006-10-17-08:31</t:lastplayed>
    ; 			</t:song>
    ; 			<t:song length="3:45" tracknumber="2">
    ; 				<t:title>Who do you know?</t:title>
    ; 				<t:artist>Steve and the flubberblubs</t:artist>
    ; 				<t:lastplayed>2006-10-17-08:35</t:lastplayed>
    ; 			</t:song>
    ; 			<t:song length="5:14" tracknumber="3">
    ; 				<t:title>When do you know?</t:title>
    ; 				<t:artist>Steve and the flubberblubs</t:artist>
    ; 				<t:lastplayed>2006-10-17-08:39</t:lastplayed>
    ; 			</t:song>
    ; 			<t:song length="4:19" tracknumber="4">
    ; 				<t:title>Do you know?</t:title>
    ; 				<t:artist>Steve and the flubberblubs</t:artist>
    ; 				<t:lastplayed>2006-10-17-08:44</t:lastplayed>
    ; 			</t:song>
    ; 		</t:tracks>
    ; 	</album>
    ; <ds:Signature xmlns:ds="http://www.w3.org/2000/09/xmldsig#"><ds:SignedInfo><ds:CanonicalizationMethod Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#"/><ds:SignatureMethod Algorithm="http://www.w3.org/2001/04/xmldsig-more#hmac-sha256"/><ds:Reference URI="#root"><ds:Transforms><ds:Transform Algorithm="http://www.w3.org/2000/09/xmldsig#enveloped-signature"/></ds:Transforms><ds:DigestMethod Algorithm="http://www.w3.org/2001/04/xmlenc#sha256"/><ds:DigestValue>rD/g8soqKz8EiPUBhEWfcQacS0ta4ULHX3dKMEH6ZoQ=</ds:DigestValue></ds:Reference></ds:SignedInfo><ds:SignatureValue>R8dXP95VRYJBfL6d0Peogybdk27+R+JIfX8jnVu0NOI=</ds:SignatureValue></ds:Signature></collection>
    ; 


    CkHttp::ckDispose(http)
    CkStringBuilder::ckDispose(sbXml)
    CkXmlDSigGen::ckDispose(xmlSigGen)


    ProcedureReturn
EndProcedure