Module encryption

Expand description

Module for CipherStash encryption schemes and indexers

Modules§

BytesWithDescriptor
DecryptOptions
EncryptedEntry: One SteVec wire entry: {s, c} plus an optional orderable term.
Encryption
IndexedArray
IndexedBool
IndexedNull
IndexedNumber
IndexedObject
IndexedString
JsonIndexer: Indexer for searchable encryption of JSON documents.
JsonIndexerOptions: Configuration for a JsonIndexer.
JsonbIndexer: Structure preserving cryptographic JSONB indexing.
MatchIndexer
OpeIndexer
OreIndexer
Payload
PlaintextTarget: Convenience type that represents a Param which will be mapped using config. config will always be present but operator may be None in this case.
QueryBuilder
ScopedCipher: A Scoped Cipher is one which has been initialized for a specific keyset. It can be used only to encrypt and decrypt data for that keyset.
SteQueryVec: Represents a vector of query entries.
SteVec: Describes a SteVec, which is a vector of encrypted entries used to index JSON. N is the length of the selector.
StorageBuilder
TokenizedSelector: Represents a tokenized selector for a value in a JSON object.
TypeParseError
UniqueIndexer

Encrypted: Represents an encrypted payload that is ready to be stored.
EncryptedSteVecTerm: The (optional) orderable term carried by a SteVec entry — the ONLY term kind an entry can carry. Exact matching for every node kind is the value-inclusive selector’s job (see [super::priv_state::value_selector]), so no per-value MAC term (hm) exists on entries.
EncryptionError
IndexTerm
IndexedValue: An IndexedValue structurally mirrors a serde_json::Value and enhances it with cryptographic search terms.
JsonbIndexerError
Plaintext
QueryOp: Query operations for STE-vec indexed columns.

VALUE_ENTRY_SENTINEL: The plaintext a value entry encrypts: a fixed, versioned sentinel.

is_value_entry_sentinel: True when bytes (a decrypted entry plaintext) is the value-entry sentinel — i.e. the entry was a value-inclusive selector, not a node.