Crypto Lib
    Preparing search index...

    Interface KdfDeriveOptions

    Options for deriving a key using a KDF.

    interface KdfDeriveOptions {
        algorithm: "hkdf-sha256" | "scrypt" | "pbkdf2-sha256";
        password: string | Uint8Array<ArrayBufferLike>;
        salt?: string | Uint8Array<ArrayBufferLike>;
        keyLength?: number;
        params?: {
            N?: number;
            r?: number;
            p?: number;
            iterations?: number;
            info?: string | Uint8Array<ArrayBufferLike>;
        };
    }
    Index
    algorithm password salt? keyLength? params?
    algorithm: "hkdf-sha256" | "scrypt" | "pbkdf2-sha256"

    Algorithm to use.

    password: string | Uint8Array<ArrayBufferLike>

    Input keying material (password or key).

    salt?: string | Uint8Array<ArrayBufferLike>

    Salt (hex string or bytes). If omitted, a random 16-byte salt is generated.

    keyLength?: number

    Desired output key length in bytes (default: 32).

    params?: {
        N?: number;
        r?: number;
        p?: number;
        iterations?: number;
        info?: string | Uint8Array<ArrayBufferLike>;
    }

    Algorithm-specific parameters.

    Type Declaration

    • OptionalN?: number

      scrypt: CPU/memory cost (default: 2^17 = 131072).

    • Optionalr?: number

      scrypt: block size (default: 8).

    • Optionalp?: number

      scrypt: parallelism (default: 1).

    • Optionaliterations?: number

      PBKDF2: iteration count (default: 600000).

    • Optionalinfo?: string | Uint8Array<ArrayBufferLike>

      HKDF: info context (default: empty).

    Settings
    Member Visibility

    On This Page
    Properties