Chilkat Examples

ChilkatHOMEAndroid™Classic ASPCC++C#Mono C#.NET Core C#C# UWP/WinRTDataFlexDelphi ActiveXDelphi DLLVisual FoxProJavaLianjaMFCObjective-CPerlPHP ActiveXPHP ExtensionPowerBuilderPowerShellPureBasicCkPythonChilkat2-PythonRubySQL ServerSwift 2Swift 3/4TclUnicode CUnicode C++Visual Basic 6.0VB.NETVB.NET UWP/WinRTVBScriptXojo PluginNode.jsExcelGo

PowerBuilder Examples

Web API Categories

ASN.1
Amazon Glacier
Amazon S3
Amazon S3 (new)
Amazon SES
Amazon SNS
Amazon SQS
Async
Azure Cloud Storage
Azure Service Bus
Base64
Bounced Email
Box
CAdES
CSR
CSV
Certificates
Compression
DKIM / DomainKey
DSA
Diffie-Hellman
Digital Signatures
Dropbox
Dynamics CRM
ECC
Email Object
Encryption
FTP
FileAccess
Firebase
GMail REST API
Geolocation
Google APIs
Google Calendar
Google Cloud Storage
Google Drive
Google Photos
Google Sheets
Google Tasks
Gzip
HTML-to-XML/Text

HTTP
HTTP Misc
IMAP
JSON
JSON Web Encryption (JWE)
JSON Web Signatures (JWS)
JSON Web Token (JWT)
Java KeyStore (JKS)
MHT / HTML Email
MIME
Microsoft Graph
NTLM
OAuth1
OAuth2
OneDrive
OpenSSL
Outlook
PEM
PFX/P12
POP3
PRNG
REST
REST Misc
RSA
SCP
SFTP
SMTP
SSH
SSH Key
SSH Tunnel
SharePoint
Socket/SSL/TLS
Spider
Stream
Tar Archive
Upload
WebSocket
XAdES
XML
XML Digital Signatures
XMP
Zip
curl

 

 

 

(PowerBuilder) Sign SOAP XML using a wsse:SecurityTokenReference

This example signs SOAP XML such that the KeyInfo in the XML Signature is a wsse:SecurityTokenReference to the X.509 certificate embedded elsewhere in the SOAP XML.

Chilkat ActiveX Downloads

ActiveX for 32-bit and 64-bit Windows

integer li_rc
oleobject loo_SbXml
oleobject loo_Http
integer li_Success
oleobject loo_PfxData
oleobject loo_Pfx
string ls_Password
oleobject loo_Cert
integer li_NumReplaced
oleobject loo_RefXml
oleobject loo_Gen

//  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 template to be signed.
// 
loo_SbXml = create oleobject
li_rc = loo_SbXml.ConnectToNewObject("Chilkat_9_5_0.StringBuilder")
if li_rc < 0 then
    destroy loo_SbXml
    MessageBox("Error","Connecting to COM object failed")
    return
end if

loo_Http = create oleobject
li_rc = loo_Http.ConnectToNewObject("Chilkat_9_5_0.Http")

li_Success = loo_Http.QuickGetSb("https://www.chilkatsoft.com/exampleData/wssSoapTemplate.xml",loo_SbXml)
if li_Success <> 1 then
    Write-Debug loo_Http.LastErrorText
    destroy loo_SbXml
    destroy loo_Http
    return
end if

//  The SOAP XML template contains this:

