AES

Overview

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.

Encrypting with AES

Using aes256skv1

For those needing to specify the encryption method explicitly, aes256skv1 references the latest version of AES encryption, ensuring you utilize strong and up-to-date cryptographic standards.

Request Example:

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"
}

Using the aes Alias

To simplify the encryption process and ensure the use of the latest AES standard, the aes alias can be utilized. This approach automatically selects the most current version of AES implemented by the API.

Request Example:

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"
}

Encrypting Encoded Data

When dealing with non-UTF8 text, it's essential to specify the encoding used. This ensures the data is correctly interpreted and encrypted by the API.

Request Example:

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"
}

Encrypting with a Session Key

For enhanced security and efficiency, you can encrypt data using a session key. This method is particularly useful in scenarios requiring multiple encryptions within the same session.

Request Example:

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"
}