Security

Generate UUID

    security.create_uuid as $myVariable

Parameter	Purpose	Example
$myVariable	This is the variable you want to store the generated value in.	$myVariable

Example

    security.create_uuid as $myVariable

Create Authentication Token

    security.create_auth_token {
      table = "users"
      extras = { "role": "admin" }
      expiration = 86400
      id = 1
    } as $authToken

Parameter	Purpose	Example
dbtable	The ID of the database table that has authentication enabled	”97”
extras	A JSON object that contains any extra information you want to include in the token	`’{“role”:“admin”}‘\|json_decode`
expiration	The time in seconds that the token should remain valid	86400
id	The ID of the record to use to generate the authentication token	1
as	The variable to store the generated token in	$authToken

Example

    security.create_auth_token {
      table = "users"
      extras = { "role": "admin" }
      expiration = 86400
      id = 1
    } as $authToken

Validate Password

    security.check_password {
      text_password = "textPassword"
      hash_password = "hashedPassword"
    } as $tokenValidate

Parameter	Purpose	Example
text_password	The text version of the password to check	”textPassword” $textPassword
hash_password	The hashed version of the password to check, usually coming from a database table	”hashedPassword” $user1.password

Example

    security.check_password {
      text_password = "textPassword"
      hash_password = "hashedPassword"
    } as tokenValidate

Generate Password

    security.create_password {
      character_count = 12
      require_lowercase = true
      require_uppercase = true
      require_digit = true
      require_symbol = true
      symbol_whitelist = "$#%&"
    } as $generatedPassword

Parameter	Purpose	Example
character_count	The length of the generated password	12
require_lowercase require_uppercase require_digit require_symbol	Various specifications for the generated password	`require_lowercase = true require_uppercase = true require_digit = true require_symbol = true`
symbol_whitelist	If you require symbols in your generated password, whitelist the allowed symbols here.	`symbol_whitelist = ”$#%&“`
as	The variable that you want to store the generated password.	generatedPassword

Example

    security.create_password {
      character_count = 12
      require_lowercase = true
      require_uppercase = true
      require_digit = true
      require_symbol = true
      symbol_whitelist = "$#%&"
    } as generatedPassword

Generate Random Number

    security.random_number {
      min = 0
      max = 9007199254740991
    } as $randomNumber

Parameter	Purpose	Example
min	The beginning of the range for the randomly generated number	0
max	The end of the range for the randomly generated number	10000
as	The variable that you want to store the generated number	randomNumber

Example

    security.random_number {
      min = 0
      max = 9007199254740991
    } as randomNumber

Generate Random Bytes

    security.random_bytes {
      length = 16
    } as $randomBytes

Parameter	Purpose	Example
length	The length of the string you’d like to generate	16
as	The variable that you want to store the random bytes generated	randomBytes

Example

    security.random_bytes {
      length = 16
    } as randomBytes

Create Secret Key

    security.create_secret_key {
      bits = 1024
      format = "object"
    } as $crypto1

Parameter	Purpose	Example
bits	The length of the key generated. Common values are 1024, 2048, 4096, etc…	1024
format	The format of the key generated. This can be either object or base64	”object”
as	The variable that you want to store the key	crypto1

Example

    security.create_secret_key {
      bits = 1024
      format = "object"
    } as crypto1

Create RSA Key

    security.create_rsa_key {
      bits = 1024
      format = "object"
    } as $crypto1

Parameter	Purpose	Example
bits	The length of the key generated. Common values are 1024, 2048, 4096, etc…	1024
format	The format of the key generated. This can be either object or base64	”object”
as	The variable that you want to store the key	crypto1

Example

    security.create_rsa_key {
      bits = 1024
      format = "object"
    } as crypto1

Create Elliptic Curve Key

    security.create_curve_key {
      curve = "P-256"
      format = "object"
    } as $crypto3

Encrypt Data

    security.encrypt {
      data = $sensitive_data
      algorithm = "aes-256-cbc"
      key = "encryption_key"
      iv = "init_vector"
    } as $encrypted_data

Encrypts a payload into binary data using the specified algorithm, key, and initialization vector. The result is stored in $encrypted_data.

Decrypt Data

    security.decrypt {
      data = $encrypted_data
      algorithm = "aes-256-cbc"
      key = "encryption_key"
      iv = "init_vector"
    } as $decrypted_data

Decrypts a payload back to its original form using the specified algorithm, key, and initialization vector. The result is stored in $decrypted_data.

JWS Encode

    security.jws_encode {
      headers = { "alg": "HS256" }
      claims = { "user_id": "123" }
      key = "signing_key"
      signature_algorithm = "HS256"
      ttl = 3600
    } as $signed_token

Encodes a payload as a JSON Web Signature (JWS) token with headers, claims, and a key. The result is stored in $signed_token.

JWS Decode

    security.jws_decode {
      token = $jws_token
      key = "signing_key"
      check_claims = { "user_id": "123" }
      signature_algorithm = "HS256"
      timeDrift = 0
    } as $verified_payload

Decodes a JWS token using the key and signature algorithm. The result is stored in $verified_payload.

JWE Encode

    security.jwe_encode {
      headers = { "alg": "A256KW" }
      claims = { "data": "secret" }
      key = "encryption_key"
      key_algorithm = "A256KW"
      content_algorithm = "A256GCM"
      ttl = 0
    } as $encrypted_token

Encodes a payload as a JSON Web Encryption (JWE) token with headers, claims, and a key. The result is stored in $encrypted_token.

JWE Decode

    security.jwe_decode {
      token = $jwe_token
      key = "decryption_key"
      check_claims = { "iss": "my_app" }
      key_algorithm = "A256KW"
      content_algorithm = "A256GCM"
      timeDrift = 0
    } as $decoded_payload

Decodes a JWE token using the key, key algorithm, and content algorithm. The result is stored in $decoded_payload.

Parameter	Purpose	Example
curve	The curve applied to the generated key. Can be P-256, P-384, or P-521	P-256
format	The format of the key generated. This can be either object or base64	”object”
as	The variable that you want to store the key	crypto3

Example

    security.create_curve_key {
      curve = "P-256"
      format = "object"
    } as crypto3

Start

AI

References

Generate UUID

Create Authentication Token

Validate Password

Generate Password

Generate Random Number

Generate Random Bytes

Create Secret Key

Create RSA Key

Create Elliptic Curve Key

Encrypt Data

Decrypt Data

JWS Encode

JWS Decode

JWE Encode

JWE Decode

​ Generate UUID

​ Create Authentication Token

​ Validate Password

​ Generate Password

​ Generate Random Number

​ Generate Random Bytes

​ Create Secret Key

​ Create RSA Key

​ Create Elliptic Curve Key

​ Encrypt Data

​ Decrypt Data

​ JWS Encode

​ JWS Decode

​ JWE Encode

​ JWE Decode

Generate UUID

Create Authentication Token

Validate Password

Generate Password

Generate Random Number

Generate Random Bytes

Create Secret Key

Create RSA Key

Create Elliptic Curve Key

Encrypt Data

Decrypt Data

JWS Encode

JWS Decode

JWE Encode

JWE Decode