Skip to content

8349946: Cipher javadoc could describe AEAD reuse better #25399

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.

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

Open
wants to merge 10 commits into
base: master
Choose a base branch
from

Conversation

koushikthirupattur
Copy link
Contributor

@koushikthirupattur koushikthirupattur commented May 22, 2025

The class documentation in javax.crypto.Cipher could better describe AEAD and reuse. The current class description example is outdated as GCM encryption does not allow resets. The doc should state that reset() may not be possible with some algorithms or providers and that an InvalidAlgorithmParameterException is thrown


Progress

  • Change must be properly reviewed (1 review required, with at least 1 Reviewer)
  • Change must not contain extraneous whitespace
  • Commit message must refer to an issue
  • Change requires CSR request JDK-8358812 to be approved

Issues

  • JDK-8349946: Cipher javadoc could describe AEAD reuse better (Bug - P4)
  • JDK-8358812: Cipher javadoc could describe AEAD reuse better (CSR)

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.org/jdk.git pull/25399/head:pull/25399
$ git checkout pull/25399

Update a local copy of the PR:
$ git checkout pull/25399
$ git pull https://git.openjdk.org/jdk.git pull/25399/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 25399

View PR using the GUI difftool:
$ git pr show -t 25399

Using diff file

Download this PR as a diff file:
https://git.openjdk.org/jdk/pull/25399.diff

Using Webrev

Link to Webrev Comment

@bridgekeeper
Copy link

bridgekeeper bot commented May 22, 2025

👋 Welcome back koushikthirupattur! A progress list of the required criteria for merging this PR into master will be added to the body of your pull request. There are additional pull request commands available for use with this pull request.

@openjdk
Copy link

openjdk bot commented May 22, 2025

❗ This change is not yet ready to be integrated.
See the Progress checklist in the description for automated requirements.

@openjdk
Copy link

openjdk bot commented May 22, 2025

@koushikthirupattur The following label will be automatically applied to this pull request:

  • security

When this pull request is ready to be reviewed, an "RFR" email will be sent to the corresponding mailing list. If you would like to change these labels, use the /label pull request command.

@ascarpino
Copy link
Contributor

/csr

@openjdk openjdk bot added the csr Pull request needs approved CSR before integration label Jun 6, 2025
@openjdk
Copy link

openjdk bot commented Jun 6, 2025

@ascarpino has indicated that a compatibility and specification (CSR) request is needed for this pull request.

@koushikthirupattur please create a CSR request for issue JDK-8349946 with the correct fix version. This pull request cannot be integrated until the CSR request is approved.

@koushikthirupattur koushikthirupattur marked this pull request as ready for review June 6, 2025 19:52
@openjdk openjdk bot added the rfr Pull request is ready for review label Jun 6, 2025
@mlbridge
Copy link

mlbridge bot commented Jun 6, 2025

Webrevs

Copy link
Contributor

@ascarpino ascarpino left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Line 170 and 171 can be removed as the CC20/Poly1305 RFC isn't referenced anymore

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
csr Pull request needs approved CSR before integration rfr Pull request is ready for review security [email protected]
Development

Successfully merging this pull request may close these issues.

3 participants