KEYCLOAK-6439

This commit is contained in:
stianst 2018-01-31 14:35:29 +01:00 committed by Stian Thorgersen
parent d76c686c1e
commit 15b0850d73
5 changed files with 218 additions and 116 deletions

View file

@ -8,6 +8,7 @@ include::topics/oidc/oidc-overview.adoc[]
include::topics/oidc/java/java-adapters.adoc[]
include::topics/oidc/java/java-adapter-config.adoc[]
include::topics/oidc/java/jboss-adapter.adoc[]
include::topics/oidc/java/jboss-adapter-rpms.adoc[]
include::topics/oidc/java/fuse-adapter.adoc[]
include::topics/oidc/java/fuse/install-feature.adoc[]
include::topics/oidc/java/fuse/classic-war.adoc[]
@ -64,6 +65,7 @@ include::topics/saml/java/general-config/idp_keys_subelement.adoc[]
include::topics/saml/java/general-config/idp_httpclient_subelement.adoc[]
include::topics/saml/java/saml-jboss-adapter.adoc[]
include::topics/saml/java/jboss-adapter/jboss_adapter_installation.adoc[]
include::topics/saml/java/jboss-adapter/jboss-adapter-rpms.adoc[]
include::topics/saml/java/jboss-adapter/required_per_war_configuration.adoc[]
include::topics/saml/java/jboss-adapter/securing_wars.adoc[]
ifeval::[{project_community}==true]

View file

@ -0,0 +1,75 @@
[[_jboss_adapter_rpm]]
==== Installing JBoss EAP Adapter from an RPM
Install the EAP 7 Adapters from an RPM:
NOTE: With Red Hat Enterprise Linux 7, the term channel was replaced with the term repository. In these instructions only the term repository is used.
You must subscribe to the JBoss EAP 7.0 repository before you can install the EAP 7 adapters from an RPM.
.Prerequisites
. Ensure that your Red Hat Enterprise Linux system is registered to your account using Red Hat Subscription Manager. For more information see the link:https://access.redhat.com/documentation/en-us/red_hat_subscription_management/1/html-single/quick_registration_for_rhel/index[Red Hat Subscription Management documentation].
. If you are already subscribed to another JBoss EAP repository, you must unsubscribe from that repository first.
Using Red Hat Subscription Manager, subscribe to the JBoss EAP 7.0 repository using the following command. Replace <RHEL_VERSION> with either 6 or 7 depending on your Red Hat Enterprise Linux version.
----
$ sudo subscription-manager repos --enable=jb-eap-7-for-rhel-<RHEL_VERSION>-server-rpms
----
Install the EAP 7 adapters for OIDC using the following command:
----
$ sudo yum install eap7-keycloak-adapter-sso7_2
----
NOTE: The default EAP_HOME path for the RPM installation is /opt/rh/eap7/root/usr/share/wildfly.
Run the appropriate module installation script.
For the OIDC module, enter the following command:
----
$ {EAP_HOME}/bin/jboss-cli.sh -c --file=${EAP_HOME}/bin/adapter-install.cli
----
Your installation is complete.
Install the EAP 6 Adapters from an RPM:
NOTE: With Red Hat Enterprise Linux 7, the term channel was replaced with the term repository. In these instructions only the term repository is used.
You must subscribe to the JBoss EAP 6.0 repository before you can install the EAP 6 adapters from an RPM.
.Prerequisites
. Ensure that your Red Hat Enterprise Linux system is registered to your account using Red Hat Subscription Manager. For more information see the link:https://access.redhat.com/documentation/en-us/red_hat_subscription_management/1/html-single/quick_registration_for_rhel/index[Red Hat Subscription Management documentation].
. If you are already subscribed to another JBoss EAP repository, you must unsubscribe from that repository first.
Using Red Hat Subscription Manager, subscribe to the JBoss EAP 6.0 repository using the following command. Replace <RHEL_VERSION> with either 6 or 7 depending on your Red Hat Enterprise Linux version.
----
$ sudo subscription-manager repos --enable=jb-eap-6-for-rhel-<RHEL_VERSION>-server-rpms
----
Install the EAP 6 adapters for OIDC using the following command:
----
$ sudo yum install keycloak-adapter-sso7_2-eap6
----
NOTE: The default EAP_HOME path for the RPM installation is /opt/rh/eap6/root/usr/share/wildfly.
Run the appropriate module installation script.
For the OIDC module, enter the following command:
----
$ {EAP_HOME}/bin/jboss-cli.sh -c --file=${EAP_HOME}/bin/adapter-install.cli
----
Your installation is complete.

