4964430: (spec) missing IllegalStateException exception requirement for javax.crypto.Cipher.doFinal #15727

blperez01 · 2023-09-13T18:08:35Z

Updated IllegalStateException exception requirements for update, doFinal, wrap, and unwrap

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

Issue

JDK-4964430: (spec) missing IllegalStateException exception requirement for javax.crypto.Cipher.doFinal (Bug - P4)

Reviewers

Sean Mullan (@seanjmullan - Reviewer)
Valerie Peng (@valeriepeng - Reviewer)

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 15727

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

Using diff file

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

Webrev

Link to Webrev Comment

…nd unwrap

bridgekeeper · 2023-09-13T18:09:39Z

👋 Welcome back blperez01! 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 · 2023-09-13T18:10:56Z

@blperez01 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.

mlbridge · 2023-09-13T18:14:49Z

Webrevs

src/java.base/share/classes/javax/crypto/Cipher.java

valeriepeng · 2023-09-25T23:48:49Z

Cipher.updateAAD(...) methods also calls checkCipherState(), so its javadoc should be updated as well?
Given the current checkCipherState() impl does not check for states for NullCipher objects, do we want to also update the javax.crypto.NullCipher class javadoc to mention that IllegalStateException is not thrown by various methods?
Update copyright year to 2023?

blperez01 · 2023-10-02T23:01:13Z

Cipher.updateAAD(...) methods also calls checkCipherState(), so its javadoc should be updated as well?

The current documentation for Cipher.updateAAD(...) is:

"@throws IllegalStateException if this {@code Cipher} object is in a wrong state (e.g., has not been initialized), does not accept AAD, or if operating in either GCM or CCM mode and one of the {@code update} methods has already been called for the active encryption/decryption operation"

This seems fairly explicit, but I could change the wording to

"@throws IllegalStateException if this {@code Cipher} object is in a wrong state (e.g., has not been initialized, or is not in ENCRYPT_MODE or DECRYPT_MODE)"

valeriepeng · 2023-10-02T23:59:33Z

Cipher.updateAAD(...) methods also calls checkCipherState(), so its javadoc should be updated as well?

The current documentation for Cipher.updateAAD(...) is:

"@throws IllegalStateException if this {@code Cipher} object is in a wrong state (e.g., has not been initialized), does not accept AAD, or if operating in either GCM or CCM mode and one of the {@code update} methods has already been called for the active encryption/decryption operation"

This seems fairly explicit, but I could change the wording to

"@throws IllegalStateException if this {@code Cipher} object is in a wrong state (e.g., has not been initialized, or is not in ENCRYPT_MODE or DECRYPT_MODE)"

We still need the part of "does not accept AAD, or if operating in either GCM or CCM mode and one of the {@code update} methods has already been called for the active encryption/decryption operation".

blperez01 · 2023-10-03T16:23:45Z

Given the current checkCipherState() impl does not check for states for NullCipher objects, do we want to also update the javax.crypto.NullCipher class javadoc to mention that IllegalStateException is not thrown by various methods?

Current documentation is:

"The {@code NullCipher} class is a class that provides an "identity cipher" -- one that does not transform the plain text. As a consequence, the ciphertext is identical to the plaintext. All initialization methods do nothing, while the blocksize is set to 1 byte."

Would it be sufficient for me to add "Unlike other ciphers, the {@code NullCipher} will not throw an {@code IllegalStateException} when calling {@code Cipher} methods in an incorrect state."

…StateException when calling Cipher methods in bad state

seanjmullan · 2023-10-05T14:26:44Z

src/java.base/share/classes/javax/crypto/Cipher.java

@@ -1851,7 +1851,8 @@ private void checkCipherState() {
     * new block
     *
     * @throws IllegalStateException if this {@code Cipher} object is in a
-     * wrong state (e.g., has not been initialized)
+     * wrong state (e.g., has not been initialized, or is not
+     * in ENCRYPT_MODE or DECRYPT_MODE)


Use code format when referencing the modes, ex: change this line to:

* in {@code ENCRYPT_MODE} or {@code DECRYPT_MODE})

Same comment applies to all other applicable lines below.

seanjmullan · 2023-10-05T14:29:35Z

src/java.base/share/classes/javax/crypto/NullCipher.java

+ * {@code IllegalStateException} when calling {@code Cipher} methods
+ * in an incorrect state.


