Skip to main content
Version: 2.8.1

憑證

在憑證頁籤中,可以設定驗證插件所需要的憑證。

驗證插件包括 Basic AuthenticationKey AuthenticationOAuth2HMAC Authentication 以及 JWT.

Basic Authentication#

搭配的插件配置及說明部分請參考 Basic Authentication 頁面

basic-auth

欄位配置說明#

變數類型預設值說明必填
usernamestring使用在 Basic Authentication 中的使用者名稱。V
passwordstring使用在 Basic Authentication 中的密碼。V
tagsarray of string可填入任意字串來做分類使用。

Key Authentication#

搭配的插件配置及說明部分請參考 Key Authentication 頁面

key-auth

欄位配置說明#

變數類型預設值說明必填
keystring可設定獨一無二的金鑰。或是留空自動生成。
tagsarray of string可填入任意字串來做分類使用。

OAuth2#

搭配的插件配置及說明部分請參考 OAuth2 頁面

oauth2

欄位配置說明#

變數類型預設值說明必填
namestring代表此憑證之名稱。V
client_idnumber可以設定獨一無二的 client_id ,或是留空自動生成。
client_secretstring可以設定獨一無二的 client_secret ,或是留空自動生成。
client_typestringconfidential客戶端類型,可以選擇 confidential 或是 public
redirect_urisarray of string通過驗證後會被送往的 URLs 列表。可參考 RFC 6742 Section 3.1.2V
hash_secretbooleanfalse表示 client_secret 欄位的字段是否將以 hash 形式儲存。
如果在現有插件實例上啟用(設為 true),則 client secrets 會在首次使用時被 hash。
V
tagsarray of string可填入任意字串來做分類使用。

HMAC Authentication#

搭配的插件配置及說明部分請參考 HMAC Authentication 頁面

hmac-auth

欄位配置說明#

變數類型預設值說明必填
usernamestring使用在 HMAC Signature 中的使用者名稱。V
secretstring使用在 HMAC Signature 中的密鑰。如果留空則會自動產生值,並將其當作回應的 Body 一部分來發送。
tagsarray of string可填入任意字串來做分類使用。

JWT#

搭配的插件配置及說明部分請參考 JWT 頁面

jwt

欄位配置說明#

變數類型預設值說明必填
keystring代表此憑證獨一無二之金鑰。如留空則會自動生成。
algorithmstringHS256用來驗證簽署的演算法。此欄位接受輸入的值為以下其一: HS256HS384HS512RS256RS384RS512ES256ES384
rsa_public_keystring如果 algorithmRS256RS384RS512ES256ES384 ,則用來驗證簽署的公開金鑰(PEM格式)。
secretstring如果 algorithmHS256HS384HS512 ,則用來簽署 JWTs 的祕鑰。如留空則會自動生成。
tagsarray of string可填入任意字串來做分類使用。