adjust documentation of Parse() #393
Conversation
| // https://auth0.com/blog/critical-vulnerabilities-in-json-web-token-libraries/ | ||
| // Parse parses, validates, verifies the signature, and returns the parsed token. | ||
| // When a keyFunc is set and a tokenString is provided, the library will not accept | ||
| // the 'none' type algorithm, ensuring security by default. However, it is strongly |
There was a problem hiding this comment.
This is not entirely correct. By default no token is rejected based on an algorithm value alone. The specified algorithms is matched against a list of available algorithms GetSigningMethod:
Line 30 in 62e504c
After this step, the key returned in keyFunc is forwarded to the signing method implementation, which checks whether the type of key is suitable for that particular method or not.
In order to avoid simple mistakes, the signing method of none only allows keys of a very special global variable jwt.UnsafeAllowNoneSignatureType.
There was a problem hiding this comment.
I think I captured this, but just not that intricate detail. The main reason why I made the change here is that from the original comment it is not quite clear if the Parse function will be secure by default or not. It just mentions a rather unclear recommendation "caller is strongly encouraged to set the WithValidMethods option".
But hey, if you have a better idea for wording I'm all for it. I'm just looking to make the documentation clearer for users.
There was a problem hiding this comment.
Understood. I will try to come up with a very condensed version of what I wrote for the doc. The issue that I have with the wording "When a keyFunc is set and a tokenString is provided, the library will not accept the 'none' type algorithm, ensuring security by default" is that strictly speaking is not true. If you have a keyFunc that returns jwt.UnsafeAllowNoneSignatureType it will accept the 'none' type. The 'none' type does not have any special handling.
as discussed here:
#392