forked from golang-jwt/jwt
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Moving claim information into claims.go
- Loading branch information
Showing
2 changed files
with
193 additions
and
191 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,193 @@ | ||
package jwt | ||
|
||
import "crypto/subtle" | ||
|
||
// For a type to be a Claims object, it must just have a Valid method that determines | ||
// if the token is invalid for any supported reason | ||
type Claims interface { | ||
Valid() error | ||
} | ||
|
||
// Structured version of Claims Section, as referenced at | ||
// https://tools.ietf.org/html/rfc7519#section-4.1 | ||
type StandardClaims struct { | ||
Audience string `json:"aud,omitempty"` | ||
ExpiresAt int64 `json:"exp,omitempty"` | ||
Id string `json:"jti,omitempty"` | ||
IssuedAt int64 `json:"iat,omitempty"` | ||
Issuer string `json:"iss,omitempty"` | ||
NotBefore int64 `json:"nbf,omitempty"` | ||
Subject string `json:"sub,omitempty"` | ||
} | ||
|
||
// Validates time based claims "exp, iat, nbf". | ||
// There is no accounting for clock skew. | ||
// As well, if any of the above claims are not in the token, it will still | ||
// be considered a valid claim. | ||
func (c StandardClaims) Valid() error { | ||
vErr := new(ValidationError) | ||
now := TimeFunc().Unix() | ||
|
||
// The claims below are optional, by default, so if they are set to the | ||
// default value in Go, let's not fail the verification for them. | ||
if c.VerifyExpiresAt(now, false) == false { | ||
vErr.err = "Token is expired" | ||
vErr.Errors |= ValidationErrorExpired | ||
} | ||
|
||
if c.VerifyIssuedAt(now, false) == false { | ||
vErr.err = "Token used before issued, clock skew issue?" | ||
vErr.Errors |= ValidationErrorIssuedAt | ||
} | ||
|
||
if c.VerifyNotBefore(now, false) == false { | ||
vErr.err = "Token is not valid yet" | ||
vErr.Errors |= ValidationErrorNotValidYet | ||
} | ||
|
||
if vErr.valid() { | ||
return nil | ||
} | ||
|
||
return vErr | ||
} | ||
|
||
// Compares the aud claim against cmp. | ||
// If required is false, this method will return true if the value matches or is unset | ||
func (c *StandardClaims) VerifyAudience(cmp string, req bool) bool { | ||
return verifyAud(c.Audience, cmp, req) | ||
} | ||
|
||
// Compares the exp claim against cmp. | ||
// If required is false, this method will return true if the value matches or is unset | ||
func (c *StandardClaims) VerifyExpiresAt(cmp int64, req bool) bool { | ||
return verifyExp(c.ExpiresAt, cmp, req) | ||
} | ||
|
||
// Compares the iat claim against cmp. | ||
// If required is false, this method will return true if the value matches or is unset | ||
func (c *StandardClaims) VerifyIssuedAt(cmp int64, req bool) bool { | ||
return verifyIat(c.IssuedAt, cmp, req) | ||
} | ||
|
||
// Compares the iss claim against cmp. | ||
// If required is false, this method will return true if the value matches or is unset | ||
func (c *StandardClaims) VerifyIssuer(cmp string, req bool) bool { | ||
return verifyIss(c.Issuer, cmp, req) | ||
} | ||
|
||
// Compares the nbf claim against cmp. | ||
// If required is false, this method will return true if the value matches or is unset | ||
func (c *StandardClaims) VerifyNotBefore(cmp int64, req bool) bool { | ||
return verifyNbf(c.NotBefore, cmp, req) | ||
} | ||
|
||
type MapClaim map[string]interface{} | ||
|
||
// Compares the aud claim against cmp. | ||
// If required is false, this method will return true if the value matches or is unset | ||
func (m MapClaim) VerifyAudience(cmp string, req bool) bool { | ||
aud, _ := m["aud"].(string) | ||
return verifyAud(aud, cmp, req) | ||
} | ||
|
||
// Compares the exp claim against cmp. | ||
// If required is false, this method will return true if the value matches or is unset | ||
func (m MapClaim) VerifyExpiresAt(cmp int64, req bool) bool { | ||
exp, _ := m["exp"].(float64) | ||
return verifyExp(int64(exp), cmp, req) | ||
} | ||
|
||
// Compares the iat claim against cmp. | ||
// If required is false, this method will return true if the value matches or is unset | ||
func (m MapClaim) VerifyIssuedAt(cmp int64, req bool) bool { | ||
iat, _ := m["iat"].(float64) | ||
return verifyIat(int64(iat), cmp, req) | ||
} | ||
|
||
// Compares the iss claim against cmp. | ||
// If required is false, this method will return true if the value matches or is unset | ||
func (m MapClaim) VerifyIssuer(cmp string, req bool) bool { | ||
iss, _ := m["iss"].(string) | ||
return verifyIss(iss, cmp, req) | ||
} | ||
|
||
// Compares the nbf claim against cmp. | ||
// If required is false, this method will return true if the value matches or is unset | ||
func (m MapClaim) VerifyNotBefore(cmp int64, req bool) bool { | ||
nbf, _ := m["nbf"].(float64) | ||
return verifyNbf(int64(nbf), cmp, req) | ||
} | ||
|
||
// Validates time based claims "exp, iat, nbf". | ||
// There is no accounting for clock skew. | ||
// As well, if any of the above claims are not in the token, it will still | ||
// be considered a valid claim. | ||
func (m MapClaim) Valid() error { | ||
vErr := new(ValidationError) | ||
now := TimeFunc().Unix() | ||
|
||
if m.VerifyExpiresAt(now, false) == false { | ||
vErr.err = "Token is expired" | ||
vErr.Errors |= ValidationErrorExpired | ||
} | ||
|
||
if m.VerifyIssuedAt(now, false) == false { | ||
vErr.err = "Token used before issued, clock skew issue?" | ||
vErr.Errors |= ValidationErrorIssuedAt | ||
} | ||
|
||
if m.VerifyNotBefore(now, false) == false { | ||
vErr.err = "Token is not valid yet" | ||
vErr.Errors |= ValidationErrorNotValidYet | ||
} | ||
|
||
if vErr.valid() { | ||
return nil | ||
} | ||
|
||
return vErr | ||
} | ||
|
||
func verifyAud(aud string, cmp string, required bool) bool { | ||
if aud == "" { | ||
return !required | ||
} | ||
if subtle.ConstantTimeCompare([]byte(aud), []byte(cmp)) != 0 { | ||
return true | ||
} else { | ||
return false | ||
} | ||
} | ||
|
||
func verifyExp(exp int64, now int64, required bool) bool { | ||
if exp == 0 { | ||
return !required | ||
} | ||
return now <= exp | ||
} | ||
|
||
func verifyIat(iat int64, now int64, required bool) bool { | ||
if iat == 0 { | ||
return !required | ||
} | ||
return now >= iat | ||
} | ||
|
||
func verifyIss(iss string, cmp string, required bool) bool { | ||
if iss == "" { | ||
return !required | ||
} | ||
if subtle.ConstantTimeCompare([]byte(iss), []byte(cmp)) != 0 { | ||
return true | ||
} else { | ||
return false | ||
} | ||
} | ||
|
||
func verifyNbf(nbf int64, now int64, required bool) bool { | ||
if nbf == 0 { | ||
return !required | ||
} | ||
return now >= nbf | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters