(Excel) Create XML Signature with KeyInfo / X509Data / X509IssuerSerial

This example demonstrates how to create an XML Digital Signature where the KeyInfo element contains an X509Data element,
which in turn contains an X509IssuerSerial element which contains only the issuing cert's distinguished name and the signing cert's serial number.

Download Excel Class Modules Chilkat Excel Class Modules

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

' To begin, we'll need a PFX containing a certificate and private key, and the SOAP XML to be signed.
' Chilkat provides sample data at chilkatsoft.com and chilkatdownload.com, and our first step is to download.

' -------------------------------------------------------------------------
' Step 1: Get the SOAP XML to be signed.
' 
Dim sbXml As Chilkat.StringBuilder
Set sbXml = Chilkat.NewStringBuilder

Dim http As Chilkat.Http
Set http = Chilkat.NewHttp

success = http.QuickGetSb("https://www.chilkatsoft.com/exampleData/soapToSign.xml",sbXml)
If (success <> True) Then
    Debug.Print http.LastErrorText
    Exit Sub
End If

' The SOAP XML contains this:

' <?xml version="1.0" encoding="UTF-8" standalone="no" ?>
' <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
'     <SOAP-ENV:Header>
'         <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>
'     </SOAP-ENV:Header>
'     <SOAP-ENV:Body xmlns:SOAP-SEC="http://schemas.xmlsoap.org/soap/security/2000-12" SOAP-SEC:id="Body">
'         <z:FooBar xmlns:z="http://example.com" />
'     </SOAP-ENV:Body>
' </SOAP-ENV:Envelope>

' -------------------------------------------------------------------------
' Step 2: Get the test certificate and private key stored in a .pfx
' 
Dim pfxData As Chilkat.BinData
Set pfxData = Chilkat.NewBinData
success = http.QuickGetBd("https://chilkatdownload.com/example_data/testcertificate.pfx",pfxData)
If (success <> True) Then
    Debug.Print http.LastErrorText
    Exit Sub
End If

Dim pfx As Chilkat.Pfx
Set pfx = Chilkat.NewPfx

password = "test"
success = pfx.LoadPfxEncoded(pfxData.GetEncoded("base64"),"base64",password)
If (success <> True) Then
    Debug.Print pfx.LastErrorText
    Exit Sub
End If

' -------------------------------------------------------------------------
' Step 3: Get the certificate from the PFX.
' 

Set cert = pfx.GetCert(0)
If (pfx.LastMethodSuccess <> True) Then
    Debug.Print pfx.LastErrorText
    Exit Sub
End If

' Prepare for signing...
Dim gen As Chilkat.XmlDSigGen
Set gen = Chilkat.NewXmlDSigGen

' Indicate where the Signature will be inserted.
gen.SigLocation = "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"
Dim success As Boolean
success = gen.AddSameDocRef("Body","sha1","EXCL_C14N","","")

' (You can read about the SignedInfoPrefixList in the online reference documentation.  It's optional..)
gen.SignedInfoPrefixList = "wsse SOAP-ENV"

' Provide the private key for signing via the certificate, and indicate that
' we want only the Issuer's DN and serial number of the certificate embedded in the KeyInfo.
gen.KeyInfoType = "X509Data"
gen.X509Type = "IssuerSerial"

' Note: Because our certificate was loaded from a PFX which also contained the private key,
' Chilkat automatically knows and has the private key associated with the certificate.
' We set bUsePrivateKey to tell the SetX509Cert method to automatically use the private key
' associated with the certificate for signing.  If, for example, we obtained the certificate
' by loading from a .cer file, then we would not already have the associated private key.
' In that case, the application could explicitly load the cert's private key from some
' other source, such as a .key, .pem, etc. and then call gen.SetPrivateKey.

bUsePrivateKey = True
success = gen.SetX509Cert(cert,bUsePrivateKey)
If (success <> True) Then
    Debug.Print gen.LastErrorText

    Exit Sub
End If

' Everything's specified.  Now create and insert the Signature
success = gen.CreateXmlDSigSb(sbXml)
If (success <> True) Then
    Debug.Print gen.LastErrorText
    Exit Sub
End If

' Examine the XML with the digital signature inserted
Debug.Print sbXml.GetAsString()

' Here is the actual output.  A pretty-printed version of the output is shown below, but the addition of whitespace
' in the XML invalidates the signature.

