README
¶
Go JWT Service
This is a GO JWT service that provides a standardized way to generate, verify, and authenticate JSON Web Tokens (JWT).
Create Service
You can initialize the service with just a secret in this case 123.
By default the token expires in 24 hours
service := jwtservice.New("123")
You can also override options like expiration WithExpiration(exp time.Duration)
service := jwtservice.New("123", WithExpiration(12 * time.Hour))
Generate Token
service := jwtservice.New("123")
token, err := service.GenerateToken(jwtservice.Claims{"userId": 1})
Middleware Usage
service := jwtservice.New("123")
r := chi.NewRouter()
service.ApplyMiddleware(r)
Get Claims From Request Context
service := jwtservice.New("123")
token, err := service.GenerateToken(jwtservice.Claims{"userId": 1})
router := chi.NewRouter()
service.ApplyMiddleware(router)
router.Get("/admin", func(w http.ResponseWriter, r *http.Request) {
claims, err := service.ClaimsFromRequest(r)
fmt.Println(claims["userId"])
})
Credits
JWT Service uses mainly these packages:
Contributing
Feel free to create an issue or propose a pull request.
Follow the Code of Conduct.
Documentation
¶
Overview ¶
Package jwtservice provides a standardized way to generate, verify, and authenticate JWT.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Service ¶
type Service struct {
// contains filtered or unexported fields
}
Service defines the JWT service structure
func (*Service) ApplyMiddleware ¶
func (s *Service) ApplyMiddleware(router *chi.Mux)
ApplyMiddleware append Verifier and Authenticator middleware to the Mux middleware stack
func (*Service) ClaimsFromRequest ¶
ClaimsFromRequest parses token claims from request token
type ServiceOption ¶
type ServiceOption func(*Service)
ServiceOption defines functions for configuring JWT service
func WithCustomAuth ¶
func WithCustomAuth(auth *jwtauth.JWTAuth) ServiceOption
WithCustomAuth this allows overriding the default JWT auth instance
func WithExpiration ¶
func WithExpiration(exp time.Duration) ServiceOption
WithExpiration is an option to set the token expiration using time duration (default: 24 * time.Hour)
Source Files