forked from mirror/jwt
118 lines
3.9 KiB
Go
118 lines
3.9 KiB
Go
package jwt_test
|
|
|
|
import (
|
|
"errors"
|
|
"fmt"
|
|
"time"
|
|
|
|
"git.internal/re/jwt/v4"
|
|
)
|
|
|
|
// Example (atypical) using the RegisteredClaims type by itself to parse a token.
|
|
// The RegisteredClaims 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.
|
|
// See the CustomClaimsType example for intended usage.
|
|
func ExampleNewWithClaims_registeredClaims() {
|
|
mySigningKey := []byte("AllYourBase")
|
|
|
|
// Create the Claims
|
|
claims := &jwt.RegisteredClaims{
|
|
ExpiresAt: jwt.NewNumericDate(time.Unix(1516239022, 0)),
|
|
Issuer: "test",
|
|
}
|
|
|
|
token := jwt.NewWithClaims(jwt.SigningMethodHS256, claims)
|
|
ss, err := token.SignedString(mySigningKey)
|
|
fmt.Printf("%v %v", ss, err)
|
|
// Output: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJ0ZXN0IiwiZXhwIjoxNTE2MjM5MDIyfQ.0XN_1Tpp9FszFOonIBpwha0c_SfnNI22DhTnjMshPg8 <nil>
|
|
}
|
|
|
|
// Example creating a token using a custom claims type. The RegisteredClaims is embedded
|
|
// in the custom type to allow for easy encoding, parsing and validation of registered claims.
|
|
func ExampleNewWithClaims_customClaimsType() {
|
|
mySigningKey := []byte("AllYourBase")
|
|
|
|
type MyCustomClaims struct {
|
|
Foo string `json:"foo"`
|
|
jwt.RegisteredClaims
|
|
}
|
|
|
|
// Create the claims
|
|
claims := MyCustomClaims{
|
|
"bar",
|
|
jwt.RegisteredClaims{
|
|
// A usual scenario is to set the expiration time relative to the current time
|
|
ExpiresAt: jwt.NewNumericDate(time.Now().Add(24 * time.Hour)),
|
|
IssuedAt: jwt.NewNumericDate(time.Now()),
|
|
NotBefore: jwt.NewNumericDate(time.Now()),
|
|
Issuer: "test",
|
|
Subject: "somebody",
|
|
ID: "1",
|
|
Audience: []string{"somebody_else"},
|
|
},
|
|
}
|
|
|
|
// Create claims while leaving out some of the optional fields
|
|
claims = MyCustomClaims{
|
|
"bar",
|
|
jwt.RegisteredClaims{
|
|
// Also fixed dates can be used for the NumericDate
|
|
ExpiresAt: jwt.NewNumericDate(time.Unix(1516239022, 0)),
|
|
Issuer: "test",
|
|
},
|
|
}
|
|
|
|
token := jwt.NewWithClaims(jwt.SigningMethodHS256, claims)
|
|
ss, err := token.SignedString(mySigningKey)
|
|
fmt.Printf("%v %v", ss, err)
|
|
|
|
// Output: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJmb28iOiJiYXIiLCJpc3MiOiJ0ZXN0IiwiZXhwIjoxNTE2MjM5MDIyfQ.xVuY2FZ_MRXMIEgVQ7J-TFtaucVFRXUzHm9LmV41goM <nil>
|
|
}
|
|
|
|
// Example creating a token using a custom claims type. The StandardClaim is embedded
|
|
// in the custom type to allow for easy encoding, parsing and validation of standard claims.
|
|
func ExampleParseWithClaims_customClaimsType() {
|
|
tokenString := "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJmb28iOiJiYXIiLCJpc3MiOiJ0ZXN0IiwiYXVkIjoic2luZ2xlIn0.QAWg1vGvnqRuCFTMcPkjZljXHh8U3L_qUjszOtQbeaA"
|
|
|
|
type MyCustomClaims struct {
|
|
Foo string `json:"foo"`
|
|
jwt.RegisteredClaims
|
|
}
|
|
|
|
token, err := jwt.ParseWithClaims(tokenString, &MyCustomClaims{}, func(token *jwt.Token) (interface{}, error) {
|
|
return []byte("AllYourBase"), nil
|
|
})
|
|
|
|
if claims, ok := token.Claims.(*MyCustomClaims); ok && token.Valid {
|
|
fmt.Printf("%v %v", claims.Foo, claims.RegisteredClaims.Issuer)
|
|
} else {
|
|
fmt.Println(err)
|
|
}
|
|
|
|
// Output: bar test
|
|
}
|
|
|
|
// An example of parsing the error types using bitfield checks
|
|
func ExampleParse_errorChecking() {
|
|
// Token from another example. This token is expired
|
|
tokenString := "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJmb28iOiJiYXIiLCJleHAiOjE1MDAwLCJpc3MiOiJ0ZXN0In0.HE7fK0xOQwFEr4WDgRWj4teRPZ6i3GLwD5YCm6Pwu_c"
|
|
|
|
token, err := jwt.Parse(tokenString, func(token *jwt.Token) (interface{}, error) {
|
|
return []byte("AllYourBase"), nil
|
|
})
|
|
|
|
if token.Valid {
|
|
fmt.Println("You look nice today")
|
|
} else if errors.Is(err, jwt.ErrTokenMalformed) {
|
|
fmt.Println("That's not even a token")
|
|
} else if errors.Is(err, jwt.ErrTokenExpired) || errors.Is(err, jwt.ErrTokenNotValidYet) {
|
|
// Token is either expired or not active yet
|
|
fmt.Println("Timing is everything")
|
|
} else {
|
|
fmt.Println("Couldn't handle this token:", err)
|
|
}
|
|
|
|
// Output: Timing is everything
|
|
}
|