-
Notifications
You must be signed in to change notification settings - Fork 80
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
15 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,7 @@ | ||
--- | ||
categories: | ||
- elytron | ||
--- | ||
= [Preview] Bearer token timeout configurability will be added to WildFly's Elytron subsystem. | ||
:author: Rebecca Searls | ||
:email: [email protected] | ||
|
@@ -10,19 +14,20 @@ | |
|
||
Bearer Token Authorization is the process of authorizing HTTP requests based on | ||
the existence and validity of a bearer token. The token carries within it | ||
an expiration timestamp. The two parameters being added, connectionTimeout | ||
and readTimeout are placed on the URL used in retrieving the public key. | ||
an expiration timestamp. The two parameters being added, connection-timeout | ||
and read-timeout are placed on the URL used in retrieving the public key. | ||
|
||
|
||
== Issue Metadata | ||
|
||
=== Issue | ||
* https://issues.redhat.com/browse/EAP7-1856[EAP7-1856] | ||
|
||
* https://issues.redhat.com/browse/WFCORE-5691[WFCORE-5691] | ||
|
||
=== Related Issues | ||
|
||
* https://issues.redhat.com/browse/EAP7-1856[EAP7-1856] | ||
* https://issues.redhat.com/browse/ELY-2189[ELY-2189] | ||
* https://issues.redhat.com/browse/WFCORE-5691[WFCORE-5691] | ||
* https://issues.redhat.com/browse/EAPSUP-640[EAPSUP-640] | ||
|
||
=== Stability Level | ||
|
@@ -68,7 +73,7 @@ N/A | |
|
||
=== Hard Requirements | ||
|
||
* Two new attributes, `connectionTimeout` and `readTimeout` will be | ||
* Two new attributes, `connection-timeout` and `read-timeout` will be | ||
added to the token-realm element in the Elytron subsystem of WildFly. | ||
|
||
Both parameters are datatype int. The value is in milliseonds. Only zero or positive integers are allowed. Zero means infinite time. WildFly uses a default | ||
|
@@ -77,10 +82,10 @@ If the connection time and/or read time expires during | |
public key retrieval a warning message is logged and null is returned as | ||
the public key to Elyton's process code. | ||
|
||
** connectionTimeout: The value represents the length of time to wait when | ||
** connection-timeout: The value represents the length of time to wait when | ||
establishing a connection with the URL used to retrieve the public key. The attribute is optional. | ||
|
||
** readTimeout: The value represents the length of time to wait when | ||
** read-timeout: The value represents the length of time to wait when | ||
downloading the public key from the URL. The attribute is optional. | ||
|
||
* wildfly-elytron_18_0.xsd will be updated to wildfly-elytron_preview_19_0.xsd with the added attributes | ||
|
@@ -99,19 +104,19 @@ For backward compatibility the default value of 2000 milliseconds will be used. | |
|
||
=== Default Configuration | ||
|
||
By default, neither, `connectionTimeout` nor `readTimeout` will be | ||
By default, neither, `connection-timeout` nor `read-timeout` will be | ||
declared. The default values will be used. | ||
|
||
== Test Plan | ||
|
||
* WildFly Tests: Integration test cases implemented for functionality. | ||
* WildFly Testsuite: Test cases will be added to check for subsystem parsing. | ||
** Additional integration tests will be added to test the full functionality when `connectionTimeout` and `readTimeout` are configured. | ||
** Additional integration tests will be added to test the full functionality when `connection-timeout` and `read-timeout` are configured. | ||
* Tests will be added for subsystem configurations. | ||
* Tests may be added to ensure that server configuration fails when the stability level is not specified appropriately. | ||
|
||
== Community Documentation | ||
Documentation for `connectionTimeout` and `readTimeout` will be added | ||
Documentation for `connection-timeout` and `read-timeout` will be added | ||
to https://github.com/wildfly/wildfly/blob/main/docs/src/main/asciidoc/_elytron/Bearer_Token_Authorization.adoc[Bearer Token Authorization] | ||
|
||
== Release Note Content | ||
|