SecurityTokenHandler クラス

  • リファレンス

定義

名前空間:
System.IdentityModel.Tokens
アセンブリ:
System.IdentityModel.dll

セキュリティ トークン ハンドラーの抽象基本クラス。

public ref class SecurityTokenHandler abstract : System::IdentityModel::Configuration::ICustomIdentityConfiguration
public abstract class SecurityTokenHandler : System.IdentityModel.Configuration.ICustomIdentityConfiguration
type SecurityTokenHandler = class
    interface ICustomIdentityConfiguration
Public MustInherit Class SecurityTokenHandler
Implements ICustomIdentityConfiguration
継承
Object
SecurityTokenHandler
派生
実装
ICustomIdentityConfiguration

例

すべてのトピックのコード例は、 SecurityTokenHandler サンプルから取り上 Custom Token げます。 このサンプルでは、Simple Web Tokens (SWT) の処理を有効にするカスタム クラスを提供します。 WIF で使用できるこのサンプルとその他のサンプルの詳細と、それらをダウンロードする場所については、「 WIF コード サンプル インデックス」を参照してください。 次の XML は、SWT トークン ハンドラーをトークン ハンドラー コレクションに追加する方法を示しています。

<system.identityModel>
  <identityConfiguration saveBootstrapContext="true">
    <issuerTokenResolver type="SimpleWebToken.CustomIssuerTokenResolver, SimpleWebToken">
      <AddAudienceKeyPair  symmetricKey="wAVkldQiFypTQ+kdNdGWCYCHRcee8XmXxOvgmak8vSY=" audience="http://localhost:19851/" />
    </issuerTokenResolver>
    <issuerNameRegistry type="RelyingParty.TrustedIssuerNameRegistry, RelyingParty"/>
    <audienceUris>
      <add value="http://localhost:19851/"/>
    </audienceUris>
    <securityTokenHandlers>
      <add type="SimpleWebToken.SimpleWebTokenHandler, SimpleWebToken" />
    </securityTokenHandlers>
  </identityConfiguration>
</system.identityModel>

注釈

クラスは SecurityTokenHandler 、すべてのセキュリティ トークン ハンドラーの派生元となる基本クラスです。 セキュリティ トークン ハンドラーは、次のことを担当します。

  • トークンに含まれる要求を処理してオブジェクトにパッケージ化するように設計された型のセキュリティ トークン ClaimsIdentity (SecurityToken) を検証します。

  • 処理するように設計された型のセキュリティ トークンのシリアル化と逆シリアル化。

  • 要素との間で処理するように設計された型のトークンを参照するキー識別子句 (SecurityKeyIdentifierClause) のシリアル化と <wsse:SecurityTokenReference> 逆シリアル化。

  • クラスの実装によって渡されるオブジェクトから SecurityTokenDescriptor セキュリティ トークンを SecurityTokenService 作成する。

  • クラスの実装用のセキュリティ トークンからキー識別子句を SecurityTokenService 作成する。

Windows Identity Foundation (WIF) には、次のセキュリティ トークン ハンドラーがすぐに付属しています。

これらのクラスのほとんどは、クラスが設計されているトークンの処理に固有の機能を実装する追加のメンバーを公開します。 多くの場合、 クラスから直接ではなく、これらのクラスの 1 つから SecurityTokenHandler 派生することをお勧めします。

セキュリティ トークン ハンドラーは、構成ファイルの securityTokenHandlers> 要素の下に<add>、remove、または clear 要素を<指定することで、トークン ハンドラー コレクションに追加または<削除できます。>>< ハンドラー コレクションの構成設定を含む オブジェクトには SecurityTokenHandlerConfiguration 、 プロパティを Configuration 使用してアクセスでき、トークン ハンドラーがメンバーであるハンドラー コレクションには、 プロパティから ContainingCollection アクセスできます。 メソッドを LoadCustomConfiguration オーバーライドして、ハンドラーが受け取るカスタム構成要素を処理できます。

クラスは SecurityTokenHandler 、他のいくつかのプロパティとメソッドを公開します。 実装する機能によっては、これらのメンバーの一部またはすべてをオーバーライドできます。

クラスが TokenType 処理するように設計されているセキュリティ トークンの種類に関する情報を WIF インフラストラクチャに提供するには、 プロパティと GetTokenTypeIdentifiers メソッドをオーバーライドする必要があります。

検証、シリアル化、逆シリアル化の機能は、ハンドラーが機能を実装するメソッドまたはメソッドと組み合わせて特定の関数を実行できるかどうかを示すプロパティまたはメソッドを介して公開されます。 次の一覧では、機能を示すプロパティまたはメソッドと、その機能を実装するメソッドのペアを示します。

CreateTokenメソッドと CreateSecurityTokenReference メソッドは、 クラスの実装SecurityTokenServiceでパイプラインから呼び出されます。

メソッドは DetectReplayedToken WIF インフラストラクチャによって呼び出され、指定されたトークンが既に受信されているかどうかを判断します。 既定では、このメソッドは を返 falseします。これは、トークンがまだ受信されていないことを示します。 メソッドをオーバーライドし、再生されたトークンを検出するロジックを提供できます。

