EncryptContentOptions | Stacks.js 1.0.0 Library Reference

Specify encryption options, and whether to sign the ciphertext.

Hierarchy

EncryptionOptions
- EncryptContentOptions

Index

Properties

Optional cipherTextEncoding

cipherTextEncoding: CipherTextEncoding

String encoding format for the cipherText buffer. Currently defaults to 'hex' for legacy backwards-compatibility. Only used if the encrypt option is also used. Note: in the future this should default to 'base64' for the significant file size reduction.

Optional privateKey

privateKey: undefined | string

Encrypt the data with the public key corresponding to the supplied private key

Optional publicKey

publicKey: undefined | string

Encrypt the data with this key.

Optional sign

sign: boolean | string

If set to true the data is signed using ECDSA on SHA256 hashes with the user's app private key. If a string is specified, it is used as the private key instead of the user's app private key.

default: false

Optional wasString

wasString: undefined | false | true

Specifies if the original unencrypted content is a ASCII or UTF-8 string. For example stringified JSON. If true, then when the ciphertext is decrypted, it will be returned as a string type variable, otherwise will be returned as a Buffer.