From 1f7af073afe01c22b778e82950fb2497afce6eab Mon Sep 17 00:00:00 2001
From: Keith Wall <kwall@apache.org>
Date: Fri, 15 Feb 2013 11:25:19 +0000
Subject: NO-JIRA: Update Java Broker SSL docbook to note that keystorepassword
 must match keypassword

git-svn-id: https://svn.apache.org/repos/asf/qpid/trunk/qpid@1446517 13f79535-47bb-0310-9956-ffa450edef68
---
 doc/book/src/java-broker/Java-Broker-Security-SSL.xml | 14 ++++++++++++++
 doc/book/src/java-broker/commonEntities.xml           |  1 +
 2 files changed, 15 insertions(+)

(limited to 'doc')

diff --git a/doc/book/src/java-broker/Java-Broker-Security-SSL.xml b/doc/book/src/java-broker/Java-Broker-Security-SSL.xml
index 541f6cf5d9..e415065a84 100644
--- a/doc/book/src/java-broker/Java-Broker-Security-SSL.xml
+++ b/doc/book/src/java-broker/Java-Broker-Security-SSL.xml
@@ -1,4 +1,8 @@
 <?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE entities [
+<!ENTITY %  entities SYSTEM  "commonEntities.xml">
+%entities;
+]>
 <!--
 
  Licensed to the Apache Software Foundation (ASF) under one
@@ -61,6 +65,16 @@
             the configured SSL port(s) or will also bind the non-SSL port(s). Setting sslOnly to true will
             disable the non-SSL ports.
         </para>
+
+        <important>
+            <para>
+                The password of the certificate used by the Broker <emphasis role="bold">must</emphasis>
+                match the password of the keystore itself. This is a restriction of the Qpid Broker
+                implementation.  If using the <ulink url="&oracleKeytool;">keytool</ulink> utility,
+                note that this means the argument to the <option>-keypass</option> option must match
+                the <option>-storepass</option> option.
+            </para>
+        </important>
     </section>
 
     <section role="h2" id="SSL-Truststore-ClientCertificate">
diff --git a/doc/book/src/java-broker/commonEntities.xml b/doc/book/src/java-broker/commonEntities.xml
index 4dcbc96b69..a53440a467 100644
--- a/doc/book/src/java-broker/commonEntities.xml
+++ b/doc/book/src/java-broker/commonEntities.xml
@@ -28,6 +28,7 @@
 <!-- Oracle javadoc -->
 <!ENTITY oracleJdkDocUrl "http://oracle.com/javase/6/docs/api/">
 <!ENTITY oracleJeeDocUrl "http://docs.oracle.com/javaee/6/api/">
+<!ENTITY oracleKeytool "http://docs.oracle.com/javase/6/docs/technotes/tools/solaris/keytool.html">
 
 <!-- Oracle BDB JE-->
 <!ENTITY oracleJeDownloadUrl "http://www.oracle.com/technetwork/products/berkeleydb/downloads/index.html?ssSourceSiteId=ocomen">
-- 
cgit v1.2.1