webtoken

Documentation

Index

• Variables
• type Configuration
  • func New(secret []byte) *Configuration
  • func (c *Configuration) Generate(userID string, duration time.Duration) (string, error)
  • func (c *Configuration) SetClock(clock IClock)
  • func (c *Configuration) Verify(s string) (string, error)
• type IClock
• type SecretKey
  • func (k *SecretKey) UnmarshalJSON(b []byte) error

Variables

var (
	// ErrNotValidYet is when a token is used prior to the issue date.
	ErrNotValidYet = errors.New("token is not valid yet")
	// ErrExpired is when a token is used after the expiration date.
	ErrExpired = errors.New("token is expired")
	// ErrMalformed is when a token is malformed.
	ErrMalformed = errors.New("token is malformed")
	// ErrSignatureInvalid is when a signature is invalid.
	ErrSignatureInvalid = errors.New("signature is invalid")
	// ErrAudienceInvalid is when the audience is invalid.
	ErrAudienceInvalid = errors.New("audience is invalid")
	// ErrExpirationInvalid is when the expiration is invalid.
	ErrExpirationInvalid = errors.New("expiration is invalid")
	// ErrIssuedAtInvalid is when the issued date is invalid.
	ErrIssuedAtInvalid = errors.New("issue date is invalid")
	// ErrNotBeforeInvalid is when the before date is invalid.
	ErrNotBeforeInvalid = errors.New("before date is invalid")
	// ErrSecretTooShort is when the secret is not long enough.
	ErrSecretTooShort = errors.New("secret must be 256 bit (32 bytes)")
)

Types

type Configuration

type Configuration struct {
	Secret SecretKey `json:"Secret"`
	// contains filtered or unexported fields
}

Configuration contains the JWT dependencies.

func New

func New(secret []byte) *Configuration

New creates a new JWT configuration.

func (*Configuration) Generate

func (c *Configuration) Generate(userID string, duration time.Duration) (string, error)

Generate will generate a JWT.

func (*Configuration) SetClock

func (c *Configuration) SetClock(clock IClock)

SetClock will set the clock.

func (*Configuration) Verify

func (c *Configuration) Verify(s string) (string, error)

Verify will ensure a JWT is valid.

type IClock

type IClock interface {
	Now() time.Time
}

IClock represents a system clock.

type SecretKey

type SecretKey []byte

SecretKey is a byte array.

func (*SecretKey) UnmarshalJSON

func (k *SecretKey) UnmarshalJSON(b []byte) error

UnmarshalJSON will unmarshal the value from a base64 encoded value.