View file

@ -84,53 +84,6 @@ $ cd $EAP_HOME
$ unzip rh-sso-{project_version}-eap7-adapter.zip
----
Install the EAP 7 Adapters from an RPM:
NOTE: With Red Hat Enterprise Linux 7, the term channel was replaced with the term repository. In these instructions only the term repository is used.
You must subscribe to the JBoss EAP 7.0 repository before you can install the EAP 7 adapters from an RPM.
.Prerequisites
. Ensure that your Red Hat Enterprise Linux system is registered to your account using Red Hat Subscription Manager. For more information see the link:https://access.redhat.com/documentation/en-us/red_hat_subscription_management/1/html-single/quick_registration_for_rhel/index[Red Hat Subscription Management documentation].
. If you are already subscribed to another JBoss EAP repository, you must unsubscribe from that repository first.
Using Red Hat Subscription Manager, subscribe to the JBoss EAP 7.0 repository using the following command. Replace <RHEL_VERSION> with either 6 or 7 depending on your Red Hat Enterprise Linux version.
----
$ sudo subscription-manager repos --enable=jb-eap-7-for-rhel-<RHEL_VERSION>-server-rpms
----
Install the EAP 7 adapters for OIDC using the following command:
----
$ sudo yum install eap7-keycloak-adapter-sso7_2
----
Install the EAP 7 adapters for SAML using the following command:
----
$ sudo yum install eap7-keycloak-saml-adapter-sso7_2
----
NOTE: The default EAP_HOME path for the RPM installation is /opt/rh/eap7/root/usr/share/wildfly.
Run the appropriate module installation script.
For the OIDC module, enter the following command:
----
$ {EAP_HOME}/bin/jboss-cli.sh -c --file=${EAP_HOME}/bin/adapter-install.cli
----
For the SAML module, enter the following command:
----
$ {EAP_HOME}/bin/jboss-cli.sh -c --file=${EAP_HOME}/bin/adapter-install-saml.cli
----
Your installation is complete.
Install on JBoss EAP 6:
@ -143,54 +96,6 @@ Install the EAP 6 Adapters from a ZIP File:
$ cd $EAP_HOME
$ unzip rh-sso-{project_version}-eap6-adapter.zip
----
Install the EAP 6 Adapters from an RPM:
NOTE: With Red Hat Enterprise Linux 7, the term channel was replaced with the term repository. In these instructions only the term repository is used.
You must subscribe to the JBoss EAP 6.0 repository before you can install the EAP 6 adapters from an RPM.
.Prerequisites
. Ensure that your Red Hat Enterprise Linux system is registered to your account using Red Hat Subscription Manager. For more information see the link:https://access.redhat.com/documentation/en-us/red_hat_subscription_management/1/html-single/quick_registration_for_rhel/index[Red Hat Subscription Management documentation].
. If you are already subscribed to another JBoss EAP repository, you must unsubscribe from that repository first.
Using Red Hat Subscription Manager, subscribe to the JBoss EAP 6.0 repository using the following command. Replace <RHEL_VERSION> with either 6 or 7 depending on your Red Hat Enterprise Linux version.
----
$ sudo subscription-manager repos --enable=jb-eap-6-for-rhel-<RHEL_VERSION>-server-rpms
----
Install the EAP 6 adapters for OIDC using the following command:
----
$ sudo yum install keycloak-adapter-sso7_2-eap6
----
Install the EAP 6 adapters for SAML using the following command:
----
$ sudo yum install keycloak-saml-adapter-sso7_2-eap6
----
NOTE: The default EAP_HOME path for the RPM installation is /opt/rh/eap6/root/usr/share/wildfly.
Run the appropriate module installation script.
For the OIDC module, enter the following command:
----
$ {EAP_HOME}/bin/jboss-cli.sh -c --file=${EAP_HOME}/bin/adapter-install.cli
----
For the SAML module, enter the following command:
----
$ {EAP_HOME}/bin/jboss-cli.sh -c --file=${EAP_HOME}/bin/adapter-install-saml.cli
----
Your installation is complete.
endif::[]
This ZIP archive contains JBoss Modules specific to the {project_name} adapter. It also contains JBoss CLI scripts to configure the adapter subsystem.
@ -198,20 +103,35 @@ This ZIP archive contains JBoss Modules specific to the {project_name} adapter.
To configure the adapter subsystem if the server is not running execute:
ifeval::[{project_community}==true]
.Wildfly 11
.WildFly 11
[source]
----
$ ./bin/jboss-cli.sh --file=adapter-elytron-install-offline.cli
----
endif::[]
.Any other server but Wildfly 11
.WildFly 10 or older
[source]
----
$ ./bin/jboss-cli.sh --file=adapter-install-offline.cli
----
endif::[]
NOTE: The offline script is not available for JBoss EAP 6
ifeval::[{project_product}==true]
.JBoss EAP 7.1
[source]
----
$ ./bin/jboss-cli.sh --file=adapter-elytron-install-offline.cli
----
.JBoss EAP 7.0
[source]
----
$ ./bin/jboss-cli.sh --file=adapter-install-offline.cli
----
endif::[]
NOTE: The offline script is not available for JBoss EAP 6.4
Alternatively, if the server is running execute:
@ -221,13 +141,28 @@ ifeval::[{project_community}==true]
----
$ ./bin/jboss-cli.sh --file=adapter-elytron-install.cli
----
endif::[]
.Any other server but Wildfly 11
.WildFly 10 or older
[source]
----
$ ./bin/jboss-cli.sh --file=adapter-install.cli
----
endif::[]
ifeval::[{project_product}==true]
.JBoss EAP 7.1
[source]
----
$ ./bin/jboss-cli.sh --file=adapter-elytron-install.cli
----
.JBoss EAP 7.0 and 6.4
[source]
----
$ ./bin/jboss-cli.sh --file=adapter-install.cli
----
endif::[]
===== JBoss SSO

