This documentation is archived and is not being maintained.

DataProtectionSecurityStateEncoder Class

Provides encoding and decoding mechanisms for the security state using the Windows DataProtection API functionality.


Namespace:  System.ServiceModel.Security
Assembly:  System.ServiceModel (in System.ServiceModel.dll)

public class DataProtectionSecurityStateEncoder : SecurityStateEncoder

The DataProtectionSecurityStateEncoder type exposes the following members.

Public methodDataProtectionSecurityStateEncoder()Initializes a new instance of this class.
Public methodDataProtectionSecurityStateEncoder(Boolean)Initializes a new instance of this class.
Public methodDataProtectionSecurityStateEncoder(Boolean, Byte[])Initializes a new instance of this class.

Public propertyUseCurrentUserProtectionScopeGets a value that indicates whether to use the current user protection scope.

Protected methodDecodeSecurityStateInfrastructure. Decodes the security state. (Overrides SecurityStateEncoder.DecodeSecurityState(Byte[]).)
Protected methodEncodeSecurityStateInfrastructure. Encodes the security state. (Overrides SecurityStateEncoder.EncodeSecurityState(Byte[]).)
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetEntropyIndicates the randomness of this encoder.
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current DataProtectionSecurityStateEncoder instance. (Overrides Object.ToString().)

This class is used for encoding the security state as represented by a Stateful Security Context Token when the message is sent, and for decoding the security context when the message arrives at a recipient.

The encoding can either be in the current user scope (whereby only processes running as the user account can decode the security state) or it can be in the local machine scope (whereby all processes running on the machine can decode the security state). By default, the encoding is in the current user scope.

This class is used by the server when sending the security state in the Stateful Security Context Token issued to the client.

DataProtection based on the CurrentUser scope requires the current user to have a user profile. If the user has a roaming profile, then the security state encoded by the user process running on one machine can be decoded by a user process running on a different machine.

.NET Framework

Supported in: 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

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