このページは、まだ日本語ではご利用いただけません。翻訳中です。
構成
このプラグインはDBレスモードに対応しています。
互換性のあるプロトコル
LDAP Authenticationプラグインは以下のプロトコルに対応しています:
grpc
, grpcs
, http
, https
, ws
, wss
パラメータ
このプラグインの設定で使用できるすべてのパラメータのリストは次のとおりです。
-
name or plugin
string requiredプラグイン名。この場合は
ldap-auth
。- Kong Admin API、Kong Konnect API、宣言型構成、または decK ファイルを使用する場合、フィールドは
name
です。 - Kubernetes で KongPlugin オブジェクトを使用する場合、フィールドは
plugin
です。
- Kong Admin API、Kong Konnect API、宣言型構成、または decK ファイルを使用する場合、フィールドは
-
instance_name
stringプラグインのインスタンスを識別するための任意のカスタム名 (例:
ldap-auth_my-service
。インスタンス名はKong ManagerとKonnectに表示されるので、 例えば複数のサービスで同じプラグインを複数のコンテキストで実行する場合に便利です。また、Kong Admin API経由で特定のプラグインインスタンスに アクセスするためにも使用できます。
インスタンス名は、次のコンテキスト内で一意である必要があります。
- Kong Gateway Enterpriseのワークスペース内
- Konnectのコントロールプレーン(CP)またはコントロールプレーン(CP)グループ内
- Kong Gateway (OSS)の全世界
-
service.name or service.id
stringプラグインが対象とするサービス名または ID。最上位の
/plugins
エンドポイント. からプラグインをサービスに追加する場合は、これらのパラメータのいずれかを設定してください/services/{serviceName|Id}/plugins
を使用する場合は必要ありません。 -
route.name or route.id
stringプラグインがターゲットとするルート名または ID。最上位の
/plugins
エンドポイント. を通るルートにプラグインを追加する場合は、これらのパラメータのいずれかを設定してください/routes/{routeName|Id}/plugins
を使用する場合は必要ありません。 -
enabled
boolean default:true
このプラグインが適用されるかどうか。
-
config
record required-
ldap_host
string requiredA string representing a host name, such as example.com.
-
ldap_port
integer required default:389
between:0
65535
An integer representing a port number between 0 and 65535, inclusive.
-
ldaps
boolean required default:false
Set to
true
to connect using the LDAPS protocol (LDAP over TLS). Whenldaps
is configured, you must use port 636. If theldap
setting is enabled, ensure thestart_tls
setting is disabled.
-
start_tls
boolean required default:false
Set it to
true
to issue StartTLS (Transport Layer Security) extended operation overldap
connection. If thestart_tls
setting is enabled, ensure theldaps
setting is disabled.
-
verify_ldap_host
boolean required default:false
Set to
true
to authenticate LDAP server. The server certificate will be verified according to the CA certificates specified by thelua_ssl_trusted_certificate
directive.
-
base_dn
string requiredBase DN as the starting point for the search; e.g., dc=example,dc=com
-
attribute
string requiredAttribute to be used to search the user; e.g. cn
-
cache_ttl
number required default:60
Cache expiry time in seconds.
-
hide_credentials
boolean required default:false
An optional boolean value telling the plugin to hide the credential to the upstream server. It will be removed by Kong before proxying the request.
-
timeout
number default:10000
An optional timeout in milliseconds when waiting for connection with LDAP server.
-
keepalive
number default:60000
An optional value in milliseconds that defines how long an idle connection to LDAP server will live before being closed.
-
anonymous
stringAn optional string (consumer UUID or username) value to use as an “anonymous” consumer if authentication fails. If empty (default null), the request fails with an authentication failure
4xx
.
-
header_type
string default:ldap
An optional string to use as part of the Authorization header
-
realm
stringWhen authentication fails the plugin sends
WWW-Authenticate
header withrealm
attribute value.
-