ssl-guide.html 9.96 KB
Newer Older
Matt Tucker's avatar
Matt Tucker committed
1
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2

Matt Tucker's avatar
Matt Tucker committed
3 4
<html>
<head>
5 6
<title>Jive Software - Wildfire: SSL Guide</title>
<link type="text/css" rel="stylesheet" href="style.css">
Matt Tucker's avatar
Matt Tucker committed
7 8
</head>
<body>
9 10 11

<div id="pageContainer">

Matt Tucker's avatar
Matt Tucker committed
12
<a name="top"></a>
13 14 15 16 17 18 19 20 21 22 23

	<div id="pageHeader">
		<div id="logo"></div>
		<h1>SSL Guide</h1>
	</div>
	<div class="navigation">
		<a href="index.html">&laquo; Back to documentation index</a>
	</div>
	
	<div id="pageBody">
		
Matt Tucker's avatar
Matt Tucker committed
24 25
<h2>Introduction</h2>
<p>
26
This document outlines how to customize the SSL support in Wildfire.
27

28
<font color="red"><b>Important note:</b></font>
29 30 31
because Wildfire ships with self-signed certificates, it will work out of the box without
installing your own certificate. However, most users will wish to user their own
certificates.</p>
32

33
<p>Wildfire's SSL support is built using the standard Java security
34 35
SSL implementation (javax.net.ssl.SSLServerSocket). In this document, we will
describe how use the standard JDK 1.5 tools to accomplish these tasks.
Matt Tucker's avatar
Matt Tucker committed
36 37 38 39 40 41 42
</p>
<h2>Background</h2>
<p>
A server SSL connection uses two sets of certificates to secure the
connection. The first set is called a "keystore". The keystore contains
the keys and certificates for the server. These security credentials
are used to prove to clients that the server is legitimately operating
43 44
on behalf of a particular domain. If your server will only need to act
as one domain, you only need one key entry and certificate in the keystore.
Matt Tucker's avatar
Matt Tucker committed
45
Keys are stored in the keystore under aliases. Each alias corresponds
Matt Tucker's avatar
Matt Tucker committed
46
to a domain name (e.g. "example.com").
Matt Tucker's avatar
Matt Tucker committed
47 48 49
</p>
<p>
The second set of certificates is called the "truststore" and is used
50 51 52 53
to verify that a client is legitimately operating on behalf of a
particular user. In the vast majority of cases, the truststore is
empty and the server will not attempt to validate client connections
using SSL. Instead, the XMPP authentication process verifies users
Matt Tucker's avatar
Matt Tucker committed
54
in-band. However, you may wish to require SSL authentication for
55 56
certain clients when security is especially important and the number
of clients connection to the server is relatively small.
Matt Tucker's avatar
Matt Tucker committed
57 58 59
</p>
<p>
Certificates attempt to guarantee that a particular party is who they
60 61 62
claim to be. Certificates are trusted based on who signed the certificate.
If you only require light security, are deploying for internal use on
trusted networks, etc. you can use "self-signed" certificates.
Matt Tucker's avatar
Matt Tucker committed
63
Self-signed certificates encrypts the communication channel between
64 65 66
client and server. However the client must verify the legitimacy of the
self-signed certificate through some other channel. The most common client
reaction to a self-signed certificate is to ask the user whether
Matt Tucker's avatar
Matt Tucker committed
67 68 69
to trust the certificate, or to silently trust the certificate is
legitimate. Unfortunately, blindly accepting self-signed certificates
opens up the system to 'man-in-the-middle' attacks.
70

Matt Tucker's avatar
Matt Tucker committed
71 72 73
</p>
<p>
The advantage of a self-signed certificate is you can create them for
74 75 76 77
free which is great when cost is a major concern, or for testing and evaluation.
In addition, you can safely use a self-signed certificate if you can verify
that the certificate you're using is legitimate. So if a system administrator
creates a self-signed certificate, then personally installs it on a client's
Matt Tucker's avatar
Matt Tucker committed
78
truststore (so that the certificate is trusted) you can be assured that
79
the SSL connection will only work between the client and the correct server.
Matt Tucker's avatar
Matt Tucker committed
80 81 82
</p>
<p>
For higher security deployments, you should get your certificate signed
83 84 85 86 87 88
by a certificate authority (CA). Clients truststores will usually contain
the certificates of the major CA's and can verify that a CA has signed a
certificate. This chain of trust allows clients to trust certificate from
servers they've never interacted with before. Certificate signing is similar
to a public notary (with equivalent amounts of verification of identity,
record keeping, and costs).
Matt Tucker's avatar
Matt Tucker committed
89
</p>
Gaston Dombiak's avatar
Gaston Dombiak committed
90
<h2>Sun JDK 1.5 security tools</h2>
Matt Tucker's avatar
Matt Tucker committed
91
<p>
Gaston Dombiak's avatar
Gaston Dombiak committed
92
The Sun JDK (version 1.5.x) ships with all the security tools you need
93
to configure SSL with Wildfire. The most important is the
94 95 96
<tt>keytool</tt> located in the <tt>JAVA_HOME/bin directory</tt> of the
JDK. Sun JVMs persist keystores and truststores on the filesystem as
encrypted files. The <tt>keytool</tt> is used to create, read, update,
97
and delete entries in these files. Wildfire ships with a self-signed
98 99
"dummy" certificate designed for initial evaluation testing. You will need
to adjust the default configuration for most deployments.
100

