Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CipherParams

A collection of cipher parameters.

Hierarchy

  • CipherParams

Index

Properties

Methods

Properties

algorithm

algorithm: CipherStatic

The cipher algorithm.

blockSize

blockSize: number

The block size of the cipher.

ciphertext

ciphertext: cryptojs.lib.WordArray

The raw ciphertext.

formatter

formatter: Format

The default formatting strategy to convert this cipher params object to a string.

iv

iv: cryptojs.lib.WordArray

The IV used in the ciphering operation.

key

key: cryptojs.lib.WordArray

The key to this ciphertext.

mode

mode: Mode

The block mode used in the ciphering operation.

padding

padding: Padding

The padding scheme used in the ciphering operation.

salt

salt: cryptojs.lib.WordArray

The salt used with a key derivation function.

Methods

toString

  • toString(formatter?: Format): string

  • Converts this cipher params object to a string.

    throws

    Error If neither the formatter nor the default formatter is set.

    example
    var string = cipherParams + '';
    var string = cipherParams.toString();
    var string = cipherParams.toString(CryptoJS.format.OpenSSL);

    Parameters

    • Optional formatter: Format

      (Optional) The formatting strategy to use.

    Returns string

    The stringified cipher params.

Generated using TypeDoc