Java 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. Chilkat2 Java

import com.chilkatsoft.chilkat2.ChilkatException;
import com.chilkatsoft.chilkat2.Crypt2;
import com.chilkatsoft.chilkat2.DateTime;
import com.chilkatsoft.chilkat2.JsonObject;
import com.chilkatsoft.chilkat2.PrivateKey;
import com.chilkatsoft.chilkat2.Rsa;
import com.chilkatsoft.chilkat2.StringBuilder;

public class ChilkatExample {

    public static void main(String[] args) {
        // 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
        JsonObject json = new JsonObject();
        json.updateString("data.type", "customerAccessToken");
        json.updateString("data.attributes.applicationCustomerReference", "15874569");

        String payload = json.emit();
        System.out.println("payload = " + payload);

        // Step 1: Build the (created) virtual header

        DateTime dtNow = new DateTime();
        dtNow.setFromCurrentSystemTime();
        String created = dtNow.getAsUnixTimeStr(false);
        System.out.println("created = " + created);

        // Step 2: Build the Digest header
        Crypt2 crypt = new Crypt2();
        crypt.setHashAlgorithm("sha512");
        crypt.setEncodingMode("base64");
        crypt.setCharset("utf-8");

        StringBuilder sbDigestHdrValue = new StringBuilder();
        sbDigestHdrValue.append("SHA-512=");
        sbDigestHdrValue.append(crypt.hashStringENC(json.emit()));

        System.out.println(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.
        String request_target = "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.

        StringBuilder sbSigningString = new StringBuilder();
        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: ");
        String idempotencyKey = 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.
        String signed_headers_list = "(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.

        PrivateKey privKey = new PrivateKey();
        try {
            privKey.loadEncryptedPemFile("my_ibanity_signature_private_key.pem", "pem_password");
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            return;
        }

        Rsa rsa = new Rsa();
        rsa.setPssSaltLen(32);
        rsa.setEncodingMode("base64");
        // Use the RSASSA-PSS signature algorithm
        rsa.setPkcsPadding(false);

        String sigBase64;
        try {
            rsa.usePrivateKey(privKey);

            // Sign the signing string.
            sigBase64 = rsa.signStringENC(sbSigningString.getAsString(), "sha-256");
        } catch (ChilkatException e) {
            System.out.println(e.getLastErrorText());
            return;
        }

        // Build the signature header value.
        StringBuilder sbSigHeaderValue = new StringBuilder();
        sbSigHeaderValue.append("keyId=\"");
        // Use your identifier for the application's signature certificate, obtained from the Developer Portal
        sbSigHeaderValue.append("62f02718-eeee-46e1-b5eb-e8fd6e799c2e");
        sbSigHeaderValue.append("\",created=");
        sbSigHeaderValue.append(created);
        sbSigHeaderValue.append(",algorithm=\"hs2019\",headers=\"");
        sbSigHeaderValue.append(signed_headers_list);
        sbSigHeaderValue.append("\",signature=\"");
        sbSigHeaderValue.append(sigBase64);
        sbSigHeaderValue.append("\"");

        System.out.println(sbSigHeaderValue.getAsString());
    }
}