Class Secret

constructor

• new Secret(
      opts: {
          app: string;
          env: string;
          key: string;
          value?: any;
          type?: string;
          plaintext_value?: string;
          vault_dir?: string;
      },
  ): Secret

  Parameters

  • opts: {
        app: string;
        env: string;
        key: string;
        value?: any;
        type?: string;
        plaintext_value?: string;
        vault_dir?: string;
    }

    • app: string

    • env: string

    • key: string

    • Optionalvalue?: any

      encrypted Fernet token

    • Optionaltype?: string

    • Optionalplaintext_value?: string

      if provided, will be encrypted

    • Optionalvault_dir?: string

      vault directory (defaults to get_seeqret_dir())

  Returns Secret

app

env

key

type

_vault_dir

_value

vault_dir

• get vault_dir(): string

  Returns string

encrypted_value

• get encrypted_value(): any

  Get the raw encrypted value (for database storage).

  Returns any

row

• get row(): (string | number)[]

  Returns (string | number)[]

get_value

• get_value(): string | number

  Get the decrypted plaintext value.

  Returns string | number

set_value

• set_value(plaintext: string): void

  Set value by encrypting plaintext.

  Parameters

  • plaintext: string

  Returns void

encrypt_value

• encrypt_value(
      sender_private_key: Uint8Array<ArrayBufferLike>,
      recipient_public_key: Uint8Array<ArrayBufferLike>,
  ): string

  Encrypt the plaintext value for transfer using NaCl Box.

  Parameters

  • sender_private_key: Uint8Array<ArrayBufferLike>
  • recipient_public_key: Uint8Array<ArrayBufferLike>

  Returns string

  base64-encoded encrypted value

Staticdecrypt_value

• decrypt_value(
      cipher: string,
      sender_public_key: Uint8Array<ArrayBufferLike>,
      receiver_private_key: Uint8Array<ArrayBufferLike>,
  ): string

  Decrypt a value received via transfer.

  Parameters

  • cipher: string

    base64-encoded encrypted value

  • sender_public_key: Uint8Array<ArrayBufferLike>
  • receiver_private_key: Uint8Array<ArrayBufferLike>

  Returns string

fingerprint

• fingerprint(): string

  Get a short fingerprint of this secret.

  Returns string

encrypt_to_dict

• encrypt_to_dict(
      sender_private_key: Uint8Array<ArrayBufferLike>,
      recipient_public_key: Uint8Array<ArrayBufferLike>,
  ): object

  Encrypt to a dict for JSON export.

  Parameters

  • sender_private_key: Uint8Array<ArrayBufferLike>
  • recipient_public_key: Uint8Array<ArrayBufferLike>

  Returns object

to_plaintext_dict

• to_plaintext_dict(): {
      app: string;
      env: string;
      key: string;
      type: string;
      value: string
      | number;
  }

  Returns { app: string; env: string; key: string; type: string; value: string | number }

toJSON

• toJSON(): { app: string; env: string; key: string; value: any; type: string }

  Returns { app: string; env: string; key: string; value: any; type: string }

toString

• toString(): string

  Returns string