Crypto SDK
    Preparing search index...

    Class CryptoClient

    Index
    • Decrypt ciphertext and return the original plaintext.

      Parameters

      • params: { key: string; ciphertext: string }

      Returns Promise<ApiResponse<{ plaintext: string }>>

    • Derive a key from a password using a KDF algorithm. The server enforces OWASP floors: scrypt N = 2^17 with r = 8, PBKDF2 at least 600,000 iterations.

      Parameters

      • params: {
            algorithm: KdfAlgorithm;
            password: string;
            salt?: string;
            keyLength?: number;
            params?: {
                N?: number;
                r?: number;
                p?: number;
                iterations?: number;
                info?: string;
            };
        }
        • algorithm: KdfAlgorithm
        • password: string
        • Optionalsalt?: string
        • OptionalkeyLength?: number

          Derived key length in bytes (16 to 64).

        • Optionalparams?: { N?: number; r?: number; p?: number; iterations?: number; info?: string }
          • OptionalN?: number

            scrypt cost (only 131072 is accepted).

          • Optionalr?: number

            scrypt block size (only 8 is accepted).

          • Optionalp?: number

            scrypt parallelism (1 to 4).

          • Optionaliterations?: number

            PBKDF2 iterations (600,000 to 1,000,000).

          • Optionalinfo?: string

            HKDF info string.

      Returns Promise<ApiResponse<KdfResult>>

    • Hash a password with Argon2id. The server requires at least two passes and 19456 KiB of memory.

      Parameters

      • params: {
            password: string;
            timeCost?: number;
            memoryCost?: number;
            parallelism?: number;
        }

      Returns Promise<ApiResponse<PasswordHashResult>>

    • Verify a password against a stored Argon2id hash.

      Parameters

      • params: { password: string; hash: string; salt: string; params: Argon2Params }

      Returns Promise<ApiResponse<{ valid: boolean }>>

    • Open a secretbox; data is the recovered plaintext.

      Parameters

      • params: { key: string; ciphertext: string; aad?: string }

      Returns Promise<ApiResponse<string>>

    • Decrypt a payload from passwordEncrypt (its encrypted field); data is the plaintext.

      Parameters

      • params: { password: string; ciphertext: string }

      Returns Promise<ApiResponse<string>>