log

Documentation

Overview

Package log provides a request logging filter, usable also for audit logging. Audit logging is showing who did a request in case of OAuth2 provider returns a "uid" key and value.

Index

• Constants
• func NewAuditLog(maxAuditBody int) filters.Spec
• func NewUnverifiedAuditLog() filters.Spec

Constants

const (
	// Deprecated, use filters.AuditLogName instead
	AuditLogName = filters.AuditLogName

	// AuthUserKey is used by the auth package to set the user
	// information into the state bag to pass the information to
	// the auditLog filter.
	AuthUserKey = "auth-user"
	// AuthRejectReasonKey is used by the auth package to set the
	// reject reason information into the state bag to pass the
	// information to the auditLog filter.
	AuthRejectReasonKey = "auth-reject-reason"

	// Deprecated, use filters.UnverifiedAuditLogName instead
	UnverifiedAuditLogName = filters.UnverifiedAuditLogName

	// UnverifiedAuditHeader is the name of the header added to the request which contains the unverified audit details
	UnverifiedAuditHeader = "X-Unverified-Audit"
)

Functions

func NewAuditLog

func NewAuditLog(maxAuditBody int) filters.Spec

NewAuditLog creates an auditLog filter specification. It expects a maxAuditBody attribute to limit the size of the log. It will use os.Stderr as writer for the output of the log entries.

spec := NewAuditLog(1024)

func NewUnverifiedAuditLog

func NewUnverifiedAuditLog() filters.Spec

NewUnverifiedAuditLog logs "Sub" of the middle part of a JWT Token. Or else, logs the requested JSON key if present