Virtual HSM
Home
  • Virtual HSM
  • Documentation
    • What is Virtual HSM?
    • Use Case: Attested Secret Provisioning in the Cloud
    • Setup
      • Install
      • vHSM Server Configuration
        • Parameters
        • vHSM Telemetry Parameters
      • vHSM Agent
        • Agent Configuration
      • vHSM Proxy
        • Proxy Configuration
    • Get Started
      • Start the Vault server
      • MariaDB root admin password provisioning on Azure DCXas_v5 VM
    • Supported Cloud Configurations
  • Tutorials
    • Deploying the vhsm Container on an EC2 Instance
    • CLI quickstart
    • vHSM Agent quickstart
    • vHSM Proxy quickstart
    • Passing vHSM secrets using ConfigMaps
    • Provisioning MariaDB Password on Azure DCXas_v5 VM
    • Registering a buckypaper plugin
    • Monitoring vHSM with Grafana
  • Integration with Utimaco SecurityServer
    • Integrate enclaive vHSM with Utimaco HSM
  • API
    • Auth
    • Default
    • Secrets
    • System
    • Identity
    • Models
  • vHSM CLI
    • Server and Infrastructure Management
      • vhsm server
      • vhsm proxy
      • vhsm monitor
      • vhsm status
      • vhsm agent
    • Secret Management
      • vhsm read
      • vhsm write
      • vhsm delete
      • vhsm list
      • vhsm secrets
        • vhsm secrets enable
        • vhsm secrets disable
        • vhsm secrets list
        • vhsm secrets move
        • vhsm secrets tune
      • vhsm unwrap
    • Configuration and Management
      • vhsm plugin
        • vhsm plugin info
        • vhsm plugin deregister
        • vhsm plugin list
        • vhsm plugin register
        • vhsm plugin reload
        • vhsm plugin reload-status
      • vhsm namespace
      • vhsm operator
      • vhsm print
      • vhsm path-help
      • vhsm lease
    • Auditing and Debugging
      • vhsm audit
      • vhsm debug
    • Attestation
    • Security and Encryption
      • vhsm pki
        • vhsm pki health-check
        • vhsm pki issue
        • vhsm pki list-intermediates
        • vhsm pki reissue
        • vhsm pki verify-sign
      • vhsm transit
      • vhsm ssh
      • vhsm transform
    • Authentication and Authorization
      • vhsm login
      • vhsm auth
      • vhsm token
      • vhsm policy
    • Storage and Data Mangement
      • vhsm kv
      • vhsm patch
    • vhsm version
      • vhsm version-history
  • Troubleshooting
    • CA Validity Period
    • CRL Validity Period
    • Root Certificate Issued Non-CA Leaves
    • Role Allows Implicit Localhost Issuance
    • Role Allows Glob-Based Wildcard Issuance
    • Performance Impact
    • Accessibility of Audit Information
    • Allow If-Modified-Since Requests
    • Auto-Tidy Disabled
    • Tidy Hasn't Run
    • Too Many Certificates
    • Enable ACME Issuance
    • ACME Response Headers Configuration
  • Resources
    • Community
    • GitHub
    • Youtube
    • CCx101 wiki
Powered by GitBook
On this page

Was this helpful?

  1. Documentation
  2. Setup
  3. vHSM Proxy

Proxy Configuration

Learn about configuring a Proxy for vHSM

General Configuration Options

Option
Description

vault

Defines the remote Vault server connection.

auto_auth

Configures Auto-Auth functionality.

api_proxy

Sets API Proxy options.

cache

Defines caching behavior.

listener

Configures the listener for Vault Proxy.

pid_file

Stores the proxy’s process ID (PID).

exit_after_auth

If true, proxy exits after a successful auth.

disable_idle_connections

Disables idle connections (auto-auth, proxying).

disable_keep_alives

Disables keep-alive connections.

template

Configures secret templating.

telemetry

Reports runtime metrics.

Vault Stanza

Option

Description

address

Vault server address (https://vault.example.com:8200).

ca_cert

Path to CA certificate for SSL verification.

client_cert

Path to client TLS certificate.

client_key

Path to private key matching client_cert.

tls_skip_verify

Disables TLS verification (not recommended).

tls_server_name

Specifies SNI host name for TLS connections.

Retry Stanza

Option

Default

Description

num_retries

12

Number of retry attempts on failure (-1 to disable retries).

Listener Stanza

Option

Default

Description

require_request_header

false

Requires X-Vault-Request: true for added security.

role

default

Set to metrics_only for metrics access only.

proxy_api

<optional>

Manages Proxy API endpoints.

Proxy API Stanza

Option

Default

Description

enable_quit

false

Enables the quit API endpoint.

Telemetry Stanza

vHSM Proxy collects runtime metrics, including:

Metric

Description

vault.proxy.auth.failure

Count of authentication failures.

vault.proxy.auth.success

Count of authentication successes.

vault.proxy.proxy.success

Number of successfully proxied requests.

vault.proxy.proxy.client_error

Count of Vault API errors.

vault.proxy.proxy.error

Count of failed proxy requests.

vault.proxy.cache.hit

Number of cache hits.

vault.proxy.cache.miss

Number of cache misses.

PreviousvHSM ProxyNextGet Started

Last updated 2 months ago

Was this helpful?