Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Patch to support VAULT_HTTP_PROXY variable #12582

Merged
merged 6 commits into from Oct 6, 2021
Merged

Patch to support VAULT_HTTP_PROXY variable #12582

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
ef0cddc
patch to support VAULT_HTTP_PROXY variable
davidducros Sep 10, 2021
c3215ad
simplify the proxy replacement
davidducros Sep 22, 2021
fa82635
internal code review
davidducros Sep 23, 2021
003d18a
rename to VAULT_HTTP_PROXY, apply within ReadEnvironment
davidducros Oct 5, 2021
47a73b7
clean up some unintended whitespace changes
davidducros Oct 5, 2021
7c10fcd
add docs for the new env variable and a changelog entry
davidducros Oct 5, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
16 changes: 16 additions & 0 deletions api/client.go
View file
Open in desktop
Expand Up @@ -42,6 +42,7 @@ const (
EnvVaultToken = "VAULT_TOKEN"
EnvVaultMFA = "VAULT_MFA"
EnvRateLimit = "VAULT_RATE_LIMIT"
EnvHTTPProxy = "VAULT_HTTP_PROXY"
)

// Deprecated values
Expand Down Expand Up @@ -271,6 +272,7 @@ func (c *Config) ReadEnvironment() error {
var envMaxRetries *uint64
var envSRVLookup bool
var limit *rate.Limiter
var envHTTPProxy string

// Parse the environment variables
if v := os.Getenv(EnvVaultAddress); v != "" {
Expand Down Expand Up @@ -339,6 +341,10 @@ func (c *Config) ReadEnvironment() error {
envTLSServerName = v
}

if v := os.Getenv(EnvHTTPProxy); v != "" {
envHTTPProxy = v
}

// Configure the HTTP clients TLS configuration.
t := &TLSConfig{
CACert: envCACert,
Expand Down Expand Up @@ -375,6 +381,16 @@ func (c *Config) ReadEnvironment() error {
c.Timeout = envClientTimeout
}

if envHTTPProxy != "" {
url, err := url.Parse(envHTTPProxy)
if err != nil {
return err
}

transport := c.HttpClient.Transport.(*http.Transport)
transport.Proxy = http.ProxyURL(url)
}

return nil
}

Expand Down
3 changes: 3 additions & 0 deletions changelog/12582.txt
View file
Open in desktop
@@ -0,0 +1,3 @@
```release-note:improvement
api: Support VAULT_HTTP_PROXY environment variable to allow overriding the Vault client's HTTP proxy
```
6 changes: 6 additions & 0 deletions website/content/docs/commands/index.mdx
View file
Open in desktop
Expand Up @@ -323,6 +323,12 @@ can be supplied. If a MFA method expects multiple credential values, or if there
are multiple MFA methods specified on a path, then the CLI flag `-mfa` should be
used.

### `VAULT_HTTP_PROXY`

HTTP proxy location which should be used to access Vault. When present, this
overrides any other proxies found in the environment. Format should be
`http://server:port`.

## Flags

There are different CLI flags that are available depending on subcommands. Some
Expand Down