Skip to content

Commit 64ef4ce

Browse files
authored
Update docs to clarify other client HKDF support (#1796)
1 parent 1744ee4 commit 64ef4ce

File tree

2 files changed

+9
-2
lines changed

2 files changed

+9
-2
lines changed

.changeset/slow-dingos-look.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
'livekit-client': patch
3+
---
4+
5+
Update docs to clarify other client HKDF support

src/e2ee/KeyProvider.ts

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -91,8 +91,10 @@ export class ExternalE2EEKeyProvider extends BaseKeyProvider {
9191

9292
/**
9393
* Accepts a passphrase that's used to create the crypto keys.
94-
* When passing in a string, PBKDF2 is used.
95-
* When passing in an Array buffer of cryptographically random numbers, HKDF is being used. (recommended)
94+
* When passing in a string, PBKDF2 is used. (recommended for maximum compatibility across SDKs)
95+
* When passing in an ArrayBuffer of cryptographically random numbers, HKDF is used.
96+
*
97+
* Note: Not all client SDKS support HKDF.
9698
* @param key
9799
*/
98100
async setKey(key: string | ArrayBuffer) {

0 commit comments

Comments
 (0)