コンストラクター

SecurityTokenHandler()

SecurityTokenHandler クラスを初期化するために、派生クラスのコンストラクターから呼び出されます。

プロパティ

CanValidateToken

ハンドラーが、セキュリティ トークンの検証をサポートするかどうかを示す値を取得します。
CanWriteToken

ハンドラーが、セキュリティ トークンをシリアル化できるかどうかを示す値を取得します。
Configuration

現在のインスタンスの構成を提供する SecurityTokenHandlerConfiguration オブジェクトを取得または設定します。
ContainingCollection

現在のインスタンスを含むトークン ハンドラー コレクションを取得します。
TokenType

派生クラスでオーバーライドされると、このインスタンスで処理されるセキュリティ トークンの型を取得します。

メソッド

CanReadKeyIdentifierClause(XmlReader)

指定した XML リーダーによって参照される XML 要素が、このインスタンスによって逆シリアル化できるキー識別子節であるかどうかを示す値を返します。
CanReadToken(String)

指定した文字列が、このインスタンスが処理する型のトークンとして逆シリアル化できるかどうかを示す値を返します。
CanReadToken(XmlReader)

指定した XML リーダーによって参照される XML 要素が、このインスタンスによって処理される型のトークンとして読み取ることができるかどうかを示す値を返します。
CanWriteKeyIdentifierClause(SecurityKeyIdentifierClause)

指定したキー識別子句をこのインスタンスでシリアル化できるかどうかを示す値を返します。
CreateSecurityTokenReference(SecurityToken, Boolean)

派生クラスでオーバーライドされると、そのクラスによって処理されるトークンのセキュリティ トークン参照を作成します。 このメソッドは、通常、セキュリティ トークン サービス (STS) によって呼び出されます。
CreateToken(SecurityTokenDescriptor)

派生クラスでオーバーライドされると、指定されたトークン記述子を使用してセキュリティ トークンを作成します。 このメソッドは、セキュリティ トークン サービス (STS) によって呼び出されます。
DetectReplayedToken(SecurityToken)

派生クラスでオーバーライドされると、指定したトークンが再生中に検出された場合に例外をスローします。
Equals(Object)

指定されたオブジェクトが現在のオブジェクトと等しいかどうかを判断します。

(継承元 Object)
GetHashCode()

既定のハッシュ関数として機能します。

(継承元 Object)
GetTokenTypeIdentifiers()

派生クラスでオーバーライドされると、派生クラスによって処理される型のトークンを識別するために要求で使用される URI のセットを返します。
GetType()

現在のインスタンスの Type を取得します。

(継承元 Object)
LoadCustomConfiguration(XmlNodeList)

派生クラスでオーバーライドされると、XML からカスタム構成を読み込みます。
MemberwiseClone()

現在の Object の簡易コピーを作成します。

(継承元 Object)
ReadKeyIdentifierClause(XmlReader)

派生クラスでオーバーライドされると、指定された XML リーダーによって参照される XML を、派生クラスによって処理されるトークンを参照するキー識別句に逆シリアル化します。
ReadToken(String)

派生クラスでオーバーライドされると、派生クラスによって処理される型のトークンに指定の文字列を逆シリアル化します。
ReadToken(XmlReader)

派生クラスでオーバーライドされると、指定された XML リーダーによって参照される XML を、派生クラスによって処理される型のトークンに逆シリアル化します。
ReadToken(XmlReader, SecurityTokenResolver)

派生クラスでオーバーライドされると、指定された XML リーダーによって参照される XML を、指定のトークン リゾルバーを使用して派生クラスによって処理される型のトークンに逆シリアル化します。
ToString()

現在のオブジェクトを表す文字列を返します。

(継承元 Object)
TraceTokenValidationFailure(SecurityToken, String)

トレースが有効であるとき、セキュリティ トークンの検証中、障害イベントをトレースします。
TraceTokenValidationSuccess(SecurityToken)

トレースが有効であるとき、セキュリティ トークン イベントの検証の成功をトレースします。
ValidateToken(SecurityToken)

派生クラスでオーバーライドされると、指定されたセキュリティ トークンを検証します。 トークンは、派生クラスによって処理される種類である必要があります。
WriteKeyIdentifierClause(XmlWriter, SecurityKeyIdentifierClause)

派生クラスでオーバーライドされると、指定されたキー識別句を XML にシリアル化します。 キー識別句は、派生クラスでサポートされているタイプにする必要があります。
WriteToken(SecurityToken)

派生クラスでオーバーライドされると、指定されたセキュリティ トークンを文字列にシリアル化します。 トークンは、派生クラスによって処理される種類である必要があります。
WriteToken(XmlWriter, SecurityToken)

派生クラスでオーバーライドされると、指定されたセキュリティ トークンを XML にシリアル化します。 トークンは、派生クラスによって処理される種類である必要があります。

適用対象

こちらもご覧ください