Interface CipherParams

A collection of cipher parameters.

interface CipherParams {
    algorithm: CipherStatic;
    blockSize: number;
    ciphertext: cryptojs.lib.WordArray;
    formatter: Format;
    iv: cryptojs.lib.WordArray;
    key: cryptojs.lib.WordArray;
    mode: Mode;
    padding: Padding;
    salt: cryptojs.lib.WordArray;
    toString(formatter?: Format): string;
}

Properties

algorithm blockSize ciphertext formatter iv key mode padding salt

Methods

toString

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?): string

  • Converts this cipher params object to a string.

    Parameters

    • Optionalformatter: Format

      (Optional) The formatting strategy to use.

    Returns string

    The stringified cipher params.

    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);

Settings

Member Visibility

On This Page

Properties
Methods