Update vendor

This commit is contained in:
Tim Hockin 2025-03-24 13:03:08 -07:00
parent b2ca599b06
commit de11885271
2 changed files with 54 additions and 25 deletions

View File

@ -7,6 +7,8 @@ import (
"strings" "strings"
) )
const tokenDelimiter = "."
type Parser struct { type Parser struct {
// If populated, only these methods will be considered valid. // If populated, only these methods will be considered valid.
// //
@ -36,19 +38,21 @@ func NewParser(options ...ParserOption) *Parser {
return p return p
} }
// Parse parses, validates, verifies the signature and returns the parsed token. // Parse parses, validates, verifies the signature and returns the parsed token. keyFunc will
// keyFunc will receive the parsed token and should return the key for validating. // receive the parsed token and should return the key for validating.
func (p *Parser) Parse(tokenString string, keyFunc Keyfunc) (*Token, error) { func (p *Parser) Parse(tokenString string, keyFunc Keyfunc) (*Token, error) {
return p.ParseWithClaims(tokenString, MapClaims{}, keyFunc) return p.ParseWithClaims(tokenString, MapClaims{}, keyFunc)
} }
// ParseWithClaims parses, validates, and verifies like Parse, but supplies a default object implementing the Claims // ParseWithClaims parses, validates, and verifies like Parse, but supplies a default object
// interface. This provides default values which can be overridden and allows a caller to use their own type, rather // implementing the Claims interface. This provides default values which can be overridden and
// than the default MapClaims implementation of Claims. // allows a caller to use their own type, rather than the default MapClaims implementation of
// Claims.
// //
// Note: If you provide a custom claim implementation that embeds one of the standard claims (such as RegisteredClaims), // Note: If you provide a custom claim implementation that embeds one of the standard claims (such
// make sure that a) you either embed a non-pointer version of the claims or b) if you are using a pointer, allocate the // as RegisteredClaims), make sure that a) you either embed a non-pointer version of the claims or
// proper memory for it before passing in the overall claims, otherwise you might run into a panic. // b) if you are using a pointer, allocate the proper memory for it before passing in the overall
// claims, otherwise you might run into a panic.
func (p *Parser) ParseWithClaims(tokenString string, claims Claims, keyFunc Keyfunc) (*Token, error) { func (p *Parser) ParseWithClaims(tokenString string, claims Claims, keyFunc Keyfunc) (*Token, error) {
token, parts, err := p.ParseUnverified(tokenString, claims) token, parts, err := p.ParseUnverified(tokenString, claims)
if err != nil { if err != nil {
@ -85,12 +89,17 @@ func (p *Parser) ParseWithClaims(tokenString string, claims Claims, keyFunc Keyf
return token, &ValidationError{Inner: err, Errors: ValidationErrorUnverifiable} return token, &ValidationError{Inner: err, Errors: ValidationErrorUnverifiable}
} }
// Perform validation
token.Signature = parts[2]
if err := token.Method.Verify(strings.Join(parts[0:2], "."), token.Signature, key); err != nil {
return token, &ValidationError{Inner: err, Errors: ValidationErrorSignatureInvalid}
}
vErr := &ValidationError{} vErr := &ValidationError{}
// Validate Claims // Validate Claims
if !p.SkipClaimsValidation { if !p.SkipClaimsValidation {
if err := token.Claims.Valid(); err != nil { if err := token.Claims.Valid(); err != nil {
// If the Claims Valid returned an error, check if it is a validation error, // If the Claims Valid returned an error, check if it is a validation error,
// If it was another error type, create a ValidationError with a generic ClaimsInvalid flag set // If it was another error type, create a ValidationError with a generic ClaimsInvalid flag set
if e, ok := err.(*ValidationError); !ok { if e, ok := err.(*ValidationError); !ok {
@ -98,22 +107,14 @@ func (p *Parser) ParseWithClaims(tokenString string, claims Claims, keyFunc Keyf
} else { } else {
vErr = e vErr = e
} }
return token, vErr
} }
} }
// Perform validation // No errors so far, token is valid.
token.Signature = parts[2] token.Valid = true
if err = token.Method.Verify(strings.Join(parts[0:2], "."), token.Signature, key); err != nil {
vErr.Inner = err
vErr.Errors |= ValidationErrorSignatureInvalid
}
if vErr.valid() { return token, nil
token.Valid = true
return token, nil
}
return token, vErr
} }
// ParseUnverified parses the token but doesn't validate the signature. // ParseUnverified parses the token but doesn't validate the signature.
@ -123,9 +124,10 @@ func (p *Parser) ParseWithClaims(tokenString string, claims Claims, keyFunc Keyf
// It's only ever useful in cases where you know the signature is valid (because it has // It's only ever useful in cases where you know the signature is valid (because it has
// been checked previously in the stack) and you want to extract values from it. // been checked previously in the stack) and you want to extract values from it.
func (p *Parser) ParseUnverified(tokenString string, claims Claims) (token *Token, parts []string, err error) { func (p *Parser) ParseUnverified(tokenString string, claims Claims) (token *Token, parts []string, err error) {
parts = strings.Split(tokenString, ".") var ok bool
if len(parts) != 3 { parts, ok = splitToken(tokenString)
return nil, parts, NewValidationError("token contains an invalid number of segments", ValidationErrorMalformed) if !ok {
return nil, nil, NewValidationError("token contains an invalid number of segments", ValidationErrorMalformed)
} }
token = &Token{Raw: tokenString} token = &Token{Raw: tokenString}
@ -175,3 +177,30 @@ func (p *Parser) ParseUnverified(tokenString string, claims Claims) (token *Toke
return token, parts, nil return token, parts, nil
} }
// splitToken splits a token string into three parts: header, claims, and signature. It will only
// return true if the token contains exactly two delimiters and three parts. In all other cases, it
// will return nil parts and false.
func splitToken(token string) ([]string, bool) {
parts := make([]string, 3)
header, remain, ok := strings.Cut(token, tokenDelimiter)
if !ok {
return nil, false
}
parts[0] = header
claims, remain, ok := strings.Cut(remain, tokenDelimiter)
if !ok {
return nil, false
}
parts[1] = claims
// One more cut to ensure the signature is the last part of the token and there are no more
// delimiters. This avoids an issue where malicious input could contain additional delimiters
// causing unecessary overhead parsing tokens.
signature, _, unexpected := strings.Cut(remain, tokenDelimiter)
if unexpected {
return nil, false
}
parts[2] = signature
return parts, true
}

2
vendor/modules.txt vendored
View File

@ -8,7 +8,7 @@ github.com/cespare/xxhash/v2
## explicit; go 1.16 ## explicit; go 1.16
github.com/go-logr/logr github.com/go-logr/logr
github.com/go-logr/logr/funcr github.com/go-logr/logr/funcr
# github.com/golang-jwt/jwt/v4 v4.5.0 # github.com/golang-jwt/jwt/v4 v4.5.2
## explicit; go 1.16 ## explicit; go 1.16
github.com/golang-jwt/jwt/v4 github.com/golang-jwt/jwt/v4
# github.com/golang/protobuf v1.5.2 # github.com/golang/protobuf v1.5.2