6227536: KeyGenerator.init() methods do not throw IllegalArgumentException for keysize == 0 #9679

driverkt · 2022-07-28T17:32:57Z

As mentioned in the bug report, this issue should not be a framework-level issue, since potentially an individual provider could create a keysize of zero to have a certain significance.

In the changes made here for HmacMD5- and HmacSHA1- KeyGenerators, the check is for keysize <= 0 and this message indicates this is a check characteristic to the SunJCE provider.

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-6227536: KeyGenerator.init() methods do not throw IllegalArgumentException for keysize == 0

Reviewers

Bradford Wetmore (@bradfordwetmore - Reviewer)

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 9679

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

Using diff file

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

bridgekeeper · 2022-07-28T17:33:44Z

👋 Welcome back kdriver! 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.

driverkt · 2022-07-28T17:35:25Z

/issue add 6227536

openjdk · 2022-07-28T17:37:45Z

@driverkt This issue is referenced in the PR title - it will now be updated.

openjdk · 2022-07-28T17:40:25Z

@driverkt 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 · 2022-07-28T17:43:04Z

Webrevs

src/java.base/share/classes/com/sun/crypto/provider/HmacMD5KeyGenerator.java

src/java.base/share/classes/com/sun/crypto/provider/HmacSHA1KeyGenerator.java

bradfordwetmore

Needs regression tests.

Have you looked at the other Key(Pair)Generators? We've probably added more when this bug was filed. I took a quick look at some, and they were covered. (DES/DESede/Blowfish/AES/etc.)

bradfordwetmore · 2022-07-28T20:24:53Z

