B4X Requires Chilkat v11.0.0+

Ibanity HTTP Signature for XS2A, Isabel Connect, Ponto Connect

See more Ibanity Examples

Demonstrates how to add a Signature header for Ibanity HTTP requests. B4X

Dim success As Boolean = False

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

'  In order to sign your HTTP requests, you have to add 2 headers to the HTTP request: Digest: the digest of the request payload and Signature: the actual signature of the request. 

'  POST /xs2a/customer-access-tokens HTTP/1.1
'  Host: api.ibanity.com
'  Content-Type: application/json
'  Digest: SHA-512=z4PhNX7vuL3xVChQ1m2AB9Yg5AULVxXcg/SpIdNs6c5H0NE8XYXysP+DGNKHfuwvY7kxvUdBeoGlODJ6+SfaPg==
'  Ibanity-Idempotency-Key: 61f02718-eeee-46e1-b5eb-e8fd6e799c2d
'  Signature: keyId="62f02718-eeee-46e1-b5eb-e8fd6e799c2e",created=1599659223,algorithm="hs2019",headers="(request-target) host digest (created) ibanity-idempotency-key",signature="SjWJWbWN7i0...zsbM="
'  
'  {"data":{"type":"customerAccessToken", "attributes":{"applicationCustomerReference":"15874569"}}}

'  The payload (body) of the above HTTP request is the JSON.
'  Build the JSON above.
'  Use this online tool to generate code from sample JSON: 
'  Generate Code to Create JSON
Dim json As ChilkatJsonObject
json.Initialize
json.UpdateString("data.type", "customerAccessToken")
json.UpdateString("data.attributes.applicationCustomerReference", "15874569")

Dim payload As String = json.Emit
Log("payload = " & payload)

'  Step 1: Build the (created) virtual header

Dim dtNow As ChilkatDateTime
dtNow.Initialize
dtNow.SetFromCurrentSystemTime
Dim created As String = dtNow.GetAsUnixTimeStr(False)
Log("created = " & created)

'  Step 2: Build the Digest header
Dim crypt As ChilkatCrypt2
crypt.Initialize("crypt")
crypt.HashAlgorithm = "sha512"
crypt.EncodingMode = "base64"
crypt.Charset = "utf-8"

Dim sbDigestHdrValue As ChilkatStringBuilder
sbDigestHdrValue.Initialize
sbDigestHdrValue.Append("SHA-512=")
sbDigestHdrValue.Append(crypt.HashStringENC(json.Emit))

Log(sbDigestHdrValue.GetAsString)

'  Step 3: Build the (request target) virtual header

'  In order to build the signature you will need a virtual header named (request-target) (the parentheses are important). 
'  The (request-target) is the string concatenation of the HTTP method (in lowercase) with the path and query parameters.
Dim request_target As String = "post /xs2a/customer-access-tokens"

'  Step 4: Build the signing string

'  The signing string is the concatenation of the signed header names (in lowercase) and values separated by a LF.

'  You must always sign the following headers: (request-target), host, (created), digest. 
'  If used, you must also sign the authorization header and any ibanity-* headers, such as ibanity-idempotency-key. 

Dim sbSigningString As ChilkatStringBuilder
sbSigningString.Initialize
sbSigningString.Append("(request-target): ")
sbSigningString.AppendLine(request_target, False)
sbSigningString.Append("host: ")
sbSigningString.AppendLine("api.ibanity.com", False)
sbSigningString.Append("digest: ")
sbSigningString.AppendLine(sbDigestHdrValue.GetAsString, False)
sbSigningString.Append("(created): ")
sbSigningString.AppendLine(created, False)
sbSigningString.Append("ibanity-idempotency-key: ")
Dim idempotencyKey As String = crypt.GenerateUuid
sbSigningString.Append(idempotencyKey)

'  Step 5: Build the signed headers list

'  To allow Ibanity to check the signed headers, you must provide a list of the header names. They should be lowercase and in the same order used to create the signing string. 
Dim signed_headers_list As String = "(request-target) host digest (created) ibanity-idempotency-key"

'  Step 6: Build the Signature header

'  This is where the real signing happens. The signature header is a combination of several sub-headers -
'  
'      keyId: the identifier for the application's signature certificate, obtained from the Developer Portal
'      algorithm: the digital signature algorithm used to generate the signature (must be hs2019)
'      headers: The list of HTTP headers created in step 5
'      signature: the Base64-encoded digital signature of the signing string created in step 4.

Dim privKey As ChilkatPrivateKey
privKey.Initialize("privKey")
success = privKey.LoadEncryptedPemFile("my_ibanity_signature_private_key.pem", "pem_password")
If success = False Then
    Log(privKey.LastErrorText)
    Return
End If


Dim rsa As ChilkatRsa
rsa.Initialize
rsa.PssSaltLen = 32
rsa.EncodingMode = "base64"
'  Use the RSASSA-PSS signature algorithm
rsa.PkcsPadding = False

success = rsa.UsePrivateKey(privKey)
If success = False Then
    Log(rsa.LastErrorText)
    Return
End If


'  Sign the signing string.
Dim sigBase64 As String = rsa.SignStringENC(sbSigningString.GetAsString, "sha-256")
If rsa.LastMethodSuccess = False Then
    Log(rsa.LastErrorText)
    Return
End If


'  Build the signature header value.
Dim sbSigHeaderValue As ChilkatStringBuilder
sbSigHeaderValue.Initialize
sbSigHeaderValue.Append("keyId=" & Chr(34))
'  Use your identifier for the application's signature certificate, obtained from the Developer Portal
sbSigHeaderValue.Append("62f02718-eeee-46e1-b5eb-e8fd6e799c2e")
sbSigHeaderValue.Append(Chr(34) & ",created=")
sbSigHeaderValue.Append(created)
sbSigHeaderValue.Append(",algorithm=" & Chr(34) & "hs2019" & Chr(34) & ",headers=" & Chr(34))
sbSigHeaderValue.Append(signed_headers_list)
sbSigHeaderValue.Append(Chr(34) & ",signature=" & Chr(34))
sbSigHeaderValue.Append(sigBase64)
sbSigHeaderValue.Append(Chr(34))

Log(sbSigHeaderValue.GetAsString)