2014-01-13 01:57:31 +00:00
<chapter id= "server-installation" >
<title > Installation and Configuration of Keycloak Server</title>
2015-04-30 10:33:27 +00:00
<section >
<title > Installation</title>
2014-01-13 01:57:31 +00:00
<para >
2016-01-08 12:56:07 +00:00
Keycloak Server has three downloadable distributions. To run the Keycloak server you need to have Java 8 already
installed.
2014-01-13 01:57:31 +00:00
</para>
<para >
2015-04-30 10:33:27 +00:00
<itemizedlist >
<listitem >
<literal > keycloak-&project.version; .[zip|tar.gz]</literal> - Standalone server
</listitem>
<listitem >
<literal > keycloak-overlay-&project.version; .[zip|tar.gz]</literal> - Installer for WildFly or JBoss EAP
</listitem>
<listitem >
<literal > keycloak-demo-&project.version; .[zip|tar.gz]</literal> - Development bundle including WildFly, Keycloak, examples and documentation
</listitem>
</itemizedlist>
2014-01-13 01:57:31 +00:00
</para>
2015-04-30 10:33:27 +00:00
<section id= "server_install" >
<title > Install Standalone Server</title>
<para >
For production and for non-JavaEE developers we recommend using the standalone Keycloak server. All you need to
do is to download <literal > keycloak-&project.version; .zip</literal> or <literal > keycloak-&project.version; .tar.gz</literal> ,
unpackage and start to have a Keycloak server up and running.
</para>
<para >
To install first download either the zip or tar.gz and extract. Then start by running either:
<programlisting > keycloak-&project.version; /bin/standalone.sh</programlisting>
or:
<programlisting > keycloak-&project.version; /bin/standalone.bat</programlisting>
</para>
</section>
<section id= "overlay_install" >
2016-01-13 13:24:31 +00:00
<title > Install on existing WildFly &wildfly.version; or JBoss EAP &eap.version; </title>
2015-04-30 10:33:27 +00:00
<para >
2016-01-13 13:24:31 +00:00
Keycloak can be installed into an existing installations of WildFly &wildfly.version; or JBoss EAP &eap.version; .
To do this download <literal > keycloak-overlay-&project.version; .zip</literal> or <literal > keycloak-overlay-&project.version; .tar.gz</literal> .
Once downloaded extract into the root directory of your installation.
2015-04-30 10:33:27 +00:00
</para>
2015-10-14 22:44:33 +00:00
<para >
2016-01-13 13:24:31 +00:00
To add Keycloak to existing standalone.xml server config run:
2015-11-12 08:17:47 +00:00
<programlisting >
2016-01-13 13:24:31 +00:00
bin/jboss-cli.sh --file=keycloak-install.cli
2015-11-12 08:17:47 +00:00
</programlisting>
2016-01-13 13:24:31 +00:00
To add Keycloak to existing standalone-ha.xml server config run:
2015-11-12 08:17:47 +00:00
<programlisting >
2016-01-13 13:24:31 +00:00
bin/jboss-cli.sh --file=keycloak-install.cli
2015-11-12 08:17:47 +00:00
</programlisting>
2016-01-13 13:24:31 +00:00
If you want to add Keycloak to a different server config edit keycloak-install.cli or keycloak-install-ha.cli
and change the name of the server config.
2015-04-30 10:33:27 +00:00
</para>
</section>
<section >
<title id= "demo_install" > Install Development Bundle</title>
<para >
The demo bundle contains everything you need to get started with Keycloak including documentation and examples.
To install it first download <literal > keycloak-demo-&project.version; .zip</literal> or
<literal > keycloak-demo-&project.version; .tar.gz</literal> . Once downloaded extract it inside
<literal > keycloak-demo-&project.version; </literal> you'll find <literal > keycloak</literal> which contains
2015-11-12 08:17:47 +00:00
a full WildFly &wildfly.version; server with Keycloak Server and Adapters included. You'll also find <literal > docs</literal>
2015-04-30 10:33:27 +00:00
and <literal > examples</literal> which contains everything you need to get started developing applications that use Keycloak.
</para>
<para >
To start WildFly with Keycloak run:
<programlisting > keycloak-&project.version; /bin/standalone.sh</programlisting>
or:
<programlisting > keycloak-&project.version; /bin/standalone.bat</programlisting>
</para>
</section>
2014-01-13 01:57:31 +00:00
</section>
2015-04-30 10:33:27 +00:00
2014-01-13 01:57:31 +00:00
<section >
2014-10-06 11:58:22 +00:00
<title id= "configure-server" > Configuring the Server</title>
2014-01-13 01:57:31 +00:00
<para >
Although the Keycloak Server is designed to run out of the box, there's some things you'll need
to configure before you go into production. Specifically:
<itemizedlist >
<listitem >
2016-01-13 08:02:52 +00:00
Configuring Keycloak to use a production database
2014-01-13 01:57:31 +00:00
</listitem>
<listitem >
Setting up SSL/HTTPS
</listitem>
<listitem >
Enforcing HTTPS connections
</listitem>
</itemizedlist>
</para>
2015-11-23 13:45:25 +00:00
<section >
2016-01-13 08:02:52 +00:00
<title id= "create-admin-user" > Admin User</title>
2015-11-23 13:45:25 +00:00
<para >
2015-12-22 13:44:43 +00:00
To access the admin console to configure Keycloak you need an account to login. There is no built in user,
instead you have to first create an admin account. This can done either by opening <ulink url= "http://localhost:8080/auth" > http://localhost:8080/auth</ulink>
(creating a user through the browser can only be done through localhost) or you can use the add-user script from
the command-line.
2015-11-23 13:45:25 +00:00
</para>
<para >
2015-12-22 13:44:43 +00:00
The <literal > add-user</literal> script creates a temporary file with the details of the user,
which are imported at startup. To add a user with this script run:
2015-11-23 13:45:25 +00:00
<programlisting > < ![CDATA[
bin/add-user.[sh|bat] -r master -u <username > -p <password >
]]></programlisting>
Then restart the server.
</para>
</section>
2014-01-13 01:57:31 +00:00
<section >
2014-08-19 19:10:32 +00:00
<title > Relational Database Configuration</title>
2014-01-13 01:57:31 +00:00
<para >
2015-04-23 13:30:15 +00:00
You might want to use a better relational database for Keycloak like PostgreSQL or MySQL. You might also
want to tweak the configuration settings of the datasource. Please see the <ulink url= "https://docs.jboss.org/author/display/WFLY8/DataSource+configuration" > Wildfly</ulink>
documentation on how to do this.
2014-01-13 01:57:31 +00:00
</para>
<para >
2015-04-23 13:30:15 +00:00
Keycloak runs on a Hibernate/JPA backend which is configured in the
2014-08-07 10:23:46 +00:00
<literal > standalone/configuration/keycloak-server.json</literal> .
By default the setting is like this:
<programlisting > < ![CDATA[
"connectionsJpa": {
"default": {
"dataSource": "java:jboss/datasources/KeycloakDS",
"databaseSchema": "update"
}
},
]]></programlisting>
Possible configuration options are:
<variablelist >
<varlistentry >
<term > dataSource</term>
<listitem >
<para >
JNDI name of the dataSource
</para>
</listitem>
</varlistentry>
<varlistentry >
<term > jta</term>
<listitem >
<para >
boolean property to specify if datasource is JTA capable
</para>
</listitem>
</varlistentry>
<varlistentry >
<term > driverDialect</term>
<listitem >
<para >
Value of Hibernate dialect. In most cases you don't need to specify this property as dialect will be
autodetected by Hibernate.
</para>
</listitem>
</varlistentry>
<varlistentry >
<term > databaseSchema</term>
<listitem >
<para >
2015-05-13 06:09:17 +00:00
Specify if schema should be updated or validated. Valid values are "update" and "validate" ("update is default).
2014-08-07 10:23:46 +00:00
</para>
</listitem>
</varlistentry>
<varlistentry >
<term > showSql</term>
<listitem >
<para >
Specify whether Hibernate should show all SQL commands in the console (false by default)
</para>
</listitem>
</varlistentry>
<varlistentry >
<term > formatSql</term>
<listitem >
<para >
Specify whether Hibernate should format SQL commands (true by default)
</para>
</listitem>
</varlistentry>
2014-09-03 08:13:05 +00:00
<varlistentry >
2015-07-03 12:56:28 +00:00
<term > schema</term>
2014-09-03 08:13:05 +00:00
<listitem >
<para >
2015-07-14 12:33:45 +00:00
Specify the database schema to use
2014-09-03 08:13:05 +00:00
</para>
</listitem>
</varlistentry>
2014-08-07 10:23:46 +00:00
</variablelist>
2014-01-13 01:57:31 +00:00
</para>
2014-02-19 15:16:15 +00:00
<section >
<title > Tested databases</title>
<para >
Here is list of RDBMS databases and corresponding JDBC drivers, which were tested with Keycloak. Note that Hibernate dialect
is usually set automatically according to your database, but in some cases, you must manually set the proper dialect,
2014-08-07 10:23:46 +00:00
as the default dialect may not work correctly. You can setup dialect by adding property <literal > driverDialect</literal>
to the <literal > keycloak-server.json</literal> into <literal > connectionsJpa</literal> section (see above).
2014-02-19 15:16:15 +00:00
<table frame= 'all' > <title > Tested databases</title>
<tgroup cols= '3' align= 'left' colsep= '1' rowsep= '1' >
<thead >
<row >
<entry > Database</entry>
<entry > JDBC driver</entry>
<entry > Hibernate Dialect</entry>
</row>
</thead>
<tbody >
<row >
<entry > H2 1.3.161</entry>
<entry > H2 1.3.161</entry>
<entry > auto</entry>
</row>
<row >
<entry > MySQL 5.5</entry>
<entry > MySQL Connector/J 5.1.25</entry>
<entry > auto</entry>
</row>
<row >
<entry > PostgreSQL 9.2</entry>
<entry > JDBC4 Postgresql Driver, Version 9.3-1100</entry>
<entry > auto</entry>
</row>
<row >
<entry > Oracle 11g R1</entry>
<entry > Oracle JDBC Driver v11.1.0.7</entry>
<entry > auto</entry>
</row>
<row >
<entry > Microsoft SQL Server 2012</entry>
<entry > Microsoft SQL Server JDBC Driver 4.0.2206.100</entry>
<entry > org.hibernate.dialect.SQLServer2008Dialect</entry>
</row>
<row >
<entry > Sybase ASE 15.7</entry>
<entry > JDBC(TM)/7.07 ESD #5 (Build 26792)/P/EBF20686</entry>
<entry > auto</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</section>
2014-01-13 01:57:31 +00:00
</section>
2014-02-19 16:43:11 +00:00
<section >
<title > MongoDB based model</title>
<para >
Keycloak provides <ulink url= "http://www.mongodb.com" > MongoDB</ulink> based model implementation, which means that your identity data will be saved
2014-05-27 11:05:35 +00:00
in MongoDB instead of traditional RDBMS. To configure Keycloak to use Mongo open <literal > standalone/configuration/keycloak-server.json</literal>
in your favourite editor, then change:
2014-02-19 16:43:11 +00:00
<programlisting > < ![CDATA[
2014-08-27 10:41:40 +00:00
"eventsStore": {
2014-08-07 10:23:46 +00:00
"provider": "jpa",
"jpa": {
"exclude-events": [ "REFRESH_TOKEN" ]
}
2014-05-27 11:05:35 +00:00
},
2014-08-07 10:23:46 +00:00
"realm": {
"provider": "jpa"
},
"user": {
"provider": "${keycloak.user.provider:jpa}"
2014-05-27 11:05:35 +00:00
},
2014-02-19 16:43:11 +00:00
]]></programlisting>
2014-05-27 11:05:35 +00:00
to:
<programlisting > < ![CDATA[
2014-08-27 10:41:40 +00:00
"eventsStore": {
2014-08-07 10:23:46 +00:00
"provider": "mongo",
2014-09-03 08:13:05 +00:00
"mongo": {
"exclude-events": [ "REFRESH_TOKEN" ]
}
2014-05-27 11:05:35 +00:00
},
2014-08-07 10:23:46 +00:00
"realm": {
"provider": "mongo"
2014-05-27 11:05:35 +00:00
},
2014-08-07 10:23:46 +00:00
"user": {
"provider": "mongo"
2014-09-03 08:13:05 +00:00
},
2014-02-19 16:43:11 +00:00
]]></programlisting>
2014-05-27 11:05:35 +00:00
2014-08-07 10:23:46 +00:00
And at the end of the file add the snippet like this where you can configure details about your Mongo database:
<programlisting > < ![CDATA[
"connectionsMongo": {
"default": {
"host": "127.0.0.1",
"port": "27017",
2014-10-30 10:09:21 +00:00
"db": "keycloak",
2015-01-23 12:01:39 +00:00
"connectionsPerHost": 100,
"databaseSchema": "update"
2014-08-07 10:23:46 +00:00
}
}
]]></programlisting>
2014-05-27 11:05:35 +00:00
2014-08-07 10:23:46 +00:00
All configuration options are optional. Default values for host and port are localhost and 27017. Default name of database
is <literal > keycloak</literal> . You can also specify properties <literal > user</literal> and <literal > password</literal>
if you want authenticate against your MongoDB. If user and password are not specified, Keycloak will connect
unauthenticated to your MongoDB.
2014-02-19 16:43:11 +00:00
</para>
2014-10-30 10:09:21 +00:00
<para > Finally there is set of optional configuration options, which can be used to specify connection-pooling capabilities of Mongo client. Supported int options are:
<literal > connectionsPerHost</literal> , <literal > threadsAllowedToBlockForConnectionMultiplier</literal> , <literal > maxWaitTime</literal> , <literal > connectTimeout</literal>
<literal > socketTimeout</literal> . Supported boolean options are: <literal > socketKeepAlive</literal> , <literal > autoConnectRetry</literal> .
Supported long option is <literal > maxAutoConnectRetryTime</literal> . See <ulink url= "http://api.mongodb.org/java/2.11.4/com/mongodb/MongoClientOptions.html" > Mongo documentation</ulink>
for details about those options and their default values.
</para>
2015-10-12 11:04:48 +00:00
<para >
Alternatively, you can configure MongoDB using a MongoDB <ulink url= "http://docs.mongodb.org/manual/reference/connection-string/" > connection URI</ulink> .
In this case, you define all information concerning the connection and authentication within the URI, as described in the MongoDB documentation.
Please note that the database specified within the URI is only used for authentication. To change the database used by keycloak you have to set
<literal > db</literal> property as before. Therefore, a configuration like the
following
<programlisting > < ![CDATA[
"connectionsMongo": {
"default": {
"uri": "mongodb://user:password@127.0.0.1/authentication",
"db": "keycloak"
}
}
]]></programlisting>
will authenticate the user against the authentication database, but store all keycloak related data in the keycloak database.
</para>
<section >
<title > MongoDB Replica Sets</title>
<para >
In order to use a mongo replica set for Keycloak, one has to use URI based configuration, which supports the
definition of replica sets out of the box: <literal > mongodb://host1:27017,host2:27017,host3:27017/</literal> .
</para>
</section>
2014-02-19 16:43:11 +00:00
</section>
2014-05-27 11:05:35 +00:00
2015-04-30 01:42:32 +00:00
<section >
<title > Outgoing Server HTTP Requests</title>
<para >
Keycloak server needs to invoke on remote HTTP endpoints to do things like backchannel logouts and other
management functions. Keycloak maintains a HTTP client connection pool which has various configuration
settings you can specify before boot time. This is configured in the
<literal > standalone/configuration/keycloak-server.json</literal> .
By default the setting is like this:
2015-11-12 08:17:47 +00:00
<programlisting > < ![CDATA[
"connectionsHttpClient": {
2016-01-05 14:14:31 +00:00
"default": {}
2015-11-12 08:17:47 +00:00
},
2015-04-30 01:42:32 +00:00
]]></programlisting>
Possible configuration options are:
<variablelist >
<varlistentry >
<term > establish-connection-timeout-millis</term>
<listitem >
<para >
Timeout for establishing a socket connection.
</para>
</listitem>
</varlistentry>
<varlistentry >
<term > socket-timeout-millis</term>
<listitem >
<para >
If an outgoing request does not receive data for this amount of time, timeout the connection.
</para>
</listitem>
</varlistentry>
<varlistentry >
<term > connection-pool-size</term>
<listitem >
<para >
How many connections can be in the pool.
</para>
</listitem>
</varlistentry>
<varlistentry >
<term > max-pooled-per-route</term>
<listitem >
<para >
How many connections can be pooled per host.
</para>
</listitem>
</varlistentry>
<varlistentry >
<term > disable-cookies</term>
<listitem >
<para >
<literal > true</literal> by default. When set to true, this will disable any cookie
caching.
</para>
</listitem>
</varlistentry>
<varlistentry >
2016-01-05 14:14:31 +00:00
<term > client-keystore</term>
2015-04-30 01:42:32 +00:00
<listitem >
<para >
2016-01-05 14:14:31 +00:00
This is the file path to a Java keystore file.
This keystore contains client certificate for two-way SSL.
2015-04-30 01:42:32 +00:00
</para>
</listitem>
</varlistentry>
<varlistentry >
2016-01-05 14:14:31 +00:00
<term > client-keystore-password</term>
2015-04-30 01:42:32 +00:00
<listitem >
<para >
2016-01-05 14:14:31 +00:00
Password for the client keystore.
This is
<emphasis > REQUIRED</emphasis>
if
<literal > client-keystore</literal>
is set.
2015-04-30 01:42:32 +00:00
</para>
</listitem>
</varlistentry>
<varlistentry >
2016-01-05 14:14:31 +00:00
<term > client-key-password</term>
2015-04-30 01:42:32 +00:00
<listitem >
<para >
2016-01-05 14:14:31 +00:00
<emphasis > Not supported yet, but we will support in future versions.</emphasis>
Password for the client's key.
2015-04-30 01:42:32 +00:00
This is
<emphasis > REQUIRED</emphasis>
if
2016-01-05 14:14:31 +00:00
<literal > client-keystore</literal>
2015-04-30 01:42:32 +00:00
is set.
</para>
</listitem>
</varlistentry>
2016-01-05 14:14:31 +00:00
</variablelist>
</para>
</section>
<section id= "truststore" >
<title > Securing Outgoing Server HTTP Requests</title>
<para >
When Keycloak connects out to remote HTTP endpoints over secure https connection, it has to validate the other
server's certificate in order to ensure it is connecting to a trusted server. That is necessary in order to
prevent man-in-the-middle attacks.
</para>
<para >
How certificates are validated is configured in the <literal > standalone/configuration/keycloak-server.json</literal> .
By default truststore provider is not configured, and any https connections fall back to standard java truststore
configuration as described in <ulink url= "https://docs.oracle.com/javase/8/docs/technotes/guides/security/jsse/JSSERefGuide.html" >
Java's JSSE Reference Guide</ulink> - using <literal > javax.net.ssl.trustStore system property</literal> ,
otherwise <literal > cacerts</literal> file that comes with java is used.
</para>
<para >
Truststore is used when connecting securely to identity brokers, LDAP identity providers, when sending emails,
and for backchannel communication with client applications.
Some of these facilities may - in case when no trusted certificate is found in your configured truststore -
fallback to using the JSSE provided truststore.
The default JavaMail API implementation used to send out emails behaves in this way, for example.
</para>
<para >
You can add your truststore configuration by using the following template:
<programlisting > < ![CDATA[
"truststore": {
"file": {
"file": "path to your .jks file containing public certificates",
"password": "password",
"hostname-verification-policy": "WILDCARD",
"disabled": false
}
}
]]></programlisting>
</para>
<para >
Possible configuration options are:
<variablelist >
2015-04-30 01:42:32 +00:00
<varlistentry >
2016-01-05 14:14:31 +00:00
<term > file</term>
2015-04-30 01:42:32 +00:00
<listitem >
<para >
2016-01-05 14:14:31 +00:00
The value is the file path to a Java keystore file.
HTTPS requests need a way to verify the host of the server they are talking to. This is
what the trustore does. The keystore contains one or more trusted host certificates or
certificate authorities. Truststore file should only contain public certificates of your secured hosts.
This is
<emphasis > REQUIRED</emphasis>
if <literal > disabled</literal> is not true.
2015-04-30 01:42:32 +00:00
</para>
</listitem>
</varlistentry>
<varlistentry >
2016-01-05 14:14:31 +00:00
<term > password</term>
2015-04-30 01:42:32 +00:00
<listitem >
<para >
2016-01-05 14:14:31 +00:00
Password for the truststore.
2015-04-30 01:42:32 +00:00
This is
<emphasis > REQUIRED</emphasis>
2016-01-05 14:14:31 +00:00
if <literal > disabled</literal> is not true.
2015-04-30 01:42:32 +00:00
</para>
</listitem>
</varlistentry>
<varlistentry >
2016-01-05 14:14:31 +00:00
<term > hostname-verification-policy</term>
2015-04-30 01:42:32 +00:00
<listitem >
<para >
2016-01-05 14:14:31 +00:00
<literal > WILDCARD</literal> by default. For HTTPS requests, this verifies the hostname
of the server's certificate. <literal > ANY</literal> means that the hostname is not verified.
<literal > WILDCARD</literal> Allows wildcards in subdomain names i.e. *.foo.com.
<literal > STRICT</literal> CN must match hostname exactly.
</para>
</listitem>
</varlistentry>
<varlistentry >
<term > disabled</term>
<listitem >
<para >
If true (default value), truststore configuration will be ignored, and certificate checking will
fall back to JSSE configuration as described. If set to false, you must
configure <literal > file</literal> , and <literal > password</literal> for the truststore.
2015-04-30 01:42:32 +00:00
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
2016-01-05 14:14:31 +00:00
<para >
You can use <emphasis > keytool</emphasis> to create a new truststore file and add trusted host certificates to it:
<programlisting >
$ keytool -import -alias HOSTDOMAIN -keystore truststore.jks -file host-certificate.cer
</programlisting>
</para>
2015-04-30 01:42:32 +00:00
</section>
2014-09-19 15:03:08 +00:00
<section id= "ssl_modes" >
2014-08-20 18:37:15 +00:00
<title > SSL/HTTPS Requirement/Modes</title>
2014-01-13 01:57:31 +00:00
<warning >
<para >
2016-01-05 14:14:31 +00:00
Keycloak is not set up by default to handle SSL/HTTPS. It is highly recommended that you either enable SSL
on the Keycloak server itself or on a reverse proxy in front of the Keycloak server.
2014-01-13 01:57:31 +00:00
</para>
</warning>
2014-08-20 18:37:15 +00:00
<para >
Keycloak can run out of the box without SSL so long as you stick to private IP addresses like
localhost, 127.0.0.1, 10.0.x.x, 192.168.x.x, and 172..16.x.x. If you try to access Keycloak from a
non-IP adress you will get an error.
</para>
<para >
Keycloak has 3 SSL/HTTPS modes which you can set up in the admin console under the Settings->Login page
and the <literal > Require SSL</literal> select box. Each adapter config should mirror this server-side
setting. See adapter config section for more details.
<variablelist >
<varlistentry >
<term > external</term>
<listitem >
<para >
Keycloak can run out of the box without SSL so long as you stick to private IP addresses like
localhost, 127.0.0.1, 10.0.x.x, 192.168.x.x, and 172..16.x.x. If you try to access Keycloak from a
non-IP adress you will get an error.
</para>
</listitem>
</varlistentry>
<varlistentry >
<term > none</term>
<listitem >
<para >
Keycloak does not require SSL.
</para>
</listitem>
</varlistentry>
<varlistentry >
<term > all</term>
<listitem >
<para >
Keycloak requires SSL for all IP addresses.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</section>
<section >
<title > SSL/HTTPS Setup</title>
2014-01-13 01:57:31 +00:00
2014-06-18 08:59:23 +00:00
<para >
First enable SSL on Keycloak or on a reverse proxy in front of Keycloak. Then configure the Keycloak Server to enforce HTTPS connections.
2014-01-13 01:57:31 +00:00
</para>
2014-06-18 08:59:23 +00:00
2014-01-13 01:57:31 +00:00
<section >
2014-06-18 08:59:23 +00:00
<title > Enable SSL on Keycloak</title>
2014-01-13 01:57:31 +00:00
<para >
2014-06-18 08:59:23 +00:00
The following things need to be done
<itemizedlist >
<listitem >
Generate a self signed or third-party signed certificate and import it into a Java keystore
using <literal > keytool</literal> .
</listitem>
<listitem >
2015-04-23 13:30:15 +00:00
Enable Wildfly to use this certificate and turn on SSL/HTTPS.
2014-06-18 08:59:23 +00:00
</listitem>
</itemizedlist>
2014-01-13 01:57:31 +00:00
</para>
<section >
2014-06-18 08:59:23 +00:00
<title > Creating the Certificate and Java Keystore</title>
2014-01-13 01:57:31 +00:00
<para >
2014-06-18 08:59:23 +00:00
In order to allow HTTPS connections, you need to obtain a self signed or third-party signed certificate
and import it into a Java keystore before you can enable HTTPS in the web container you are deploying
the Keycloak Server to.
2014-01-13 01:57:31 +00:00
</para>
2014-06-18 08:59:23 +00:00
<section >
<title > Self Signed Certificate</title>
<para >
In development, you will probably not have a third party signed certificate available to test
a Keycloak deployment so you'll need to generate a self-signed on. Generate one is very easy
to do with the <literal > keytool</literal> utility that comes with the Java jdk.
</para>
<para >
2015-11-12 08:17:47 +00:00
<programlisting >
$ keytool -genkey -alias localhost -keyalg RSA -keystore keycloak.jks -validity 10950
Enter keystore password: secret
Re-enter new password: secret
What is your first and last name?
[Unknown]: localhost
What is the name of your organizational unit?
[Unknown]: Keycloak
What is the name of your organization?
[Unknown]: Red Hat
What is the name of your City or Locality?
[Unknown]: Westford
What is the name of your State or Province?
[Unknown]: MA
What is the two-letter country code for this unit?
[Unknown]: US
Is CN=localhost, OU=Keycloak, O=Test, L=Westford, ST=MA, C=US correct?
[no]: yes
</programlisting>
2014-06-18 08:59:23 +00:00
</para>
<para >
2015-02-14 10:07:25 +00:00
You should answer <literal > What is your first and last name ?</literal> question with
2014-06-18 08:59:23 +00:00
the DNS name of the machine you're installing the server on. For testing purposes,
<literal > localhost</literal> should be used. After executing this command, the
<literal > keycloak.jks</literal> file will be generated in the same directory as you executed
the <literal > keytool</literal> command in.
</para>
<para >
If you want a third-party signed certificate, but don't have one, you can obtain one for free
at <ulink url= "http://cacert.org" > cacert.org</ulink> . You'll have to do a little set up first
before doing this though.
</para>
<para >
The first thing to do is generate a Certificate Request:
2015-11-12 08:17:47 +00:00
<programlisting >
$ keytool -certreq -alias yourdomain -keystore keycloak.jks > keycloak.careq
</programlisting>
2014-06-18 08:59:23 +00:00
</para>
<para >
Where <literal > yourdomain</literal> is a DNS name for which this certificate is generated for.
Keytool generates the request:
2015-11-12 08:17:47 +00:00
<programlisting >
-----BEGIN NEW CERTIFICATE REQUEST-----
MIIC2jCCAcICAQAwZTELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAk1BMREwDwYDVQQHEwhXZXN0Zm9y
ZDEQMA4GA1UEChMHUmVkIEhhdDEQMA4GA1UECxMHUmVkIEhhdDESMBAGA1UEAxMJbG9jYWxob3N0
MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAr7kck2TaavlEOGbcpi9c0rncY4HhdzmY
Ax2nZfq1eZEaIPqI5aTxwQZzzLDK9qbeAd8Ji79HzSqnRDxNYaZu7mAYhFKHgixsolE3o5Yfzbw1
29Rvy+eUVe+WZxv5oo9wolVVpdSINIMEL2LaFhtX/c1dqiqYVpfnvFshZQaIg2nL8juzZcBjj4as
H98gIS7khql/dkZKsw9NLvyxgJvp7PaXurX29fNf3ihG+oFrL22oFyV54BWWxXCKU/GPn61EGZGw
Ft2qSIGLdctpMD1aJR2bcnlhEjZKDksjQZoQ5YMXaAGkcYkG6QkgrocDE2YXDbi7GIdf9MegVJ35
2DQMpwIDAQABoDAwLgYJKoZIhvcNAQkOMSEwHzAdBgNVHQ4EFgQUQwlZJBA+fjiDdiVzaO9vrE/i
n2swDQYJKoZIhvcNAQELBQADggEBAC5FRvMkhal3q86tHPBYWBuTtmcSjs4qUm6V6f63frhveWHf
PzRrI1xH272XUIeBk0gtzWo0nNZnf0mMCtUBbHhhDcG82xolikfqibZijoQZCiGiedVjHJFtniDQ
9bMDUOXEMQ7gHZg5q6mJfNG9MbMpQaUVEEFvfGEQQxbiFK7hRWU8S23/d80e8nExgQxdJWJ6vd0X
MzzFK6j4Dj55bJVuM7GFmfdNC52pNOD5vYe47Aqh8oajHX9XTycVtPXl45rrWAH33ftbrS8SrZ2S
vqIFQeuLL3BaHwpl3t7j2lMWcK1p80laAxEASib/fAwrRHpLHBXRcq6uALUOZl4Alt8=
-----END NEW CERTIFICATE REQUEST-----
</programlisting>
2014-06-18 08:59:23 +00:00
</para>
<para >
Send this ca request to your CA. The CA will issue you a signed certificate and send it to you.
Before you import your new cert, you must obtain and import the root certificate of the CA.
You can download the cert from CA (ie.: root.crt) and import as follows:
2015-11-12 08:17:47 +00:00
<programlisting >
$ keytool -import -keystore keycloak.jks -file root.crt -alias root
</programlisting>
2014-06-18 08:59:23 +00:00
</para>
<para >
Last step is import your new CA generated certificate to your keystore:
2015-11-12 08:17:47 +00:00
<programlisting >
$ keytool -import -alias yourdomain -keystore keycloak.jks -file your-certificate.cer
</programlisting>
2014-06-18 08:59:23 +00:00
</para>
</section>
</section>
<section >
<title > Installing the keystore to WildFly</title>
2014-01-13 01:57:31 +00:00
<para >
2014-06-18 08:59:23 +00:00
Now that you have a Java keystore with the appropriate certificates, you need to configure your
Wildfly installation to use it. First step is to move the keystore file to a directory
you can reference in configuration. I like to put it in <literal > standalone/configuration</literal> .
Then you need to edit <literal > standalone/configuration/standalone.xml</literal> to enable SSL/HTTPS.
2014-01-13 01:57:31 +00:00
</para>
<para >
2014-06-18 08:59:23 +00:00
To the <literal > security-realms</literal> element add:
2015-11-12 08:17:47 +00:00
<programlisting > < ![CDATA[
<security-realm name= "UndertowRealm" >
<server-identities >
<ssl >
<keystore path= "keycloak.jks" relative-to= "jboss.server.config.dir" keystore-password= "secret" />
</ssl>
</server-identities>
</security-realm>
]]></programlisting>
2014-01-13 01:57:31 +00:00
</para>
<para >
2014-06-18 08:59:23 +00:00
Find the element <literal > < server name="default-server"> </literal> (it's a child element of <literal > < subsystem xmlns="urn:jboss:domain:undertow:1.0"> </literal> ) and add:
2015-11-12 08:17:47 +00:00
<programlisting > <![CDATA[<https-listener name="https" socket-binding="https" security-realm="UndertowRealm"/>]]> </programlisting>
2014-01-13 01:57:31 +00:00
</para>
<para >
2014-06-18 08:59:23 +00:00
Check the <ulink url= "https://docs.jboss.org/author/display/WFLY8/Undertow+(web)+subsystem+configuration" > Wildfly Undertow</ulink> documentation for more information on fine tuning the socket connections.
2014-01-13 01:57:31 +00:00
</para>
2014-06-18 08:59:23 +00:00
</section>
2014-01-13 01:57:31 +00:00
</section>
2014-06-18 08:59:23 +00:00
2014-01-13 01:57:31 +00:00
<section >
2014-06-18 08:59:23 +00:00
<title > Enable SSL on a Reverse Proxy</title>
2014-01-20 17:46:33 +00:00
<para >
2014-06-18 08:59:23 +00:00
Follow the documentation for your web server to enable SSL and configure reverse proxy for Keycloak.
It is important that you make sure the web server sets the <literal > X-Forwarded-For</literal> and
<literal > X-Forwarded-Proto</literal> headers on the requests made to Keycloak. Next you need to enable
2014-06-18 10:08:06 +00:00
<literal > proxy-address-forwarding</literal> on the Keycloak http connector. Assuming that your reverse
proxy doesn't use port 8443 for SSL you also need to configure what port http traffic is redirected to.
2014-01-20 17:46:33 +00:00
</para>
2014-10-29 13:02:16 +00:00
<section >
2015-04-23 13:30:15 +00:00
<title > Configure WildFly</title>
2014-10-29 13:02:16 +00:00
<para >
Open <literal > standalone/configuration/standalone.xml</literal> in your favorite editor.
</para>
<para >
First add <literal > proxy-address-forwarding</literal> and <literal > redirect-socket</literal> to
the <literal > http-listener</literal> element:
2014-06-18 08:59:23 +00:00
<programlisting > <![CDATA[<subsystem xmlns="urn:jboss:domain:undertow:1.1">
...
2014-10-29 13:02:16 +00:00
<http-listener name= "default" socket-binding= "http"
proxy-address-forwarding="true" redirect-socket="proxy-https"/>
2014-06-18 08:59:23 +00:00
...
</subsystem>
2014-06-18 10:08:06 +00:00
]]></programlisting>
2014-10-29 13:02:16 +00:00
</para>
<para >
Then add a new <literal > socket-binding</literal> element to the <literal > socket-binding-group</literal> element:
2014-06-18 10:08:06 +00:00
<programlisting > < ![CDATA[
2014-10-29 13:02:16 +00:00
<socket-binding-group name= "standard-sockets" default-interface= "public"
port-offset="${jboss.socket.binding.port-offset:0}">
2014-06-18 10:08:06 +00:00
...
<socket-binding name= "proxy-https" port= "443" />
...
</socket-binding-group>
2014-02-18 10:36:58 +00:00
]]></programlisting>
2014-10-29 13:02:16 +00:00
</para>
<para >
Check the <ulink url= "https://docs.jboss.org/author/display/WFLY8/Undertow+(web)+subsystem+configuration" > WildFly</ulink> documentation for more information.
</para>
</section>
2014-01-13 01:57:31 +00:00
</section>
2014-06-18 08:59:23 +00:00
2014-01-13 01:57:31 +00:00
</section>
</section>
2015-04-01 07:36:06 +00:00
2014-11-02 21:46:41 +00:00
<section >
2015-11-13 08:03:58 +00:00
<title > Keycloak server in Domain Mode</title>
2014-11-02 21:46:41 +00:00
<para >
2015-04-01 07:36:06 +00:00
In domain mode, you start the server with the "domain" command instead of the "standalone" command. In this case, the Keycloak subsystem is
defined in domain/configuration/domain.xml instead of standalone/configuration.standalone.xml. Inside domain.xml, you will see more than one
2015-11-13 08:03:58 +00:00
profile. The Keycloak subsystem is defined for all initial profiles.
2014-11-02 21:46:41 +00:00
</para>
2015-04-01 07:36:06 +00:00
<para >
2015-11-13 08:03:58 +00:00
THe server is also added to server profiles. By default two servers are started
in the main-server-group which uses the full profile.
2015-04-01 07:36:06 +00:00
</para>
<para >
2015-11-13 08:03:58 +00:00
You need to make sure <literal > domain/servers/< SERVER NAME> /configuration</literal> is identical
2015-04-01 07:36:06 +00:00
for all servers in a group.
</para>
<para >
To deploy custom providers and themes you should deploys these as modules and make sure the modules are
available to all servers in the group. See <link linkend= 'providers' > Providers</link> and
<link linkend= 'themes' > Themes</link> sections for more information on how to do this.
</para>
2014-11-02 21:46:41 +00:00
</section>
2015-04-15 14:36:38 +00:00
<section >
<title > Installing Keycloak Server as Root Context</title>
<para >
2015-09-29 02:32:16 +00:00
The Keycloak server can be installed as the default web application. In doing so, the server can be referenced at <literal > http://mydomain.com/</literal> instead of <literal > http://mydomain.com/auth</literal> .
2015-04-15 14:36:38 +00:00
</para>
<para >
2015-09-29 02:32:16 +00:00
To do this, add the <literal > default-web-module</literal> attribute in the Undertow subystem in standalone.xml.
2015-11-12 08:17:47 +00:00
<programlisting > < ![CDATA[
2015-09-29 02:32:16 +00:00
<subsystem xmlns= "urn:jboss:domain:undertow:2.0" >
2015-11-12 08:17:47 +00:00
<server name= "default-server" >
<host name= "default-host" alias= "localhost" default-web-module= "keycloak-server.war" >
<location name= "/" handler= "welcome-content" />
</host>
2015-04-15 14:36:38 +00:00
]]></programlisting>
</para>
<para >
2015-09-29 02:32:16 +00:00
<literal > keycloak-server.war</literal> is the runtime name of the Keycloak server application. Note that the WAR file does not exist as a file. If its name changes (ie. <literal > keycloak-server.war</literal> ) in the future, find its new name from the Keycloak log entry with <literal > runtime-name:</literal> .
2015-04-15 14:36:38 +00:00
</para>
<para >
<note >
2015-09-29 02:32:16 +00:00
If you have run your server before altering the root context, your database
will contain references to the old /auth context. Your clients may also have incorrect
2015-04-15 14:36:38 +00:00
references. To fix this on the server side, you will need to <link linkend= "export-import" > export
your database to json, make corrections, and then import.</link> Client-side keycloak.json
files will need to be updated manually as well.
</note>
</para>
</section>
2014-01-13 01:57:31 +00:00
</chapter>
