docs: clarify JWTClaimValidationFailed error instance payload property

panva · Jun 18, 2024 · c1a852c · c1a852c
1 parent 1eab369
commit c1a852c
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 4 deletions.
diff --git a/docs/classes/util_errors.JWTClaimValidationFailed.md b/docs/classes/util_errors.JWTClaimValidationFailed.md
@@ -63,7 +63,10 @@ ___
 
 • **payload**: [`JWTPayload`](../interfaces/types.JWTPayload.md)
 
-The parsed JWT payload.
+The parsed JWT Claims Set (aka payload). Other JWT claims may or may not have been verified at
+this point. The JSON Web Signature (JWS) or a JSON Web Encryption (JWE) structures' integrity
+has however been verified. Claims Set verification happens after the JWS Signature or JWE
+Decryption processes.
 
 ___
 

diff --git a/docs/classes/util_errors.JWTExpired.md b/docs/classes/util_errors.JWTExpired.md
@@ -63,7 +63,10 @@ ___
 
 • **payload**: [`JWTPayload`](../interfaces/types.JWTPayload.md)
 
-The parsed JWT payload.
+The parsed JWT Claims Set (aka payload). Other JWT claims may or may not have been verified at
+this point. The JSON Web Signature (JWS) or a JSON Web Encryption (JWE) structures' integrity
+has however been verified. Claims Set verification happens after the JWS Signature or JWE
+Decryption processes.
 
 ___
 

diff --git a/src/util/errors.ts b/src/util/errors.ts
@@ -72,7 +72,12 @@ export class JWTClaimValidationFailed extends JOSEError {
  /** Reason code for the validation failure. */
  reason: string
 
- /** The parsed JWT payload. */
+ /**
+ * The parsed JWT Claims Set (aka payload). Other JWT claims may or may not have been verified at
+ * this point. The JSON Web Signature (JWS) or a JSON Web Encryption (JWE) structures' integrity
+ * has however been verified. Claims Set verification happens after the JWS Signature or JWE
+ * Decryption processes.
+ */
  payload: JWTPayload
 
  /** @ignore */
@@ -121,7 +126,12 @@ export class JWTExpired extends JOSEError implements JWTClaimValidationFailed {
  /** Reason code for the validation failure. */
  reason: string
 
- /** The parsed JWT payload. */
+ /**
+ * The parsed JWT Claims Set (aka payload). Other JWT claims may or may not have been verified at
+ * this point. The JSON Web Signature (JWS) or a JSON Web Encryption (JWE) structures' integrity
+ * has however been verified. Claims Set verification happens after the JWS Signature or JWE
+ * Decryption processes.
+ */
  payload: JWTPayload
 
  /** @ignore */