SAML 用のアプリケーション・プログラミング・インターフェース (API) の概要
SAML 用の WebSphere® Application Server サポートは、SAML トークンを認識するアプリケーションのビルドに使用できる、共通アプリケーション・プログラミング・インターフェース (API) を提供しています。
SAML トークンの作成、検証、および認証 と、SAML トークンを表す JAAS サブジェクトの作成には、SAMLTokenFactory API を使用できます。 SAMLTokenFactory 実装は、OASIS SAML v1.1 トークン仕様 と OASIS SAML v2.0 トークン仕様の両方をサポートします。指定された STS への WS-Trust 要求メッセージの 送信、発行、および検証には、WSSTrustClient API を使用します。WSSTrustClient 実装は、 WS-Trust v1.3 仕様と WS-Trust v1.2 仕様の両方をサポートし、 SOAP v1.1 名前空間と SOAP v1.2 名前空間の両方をサポートします。
WSS API SAML サポートは、com.ibm.websphere.wssecurity.wssapi.token.SAMLTokenFactory インターフェースおよび com.ibm.websphere.wssecurity.wssapi.trust.WSSTrustClient インターフェースを補完します。 com.ibm.websphere.wssecurity.wssapi.WSSFactory newSecurityToken() メソッドを使用して生成される SAMLToken は、SAMLTokenFactory プログラミング・インターフェースおよび WSSTrustClient プログラミング・インターフェースによって処理できます。 一方、SAMLTokenFactory によって生成される SAMLToken または WSSTrustClient によって返される SAMLToken は、WSS API で使用できます。 アプリケーションでどの API を使用するか決定することは、特定のニーズによって異なります。 WSS API SAML サポートは、Web サービス・クライアント・アプリケーションに関する限り、SAMLTokenFactory インターフェースおよび WSSTrustClient インターフェースと同等の機能を提供するという点では、自己完結的です。SAMLTokenFactory インターフェースには、SAMLToken を検証し、認証された SAMLToken を表す JAAS サブジェクトを作成する追加機能があります。この検証は、 Web サービス・プロバイダー側で役に立ちます。SAMLToken を消費するようにアプリケーションを開発する場合、 SAMLTokenFactory プログラミング・インターフェースがより適しています。
SAML 対応の WebSphere Application Server は、 セキュリティー・トークンとして SAML を実装する、以下の API を 提供します。これらの API におけるメソッドについては、 SAML トークン・ライブラリー API 資料を参照してください。資料には、 各 API の説明とサンプル・コードが記載されています。
- com.ibm.websphere.wssecurity.wssapi.token.SAMLTokenFactory
- com.ibm.websphere.wssecurity.wssapi.token.SAMLToken
- com.ibm.wsspi.wssecurity.saml.data.SAMLAttribute
- com.ibm.wsspi.wssecurity.saml.data.SAMLNameID
- com.ibm.wsspi.wssecurity.saml.config.ConsumerConfig
- com.ibm.wsspi.wssecurity.saml.config.CredentialConfig
- com.ibm.wsspi.wssecurity.saml.config.ProviderConfig
- com.ibm.wsspi.wssecurity.saml.config.RequesterConfig
- com.ibm.wsspi.wssecurity.saml.config.SamlConstants
- com.ibm.wsspi.wssecurity.core.token.config.ConsumerConfiguration
- com.ibm.wsspi.wssecurity.core.token.config.CredentialConfiguration
- com.ibm.wsspi.wssecurity.core.token.config.ProviderConfiguration
- com.ibm.wsspi.wssecurity.core.token.config.RequesterConfiguration
- com.ibm.websphere.wssecurity.callbackhandler.SAMLConsumeCallback
- com.ibm.websphere.wssecurity.callbackhandler.SAMLConsumerCallbackHandler
- com.ibm.websphere.wssecurity.callbackhandler.SAMLGenerateCallback
- com.ibm.websphere.wssecurity.callbackhandler.SAMLGenerateCallbackHandler
- com.ibm.wsspi.wssecurity.wssapi.DOMStructure
- com.ibm.wsspi.wssecurity.wssapi.OMStructure
- com.ibm.websphere.wssecurity.wssapi.trust.WSSTrustClient
- com.ibm.websphere.wssecurity.wssapi.token.GenericSecurityToken
- com.ibm.wsspi.wssecurity.trust.config.ConsumerConfig
- com.ibm.wsspi.wssecurity.trust.config.ConsumerConfig.RSTR
- com.ibm.wsspi.wssecurity.trust.config.ProviderConfig
- com.ibm.wsspi.wssecurity.trust.config.RequesterConfig
- com.ibm.wsspi.wssecurity.core.token.config.WSSConstants
- com.ibm.wsspi.wssecurity.core.token.config.WSSConstants.Namespace
- com.ibm.wsspi.wssecurity.core.token.config.WSSConstants.TokenType
- com.ibm.wsspi.wssecurity.core.token.config.WSSConstants.WST12
- com.ibm.wsspi.wssecurity.core.token.config.WSSConstants.WST13
- com.ibm.wsspi.wssecurity.core.token.config.WSSConstants.Algorithm
- com.ibm.wsspi.wssecurity.core.token.config.WSSConstants.SAML
これらの API をいつ、どのように適用するのかを示す実用的なシナリオなど、API の使用に関する追加情報については、 『SAML の使用シナリオ』を参照してください。