package http import ( "encoding/json" "fmt" "io" "net/http" "net/url" "strings" "github.com/hashicorp/errwrap" "github.com/hashicorp/vault/helper/duration" "github.com/hashicorp/vault/helper/jsonutil" "github.com/hashicorp/vault/logical" "github.com/hashicorp/vault/vault" ) const ( // AuthHeaderName is the name of the header containing the token. AuthHeaderName = "X-Vault-Token" // WrapHeaderName is the name of the header containing a directive to wrap the // response. WrapTTLHeaderName = "X-Vault-Wrap-TTL" ) // Handler returns an http.Handler for the API. This can be used on // its own to mount the Vault API within another web server. func Handler(core *vault.Core) http.Handler { // Create the muxer to handle the actual endpoints mux := http.NewServeMux() mux.Handle("/v1/sys/init", handleSysInit(core)) mux.Handle("/v1/sys/seal-status", handleSysSealStatus(core)) mux.Handle("/v1/sys/seal", handleSysSeal(core)) mux.Handle("/v1/sys/step-down", handleSysStepDown(core)) mux.Handle("/v1/sys/unseal", handleSysUnseal(core)) mux.Handle("/v1/sys/renew", handleLogical(core, false, nil)) mux.Handle("/v1/sys/renew/", handleLogical(core, false, nil)) mux.Handle("/v1/sys/leader", handleSysLeader(core)) mux.Handle("/v1/sys/health", handleSysHealth(core)) mux.Handle("/v1/sys/generate-root/attempt", handleSysGenerateRootAttempt(core)) mux.Handle("/v1/sys/generate-root/update", handleSysGenerateRootUpdate(core)) mux.Handle("/v1/sys/rekey/init", handleSysRekeyInit(core, false)) mux.Handle("/v1/sys/rekey/update", handleSysRekeyUpdate(core, false)) mux.Handle("/v1/sys/rekey-recovery-key/init", handleSysRekeyInit(core, true)) mux.Handle("/v1/sys/rekey-recovery-key/update", handleSysRekeyUpdate(core, true)) mux.Handle("/v1/sys/capabilities-self", handleLogical(core, true, sysCapabilitiesSelfCallback)) mux.Handle("/v1/sys/", handleLogical(core, true, nil)) mux.Handle("/v1/", handleLogical(core, false, nil)) // Wrap the handler in another handler to trigger all help paths. handler := handleHelpHandler(mux, core) return handler } // ClientToken is required in the handler of sys/capabilities-self endpoint in // system backend. But the ClientToken gets obfuscated before the request gets // forwarded to any logical backend. So, setting the ClientToken in the data // field for this request. func sysCapabilitiesSelfCallback(req *logical.Request) error { if req == nil || req.Data == nil { return fmt.Errorf("invalid request") } req.Data["token"] = req.ClientToken return nil } // stripPrefix is a helper to strip a prefix from the path. It will // return false from the second return value if it the prefix doesn't exist. func stripPrefix(prefix, path string) (string, bool) { if !strings.HasPrefix(path, prefix) { return "", false } path = path[len(prefix):] if path == "" { return "", false } return path, true } func parseRequest(r *http.Request, out interface{}) error { err := jsonutil.DecodeJSONFromReader(r.Body, out) if err != nil && err != io.EOF { return fmt.Errorf("Failed to parse JSON input: %s", err) } return err } // request is a helper to perform a request and properly exit in the // case of an error. func request(core *vault.Core, w http.ResponseWriter, rawReq *http.Request, r *logical.Request) (*logical.Response, bool) { resp, err := core.HandleRequest(r) if errwrap.Contains(err, vault.ErrStandby.Error()) { respondStandby(core, w, rawReq.URL) return resp, false } if respondErrorCommon(w, resp, err) { return resp, false } return resp, true } // respondStandby is used to trigger a redirect in the case that this Vault is currently a hot standby func respondStandby(core *vault.Core, w http.ResponseWriter, reqURL *url.URL) { // Request the leader address _, advertise, err := core.Leader() if err != nil { respondError(w, http.StatusInternalServerError, err) return } // If there is no leader, generate a 503 error if advertise == "" { err = fmt.Errorf("no active Vault instance found") respondError(w, http.StatusServiceUnavailable, err) return } // Parse the advertise location advertiseURL, err := url.Parse(advertise) if err != nil { respondError(w, http.StatusInternalServerError, err) return } // Generate a redirect URL redirectURL := url.URL{ Scheme: advertiseURL.Scheme, Host: advertiseURL.Host, Path: reqURL.Path, RawQuery: reqURL.RawQuery, } // Ensure there is a scheme, default to https if redirectURL.Scheme == "" { redirectURL.Scheme = "https" } // If we have an address, redirect! We use a 307 code // because we don't actually know if its permanent and // the request method should be preserved. w.Header().Set("Location", redirectURL.String()) w.WriteHeader(307) } // requestAuth adds the token to the logical.Request if it exists. func requestAuth(r *http.Request, req *logical.Request) *logical.Request { // Attach the header value if we have it if v := r.Header.Get(AuthHeaderName); v != "" { req.ClientToken = v } return req } // requestWrapTTL adds the WrapTTL value to the logical.Request if it // exists. func requestWrapTTL(r *http.Request, req *logical.Request) (*logical.Request, error) { // First try for the header value wrapTTL := r.Header.Get(WrapTTLHeaderName) if wrapTTL == "" { return req, nil } // If it has an allowed suffix parse as a duration string dur, err := duration.ParseDurationSecond(wrapTTL) if err != nil { return req, err } if int64(dur) < 0 { return req, fmt.Errorf("requested wrap ttl cannot be negative") } req.WrapTTL = dur return req, nil } func respondError(w http.ResponseWriter, status int, err error) { // Adjust status code when sealed if errwrap.Contains(err, vault.ErrSealed.Error()) { status = http.StatusServiceUnavailable } // Allow HTTPCoded error passthrough to specify a code if t, ok := err.(logical.HTTPCodedError); ok { status = t.Code() } w.Header().Add("Content-Type", "application/json") w.WriteHeader(status) resp := &ErrorResponse{Errors: make([]string, 0, 1)} if err != nil { resp.Errors = append(resp.Errors, err.Error()) } enc := json.NewEncoder(w) enc.Encode(resp) } func respondErrorCommon(w http.ResponseWriter, resp *logical.Response, err error) bool { // If there are no errors return if err == nil && (resp == nil || !resp.IsError()) { return false } // Start out with internal server error since in most of these cases there // won't be a response so this won't be overridden statusCode := http.StatusInternalServerError // If we actually have a response, start out with bad request if resp != nil { statusCode = http.StatusBadRequest } // Now, check the error itself; if it has a specific logical error, set the // appropriate code if err != nil { switch { case errwrap.ContainsType(err, new(vault.StatusBadRequest)): statusCode = http.StatusBadRequest case errwrap.Contains(err, logical.ErrPermissionDenied.Error()): statusCode = http.StatusForbidden case errwrap.Contains(err, logical.ErrUnsupportedOperation.Error()): statusCode = http.StatusMethodNotAllowed case errwrap.Contains(err, logical.ErrUnsupportedPath.Error()): statusCode = http.StatusNotFound case errwrap.Contains(err, logical.ErrInvalidRequest.Error()): statusCode = http.StatusBadRequest } } if resp != nil && resp.IsError() { err = fmt.Errorf("%s", resp.Data["error"].(string)) } respondError(w, statusCode, err) return true } func respondOk(w http.ResponseWriter, body interface{}) { w.Header().Add("Content-Type", "application/json") if body == nil { w.WriteHeader(http.StatusNoContent) } else { w.WriteHeader(http.StatusOK) enc := json.NewEncoder(w) enc.Encode(body) } } type ErrorResponse struct { Errors []string `json:"errors"` }