SecurityTokenProvider クラス

定義

名前空間:

System.IdentityModel.Selectors

アセンブリ:

System.ServiceModel.Primitives.dll

パッケージ:

System.ServiceModel.Primitives v6.2.0

ソース:

SecurityTokenProvider.cs

SOAP メッセージ送信者のセキュリティ トークンを処理するセキュリティ トークン プロバイダーを表します。

public ref class SecurityTokenProvider abstract

public abstract class SecurityTokenProvider

type SecurityTokenProvider = class

Public MustInherit Class SecurityTokenProvider

継承

Object

SecurityTokenProvider

派生

System.IdentityModel.Selectors.KerberosSecurityTokenProvider

System.IdentityModel.Selectors.UserNameSecurityTokenProvider

System.IdentityModel.Selectors.X509SecurityTokenProvider

System.ServiceModel.Federation.WSTrustChannelSecurityTokenProvider

System.ServiceModel.Security.SimpleSecurityTokenProvider

System.ServiceModel.Security.SspiSecurityTokenProvider

System.ServiceModel.Security.Tokens.IssuedSecurityTokenProvider

例

using System;

using System.IdentityModel.Selectors;
using System.IdentityModel.Tokens;

using System.IO;

using System.ServiceModel.Security;

using System.Xml;

namespace Microsoft.ServiceModel.Samples
{
    /// <summary>
    /// class that derives from SecurityTokenProvider and returns a SecurityToken representing a SAML assertion
    /// </summary>
    public class SamlSecurityTokenProvider : SecurityTokenProvider
    {
        /// <summary>
        /// The SAML assertion that the SamlSecurityTokenProvider will return as a SecurityToken
        /// </summary>
        SamlAssertion assertion;

        /// <summary>
        /// The proof token associated with the SAML assertion
        /// </summary>
        SecurityToken proofToken;

        /// <summary>
        /// Constructor
        /// </summary>
        /// <param name="assertion">The SAML assertion that the SamlSecurityTokenProvider will return as a SecurityToken</param>
        /// <param name="proofToken">The proof token associated with the SAML assertion</param>
        public SamlSecurityTokenProvider(SamlAssertion assertion, SecurityToken proofToken )
        {
            this.assertion = assertion;
            this.proofToken = proofToken;
        }

        /// <summary>
        /// Creates the security token
        /// </summary>
        /// <param name="timeout">Maximum amount of time the method is supposed to take. Ignored in this implementation.</param>
        /// <returns>A SecurityToken corresponding the SAML assertion and proof key specified at construction time</returns>
        protected override SecurityToken GetTokenCore(TimeSpan timeout)
        {
            // Create a SamlSecurityToken from the provided assertion
            SamlSecurityToken samlToken = new SamlSecurityToken(assertion);

            // Create a SecurityTokenSerializer that will be used to serialize the SamlSecurityToken
            WSSecurityTokenSerializer ser = new WSSecurityTokenSerializer();

            // Create a memory stream to write the serialized token into
            // Use an initial size of 64Kb
            MemoryStream s = new MemoryStream(UInt16.MaxValue);

            // Create an XmlWriter over the stream
            XmlWriter xw = XmlWriter.Create(s);

            // Write the SamlSecurityToken into the stream
            ser.WriteToken(xw, samlToken);

            // Seek back to the beginning of the stream
            s.Seek(0, SeekOrigin.Begin);

            // Load the serialized token into a DOM
            XmlDocument dom = new XmlDocument();
            dom.Load(s);

            // Create a KeyIdentifierClause for the SamlSecurityToken
            SamlAssertionKeyIdentifierClause samlKeyIdentifierClause = samlToken.CreateKeyIdentifierClause<SamlAssertionKeyIdentifierClause>();

            // Return a GenericXmlToken from the XML for the SamlSecurityToken, the proof token, the valid from
            // and valid until times from the assertion and the key identifier clause created above
            return new GenericXmlSecurityToken(dom.DocumentElement, proofToken, assertion.Conditions.NotBefore, assertion.Conditions.NotOnOrAfter, samlKeyIdentifierClause, samlKeyIdentifierClause, null);
        }
    }
}

