matrix/matrix-js-sdk
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-js-sdk.git synced 2025-08-09 10:22:46 +03:00
Code Activity

Improve documentation on {encrypt,decrypt}AES (#4397)

Browse Source
This commit is contained in:
Richard van der Hoff
2024-09-11 15:13:12 +01:00
committed by GitHub
parent ed44514974
commit 60cedf2fdb
1 changed files with 15 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
src/crypto/aes.ts
View File

@@ -30,12 +30,17 @@ export interface IEncryptedPayload {
} }
/** /**
* encrypt a string * Encrypt a string using AES-CTR.
* *
* @param data - the plaintext to encrypt * @param data - the plaintext to encrypt
* @param key - the encryption key to use * @param key - the encryption key to use as an input to the HKDF function which is used to derive the AES key for
* @param name - the name of the secret * encryption. Obviously, the same key must be provided when decrypting.
* @param ivStr - the initialization vector to use * @param name - the name of the secret. Used as an input to the HKDF operation which is used to derive the AES key,
* so again the same value must be provided when decrypting.
* @param ivStr - the base64-encoded initialization vector to use. If not supplied, a random one will be generated.
*
* @returns The encrypted result, including the ciphertext itself, the initialization vector (as supplied in `ivStr`,
* or generated), and an HMAC on the ciphertext — all base64-encoded.
*/ */
export async function encryptAES( export async function encryptAES(
data: string, data: string,
@@ -79,11 +84,13 @@ export async function encryptAES(
} }
/** /**
* decrypt a string * Decrypt an AES-encrypted string.
* *
* @param data - the encrypted data * @param data - the encrypted data, returned by {@link encryptAES}.
* @param key - the encryption key to use * @param key - the encryption key to use as an input to the HKDF function which is used to derive the AES key. Must
* @param name - the name of the secret * be the same as provided to {@link encryptAES}.
* @param name - the name of the secret. Also used as an input to the HKDF operation which is used to derive the AES
* key, so again must be the same as provided to {@link encryptAES}.
*/ */
export async function decryptAES(data: IEncryptedPayload, key: Uint8Array, name: string): Promise<string> { export async function decryptAES(data: IEncryptedPayload, key: Uint8Array, name: string): Promise<string> {
const [aesKey, hmacKey] = await deriveKeys(key, name); const [aesKey, hmacKey] = await deriveKeys(key, name);