Update exception handling in PFX.verifyAuthSafes()

[edewata]

Previously the PFX.verifyAuthSafes() discarded the original exception and simply returned a generic error message which was usually insufficient to determine the cause of the issue.

To help troubleshooting, the PFX.verifyAuthSafes() has been modified to throw the exception so the original error message and the stack trace are preserved.

[fmarco76]

This code is invoked by the CLI so if there is an error the user get the stacktrace. I think the original approach with a reason message was better. Could we just add the exception message to the reason to make clearer what is the problem? Is it possible to add more information when the CLI run in debug mode?

[fmarco76]

Since we are not doing any action with the exception then try/catch could be totally removed.

[edewata]

Updated, the try-catch is removed now.

[sonarqubecloud]

Quality Gate failed

Failed conditions
E Maintainability Rating on New Code (required ≥ A)

See analysis details on SonarCloud

Catch issues before they fail your Quality Gate with our IDE extension SonarLint

[edewata]

@fmarco76 Please see the updated patch. I removed the try-catch statement as you suggested. As for the stack trace, I think it's better to let the application (i.e. CLI or UI) handle the exception. Currently by default the CLI will only show the exception message without the stack trace, for example:

$ pki pkcs12-cert-find --pkcs12 certs.p12 --password wrong
ERROR: Unable to validate PKCS #12 file: Digests do not match

However, for troubleshooting we can run the CLI in verbose mode to see the stack trace:

$ pki pkcs12-cert-find --pkcs12 certs.p12 --password wrong -v
INFO: Initializing NSS
INFO: Using internal token
java.lang.Exception: Unable to validate PKCS #12 file: Digests do not match
	at org.mozilla.jss.netscape.security.pkcs.PKCS12Util.loadFromByteArray(PKCS12Util.java:830)
	at org.mozilla.jss.netscape.security.pkcs.PKCS12Util.loadFromFile(PKCS12Util.java:816)
	at com.netscape.cmstools.pkcs12.PKCS12CertFindCLI.execute(PKCS12CertFindCLI.java:128)
	at org.dogtagpki.cli.CommandCLI.execute(CommandCLI.java:58)
	at org.dogtagpki.cli.CLI.execute(CLI.java:353)
	at org.dogtagpki.cli.CLI.execute(CLI.java:353)
	at org.dogtagpki.cli.CLI.execute(CLI.java:353)
	at com.netscape.cmstools.cli.MainCLI.execute(MainCLI.java:659)
	at com.netscape.cmstools.cli.MainCLI.main(MainCLI.java:698)

The original code removed the exception info completely so it's not possible to see the stack trace at all, and the original error messages were too generic to be useful.

[fmarco76]

LGTM

[edewata]

@fmarco76 Thanks!