Renamed RFC7519Claims to RegisteredClaims

claims.go

@@ -12,11 +12,13 @@ type Claims interface {
 	Valid() error
 }
 
-// RFC7519Claims are a structured version of the JWT Claims Set, as referenced at
-// https://datatracker.ietf.org/doc/html/rfc7519#section-4
+// RegisteredClaims are a structured version of the JWT Claims Set, restricted to
+// Registered Claim Names, as referenced at https://datatracker.ietf.org/doc/html/rfc7519#section-4
 //
-// See examples for how to use this with your own claim types
-type RFC7519Claims struct {
+// This type can be used on its own, but then additional private claim names will not be parsed.
+// The typical usecase is therefore to embedded this in your own claim type. See examples for how
+// to use this with your own claim types
+type RegisteredClaims struct {
 	// the `iss` (Issuer) claim. See https://datatracker.ietf.org/doc/html/rfc7519#section-4.1.1
 	Issuer string `json:"iss,omitempty"`
 
@@ -43,7 +45,7 @@ type RFC7519Claims struct {
 // 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 RFC7519Claims) Valid() error {
+func (c StructuredClaims) Valid() error {
 	vErr := new(ValidationError)
 	now := TimeFunc()
 
@@ -74,13 +76,13 @@ func (c RFC7519Claims) Valid() error {
 
 // VerifyAudience compares the aud claim against cmp.
 // If required is false, this method will return true if the value matches or is unset
-func (c *RFC7519Claims) VerifyAudience(cmp string, req bool) bool {
+func (c *StructuredClaims) VerifyAudience(cmp string, req bool) bool {
 	return verifyAud(c.Audience, cmp, req)
 }
 
 // VerifyExpiresAt compares the exp claim against cmp.
 // If required is false, this method will return true if the value matches or is unset
-func (c *RFC7519Claims) VerifyExpiresAt(cmp time.Time, req bool) bool {
+func (c *StructuredClaims) VerifyExpiresAt(cmp time.Time, req bool) bool {
 	if c.ExpiresAt == nil {
 		verifyExp(nil, cmp, req)
 	}
@@ -90,7 +92,7 @@ func (c *RFC7519Claims) VerifyExpiresAt(cmp time.Time, req bool) bool {
 
 // VerifyIssuedAt compares the iat claim against cmp.
 // If required is false, this method will return true if the value matches or is unset
-func (c *RFC7519Claims) VerifyIssuedAt(cmp time.Time, req bool) bool {
+func (c *StructuredClaims) VerifyIssuedAt(cmp time.Time, req bool) bool {
 	if c.IssuedAt == nil {
 		return verifyIat(nil, cmp, req)
 	}
@@ -100,7 +102,7 @@ func (c *RFC7519Claims) VerifyIssuedAt(cmp time.Time, req bool) bool {
 
 // VerifyNotBefore compares the nbf claim against cmp.
 // If required is false, this method will return true if the value matches or is unset
-func (c *RFC7519Claims) VerifyNotBefore(cmp time.Time, req bool) bool {
+func (c *StructuredClaims) VerifyNotBefore(cmp time.Time, req bool) bool {
 	if c.NotBefore == nil {
 		return verifyNbf(nil, cmp, req)
 	}
@@ -116,7 +118,7 @@ func (c *RFC7519Claims) VerifyNotBefore(cmp time.Time, req bool) bool {
 //
 // See examples for how to use this with your own claim types
 //
-// Deprecated: Use RFC7519Claims instead.
+// Deprecated: Use StructuredClaims instead for a forward-compatible way to access claims in a struct.
 type StandardClaims struct {
 	Audience  string `json:"aud,omitempty"`
 	ExpiresAt int64  `json:"exp,omitempty"`

example_test.go

@@ -7,7 +7,7 @@ import (
 	"github.com/golang-jwt/jwt"
 )
 
-// Example (atypical) using the StandardClaims type by itself to parse a token.
+// Example (atypical) using the StructuredClaims type by itself to parse a token.
 // The StandardClaims type is designed to be embedded into your custom types
 // to provide standard validation features.  You can use it alone, but there's
 // no way to retrieve other fields after parsing.

parser_test.go

@@ -185,7 +185,7 @@ var jwtTestData = []struct {
 		"RFC7519 Claims",
 		"",
 		defaultKeyFunc,
-		&jwt.RFC7519Claims{
+		&jwt.StructuredClaims{
 			ExpiresAt: jwt.NewNumericDate(time.Now().Add(time.Second * 10)),
 		},
 		true,
@@ -217,8 +217,8 @@ func TestParser_Parse(t *testing.T) {
 			token, err = parser.ParseWithClaims(data.tokenString, jwt.MapClaims{}, data.keyfunc)
 		case *jwt.StandardClaims:
 			token, err = parser.ParseWithClaims(data.tokenString, &jwt.StandardClaims{}, data.keyfunc)
-		case *jwt.RFC7519Claims:
-			token, err = parser.ParseWithClaims(data.tokenString, &jwt.RFC7519Claims{}, data.keyfunc)
+		case *jwt.StructuredClaims:
+			token, err = parser.ParseWithClaims(data.tokenString, &jwt.StructuredClaims{}, data.keyfunc)
 		}
 
 		// Verify result matches expectation
@@ -283,8 +283,8 @@ func TestParser_ParseUnverified(t *testing.T) {
 			token, _, err = parser.ParseUnverified(data.tokenString, jwt.MapClaims{})
 		case *jwt.StandardClaims:
 			token, _, err = parser.ParseUnverified(data.tokenString, &jwt.StandardClaims{})
-		case *jwt.RFC7519Claims:
-			token, _, err = parser.ParseUnverified(data.tokenString, &jwt.RFC7519Claims{})
+		case *jwt.StructuredClaims:
+			token, _, err = parser.ParseUnverified(data.tokenString, &jwt.StructuredClaims{})
 		}
 
 		if err != nil {