mirrors/haproxy
1
0
Fork 0
mirror of https://git.haproxy.org/git/haproxy.git/ synced 2025-09-22 06:11:32 +02:00
Code Issues Projects Releases Wiki Activity

DOC: jwt: fix a typo in the jwt_verify() keyword description

Browse Source 
Just a missing "s" in "case". Also, the wide table was slightly reduced
to fit into 80 columns.
This commit is contained in:
Willy Tarreau 2021-10-15 11:48:42 +02:00
parent ce16db4145
commit 0eba94e98c
1 changed files with 14 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
doc/configuration.txt
View File

@ -16658,13 +16658,15 @@ jwt_payload_query([<json_path>],[<output_type>])
jwt_verify(<alg>,<key>) jwt_verify(<alg>,<key>)
Performs a signature verification for the JSON Web Token (JWT) given in input Performs a signature verification for the JSON Web Token (JWT) given in input
by using the <alg> algorithm and the <key> parameter, which should either by using the <alg> algorithm and the <key> 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 verification success. See below for a full list of the possible return
values. values.
For now, only JWS tokens using the Compact Serialization format can be For now, only JWS tokens using the Compact Serialization format can be
processed (three dot-separated base64-url encoded strings). Among the processed (three dot-separated base64-url encoded strings). Among the
accepted algorithms for a JWS (see section 3.1 of RFC7518), the PSXXX ones accepted algorithms for a JWS (see section 3.1 of RFC7518), the PSXXX ones
are not managed yet. are not managed yet.
If the used algorithm is of the HMAC family, <key> should be the secret used If the used algorithm is of the HMAC family, <key> should be the secret used
in the HMAC signature calculation. Otherwise, <key> should be the path to the in the HMAC signature calculation. Otherwise, <key> should be the path to the
public certificate that can be used to validate the token's signature. All public certificate that can be used to validate the token's signature. All
@ -16682,9 +16684,9 @@ jwt_verify(<alg>,<key>)
The possible return values are the following : The possible return values are the following :
+----+---------------------------------------------------------------------------+ +----+----------------------------------------------------------------------+
| ID | message | | ID | message |
+----+---------------------------------------------------------------------------+ +----+----------------------------------------------------------------------+
| 0 | "Verification failure" | | 0 | "Verification failure" |
| 1 | "Verification sucess" | | 1 | "Verification sucess" |
| 2 | "Unknown algorithm (not mentioned in RFC7518)" | | 2 | "Unknown algorithm (not mentioned in RFC7518)" |
@ -16692,7 +16694,7 @@ jwt_verify(<alg>,<key>)
| 4 | "Invalid token" | | 4 | "Invalid token" |
| 5 | "Out of memory" | | 5 | "Out of memory" |
| 6 | "Unknown certificate" | | 6 | "Unknown certificate" |
+----+---------------------------------------------------------------------------+ +----+----------------------------------------------------------------------+
Please note that this converter is only available when HAProxy has been Please note that this converter is only available when HAProxy has been
compiled with USE_OPENSSL. compiled with USE_OPENSSL.