auth

package

v0.0.0-...-9ed9871 Latest Latest Go to latest Published: Aug 22, 2023 License: MIT Imports: 5 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

View Source

var (
	RoleAdmin = Role{"ADMIN"}
	RoleUser  = Role{"USER"}
)

func SetClaims(ctx context.Context, claims Claims) context.Context

type Auth struct {
	// contains filtered or unexported fields
}

Auth is to used for authenticate clients

func New(activeKID string, keyLookup KeyLookup) (*Auth, error)

func (a *Auth) GenerateToken(claims Claims) (string, error)

func (a *Auth) ValidateToken(tokenString string) (Claims, error)

type Claims struct {
	jwt.RegisteredClaims `json:"registered"`
	Roles                []Role `json:"roles"`
}

func GetClaims(ctx context.Context) (Claims, error)

func (c Claims) Authorized(roles ...Role) bool

type KeyLookup interface {
	PrivateKey(kid string) (*rsa.PrivateKey, error)
	PublicKey(kid string) (*rsa.PublicKey, error)
}

private and public keys for JWT use

type Role struct {
	// contains filtered or unexported fields
}

func MustParseRole(value string) Role

func ParseRole(value string) (Role, error)

func (r Role) Equal(other Role) bool

func (r *Role) MarshalText() ([]byte, error)

func (r Role) Name() string

func (r *Role) UnmarshalText(data []byte) error