//  <?xml version="1.0" encoding="UTF8"?>
//  <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
//  <SOAP-ENV:Header>
//   <wsse:Security xmlns:ds="http://www.w3.org/2000/09/xmldsig#"
//                  xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"
//                  xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd"
//                  xmlns:xenc="http://www.w3.org/2001/04/xmlenc#" SOAP-ENV:mustUnderstand="1">
//   <wsse:BinarySecurityToken
//                 EncodingType="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-soap-message-security-1.0#Base64Binary"
//                 ValueType="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-x509-token-profile-1.0#X509"
//                 wsu:Id="x509cert00">BASE64_CERT</wsse:BinarySecurityToken>
//   </wsse:Security>
//  </SOAP-ENV:Header>
//  <SOAP-ENV:Body xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" wsu:Id="TheBody">
//   <getVersion xmlns="http://msgsec.wssecfvt.ws.ibm.com"/>
//  </SOAP-ENV:Body>
//  </SOAP-ENV:Envelope>
// 

//  -------------------------------------------------------------------------
//  Step 2: Get the test certificate and private key stored in a .pfx
// 
loo_PfxData = create oleobject
li_rc = loo_PfxData.ConnectToNewObject("Chilkat_9_5_0.BinData")

li_Success = loo_Http.QuickGetBd("http://chilkatdownload.com/example_data/testcertificate.pfx",loo_PfxData)
if li_Success <> 1 then
    Write-Debug loo_Http.LastErrorText
    destroy loo_SbXml
    destroy loo_Http
    destroy loo_PfxData
    return
end if

loo_Pfx = create oleobject
li_rc = loo_Pfx.ConnectToNewObject("Chilkat_9_5_0.Pfx")

ls_Password = "test"
li_Success = loo_Pfx.LoadPfxEncoded(loo_PfxData.GetEncoded("base64"),"base64",ls_Password)
if li_Success <> 1 then
    Write-Debug loo_Pfx.LastErrorText
    destroy loo_SbXml
    destroy loo_Http
    destroy loo_PfxData
    destroy loo_Pfx
    return
end if

//  -------------------------------------------------------------------------
//  Step 3: Get the certificate from the PFX.
// 
loo_Cert = loo_Pfx.GetCert(0)
if loo_Pfx.LastMethodSuccess <> 1 then
    Write-Debug loo_Pfx.LastErrorText
    destroy loo_SbXml
    destroy loo_Http
    destroy loo_PfxData
    destroy loo_Pfx
    return
end if

//  -------------------------------------------------------------------------
//  Step 4: Replace "BASE64_CERT" with the actual base64 encoded certificate.
// 
li_NumReplaced = loo_SbXml.Replace("BASE64_CERT",loo_Cert.GetEncoded())

//  -------------------------------------------------------------------------
//  Step 5: Build the wsse:SecurityTokenReference XML.
//  This will be the CustomKeyInfoXml (see below).
// 
loo_RefXml = create oleobject
li_rc = loo_RefXml.ConnectToNewObject("Chilkat_9_5_0.Xml")

loo_RefXml.Tag = "wsse:SecurityTokenReference"
loo_RefXml.UpdateAttrAt("wsse:Reference",1,"URI","#x509cert00")
loo_RefXml.UpdateAttrAt("wsse:Reference",1,"ValueType","http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-x509-token-profile-1.0#X509")

//  The above lines of code builds the following XML:

//  	<wsse:SecurityTokenReference>
//  	    <wsse:Reference URI="#x509cert00" ValueType="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-x509-token-profile-1.0#X509" />
//  	</wsse:SecurityTokenReference>
// 
loo_RefXml.EmitXmlDecl = 0
Write-Debug loo_RefXml.GetXml()

//  -------------------------------------------------------------------------
//  Step 6: Setup the XML Digital Signature Generator and add the XML Signature.
// 
loo_Gen = create oleobject
li_rc = loo_Gen.ConnectToNewObject("Chilkat_9_5_0.XmlDSigGen")

loo_Gen.SigLocation = "SOAP-ENV:Envelope|SOAP-ENV:Header|wsse:Security"
loo_Gen.SignedInfoPrefixList = "wsse SOAP-ENV"
loo_Gen.AddSameDocRef("TheBody","sha1","EXCL_C14N","","")
loo_Gen.KeyInfoType = "Custom"
loo_RefXml.EmitCompact = 1
loo_Gen.CustomKeyInfoXml = loo_RefXml.GetXml()
loo_Gen.SetX509Cert(loo_Cert,1)
destroy loo_Cert

