diff --git a/master-docinfo.xml b/master-docinfo.xml new file mode 100755 index 0000000000..819b70d24c --- /dev/null +++ b/master-docinfo.xml @@ -0,0 +1,12 @@ +Red Hat Single Sign-On +7.0.0 +Securing Applications and Services Guide +Securing Applications and Services Guide +7.0.0 + + This guide consist of information for securing applications and services using Red Hat Single Sign-On 7.0.0 + + + Red Hat Customer Content Services + + diff --git a/metadata.ini b/metadata.ini new file mode 100644 index 0000000000..fbb306cc3f --- /dev/null +++ b/metadata.ini @@ -0,0 +1,20 @@ +[source] +language = en-US +type = book +markup = asciidoc + +[metadata] +title = Securing Applications and Services Guide +product = Red Hat Single Sign-On +version = 7.0.0 +edition = +subtitle = +keywords = +abstract = + +[bugs] +reporting_url = +type = +product = +component = Documentation + diff --git a/topics/oidc/java/jboss-adapter.adoc b/topics/oidc/java/jboss-adapter.adoc index 737724b9ef..d7c83276d0 100755 --- a/topics/oidc/java/jboss-adapter.adoc +++ b/topics/oidc/java/jboss-adapter.adoc @@ -174,6 +174,7 @@ public class CustomerService { This section describes how to secure a WAR directly by adding config and editing files within your WAR package. The first thing you must do is create a `keycloak.json` adapter config file within the `WEB-INF` directory of your WAR. + The format of this config file is describe in the <> section. Next you must set the `auth-method` to `KEYCLOAK` in `web.xml`. @@ -259,7 +260,9 @@ This metadata is instead defined within server configuration (i.e. `standalone.x The `secure-deployment` `name` attribute identifies the WAR you want to secure. Its value is the `module-name` defined in `web.xml` with `.war` appended. + The rest of the configuration corresponds pretty much one to one with the `keycloak.json` configuration options defined in <>. + The exception is the `credential` element. To make it easier for you, you can go to the {{book.project.title}} Administration Console and go to the Application/Installation tab of the application this WAR is aligned with. diff --git a/topics/oidc/java/jetty9-adapter.adoc b/topics/oidc/java/jetty9-adapter.adoc index 9aaf122886..bcad9713c5 100755 --- a/topics/oidc/java/jetty9-adapter.adoc +++ b/topics/oidc/java/jetty9-adapter.adoc @@ -58,6 +58,7 @@ This is a Jetty specific config file and you must define a Keycloak specific aut ---- Next you must create a `keycloak.json` adapter config file within the `WEB-INF` directory of your WAR. + The format of this config file is describe in the <> section. WARNING: The Jetty 9.1.x adapter will not be able to find the `keycloak.json` file. @@ -145,4 +146,4 @@ Here's an example: user ----- \ No newline at end of file +---- diff --git a/topics/oidc/java/tomcat-adapter.adoc b/topics/oidc/java/tomcat-adapter.adoc index f07a135e09..096dcc3824 100755 --- a/topics/oidc/java/tomcat-adapter.adoc +++ b/topics/oidc/java/tomcat-adapter.adoc @@ -45,7 +45,8 @@ This is a Tomcat specific config file and you must define a Keycloak specific Va ---- Next you must create a `keycloak.json` adapter config file within the `WEB-INF` directory of your WAR. -The format of this config file is describe in the <> section. + +The format of this config file is describe in the <> Finally you must specify both a `login-config` and use standard servlet security to specify role-base constraints on your URLs. Here's an example: @@ -84,4 +85,4 @@ Here's an example: user ----- \ No newline at end of file +---- diff --git a/topics/oidc/oidc-generic.adoc b/topics/oidc/oidc-generic.adoc index 98bc456da6..46fc8c2397 100644 --- a/topics/oidc/oidc-generic.adoc +++ b/topics/oidc/oidc-generic.adoc @@ -190,4 +190,4 @@ There's also a few special redirect URIs: If its not possible to start a web server in the client (or a browser is not available) it is possible to use the special `urn:ietf:wg:oauth:2.0:oob` redirect uri. When this redirect uri is used Keycloak displays a page with the code in the title and in a box on the page. The application can either detect that the browser title has changed, or the user can copy/paste the code manually to the application. - With this redirect uri it is also possible for a user to use a different device to obtain a code to paste back to the application. \ No newline at end of file + With this redirect uri it is also possible for a user to use a different device to obtain a code to paste back to the application. diff --git a/topics/saml/java/jetty-adapter.adoc b/topics/saml/java/jetty-adapter.adoc index bb342de974..b6d9c0276c 100644 --- a/topics/saml/java/jetty-adapter.adoc +++ b/topics/saml/java/jetty-adapter.adoc @@ -1,4 +1,5 @@ [[_jetty_saml_adapter]] + ==== Jetty SAML Adapters To be able to secure WAR apps deployed on Jetty you must install the {{book.project.name}} Jetty 9.x or 8.x SAML adapter into your Jetty installation.