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