li_Success = loo_Gen.CreateXmlDSigSb(loo_SbXml)
if li_Success <> 1 then
    Write-Debug loo_Gen.LastErrorText
    destroy loo_SbXml
    destroy loo_Http
    destroy loo_PfxData
    destroy loo_Pfx
    destroy loo_RefXml
    destroy loo_Gen
    return
end if

//  Examine the signed XML
Write-Debug loo_SbXml.GetAsString()

//  Pretty-printed, the XML signature looks as shown here:
//  (The exact XML signature is shown below. Pretty-printing invalidates the XML signature.)

//  <?xml version="1.0" encoding="UTF8" ?>
//  <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
//      <SOAP-ENV:Header>
//          <wsse:Security xmlns:ds="http://www.w3.org/2000/09/xmldsig#" xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" xmlns:xenc="http://www.w3.org/2001/04/xmlenc#" SOAP-ENV:mustUnderstand="1">
//              <wsse:BinarySecurityToken EncodingType="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-soap-message-security-1.0#Base64Binary" ValueType="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-x509-token-profile-1.0#X509" wsu:Id="x509cert00">MIIDgzCCAmugAwIBAgIBADANBgkqhkiG9w0BAQUFADBcMRUwEwYDVQQDDAxUZXN0
//  IENvbXBhbnkxCzAJBgNVBAYTAkFVMRMwEQYDVQQIDApTb21lLVN0YXRlMSEwHwYD
//  VQQKDBhJbnRlcm5ldCBXaWRnaXRzIFB0eSBMdGQwHhcNMTcwOTEzMDA1NTM1WhcN
//  MTgwOTEzMDA1NTM1WjBcMRUwEwYDVQQDDAxUZXN0IENvbXBhbnkxCzAJBgNVBAYT
//  AkFVMRMwEQYDVQQIDApTb21lLVN0YXRlMSEwHwYDVQQKDBhJbnRlcm5ldCBXaWRn
//  aXRzIFB0eSBMdGQwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDiWRKl
//  x+88u4SKZnfCMraqMsfJCs6tcz3EjMYTWmRKhhUOE9pDkvZfv0mgF7pNHsTKvFRt
//  oVnEVQaZC5TlHNOGa2QWit9YuruWjW8VSaU4s9gR1/Cg9/Zc8Z0yUEDpsaVnwuoA
//  RpVzvzoRzPmTNpMNEcQ07aBjHP7OJrwyvcdqQA1BbfDVMmRmw1d+/i8tyR3cTyzl
//  /3TismN5nrmhGh/ZF75FFA/xDN7PbVYDPowiFnEVHiBrYh2mFTabRUnb7K4oLx+d
//  1L5x3Az299F/HYZlBenXpJLtnCL3+HY6qsGXVbzKjlKNqbXsmlzVkChu093weN/q
//  UvWO2883cEiXmdqxAgMBAAGjUDBOMB0GA1UdDgQWBBRsMy2bxsCKYyUYtTYz/zZb
//  z7Le0zAfBgNVHSMEGDAWgBRsMy2bxsCKYyUYtTYz/zZbz7Le0zAMBgNVHRMEBTAD
//  AQH/MA0GCSqGSIb3DQEBBQUAA4IBAQBnFQ+Sc3s8y79DTsA7CvvAFeG/zvWQiu8y
//  UM5LO1QcWeQQj29GMThqrY21dNfkynl7mZUMEeXKvwwzweFCc2odiUPHxoV1G4FE
//  tzNaZ8Ap9jye78YQ8SB8NPQwC7ovecfSqNflT4NMAThSuxpGp8Ugf7a24LXozLzL
//  bCRvG9sLGyRneZbfU8B43ELRLCkjzWR32N7D2pmKk4CEMiW0ScphU1JEHaimneMa
//  TFc63hNzKpuj7+BGv4ZuvB1j/Mbmz53PGgFKnGQHPb2TIvMxyB+lML5vE0Bm8YWt
//  P8DNyx11CCCdBdMWfeta6MjmmqcV5/YEq92c5O2Ql94tWFNLR6wQ</wsse:BinarySecurityToken>
//              <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="#TheBody">
//                          <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>VhsSnaEAFsY0OYegKQh99v9csXg=</ds:DigestValue>
//                      </ds:Reference>
//                  </ds:SignedInfo>
//                  <ds:SignatureValue>Ynp3H4rtzpXIh4TaVxkpEkS1bMCCu672aeCzUOzheNNfnpmLsCZz3+zQjMBbchPggCayC5ihpEdhRe3XvPXjPXXAgxDP4mic091QPmjHlmUcu8yqRKfxnPtD35nqaxDtCYw+jGIzj+ch094vA4RPCfY8JQnb1mpy1ZjjsMW8741CIh1epbsd/0bZt6tfINUQ37seg07yvLbCJZ/Zf+h8FlFryQk6lHTTeZl/GfQ9NlDBcShby3x8Hc1KwW++zFqEA7G783R9AYPYn3fWTOBhYk5gkgFc+HaPRLR/L0Bp7ZPbmOR/iZQ+HK4W672tTdN/R2GdN7/deV7QTp2DYK1Z8w==</ds:SignatureValue>
//                  <ds:KeyInfo>
//                      <wsse:SecurityTokenReference>
//                          <wsse:Reference URI="#x509cert00" ValueType="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-x509-token-profile-1.0#X509" />
//                      </wsse:SecurityTokenReference>
//                  </ds:KeyInfo>
//              </ds:Signature>
//          </wsse:Security>
//      </SOAP-ENV:Header>
//      <SOAP-ENV:Body xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" wsu:Id="TheBody">
//          <getVersion xmlns="http://msgsec.wssecfvt.ws.ibm.com" />
//      </SOAP-ENV:Body>
//  </SOAP-ENV:Envelope>
// 

