Skip to content

doc: add AES-OCB to aesKeyGenParams.name - #65181

Open
arhxam wants to merge 1 commit into
nodejs:mainfrom
arhxam:doc-webcrypto-aes-ocb
Open

doc: add AES-OCB to aesKeyGenParams.name#65181
arhxam wants to merge 1 commit into
nodejs:mainfrom
arhxam:doc-webcrypto-aes-ocb

Conversation

@arhxam

@arhxam arhxam commented Aug 10, 2026

Copy link
Copy Markdown

Description

The aesKeyGenParams.name value list in doc/api/webcrypto.md omits
'AES-OCB', even though AES-OCB key generation is supported:

  • lib/internal/crypto/util.js dispatches AES-OCB's generateKey
    through the AesKeyGenParams dictionary, and it works at runtime:

    $ node -e "crypto.subtle.generateKey({ name: 'AES-OCB', length: 256 }, true, ['encrypt', 'decrypt']).then((k) => console.log(k.algorithm))"
    { name: 'AES-OCB', length: 256 }
  • The sibling aesDerivedKeyParams.name list in the same document
    already includes 'AES-OCB', and so does the list of algorithms
    supported by generateKey() — so the omission is an internal
    inconsistency.

This adds 'AES-OCB' to the aesKeyGenParams.name list so the value
lists agree. Documentation-only change.

The `aesKeyGenParams.name` value list omitted `'AES-OCB'`, but AES-OCB
key generation is dispatched through the `AesKeyGenParams` dictionary in
lib/internal/crypto/util.js and works at runtime. The sibling
`aesDerivedKeyParams.name` list and the list of algorithms supported by
`generateKey()` in the same document already include `'AES-OCB'`. Add it
so the value lists are consistent.

Signed-off-by: Arham Wani <arhamwani765@gmail.com>
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

Review requested:

  • @nodejs/crypto

@nodejs-github-bot nodejs-github-bot added crypto Issues and PRs related to the crypto subsystem. doc Issues and PRs related to the documentations. labels Aug 10, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

crypto Issues and PRs related to the crypto subsystem. doc Issues and PRs related to the documentations.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants