snapshot of https://github.com/grpc/grpc-go.git (master, 2026-09-15; blobs > 131072B omitted)
Some checks failed
codecov / upload (push) Failing after 13m59s
CodeQL / Analyze (push) Failing after 1s
Testing / vet-proto (push) Failing after 1s
Testing / tests (arm, latest) (push) Waiting to run
Testing / extras (latest) (push) Failing after 1s
Testing / static checks (latest-1) (push) Failing after 1s
Testing / tests (-race, latest) (push) Failing after 1s
Testing / tests (i386, latest) (push) Failing after 1s
Testing / tests (latest) (push) Failing after 1s
Testing / tests (latest-1) (push) Failing after 1s
Lock Threads / lock (push) Failing after 1s
govulncheck / govulncheck (.) (push) Failing after 1s
govulncheck / govulncheck (./cmd/protoc-gen-go-grpc) (push) Failing after 1s
govulncheck / govulncheck (./gcp/observability) (push) Failing after 1s
govulncheck / govulncheck (./security/advancedtls) (push) Failing after 1s
govulncheck / govulncheck (./stats/opencensus) (push) Failing after 1s
Stale bot / stale (push) Failing after 1s
Some checks failed
codecov / upload (push) Failing after 13m59s
CodeQL / Analyze (push) Failing after 1s
Testing / vet-proto (push) Failing after 1s
Testing / tests (arm, latest) (push) Waiting to run
Testing / extras (latest) (push) Failing after 1s
Testing / static checks (latest-1) (push) Failing after 1s
Testing / tests (-race, latest) (push) Failing after 1s
Testing / tests (i386, latest) (push) Failing after 1s
Testing / tests (latest) (push) Failing after 1s
Testing / tests (latest-1) (push) Failing after 1s
Lock Threads / lock (push) Failing after 1s
govulncheck / govulncheck (.) (push) Failing after 1s
govulncheck / govulncheck (./cmd/protoc-gen-go-grpc) (push) Failing after 1s
govulncheck / govulncheck (./gcp/observability) (push) Failing after 1s
govulncheck / govulncheck (./security/advancedtls) (push) Failing after 1s
govulncheck / govulncheck (./stats/opencensus) (push) Failing after 1s
Stale bot / stale (push) Failing after 1s
This commit is contained in:
127
authz/audit/audit_logger.go
Normal file
127
authz/audit/audit_logger.go
Normal file
@@ -0,0 +1,127 @@
|
||||
/*
|
||||
*
|
||||
* Copyright 2023 gRPC authors.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*
|
||||
*/
|
||||
|
||||
// Package audit contains interfaces for audit logging during authorization.
|
||||
package audit
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"sync"
|
||||
)
|
||||
|
||||
// loggerBuilderRegistry holds a map of audit logger builders and a mutex
|
||||
// to facilitate thread-safe reading/writing operations.
|
||||
type loggerBuilderRegistry struct {
|
||||
mu sync.Mutex
|
||||
builders map[string]LoggerBuilder
|
||||
}
|
||||
|
||||
var (
|
||||
registry = loggerBuilderRegistry{
|
||||
builders: make(map[string]LoggerBuilder),
|
||||
}
|
||||
)
|
||||
|
||||
// RegisterLoggerBuilder registers the builder in a global map
|
||||
// using b.Name() as the key.
|
||||
//
|
||||
// This should only be called during initialization time (i.e. in an init()
|
||||
// function). If multiple builders are registered with the same name,
|
||||
// the one registered last will take effect.
|
||||
func RegisterLoggerBuilder(b LoggerBuilder) {
|
||||
registry.mu.Lock()
|
||||
defer registry.mu.Unlock()
|
||||
registry.builders[b.Name()] = b
|
||||
}
|
||||
|
||||
// GetLoggerBuilder returns a builder with the given name.
|
||||
// It returns nil if the builder is not found in the registry.
|
||||
func GetLoggerBuilder(name string) LoggerBuilder {
|
||||
registry.mu.Lock()
|
||||
defer registry.mu.Unlock()
|
||||
return registry.builders[name]
|
||||
}
|
||||
|
||||
// Event contains information passed to the audit logger as part of an
|
||||
// audit logging event.
|
||||
type Event struct {
|
||||
// FullMethodName is the full method name of the audited RPC, in the format
|
||||
// of "/pkg.Service/Method". For example, "/helloworld.Greeter/SayHello".
|
||||
FullMethodName string
|
||||
// Principal is the identity of the caller. Currently it will only be
|
||||
// available in certificate-based TLS authentication.
|
||||
Principal string
|
||||
// PolicyName is the authorization policy name or the xDS RBAC filter name.
|
||||
PolicyName string
|
||||
// MatchedRule is the matched rule or policy name in the xDS RBAC filter.
|
||||
// It will be empty if there is no match.
|
||||
MatchedRule string
|
||||
// Authorized indicates whether the audited RPC is authorized or not.
|
||||
Authorized bool
|
||||
}
|
||||
|
||||
// LoggerConfig represents an opaque data structure holding an audit
|
||||
// logger configuration. Concrete types representing configuration of specific
|
||||
// audit loggers must embed this interface to implement it.
|
||||
type LoggerConfig interface {
|
||||
loggerConfig()
|
||||
}
|
||||
|
||||
// Logger is the interface to be implemented by audit loggers.
|
||||
//
|
||||
// An audit logger is a logger instance that can be configured via the
|
||||
// authorization policy API or xDS HTTP RBAC filters. When the authorization
|
||||
// decision meets the condition for audit, all the configured audit loggers'
|
||||
// Log() method will be invoked to log that event.
|
||||
//
|
||||
// Please refer to
|
||||
// https://github.com/grpc/proposal/blob/master/A59-audit-logging.md for more
|
||||
// details about audit logging.
|
||||
type Logger interface {
|
||||
// Log performs audit logging for the provided audit event.
|
||||
//
|
||||
// This method is invoked in the RPC path and therefore implementations
|
||||
// must not block.
|
||||
Log(*Event)
|
||||
}
|
||||
|
||||
// LoggerBuilder is the interface to be implemented by audit logger
|
||||
// builders that are used at runtime to configure and instantiate audit loggers.
|
||||
//
|
||||
// Users who want to implement their own audit logging logic should
|
||||
// implement this interface, along with the Logger interface, and register
|
||||
// it by calling RegisterLoggerBuilder() at init time.
|
||||
//
|
||||
// Please refer to
|
||||
// https://github.com/grpc/proposal/blob/master/A59-audit-logging.md for more
|
||||
// details about audit logging.
|
||||
type LoggerBuilder interface {
|
||||
// ParseLoggerConfig parses the given JSON bytes into a structured
|
||||
// logger config this builder can use to build an audit logger.
|
||||
ParseLoggerConfig(config json.RawMessage) (LoggerConfig, error)
|
||||
// Build builds an audit logger with the given logger config.
|
||||
// This will only be called with valid configs returned from
|
||||
// ParseLoggerConfig() and any runtime issues such as failing to
|
||||
// create a file should be handled by the logger implementation instead of
|
||||
// failing the logger instantiation. So implementers need to make sure it
|
||||
// can return a logger without error at this stage.
|
||||
Build(LoggerConfig) Logger
|
||||
// Name returns the name of logger built by this builder.
|
||||
// This is used to register and pick the builder.
|
||||
Name() string
|
||||
}
|
||||
370
authz/audit/audit_logging_test.go
Normal file
370
authz/audit/audit_logging_test.go
Normal file
@@ -0,0 +1,370 @@
|
||||
/*
|
||||
*
|
||||
* Copyright 2023 gRPC authors.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*
|
||||
*/
|
||||
|
||||
package audit_test
|
||||
|
||||
import (
|
||||
"context"
|
||||
"crypto/tls"
|
||||
"crypto/x509"
|
||||
"encoding/json"
|
||||
"io"
|
||||
"os"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/google/go-cmp/cmp"
|
||||
"google.golang.org/grpc"
|
||||
"google.golang.org/grpc/authz"
|
||||
"google.golang.org/grpc/authz/audit"
|
||||
"google.golang.org/grpc/codes"
|
||||
"google.golang.org/grpc/credentials"
|
||||
"google.golang.org/grpc/internal/grpctest"
|
||||
"google.golang.org/grpc/internal/stubserver"
|
||||
testgrpc "google.golang.org/grpc/interop/grpc_testing"
|
||||
testpb "google.golang.org/grpc/interop/grpc_testing"
|
||||
"google.golang.org/grpc/status"
|
||||
"google.golang.org/grpc/testdata"
|
||||
|
||||
_ "google.golang.org/grpc/authz/audit/stdout"
|
||||
)
|
||||
|
||||
type s struct {
|
||||
grpctest.Tester
|
||||
}
|
||||
|
||||
func Test(t *testing.T) {
|
||||
grpctest.RunSubTests(t, s{})
|
||||
}
|
||||
|
||||
type statAuditLogger struct {
|
||||
authzDecisionStat map[bool]int // Map to hold the counts of authorization decisions
|
||||
lastEvent *audit.Event // Field to store last received event
|
||||
}
|
||||
|
||||
func (s *statAuditLogger) Log(event *audit.Event) {
|
||||
s.authzDecisionStat[event.Authorized]++
|
||||
*s.lastEvent = *event
|
||||
}
|
||||
|
||||
type loggerBuilder struct {
|
||||
authzDecisionStat map[bool]int
|
||||
lastEvent *audit.Event
|
||||
}
|
||||
|
||||
func (loggerBuilder) Name() string {
|
||||
return "stat_logger"
|
||||
}
|
||||
|
||||
func (lb *loggerBuilder) Build(audit.LoggerConfig) audit.Logger {
|
||||
return &statAuditLogger{
|
||||
authzDecisionStat: lb.authzDecisionStat,
|
||||
lastEvent: lb.lastEvent,
|
||||
}
|
||||
}
|
||||
|
||||
func (*loggerBuilder) ParseLoggerConfig(json.RawMessage) (audit.LoggerConfig, error) {
|
||||
return nil, nil
|
||||
}
|
||||
|
||||
// TestAuditLogger examines audit logging invocations using four different
|
||||
// authorization policies. It covers scenarios including a disabled audit,
|
||||
// auditing both 'allow' and 'deny' outcomes, and separately auditing 'allow'
|
||||
// and 'deny' outcomes. Additionally, it checks if SPIFFE ID from a certificate
|
||||
// is propagated correctly.
|
||||
func (s) TestAuditLogger(t *testing.T) {
|
||||
// Each test data entry contains an authz policy for a grpc server,
|
||||
// how many 'allow' and 'deny' outcomes we expect (each test case makes 2
|
||||
// unary calls and one client-streaming call), and a structure to check if
|
||||
// the audit.Event fields are properly populated. Additionally, we specify
|
||||
// directly which authz outcome we expect from each type of call.
|
||||
tests := []struct {
|
||||
name string
|
||||
authzPolicy string
|
||||
wantAuthzOutcomes map[bool]int
|
||||
eventContent *audit.Event
|
||||
wantUnaryCallCode codes.Code
|
||||
wantStreamingCallCode codes.Code
|
||||
}{
|
||||
{
|
||||
name: "No audit",
|
||||
authzPolicy: `{
|
||||
"name": "authz",
|
||||
"allow_rules": [
|
||||
{
|
||||
"name": "allow_UnaryCall",
|
||||
"request": {
|
||||
"paths": [
|
||||
"/grpc.testing.TestService/UnaryCall"
|
||||
]
|
||||
}
|
||||
}
|
||||
],
|
||||
"audit_logging_options": {
|
||||
"audit_condition": "NONE",
|
||||
"audit_loggers": [
|
||||
{
|
||||
"name": "stat_logger",
|
||||
"config": {},
|
||||
"is_optional": false
|
||||
}
|
||||
]
|
||||
}
|
||||
}`,
|
||||
wantAuthzOutcomes: map[bool]int{true: 0, false: 0},
|
||||
wantUnaryCallCode: codes.OK,
|
||||
wantStreamingCallCode: codes.PermissionDenied,
|
||||
},
|
||||
{
|
||||
name: "Allow All Deny Streaming - Audit All",
|
||||
authzPolicy: `{
|
||||
"name": "authz",
|
||||
"allow_rules": [
|
||||
{
|
||||
"name": "allow_all",
|
||||
"request": {
|
||||
"paths": [
|
||||
"*"
|
||||
]
|
||||
}
|
||||
}
|
||||
],
|
||||
"deny_rules": [
|
||||
{
|
||||
"name": "deny_all",
|
||||
"request": {
|
||||
"paths": [
|
||||
"/grpc.testing.TestService/StreamingInputCall"
|
||||
]
|
||||
}
|
||||
}
|
||||
],
|
||||
"audit_logging_options": {
|
||||
"audit_condition": "ON_DENY_AND_ALLOW",
|
||||
"audit_loggers": [
|
||||
{
|
||||
"name": "stat_logger",
|
||||
"config": {},
|
||||
"is_optional": false
|
||||
},
|
||||
{
|
||||
"name": "stdout_logger",
|
||||
"is_optional": false
|
||||
}
|
||||
]
|
||||
}
|
||||
}`,
|
||||
wantAuthzOutcomes: map[bool]int{true: 2, false: 1},
|
||||
eventContent: &audit.Event{
|
||||
FullMethodName: "/grpc.testing.TestService/StreamingInputCall",
|
||||
Principal: "spiffe://foo.bar.com/client/workload/1",
|
||||
PolicyName: "authz",
|
||||
MatchedRule: "authz_deny_all",
|
||||
Authorized: false,
|
||||
},
|
||||
wantUnaryCallCode: codes.OK,
|
||||
wantStreamingCallCode: codes.PermissionDenied,
|
||||
},
|
||||
{
|
||||
name: "Allow Unary - Audit Allow",
|
||||
authzPolicy: `{
|
||||
"name": "authz",
|
||||
"allow_rules": [
|
||||
{
|
||||
"name": "allow_UnaryCall",
|
||||
"request": {
|
||||
"paths": [
|
||||
"/grpc.testing.TestService/UnaryCall"
|
||||
]
|
||||
}
|
||||
}
|
||||
],
|
||||
"audit_logging_options": {
|
||||
"audit_condition": "ON_ALLOW",
|
||||
"audit_loggers": [
|
||||
{
|
||||
"name": "stat_logger",
|
||||
"config": {},
|
||||
"is_optional": false
|
||||
}
|
||||
]
|
||||
}
|
||||
}`,
|
||||
wantAuthzOutcomes: map[bool]int{true: 2, false: 0},
|
||||
wantUnaryCallCode: codes.OK,
|
||||
wantStreamingCallCode: codes.PermissionDenied,
|
||||
},
|
||||
{
|
||||
name: "Allow Typo - Audit Deny",
|
||||
authzPolicy: `{
|
||||
"name": "authz",
|
||||
"allow_rules": [
|
||||
{
|
||||
"name": "allow_UnaryCall",
|
||||
"request": {
|
||||
"paths": [
|
||||
"/grpc.testing.TestService/UnaryCall_Z"
|
||||
]
|
||||
}
|
||||
}
|
||||
],
|
||||
"audit_logging_options": {
|
||||
"audit_condition": "ON_DENY",
|
||||
"audit_loggers": [
|
||||
{
|
||||
"name": "stat_logger",
|
||||
"config": {},
|
||||
"is_optional": false
|
||||
}
|
||||
]
|
||||
}
|
||||
}`,
|
||||
wantAuthzOutcomes: map[bool]int{true: 0, false: 3},
|
||||
wantUnaryCallCode: codes.PermissionDenied,
|
||||
wantStreamingCallCode: codes.PermissionDenied,
|
||||
},
|
||||
}
|
||||
|
||||
for _, test := range tests {
|
||||
t.Run(test.name, func(t *testing.T) {
|
||||
// Construct the credentials for the tests and the stub server
|
||||
serverCreds := loadServerCreds(t)
|
||||
clientCreds := loadClientCreds(t)
|
||||
ss := &stubserver.StubServer{
|
||||
UnaryCallF: func(context.Context, *testpb.SimpleRequest) (*testpb.SimpleResponse, error) {
|
||||
return &testpb.SimpleResponse{}, nil
|
||||
},
|
||||
FullDuplexCallF: func(stream testgrpc.TestService_FullDuplexCallServer) error {
|
||||
_, err := stream.Recv()
|
||||
if err != io.EOF {
|
||||
return err
|
||||
}
|
||||
return nil
|
||||
},
|
||||
}
|
||||
// Setup test statAuditLogger, gRPC test server with authzPolicy, unary
|
||||
// and stream interceptors.
|
||||
lb := &loggerBuilder{
|
||||
authzDecisionStat: map[bool]int{true: 0, false: 0},
|
||||
lastEvent: &audit.Event{},
|
||||
}
|
||||
audit.RegisterLoggerBuilder(lb)
|
||||
i, _ := authz.NewStatic(test.authzPolicy)
|
||||
|
||||
s := grpc.NewServer(grpc.Creds(serverCreds), grpc.ChainUnaryInterceptor(i.UnaryInterceptor), grpc.ChainStreamInterceptor(i.StreamInterceptor))
|
||||
defer s.Stop()
|
||||
ss.S = s
|
||||
stubserver.StartTestService(t, ss)
|
||||
|
||||
// Setup gRPC test client with certificates containing a SPIFFE Id.
|
||||
cc, err := grpc.NewClient(ss.Address, grpc.WithTransportCredentials(clientCreds))
|
||||
if err != nil {
|
||||
t.Fatalf("grpc.NewClient(%v) failed: %v", ss.Address, err)
|
||||
}
|
||||
defer cc.Close()
|
||||
client := testgrpc.NewTestServiceClient(cc)
|
||||
ctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
|
||||
defer cancel()
|
||||
|
||||
if _, err := client.UnaryCall(ctx, &testpb.SimpleRequest{}); status.Code(err) != test.wantUnaryCallCode {
|
||||
t.Errorf("Unexpected UnaryCall fail: got %v want %v", err, test.wantUnaryCallCode)
|
||||
}
|
||||
if _, err := client.UnaryCall(ctx, &testpb.SimpleRequest{}); status.Code(err) != test.wantUnaryCallCode {
|
||||
t.Errorf("Unexpected UnaryCall fail: got %v want %v", err, test.wantUnaryCallCode)
|
||||
}
|
||||
stream, err := client.StreamingInputCall(ctx)
|
||||
if err != nil {
|
||||
t.Fatalf("StreamingInputCall failed: %v", err)
|
||||
}
|
||||
req := &testpb.StreamingInputCallRequest{
|
||||
Payload: &testpb.Payload{
|
||||
Body: []byte("hi"),
|
||||
},
|
||||
}
|
||||
if err := stream.Send(req); err != nil && err != io.EOF {
|
||||
t.Fatalf("stream.Send failed: %v", err)
|
||||
}
|
||||
if _, err := stream.CloseAndRecv(); status.Code(err) != test.wantStreamingCallCode {
|
||||
t.Errorf("Unexpected stream.CloseAndRecv fail: got %v want %v", err, test.wantStreamingCallCode)
|
||||
}
|
||||
|
||||
// Compare expected number of allows/denies with content of the internal
|
||||
// map of statAuditLogger.
|
||||
if diff := cmp.Diff(lb.authzDecisionStat, test.wantAuthzOutcomes); diff != "" {
|
||||
t.Errorf("Authorization decisions do not match\ndiff (-got +want):\n%s", diff)
|
||||
}
|
||||
// Compare last event received by statAuditLogger with expected event.
|
||||
if test.eventContent != nil {
|
||||
if diff := cmp.Diff(lb.lastEvent, test.eventContent); diff != "" {
|
||||
t.Errorf("Unexpected message\ndiff (-got +want):\n%s", diff)
|
||||
}
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
// loadServerCreds constructs TLS containing server certs and CA
|
||||
func loadServerCreds(t *testing.T) credentials.TransportCredentials {
|
||||
t.Helper()
|
||||
cert := loadKeys(t, "x509/server1_cert.pem", "x509/server1_key.pem")
|
||||
certPool := loadCACerts(t, "x509/client_ca_cert.pem")
|
||||
return credentials.NewTLS(&tls.Config{
|
||||
ClientAuth: tls.RequireAndVerifyClientCert,
|
||||
Certificates: []tls.Certificate{cert},
|
||||
ClientCAs: certPool,
|
||||
})
|
||||
}
|
||||
|
||||
// loadClientCreds constructs TLS containing client certs and CA
|
||||
func loadClientCreds(t *testing.T) credentials.TransportCredentials {
|
||||
t.Helper()
|
||||
cert := loadKeys(t, "x509/client_with_spiffe_cert.pem", "x509/client_with_spiffe_key.pem")
|
||||
roots := loadCACerts(t, "x509/server_ca_cert.pem")
|
||||
return credentials.NewTLS(&tls.Config{
|
||||
Certificates: []tls.Certificate{cert},
|
||||
RootCAs: roots,
|
||||
ServerName: "x.test.example.com",
|
||||
})
|
||||
|
||||
}
|
||||
|
||||
// loadKeys loads X509 key pair from the provided file paths.
|
||||
// It is used for loading both client and server certificates for the test
|
||||
func loadKeys(t *testing.T, certPath, key string) tls.Certificate {
|
||||
t.Helper()
|
||||
cert, err := tls.LoadX509KeyPair(testdata.Path(certPath), testdata.Path(key))
|
||||
if err != nil {
|
||||
t.Fatalf("tls.LoadX509KeyPair(%q, %q) failed: %v", certPath, key, err)
|
||||
}
|
||||
return cert
|
||||
}
|
||||
|
||||
// loadCACerts loads CA certificates and constructs x509.CertPool
|
||||
// It is used for loading both client and server CAs for the test
|
||||
func loadCACerts(t *testing.T, certPath string) *x509.CertPool {
|
||||
t.Helper()
|
||||
ca, err := os.ReadFile(testdata.Path(certPath))
|
||||
if err != nil {
|
||||
t.Fatalf("os.ReadFile(%q) failed: %v", certPath, err)
|
||||
}
|
||||
roots := x509.NewCertPool()
|
||||
if !roots.AppendCertsFromPEM(ca) {
|
||||
t.Fatal("Failed to append certificates")
|
||||
}
|
||||
return roots
|
||||
}
|
||||
110
authz/audit/stdout/stdout_logger.go
Normal file
110
authz/audit/stdout/stdout_logger.go
Normal file
@@ -0,0 +1,110 @@
|
||||
/*
|
||||
*
|
||||
* Copyright 2023 gRPC authors.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*
|
||||
*/
|
||||
|
||||
// Package stdout defines an stdout audit logger.
|
||||
package stdout
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"log"
|
||||
"os"
|
||||
"time"
|
||||
|
||||
"google.golang.org/grpc/authz/audit"
|
||||
"google.golang.org/grpc/grpclog"
|
||||
)
|
||||
|
||||
var grpcLogger = grpclog.Component("authz-audit")
|
||||
|
||||
// Name is the string to identify this logger type in the registry
|
||||
const Name = "stdout_logger"
|
||||
|
||||
func init() {
|
||||
audit.RegisterLoggerBuilder(&loggerBuilder{
|
||||
goLogger: log.New(os.Stdout, "", 0),
|
||||
})
|
||||
}
|
||||
|
||||
type event struct {
|
||||
FullMethodName string `json:"rpc_method"`
|
||||
Principal string `json:"principal"`
|
||||
PolicyName string `json:"policy_name"`
|
||||
MatchedRule string `json:"matched_rule"`
|
||||
Authorized bool `json:"authorized"`
|
||||
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.
|
||||
type logger struct {
|
||||
goLogger *log.Logger
|
||||
}
|
||||
|
||||
// Log marshals the audit.Event to json and prints it to standard output.
|
||||
func (l *logger) Log(event *audit.Event) {
|
||||
jsonContainer := map[string]any{
|
||||
"grpc_audit_log": convertEvent(event),
|
||||
}
|
||||
jsonBytes, err := json.Marshal(jsonContainer)
|
||||
if err != nil {
|
||||
grpcLogger.Errorf("failed to marshal AuditEvent data to JSON: %v", err)
|
||||
return
|
||||
}
|
||||
l.goLogger.Println(string(jsonBytes))
|
||||
}
|
||||
|
||||
// loggerConfig represents the configuration for the stdout logger.
|
||||
// It is currently empty and implements the audit.Logger interface by embedding it.
|
||||
type loggerConfig struct {
|
||||
audit.LoggerConfig
|
||||
}
|
||||
|
||||
type loggerBuilder struct {
|
||||
goLogger *log.Logger
|
||||
}
|
||||
|
||||
func (loggerBuilder) Name() string {
|
||||
return Name
|
||||
}
|
||||
|
||||
// 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 (lb *loggerBuilder) Build(audit.LoggerConfig) audit.Logger {
|
||||
return &logger{
|
||||
goLogger: lb.goLogger,
|
||||
}
|
||||
}
|
||||
|
||||
// ParseLoggerConfig is a no-op since the stdout logger does not accept any configuration.
|
||||
func (*loggerBuilder) ParseLoggerConfig(config json.RawMessage) (audit.LoggerConfig, error) {
|
||||
if len(config) != 0 && string(config) != "{}" {
|
||||
grpcLogger.Warningf("Stdout logger doesn't support custom configs. Ignoring:\n%s", string(config))
|
||||
}
|
||||
return &loggerConfig{}, nil
|
||||
}
|
||||
|
||||
func convertEvent(auditEvent *audit.Event) *event {
|
||||
return &event{
|
||||
FullMethodName: auditEvent.FullMethodName,
|
||||
Principal: auditEvent.Principal,
|
||||
PolicyName: auditEvent.PolicyName,
|
||||
MatchedRule: auditEvent.MatchedRule,
|
||||
Authorized: auditEvent.Authorized,
|
||||
Timestamp: time.Now().Format(time.RFC3339Nano),
|
||||
}
|
||||
}
|
||||
140
authz/audit/stdout/stdout_logger_test.go
Normal file
140
authz/audit/stdout/stdout_logger_test.go
Normal file
@@ -0,0 +1,140 @@
|
||||
/*
|
||||
*
|
||||
* Copyright 2023 gRPC authors.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*
|
||||
*/
|
||||
|
||||
package stdout
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"encoding/json"
|
||||
"log"
|
||||
"os"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/google/go-cmp/cmp"
|
||||
"google.golang.org/grpc/authz/audit"
|
||||
"google.golang.org/grpc/internal/grpctest"
|
||||
)
|
||||
|
||||
type s struct {
|
||||
grpctest.Tester
|
||||
}
|
||||
|
||||
func Test(t *testing.T) {
|
||||
grpctest.RunSubTests(t, s{})
|
||||
}
|
||||
|
||||
func (s) TestStdoutLogger_Log(t *testing.T) {
|
||||
tests := map[string]struct {
|
||||
event *audit.Event
|
||||
wantMessage string
|
||||
wantErr string
|
||||
}{
|
||||
"few fields": {
|
||||
event: &audit.Event{PolicyName: "test policy", Principal: "test principal"},
|
||||
wantMessage: `{"fullMethodName":"","principal":"test principal","policyName":"test policy","matchedRule":"","authorized":false`,
|
||||
},
|
||||
"all fields": {
|
||||
event: &audit.Event{
|
||||
FullMethodName: "/helloworld.Greeter/SayHello",
|
||||
Principal: "spiffe://example.org/ns/default/sa/default/backend",
|
||||
PolicyName: "example-policy",
|
||||
MatchedRule: "dev-access",
|
||||
Authorized: true,
|
||||
},
|
||||
wantMessage: `{"fullMethodName":"/helloworld.Greeter/SayHello",` +
|
||||
`"principal":"spiffe://example.org/ns/default/sa/default/backend","policyName":"example-policy",` +
|
||||
`"matchedRule":"dev-access","authorized":true`,
|
||||
},
|
||||
}
|
||||
|
||||
for name, test := range tests {
|
||||
t.Run(name, func(t *testing.T) {
|
||||
before := time.Now().Unix()
|
||||
var buf bytes.Buffer
|
||||
builder := &loggerBuilder{goLogger: log.New(&buf, "", 0)}
|
||||
auditLogger := builder.Build(nil)
|
||||
|
||||
auditLogger.Log(test.event)
|
||||
|
||||
var container map[string]any
|
||||
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]any))
|
||||
if innerEvent.Timestamp == "" {
|
||||
t.Fatalf("Resulted event has no timestamp: %v", innerEvent)
|
||||
}
|
||||
after := time.Now().Unix()
|
||||
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 != "" {
|
||||
t.Fatalf("Unexpected message\ndiff (-got +want):\n%s", diff)
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func (s) TestStdoutLoggerBuilder_NilConfig(t *testing.T) {
|
||||
builder := &loggerBuilder{
|
||||
goLogger: log.New(os.Stdout, "", log.LstdFlags),
|
||||
}
|
||||
config, err := builder.ParseLoggerConfig(nil)
|
||||
if err != nil {
|
||||
t.Fatalf("Failed to parse stdout logger configuration: %v", err)
|
||||
}
|
||||
if l := builder.Build(config); l == nil {
|
||||
t.Fatal("Failed to build stdout audit logger")
|
||||
}
|
||||
}
|
||||
|
||||
func (s) TestStdoutLoggerBuilder_Registration(t *testing.T) {
|
||||
if audit.GetLoggerBuilder("stdout_logger") == nil {
|
||||
t.Fatal("stdout logger is not registered")
|
||||
}
|
||||
}
|
||||
|
||||
// extractEvent extracts an stdout.event from a map
|
||||
// unmarshalled from a logged json message.
|
||||
func extractEvent(container map[string]any) event {
|
||||
return event{
|
||||
FullMethodName: container["rpc_method"].(string),
|
||||
Principal: container["principal"].(string),
|
||||
PolicyName: container["policy_name"].(string),
|
||||
MatchedRule: container["matched_rule"].(string),
|
||||
Authorized: container["authorized"].(bool),
|
||||
Timestamp: container["timestamp"].(string),
|
||||
}
|
||||
}
|
||||
|
||||
// trimEvent converts a logged stdout.event into an audit.Event
|
||||
// by removing Timestamp field. It is used for comparing events during testing.
|
||||
func trimEvent(testEvent event) *audit.Event {
|
||||
return &audit.Event{
|
||||
FullMethodName: testEvent.FullMethodName,
|
||||
Principal: testEvent.Principal,
|
||||
PolicyName: testEvent.PolicyName,
|
||||
MatchedRule: testEvent.MatchedRule,
|
||||
Authorized: testEvent.Authorized,
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user