8372731: Detailed authentication failure messages

[djelinski]

Currently the HttpUrlConnection throws a generic "Authentication failure" exception when authentication fails locally.

The authentication may fail for various reasons like: incorrect server challenge message, unavailable encryption/digest algorithms, encoding errors etc. The detailed failure information should be available to the user. Without it, the exception is next to impossible to diagnose, see JDK-8347778 for example.

This PR adds the original exception as the cause of the "Authentication failure" exception.

The detailed exception messages are enabled by the "hostInfo" and "hostInfoExclSocket" categories of "jdk.includeInExceptions". Note that "hostInfoExclSocket" is enabled by default.

Added a new test to verify that the exception details are present when jdk.includeInExceptions includes hostInfoExclSocket (default), and absent otherwise. Existing tier1-3 tests continue to pass.

---

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-8372731: Detailed authentication failure messages (Enhancement - P4)

Reviewers

• Daniel Fuchs (@dfuch - Reviewer)
• Michael McMahon (@Michael-Mc-Mahon - Reviewer)

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 28601

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

Using diff file

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

Using Webrev

Link to Webrev Comment

[bridgekeeper]

👋 Welcome back djelinski! 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]

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

8372731: Detailed authentication failure messages

Reviewed-by: dfuchs, michaelm

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

• a99f340: 8371721: Refactor checkTrusted methods in X509TrustManagerImpl
• d854a04: 8373411: Crash when PrintSharedArchiveAndExit is enabled but shared heap is disabled
• 4100143: 8373225: GenShen: More adaptive old-generation growth heuristics
• ... and 192 more: https://git.openjdk.org/jdk/compare/002fff39aace870b27a9068de1662fcb0b3033a6...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]

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

• net

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]

Webrevs

• 01: Full - Incremental (b22e8108)
• 00: Full (9fe45ac8)

[dfuch]

Since more than NTLM authentication has been improved, should we test the other authentications too?

[djelinski]

Thanks @dfuch for the review.

NTLM was the only authentication scheme where testing this was reasonably easy:

• Basic doesn't throw exceptions,
• Digest always suppresses the exceptions and relays the 401/407 response to the user,
• I couldn't find any Kerberos / Negotiate tests I could adapt.

I'll add the suggested assertion.

[dfuch]

@wangweij would you mind having a look? I know you have some expertise in this area too.

[wangweij]

Any reason why getHeaderValue is not updated the same way? There are several places where the return value is set into a request. I have no memory of the details but it makes me feel uneasy.

[djelinski]

Thanks @wangweij for the review. I didn't want to modify any of the existing URLConnection behaviors, and authentication schemes that use getHeaderValue do not throw when the function fails. The schemes that use setHeaders were already throwing exceptions to user code sometimes, and I augmented these exceptions with additional information.

[dfuch]

The changes are limited to private APIs so look reasonable enough to me. I have run some tests and everything seems stable enough. If @Michael-Mc-Mahon is OK with this I see no objection.

[Michael-Mc-Mahon]

I was wondering if we should let the exception propagate in these cases as well. Though I think these methods get called primarily through pre-emptive authentication, which is less likely to fail (with an exception). So, maybe they are okay...

[Michael-Mc-Mahon]

Looks fine.

[djelinski]

Thanks @Michael-Mc-Mahon for the review and @dfuch for the re-review.

/integrate

[openjdk]

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

• 5141e1a: 8373497: SpinCriticalSection should use SpinYield
• 01adf28: 8372974: Add missing @OverRide annotations in "com.sun.java.swing.plaf.gtk" package
• dc1b0b5: 8373557: Remove stale comments after JDK-8372584
• ... and 214 more: https://git.openjdk.org/jdk/compare/002fff39aace870b27a9068de1662fcb0b3033a6...master

Your commit was automatically rebased without conflicts.

[openjdk]

@djelinski Pushed as commit 895232f.

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