Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

8272163: Add -version option to keytool and jarsigner #5954

Closed
wants to merge 5 commits into from

Conversation

haimaychao
Copy link
Contributor

@haimaychao haimaychao commented Oct 14, 2021

It'd be useful to have a -version option for keytool and jarsigner. Many other JDK tools already have a -version option. This is to add -version option to keytool and jarsigner like jar command does.

CSR review:
https://bugs.openjdk.java.net/browse/JDK-8275174


Progress

  • Change must not contain extraneous whitespace
  • Commit message must refer to an issue
  • Change must be properly reviewed

Issue

  • JDK-8272163: Add -version option to keytool and jarsigner

Reviewers

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 5954

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

Using diff file

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

@bridgekeeper
Copy link

bridgekeeper bot commented Oct 14, 2021

👋 Welcome back hchao! 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 openjdk bot added the rfr Pull request is ready for review label Oct 14, 2021
@openjdk
Copy link

openjdk bot commented Oct 14, 2021

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

  • compiler
  • core-libs
  • 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.

@openjdk openjdk bot added security security-dev@openjdk.org core-libs core-libs-dev@openjdk.org compiler compiler-dev@openjdk.org labels Oct 14, 2021
@mlbridge
Copy link

mlbridge bot commented Oct 14, 2021

Webrevs

@AlanBateman
Copy link
Contributor

AlanBateman commented Oct 14, 2021

/remove label compiler

@AlanBateman
Copy link
Contributor

AlanBateman commented Oct 14, 2021

/remove label core-libs

@openjdk
Copy link

openjdk bot commented Oct 14, 2021

@AlanBateman Unknown command remove - for a list of valid commands use /help.

@openjdk
Copy link

openjdk bot commented Oct 14, 2021

@AlanBateman Unknown command remove - for a list of valid commands use /help.

@AlanBateman
Copy link
Contributor

AlanBateman commented Oct 14, 2021

/label remove core-libs

@openjdk openjdk bot removed the core-libs core-libs-dev@openjdk.org label Oct 14, 2021
@openjdk
Copy link

openjdk bot commented Oct 14, 2021

@AlanBateman
The core-libs label was successfully removed.

@haimaychao
Copy link
Contributor Author

haimaychao commented Oct 14, 2021

/label remove compiler

@openjdk openjdk bot removed the compiler compiler-dev@openjdk.org label Oct 14, 2021
@openjdk
Copy link

openjdk bot commented Oct 14, 2021

@haimaychao
The compiler label was successfully removed.

@seanjmullan
Copy link
Member

seanjmullan commented Oct 15, 2021

/csr

@seanjmullan
Copy link
Member

seanjmullan commented Oct 15, 2021

This will also need a CSR so I added the csr label.

@openjdk openjdk bot added the csr Pull request needs approved CSR before integration label Oct 15, 2021
@openjdk
Copy link

openjdk bot commented Oct 15, 2021

@seanjmullan this pull request will not be integrated until the CSR request JDK-8275174 for issue JDK-8272163 has been approved.

usageTooManyArg();
}
doPrintVersion();
}
Copy link
Contributor

@wangweij wangweij Oct 15, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What happens if -version appears elsewhere?

I tried some other commands. When both -version and other arguments are provided, java ignores the others and prints out version info. javac prints out the version info and compiles as well.

It's possible that user writes a script or alias that always run the tool with some options (Ex: -keystore, -storepass, -verbose). Maybe we should not fail if -version is used with other options (no matter at the beginning or the end).

Copy link
Contributor Author

@haimaychao haimaychao Oct 19, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed so -version can be used with other options in jarsigner.

@@ -591,17 +597,30 @@ static void usageNoArg() {
usage();
}

