8327818: Implement Kerberos debug with sun.security.util.Debug #18199

wangweij · 2024-03-11T15:31:03Z

Change Krb5LoginModule debugging to use sun.security.util.Debug.

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

Issues

JDK-8327818: Implement Kerberos debug with sun.security.util.Debug (Enhancement - P4)
JDK-8327830: Implement Kerberos debug with sun.security.util.Debug (CSR)

Reviewers

Sean Coffey (@coffeys - Reviewer)
Sibabrata Sahoo (@sisahoo - Committer)

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 18199

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

Using diff file

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

Webrev

Link to Webrev Comment

bridgekeeper · 2024-03-11T16:36:25Z

👋 Welcome back weijun! 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 · 2024-03-11T16:39:02Z

@wangweij 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 · 2024-03-11T16:42:31Z

Webrevs

openjdk · 2024-03-13T20:11:01Z

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

8327818: Implement Kerberos debug with sun.security.util.Debug

Reviewed-by: coffeys, ssahoo

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

c342188: 8328074: Add jcheck whitespace checking for assembly files
3c70f26: 8328112: Remove CardTable::_guard_region
48717d6: 8326333: jshell completion on arrays is incomplete
ece4124: 8328247: Remove redundant dir for tests converted from applet to main
d32ce65: 8327651: Rename DictionaryEntry members related to protection domain
0719419: 8328236: module_entry in CDS map file has stale value
0204aac: 8328115: Convert java/awt/font/TextLayout/TestJustification.html applet test to main
9bc1b06: 8328242: Add a log area to the PassFailJFrame
65a84c2: 8328006: refactor large anonymous inner class in HtmlDocletWriter
044f4ed: 8326979: (jdeps) improve the error message for FindException caused by InvalidModuleDescriptorException
... and 126 more: https://git.openjdk.org/jdk/compare/a6dc4bc2b83c7240e573ac43f9b7a10191c58ed3...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.

wangweij · 2024-03-14T13:36:04Z

A new commit is pushed to cover all other debug outpus in JGSS/krb5. Most of the changes are simply one of:

if (DEBUG)/ to if (DEBUG != null)
System.out.println to DEBUG.println.
e.printStackTrace(System.out) to e.printStackTrace(DEBUG.getPrintStream())

There is no more DEBUG = Krb5.DEBUG assignments. Always use import static Krb5.DEBUG.

src/jdk.security.auth/share/classes/com/sun/security/auth/module/Krb5LoginModule.java

src/java.security.jgss/share/classes/sun/security/krb5/internal/crypto/crc32.java

src/java.security.jgss/share/classes/sun/security/krb5/internal/KerberosTime.java

src/java.security.jgss/share/classes/sun/security/jgss/spnego/SpNegoToken.java

src/jdk.security.auth/share/classes/com/sun/security/auth/module/Krb5LoginModule.java

coffeys

Looks good. Few minor comments made.

the new Debug.of method will need to implement some logic from the decorator debug PR at #18084 -- depending on integration order, we can tackle that as needed.

coffeys · 2024-03-15T13:04:00Z

src/java.base/share/classes/sun/security/util/Debug.java

