Skip to content

Commit

Permalink
VAULT-1303 when a request to vault fails, show namespace if set (#12196)
Browse files Browse the repository at this point in the history
* VAULT-1303 when a request to vault fails, show namespace if set

* Adding changelog

* Fix Changelog file name

* Set namespace in ResponseWriter headers if it is set

* Using consts.NamespaceHeaderName instead of the literal string
  • Loading branch information
hghaf099 authored Jul 30, 2021
1 parent abaf6bb commit 6a8e377
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 3 deletions.
19 changes: 16 additions & 3 deletions api/response.go
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import (
"io/ioutil"
"net/http"

"github.com/hashicorp/vault/sdk/helper/consts"
"github.com/hashicorp/vault/sdk/helper/jsonutil"
)

Expand Down Expand Up @@ -41,12 +42,14 @@ func (r *Response) Error() error {

r.Body.Close()
r.Body = ioutil.NopCloser(bodyBuf)
ns := r.Header.Get(consts.NamespaceHeaderName)

// Build up the error object
respErr := &ResponseError{
HTTPMethod: r.Request.Method,
URL: r.Request.URL.String(),
StatusCode: r.StatusCode,
HTTPMethod: r.Request.Method,
URL: r.Request.URL.String(),
StatusCode: r.StatusCode,
NamespacePath: ns,
}

// Decode the error response if we can. Note that we wrap the bodyBuf
Expand Down Expand Up @@ -92,6 +95,10 @@ type ResponseError struct {

// Errors are the underlying errors returned by Vault.
Errors []string

// Namespace path to be reported to the client if it is set to anything other
// than root
NamespacePath string
}

// Error returns a human-readable error string for the response error.
Expand All @@ -101,9 +108,15 @@ func (r *ResponseError) Error() string {
errString = "Raw Message"
}

var ns string
if r.NamespacePath != "" && r.NamespacePath != "root/" {
ns = "Namespace: " + r.NamespacePath + "\n"
}

var errBody bytes.Buffer
errBody.WriteString(fmt.Sprintf(
"Error making API request.\n\n"+
ns+
"URL: %s %s\n"+
"Code: %d. %s:\n\n",
r.HTTPMethod, r.URL, r.StatusCode, errString))
Expand Down
3 changes: 3 additions & 0 deletions changelog/12196.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
```release-note:bug
core (enterprise): namespace header included in responses, Go client uses it when displaying error messages
```
6 changes: 6 additions & 0 deletions http/handler.go
Original file line number Diff line number Diff line change
Expand Up @@ -350,6 +350,12 @@ func wrapGenericHandler(core *vault.Core, h http.Handler, props *vault.HandlerPr
return
}

// Setting the namespace in the header to be included in the error message
ns := r.Header.Get(consts.NamespaceHeaderName)
if ns != "" {
w.Header().Set(consts.NamespaceHeaderName, ns)
}

h.ServeHTTP(w, r)

cancelFunc()
Expand Down

0 comments on commit 6a8e377

Please sign in to comment.