srvcommon

Documentation

Overview

Package srvcommon contains various constants, interfaces and functions used by one or more server provider

Index

• func RandomString(xlen int) string
• func RedirectWithState(oauther OAuther, ctx *fiber.Ctx)
• func RespondWithHTML(ctx *fiber.Ctx, html string)
• type CredentialProvider
• type OAuther
• type Provider
• type Question
• type SSHKeyProvider
• type Software

Functions

func RandomString

func RandomString(xlen int) string

RandomString generates a string of xlen length from random alphabet runes

func RedirectWithState

func RedirectWithState(oauther OAuther, ctx *fiber.Ctx)

RedirectWithState sets a state cookie for OAuth and redirects the client

func RespondWithHTML

func RespondWithHTML(ctx *fiber.Ctx, html string)

RespondWithHTML takes a given fiber request context and returns a 200 OK status with the given html response body

Types

type CredentialProvider

type CredentialProvider interface {
	EnterCredentials() (string, map[string]string)
	ValidateCredentials(ctx *fiber.Ctx, session *session.Session) error
}

type OAuther

type OAuther interface {
	OAuth2() *oauth2.Config
}

type Provider

type Provider interface {
	OAuther
	SSHKeyProvider
	CredentialProvider
}

type Question

type Question struct {
	Options  *map[string]string
	Question string
	Validate func(input string) error
}

type SSHKeyProvider

type SSHKeyProvider interface {
	CreateSSHKey(token string, sshKey string) (interface{}, error)
	CreateServer(token string, sshKey interface{}) (*string, *string, error)
}

type Software

type Software interface {
	Name() string
	URL() string
	AdditionalQuestions() map[string]Question
	Prepare(ip string, domain string, provider string, questions map[string]string) error
	Execute(ip string, domain string, provider string, questions map[string]string) error
	Export(ip string, domain string, provider string, questions map[string]string) (map[string]string, error)
	Cleanup(ip string, domain string, provider string, questions map[string]string) error
}