audit

Documentation

Index

• Constants
• func ExtractLogFields(ctx context.Context) logrus.Fields
• func IsRBACLog(entry *logrus.Entry) bool
• func IsRBACPermissionDenied(entry *logrus.Entry) bool
• func Log(fields logrus.Fields)
• func LogFromErr(fields logrus.Fields, err error)
• func SupplyEntityID(ctx context.Context, id interface{}) context.Context
• type LogKey
• type PermissionWithSubject
  • func (p PermissionWithSubject) String() string

Constants

const EntityIDKey = "entityID"

EntityIDKey is the key used to store and extract entity IDs from log fields.

Functions

func ExtractLogFields

func ExtractLogFields(ctx context.Context) logrus.Fields

ExtractLogFields retrieves logrus Fields from a context, if it exists.

func IsRBACLog

func IsRBACLog(entry *logrus.Entry) bool

IsRBACLog determines whether the log entry is an RBAC log.

func IsRBACPermissionDenied

func IsRBACPermissionDenied(entry *logrus.Entry) bool

IsRBACPermissionDenied determines whether the log entry is an RBAC log that indicates permission was denied.

func Log

func Log(fields logrus.Fields)

Log is a convenience function for logging to logrus.

func LogFromErr

func LogFromErr(fields logrus.Fields, err error)

LogFromErr is a convenience function that interprets the error to determined whether permission was granted.

func SupplyEntityID

func SupplyEntityID(ctx context.Context, id interface{}) context.Context

SupplyEntityID augments a context's log fields with the entity ID.

Types

type LogKey

type LogKey struct{}

LogKey is the key used to store and extract logrus fields from context.

type PermissionWithSubject

type PermissionWithSubject struct {
	PermissionTypes []rbacv1.PermissionType
	SubjectType     string
	SubjectIDs      []string
}

PermissionWithSubject contains the permission and what subject requires it.

func (PermissionWithSubject) String

func (p PermissionWithSubject) String() string