mirror of https://github.com/status-im/consul.git
440 lines
13 KiB
Go
440 lines
13 KiB
Go
package agent
|
|
|
|
import (
|
|
"crypto/tls"
|
|
"encoding/json"
|
|
"fmt"
|
|
"io"
|
|
"log"
|
|
"net"
|
|
"net/http"
|
|
"net/http/pprof"
|
|
"os"
|
|
"strconv"
|
|
"strings"
|
|
"time"
|
|
|
|
"github.com/hashicorp/consul/consul/structs"
|
|
"github.com/hashicorp/consul/tlsutil"
|
|
"github.com/mitchellh/mapstructure"
|
|
)
|
|
|
|
// HTTPServer is used to wrap an Agent and expose various API's
|
|
// in a RESTful manner
|
|
type HTTPServer struct {
|
|
agent *Agent
|
|
mux *http.ServeMux
|
|
listener net.Listener
|
|
logger *log.Logger
|
|
uiDir string
|
|
addr string
|
|
}
|
|
|
|
// NewHTTPServers starts new HTTP servers to provide an interface to
|
|
// the agent.
|
|
func NewHTTPServers(agent *Agent, config *Config, logOutput io.Writer) ([]*HTTPServer, error) {
|
|
var tlsConfig *tls.Config
|
|
var list net.Listener
|
|
var httpAddr net.Addr
|
|
var err error
|
|
var servers []*HTTPServer
|
|
|
|
if config.Ports.HTTPS > 0 {
|
|
httpAddr, err = config.ClientListener(config.Addresses.HTTPS, config.Ports.HTTPS)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
tlsConf := &tlsutil.Config{
|
|
VerifyIncoming: config.VerifyIncoming,
|
|
VerifyOutgoing: config.VerifyOutgoing,
|
|
CAFile: config.CAFile,
|
|
CertFile: config.CertFile,
|
|
KeyFile: config.KeyFile,
|
|
NodeName: config.NodeName,
|
|
ServerName: config.ServerName}
|
|
|
|
tlsConfig, err = tlsConf.IncomingTLSConfig()
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
ln, err := net.Listen(httpAddr.Network(), httpAddr.String())
|
|
if err != nil {
|
|
return nil, fmt.Errorf("Failed to get Listen on %s: %v", httpAddr.String(), err)
|
|
}
|
|
|
|
list = tls.NewListener(tcpKeepAliveListener{ln.(*net.TCPListener)}, tlsConfig)
|
|
|
|
// Create the mux
|
|
mux := http.NewServeMux()
|
|
|
|
// Create the server
|
|
srv := &HTTPServer{
|
|
agent: agent,
|
|
mux: mux,
|
|
listener: list,
|
|
logger: log.New(logOutput, "", log.LstdFlags),
|
|
uiDir: config.UiDir,
|
|
addr: httpAddr.String(),
|
|
}
|
|
srv.registerHandlers(config.EnableDebug)
|
|
|
|
// Start the server
|
|
go http.Serve(list, mux)
|
|
servers = append(servers, srv)
|
|
}
|
|
|
|
if config.Ports.HTTP > 0 {
|
|
httpAddr, err = config.ClientListener(config.Addresses.HTTP, config.Ports.HTTP)
|
|
if err != nil {
|
|
return nil, fmt.Errorf("Failed to get ClientListener address:port: %v", err)
|
|
}
|
|
|
|
// Error if we are trying to bind a domain socket to an existing path
|
|
socketPath, isSocket := unixSocketAddr(config.Addresses.HTTP)
|
|
if isSocket {
|
|
if _, err := os.Stat(socketPath); !os.IsNotExist(err) {
|
|
agent.logger.Printf("[WARN] agent: Replacing socket %q", socketPath)
|
|
}
|
|
if err := os.Remove(socketPath); err != nil && !os.IsNotExist(err) {
|
|
return nil, fmt.Errorf("error removing socket file: %s", err)
|
|
}
|
|
}
|
|
|
|
ln, err := net.Listen(httpAddr.Network(), httpAddr.String())
|
|
if err != nil {
|
|
return nil, fmt.Errorf("Failed to get Listen on %s: %v", httpAddr.String(), err)
|
|
}
|
|
|
|
if isSocket {
|
|
// Set up ownership/permission bits on the socket file
|
|
if err := setFilePermissions(socketPath, config.UnixSockets); err != nil {
|
|
return nil, fmt.Errorf("Failed setting up HTTP socket: %s", err)
|
|
}
|
|
list = ln
|
|
} else {
|
|
list = tcpKeepAliveListener{ln.(*net.TCPListener)}
|
|
}
|
|
|
|
// Create the mux
|
|
mux := http.NewServeMux()
|
|
|
|
// Create the server
|
|
srv := &HTTPServer{
|
|
agent: agent,
|
|
mux: mux,
|
|
listener: list,
|
|
logger: log.New(logOutput, "", log.LstdFlags),
|
|
uiDir: config.UiDir,
|
|
addr: httpAddr.String(),
|
|
}
|
|
srv.registerHandlers(config.EnableDebug)
|
|
|
|
// Start the server
|
|
go http.Serve(list, mux)
|
|
servers = append(servers, srv)
|
|
}
|
|
|
|
return servers, nil
|
|
}
|
|
|
|
// 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
|
|
}
|
|
|
|
// Shutdown is used to shutdown the HTTP server
|
|
func (s *HTTPServer) Shutdown() {
|
|
if s != nil {
|
|
s.logger.Printf("[DEBUG] http: Shutting down http server(%v)", s.addr)
|
|
s.listener.Close()
|
|
}
|
|
}
|
|
|
|
// registerHandlers is used to attach our handlers to the mux
|
|
func (s *HTTPServer) registerHandlers(enableDebug bool) {
|
|
s.mux.HandleFunc("/", s.Index)
|
|
|
|
s.mux.HandleFunc("/v1/status/leader", s.wrap(s.StatusLeader))
|
|
s.mux.HandleFunc("/v1/status/peers", s.wrap(s.StatusPeers))
|
|
|
|
s.mux.HandleFunc("/v1/catalog/register", s.wrap(s.CatalogRegister))
|
|
s.mux.HandleFunc("/v1/catalog/deregister", s.wrap(s.CatalogDeregister))
|
|
s.mux.HandleFunc("/v1/catalog/datacenters", s.wrap(s.CatalogDatacenters))
|
|
s.mux.HandleFunc("/v1/catalog/nodes", s.wrap(s.CatalogNodes))
|
|
s.mux.HandleFunc("/v1/catalog/services", s.wrap(s.CatalogServices))
|
|
s.mux.HandleFunc("/v1/catalog/service/", s.wrap(s.CatalogServiceNodes))
|
|
s.mux.HandleFunc("/v1/catalog/node/", s.wrap(s.CatalogNodeServices))
|
|
|
|
s.mux.HandleFunc("/v1/health/node/", s.wrap(s.HealthNodeChecks))
|
|
s.mux.HandleFunc("/v1/health/checks/", s.wrap(s.HealthServiceChecks))
|
|
s.mux.HandleFunc("/v1/health/state/", s.wrap(s.HealthChecksInState))
|
|
s.mux.HandleFunc("/v1/health/service/", s.wrap(s.HealthServiceNodes))
|
|
|
|
s.mux.HandleFunc("/v1/agent/self", s.wrap(s.AgentSelf))
|
|
s.mux.HandleFunc("/v1/agent/maintenance", s.wrap(s.AgentNodeMaintenance))
|
|
s.mux.HandleFunc("/v1/agent/services", s.wrap(s.AgentServices))
|
|
s.mux.HandleFunc("/v1/agent/checks", s.wrap(s.AgentChecks))
|
|
s.mux.HandleFunc("/v1/agent/members", s.wrap(s.AgentMembers))
|
|
s.mux.HandleFunc("/v1/agent/join/", s.wrap(s.AgentJoin))
|
|
s.mux.HandleFunc("/v1/agent/force-leave/", s.wrap(s.AgentForceLeave))
|
|
|
|
s.mux.HandleFunc("/v1/agent/check/register", s.wrap(s.AgentRegisterCheck))
|
|
s.mux.HandleFunc("/v1/agent/check/deregister/", s.wrap(s.AgentDeregisterCheck))
|
|
s.mux.HandleFunc("/v1/agent/check/pass/", s.wrap(s.AgentCheckPass))
|
|
s.mux.HandleFunc("/v1/agent/check/warn/", s.wrap(s.AgentCheckWarn))
|
|
s.mux.HandleFunc("/v1/agent/check/fail/", s.wrap(s.AgentCheckFail))
|
|
|
|
s.mux.HandleFunc("/v1/agent/service/register", s.wrap(s.AgentRegisterService))
|
|
s.mux.HandleFunc("/v1/agent/service/deregister/", s.wrap(s.AgentDeregisterService))
|
|
s.mux.HandleFunc("/v1/agent/service/maintenance/", s.wrap(s.AgentServiceMaintenance))
|
|
|
|
s.mux.HandleFunc("/v1/event/fire/", s.wrap(s.EventFire))
|
|
s.mux.HandleFunc("/v1/event/list", s.wrap(s.EventList))
|
|
|
|
s.mux.HandleFunc("/v1/kv/", s.wrap(s.KVSEndpoint))
|
|
|
|
s.mux.HandleFunc("/v1/session/create", s.wrap(s.SessionCreate))
|
|
s.mux.HandleFunc("/v1/session/destroy/", s.wrap(s.SessionDestroy))
|
|
s.mux.HandleFunc("/v1/session/renew/", s.wrap(s.SessionRenew))
|
|
s.mux.HandleFunc("/v1/session/info/", s.wrap(s.SessionGet))
|
|
s.mux.HandleFunc("/v1/session/node/", s.wrap(s.SessionsForNode))
|
|
s.mux.HandleFunc("/v1/session/list", s.wrap(s.SessionList))
|
|
|
|
if s.agent.config.ACLDatacenter != "" {
|
|
s.mux.HandleFunc("/v1/acl/create", s.wrap(s.ACLCreate))
|
|
s.mux.HandleFunc("/v1/acl/update", s.wrap(s.ACLUpdate))
|
|
s.mux.HandleFunc("/v1/acl/destroy/", s.wrap(s.ACLDestroy))
|
|
s.mux.HandleFunc("/v1/acl/info/", s.wrap(s.ACLGet))
|
|
s.mux.HandleFunc("/v1/acl/clone/", s.wrap(s.ACLClone))
|
|
s.mux.HandleFunc("/v1/acl/list", s.wrap(s.ACLList))
|
|
} else {
|
|
s.mux.HandleFunc("/v1/acl/create", s.wrap(aclDisabled))
|
|
s.mux.HandleFunc("/v1/acl/update", s.wrap(aclDisabled))
|
|
s.mux.HandleFunc("/v1/acl/destroy/", s.wrap(aclDisabled))
|
|
s.mux.HandleFunc("/v1/acl/info/", s.wrap(aclDisabled))
|
|
s.mux.HandleFunc("/v1/acl/clone/", s.wrap(aclDisabled))
|
|
s.mux.HandleFunc("/v1/acl/list", s.wrap(aclDisabled))
|
|
}
|
|
|
|
if enableDebug {
|
|
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)
|
|
}
|
|
|
|
// Enable the UI + special endpoints
|
|
if s.uiDir != "" {
|
|
// Static file serving done from /ui/
|
|
s.mux.Handle("/ui/", http.StripPrefix("/ui/", http.FileServer(http.Dir(s.uiDir))))
|
|
|
|
// API's are under /internal/ui/ to avoid conflict
|
|
s.mux.HandleFunc("/v1/internal/ui/nodes", s.wrap(s.UINodes))
|
|
s.mux.HandleFunc("/v1/internal/ui/node/", s.wrap(s.UINodeInfo))
|
|
s.mux.HandleFunc("/v1/internal/ui/services", s.wrap(s.UIServices))
|
|
}
|
|
}
|
|
|
|
// 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) {
|
|
setHeaders(resp, s.agent.config.HTTPAPIResponseHeaders)
|
|
|
|
// Invoke the handler
|
|
start := time.Now()
|
|
defer func() {
|
|
s.logger.Printf("[DEBUG] http: Request %v (%v)", req.URL, time.Now().Sub(start))
|
|
}()
|
|
obj, err := handler(resp, req)
|
|
|
|
// Check for an error
|
|
HAS_ERR:
|
|
if err != nil {
|
|
s.logger.Printf("[ERR] http: Request %v, error: %v", req.URL, err)
|
|
code := 500
|
|
errMsg := err.Error()
|
|
if strings.Contains(errMsg, "Permission denied") || strings.Contains(errMsg, "ACL not found") {
|
|
code = 403
|
|
}
|
|
resp.WriteHeader(code)
|
|
resp.Write([]byte(err.Error()))
|
|
return
|
|
}
|
|
|
|
prettyPrint := false
|
|
if _, ok := req.URL.Query()["pretty"]; ok {
|
|
prettyPrint = true
|
|
}
|
|
// Write out the JSON object
|
|
if obj != nil {
|
|
var buf []byte
|
|
if prettyPrint {
|
|
buf, err = json.MarshalIndent(obj, "", " ")
|
|
} else {
|
|
buf, err = json.Marshal(obj)
|
|
}
|
|
if err != nil {
|
|
goto HAS_ERR
|
|
}
|
|
resp.Header().Set("Content-Type", "application/json")
|
|
resp.Write(buf)
|
|
}
|
|
}
|
|
return f
|
|
}
|
|
|
|
// Renders a simple index page
|
|
func (s *HTTPServer) Index(resp http.ResponseWriter, req *http.Request) {
|
|
// Check if this is a non-index path
|
|
if req.URL.Path != "/" {
|
|
resp.WriteHeader(404)
|
|
return
|
|
}
|
|
|
|
// Check if we have no UI configured
|
|
if s.uiDir == "" {
|
|
resp.Write([]byte("Consul Agent"))
|
|
return
|
|
}
|
|
|
|
// Redirect to the UI endpoint
|
|
http.Redirect(resp, req, "/ui/", 301)
|
|
}
|
|
|
|
// decodeBody is used to decode a JSON request body
|
|
func decodeBody(req *http.Request, out interface{}, cb func(interface{}) error) error {
|
|
var raw interface{}
|
|
dec := json.NewDecoder(req.Body)
|
|
if err := dec.Decode(&raw); err != nil {
|
|
return err
|
|
}
|
|
|
|
// Invoke the callback prior to decode
|
|
if cb != nil {
|
|
if err := cb(raw); err != nil {
|
|
return err
|
|
}
|
|
}
|
|
return mapstructure.Decode(raw, out)
|
|
}
|
|
|
|
// setIndex is used to set the index response header
|
|
func setIndex(resp http.ResponseWriter, index uint64) {
|
|
resp.Header().Set("X-Consul-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-Consul-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-Consul-LastContact", strconv.FormatUint(lastMsec, 10))
|
|
}
|
|
|
|
// 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)
|
|
}
|
|
|
|
// setHeaders is used to set canonical response header fields
|
|
func setHeaders(resp http.ResponseWriter, headers map[string]string) {
|
|
for field, value := range headers {
|
|
resp.Header().Set(http.CanonicalHeaderKey(field), value)
|
|
}
|
|
}
|
|
|
|
// 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 and ?consistent query params.
|
|
// Returns true on error
|
|
func parseConsistency(resp http.ResponseWriter, req *http.Request, b *structs.QueryOptions) bool {
|
|
query := req.URL.Query()
|
|
if _, ok := query["stale"]; ok {
|
|
b.AllowStale = true
|
|
}
|
|
if _, ok := query["consistent"]; ok {
|
|
b.RequireConsistent = true
|
|
}
|
|
if b.AllowStale && b.RequireConsistent {
|
|
resp.WriteHeader(400)
|
|
resp.Write([]byte("Cannot specify ?stale with ?consistent, conflicting semantics."))
|
|
return true
|
|
}
|
|
return false
|
|
}
|
|
|
|
// parseDC is used to parse the ?dc query param
|
|
func (s *HTTPServer) parseDC(req *http.Request, dc *string) {
|
|
if other := req.URL.Query().Get("dc"); other != "" {
|
|
*dc = other
|
|
} else if *dc == "" {
|
|
*dc = s.agent.config.Datacenter
|
|
}
|
|
}
|
|
|
|
// parseToken is used to parse the ?token query param
|
|
func (s *HTTPServer) parseToken(req *http.Request, token *string) {
|
|
if other := req.URL.Query().Get("token"); other != "" {
|
|
*token = other
|
|
} else if *token == "" {
|
|
*token = s.agent.config.ACLToken
|
|
}
|
|
}
|
|
|
|
// parse is a convenience method for endpoints that need
|
|
// to use both parseWait and parseDC.
|
|
func (s *HTTPServer) parse(resp http.ResponseWriter, req *http.Request, dc *string, b *structs.QueryOptions) bool {
|
|
s.parseDC(req, dc)
|
|
s.parseToken(req, &b.Token)
|
|
if parseConsistency(resp, req, b) {
|
|
return true
|
|
}
|
|
return parseWait(resp, req, b)
|
|
}
|