Documentation ¶
Index ¶
- Constants
- func NewToken(config Config) (*jwt, error)
- type Claims
- type Config
- type Headers
- type Jwt
- type MockDescription
- func (s *MockDescription) Create(_ Claims, _ ...Headers) (string, error)
- func (s *MockDescription) GetClaims() Claims
- func (s *MockDescription) GetHeaders() Headers
- func (s *MockDescription) GetParseOptions() ParseOptions
- func (s *MockDescription) Parse(_ string, _ ...ParseOptions) (Token, string, error)
- type ParseOptions
- type Token
Constants ¶
View Source
const ( ValidationErrorMalformed = "token is malformed" ValidationErrorHeadersMalformed = "token headers are malformed" ValidationErrorClaimsMalformed = "token claims are malformed" ValidationErrorUnverifiable = "the token could not be verified due to problems with the generation of the test sample" ValidationErrorSignatureInvalid = "signature validation failed" ValidationErrorHeadersContentType = "header 'cty' validation failed" ValidationErrorHeadersKeyID = "header 'kid' validation failed" ValidationErrorHeadersCritical = "header 'crit' validation failed" ValidationErrorClaimsIssuer = "claim 'iss' validation failed" ValidationErrorClaimsSubject = "claim 'sub' validation failed" ValidationErrorClaimsAudience = "claim 'aud' validation failed" ValidationErrorClaimsExpired = "claim 'exp' validation failed" ValidationErrorClaimsNotValidYet = "claim 'nbf' validation failed" ValidationErrorClaimsIssuedAt = "claim 'iat' validation failed" ValidationErrorClaimsJwtId = "claim 'jti' validation failed" ValidationErrorClaimsSessionID = "claim 'sessionID' validation failed" ValidationErrorClaimsData = "claim 'data' validation failed" )
View Source
const ( TokenType = "JWT" TokenUseAccess = "Access" TokenUseRefresh = "Refresh" TokenSignatureAlgorithmHS256 = "HS256" TokenSignatureAlgorithmHS512 = "HS512" )
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Claims ¶ added in v0.1.1
type Claims struct { Issuer string `json:"iss,omitempty"` Subject string `json:"sub,omitempty"` Audience string `json:"aud,omitempty"` ExpirationTime int64 `json:"exp,omitempty"` NotBefore int64 `json:"nbf,omitempty"` IssuedAt int64 `json:"iat,omitempty"` JwtID string `json:"jti,omitempty"` Data []byte `json:"data,omitempty"` // It is a custom field for any data (for example, encrypted data). }
type Config ¶
type Config struct { Headers Headers Claims Claims ParseOptions ParseOptions TokenLifetimeSec int Key string }
type MockDescription ¶
type MockDescription struct { Expected struct { Create struct { JWT string Error error } Parse struct { Token Token Error error } GetHeaders struct { Headers Headers } GetClaims struct { Claims Claims } GetParseOptions struct { ParseOptions ParseOptions } } }
var Mock MockDescription
func (*MockDescription) Create ¶
func (s *MockDescription) Create(_ Claims, _ ...Headers) (string, error)
func (*MockDescription) GetClaims ¶ added in v0.1.3
func (s *MockDescription) GetClaims() Claims
func (*MockDescription) GetHeaders ¶ added in v0.1.3
func (s *MockDescription) GetHeaders() Headers
func (*MockDescription) GetParseOptions ¶ added in v0.1.3
func (s *MockDescription) GetParseOptions() ParseOptions
func (*MockDescription) Parse ¶ added in v0.1.3
func (s *MockDescription) Parse(_ string, _ ...ParseOptions) (Token, string, error)
type ParseOptions ¶ added in v0.1.1
type ParseOptions struct { RequiredHeaderContentType bool RequiredHeaderKeyID bool RequiredHeaderX509CertificateChain bool RequiredHeaderX509CertificateChainURL bool RequiredHeaderCritical bool RequiredClaimIssuer bool RequiredClaimSubject bool RequiredClaimAudience bool RequiredClaimJwtID bool RequiredClaimData bool SkipClaimsValidation bool SkipSignatureValidation bool }
Click to show internal directories.
Click to hide internal directories.