Skip to content

Configuration

OpenBaoConfig holds every setting of a client. It is immutable after construction, validated when it is built (invalid values raise a CONFIG error) and its string/debug form redacts every credential. The settings of OpenBao itself (endpoint, credentials and other service fields) are listed under Service settings; the settings every Grow Codes SDK shares follow under Common settings.

Service settings

Setting Default Environment variable
url — endpoint base URL http://127.0.0.1:8200 GROW_OPENBAO_URL, BAO_ADDR, VAULT_ADDR
token — client token (secret) none (log in with an auth method instead) GROW_OPENBAO_TOKEN, BAO_TOKEN, VAULT_TOKEN
namespace — sent as X-Vault-Namespace root namespace GROW_OPENBAO_NAMESPACE, BAO_NAMESPACE, VAULT_NAMESPACE
kvMount — KV mount of client.secrets() secret GROW_OPENBAO_KV_MOUNT
kvVersion — 1, 2 or 0 (auto) auto-detect per mount GROW_OPENBAO_KV_VERSION
secretsPath — base path of client.secrets() mount root GROW_OPENBAO_SECRETS_PATH
valueField — KV field of a client.secrets() value value —

The TLS settings below also read the vendor variables BAO_CACERT / VAULT_CACERT, BAO_CLIENT_CERT / VAULT_CLIENT_CERT, BAO_CLIENT_KEY / VAULT_CLIENT_KEY and BAO_SKIP_VERIFY / VAULT_SKIP_VERIFY. The OpenBao (BAO_*) name is read before the HashiCorp Vault compatible (VAULT_*) name; ~/.vault-token is not read. Auth methods (AppRole, userpass, JWT, Kubernetes) are on the Functions page.

Common settings

Setting Default Environment variable
connectTimeout — connection setup 10 s GROW_OPENBAO_CONNECT_TIMEOUT
requestTimeout — per attempt (headers + body) 30 s GROW_OPENBAO_REQUEST_TIMEOUT
totalTimeout — whole call incl. retries and backoff 120 s GROW_OPENBAO_TOTAL_TIMEOUT
retry — retry policy (below) 3 retries GROW_OPENBAO_MAX_RETRIES
tls.caCertPath / tls.caCertPem — extra CA none GROW_OPENBAO_CA_CERT (path)
tls.clientCertPath + tls.clientKeyPath — mutual TLS none GROW_OPENBAO_CLIENT_CERT, GROW_OPENBAO_CLIENT_KEY
tls.insecureSkipVerify — tests only, logs a warning once false GROW_OPENBAO_INSECURE_SKIP_VERIFY
proxy — proxy URL none (environment proxies are ignored) GROW_OPENBAO_PROXY
headers — extra request headers {} —
userAgentSuffix — appended to the User-Agent none —
hooks — request/response callbacks (Hooks) none —
logger — diagnostic logger (Hooks) silent —

Every request sends User-Agent: grow-codes-openbao/<version> (<language>).

From the environment

fromEnv resolves each setting with this precedence:

  1. the value passed in code (overrides),
  2. GROW_OPENBAO_<NAME>,
  3. the vendor variables of OpenBao (see Functions), in their documented order,
  4. the default.

Parsing rules:

  • Durations accept integer milliseconds (1500) or Go-style units: 500ms, 10s, 2m, 1h, combinations such as 1m30s.
  • Booleans accept true/false, 1/0, yes/no, on/off (any case).
  • An empty variable counts as unset.
  • A present but invalid value raises a CONFIG error that names the variable, never its value.
import { OpenBaoClient, OpenBaoConfig } from "@grow-codes/openbao";

// Environment only
const client = OpenBaoClient.fromEnv();

// Environment with explicit overrides (explicit values win)
const config = OpenBaoConfig.fromEnv({ requestTimeoutMs: 5_000 });

// Everything in code
const explicit = new OpenBaoConfig({
  url: "https://openbao.example.com",
  token: process.env.MY_TOKEN,
  connectTimeoutMs: 5_000,
  requestTimeoutMs: 15_000,
  totalTimeoutMs: 60_000,
  retry: { maxRetries: 5, initialBackoffMs: 200 },
  tls: { caCertPath: "/etc/ssl/internal-ca.pem" },
  proxy: "http://proxy.internal:3128",
  headers: { "x-team": "payments" },
  userAgentSuffix: "my-app/1.4",
});
const custom = new OpenBaoClient(explicit);
console.log(String(explicit)); // token shown as [REDACTED]
use std::time::Duration;
use grow_openbao::{OpenBaoClient, OpenBaoConfig, RetryPolicy};

// Environment only
let client = OpenBaoClient::from_env()?;

// Environment with explicit overrides (explicit values win)
let config = OpenBaoConfig::builder()
    .request_timeout(Duration::from_secs(5))
    .build_from_env()?;

// Everything in code
let explicit = OpenBaoConfig::builder()
    .url("https://openbao.example.com")
    .token(std::env::var("MY_TOKEN").unwrap_or_default())
    .connect_timeout(Duration::from_secs(5))
    .request_timeout(Duration::from_secs(15))
    .total_timeout(Duration::from_secs(60))
    .retry(RetryPolicy::default().with_max_retries(5))
    .ca_cert_path("/etc/ssl/internal-ca.pem")
    .proxy("http://proxy.internal:3128")
    .header("x-team", "payments")
    .user_agent_suffix("my-app/1.4")
    .build()?;
