gwt

Documentation

Overview

Package gwt implements an api token manager with rsa crypto

Index

• func Config(secret string, encoding string)
• func IsExpired(err error) bool
• func ParseToken(tokenString string, v interface{}) (err error)
• func ParseTokenBy(issuer string, tokenString string, v interface{}) (err error)
• func SignToken(payload interface{}, expires time.Duration) (token string, err error)
• func SignTokenBy(issuer string, payload interface{}, expires time.Duration) (token string, err error)
• type Channel
• type GWT
  • func (gwt *GWT) ParseToken(tokenString string, v interface{}) (err error)
  • func (gwt *GWT) ParseTokenBy(issuer string, tokenString string, v interface{}) (err error)
  • func (gwt *GWT) SignToken(payload interface{}, expires time.Duration) (token string, err error)
  • func (gwt *GWT) SignTokenBy(issuer string, payload interface{}, expires time.Duration) (token string, err error)

Functions

func Config

func Config(secret string, encoding string)

Config sets the secret and encoding of the default GWT

func IsExpired

func IsExpired(err error) bool

IsExpired returns a boolean indicating whether the error is known to report that a gwt token is expired.

func ParseToken

func ParseToken(tokenString string, v interface{}) (err error)

ParseToken parses a token

func ParseTokenBy

func ParseTokenBy(issuer string, tokenString string, v interface{}) (err error)

ParseTokenBy parses a token with issuer

func SignToken

func SignToken(payload interface{}, expires time.Duration) (token string, err error)

SignToken creates a token

func SignTokenBy

func SignTokenBy(issuer string, payload interface{}, expires time.Duration) (token string, err error)

SignTokenBy creates a token with issuer

Types

type Channel

type Channel struct {
	Payload   []byte
	ExpiresAt int64
	Issuer    string
}

Channel is a payload container includes expires and issuer for GWT

type GWT

type GWT struct {
	Secret   string
	Encoding string
}

GWT is an api token manager with rsa crypto

func (*GWT) ParseToken

func (gwt *GWT) ParseToken(tokenString string, v interface{}) (err error)

ParseToken parses a token

func (*GWT) ParseTokenBy

func (gwt *GWT) ParseTokenBy(issuer string, tokenString string, v interface{}) (err error)

ParseTokenBy parses a token with issuer

func (*GWT) SignToken

func (gwt *GWT) SignToken(payload interface{}, expires time.Duration) (token string, err error)

SignToken creates a token

func (*GWT) SignTokenBy

func (gwt *GWT) SignTokenBy(issuer string, payload interface{}, expires time.Duration) (token string, err error)

SignTokenBy creates a token with issuer