Replace *jwt.validateClaimsWithLeeway with custom validation func #176
Conversation
+ refactor validator pkg
sergiught
force-pushed
the
pathc/issue#148-multiple-audience
branch
from
33c3d1d
to
5cd381b
Compare
| req.Header.Set("Authorization", "Bearer "+token) | ||
|
|
||
| rr := httptest.NewRecorder() | ||
|
|
||
| mainHandler := setupHandler(testServer.URL, []string{}) | ||
| mainHandler := setupHandler(testServer.URL, []string{"my-audience"}) |
There was a problem hiding this comment.
This was incorrectly set to validate no audience.
| @@ -26,5 +26,5 @@ jobs: | |||
| uses: codecov/codecov-action@v3 | |||
| with: | |||
| files: coverage.out | |||
| fail_ci_if_error: true | |||
| fail_ci_if_error: false | |||
There was a problem hiding this comment.
Quick toggle to not fail the CI build if we fail to upload codecov.
| v.signatureAlgorithm, | ||
| token.Headers[0].Algorithm, | ||
| ) | ||
| if err = validateSigningMethod(string(v.signatureAlgorithm), token.Headers[0].Algorithm); err != nil { |
There was a problem hiding this comment.
Trying to refactor this func so that the steps read better.
| foundAudience := false | ||
| for _, value := range expectedClaims.Audience { | ||
| if actualClaims.Audience.Contains(value) { | ||
| foundAudience = true | ||
| break | ||
| } | ||
| } | ||
| if !foundAudience { | ||
| return jwt.ErrInvalidAudience |
There was a problem hiding this comment.
This is mainly the fix for the multiple audiences described in #148
| return validatedClaims, nil | ||
| } | ||
|
|
||
| func validateClaimsWithLeeway(actualClaims jwt.Claims, expected jwt.Expected, leeway time.Duration) error { |
There was a problem hiding this comment.
There was a problem hiding this comment.
Should this also include the sub and jti validation?
There was a problem hiding this comment.
Although that original func does include them, we were never actually using them for the validation. We're only setting as expected the audience, issuer and the time based claims.
Re:
There was a problem hiding this comment.
Note that in other SDKs we do validate the sub claim: https://github.com/auth0/Auth0.swift/blob/master/Auth0/IDTokenValidator.swift#L56
There was a problem hiding this comment.
Maybe we can add that validation?
There was a problem hiding this comment.
(if applicable, of course).
There was a problem hiding this comment.
Unfortunately we can't introduce that right now without a breaking change. The expectedClaims are a private internal property inside the validator and we set it with the passed in issuer and audience when constructing the validator. We'll have to change this func https://github.com/auth0/go-jwt-middleware/blob/master/validator/validator.go#L59 to allow for the subject as well. I'll note this down for a potential upcoming v3 perhaps, wdyt?
馃摑 Checklist
馃敡 Changes
We are replacing the *jwt.validateClaimsWithLeeway func with our own logic to fix the issue with multiple audiences within the 3rd party pkg as it seems we are not getting a new release. This was preferred right now to swapping the jwt library used under the hood as that would be a bigger undertaking that we'll defer for later, perhaps a v3.
馃摎 References
馃敩 Testing