8348986: Improve coverage of enhanced exception messages #23929

Michael-Mc-Mahon · 2025-03-06T10:24:13Z

Hi,

Enhanced exception messages are designed to hide sensitive information such as hostnames, IP
addresses from exception message strings, unless the enhanced mode for the specific category
has been explicitly enabled. Enhanced exceptions were first introduced in 8204233 in JDK 11 and
updated in 8207846.

This PR aims to increase the coverage of enhanced exception messages in the networking code.
A limited number of exceptions are already hidden (restricted) by default. The new categories and
exceptions in this PR will be restricted on an opt-in basis, ie. the default mode will be enhanced
(while preserving the existing behavior).

The mechanism is controlled by the security/system property "jdk.includeInExceptions" which takes as value
a comma separated list of category names, which identify groups of exceptions where the exception
message may be enhanced. Any category not listed is "restricted" which means that potentially
sensitive information (such as hostnames, IP addresses, user identities) are excluded from the message text.

The changes to the java.security conf file describe the exact changes in terms of the categories now
supported and any changes in behavior.

Thanks,
Michael

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-8354677 to be approved

Issues

JDK-8348986: Improve coverage of enhanced exception messages (Enhancement - P3)
JDK-8354677: Improve coverage of enhanced exception messages (CSR)

Reviewers

Daniel Fuchs (@dfuch - Reviewer)

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 23929

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

Using diff file

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

Using Webrev

Link to Webrev Comment

bridgekeeper · 2025-03-06T10:24:50Z

👋 Welcome back michaelm! 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 · 2025-03-06T10:25:09Z

@Michael-Mc-Mahon 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:

8348986: Improve coverage of enhanced exception messages

Reviewed-by: dfuchs

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

4618374: 8358310: ZGC: riscv, ppc ZPlatformAddressOffsetBits may return a too large value
78a392a: 8356880: ZGC: Backoff in ZLiveMap::reset spin-loop
c1a81cf: 8358284: doc/testing.html is not up to date after JDK-8355003
... and 7 more: https://git.openjdk.org/jdk/compare/dbf562c72502ab8da96eb130ff8222bba66c72cc...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.

openjdk · 2025-03-06T10:25:42Z

@Michael-Mc-Mahon The following labels will be automatically applied to this pull request:

core-libs
net
nio
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 · 2025-03-06T10:28:19Z

Webrevs

Michael-Mc-Mahon · 2025-03-06T10:35:38Z

/csr needed

openjdk · 2025-03-06T10:36:46Z

@Michael-Mc-Mahon has indicated that a compatibility and specification (CSR) request is needed for this pull request.

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

src/java.base/share/classes/jdk/internal/util/Exceptions.java

test/jdk/sun/net/util/ExceptionsTest.java

Michael-Mc-Mahon · 2025-05-29T09:00:54Z

here are a few files with IOException, UnknownHostException and MalformedURLException, which are worth reviewing for Exception that may have been missed

IOEXception:

open/src/java.base/share/classes/sun/net/www/protocol/https/HttpsClient.java Ln 562

open/src/java.base/share/classes/sun/security/x509/IPAddressName.java

open/src/java.base/share/classes/sun/security/x509/URIName.java

open/src/java.base/share/classes/sun/security/x509/RDN.java

open/src/java.base/share/classes/java/util/jar/JarFile.java

UnknownHostException

open/src/java.base/share/classes/sun/nio/ch/SocketAdaptor.java

open/src/java.base/share/classes/sun/nio/ch/NioSocketImpl.java

MalformedURLException

open/src/java.base/share/classes/sun/net/www/protocol/https/HttpsURLConnectionImpl.java

open/src/java.base/share/classes/java/net/URL.java — Invalid port

open/src/java.naming/share/classes/com/sun/jndi/ldap/LdapURL.java

open/src/java.naming/share/classes/com/sun/jndi/toolkit/url/Uri.java

open/src/java.rmi/share/classes/java/rmi/Naming.java

Thanks, I will take another look at all these cases and update any that I agree need to be included.

src/java.base/share/classes/sun/net/www/protocol/https/HttpsClient.java

src/java.naming/share/classes/com/sun/jndi/ldap/LdapURL.java

src/java.naming/share/classes/com/sun/jndi/toolkit/url/Uri.java

src/java.base/share/classes/sun/nio/ch/NioSocketImpl.java

