== Advanced Concepts These cover additional configuration topics, such as seting up keystores and a truststore for the {project_name_abbr} server, creating an administrator account, an overview of available {project_name_abbr} client registration methods, and guidance on configuring clustering. === Requirements and Deploying xref:../introduction/introduction.adoc#passthrough-templates[Passthrough TLS Termination] {project_name_abbr} Templates ==== Preparing the Deployment Log in to the OpenShift CLI with a user that holds the _cluster:admin_ role. . Create a new project: + [subs="verbatim,macros,attributes"] ---- $ oc new-project sso-app-demo ---- . Add the `view` role to the link:https://docs.openshift.com/container-platform/latest/dev_guide/service_accounts.html#default-service-accounts-and-roles[`default`] service account. This enables the service account to view all the resources in the sso-app-demo namespace, which is necessary for managing the cluster. + [subs="verbatim,macros,attributes"] ---- $ oc policy add-role-to-user view system:serviceaccount:$(oc project -q):default ---- [[advanced-concepts-Configuring-Keystores]] ==== Creating HTTPS and JGroups Keystores, and Truststore for the {project_name_abbr} Server The {project_name_abbr} application templates using xref:../introduction/introduction.adoc#passthrough-templates[passthrough TLS termination] require: * An xref:create-https-keystore[HTTPS keystore] used for encryption of https traffic, * The xref:create-jgroups-keystore[JGroups keystore] used for encryption of JGroups communications between nodes in the cluster, and * xref:create-server-truststore[{project_name_abbr} server truststore] used for securing the {project_name_abbr} requests the {project_openshift_product_name} image to be deployed properly. [IMPORTANT] ==== The {project_name_abbr} application templates using xref:../introduction/introduction.adoc#reencrypt-templates[re-encryption TLS termination] do not *require* or *expect* the aforementioned HTTPS and JGroups keystores and {project_name_abbr} server truststore to be prepared beforehand. The templates use OpenShift's internal link:https://docs.openshift.com/container-platform/latest/dev_guide/secrets.html#service-serving-certificate-secrets[service serving x509 certificate secrets] to automatically create the HTTPS and JGroups keystores. The {project_name_abbr} server truststore is also created automatically, containing the */var/run/secrets/kubernetes.io/serviceaccount/service-ca.crt* CA certificate file, which is used to create these cluster certificates. Moreover, the truststore for the {project_name_abbr} server is pre-populated with the all known, trusted CA certificate files found in the Java system path. ==== The *_openssl_* toolkit is used in the following example to generate a CA certificate to sign the HTTPS keystore, and create a truststore for the {project_name_abbr} server. *_keytool_*, a package *included with the Java Development Kit*, is then utilized to the generate self-signed certificates for these keystores. [WARNING] ==== For production environments Red Hat recommends that you use your own SSL certificate purchased from a verified Certificate Authority (CA) for SSL-encrypted connections (HTTPS). See the https://access.redhat.com/documentation/en-us/jboss_enterprise_application_platform/6.1/html-single/security_guide/index#Generate_a_SSL_Encryption_Key_and_Certificate[JBoss Enterprise Application Platform Security Guide] for more information on how to create a keystore with self-signed or purchased SSL certificates. ==== [[create-https-keystore]] *_Create the HTTPS keystore:_* [[generate-ca-certificate]] .. Generate a CA certificate. Pick and remember the password. Provide identical password, when xref:signing-csr-with-ca-certificate[signing the certificate sign request with the CA certificate] below: + [subs="verbatim,macros,attributes"] ---- $ openssl req -new -newkey rsa:4096 -x509 -keyout xpaas.key -out xpaas.crt -days 365 -subj "/CN=xpaas-sso-demo.ca" ---- .. Generate a CA certificate for the HTTPS keystore. Provide `mykeystorepass` as the keystore password: + [subs="verbatim,macros,attributes"] ---- $ keytool -genkeypair -keyalg RSA -keysize 2048 -dname "CN=secure-sso-sso-app-demo.openshift.example.com" -alias jboss -keystore keystore.jks ---- .. Generate a certificate sign request for the HTTPS keystore. Provide `mykeystorepass` as the keystore password: + [subs="verbatim,macros,attributes"] ---- $ keytool -certreq -keyalg rsa -alias jboss -keystore keystore.jks -file sso.csr ---- [[signing-csr-with-ca-certificate]] [start=4] .. Sign the certificate sign request with the CA certificate. Provide the same password that was used to xref:generate-ca-certificate[generate the CA certificate]: + [subs="verbatim,macros,attributes"] ---- $ openssl x509 -req -CA xpaas.crt -CAkey xpaas.key -in sso.csr -out sso.crt -days 365 -CAcreateserial ---- .. Import the CA certificate into the HTTPS keystore. Provide `mykeystorepass` as the keystore password. Reply `yes` to `Trust this certificate? [no]:` question: + [subs="verbatim,macros,attributes"] ---- $ keytool -import -file xpaas.crt -alias xpaas.ca -keystore keystore.jks ---- .. Import the signed certificate sign request into the HTTPS keystore. Provide `mykeystorepass` as the keystore password: + [subs="verbatim,macros,attributes"] ---- $ keytool -import -file sso.crt -alias jboss -keystore keystore.jks ---- [[create-jgroups-keystore]] *_Generate a secure key for the JGroups keystore:_* Provide `password` as the keystore password: [subs="verbatim,macros,attributes"] ---- $ keytool -genseckey -alias secret-key -storetype JCEKS -keystore jgroups.jceks ---- [[create-server-truststore]] *_Import the CA certificate into a new {project_name_abbr} server truststore:_* Provide `mykeystorepass` as the truststore password. Reply `yes` to `Trust this certificate? [no]:` question: [subs="verbatim,macros,attributes"] ---- $ keytool -import -file xpaas.crt -alias xpaas.ca -keystore truststore.jks ---- [[Configuring-Secrets]] ==== Secrets OpenShift uses objects called link:https://docs.openshift.com/container-platform/latest/dev_guide/secrets.html[secrets] to hold sensitive information, such as passwords or keystores. . Create the secrets for the HTTPS and JGroups keystores, and {project_name_abbr} server truststore, generated in the xref:Configuring-Keystores[previous section]. + [subs="verbatim,macros,attributes"] ---- $ oc secret new sso-app-secret keystore.jks jgroups.jceks truststore.jks ---- . Link these secrets to the link:https://docs.openshift.com/container-platform/latest/dev_guide/service_accounts.html#default-service-accounts-and-roles[default] service account, which is used to run {project_name_abbr} pods. + [subs="verbatim,macros,attributes"] ---- $ oc secrets link default sso-app-secret ---- ==== Deploying the Chosen {project_name_abbr} Passthrough TLS Template via OpenShift CLI After the aforementioned xref:Configuring-Keystores[keystores] and xref:Configuring-Secrets[secrets] are created, deploy some of the available xref:../introduction/introduction.adoc#passthrough-templates[passthrough TLS termination] as follows: [WARNING] ==== For simplicity, the values of *_SSO_ADMIN_USERNAME_*, *_SSO_ADMIN_PASSWORD_*, *_HTTPS_PASSWORD_*, *_JGROUPS_ENCRYPT_PASSWORD_*, and *_SSO_TRUSTSTORE_PASSWORD_* variables xref:advanced-topics-deploy-{project_templates_version}-https-template[in the following command] have been chosen to match the default values of the respective parameters of the *_{project_templates_version}-https_* {project_name_abbr} application template. For production environments, Red Hat recommends that you consult the on-site policy, specific to your organization for guidance on how to generate sufficiently strong user name and password for the administrator user account of the {project_name_abbr} server, and passwords for the HTTPS and JGroups keystores, and the truststore of the {project_name_abbr} server. Be aware that *the passwords provided when provisioning the template need to match the passwords provided when creating the keystores*. If using different username and passwords, modify the values of respective xref:advanced-topics-deploy-{project_templates_version}-https-template[template parameters] as appropriate for your environment. ==== [NOTE] ==== The following commands using the *_keytool_*, a package *included with the Java Development Kit*, can be used to determine the names associated with the certificate: [subs="verbatim,macros,attributes"] ---- $ keytool -v -list -keystore keystore.jks | grep Alias Enter keystore password: mykeystorepass Alias name: xpaas.ca Alias name: jboss ---- [subs="verbatim,macros,attributes"] ---- $ keytool -v -list -keystore jgroups.jceks -storetype jceks | grep Alias Enter keystore password: password Alias name: secret-key ---- Finally, the *_SSO_ADMIN_USERNAME_*, *_SSO_ADMIN_PASSWORD_*, and the *_SSO_REALM_* template parameters in the following command are optional. ==== [[advanced-topics-deploy-{project_templates_version}-https-template]] [subs="verbatim,macros,attributes"] ---- $ oc new-app --template={project_templates_version}-https \ -p HTTPS_SECRET="sso-app-secret" \ -p HTTPS_KEYSTORE="keystore.jks" \ -p HTTPS_NAME="jboss" \ -p HTTPS_PASSWORD="mykeystorepass" \ -p JGROUPS_ENCRYPT_SECRET="sso-app-secret" \ -p JGROUPS_ENCRYPT_KEYSTORE="jgroups.jceks" \ -p JGROUPS_ENCRYPT_NAME="secret-key" \ -p JGROUPS_ENCRYPT_PASSWORD="password" \ -p SSO_ADMIN_USERNAME="admin" \ -p SSO_ADMIN_PASSWORD="redhat" \ -p SSO_REALM="demorealm" \ -p SSO_TRUSTSTORE="truststore.jks" \ -p SSO_TRUSTSTORE_PASSWORD="mykeystorepass" \ -p SSO_TRUSTSTORE_SECRET="sso-app-secret" --> Deploying template "openshift/{project_templates_version}-https" to project sso-app-demo {project_name} {project_version} (Ephemeral with passthrough TLS) --------- An example {project_name_abbr} 7 application. For more information about using this template, see https://github.com/jboss-openshift/application-templates. A new {project_name_abbr} service has been created in your project. The admin username/password for accessing the master realm via the {project_name_abbr} console is admin/redhat. Please be sure to create the following secrets: "sso-app-secret" containing the keystore.jks file used for serving secure content; "sso-app-secret" containing the jgroups.jceks file used for securing JGroups communications; "sso-app-secret" containing the truststore.jks file used for securing {project_name_abbr} requests. * With parameters: * Application Name=sso * Custom http Route Hostname= * Custom https Route Hostname= * Server Keystore Secret Name=sso-app-secret * Server Keystore Filename=keystore.jks * Server Keystore Type= * Server Certificate Name=jboss * Server Keystore Password=mykeystorepass * Datasource Minimum Pool Size= * Datasource Maximum Pool Size= * Datasource Transaction Isolation= * JGroups Secret Name=sso-app-secret * JGroups Keystore Filename=jgroups.jceks * JGroups Certificate Name=secret-key * JGroups Keystore Password=password * JGroups Cluster Password=yeSppLfp # generated * ImageStream Namespace=openshift * {project_name_abbr} Administrator Username=admin * {project_name_abbr} Administrator Password=redhat * {project_name_abbr} Realm=demorealm * {project_name_abbr} Service Username= * {project_name_abbr} Service Password= * {project_name_abbr} Trust Store=truststore.jks * {project_name_abbr} Trust Store Password=mykeystorepass * {project_name_abbr} Trust Store Secret=sso-app-secret * Container Memory Limit=1Gi --> Creating resources ... service "sso" created service "secure-sso" created service "sso-ping" created route "sso" created route "secure-sso" created deploymentconfig "sso" created --> Success Run 'oc status' to view your app. ---- ==== Accessing the Administrator Console of the {project_name_abbr} Pod After the template got deployed, identify the available routes: [subs="verbatim,macros,attributes"] ---- $ oc get routes ---- [cols="7",options="header"] |=== |NAME |HOST/PORT |PATH |SERVICES |PORT |TERMINATION |WILDCARD |secure-sso |secure-sso-sso-app-demo.openshift.example.com | |secure-sso | |passthrough |None |sso |sso-sso-app-demo.openshift.example.com | |sso | | |None |=== and access the {project_name_abbr} administrator console at: * *\https://secure-sso-sso-app-demo.openshift.example.com/auth/admin* * *\http://sso-sso-app-demo.openshift.example.com/auth/admin* using the xref:../advanced_concepts/advanced_concepts.adoc#advanced-concepts-sso-administrator-setup[administrator account]. [[advanced-concepts-sso-hostname-spi-setup]] === Customizing Hostname for the {project_name} Server The hostname SPI introduced a flexible way to configure the hostname for the {project_name} server. There are two built-in providers. The first is `request`, which uses the request headers to determine the hostname. This is the *default setting* for {project_openshift_product_name} image. The second is `fixed`, which allows configuring a fixed hostname. The latter makes sure that only valid hostnames can be used and allows internal applications to invoke {project_name} server through an alternative URL. Run the following commands to set the `fixed` hostname SPI provider for the {project_name} server: . Deploy the {project_openshift_product_name} image with *_SSO_HOSTNAME_* environment variable set to the desired hostname of the {project_name} server. + ---- $ oc new-app --template=sso-cd-x509-https \ -p SSO_HOSTNAME="rh-sso-server.openshift.example.com" ---- . Identify the name of the route for the {project_name} service. + ---- $ oc get routes ---- + [cols="7",options="header"] |=== |NAME |HOST/PORT |PATH |SERVICES |PORT |TERMINATION |WILDCARD |sso |sso-sso-app-demo.openshift.example.com | |sso | |reencrypt |None |=== . Change the `host:` field to match the hostname specified as the value of the *_SSO_HOSTNAME_* environment variable above. + [NOTE] ==== Adjust the `rh-sso-server.openshift.example.com` value in the following command as necessary. ==== + ---- $ oc patch route/sso --type=json -p '[{"op": "replace", "path": "/spec/host", "value": "rh-sso-server.openshift.example.com"}]' ---- + If successful, the previous command will return the following output: + ---- route "sso" patched ---- [[advanced-concepts-sso-administrator-setup]] === Creating Administrator Account for Red Hat Single Sign-On Server Red Hat Single Sign-On does not provide any pre-configured management account out of the box. This administrator account is necessary for logging into the `master` realm's management console and perform server maintenance operations such as, creating realms or users, or registering applications intended to be secured by Red Hat Single Sign-On. The administrator account can be created: * By providing values for the xref:sso-admin-template-parameters[*_SSO_ADMIN_USERNAME_* and *_SSO_ADMIN_PASSWORD_* parameters], when deploying the {project_name_abbr} application template, or * By xref:sso-admin-remote-shell[a remote shell session to particular {project_name_abbr} pod], if the {project_openshift_product_name} image is deployed without an application template. [NOTE] ==== Red Hat Single Sign-On allows an initial administrator account to be created via the link:https://access.redhat.com/documentation/en-us/red_hat_single_sign-on/7.2/html-single/getting_started_guide/#creating_the_admin_account[Welcome Page] web form, but only if the Welcome Page is accessed from localhost; this method of administrator account creation is not applicable for the {project_openshift_product_name} image. ==== [[advanced-concepts-sso-admin-template-parameters]] ==== Creating {project_name_abbr} Administrator Account via Template Parameters When deploying {project_name_abbr} application template, *_SSO_ADMIN_USERNAME_* and *_SSO_ADMIN_PASSWORD_* parameters denote the username and password of the {project_name_abbr} server's administrator account to be created for the `master` realm. [NOTE] ==== *Both of these parameters are required.* If not specified, they are auto generated and displayed as an OpenShift instructional message when the template is instantiated. ==== [IMPORTANT] ==== The lifespan of the {project_name_abbr} server's administrator account depends upon the storage type used to store the {project_name_abbr} server's database: * For an in-memory database mode (*_{project_templates_version}-https_* and *_{project_templates_version}-x509-https_* templates) the account exists throughout the lifecycle of the particular {project_name_abbr} pod (stored account data is lost upon pod destruction), * For an ephemeral database mode (*_{project_templates_version}-mysql_* and *_{project_templates_version}-postgresql_* templates) the account exists throughout the lifecycle of the database pod (even if the {project_name_abbr} pod is destructed, the stored account data is preserved under the assumption that the database pod is still running), * For persistent database mode (*_{project_templates_version}-mysql-persistent_*, *_{project_templates_version}-x509-mysql-persistent_*, *_{project_templates_version}-postgresql-persistent_*, and *_{project_templates_version}-x509-postgresql-persistent_* templates) the account exists throughout the lifecycle of the persistent medium used to hold the database data. This means that the stored account data is preserved even when both the {project_name_abbr} and the database pods are destructed. It is a common practice to deploy an {project_name_abbr} application template to get the corresponding OpenShift deployment config for the application, and then reuse that deployment config multiple times (every time a new {project_name_abbr} application needs to be instantiated). ==== [WARNING] ==== In the case of *ephemeral or persistent database mode*, after creating the RH_SSO server's administrator account, remove the *_SSO_ADMIN_USERNAME_* and *_SSO_ADMIN_PASSWORD_* variables from the deployment config before deploying new {project_name_abbr} applications. ==== [IMPORTANT] ==== Run the following commands to prepare the previously created deployment config of the {project_name_abbr} application for reuse after the administrator account has been created: . Identify the deployment config of the {project_name_abbr} application. + [subs="verbatim,macros,attributes"] ---- $ oc get dc -o name deploymentconfig/sso deploymentconfig/sso-mysql ---- . Clear the *_SSO_ADMIN_USERNAME_* and *_SSO_ADMIN_PASSWORD_* variables setting. + [subs="verbatim,macros,attributes"] ---- $ oc env dc/sso -e SSO_ADMIN_USERNAME="" SSO_ADMIN_PASSWORD="" ---- ==== [[advanced-concepts-sso-admin-remote-shell]] ==== Creating {project_name_abbr} Administrator Account via Remote Shell Session to {project_name_abbr} Pod Run following commands to create an administrator account for the `master` realm of the {project_name_abbr} server, when deploying the {project_openshift_product_name} image directly from the image stream (without the xref:../introduction/introduction.adoc#sso-templates[template]), after the {project_name_abbr} application pod has been started: . Identify the {project_name_abbr} application pod. + [subs="verbatim,macros,attributes"] ---- $ oc get pods NAME READY STATUS RESTARTS AGE sso-12-pt93n 1/1 Running 0 1m sso-mysql-6-d97pf 1/1 Running 0 2m ---- . Open a remote shell session to the {project_openshift_product_name} container. + [subs="verbatim,macros,attributes"] ---- $ oc rsh sso-12-pt93n sh-4.2$ ---- . Create the {project_name_abbr} server administrator account for the `master` realm at the command line with the `add-user-keycloak.sh` script. + [subs="verbatim,macros,attributes"] ---- sh-4.2$ cd /opt/eap/bin/ sh-4.2$ ./add-user-keycloak.sh -r master -u sso_admin -p sso_password Added 'sso_admin' to '/opt/eap/standalone/configuration/keycloak-add-user.json', restart server to load user ---- + [NOTE] ==== The `sso_admin`/`sso_password` credentials in the example above are for demonstration purposes only. Refer to the password policy applicable within your organization for guidance on how to create a secure user name and password. ==== . Restart the underlying JBoss EAP server instance to load the newly added user account. Wait for the server to restart properly. + [subs="verbatim,macros,attributes"] ---- sh-4.2$ ./jboss-cli.sh --connect ':reload' { "outcome" => "success", "result" => undefined } ---- + [WARNING] ==== When restarting the server it is important to restart just the JBoss EAP process within the running {project_name_abbr} container, and not the whole container. This is because restarting the whole container will recreate it from scratch, without the {project_name_abbr} server administration account for the `master` realm. ==== . Log in to the `master` realm's administration console of the {project_name_abbr} server using the credentials created in the steps above. In the browser, navigate to *\http://sso-./auth/admin* for the {project_name_abbr} web server, or to *\https://secure-sso-./auth/admin* for the encrypted {project_name_abbr} web server, and specify the user name and password used to create the administrator user. === Deployment Process Once deployed, the *_{project_templates_version}-https_* and *_{project_templates_version}-x509-https_* templates create a single pod that contains both the database and the {project_name_abbr} servers. The *_{project_templates_version}-mysql_*, *_{project_templates_version}-mysql-persistent_*, *_{project_templates_version}-x509-mysql-persistent_*, *_{project_templates_version}-postgresql_*, *_{project_templates_version}-postgresql-persistent_*, and *_{project_templates_version}-x509-postgresql-persistent_* templates create two pods, one for the database server and one for the {project_name_abbr} web server. After the {project_name_abbr} web server pod has started, it can be accessed from its custom configured hostnames, or from the default hostnames: * *\http://sso-__.__/auth/admin*: for the {project_name_abbr} web server, and * *\https://secure-sso-__.__/auth/admin*: for the encrypted {project_name_abbr} web server. Use the xref:../advanced_concepts/advanced_concepts.adoc#advanced-concepts-sso-administrator-setup[administrator user credentials] to log in into the `master` realm’s administration console. [[advanced-concepts-SSO-Clients]] === {project_name_abbr} Clients Clients are {project_name_abbr} entities that request user authentication. A client can be an application requesting {project_name_abbr} to provide user authentication, or it can make requests for access tokens to start services on behalf of an authenticated user. See the link:https://access.redhat.com/documentation/en-us/red_hat_single_sign-on/7.2/html/server_administration_guide/clients[Managing Clients chapter of the Red Hat Single Sign-On documentation] for more information. {project_name_abbr} provides link:https://access.redhat.com/documentation/en-us/red_hat_single_sign-on/7.2/html/server_administration_guide/clients#oidc_clients[OpenID-Connect] and link:https://access.redhat.com/documentation/en-us/red_hat_single_sign-on/7.2/html/server_administration_guide/clients#saml_clients[SAML] client protocols. + OpenID-Connect is the preferred protocol and utilizes three different access types: - *public*: Useful for JavaScript applications that run directly in the browser and require no server configuration. - *confidential*: Useful for server-side clients, such as EAP web applications, that need to perform a browser login. - *bearer-only*: Useful for back-end services that allow bearer token requests. It is required to specify the client type in the ** key of the application *web.xml* file. This file is read by the image at deployment. Set the value of ** element to: * *KEYCLOAK* for the OpenID Connect client. * *KEYCLOAK-SAML* for the SAML client. The following is an example snippet for the application *web.xml* to configure an OIDC client: [subs="verbatim,macros,attributes"] ---- ... KEYCLOAK ... ---- [[advanced-concepts-Auto-Man-Client-Reg]] ==== Automatic and Manual {project_name_abbr} Client Registration Methods A client application can be automatically registered to an {project_name_abbr} realm by using credentials passed in variables specific to the *_eap64-sso-s2i_*, *_eap71-sso-s2i_*, and *_datavirt63-secure-s2i_* templates. Alternatively, you can manually register the client application by configuring and exporting the {project_name_abbr} client adapter and including it in the client application configuration. ===== Automatic {project_name_abbr} Client Registration Automatic {project_name_abbr} client registration is determined by {project_name_abbr} environment variables specific to the *_eap64-sso-s2i_*, *_eap71-sso-s2i_*, and *_datavirt63-secure-s2i_* templates. The {project_name_abbr} credentials supplied in the template are then used to register the client to the {project_name_abbr} realm during deployment of the client application. The {project_name_abbr} environment variables included in the *_eap64-sso-s2i_*, *_eap71-sso-s2i_*, and *_datavirt63-secure-s2i_* templates are: [cols="2*", options="header"] |=== |Variable |Description |*_HOSTNAME_HTTP_* |Custom hostname for http service route. Leave blank for default hostname of .. |*_HOSTNAME_HTTPS_* |Custom hostname for https service route. Leave blank for default hostname of .. |*_SSO_URL_* |The {project_name_abbr} web server authentication address: $$https://secure-sso-$$__.__/auth |*_SSO_REALM_* |The {project_name_abbr} realm created for this procedure. |*_SSO_USERNAME_* |The name of the _realm management user_. |*_SSO_PASSWORD_* | The password of the user. |*_SSO_PUBLIC_KEY_* |The public key generated by the realm. It is located in the *Keys* tab of the *Realm Settings* in the {project_name_abbr} console. |*_SSO_BEARER_ONLY_* |If set to *true*, the OpenID Connect client is registered as bearer-only. |*_SSO_ENABLE_CORS_* |If set to *true*, the {project_name_abbr} adapter enables Cross-Origin Resource Sharing (CORS). |=== If the {project_name_abbr} client uses the SAML protocol, the following additional variables need to be configured: [cols="2*", options="header"] |=== |Variable |Description |*_SSO_SAML_KEYSTORE_SECRET_* |Secret to use for access to SAML keystore. The default is _sso-app-secret_. |*_SSO_SAML_KEYSTORE_* |Keystore filename in the SAML keystore secret. The default is _keystore.jks_. |*_SSO_SAML_KEYSTORE_PASSWORD_* |Keystore password for SAML. The default is _mykeystorepass_. |*_SSO_SAML_CERTIFICATE_NAME_* |Alias for keys/certificate to use for SAML. The default is _jboss_. |=== See xref:Example-EAP-Auto[Example Workflow: Automatically Registering EAP Application in {project_name_abbr} with OpenID-Connect Client] for an end-to-end example of the automatic client registration method using an OpenID-Connect client. ===== Manual {project_name_abbr} Client Registration Manual {project_name_abbr} client registration is determined by the presence of a deployment file in the client application's _../configuration/_ directory. These files are exported from the client adapter in the {project_name_abbr} web console. The name of this file is different for OpenID-Connect and SAML clients: [horizontal] *OpenID-Connect*:: _../configuration/secure-deployments_ *SAML*:: _../configuration/secure-saml-deployments_ These files are copied to the {project_name_abbr} adapter configuration section in the _standalone-openshift.xml_ at when the application is deployed. There are two methods for passing the {project_name_abbr} adapter configuration to the client application: * Modify the deployment file to contain the {project_name_abbr} adapter configuration so that it is included in the _standalone-openshift.xml_ file at deployment, or * Manually include the OpenID-Connect _keycloak.json_ file, or the SAML _keycloak-saml.xml_ file in the client application's *../WEB-INF* directory. See xref:Example-EAP-Manual[Example Workflow: Manually Configure an Application to Use {project_name_abbr} Authentication, Using SAML Client] for an end-to-end example of the manual {project_name_abbr} client registration method using a SAML client. === Limitations OpenShift does not currently accept OpenShift role mapping from external providers. If {project_name_abbr} is used as an authentication gateway for OpenShift, users created in {project_name_abbr} must have the roles added using the OpenShift Administrator `oadm policy` command. For example, to allow an {project_name_abbr}-created user to view a project namespace in OpenShift: [subs="verbatim,macros,attributes"] ---- oadm policy add-role-to-user view -n ----