クラス RelyingPartyRegistration
java.lang.ObjectSE
org.springframework.security.saml2.provider.service.registration.RelyingPartyRegistration
- 実装済みのインターフェース一覧:
SerializableSE
構成済みの証明書利用者(別名サービスプロバイダー)とアサーティングパーティー(別名 ID プロバイダー)のペアを表します。
各 RP/AP ペアは、任意の文字列である registrationId を使用して一意に識別されます。
完全に構成された登録は次のようになります。
String registrationId = "simplesamlphp";
String relyingPartyEntityId = "{baseUrl}/saml2/service-provider-metadata/{registrationId}";
String assertingConsumerServiceLocation = "{baseUrl}/login/saml2/sso/{registrationId}";
Saml2X509Credential relyingPartySigningCredential = ...;
String assertingPartyEntityId = "https://simplesaml-for-spring-saml.apps.pcfone.io/saml2/idp/metadata.php";
String singleSignOnServiceLocation = "https://simplesaml-for-spring-saml.apps.pcfone.io/saml2/idp/SSOService.php";
Saml2X509Credential assertingPartyVerificationCredential = ...;
RelyingPartyRegistration rp = RelyingPartyRegistration.withRegistrationId(registrationId)
.entityId(relyingPartyEntityId)
.assertionConsumerServiceLocation(assertingConsumerServiceLocation)
.signingX509Credentials((c) -> c.add(relyingPartySigningCredential))
.assertingPartyMetadata((metadata) -> metadata
.entityId(assertingPartyEntityId));
.singleSignOnServiceLocation(singleSignOnServiceLocation))
.verifyingX509Credentials((c) -> c.add(assertingPartyVerificationCredential))
.build();
- 導入:
- 5.2
- 関連事項:
ネストされたクラスの概要
ネストされたクラス修飾子と型クラス説明static classアサーティングパーティの構成メタデータstatic classコンストラクター概要
コンストラクター修飾子コンストラクター説明protectedRelyingPartyRegistration(StringSE registrationId, StringSE entityId, StringSE assertionConsumerServiceLocation, Saml2MessageBinding assertionConsumerServiceBinding, StringSE singleLogoutServiceLocation, StringSE singleLogoutServiceResponseLocation, CollectionSE<Saml2MessageBinding> singleLogoutServiceBindings, RelyingPartyRegistration.AssertingPartyDetails assertingPartyDetails, StringSE nameIdFormat, boolean authnRequestsSigned, CollectionSE<Saml2X509Credential> decryptionX509Credentials, CollectionSE<Saml2X509Credential> signingX509Credentials) 方法の概要
修飾子と型メソッド説明アサーティングパーティのメタデータを取得するAssertionConsumerService バインディングを取得します。AssertionConsumerService の場所を取得します。この証明書利用者に関連付けられている復号化Saml2X509CredentialのCollectionSE を取得します証明書利用者の EntityID を取得します。NameID 形式を取得します。この RP/AP ペアの一意の登録 ID を取得しますこの証明書利用者に関連付けられたSaml2X509Credentialの署名のCollectionSE を取得しますbooleanAuthnRequestsSigned の設定を取得します。mutate()このRelyingPartyRegistrationのプロパティをRelyingPartyRegistration.Builderにコピーしますアサーション側のエンティティ ID と同等のregistrationIdを持つRelyingPartyRegistrationRelyingPartyRegistration.Builderを作成します。withRegistrationId(StringSE registrationId)
コンストラクターの詳細
RelyingPartyRegistration
protected RelyingPartyRegistration(StringSE registrationId, StringSE entityId, StringSE assertionConsumerServiceLocation, Saml2MessageBinding assertionConsumerServiceBinding, StringSE singleLogoutServiceLocation, StringSE singleLogoutServiceResponseLocation, CollectionSE<Saml2MessageBinding> singleLogoutServiceBindings, RelyingPartyRegistration.AssertingPartyDetails assertingPartyDetails, StringSE nameIdFormat, boolean authnRequestsSigned, CollectionSE<Saml2X509Credential> decryptionX509Credentials, CollectionSE<Saml2X509Credential> signingX509Credentials)
メソッドの詳細
mutate
このRelyingPartyRegistrationのプロパティをRelyingPartyRegistration.Builderにコピーします- 戻り値:
- この
RelyingPartyRegistrationのプロパティに基づくRelyingPartyRegistration.Builder - 導入:
- 6.1
getRegistrationId
この RP/AP ペアの一意の登録 ID を取得します- 戻り値:
- この RP/AP ペアの一意の登録 ID
getEntityId
証明書利用者の EntityID を取得します。証明書利用者の <EntityDescriptor EntityID="..." /> にある値に相当します
この値には、使用する前に解決する必要のあるいくつかのプレースホルダーが含まれている場合があります。それらは
baseUrl、registrationId、baseScheme、baseHost、basePortです。- 戻り値:
- 依存パーティの EntityID
- 導入:
- 5.4
getAssertionConsumerServiceLocation
AssertionConsumerService の場所を取得します。証明書利用者の <SPSSODescriptor> の <AssertionConsumerService Location="..." /> にある値に相当します。この値には、使用する前に解決する必要のあるいくつかのプレースホルダーが含まれている場合があります。それらはbaseUrl、registrationId、baseScheme、baseHost、basePortです。- 戻り値:
- AssertionConsumerService ロケーション
- 導入:
- 5.4
getAssertionConsumerServiceBinding
AssertionConsumerService バインディングを取得します。証明書利用者の <SPSSODescriptor> の <AssertionConsumerService Binding="..." /> にある値に相当します。- 戻り値:
- AssertionConsumerService バインディング
- 導入:
- 5.4
getSingleLogoutServiceBinding
SingleLogoutService バインディングを入手する証明書利用者の <SPSSODescriptor> の <SingleLogoutService Binding="..." /> にある値に相当します。
- 戻り値:
- SingleLogoutService バインディング
- 導入:
- 5.6
getSingleLogoutServiceBindings
SingleLogoutService バインディングを入手する証明書利用者の <SPSSODescriptor> の <SingleLogoutService Binding="..." /> にある値に相当します。
- 戻り値:
- SingleLogoutService バインディング
- 導入:
- 5.8
getSingleLogoutServiceLocation
SingleLogoutService の場所を入手する証明書利用者の <SPSSODescriptor> の <SingleLogoutService Location="..." /> にある値に相当します。
- 戻り値:
- SingleLogoutService ロケーション
- 導入:
- 5.6
getSingleLogoutServiceResponseLocation
SingleLogoutService レスポンス場所を入手する証明書利用者の <SPSSODescriptor> の <SingleLogoutService ResponseLocation="..." /> にある値に相当します。
- 戻り値:
- SingleLogoutService レスポンス位置
- 導入:
- 5.6
getNameIdFormat
NameID 形式を取得します。- 戻り値:
- NameID 形式
- 導入:
- 5.7
isAuthnRequestsSigned
public boolean isAuthnRequestsSigned()AuthnRequestsSigned の設定を取得します。trueの場合、依存当事者は、アサーティング当事者の優先順位に関係なく、すべての AuthnRequests に署名します。isAuthnRequestsSigned()がtrueであるか、RelyingPartyRegistration.AssertingPartyDetails.getWantAuthnRequestsSigned()がtrueである場合、Spring Security はリクエストに署名することに注意してください。- 戻り値:
- 証明書利用者の優先順位
- 導入:
- 6.1
getDecryptionX509Credentials
この証明書利用者に関連付けられている復号化Saml2X509CredentialのCollectionSE を取得します- 戻り値:
- この依拠当事者に関連付けられた復号化
Saml2X509CredentialのCollectionSE - 導入:
- 5.4
getSigningX509Credentials
この証明書利用者に関連付けられたSaml2X509Credentialの署名のCollectionSE を取得します- 戻り値:
- この依拠当事者に関連付けられた
Saml2X509Credentialの署名のCollectionSE - 導入:
- 5.4
getAssertingPartyMetadata
アサーティングパーティのメタデータを取得する- 戻り値:
AssertingPartyMetadata- 導入:
- 6.4
withRegistrationId
- パラメーター:
registrationId-RelyingPartyRegistrationの文字列識別子- 戻り値:
-
RelyingPartyRegistrationオブジェクトを作成するBuilder
withAssertingPartyMetadata
public static RelyingPartyRegistration.Builder withAssertingPartyMetadata(AssertingPartyMetadata metadata) アサーション側のエンティティ ID と同等のregistrationIdを持つRelyingPartyRegistrationRelyingPartyRegistration.Builderを作成します。また、指定されたAssertingPartyMetadataの内容に初期化します。- パラメーター:
metadata-RelyingPartyRegistrationRelyingPartyRegistration.Builderを初期化するために使用されるメタデータ- 戻り値:
RelyingPartyRegistration.BuilderはRelyingPartyRegistrationオブジェクトを作成します- 導入:
- 6.4