encrypt()

The encrypt() function encrypts binary data using a specified cipher algorithm and key, and returns the result as binary.

Syntax

Parameters

CIPHER

A string in algorithm/mode/padding format. If mode and padding are omitted and only the algorithm is specified, the default values for that algorithm are applied.

Refer to the Java Security Standard Algorithm Names documentation for available algorithms, modes, and paddings.

KEY

A binary key of the size required by the specified cipher algorithm. Key lengths by algorithm are as follows.

• AES: choose from 16 bytes (128-bit), 24 bytes (192-bit), or 32 bytes (256-bit)
• RSA: choose from 128 bytes (1024-bit) or 256 bytes (2048-bit)

DATA

The binary data to encrypt.

IV

A binary initialization vector (IV) required by operation modes such as CBC.

Description

The encrypt() function uses the Java Cipher class to encrypt binary data with the specified cipher algorithm and key, and returns the result as binary.

Returns null if KEY or DATA is null or not a binary type. If IV is specified, it must also be a binary type; otherwise null is returned. Returns null if an error occurs during encryption.

Error codes

Usage examples

1. Encrypt data with the AES algorithm

   json "{}"
   | eval key = frombase64("mRcOlK9V47rjVL/RBYQYRw=="),
          data = encode("hello, world!"),
          encrypted = tobase64(encrypt("AES", key, data))
   | # encrypted: y7+NQQ9/9xGtbBq5pgBvCA==
   

2. Encrypt with an IV specified in CBC mode

   json "{}"
   | eval key = frombase64("mRcOlK9V47rjVL/RBYQYRw=="),
          iv = randbytes(16),
          data = encode("hello, world!"),
          encrypted = encrypt("AES/CBC/PKCS5Padding", key, data, iv)
   

3. KEY or DATA is null

   json "{}" | eval result = encrypt("AES", null, encode("data"))
   | # result: null
   

Compatibility

The encrypt() function has been available since before Sonar 4.0.