Options
All
  • Public
  • Public/Protected
  • All
Menu

Module @cipherstash/stash-rs

Index

Type Aliases

CipherText: Buffer
IndexerCollectionSchema: { indexes: {}; type: {} }

The collection schema used to initialize a RecordIndexer.

This is base on the CipherStash schema definition and includes metadata required for encryption.

Type declaration

  • indexes: {}
    • [key: string]: { index_id: Buffer | Uint8Array; kind: string; prf_key: Buffer | Uint8Array; prp_key: Buffer | Uint8Array }
      • [key: string]: unknown
      • index_id: Buffer | Uint8Array
      • kind: string
      • prf_key: Buffer | Uint8Array
      • prp_key: Buffer | Uint8Array
  • type: {}
    • [key: string]: unknown
Key: Buffer
ORECipher: { encrypt: any; encryptLeft: any }

Type declaration

  • encrypt:function
    • encrypt(input: Buffer): Buffer
    • Parameters

      • input: Buffer

      Returns Buffer

  • encryptLeft:function
    • encryptLeft(input: Buffer): Buffer
    • Parameters

      • input: Buffer

      Returns Buffer

Ordering: -1 | 0 | 1
OrePlainText: Buffer
OreRange: { max: OrePlainText; min: OrePlainText }

Type declaration

TermVector: { indexId: Buffer; terms: { link: Buffer; term: Buffer[] }[] }[]

The terms that can be used to insert a record into the index

Variables

ORE: ORE

Module to perform Order-revealing Encryption using the underlying ore.rs Rust library.

Functions

  • isObject(value: unknown): value is {}
  • Parameters

    • value: unknown

    Returns value is {}

Generated using TypeDoc