Interface AesEncryption<I, G>

AES encryption algorithm.

interface AesEncryption<I, G extends AesGenParams> {
    cryptoGenerate: (
        params: G,
        extractable: boolean,
    ) => Promise<GeneratedSecretKey<I>>;
    importSpki?: (
        spki: Uint8Array<ArrayBufferLike>,
        der: ElementBuffer,
    ) => Promise<CryptoAlgorithm.PublicKey<I>>;
    ivLength: number;
    keyUsages: Record<"secret", readonly KeyUsage[]>;
    makeAesKeyGenParams: (genParams: G) => AesKeyGenParams;
    makeLLDecrypt: (key: CryptoAlgorithm.SecretKey<I>) => LLDecrypt;
    makeLLEncrypt: (key: CryptoAlgorithm.SecretKey<I>) => LLEncrypt;
    uuid: string;
}

Type Parameters

  • I
  • G extends AesGenParams

Hierarchy (View Summary)

Properties

cryptoGenerate importSpki? ivLength keyUsages makeAesKeyGenParams makeLLDecrypt makeLLEncrypt uuid

Properties

cryptoGenerate

cryptoGenerate: (
    params: G,
    extractable: boolean,
) => Promise<GeneratedSecretKey<I>>

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

Type declaration

    • (params: G, extractable: boolean): Promise<GeneratedSecretKey<I>>

    • Parameters

      • params: G

        Key generation parameters.

      • extractable: boolean

        Whether to generate as extractable WebCrypto key.

      Returns Promise<GeneratedSecretKey<I>>

      Generated key pair or secret key.

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<ArrayBufferLike>,
    der: ElementBuffer,
) => Promise<CryptoAlgorithm.PublicKey<I>>

Import public key from SubjectPublicKeyInfo.

Remarks

This should only appear on asymmetric algorithm.

ReadonlyivLength

ivLength: number

ReadonlykeyUsages

keyUsages: Record<"secret", readonly KeyUsage[]>

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

makeAesKeyGenParams

makeAesKeyGenParams: (genParams: G) => AesKeyGenParams

makeLLDecrypt

makeLLDecrypt: (key: CryptoAlgorithm.SecretKey<I>) => LLDecrypt

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

makeLLEncrypt

makeLLEncrypt: (key: CryptoAlgorithm.SecretKey<I>) => LLEncrypt

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