View file

@ -0,0 +1,75 @@
[[_jboss_adapter_rpm]]
==== Installing JBoss EAP Adapter from an RPM
Install the EAP 7 Adapters from an RPM:
NOTE: With Red Hat Enterprise Linux 7, the term channel was replaced with the term repository. In these instructions only the term repository is used.
You must subscribe to the JBoss EAP 7.0 repository before you can install the EAP 7 adapters from an RPM.
.Prerequisites
. Ensure that your Red Hat Enterprise Linux system is registered to your account using Red Hat Subscription Manager. For more information see the link:https://access.redhat.com/documentation/en-us/red_hat_subscription_management/1/html-single/quick_registration_for_rhel/index[Red Hat Subscription Management documentation].
. If you are already subscribed to another JBoss EAP repository, you must unsubscribe from that repository first.
Using Red Hat Subscription Manager, subscribe to the JBoss EAP 7.0 repository using the following command. Replace <RHEL_VERSION> with either 6 or 7 depending on your Red Hat Enterprise Linux version.
----
$ sudo subscription-manager repos --enable=jb-eap-7-for-rhel-<RHEL_VERSION>-server-rpms
----
Install the EAP 7 adapters for SAML using the following command:
----
$ sudo yum install eap7-keycloak-saml-adapter-sso7_2
----
NOTE: The default EAP_HOME path for the RPM installation is /opt/rh/eap7/root/usr/share/wildfly.
Run the appropriate module installation script.
For the SAML module, enter the following command:
----
$ {EAP_HOME}/bin/jboss-cli.sh -c --file=${EAP_HOME}/bin/adapter-install-saml.cli
----
Your installation is complete.
Install the EAP 6 Adapters from an RPM:
NOTE: With Red Hat Enterprise Linux 7, the term channel was replaced with the term repository. In these instructions only the term repository is used.
You must subscribe to the JBoss EAP 6.0 repository before you can install the EAP 6 adapters from an RPM.
.Prerequisites
. Ensure that your Red Hat Enterprise Linux system is registered to your account using Red Hat Subscription Manager. For more information see the link:https://access.redhat.com/documentation/en-us/red_hat_subscription_management/1/html-single/quick_registration_for_rhel/index[Red Hat Subscription Management documentation].
. If you are already subscribed to another JBoss EAP repository, you must unsubscribe from that repository first.
Using Red Hat Subscription Manager, subscribe to the JBoss EAP 6.0 repository using the following command. Replace <RHEL_VERSION> with either 6 or 7 depending on your Red Hat Enterprise Linux version.
----
$ sudo subscription-manager repos --enable=jb-eap-6-for-rhel-<RHEL_VERSION>-server-rpms
----
Install the EAP 6 adapters for SAML using the following command:
----
$ sudo yum install keycloak-saml-adapter-sso7_2-eap6
----
NOTE: The default EAP_HOME path for the RPM installation is /opt/rh/eap6/root/usr/share/wildfly.
Run the appropriate module installation script.
For the SAML module, enter the following command:
----
$ {EAP_HOME}/bin/jboss-cli.sh -c --file=${EAP_HOME}/bin/adapter-install-saml.cli
----
Your installation is complete.

