Skip to content

Audit logging #674

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.

Sign up for GitHub

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

Open
weimingx wants to merge 1 commit into
base: master
Choose a base branch
from
+45 −3
Open

Audit logging #674

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 45 additions & 3 deletions gnmi_server/server.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -931,7 +931,28 @@ func IsNativeOrigin(origin string) bool {
}

// Get implements the Get RPC in gNMI spec.
func (s *Server) Get(ctx context.Context, req *gnmipb.GetRequest) (*gnmipb.GetResponse, error) {
func (s *Server) Get(ctx context.Context, req *gnmipb.GetRequest) (resp *gnmipb.GetResponse, err error) {
// GNMI-AUDIT logging
start := time.Now()
user := extractUser(ctx)
peer := extractPeer(ctx)

log.Infof("[GNMI-AUDIT] GetRequest user=%s peer=%s prefix=%v paths=%v type=%v",
user, peer, req.GetPrefix(), req.GetPath(), req.GetType())

// defer logs automatically when function returns
defer func() {
duration := time.Since(start)

if err != nil {
log.Errorf("[GNMI-AUDIT] GetResponse user=%s peer=%s status=FAIL err=%v duration=%v",
user, peer, err, duration)
} else {
log.Infof("[GNMI-AUDIT] GetResponse user=%s peer=%s status=OK duration=%v",
user, peer, duration)
}
}()

common_utils.IncCounter(common_utils.GNMI_GET)

if req.GetType() != gnmipb.GetRequest_ALL {
Expand Down Expand Up @@ -1072,8 +1093,19 @@ func SaveOnSetEnabled() error {
func saveOnSetDisabled() error { return nil }

func (s *Server) Set(ctx context.Context, req *gnmipb.SetRequest) (*gnmipb.SetResponse, error) {
// GNMI-AUDIT logging
start := time.Now()
user := extractUser(ctx) // from auth metadata
peer := extractPeer(ctx) // client address

log.Infof("[GNMI-AUDIT] SetRequest user=%s peer=%s prefix=%v updates=%d replaces=%d deletes=%d",
user, peer, req.GetPrefix(), len(req.GetUpdate()), len(req.GetReplace()), len(req.GetDelete()))

e := s.ReqFromMaster(req, &s.masterEID)
if e != nil {
duration := time.Since(start)
log.Errorf("[GNMI-AUDIT] SetResponse user=%s peer=%s status=FAIL err=%v duration=%v",
user, peer, e, duration)
return nil, e
}

Expand Down Expand Up @@ -1213,11 +1245,21 @@ func (s *Server) Set(ctx context.Context, req *gnmipb.SetRequest) (*gnmipb.SetRe
s.SaveStartupConfig()
}

return &gnmipb.SetResponse{
resp := &gnmipb.SetResponse{
Prefix: req.GetPrefix(),
Response: results,
}, err
}

duration := time.Since(start)

if err != nil {
log.Errorf("[GNMI-AUDIT] SetResponse user=%s peer=%s status=FAIL err=%v duration=%v",
user, peer, err, duration)
} else {
log.Infof("[GNMI-AUDIT] SetResponse user=%s peer=%s status=OK duration=%v",
user, peer, duration)
}
return resp, err
}

func (s *Server) Capabilities(ctx context.Context, req *gnmipb.CapabilityRequest) (*gnmipb.CapabilityResponse, error) {
Expand Down
Loading