FormsAuthenticationTicket 类

参考

定义

命名空间:: System.Web.Security

程序集:: System.Web.dll

重要

一些信息与预发行产品相关，相应产品在发行之前可能会进行重大修改。对于此处提供的信息，Microsoft 不作任何明示或暗示的担保。

提供对票证的属性和值的访问，这些票证用于 Forms 身份验证对用户进行标识。此类不能被继承。

public ref class FormsAuthenticationTicket sealed

[System.Serializable]
public sealed class FormsAuthenticationTicket

[<System.Serializable>]
type FormsAuthenticationTicket = class

Public NotInheritable Class FormsAuthenticationTicket

继承: Object
FormsAuthenticationTicket

属性: SerializableAttribute

示例

下面的代码示例使用 FormsCookieName 将方法的结果Encrypt存储在 Cookie 中，并将用户重定向到从 GetRedirectUrl 方法返回的 URL。

重要

此示例包含一个接受用户输入的文本框，这是一个潜在的安全威胁。默认情况下，ASP.NET 网页验证用户输入是否不包含脚本或 HTML 元素。有关详细信息，请参阅脚本侵入概述。

<%@ Page Language="C#" %>
<%@ Import Namespace="System.Web.Security" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">

  private void Login_Click(Object sender, EventArgs e)
  {
    // Create a custom FormsAuthenticationTicket containing
    // application specific data for the user.

    string username     = UserNameTextBox.Text;
    string password     = UserPassTextBox.Text;
    bool   isPersistent = false;

    if (Membership.ValidateUser(username, password))
    {
      string userData = "ApplicationSpecific data for this user.";

      FormsAuthenticationTicket ticket = new FormsAuthenticationTicket(1,
        username,
        DateTime.Now,
        DateTime.Now.AddMinutes(30),
        isPersistent,
        userData,
        FormsAuthentication.FormsCookiePath);

      // Encrypt the ticket.
      string encTicket = FormsAuthentication.Encrypt(ticket);

      // Create the cookie.
      Response.Cookies.Add(new HttpCookie(FormsAuthentication.FormsCookieName, encTicket));

      // Redirect back to original URL.
      Response.Redirect(FormsAuthentication.GetRedirectUrl(username, isPersistent));
    }
    else
    {
      Msg.Text = "Login failed. Please check your user name and password and try again.";
    }
  }

</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
<head>
    <title>Forms Authentication Login</title>
</head>
<body>
    <form id="form1" runat="server">
        <span style="BACKGROUND: #80ff80; font-weight:bold"> 
            Login Page
        </span> 
        <asp:Label id="Msg" ForeColor="maroon" runat="server" /><br />
        <table border="0">
            <tbody>
                <tr>
                    <td>Username:</td>
                    <td><asp:TextBox id="UserNameTextBox" runat="server" /></td>
                    <td>
                      <asp:RequiredFieldValidator id="RequiredFieldValidator1" 
                                                  runat="server" ErrorMessage="*" 
                                                  Display="Static" 
                                                  ControlToValidate="UserNameTextBox" />
                    </td>
                </tr>
                <tr>
                    <td>Password:</td>
                    <td><asp:TextBox id="UserPassTextBox" TextMode="Password" runat="server" /></td>
                    <td>
                      <asp:RequiredFieldValidator id="RequiredFieldValidator2" 
                                                  runat="server" ErrorMessage="*" 
                                                  Display="Static" 
                                                  ControlToValidate="UserPassTextBox" />
                    </td>
                </tr>
            </tbody>
        </table>
        <input type="submit" value="Login" runat="server" onserverclick="Login_Click" />
    </form>
</body>
</html>

<%@ Page Language="VB" %>
<%@ Import Namespace="System.Web.Security" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">

  Private Sub Login_Click(sender As Object, e As EventArgs)
  
    ' Create a custom FormsAuthenticationTicket containing
    ' application specific data for the user.

        Dim username As String = UserNameTextBox.Text
        Dim password As String = UserPassTextBox.Text
        Dim isPersistent As Boolean = False

    If Membership.ValidateUser(username, password) Then
    
      Dim userData As String = "ApplicationSpecific data for this user."

      Dim ticket As FormsAuthenticationTicket = New FormsAuthenticationTicket(1, _
        username, _
        DateTime.Now, _
        DateTime.Now.AddMinutes(30), _
        isPersistent, _
        userData, _
        FormsAuthentication.FormsCookiePath)

      ' Encrypt the ticket.
      Dim encTicket As String = FormsAuthentication.Encrypt(ticket)

      ' Create the cookie.
      Response.Cookies.Add(New HttpCookie(FormsAuthentication.FormsCookieName, encTicket))

      ' Redirect back to original URL.
      Response.Redirect(FormsAuthentication.GetRedirectUrl(username, isPersistent))
    Else    
      Msg.Text = "Login failed. Please check your user name and password and try again."
    End If
  End Sub

