You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

parser.go 4.0KB

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