Imports System.IdentityModel.Selectors
Imports System.IdentityModel.Tokens

Imports System.IO

Imports System.ServiceModel.Security

Imports System.Xml


'/ <summary>
'/ class that derives from SecurityTokenProvider and returns a SecurityToken representing a SAML assertion
'/ </summary>

Public Class SamlSecurityTokenProvider
    Inherits SecurityTokenProvider
    '/ <summary>
    '/ The SAML assertion that the SamlSecurityTokenProvider will return as a SecurityToken
    '/ </summary>
    Private assertion As SamlAssertion

    '/ <summary>
    '/ The proof token associated with the SAML assertion
    '/ </summary>
    Private proofToken As SecurityToken


    '/ <summary>
    '/ Constructor
    '/ </summary>
    '/ <param name="assertion">The SAML assertion that the SamlSecurityTokenProvider will return as a SecurityToken</param>
    '/ <param name="proofToken">The proof token associated with the SAML assertion</param>
    Public Sub New(ByVal assertion As SamlAssertion, ByVal proofToken As SecurityToken)
        Me.assertion = assertion
        Me.proofToken = proofToken

    End Sub


    '/ <summary>
    '/ Creates the security token
    '/ </summary>
    '/ <param name="timeout">Maximum amount of time the method is supposed to take. Ignored in this implementation.</param>
    '/ <returns>A SecurityToken corresponding the SAML assertion and proof key specified at construction time</returns>
    Protected Overrides Function GetTokenCore(ByVal timeout As TimeSpan) As SecurityToken
        ' Create a SamlSecurityToken from the provided assertion
        Dim samlToken As New SamlSecurityToken(assertion)

        ' Create a SecurityTokenSerializer that will be used to serialize the SamlSecurityToken
        Dim ser As New WSSecurityTokenSerializer()

        ' Create a memory stream to write the serialized token into
        ' Use an initial size of 64Kb
        Dim s As New MemoryStream(UInt16.MaxValue)

        ' Create an XmlWriter over the stream
        Dim xw As XmlWriter = XmlWriter.Create(s)

        ' Write the SamlSecurityToken into the stream
        ser.WriteToken(xw, samlToken)

        ' Seek back to the beginning of the stream
        s.Seek(0, SeekOrigin.Begin)

        ' Load the serialized token into a DOM
        Dim dom As New XmlDocument()
        dom.Load(s)

        ' Create a KeyIdentifierClause for the SamlSecurityToken
        Dim samlKeyIdentifierClause As SamlAssertionKeyIdentifierClause = samlToken.CreateKeyIdentifierClause(Of SamlAssertionKeyIdentifierClause)()
        
        ' Return a GenericXmlToken from the XML for the SamlSecurityToken, the proof token, the valid from 
        ' and valid until times from the assertion and the key identifier clause created above            
        Return New GenericXmlSecurityToken(dom.DocumentElement, proofToken, assertion.Conditions.NotBefore, assertion.Conditions.NotOnOrAfter, samlKeyIdentifierClause, samlKeyIdentifierClause, Nothing)

    End Function 'GetTokenCore
End Class

注釈

カスタム セキュリティ トークンが必要な場合、SecurityTokenProvider クラスを使用します。 セキュリティ トークン プロバイダーは、クライアントから SOAP メッセージが送信されたときにセキュリティ トークンを取得する機能を果たします。セキュリティ トークンはクライアントの認証や SOAP メッセージの保護に使用されます。 具体的には、GetToken メソッドは、セキュリティ トークンを取得するために、呼び出されます。 CancelToken メソッドや RenewToken メソッドを使用してセキュリティ トークン プロバイダーを呼び出し、セキュリティのキャンセルや更新を行うこともできます。

SecurityTokenManager クラスの派生クラスは、CreateSecurityTokenProvider メソッドを実装して、特定のセキュリティ トークンにどのセキュリティ トークン プロバイダーが必要かであるのかを確認します。

