コンテンツにスキップ
|
Plugin Hub
report-issue問題を報告する
header icon

Session Configuration

By Kong Inc.

このページは、まだ日本語ではご利用いただけません。翻訳中です。

古いプラグインバージョンのドキュメントを閲覧しています。

構成

このプラグインはDB-lessモードと部分的に互換性があります。

config.storage must be set to cookie. The kong strategy uses a database, and is not supported. The plugin currently lacks checks for this invalid configuration in DB-less mode.

互換性のあるプロトコル

Sessionプラグインは以下のプロトコルに対応しています：

grpc, grpcs, http, https, tcp, tls, tls_passthrough, udp, ws, wss

パラメータ

このプラグインの設定で使用できるすべてのパラメータのリストは次のとおりです。

  • name or plugin

    string required

    プラグイン名。この場合は session 。

    • Kong Admin API、Kong Konnect API、宣言型構成、または decK ファイルを使用する場合、フィールドはnameです。
    • Kubernetes で KongPlugin オブジェクトを使用する場合、フィールドはpluginです。

  • 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

    • secret

      string referenceable encrypted default: tW20j9bkitAMqUwbXl2Pmj5jBjpq2WTQBrUzVzsvvo4y

      The secret that is used in keyed HMAC generation.

    • string default: session

      The name of the cookie.

    • number default: 3600

      The duration in seconds that the session will remain open.

    • number

      The cookie idle time (in seconds); if a cookie is not used for this time period, the session becomes invalid. This value is not set by default, meaning idle time checks are disabled.

    • number default: 600

      The remaining duration in seconds of a session at which point the Plugin renews the session.

    • string default: /

      The resource in the host where the cookie is available.

    • string

      The domain with which the cookie is intended to be exchanged.

    • string default: Strict Must be one of: Strict, Lax, None, off

      Determines whether and how a cookie may be sent with cross-site requests.

      • Strict: The browser sends cookies only if the request originated from the website that set the cookie.
      • Lax: Same-site cookies are withheld on cross-domain subrequests, but are sent when a user navigates to the URL from an external site, for example, by following a link.
      • None or off: Disables the same-site attribute so that a cookie may be sent with cross-site requests. None requires the Secure attribute (cookie_secure) in latest browser versions. For more information, see the SameSite cookies docs on MDN.
    • boolean default: true

      Applies the Secure directive so that the cookie may be sent to the server only with an encrypted request over the HTTPS protocol. See the Restrict access to cookies docs on MDN.

    • number default: 10

      The duration in seconds after which an old session’s TTL is updated that an old cookie is discarded.

    • boolean default: false

      Allows the browser to persist cookies even if the browser is closed. By default, cookies are not persisted across browser restarts.

    • storage

      string default: cookie Must be one of: cookie, kong

      Determines where the session data is stored. kong: Stores encrypted session data into Kong’s current database strategy; the cookie will not contain any session data. cookie: Stores encrypted session data within the cookie itself.

    • logout_methods

      array of type string default: POST, DELETE Must be one of: GET, POST, DELETE

      The methods that may be used to end sessions: POST, DELETE, GET.

    • logout_query_arg

      string default: session_logout

      The query argument passed to logout requests.

    • logout_post_arg

      string default: session_logout

      The POST argument passed to logout requests. Do not change this property.