authentication

Documentation

Index

• Constants
• Variables
• func AddAuthentication(apiRoot echoswagger.ApiRoot, userManager *users.UserManager, ...) echo.MiddlewareFunc
• func GetNoneAuthMiddleware() echo.MiddlewareFunc
• func ValidatePermissions(permissions []string) func(next echo.HandlerFunc) echo.HandlerFunc
• type AuthConfiguration
• type AuthContext
  • func (a *AuthContext) Name() string
  • func (a *AuthContext) Scheme() string
• type AuthHandler
  • func (a *AuthHandler) JWTLoginHandler(c echo.Context) error
• type JWTAuth
  • func GetJWTAuthMiddleware(config JWTAuthConfiguration, privateKey []byte, userManager *users.UserManager) (*JWTAuth, echo.MiddlewareFunc)
  • func NewJWTAuth(duration time.Duration, nodeID string, secret []byte) *JWTAuth
  • func (j *JWTAuth) IssueJWT(username string, claims *WaspClaims) (string, error)
• type JWTAuthConfiguration
• type ValidationError
• type WaspClaims
  • func (c *WaspClaims) HasPermission(permission string) bool
  • func (c *WaspClaims) VerifySubject(expected string) bool
• type WebAPI

Constants

const (
	AuthNone = "none"
	AuthJWT  = "jwt"
)

const (
	JWTContextKey = "jwt"
)

Variables

var (
	ErrJWTInvalidClaims = echo.NewHTTPError(http.StatusUnauthorized, "invalid jwt claims")
	ErrInvalidJWT       = echo.NewHTTPError(http.StatusUnauthorized, "token is invalid")
)

Errors

var DefaultJWTDuration time.Duration

Functions

func AddAuthentication

func AddAuthentication(
	apiRoot echoswagger.ApiRoot,
	userManager *users.UserManager,
	nodeIdentityProvider registry.NodeIdentityProvider,
	authConfig AuthConfiguration,
	mocker interfaces.Mocker,
) echo.MiddlewareFunc

func GetNoneAuthMiddleware

func GetNoneAuthMiddleware() echo.MiddlewareFunc

func ValidatePermissions

func ValidatePermissions(permissions []string) func(next echo.HandlerFunc) echo.HandlerFunc

Types

type AuthConfiguration

type AuthConfiguration struct {
	Scheme string `default:"ip" usage:"selects which authentication to choose"`

	JWTConfig JWTAuthConfiguration `name:"jwt" usage:"defines the jwt configuration"`
}

type AuthContext

type AuthContext struct {
	echo.Context
	// contains filtered or unexported fields
}

func (*AuthContext) Name

func (a *AuthContext) Name() string

func (*AuthContext) Scheme

func (a *AuthContext) Scheme() string

type AuthHandler

type AuthHandler struct {
	Jwt         *JWTAuth
	UserManager *users.UserManager
}

func (*AuthHandler) JWTLoginHandler

func (a *AuthHandler) JWTLoginHandler(c echo.Context) error

type JWTAuth

type JWTAuth struct {
	// contains filtered or unexported fields
}

func GetJWTAuthMiddleware

func GetJWTAuthMiddleware(
	config JWTAuthConfiguration,
	privateKey []byte,
	userManager *users.UserManager,
) (*JWTAuth, echo.MiddlewareFunc)

func NewJWTAuth

func NewJWTAuth(duration time.Duration, nodeID string, secret []byte) *JWTAuth

func (*JWTAuth) IssueJWT

func (j *JWTAuth) IssueJWT(username string, claims *WaspClaims) (string, error)

type JWTAuthConfiguration

type JWTAuthConfiguration struct {
	Duration time.Duration `default:"24h" usage:"jwt token lifetime"`
}

type ValidationError

type ValidationError struct {
	MissingPermission string `json:"missingPermission" swagger:"required"`
	Error             string `json:"error" swagger:"required"`
}

type WaspClaims

type WaspClaims struct {
	jwt.RegisteredClaims
	Permissions map[string]struct{} `json:"permissions"`
}

func (*WaspClaims) HasPermission

func (c *WaspClaims) HasPermission(permission string) bool

func (*WaspClaims) VerifySubject

func (c *WaspClaims) VerifySubject(expected string) bool

type WebAPI

type WebAPI interface {
	GET(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	POST(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	Use(middleware ...echo.MiddlewareFunc)
}