easyjwt

README

easyjwt

Simple jwt in golang

easyjwt is used to generate jwt token and parse jwt token, use HS256 to sign the payload, support custom secret and expiration time, default expiration time is 1 hour.

Usage

normal:

// Your payload
data := map[string]interface{}{
    "name":  "Your name",
    "age":   18,
    "admin": true,
}

token, err := easyjwt.GenerateToken(data)
if err != nil {
    log.Fatal(err)
}

got, err := easyjwt.ParseToken(token)
if err != nil {
    log.Fatal(err)
}

custom:

var (
    // Custom secret string
    secret = "custom"

    // Custom token expiration time
    expire = time.Minute * 30

    // Your payload
    data   = map[string]interface{}{
        "name":  "Your name",
        "age":   18,
        "admin": true,
    }
)

token, err := easyjwt.GenerateCustomToken(data, secret, expire)
if err != nil {
    log.Fatal(err)
}

got, err := easyjwt.ParseCustomToken(token, secret)
if err != nil {
    log.Fatal(err)
}

Get Help

The fastest way to get response is to send email to my mail:

• zengxianglong0@gmail.com

LICENCE

Please refer to LICENSE file.

Documentation

Overview

Package easyjwt is used to generate jwt token and parse jwt token, use HS256 to sign the payload, support custom secret and expiration time.

Index

• Variables
• func GenerateCustomToken(payload map[string]interface{}, secret string, expire time.Duration) (string, error)
• func GenerateToken(payload map[string]interface{}) (string, error)
• func ParseCustomToken(tokenStr, secret string) (interface{}, error)
• func ParseToken(tokenStr string) (interface{}, error)

Variables

var (
	// ErrPayloadEmpty means the payload passed in is empty.
	ErrPayloadEmpty = fmt.Errorf("Payload is empty")

	// ErrExpiredToken means the token has expired.
	ErrExpiredToken = fmt.Errorf("Token was expired")

	// ErrSignatureInvalid means that the signature of the token is invalid.
	ErrSignatureInvalid = fmt.Errorf("Signature validation failed")

	// ErrUnknown means unknown error type.
	ErrUnknown = fmt.Errorf("Unknown error")
)

Functions

func GenerateCustomToken

func GenerateCustomToken(payload map[string]interface{}, secret string, expire time.Duration) (string, error)

GenerateCustomToken generates jwt token according to data, custom secret and expire time.

func GenerateToken

func GenerateToken(payload map[string]interface{}) (string, error)

GenerateToken generates jwt token with data.

func ParseCustomToken

func ParseCustomToken(tokenStr, secret string) (interface{}, error)

ParseCustomToken parses jwt token with custom secret and return data.

func ParseToken

func ParseToken(tokenStr string) (interface{}, error)

ParseToken parses jwt token and return data.