DataProtectionSecurityStateEncoder Class


The .NET API Reference documentation has a new home. Visit the .NET API Browser on to see the new experience.

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


Initializes a new instance of this class.


Initializes a new instance of this class.

System_CAPS_pubmethodDataProtectionSecurityStateEncoder(Boolean, Byte[])

Initializes a new instance of this class.


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


This API supports the product infrastructure and is not intended to be used directly from your code. Decodes the security state.(Overrides SecurityStateEncoder.DecodeSecurityState(Byte[]).)


This API supports the product infrastructure and is not intended to be used directly from your code. Encodes the security state.(Overrides SecurityStateEncoder.EncodeSecurityState(Byte[]).)


Determines whether the specified object is equal to the current object.(Inherited from Object.)


Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)


Indicates the randomness of this encoder.


Serves as the default hash function. (Inherited from Object.)


Gets the Type of the current instance.(Inherited from Object.)


Creates a shallow copy of the current Object.(Inherited from Object.)


Returns 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
Available since 3.0

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

Return to top