HashiCorp Vault

Vault secrets 可在 Apidog Enterprise plan 使用。

Apidog 支援與 HashiCorp Vault 的 Community 和 Cloud 版本整合。支援兩種驗證方法：Token 和 OIDC。

設定 Vault Provider：Community Edition

Token Auth

輸入 URL。預設情況下，本機 Vault 服務會執行於 http://127.0.0.1:8200。

輸入 Token。產生 token 的詳細說明可在 Vault documentation 中找到。

NOTE

token 不會上傳至伺服器，也不會與其他團隊成員分享。

點擊 Test Connection。如果設定正確，將會顯示「Succeeded」。

OIDC Auth

首先，在你的 Vault 中啟用並設定 OIDC auth method。設定第三方 OAuth 2.0 服務提供者時，請確保新增 Apidog 的 callback URL。

接著，前往 Apidog：

輸入 URL。預設情況下，本機 Vault 服務會執行於 http://127.0.0.1:8200。

輸入 Auth URL。預設為 http://127.0.0.1:8200/v1/auth/oidc/oidc/auth_url。

輸入 Access Token URL。預設為 http://127.0.0.1:8200/v1/auth/oidc/oidc/callback。

點擊 Test Connection。將會出現 OAuth 2.0 登入視窗。登入後，將會顯示「Succeeded」。

設定 Vault Provider：HCP Vault Dedicated（Cloud Edition）

Token Auth

輸入 URL，你可以在 HashiCorp Cloud Portal 中找到它。

輸入 Namespace。預設 namespace 通常是 admin。詳情請參閱 Namespace usage。

輸入 Token。你可以在 HashiCorp Cloud Portal 中產生 token。

NOTE

token 不會上傳至伺服器，也不會與其他團隊成員分享。

點擊 Test Connection。如果設定正確，將會顯示「Succeeded」。

OIDC Auth

首先，在你的 Vault 中啟用並設定 OIDC auth method。設定第三方 OAuth 2.0 服務提供者時，請確保新增 Apidog 的 callback URL。

接著，前往 Apidog：

輸入 Namespace。預設 namespace 通常是 admin。

以此格式輸入 Auth URL：{{VAULT_ADDR}}/v1/auth/oidc/oidc/auth_url。

以此格式輸入 Access Token URL：{{VAULT_ADDR}}/v1/auth/oidc/oidc/callback。

點擊 Test Connection。將會出現 OAuth 2.0 登入視窗。登入後，將會顯示「Succeeded」。

連結 Secrets

HashiCorp Vault 的 Community 和 Cloud 版本連結 secrets 的流程相同。

如果你使用 CLI 建立 secret，輸出可能如下所示：

在 Web UI 中，secret 會如下顯示：

若要在 Apidog 中連結此 secret：

如下所示輸入 metadata。

點擊 Fetch Secrets 按鈕。

點擊右側的眼睛圖示以檢視擷取到的 secret 值。

設定 Vault Provider：Community Edition#

Token Auth#

OIDC Auth#

設定 Vault Provider：HCP Vault Dedicated（Cloud Edition）#

Token Auth#

OIDC Auth#

連結 Secrets#

設定 Vault Provider：Community Edition

Token Auth

OIDC Auth

設定 Vault Provider：HCP Vault Dedicated（Cloud Edition）

Token Auth

OIDC Auth

連結 Secrets