mirror of
https://github.com/keycloak/keycloak.git
synced 2026-06-08 16:42:13 -04:00
Update EAP documentation for OIDC and SAML (#24734)
* Update EAP documentation for OIDC and SAML Signed-off-by: stianst <stianst@gmail.com> * Add note that only Spring Boot 2 is supported by RH-SSO adapters Signed-off-by: stianst <stianst@gmail.com> * Update docs/documentation/securing_apps/topics/oidc/java/java-adapters-product.adoc Co-authored-by: andymunro <48995441+andymunro@users.noreply.github.com> * Update docs/documentation/securing_apps/topics/oidc/java/java-adapters-product.adoc Co-authored-by: andymunro <48995441+andymunro@users.noreply.github.com> * Update docs/documentation/securing_apps/topics/oidc/java/java-adapters-product.adoc Co-authored-by: andymunro <48995441+andymunro@users.noreply.github.com> * Update docs/documentation/securing_apps/topics/oidc/java/java-adapters-product.adoc Co-authored-by: andymunro <48995441+andymunro@users.noreply.github.com> * Update docs/documentation/securing_apps/topics/saml/java/java-adapters-product.adoc Co-authored-by: andymunro <48995441+andymunro@users.noreply.github.com> --------- Signed-off-by: stianst <stianst@gmail.com> Co-authored-by: andymunro <48995441+andymunro@users.noreply.github.com>
This commit is contained in:
Stian Thorgersen
GitHub
parent
1359ea5332
commit
d7f2ad747d
4 changed files with 107 additions and 43 deletions
|
|
@ -15,6 +15,9 @@ include::topics/oidc/supported-grant-types.adoc[]
|
|||
ifeval::[{project_community}==true]
|
||||
include::topics/oidc/java/java-adapters.adoc[]
|
||||
endif::[]
|
||||
ifeval::[{project_product}==true]
|
||||
include::topics/oidc/java/java-adapters-product.adoc[]
|
||||
endif::[]
|
||||
|
||||
include::topics/oidc/javascript-adapter.adoc[]
|
||||
|
||||
|
|
@ -29,51 +32,14 @@ include::topics/oidc/fapi-support.adoc[]
|
|||
include::topics/oidc/recommendations.adoc[]
|
||||
|
||||
include::topics/saml/saml-overview.adoc[]
|
||||
ifeval::[{project_community}==true]
|
||||
include::topics/saml/java/java-adapters.adoc[]
|
||||
include::topics/saml/java/general-config.adoc[]
|
||||
include::topics/saml/java/general-config/sp_element.adoc[]
|
||||
include::topics/saml/java/general-config/sp-keys.adoc[]
|
||||
include::topics/saml/java/general-config/sp-keys/keystore_element.adoc[]
|
||||
include::topics/saml/java/general-config/sp-keys/key_pems.adoc[]
|
||||
include::topics/saml/java/general-config/sp_principalname_mapping_element.adoc[]
|
||||
include::topics/saml/java/general-config/roleidentifiers_element.adoc[]
|
||||
include::topics/saml/java/general-config/sp_role_mappings_provider_element.adoc[]
|
||||
include::topics/saml/java/general-config/idp_element.adoc[]
|
||||
include::topics/saml/java/general-config/idp_allowedclockskew_subelement.adoc[]
|
||||
include::topics/saml/java/general-config/idp_singlesignonservice_subelement.adoc[]
|
||||
include::topics/saml/java/general-config/idp_singlelogoutservice_subelement.adoc[]
|
||||
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-samesite-setting.adoc[]
|
||||
|
||||
ifeval::[{project_product}==true]
|
||||
include::topics/saml/java/jboss-adapter/jboss-adapter-rpms.adoc[]
|
||||
endif::[]
|
||||
include::topics/saml/java/jboss-adapter/required_per_war_configuration.adoc[]
|
||||
include::topics/saml/java/jboss-adapter/securing_wars.adoc[]
|
||||
ifeval::[{project_community}==true]
|
||||
include::topics/saml/java/tomcat-adapter.adoc[]
|
||||
include::topics/saml/java/tomcat-adapter/tomcat_adapter_installation.adoc[]
|
||||
include::topics/saml/java/tomcat-adapter/tomcat_adapter_per_war_config.adoc[]
|
||||
include::topics/saml/java/tomcat-adapter/tomcat-adapter-samesite-setting.adoc[]
|
||||
include::topics/saml/java/jetty-adapter.adoc[]
|
||||
include::topics/saml/java/jetty-adapter/jetty9_installation.adoc[]
|
||||
include::topics/saml/java/jetty-adapter/jetty9_per_war_config.adoc[]
|
||||
endif::[]
|
||||
|
||||
include::topics/saml/java/servlet-filter-adapter.adoc[]
|
||||
include::topics/saml/java/idp-registration.adoc[]
|
||||
include::topics/saml/java/logout.adoc[]
|
||||
include::topics/saml/java/assertion-api.adoc[]
|
||||
include::topics/saml/java/error_handling.adoc[]
|
||||
include::topics/saml/java/debugging.adoc[]
|
||||
include::topics/saml/java/multi-tenancy.adoc[]
|
||||
ifeval::[{project_community}==true]
|
||||
include::topics/saml/java/MigrationFromOlderVersions.adoc[]
|
||||
endif::[]
|
||||
include::topics/saml/mod-auth-mellon.adoc[]
|
||||
endif::[]
|
||||
ifeval::[{project_product}==true]
|
||||
include::topics/saml/java/java-adapters-product.adoc[]
|
||||
endif::[]
|
||||
|
||||
include::topics/docker/docker-overview.adoc[]
|
||||
include::topics/client-registration.adoc[]
|
||||
include::topics/client-registration/client-registration-cli.adoc[]
|
||||
|
|
|
|||
|
|
@ -0,0 +1,35 @@
|
|||
=== {project_name} Java adapters
|
||||
|
||||
==== Red Hat JBoss Enterprise Application Platform
|
||||
|
||||
{project_name} does not include any adapters for Red Hat JBoss Enterprise Application Platform. However, there are
|
||||
alternatives for existing applications deployed to Red Hat JBoss Enterprise Application Platform.
|
||||
|
||||
===== 8.0 Beta
|
||||
|
||||
Red Hat Enterprise Application Platform 8.0 Beta provides a native OpenID Connect client through the Elytron OIDC client
|
||||
subsystem.
|
||||
|
||||
For more information, see the https://access.redhat.com/documentation/en-us/red_hat_jboss_enterprise_application_platform/8-beta/html/using_single_sign-on_with_jboss_eap/index[Red Hat JBoss Enterprise Application Platform documentation].
|
||||
|
||||
===== 6.4 and 7.x
|
||||
|
||||
Existing applications deployed to Red Hat JBoss Enterprise Application Platform 6.4 and 7.x can leverage adapters from
|
||||
Red Hat Single Sign-On 7.6 in combination with the {project_name} server.
|
||||
|
||||
For more information, see the
|
||||
https://access.redhat.com/documentation/en-us/red_hat_single_sign-on/7.6/html/securing_applications_and_services_guide/oidc#jboss_adapter[Red Hat Single Sign-On documentation].
|
||||
|
||||
|
||||
==== Spring Boot adapter
|
||||
|
||||
{project_name} does not include any adapters for Spring Boot. However, there are
|
||||
alternatives for existing applications built with Spring Boot.
|
||||
|
||||
Spring Security provides comprehensive support for OAuth 2 and OpenID Connect. For more information, see the
|
||||
https://spring.io/projects/spring-security[Spring Security documentation].
|
||||
|
||||
Alternatively, for Spring Boot 2.x the Spring Boot adapter from Red Hat Single Sign-On 7.6 can be used in combination with the {project_name} server. For more information, see the
|
||||
https://access.redhat.com/documentation/en-us/red_hat_single_sign-on/7.6/html/securing_applications_and_services_guide/oidc#jboss_adapter[Red Hat Single Sign-On documentation].
|
||||
|
||||
|
||||
|
|
@ -0,0 +1,19 @@
|
|||
|
||||
=== {project_name} Java adapters
|
||||
|
||||
{project_name} comes with a range of different adapters for Java application. Selecting the correct adapter depends on the target platform.
|
||||
|
||||
==== Red Hat JBoss Enterprise Application Platform
|
||||
|
||||
===== 8.0 Beta
|
||||
|
||||
{project_name} provides a SAML adapter for Red Hat Enterprise Application Platform 8.0 Beta. However, the documentation
|
||||
is not currently available, and will be added in the near future.
|
||||
|
||||
===== 6.4 and 7.x
|
||||
|
||||
Existing applications deployed to Red Hat JBoss Enterprise Application Platform 6.4 and 7.x can leverage adapters from
|
||||
Red Hat Single Sign-On 7.6 in combination with the {project_name} server.
|
||||
|
||||
For more information, see the
|
||||
https://access.redhat.com/documentation/en-us/red_hat_single_sign-on/7.6/html/securing_applications_and_services_guide/using_saml_to_secure_applications_and_services#saml_jboss_adapter[Red Hat Single Sign-On documentation].
|
||||
|
|
@ -2,3 +2,47 @@
|
|||
=== {project_name} Java adapters
|
||||
|
||||
{project_name} comes with a range of different adapters for Java application. Selecting the correct adapter depends on the target platform.
|
||||
|
||||
include::general-config.adoc[]
|
||||
include::general-config/sp_element.adoc[]
|
||||
include::general-config/sp-keys.adoc[]
|
||||
include::general-config/sp-keys/keystore_element.adoc[]
|
||||
include::general-config/sp-keys/key_pems.adoc[]
|
||||
include::general-config/sp_principalname_mapping_element.adoc[]
|
||||
include::general-config/roleidentifiers_element.adoc[]
|
||||
include::general-config/sp_role_mappings_provider_element.adoc[]
|
||||
include::general-config/idp_element.adoc[]
|
||||
include::general-config/idp_allowedclockskew_subelement.adoc[]
|
||||
include::general-config/idp_singlesignonservice_subelement.adoc[]
|
||||
include::general-config/idp_singlelogoutservice_subelement.adoc[]
|
||||
include::general-config/idp_keys_subelement.adoc[]
|
||||
include::general-config/idp_httpclient_subelement.adoc[]
|
||||
include::saml-jboss-adapter.adoc[]
|
||||
include::jboss-adapter/jboss_adapter_installation.adoc[]
|
||||
include::jboss-adapter/jboss-adapter-samesite-setting.adoc[]
|
||||
|
||||
ifeval::[{project_product}==true]
|
||||
include::jboss-adapter/jboss-adapter-rpms.adoc[]
|
||||
endif::[]
|
||||
include::jboss-adapter/required_per_war_configuration.adoc[]
|
||||
include::jboss-adapter/securing_wars.adoc[]
|
||||
ifeval::[{project_community}==true]
|
||||
include::tomcat-adapter.adoc[]
|
||||
include::tomcat-adapter/tomcat_adapter_installation.adoc[]
|
||||
include::tomcat-adapter/tomcat_adapter_per_war_config.adoc[]
|
||||
include::tomcat-adapter/tomcat-adapter-samesite-setting.adoc[]
|
||||
include::jetty-adapter.adoc[]
|
||||
include::jetty-adapter/jetty9_installation.adoc[]
|
||||
include::jetty-adapter/jetty9_per_war_config.adoc[]
|
||||
endif::[]
|
||||
|
||||
include::servlet-filter-adapter.adoc[]
|
||||
include::idp-registration.adoc[]
|
||||
include::logout.adoc[]
|
||||
include::assertion-api.adoc[]
|
||||
include::error_handling.adoc[]
|
||||
include::debugging.adoc[]
|
||||
include::multi-tenancy.adoc[]
|
||||
ifeval::[{project_community}==true]
|
||||
include::MigrationFromOlderVersions.adoc[]
|
||||
endif::[]
|
||||
Loading…
Reference in a new issue