8282723: Add constructors taking a cause to JSSE exceptions #7722

XueleiFan · 2022-03-07T07:52:29Z

Please review this small API enhancement to add the usual constructors taking a cause to javax.net.ssl exceptions. The use of initCause in the JSSE implementation code is updated to use the new constructors accordingly.

Please review the CSR: https://bugs.openjdk.java.net/browse/JDK-8282724

Progress

Change must not contain extraneous whitespace
Commit message must refer to an issue
Change must be properly reviewed
Change requires a CSR request to be approved

Issues

JDK-8282723: Add constructors taking a cause to JSSE exceptions
JDK-8282724: Add constructors taking a cause to JSSE exceptions (CSR)

Reviewers

Bradford Wetmore (@bradfordwetmore - Reviewer) ⚠️ Review applies to 61cc793
Iris Clark (@irisclark - Reviewer) ⚠️ Review applies to 61cc793

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.java.net/jdk pull/7722/head:pull/7722
$ git checkout pull/7722

Update a local copy of the PR:
$ git checkout pull/7722
$ git pull https://git.openjdk.java.net/jdk pull/7722/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 7722

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

Using diff file

Download this PR as a diff file:
https://git.openjdk.java.net/jdk/pull/7722.diff

XueleiFan · 2022-03-07T07:52:46Z

/csr

bridgekeeper · 2022-03-07T07:53:46Z

👋 Welcome back xuelei! 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 · 2022-03-07T07:55:48Z

@XueleiFan an approved CSR request is already required for this pull request.

openjdk · 2022-03-07T07:59:29Z

@XueleiFan The following labels will be automatically applied to this pull request:

net
security

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

mlbridge · 2022-03-07T08:03:28Z

Webrevs

dfuch · 2022-03-07T12:06:09Z

LGTM. Someone from security-dev should probably review this too.

bradfordwetmore · 2022-03-07T19:20:33Z

src/java.base/share/classes/javax/net/ssl/SSLException.java

@@ -48,8 +46,7 @@
     *
     * @param reason describes the problem.
     */
