commit a14f829d8ac5e946cf8dcfcb09dbc0e68f614757
author Christopher Colemani <chrisc@stepaheadsoftware.com> Wed Apr 17 19:22:08 2024 +1000
committer Rene Cordier <rene.cordier@gmail.com> Fri Apr 19 08:57:17 2024 +0700
tree 55a9caf49283ba1313aea3d49c1c5fd57596d92f
parent 4a70f8a985d2f5e7adf86c8c162b6b9ea48ab681

Update config-ssl-tls.xml: Fixed typo in <keystoreType> element and indicate that keytool, by default, now creates PKCS12 format keystores not JKS

src/site/xdoc/server/config-ssl-tls.xml

diff --git a/src/site/xdoc/server/config-ssl-tls.xml b/src/site/xdoc/server/config-ssl-tls.xml
index 1cbdae8..2c9955e 100644
--- a/src/site/xdoc/server/config-ssl-tls.xml
+++ b/src/site/xdoc/server/config-ssl-tls.xml
@@ -48,7 +48,7 @@
       <source>
 &lt;tls socketTLS="false" startTLS="false"&gt;
   &lt;keystore&gt;file://conf/keystore&lt;/keystore&gt;
-  &lt;keystoreType&gt;PKSC12&lt;/keystoreType&gt;
+  &lt;keystoreType&gt;PKCS12&lt;/keystoreType&gt;
   &lt;secret&gt;yoursecret&lt;/secret&gt;
   &lt;provider&gt;org.bouncycastle.jce.provider.BouncyCastleProvider&lt;/provider&gt;
 &lt;/tls&gt;
@@ -188,10 +188,11 @@
       
       <p><b>Creating your own Certificate Keystore</b></p>
         <p>(Adapted from the Tomcat 4.1 documentation)</p>
-        <p>James currently operates only on JKS and PKCS12 format keystores. This is Java's standard "Java KeyStore" format, and is the format created by the keytool command-line utility. This tool is included in the JDK.</p>
+        <p>James currently operates only on JKS and PKCS12 format keystores. PKCS12 is Java's default "Java KeyStore" format created by the keytool command-line utility (for Java 8+) when no "-storetype" option is provided. This tool is included in the JDK.</p>
         <p>To import an existing certificate into a JKS keystore, please read the documentation (in your JDK documentation package) about keytool.</p>
         <p>To create a new keystore from scratch, containing a single self-signed Certificate, execute the following from a terminal command line:</p>
         <p><code>keytool -genkey -alias james -keyalg RSA -keystore your_keystore_filename</code></p>
+        <p><strong>Note:</strong> This will create a keystore in PKCS12 format. To create a JKS format keystore add the option '-storetype JKS' to the command line.
         <p>(The RSA algorithm should be preferred as a secure algorithm, and this also ensures general compatibility with other servers and components.)</p>
         <p>As a suggested standard, create the keystore in the james/conf directory, with a name like james.keystore.</p>
         <p>After executing this command, you will first be prompted for the keystore password.</p>