View file

@ -13,10 +13,7 @@ Install on Wildfly 9 or 10, 11 or JBoss EAP 7:
$ cd $WILDFLY_HOME
$ unzip keycloak-saml-wildfly-adapter-dist.zip
----
endif::[]
ifeval::[{project_community}==true]
Install on JBoss EAP 6.x:
[source]
----
@ -27,21 +24,21 @@ $ unzip keycloak-saml-eap6-adapter-dist.zip
endif::[]
ifeval::[{project_product}==true]
Install on JBoss EAP 6.x:
[source]
----
$ cd $JBOSS_HOME
$ unzip rh-sso-saml-eap6-adapter.zip
----
Install on JBoss EAP 7.x:
[source]
----
$ cd $JBOSS_HOME
$ cd $EAP_HOME
$ unzip rh-sso-saml-eap7-adapter.zip
----
Install on JBoss EAP 6.x:
[source]
----
$ cd $EAP_HOME
$ unzip rh-sso-saml-eap6-adapter.zip
----
endif::[]
@ -58,15 +55,33 @@ ifeval::[{project_community}==true]
----
$ ./bin/jboss-cli.sh --file=adapter-elytron-install-saml.cli
----
endif::[]
.Any other server but Wildfly 11
.WildFly 10 and older
[source]
----
$ cd $JBOSS_HOME/bin
$ jboss-cli.sh -c --file=adapter-install-saml.cli
----
----
endif::[]
ifeval::[{project_product}==true]
.JBoss EAP 7.1
[source]
----
$ ./bin/jboss-cli.sh --file=adapter-elytron-install-saml.cli
----
.JBoss EAP 7.0 and EAP 6
[source]
----
$ cd $JBOSS_HOME/bin
$ jboss-cli.sh -c --file=adapter-install-saml.cli
----
endif::[]
The script will add the extension, subsystem, and optional security-domain as described below.
[source,xml]