auth

README

auth使用方法

描述：用户身份认证

安装

go get github.com/hanguangbaihuo/sparrow_cloud_go

配置前提

需要先配置JWT中间件，详见github.com/hanguangbaihuo/sparrow_cloud_go/middleware/jwt

使用方法

import (
	...
	"github.com/hanguangbaihuo/sparrow_cloud_go/middleware/jwt"
	"github.com/hanguangbaihuo/sparrow_cloud_go/middleware/auth"
)

func main() {
    // 初始化iris app
    app := iris.New()
    // 配置jwt中间件
    jwtMiddleware := jwt.DefaultJwtMiddleware("your_jwt_secret")
	app.Use(jwtMiddleware.Serve)
    ...
    // /test 接口需要认证才可以进行
    app.Get("/test", auth.IsAuthenticated, processRequest)
    app.Listen("8081")
}

获取auth User

user := ctx.Values().Get(auth.DefaultUserKey).(auth.User)
// user := ctx.Values().Get("user")
fmt.Println(user.ID, user.IsAuthenticated)

无需auth中间件获取User

user := auth.CheckUser(ctx)
fmt.Println(user.ID, user.IsAuthenticated)

Documentation

Index

• Constants
• Variables
• func ErrorHandler(ctx context.Context, err error)
• func IsAuthenticated(ctx context.Context)
• type User
  • func CheckUser(ctx context.Context) User

Constants

const DefaultUserKey = "user"

DefaultUserKey user

Variables

var (
	// ErrTokenMissing is the error value that it's returned when
	// a token is not found based on the token extractor.
	ErrTokenMissing = errors.New("this api requires authorization token")

	// ErrUserIDMissing is the error value when no user id found in jwt token
	ErrUserIDMissing = errors.New("authorization token missing user id")

	// ErrTokenType when parse jwt token, its type is not available type
	ErrTokenType = errors.New("token type error")
)

Functions

func ErrorHandler

func ErrorHandler(ctx context.Context, err error)

ErrorHandler is the default error handler. Use it to change the behavior for each error.

func IsAuthenticated

func IsAuthenticated(ctx context.Context)

IsAuthenticated is authentication middleware JWT middleware must be configured before this only when your api need be authenticated, you should configure this middleware, otherwise do not configure it

Types

type User

type User struct {
	ID              string
	IsAuthenticated bool
}

User is for authentication

func CheckUser

func CheckUser(ctx context.Context) User

CheckUser is a function to check token contains user id, return a User struct