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.

Sign up for GitHub

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

8328914: Document the java.security.debug property in javadoc #23569

Open
wants to merge 10 commits into
base: master
Choose a base branch
from
+203 −0
Open

8328914: Document the java.security.debug property in javadoc #23569

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
5df281e
8328914: Document the java.security.debug property in javadoc
koushikthirupattur Feb 11, 2025
0ccb6fb
8328914: Document the java.security.debug property in javadoc
koushikthirupattur Feb 12, 2025
5790173
8328914: Document the java.security.debug property in javadoc
koushikthirupattur Feb 13, 2025
1067f1a
8328914: Document the java.security.debug property in javadoc
koushikthirupattur Feb 14, 2025
07f84df
8328914: Document the java.security.debug property in javadoc
koushikthirupattur Feb 19, 2025
7f1f76c
8328914: Document the java.security.debug property in javadoc
koushikthirupattur Feb 19, 2025
ad4454e
8328914: Document the java.security.debug property in javadoc
koushikthirupattur Feb 21, 2025
e950afb
8328914: Document the java.security.debug property in javadoc
koushikthirupattur Feb 21, 2025
dbedca4
8328914: Document the java.security.debug property in javadoc
koushikthirupattur Feb 21, 2025
4695453
8328914: Document the java.security.debug property in javadoc
koushikthirupattur Feb 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
197 changes: 197 additions & 0 deletions src/java.base/share/classes/java/security/doc-files/security-related-system-properties.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,197 @@
<!doctype html>
<!--
Copyright (c) 2025, Oracle and/or its affiliates. All rights reserved.
DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.

This code is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License version 2 only, as
published by the Free Software Foundation. Oracle designates this
particular file as subject to the "Classpath" exception as provided
by Oracle in the LICENSE file that accompanied this code.

This code is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
version 2 for more details (a copy is included in the LICENSE file that
accompanied this code).

You should have received a copy of the GNU General Public License version
2 along with this work; if not, write to the Free Software Foundation,
Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.

Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
or visit www.oracle.com if you need additional information or have any
questions.
-->
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Security-Related System Properties</title>
<style>
#debug {
border: 1px solid black;
border-collapse: collapse;
margin: 0 auto;
}
#debug caption {
font-weight: bold;
font-size: smaller;
}
#debug, #debug th, #debug td {
border: 1px solid black;
padding: 2px .5em;
}
#debug tbody th {
font-weight: normal;
text-align:left;
}
</style>
</head>
<body LANG="en-US" DIR="LTR">
<H1 style="text-align:center">Security-Related System Properties</H1>
<p>
There are several system properties used to
alter the mechanisms and behavior of the various classes of the
<code>java.security</code> package. Some are checked only once at startup of the VM,
and therefore are best set using the <code>-D</code> option of the java command,
while others have a more dynamic nature and can also be changed using
the <a href="../../lang/System.html#setProperty(java.lang.String,java.lang.String)">System.setProperty()</a> API.
</P>
<a id="security.debug"></a>
<H2>Debug</H2>
<p><B>{@systemProperty java.security.debug}</B><BR></p>
<p> To monitor security access, you can set the <code>java.security.debug</code> system property,
which determines what trace messages are printed during execution. The value of the property is one or more options separated by a comma.
Some options also have additional sub-options; see the list below for more details on the syntax of each.
The following table lists <code>java.security.debug</code> options table:</p>

