parser.go 3.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128
  1. package jwt
  2. import (
  3. "bytes"
  4. "encoding/json"
  5. "fmt"
  6. "strings"
  7. )
  8. type Parser struct {
  9. ValidMethods []string // If populated, only these methods will be considered valid
  10. UseJSONNumber bool // Use JSON Number format in JSON decoder
  11. }
  12. // Parse, validate, and return a token.
  13. // keyFunc will receive the parsed token and should return the key for validating.
  14. // If everything is kosher, err will be nil
  15. func (p *Parser) Parse(tokenString string, keyFunc Keyfunc) (*Token, error) {
  16. return p.ParseWithClaims(tokenString, MapClaims{}, keyFunc)
  17. }
  18. func (p *Parser) ParseWithClaims(tokenString string, claims Claims, keyFunc Keyfunc) (*Token, error) {
  19. parts := strings.Split(tokenString, ".")
  20. if len(parts) != 3 {
  21. return nil, NewValidationError("token contains an invalid number of segments", ValidationErrorMalformed)
  22. }
  23. var err error
  24. token := &Token{Raw: tokenString}
  25. // parse Header
  26. var headerBytes []byte
  27. if headerBytes, err = DecodeSegment(parts[0]); err != nil {
  28. if strings.HasPrefix(strings.ToLower(tokenString), "bearer ") {
  29. return token, NewValidationError("tokenstring should not contain 'bearer '", ValidationErrorMalformed)
  30. }
  31. return token, &ValidationError{Inner: err, Errors: ValidationErrorMalformed}
  32. }
  33. if err = json.Unmarshal(headerBytes, &token.Header); err != nil {
  34. return token, &ValidationError{Inner: err, Errors: ValidationErrorMalformed}
  35. }
  36. // parse Claims
  37. var claimBytes []byte
  38. token.Claims = claims
  39. if claimBytes, err = DecodeSegment(parts[1]); err != nil {
  40. return token, &ValidationError{Inner: err, Errors: ValidationErrorMalformed}
  41. }
  42. dec := json.NewDecoder(bytes.NewBuffer(claimBytes))
  43. if p.UseJSONNumber {
  44. dec.UseNumber()
  45. }
  46. // JSON Decode. Special case for map type to avoid weird pointer behavior
  47. if c, ok := token.Claims.(MapClaims); ok {
  48. err = dec.Decode(&c)
  49. } else {
  50. err = dec.Decode(&claims)
  51. }
  52. // Handle decode error
  53. if err != nil {
  54. return token, &ValidationError{Inner: err, Errors: ValidationErrorMalformed}
  55. }
  56. // Lookup signature method
  57. if method, ok := token.Header["alg"].(string); ok {
  58. if token.Method = GetSigningMethod(method); token.Method == nil {
  59. return token, NewValidationError("signing method (alg) is unavailable.", ValidationErrorUnverifiable)
  60. }
  61. } else {
  62. return token, NewValidationError("signing method (alg) is unspecified.", ValidationErrorUnverifiable)
  63. }
  64. // Verify signing method is in the required set
  65. if p.ValidMethods != nil {
  66. var signingMethodValid = false
  67. var alg = token.Method.Alg()
  68. for _, m := range p.ValidMethods {
  69. if m == alg {
  70. signingMethodValid = true
  71. break
  72. }
  73. }
  74. if !signingMethodValid {
  75. // signing method is not in the listed set
  76. return token, NewValidationError(fmt.Sprintf("signing method %v is invalid", alg), ValidationErrorSignatureInvalid)
  77. }
  78. }
  79. // Lookup key
  80. var key interface{}
  81. if keyFunc == nil {
  82. // keyFunc was not provided. short circuiting validation
  83. return token, NewValidationError("no Keyfunc was provided.", ValidationErrorUnverifiable)
  84. }
  85. if key, err = keyFunc(token); err != nil {
  86. // keyFunc returned an error
  87. return token, &ValidationError{Inner: err, Errors: ValidationErrorUnverifiable}
  88. }
  89. vErr := &ValidationError{}
  90. // Validate Claims
  91. if err := token.Claims.Valid(); err != nil {
  92. // If the Claims Valid returned an error, check if it is a validation error,
  93. // If it was another error type, create a ValidationError with a generic ClaimsInvalid flag set
  94. if e, ok := err.(*ValidationError); !ok {
  95. vErr = &ValidationError{Inner: err, Errors: ValidationErrorClaimsInvalid}
  96. } else {
  97. vErr = e
  98. }
  99. }
  100. // Perform validation
  101. token.Signature = parts[2]
  102. if err = token.Method.Verify(strings.Join(parts[0:2], "."), token.Signature, key); err != nil {
  103. vErr.Inner = err
  104. vErr.Errors |= ValidationErrorSignatureInvalid
  105. }
  106. if vErr.valid() {
  107. token.Valid = true
  108. return token, nil
  109. }
  110. return token, vErr
  111. }