Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documented MP JWT Public Key Cache TTL #127

Merged
merged 2 commits into from
Jan 29, 2021
Merged

Documented MP JWT Public Key Cache TTL #127

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5a705df
Documented MP JWT Puiblic Key Cache TTL
fturizo Jan 28, 2021
7f6cd17
Update docs/modules/ROOT/pages/documentation/microprofile/jwt.adoc
Jan 29, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion docs/modules/ROOT/pages/documentation/microprofile/jwt.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,6 +196,16 @@ NOTE: This property has to be defined in the `payara-mp-jwt.properties` configur

IMPORTANT: Keep in mind that tokens which are missing their type claim and are propagated to other services running on other Eclipse MicroProfile runtimes might be rejected, as the specification mandates the inclusion of the claim.

=== Caching the Public Key

_Since Payara Platform 5.2021.1_

By default, the public key retrieved by the `mp.jwt.verify.publickey.location` configuration property will be cached in memory for 5 minutes after being read from either a local file or a remote location. You can modify this _"time-to-live"_ which determines how long the key stays cached in memory in the case you are dealing with long-lived keys, this is done by setting the `publicKey.cache.ttl` custom property.

NOTE: This property has to be defined in the `payara-mp-jwt.properties` configuration file described in the previous section.

IMPORTANT: The value of the `publicKey.cache.ttl` property is defined in milliseconds, so keep this in mind when modifying the property

== Activating JWT Authentication

An application activates the JWT authentication mechanism and identity store by annotating a class in the application, for instance, the JAX-RS `Application` class, with `@LoginConfig(authMethod = "MP-JWT")`.
Expand Down Expand Up @@ -252,4 +262,4 @@ The out-of-the-box support of `@RolesAllowed` for JAX-RS resources can be switch

Two full examples of using JWT authentication with a JAX-RS endpoint as well as a Servlet resource are provided here:

* https://github.com/javaee-samples/microprofile1.2-samples/tree/master/jwt-auth
* https://github.com/javaee-samples/microprofile1.2-samples/tree/master/jwt-auth