token

Documentation

Index

• Variables
• func Sign(ctx *gin.Context, c Context, secret string) (tokenString string, err error)
• type Context
  • func Parse(tokenString string, secret string) (*Context, error)
  • func ParseRequest(c *gin.Context) (*Context, error)
  • func ParseToken(t string) (*Context, error)

Variables

var (
	// ErrMissingHeader means the `Authorization` header was empty.
	ErrMissingHeader = errors.New("the length of the `Authorization` header is zero")
	// ErrMissingToken means the `token` params was empty.
	ErrMissingToken = errors.New("missing token")
)

Functions

func Sign

func Sign(ctx *gin.Context, c Context, secret string) (tokenString string, err error)

Sign signs the context with the specified secret.

Types

type Context

type Context struct {
	ID       uint64
	Username string
}

Context is the context of the JSON view token.

func Parse

func Parse(tokenString string, secret string) (*Context, error)

Parse validates the token with the specified secret, and returns the context if the token was valid.

func ParseRequest

func ParseRequest(c *gin.Context) (*Context, error)

ParseRequest gets the token from the header and pass it to the Parse function to parses the token.

func ParseToken

func ParseToken(t string) (*Context, error)

ParseToken directly parse the token