クラス HeadersConfigurer<H extends HttpSecurityBuilder<H>>
- 実装されているすべてのインターフェース:
SecurityConfigurer<DefaultSecurityFilterChain,H>
Security HTTP ヘッダーをレスポンスに追加します。EnableWebSecurity のデフォルトコンストラクターを使用すると、セキュリティ HTTP ヘッダーがデフォルトでアクティブになります。
デフォルトのヘッダーは次のとおりです。
Cache-Control: no-cache, no-store, max-age=0, must-revalidate Pragma: no-cache Expires: 0 X-Content-Type-Options: nosniff Strict-Transport-Security: max-age=31536000 ; includeSubDomains X-Frame-Options: DENY X-XSS-Protection: 0
- 導入:
- 3.2
ネストされたクラスの要約
ネストされたクラス修飾子と型クラス説明final classfinal classfinal classfinal classfinal classfinal classfinal classfinal classfinal class使用すべきではありません。詳細なコンテキストについては、証明書と公開鍵ピンニングを参照してくださいfinal classfinal classfinal classfinal classコンストラクターの概要
コンストラクターメソッドのサマリー
修飾子と型メソッド説明addHeaderWriter(HeaderWriter headerWriter) HeaderWriterインスタンスを追加しますcacheControl(Customizer<HeadersConfigurer<H>.CacheControlConfig> cacheControlCustomizer) CacheControlHeadersWriterをカスタマイズできます。voidSecurityBuilderに必要なプロパティを設定して、SecurityBuilderを構成します。contentSecurityPolicy(Customizer<HeadersConfigurer<H>.ContentSecurityPolicyConfig> contentSecurityCustomizer) コンテンツセキュリティポリシー(CSP)レベル 2 の構成を許可します。contentTypeOptions(Customizer<HeadersConfigurer<H>.ContentTypeOptionsConfig> contentTypeOptionsCustomizer) X-Content-Type-Options を挿入するXContentTypeOptionsHeaderWriterを構成します。crossOriginEmbedderPolicy(Customizer<HeadersConfigurer<H>.CrossOriginEmbedderPolicyConfig> crossOriginEmbedderPolicyCustomizer) Cross-Origin-Embedder-Policy ヘッダーの構成を許可します。crossOriginOpenerPolicy(Customizer<HeadersConfigurer<H>.CrossOriginOpenerPolicyConfig> crossOriginOpenerPolicyCustomizer) Cross-Origin-Opener-Policy ヘッダーの構成を許可します。crossOriginResourcePolicy(Customizer<HeadersConfigurer<H>.CrossOriginResourcePolicyConfig> crossOriginResourcePolicyCustomizer) Cross-Origin-Resource-Policy ヘッダーの構成を許可します。レスポンスからすべてのデフォルトヘッダーをクリアします。featurePolicy(StringSE policyDirectives) 使用すべきではありません。7.0 の取り外し用。frameOptions(Customizer<HeadersConfigurer<H>.FrameOptionsConfig> frameOptionsCustomizer) XFrameOptionsHeaderWriterをカスタマイズできます。httpPublicKeyPinning(Customizer<HeadersConfigurer<H>.HpkpConfig> hpkpCustomizer) 使用すべきではありません。詳細なコンテキストについては、証明書と公開鍵ピンニングを参照してくださいhttpStrictTransportSecurity(Customizer<HeadersConfigurer<H>.HstsConfig> hstsCustomizer) HTTP Strict Transport Security (HSTS) をサポートするHstsHeaderWriterをカスタマイズできます。permissionsPolicy(Customizer<HeadersConfigurer<H>.PermissionsPolicyConfig> permissionsPolicyCustomizer) 非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。7.0 の取り外し用。permissionsPolicyHeader(Customizer<HeadersConfigurer<H>.PermissionsPolicyConfig> permissionsPolicyCustomizer) 権限ポリシーの構成を許可します。referrerPolicy(Customizer<HeadersConfigurer<H>.ReferrerPolicyConfig> referrerPolicyCustomizer) リファラーポリシーの構成を許可します。xssProtection(Customizer<HeadersConfigurer<H>.XXssConfig> xssCustomizer) これは包括的な XSS 保護ではないことに注意してください!クラス org.springframework.security.config.annotation.web.configurers.AbstractHttpConfigurer から継承されたメソッド
disable, getRequestMatcherBuilder, getSecurityContextHolderStrategy, withObjectPostProcessorクラス org.springframework.security.config.annotation.SecurityConfigurerAdapter から継承されたメソッド
addObjectPostProcessor, getBuilder, init, postProcess, setBuilder
コンストラクターの詳細
HeadersConfigurer
public HeadersConfigurer()新しいインスタンスを作成します
メソッドの詳細
addHeaderWriter
HeaderWriterインスタンスを追加します- パラメーター:
headerWriter- 追加するHeaderWriterインスタンス- 戻り値:
- 追加のカスタマイズのための
HeadersConfigurer
contentTypeOptions
public HeadersConfigurer<H> contentTypeOptions(Customizer<HeadersConfigurer<H>.ContentTypeOptionsConfig> contentTypeOptionsCustomizer) X-Content-Type-Options を挿入するXContentTypeOptionsHeaderWriterを構成します。X-Content-Type-Options: nosniff
- パラメーター:
contentTypeOptionsCustomizer-HeadersConfigurer<H extends HttpSecurityBuilder<H>>.ContentTypeOptionsConfigにより多くのオプションを提供するCustomizer- 戻り値:
- 追加のカスタマイズのための
HeadersConfigurer
xssProtection
public HeadersConfigurer<H> xssProtection(Customizer<HeadersConfigurer<H>.XXssConfig> xssCustomizer) これは包括的な XSS 保護ではないことに注意してください!X-XSS-Protection ヘッダーを追加する
XXssProtectionHeaderWriterをカスタマイズできます- パラメーター:
xssCustomizer-HeadersConfigurer<H extends HttpSecurityBuilder<H>>.XXssConfigにより多くのオプションを提供するCustomizer- 戻り値:
- 追加のカスタマイズのための
HeadersConfigurer
cacheControl
public HeadersConfigurer<H> cacheControl(Customizer<HeadersConfigurer<H>.CacheControlConfig> cacheControlCustomizer) CacheControlHeadersWriterをカスタマイズできます。具体的には、次のヘッダーを追加します。- キャッシュ制御: no-cache、no-store、max-age = 0、must-revalidate
- プラグマ: no-cache
- 有効期限: 0
- パラメーター:
cacheControlCustomizer-HeadersConfigurer<H extends HttpSecurityBuilder<H>>.CacheControlConfigにより多くのオプションを提供するCustomizer- 戻り値:
- 追加のカスタマイズのための
HeadersConfigurer
httpStrictTransportSecurity
public HeadersConfigurer<H> httpStrictTransportSecurity(Customizer<HeadersConfigurer<H>.HstsConfig> hstsCustomizer) HTTP Strict Transport Security (HSTS) をサポートするHstsHeaderWriterをカスタマイズできます。- パラメーター:
hstsCustomizer-HeadersConfigurer<H extends HttpSecurityBuilder<H>>.HstsConfigにより多くのオプションを提供するCustomizer- 戻り値:
- 追加のカスタマイズのための
HeadersConfigurer
frameOptions
public HeadersConfigurer<H> frameOptions(Customizer<HeadersConfigurer<H>.FrameOptionsConfig> frameOptionsCustomizer) XFrameOptionsHeaderWriterをカスタマイズできます。- パラメーター:
frameOptionsCustomizer-HeadersConfigurer<H extends HttpSecurityBuilder<H>>.FrameOptionsConfigにより多くのオプションを提供するCustomizer- 戻り値:
- 追加のカスタマイズのための
HeadersConfigurer
httpPublicKeyPinning
@DeprecatedSE public HeadersConfigurer<H> httpPublicKeyPinning(Customizer<HeadersConfigurer<H>.HpkpConfig> hpkpCustomizer) 使用すべきではありません。詳細なコンテキストについては、証明書と公開鍵ピンニングを参照してくださいHTTP 公開鍵ピンニング (HPKP) をサポートするHpkpHeaderWriterをカスタマイズできます。- パラメーター:
hpkpCustomizer-HeadersConfigurer<H extends HttpSecurityBuilder<H>>.HpkpConfigにより多くのオプションを提供するCustomizer- 戻り値:
- 追加のカスタマイズのための
HeadersConfigurer
contentSecurityPolicy
public HeadersConfigurer<H> contentSecurityPolicy(Customizer<HeadersConfigurer<H>.ContentSecurityPolicyConfig> contentSecurityCustomizer) コンテンツセキュリティポリシー(CSP)レベル 2 の構成を許可します。
このメソッドを呼び出すと、提供されたセキュリティポリシーディレクティブを使用して、レスポンスの Content-Security-Policy ヘッダーが自動的に有効になります(含まれます)。
W3C Candidate Recommendation に詳述されているように、2 つのヘッダーの書き込みをサポートする
ContentSecurityPolicyHeaderWriterに構成が提供されます。- コンテンツセキュリティポリシー
- コンテンツ - セキュリティ - ポリシー - レポートのみ
- パラメーター:
contentSecurityCustomizer-HeadersConfigurer<H extends HttpSecurityBuilder<H>>.ContentSecurityPolicyConfigにより多くのオプションを提供するCustomizer- 戻り値:
- 追加のカスタマイズのための
HeadersConfigurer - 関連事項:
defaultsDisabled
レスポンスからすべてのデフォルトヘッダーをクリアします。その後、ヘッダーを元に戻すことができます。例: Spring Security のキャッシュコントロールのみを使用する場合は、以下を使用できます。http.headers().defaultsDisabled().cacheControl();
- 戻り値:
- 追加のカスタマイズのための
HeadersConfigurer
configure
インターフェースからコピーされた説明:SecurityConfigurerSecurityBuilderに必要なプロパティを設定して、SecurityBuilderを構成します。- 次で指定:
- インターフェース
SecurityConfigurer<DefaultSecurityFilterChain,のH extends HttpSecurityBuilder<H>> configure - オーバーライド:
- クラス
SecurityConfigurerAdapter<DefaultSecurityFilterChain,のH extends HttpSecurityBuilder<H>> configure
referrerPolicy
public HeadersConfigurer<H> referrerPolicy(Customizer<HeadersConfigurer<H>.ReferrerPolicyConfig> referrerPolicyCustomizer) リファラーポリシーの構成を許可します。
W3C テクニカルレポートで詳しく説明されているように、ヘッダーの書き込みをサポートする
ReferrerPolicyHeaderWriterに構成が提供されます。- リファラーポリシー
- パラメーター:
referrerPolicyCustomizer-HeadersConfigurer<H extends HttpSecurityBuilder<H>>.ReferrerPolicyConfigにより多くのオプションを提供するCustomizer- 戻り値:
- 追加のカスタマイズのための
HeadersConfigurer - 関連事項:
featurePolicy
@DeprecatedSE public HeadersConfigurer<H>.FeaturePolicyConfig featurePolicy(StringSE policyDirectives) 使用すべきではありません。7.0 の取り外し用。デフォルトをそのまま使用するには、permissionsPolicy(Customizer)またはpermissionsPolicy(Customizer.withDefaults())を使用します。詳細については、ドキュメントを参照してください。機能ポリシーの構成を許可します。このメソッドを呼び出すと、提供されたポリシーディレクティブを使用して、レスポンスの
Feature-Policyヘッダーが自動的に有効になります(含まれます)。構成は、ヘッダーの書き込みを担当する
FeaturePolicyHeaderWriterに提供されます。- 戻り値:
- 追加構成のための
HeadersConfigurer<H extends HttpSecurityBuilder<H>>.FeaturePolicyConfig - 例外:
IllegalArgumentExceptionSE- policyDirectives がnullまたは空の場合- 導入:
- 5.1
- 関連事項:
permissionsPolicy
@DeprecatedSE(since="6.4", forRemoval=true) public HeadersConfigurer<H>.PermissionsPolicyConfig permissionsPolicy(Customizer<HeadersConfigurer<H>.PermissionsPolicyConfig> permissionsPolicyCustomizer) 非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。7.0 の取り外し用。代わりにpermissionsPolicyHeader(Customizer)を使用してください権限ポリシーの構成を許可します。このメソッドを呼び出すと、提供されたポリシーディレクティブを使用して、レスポンスの
Permissions-Policyヘッダーが自動的に有効になります(含まれます)。構成は、ヘッダーの書き込みを担当する
PermissionsPolicyHeaderWriterに提供されます。- 戻り値:
- 追加構成のための
HeadersConfigurer<H extends HttpSecurityBuilder<H>>.PermissionsPolicyConfig - 例外:
IllegalArgumentExceptionSE- policyDirectives がnullまたは空の場合- 導入:
- 5.5
- 関連事項:
permissionsPolicyHeader
public HeadersConfigurer<H> permissionsPolicyHeader(Customizer<HeadersConfigurer<H>.PermissionsPolicyConfig> permissionsPolicyCustomizer) 権限ポリシーの構成を許可します。このメソッドを呼び出すと、提供されたポリシーディレクティブを使用して、レスポンスの
Permissions-Policyヘッダーが自動的に有効になります(含まれます)。構成は、ヘッダーの書き込みを担当する
PermissionsPolicyHeaderWriterに提供されます。- 戻り値:
- 追加構成のための
HeadersConfigurer<H extends HttpSecurityBuilder<H>>.PermissionsPolicyConfig - 例外:
IllegalArgumentExceptionSE- policyDirectives がnullまたは空の場合- 導入:
- 6.4
- 関連事項:
crossOriginOpenerPolicy
public HeadersConfigurer<H> crossOriginOpenerPolicy(Customizer<HeadersConfigurer<H>.CrossOriginOpenerPolicyConfig> crossOriginOpenerPolicyCustomizer) Cross-Origin-Opener-Policy ヘッダーの構成を許可します。このメソッドを呼び出すと、提供されたポリシーを使用して、レスポンスで
Cross-Origin-Opener-Policyヘッダーが自動的に有効になります(含まれます)。構成は、ヘッダーの書き込みを担当する
CrossOriginOpenerPolicyHeaderWriterに提供されます。- 戻り値:
- 追加のカスタマイズのための
HeadersConfigurer - 導入:
- 5.7
- 関連事項:
crossOriginEmbedderPolicy
public HeadersConfigurer<H> crossOriginEmbedderPolicy(Customizer<HeadersConfigurer<H>.CrossOriginEmbedderPolicyConfig> crossOriginEmbedderPolicyCustomizer) Cross-Origin-Embedder-Policy ヘッダーの構成を許可します。このメソッドを呼び出すと、提供されたポリシーを使用して、レスポンスで
Cross-Origin-Embedder-Policyヘッダーが自動的に有効になります(含まれます)。構成は、ヘッダーの書き込みを担当する
CrossOriginEmbedderPolicyHeaderWriterに提供されます。- 戻り値:
- 追加のカスタマイズのための
HeadersConfigurer - 導入:
- 5.7
- 関連事項:
crossOriginResourcePolicy
public HeadersConfigurer<H> crossOriginResourcePolicy(Customizer<HeadersConfigurer<H>.CrossOriginResourcePolicyConfig> crossOriginResourcePolicyCustomizer) Cross-Origin-Resource-Policy ヘッダーの構成を許可します。このメソッドを呼び出すと、提供されたポリシーを使用して、レスポンスで
Cross-Origin-Resource-Policyヘッダーが自動的に有効になります(含まれます)。構成は、ヘッダーの書き込みを担当する
CrossOriginResourcePolicyHeaderWriterに提供されます。- 戻り値:
- 追加のカスタマイズのための
HeadersConfigurer - 導入:
- 5.7
- 関連事項: