8349121: SSLParameters.setApplicationProtocols() ALPN example could be clarified #23379

bradfordwetmore · 2025-01-31T01:45:47Z

Update and clarify the sample code.

Docs only, no additional testing other than verifying javadoc is correctly output.

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-8349121: SSLParameters.setApplicationProtocols() ALPN example could be clarified (Bug - P4)

Reviewers

Daniel Fuchs (@dfuch - Reviewer) Review applies to 61345a63
Artur Barashev (@artur-oracle - Author)
Jamil Nimeh (@jnimeh - Reviewer)

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 23379

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

Using diff file

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

Using Webrev

Link to Webrev Comment

…e clarified

bridgekeeper · 2025-01-31T01:46:18Z

👋 Welcome back wetmore! 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-01-31T01:46:29Z

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

8349121: SSLParameters.setApplicationProtocols() ALPN example could be clarified

Reviewed-by: abarashev, jnimeh, 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 45 new commits pushed to the master branch:

7cd5cb2: 8349532: Refactor ./util/Pem/encoding.sh to run in java
86cec4e: 8343782: G1: Use one G1CardSet instance for multiple old gen regions
006ed5c: 8349375: Cleanup AIX special file build settings
3989a19: 8344925: translet-name ignored when package-name is also set
1eb54e4: 8346049: jdk/test/lib/security/timestamp/TsaServer.java warnings
a0c7f66: 8349508: runtime/cds/appcds/TestParallelGCWithCDS.java should not check for specific output
1079147: 8348570: CTW: Expose the code hidden by uncommon traps
1a74ee6: 8349092: File.getFreeSpace violates specification if quotas are in effect (win)
0181030: 8349006: File.getCanonicalPath should remove "(on UNIX platforms)" from its specification
ed8945a: 8347377: Add validation checks for ICC_Profile header fields
... and 35 more: https://git.openjdk.org/jdk/compare/bad39b6d8892ba9b86bc81bf01108a1df617defb...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-01-31T01:47:01Z

@bradfordwetmore 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 · 2025-01-31T01:50:14Z

Webrevs

dfuch · 2025-02-04T17:18:09Z

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

+     *     // Convert bytes into a ISO_8859_1 encoded string
+     *     String encodedHukUnI =
+     *         new String(bytes, StandardCharsets.ISO_8859_1);
+     *


Maybe a better comment here would be:

* // Preserve bytes by using ISO_8859_1 encoding

because we're not converting anything into anything.

As far as I understand what you are trying to do is to shoe-horn a byte array into a string, so that you can retrieve the original array using String.getBytes(StandardCharsets.ISO_8859_1)?

I had a similar thought over the weekend.

Updated the comment to Preserve network byte order by using ISO_8859_1 encoding.

As far as I understand what you are trying to do...

Yes. The API was String[] (implemented with 7-bit ASCII), but it was pointed out that we didn't have any way to send some of the TLS GREASE (RFC 8701) values or use extended ASCII (8-bit) characters. (International Charsets was a bonus, but likely aren't used for ALPN.) This was a reasonable workaround.

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

dfuch

I had to convince myself (using jshell) that rfc8701Grease8A.getBytes("ISO_8859_1") would return the correct result - but I see that's OK, so this looks good to me. Maybe wait for a review from someone from security-libs before integrating.

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

artur-oracle

LGTM

jnimeh · 2025-02-07T16:10:42Z

The comment changes look good to me also.

bradfordwetmore · 2025-02-07T17:08:50Z

/integrate

openjdk · 2025-02-07T17:09:56Z

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

fb847bb: 8349493: Replace sun.util.locale.ParseStatus usage with java.text.ParsePosition
7cd5cb2: 8349532: Refactor ./util/Pem/encoding.sh to run in java
86cec4e: 8343782: G1: Use one G1CardSet instance for multiple old gen regions
006ed5c: 8349375: Cleanup AIX special file build settings
3989a19: 8344925: translet-name ignored when package-name is also set
1eb54e4: 8346049: jdk/test/lib/security/timestamp/TsaServer.java warnings
a0c7f66: 8349508: runtime/cds/appcds/TestParallelGCWithCDS.java should not check for specific output
1079147: 8348570: CTW: Expose the code hidden by uncommon traps
1a74ee6: 8349092: File.getFreeSpace violates specification if quotas are in effect (win)
0181030: 8349006: File.getCanonicalPath should remove "(on UNIX platforms)" from its specification
... and 36 more: https://git.openjdk.org/jdk/compare/bad39b6d8892ba9b86bc81bf01108a1df617defb...master

