Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

ginjwt

package

Go to main page

Versions in this module

v0

v0.6.3

Mar 27, 2024

v0.6.2

Oct 19, 2023

v0.6.1

Jul 17, 2023

v0.6.0

May 16, 2023

v0.5.1

Feb 14, 2023

v0.5.0

Feb 13, 2023

Changes in this version

+ var ErrJWKSConfigConflict = errors.New("JWKS and JWKSURI can't both be set at the same time")

type AuthConfig

+ JWKS jose.JSONWebKeySet

v0.4.1

Oct 25, 2022

Changes in this version

+ func BindFlagFromViperInst(v *viper.Viper, name string, flag *pflag.Flag)

v0.4.0

Oct 14, 2022

v0.3.1

Oct 6, 2022

v0.3.0

Jul 20, 2022

Changes in this version

type AuthConfig

+ RoleValidationStrategy RoleValidationStrategy

type OIDCConfig

+ RoleValidationStrategy RoleValidationStrategy

+ type RoleValidationStrategy string

+ const RoleValidationStrategyAll

+ const RoleValidationStrategyAny

v0.2.0

Jul 15, 2022

v0.1.5

Jun 14, 2022

Changes in this version

type AuthConfig

+ JWKSRemoteTimeout time.Duration

type OIDCConfig

+ JWKSRemoteTimeout time.Duration

v0.1.4

Apr 27, 2022

Changes in this version

type Middleware

+ func (m *Middleware) RequiredScopes(scopes []string) gin.HandlerFunc

+ func (m *Middleware) VerifyScopes(c *gin.Context, scopes []string) error

+ func (m *Middleware) VerifyTokenWithScopes(c *gin.Context, scopes []string) (ginauth.ClaimMetadata, error)

v0.1.3

Mar 1, 2022

Changes in this version

+ var ErrInvalidAuthConfig = errors.New("invalid oidc config provided")

+ var ErrMissingAuthConfig = errors.New("oidc auth config wasn't provided")

+ type Claims struct

+ Roles string

+ Username string

+ type OIDCConfig struct

+ Audience string

+ Claims Claims

+ Enabled bool

+ Issuer string

+ JWKSURI string

v0.1.2

Feb 24, 2022

v0.1.1

Feb 23, 2022

Changes in this version

+ func NewMultiTokenMiddlewareFromConfigs(cfgs ...AuthConfig) (*ginauth.MultiTokenMiddleware, error)

v0.1.0

Feb 18, 2022

Changes in this version

+ var ErrInvalidAudience = errors.New("invalid JWT audience")

+ var ErrInvalidIssuer = errors.New("invalid JWT issuer")

+ var ErrIssuersDontMatchJWKURIs = errors.New("the number of issuers doesn't match the number of JWK URIs")

+ var ErrMissingIssuerFlag = errors.New("issuer wasn't provided")

+ var ErrMissingJWKURIFlag = errors.New("JWK URI wasn't provided")

+ func CreateScopes(items ...string) []string

+ func DeleteScopes(items ...string) []string

+ func GetSubject(c *gin.Context) string

+ func GetUser(c *gin.Context) string

+ func NewMultiTokenMiddlwareFromConfigs(cfgs ...AuthConfig) (*ginauth.MultiTokenMiddleware, error)

+ func ReadScopes(items ...string) []string

+ func RegisterViperOIDCFlags(v *viper.Viper, cmd *cobra.Command)

+ func UpdateScopes(items ...string) []string

+ func ViperBindFlag(name string, flag *pflag.Flag)

+ type AuthConfig struct

+ Audience string

+ Enabled bool

+ Issuer string

+ JWKSURI string

+ LogFields []string

+ RolesClaim string

+ UsernameClaim string

+ func GetAuthConfigFromFlags(v *viper.Viper) (AuthConfig, error)

+ func GetAuthConfigsFromFlags(v *viper.Viper) ([]AuthConfig, error)

+ type Middleware struct

+ func NewAuthMiddleware(cfg AuthConfig) (*Middleware, error)

+ func (m *Middleware) AuthRequired(scopes []string) gin.HandlerFunc

+ func (m *Middleware) SetMetadata(c *gin.Context, cm ginauth.ClaimMetadata)

+ func (m *Middleware) VerifyToken(c *gin.Context, scopes []string) (ginauth.ClaimMetadata, error)