Scope.SymmetricKeyEncryptionRequired Property

Article
10/05/2012

[Starting with the .NET Framework 4.5, Windows Identity Foundation (WIF) has been fully integrated into the .NET Framework. The version of WIF addressed by this topic, WIF 3.5, is deprecated and should only be used when developing against the .NET Framework 3.5 SP1 or the .NET Framework 4. For more information about WIF in the .NET Framework 4.5, also known as WIF 4.5, see the Windows Identity Foundation documentation in the .NET Framework 4.5 Development Guide.]

Gets or sets a value that indicates whether issued symmetric keys must be encrypted.

Namespace: Microsoft.IdentityModel.SecurityTokenService
Assembly: Microsoft.IdentityModel (in Microsoft.IdentityModel.dll)

Usage

'Usage
Dim instance As Scope
Dim value As Boolean

value = instance.SymmetricKeyEncryptionRequired

instance.SymmetricKeyEncryptionRequired = value

Syntax

'Declaration
Public Overridable Property SymmetricKeyEncryptionRequired As Boolean

public virtual bool SymmetricKeyEncryptionRequired { get; set; }

public:
virtual property bool SymmetricKeyEncryptionRequired {
    bool get ();
    void set (bool value);
}

/** @property */
public boolean get_SymmetricKeyEncryptionRequired ()

/** @property */
public void set_SymmetricKeyEncryptionRequired (boolean value)

public function get SymmetricKeyEncryptionRequired () : boolean

public function set SymmetricKeyEncryptionRequired (value : boolean)

Property Value

true if symmetric keys must be encrypted; otherwise, false. The default is true.

Remarks

If the SymmetricKeyEncryptionRequired property is true, symmetric keys are encrypted using the credentials in the EncryptingCredentials property.

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

Target Platforms

Windows 7, Windows Server 2008 R2, Windows Vista SP2, Windows Server 2008 SP2, Windows Server 2003 SP2 (32-bit or 64-bit)