Roles.CookieRequireSSL Property (System.Web.Security)

CookieRequireSSL Property

Switch on low bandwidth view

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:

.NET Framework Class Library

Roles..::.CookieRequireSSL Property

Gets a value indicating whether the role names cookie requires SSL in order to be returned to the server.

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

Syntax

Visual Basic (Declaration)

Public Shared ReadOnly Property CookieRequireSSL As Boolean

Visual Basic (Usage)

Dim value As Boolean

value = Roles.CookieRequireSSL

public static bool CookieRequireSSL { get; }

Visual C++

public:
static property bool CookieRequireSSL {
    bool get ();
}

JScript

public static function get CookieRequireSSL () : boolean

Property Value

Type: System..::.Boolean
true if SSL is required to return the role names cookie to the server; otherwise, false. The default is false.

Remarks

You can specify whether SSL (Secure Sockets Layer) is required to return the role names cookie to the server in your application by setting the cookieRequireSSL attribute in the Web.config file for your ASP.NET application. For more information, see Secure.

Examples

The following example shows the roleManager element in the system.web section of the Web.config file for an ASP.NET application. It specifies that the application uses a SqlRoleProvider instance and sets cookieRequireSSL to true.

<roleManager defaultProvider="SqlProvider" 
  enabled="true"
  cacheRolesInCookie="true"
  cookieName=".ASPROLES"
  cookieTimeout="30"
  cookiePath="/MyApplication"
  cookieRequireSSL="true"
  cookieSlidingExpiration="true"
  cookieProtection="Encrypted" >
  <providers>
    <add
      name="SqlProvider"
      type="System.Web.Security.SqlRoleProvider"
      connectionStringName="SqlServices"
      applicationName="MyApplication" />
  </providers>
</roleManager>

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

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

Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0

Reference

Roles Class

Roles Members

System.Web.Security Namespace

Other Resources

Understanding Role Management