mirror of
https://github.com/optim-enterprises-bv/vault.git
synced 2025-10-29 17:52:32 +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>
75 lines
1.8 KiB
Go
75 lines
1.8 KiB
Go
// Copyright (c) HashiCorp, Inc.
|
|
// SPDX-License-Identifier: BUSL-1.1
|
|
|
|
package event
|
|
|
|
import (
|
|
"context"
|
|
"fmt"
|
|
"os"
|
|
"strings"
|
|
|
|
"github.com/hashicorp/eventlogger"
|
|
)
|
|
|
|
var _ eventlogger.Node = (*StdoutSink)(nil)
|
|
|
|
// StdoutSink is structure that implements the eventlogger.Node interface
|
|
// as a Sink node that writes the events to the standard output stream.
|
|
type StdoutSink struct {
|
|
requiredFormat string
|
|
}
|
|
|
|
// NewStdoutSinkNode creates a new StdoutSink that will persist the events
|
|
// it processes using the specified expected format.
|
|
func NewStdoutSinkNode(format string) (*StdoutSink, error) {
|
|
const op = "event.NewStdoutSinkNode"
|
|
|
|
format = strings.TrimSpace(format)
|
|
if format == "" {
|
|
return nil, fmt.Errorf("%s: format is required: %w", op, ErrInvalidParameter)
|
|
}
|
|
|
|
return &StdoutSink{
|
|
requiredFormat: format,
|
|
}, nil
|
|
}
|
|
|
|
// Process persists the provided eventlogger.Event to the standard output stream.
|
|
func (s *StdoutSink) Process(ctx context.Context, event *eventlogger.Event) (*eventlogger.Event, error) {
|
|
const op = "event.(StdoutSink).Process"
|
|
|
|
select {
|
|
case <-ctx.Done():
|
|
return nil, ctx.Err()
|
|
default:
|
|
}
|
|
|
|
if event == nil {
|
|
return nil, fmt.Errorf("%s: event is nil: %w", op, ErrInvalidParameter)
|
|
}
|
|
|
|
formattedBytes, found := event.Format(s.requiredFormat)
|
|
if !found {
|
|
return nil, fmt.Errorf("%s: unable to retrieve event formatted as %q", op, s.requiredFormat)
|
|
}
|
|
|
|
_, err := os.Stdout.Write(formattedBytes)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("%s: error writing to stdout: %w", op, err)
|
|
}
|
|
|
|
// Return nil, nil to indicate the pipeline is complete.
|
|
return nil, nil
|
|
}
|
|
|
|
// Reopen is a no-op for the StdoutSink type.
|
|
func (s *StdoutSink) Reopen() error {
|
|
return nil
|
|
}
|
|
|
|
// Type returns the eventlogger.NodeTypeSink constant.
|
|
func (s *StdoutSink) Type() eventlogger.NodeType {
|
|
return eventlogger.NodeTypeSink
|
|
}
|