このページは、まだ日本語ではご利用いただけません。翻訳中です。
古いプラグインバージョンのドキュメントを閲覧しています。
構成
このプラグインはDBレスモードに対応しています。
互換性のあるプロトコル
SAMLプラグインは以下のプロトコルに対応しています:
grpc
, grpcs
, http
, https
パラメータ
このプラグインの設定で使用できるすべてのパラメータのリストは次のとおりです。
-
name or plugin
string requiredプラグイン名。この場合は
saml
。- Kong Admin API、Kong Konnect API、宣言型構成、または decK ファイルを使用する場合、フィールドは
name
です。 - Kubernetes で KongPlugin オブジェクトを使用する場合、フィールドは
plugin
です。
- Kong Admin API、Kong Konnect API、宣言型構成、または decK ファイルを使用する場合、フィールドは
-
instance_name
stringプラグインのインスタンスを識別するための任意のカスタム名 (例:
saml_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-
assertion_consumer_path
string required starts_with:/
The relative path the SAML IdP provider uses when responding with an authentication response.
-
idp_sso_url
string requiredThe Single Sign-On URL exposed by the IdP provider. This is where SAML requests are posted. The IdP provides this information.
-
idp_certificate
string referenceable encryptedThe public certificate provided by the IdP. This is used to validate responses from the IdP.
Only include the contents of the certificate. Do not include the header (
BEGIN CERTIFICATE
) and footer (END CERTIFICATE
) lines.
-
response_encryption_key
string referenceable encryptedThe private encryption key required to decrypt encrypted assertions.
-
request_signing_key
string referenceable encryptedThe private key for signing requests. If this parameter is set, requests sent to the IdP are signed. The
request_signing_certificate
parameter must be set as well.
-
request_signing_certificate
string referenceable encryptedThe certificate for signing requests.
-
request_signature_algorithm
string default:SHA256
Must be one of:SHA256
,SHA384
,SHA512
The signature algorithm for signing Authn requests. Options available are:
SHA256
SHA384
SHA512
-
request_digest_algorithm
string default:SHA256
Must be one of:SHA256
,SHA1
The digest algorithm for Authn requests:
SHA256
SHA1
-
response_signature_algorithm
string default:SHA256
Must be one of:SHA256
,SHA384
,SHA512
The algorithm for validating signatures in SAML responses. Options available are:
SHA256
SHA384
SHA512
-
response_digest_algorithm
string default:SHA256
Must be one of:SHA256
,SHA1
The algorithm for verifying digest in SAML responses:
SHA256
SHA1
-
issuer
string requiredThe unique identifier of the IdP application. Formatted as a URL containing information about the IdP so the SP can validate that the SAML assertions it receives are issued from the correct IdP.
-
nameid_format
string default:EmailAddress
Must be one of:Unspecified
,EmailAddress
,Persistent
,Transient
The requested
NameId
format. Options available are:Unspecified
EmailAddress
Persistent
Transient
-
validate_assertion_signature
boolean default:true
Enable signature validation for SAML responses.
-
anonymous
stringAn optional string (consumer UUID or username) value to use as an “anonymous” consumer. If not set, a Kong Consumer must exist for the SAML IdP user credentials, mapping the username format to the Kong Consumer username.
-
session_secret
string required referenceable encrypted matches:^[0-9a-zA-Z/_+]+$
len_min:32
len_max:32
The session secret. This must be a random string of 32 characters from the base64 alphabet (letters, numbers,
/
,_
and+
). It is used as the secret key for encrypting session data as well as state information that is sent to the IdP in the authentication exchange.
-
session_audience
string default:default
The session audience, for example “my-application”
-
session_cookie_name
string default:session
The session cookie name.
-
session_remember
boolean default:false
Enables or disables persistent sessions
-
session_remember_cookie_name
string default:remember
Persistent session cookie name
-
session_remember_rolling_timeout
number default:604800
Persistent session rolling timeout in seconds.
-
session_remember_absolute_timeout
number default:2592000
Persistent session absolute timeout in seconds.
-
session_idling_timeout
number default:900
The session cookie idle time in seconds.
-
session_rolling_timeout
number default:3600
The session cookie absolute timeout in seconds. Specifies how long the session can be used until it is no longer valid.
-
session_absolute_timeout
number default:86400
The session cookie absolute timeout in seconds. Specifies how long the session can be used until it is no longer valid.
-
session_cookie_path
string default:/
starts_with:/
The session cookie path flag.
-
session_cookie_domain
stringThe session cookie domain flag.
-
session_cookie_same_site
string default:Lax
Must be one of:Strict
,Lax
,None
,Default
Controls whether a cookie is sent with cross-origin requests, providing some protection against cross-site request forgery attacks:
-
Strict
: Cookies will only be sent in a first-party context and aren’t sent along with requests initiated by third party websites. -
Lax
: Cookies are not sent on normal cross-site subrequests, like loading images or frames into a third party site, but are sent when a user is navigating to the origin site, like when they are following a link. -
None
: Cookies will be sent in all contexts, including responses to both first party and cross-origin requests. IfSameSite=None
is set, the cookie secure attribute must also be set or the cookie will be blocked. -
Default
: Do not explicitly specify a Same-Site attribute.
-
-
session_cookie_http_only
boolean default:true
Forbids JavaScript from accessing the cookie, for example, through the
Document.cookie
property.
-
session_cookie_secure
booleanThe cookie is only sent to the server when a request is made with the https:scheme (except on localhost), and therefore is more resistant to man-in-the-middle attacks.
-
session_request_headers
set of typestring
Must be one of:id
,audience
,subject
,timeout
,idling-timeout
,rolling-timeout
,absolute-timeout
List of information to include (as headers) in the request to upstream. Accepted values are:
id
,audience
,subject
,timeout
,idling-timeout
,rolling-timeout
, andabsolute-timeout
. For example, { “id”, “timeout” } will set bothSession-Id
andSession-Timeout
in the request headers.
-
session_response_headers
set of typestring
Must be one of:id
,audience
,subject
,timeout
,idling-timeout
,rolling-timeout
,absolute-timeout
List of information to include (as headers) in the response to downstream. Accepted values are:
id
,audience
,subject
,timeout
,idling-timeout
,rolling-timeout
, andabsolute-timeout
. For example: { “id”, “timeout” } will inject bothSession-Id
andSession-Timeout
in the response headers.
-
session_storage
string default:cookie
Must be one of:cookie
,memcache
,memcached
,redis
The session storage for session data:
-
cookie
: stores session data with the session cookie. The session cannot be invalidated or revoked without changing the session secret, but is stateless, and doesn’t require a database. -
memcached
: stores session data in memcached -
redis
: stores session data in Redis
-
-
session_store_metadata
boolean default:false
Configures whether or not session metadata should be stored. This includes information about the active sessions for the
specific_audience
belonging to a specific subject.
-
session_enforce_same_subject
boolean default:false
When set to
true
, audiences are forced to share the same subject.
-
session_hash_subject
boolean default:false
When set to
true
, the value of subject is hashed before being stored. Only applies whensession_store_metadata
is enabled.
-
session_hash_storage_key
boolean default:false
When set to
true
, the storage key (session ID) is hashed for extra security. Hashing the storage key means it is impossible to decrypt data from the storage without a cookie.
-
session_memcached_prefix
stringThe memcached session key prefix.
-
session_memcached_socket
stringThe memcached unix socket path.
-
session_memcached_host
string default:127.0.0.1
The memcached host.
-
session_memcached_port
integer default:11211
between:0
65535
The memcached port.
-
session_redis_prefix
stringThe Redis session key prefix.
-
session_redis_socket
stringThe Redis unix socket path.
-
session_redis_host
string default:127.0.0.1
The Redis host IP.
-
session_redis_port
integer default:6379
between:0
65535
The Redis port.
-
session_redis_username
string referenceableRedis username if the
redis
session storage is defined and ACL authentication is desired.If undefined, ACL authentication will not be performed.This requires Redis v6.0.0+. The username cannot be set to
default
.
-
session_redis_password
string referenceable encryptedPassword to use for Redis connection when the
redis
session storage is defined. If undefined, no auth commands are sent to Redis. This value is pulled from
-
session_redis_connect_timeout
integerThe Redis connection timeout in milliseconds.
-
session_redis_read_timeout
integerThe Redis read timeout in milliseconds.
-
session_redis_send_timeout
integerThe Redis send timeout in milliseconds.
-
session_redis_ssl
boolean default:false
Use SSL/TLS for the Redis connection.
-
session_redis_ssl_verify
boolean default:false
Verify the Redis server certificate.
-
session_redis_server_name
stringThe SNI used for connecting to the Redis server.
-
session_redis_cluster_nodes
array of typerecord
The Redis cluster node host. Takes an array of host records, with either
ip
orhost
, andport
values.-
ip
string required default:127.0.0.1
-
port
integer default:6379
between:0
65535
-
-
session_redis_cluster_max_redirections
integerThe Redis cluster maximum redirects.
-
-
session_cookie_lifetime
numberDeprecation notice:
-
session_cookie_idletime
numberThe session cookie idle time in seconds.
Deprecation notice:
-
session_cookie_samesite
stringDeprecation notice:
-
session_cookie_httponly
booleanDeprecation notice:
-
session_memcache_prefix
stringDeprecation notice:
-
session_memcache_socket
stringDeprecation notice:
-
session_memcache_host
stringDeprecation notice:
-
session_memcache_port
integerDeprecation notice:
-
session_redis_cluster_maxredirections
integerDeprecation notice:
-
session_cookie_renew
numberThe session cookie renew time in seconds.
Deprecation notice:
-
session_cookie_maxsize
integerThe maximum size of each cookie in bytes.
Deprecation notice:
-
session_strategy
stringDeprecation notice:
-
session_compressor
stringDeprecation notice:
-
session_auth_ttl
stringDeprecation notice: