mirror of
https://github.com/optim-enterprises-bv/vault.git
synced 2025-11-02 03:27:54 +00:00
17ffe62d0d
* VAULT-22481: Audit filter node (#24465) * Initial commit on adding filter nodes for audit * tests for audit filter * test: longer filter - more conditions * copywrite headers * Check interface for the right type * Add audit filtering feature (#24554) * Support filter nodes in backend factories and add some tests * More tests and cleanup * Attempt to move control of registration for nodes and pipelines to the audit broker (#24505) * invert control of the pipelines/nodes to the audit broker vs. within each backend * update noop audit test code to implement the pipeliner interface * noop mount path has trailing slash * attempting to make NoopAudit more friendly * NoopAudit uses known salt * Refactor audit.ProcessManual to support filter nodes * HasFiltering * rename the pipeliner * use exported AuditEvent in Filter * Add tests for registering and deregistering backends on the audit broker * Add missing licence header to one file, fix a typo in two tests --------- Co-authored-by: Peter Wilson <peter.wilson@hashicorp.com> * Add changelog file * update bexpr datum to use a strong type * go docs updates * test path * PR review comments * handle scenarios/outcomes from broker.send * don't need to re-check the complete sinks * add extra check to deregister to ensure that re-registering non-filtered device sets sink threshold * Ensure that the multierror is appended before attempting to return it --------- Co-authored-by: Peter Wilson <peter.wilson@hashicorp.com>
84 lines
2.0 KiB
Go
84 lines
2.0 KiB
Go
// Copyright (c) HashiCorp, Inc.
|
|
// SPDX-License-Identifier: BUSL-1.1
|
|
|
|
package event
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"strings"
|
|
|
|
gsyslog "github.com/hashicorp/go-syslog"
|
|
|
|
"github.com/hashicorp/eventlogger"
|
|
)
|
|
|
|
var _ eventlogger.Node = (*SyslogSink)(nil)
|
|
|
|
// SyslogSink is a sink node which handles writing events to syslog.
|
|
type SyslogSink struct {
|
|
requiredFormat string
|
|
logger gsyslog.Syslogger
|
|
}
|
|
|
|
// NewSyslogSink should be used to create a new SyslogSink.
|
|
// Accepted options: WithFacility and WithTag.
|
|
func NewSyslogSink(format string, opt ...Option) (*SyslogSink, error) {
|
|
const op = "event.NewSyslogSink"
|
|
|
|
format = strings.TrimSpace(format)
|
|
if format == "" {
|
|
return nil, fmt.Errorf("%s: format is required: %w", op, ErrInvalidParameter)
|
|
}
|
|
|
|
opts, err := getOpts(opt...)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("%s: error applying options: %w", op, err)
|
|
}
|
|
|
|
logger, err := gsyslog.NewLogger(gsyslog.LOG_INFO, opts.withFacility, opts.withTag)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("%s: error creating syslogger: %w", op, err)
|
|
}
|
|
|
|
return &SyslogSink{requiredFormat: format, logger: logger}, nil
|
|
}
|
|
|
|
// Process handles writing the event to the syslog.
|
|
func (s *SyslogSink) Process(ctx context.Context, e *eventlogger.Event) (*eventlogger.Event, error) {
|
|
const op = "event.(SyslogSink).Process"
|
|
|
|
select {
|
|
case <-ctx.Done():
|
|
return nil, ctx.Err()
|
|
default:
|
|
}
|
|
|
|
if e == nil {
|
|
return nil, fmt.Errorf("%s: event is nil: %w", op, ErrInvalidParameter)
|
|
}
|
|
|
|
formatted, found := e.Format(s.requiredFormat)
|
|
if !found {
|
|
return nil, fmt.Errorf("%s: unable to retrieve event formatted as %q", op, s.requiredFormat)
|
|
}
|
|
|
|
_, err := s.logger.Write(formatted)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("%s: error writing to syslog: %w", op, err)
|
|
}
|
|
|
|
// return nil for the event to indicate the pipeline is complete.
|
|
return nil, nil
|
|
}
|
|
|
|
// Reopen is a no-op for a syslog sink.
|
|
func (_ *SyslogSink) Reopen() error {
|
|
return nil
|
|
}
|
|
|
|
// Type describes the type of this node (sink).
|
|
func (_ *SyslogSink) Type() eventlogger.NodeType {
|
|
return eventlogger.NodeTypeSink
|
|
}
|