"crypto/symmetricCrypto" | @coast-team/mute-crypto-helper

Index

Functions

Functions

decrypt

decrypt(data: Uint8Array, encryptionKey: CryptoKey): Promise<Uint8Array>

- Defined in crypto/symmetricCrypto.ts:91
decrypt decrypts the given ciphertext.

Parameters
- data: Uint8Array
- encryptionKey: CryptoKey
  
  The secret key used to decrypt (same as the one to encrypt, generated by generateEncryptionKey).
Returns Promise<Uint8Array>

encrypt

encrypt(plaintext: Uint8Array, encryptionKey: CryptoKey): Promise<Uint8Array>

- Defined in crypto/symmetricCrypto.ts:79
encrypt returns the ciphertext of the given plaintext.

Parameters
- plaintext: Uint8Array
- encryptionKey: CryptoKey
  
  The secret key used to encrypt (generated by generateEncryptionKey).
Returns Promise<Uint8Array>

exportKey

exportKey(cryptoKey: CryptoKey): Promise<JsonWebKey>

- Defined in crypto/symmetricCrypto.ts:45
exportKey exports a CryptoKey to a JSON Web Key. The CryptoKeyPair should be the same as returned by generateEncryptionKey.

Parameters
- cryptoKey: CryptoKey
Returns Promise<JsonWebKey>

fromB64

fromB64(keyDataB64: string): JsonWebKey

- Defined in crypto/symmetricCrypto.ts:59
fromB64 decodes the given Base64 to the corresponding JSON Web Key representation.

Parameters
- keyDataB64: string
Returns JsonWebKey

generateEncryptionKey

generateEncryptionKey(): Promise<CryptoKey>

- Defined in crypto/symmetricCrypto.ts:33
generateEncryptionKey generates a cryptoKeyPair with sane defaults to be used for symmetric encryption purpose.

see

defaultSymmetricEncryptionParams

Returns Promise<CryptoKey>

importKey

importKey(cryptoKeyData: JsonWebKey): Promise<CryptoKey>

- Defined in crypto/symmetricCrypto.ts:67
importKey imports a JSON Web Key to a CryptoKey. The JSON Web Key should be the same as returned by exportKey.

Parameters
- cryptoKeyData: JsonWebKey
Returns Promise<CryptoKey>

toB64

toB64(keyData: JsonWebKey): string

- Defined in crypto/symmetricCrypto.ts:52
toB64 encodes the given JSON Web Key to the base64 representation

Parameters
- keyData: JsonWebKey
Returns string

Generated using TypeDoc