zdpgo_jwt

package module
v0.1.3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 16, 2022 License: MIT Imports: 17 Imported by: 0

README

zdpgo_jwt

使用Golang创建、刷新和校验JWT Token

项目地址：https://github.com/zhangdapeng520/zdpgo_jwt

功能清单

  • 创建token
  • 校验token
  • 刷新token

版本历史

  • v0.1.0 2022/03/09 新增：基本功能
  • v0.1.1 2022/04/04 新增：代码优化
  • v0.1.2 2022/04/05 新增：支持传递JSON字符串
  • v0.1.3 2022/07/16 优化：代码优化

使用示例

请查看 examples 目录

Documentation

Index

Constants

View Source 
const (
	ValidationErrorMalformed        uint32 = 1 << iota // Token is malformed
	ValidationErrorUnverifiable                        // Token could not be verified because of signing problems
	ValidationErrorSignatureInvalid                    // Signature validation failed

	// Standard Claim validation errors
	ValidationErrorAudience      // AUD validation failed
	ValidationErrorExpired       // EXP validation failed
	ValidationErrorIssuedAt      // IAT validation failed
	ValidationErrorIssuer        // ISS validation failed
	ValidationErrorNotValidYet   // NBF validation failed
	ValidationErrorId            // JTI validation failed
	ValidationErrorClaimsInvalid // Generic claims validation error
)

The errors that might occur when parsing and validating a token

View Source 
const UnsafeAllowNoneSignatureType unsafeNoneMagicConstant = "none signing method allowed"

Variables

View Source 
var (
	ErrNotECPublicKey  = errors.New("Key is not a valid ECDSA public key")
	ErrNotECPrivateKey = errors.New("Key is not a valid ECDSA private key")
)
View Source 
var (
	ErrInvalidKey      = errors.New("key is invalid")
	ErrInvalidKeyType  = errors.New("key is of invalid type")
	ErrHashUnavailable = errors.New("the requested hash function is unavailable")
)

Error constants

View Source 
var (
	TokenExpired     = errors.New("token已过期")
	TokenNotValidYet = errors.New("token校验失败")
	TokenMalformed   = errors.New("token格式错误")
	TokenInvalid     = errors.New("token无效")
)
View Source 
var (
	ErrKeyMustBePEMEncoded = errors.New("Invalid Key: Key must be PEM encoded PKCS1 or PKCS8 private key")
	ErrNotRSAPrivateKey    = errors.New("Key is not a valid RSA private key")
	ErrNotRSAPublicKey     = errors.New("Key is not a valid RSA public key")
)
View Source 
var (
	// Sadly this is missing from crypto/ecdsa compared to crypto/rsa
	ErrECDSAVerification = errors.New("crypto/ecdsa: verification error")
)
View Source 
var NoneSignatureTypeDisallowedError error
View Source 
var SigningMethodNone *signingMethodNone

Implements the none signing method. This is required by the spec but you probably should never use it.

View Source 
var TimeFunc = time.Now

TimeFunc provides the current time when parsing token to validate "exp" claim (expiration time). You can override it to use another time value. This is useful for testing or if your server uses a different time zone than your tokens.

Functions

func DecodeSegment added in v0.1.3 

func DecodeSegment(seg string) ([]byte, error)

Decode JWT specific base64url encoding with padding stripped

func EncodeSegment added in v0.1.3 

func EncodeSegment(seg []byte) string

Encode JWT specific base64url encoding with padding stripped

func ParseECPrivateKeyFromPEM added in v0.1.3 

func ParseECPrivateKeyFromPEM(key []byte) (*ecdsa.PrivateKey, error)

Parse PEM encoded Elliptic Curve Private Key Structure

func ParseECPublicKeyFromPEM added in v0.1.3 

func ParseECPublicKeyFromPEM(key []byte) (*ecdsa.PublicKey, error)

Parse PEM encoded PKCS1 or PKCS8 public key

func ParseRSAPrivateKeyFromPEM added in v0.1.3 

func ParseRSAPrivateKeyFromPEM(key []byte) (*rsa.PrivateKey, error)

Parse PEM encoded PKCS1 or PKCS8 private key

func ParseRSAPrivateKeyFromPEMWithPassword added in v0.1.3 

func ParseRSAPrivateKeyFromPEMWithPassword(key []byte, password string) (*rsa.PrivateKey, error)

Parse PEM encoded PKCS1 or PKCS8 private key protected with password

func ParseRSAPublicKeyFromPEM added in v0.1.3 

func ParseRSAPublicKeyFromPEM(key []byte) (*rsa.PublicKey, error)

