Chapter 4. Configuring OAuth clients
OpenShift Container Platform includes default OAuth clients for platform authentication. You can register additional OAuth clients to integrate third-party applications and configure token inactivity timeouts to enhance security.
4.1. Default OAuth clients Copy linkLink copied to clipboard!
OpenShift Container Platform automatically creates OAuth clients for browser-based logins, CLI authentication, and challenge-based authentication when the API starts.
The following OAuth clients are created:
| OAuth client | Usage |
|---|---|
|
|
Requests tokens at |
|
|
Requests tokens with a user-agent that can handle |
|
| Requests tokens by using a local HTTP server fetching an authorization code grant. |
where:
<namespace_route>Specifies the namespace route. Find this value by running the following command:
$ oc get route oauth-openshift -n openshift-authentication -o json | jq .spec.host
4.2. Registering an additional OAuth client Copy linkLink copied to clipboard!
Register additional OAuth clients to manage authentication for applications that need to interact with your OpenShift Container Platform cluster.
Procedure
To register additional OAuth clients:
$ oc create -f <(echo ' kind: OAuthClient apiVersion: oauth.openshift.io/v1 metadata: name: demo secret: "..." redirectURIs: - "http://www.example.com/" grantMethod: prompt ')where:
metadata.name-
Specifies the OAuth client name. This value is used as the
client_idparameter when making requests to<namespace_route>/oauth/authorizeand<namespace_route>/oauth/token. secret-
Specifies the secret value used as the
client_secretparameter when making requests to<namespace_route>/oauth/token. redirectURIs-
Specifies the list of valid redirect URIs. The
redirect_uriparameter specified in requests to<namespace_route>/oauth/authorizeand<namespace_route>/oauth/tokenmust be equal to or prefixed by one of these URIs. grantMethod-
Specifies the action to take when this client requests tokens and has not yet been granted access by the user. Use
autoto automatically approve the grant and retry the request, orpromptto prompt the user to approve or deny the grant.
4.3. Configuring token inactivity timeout for an OAuth client Copy linkLink copied to clipboard!
Configure OAuth clients to expire tokens after a set period of inactivity, improving security by automatically invalidating idle sessions.
By default, no token inactivity timeout is set.
If the token inactivity timeout is also configured in the internal OAuth server configuration, the timeout that is set in the OAuth client overrides that value.
Prerequisites
-
You have access to the cluster as a user with the
cluster-adminrole. - You have configured an identity provider (IDP).
Procedure
Update the
OAuthClientconfiguration to set a token inactivity timeout.Edit the
OAuthClientobject:$ oc edit oauthclient <oauth_client>Replace
<oauth_client>with the OAuth client to configure, for example,console.Add the
accessTokenInactivityTimeoutSecondsfield and set your timeout value:apiVersion: oauth.openshift.io/v1 grantMethod: auto kind: OAuthClient metadata: ... accessTokenInactivityTimeoutSeconds: 600where:
accessTokenInactivityTimeoutSeconds-
Specifies the token inactivity timeout in seconds. The minimum allowed value is
300.
- Save the file to apply the changes.
Verification
- Log in to the cluster with an identity from your IDP. Be sure to use the OAuth client that you just configured.
- Perform an action and verify that it was successful.
- Wait longer than the configured timeout without using the identity. In this procedure’s example, wait longer than 600 seconds.
Try to perform an action from the same identity’s session.
This attempt should fail because the token should have expired due to inactivity longer than the configured timeout.