From 73bcf096c2b5fe9a0c616c37cb7719f9af8c643a Mon Sep 17 00:00:00 2001 From: Guillaume Smet Date: Sun, 3 Nov 2019 15:00:48 +0100 Subject: [PATCH] Reorder JWT guide to be more consistent with others Having the configuration reference at the beginning is not what we do elsewhere and it's not pretty with the TOC being there too. --- docs/src/main/asciidoc/security-jwt.adoc | 60 ++++++++++++------------ 1 file changed, 30 insertions(+), 30 deletions(-) diff --git a/docs/src/main/asciidoc/security-jwt.adoc b/docs/src/main/asciidoc/security-jwt.adoc index 291887e7bb108..064488e4a96ec 100644 --- a/docs/src/main/asciidoc/security-jwt.adoc +++ b/docs/src/main/asciidoc/security-jwt.adoc @@ -13,35 +13,6 @@ This guide explains how your Quarkus application can utilize MicroProfile Json W Role-Based Access Control (link:https://en.wikipedia.org/wiki/Role-based_access_control[RBAC]) to provide secured access to the JAX-RS endpoints. -[[configuration-reference]] -== Configuration Reference - -=== Quarkus configuration - -include::{generated-dir}/config/quarkus-smallrye-jwt.adoc[opts=optional, leveloffset=+1] - -=== MicroProfile JWT configuration - -[cols=">. -|mp.jwt.verify.publickey.location|none|Config property allows for an external or internal location of Public Key to be specified. The value may be a relative path or a URL. If the value points to an HTTPS based JWK set then, for it to work in native mode, the `quarkus.ssl.native` property must also be set to `true`, see link:native-and-ssl.html[Using SSL With Native Executables] for more details. -|mp.jwt.verify.issuer|none|Config property specifies the value of the `iss` (issuer) - claim of the JWT that the server will accept as valid. -|=== - -=== Supported Public Key Formats - -Public Keys may be formatted in any of the following formats, specified in order of -precedence: - - - Public Key Cryptography Standards #8 (PKCS#8) PEM - - JSON Web Key (JWK) - - JSON Web Key Set (JWKS) - - JSON Web Key (JWK) Base64 URL encoded - - JSON Web Key Set (JWKS) Base64 URL encoded - == Solution We recommend that you follow the instructions in the next sections and create the application step by step. @@ -950,7 +921,36 @@ Scotts-iMacPro:using-jwt-rbac starksm$ ./target/security-jwt-quickstart-runner == Explore the Solution -The solution repository located in the `using-jwt-rbac` {quickstarts-archive-url}[directory] contains all of the versions we have +The solution repository located in the `security-jwt-quickstart` {quickstarts-tree-url}/security-jwt-quickstart[directory] contains all of the versions we have worked through in this quickstart guide as well as some additional endpoints that illustrate subresources with injection of ``JsonWebToken``s and their claims into those using the CDI APIs. We suggest that you check out the quickstart solutions and explore the `using-jwt-rbac` directory to learn more about the {extension-name} extension features. + +[[configuration-reference]] +== Configuration Reference + +=== Quarkus configuration + +include::{generated-dir}/config/quarkus-smallrye-jwt.adoc[opts=optional, leveloffset=+1] + +=== MicroProfile JWT configuration + +[cols=">. +|mp.jwt.verify.publickey.location|none|Config property allows for an external or internal location of Public Key to be specified. The value may be a relative path or a URL. If the value points to an HTTPS based JWK set then, for it to work in native mode, the `quarkus.ssl.native` property must also be set to `true`, see link:native-and-ssl.html[Using SSL With Native Executables] for more details. +|mp.jwt.verify.issuer|none|Config property specifies the value of the `iss` (issuer) + claim of the JWT that the server will accept as valid. +|=== + +=== Supported Public Key Formats + +Public Keys may be formatted in any of the following formats, specified in order of +precedence: + + - Public Key Cryptography Standards #8 (PKCS#8) PEM + - JSON Web Key (JWK) + - JSON Web Key Set (JWKS) + - JSON Web Key (JWK) Base64 URL encoded + - JSON Web Key Set (JWKS) Base64 URL encoded