Matt Tucker's avatar
Matt Tucker committed
101 102 103 104 105 106
</p>
<p>
In order to configure SSL on your server you need complete the
following tasks:
</p>
<ol>
107
  <li>Decide on your Wildfire server's domain.</li>
Matt Tucker's avatar
Matt Tucker committed
108
  <li>Create a self-signed SSL server certificate for your server
109
domain. Note: you may already have one if your Wildfire server
Matt Tucker's avatar
Matt Tucker committed
110 111 112 113 114 115
domain matches an existing web domain with SSL.
If so, you can skip to step 4.</li>
  <li>[Optional] Have a certificate authority (CA) certify the SSL
server certificate.
    <ol style="list-style-type: lower-alpha;">
      <li>Generate a certificate signing request (CSR).</li>
116

Matt Tucker's avatar
Matt Tucker committed
117 118 119 120 121 122 123
      <li>Submit your CSR to a CA for signing.</li>
    </ol>
  </li>
  <li>Import the server certificate into the keystore. Note: if you are
going to use a self-signed certificate
generated in step 2, the certificate is already imported and you can
skip this step.</li>
124
  <li>Remove default certificates from the keystore.</li>
Matt Tucker's avatar
Matt Tucker committed
125
  <li>Import client certificates into the truststore.</li>
126
  <li>Adjust the Wildfire configuration with proper keystore and
Matt Tucker's avatar
Matt Tucker committed
127
truststore settings.</li>
128

Matt Tucker's avatar
Matt Tucker committed
129
</ol>
Matt Tucker's avatar
Matt Tucker committed
130
<h3>1. Decide on a Server Domain</h3>
Matt Tucker's avatar
Matt Tucker committed
131
<p>
132
The Wildfire server domain should match the host name of the server;
Matt Tucker's avatar
Matt Tucker committed
133 134 135
for example, "example.com". Your user accounts will have addresses with
the format "user@example.com" like email addresses. We'll assume
the domain is "example.com" for the rest of the examples.
Matt Tucker's avatar
Matt Tucker committed
136
</p>
Matt Tucker's avatar
Matt Tucker committed
137
<h3>2. Create a self-signed server certificate</h3>
Matt Tucker's avatar
Matt Tucker committed
138 139
<p>
In order to create a self-signed server certificate go to the command
Matt Tucker's avatar
Matt Tucker committed
140
line and change directories to the <tt>resources/security</tt>
141
directory of your Wildfire installation. You should see the default
Matt Tucker's avatar
Matt Tucker committed
142 143 144
<tt>keystore</tt> and <tt>truststore</tt> files. First, you should
change the default keystore
password:
145

Matt Tucker's avatar
Matt Tucker committed
146 147 148 149 150 151 152
</p>
<p><tt>keytool -storepasswd -keystore keystore</tt></p>
<p>
keytool will ask for the old password (by default it is <tt>changeit</tt>)
then the new password.
Now we'll create a certificate using the keytool:
</p>
Matt Tucker's avatar
Matt Tucker committed
153
<p><tt>keytool -genkey -keystore keystore -alias example.com</tt></p>
Matt Tucker's avatar
Matt Tucker committed
154
<p>
Matt Tucker's avatar
Matt Tucker committed
155
where you should substitute your server's name for <tt>example.com</tt>.
156
The keytool will ask for the store password, then several pieces of
157 158 159 160
information required for the certificate. Enter all the information but remember 
to <b>complete with your server's name when asked for your first and last name</b>. 
After you have entered all the required information, keytool will ask you to 
verify the information and set a key password.
161 162
<b>You must use the same key password as the store password.</b> By default
you get this by simply hitting 'enter' when prompted for a key password.</p>
163

164 165 166
<p>If you later change the keystore password remember to change the entries'
password as well using the keytool:</p>

