const (// ActionIgnore ignores diffing for the field.ActionIgnore = "ignore"// ActionTrack includes the value in the diff if the value changed.ActionTrack = "track"// ActionSecret includes a zero value of the same type if the value changed.// It lets you indicate that a value changed, but without leaking its// contents.ActionSecret = "secret")

var AuditActionMap = map[string][]codersdk.AuditAction{"GitSSHKey":       {codersdk.AuditActionCreate},"Template":        {codersdk.AuditActionWrite,codersdk.AuditActionDelete},"TemplateVersion": {codersdk.AuditActionCreate,codersdk.AuditActionWrite},"User":            {codersdk.AuditActionCreate,codersdk.AuditActionWrite,codersdk.AuditActionDelete},"Workspace":       {codersdk.AuditActionCreate,codersdk.AuditActionWrite,codersdk.AuditActionDelete},"WorkspaceBuild":  {codersdk.AuditActionStart,codersdk.AuditActionStop},"Group":           {codersdk.AuditActionCreate,codersdk.AuditActionWrite,codersdk.AuditActionDelete},"APIKey":          {codersdk.AuditActionLogin,codersdk.AuditActionLogout,codersdk.AuditActionRegister,codersdk.AuditActionCreate,codersdk.AuditActionDelete},"License":         {codersdk.AuditActionCreate,codersdk.AuditActionDelete},"WorkspaceAgent":  {codersdk.AuditActionConnect,codersdk.AuditActionDisconnect},"WorkspaceApp":    {codersdk.AuditActionOpen,codersdk.AuditActionClose},}

var AuditableResources = auditMap(auditableResourcesTypes)

funcNewAuditor¶

func NewAuditor(dbdatabase.Store, filterFilter, backends ...Backend)audit.Auditor

typeAction¶

type Actionstring

func (tAction) String()string

typeActor¶added inv2.1.5

type Actor struct {IDuuid.UUID `json:"id"`Emailstring    `json:"email"`Usernamestring    `json:"username"`}

typeBackend¶

type Backend interface {// Decision determines the FilterDecisions that the backend tolerates.Decision()FilterDecision// Export sends an audit log to the backend.Export(ctxcontext.Context, alogdatabase.AuditLog, detailsBackendDetails)error}

Backends can store or send audit logs to arbitrary locations.

typeBackendDetails¶added inv2.1.5

type BackendDetails struct {Actor *Actor}

typeFilter¶

type Filter interface {Check(ctxcontext.Context, alogdatabase.AuditLog) (FilterDecision,error)}

Filters produce a FilterDecision for a given audit log.

var DefaultFilterFilter =FilterFunc(func(_context.Context, _database.AuditLog) (FilterDecision,error) {returnFilterDecisionStore |FilterDecisionExport,nil})

typeFilterDecision¶

type FilterDecisionuint8

FilterDecision is a bitwise flag describing the actions a given filter allowsfor a given audit log.

const (// FilterDecisionDrop indicates that the audit log should be dropped. It// should not be stored or exported anywhere.FilterDecisionDropFilterDecision = 0// FilterDecisionStore indicates that the audit log should be allowed to be// stored in the Coder database.FilterDecisionStoreFilterDecision = 1 <<iota// FilterDecisionExport indicates that the audit log should be exported// externally of Coder.FilterDecisionExport)

typeFilterFunc¶

type FilterFunc func(ctxcontext.Context, alogdatabase.AuditLog) (FilterDecision,error)

FilterFunc constructs a Filter from a simple function.

func (fFilterFunc) Check(ctxcontext.Context, alogdatabase.AuditLog) (FilterDecision,error)

typeTable¶

type Table map[string]map[string]Action

Table is a map of struct names to a map of field names that indicate thatfield's AuditType.