Skip to content

Update docs to clarify other client HKDF support #1796

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
1egoman merged 4 commits into from
Jan 27, 2026
Merged

Update docs to clarify other client HKDF support #1796

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ac182a3
fix: update docs to clarify other client client HKDF support
1egoman Jan 27, 2026
c369723
fix: add changeset
1egoman Jan 27, 2026
24394c7
fix: address typos
1egoman Jan 27, 2026
ffb628d
fix: apply small docs nitpicks
1egoman Jan 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/slow-dingos-look.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'livekit-client': patch
---

Update docs to clarify other client HKDF support
6 changes: 4 additions & 2 deletions src/e2ee/KeyProvider.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,8 +91,10 @@ export class ExternalE2EEKeyProvider extends BaseKeyProvider {

/**
* Accepts a passphrase that's used to create the crypto keys.
* When passing in a string, PBKDF2 is used.
* When passing in an Array buffer of cryptographically random numbers, HKDF is being used. (recommended)
* When passing in a string, PBKDF2 is used. (recommended for maximum compatibility across SDKs)
* When passing in an ArrayBuffer of cryptographically random numbers, HKDF is used.
*
* Note: Not all client SDKS support HKDF.
* @param key
*/
async setKey(key: string | ArrayBuffer) {
Expand Down
Loading