Skip to content

Commit 3016d93

Browse files
authored
manual cherrypick of update RHBK config docs with security consideration (#892)
1 parent 34b3855 commit 3016d93

File tree

2 files changed

+17
-5
lines changed

2 files changed

+17
-5
lines changed

modules/authentication/proc-enabling-authentication-with-rhsso.adoc

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,6 @@ Save the value for the next step:
2323
* **Client ID**
2424
* **Client Secret**
2525

26-
.. Configure your {rhsso} realm for performance and security:
27-
... Navigate to the **Configure** > **Realm Settings**.
28-
... Set the **Access Token Lifespan** to a value greater than five minutes (preferably 10 or 15 minutes) to prevent performance issues from frequent refresh token requests for every API call.
29-
... Enable the **Revoke Refresh Token** option to improve security by enabling the refresh token rotation strategy.
30-
3126
.. To prepare for the verification steps, in the same realm, get the credential information for an existing user or link:https://docs.redhat.com/en/documentation/red_hat_single_sign-on/7.6/html-single/getting_started_guide/index#create-user_[create a user]. Save the user credential information for the verification steps.
3227

3328
. To add your {rhsso} credentials to your {product-short} secrets, edit your {product-short} secrets, such as `secrets-rhdh`, and add the following key/value pairs:
@@ -182,6 +177,13 @@ auth:
182177

183178
--
184179

180+
.Security consideration
181+
If multiple valid refresh tokens are issued due to frequent refresh token requests, older tokens will remain valid until they expire. To enhance security and prevent potential misuse of older tokens, enable a refresh token rotation strategy in your {rhbk} realm.
182+
183+
. From the *Configure* section of the navigation menu, click *Realm Settings*.
184+
. From the *Realm Settings* page, click the *Tokens* tab.
185+
. From the *Refresh tokens* section of the *Tokens* tab, toggle the *Revoke Refresh Token* to the *Enabled* position.
186+
185187
.Verification
186188
. Go to the {product-short} login page.
187189
. Your {product-short} sign-in page displays *Sign in using OIDC* and the Guest user sign-in is disabled.

modules/release-notes/ref-release-notes-known-issues.adoc

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,5 +56,15 @@ Permissions associated only with front-end plugins do not appear in the UI becau
5656

5757
* link:https://issues.redhat.com/browse/RHIDP-3396[RHIDP-3396]
5858

59+
[id="known-issue-rhidp-4695"]
60+
== [Doc] OIDC refresh token behavior
61+
62+
When using {rhsso-brand-name} or {rhbk-brand-name} as an OIDC provider, the default access token lifespan is set to 5 minutes, which corresponds to the token refresh grace period set in {product-short}. This 5-minute grace period is the threshold used to trigger a new refresh token call. Since the token is always near expiration, frequent refresh token requests will cause performance issues.
63+
64+
This issue will be resolved in the 1.5 release. To prevent the performance issues, increase the lifespan in the {rhsso-brand-name} or {rhbk-brand-name} server by setting *Configure > Realm Settings > Access Token Lifespan* to a value greater than five minutes (preferably 10 or 15 minutes).
65+
66+
67+
.Additional resources
68+
* link:https://issues.redhat.com/browse/RHIDP-4695[RHIDP-4695]
5969

6070

0 commit comments

Comments
 (0)