Module eql 

Types for representing EQL payloads, and encryption/decryption functions.

The serialization shapes here match the EQL v2.3 schema at cipherstash/encrypt-query-language/docs/reference/schema/eql-payload-v2.3.schema.json.

Structs

EncryptedPayload

Scalar EQL storage payload (k = "ct").

EncryptedQueryPayload

Root-scalar query payload — carries exactly one root-scope index term.

EqlDecryptOpts

Options for EQL decryption operations.

EqlEncryptOpts

Options for EQL encryption operations.

Identifier

Identifies a specific database table and column pair.

PreparedPlaintext

A prepared plaintext value ready for EQL encryption.

SteVecEntry

One entry inside an SteVecPayload.

SteVecPayload

STE-vector EQL storage payload (k = "sv").

SteVecQueryPayload

STE-vector query payload — carries either a selector lookup or a single per-element term used to match against an SteVecEntry.

Enums

EqlCiphertext

EQL v2.3 storage payload. One of two mutually exclusive root shapes discriminated by k.

EqlError

Errors that can occur during EQL encryption, decryption, and index operations.

EqlOperation

Specifies what to encrypt when encrypting encryption::Plaintext values.

EqlOutput

Output of encrypt_eql for a single PreparedPlaintext.

EqlQueryPayload

EQL query payload — partial encrypted payload used to match against stored EqlCiphertext values.

RootQueryTerm

Per-root-scalar query term. Exactly one of hm, bf, or ob.

SteVecEntryTerm

Equality / ordering term carried by an SteVecEntry.

SteVecQueryTerm

Per-STE-vector query term. Exactly one of s, hm, oc, or q.

Constants

EQL_SCHEMA_VERSION

The current version of the EQL schema format.

Functions

decrypt_eql

Decrypts multiple EQL storage payloads back to plaintext.

decrypt_eql_fallible

Like decrypt_eql but decryption failure of one or more ciphertexts does not fail the entire operation. Instead, a decryption result (success or failure) is returned for every ciphertext.

encrypt_eql

Encrypts multiple plaintexts into EQL format.