Parse PEM encoded PKCS1 or PKCS8 public key

func RegisterSigningMethod added in v0.1.3 

func RegisterSigningMethod(alg string, f func() SigningMethod)

Register the "alg" name and a factory function for signing method. This is typically done during init() in the method's implementation

Types

type Claims added in v0.1.3 

type Claims interface {
	Valid() error
}

For a type to be a Claims object, it must just have a Valid method that determines if the token is invalid for any supported reason

type ClaimsData added in v0.1.3 

type ClaimsData struct {
	UserId    string                 `json:"user_id"`   // 用户ID，可能是整数ID，也可能是UUID
	Username  string                 `json:"username"`  // 用户名称
	UserType  string                 `json:"user_type"` // 用户类型（username,email,phone）
	Role      uint                   `json:"role"`      // 用户角色
	Data      map[string]interface{} `json:"data"`      // 要传递的其他数据
	Audience  string                 `json:"aud,omitempty"`
	ExpiresAt int64                  `json:"exp,omitempty"`
	Id        string                 `json:"jti,omitempty"`
	IssuedAt  int64                  `json:"iat,omitempty"`
	Issuer    string                 `json:"iss,omitempty"`
	NotBefore int64                  `json:"nbf,omitempty"`
	Subject   string                 `json:"sub,omitempty"`
}

Structured version of Claims Section, as referenced at https://tools.ietf.org/html/rfc7519#section-4.1 See examples for how to use this with your own claim types

func (ClaimsData) Valid added in v0.1.3 

func (c ClaimsData) Valid() error

Validates time based claims "exp, iat, nbf". There is no accounting for clock skew. As well, if any of the above claims are not in the token, it will still be considered a valid claim.

func (*ClaimsData) VerifyAudience added in v0.1.3 

func (c *ClaimsData) VerifyAudience(cmp string, req bool) bool

Compares the aud claim against cmp. If required is false, this method will return true if the value matches or is unset

func (*ClaimsData) VerifyExpiresAt added in v0.1.3 

func (c *ClaimsData) VerifyExpiresAt(cmp int64, req bool) bool

Compares the exp claim against cmp. If required is false, this method will return true if the value matches or is unset

func (*ClaimsData) VerifyIssuedAt added in v0.1.3 

func (c *ClaimsData) VerifyIssuedAt(cmp int64, req bool) bool

Compares the iat claim against cmp. If required is false, this method will return true if the value matches or is unset

func (*ClaimsData) VerifyIssuer added in v0.1.3 

func (c *ClaimsData) VerifyIssuer(cmp string, req bool) bool

Compares the iss claim against cmp. If required is false, this method will return true if the value matches or is unset

func (*ClaimsData) VerifyNotBefore added in v0.1.3 

func (c *ClaimsData) VerifyNotBefore(cmp int64, req bool) bool

Compares the nbf claim against cmp. If required is false, this method will return true if the value matches or is unset

type Config added in v0.1.3 

type Config struct {
	Key     string `yaml:"key" json:"key"`         // jwt加密的key
	Expired uint16 `yaml:"expired" json:"expired"` // token过期时间（秒），默认15分钟
}

Config jwt配置

type Jwt 

type Jwt struct {
	Config *Config // config配置对象
}

Jwt Jwt核心对象

func NewJwt added in v0.1.3 

func NewJwt() *Jwt

NewJwt 创建Jwt对象

func NewJwtWithConfig added in v0.1.3 

func NewJwtWithConfig(config *Config) *Jwt

NewJwtWithConfig 根据配置创建JWT对象

func (*Jwt) CreateToken 

func (j *Jwt) CreateToken(claims ClaimsData) (string, error)

CreateToken 创建一个token

func (*Jwt) ParseToken 

func (j *Jwt) ParseToken(tokenString string) (*ClaimsData, error)

ParseToken 解析 token

func (*Jwt) RefreshToken 

func (j *Jwt) RefreshToken(tokenString string) (string, error)

RefreshToken 更新token

type Keyfunc added in v0.1.3 

type Keyfunc func(*Token) (interface{}, error)

Parse methods use this callback function to supply the key for verification. The function receives the parsed, but unverified Token. This allows you to use properties in the Header of the token (such as `kid`) to identify which key to use.

type MapClaims added in v0.1.3 

type MapClaims map[string]interface{}

Claims type that uses the map[string]interface{} for JSON decoding This is the default claims type if you don't supply one

func (MapClaims) Valid added in v0.1.3 

func (m MapClaims) Valid() error

Validates time based claims "exp, iat, nbf". There is no accounting for clock skew. As well, if any of the above claims are not in the token, it will still be considered a valid claim.