src/java.base/share/classes/com/sun/crypto/provider/HmacMD5KeyGenerator.java

    protected void engineInit(int keysize, SecureRandom random) {
+
+        if (keysize <= 0) {
+            throw new IllegalArgumentException("keysize must not be <= 0 for SunJCE");


< 80 chars please

The "for SunJCE" is odd to see in an exception message, I would leave that out.

A stack trace of the exception should be sufficient to tell what provider/code is generating it.

@seanjmullan I thought about this, but I added it due to the bug describing that this would be implementation-specific rather than framework-specific. I can take it out.

Needs regression tests.

Have you looked at the other Key(Pair)Generators? We've probably added more when this bug was filed. I took a quick look at some, and they were covered. (DES/DESede/Blowfish/AES/etc.)

@bradfordwetmore The bug mentions only the Hmac*KeyGenerators. I thought about this too, but you mentioned in your initial triage comment on the bug that it should be treated as only relevant to the classes I modified. Thoughts?

What bug/Sean meant was that we wouldn't put in a check into java.security.* framework, but rather in sun.security.* implementation. And that we don't need to put "SunJCE" in this particular throws message, as we'll know where it is from the stack trace.

My comment agrees that we have a problem in the JCE Hmac code, but there might be other locations where init's like this might allow for invalid 0 values. It's just a general idea to check we didn't make the same issue elsewhere.

Other (newer) HmacXXX KeyGenerator enforces min key size to be 40. So, perhaps just enforce the same lower limit or just check for <0?

Also, it'd be nice to include HmacMD5 and HmacSHA1 to the bug synopsis as KeyGenerator covers many algorithms. Would be nice to add SunJCE provider to synopsis, so it's clear that this change/fix is provider-specific.

src/java.base/share/classes/com/sun/crypto/provider/HmacSHA1KeyGenerator.java

driverkt · 2022-07-29T18:46:32Z

Needs regression tests.

Have you looked at the other Key(Pair)Generators? We've probably added more when this bug was filed. I took a quick look at some, and they were covered. (DES/DESede/Blowfish/AES/etc.)

Yes, the others are covered.

driverkt · 2022-07-29T18:47:19Z

All review comments have been addressed.

bradfordwetmore

We are Slacking on some other test issues. Will approve on next update.

test/jdk/com/sun/crypto/provider/KeyGenerator/Test6227536.java

bradfordwetmore · 2022-07-29T20:07:20Z

test/jdk/com/sun/crypto/provider/KeyGenerator/Test6227536.java

+    }
+
+    public static void main(String[] args) throws Exception {
+        Test6227536 test = new Test6227536();


Calling the constructor just to get the class name seems redundant, as the test name will appear in all of the jtreg test output. I would probably pull it out, just my $0.02.

Ack. It's also a nice pattern for avoiding issues with main being static.

openjdk · 2022-07-29T20:09:23Z

@driverkt 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:

6227536: KeyGenerator.init() methods do not throw IllegalArgumentException for keysize == 0

Reviewed-by: wetmore

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 24 new commits pushed to the master branch:

cc2861a: 8290901: Reduce use of -source in langtools tests
64a1a08: 8289647: AssertionError during annotation processing of record related tests
95fc16b: 8290525: Move HeapRegion::_compaction_top to G1FullCollector
f58e08e: 8290715: Fix incorrect uses of G1CollectedHeap::heap_region_containing()
18cd16d: 8291003: ARM32: constant_table.size assertion
cfe9026: 8289511: Improve test coverage for XPath Axes: child
eeac3da: 8289755: Remove --enable-reproducible-build from jib profile
791fc57: 6383195: javax.crypto.spec.PBEKeySpec is not thread safe
e052d7f: 8288477: nmethod header size reduction
54a2c5a: 8290059: Do not use std::thread in panama tests
... and 14 more: https://git.openjdk.org/jdk/compare/c1040897cd6d5bc6e76c971035cc36c9d35b31e6...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 (@bradfordwetmore) 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).

driverkt · 2022-07-29T20:14:26Z

/integrate

openjdk · 2022-07-29T20:15:31Z

@driverkt
Your change (at version 921fb97) is now ready to be sponsored by a Committer.

bradfordwetmore · 2022-07-29T20:28:34Z

/sponsor

openjdk · 2022-07-29T20:30:39Z

Going to push as commit 0bcf176.
Since your change was applied there have been 24 commits pushed to the master branch:

cc2861a: 8290901: Reduce use of -source in langtools tests
64a1a08: 8289647: AssertionError during annotation processing of record related tests
95fc16b: 8290525: Move HeapRegion::_compaction_top to G1FullCollector
f58e08e: 8290715: Fix incorrect uses of G1CollectedHeap::heap_region_containing()
18cd16d: 8291003: ARM32: constant_table.size assertion
cfe9026: 8289511: Improve test coverage for XPath Axes: child
eeac3da: 8289755: Remove --enable-reproducible-build from jib profile
791fc57: 6383195: javax.crypto.spec.PBEKeySpec is not thread safe
e052d7f: 8288477: nmethod header size reduction
54a2c5a: 8290059: Do not use std::thread in panama tests
... and 14 more: https://git.openjdk.org/jdk/compare/c1040897cd6d5bc6e76c971035cc36c9d35b31e6...master

Your commit was automatically rebased without conflicts.

openjdk · 2022-07-29T20:30:51Z

@bradfordwetmore @driverkt Pushed as commit 0bcf176.

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

initial commit

9ba7096

openjdk bot added the rfr Pull request is ready for review label Jul 28, 2022

update copyrights

5e8f143

openjdk bot changed the title ~~JDK-6227536: KeyGenerator.init() methods do not throw IllegalArgumentException for keysize == 0~~ 6227536: KeyGenerator.init() methods do not throw IllegalArgumentException for keysize == 0 Jul 28, 2022

openjdk bot added the security security-dev@openjdk.org label Jul 28, 2022

mcpowers reviewed Jul 28, 2022

View reviewed changes

src/java.base/share/classes/com/sun/crypto/provider/HmacMD5KeyGenerator.java Outdated Show resolved Hide resolved

mcpowers reviewed Jul 28, 2022

View reviewed changes

src/java.base/share/classes/com/sun/crypto/provider/HmacSHA1KeyGenerator.java Outdated Show resolved Hide resolved

formatting

f0d0912

bradfordwetmore reviewed Jul 28, 2022

View reviewed changes

driverkt added 3 commits July 28, 2022 16:38

80 char line

2cf5b7b

remove provider mention

3a7367e

initial commit

9752981

driverkt added 2 commits July 29, 2022 14:25

using jtreg helper

07de4cd

optimizing test case

94ccc3d

bradfordwetmore reviewed Jul 29, 2022

View reviewed changes

test/jdk/com/sun/crypto/provider/KeyGenerator/Test6227536.java Outdated Show resolved Hide resolved

test/jdk/com/sun/crypto/provider/KeyGenerator/Test6227536.java Outdated Show resolved Hide resolved

driverkt added 3 commits July 29, 2022 14:46

optimizing test case

ae3e254

update copyright

d754211

put back standard if block, since we never hit the failure case

921fb97

bradfordwetmore approved these changes Jul 29, 2022

View reviewed changes

openjdk bot added the ready Pull request is ready to be integrated label Jul 29, 2022

openjdk bot added the sponsor Pull request is ready to be sponsored label Jul 29, 2022

openjdk bot added the integrated Pull request has been integrated label Jul 29, 2022

openjdk bot closed this Jul 29, 2022

openjdk bot removed ready Pull request is ready to be integrated rfr Pull request is ready for review sponsor Pull request is ready to be sponsored labels Jul 29, 2022

driverkt deleted the JDK-6227536 branch July 29, 2022 20:50

6227536: KeyGenerator.init() methods do not throw IllegalArgumentException for keysize == 0 #9679

6227536: KeyGenerator.init() methods do not throw IllegalArgumentException for keysize == 0 #9679

Uh oh!

Conversation

driverkt commented Jul 28, 2022 • edited by openjdk bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Progress

Issue

Reviewers

Reviewing

Uh oh!

bridgekeeper bot commented Jul 28, 2022

Uh oh!

driverkt commented Jul 28, 2022

Uh oh!

openjdk bot commented Jul 28, 2022

Uh oh!

openjdk bot commented Jul 28, 2022

Uh oh!

mlbridge bot commented Jul 28, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Webrevs

Uh oh!

Uh oh!

Uh oh!

bradfordwetmore left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

driverkt Jul 28, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

valeriepeng Jul 28, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

driverkt commented Jul 29, 2022

Uh oh!

driverkt commented Jul 29, 2022

Uh oh!

bradfordwetmore left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

openjdk bot commented Jul 29, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

driverkt commented Jul 29, 2022

Uh oh!

openjdk bot commented Jul 29, 2022

Uh oh!

bradfordwetmore commented Jul 29, 2022

Uh oh!

openjdk bot commented Jul 29, 2022

Uh oh!

openjdk bot commented Jul 29, 2022

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

driverkt commented Jul 28, 2022 •

edited by openjdk bot

Loading

mlbridge bot commented Jul 28, 2022 •

edited

Loading

driverkt Jul 28, 2022 •

edited

Loading

valeriepeng Jul 28, 2022 •

edited

Loading

openjdk bot commented Jul 29, 2022 •

edited

Loading