+     * Usually, this method is used by other individual era-specific debug
+     * settings. For example,
+     * {@snippet lang=java:
+     * Map<String,String> settings = loadLoginSettings();


minor nit - needs a space : Map<String, String>

Will add one.

coffeys · 2024-03-15T13:04:49Z

src/java.base/share/classes/sun/security/util/Debug.java

+     * {@snippet lang=java:
+     * Map<String,String> settings = loadLoginSettings();
+     * String property = settings.get("login");
+     * Debug debug = Debug.of("login", setting);


did you mean to use the property variable name here ?

coffeys · 2024-03-15T13:07:01Z

src/java.base/share/classes/sun/security/util/Debug.java

+     * @param property debug setting for this option
+     * @return a new Debug object if the property is true
+     */
+    public static Debug of(String option, String property) {


the property name is a bit confusing here IMO. Most use cases will be string corresponding to a boolean (or null) - Would a boolean paramater make more sense ? Otherwise. I'd suggest renaming variable to something like debugEnabled

I was thinking that it will contain more options like true+timestamp later. By that time, we only need to update the Debug class to add this feature.

I see. Seems reasonable then.

I can see how folding these krb5 debug options in under the java.security.debug property will make debugging easier for everyone. Hopefully, something that can be done in the near future in a follow on patch.

sisahoo · 2024-03-18T06:59:57Z

test/jdk/sun/security/krb5/auto/LoginModuleDebug.java

+ */
+import com.sun.security.auth.module.Krb5LoginModule;
+import jdk.test.lib.process.ProcessTools;
+


Additional line can be removed.

IntelliJ IDEA suggested the format. The other imports (non Java SE) and normal imports (Java SE) are separated.

wangweij · 2024-03-18T15:36:09Z

/integrate

openjdk · 2024-03-18T15:36:30Z

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

dec68d7: 8328234: Remove unused nativeUtils files
7734466: 8325871: Move StringTable and SymbolTable rehashing calls
9e98118: 8328177: Move LDFLAGS_JDK[LIB/EXE] to JdkNativeCompilation.gmk
f3af918: 8327945: Inline HasScavengableOops
fb390d2: 8327839: Crash with unboxing and widening primitive conversion in switch
86f1744: 8328248: Convert javax/swing/JSlider/6587742/bug6587742.java applet test to main
7baec66: 8328168: Epsilon: Premature OOM when allocating object larger than uncommitted heap size
c342188: 8328074: Add jcheck whitespace checking for assembly files
3c70f26: 8328112: Remove CardTable::_guard_region
48717d6: 8326333: jshell completion on arrays is incomplete
... and 133 more: https://git.openjdk.org/jdk/compare/a6dc4bc2b83c7240e573ac43f9b7a10191c58ed3...master

Your commit was automatically rebased without conflicts.

openjdk · 2024-03-18T15:36:36Z

@wangweij Pushed as commit 569b05a.

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

the fix

fef55d2

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

openjdk bot added the security security-dev@openjdk.org label Mar 11, 2024

no longer configurable with java.security.debug

46dcb68

all other JGSS debugging

25cf73c

wangweij added 2 commits March 14, 2024 09:39

just use true

b63deeb

native debug in stderr

c877d7b

mcpowers reviewed Mar 14, 2024

View reviewed changes

wangweij added 2 commits March 14, 2024 16:08

a native test

a89d358

Mark's comments

3491a4c

coffeys reviewed Mar 15, 2024

View reviewed changes

wangweij added 2 commits March 15, 2024 09:36

Seán's comments

94d0b4e

typo

01bb32c

coffeys approved these changes Mar 15, 2024

View reviewed changes

openjdk bot added ready Pull request is ready to be integrated and removed csr Pull request needs approved CSR before integration labels Mar 16, 2024

sisahoo approved these changes Mar 18, 2024

View reviewed changes

openjdk bot added the integrated Pull request has been integrated label Mar 18, 2024

openjdk bot closed this Mar 18, 2024

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

wangweij deleted the 8327818 branch March 18, 2024 15:39

8327818: Implement Kerberos debug with sun.security.util.Debug #18199

8327818: Implement Kerberos debug with sun.security.util.Debug #18199

Uh oh!

Conversation

wangweij commented Mar 11, 2024 • edited by openjdk bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Progress

Issues

Reviewers

Reviewing

Webrev

Uh oh!

bridgekeeper bot commented Mar 11, 2024

Uh oh!

openjdk bot commented Mar 11, 2024

Uh oh!

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

Uh oh!

Webrevs

Uh oh!

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

Uh oh!

Uh oh!

wangweij commented Mar 14, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

coffeys 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!

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!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

wangweij commented Mar 18, 2024

Uh oh!

openjdk bot commented Mar 18, 2024

Uh oh!

openjdk bot commented Mar 18, 2024

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

4 participants

wangweij commented Mar 11, 2024 •

edited by openjdk bot

Loading

mlbridge bot commented Mar 11, 2024 •

edited

Loading

openjdk bot commented Mar 13, 2024 •

edited

Loading

wangweij commented Mar 14, 2024 •

edited

Loading