authorization

package

v0.0.0-...-ebd6d4f Latest Latest Go to latest Published: Apr 4, 2024 License: Apache-2.0 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

Repository

github.com/energietransitie/twomes-backoffice-api

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func NewToken(kind AuthKind, id uint, expiry time.Time, key crypto.PrivateKey) (string, error)
func NewTokenFromAuthorization(auth Authorization, expiry time.Time, key crypto.PrivateKey) (string, error)
func ParseToken(tokenString string, pubkey crypto.PublicKey) (AuthKind, uint, *Claims, error)
type AuthKind
type Authorization
- func ParseTokenToAuthorization(tokenString string, pubkey crypto.PublicKey) (*Authorization, error)
- func (a *Authorization) IsKind(kind AuthKind) bool
type Claims

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	ErrInvalidSigningMethod = errors.New("invalid signing method")
	ErrInvalidToken         = errors.New("invalid token")
)

Functions ¶

func NewToken ¶

func NewToken(kind AuthKind, id uint, expiry time.Time, key crypto.PrivateKey) (string, error)

Create a new token of a specified kind, for specified ID.

func NewTokenFromAuthorization ¶

func NewTokenFromAuthorization(auth Authorization, expiry time.Time, key crypto.PrivateKey) (string, error)

Create a new token from an Authorization.

func ParseToken ¶

func ParseToken(tokenString string, pubkey crypto.PublicKey) (AuthKind, uint, *Claims, error)

Parse a signed token. Check if it is valid and return the kind of token and the corresponding ID.

Types ¶

type AuthKind ¶

type AuthKind string

Kind of authorization.

const (
	AdminToken             AuthKind = "adminToken"
	AccountToken           AuthKind = "accountToken"
	DeviceToken            AuthKind = "deviceToken"
	AccountActivationToken AuthKind = "accountActivationToken"
	InvalidToken           AuthKind = "invalidToken"
)

type Authorization ¶

type Authorization struct {
	Kind   AuthKind
	ID     uint
	Claims *Claims
}

An Authorization is used to check for permissions.

func ParseTokenToAuthorization ¶

func ParseTokenToAuthorization(tokenString string, pubkey crypto.PublicKey) (*Authorization, error)

func (*Authorization) IsKind ¶

func (a *Authorization) IsKind(kind AuthKind) bool

Returns if the Authorization is of the specified kind.

type Claims ¶

type Claims struct {
	jwt.RegisteredClaims
	Kind AuthKind `json:"kind"`
}

Claims contained in the JWT.

Source Files ¶

View all Source files

authorization.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL