Author: Giriraj Sharma, Stefan Guilhen
Level: Intermediate
Technologies: Mutual SSL, Security, Undertow
Summary: The helloworld-mutual-ssl-secured
quickstart demonstrates securing a Web application using client mutual SSL authentication and role-based access control
Target Product: WildFly
Source: https://github.com/wildfly/quickstart/
This example demonstrates the configuration of mutual SSL authentication in WildFly Application Server 11 to secure a war application.
Mutual SSL provides the same security as SSL, with the addition of authentication and non-repudiation of the client authentication, using digital signatures. When mutual authentication is used, the server would request the client to provide a certificate in addition to the server certificate issued to the client. Mutual authentication requires an extra round trip time for client certificate exchange. In addition, the client must buy and maintain a digital certificate. We can secure our war application deployed over WildFly with mutual(two-way) client certificate authentication and provide access permissions or privileges to legitimate users.
This quickstart shows how to configure WildFly to enable TLS/SSL configuration for the new WildFly undertow
subsystem and enable mutual (two-way) SSL authentication for clients in order to secure a WAR application with restricted access.
The applications these projects produce are designed to be run on WildFly Application Server 11 or later.
All you need to build these projects is Java 8.0 (Java SDK 1.8) or later and Maven 3.3.1 or later. See Configure Maven for WildFly 11 to make sure you are configured correctly for testing the quickstarts.
To run these quickstarts with the provided build scripts, you need the WildFly distribution ZIP. For information on how to install and run WildFly, see the WildFly Application Server Documentation Getting Started Guide located on the Customer Portal.
You can also use JBoss Developer Studio or Eclipse to run the quickstarts.
In the following instructions, replace WILDFLY_HOME
with the actual path to your WildFly installation. The installation path is described in detail here: Use of WILDFLY_HOME and JBOSS_HOME Variables.
Using the add-user utility script, you must add the following user to the ApplicationRealm
:
UserName | Realm | Password | Roles |
---|---|---|---|
quickstartUser | ApplicationRealm | quickstartPwd1! | JBossAdmin |
For the purpose of this quickstart the password can contain any valid value because the ApplicationRealm
will be used for authorization only, for example, to obtain the security roles.
To add the application user, open a command prompt and type the following commands:
For Linux:
WILDFLY_HOME/bin/add-user.sh -a -u 'quickstartUser' -p 'quickstartPwd1!' -g 'JBossAdmin'
For Windows:
WILDFLY_HOME\bin\add-user.bat -a -u 'quickstartUser' -p 'quickstartPwd1!' -g 'JBossAdmin'
If you prefer, you can use the add-user utility interactively. For an example of how to use the add-user utility, see the instructions located here: Add an Application User.
configuration
directory:
For Linux: WILDFLY_HOME/standalone/configuration
For Windows: WILDFLY_HOME\standalone\configuration
$>keytool -genkey -keyalg RSA -keystore server.keystore -storepass secret -keypass secret -validity 365
What is your first and last name?
[Unknown]: localhost
What is the name of your organizational unit?
[Unknown]: wildfly
What is the name of your organization?
[Unknown]: jboss
What is the name of your City or Locality?
[Unknown]: Raleigh
What is the name of your State or Province?
[Unknown]: Carolina
What is the two-letter country code for this unit?
[Unknown]: US
Is CN=localhost, OU=wildfly, O=jboss, L=Raleigh, ST=Carolina, C=US correct?
[no]: yes
Create the client certificate, which is used to authenticate against the server when accessing a resource through SSL.
$>keytool -genkey -keystore client.keystore -storepass secret -validity 365 -keyalg RSA -keysize 2048 -storetype pkcs12
What is your first and last name?
[Unknown]: quickstartUser
What is the name of your organizational unit?
[Unknown]: Sales
What is the name of your organization?
[Unknown]: My Company
What is the name of your City or Locality?
[Unknown]: Sao Paulo
What is the name of your State or Province?
[Unknown]: Sao Paulo
What is the two-letter country code for this unit?
[Unknown]: BR
Is CN=quickstartUser, OU=Sales, O=My Company, L=Sao Paulo, ST=Sao Paulo, C=BR correct?
[no]: yes
Notice that we set the fisrt and last name
to quickstartUser
and that this matches the user we've added to the ApplicationRealm
. When authorizing access to a resource, the CN (common name) of the client's certificate is extracted by a principal decoder and this name is then used by the ApplicationRealm
to obtain the client's roles.
Export the client certificate and create a truststore by importing this certificate:
$>keytool -exportcert -keystore client.keystore -storetype pkcs12 -storepass secret -keypass secret -file client.crt
$>keytool -import -file client.crt -alias quickstartUser -keystore client.truststore -storepass secret
Owner: CN=quickstartUser, OU=Sales, O=My Company, L=Sao Paulo, ST=Sao Paulo, C=BR
Issuer: CN=quickstartUser, OU=Sales, O=My Company, L=Sao Paulo, ST=Sao Paulo, C=BR
Serial number: 7fd95ce4
Valid from: Mon Jul 24 16:14:03 BRT 2017 until: Tue Jul 24 16:14:03 BRT 2018
Certificate fingerprints:
MD5: 87:41:C5:CC:E6:79:91:F0:9D:90:AD:9E:DD:57:81:80
SHA1: 55:35:CA:B0:DC:DD:4F:E6:B8:9F:45:4B:4B:98:93:B5:3B:7C:55:84
SHA256: 0A:FC:93:B6:25:5A:74:42:B8:A1:C6:5F:69:88:72:7F:27:A9:81:B0:17:0C:F1:AF:3D:DE:B7:E5:F1:69:66:4B
Signature algorithm name: SHA256withRSA
Version: 3
Extensions:
#1: ObjectId: 2.5.29.14 Criticality=false
SubjectKeyIdentifier [
KeyIdentifier [
0000: 95 84 BE C6 32 BB 2B 13 4C 7F 5D D4 C4 C8 22 12 ....2.+.L.]...".
0010: CB 09 39 09 ..9.
]
]
Trust this certificate? [no]: yes
Certificate was added to keystore
It is worth noticing that the client certificate was imported under the quickstartUser
alias. When authenticating a client in a CLIENT_CERT
configuration, the CN (common name) of the client's certificate is extracted by a principal decoder and this name is then used by the KeyStoreRealm
to match an alias in the trust store. If a trusted certificate is found under this alas, the client is considered authenticated.
Export client certificate to pkcs12 format
$>keytool -importkeystore -srckeystore client.keystore -srcstorepass secret -destkeystore clientCert.p12 -srcstoretype PKCS12 -deststoretype PKCS12 -deststorepass secret
The certificates and keystores are now properly configured.
These steps assume you are running the server in standalone mode and using the default standalone.xml
supplied with the distribution.
You configure the SSL context and required security domain by running JBoss CLI commands. For your convenience, this quickstart batches the commands into a configure-ssl.cli
script provided in the root directory of this quickstart.
Before you begin, back up your server configuration file
WILDFLY_HOME/standalone/configuration/standalone.xml
Start the WildFly server by typing the following:
For Linux: WILDFLY_HOME/bin/standalone.sh
For Windows: WILDFLY_HOME\bin\standalone.bat
configure-ssl.cli
file in the root of this quickstart directory. Comments in the script describe the purpose of each block of commands.Open a new command prompt, navigate to the root directory of this quickstart, and run the following command, replacing WILDFLY_HOME with the path to your server:
For Linux: WILDFLY_HOME/bin/jboss-cli.sh --connect --file=configure-ssl.cli
For Windows: WILDFLY_HOME\bin\jboss-cli.bat --connect --file=configure-ssl.cli
You should see the following result when you run the script:
The batch executed successfully
process-state: reload-required
Stop the WildFly server.
After stopping the server, open the WILDFLY_HOME/standalone/configuration/standalone.xml
file and review the changes.
The following key-store
s were added to the elytron
subsystem:
<key-store name="qsKeyStore">
<credential-reference clear-text="secret"/>
<implementation type="JKS"/>
<file path="server.keystore" relative-to="jboss.server.config.dir"/>
</key-store>
<key-store name="qsTrustStore">
<credential-reference clear-text="secret"/>
<implementation type="JKS"/>
<file path="client.truststore" relative-to="jboss.server.config.dir"/>
</key-store>
The following key-manager
was added to the elytron
subsystem:
<key-managers>
<key-manager name="qsKeyManager" key-store="qsKeyStore">
<credential-reference clear-text="secret"/>
</key-manager>
</key-managers>
The following trust-manager
was added to the elytron
subsystem:
<trust-managers>
<trust-manager name="qsTrustManager" key-store="qsTrustStore"/>
</trust-managers>
The following ssl-context
was added to the elytron
subsystem:
<server-ssl-contexts>
<server-ssl-context name="qsSSLContext" protocols="TLSv1.2" need-client-auth="true" key-manager="qsKeyManager" trust-manager="qsTrustManager"/>
</server-ssl-contexts>
The following realms were added to the elytron
subsystem:
<key-store-realm name="KeyStoreRealm" key-store="qsTrustStore"/>
<aggregate-realm name="QuickstartRealm" authentication-realm="KeyStoreRealm" authorization-realm="ApplicationRealm"/>
The aggregate-realm
defines different security realms for authentication and authorization. In this case, the KeyStoreRealm
is responsible for authenticating the principal extracted from the client's certificate and the ApplicationRealm
is responsible for obtaining the roles required to access the application.
The following principal-decoder
and security-domain
were added to the elytron
subsystem:
<x500-attribute-principal-decoder name="QuickstartDecoder" attribute-name="cn"/>
<security-domain name="QuickstartDomain" default-realm="QuickstartRealm" permission-mapper="default-permission-mapper" principal-decoder="QuickstartDecoder">
<realm name="QuickstartRealm" role-decoder="groups-to-roles"/>
</security-domain>
The x500-attribute-principal-decoder
creates a new Principal
from the CN attribute of the X500Principal
obtained from the client's certificate. This new principal is supplied to the security realms and is also the principal returned in methods like getUserPrincipal
and getCallerPrincipal
.
The following http-authentication-factory
was added to the elytron
subsystem:
<http-authentication-factory name="quickstart-http-authentication" http-server-mechanism-factory="global" security-domain="QuickstartDomain">
<mechanism-configuration>
<mechanism mechanism-name="CLIENT_CERT"/>
</mechanism-configuration>
</http-authentication-factory>
It defines the security domain that will handle requests using the CLIENT_CERT
HTTP mechanism.
The https-listener
in the undertow
subsystem was changed to reference the qsSSLContext
ssl-context
:
<https-listener name="https" socket-binding="https" ssl-context="qsSSLContext" enable-http2="true"/>
The following application-security-domain
was added to the undertow
subsystem:
<application-security-domains>
<application-security-domain name="client_cert_domain" http-authentication-factory="quickstart-http-authentication"/>
</application-security-domains>
It maps the client_cert_domain
from the quickstart application to the http-authentication-factory
shown above, so requests made to the application go through the configured HTTP authentication factory.
To test the SSL configuration, access: https://localhost:8443
If it is configured correctly, you should be asked to trust the server certificate.
Before you access the application, you must import the clientCert.p12, which holds the client certificate, into your browser.
clientCert.p12
file. You will be prompted to enter the password: secret
.clientCert.p12
file. You will be prompted to enter the password: secret
.For Linux: bin/standalone.sh
For Windows: bin\standalone.bat
NOTE: The following build command assumes you have configured your Maven user settings. If you have not, you must include Maven setting arguments on the command line. See Build and Deploy the Quickstarts for complete instructions and additional options.
mvn clean package wildfly:deploy
This will deploy target/helloworld-mutual-ssl-secured.war
to the running instance of the server.
clientCert.p12
is same as the one mentioned in app-roles.properties
file. It will otherwise result into a HTTP Status 403
or forbidden error.The application will be running at the following URL: <https://localhost:8443/helloworld-mutual-ssl-secured>
. A page displaying the caller principal and the client certificate used for mutual SSL should be visible:
Hello World ! Mutual SSL client authentication is successful and your war app is secured.!!
Caller Principal: quickstartUser
Client Certificate Pem: MIIDhTCCAm2gAwIBAgIEf9lc5DANBgkqhkiG9w0BAQsFADBzMQswCQYDVQQGEwJCUjESMBAGA1UECBMJU2FvIFBhdW
xvMRIwEAYDVQQHEwlTYW8gUGF1bG8xEzARBgNVBAoTCk15IENvbXBhbnkxDjAMBgNVBAsTBVNhbGVzMRcwFQYDVQQDEw5xdWlja3N0YXJ0VXNlcjAe
Fw0xNzA3MjQxOTE0MDNaFw0xODA3MjQxOTE0MDNaMHMxCzAJBgNVBAYTAkJSMRIwEAYDVQQIEwlTYW8gUGF1bG8xEjAQBgNVBAcTCVNhbyBQYXVsbz
ETMBEGA1UEChMKTXkgQ29tcGFueTEOMAwGA1UECxMFU2FsZXMxFzAVBgNVBAMTDnF1aWNrc3RhcnRVc2VyMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8A
MIIBCgKCAQEAnHwflE8K/ArTPbTeZZEFK+1jtpg9grPSD62GIz/awoIDr6Rf9vCBTpAg4lom62A0BNZDEJKdab/ExNOOBRY+/pOnYlXZTYlDpdQQap
0E7UP5EfHNZsafgpfILCop2LdTuUbcV7tLKBsthJLJ0ZCoG5QJFble+OPxEbissOvIqHfvUJZi34k9ULteLJc330g0uTuDrLgtoFQ0cbHa4FCQ86o8
5EuRPpFeW6EBA3iYE/tKHSYsK7QSajefX6jZjXoZiUflw97SAGL43ZtvNbrKRywEfsVqDpDurjBg2HI+YahuDz5R1QWTSyTHWMZzcyJYqxjXiSf0oK
1cUahn6m5t1wIDAQABoyEwHzAdBgNVHQ4EFgQUlYS+xjK7KxNMf13UxMgiEssJOQkwDQYJKoZIhvcNAQELBQADggEBADkp+R6kSNXJNfihqbDRp3uF
tNMG6OgaYsfC7RtNLMdrhvoLlU7uWzxVCFuifvNlWVRiADBHDCRQU2uNRFW35GQSfHQyok4KoBuKlfBtQ+Xu7c8R0JzxN/rPJPXoCbShzDHo1uoz5/
dzXZz0EjjWCPJk+LVEhEvH0GcWAp3x3irpNU4hRZLd0XomY0Z4NnUt7VMBNYDOxVxgT9qcLnEaEpIfYULubLLCFHwAga2YgsKzZYLuwMaEWK4zhPVF
ynfnMaOxI67FC2QzhfzERyKqHj47WuwN0xWbS/1gBypS2nUwvItyxaEQG2X5uQY8j8QoY9wcMzIIkP2Mk14gJGHUnA8=
mvn wildfly:undeploy
You can restore the original server configuration by running the restore-configuration.cli
script provided in the root directory of this quickstart or by manually restoring the back-up copy the configuration file.
For Linux: WILDFLY_HOME/bin/standalone.sh
For Windows: WILDFLY_HOME\bin\standalone.bat
For Linux: WILDFLY_HOME/bin/jboss-cli.sh --connect --file=restore-configuration.cli
For Windows: WILDFLY_HOME\bin\jboss-cli.bat --connect --file=restore-configuration.cli
This script reverts the changes made to the undertow
and elytron
subsystems. You should see the following result when you run the script:
The batch executed successfully
process-state: reload-required
WILDFLY_HOME/standalone/configuration/standalone.xml
file with the back-up copy of the file.configuration
directory:
For Linux: standalone/configuration
For Windows: standalone\configuration
clientCert.p12
, client.crt
, client.keystore
, client.truststore
and server.keystore
files that were generated for this quickstart.After you are done with this quickstart, remember to remove the certificate that was imported into your browser.
quickstartUser
entry. Click on the icon (3 dots) to the right of it and then select 'Delete'.quickstartUser
certificate and click the Delete
button.You can also start the server and deploy the quickstarts or run the Arquillian tests from Eclipse using JBoss tools. For general information about how to import a quickstart, add a WildFly server, and build and deploy a quickstart, see Use JBoss Developer Studio or Eclipse to Run the Quickstarts.
If you want to debug the source code of any library in the project, run the following command to pull the source into your local repository. The IDE should then detect it.
mvn dependency:sources