Interface EncryptionAlgorithm<I, Asym, G>

WebCrypto based encryption algorithm implementation.

interface EncryptionAlgorithm<I = any, Asym extends boolean = any, G = any> {
    cryptoGenerate: (
        params: G,
        extractable: boolean,
    ) => Promise<If<Asym, GeneratedKeyPair<I>, GeneratedSecretKey<I>, never>>;
    importSpki?: (
        spki: Uint8Array,
        der: ElementBuffer,
    ) => Promise<CryptoAlgorithm.PublicKey<I>>;
    keyUsages: If<
        Asym,
        Record<"private" | "public", readonly KeyUsage[]>,
        Record<"secret", readonly KeyUsage[]>,
        {},
    >;
    makeLLDecrypt: If<
        Asym,
        (key: CryptoAlgorithm.PrivateKey<I>) => LLDecrypt,
        (key: CryptoAlgorithm.SecretKey<I>) => LLDecrypt,
        unknown,
    >;
    makeLLEncrypt: If<
        Asym,
        (key: CryptoAlgorithm.PublicKey<I>) => LLEncrypt,
        (key: CryptoAlgorithm.SecretKey<I>) => LLEncrypt,
        unknown,
    >;
    uuid: string;
}

Type Parameters

  • I = any

    Algorithm-specific per-key information.

  • Asym extends boolean = any

    Whether the algorithm is asymmetric.

  • G = any

    Key generation parameters.

Hierarchy (View Summary)

Properties

cryptoGenerate importSpki? keyUsages makeLLDecrypt makeLLEncrypt uuid

Properties

cryptoGenerate

cryptoGenerate: (
    params: G,
    extractable: boolean,
) => Promise<If<Asym, GeneratedKeyPair<I>, GeneratedSecretKey<I>, never>>

Generate key pair (for asymmetric algorithm) or secret key (for symmetric algorithm).

Type declaration

Remarks

Some algorithms allow importing an existing key pair from a serialization format such as PKCS#8 or JWK. This could be supported by passing the serialized key as part of params, and then importing instead of generating in this method.

OptionalimportSpki

importSpki?: (
    spki: Uint8Array,
    der: ElementBuffer,
) => Promise<CryptoAlgorithm.PublicKey<I>>

Import public key from SubjectPublicKeyInfo.

Remarks

This should only appear on asymmetric algorithm.

ReadonlykeyUsages

keyUsages: If<
    Asym,
    Record<"private" | "public", readonly KeyUsage[]>,
    Record<"secret", readonly KeyUsage[]>,
    {},
>

WebCrypto KeyUsages for generated keys. These are specified separately for private/public/secret keys.

makeLLDecrypt

makeLLDecrypt: If<
    Asym,
    (key: CryptoAlgorithm.PrivateKey<I>) => LLDecrypt,
    (key: CryptoAlgorithm.SecretKey<I>) => LLDecrypt,
    unknown,
>

Create a low level decryption function from private key (in asymmetric algorithm) or secret key (in symmetric algorithm).

makeLLEncrypt

makeLLEncrypt: If<
    Asym,
    (key: CryptoAlgorithm.PublicKey<I>) => LLEncrypt,
    (key: CryptoAlgorithm.SecretKey<I>) => LLEncrypt,
    unknown,
>

Create a low level encryption function from public key (in asymmetric algorithm) or secret key (in symmetric algorithm).

Readonlyuuid

uuid: string

Identifies an algorithm in storage.

Remarks

This should be changed when the serialization format changes.

Settings

Member Visibility

On This Page

Properties