ClientCredentialsSecurityTokenManager クラスおよび ServiceCredentialsSecurityTokenManager クラスには、組み込みのセキュリティ トークンの種類の既定の実装が用意されています。 カスタム セキュリティ トークン シナリオでは、SecurityTokenManager、ClientCredentialsSecurityTokenManager、または ServiceCredentialsSecurityTokenManager クラスのいずれかの派生クラスを作成し、カスタム セキュリティ トークンのセキュリティ トークン プロバイダーの作成、セキュリティ トークンの認証、およびセキュリティ トークンのシリアル化の機能を実装する必要があります。 カスタム トークンの作成の詳細については、「 方法: カスタム トークンを作成する」を参照してください。

コンストラクター

SecurityTokenProvider()

SecurityTokenProvider クラスの新しいインスタンスを初期化します。

プロパティ

SupportsTokenCancellation	セキュリティ トークンをキャンセルできるかどうかを示す値を取得します。
SupportsTokenRenewal	セキュリティ トークンを更新できるかどうかを示す値を取得します。

メソッド

BeginCancelToken(TimeSpan, SecurityToken, AsyncCallback, Object)	非同期の操作によるセキュリティ トークンのキャンセルを開始します。
BeginCancelTokenCore(TimeSpan, SecurityToken, AsyncCallback, Object)	非同期の操作によるセキュリティ トークンのキャンセルを開始します。
BeginGetToken(TimeSpan, AsyncCallback, Object)	非同期の操作によるセキュリティ トークンの取得を開始します。
BeginGetTokenCore(TimeSpan, AsyncCallback, Object)	非同期の操作によるセキュリティ トークンの取得を開始します。
BeginRenewToken(TimeSpan, SecurityToken, AsyncCallback, Object)	非同期の操作によるセキュリティ トークンの更新を開始します。
BeginRenewTokenCore(TimeSpan, SecurityToken, AsyncCallback, Object)	非同期の操作によるセキュリティ トークンの更新を開始します。
CancelToken(TimeSpan, SecurityToken)	セキュリティ トークンをキャンセルします。
CancelTokenAsync(TimeSpan, SecurityToken)	セキュリティ トークンをキャンセルします。
CancelTokenCore(TimeSpan, SecurityToken)	セキュリティ トークンをキャンセルします。
CancelTokenCoreAsync(TimeSpan, SecurityToken)	セキュリティ トークンをキャンセルします。
EndCancelToken(IAsyncResult)	非同期の操作によるセキュリティ トークンのキャンセルを完了します。
EndCancelTokenCore(IAsyncResult)	非同期の操作によるセキュリティ トークンのキャンセルを完了します。
EndGetToken(IAsyncResult)	非同期の操作によるセキュリティ トークンの取得を完了します。
EndGetTokenCore(IAsyncResult)	非同期の操作によるセキュリティ トークンの取得を完了します。
EndRenewToken(IAsyncResult)	非同期の操作によるセキュリティ トークンの更新を完了します。
EndRenewTokenCore(IAsyncResult)	非同期の操作によるセキュリティ トークンの更新を完了します。
Equals(Object)	指定されたオブジェクトが現在のオブジェクトと等しいかどうかを判断します。 (継承元 Object)
GetHashCode()	既定のハッシュ関数として機能します。 (継承元 Object)
GetToken(TimeSpan)	セキュリティ トークンを取得します。
GetTokenAsync(TimeSpan)	セキュリティ トークンを取得します。
GetTokenCore(TimeSpan)	セキュリティ トークンを取得します。
GetTokenCoreAsync(TimeSpan)	セキュリティ トークンを取得します。
GetType()	現在のインスタンスの Type を取得します。 (継承元 Object)
MemberwiseClone()	現在の Object の簡易コピーを作成します。 (継承元 Object)
RenewToken(TimeSpan, SecurityToken)	セキュリティ トークンを更新します。
RenewTokenAsync(TimeSpan, SecurityToken)	セキュリティ トークンを更新します。
RenewTokenCore(TimeSpan, SecurityToken)	セキュリティ トークンを更新します。
RenewTokenCoreAsync(TimeSpan, SecurityToken)	セキュリティ トークンを更新します。
ToString()	現在のオブジェクトを表す文字列を返します。 (継承元 Object)

こちらもご覧ください

• SecurityTokenManager
• SecurityTokenAuthenticator
• 方法: カスタム トークンを作成する