API Reference

What is Checksum

A checksum is a cryptographic hash that summarizes data in a fixed-length string.

  • Integrity: The data has not been altered during transmission or storage.
  • Authentication: The checksum generated with a private key proves that the data originates from a trusted source.

📘

Use case

  • **APIs**: Ensure the integrity of data in API requests and responses.
  • **Data Validation**: Verify data has not been tampered with in storage or transit.
  • **Authentication**: Ensure data originates from a trusted source.

Why use a private key ?

The private key is used to generate a secure checksum that cannot be reproduced without the key. This is typically done using algorithms like HMAC-SHA256, which combines a private key with the data to generate the hash.

How the process works

Input Data Preparation:

  • Collect the data you want to secure (e.g., a dictionary or map).
  • Convert the data to a consistent format (e.g., JSON strings for nested structures).
  • Sort the data to ensure the same input always generates the same checksum.

Concatenation:

  • Combine the data values into a single string, separated by a delimiter like a comma ,.

Apply the Private Key:

  • Use a cryptographic function (e.g., HMAC with SHA256) to generate a hash.
  • The private key ensures that the hash is unique to the sender.

Output the Checksum:

  • The hash is converted into a readable format, usually a hexadecimal string.

❗️

Manage Key

  1. The private key must be stored securely and never exposed in plaintext.
  2. Use secure storage mechanisms like environment variables or dedicated key management systems.