func (MapClaims) VerifyAudience added in v0.1.3 

func (m MapClaims) VerifyAudience(cmp string, req bool) bool

Compares the aud claim against cmp. If required is false, this method will return true if the value matches or is unset

func (MapClaims) VerifyExpiresAt added in v0.1.3 

func (m MapClaims) VerifyExpiresAt(cmp int64, req bool) bool

Compares the exp claim against cmp. If required is false, this method will return true if the value matches or is unset

func (MapClaims) VerifyIssuedAt added in v0.1.3 

func (m MapClaims) VerifyIssuedAt(cmp int64, req bool) bool

Compares the iat claim against cmp. If required is false, this method will return true if the value matches or is unset

func (MapClaims) VerifyIssuer added in v0.1.3 

func (m MapClaims) VerifyIssuer(cmp string, req bool) bool

Compares the iss claim against cmp. If required is false, this method will return true if the value matches or is unset

func (MapClaims) VerifyNotBefore added in v0.1.3 

func (m MapClaims) VerifyNotBefore(cmp int64, req bool) bool

Compares the nbf claim against cmp. If required is false, this method will return true if the value matches or is unset

type Parser added in v0.1.3 

type Parser struct {
	ValidMethods         []string // If populated, only these methods will be considered valid
	UseJSONNumber        bool     // Use JSON Number format in JSON decoder
	SkipClaimsValidation bool     // Skip claims validation during token parsing
}

func (*Parser) Parse added in v0.1.3 

func (p *Parser) Parse(tokenString string, keyFunc Keyfunc) (*Token, error)

Parse, validate, and return a token. keyFunc will receive the parsed token and should return the key for validating. If everything is kosher, err will be nil

func (*Parser) ParseUnverified added in v0.1.3 

func (p *Parser) ParseUnverified(tokenString string, claims Claims) (token *Token, parts []string, err error)

WARNING: Don't use this method unless you know what you're doing

This method parses the token but doesn't validate the signature. It's only ever useful in cases where you know the signature is valid (because it has been checked previously in the stack) and you want to extract values from it.

func (*Parser) ParseWithClaims added in v0.1.3 

func (p *Parser) ParseWithClaims(tokenString string, claims Claims, keyFunc Keyfunc) (*Token, error)

type SigningMethod added in v0.1.3 

type SigningMethod interface {
	Verify(signingString, signature string, key interface{}) error // Returns nil if signature is valid
	Sign(signingString string, key interface{}) (string, error)    // Returns encoded signature or error
	Alg() string                                                   // returns the alg identifier for this method (example: 'HS256')
}

Implement SigningMethod to add new methods for signing or verifying tokens.

func GetSigningMethod added in v0.1.3 

func GetSigningMethod(alg string) (method SigningMethod)

Get a signing method from an "alg" string

type SigningMethodECDSA added in v0.1.3 

type SigningMethodECDSA struct {
	Name      string
	Hash      crypto.Hash
	KeySize   int
	CurveBits int
}

Implements the ECDSA family of signing methods signing methods Expects *ecdsa.PrivateKey for signing and *ecdsa.PublicKey for verification 

var (
	SigningMethodES256 *SigningMethodECDSA
	SigningMethodES384 *SigningMethodECDSA
	SigningMethodES512 *SigningMethodECDSA
)

Specific instances for EC256 and company

func (*SigningMethodECDSA) Alg added in v0.1.3 

func (m *SigningMethodECDSA) Alg() string

func (*SigningMethodECDSA) Sign added in v0.1.3 

func (m *SigningMethodECDSA) Sign(signingString string, key interface{}) (string, error)

Implements the Sign method from SigningMethod For this signing method, key must be an ecdsa.PrivateKey struct

func (*SigningMethodECDSA) Verify added in v0.1.3 

func (m *SigningMethodECDSA) Verify(signingString, signature string, key interface{}) error

Implements the Verify method from SigningMethod For this verify method, key must be an ecdsa.PublicKey struct

type SigningMethodHMAC added in v0.1.3 

type SigningMethodHMAC struct {
	Name string
	Hash crypto.Hash
}

Implements the HMAC-SHA family of signing methods signing methods Expects key type of []byte for both signing and validation 

var (
	SigningMethodHS256  *SigningMethodHMAC
	SigningMethodHS384  *SigningMethodHMAC
	SigningMethodHS512  *SigningMethodHMAC
	ErrSignatureInvalid = errors.New("signature is invalid")
)

Specific instances for HS256 and company

func (*SigningMethodHMAC) Alg added in v0.1.3 

func (m *SigningMethodHMAC) Alg() string

