audit

Documentation

Index

• func Hash(salter *salt.Salt, raw interface{}) error
• func HashString(salter *salt.Salt, data string) string
• func HashStructure(s interface{}, cb HashCallback) (interface{}, error)
• type Backend
• type BackendConfig
• type Factory
• type FormatJSON
  • func (f *FormatJSON) FormatRequest(w io.Writer, auth *logical.Auth, req *logical.Request, err error) error
  • func (f *FormatJSON) FormatResponse(w io.Writer, auth *logical.Auth, req *logical.Request, resp *logical.Response, ...) error
• type Formatter
• type HashCallback
• type JSONAuth
• type JSONRequest
• type JSONRequestEntry
• type JSONResponse
• type JSONResponseEntry
• type JSONSecret
• type JSONWrapInfo

Functions

func Hash

func Hash(salter *salt.Salt, raw interface{}) error

Hash will hash the given type. This has built-in support for auth, requests, and responses. If it is a type that isn't recognized, then it will be passed through.

The structure is modified in-place.

func HashString

func HashString(salter *salt.Salt, data string) string

HashString hashes the given opaque string and returns it

func HashStructure

func HashStructure(s interface{}, cb HashCallback) (interface{}, error)

HashStructure takes an interface and hashes all the values within the structure. Only _values_ are hashed: keys of objects are not.

For the HashCallback, see the built-in HashCallbacks below.

Types

type Backend

type Backend interface {
	// LogRequest is used to synchronously log a request. This is done after the
	// request is authorized but before the request is executed. The arguments
	// MUST not be modified in anyway. They should be deep copied if this is
	// a possibility.
	LogRequest(*logical.Auth, *logical.Request, error) error

	// LogResponse is used to synchronously log a response. This is done after
	// the request is processed but before the response is sent. The arguments
	// MUST not be modified in anyway. They should be deep copied if this is
	// a possibility.
	LogResponse(*logical.Auth, *logical.Request, *logical.Response, error) error

	// GetHash is used to return the given data with the backend's hash,
	// so that a caller can determine if a value in the audit log matches
	// an expected plaintext value
	GetHash(string) string
}

Backend interface must be implemented for an audit mechanism to be made available. Audit backends can be enabled to sink information to different backends such as logs, file, databases, or other external services.

type BackendConfig

type BackendConfig struct {
	// The salt that should be used for any secret obfuscation
	Salt *salt.Salt

	// Config is the opaque user configuration provided when mounting
	Config map[string]string
}

type Factory

type Factory func(*BackendConfig) (Backend, error)

Factory is the factory function to create an audit backend.

type FormatJSON

type FormatJSON struct{}

FormatJSON is a Formatter implementation that structures data into a JSON format.

func (*FormatJSON) FormatRequest

func (f *FormatJSON) FormatRequest(
	w io.Writer,
	auth *logical.Auth,
	req *logical.Request,
	err error) error

func (*FormatJSON) FormatResponse

func (f *FormatJSON) FormatResponse(
	w io.Writer,
	auth *logical.Auth,
	req *logical.Request,
	resp *logical.Response,
	err error) error

type Formatter

type Formatter interface {
	FormatRequest(io.Writer, *logical.Auth, *logical.Request, error) error
	FormatResponse(io.Writer, *logical.Auth, *logical.Request, *logical.Response, error) error
}

Formatter is an interface that is responsible for formating a request/response into some format. Formatters write their output to an io.Writer.

It is recommended that you pass data through Hash prior to formatting it.

type HashCallback

type HashCallback func(string) string

HashCallback is the callback called for HashStructure to hash a value.

type JSONAuth

type JSONAuth struct {
	ClientToken string            `json:"client_token,omitempty"`
	Accessor    string            `json:"accessor,omitempty"`
	DisplayName string            `json:"display_name"`
	Policies    []string          `json:"policies"`
	Metadata    map[string]string `json:"metadata"`
}

type JSONRequest

type JSONRequest struct {
	Operation   logical.Operation      `json:"operation"`
	ClientToken string                 `json:"client_token"`
	Path        string                 `json:"path"`
	Data        map[string]interface{} `json:"data"`
	RemoteAddr  string                 `json:"remote_address"`
	WrapTTL     int                    `json:"wrap_ttl"`
}

type JSONRequestEntry

type JSONRequestEntry struct {
	Time    string      `json:"time"`
	Type    string      `json:"type"`
	Auth    JSONAuth    `json:"auth"`
	Request JSONRequest `json:"request"`
	Error   string      `json:"error"`
}

JSONRequest is the structure of a request audit log entry in JSON.

type JSONResponse

type JSONResponse struct {
	Auth     *JSONAuth              `json:"auth,omitempty"`
	Secret   *JSONSecret            `json:"secret,emitempty"`
	Data     map[string]interface{} `json:"data"`
	Redirect string                 `json:"redirect"`
	WrapInfo *JSONWrapInfo          `json:"wrap_info,omitempty"`
}

type JSONResponseEntry

type JSONResponseEntry struct {
	Time     string       `json:"time"`
	Type     string       `json:"type"`
	Error    string       `json:"error"`
	Auth     JSONAuth     `json:"auth"`
	Request  JSONRequest  `json:"request"`
	Response JSONResponse `json:"response"`
}

JSONResponseEntry is the structure of a response audit log entry in JSON.

type JSONSecret

type JSONSecret struct {
	LeaseID string `json:"lease_id"`
}

type JSONWrapInfo

type JSONWrapInfo struct {
	TTL          int       `json:"ttl"`
	Token        string    `json:"token"`
	CreationTime time.Time `json:"creation_time"`
}