auditx

Documentation

Overview

Package auditx provides functions and data for wrapping echoaudit and performing audit logging.

Package auditx provides functions and data for auditing OAuth 2.0-specific events.

Index

• func MustViperFlags(v *viper.Viper, flags *pflag.FlagSet)
• func NewMiddleware(ctx context.Context, c Config) (*echoaudit.Middleware, func() error, error)
• func SetOutcome(c echo.Context, outcome string)
• func SetSubject(c echo.Context, subject map[string]string)
• type Config

Functions

func MustViperFlags

func MustViperFlags(v *viper.Viper, flags *pflag.FlagSet)

MustViperFlags sets the flags needed for auditing to work.

func NewMiddleware

func NewMiddleware(ctx context.Context, c Config) (*echoaudit.Middleware, func() error, error)

NewMiddleware creates a new echoaudit middleware with closer function based on the given config.

func SetOutcome

func SetOutcome(c echo.Context, outcome string)

SetOutcome sets the outcome of the auditable event.

func SetSubject

func SetSubject(c echo.Context, subject map[string]string)

SetSubject sets the subject of the auditable event.

Types

type Config

type Config struct {
	Enabled   bool
	Path      string
	Component string
}

Config represents an audit middleware configuration.