func (*SigningMethodHMAC) Sign added in v0.1.3 

func (m *SigningMethodHMAC) Sign(signingString string, key interface{}) (string, error)

Implements the Sign method from SigningMethod for this signing method. Key must be []byte

func (*SigningMethodHMAC) Verify added in v0.1.3 

func (m *SigningMethodHMAC) Verify(signingString, signature string, key interface{}) error

Verify the signature of HSXXX tokens. Returns nil if the signature is valid.

type SigningMethodRSA added in v0.1.3 

type SigningMethodRSA struct {
	Name string
	Hash crypto.Hash
}

Implements the RSA family of signing methods signing methods Expects *rsa.PrivateKey for signing and *rsa.PublicKey for validation 

var (
	SigningMethodRS256 *SigningMethodRSA
	SigningMethodRS384 *SigningMethodRSA
	SigningMethodRS512 *SigningMethodRSA
)

Specific instances for RS256 and company

func (*SigningMethodRSA) Alg added in v0.1.3 

func (m *SigningMethodRSA) Alg() string

func (*SigningMethodRSA) Sign added in v0.1.3 

func (m *SigningMethodRSA) Sign(signingString string, key interface{}) (string, error)

Implements the Sign method from SigningMethod For this signing method, must be an *rsa.PrivateKey structure.

func (*SigningMethodRSA) Verify added in v0.1.3 

func (m *SigningMethodRSA) Verify(signingString, signature string, key interface{}) error

Implements the Verify method from SigningMethod For this signing method, must be an *rsa.PublicKey structure.

type SigningMethodRSAPSS added in v0.1.3 

type SigningMethodRSAPSS struct {
	*SigningMethodRSA
	Options *rsa.PSSOptions
}

Implements the RSAPSS family of signing methods signing methods 

var (
	SigningMethodPS256 *SigningMethodRSAPSS
	SigningMethodPS384 *SigningMethodRSAPSS
	SigningMethodPS512 *SigningMethodRSAPSS
)

Specific instances for RS/PS and company

func (*SigningMethodRSAPSS) Sign added in v0.1.3 

func (m *SigningMethodRSAPSS) Sign(signingString string, key interface{}) (string, error)

Implements the Sign method from SigningMethod For this signing method, key must be an rsa.PrivateKey struct

func (*SigningMethodRSAPSS) Verify added in v0.1.3 

func (m *SigningMethodRSAPSS) Verify(signingString, signature string, key interface{}) error

Implements the Verify method from SigningMethod For this verify method, key must be an rsa.PublicKey struct

type Token 

type Token struct {
	Raw       string                 // The raw token.  Populated when you Parse a token
	Method    SigningMethod          // The signing method used or to be used
	Header    map[string]interface{} // 令牌的第一段
	Claims    Claims                 // 令牌的第二段
	Signature string                 // The third segment of the token.  Populated when you Parse a token
	Valid     bool                   // Is the token valid?  Populated when you Parse/Verify a token
}

A JWT Token. Different fields will be used depending on whether you're creating or parsing/verifying a token.

func New 

func New(method SigningMethod) *Token

Create a new Token. Takes a signing method

func NewWithClaims added in v0.1.3 

func NewWithClaims(method SigningMethod, claims Claims) *Token

func Parse 

func Parse(tokenString string, keyFunc Keyfunc) (*Token, error)

Parse, validate, and return a token. keyFunc will receive the parsed token and should return the key for validating. If everything is kosher, err will be nil

func ParseWithClaims added in v0.1.3 

func ParseWithClaims(tokenString string, claims Claims, keyFunc Keyfunc) (*Token, error)

func (*Token) SignedString added in v0.1.3 

func (t *Token) SignedString(key interface{}) (string, error)

Get the complete, signed token

func (*Token) SigningString added in v0.1.3 

func (t *Token) SigningString() (string, error)

Generate the signing string. This is the most expensive part of the whole deal. Unless you need this for something special, just go straight for the SignedString.

type ValidationError added in v0.1.3 

type ValidationError struct {
	Inner  error  // stores the error returned by external dependencies, i.e.: KeyFunc
	Errors uint32 // bitfield.  see ValidationError... constants
	// contains filtered or unexported fields
}

The error from Parse if token is not valid

func NewValidationError added in v0.1.3 

func NewValidationError(errorText string, errorFlags uint32) *ValidationError

Helper for constructing a ValidationError with a string error message

func (ValidationError) Error added in v0.1.3 

func (e ValidationError) Error() string

Validation error is an error type

Source Files

View all Source files

Directories

Path Synopsis
examples
base

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.