' <?xml version="1.0" encoding="UTF-8" standalone="no" ?>
' <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
'     <SOAP-ENV:Header>
'         <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" SOAP-ENV:mustUnderstand="1"><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#"><InclusiveNamespaces xmlns="http://www.w3.org/2001/10/xml-exc-c14n#" PrefixList="wsse SOAP-ENV"/></ds:CanonicalizationMethod><ds:SignatureMethod Algorithm="http://www.w3.org/2001/04/xmldsig-more#rsa-sha256"/><ds:Reference URI="#Body"><ds:Transforms><ds:Transform Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#"/></ds:Transforms><ds:DigestMethod Algorithm="http://www.w3.org/2000/09/xmldsig#sha1"/><ds:DigestValue>PIiVPpuMc1jGpWaL8ftzTOcc4gc=</ds:DigestValue></ds:Reference></ds:SignedInfo><ds:SignatureValue>Rlta8LplnFH0q8L+UeVmh4Smdn6oVETi4RoUmpT/KQX3RNAIOdCVE3b7gjmx5+3vp3DhjphOsZvW6dXzkI46xt9pD5otp3b/ZppGqKzltggo9gyQtPvJ8ltJZqVKYOGo5uElRFF/xm/zcx5Y3E14t+LYVSlv2lbem/zZ5zQ7ai8DmGD33id7nGu+MXVwb3kGkJFYoB/GOXtwsep+bcilMglTp8/7SBfBaVFKxWVBp4N2NW7bGlyDct8FaCk9hXQDNm/kqne9GU87tgh8/rbsFCYgyqIRMIvMPvhRWr2EKdEKyLtlZ8w0KYJYpgsf4T7SDghemzXkJoJPrfUQmHudIw==</ds:SignatureValue><ds:KeyInfo><ds:X509Data><ds:X509IssuerSerial><ds:X509IssuerName>CN=Test Company, C=AU, ST=Some-State, O=Internet Widgits Pty Ltd</ds:X509IssuerName><ds:X509SerialNumber>00</ds:X509SerialNumber></ds:X509IssuerSerial></ds:X509Data></ds:KeyInfo></ds:Signature></wsse:Security>
'     </SOAP-ENV:Header>
'     <SOAP-ENV:Body xmlns:SOAP-SEC="http://schemas.xmlsoap.org/soap/security/2000-12" SOAP-SEC:id="Body">
'         <z:FooBar xmlns:z="http://example.com" />
'     </SOAP-ENV:Body>
' </SOAP-ENV:Envelope>

' ----------------------------------------------------------------
' Pretty-printed output (invalidates the signature)
' This makes it easier to see the X509IssuerSerial contained within the KeyInfo.

' <?xml version="1.0" encoding="UTF-8" standalone="no" ?>
' <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
'     <SOAP-ENV:Header>
'         <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" SOAP-ENV:mustUnderstand="1">
'             <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#">
'                         <InclusiveNamespaces xmlns="http://www.w3.org/2001/10/xml-exc-c14n#" PrefixList="wsse SOAP-ENV" />
'                     </ds:CanonicalizationMethod>
'                     <ds:SignatureMethod Algorithm="http://www.w3.org/2001/04/xmldsig-more#rsa-sha256" />
'                     <ds:Reference URI="#Body">
'                         <ds:Transforms>
'                             <ds:Transform Algorithm="http://www.w3.org/2001/10/xml-exc-c14n#" />
'                         </ds:Transforms>
'                         <ds:DigestMethod Algorithm="http://www.w3.org/2000/09/xmldsig#sha1" />
'                         <ds:DigestValue>PIiVPpuMc1jGpWaL8ftzTOcc4gc=</ds:DigestValue>
'                     </ds:Reference>
'                 </ds:SignedInfo>
'                 <ds:SignatureValue>Rlta8LplnFH0q8L+UeVmh4Smdn6oVETi4RoUmpT/KQX3RNAIOdCVE3b7gjmx5+3vp3DhjphOsZvW6dXzkI46xt9pD5otp3b/ZppGqKzltggo9gyQtPvJ8ltJZqVKYOGo5uElRFF/xm/zcx5Y3E14t+LYVSlv2lbem/zZ5zQ7ai8DmGD33id7nGu+MXVwb3kGkJFYoB/GOXtwsep+bcilMglTp8/7SBfBaVFKxWVBp4N2NW7bGlyDct8FaCk9hXQDNm/kqne9GU87tgh8/rbsFCYgyqIRMIvMPvhRWr2EKdEKyLtlZ8w0KYJYpgsf4T7SDghemzXkJoJPrfUQmHudIw==</ds:SignatureValue>
'                 <ds:KeyInfo>
'                     <ds:X509Data>
'                         <ds:X509IssuerSerial>
'                             <ds:X509IssuerName>CN=Test Company, C=AU, ST=Some-State, O=Internet Widgits Pty Ltd</ds:X509IssuerName>
'                             <ds:X509SerialNumber>00</ds:X509SerialNumber>
'                         </ds:X509IssuerSerial>
'                     </ds:X509Data>
'                 </ds:KeyInfo>
'             </ds:Signature>
'         </wsse:Security>
'     </SOAP-ENV:Header>
'     <SOAP-ENV:Body xmlns:SOAP-SEC="http://schemas.xmlsoap.org/soap/security/2000-12" SOAP-SEC:id="Body">
'         <z:FooBar xmlns:z="http://example.com" />
'     </SOAP-ENV:Body>
' </SOAP-ENV:Envelope>
'