AES

AES (Advanced Encryption Standard) is the cornerstone of modern cryptographic security and is the recommended encryption method within the Vortex Crypto API. It offers a balance of performance and security, making it suitable for a wide range of applications. The API supports encryption using the latest version of AES, specifically aes256skv1, as well as providing an alias method for ease of use.

In this guide you'll find:

• Information about the role of AES in modern cryptographic security.
• Details about the AES version supported by the API (aes256skv1).
• How the API simplifies encryption with alias methods.

Encrypting with AES

Vortex supports symmetric encryption using AES. You can explicitly select the AES version, use the latest alias, specify encoding, or encrypt within a session. Below are usage examples for each scenario.

1. Encrypting with aes256skv1 Method

Use the aes256skv1 method to explicitly reference the current version of AES encryption. This ensures strong and up-to-date cryptographic standards are applied.

POST /dispatch HTTP/1.1
Request-ID: YOUR_REQUEST_ID
Authorization: Bearer YOUR_API_TOKEN
Content-Type: application/json

{
  "dispatch": {
    "operation": "encrypt",
    "method": "aes256skv1"
  },
  "payload": "my test data"
}

2. Encrypting with aes Alias

To simplify encryption and ensure use of the latest supported AES version, use the aes alias. This automatically routes to the most current AES implementation.

POST /dispatch HTTP/1.1
Request-ID: YOUR_REQUEST_ID
Authorization: Bearer YOUR_API_TOKEN
Content-Type: application/json

{
  "dispatch": {
    "operation": "encrypt",
    "method": "aes"
  },
  "payload": "my test data"
}

3. Encrypting Base64-Encoded Data

When working with non-UTF-8 text, specify the encoding used. This example demonstrates encrypting a Base64-encoded string using AES.

POST /dispatch HTTP/1.1
Request-ID: YOUR_REQUEST_ID
Authorization: Bearer YOUR_API_TOKEN
Content-Type: application/json

{
  "dispatch": {
    "operation": "encrypt",
    "method": "aes",
    "encoding": "base64"
  },
  "payload": "bXkgdGVzdCBkYXRh"
}

4. Encrypting with a Session Key

To optimize for scenarios involving repeated encryption within the same session, use a session key by providing the sessionId parameter.

POST /dispatch HTTP/1.1
Host: localhost:9200
Request-ID: YOUR_REQUEST_ID
Authorization: Bearer YOUR_API_TOKEN
Content-Type: application/json

{
  "dispatch": {
    "operation": "encrypt",
    "method": "aes",
    "sessionId": "YOUR_SESSION_ID"
  },
  "payload": "bXkgdGVzdCBkYXRh"
}

Summary