Matt Tucker's avatar
Matt Tucker committed
167
<p><tt>keytool -keypasswd -alias example.com -keystore keystore</tt>
Matt Tucker's avatar
Matt Tucker committed
168
</p>
Matt Tucker's avatar
Matt Tucker committed
169
<h3>3. Obtain a CA signed certificate</h3>
Matt Tucker's avatar
Matt Tucker committed
170 171 172 173 174
<p>
If you decide to get a CA signed certificate, you must first export the
certificate in the
standard CSR format. You can do this with the keytool:
</p>
Matt Tucker's avatar
Matt Tucker committed
175
<p><tt>keytool -certreq -keystore keystore -alias example.com -file
Matt Tucker's avatar
Matt Tucker committed
176 177
certificate_file</tt></p>
<p>
Matt Tucker's avatar
Matt Tucker committed
178
Where you should substitute your server's name for <tt>example.com</tt>
179

Matt Tucker's avatar
Matt Tucker committed
180 181 182 183 184
and the name of the
certificate file you wish to produce for <tt>certificate_file</tt>.
Submit the generated CSR to the CA and follow their instructions to get
it signed.
</p>
Matt Tucker's avatar
Matt Tucker committed
185
<h3>4. Import server certificates</h3>
Matt Tucker's avatar
Matt Tucker committed
186 187 188 189 190
<p>
If you had a CA sign your server certificate, or if you have an
existing SSL certificate,
you must import it using the keytool.
</p>
Matt Tucker's avatar
Matt Tucker committed
191
<p><tt>keytool -import -keystore keystore -alias example.com -file
Matt Tucker's avatar
Matt Tucker committed
192 193 194 195 196
signed_certificate_file</tt></p>
<p>
It is important that the alias not already have an associated key or
you'll receive an error.
</p>
197 198
<h3>5. Remove default certificates</h3>
<p>
199

200 201 202 203 204 205
After importing your certificate you must remove the default certificates
using the keytool.
</p>
<p><tt>keytool -delete -keystore keystore -alias rsa</tt></p>
<p><tt>keytool -delete -keystore keystore -alias dsa</tt></p>
<h3>6. Import client certificates</h3>
Matt Tucker's avatar
Matt Tucker committed
206 207 208 209 210 211 212 213 214 215 216
<p>
If you require clients to verify themselves using certificates, obtain
their certificates and import them into the truststore file rather than
the keystore. First, you should change the default truststore
password:
</p>
<p><tt>keytool -storepasswd -keystore truststore</tt></p>
<p>
keytool will ask for the old password (by default it is <tt>changeit</tt>)
then the new password.
Now import each certificate using the keytool:
217

Matt Tucker's avatar
Matt Tucker committed
218 219 220
</p>
<p><tt>keytool -import -keystore truststore -alias user_name -file
certificate_file</tt></p>
221
<h3>7. Configure Wildfire</h3>
Matt Tucker's avatar
Matt Tucker committed
222
<p>
223
Open the Wildfire Admin Console in your favorite
Gaston Dombiak's avatar
Gaston Dombiak committed
224
browser and add or change the following system properties:
Matt Tucker's avatar
Matt Tucker committed
225 226
</p>
<ul>
227 228
  <li>xmpp.socket.ssl.active -- set to 'true' to active SSL</li>
  <li>xmpp.socket.ssl.port -- the port to use for SSL (default is
Matt Tucker's avatar
Matt Tucker committed
229
5223 for XMPP)</li>
230
  <li>xmpp.socket.ssl.storeType -- the store type used ("JKS" is
231
the Sun Java Keystore format used by the JDK keytool). If this property is 
232
not defined, Wildfire will assume a value of "jks".</li>
233

234
  <li>xmpp.socket.ssl.keystore -- the location of the keystore file
235
relative to your Wildfire installation root directory. You can leave this property
Matt Tucker's avatar
Matt Tucker committed
236
blank to use the default keystore.</li>
237
  <li>xmpp.socket.ssl.keypass -- the keystore/key password you
Matt Tucker's avatar
Matt Tucker committed
238
changed in step 2.</li>
239
  <li>xmpp.socket.ssl.truststore -- leave blank to not use a
Matt Tucker's avatar
Matt Tucker committed
240
truststore, otherwise the location of the truststore file relative to
241
your Wildfire installation root directory.</li>
242
  <li>xmpp.socket.ssl.trustpass -- the truststore/key password you
243
changed in step 6.</li>
Matt Tucker's avatar
Matt Tucker committed
244
</ul>
245
You will need to restart the server after you have modified any of the above system properties.
246 247 248 249 250

	</div>

</div>

Gaston Dombiak's avatar
Gaston Dombiak committed
251
</body>
Matt Tucker's avatar
Matt Tucker committed
252
</html>