2015-08-24 00:50:33 +00:00
|
|
|
package agent
|
|
|
|
|
|
|
|
|
|
import (
|
2016-05-18 01:05:00 +00:00
|
|
|
"bytes"
|
2016-10-24 05:22:00 +00:00
|
|
|
"crypto/tls"
|
2015-09-06 00:06:05 +00:00
|
|
|
"encoding/json"
|
2020-05-19 13:46:31 +00:00
|
|
|
"errors"
|
2015-08-24 00:50:33 +00:00
|
|
|
"fmt"
|
|
|
|
|
"net"
|
|
|
|
|
"net/http"
|
|
|
|
|
"net/http/pprof"
|
2017-09-19 14:47:10 +00:00
|
|
|
"os"
|
2015-09-06 00:06:05 +00:00
|
|
|
"strconv"
|
2018-01-05 22:12:52 +00:00
|
|
|
"strings"
|
2015-09-06 00:06:05 +00:00
|
|
|
"time"
|
|
|
|
|
|
2022-07-20 18:12:21 +00:00
|
|
|
"github.com/armon/go-metrics"
|
2017-11-15 01:53:23 +00:00
|
|
|
assetfs "github.com/elazarl/go-bindata-assetfs"
|
2022-01-12 21:17:16 +00:00
|
|
|
"github.com/gorilla/handlers"
|
2019-04-28 21:33:25 +00:00
|
|
|
"github.com/gorilla/websocket"
|
2020-01-15 15:41:59 +00:00
|
|
|
"github.com/hashicorp/go-connlimit"
|
2018-09-13 17:43:40 +00:00
|
|
|
log "github.com/hashicorp/go-hclog"
|
2020-03-18 11:27:32 +00:00
|
|
|
"github.com/hashicorp/go-msgpack/codec"
|
2022-01-03 14:33:53 +00:00
|
|
|
multierror "github.com/hashicorp/go-multierror"
|
2021-02-11 15:40:59 +00:00
|
|
|
"github.com/rs/cors"
|
2022-07-20 18:12:21 +00:00
|
|
|
"golang.org/x/time/rate"
|
2021-02-11 15:40:59 +00:00
|
|
|
|
2022-02-01 23:54:53 +00:00
|
|
|
"github.com/hashicorp/nomad/acl"
|
2020-03-20 22:37:23 +00:00
|
|
|
"github.com/hashicorp/nomad/helper/noxssrw"
|
2016-10-25 23:05:37 +00:00
|
|
|
"github.com/hashicorp/nomad/helper/tlsutil"
|
2015-09-06 00:06:05 +00:00
|
|
|
"github.com/hashicorp/nomad/nomad/structs"
|
2015-08-24 00:50:33 +00:00
|
|
|
)
|
|
|
|
|
|
2015-09-06 01:00:30 +00:00
|
|
|
const (
|
|
|
|
|
// ErrInvalidMethod is used if the HTTP method is not supported
|
|
|
|
|
ErrInvalidMethod = "Invalid method"
|
2015-09-14 22:33:08 +00:00
|
|
|
|
2017-09-19 14:47:10 +00:00
|
|
|
// ErrEntOnly is the error returned if accessing an enterprise only
|
|
|
|
|
// endpoint
|
|
|
|
|
ErrEntOnly = "Nomad Enterprise only endpoint"
|
2020-03-22 16:17:33 +00:00
|
|
|
|
2022-01-06 16:56:13 +00:00
|
|
|
// ErrServerOnly is the error text returned if accessing a server only
|
|
|
|
|
// endpoint
|
|
|
|
|
ErrServerOnly = "Server only endpoint"
|
|
|
|
|
|
2020-03-22 16:17:33 +00:00
|
|
|
// ContextKeyReqID is a unique ID for a given request
|
|
|
|
|
ContextKeyReqID = "requestID"
|
|
|
|
|
|
|
|
|
|
// MissingRequestID is a placeholder if we cannot retrieve a request
|
|
|
|
|
// UUID from context
|
|
|
|
|
MissingRequestID = "<missing request id>"
|
2017-09-19 14:47:10 +00:00
|
|
|
)
|
|
|
|
|
|
|
|
|
|
var (
|
|
|
|
|
// Set to false by stub_asset if the ui build tag isn't enabled
|
|
|
|
|
uiEnabled = true
|
|
|
|
|
|
2021-11-24 16:20:02 +00:00
|
|
|
// Displayed when ui is disabled, but overridden if the ui build
|
|
|
|
|
// tag isn't enabled
|
|
|
|
|
stubHTML = "<html><p>Nomad UI is disabled</p></html>"
|
2017-10-19 00:32:36 +00:00
|
|
|
|
2022-05-13 17:11:27 +00:00
|
|
|
// allowCORSWithMethods sets permissive CORS headers for a handler, used by
|
|
|
|
|
// wrapCORS and wrapCORSWithMethods
|
|
|
|
|
allowCORSWithMethods = func(methods ...string) *cors.Cors {
|
|
|
|
|
return cors.New(cors.Options{
|
|
|
|
|
AllowedOrigins: []string{"*"},
|
|
|
|
|
AllowedMethods: methods,
|
|
|
|
|
AllowedHeaders: []string{"*"},
|
|
|
|
|
AllowCredentials: true,
|
|
|
|
|
})
|
|
|
|
|
}
|
2015-09-06 01:00:30 +00:00
|
|
|
)
|
|
|
|
|
|
2020-03-22 16:17:33 +00:00
|
|
|
type handlerFn func(resp http.ResponseWriter, req *http.Request) (interface{}, error)
|
|
|
|
|
type handlerByteFn func(resp http.ResponseWriter, req *http.Request) ([]byte, error)
|
|
|
|
|
|
2015-08-24 00:50:33 +00:00
|
|
|
// HTTPServer is used to wrap an Agent and expose it over an HTTP interface
|
|
|
|
|
type HTTPServer struct {
|
2017-11-30 15:50:43 +00:00
|
|
|
agent *Agent
|
|
|
|
|
mux *http.ServeMux
|
|
|
|
|
listener net.Listener
|
|
|
|
|
listenerCh chan struct{}
|
2018-09-13 17:43:40 +00:00
|
|
|
logger log.Logger
|
2017-11-30 15:50:43 +00:00
|
|
|
Addr string
|
2019-04-28 21:33:25 +00:00
|
|
|
|
|
|
|
|
wsUpgrader *websocket.Upgrader
|
2015-08-24 00:50:33 +00:00
|
|
|
}
|
|
|
|
|
|
2022-01-03 14:33:53 +00:00
|
|
|
// NewHTTPServers starts an HTTP server for every address.http configured in
|
|
|
|
|
// the agent.
|
|
|
|
|
func NewHTTPServers(agent *Agent, config *Config) ([]*HTTPServer, error) {
|
|
|
|
|
var srvs []*HTTPServer
|
|
|
|
|
var serverInitializationErrors error
|
2015-08-24 00:50:33 +00:00
|
|
|
|
2020-01-15 15:41:59 +00:00
|
|
|
// Get connection handshake timeout limit
|
|
|
|
|
handshakeTimeout, err := time.ParseDuration(config.Limits.HTTPSHandshakeTimeout)
|
|
|
|
|
if err != nil {
|
2022-01-03 14:33:53 +00:00
|
|
|
return srvs, fmt.Errorf("error parsing https_handshake_timeout: %v", err)
|
2020-01-15 15:41:59 +00:00
|
|
|
} else if handshakeTimeout < 0 {
|
2022-01-03 14:33:53 +00:00
|
|
|
return srvs, fmt.Errorf("https_handshake_timeout must be >= 0")
|
2020-01-15 15:41:59 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// Get max connection limit
|
|
|
|
|
maxConns := 0
|
|
|
|
|
if mc := config.Limits.HTTPMaxConnsPerClient; mc != nil {
|
|
|
|
|
maxConns = *mc
|
|
|
|
|
}
|
|
|
|
|
if maxConns < 0 {
|
2022-01-03 14:33:53 +00:00
|
|
|
return srvs, fmt.Errorf("http_max_conns_per_client must be >= 0")
|
2020-01-15 15:41:59 +00:00
|
|
|
}
|
|
|
|
|
|
2022-01-03 14:33:53 +00:00
|
|
|
tlsConf, err := tlsutil.NewTLSConfiguration(config.TLSConfig, config.TLSConfig.VerifyHTTPSClient, true)
|
|
|
|
|
if err != nil && config.TLSConfig.EnableHTTP {
|
|
|
|
|
return srvs, fmt.Errorf("failed to initialize HTTP server TLS configuration: %s", err)
|
2020-01-15 15:41:59 +00:00
|
|
|
}
|
|
|
|
|
|
2022-01-03 14:33:53 +00:00
|
|
|
wsUpgrader := &websocket.Upgrader{
|
|
|
|
|
ReadBufferSize: 2048,
|
|
|
|
|
WriteBufferSize: 2048,
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// Start the listener
|
|
|
|
|
for _, addr := range config.normalizedAddrs.HTTP {
|
|
|
|
|
lnAddr, err := net.ResolveTCPAddr("tcp", addr)
|
|
|
|
|
if err != nil {
|
|
|
|
|
serverInitializationErrors = multierror.Append(serverInitializationErrors, err)
|
|
|
|
|
continue
|
|
|
|
|
}
|
|
|
|
|
ln, err := config.Listener("tcp", lnAddr.IP.String(), lnAddr.Port)
|
|
|
|
|
if err != nil {
|
|
|
|
|
serverInitializationErrors = multierror.Append(serverInitializationErrors, fmt.Errorf("failed to start HTTP listener: %v", err))
|
|
|
|
|
continue
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// If TLS is enabled, wrap the listener with a TLS listener
|
|
|
|
|
if config.TLSConfig.EnableHTTP {
|
|
|
|
|
tlsConfig, err := tlsConf.IncomingTLSConfig()
|
|
|
|
|
if err != nil {
|
|
|
|
|
serverInitializationErrors = multierror.Append(serverInitializationErrors, err)
|
|
|
|
|
continue
|
|
|
|
|
}
|
|
|
|
|
ln = tls.NewListener(tcpKeepAliveListener{ln.(*net.TCPListener)}, tlsConfig)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// Create the server
|
|
|
|
|
srv := &HTTPServer{
|
|
|
|
|
agent: agent,
|
2022-04-06 17:17:05 +00:00
|
|
|
mux: http.NewServeMux(),
|
2022-01-03 14:33:53 +00:00
|
|
|
listener: ln,
|
|
|
|
|
listenerCh: make(chan struct{}),
|
|
|
|
|
logger: agent.httpLogger,
|
|
|
|
|
Addr: ln.Addr().String(),
|
|
|
|
|
wsUpgrader: wsUpgrader,
|
|
|
|
|
}
|
|
|
|
|
srv.registerHandlers(config.EnableDebug)
|
|
|
|
|
|
|
|
|
|
// Create HTTP server with timeouts
|
|
|
|
|
httpServer := http.Server{
|
|
|
|
|
Addr: srv.Addr,
|
2022-04-06 17:17:05 +00:00
|
|
|
Handler: handlers.CompressHandler(srv.mux),
|
2022-07-20 18:12:21 +00:00
|
|
|
ConnState: makeConnState(config.TLSConfig.EnableHTTP, handshakeTimeout, maxConns, srv.logger),
|
2022-01-03 14:33:53 +00:00
|
|
|
ErrorLog: newHTTPServerLogger(srv.logger),
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
go func() {
|
|
|
|
|
defer close(srv.listenerCh)
|
|
|
|
|
httpServer.Serve(ln)
|
|
|
|
|
}()
|
|
|
|
|
|
|
|
|
|
srvs = append(srvs, srv)
|
|
|
|
|
}
|
|
|
|
|
|
2022-04-06 17:17:05 +00:00
|
|
|
// This HTTP server is only create when running in client mode, otherwise
|
|
|
|
|
// the builtinDialer and builtinListener will be nil.
|
|
|
|
|
if agent.builtinDialer != nil && agent.builtinListener != nil {
|
|
|
|
|
srv := &HTTPServer{
|
|
|
|
|
agent: agent,
|
|
|
|
|
mux: http.NewServeMux(),
|
|
|
|
|
listener: agent.builtinListener,
|
|
|
|
|
listenerCh: make(chan struct{}),
|
|
|
|
|
logger: agent.httpLogger,
|
|
|
|
|
Addr: "builtin",
|
|
|
|
|
wsUpgrader: wsUpgrader,
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
srv.registerHandlers(config.EnableDebug)
|
|
|
|
|
|
|
|
|
|
httpServer := http.Server{
|
|
|
|
|
Addr: srv.Addr,
|
|
|
|
|
Handler: srv.mux,
|
|
|
|
|
ErrorLog: newHTTPServerLogger(srv.logger),
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
go func() {
|
|
|
|
|
defer close(srv.listenerCh)
|
|
|
|
|
httpServer.Serve(agent.builtinListener)
|
|
|
|
|
}()
|
|
|
|
|
|
|
|
|
|
srvs = append(srvs, srv)
|
|
|
|
|
}
|
|
|
|
|
|
2022-01-03 14:33:53 +00:00
|
|
|
if serverInitializationErrors != nil {
|
|
|
|
|
for _, srv := range srvs {
|
|
|
|
|
srv.Shutdown()
|
|
|
|
|
}
|
|
|
|
|
}
|
2017-09-08 18:50:07 +00:00
|
|
|
|
2022-01-03 14:33:53 +00:00
|
|
|
return srvs, serverInitializationErrors
|
2015-08-24 00:50:33 +00:00
|
|
|
}
|
|
|
|
|
|
2020-01-15 15:41:59 +00:00
|
|
|
// makeConnState returns a ConnState func for use in an http.Server. If
|
|
|
|
|
// isTLS=true and handshakeTimeout>0 then the handshakeTimeout will be applied
|
|
|
|
|
// as a connection deadline to new connections and removed when the connection
|
|
|
|
|
// is active (meaning it has successfully completed the TLS handshake).
|
|
|
|
|
//
|
|
|
|
|
// If limit > 0, a per-address connection limit will be enabled regardless of
|
|
|
|
|
// TLS. If connLimit == 0 there is no connection limit.
|
2022-07-20 18:12:21 +00:00
|
|
|
func makeConnState(isTLS bool, handshakeTimeout time.Duration, connLimit int, logger log.Logger) func(conn net.Conn, state http.ConnState) {
|
|
|
|
|
connLimiter := connLimiter(connLimit, logger)
|
2020-01-15 15:41:59 +00:00
|
|
|
if !isTLS || handshakeTimeout == 0 {
|
|
|
|
|
if connLimit > 0 {
|
|
|
|
|
// Still return the connection limiter
|
2022-07-20 18:12:21 +00:00
|
|
|
return connLimiter
|
2020-01-15 15:41:59 +00:00
|
|
|
}
|
|
|
|
|
return nil
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
if connLimit > 0 {
|
|
|
|
|
// Return conn state callback with connection limiting and a
|
|
|
|
|
// handshake timeout.
|
|
|
|
|
|
|
|
|
|
return func(conn net.Conn, state http.ConnState) {
|
|
|
|
|
switch state {
|
|
|
|
|
case http.StateNew:
|
|
|
|
|
// Set deadline to prevent slow send before TLS handshake or first
|
|
|
|
|
// byte of request.
|
|
|
|
|
conn.SetDeadline(time.Now().Add(handshakeTimeout))
|
|
|
|
|
case http.StateActive:
|
|
|
|
|
// Clear read deadline. We should maybe set read timeouts more
|
|
|
|
|
// generally but that's a bigger task as some HTTP endpoints may
|
|
|
|
|
// stream large requests and responses (e.g. snapshot) so we can't
|
|
|
|
|
// set sensible blanket timeouts here.
|
|
|
|
|
conn.SetDeadline(time.Time{})
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// Call connection limiter
|
|
|
|
|
connLimiter(conn, state)
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// Return conn state callback with just a handshake timeout
|
|
|
|
|
// (connection limiting disabled).
|
|
|
|
|
return func(conn net.Conn, state http.ConnState) {
|
|
|
|
|
switch state {
|
|
|
|
|
case http.StateNew:
|
|
|
|
|
// Set deadline to prevent slow send before TLS handshake or first
|
|
|
|
|
// byte of request.
|
|
|
|
|
conn.SetDeadline(time.Now().Add(handshakeTimeout))
|
|
|
|
|
case http.StateActive:
|
|
|
|
|
// Clear read deadline. We should maybe set read timeouts more
|
|
|
|
|
// generally but that's a bigger task as some HTTP endpoints may
|
|
|
|
|
// stream large requests and responses (e.g. snapshot) so we can't
|
|
|
|
|
// set sensible blanket timeouts here.
|
|
|
|
|
conn.SetDeadline(time.Time{})
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2022-07-20 18:12:21 +00:00
|
|
|
// connLimiter returns a connection-limiter function with a rate-limited 429-response error handler.
|
|
|
|
|
// The rate-limit prevents the TLS handshake necessary to write the HTTP response
|
|
|
|
|
// from consuming too many server resources.
|
|
|
|
|
func connLimiter(connLimit int, logger log.Logger) func(conn net.Conn, state http.ConnState) {
|
|
|
|
|
// Global rate-limit of 10 responses per second with a 100-response burst.
|
|
|
|
|
limiter := rate.NewLimiter(10, 100)
|
|
|
|
|
|
|
|
|
|
tooManyConnsMsg := "Your IP is issuing too many concurrent connections, please rate limit your calls\n"
|
|
|
|
|
tooManyRequestsResponse := []byte(fmt.Sprintf("HTTP/1.1 429 Too Many Requests\r\n"+
|
|
|
|
|
"Content-Type: text/plain\r\n"+
|
|
|
|
|
"Content-Length: %d\r\n"+
|
|
|
|
|
"Connection: close\r\n\r\n%s", len(tooManyConnsMsg), tooManyConnsMsg))
|
|
|
|
|
return connlimit.NewLimiter(connlimit.Config{
|
|
|
|
|
MaxConnsPerClientIP: connLimit,
|
|
|
|
|
}).HTTPConnStateFuncWithErrorHandler(func(err error, conn net.Conn) {
|
|
|
|
|
if err == connlimit.ErrPerClientIPLimitReached {
|
|
|
|
|
metrics.IncrCounter([]string{"nomad", "agent", "http", "exceeded"}, 1)
|
|
|
|
|
if n := limiter.Reserve(); n.Delay() == 0 {
|
|
|
|
|
logger.Warn("Too many concurrent connections", "address", conn.RemoteAddr().String(), "limit", connLimit)
|
|
|
|
|
conn.SetDeadline(time.Now().Add(10 * time.Millisecond))
|
|
|
|
|
conn.Write(tooManyRequestsResponse)
|
|
|
|
|
} else {
|
|
|
|
|
n.Cancel()
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
conn.Close()
|
|
|
|
|
})
|
|
|
|
|
}
|
|
|
|
|
|
2016-10-24 05:22:00 +00:00
|
|
|
// tcpKeepAliveListener sets TCP keep-alive timeouts on accepted
|
|
|
|
|
// connections. It's used by NewHttpServer so
|
|
|
|
|
// dead TCP connections eventually go away.
|
|
|
|
|
type tcpKeepAliveListener struct {
|
|
|
|
|
*net.TCPListener
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
func (ln tcpKeepAliveListener) Accept() (c net.Conn, err error) {
|
|
|
|
|
tc, err := ln.AcceptTCP()
|
|
|
|
|
if err != nil {
|
|
|
|
|
return
|
|
|
|
|
}
|
|
|
|
|
tc.SetKeepAlive(true)
|
|
|
|
|
tc.SetKeepAlivePeriod(30 * time.Second)
|
|
|
|
|
return tc, nil
|
|
|
|
|
}
|
|
|
|
|
|
2015-08-24 00:50:33 +00:00
|
|
|
// Shutdown is used to shutdown the HTTP server
|
|
|
|
|
func (s *HTTPServer) Shutdown() {
|
|
|
|
|
if s != nil {
|
2018-09-13 17:43:40 +00:00
|
|
|
s.logger.Debug("shutting down http server")
|
2015-08-24 00:50:33 +00:00
|
|
|
s.listener.Close()
|
2017-11-30 15:50:43 +00:00
|
|
|
<-s.listenerCh // block until http.Serve has returned.
|
2015-08-24 00:50:33 +00:00
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2022-02-01 23:54:53 +00:00
|
|
|
// ResolveToken extracts the ACL token secret ID from the request and
|
|
|
|
|
// translates it into an ACL object. Returns nil if ACLs are disabled.
|
|
|
|
|
func (s *HTTPServer) ResolveToken(req *http.Request) (*acl.ACL, error) {
|
|
|
|
|
var secret string
|
|
|
|
|
s.parseToken(req, &secret)
|
|
|
|
|
|
|
|
|
|
var aclObj *acl.ACL
|
|
|
|
|
var err error
|
|
|
|
|
|
|
|
|
|
if srv := s.agent.Server(); srv != nil {
|
|
|
|
|
aclObj, err = srv.ResolveToken(secret)
|
|
|
|
|
} else {
|
|
|
|
|
// Not a Server, so use the Client for token resolution. Note
|
|
|
|
|
// this gets forwarded to a server with AllowStale = true if
|
|
|
|
|
// the local ACL cache TTL has expired (30s by default)
|
|
|
|
|
aclObj, err = s.agent.Client().ResolveToken(secret)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
if err != nil {
|
|
|
|
|
return nil, fmt.Errorf("failed to resolve ACL token: %v", err)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
return aclObj, nil
|
|
|
|
|
}
|
|
|
|
|
|
2015-08-24 00:50:33 +00:00
|
|
|
// registerHandlers is used to attach our handlers to the mux
|
2022-01-03 14:33:53 +00:00
|
|
|
func (s HTTPServer) registerHandlers(enableDebug bool) {
|
2015-09-06 01:00:30 +00:00
|
|
|
s.mux.HandleFunc("/v1/jobs", s.wrap(s.JobsRequest))
|
2018-04-11 18:57:12 +00:00
|
|
|
s.mux.HandleFunc("/v1/jobs/parse", s.wrap(s.JobsParseRequest))
|
2015-09-06 00:06:05 +00:00
|
|
|
s.mux.HandleFunc("/v1/job/", s.wrap(s.JobSpecificRequest))
|
|
|
|
|
|
2015-09-06 21:18:11 +00:00
|
|
|
s.mux.HandleFunc("/v1/nodes", s.wrap(s.NodesRequest))
|
|
|
|
|
s.mux.HandleFunc("/v1/node/", s.wrap(s.NodeSpecificRequest))
|
|
|
|
|
|
2015-09-06 22:37:21 +00:00
|
|
|
s.mux.HandleFunc("/v1/allocations", s.wrap(s.AllocsRequest))
|
|
|
|
|
s.mux.HandleFunc("/v1/allocation/", s.wrap(s.AllocSpecificRequest))
|
|
|
|
|
|
2015-09-06 23:02:53 +00:00
|
|
|
s.mux.HandleFunc("/v1/evaluations", s.wrap(s.EvalsRequest))
|
|
|
|
|
s.mux.HandleFunc("/v1/evaluation/", s.wrap(s.EvalSpecificRequest))
|
|
|
|
|
|
2017-06-29 21:50:47 +00:00
|
|
|
s.mux.HandleFunc("/v1/deployments", s.wrap(s.DeploymentsRequest))
|
|
|
|
|
s.mux.HandleFunc("/v1/deployment/", s.wrap(s.DeploymentSpecificRequest))
|
|
|
|
|
|
2020-03-12 18:20:40 +00:00
|
|
|
s.mux.HandleFunc("/v1/volumes", s.wrap(s.CSIVolumesRequest))
|
2021-04-07 14:34:06 +00:00
|
|
|
s.mux.HandleFunc("/v1/volumes/external", s.wrap(s.CSIExternalVolumesRequest))
|
2021-04-01 15:16:52 +00:00
|
|
|
s.mux.HandleFunc("/v1/volumes/snapshot", s.wrap(s.CSISnapshotsRequest))
|
2020-03-12 18:20:40 +00:00
|
|
|
s.mux.HandleFunc("/v1/volume/csi/", s.wrap(s.CSIVolumeSpecificRequest))
|
|
|
|
|
s.mux.HandleFunc("/v1/plugins", s.wrap(s.CSIPluginsRequest))
|
|
|
|
|
s.mux.HandleFunc("/v1/plugin/csi/", s.wrap(s.CSIPluginSpecificRequest))
|
2019-12-18 22:20:30 +00:00
|
|
|
|
2017-08-08 06:02:03 +00:00
|
|
|
s.mux.HandleFunc("/v1/acl/policies", s.wrap(s.ACLPoliciesRequest))
|
|
|
|
|
s.mux.HandleFunc("/v1/acl/policy/", s.wrap(s.ACLPolicySpecificRequest))
|
|
|
|
|
|
2021-02-25 21:41:00 +00:00
|
|
|
s.mux.HandleFunc("/v1/acl/token/onetime", s.wrap(s.UpsertOneTimeToken))
|
|
|
|
|
s.mux.HandleFunc("/v1/acl/token/onetime/exchange", s.wrap(s.ExchangeOneTimeToken))
|
2017-08-21 01:31:22 +00:00
|
|
|
s.mux.HandleFunc("/v1/acl/bootstrap", s.wrap(s.ACLTokenBootstrap))
|
2017-08-12 23:08:00 +00:00
|
|
|
s.mux.HandleFunc("/v1/acl/tokens", s.wrap(s.ACLTokensRequest))
|
|
|
|
|
s.mux.HandleFunc("/v1/acl/token", s.wrap(s.ACLTokenSpecificRequest))
|
2017-08-24 02:54:58 +00:00
|
|
|
s.mux.HandleFunc("/v1/acl/token/", s.wrap(s.ACLTokenSpecificRequest))
|
2017-08-12 23:08:00 +00:00
|
|
|
|
2017-11-16 18:26:28 +00:00
|
|
|
s.mux.Handle("/v1/client/fs/", wrapCORS(s.wrap(s.FsRequest)))
|
2016-12-12 06:33:12 +00:00
|
|
|
s.mux.HandleFunc("/v1/client/gc", s.wrap(s.ClientGCRequest))
|
2017-10-19 00:32:36 +00:00
|
|
|
s.mux.Handle("/v1/client/stats", wrapCORS(s.wrap(s.ClientStatsRequest)))
|
|
|
|
|
s.mux.Handle("/v1/client/allocation/", wrapCORS(s.wrap(s.ClientAllocRequest)))
|
2016-01-12 23:03:53 +00:00
|
|
|
|
2015-09-07 02:08:05 +00:00
|
|
|
s.mux.HandleFunc("/v1/agent/self", s.wrap(s.AgentSelfRequest))
|
|
|
|
|
s.mux.HandleFunc("/v1/agent/join", s.wrap(s.AgentJoinRequest))
|
|
|
|
|
s.mux.HandleFunc("/v1/agent/members", s.wrap(s.AgentMembersRequest))
|
|
|
|
|
s.mux.HandleFunc("/v1/agent/force-leave", s.wrap(s.AgentForceLeaveRequest))
|
2015-09-25 03:39:03 +00:00
|
|
|
s.mux.HandleFunc("/v1/agent/servers", s.wrap(s.AgentServersRequest))
|
2022-01-06 16:56:13 +00:00
|
|
|
s.mux.HandleFunc("/v1/agent/schedulers", s.wrap(s.AgentSchedulerWorkerInfoRequest))
|
|
|
|
|
s.mux.HandleFunc("/v1/agent/schedulers/config", s.wrap(s.AgentSchedulerWorkerConfigRequest))
|
2016-10-17 17:48:04 +00:00
|
|
|
s.mux.HandleFunc("/v1/agent/keyring/", s.wrap(s.KeyringOperationRequest))
|
2017-10-13 22:37:44 +00:00
|
|
|
s.mux.HandleFunc("/v1/agent/health", s.wrap(s.HealthRequest))
|
2020-07-02 13:51:25 +00:00
|
|
|
s.mux.HandleFunc("/v1/agent/host", s.wrap(s.AgentHostRequest))
|
2020-03-20 22:37:23 +00:00
|
|
|
|
2022-03-03 11:13:00 +00:00
|
|
|
// Register our service registration handlers.
|
|
|
|
|
s.mux.HandleFunc("/v1/services", s.wrap(s.ServiceRegistrationListRequest))
|
|
|
|
|
s.mux.HandleFunc("/v1/service/", s.wrap(s.ServiceRegistrationRequest))
|
|
|
|
|
|
2020-03-20 22:37:23 +00:00
|
|
|
// Monitor is *not* an untrusted endpoint despite the log contents
|
|
|
|
|
// potentially containing unsanitized user input. Monitor, like
|
|
|
|
|
// "/v1/client/fs/logs", explicitly sets a "text/plain" or
|
|
|
|
|
// "application/json" Content-Type depending on the ?plain= query
|
|
|
|
|
// parameter.
|
2019-10-07 20:41:52 +00:00
|
|
|
s.mux.HandleFunc("/v1/agent/monitor", s.wrap(s.AgentMonitor))
|
2015-09-07 02:08:05 +00:00
|
|
|
|
2019-12-11 19:58:41 +00:00
|
|
|
s.mux.HandleFunc("/v1/agent/pprof/", s.wrapNonJSON(s.AgentPprofRequest))
|
2019-12-04 13:36:12 +00:00
|
|
|
|
2017-09-04 03:50:05 +00:00
|
|
|
s.mux.HandleFunc("/v1/metrics", s.wrap(s.MetricsRequest))
|
|
|
|
|
|
2017-02-06 19:48:28 +00:00
|
|
|
s.mux.HandleFunc("/v1/validate/job", s.wrap(s.ValidateJobRequest))
|
|
|
|
|
|
2015-11-24 06:22:48 +00:00
|
|
|
s.mux.HandleFunc("/v1/regions", s.wrap(s.RegionListRequest))
|
2015-11-24 05:47:11 +00:00
|
|
|
|
2020-01-16 20:12:52 +00:00
|
|
|
s.mux.HandleFunc("/v1/scaling/policies", s.wrap(s.ScalingPoliciesRequest))
|
|
|
|
|
s.mux.HandleFunc("/v1/scaling/policy/", s.wrap(s.ScalingPolicySpecificRequest))
|
|
|
|
|
|
2015-09-07 01:39:03 +00:00
|
|
|
s.mux.HandleFunc("/v1/status/leader", s.wrap(s.StatusLeaderRequest))
|
|
|
|
|
s.mux.HandleFunc("/v1/status/peers", s.wrap(s.StatusPeersRequest))
|
2017-02-10 01:58:20 +00:00
|
|
|
|
api: implement fuzzy search API
This PR introduces the /v1/search/fuzzy API endpoint, used for fuzzy
searching objects in Nomad. The fuzzy search endpoint routes requests
to the Nomad Server leader, which implements the Search.FuzzySearch RPC
method.
Requests to the fuzzy search API are based on the api.FuzzySearchRequest
object, e.g.
{
"Text": "ed",
"Context": "all"
}
Responses from the fuzzy search API are based on the api.FuzzySearchResponse
object, e.g.
{
"Index": 27,
"KnownLeader": true,
"LastContact": 0,
"Matches": {
"tasks": [
{
"ID": "redis",
"Scope": [
"default",
"example",
"cache"
]
}
],
"evals": [],
"deployment": [],
"volumes": [],
"scaling_policy": [],
"images": [
{
"ID": "redis:3.2",
"Scope": [
"default",
"example",
"cache",
"redis"
]
}
]
},
"Truncations": {
"volumes": false,
"scaling_policy": false,
"evals": false,
"deployment": false
}
}
The API is tunable using the new server.search stanza, e.g.
server {
search {
fuzzy_enabled = true
limit_query = 200
limit_results = 1000
min_term_length = 5
}
}
These values can be increased or decreased, so as to provide more
search results or to reduce load on the Nomad Server. The fuzzy search
API can be disabled entirely by setting `fuzzy_enabled` to `false`.
2021-02-23 20:24:52 +00:00
|
|
|
s.mux.HandleFunc("/v1/search/fuzzy", s.wrap(s.FuzzySearchRequest))
|
2017-08-14 17:35:13 +00:00
|
|
|
s.mux.HandleFunc("/v1/search", s.wrap(s.SearchRequest))
|
2021-02-08 18:53:06 +00:00
|
|
|
s.mux.HandleFunc("/v1/operator/license", s.wrap(s.LicenseRequest))
|
2017-12-18 21:16:23 +00:00
|
|
|
s.mux.HandleFunc("/v1/operator/raft/", s.wrap(s.OperatorRequest))
|
2022-05-20 16:16:21 +00:00
|
|
|
s.mux.HandleFunc("/v1/operator/keyring/", s.wrap(s.KeyringRequest))
|
2017-12-18 21:16:23 +00:00
|
|
|
s.mux.HandleFunc("/v1/operator/autopilot/configuration", s.wrap(s.OperatorAutopilotConfiguration))
|
|
|
|
|
s.mux.HandleFunc("/v1/operator/autopilot/health", s.wrap(s.OperatorServerHealth))
|
2020-05-21 14:05:04 +00:00
|
|
|
s.mux.HandleFunc("/v1/operator/snapshot", s.wrap(s.SnapshotRequest))
|
2015-09-07 01:39:03 +00:00
|
|
|
|
2016-02-20 23:50:41 +00:00
|
|
|
s.mux.HandleFunc("/v1/system/gc", s.wrap(s.GarbageCollectRequest))
|
2016-08-04 01:08:37 +00:00
|
|
|
s.mux.HandleFunc("/v1/system/reconcile/summaries", s.wrap(s.ReconcileJobSummaries))
|
2016-02-20 23:50:41 +00:00
|
|
|
|
2018-11-12 21:57:45 +00:00
|
|
|
s.mux.HandleFunc("/v1/operator/scheduler/configuration", s.wrap(s.OperatorSchedulerConfiguration))
|
2018-09-28 04:27:38 +00:00
|
|
|
|
2020-09-28 14:13:10 +00:00
|
|
|
s.mux.HandleFunc("/v1/event/stream", s.wrap(s.EventStream))
|
2022-05-13 17:11:27 +00:00
|
|
|
|
2020-10-21 04:16:25 +00:00
|
|
|
s.mux.HandleFunc("/v1/namespaces", s.wrap(s.NamespacesRequest))
|
|
|
|
|
s.mux.HandleFunc("/v1/namespace", s.wrap(s.NamespaceCreateRequest))
|
|
|
|
|
s.mux.HandleFunc("/v1/namespace/", s.wrap(s.NamespaceSpecificRequest))
|
|
|
|
|
|
2022-05-13 17:11:27 +00:00
|
|
|
s.mux.Handle("/v1/vars", wrapCORS(s.wrap(s.SecureVariablesListRequest)))
|
|
|
|
|
s.mux.Handle("/v1/var/", wrapCORSWithAllowedMethods(s.wrap(s.SecureVariableSpecificRequest), "HEAD", "GET", "PUT", "DELETE"))
|
|
|
|
|
|
2021-11-24 16:20:02 +00:00
|
|
|
uiConfigEnabled := s.agent.config.UI != nil && s.agent.config.UI.Enabled
|
|
|
|
|
|
|
|
|
|
if uiEnabled && uiConfigEnabled {
|
2020-03-27 13:01:54 +00:00
|
|
|
s.mux.Handle("/ui/", http.StripPrefix("/ui/", s.handleUI(http.FileServer(&UIAssetWrapper{FileSystem: assetFS()}))))
|
2021-11-24 16:20:02 +00:00
|
|
|
s.logger.Debug("UI is enabled")
|
2017-09-19 14:47:10 +00:00
|
|
|
} else {
|
|
|
|
|
// Write the stubHTML
|
|
|
|
|
s.mux.HandleFunc("/ui/", func(w http.ResponseWriter, r *http.Request) {
|
|
|
|
|
w.Write([]byte(stubHTML))
|
|
|
|
|
})
|
2021-11-24 16:20:02 +00:00
|
|
|
if uiEnabled && !uiConfigEnabled {
|
|
|
|
|
s.logger.Warn("UI is disabled")
|
|
|
|
|
} else {
|
|
|
|
|
s.logger.Debug("UI is disabled in this build")
|
|
|
|
|
}
|
2017-09-19 14:47:10 +00:00
|
|
|
}
|
2020-03-27 13:01:54 +00:00
|
|
|
s.mux.Handle("/", s.handleRootFallthrough())
|
2017-09-19 14:47:10 +00:00
|
|
|
|
2015-08-24 00:50:33 +00:00
|
|
|
if enableDebug {
|
2019-12-16 18:42:18 +00:00
|
|
|
if !s.agent.config.DevMode {
|
|
|
|
|
s.logger.Warn("enable_debug is set to true. This is insecure and should not be enabled in production")
|
|
|
|
|
}
|
2015-08-24 00:50:33 +00:00
|
|
|
s.mux.HandleFunc("/debug/pprof/", pprof.Index)
|
|
|
|
|
s.mux.HandleFunc("/debug/pprof/cmdline", pprof.Cmdline)
|
|
|
|
|
s.mux.HandleFunc("/debug/pprof/profile", pprof.Profile)
|
|
|
|
|
s.mux.HandleFunc("/debug/pprof/symbol", pprof.Symbol)
|
2017-05-01 18:09:08 +00:00
|
|
|
s.mux.HandleFunc("/debug/pprof/trace", pprof.Trace)
|
2015-08-24 00:50:33 +00:00
|
|
|
}
|
2017-09-07 23:56:15 +00:00
|
|
|
|
|
|
|
|
// Register enterprise endpoints.
|
|
|
|
|
s.registerEnterpriseHandlers()
|
2015-08-24 00:50:33 +00:00
|
|
|
}
|
2015-09-06 00:06:05 +00:00
|
|
|
|
|
|
|
|
// HTTPCodedError is used to provide the HTTP error code
|
|
|
|
|
type HTTPCodedError interface {
|
|
|
|
|
error
|
|
|
|
|
Code() int
|
|
|
|
|
}
|
|
|
|
|
|
2017-09-19 14:47:10 +00:00
|
|
|
type UIAssetWrapper struct {
|
|
|
|
|
FileSystem *assetfs.AssetFS
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
func (fs *UIAssetWrapper) Open(name string) (http.File, error) {
|
|
|
|
|
if file, err := fs.FileSystem.Open(name); err == nil {
|
|
|
|
|
return file, nil
|
|
|
|
|
} else {
|
|
|
|
|
// serve index.html instead of 404ing
|
|
|
|
|
if err == os.ErrNotExist {
|
|
|
|
|
return fs.FileSystem.Open("index.html")
|
|
|
|
|
}
|
|
|
|
|
return nil, err
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2015-09-06 00:06:05 +00:00
|
|
|
func CodedError(c int, s string) HTTPCodedError {
|
|
|
|
|
return &codedError{s, c}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
type codedError struct {
|
|
|
|
|
s string
|
|
|
|
|
code int
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
func (e *codedError) Error() string {
|
|
|
|
|
return e.s
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
func (e *codedError) Code() int {
|
|
|
|
|
return e.code
|
|
|
|
|
}
|
|
|
|
|
|
2020-03-27 13:01:54 +00:00
|
|
|
func (s *HTTPServer) handleUI(h http.Handler) http.Handler {
|
2020-03-27 14:12:42 +00:00
|
|
|
return http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) {
|
2017-09-19 14:47:10 +00:00
|
|
|
header := w.Header()
|
2017-11-10 21:28:11 +00:00
|
|
|
header.Add("Content-Security-Policy", "default-src 'none'; connect-src *; img-src 'self' data:; script-src 'self'; style-src 'self' 'unsafe-inline'; form-action 'none'; frame-ancestors 'none'")
|
2017-09-19 14:47:10 +00:00
|
|
|
h.ServeHTTP(w, req)
|
2020-03-27 14:12:42 +00:00
|
|
|
})
|
2017-09-19 14:47:10 +00:00
|
|
|
}
|
|
|
|
|
|
2020-03-27 13:01:54 +00:00
|
|
|
func (s *HTTPServer) handleRootFallthrough() http.Handler {
|
|
|
|
|
return s.auditHTTPHandler(http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) {
|
2019-11-11 13:35:56 +00:00
|
|
|
if req.URL.Path == "/" {
|
2021-03-26 18:35:49 +00:00
|
|
|
url := "/ui/"
|
|
|
|
|
if req.URL.RawQuery != "" {
|
|
|
|
|
url = url + "?" + req.URL.RawQuery
|
|
|
|
|
}
|
|
|
|
|
http.Redirect(w, req, url, 307)
|
2019-11-11 13:35:56 +00:00
|
|
|
} else {
|
2019-11-08 20:34:35 +00:00
|
|
|
w.WriteHeader(http.StatusNotFound)
|
|
|
|
|
}
|
2020-03-27 13:01:54 +00:00
|
|
|
}))
|
2017-09-19 14:47:10 +00:00
|
|
|
}
|
|
|
|
|
|
2020-03-22 16:17:33 +00:00
|
|
|
func errCodeFromHandler(err error) (int, string) {
|
|
|
|
|
if err == nil {
|
|
|
|
|
return 0, ""
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
code := 500
|
|
|
|
|
errMsg := err.Error()
|
|
|
|
|
if http, ok := err.(HTTPCodedError); ok {
|
|
|
|
|
code = http.Code()
|
|
|
|
|
} else if ecode, emsg, ok := structs.CodeFromRPCCodedErr(err); ok {
|
|
|
|
|
code = ecode
|
|
|
|
|
errMsg = emsg
|
|
|
|
|
} else {
|
|
|
|
|
// RPC errors get wrapped, so manually unwrap by only looking at their suffix
|
|
|
|
|
if strings.HasSuffix(errMsg, structs.ErrPermissionDenied.Error()) {
|
|
|
|
|
errMsg = structs.ErrPermissionDenied.Error()
|
|
|
|
|
code = 403
|
|
|
|
|
} else if strings.HasSuffix(errMsg, structs.ErrTokenNotFound.Error()) {
|
|
|
|
|
errMsg = structs.ErrTokenNotFound.Error()
|
|
|
|
|
code = 403
|
2021-12-06 20:20:34 +00:00
|
|
|
} else if strings.HasSuffix(errMsg, structs.ErrJobRegistrationDisabled.Error()) {
|
|
|
|
|
errMsg = structs.ErrJobRegistrationDisabled.Error()
|
|
|
|
|
code = 403
|
2020-03-22 16:17:33 +00:00
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
return code, errMsg
|
|
|
|
|
}
|
|
|
|
|
|
2015-09-06 00:06:05 +00:00
|
|
|
// wrap is used to wrap functions to make them more convenient
|
|
|
|
|
func (s *HTTPServer) wrap(handler func(resp http.ResponseWriter, req *http.Request) (interface{}, error)) func(resp http.ResponseWriter, req *http.Request) {
|
|
|
|
|
f := func(resp http.ResponseWriter, req *http.Request) {
|
2016-01-22 18:52:20 +00:00
|
|
|
setHeaders(resp, s.agent.config.HTTPAPIResponseHeaders)
|
2015-09-06 00:06:05 +00:00
|
|
|
// Invoke the handler
|
|
|
|
|
reqURL := req.URL.String()
|
|
|
|
|
start := time.Now()
|
|
|
|
|
defer func() {
|
2020-12-09 19:05:18 +00:00
|
|
|
s.logger.Debug("request complete", "method", req.Method, "path", reqURL, "duration", time.Since(start))
|
2015-09-06 00:06:05 +00:00
|
|
|
}()
|
2020-03-22 16:17:33 +00:00
|
|
|
obj, err := s.auditHandler(handler)(resp, req)
|
2015-09-06 00:06:05 +00:00
|
|
|
|
|
|
|
|
// Check for an error
|
|
|
|
|
HAS_ERR:
|
|
|
|
|
if err != nil {
|
|
|
|
|
code := 500
|
2018-01-05 22:12:52 +00:00
|
|
|
errMsg := err.Error()
|
2015-09-06 00:06:05 +00:00
|
|
|
if http, ok := err.(HTTPCodedError); ok {
|
|
|
|
|
code = http.Code()
|
2019-10-04 14:08:03 +00:00
|
|
|
} else if ecode, emsg, ok := structs.CodeFromRPCCodedErr(err); ok {
|
|
|
|
|
code = ecode
|
|
|
|
|
errMsg = emsg
|
2017-10-12 22:39:05 +00:00
|
|
|
} else {
|
2018-01-05 22:12:52 +00:00
|
|
|
// RPC errors get wrapped, so manually unwrap by only looking at their suffix
|
|
|
|
|
if strings.HasSuffix(errMsg, structs.ErrPermissionDenied.Error()) {
|
|
|
|
|
errMsg = structs.ErrPermissionDenied.Error()
|
|
|
|
|
code = 403
|
|
|
|
|
} else if strings.HasSuffix(errMsg, structs.ErrTokenNotFound.Error()) {
|
|
|
|
|
errMsg = structs.ErrTokenNotFound.Error()
|
2017-10-12 22:39:05 +00:00
|
|
|
code = 403
|
2021-12-06 20:20:34 +00:00
|
|
|
} else if strings.HasSuffix(errMsg, structs.ErrJobRegistrationDisabled.Error()) {
|
|
|
|
|
errMsg = structs.ErrJobRegistrationDisabled.Error()
|
|
|
|
|
code = 403
|
2022-02-16 16:40:30 +00:00
|
|
|
} else if strings.HasSuffix(errMsg, structs.ErrIncompatibleFiltering.Error()) {
|
|
|
|
|
errMsg = structs.ErrIncompatibleFiltering.Error()
|
|
|
|
|
code = 400
|
2017-10-12 22:39:05 +00:00
|
|
|
}
|
2015-09-06 00:06:05 +00:00
|
|
|
}
|
2017-10-12 22:39:05 +00:00
|
|
|
|
2015-09-06 00:06:05 +00:00
|
|
|
resp.WriteHeader(code)
|
2018-01-05 22:12:52 +00:00
|
|
|
resp.Write([]byte(errMsg))
|
2020-04-22 20:19:59 +00:00
|
|
|
if isAPIClientError(code) {
|
|
|
|
|
s.logger.Debug("request failed", "method", req.Method, "path", reqURL, "error", err, "code", code)
|
|
|
|
|
} else {
|
|
|
|
|
s.logger.Error("request failed", "method", req.Method, "path", reqURL, "error", err, "code", code)
|
|
|
|
|
}
|
2015-09-06 00:06:05 +00:00
|
|
|
return
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
prettyPrint := false
|
2016-05-11 22:46:08 +00:00
|
|
|
if v, ok := req.URL.Query()["pretty"]; ok {
|
|
|
|
|
if len(v) > 0 && (len(v[0]) == 0 || v[0] != "0") {
|
|
|
|
|
prettyPrint = true
|
|
|
|
|
}
|
2015-09-06 00:06:05 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// Write out the JSON object
|
|
|
|
|
if obj != nil {
|
2016-05-18 01:05:00 +00:00
|
|
|
var buf bytes.Buffer
|
2015-09-06 00:06:05 +00:00
|
|
|
if prettyPrint {
|
2021-04-02 13:31:10 +00:00
|
|
|
enc := codec.NewEncoder(&buf, structs.JsonHandlePretty)
|
2016-05-18 01:05:00 +00:00
|
|
|
err = enc.Encode(obj)
|
2016-05-10 22:46:20 +00:00
|
|
|
if err == nil {
|
2016-05-18 01:05:00 +00:00
|
|
|
buf.Write([]byte("\n"))
|
2016-05-10 22:46:20 +00:00
|
|
|
}
|
2015-09-06 00:06:05 +00:00
|
|
|
} else {
|
2021-04-02 13:31:10 +00:00
|
|
|
enc := codec.NewEncoder(&buf, structs.JsonHandleWithExtensions)
|
2016-05-18 01:05:00 +00:00
|
|
|
err = enc.Encode(obj)
|
2015-09-06 00:06:05 +00:00
|
|
|
}
|
|
|
|
|
if err != nil {
|
|
|
|
|
goto HAS_ERR
|
|
|
|
|
}
|
|
|
|
|
resp.Header().Set("Content-Type", "application/json")
|
2016-05-18 01:05:00 +00:00
|
|
|
resp.Write(buf.Bytes())
|
2015-09-06 00:06:05 +00:00
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
return f
|
|
|
|
|
}
|
|
|
|
|
|
2019-12-16 18:42:18 +00:00
|
|
|
// wrapNonJSON is used to wrap functions returning non JSON
|
2019-12-11 19:58:41 +00:00
|
|
|
// serializeable data to make them more convenient. It is primarily
|
|
|
|
|
// responsible for setting nomad headers and logging.
|
2019-12-19 18:32:23 +00:00
|
|
|
// Handler functions are responsible for setting Content-Type Header
|
2019-12-11 19:58:41 +00:00
|
|
|
func (s *HTTPServer) wrapNonJSON(handler func(resp http.ResponseWriter, req *http.Request) ([]byte, error)) func(resp http.ResponseWriter, req *http.Request) {
|
|
|
|
|
f := func(resp http.ResponseWriter, req *http.Request) {
|
|
|
|
|
setHeaders(resp, s.agent.config.HTTPAPIResponseHeaders)
|
|
|
|
|
// Invoke the handler
|
|
|
|
|
reqURL := req.URL.String()
|
|
|
|
|
start := time.Now()
|
|
|
|
|
defer func() {
|
2020-12-09 19:05:18 +00:00
|
|
|
s.logger.Debug("request complete", "method", req.Method, "path", reqURL, "duration", time.Since(start))
|
2019-12-11 19:58:41 +00:00
|
|
|
}()
|
2020-03-25 14:57:44 +00:00
|
|
|
obj, err := s.auditNonJSONHandler(handler)(resp, req)
|
2019-12-11 19:58:41 +00:00
|
|
|
|
|
|
|
|
// Check for an error
|
|
|
|
|
if err != nil {
|
2020-03-22 16:17:33 +00:00
|
|
|
code, errMsg := errCodeFromHandler(err)
|
2019-12-11 19:58:41 +00:00
|
|
|
resp.WriteHeader(code)
|
|
|
|
|
resp.Write([]byte(errMsg))
|
2020-04-22 20:19:59 +00:00
|
|
|
if isAPIClientError(code) {
|
|
|
|
|
s.logger.Debug("request failed", "method", req.Method, "path", reqURL, "error", err, "code", code)
|
|
|
|
|
} else {
|
|
|
|
|
s.logger.Error("request failed", "method", req.Method, "path", reqURL, "error", err, "code", code)
|
|
|
|
|
}
|
2019-12-11 19:58:41 +00:00
|
|
|
return
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// write response
|
|
|
|
|
if obj != nil {
|
|
|
|
|
resp.Write(obj)
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
return f
|
|
|
|
|
}
|
|
|
|
|
|
2020-04-22 20:19:59 +00:00
|
|
|
// isAPIClientError returns true if the passed http code represents a client error
|
|
|
|
|
func isAPIClientError(code int) bool {
|
|
|
|
|
return 400 <= code && code <= 499
|
|
|
|
|
}
|
|
|
|
|
|
2015-09-06 00:06:05 +00:00
|
|
|
// decodeBody is used to decode a JSON request body
|
2015-09-23 03:01:57 +00:00
|
|
|
func decodeBody(req *http.Request, out interface{}) error {
|
2020-05-19 13:46:31 +00:00
|
|
|
|
|
|
|
|
if req.Body == http.NoBody {
|
|
|
|
|
return errors.New("Request body is empty")
|
|
|
|
|
}
|
|
|
|
|
|
2015-09-06 00:06:05 +00:00
|
|
|
dec := json.NewDecoder(req.Body)
|
2015-09-23 03:01:57 +00:00
|
|
|
return dec.Decode(&out)
|
2015-09-06 00:06:05 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// setIndex is used to set the index response header
|
|
|
|
|
func setIndex(resp http.ResponseWriter, index uint64) {
|
|
|
|
|
resp.Header().Set("X-Nomad-Index", strconv.FormatUint(index, 10))
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// setKnownLeader is used to set the known leader header
|
|
|
|
|
func setKnownLeader(resp http.ResponseWriter, known bool) {
|
|
|
|
|
s := "true"
|
|
|
|
|
if !known {
|
|
|
|
|
s = "false"
|
|
|
|
|
}
|
|
|
|
|
resp.Header().Set("X-Nomad-KnownLeader", s)
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// setLastContact is used to set the last contact header
|
|
|
|
|
func setLastContact(resp http.ResponseWriter, last time.Duration) {
|
|
|
|
|
lastMsec := uint64(last / time.Millisecond)
|
|
|
|
|
resp.Header().Set("X-Nomad-LastContact", strconv.FormatUint(lastMsec, 10))
|
|
|
|
|
}
|
|
|
|
|
|
2021-12-10 18:43:03 +00:00
|
|
|
// setNextToken is used to set the next token header for pagination
|
|
|
|
|
func setNextToken(resp http.ResponseWriter, nextToken string) {
|
|
|
|
|
if nextToken != "" {
|
|
|
|
|
resp.Header().Set("X-Nomad-NextToken", nextToken)
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2015-09-06 00:06:05 +00:00
|
|
|
// setMeta is used to set the query response meta data
|
|
|
|
|
func setMeta(resp http.ResponseWriter, m *structs.QueryMeta) {
|
|
|
|
|
setIndex(resp, m.Index)
|
|
|
|
|
setLastContact(resp, m.LastContact)
|
|
|
|
|
setKnownLeader(resp, m.KnownLeader)
|
2021-12-10 18:43:03 +00:00
|
|
|
setNextToken(resp, m.NextToken)
|
2015-09-06 00:06:05 +00:00
|
|
|
}
|
|
|
|
|
|
2016-01-22 18:52:20 +00:00
|
|
|
// setHeaders is used to set canonical response header fields
|
|
|
|
|
func setHeaders(resp http.ResponseWriter, headers map[string]string) {
|
|
|
|
|
for field, value := range headers {
|
2020-12-09 19:05:18 +00:00
|
|
|
resp.Header().Set(field, value)
|
2016-01-22 18:52:20 +00:00
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2015-09-06 00:06:05 +00:00
|
|
|
// parseWait is used to parse the ?wait and ?index query params
|
|
|
|
|
// Returns true on error
|
|
|
|
|
func parseWait(resp http.ResponseWriter, req *http.Request, b *structs.QueryOptions) bool {
|
|
|
|
|
query := req.URL.Query()
|
|
|
|
|
if wait := query.Get("wait"); wait != "" {
|
|
|
|
|
dur, err := time.ParseDuration(wait)
|
|
|
|
|
if err != nil {
|
|
|
|
|
resp.WriteHeader(400)
|
|
|
|
|
resp.Write([]byte("Invalid wait time"))
|
|
|
|
|
return true
|
|
|
|
|
}
|
|
|
|
|
b.MaxQueryTime = dur
|
|
|
|
|
}
|
|
|
|
|
if idx := query.Get("index"); idx != "" {
|
|
|
|
|
index, err := strconv.ParseUint(idx, 10, 64)
|
|
|
|
|
if err != nil {
|
|
|
|
|
resp.WriteHeader(400)
|
|
|
|
|
resp.Write([]byte("Invalid index"))
|
|
|
|
|
return true
|
|
|
|
|
}
|
|
|
|
|
b.MinQueryIndex = index
|
|
|
|
|
}
|
|
|
|
|
return false
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// parseConsistency is used to parse the ?stale query params.
|
|
|
|
|
func parseConsistency(req *http.Request, b *structs.QueryOptions) {
|
|
|
|
|
query := req.URL.Query()
|
|
|
|
|
if _, ok := query["stale"]; ok {
|
|
|
|
|
b.AllowStale = true
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2015-12-22 22:44:33 +00:00
|
|
|
// parsePrefix is used to parse the ?prefix query param
|
|
|
|
|
func parsePrefix(req *http.Request, b *structs.QueryOptions) {
|
|
|
|
|
query := req.URL.Query()
|
|
|
|
|
if prefix := query.Get("prefix"); prefix != "" {
|
|
|
|
|
b.Prefix = prefix
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2015-09-06 00:06:05 +00:00
|
|
|
// parseRegion is used to parse the ?region query param
|
|
|
|
|
func (s *HTTPServer) parseRegion(req *http.Request, r *string) {
|
|
|
|
|
if other := req.URL.Query().Get("region"); other != "" {
|
|
|
|
|
*r = other
|
|
|
|
|
} else if *r == "" {
|
|
|
|
|
*r = s.agent.config.Region
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2017-09-07 23:56:15 +00:00
|
|
|
// parseNamespace is used to parse the ?namespace parameter
|
|
|
|
|
func parseNamespace(req *http.Request, n *string) {
|
|
|
|
|
if other := req.URL.Query().Get("namespace"); other != "" {
|
|
|
|
|
*n = other
|
|
|
|
|
} else if *n == "" {
|
|
|
|
|
*n = structs.DefaultNamespace
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2021-07-07 21:26:35 +00:00
|
|
|
// parseIdempotencyToken is used to parse the ?idempotency_token parameter
|
|
|
|
|
func parseIdempotencyToken(req *http.Request, n *string) {
|
|
|
|
|
if idempotencyToken := req.URL.Query().Get("idempotency_token"); idempotencyToken != "" {
|
|
|
|
|
*n = idempotencyToken
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2020-10-14 19:23:25 +00:00
|
|
|
// parseBool parses a query parameter to a boolean or returns (nil, nil) if the
|
|
|
|
|
// parameter is not present.
|
|
|
|
|
func parseBool(req *http.Request, field string) (*bool, error) {
|
|
|
|
|
if str := req.URL.Query().Get(field); str != "" {
|
2020-10-09 05:21:41 +00:00
|
|
|
param, err := strconv.ParseBool(str)
|
|
|
|
|
if err != nil {
|
2020-10-14 19:23:25 +00:00
|
|
|
return nil, fmt.Errorf("Failed to parse value of %q (%v) as a bool: %v", field, str, err)
|
2020-10-09 05:21:41 +00:00
|
|
|
}
|
2020-10-14 19:23:25 +00:00
|
|
|
return ¶m, nil
|
2020-10-09 05:21:41 +00:00
|
|
|
}
|
|
|
|
|
|
2020-10-14 19:23:25 +00:00
|
|
|
return nil, nil
|
2020-10-09 05:21:41 +00:00
|
|
|
}
|
|
|
|
|
|
2021-11-23 08:23:31 +00:00
|
|
|
// parseInt parses a query parameter to a int or returns (nil, nil) if the
|
|
|
|
|
// parameter is not present.
|
|
|
|
|
func parseInt(req *http.Request, field string) (*int, error) {
|
|
|
|
|
if str := req.URL.Query().Get(field); str != "" {
|
|
|
|
|
param, err := strconv.Atoi(str)
|
|
|
|
|
if err != nil {
|
|
|
|
|
return nil, fmt.Errorf("Failed to parse value of %q (%v) as a int: %v", field, str, err)
|
|
|
|
|
}
|
|
|
|
|
return ¶m, nil
|
|
|
|
|
}
|
|
|
|
|
return nil, nil
|
|
|
|
|
}
|
|
|
|
|
|
2017-08-21 03:13:05 +00:00
|
|
|
// parseToken is used to parse the X-Nomad-Token param
|
|
|
|
|
func (s *HTTPServer) parseToken(req *http.Request, token *string) {
|
|
|
|
|
if other := req.Header.Get("X-Nomad-Token"); other != "" {
|
|
|
|
|
*token = other
|
|
|
|
|
return
|
|
|
|
|
}
|
2022-06-06 19:51:02 +00:00
|
|
|
|
|
|
|
|
if other := req.Header.Get("Authorization"); other != "" {
|
|
|
|
|
// HTTP Authorization headers are in the format: <Scheme>[SPACE]<Value>
|
|
|
|
|
// Ref. https://tools.ietf.org/html/rfc7236#section-3
|
|
|
|
|
parts := strings.Split(other, " ")
|
|
|
|
|
|
|
|
|
|
// Authorization Header is invalid if containing 1 or 0 parts, e.g.:
|
|
|
|
|
// "" || "<Scheme><Value>" || "<Scheme>" || "<Value>"
|
|
|
|
|
if len(parts) > 1 {
|
|
|
|
|
scheme := parts[0]
|
|
|
|
|
// Everything after "<Scheme>" is "<Value>", trimmed
|
|
|
|
|
value := strings.TrimSpace(strings.Join(parts[1:], " "))
|
|
|
|
|
|
|
|
|
|
// <Scheme> must be "Bearer"
|
|
|
|
|
if strings.ToLower(scheme) == "bearer" {
|
|
|
|
|
// Since Bearer tokens shouldn't contain spaces (rfc6750#section-2.1)
|
|
|
|
|
// "value" is tokenized, only the first item is used
|
|
|
|
|
*token = strings.TrimSpace(strings.Split(value, " ")[0])
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
2017-08-21 03:13:05 +00:00
|
|
|
}
|
|
|
|
|
|
2015-09-06 00:06:05 +00:00
|
|
|
// parse is a convenience method for endpoints that need to parse multiple flags
|
2020-07-02 13:51:25 +00:00
|
|
|
// It sets r to the region and b to the QueryOptions in req
|
2015-09-06 00:06:05 +00:00
|
|
|
func (s *HTTPServer) parse(resp http.ResponseWriter, req *http.Request, r *string, b *structs.QueryOptions) bool {
|
|
|
|
|
s.parseRegion(req, r)
|
2017-10-12 22:16:33 +00:00
|
|
|
s.parseToken(req, &b.AuthToken)
|
2015-09-06 00:06:05 +00:00
|
|
|
parseConsistency(req, b)
|
2015-12-22 22:44:33 +00:00
|
|
|
parsePrefix(req, b)
|
2017-09-07 23:56:15 +00:00
|
|
|
parseNamespace(req, &b.Namespace)
|
2021-03-23 13:45:14 +00:00
|
|
|
parsePagination(req, b)
|
2022-02-16 16:40:30 +00:00
|
|
|
parseFilter(req, b)
|
2022-03-09 01:54:17 +00:00
|
|
|
parseReverse(req, b)
|
2015-09-06 00:06:05 +00:00
|
|
|
return parseWait(resp, req, b)
|
|
|
|
|
}
|
2017-09-07 23:56:15 +00:00
|
|
|
|
2021-03-23 13:45:14 +00:00
|
|
|
// parsePagination parses the pagination fields for QueryOptions
|
|
|
|
|
func parsePagination(req *http.Request, b *structs.QueryOptions) {
|
|
|
|
|
query := req.URL.Query()
|
|
|
|
|
rawPerPage := query.Get("per_page")
|
|
|
|
|
if rawPerPage != "" {
|
2022-01-25 16:16:48 +00:00
|
|
|
perPage, err := strconv.ParseInt(rawPerPage, 10, 32)
|
2021-03-23 13:45:14 +00:00
|
|
|
if err == nil {
|
|
|
|
|
b.PerPage = int32(perPage)
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2021-12-10 18:43:03 +00:00
|
|
|
b.NextToken = query.Get("next_token")
|
2021-03-23 13:45:14 +00:00
|
|
|
}
|
|
|
|
|
|
2022-02-16 16:40:30 +00:00
|
|
|
// parseFilter parses the filter query parameter for QueryOptions
|
|
|
|
|
func parseFilter(req *http.Request, b *structs.QueryOptions) {
|
|
|
|
|
query := req.URL.Query()
|
|
|
|
|
if filter := query.Get("filter"); filter != "" {
|
|
|
|
|
b.Filter = filter
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2022-03-09 01:54:17 +00:00
|
|
|
// parseReverse parses the reverse query parameter for QueryOptions
|
|
|
|
|
func parseReverse(req *http.Request, b *structs.QueryOptions) {
|
2022-02-16 19:34:36 +00:00
|
|
|
query := req.URL.Query()
|
2022-03-09 01:54:17 +00:00
|
|
|
b.Reverse = query.Get("reverse") == "true"
|
2022-02-16 19:34:36 +00:00
|
|
|
}
|
|
|
|
|
|
2018-03-11 17:50:48 +00:00
|
|
|
// parseWriteRequest is a convenience method for endpoints that need to parse a
|
2017-09-07 23:56:15 +00:00
|
|
|
// write request.
|
|
|
|
|
func (s *HTTPServer) parseWriteRequest(req *http.Request, w *structs.WriteRequest) {
|
|
|
|
|
parseNamespace(req, &w.Namespace)
|
2017-10-12 22:16:33 +00:00
|
|
|
s.parseToken(req, &w.AuthToken)
|
2017-09-07 23:56:15 +00:00
|
|
|
s.parseRegion(req, &w.Region)
|
2021-07-07 21:26:35 +00:00
|
|
|
parseIdempotencyToken(req, &w.IdempotencyToken)
|
2017-09-07 23:56:15 +00:00
|
|
|
}
|
2017-10-19 00:32:36 +00:00
|
|
|
|
2020-03-20 22:37:23 +00:00
|
|
|
// wrapUntrustedContent wraps handlers in a http.ResponseWriter that prevents
|
|
|
|
|
// setting Content-Types that a browser may render (eg text/html). Any API that
|
|
|
|
|
// returns service-generated content (eg /v1/client/fs/cat) must be wrapped.
|
|
|
|
|
func (s *HTTPServer) wrapUntrustedContent(handler handlerFn) handlerFn {
|
|
|
|
|
return func(resp http.ResponseWriter, req *http.Request) (interface{}, error) {
|
|
|
|
|
resp, closeWriter := noxssrw.NewResponseWriter(resp)
|
|
|
|
|
defer func() {
|
|
|
|
|
if _, err := closeWriter(); err != nil {
|
|
|
|
|
// Can't write an error response at this point so just
|
|
|
|
|
// log. s.wrap does not even log when resp.Write fails,
|
|
|
|
|
// so log at low level.
|
|
|
|
|
s.logger.Debug("error writing HTTP response", "error", err,
|
|
|
|
|
"method", req.Method, "path", req.URL.String())
|
|
|
|
|
}
|
|
|
|
|
}()
|
|
|
|
|
|
|
|
|
|
// Call the wrapped handler
|
|
|
|
|
return handler(resp, req)
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2022-05-13 17:11:27 +00:00
|
|
|
// wrapCORS wraps a HandlerFunc in allowCORS with read ("HEAD", "GET") methods
|
|
|
|
|
// and returns a http.Handler
|
2017-10-19 00:32:36 +00:00
|
|
|
func wrapCORS(f func(http.ResponseWriter, *http.Request)) http.Handler {
|
2022-05-13 17:11:27 +00:00
|
|
|
return wrapCORSWithAllowedMethods(f, "HEAD", "GET")
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
// wrapCORSWithAllowedMethods wraps a HandlerFunc in an allowCORS with the given
|
|
|
|
|
// method list and returns a http.Handler
|
|
|
|
|
func wrapCORSWithAllowedMethods(f func(http.ResponseWriter, *http.Request), methods ...string) http.Handler {
|
|
|
|
|
return allowCORSWithMethods(methods...).Handler(http.HandlerFunc(f))
|
2017-10-19 00:32:36 +00:00
|
|
|
}
|