Suggest rewording last part as "... when {@code Cipher} methods are called in an incorrect state." I also think we should say a NullCipher has no state. So how about:

"Unlike other ciphers, the {@code NullCipher} has no state, and will not throw an {@code IllegalStateException} when {@code Cipher} methods are called in an incorrect state."

Well, if it has no state it cannot be in an incorrect state so the " in an incorrect state" part can be omitted.

Good point!

openjdk · 2023-10-05T18:08:02Z

@blperez01 This change now passes all automated pre-integration checks.

ℹ️ This project also has non-automated pre-integration requirements. Please see the file CONTRIBUTING.md for details.

After integration, the commit message for the final commit will be:

4964430: (spec) missing IllegalStateException exception requirement for javax.crypto.Cipher.doFinal

Reviewed-by: mullan, valeriep

You can use pull request commands such as /summary, /contributor and /issue to adjust it as needed.

At the time when this comment was updated there had been 591 new commits pushed to the master branch:

a1c9587: 8313348: Fix typo in JFormattedTextField: 'it self'
a8eacb3: 8317240: Promptly free OopMapEntry after fail to insert the entry to OopMapCache
4c5b66d: 8317522: Test logic for BODY_CF in AbstractThrowingSubscribers.java is wrong
42be238: 8316523: Relativize esp in interpreter frames (PowerPC only)
a250ae4: 8317039: Enable specifying the JDK used to run jtreg
1ed9c76: 8309204: Obsolete DoReserveCopyInSuperWord
3630af2: 8316594: C2 SuperWord: wrong result with hand unrolled loops
c6c69b5: 8314654: Metaspace: move locking out of MetaspaceArena
3105538: 8316146: Open some swing tests 4
36314a9: 8267509: Improve IllegalAccessException message to include the cause of the exception
... and 581 more: https://git.openjdk.org/jdk/compare/17a19dc06062331c954fa519a4f668664b1533c9...master

As there are no conflicts, your changes will automatically be rebased on top of these commits when integrating. If you prefer to avoid this automatic rebasing, please check the documentation for the /integrate command for further details.

As you do not have Committer status in this project an existing Committer must agree to sponsor your change. Possible candidates are the reviewers of this PR (@seanjmullan, @valeriepeng) but any other Committer may sponsor as well.

➡️ To flag this PR as ready for integration with the above commit message, type /integrate in a new comment. (Afterwards, your sponsor types /sponsor in a new comment to perform the integration).

blperez01 · 2023-10-05T18:53:48Z

/integrate

openjdk · 2023-10-05T18:54:59Z

@blperez01
Your change (at version 201275d) is now ready to be sponsored by a Committer.

valeriepeng · 2023-10-06T03:06:04Z

/sponsor

openjdk · 2023-10-06T03:07:25Z

Going to push as commit 991ce84.
Since your change was applied there have been 592 commits pushed to the master branch:

8a30c2a: 8317443: StackOverflowError on calling ListFormat::getInstance() for Norwegian locales
a1c9587: 8313348: Fix typo in JFormattedTextField: 'it self'
a8eacb3: 8317240: Promptly free OopMapEntry after fail to insert the entry to OopMapCache
4c5b66d: 8317522: Test logic for BODY_CF in AbstractThrowingSubscribers.java is wrong
42be238: 8316523: Relativize esp in interpreter frames (PowerPC only)
a250ae4: 8317039: Enable specifying the JDK used to run jtreg
1ed9c76: 8309204: Obsolete DoReserveCopyInSuperWord
3630af2: 8316594: C2 SuperWord: wrong result with hand unrolled loops
c6c69b5: 8314654: Metaspace: move locking out of MetaspaceArena
3105538: 8316146: Open some swing tests 4
... and 582 more: https://git.openjdk.org/jdk/compare/17a19dc06062331c954fa519a4f668664b1533c9...master

Your commit was automatically rebased without conflicts.

openjdk · 2023-10-06T03:07:37Z

@valeriepeng @blperez01 Pushed as commit 991ce84.

💡 You may see a message that your pull request was closed with unmerged commits. This can be safely ignored.

Updated IllegalStateException requirement in update, doFinal, wrap, a…

5a40880

…nd unwrap

openjdk bot added the rfr Pull request is ready for review label Sep 13, 2023

openjdk bot added the security security-dev@openjdk.org label Sep 13, 2023

seanjmullan reviewed Sep 14, 2023