</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
<head>
    <title>Forms Authentication Login</title>
</head>
<body>
    <form id="form1" runat="server">
        <span style="BACKGROUND:#80ff80; font-weight:bold"> 
          Login Page
        </span> 
        <asp:Label id="Msg" ForeColor="maroon" runat="server" /><br />
        <table border="0">
            <tbody>
                <tr>
                    <td>Username:</td>
                    <td><asp:TextBox id="UserNameTextBox" runat="server" /></td>
                    <td>
                      <asp:RequiredFieldValidator id="RequiredFieldValidator1" 
                                                  runat="server" ErrorMessage="*" 
                                                  Display="Static" 
                                                  ControlToValidate="UserNameTextBox" />
                    </td>
                </tr>
                <tr>
                    <td>Password:</td>
                    <td><asp:TextBox id="UserPassTextBox" TextMode="Password" runat="server" /></td>
                    <td>
                      <asp:RequiredFieldValidator id="RequiredFieldValidator2" 
                                                  runat="server" ErrorMessage="*" 
                                                  Display="Static" 
                                                  ControlToValidate="UserPassTextBox" />
                    </td>
                </tr>
            </tbody>
        </table>
        <input type="submit" value="Login" runat="server" onserverclick="Login_Click" />
    </form>
</body>
</html>

注解

类 FormsAuthenticationTicket 用于创建一个对象，该对象表示表单身份验证用于标识经过身份验证的用户的身份验证票证。 forms-authentication 票证的属性和值与存储在 Cookie 或 URL 中的加密字符串进行转换和转换。

类 FormsAuthentication 提供了一个 Encrypt 方法，用于创建一个字符串值，该值可以存储在 Cookie 中，也可以存储在的 URL 中 FormsAuthenticationTicket。类 FormsAuthentication 还提供了一种方法 Decrypt ，用于从 forms-authentication Cookie 或 URL 检索到的加密身份验证票证创建 FormsAuthenticationTicket 对象。

FormsAuthenticationTicket可以使用类的属性访问Ticket当前经过身份验证的用户的 FormsIdentity 。可以通过将当前 FormsIdentity 的属性转换为Identity类型 FormsIdentity来访问当前 User 对象。

构造函数

FormsAuthenticationTicket(Int32, String, DateTime, DateTime, Boolean, String)	使用 Cookie 名、版本、过期日期、发布日期、持久性以及用户特定的数据初始化 FormsAuthenticationTicket 类的新实例。 Cookie 路径设置为在应用程序的配置文件中建立的默认值。
FormsAuthenticationTicket(Int32, String, DateTime, DateTime, Boolean, String, String)	使用 cookie 名、版本、目录路径、发布日期、过期日期、持久性以及用户定义的数据初始化 FormsAuthenticationTicket 类的新实例。
FormsAuthenticationTicket(String, Boolean, Int32)	使用 cookie 名和过期信息初始化 FormsAuthenticationTicket 类的新实例。

属性

CookiePath	获取 Forms 身份验证票证的 Cookie 路径。
Expiration	获取 Forms 身份验证票证过期时的本地日期和时间。
Expired	获取一个值，它指示 Forms 身份验证票证是否已过期。
IsPersistent	获取一个值，该值指示包含 Forms 身份验证票证信息的 Cookie 是否为持久性的。
IssueDate	获取最初发出 Forms 身份验证票证时的本地日期和时间。
Name	获取与 Forms 身份验证票相关联的用户名。
UserData	获取一个存储在票证中的用户特定的字符串。
Version	获取票证的版本号。

方法

Equals(Object)	确定指定对象是否等于当前对象。 (继承自 Object)
GetHashCode()	作为默认哈希函数。 (继承自 Object)
GetType()	获取当前实例的 Type。 (继承自 Object)
MemberwiseClone()	创建当前 Object 的浅表副本。 (继承自 Object)
ToString()	返回表示当前对象的字符串。 (继承自 Object)

适用于

另请参阅

Forms 身份验证提供程序

通过

FormsAuthenticationTicket 类

定义

示例

注解

构造函数

属性

方法

适用于

另请参阅

其他资源