2023-03-15 19:00:52 +03:00
// Copyright (c) HashiCorp, Inc.
2024-01-02 21:36:20 +03:00
// SPDX-License-Identifier: BUSL-1.1
2023-03-15 19:00:52 +03:00
2019-09-19 23:44:37 +03:00
package vault
import (
"context"
"errors"
"fmt"
2023-02-15 23:00:06 +03:00
"net/http"
2019-09-19 23:44:37 +03:00
"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 {
{
2023-07-06 23:01:33 +03:00
Pattern : "pprof/?$" ,
2019-09-19 23:44:37 +03:00
2023-04-13 18:32:57 +03:00
DisplayAttrs : & framework . DisplayAttributes {
OperationPrefix : "pprof" ,
OperationVerb : "index" ,
} ,
2019-09-19 23:44:37 +03:00
Operations : map [ logical . Operation ] framework . OperationHandler {
logical . ReadOperation : & framework . PathOperation {
2019-10-04 03:02:41 +03:00
Callback : b . handlePprofIndex ,
2023-02-15 23:00:06 +03:00
Responses : map [ int ] [ ] framework . Response {
http . StatusOK : { {
Description : "OK" ,
} } ,
} ,
Summary : "Returns an HTML page listing the available profiles." ,
2019-10-04 03:02:41 +03:00
Description : ` Returns an HTML page listing the available
profiles . This should be mainly accessed via browsers or applications that can
render pages . ` ,
2019-09-19 23:44:37 +03:00
} ,
} ,
} ,
{
Pattern : "pprof/cmdline" ,
2023-04-13 18:32:57 +03:00
DisplayAttrs : & framework . DisplayAttributes {
OperationPrefix : "pprof" ,
OperationVerb : "command-line" ,
} ,
2019-09-19 23:44:37 +03:00
Operations : map [ logical . Operation ] framework . OperationHandler {
logical . ReadOperation : & framework . PathOperation {
2023-02-15 23:00:06 +03:00
Callback : b . handlePprofCmdline ,
Responses : map [ int ] [ ] framework . Response {
http . StatusOK : { {
Description : "OK" ,
} } ,
} ,
2019-09-19 23:44:37 +03:00
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" ,
2023-04-13 18:32:57 +03:00
DisplayAttrs : & framework . DisplayAttributes {
OperationPrefix : "pprof" ,
OperationVerb : "goroutines" ,
} ,
2019-09-19 23:44:37 +03:00
Operations : map [ logical . Operation ] framework . OperationHandler {
logical . ReadOperation : & framework . PathOperation {
2023-02-15 23:00:06 +03:00
Callback : b . handlePprofGoroutine ,
Responses : map [ int ] [ ] framework . Response {
http . StatusOK : { {
Description : "OK" ,
} } ,
} ,
2019-09-19 23:44:37 +03:00
Summary : "Returns stack traces of all current goroutines." ,
Description : "Returns stack traces of all current goroutines." ,
} ,
} ,
} ,
{
Pattern : "pprof/heap" ,
2023-04-13 18:32:57 +03:00
DisplayAttrs : & framework . DisplayAttributes {
OperationPrefix : "pprof" ,
OperationVerb : "memory-allocations-live" ,
} ,
2019-09-19 23:44:37 +03:00
Operations : map [ logical . Operation ] framework . OperationHandler {
logical . ReadOperation : & framework . PathOperation {
2023-02-15 23:00:06 +03:00
Callback : b . handlePprofHeap ,
Responses : map [ int ] [ ] framework . Response {
http . StatusOK : { {
Description : "OK" ,
} } ,
} ,
2019-09-19 23:44:37 +03:00
Summary : "Returns a sampling of memory allocations of live object." ,
Description : "Returns a sampling of memory allocations of live object." ,
} ,
} ,
} ,
2021-04-19 21:30:59 +03:00
{
Pattern : "pprof/allocs" ,
2023-04-13 18:32:57 +03:00
DisplayAttrs : & framework . DisplayAttributes {
OperationPrefix : "pprof" ,
OperationVerb : "memory-allocations" ,
} ,
2021-04-19 21:30:59 +03:00
Operations : map [ logical . Operation ] framework . OperationHandler {
logical . ReadOperation : & framework . PathOperation {
2023-02-15 23:00:06 +03:00
Callback : b . handlePprofAllocs ,
Responses : map [ int ] [ ] framework . Response {
http . StatusOK : { {
Description : "OK" ,
} } ,
} ,
2021-04-19 21:30:59 +03:00
Summary : "Returns a sampling of all past memory allocations." ,
Description : "Returns a sampling of all past memory allocations." ,
} ,
} ,
} ,
{
Pattern : "pprof/threadcreate" ,
2023-04-13 18:32:57 +03:00
DisplayAttrs : & framework . DisplayAttributes {
OperationPrefix : "pprof" ,
OperationVerb : "thread-creations" ,
} ,
2021-04-19 21:30:59 +03:00
Operations : map [ logical . Operation ] framework . OperationHandler {
logical . ReadOperation : & framework . PathOperation {
2023-02-15 23:00:06 +03:00
Callback : b . handlePprofThreadcreate ,
Responses : map [ int ] [ ] framework . Response {
http . StatusOK : { {
Description : "OK" ,
} } ,
} ,
2021-04-19 21:30:59 +03:00
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" ,
2023-04-13 18:32:57 +03:00
DisplayAttrs : & framework . DisplayAttributes {
OperationPrefix : "pprof" ,
OperationVerb : "blocking" ,
} ,
2021-04-19 21:30:59 +03:00
Operations : map [ logical . Operation ] framework . OperationHandler {
logical . ReadOperation : & framework . PathOperation {
2023-02-15 23:00:06 +03:00
Callback : b . handlePprofBlock ,
Responses : map [ int ] [ ] framework . Response {
http . StatusOK : { {
Description : "OK" ,
} } ,
} ,
2021-04-19 21:30:59 +03:00
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" ,
2023-04-13 18:32:57 +03:00
DisplayAttrs : & framework . DisplayAttributes {
OperationPrefix : "pprof" ,
OperationVerb : "mutexes" ,
} ,
2021-04-19 21:30:59 +03:00
Operations : map [ logical . Operation ] framework . OperationHandler {
logical . ReadOperation : & framework . PathOperation {
2023-02-15 23:00:06 +03:00
Callback : b . handlePprofMutex ,
Responses : map [ int ] [ ] framework . Response {
http . StatusOK : { {
Description : "OK" ,
} } ,
} ,
2021-04-19 21:30:59 +03:00
Summary : "Returns stack traces of holders of contended mutexes" ,
Description : "Returns stack traces of holders of contended mutexes" ,
} ,
} ,
} ,
2019-09-19 23:44:37 +03:00
{
Pattern : "pprof/profile" ,
2023-04-13 18:32:57 +03:00
DisplayAttrs : & framework . DisplayAttributes {
OperationPrefix : "pprof" ,
OperationVerb : "cpu-profile" ,
} ,
2019-09-19 23:44:37 +03:00
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 {
2023-02-15 23:00:06 +03:00
Callback : b . handlePprofProfile ,
Responses : map [ int ] [ ] framework . Response {
http . StatusOK : { {
Description : "OK" ,
} } ,
} ,
2019-09-19 23:44:37 +03:00
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" ,
2023-04-13 18:32:57 +03:00
DisplayAttrs : & framework . DisplayAttributes {
OperationPrefix : "pprof" ,
OperationVerb : "symbols" ,
} ,
2019-09-19 23:44:37 +03:00
Operations : map [ logical . Operation ] framework . OperationHandler {
logical . ReadOperation : & framework . PathOperation {
2023-02-15 23:00:06 +03:00
Callback : b . handlePprofSymbol ,
Responses : map [ int ] [ ] framework . Response {
http . StatusOK : { {
Description : "OK" ,
} } ,
} ,
2019-09-19 23:44:37 +03:00
Summary : "Returns the program counters listed in the request." ,
Description : "Returns the program counters listed in the request." ,
} ,
} ,
} ,
{
Pattern : "pprof/trace" ,
2023-04-13 18:32:57 +03:00
DisplayAttrs : & framework . DisplayAttributes {
OperationPrefix : "pprof" ,
OperationVerb : "execution-trace" ,
} ,
2019-09-19 23:44:37 +03:00
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 {
2023-02-15 23:00:06 +03:00
Callback : b . handlePprofTrace ,
Responses : map [ int ] [ ] framework . Response {
http . StatusOK : { {
Description : "OK" ,
} } ,
} ,
2019-09-19 23:44:37 +03:00
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
}
2021-04-19 21:30:59 +03:00
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
}
2019-09-19 23:44:37 +03:00
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
}