src/java.base/share/classes/sun/nio/ch/SocketAdaptor.java

src/java.rmi/share/classes/java/rmi/Naming.java

dfuch · 2025-05-29T17:04:03Z

src/java.rmi/share/classes/java/rmi/Naming.java

        String scheme = uri.getScheme();
        if (scheme != null && !scheme.equals("rmi")) {
-            throw new MalformedURLException("invalid URL scheme: " + str);
+            throw newMalformedURLException("invalid URL scheme:", str);


Suggested change

throw newMalformedURLException("invalid URL scheme:", str);

throw new MalformedURLException(formatMsg("invalid URL scheme%s", filterNonSocketInfo(str).prefixWith(": ").replaceWith(": rmi"));

Co-authored-by: Daniel Fuchs <[email protected]>

Michael-Mc-Mahon · 2025-05-30T08:58:01Z

Thanks for the suggestions. I have committed all of them except for two. One, I will modify in another way.

Michael-Mc-Mahon · 2025-05-30T10:30:31Z

The last change to java.net.HostPortrange (renaming the constructor parameter) has caused a problem. The parameter is hiding a field of the same name. I need to fix that now.

AlanBateman · 2025-05-30T10:45:00Z

src/java.base/share/classes/sun/net/www/protocol/jmod/Handler.java

        if (index == -1)
-            throw new MalformedURLException("no !/ found in url spec:" + s);
+            throw new MalformedURLException(
+                formatMsg("no !/ found in url spec%s", filterJarName(s).prefixWith(": ")));


JMOD files can only be used at compile time and link time. So I think you can drop the changes jmod stream handler.

seanjmullan · 2025-05-30T13:32:08Z

src/java.base/share/conf/security/java.security

+# names, host names, or port numbers. By default, socket related exceptions
+# have this information restricted (meaning the sensitive details are removed).


I found the "By default ..." sentence a little confusing, since other categories are also restricted by default. My initial thought is to just remove this sentence, as reading further will make it more clear that the hostInfoExclSocket category is the only one that is not restricted by default. Alternatively, you could flip the meaning of this sentence and say which exceptions are not restricted by default.

Fair point. I think we can make this clearer with a small addition. I propose to add the following sentence after the one starting "By default ..."

# Exception messages relating to Jar files and exceptions containing user # identity information are also restricted by default.

I would change "Jar" to "JAR" as I think that is the more common form and used in other places in this file. Looks fine otherwise.

dfuch

Thanks for the last updates Michael. I believe we're good now!

Michael-Mc-Mahon · 2025-06-03T15:35:25Z

/integrate

openjdk · 2025-06-03T15:36:38Z

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

01f01b6: 8358283: Inconsistent failure mode for MetaspaceObj::operator new(size_t, MemTag)
faf19ab: 8358333: Use VEX2 prefix in Assembler::psllq
e2f7366: 8329951: var emits deprecation warnings that do not point to the file or position
... and 11 more: https://git.openjdk.org/jdk/compare/dbf562c72502ab8da96eb130ff8222bba66c72cc...master

Your commit was automatically rebased without conflicts.

openjdk · 2025-06-03T15:36:47Z

@Michael-Mc-Mahon Pushed as commit b6f827e.

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

Michael-Mc-Mahon added 13 commits January 31, 2025 16:41

initial impl

269efa3

Merge branch 'master' into 8348986-exceptions

466dab4

Merge branch 'master' into 8348986-exceptions

690cdb1

Merge branch 'master' into 8348986-exceptions

b941943

Merge branch 'master' into 8348986-exceptions

3047d6d

update

ccb31ea

Merge branch 'master' into 8348986-exceptions

55a43f7

update

fce5f69

update

d94e95d

Merge branch 'master' into 8348986-exceptions

c6df8de

moved test

23f9ee0

whitespace

fa25ccc

remove file added by mistake

c441986

openjdk bot added the rfr Pull request is ready for review label Mar 6, 2025

openjdk bot added security [email protected] nio [email protected] core-libs [email protected] net [email protected] labels Mar 6, 2025

openjdk bot added the csr Pull request needs approved CSR before integration label Mar 6, 2025

doc + copyright update

074da25

turbanoff reviewed Mar 6, 2025

View reviewed changes

src/java.base/share/classes/jdk/internal/util/Exceptions.java Outdated Show resolved Hide resolved

turbanoff reviewed Mar 6, 2025

View reviewed changes

src/java.base/share/classes/jdk/internal/util/Exceptions.java Outdated Show resolved Hide resolved

turbanoff reviewed Mar 6, 2025

View reviewed changes

test/jdk/sun/net/util/ExceptionsTest.java Outdated Show resolved Hide resolved

turbanoff reviewed Mar 6, 2025

View reviewed changes

test/jdk/sun/net/util/ExceptionsTest.java Outdated Show resolved Hide resolved

Additional callsites identified by Mark S.

34f20c9

openjdk bot removed the ready Pull request is ready to be integrated label May 29, 2025

dfuch reviewed May 29, 2025

View reviewed changes

Apply suggestions from code review

cf5233c

Co-authored-by: Daniel Fuchs <[email protected]>

Michael-Mc-Mahon added 2 commits May 30, 2025 10:09

Merge branch 'master' into 8348986-exceptions

021b841

typo in suggestions and other issues

462ee01

Fixed problem with j.n.HostPortRange

3eec6c0

AlanBateman reviewed May 30, 2025

View reviewed changes

seanjmullan reviewed May 30, 2025

View reviewed changes

Michael-Mc-Mahon added 4 commits May 30, 2025 21:46

doc update to java.security

5970c2b

removed jmod/Handler change

b582a0f

doc update to java.security

4aad014

Merge branch 'master' into 8348986-exceptions

ab6387d

dfuch approved these changes Jun 3, 2025

View reviewed changes

openjdk bot added the ready Pull request is ready to be integrated label Jun 3, 2025

uodate to JNDI

1a6f5af

openjdk bot removed the ready Pull request is ready to be integrated label Jun 3, 2025

dfuch approved these changes Jun 3, 2025

View reviewed changes

openjdk bot added the ready Pull request is ready to be integrated label Jun 3, 2025

openjdk bot added the integrated Pull request has been integrated label Jun 3, 2025

openjdk bot closed this Jun 3, 2025

openjdk bot removed ready Pull request is ready to be integrated rfr Pull request is ready for review labels Jun 3, 2025

graalvmbot mentioned this pull request Jun 10, 2025

[GR-65610] Update labsjdk to 25+26-jvmci-b01 oracle/graal#11374

Merged

	throw newMalformedURLException("invalid URL scheme:", str);
	throw new MalformedURLException(formatMsg("invalid URL scheme%s", filterNonSocketInfo(str).prefixWith(": ").replaceWith(": rmi"));

		# names, host names, or port numbers. By default, socket related exceptions
		# have this information restricted (meaning the sensitive details are removed).

8348986: Improve coverage of enhanced exception messages #23929

8348986: Improve coverage of enhanced exception messages #23929

Uh oh!

Conversation

Michael-Mc-Mahon commented Mar 6, 2025 • edited by openjdk bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Progress

Issues

Reviewers

Reviewing

Uh oh!

bridgekeeper bot commented Mar 6, 2025

Uh oh!

openjdk bot commented Mar 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

openjdk bot commented Mar 6, 2025

Uh oh!

mlbridge bot commented Mar 6, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Webrevs

Uh oh!

Michael-Mc-Mahon commented Mar 6, 2025

Uh oh!

openjdk bot commented Mar 6, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Michael-Mc-Mahon commented May 29, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dfuch May 29, 2025

Choose a reason for hiding this comment

Uh oh!

Michael-Mc-Mahon commented May 30, 2025

Uh oh!

Michael-Mc-Mahon commented May 30, 2025

Uh oh!

AlanBateman May 30, 2025

Choose a reason for hiding this comment

Uh oh!

seanjmullan May 30, 2025

Choose a reason for hiding this comment

Uh oh!

Michael-Mc-Mahon May 30, 2025

Choose a reason for hiding this comment

Uh oh!

seanjmullan May 30, 2025

Choose a reason for hiding this comment

Uh oh!

dfuch left a comment

Choose a reason for hiding this comment

Uh oh!

Michael-Mc-Mahon commented Jun 3, 2025

Uh oh!

openjdk bot commented Jun 3, 2025

Uh oh!

openjdk bot commented Jun 3, 2025

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

6 participants

Michael-Mc-Mahon commented Mar 6, 2025 •

edited by openjdk bot

Loading

openjdk bot commented Mar 6, 2025 •

edited

Loading

mlbridge bot commented Mar 6, 2025 •

edited

Loading