第7章 Red Hat build of Keycloak SAML Galleon 機能パックの詳細な設定
`keycloak-saml.xml` 設定ファイルの要素に関する詳細なリスト。
この章には、Red Hat build of Keycloak SAML Galleon 機能パックで使用される keycloak-saml.xml
設定ファイルの要素の詳細なリストが記載されています。
7.1. SP 要素
SP 要素属性の説明は次のとおりです。
<SP entityID="sp" sslPolicy="ssl" nameIDPolicyFormat="format" forceAuthentication="true" isPassive="false" keepDOMAssertion="true" autodetectBearerOnly="false"> ... </SP>
<SP entityID="sp"
sslPolicy="ssl"
nameIDPolicyFormat="format"
forceAuthentication="true"
isPassive="false"
keepDOMAssertion="true"
autodetectBearerOnly="false">
...
</SP>
- entityID
- これは、このクライアントの ID です。IdP では、クライアントが通信しているユーザーを判別するためにこの値が必要です。この設定は 必須 です。
- sslPolicy
-
これは、アダプターが強制する SSL ポリシーです。有効な値は
ALL
、EXTERNAL
、およびNONE
です。ALL
の場合、すべてのリクエストは HTTPS 経由で受信する必要があります。EXTERNAL
の場合、非プライベート IP アドレスのみが HTTPS 経由で有線を通過する必要があります。NONE
の場合、HTTPS 経由のリクエストはありません。この設定は 任意 です。デフォルト値はEXTERNAL
です。 - nameIDPolicyFormat
-
SAML クライアントは、特定の NameID Subject 形式を要求できます。特定の形式が必要な場合は、この値を入力します。標準の SAML 形式の識別子である
urn:oasis:names:tc:SAML:2.0:nameid-format:transient
ある必要があります。この設定は 任意 です。デフォルトでは、特別な形式は要求されません。 - forceAuthentication
-
SAML クライアントは、ユーザーが IdP にすでにログインしていても、再認証することをリクエストできます。有効にするには、これを
true
に設定します。この設定は 任意 です。デフォルト値はfalse
です。 - isPassive
-
SAML クライアントは、IdP にログインしていない場合でも、ユーザーの認証が要求されないように要求できます。必要に応じてこれを
true
に設定します。forceAuthentication
は逆の設定なので、一緒に使用しないでください。この設定は 任意 です。デフォルト値はfalse
です。 - turnOffChangeSessionIdOnLogin
-
セッション ID は、一部のプラットフォームで正常にログインしてセキュリティー攻撃ベクトルをプラグインするためにデフォルトで変更されます。これを無効にするには、これを
true
に変更します。オフにしないことが推奨されます。デフォルト値はfalse
です。 - autodetectBearerOnly
-
アプリケーションが Web アプリケーションと Web サービス (例: SOAP または REST) の両方に対応する場合は、true に設定する必要があります。これにより、Web アプリケーションの未認証ユーザーを Red Hat build of Keycloak ログインページにリダイレクトできますが、SOAP または REST クライアントのような未認証のクライアントには、ログインページへのリダイレクトが理解できないため、HTTP
401
ステータスコードを送信します。Red Hat build of Keycloak は、X-Requested-With
、SOAPAction
、Accept
などの一般的なヘッダーに基づいて SOAP または REST クライアントを自動検出します。デフォルト値は false です。 - logoutPage
-
これにより、ログアウト後に表示するページが設定されます。ページが
http://web.example.com/logout.html
などの完全な URL の場合、ユーザーは HTTP302
ステータスコードを使用してログアウト後にそのページにリダイレクトされます。スキーム部分のないリンク (例:/logout.jsp
) が指定されると、web.xml のsecurity-constraint
宣言に従って保護領域に存在するかどうかに関係なく、ログアウトの後にページが表示され、ページがデプロイメントコンテキストルートとの関連で解決されます。 - keepDOMAssertion
-
この属性は true に設定して、要求に関連付けられた
SamlPrincipal
内の元の形式でアダプターストアにアサーションの DOM 表現を設定します。アサーションドキュメントは、プリンシパル内のgetAssertionDocument
メソッドを使用して取得できます。これは、署名済みアサーションの再生時に特に便利です。返されるドキュメントは、Red Hat build of Keycloak サーバーによって受信された SAML 応答を解析して生成されたものです。この設定は 任意 で、デフォルト値は false です (ドキュメントはプリンシパルに保存されません)。