Your commit was automatically rebased without conflicts.

openjdk · 2025-02-07T17:10:03Z

@bradfordwetmore Pushed as commit 88a8483.

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

8349121: SSLParameters.setApplicationProtocols() ALPN example could b…

ac7a6cf

…e clarified

openjdk bot added the rfr Pull request is ready for review label Jan 31, 2025

openjdk bot added security [email protected] net [email protected] labels Jan 31, 2025

bradfordwetmore changed the title ~~8349121: SSLParameters.setApplicationProtocols() ALPN example could be clarified.~~ 8349121: SSLParameters.setApplicationProtocols() ALPN example could be clarified Jan 31, 2025

dfuch reviewed Feb 4, 2025

View reviewed changes

bradfordwetmore added 2 commits February 4, 2025 11:18

Merge branch 'master' into JDK-8349121

e5da45c

Codereview Comments

61345a6

dfuch reviewed Feb 5, 2025

View reviewed changes

src/java.base/share/classes/javax/net/ssl/SSLParameters.java Show resolved Hide resolved

dfuch reviewed Feb 5, 2025

View reviewed changes

src/java.base/share/classes/javax/net/ssl/SSLParameters.java Show resolved Hide resolved

dfuch approved these changes Feb 5, 2025

View reviewed changes

openjdk bot added the ready Pull request is ready to be integrated label Feb 5, 2025

artur-oracle reviewed Feb 6, 2025

View reviewed changes

src/java.base/share/classes/javax/net/ssl/SSLParameters.java Show resolved Hide resolved

artur-oracle reviewed Feb 6, 2025

View reviewed changes

src/java.base/share/classes/javax/net/ssl/SSLParameters.java Outdated Show resolved Hide resolved

minor wording tweak

7a90be8

openjdk bot removed the ready Pull request is ready to be integrated label Feb 6, 2025

artur-oracle approved these changes Feb 6, 2025

View reviewed changes

jnimeh approved these changes Feb 7, 2025

View reviewed changes

openjdk bot added the ready Pull request is ready to be integrated label Feb 7, 2025

openjdk bot added the integrated Pull request has been integrated label Feb 7, 2025

openjdk bot closed this Feb 7, 2025

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

8349121: SSLParameters.setApplicationProtocols() ALPN example could be clarified #23379

8349121: SSLParameters.setApplicationProtocols() ALPN example could be clarified #23379

bradfordwetmore commented Jan 31, 2025 •

edited by openjdk bot

Loading

bridgekeeper bot commented Jan 31, 2025

openjdk bot commented Jan 31, 2025 •

edited

Loading

openjdk bot commented Jan 31, 2025

mlbridge bot commented Jan 31, 2025 •

edited

Loading

dfuch Feb 4, 2025

bradfordwetmore Feb 4, 2025

dfuch left a comment

artur-oracle left a comment

jnimeh commented Feb 7, 2025

bradfordwetmore commented Feb 7, 2025

openjdk bot commented Feb 7, 2025

openjdk bot commented Feb 7, 2025

8349121: SSLParameters.setApplicationProtocols() ALPN example could be clarified #23379

8349121: SSLParameters.setApplicationProtocols() ALPN example could be clarified #23379

Conversation

bradfordwetmore commented Jan 31, 2025 • edited by openjdk bot Loading

Progress

Issue

Reviewers

Reviewing

bridgekeeper bot commented Jan 31, 2025

openjdk bot commented Jan 31, 2025 • edited Loading

openjdk bot commented Jan 31, 2025

mlbridge bot commented Jan 31, 2025 • edited Loading

Webrevs

dfuch Feb 4, 2025

Choose a reason for hiding this comment

bradfordwetmore Feb 4, 2025

Choose a reason for hiding this comment

dfuch left a comment

Choose a reason for hiding this comment

artur-oracle left a comment

Choose a reason for hiding this comment

jnimeh commented Feb 7, 2025

bradfordwetmore commented Feb 7, 2025

openjdk bot commented Feb 7, 2025

openjdk bot commented Feb 7, 2025

bradfordwetmore commented Jan 31, 2025 •

edited by openjdk bot

Loading

openjdk bot commented Jan 31, 2025 •

edited

Loading

mlbridge bot commented Jan 31, 2025 •

edited

Loading