handlers

Documentation

Index

• func AuthMiddleware(roleAuth *AuthConfig) echo.MiddlewareFunc
• func GitWebHook(c echo.Context) error
• func ListSecrets(c echo.Context) error
• func PermissionGetAll(c echo.Context) error
• func RemoveSecret(c echo.Context) error
• func SetSecret(c echo.Context) error
• func SettingsPollGet(c echo.Context) error
• func SettingsPollOff(c echo.Context) error
• func SettingsPollOn(c echo.Context) error
• func UserAdd(c echo.Context) error
• func UserChangePassword(c echo.Context) error
• func UserDelete(c echo.Context) error
• func UserGetAll(c echo.Context) error
• func UserGetPermissions(c echo.Context) error
• func UserLogin(c echo.Context) error
• func UserPutPermissions(c echo.Context) error
• func UserResetTriggerToken(c echo.Context) error
• type AuthConfig
• type Dependencies
• type GaiaHandler
  • func NewGaiaHandler(deps Dependencies) *GaiaHandler
  • func (s *GaiaHandler) InitHandlers(e *echo.Echo) error
• type Hook
• type Payload
• type Repository

Functions

func AuthMiddleware

func AuthMiddleware(roleAuth *AuthConfig) echo.MiddlewareFunc

AuthMiddleware is middleware used for each request. Includes functionality that validates the JWT tokens and user permissions.

func GitWebHook

func GitWebHook(c echo.Context) error

GitWebHook handles callbacks from GitHub's webhook system.

func ListSecrets

func ListSecrets(c echo.Context) error

ListSecrets retrieves all secrets from the vault.

func PermissionGetAll

func PermissionGetAll(c echo.Context) error

PermissionGetAll simply returns a list of all the roles available.

func RemoveSecret

func RemoveSecret(c echo.Context) error

RemoveSecret removes a secret from the vault.

func SetSecret

func SetSecret(c echo.Context) error

SetSecret creates or updates a given secret

func SettingsPollGet

func SettingsPollGet(c echo.Context) error

SettingsPollGet get status of polling functionality.

func SettingsPollOff

func SettingsPollOff(c echo.Context) error

SettingsPollOff turn off polling functionality.

func SettingsPollOn

func SettingsPollOn(c echo.Context) error

SettingsPollOn turn on polling functionality.

func UserAdd

func UserAdd(c echo.Context) error

UserAdd adds a new user to the store.

func UserChangePassword

func UserChangePassword(c echo.Context) error

UserChangePassword changes the password from a user.

func UserDelete

func UserDelete(c echo.Context) error

UserDelete deletes the given user

func UserGetAll

func UserGetAll(c echo.Context) error

UserGetAll returns all users stored in store.

func UserGetPermissions

func UserGetPermissions(c echo.Context) error

UserGetPermissions returns the permissions for a user.

func UserLogin

func UserLogin(c echo.Context) error

UserLogin authenticates the user with the given credentials.

func UserPutPermissions

func UserPutPermissions(c echo.Context) error

UserPutPermissions adds or updates permissions for a user.

func UserResetTriggerToken

func UserResetTriggerToken(c echo.Context) error

UserResetTriggerToken will generate and save a new Remote trigger token for a given user.

Types

type AuthConfig

type AuthConfig struct {
	RoleCategories []*gaia.UserRoleCategory
}

AuthConfig is a simple config struct to be passed into AuthMiddleware. Currently allows the ability to specify the permission roles required for each echo endpoint.

type Dependencies

type Dependencies struct {
	Scheduler       service.GaiaScheduler
	PipelineService pipeline.Service
	Certificate     security.CAAPI
}

Dependencies define dependencies for this service.

type GaiaHandler

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

GaiaHandler defines handler functions throughout Gaia.

func NewGaiaHandler

func NewGaiaHandler(deps Dependencies) *GaiaHandler

NewGaiaHandler creates a new handler service with the required dependencies.

func (*GaiaHandler) InitHandlers

func (s *GaiaHandler) InitHandlers(e *echo.Echo) error

InitHandlers initializes(registers) all handlers.

type Hook

type Hook struct {
	Signature string
	Event     string
	ID        string
	Payload   []byte
}

Hook represent a github based webhook context.

type Payload

type Payload struct {
	Repo Repository `json:"repository"`
}

Payload contains information about the event like, user, commit id and so on. All we care about for the sake of identification is the repository.

type Repository

type Repository struct {
	GitURL  string `json:"git_url"`
	SSHURL  string `json:"ssh_url"`
	HTMLURL string `json:"html_url"`
}

Repository contains information about the repository. All we care about here are the possible urls for identification.