View reviewed changes

src/java.base/share/classes/javax/crypto/Cipher.java Outdated Show resolved Hide resolved

blperez01 changed the title ~~4964430: Missing IllegalStateException exception requirement for javax.crypto.Cipher.doFinal~~ 4964430: (spec) missing IllegalStateException exception requirement for javax.crypto.Cipher.doFinal Sep 14, 2023

Removed periods at end of IllegalStateException comment

ce5b77f

Updated doc for updateAAD, fixed copywrite

49c729f

Updated docs for NullCipher to indicate it will not throw and Illegal…

8955ffe

…StateException when calling Cipher methods in bad state

seanjmullan suggested changes Oct 5, 2023

View reviewed changes

Wording change for NullCipher doc, added @code tags

201275d

seanjmullan approved these changes Oct 5, 2023

View reviewed changes

openjdk bot added the ready Pull request is ready to be integrated label Oct 5, 2023

openjdk bot added the sponsor Pull request is ready to be sponsored label Oct 5, 2023

valeriepeng approved these changes Oct 5, 2023

View reviewed changes

openjdk bot added the integrated Pull request has been integrated label Oct 6, 2023

openjdk bot closed this Oct 6, 2023

openjdk bot removed ready Pull request is ready to be integrated rfr Pull request is ready for review labels Oct 6, 2023

openjdk bot removed the sponsor Pull request is ready to be sponsored label Oct 6, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

4964430: (spec) missing IllegalStateException exception requirement for javax.crypto.Cipher.doFinal #15727

4964430: (spec) missing IllegalStateException exception requirement for javax.crypto.Cipher.doFinal #15727

blperez01 commented Sep 13, 2023 •

edited by openjdk bot

Loading

bridgekeeper bot commented Sep 13, 2023

openjdk bot commented Sep 13, 2023

mlbridge bot commented Sep 13, 2023 •

edited

Loading

valeriepeng commented Sep 25, 2023

blperez01 commented Oct 2, 2023

valeriepeng commented Oct 2, 2023 •

edited

Loading

blperez01 commented Oct 3, 2023 •

edited

Loading

seanjmullan Oct 5, 2023

seanjmullan Oct 5, 2023

ferakocz Oct 5, 2023

seanjmullan Oct 5, 2023

openjdk bot commented Oct 5, 2023 •

edited

Loading

blperez01 commented Oct 5, 2023

openjdk bot commented Oct 5, 2023

valeriepeng commented Oct 6, 2023

openjdk bot commented Oct 6, 2023

openjdk bot commented Oct 6, 2023

		* {@code IllegalStateException} when calling {@code Cipher} methods
		* in an incorrect state.

4964430: (spec) missing IllegalStateException exception requirement for javax.crypto.Cipher.doFinal #15727

4964430: (spec) missing IllegalStateException exception requirement for javax.crypto.Cipher.doFinal #15727

Conversation

blperez01 commented Sep 13, 2023 • edited by openjdk bot Loading

Progress

Issue

Reviewers

Reviewing

Webrev

bridgekeeper bot commented Sep 13, 2023

openjdk bot commented Sep 13, 2023

mlbridge bot commented Sep 13, 2023 • edited Loading

Webrevs

valeriepeng commented Sep 25, 2023

blperez01 commented Oct 2, 2023

valeriepeng commented Oct 2, 2023 • edited Loading

blperez01 commented Oct 3, 2023 • edited Loading

seanjmullan Oct 5, 2023

Choose a reason for hiding this comment

seanjmullan Oct 5, 2023

Choose a reason for hiding this comment

ferakocz Oct 5, 2023

Choose a reason for hiding this comment

seanjmullan Oct 5, 2023

Choose a reason for hiding this comment

openjdk bot commented Oct 5, 2023 • edited Loading

blperez01 commented Oct 5, 2023

openjdk bot commented Oct 5, 2023

valeriepeng commented Oct 6, 2023

openjdk bot commented Oct 6, 2023

openjdk bot commented Oct 6, 2023

blperez01 commented Sep 13, 2023 •

edited by openjdk bot

Loading

mlbridge bot commented Sep 13, 2023 •

edited

Loading

valeriepeng commented Oct 2, 2023 •

edited

Loading

blperez01 commented Oct 3, 2023 •

edited

Loading

openjdk bot commented Oct 5, 2023 •

edited

Loading