//  --------------------------------------------------------------------------------------------
//  This is the exact XML signature, which is also available at https://www.chilkatsoft.com/exampleData/signedSoapBinarySecurityToken.xml
// 

//  <?xml version="1.0" encoding="UTF8"?>
//  <SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
//  <SOAP-ENV:Header>
//   <wsse:Security xmlns:ds="http://www.w3.org/2000/09/xmldsig#"
//                  xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"
//                  xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd"
//                  xmlns:xenc="http://www.w3.org/2001/04/xmlenc#" SOAP-ENV:mustUnderstand="1">
//   <wsse:BinarySecurityToken
//                 EncodingType="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-soap-message-security-1.0#Base64Binary"
//                 ValueType="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-x509-token-profile-1.0#X509"
//                 wsu:Id="x509cert00">MIIDgzCCAmugAwIBAgIBADANBgkqhkiG9w0BAQUFADBcMRUwEwYDVQQDDAxUZXN0
//  IENvbXBhbnkxCzAJBgNVBAYTAkFVMRMwEQYDVQQIDApTb21lLVN0YXRlMSEwHwYD
//  VQQKDBhJbnRlcm5ldCBXaWRnaXRzIFB0eSBMdGQwHhcNMTcwOTEzMDA1NTM1WhcN
//  MTgwOTEzMDA1NTM1WjBcMRUwEwYDVQQDDAxUZXN0IENvbXBhbnkxCzAJBgNVBAYT
//  AkFVMRMwEQYDVQQIDApTb21lLVN0YXRlMSEwHwYDVQQKDBhJbnRlcm5ldCBXaWRn
//  aXRzIFB0eSBMdGQwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDiWRKl
//  x+88u4SKZnfCMraqMsfJCs6tcz3EjMYTWmRKhhUOE9pDkvZfv0mgF7pNHsTKvFRt
//  oVnEVQaZC5TlHNOGa2QWit9YuruWjW8VSaU4s9gR1/Cg9/Zc8Z0yUEDpsaVnwuoA
//  RpVzvzoRzPmTNpMNEcQ07aBjHP7OJrwyvcdqQA1BbfDVMmRmw1d+/i8tyR3cTyzl
//  /3TismN5nrmhGh/ZF75FFA/xDN7PbVYDPowiFnEVHiBrYh2mFTabRUnb7K4oLx+d
//  1L5x3Az299F/HYZlBenXpJLtnCL3+HY6qsGXVbzKjlKNqbXsmlzVkChu093weN/q
//  UvWO2883cEiXmdqxAgMBAAGjUDBOMB0GA1UdDgQWBBRsMy2bxsCKYyUYtTYz/zZb
//  z7Le0zAfBgNVHSMEGDAWgBRsMy2bxsCKYyUYtTYz/zZbz7Le0zAMBgNVHRMEBTAD
//  AQH/MA0GCSqGSIb3DQEBBQUAA4IBAQBnFQ+Sc3s8y79DTsA7CvvAFeG/zvWQiu8y
//  UM5LO1QcWeQQj29GMThqrY21dNfkynl7mZUMEeXKvwwzweFCc2odiUPHxoV1G4FE
//  tzNaZ8Ap9jye78YQ8SB8NPQwC7ovecfSqNflT4NMAThSuxpGp8Ugf7a24LXozLzL
//  bCRvG9sLGyRneZbfU8B43ELRLCkjzWR32N7D2pmKk4CEMiW0ScphU1JEHaimneMa
//  TFc63hNzKpuj7+BGv4ZuvB1j/Mbmz53PGgFKnGQHPb2TIvMxyB+lML5vE0Bm8YWt
//  P8DNyx11CCCdBdMWfeta6MjmmqcV5/YEq92c5O2Ql94tWFNLR6wQ
//  </wsse:BinarySecurityToken>
//   <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="#TheBody"><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>VhsSnaEAFsY0OYegKQh99v9csXg=</ds:DigestValue></ds:Reference></ds:SignedInfo><ds:SignatureValue>Ynp3H4rtzpXIh4TaVxkpEkS1bMCCu672aeCzUOzheNNfnpmLsCZz3+zQjMBbchPggCayC5ihpEdhRe3XvPXjPXXAgxDP4mic091QPmjHlmUcu8yqRKfxnPtD35nqaxDtCYw+jGIzj+ch094vA4RPCfY8JQnb1mpy1ZjjsMW8741CIh1epbsd/0bZt6tfINUQ37seg07yvLbCJZ/Zf+h8FlFryQk6lHTTeZl/GfQ9NlDBcShby3x8Hc1KwW++zFqEA7G783R9AYPYn3fWTOBhYk5gkgFc+HaPRLR/L0Bp7ZPbmOR/iZQ+HK4W672tTdN/R2GdN7/deV7QTp2DYK1Z8w==</ds:SignatureValue><ds:KeyInfo><wsse:SecurityTokenReference><wsse:Reference URI="#x509cert00" ValueType="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-x509-token-profile-1.0#X509" /></wsse:SecurityTokenReference></ds:KeyInfo></ds:Signature></wsse:Security>
//  </SOAP-ENV:Header>
//  <SOAP-ENV:Body xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" wsu:Id="TheBody">
//   <getVersion xmlns="http://msgsec.wssecfvt.ws.ibm.com"/>
//  </SOAP-ENV:Body>
//  </SOAP-ENV:Envelope>
// 


destroy loo_SbXml
destroy loo_Http
destroy loo_PfxData
destroy loo_Pfx
destroy loo_RefXml
destroy loo_Gen

 

© 2000-2019 Chilkat Software, Inc. All Rights Reserved.