utils

Documentation

Index

• Variables
• func NewCDN(config CDNConfig) *s3.S3
• func NewDB(config DatabaseConfig) (*sqlx.DB, error)
• func NewMQ(conf MQConfig) (*amqp.Connection, error)
• func Transact(db *sqlx.DB, txFunc func(*sqlx.Tx) error) (err error)
• type AccessClaims
• type Accesser
  • func NewAccesser(conf Config) *Accesser
  • func (a *Accesser) AuthMiddleware(next echo.HandlerFunc) echo.HandlerFunc
  • func (a *Accesser) GetToken(r *http.Request) (*AccessClaims, error)
• type CDNConfig
• type Config
• type DatabaseConfig
• type MQConfig
• type Mail
• type MailConfig
• type Mailer
  • func NewMailer(config MailConfig) (*Mailer, error)
  • func (m *Mailer) SendMail(item Mail) error
• type Permission

Variables

var (
	ErrNoToken      = errors.New("token not found")
	ErrInvalidToken = errors.New("invalid token")
)

Functions

func NewCDN

func NewCDN(config CDNConfig) *s3.S3

NewCDN Initialise connection to CDN

func NewDB

func NewDB(config DatabaseConfig) (*sqlx.DB, error)

NewDB Initialises the connection to the database

func NewMQ

func NewMQ(conf MQConfig) (*amqp.Connection, error)

NewMQ initialising the AMQP broker

func Transact

func Transact(db *sqlx.DB, txFunc func(*sqlx.Tx) error) (err error)

Transact wraps transactions

Types

type AccessClaims

type AccessClaims struct {
	UserID      int      `json:"id"`
	Permissions []string `json:"perms"`
	jwt.StandardClaims
}

AccessClaims represents an identifiable JWT

type Accesser

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

func NewAccesser

func NewAccesser(conf Config) *Accesser

NewAccesser allows the validation of web-auth JWT tokens both as headers and as cookies

func (*Accesser) AuthMiddleware

func (a *Accesser) AuthMiddleware(next echo.HandlerFunc) echo.HandlerFunc

AuthMiddleware checks a HTTP request for a valid token either in the header or cookie

func (*Accesser) GetToken

func (a *Accesser) GetToken(r *http.Request) (*AccessClaims, error)

GetToken will return the claims from a access token JWT

First will check the Authorization header, if unset will check the access cookie

type CDNConfig

type CDNConfig struct {
	Endpoint        string
	Region          string
	AccessKeyID     string
	SecretAccessKey string
}

CDNConfig represents a configuration to connect to a CDN / S3 instance

type Config

type Config struct {
	AccessCookieName string
	SigningKey       []byte
}

type DatabaseConfig

type DatabaseConfig struct {
	Host     string
	Port     string
	SSLMode  string
	Name     string
	Username string
	Password string
}

DatabaseConfig represents a configuration to connect to an SQL database

type MQConfig

type MQConfig struct {
	Host     string
	Port     string
	Username string
	Password string
}

MQConfig configuration required to create a MQ connection

type Mail

type Mail struct {
	Subject string
	To      string
	Cc      []string
	Bcc     []string
	From    string
	// contains filtered or unexported fields
}

Mail represents an email to be sent

type MailConfig

type MailConfig struct {
	Host     string
	Port     int
	Username string
	Password string
}

MailConfig represents a configuration to connect to an SMTP server

type Mailer

type Mailer struct {
	*mail.SMTPClient
	Enabled bool
}

Mailer encapsulates the dependency

func NewMailer

func NewMailer(config MailConfig) (*Mailer, error)

NewMailer creates a new SMTP client

func (*Mailer) SendMail

func (m *Mailer) SendMail(item Mail) error

SendMail sends a template email

type Permission

type Permission struct {
	Name string `json:"name"`
}

Permission represents the permissions that a user has