Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

authz: Stdout logger #6230

Merged
merged 30 commits into from
May 17, 2023
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
065089d
Draft of StdoutLogger
erm-g Apr 25, 2023
e17b64e
Fitting StdoutLogger to lb patterns
erm-g Apr 25, 2023
92b53a7
Merge branch 'grpc:master' into AuditLoggerRegistry
erm-g Apr 27, 2023
5665daa
conversion from proto to json for laudit loggers
erm-g Apr 28, 2023
95ebc88
Tests for multiple loggers and empty Options
erm-g Apr 28, 2023
bcf4256
Added LoggerConfig impl
erm-g May 1, 2023
b918c0a
Switched to grpcLogger and added a unit test comparing log with os.St…
erm-g May 4, 2023
861d9f2
Minor fix in exception handling wording
erm-g May 4, 2023
270948b
Added timestamp for logging statement
erm-g May 4, 2023
8859707
Changed format to json and added custom marshalling
erm-g May 7, 2023
c073753
Migration to log.go and additional test for a full event
erm-g May 7, 2023
c6dd904
Migration of stdout logger to a separate package
erm-g May 7, 2023
e72bfa2
migration to grpcLogger, unit test fix
erm-g May 8, 2023
9866f61
Delete xds parsing functionality. Will be done in a separate PR
erm-g May 8, 2023
0d9a56e
Delete xds parsing functionality. Will be done in a separate PR
erm-g May 8, 2023
8c24380
Address PR comments (embedding interface, table test, pointer optimiz…
erm-g May 9, 2023
317f501
vet.sh fixes
erm-g May 9, 2023
e0800ba
Address PR comments
erm-g May 10, 2023
e0c53d8
Commit for go tidy changes
erm-g May 10, 2023
da716bb
vet.sh fix for buf usage
erm-g May 10, 2023
7c36609
Address PR comments
erm-g May 11, 2023
c903401
Address PR comments
erm-g May 11, 2023
9bcb689
Address PR comments (easwars)
erm-g May 12, 2023
a1e3e7a
Address PR comments (luwei)
erm-g May 14, 2023
c74d21b
Migrate printing to standard out from log package level func to a Log…
erm-g May 15, 2023
e6c450b
Changed event Timestamp format back to RFC3339
erm-g May 15, 2023
f60c376
Address PR comments
erm-g May 16, 2023
8f0ad3c
Address PR comments
erm-g May 16, 2023
6ef31dd
Address PR comments
erm-g May 16, 2023
d663a6d
Address PR comments
erm-g May 17, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
22 changes: 13 additions & 9 deletions authz/audit/stdout/stdout_logger.go
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,10 @@ import (
var grpcLogger = grpclog.Component("authz-audit")
erm-g marked this conversation as resolved.
Show resolved Hide resolved

func init() {
audit.RegisterLoggerBuilder(&loggerBuilder{})
l := log.New(os.Stdout, "", 0)
audit.RegisterLoggerBuilder(&loggerBuilder{
rockspore marked this conversation as resolved.
Show resolved Hide resolved
goLogger: l,
})
}

type event struct {
Expand All @@ -41,7 +44,7 @@ type event struct {
PolicyName string `json:"policy_name"`
MatchedRule string `json:"matched_rule"`
Authorized bool `json:"authorized"`
Timestamp int64 `json:"timestamp"` // Time when the audit event is logged via Log method
Timestamp string `json:"timestamp"` // Time when the audit event is logged via Log method
}

// logger implements the audit.Logger interface by logging to standard output.
Expand All @@ -50,7 +53,7 @@ type logger struct {
}

// Log marshals the audit.Event to json and prints it to standard output.
func (logger *logger) Log(event *audit.Event) {
func (l *logger) Log(event *audit.Event) {
jsonContainer := map[string]interface{}{
"grpc_audit_log": convertEvent(event),
}
Expand All @@ -59,7 +62,7 @@ func (logger *logger) Log(event *audit.Event) {
grpcLogger.Errorf("failed to marshal AuditEvent data to JSON: %v", err)
easwars marked this conversation as resolved.
Show resolved Hide resolved
return
}
logger.goLogger.Println(string(jsonBytes))
l.goLogger.Println(string(jsonBytes))
}

// loggerConfig represents the configuration for the stdout logger.
Expand All @@ -68,7 +71,9 @@ type loggerConfig struct {
audit.LoggerConfig
}

type loggerBuilder struct{}
type loggerBuilder struct {
goLogger *log.Logger
}

func (loggerBuilder) Name() string {
rockspore marked this conversation as resolved.
Show resolved Hide resolved
return "stdout_logger"
Expand All @@ -77,10 +82,9 @@ func (loggerBuilder) Name() string {
// Build returns a new instance of the stdout logger.
// Passed in configuration is ignored as the stdout logger does not
// expect any configuration to be provided.
func (*loggerBuilder) Build(audit.LoggerConfig) audit.Logger {
l := log.New(os.Stdout, "", log.LstdFlags)
func (lb *loggerBuilder) Build(audit.LoggerConfig) audit.Logger {
return &logger{
goLogger: l,
goLogger: lb.goLogger,
}
}

Expand All @@ -99,6 +103,6 @@ func convertEvent(auditEvent *audit.Event) *event {
PolicyName: auditEvent.PolicyName,
MatchedRule: auditEvent.MatchedRule,
Authorized: auditEvent.Authorized,
Timestamp: time.Now().Unix(),
Timestamp: time.Now().Format(time.RFC3339Nano),
}
}
22 changes: 13 additions & 9 deletions authz/audit/stdout/stdout_logger_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ import (
"bytes"
"encoding/json"
"log"
"os"
"testing"
"time"

Expand Down Expand Up @@ -67,22 +68,24 @@ func (s) TestStdoutLogger_Log(t *testing.T) {
before := time.Now().Unix()
var buf bytes.Buffer
l := log.New(&buf, "", 0)
auditLogger := &logger{
goLogger: l,
}
builder := &loggerBuilder{goLogger: l}
auditLogger := builder.Build(nil)
auditLogger.Log(test.event)
var container map[string]interface{}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: Consider adding newlines to logically separate the steps of the test. At the very least, it would be good to separate out the following steps using newlines: setup, actual test logic, verification.

if err := json.Unmarshal(buf.Bytes(), &container); err != nil {
t.Fatalf("Failed to unmarshal audit log event: %v", err)
}
innerEvent := extractEvent(container["grpc_audit_log"].(map[string]interface{}))
if innerEvent.Timestamp == 0 {
if innerEvent.Timestamp == "" {
rockspore marked this conversation as resolved.
Show resolved Hide resolved
t.Fatalf("Resulted event has no timestamp: %v", innerEvent)
}
after := time.Now().Unix()
if before > innerEvent.Timestamp || after < innerEvent.Timestamp {
t.Fatalf("The audit event timestamp is outside of the test interval: test start %v, event timestamp %v, test end %v",
before, innerEvent.Timestamp, after)
innerEventUnixTime, err := time.Parse(time.RFC3339Nano, innerEvent.Timestamp)
if err != nil {
t.Fatalf("Failed to convert event timestamp into Unix time format: %v", err)
}
if before > innerEventUnixTime.Unix() || after < innerEventUnixTime.Unix() {
t.Errorf("The audit event timestamp is outside of the test interval: test start %v, event timestamp %v, test end %v", before, innerEventUnixTime.Unix(), after)
}
if diff := cmp.Diff(trimEvent(innerEvent), test.event); diff != "" {
rockspore marked this conversation as resolved.
Show resolved Hide resolved
t.Fatalf("Unexpected message\ndiff (-got +want):\n%s", diff)
Expand All @@ -92,7 +95,8 @@ func (s) TestStdoutLogger_Log(t *testing.T) {
}

func (s) TestStdoutLoggerBuilder_NilConfig(t *testing.T) {
builder := &loggerBuilder{}
l := log.New(os.Stdout, "", log.LstdFlags)
rockspore marked this conversation as resolved.
Show resolved Hide resolved
builder := &loggerBuilder{goLogger: l}
config, err := builder.ParseLoggerConfig(nil)
if err != nil {
t.Fatalf("Failed to parse stdout logger configuration: %v", err)
Expand All @@ -117,7 +121,7 @@ func extractEvent(container map[string]interface{}) event {
PolicyName: container["policy_name"].(string),
MatchedRule: container["matched_rule"].(string),
Authorized: container["authorized"].(bool),
Timestamp: int64(container["timestamp"].(float64)),
Timestamp: container["timestamp"].(string),
}
}

Expand Down