Compartilhar via


CookieHandlerElement.RequireSsl Property

[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 specifies whether the cookie should be used only with SSL.

Namespace: Microsoft.IdentityModel.Web.Configuration
Assembly: Microsoft.IdentityModel (in Microsoft.IdentityModel.dll)

Usage

'Usage
Dim instance As CookieHandlerElement
Dim value As Boolean

value = instance.RequireSsl

instance.RequireSsl = value

Syntax

'Declaration
<ConfigurationPropertyAttribute("requireSsl", IsRequired:=False, DefaultValue:=True)> _
Public Property RequireSsl As Boolean
[ConfigurationPropertyAttribute("requireSsl", IsRequired=false, DefaultValue=true)] 
public bool RequireSsl { get; set; }
[ConfigurationPropertyAttribute(L"requireSsl", IsRequired=false, DefaultValue=true)] 
public:
property bool RequireSsl {
    bool get ();
    void set (bool value);
}
/** @property */
public boolean get_RequireSsl ()

/** @property */
public void set_RequireSsl (boolean value)
public function get RequireSsl () : boolean

public function set RequireSsl (value : boolean)

Property Value

true if the cookie should only be used over an SSL connection; otherwise, false. The default is true.

Remarks

Controls whether the "Secure" flag is emitted for any cookies written. If this value is true, the sign-in session cookies will only be available over HTTPS.

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)

See Also

Reference

CookieHandlerElement Class
CookieHandlerElement Members
Microsoft.IdentityModel.Web.Configuration Namespace

Copyright © 2008 by Microsoft Corporation. All rights reserved.