jwt

Documentation

Index

• Constants
• Variables
• type EAppClaims
• type Service
  • func (service Service) CheckToken(request *http.Request) (string, int, error)
  • func (service Service) ConfigureEnvironment(size int) error
  • func (service Service) CurrentAudience(request *http.Request) string
  • func (service Service) ExtractToken(request *http.Request) string
  • func (service Service) KeyFunc(token *jwt.Token) (interface{}, error)
  • func (service Service) NewToken(id int, sessionIndex string, audience string) (string, time.Time, error)
  • func (service Service) ParseWithClaims(tokenString string) (*jwt.Token, error)
  • func (service Service) Secret() []byte
  • func (service Service) SessionIndex(request *http.Request) string
  • func (service Service) TargetAudiences() []string
  • func (service Service) Timeout() time.Duration
  • func (service Service) TokenClaims(token *jwt.Token) *EAppClaims

Constants

const (
	// Issuer is the JWT issuer.
	Issuer = "eqip"
)

Variables

var (
	// JwtSecret is the secret used to generate tokens.
	JwtSecret = ""

	// JwtSigningMethod is the algorithm used for signing tokens.
	JwtSigningMethod = jwt.SigningMethodHS256

	// AuthBearerRegexp is a regular expression to extract the authorization token.
	AuthBearerRegexp = regexp.MustCompile("Bearer\\s(.*)")
)

Types

type EAppClaims

type EAppClaims struct {
	SessionIndex string `json:"sid,omitempty"`
	jwt.StandardClaims
}

EAppClaims are all the claims eApp uses in JWT

type Service

type Service struct {
	Env api.Settings
}

Service is an implementation of JWT service handling.

func (Service) CheckToken

func (service Service) CheckToken(request *http.Request) (string, int, error)

CheckToken tests if the token is valid and is of the correct audience.

func (Service) ConfigureEnvironment

func (service Service) ConfigureEnvironment(size int) error

ConfigureEnvironment ensure the secret is set prior to use.

func (Service) CurrentAudience

func (service Service) CurrentAudience(request *http.Request) string

CurrentAudience is the currently valid audience from the token.

func (Service) ExtractToken

func (service Service) ExtractToken(request *http.Request) string

ExtractToken returns the token from an HTTP request header.

func (Service) KeyFunc

func (service Service) KeyFunc(token *jwt.Token) (interface{}, error)

KeyFunc ensures the signing method of the token.

func (Service) NewToken

func (service Service) NewToken(id int, sessionIndex string, audience string) (string, time.Time, error)

NewToken generates a new Jwt signed token using a users account information id is the user id for the token. sessionIndex is the user session identifier provided by the SAML identity provider (facilitates Single Logout) audience is a JWT field that defines the intended recipient of the token

func (Service) ParseWithClaims

func (service Service) ParseWithClaims(tokenString string) (*jwt.Token, error)

ParseWithClaims parses the token with standard claims..

func (Service) Secret

func (service Service) Secret() []byte

Secret returns the secret to use with JWT tokens.

func (Service) SessionIndex

func (service Service) SessionIndex(request *http.Request) string

SessionIndex returns the SAML user session identifier persisted in the token.

func (Service) TargetAudiences

func (service Service) TargetAudiences() []string

TargetAudiences which are accepted based on the configured environment.

func (Service) Timeout

func (service Service) Timeout() time.Duration

Timeout returns the duration in time for how long a session is considered valid. Per policy this defaults to 15 minutes.

func (Service) TokenClaims

func (service Service) TokenClaims(token *jwt.Token) *EAppClaims

TokenClaims return all standard token claims.