Documentation
¶
Index ¶
- Constants
- Variables
- func CopyUserInfoClaims(src, dst MapClaims)
- func DecodeSegment(seg string) ([]byte, error)
- func EncodeSegment(seg []byte) string
- func SetClaimsExpiration(claims MapClaims, expiry time.Duration)
- func VerifySignature(algo, signingString, signature string, key interface{}) error
- type Audience
- type Claims
- func (c *Claims) Marshal() string
- func (c *Claims) Valid(cfg VerifyConfig) error
- func (c *Claims) VerifyAudience(expected []string) error
- func (c *Claims) VerifyExpiresAt(now time.Time, req bool) error
- func (c *Claims) VerifyIssuedAt(now time.Time, req bool) error
- func (c *Claims) VerifyIssuer(expected string) error
- func (c *Claims) VerifyNotBefore(now time.Time, req bool) error
- func (c *Claims) VerifySubject(expected string) error
- type Config
- type Key
- type Keyfunc
- type MapClaims
- func (c MapClaims) Add(val ...interface{}) error
- func (c MapClaims) Bool(k string) bool
- func (c MapClaims) Int(k string) int
- func (c MapClaims) Marshal() string
- func (c MapClaims) String(k string) string
- func (c MapClaims) Time(k string) *time.Time
- func (c MapClaims) To(val interface{}) error
- func (c MapClaims) Valid(cfg VerifyConfig) error
- func (c MapClaims) VerifyAudience(expected []string) error
- func (c MapClaims) VerifyExpiresAt(now time.Time, req bool) error
- func (c MapClaims) VerifyIssuedAt(now time.Time, req bool) error
- func (c MapClaims) VerifyIssuer(expected string) error
- func (c MapClaims) VerifyNotBefore(now time.Time, req bool) error
- func (c MapClaims) VerifySubject(expected string) error
- type NumericDate
- type Option
- type Parser
- type Provider
- func Load(cfgfile string, crypto *cryptoprov.Crypto) (Provider, error)
- func MustNew(cfg *Config, crypto *cryptoprov.Crypto, ops ...Option) Provider
- func New(cfg *Config, crypto *cryptoprov.Crypto, ops ...Option) (Provider, error)
- func NewFromCryptoSigner(signer crypto.Signer, ops ...Option) (Provider, error)
- type Signer
- type SignerInfo
- type Token
- type TokenParser
- func (p *TokenParser) Parse(tokenString string, cfg VerifyConfig, keyFunc Keyfunc) (*Token, error)
- func (p *TokenParser) ParseUnverified(tokenString string, claims MapClaims) (token *Token, parts []string, err error)
- func (p *TokenParser) ParseWithClaims(tokenString string, cfg VerifyConfig, claims MapClaims, keyFunc Keyfunc) (*Token, error)
- type ValidClaims
- type VerifyConfig
Constants ¶
const ( // DefaultNotBefore offset for NotBefore DefaultNotBefore = -2 * time.Minute )
Variables ¶
var ( // TimeNowFn to override in unit tests TimeNowFn = time.Now // DefaultTimeSkew is an interval for allowed time skew DefaultTimeSkew = 5 * time.Minute )
Functions ¶
func CopyUserInfoClaims ¶ added in v0.2.0
func CopyUserInfoClaims(src, dst MapClaims)
CopyUserInfoClaims from source to destination
func DecodeSegment ¶ added in v0.2.0
DecodeSegment JWT specific base64url encoding with padding stripped
func EncodeSegment ¶
EncodeSegment returns JWT specific base64url encoding with padding stripped
func SetClaimsExpiration ¶ added in v0.2.0
SetClaimsExpiration sets expiration claims
func VerifySignature ¶ added in v0.2.0
VerifySignature returns error if JWT signature is invalid
Types ¶
type Audience ¶ added in v0.2.0
type Audience []string
Audience represents the recipients that the token is intended for.
func (Audience) Contains ¶ added in v0.2.0
Contains returns true if audience contains expected value
func (*Audience) UnmarshalJSON ¶ added in v0.2.0
UnmarshalJSON reads an audience from its JSON representation.
type Claims ¶
type Claims struct {
Issuer string `json:"iss,omitempty"`
Subject string `json:"sub,omitempty"`
Audience Audience `json:"aud,omitempty"`
Expiry *NumericDate `json:"exp,omitempty"`
NotBefore *NumericDate `json:"nbf,omitempty"`
IssuedAt *NumericDate `json:"iat,omitempty"`
ID string `json:"jti,omitempty"`
// DPoP specific claims
CNF map[string]interface{} `json:"cnf,omitempty"`
Nonce string `json:"nonce,omitempty"`
HTTPMethod string `json:"htm,omitempty"`
HTTPUri string `json:"htu,omitempty"`
}
Claims represents public claim values (as specified in RFC 7519).
func (*Claims) Valid ¶
func (c *Claims) Valid(cfg VerifyConfig) error
Valid returns error if the standard claims are invalid
func (*Claims) VerifyAudience ¶ added in v0.2.0
VerifyAudience compares the aud claim against expected.
func (*Claims) VerifyExpiresAt ¶ added in v0.2.0
VerifyExpiresAt returns true issued at is valid.
func (*Claims) VerifyIssuedAt ¶ added in v0.2.0
VerifyIssuedAt verifies the iat claim.
func (*Claims) VerifyIssuer ¶ added in v0.2.0
VerifyIssuer compares the iss claim against expected.
func (*Claims) VerifyNotBefore ¶ added in v0.2.0
VerifyNotBefore verifies the nbf claim.
func (*Claims) VerifySubject ¶ added in v0.2.0
VerifySubject compares the sub claim against expected.
type Config ¶
type Config struct {
// Issuer specifies issuer claim
Issuer string `json:"issuer" yaml:"issuer"`
// KeyID specifies ID of the current key
KeyID string `json:"kid" yaml:"kid"`
// Keys specifies list of issuer's keys
Keys []*Key `json:"keys" yaml:"keys"`
PrivateKey string `json:"private_key" yaml:"private_key"`
}
Config provides OAuth2 configuration
func LoadConfig ¶
LoadConfig returns configuration loaded from a file
type Key ¶
type Key struct {
// ID of the key
ID string `json:"id" yaml:"id"`
Seed string `json:"seed" yaml:"seed"`
}
Key for JWT signature
type Keyfunc ¶ added in v0.2.0
Keyfunc is a 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.2.0
type MapClaims map[string]interface{}
MapClaims provides generic claims on map
func CreateClaims ¶ added in v0.2.0
func CreateClaims(jti, subject, issuer string, audience []string, expiry time.Duration, extraClaims MapClaims) MapClaims
CreateClaims returns claims
func (MapClaims) String ¶ added in v0.2.0
String will return the named claim as a string, if the underlying type is not a string, it will try and co-oerce it to a string.
func (MapClaims) Valid ¶ added in v0.2.0
func (c MapClaims) Valid(cfg VerifyConfig) error
Valid returns error if the standard claims are invalid
func (MapClaims) VerifyAudience ¶ added in v0.2.0
VerifyAudience compares the aud claim against expected.
func (MapClaims) VerifyExpiresAt ¶ added in v0.2.0
VerifyExpiresAt returns true issued at is valid.
func (MapClaims) VerifyIssuedAt ¶ added in v0.2.0
VerifyIssuedAt verifies the iat claim.
func (MapClaims) VerifyIssuer ¶ added in v0.2.0
VerifyIssuer compares the iss claim against expected.
func (MapClaims) VerifyNotBefore ¶ added in v0.2.0
VerifyNotBefore verifies the nbf claim.
func (MapClaims) VerifySubject ¶ added in v0.2.0
VerifySubject compares the sub claim against expected.
type NumericDate ¶ added in v0.2.0
type NumericDate int64
NumericDate represents date and time as the number of seconds since the epoch, ignoring leap seconds. Non-integer values can be represented in the serialized format, but we round to the nearest second. See RFC7519 Section 2: https://tools.ietf.org/html/rfc7519#section-2
func NewNumericDate ¶ added in v0.2.0
func NewNumericDate(t time.Time) *NumericDate
NewNumericDate constructs NumericDate from time.Time value.
func (NumericDate) MarshalJSON ¶ added in v0.2.0
func (n NumericDate) MarshalJSON() ([]byte, error)
MarshalJSON serializes the given NumericDate into its JSON representation.
func (*NumericDate) Time ¶ added in v0.2.0
func (n *NumericDate) Time() time.Time
Time returns time.Time representation of NumericDate.
func (*NumericDate) UnmarshalJSON ¶ added in v0.2.0
func (n *NumericDate) UnmarshalJSON(b []byte) error
UnmarshalJSON reads a date from its JSON representation.
type Option ¶
type Option interface {
// contains filtered or unexported methods
}
A Option modifies the default behavior of Provider.
func WithHeaders ¶
WithHeaders allows to specify extra headers or override defaults
type Parser ¶
type Parser interface {
// ParseToken returns jwt.StandardClaims
ParseToken(authorization string, cfg VerifyConfig) (MapClaims, error)
}
Parser specifies JWT parser interface
type Provider ¶
Provider specifies JWT provider interface
func Load ¶
func Load(cfgfile string, crypto *cryptoprov.Crypto) (Provider, error)
Load returns new provider
func MustNew ¶
func MustNew(cfg *Config, crypto *cryptoprov.Crypto, ops ...Option) Provider
MustNew returns new provider
type Signer ¶
type Signer interface {
// SignClaims returns signed JWT token
Sign(claims MapClaims) (string, error)
// PublicKey is returned for assymetric signer
PublicKey() crypto.PublicKey
// Issuer returns name of the issuer
Issuer() string
}
Signer specifies JWT signer interface
type SignerInfo ¶
type SignerInfo struct {
// contains filtered or unexported fields
}
SignerInfo represents JWT signer
func NewSignerInfo ¶
func NewSignerInfo(signer crypto.Signer) (*SignerInfo, error)
NewSignerInfo returns *SignerInfo
type Token ¶ added in v0.2.0
type Token struct {
Raw string // The raw token. Populated when you Parse a token
SigningMethod string // The signing method used or to be used
Header map[string]interface{} // The first segment of the token
Claims ValidClaims // The second segment of the token
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
}
Token for JWT
type TokenParser ¶ added in v0.2.0
type TokenParser 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
}
TokenParser config
func (*TokenParser) Parse ¶ added in v0.2.0
func (p *TokenParser) Parse(tokenString string, cfg VerifyConfig, keyFunc Keyfunc) (*Token, error)
Parse parses and validates JWT, 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 (*TokenParser) ParseUnverified ¶ added in v0.2.0
func (p *TokenParser) ParseUnverified(tokenString string, claims MapClaims) (token *Token, parts []string, err error)
ParseUnverified 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. WARNING: Don't use this method unless you know what you're doing
func (*TokenParser) ParseWithClaims ¶ added in v0.2.0
func (p *TokenParser) ParseWithClaims(tokenString string, cfg VerifyConfig, claims MapClaims, keyFunc Keyfunc) (*Token, error)
ParseWithClaims parses token with a specified Claims
type ValidClaims ¶ added in v0.2.0
type ValidClaims interface {
Valid(cfg VerifyConfig) error
}
ValidClaims interface for Claims validation
type VerifyConfig ¶
type VerifyConfig struct {
// ExpectedIssuer validates the iss claim of a JWT matches this value
ExpectedIssuer string
// ExpectedSubject validates the sub claim of a JWT matches this value
ExpectedSubject string
// ExpectedAudience validates that the aud claim of a JWT contains this value
ExpectedAudience []string
}
VerifyConfig expreses the possible options for validating a JWT