logger

Documentation

Index

• Constants
• Variables
• type AuditLog
• type AuditLogActor
• type AuditLogger
  • func CreateAuditLogger(logger slog.Logger) *AuditLogger
  • func (a *AuditLogger) RewrapFailure(ctx context.Context, policy AuditPolicy) error
  • func (a *AuditLogger) RewrapSuccess(ctx context.Context, policy AuditPolicy) error
  • func (a *AuditLogger) With(key string, value string) *AuditLogger
• type AuditPolicy
  • func CreateAuditPolicy(uuid uuid.UUID, dataAttributes []AuditPolicySimpleAttribute, ...) *AuditPolicy
• type AuditPolicyBody
• type AuditPolicySimpleAttribute
• type Config
• type Logger
  • func NewLogger(config Config) (*Logger, error)
  • func (l *Logger) With(key string, value string) *Logger

Constants

const (
	// Currently setting AUDIT level to 10, a level above ERROR so it is always logged
	LevelAudit = slog.Level(10)
)

From the Slog docs (https://betterstack.com/community/guides/logging/logging-in-go/#customizing-slog-levels): The log/slog package provides four log levels by default, with each one associated with an integer value: DEBUG (-4), INFO (0), WARN (4), and ERROR (8).

Variables

var CustomLevelNames = map[slog.Leveler]string{
	LevelAudit: "AUDIT",
}

Types

type AuditLog

type AuditLog struct {
	ID            string                 `json:"id"`
	Object        auditPolicyObject      `json:"object"`
	Action        auditPolicyAction      `json:"action"`
	Actor         AuditLogActor          `json:"actor"`
	EventMetaData map[string]interface{} `json:"eventMetaData"`
	ClientInfo    auditLogClientInfo     `json:"clientInfo"`
	Diff          map[string]interface{} `json:"diff"`
	Timestamp     string                 `json:"timestamp"`
}

type AuditLogActor

type AuditLogActor struct {
	ID         string                `json:"id"`
	Attributes auditPolicyAttributes `json:"attributes"`
}

type AuditLogger

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

func CreateAuditLogger

func CreateAuditLogger(logger slog.Logger) *AuditLogger

func (*AuditLogger) RewrapFailure

func (a *AuditLogger) RewrapFailure(ctx context.Context, policy AuditPolicy) error

KAS Rewrap Failure Event Log

func (*AuditLogger) RewrapSuccess

func (a *AuditLogger) RewrapSuccess(ctx context.Context, policy AuditPolicy) error

KAS Rewrap Success Event Log

func (*AuditLogger) With

func (a *AuditLogger) With(key string, value string) *AuditLogger

type AuditPolicy

type AuditPolicy struct {
	UUID  uuid.UUID       `json:"uuid"`
	Body  AuditPolicyBody `json:"body"`
	Actor AuditLogActor   `json:"actor"`
}

func CreateAuditPolicy

func CreateAuditPolicy(
	uuid uuid.UUID,
	dataAttributes []AuditPolicySimpleAttribute,
	policyDissem []string,
	entityToken jwt.Token,
) *AuditPolicy

Creates a simple Audit Policy to be passed into the audit rewrap logs

type AuditPolicyBody

type AuditPolicyBody struct {
	DataAttributes []AuditPolicySimpleAttribute `json:"dataAttributes"`
	Dissem         []string                     `json:"dissem"`
}

type AuditPolicySimpleAttribute

type AuditPolicySimpleAttribute struct {
	URI string `json:"attribute"`
}

type Config

type Config struct {
	Level  string `yaml:"level" default:"info"`
	Output string `yaml:"output" default:"stdout"`
	Type   string `yaml:"type" default:"json"`
}

type Logger

type Logger struct {
	*slog.Logger
	Audit *AuditLogger
}

func NewLogger

func NewLogger(config Config) (*Logger, error)

func (*Logger) With

func (l *Logger) With(key string, value string) *Logger