scottk/vault
1
0
Fork 0
mirror of https://github.com/optim-enterprises-bv/vault.git synced 2025-11-03 03:58:01 +00:00
Code Issues Packages Projects Releases Wiki Activity

document response wrapping behavior (#8156)

Browse Source 
Document response wrapping behavior so that it's clear how
WrappingLookupFuncs should behave.
This commit is contained in:
Billie Cleek
2020-06-08 07:50:48 -07:00
committed by GitHub
parent 8bd298f0f5
commit 62d0ecff3d
2 changed files with 7 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
api/client.go
View File

@@ -50,7 +50,8 @@ const EnvVaultInsecure = "VAULT_SKIP_VERIFY"
// returns an optional string duration to be used for response wrapping (e.g. // returns an optional string duration to be used for response wrapping (e.g.
// "15s", or simply "15"). The path will not begin with "/v1/" or "v1/" or "/", // "15s", or simply "15"). The path will not begin with "/v1/" or "v1/" or "/",
// however, end-of-path forward slashes are not trimmed, so must match your // however, end-of-path forward slashes are not trimmed, so must match your
// called path precisely. // called path precisely. Response wrapping will only be used when the return
// value is not the empty string.
type WrappingLookupFunc func(operation, path string) string type WrappingLookupFunc func(operation, path string) string
// Config is used to configure the creation of the client. // Config is used to configure the creation of the client.
@@ -547,7 +548,7 @@ func (c *Client) SetOutputCurlString(curl bool) {
} }
// CurrentWrappingLookupFunc sets a lookup function that returns desired wrap TTLs // CurrentWrappingLookupFunc sets a lookup function that returns desired wrap TTLs
// for a given operation and path // for a given operation and path.
func (c *Client) CurrentWrappingLookupFunc() WrappingLookupFunc { func (c *Client) CurrentWrappingLookupFunc() WrappingLookupFunc {
c.modifyLock.RLock() c.modifyLock.RLock()
defer c.modifyLock.RUnlock() defer c.modifyLock.RUnlock()
@@ -556,7 +557,7 @@ func (c *Client) CurrentWrappingLookupFunc() WrappingLookupFunc {
} }
// SetWrappingLookupFunc sets a lookup function that returns desired wrap TTLs // SetWrappingLookupFunc sets a lookup function that returns desired wrap TTLs
// for a given operation and path // for a given operation and path.
func (c *Client) SetWrappingLookupFunc(lookupFunc WrappingLookupFunc) { func (c *Client) SetWrappingLookupFunc(lookupFunc WrappingLookupFunc) {
c.modifyLock.Lock() c.modifyLock.Lock()
defer c.modifyLock.Unlock() defer c.modifyLock.Unlock()

5
api/logical.go
View File

@@ -21,8 +21,9 @@ var (
// changed // changed
DefaultWrappingTTL = "5m" DefaultWrappingTTL = "5m"
// The default function used if no other function is set, which honors the // The default function used if no other function is set. It honors the env
// env var and wraps `sys/wrapping/wrap` // var to set the wrap TTL. The default wrap TTL will apply when when writing
// to `sys/wrapping/wrap` when the env var is not set.
DefaultWrappingLookupFunc = func(operation, path string) string { DefaultWrappingLookupFunc = func(operation, path string) string {
if os.Getenv(EnvVaultWrapTTL) != "" { if os.Getenv(EnvVaultWrapTTL) != "" {
return os.Getenv(EnvVaultWrapTTL) return os.Getenv(EnvVaultWrapTTL)