ujwt

package module

v0.1.0 Latest Latest Go to latest Published: Nov 2, 2019 License: MIT Imports: 3 Imported by: 1

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/aslrousta/ujwt

Documentation ¶

Index ¶

Variables
func Issue(secretKey, user, domain string, roles []string) (string, error)
func Parse(secretKey, token string, c *Claims) error
type Claims
- func (c *Claims) HasRole(role string) bool
- func (c *Claims) User() string

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	// ErrInvalidSecretKey reports that secret key is empty.
	ErrInvalidSecretKey = errors.New("secret key is empty")

	// ErrInvalidSiginingMethod reports that signing method is invalid.
	ErrInvalidSiginingMethod = errors.New("invalid signing method")

	// ErrInvalidUser reports that user is empty.
	ErrInvalidUser = errors.New("user is empty")
)

Functions ¶

func Issue ¶

func Issue(secretKey, user, domain string, roles []string) (string, error)

Issue creates a new JWT.

func Parse ¶

func Parse(secretKey, token string, c *Claims) error

Parse validates and decrypts a JWT and fills c with its payload.

Types ¶

type Claims ¶

type Claims struct {
	jwt.StandardClaims
	Roles []string `json:"roles,omitempty"`
}

Claims is the payload for JWT.

func (*Claims) HasRole ¶

func (c *Claims) HasRole(role string) bool

HasRole returns true if claim has a specific role, and false otherwise.

func (*Claims) User ¶

func (c *Claims) User() string

User returns the authenticated user.

Source Files ¶

View all Source files

ujwt.go

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