From 0eba94e98cea25215f6c40c3f2e635963fdda175 Mon Sep 17 00:00:00 2001 From: Willy Tarreau Date: Fri, 15 Oct 2021 11:48:42 +0200 Subject: [PATCH] DOC: jwt: fix a typo in the jwt_verify() keyword description Just a missing "s" in "case". Also, the wide table was slightly reduced to fit into 80 columns. --- doc/configuration.txt | 26 ++++++++++++++------------ 1 file changed, 14 insertions(+), 12 deletions(-) diff --git a/doc/configuration.txt b/doc/configuration.txt index e58d6d3e2..c242698c4 100644 --- a/doc/configuration.txt +++ b/doc/configuration.txt @@ -16658,13 +16658,15 @@ jwt_payload_query([],[]) jwt_verify(,) Performs a signature verification for the JSON Web Token (JWT) given in input by using the algorithm and the parameter, which should either - hold a secret or a path to a public certificate. Returns 1 in cae of + hold a secret or a path to a public certificate. Returns 1 in case of verification success. See below for a full list of the possible return values. + For now, only JWS tokens using the Compact Serialization format can be processed (three dot-separated base64-url encoded strings). Among the accepted algorithms for a JWS (see section 3.1 of RFC7518), the PSXXX ones are not managed yet. + If the used algorithm is of the HMAC family, should be the secret used in the HMAC signature calculation. Otherwise, should be the path to the public certificate that can be used to validate the token's signature. All @@ -16682,17 +16684,17 @@ jwt_verify(,) The possible return values are the following : - +----+---------------------------------------------------------------------------+ - | ID | message | - +----+---------------------------------------------------------------------------+ - | 0 | "Verification failure" | - | 1 | "Verification sucess" | - | 2 | "Unknown algorithm (not mentioned in RFC7518)" | - | 3 | "Unmanaged algorithm (PSXXX algorithm family)" | - | 4 | "Invalid token" | - | 5 | "Out of memory" | - | 6 | "Unknown certificate" | - +----+---------------------------------------------------------------------------+ + +----+----------------------------------------------------------------------+ + | ID | message | + +----+----------------------------------------------------------------------+ + | 0 | "Verification failure" | + | 1 | "Verification sucess" | + | 2 | "Unknown algorithm (not mentioned in RFC7518)" | + | 3 | "Unmanaged algorithm (PSXXX algorithm family)" | + | 4 | "Invalid token" | + | 5 | "Out of memory" | + | 6 | "Unknown certificate" | + +----+----------------------------------------------------------------------+ Please note that this converter is only available when HAProxy has been compiled with USE_OPENSSL.