zbaseauth

README

zbaseauth

bearer 认证

获得zbaseauth

go get -u github.com/zlyuancn/zbaseauth

导入zbaseauth

import "github.com/zlyuancn/zbaseauth"

实例

    auth := zbaseauth.New(
        zbaseauth.WithSecret([]byte("your_secret")),
        zbaseauth.WithUser("username", "password"),
    )

    app := iris.Default()
    
    // 此处路由用于用户登录
    app.Post("/admin/auth", auth.Authentication())

    // 此处所有路由必须鉴权后才能访问
    admin := app.Party("/admin", auth.MustAuth())
    {
        admin.Get("/me", func(ctx context.Context) {
            _, _ = ctx.WriteString("[get] /admin")
        })
        admin.Post("/me", func(ctx context.Context) {
            _, _ = ctx.WriteString("[post] /admin")
        })
    }

    _ = app.Run(iris.Addr(":8080"))

访问

// 登录
[POST] http://127.0.0.1:8080/admin/auth
  {
    "user": "username",
    "pwd": "password"
  }

// 鉴权访问
[Headers] Authorization: Bearer token
[GET] http://127.0.0.1:8080/admin/me

所有的选项

// 设置秘钥, 它影响token生成和解析
WithSecret(secret []byte)
// 添加一个用户
WithUser(name, pwd string)
// 添加用户列表
WithUserList(users map[string]string)
// 设置是否自动续期, 默认为true
WithAutoKeepAlive(on bool)
// 设置存活时间, 单位为纳秒, 默认为600e9
WithTTL(ttl time.Duration)
// 设置认证通过的自定义返回数据
WithAuthOkFn(fn func(token string) string)
// 设置认证失败的自定义返回数据
WithAuthErrFn(fn func(err error) string)

Documentation

Index

• Constants
• Variables
• func New(opts ...Option) *config
• type JWTData
  • func NewJWT(user string) *JWTData
  • func (m *JWTData) GetString(secret []byte) (string, error)
  • func (m *JWTData) ParserString(tokenString string, secret []byte) error
  • func (m *JWTData) SetExpires(t time.Duration)
• type Option
  • func WithAuthErrFn(fn func(err error) string) Option
  • func WithAuthOkFn(fn func(token string) string) Option
  • func WithAutoKeepAlive(on bool) Option
  • func WithSecret(secret []byte) Option
  • func WithTTL(ttl time.Duration) Option
  • func WithUser(name, pwd string) Option
  • func WithUserList(users map[string]string) Option
• type User

Constants

const (
	DefaultHeadersAuthField = "Authorization"
	DefaultTokenPrefix      = "Bearer "
)

Variables

var (
	DefaultSecret               = []byte("zbaseauth_secret")
	DefaultTTL    time.Duration = 600e9
)

var (
	DefaultJWTAlgorithm     = jwt.SigningMethodHS512
	DefaultJWTAlgorithmName = "HS512"
)

Functions

func New

func New(opts ...Option) *config

Types

type JWTData

type JWTData struct {
	jwt.StandardClaims
	User string `json:"user"`
}

func NewJWT

func NewJWT(user string) *JWTData

func (*JWTData) GetString

func (m *JWTData) GetString(secret []byte) (string, error)

获取jwt签名后的字符串

func (*JWTData) ParserString

func (m *JWTData) ParserString(tokenString string, secret []byte) error

解析jwt数据

func (*JWTData) SetExpires

func (m *JWTData) SetExpires(t time.Duration)

设置jwt超时时间(纳秒)

type Option

type Option func(conf *config)

func WithAuthErrFn

func WithAuthErrFn(fn func(err error) string) Option

设置认证失败的自定义返回数据

func WithAuthOkFn

func WithAuthOkFn(fn func(token string) string) Option

设置认证通过的自定义返回数据

func WithAutoKeepAlive

func WithAutoKeepAlive(on bool) Option

设置是否自动续期, 默认为true

func WithSecret

func WithSecret(secret []byte) Option

设置秘钥, 它影响token生成和解析

func WithTTL

func WithTTL(ttl time.Duration) Option

设置存活时间, 单位为纳秒, 默认为600e9

func WithUser

func WithUser(name, pwd string) Option

添加一个用户

func WithUserList

func WithUserList(users map[string]string) Option

添加用户列表

type User

type User struct {
	User string `json:"user"`
	Pwd  string `json:"pwd"`
}