<table id="debug">
<caption><b>Security Debug Options</b></caption>
<thead>
<tr>
<th scope="col">Option</th>
<th scope="col">Description</th>
</tr>
</thead>
<tbody>
<tr>
<th scope="row"><code>all</code></th>
<td><code>Turn on all the debugging options</code></td>
</tr>
<tr>
<th scope="row"><code>certpath</code></th>
<td>Turns on debugging for the PKIX CertPathValidator and CertPathBuilder implementations. Use the ocsp option with the certpath option for OCSP protocol tracing. A hexadecimal dump of the OCSP request and response bytes is displayed.
You can use the following options with the certpath option:
<ul>
<li><code><b>ocsp:</b> Dump OCSP protocol exchanges</code></li>
<li><code><b>verbose:</b> Print additional debugging information</code></li>
</ul>
</td>
</tr>
<tr>
<th scope="row"><code>configfile</code></th>
<td><code>JAAS (Java Authentication and Authorization Service) configuration file loading</code></td>
</tr>
<tr>
<th scope="row"><code>configparser</code></th>
<td><code>JAAS configuration file parsing</code></td>
</tr>
<tr>
<th scope="row"><code>gssloginconfig</code></th>
<td><code>Java GSS (Generic Security Services) login configuration file debugging</code></td>
</tr>
<tr>
<th scope="row"><code>jar</code></th>
<td><code>JAR file verification</code></td>
</tr>
<tr>
<th scope="row"><code>jca</code></th>
<td><code>JCA engine class debugging</code></td>
</tr>
<tr>
<th scope="row"><code>keystore</code></th>
<td><code>Keystore debugging</code></td>
</tr>
<tr>
<th scope="row"><code>logincontext</code></th>
<td><code>LoginContext results</code></td>
</tr>
<tr>
<th scope="row"><code>pcsc</code></th>
<td><code>Java Smart Card I/O and SunPCSC provider debugging</code></td>
</tr>
<tr>
<th scope="row"><code>pkcs11</code></th>
<td><code>PKCS11 session manager debugging</code></td>
</tr>
<tr>
<th scope="row"><code>pkcs11keystore</code></th>
<td><code>PKCS11 KeyStore debugging</code></td>
</tr>
<tr>
<th scope="row"><code>pkcs12</code></th>
<td><code>PKCS12 KeyStore debugging</code></td>
</tr>
<tr>
<th scope="row"><code>properties</code></th>
<td><code>java.security configuration file debugging</code></td>
</tr>
<tr>
<th scope="row"><code>provider</code></th>
<td>Security provider debugging The following options can be used with the provider option:
engine=(engines) : The output is displayed only for a specified list of JCA engines.
The supported values for (engines) are:
<ul>
<li><code>Cipher</code></li>
<li><code>KeyAgreement</code></li>
<li><code>KeyGenerator</code></li>
<li><code>KeyPairGenerator</code></li>
<li><code>KeyStore</code></li>
<li><code>Mac</code></li>
<li><code>MessageDigest</code></li>
<li><code>SecureRandom</code></li>
<li><code>Signature</code></li>
</ul>
</td>
</tr>
<tr>
<th scope="row"><code>scl</code></th>
<td><code>Permissions that SecureClassLoader assigns</code></td>
</tr>
<tr>
<th scope="row"><code>securerandom</code></th>
<td><code>SecureRandom debugging</code></td>
</tr>
<tr>
<th scope="row"><code>sunpkcs11</code></th>
<td><code>SunPKCS11 provider debugging</code></td>
</tr>
<tr>
<th scope="row"><code>ts</code></th>
<td><code>Timestamping debugging</code></td>
</tr>
<tr>
<th scope="row"><code>x509</code></th>
<td><code>X.509 certificate debugging. You can use the following option with X.509</code>
<ul>
<li><code><b>ava:</b> Embed non-printable/non-escaped characters in AVA components as hex strings</code></li>
</ul>
</td>
</tr>
</tbody>
</table>
<H2>Printing Thread and Timestamp Information</H2>
<p>
You can append the following strings to the value specified in the <code>java.security.debug</code>
system property to print additional information:
<ul>
<li><code>+thread:</code>Print thread and caller information</li>
<li><code>+timestamp:</code>Print timestamp information</li>
</ul>
<p>
For example, to add thread, caller, and timestamp information to all debuging output,
set the <code>java.security.debug</code> system property on the command line as follows:<br>
<code>java -Djava.security.debug=all+thread+timestamp MyApp</code>
</p>
</body>
</html>
6 changes: 6 additions & 0 deletions src/java.base/share/classes/java/security/package-info.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,12 @@
*
* </ul>
*
* <h2>Additional Specification</h2>
* <ul>
* <li><a href="doc-files/security-related-system-properties.html">
* Security-Related System Properties</a></li>
* </ul>
*
* @spec security/standard-names.html Java Security Standard Algorithm Names
* @since 1.1
*/
Expand Down