408 lines
12 KiB
Go
408 lines
12 KiB
Go
// Copyright (c) HashiCorp, Inc.
|
|
// SPDX-License-Identifier: MPL-2.0
|
|
|
|
package vault
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
"fmt"
|
|
"net/http"
|
|
"net/http/pprof"
|
|
"strconv"
|
|
|
|
"github.com/hashicorp/vault/sdk/framework"
|
|
"github.com/hashicorp/vault/sdk/logical"
|
|
)
|
|
|
|
func (b *SystemBackend) pprofPaths() []*framework.Path {
|
|
return []*framework.Path{
|
|
{
|
|
Pattern: "pprof/?$",
|
|
|
|
DisplayAttrs: &framework.DisplayAttributes{
|
|
OperationPrefix: "pprof",
|
|
OperationVerb: "index",
|
|
},
|
|
|
|
Operations: map[logical.Operation]framework.OperationHandler{
|
|
logical.ReadOperation: &framework.PathOperation{
|
|
Callback: b.handlePprofIndex,
|
|
Responses: map[int][]framework.Response{
|
|
http.StatusOK: {{
|
|
Description: "OK",
|
|
}},
|
|
},
|
|
Summary: "Returns an HTML page listing the available profiles.",
|
|
Description: `Returns an HTML page listing the available
|
|
profiles. This should be mainly accessed via browsers or applications that can
|
|
render pages.`,
|
|
},
|
|
},
|
|
},
|
|
{
|
|
Pattern: "pprof/cmdline",
|
|
|
|
DisplayAttrs: &framework.DisplayAttributes{
|
|
OperationPrefix: "pprof",
|
|
OperationVerb: "command-line",
|
|
},
|
|
|
|
Operations: map[logical.Operation]framework.OperationHandler{
|
|
logical.ReadOperation: &framework.PathOperation{
|
|
Callback: b.handlePprofCmdline,
|
|
Responses: map[int][]framework.Response{
|
|
http.StatusOK: {{
|
|
Description: "OK",
|
|
}},
|
|
},
|
|
Summary: "Returns the running program's command line.",
|
|
Description: "Returns the running program's command line, with arguments separated by NUL bytes.",
|
|
},
|
|
},
|
|
},
|
|
{
|
|
Pattern: "pprof/goroutine",
|
|
|
|
DisplayAttrs: &framework.DisplayAttributes{
|
|
OperationPrefix: "pprof",
|
|
OperationVerb: "goroutines",
|
|
},
|
|
|
|
Operations: map[logical.Operation]framework.OperationHandler{
|
|
logical.ReadOperation: &framework.PathOperation{
|
|
Callback: b.handlePprofGoroutine,
|
|
Responses: map[int][]framework.Response{
|
|
http.StatusOK: {{
|
|
Description: "OK",
|
|
}},
|
|
},
|
|
Summary: "Returns stack traces of all current goroutines.",
|
|
Description: "Returns stack traces of all current goroutines.",
|
|
},
|
|
},
|
|
},
|
|
{
|
|
Pattern: "pprof/heap",
|
|
|
|
DisplayAttrs: &framework.DisplayAttributes{
|
|
OperationPrefix: "pprof",
|
|
OperationVerb: "memory-allocations-live",
|
|
},
|
|
|
|
Operations: map[logical.Operation]framework.OperationHandler{
|
|
logical.ReadOperation: &framework.PathOperation{
|
|
Callback: b.handlePprofHeap,
|
|
Responses: map[int][]framework.Response{
|
|
http.StatusOK: {{
|
|
Description: "OK",
|
|
}},
|
|
},
|
|
Summary: "Returns a sampling of memory allocations of live object.",
|
|
Description: "Returns a sampling of memory allocations of live object.",
|
|
},
|
|
},
|
|
},
|
|
{
|
|
Pattern: "pprof/allocs",
|
|
|
|
DisplayAttrs: &framework.DisplayAttributes{
|
|
OperationPrefix: "pprof",
|
|
OperationVerb: "memory-allocations",
|
|
},
|
|
|
|
Operations: map[logical.Operation]framework.OperationHandler{
|
|
logical.ReadOperation: &framework.PathOperation{
|
|
Callback: b.handlePprofAllocs,
|
|
Responses: map[int][]framework.Response{
|
|
http.StatusOK: {{
|
|
Description: "OK",
|
|
}},
|
|
},
|
|
Summary: "Returns a sampling of all past memory allocations.",
|
|
Description: "Returns a sampling of all past memory allocations.",
|
|
},
|
|
},
|
|
},
|
|
{
|
|
Pattern: "pprof/threadcreate",
|
|
|
|
DisplayAttrs: &framework.DisplayAttributes{
|
|
OperationPrefix: "pprof",
|
|
OperationVerb: "thread-creations",
|
|
},
|
|
|
|
Operations: map[logical.Operation]framework.OperationHandler{
|
|
logical.ReadOperation: &framework.PathOperation{
|
|
Callback: b.handlePprofThreadcreate,
|
|
Responses: map[int][]framework.Response{
|
|
http.StatusOK: {{
|
|
Description: "OK",
|
|
}},
|
|
},
|
|
|
|
Summary: "Returns stack traces that led to the creation of new OS threads",
|
|
Description: "Returns stack traces that led to the creation of new OS threads",
|
|
},
|
|
},
|
|
},
|
|
{
|
|
Pattern: "pprof/block",
|
|
|
|
DisplayAttrs: &framework.DisplayAttributes{
|
|
OperationPrefix: "pprof",
|
|
OperationVerb: "blocking",
|
|
},
|
|
|
|
Operations: map[logical.Operation]framework.OperationHandler{
|
|
logical.ReadOperation: &framework.PathOperation{
|
|
Callback: b.handlePprofBlock,
|
|
Responses: map[int][]framework.Response{
|
|
http.StatusOK: {{
|
|
Description: "OK",
|
|
}},
|
|
},
|
|
Summary: "Returns stack traces that led to blocking on synchronization primitives",
|
|
Description: "Returns stack traces that led to blocking on synchronization primitives",
|
|
},
|
|
},
|
|
},
|
|
{
|
|
Pattern: "pprof/mutex",
|
|
|
|
DisplayAttrs: &framework.DisplayAttributes{
|
|
OperationPrefix: "pprof",
|
|
OperationVerb: "mutexes",
|
|
},
|
|
|
|
Operations: map[logical.Operation]framework.OperationHandler{
|
|
logical.ReadOperation: &framework.PathOperation{
|
|
Callback: b.handlePprofMutex,
|
|
Responses: map[int][]framework.Response{
|
|
http.StatusOK: {{
|
|
Description: "OK",
|
|
}},
|
|
},
|
|
Summary: "Returns stack traces of holders of contended mutexes",
|
|
Description: "Returns stack traces of holders of contended mutexes",
|
|
},
|
|
},
|
|
},
|
|
{
|
|
Pattern: "pprof/profile",
|
|
|
|
DisplayAttrs: &framework.DisplayAttributes{
|
|
OperationPrefix: "pprof",
|
|
OperationVerb: "cpu-profile",
|
|
},
|
|
|
|
Fields: map[string]*framework.FieldSchema{
|
|
"seconds": {
|
|
Type: framework.TypeInt,
|
|
Description: "If provided, specifies the duration to run the profiling command.",
|
|
},
|
|
},
|
|
|
|
Operations: map[logical.Operation]framework.OperationHandler{
|
|
logical.ReadOperation: &framework.PathOperation{
|
|
Callback: b.handlePprofProfile,
|
|
Responses: map[int][]framework.Response{
|
|
http.StatusOK: {{
|
|
Description: "OK",
|
|
}},
|
|
},
|
|
Summary: "Returns a pprof-formatted cpu profile payload.",
|
|
Description: "Returns a pprof-formatted cpu profile payload. Profiling lasts for duration specified in seconds GET parameter, or for 30 seconds if not specified.",
|
|
},
|
|
},
|
|
},
|
|
{
|
|
Pattern: "pprof/symbol",
|
|
|
|
DisplayAttrs: &framework.DisplayAttributes{
|
|
OperationPrefix: "pprof",
|
|
OperationVerb: "symbols",
|
|
},
|
|
|
|
Operations: map[logical.Operation]framework.OperationHandler{
|
|
logical.ReadOperation: &framework.PathOperation{
|
|
Callback: b.handlePprofSymbol,
|
|
Responses: map[int][]framework.Response{
|
|
http.StatusOK: {{
|
|
Description: "OK",
|
|
}},
|
|
},
|
|
Summary: "Returns the program counters listed in the request.",
|
|
Description: "Returns the program counters listed in the request.",
|
|
},
|
|
},
|
|
},
|
|
|
|
{
|
|
Pattern: "pprof/trace",
|
|
|
|
DisplayAttrs: &framework.DisplayAttributes{
|
|
OperationPrefix: "pprof",
|
|
OperationVerb: "execution-trace",
|
|
},
|
|
|
|
Fields: map[string]*framework.FieldSchema{
|
|
"seconds": {
|
|
Type: framework.TypeInt,
|
|
Description: "If provided, specifies the duration to run the tracing command.",
|
|
},
|
|
},
|
|
|
|
Operations: map[logical.Operation]framework.OperationHandler{
|
|
logical.ReadOperation: &framework.PathOperation{
|
|
Callback: b.handlePprofTrace,
|
|
Responses: map[int][]framework.Response{
|
|
http.StatusOK: {{
|
|
Description: "OK",
|
|
}},
|
|
},
|
|
Summary: "Returns the execution trace in binary form.",
|
|
Description: "Returns the execution trace in binary form. Tracing lasts for duration specified in seconds GET parameter, or for 1 second if not specified.",
|
|
},
|
|
},
|
|
},
|
|
}
|
|
}
|
|
|
|
func (b *SystemBackend) handlePprofIndex(ctx context.Context, req *logical.Request, d *framework.FieldData) (*logical.Response, error) {
|
|
if err := checkRequestHandlerParams(req); err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
pprof.Index(req.ResponseWriter, req.HTTPRequest)
|
|
return nil, nil
|
|
}
|
|
|
|
func (b *SystemBackend) handlePprofCmdline(ctx context.Context, req *logical.Request, d *framework.FieldData) (*logical.Response, error) {
|
|
if err := checkRequestHandlerParams(req); err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
pprof.Cmdline(req.ResponseWriter, req.HTTPRequest)
|
|
return nil, nil
|
|
}
|
|
|
|
func (b *SystemBackend) handlePprofGoroutine(ctx context.Context, req *logical.Request, d *framework.FieldData) (*logical.Response, error) {
|
|
if err := checkRequestHandlerParams(req); err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
pprof.Handler("goroutine").ServeHTTP(req.ResponseWriter, req.HTTPRequest)
|
|
return nil, nil
|
|
}
|
|
|
|
func (b *SystemBackend) handlePprofHeap(ctx context.Context, req *logical.Request, d *framework.FieldData) (*logical.Response, error) {
|
|
if err := checkRequestHandlerParams(req); err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
pprof.Handler("heap").ServeHTTP(req.ResponseWriter, req.HTTPRequest)
|
|
return nil, nil
|
|
}
|
|
|
|
func (b *SystemBackend) handlePprofAllocs(ctx context.Context, req *logical.Request, d *framework.FieldData) (*logical.Response, error) {
|
|
if err := checkRequestHandlerParams(req); err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
pprof.Handler("allocs").ServeHTTP(req.ResponseWriter, req.HTTPRequest)
|
|
return nil, nil
|
|
}
|
|
|
|
func (b *SystemBackend) handlePprofThreadcreate(ctx context.Context, req *logical.Request, d *framework.FieldData) (*logical.Response, error) {
|
|
if err := checkRequestHandlerParams(req); err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
pprof.Handler("threadcreate").ServeHTTP(req.ResponseWriter, req.HTTPRequest)
|
|
return nil, nil
|
|
}
|
|
|
|
func (b *SystemBackend) handlePprofBlock(ctx context.Context, req *logical.Request, d *framework.FieldData) (*logical.Response, error) {
|
|
if err := checkRequestHandlerParams(req); err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
pprof.Handler("block").ServeHTTP(req.ResponseWriter, req.HTTPRequest)
|
|
return nil, nil
|
|
}
|
|
|
|
func (b *SystemBackend) handlePprofMutex(ctx context.Context, req *logical.Request, d *framework.FieldData) (*logical.Response, error) {
|
|
if err := checkRequestHandlerParams(req); err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
pprof.Handler("mutex").ServeHTTP(req.ResponseWriter, req.HTTPRequest)
|
|
return nil, nil
|
|
}
|
|
|
|
func (b *SystemBackend) handlePprofProfile(ctx context.Context, req *logical.Request, d *framework.FieldData) (*logical.Response, error) {
|
|
if err := checkRequestHandlerParams(req); err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
// Return an error if seconds exceeds max request duration. This follows a
|
|
// similar behavior to how pprof treats seconds > WriteTimeout (i.e. it
|
|
// error with a 400), and avoids drift between what gets audited vs what
|
|
// ends up happening.
|
|
if secQueryVal := req.HTTPRequest.FormValue("seconds"); secQueryVal != "" {
|
|
maxDur := int64(DefaultMaxRequestDuration.Seconds())
|
|
sec, _ := strconv.ParseInt(secQueryVal, 10, 64)
|
|
if sec > maxDur {
|
|
return logical.ErrorResponse(fmt.Sprintf("seconds %d exceeds max request duration of %d", sec, maxDur)), nil
|
|
}
|
|
}
|
|
|
|
pprof.Profile(req.ResponseWriter, req.HTTPRequest)
|
|
return nil, nil
|
|
}
|
|
|
|
func (b *SystemBackend) handlePprofSymbol(ctx context.Context, req *logical.Request, d *framework.FieldData) (*logical.Response, error) {
|
|
if err := checkRequestHandlerParams(req); err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
pprof.Symbol(req.ResponseWriter, req.HTTPRequest)
|
|
return nil, nil
|
|
}
|
|
|
|
func (b *SystemBackend) handlePprofTrace(ctx context.Context, req *logical.Request, d *framework.FieldData) (*logical.Response, error) {
|
|
if err := checkRequestHandlerParams(req); err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
// Return an error if seconds exceeds max request duration. This follows a
|
|
// similar behavior to how pprof treats seconds > WriteTimeout (i.e. it
|
|
// error with a 400), and avoids drift between what gets audited vs what
|
|
// ends up happening.
|
|
if secQueryVal := req.HTTPRequest.FormValue("seconds"); secQueryVal != "" {
|
|
maxDur := int64(DefaultMaxRequestDuration.Seconds())
|
|
sec, _ := strconv.ParseInt(secQueryVal, 10, 64)
|
|
if sec > maxDur {
|
|
return logical.ErrorResponse(fmt.Sprintf("seconds %d exceeds max request duration of %d", sec, maxDur)), nil
|
|
}
|
|
}
|
|
|
|
pprof.Trace(req.ResponseWriter, req.HTTPRequest)
|
|
return nil, nil
|
|
}
|
|
|
|
// checkRequestHandlerParams is a helper that checks for the existence of the
|
|
// HTTP request and response writer in a logical.Request.
|
|
func checkRequestHandlerParams(req *logical.Request) error {
|
|
if req.ResponseWriter == nil {
|
|
return errors.New("no writer for request")
|
|
}
|
|
|
|
if req.HTTPRequest == nil || req.HTTPRequest.Body == nil {
|
|
return errors.New("no reader for request")
|
|
}
|
|
|
|
return nil
|
|
}
|