クラス Saml2AuthenticationToken
- java.lang.Object
-
- org.springframework.security.authentication.AbstractAuthenticationToken
-
- org.springframework.security.saml2.provider.service.authentication.Saml2AuthenticationToken
- 実装されたすべてのインターフェース:
java.io.Serializable
、java.security.Principal
、Authentication
、CredentialsContainer
public class Saml2AuthenticationToken extends AbstractAuthenticationToken
検証されていないアサーションを含む受信 SAML 2.0 レスポンスを表します。isAuthenticated()
は常に false を返します。- 導入:
- 5.2
- 関連事項:
- 直列化された形式
コンストラクターのサマリー
コンストラクター コンストラクター 説明 Saml2AuthenticationToken(java.lang.String saml2Response, java.lang.String recipientUri, java.lang.String idpEntityId, java.lang.String localSpEntityId, java.util.List<Saml2X509Credential> credentials)
使用すべきではありません。代わりにSaml2AuthenticationToken(RelyingPartyRegistration, String)
を使用してくださいSaml2AuthenticationToken(RelyingPartyRegistration relyingPartyRegistration, java.lang.String saml2Response)
指定されたパラメーターを使用してSaml2AuthenticationToken
を作成します。指定されたRelyingPartyRegistration
では、この時点ですべてのテンプレートが解決されている必要があることに注意してください。Saml2AuthenticationToken(RelyingPartyRegistration relyingPartyRegistration, java.lang.String saml2Response, AbstractSaml2AuthenticationRequest authenticationRequest)
指定されたパラメーターを使用してSaml2AuthenticationToken
を作成します。
メソッドのサマリー
すべてのメソッド インスタンスメソッド 具象メソッド 非推奨のメソッド 修飾子と型 メソッド 説明 AbstractSaml2AuthenticationRequest
getAuthenticationRequest()
認証リクエストが存在しない場合は、アサーションパーティまたはnull
に送信された認証リクエストを返しますjava.lang.Object
getCredentials()
デコードおよびインフレートされた SAML 2.0 レスポンス XML オブジェクトを文字列として返しますjava.lang.String
getIdpEntityId()
使用すべきではありません。代わりにgetRelyingPartyRegistration().getAssertingPartyDetails().getEntityId()
を使用java.lang.String
getLocalSpEntityId()
使用すべきではありません。代わりにgetRelyingPartyRegistration().getEntityId()
を使用java.lang.Object
getPrincipal()
常に null を返します。java.lang.String
getRecipientUri()
使用すべきではありません。代わりにgetRelyingPartyRegistration().getAssertionConsumerServiceLocation()
を使用RelyingPartyRegistration
getRelyingPartyRegistration()
リクエストに関連付けられた解決済みのRelyingPartyRegistration
を取得しますjava.lang.String
getSaml2Response()
SAML 2 レスポンスの膨張およびデコードされた XML 表現を返しますjava.util.List<Saml2X509Credential>
getX509Credentials()
使用すべきではありません。代わりにgetRelyingPartyRegistration()
を介して資格情報を取得しますboolean
isAuthenticated()
認証トークンをAuthenticationManager
に提示する必要があるかどうかをAbstractSecurityInterceptor
に示すために使用されます。void
setAuthenticated(boolean authenticated)
このオブジェクトの状態は変更できません。クラス org.springframework.security.authentication.AbstractAuthenticationToken から継承されたメソッド
equals, eraseCredentials, getAuthorities, getDetails, getName, hashCode, setDetails, toString
コンストラクターの詳細
Saml2AuthenticationToken
public Saml2AuthenticationToken(RelyingPartyRegistration relyingPartyRegistration, java.lang.String saml2Response, AbstractSaml2AuthenticationRequest authenticationRequest)
指定されたパラメーターを使用してSaml2AuthenticationToken
を作成します。指定されたRelyingPartyRegistration
では、この時点ですべてのテンプレートが解決されている必要があることに注意してください。その解決を実行する例については、Saml2WebSsoAuthenticationFilter
を参照してください。- パラメーター:
relyingPartyRegistration
- 使用する解決済みのRelyingPartyRegistration
saml2Response
- 認証するための SAML 2.0 レスポンスauthenticationRequest
- アサート側に送信されたAuthNRequest
- 導入:
- 5.6
Saml2AuthenticationToken
public Saml2AuthenticationToken(RelyingPartyRegistration relyingPartyRegistration, java.lang.String saml2Response)
指定されたパラメーターを使用してSaml2AuthenticationToken
を作成します。指定されたRelyingPartyRegistration
では、この時点ですべてのテンプレートが解決されている必要があることに注意してください。その解決を実行する例については、Saml2WebSsoAuthenticationFilter
を参照してください。- パラメーター:
relyingPartyRegistration
- 使用する解決済みのRelyingPartyRegistration
saml2Response
- 認証するための SAML 2.0 レスポンス- 導入:
- 5.4
Saml2AuthenticationToken
@Deprecated public Saml2AuthenticationToken(java.lang.String saml2Response, java.lang.String recipientUri, java.lang.String idpEntityId, java.lang.String localSpEntityId, java.util.List<Saml2X509Credential> credentials)
使用すべきではありません。代わりにSaml2AuthenticationToken(RelyingPartyRegistration, String)
を使用してください受信 SAML 2 レスポンスオブジェクトから認証トークンを作成します- パラメーター:
saml2Response
- SAML 2 レスポンスのインフレートおよびデコードされた XML 表現recipientUri
- SAML 2 レスポンスが受信された URL。検証に使用idpEntityId
- アサーティングエンティティのエンティティ IDlocalSpEntityId
- 構成されたローカル SP、依存パーティ、エンティティ IDcredentials
- 署名の検証と復号化のために構成された資格情報
メソッドの詳細
getCredentials
public java.lang.Object getCredentials()
デコードおよびインフレートされた SAML 2.0 レスポンス XML オブジェクトを文字列として返します- 戻り値:
String
としてデコードおよびインフレートされた XML データ
getPrincipal
public java.lang.Object getPrincipal()
常に null を返します。- 戻り値:
- null
getRelyingPartyRegistration
public RelyingPartyRegistration getRelyingPartyRegistration()
リクエストに関連付けられた解決済みのRelyingPartyRegistration
を取得します- 戻り値:
- 解決された
RelyingPartyRegistration
- 導入:
- 5.4
getSaml2Response
public java.lang.String getSaml2Response()
SAML 2 レスポンスの膨張およびデコードされた XML 表現を返します- 戻り値:
- SAML 2 レスポンスのインフレートおよびデコードされた XML 表現
getRecipientUri
@Deprecated public java.lang.String getRecipientUri()
使用すべきではありません。代わりにgetRelyingPartyRegistration().getAssertionConsumerServiceLocation()
を使用SAML 2 レスポンスオブジェクトが入った URI を返します- 戻り値:
- 文字列としての URI
getLocalSpEntityId
@Deprecated public java.lang.String getLocalSpEntityId()
使用すべきではありません。代わりにgetRelyingPartyRegistration().getEntityId()
を使用受信側の証明書利用者 SP の構成されたエンティティ ID を返します- 戻り値:
- 構成されたローカル依存パーティのエンティティ ID
getX509Credentials
@Deprecated public java.util.List<Saml2X509Credential> getX509Credentials()
使用すべきではありません。代わりにgetRelyingPartyRegistration()
を介して資格情報を取得します証明書利用者の構成に関連付けられているすべての資格情報を返します- 戻り値:
- 関連するすべての資格情報
isAuthenticated
public boolean isAuthenticated()
インターフェースからコピーされた説明:Authentication
認証トークンをAuthenticationManager
に提示する必要があるかどうかをAbstractSecurityInterceptor
に示すために使用されます。通常、AuthenticationManager
(または、より頻繁には、そのAuthenticationProvider
の 1 つ)は、認証が成功した後、不変の認証トークンを返します。この場合、トークンはtrue
をこのメソッドに安全に返すことができます。true
を返すとパフォーマンスが向上します。リクエストごとにAuthenticationManager
を呼び出す必要がなくなるためです。セキュリティ上の理由から、このインターフェースの実装は、不変であるか、元の作成以降プロパティが変更されていないことを保証する方法がない限り、このメソッドから
true
を返すことに十分注意する必要があります。- 次で指定:
- インターフェース
Authentication
のisAuthenticated
- オーバーライド:
- クラス
AbstractAuthenticationToken
のisAuthenticated
- 戻り値:
- false
setAuthenticated
public void setAuthenticated(boolean authenticated)
このオブジェクトの状態は変更できません。常に例外をスローします- 次で指定:
- インターフェース
Authentication
のsetAuthenticated
- オーバーライド:
- クラス
AbstractAuthenticationToken
のsetAuthenticated
- パラメーター:
authenticated
- 無視されました
getIdpEntityId
@Deprecated public java.lang.String getIdpEntityId()
使用すべきではありません。代わりにgetRelyingPartyRegistration().getAssertingPartyDetails().getEntityId()
を使用構成された IDP、アサーティングパーティ、エンティティ ID を返します- 戻り値:
- エンティティ ID を表す文字列
getAuthenticationRequest
public AbstractSaml2AuthenticationRequest getAuthenticationRequest()
認証リクエストが存在しない場合は、アサーションパーティまたはnull
に送信された認証リクエストを返します- 戻り値:
- アサーションパーティに送信された認証リクエスト
- 導入:
- 5.6