let custom = OpenBaoClient::new(explicit)?;
println!("{:?}", custom.config()); // token shown as [REDACTED]
// Environment only
client, err := openbao.NewClientFromEnv()

// Everything in code: zero values mean "use the default"
cfg := openbao.Config{
    CommonConfig: openbao.CommonConfig{
        URL:             "https://openbao.example.com",
        ConnectTimeout:  5 * time.Second,
        RequestTimeout:  15 * time.Second,
        TotalTimeout:    time.Minute,
        Retry:           &openbao.RetryPolicy{MaxRetries: 5, InitialBackoff: 200 * time.Millisecond},
        TLS:             openbao.TLSConfig{CACertPath: "/etc/ssl/internal-ca.pem"},
        Proxy:           "http://proxy.internal:3128",
        Headers:         map[string]string{"x-team": "payments"},
        UserAgentSuffix: "my-app/1.4",
    },
    Token: openbao.NewSecret(os.Getenv("MY_TOKEN")),
}
if err := cfg.Validate(); err != nil {
    log.Fatal(err) // errors.Is(err, openbao.ErrConfig)
}
custom, err := openbao.NewClient(cfg)

// Environment with explicit overrides (explicit values win; nil env = process environment)
merged, err := openbao.ConfigFromEnvWith(openbao.Config{
    CommonConfig: openbao.CommonConfig{RequestTimeout: 5 * time.Second},
}, nil)
fmt.Println(merged) // token shown as [REDACTED]
import os
from grow_openbao import RetryPolicy, TlsConfig, OpenBaoClient, OpenBaoConfig

# Environment only
client = OpenBaoClient.from_env()

# Environment with explicit overrides (explicit values win)
config = OpenBaoConfig.from_env(request_timeout=5.0)

# Everything in code: durations are float seconds (datetime.timedelta also works)
explicit = OpenBaoConfig(
    url="https://openbao.example.com",
    token=os.environ.get("MY_TOKEN"),
    connect_timeout=5.0,
    request_timeout=15.0,
    total_timeout=60.0,
    retry=RetryPolicy(max_retries=5, initial_backoff=0.2),
    tls=TlsConfig(ca_cert_path="/etc/ssl/internal-ca.pem"),
    proxy="http://proxy.internal:3128",
    headers={"x-team": "payments"},
    user_agent_suffix="my-app/1.4",
)
custom = OpenBaoClient(explicit)
print(repr(explicit))  # token shown as [REDACTED]
import java.time.Duration;
import codes.grow.packages.openbao.OpenBaoClient;
import codes.grow.packages.openbao.OpenBaoConfig;
import codes.grow.packages.openbao.core.RetryPolicy;

// Environment only
OpenBaoClient client = OpenBaoClient.fromEnv();

// Everything in code
OpenBaoConfig config = OpenBaoConfig.builder()
    .url("https://openbao.example.com")
    .token(System.getenv("MY_TOKEN"))
    .connectTimeout(Duration.ofSeconds(5))
    .requestTimeout(Duration.ofSeconds(15))
    .totalTimeout(Duration.ofMinutes(1))
    .retry(RetryPolicy.builder().maxRetries(5).initialBackoff(Duration.ofMillis(200)).build())
    .proxy("http://proxy.internal:3128")
    .header("x-team", "payments")
    .userAgentSuffix("my-app/1.4")
    .build();
OpenBaoClient custom = OpenBaoClient.create(config);
System.out.println(config); // token shown as [REDACTED]

Retry policy

Field Default Meaning
maxRetries 3 retries after the first attempt (so up to 4 attempts)
initialBackoff 100 ms backoff cap of the first retry
maxBackoff 10 s cap of every backoff
multiplier 2 growth of the cap per retry
maxRetryAfter 60 s longest server-requested Retry-After the client waits for

Backoff for retry n (0-based) is full jitter: a random wait between 0 and min(maxBackoff, initialBackoff × multiplier^n).

Requests are retried on HTTP 429, 408, 502, 503, 504 and on network errors. Idempotent requests (GET HEAD OPTIONS PUT DELETE, or marked idempotent) are also retried on HTTP 500. Other requests (for example POST) are retried only on 429 and on connection errors that happened before the request was sent, never after an uncertain send.

On 429 and 503 the client honours Retry-After (seconds or HTTP date) and waits max(retryAfter, backoff). When that wait exceeds maxRetryAfter or the remaining totalTimeout, it stops at once with RATE_LIMITED/UNAVAILABLE and sets retryAfter on the error. Set maxRetries to 0 to turn retries off.

Timeouts and cancellation

  • connectTimeout bounds connection setup, requestTimeout each attempt, totalTimeout the whole call including backoff sleeps. An exhausted timeout raises TIMEOUT.
  • Cancellation is honoured during requests and backoff sleeps and raises CANCELLED: TypeScript { signal } (AbortSignal), Rust dropping the future, Go ctx, Python cancel= (CancelToken) or task cancellation, Java …Async futures (cancel(true)).

TLS and proxies

  • Add a private CA with tls.caCertPath (or the PEM text in tls.caCertPem).
  • Mutual TLS needs tls.clientCertPath and tls.clientKeyPath together.
  • tls.insecureSkipVerify disables certificate checks. Use it for local tests only; the client logs a warning once.
  • HTTP_PROXY/HTTPS_PROXY are ignored so that credentials never leave through an unexpected proxy. Set proxy (or GROW_OPENBAO_PROXY) to use one.