Share via

KeyInfoHelper Class

  • Article

Provides a method for deserializing a <KeyInfo> XML element.

Namespace: Microsoft.Web.Services3.Security
Assembly: Microsoft.Web.Services3 (in microsoft.web.services3.dll)

Usage

'Usage
Dim keyInfoHelper1 As KeyInfoHelper

Syntax

'Declaration
NotInheritable Public Class KeyInfoHelper

public sealed class KeyInfoHelper

public ref class KeyInfoHelper sealed

public final class KeyInfoHelper

public class KeyInfoHelper

Remarks

The LoadXmlKeyInfo method deserializes a <KeyInfo> element into a KeyInfo object. The <KeyInfo> XML element is used to specify either a security token type or a specific security token within a SOAP message. So, <KeyInfo> elements are a part of SOAP messages with WS-Security SOAP headers.

The list of elements that can be children of the <KeyInfo> element is dependent upon what is registered on the computer, with the exception of the <SecurityTokenReference> element. The <SecurityTokenReference> element is explicitly defined in the WS-Security specification, so it is supported. WSE also uses the model for loading <KeyInfo> elements that is defined by the System.Security.Cryptography.Xml.KeyInfo and System.Security.Cryptography.Xml.KeyInfoClause classes. Therefore, it is possible to extend the support for all security token managers by registering a custom KeyInfo clause.

It is also possible to extend the list of supported <KeyInfo> child elements separately for each security token manager. To do so, build and configure a custom security token manager that overrides the LoadTokenFromKeyInfo method to parse <KeyInfo> elements with your custom child elements. WSE calls the LoadTokenFromKeyInfo method for all native and configured security token managers when it receives a SOAP message containing a <KeyInfo> element until it finds one that can parse it. For more details about building a custom security token manager, see How to: Create a Security Token Manager for a Custom Security Token.

Inheritance Hierarchy

System.Object
  Microsoft.Web.Services3.Security.KeyInfoHelper

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

Windows XP Home Edition, Windows XP Professional, Windows Server 2003, Windows 2000, Windows 2000 Server, Windows 2000 Advanced Server

Target Platforms

See Also

Reference

KeyInfoHelper Members
Microsoft.Web.Services3.Security Namespace
LoadXmlKeyInfo
KeyInfo

Other Resources

How to: Create a Security Token Manager for a Custom Security Token