-    public SSLException(String reason)
-    {


Thanks for changing the style. I've always hated the extra vertical space. :)

rhalade · 2022-03-07T20:04:03Z

Please consider adding simple tests to cover new APIs, similar to https://github.com/openjdk/jdk/pull/7705/files#diff-28e1041be519b6266b3b92aea29c5d8917c279880da7e5e9823a518196e96ea5

rhalade · 2022-03-07T20:24:08Z

Update following for SSLPeerUnverifiedException -

https://github.com/openjdk/jdk/blob/master/src/java.naming/share/classes/com/sun/jndi/ldap/ext/StartTlsResponseImpl.java#L439

bradfordwetmore · 2022-03-07T20:30:07Z

src/java.base/share/classes/sun/security/ssl/SSLTrafficKeyDerivation.java

-                throw (SSLHandshakeException)(new SSLHandshakeException(
-                    "Could not generate secret").initCause(gse));
+                throw new SSLHandshakeException(
+                        "Could not generate secret", gse);


I can't quite tell given the coloring, but did this get changed into a tab?

Yes, I added 4 more whitespaces in line 158.

Ah, missed that. Good to be consistent.

bradfordwetmore · 2022-03-07T20:34:02Z

src/java.base/share/classes/sun/security/ssl/ECDHKeyExchange.java

-                throw (SSLHandshakeException) new SSLHandshakeException(
-                        "Could not generate ECPublicKey").initCause(e);
+                throw new SSLHandshakeException(
+                        "Could not generate ECPublicKey", e);


Nit: I think combining these lines would be < 80 chars

The exception name is too long to have in one line. There are 83 characters in total if combining line 203 and 204. 3 characters exceeding 80 chars per line limit is not easy to tell with eyes.

The 80 character recommendation isn't a hard limit, I favor readability in the 80-100 char range.

bradfordwetmore · 2022-03-07T20:36:41Z

src/java.base/share/classes/sun/security/ssl/SSLSocketInputRecord.java

@@ -263,8 +263,7 @@ void setDeliverStream(OutputStream outputStream) {
        } catch (BadPaddingException bpe) {


Does the copyright need to get updated?

Oops, I missed this file.

bradfordwetmore

Didn't see any unit tests for the new methods. Can approve after they are included.

XueleiFan · 2022-03-07T20:50:37Z

XueleiFan · 2022-03-07T20:51:16Z

Update following for SSLPeerUnverifiedException -

https://github.com/openjdk/jdk/blob/master/src/java.naming/share/classes/com/sun/jndi/ldap/ext/StartTlsResponseImpl.java#L439

Hm, I will check more usage out of the JSSE implementation code. Thank you!

XueleiFan · 2022-03-07T20:52:19Z

Please consider adding simple tests to cover new APIs, similar to https://github.com/openjdk/jdk/pull/7705/files#diff-28e1041be519b6266b3b92aea29c5d8917c279880da7e5e9823a518196e96ea5

Thank you for the reference. I will add some test cases.

XueleiFan · 2022-03-18T18:08:02Z

ping ...

bradfordwetmore · 2022-03-18T20:57:03Z

test/jdk/javax/net/ssl/ALPN/SSLServerSocketAlpnTest.java

@@ -484,7 +484,7 @@ SSLContext getSSLContext(String keyFilename, String trustFilename)
         */
        if ((local != null) && (remote != null)) {
            // If both failed, return the curthread's exception.
-            local.initCause(remote);
+            local.addSuppressed(remote);


bradfordwetmore · 2022-03-18T20:57:53Z

test/jdk/javax/net/ssl/ALPN/SSLSocketAlpnTest.java

@@ -480,7 +480,7 @@ SSLContext getSSLContext(String keyFilename, String trustFilename)
         */
        if ((local != null) && (remote != null)) {
            // If both failed, return the curthread's exception.
-            local.initCause(remote);
+            local.addSuppressed(remote);


bradfordwetmore · 2022-03-18T21:00:40Z

test/jdk/javax/net/ssl/SSLException/CheckSSLHandshakeException.java

@@ -0,0 +1,50 @@
+/*
+ * Copyright (C) 2022 THL A29 Limited, a Tencent company. All rights reserved.


I am unsure about the third-party copyrights on these files. They are probably ok, but you should get approval by someone more familiar.

Secondly, in the Oracle environment, we generally use a trailing , comma after the date. e.g.

Copyright (C) 2022,

The location of the copyright is fine. No need to enforce Oracle date formatting.

bradfordwetmore · 2022-03-18T21:08:56Z

test/jdk/javax/net/ssl/SSLException/CheckSSLHandshakeException.java

+import javax.net.ssl.SSLHandshakeException;
+import java.util.Objects;
+
+public class CheckSSLHandshakeException {


My personal preference would have been to combine all of these into a single testfile to minimize clutter in the logs and directories, but no strong objection.

I understand. I would like to have them in separated test cases so that it is easier to monitor the regressions in the future.

bradfordwetmore · 2022-03-18T21:10:00Z

test/jdk/javax/net/ssl/templates/SSLSocketSSLEngineTemplate.java

@@ -349,13 +349,13 @@ private void runTest(boolean direct) throws Exception {
        } finally {


Copyright update

bradfordwetmore · 2022-03-18T21:10:08Z

test/jdk/javax/net/ssl/templates/SSLSocketTemplate.java

@@ -544,7 +544,7 @@ private void bootup() throws Exception {
         */


Copyright update

bradfordwetmore

Please see latest comments and let's verify the copyright is correct, but otherwise looks good.

openjdk · 2022-03-18T21:13:15Z

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

8282723: Add constructors taking a cause to JSSE exceptions

Reviewed-by: wetmore, iris

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

8384ac4: 8283057: Update GCC to version 11.2 for Oracle builds on Linux
d8893fa: 8283059: Uninitialized warning in check_code.c with GCC 11.2
ff0b092: 8278794: Infinite loop in DeflaterOutputStream.finish()
b2aa085: 8283378: JFR: Checkpoint classes not renamed properly
85cc6f1: 8283315: jrt-fs.jar not always deterministically built
c72bcfc: 8283289: JFR: Rename CheckPoint
4b5079b: 8283202: Potential off-read when checking JFR's status in awaitFinished
b96cb04: 8283353: compiler/c2/cr6865031/Test.java and compiler/runtime/Test6826736.java fails on x86_32
cab4ff6: 8283225: ClassLoader.c produces incorrect OutOfMemory Exception when length is 0 (aix)
d83cee9: 8282407: Missing ')' in MacResources.properties
... and 112 more: https://git.openjdk.java.net/jdk/compare/974ef5542fe52f9cb8ffd8751df8a020bca503c9...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.

➡️ To integrate this PR with the above commit message to the master branch, type /integrate in a new comment.

irisclark · 2022-03-18T23:04:11Z

test/jdk/javax/net/ssl/SSLException/CheckSSLHandshakeException.java

@@ -0,0 +1,50 @@
+/*
+ * Copyright (C) 2022 THL A29 Limited, a Tencent company. All rights reserved.


The location of the copyright is fine. No need to enforce Oracle date formatting.

bradfordwetmore · 2022-03-18T23:08:54Z

Thanks, @irisclark!

XueleiFan · 2022-03-20T06:44:26Z

/integrate

openjdk · 2022-03-20T06:46:22Z

Going to push as commit 4df6742.
Since your change was applied there have been 128 commits pushed to the master branch:

3f923b8: 8282704: runtime/Thread/StopAtExit.java may leak memory
80415e0: 8282534: Remove redundant null check in ChaCha20Cipher.engineInit
e8caf84: 8282574: Cleanup unnecessary calls to Throwable.initCause() in jdk.compiler
10ccfff: 8283352: [CDS] SharedBaseAddress.java fails on x86_32
3e58a43: 8283287: ClassLoader.c cleanups
0c3094c: 8204541: Correctly support AIX xlC 16.1 symbol visibility flags
8384ac4: 8283057: Update GCC to version 11.2 for Oracle builds on Linux
d8893fa: 8283059: Uninitialized warning in check_code.c with GCC 11.2
ff0b092: 8278794: Infinite loop in DeflaterOutputStream.finish()
b2aa085: 8283378: JFR: Checkpoint classes not renamed properly
... and 118 more: https://git.openjdk.java.net/jdk/compare/974ef5542fe52f9cb8ffd8751df8a020bca503c9...master

Your commit was automatically rebased without conflicts.

openjdk · 2022-03-20T06:46:37Z

@XueleiFan Pushed as commit 4df6742.

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

8282723: Add constructors taking a cause to JSSE exceptions

20c0c6b

openjdk bot added csr Pull request needs approved CSR before integration rfr Pull request is ready for review labels Mar 7, 2022

openjdk bot added security security-dev@openjdk.org net net-dev@openjdk.org labels Mar 7, 2022

bradfordwetmore reviewed Mar 7, 2022

View reviewed changes

typo correction

edb185e

bradfordwetmore reviewed Mar 7, 2022

View reviewed changes

XueleiFan closed this Mar 7, 2022

XueleiFan reopened this Mar 7, 2022

openjdk bot removed the csr Pull request needs approved CSR before integration label Mar 7, 2022

Xuelei Fan added 3 commits March 7, 2022 21:43

update more usage and add test cases

628605e

update usage in test template

3795331

more test case udpate

61cc793

bradfordwetmore reviewed Mar 18, 2022

View reviewed changes

bradfordwetmore approved these changes Mar 18, 2022

View reviewed changes

openjdk bot added the ready Pull request is ready to be integrated label Mar 18, 2022

irisclark approved these changes Mar 18, 2022

View reviewed changes

update copyright years

5d0fcf2

openjdk bot added the integrated Pull request has been integrated label Mar 20, 2022

openjdk bot closed this Mar 20, 2022

openjdk bot removed ready Pull request is ready to be integrated rfr Pull request is ready for review labels Mar 20, 2022

XueleiFan deleted the JDK-8282723 branch March 20, 2022 06:49

8282723: Add constructors taking a cause to JSSE exceptions #7722

8282723: Add constructors taking a cause to JSSE exceptions #7722

XueleiFan commented Mar 7, 2022 •

edited by openjdk bot

XueleiFan commented Mar 7, 2022

bridgekeeper bot commented Mar 7, 2022

openjdk bot commented Mar 7, 2022

openjdk bot commented Mar 7, 2022

mlbridge bot commented Mar 7, 2022 •

edited

dfuch commented Mar 7, 2022

bradfordwetmore Mar 7, 2022

rhalade commented Mar 7, 2022

rhalade commented Mar 7, 2022

bradfordwetmore Mar 7, 2022

XueleiFan Mar 7, 2022

bradfordwetmore Mar 7, 2022

bradfordwetmore Mar 7, 2022

XueleiFan Mar 8, 2022

RogerRiggs Mar 8, 2022

bradfordwetmore Mar 7, 2022

XueleiFan Mar 7, 2022

bradfordwetmore left a comment

XueleiFan commented Mar 7, 2022

XueleiFan commented Mar 7, 2022

XueleiFan commented Mar 7, 2022

XueleiFan commented Mar 18, 2022

bradfordwetmore Mar 18, 2022

bradfordwetmore Mar 18, 2022

bradfordwetmore Mar 18, 2022 •

edited

irisclark Mar 18, 2022

bradfordwetmore Mar 18, 2022

XueleiFan Mar 19, 2022

bradfordwetmore Mar 18, 2022

bradfordwetmore Mar 18, 2022

bradfordwetmore left a comment

openjdk bot commented Mar 18, 2022 •

edited

irisclark Mar 18, 2022

bradfordwetmore commented Mar 18, 2022

XueleiFan commented Mar 20, 2022

openjdk bot commented Mar 20, 2022

openjdk bot commented Mar 20, 2022

		@@ -263,8 +263,7 @@ void setDeliverStream(OutputStream outputStream) {
		} catch (BadPaddingException bpe) {

		@@ -0,0 +1,50 @@
		/*
		* Copyright (C) 2022 THL A29 Limited, a Tencent company. All rights reserved.

		@@ -349,13 +349,13 @@ private void runTest(boolean direct) throws Exception {
		} finally {

		@@ -544,7 +544,7 @@ private void bootup() throws Exception {
		*/

8282723: Add constructors taking a cause to JSSE exceptions #7722

8282723: Add constructors taking a cause to JSSE exceptions #7722

Conversation

XueleiFan commented Mar 7, 2022 • edited by openjdk bot

Progress

Issues

Reviewers

Reviewing

XueleiFan commented Mar 7, 2022

bridgekeeper bot commented Mar 7, 2022

openjdk bot commented Mar 7, 2022

openjdk bot commented Mar 7, 2022

mlbridge bot commented Mar 7, 2022 • edited

Webrevs

dfuch commented Mar 7, 2022

Choose a reason for hiding this comment

rhalade commented Mar 7, 2022

rhalade commented Mar 7, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bradfordwetmore left a comment

Choose a reason for hiding this comment

XueleiFan commented Mar 7, 2022

XueleiFan commented Mar 7, 2022

XueleiFan commented Mar 7, 2022

XueleiFan commented Mar 18, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bradfordwetmore Mar 18, 2022 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

bradfordwetmore left a comment

Choose a reason for hiding this comment

openjdk bot commented Mar 18, 2022 • edited

Choose a reason for hiding this comment

bradfordwetmore commented Mar 18, 2022

XueleiFan commented Mar 20, 2022

openjdk bot commented Mar 20, 2022

openjdk bot commented Mar 20, 2022

XueleiFan commented Mar 7, 2022 •

edited by openjdk bot

mlbridge bot commented Mar 7, 2022 •

edited

bradfordwetmore Mar 18, 2022 •

edited

openjdk bot commented Mar 18, 2022 •

edited