Add X25519 generateKey overload to SubtleCrypto#2358
Merged
github-actions[bot] merged 1 commit intomicrosoft:mainfrom Jan 8, 2026
Merged
Add X25519 generateKey overload to SubtleCrypto#2358github-actions[bot] merged 1 commit intomicrosoft:mainfrom
github-actions[bot] merged 1 commit intomicrosoft:mainfrom
Conversation
This adds a specific overload for the X25519 key exchange algorithm to the SubtleCrypto.generateKey() method, following the same pattern as the existing Ed25519 overload. X25519 is used for key derivation (ECDH), so it uses 'deriveBits' and 'deriveKey' as valid keyUsages, unlike Ed25519 which uses 'sign' and 'verify'. This allows TypeScript to correctly infer CryptoKeyPair as the return type when using X25519, eliminating the need for type assertions or instanceof checks. Fixes microsoft/TypeScript#62926
Contributor
|
Thanks for the PR! This section of the codebase is owned by @saschanaz - if they write a comment saying "LGTM" then it will be merged. |
Contributor
Author
|
@microsoft-github-policy-service agree |
Bashamega
approved these changes
Jan 8, 2026
Collaborator
|
LGTM, thanks! (#2050 is a bigger version of it but it's too big) |
Contributor
|
Merging because @saschanaz is a code-owner of all the changes - thanks! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds a specific overload for the X25519 key exchange algorithm to the
SubtleCrypto.generateKey()method, following the same pattern as the existing Ed25519 overload.Changes
Added the following overload to
SubtleCryptointerface ininputfiles/overridingTypes.jsonc:Rationale
X25519 is used for key derivation (ECDH), so it uses
deriveBitsandderiveKeyas valid keyUsages, unlike Ed25519 which usessignandverify.This allows TypeScript to correctly infer
CryptoKeyPairas the return type when using X25519, eliminating the need for type assertions or instanceof checks:Browser Support
X25519 is supported by:
This meets the requirement of support by 2+ major browser engines.
References