static void usageTooManyArg() {
Copy link
Contributor

@wangweij wangweij Oct 15, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since the method is only for -version and the printed message also mentions "version", maybe it's better to choose a specific name.

Copy link
Contributor Author

@haimaychao haimaychao Oct 19, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed this method after the change for the comment as above.

@@ -591,17 +597,30 @@ static void usageNoArg() {
usage();
}

static void usageTooManyArg() {
System.out.println(rb.getString(
"Option.should.not.be.specified.for.version"));
Copy link
Contributor

@wangweij wangweij Oct 15, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Neither arguments not options should be specified here.

Copy link
Contributor Author

@haimaychao haimaychao Oct 19, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Method was removed.

.shouldContain("jarsigner")
.shouldHaveExitValue(0);

SecurityTools.jarsigner("-version -extraopt")
Copy link
Contributor

@wangweij wangweij Oct 15, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You might want to use some legal arguments here, for example, -version -help. Otherwise, the error might be because the extra option is not supported. Or, you can check if an expected error message is printed out.

Copy link
Contributor Author

@haimaychao haimaychao Oct 19, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated the test as suggested.

.shouldContain("keytool")
.shouldHaveExitValue(0);

SecurityTools.keytool("-version -extraopt")
Copy link
Contributor

@wangweij wangweij Oct 15, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same comment as above.

Copy link
Contributor Author

@haimaychao haimaychao Oct 19, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

@wangweij
Copy link
Contributor

wangweij commented Oct 15, 2021

For the CSR, is it necessary to list the -help output change?

@haimaychao
Copy link
Contributor Author

haimaychao commented Oct 19, 2021

@wangweij Thanks for your review! Regarding your CSR comment if it is necessary to list the -help output change, as the current keytool manage lists its commands [1], and then I’ve added an entry for -version at the end of the list in the CSR. The jarsigner manpage lists the options [2], and I also added an entry for -version to its list. Are you suggesting we should add a new output for -help in keytool and jarsigner manpages?
[1] https://docs.oracle.com/en/java/javase/17/docs/specs/man/keytool.html#synopsis
[2] https://docs.oracle.com/en/java/javase/17/docs/specs/man/jarsigner.html#synopsis

@@ -308,6 +309,10 @@ public void run(String args[]) {
Event.clearReportListener(Event.ReporterCategory.CRLCHECK);
}

if (version) {
doPrintVersion();
}
Copy link
Contributor

@wangweij wangweij Oct 19, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So if both -version and file.jar are provided, jarsigner will both sign the jar and print the version. This is probably OK but I prefer the java style that only prints the version.

Copy link
Contributor Author

@haimaychao haimaychao Oct 19, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, change made to have jarsigner to only print the version and ignore other options.

@wangweij
Copy link
Contributor

wangweij commented Oct 19, 2021

Approved the PR. Thanks. I have a small comment on the CSR.

@haimaychao
Copy link
Contributor Author

haimaychao commented Oct 19, 2021

@wangweij Thanks for reviewing the CSR and code changes.

@haimaychao
Copy link
Contributor Author

haimaychao commented Oct 19, 2021

@wangweij Updated the CSR with your comment. Thanks!

@openjdk openjdk bot removed the csr Pull request needs approved CSR before integration label Oct 22, 2021
@openjdk
Copy link

openjdk bot commented Oct 22, 2021

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

8272163: Add -version option to keytool and jarsigner

Reviewed-by: weijun

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

  • 88bbf3c: 8273111: Default timezone should return zone ID if /etc/localtime is valid but not canonicalization on linux
  • 4dec8fc: 8275645: [JVMCI] avoid unaligned volatile reads on AArch64
  • 4e647aa: 8275416: G1: remove unnecessary make_referent_alive in precleaning phase
  • dd622e5: 8275783: G1: fix incorrect region type documentation in HeapRegionType
  • b2128a9: 8263155: Allow additional contents for DMG
  • 1efe946: 8275712: Hashtable literal_size functions are broken
  • fab3d6c: 8275761: Backout: JDK-8274794 Print all owned locks in hs_err file
  • c978ca8: 8275344: -Xcheck:jni produces some warnings in the LCMS.c
  • 6a466fe: 8202056: Expand serial warning to check for bad overloads of serial-related methods and ineffectual fields
  • 4e9dd4b: 8275384: Change nested classes in jdk.jconsole to static nested classes
  • ... and 136 more: https://git.openjdk.java.net/jdk/compare/124f82377ba93359bc59118ee315ba194080fa92...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 openjdk bot added the ready Pull request is ready to be integrated label Oct 22, 2021
@haimaychao
Copy link
Contributor Author

haimaychao commented Oct 22, 2021

/integrate

@openjdk
Copy link

openjdk bot commented Oct 22, 2021

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

  • 6523c55: 8198336: java/awt/FontMetrics/FontCrash.java fails in headless mode
  • 88bbf3c: 8273111: Default timezone should return zone ID if /etc/localtime is valid but not canonicalization on linux
  • 4dec8fc: 8275645: [JVMCI] avoid unaligned volatile reads on AArch64
  • 4e647aa: 8275416: G1: remove unnecessary make_referent_alive in precleaning phase
  • dd622e5: 8275783: G1: fix incorrect region type documentation in HeapRegionType
  • b2128a9: 8263155: Allow additional contents for DMG
  • 1efe946: 8275712: Hashtable literal_size functions are broken
  • fab3d6c: 8275761: Backout: JDK-8274794 Print all owned locks in hs_err file
  • c978ca8: 8275344: -Xcheck:jni produces some warnings in the LCMS.c
  • 6a466fe: 8202056: Expand serial warning to check for bad overloads of serial-related methods and ineffectual fields
  • ... and 137 more: https://git.openjdk.java.net/jdk/compare/124f82377ba93359bc59118ee315ba194080fa92...master

Your commit was automatically rebased without conflicts.

@openjdk openjdk bot closed this Oct 22, 2021
@openjdk openjdk bot added integrated Pull request has been integrated and removed ready Pull request is ready to be integrated rfr Pull request is ready for review labels Oct 22, 2021
@openjdk
Copy link

openjdk bot commented Oct 22, 2021

@haimaychao Pushed as commit fec470f.

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
integrated Pull request has been integrated security security-dev@openjdk.org
4 participants