FormsAuthenticationTicket Classe

Referência

Definição

Namespace:: System.Web.Security

Assembly:: System.Web.dll

Importante

Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.

Fornece acesso às propriedades e aos valores do tíquete usado com autenticação de formulários para identificar usuários. Essa classe não pode ser herdada.

public ref class FormsAuthenticationTicket sealed

[System.Serializable]
public sealed class FormsAuthenticationTicket

[<System.Serializable>]
type FormsAuthenticationTicket = class

Public NotInheritable Class FormsAuthenticationTicket

Herança: Object
FormsAuthenticationTicket

Atributos: SerializableAttribute

Exemplos

O exemplo de código a seguir armazena o resultado do Encrypt método em um cookie usando e FormsCookieName redireciona o usuário para a URL retornada do GetRedirectUrl método.

Importante

Este exemplo contém uma caixa de texto que aceita a entrada do usuário, que é uma ameaça à segurança em potencial. Por padrão, ASP.NET páginas da Web validam que a entrada do usuário não inclui elementos HTML ou script. Para obter mais informações, consulte Visão geral de explorações de script.

<%@ 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>

Comentários

A FormsAuthenticationTicket classe é usada para criar um objeto que representa o tíquete de autenticação usado pela autenticação de formulários para identificar um usuário autenticado. As propriedades e os valores de um tíquete de autenticação de formulários são convertidos de e para uma cadeia de caracteres criptografada armazenada em um cookie ou na URL.

A FormsAuthentication classe fornece um Encrypt método para criar um valor de cadeia de caracteres que pode ser armazenado em um cookie ou na URL de um FormsAuthenticationTicket. A FormsAuthentication classe também fornece um Decrypt método para criar um FormsAuthenticationTicket objeto do tíquete de autenticação criptografado recuperado do cookie de autenticação de formulários ou da URL.

O FormsAuthenticationTicket usuário autenticado atual pode ser acessado usando a Ticket propriedade da FormsIdentity classe. Você pode acessar o objeto atual FormsIdentity convertendo a Identity propriedade do tipo FormsIdentityatual User como .

Construtores

FormsAuthenticationTicket(Int32, String, DateTime, DateTime, Boolean, String)	Inicializa uma nova instância da classe FormsAuthenticationTicket com o nome do cookie, a versão, a data de vencimento, a data de emissão, a persistência e dados específicos do usuário. O caminho do cookie é definido com o valor padrão estabelecido no arquivo de configuração do aplicativo.
FormsAuthenticationTicket(Int32, String, DateTime, DateTime, Boolean, String, String)	Inicializa uma nova instância da classe FormsAuthenticationTicket com o nome do cookie, versão, caminho de diretório, data de emissão, data de expiração, persistência e dados definidos pelo usuário.
FormsAuthenticationTicket(String, Boolean, Int32)	Inicializa uma nova instância da classe FormsAuthenticationTicket usando informações de nome e expiração de um cookie.

Propriedades

CookiePath	Obtém o caminho do cookie para o tíquete de autenticação de formulários.
Expiration	Obtém a data e hora local em que o tíquete de autenticação de formulários expira.
Expired	Obtém um valor que indica se o tíquete de autenticação de formulários expirou.
IsPersistent	Obtém um valor que indica se o cookie que contém as informações de tíquete de autenticação de formulários é persistente.
IssueDate	Obtém a data e hora local em que o tíquete de autenticação de formulários foi originalmente emitido.
Name	Obtém o nome de usuário associado ao tíquete de autenticação de formulários.
UserData	Obtém uma cadeia de caracteres específica do usuário armazenada com o tíquete.
Version	Obtém o número de versão do tíquete.

Métodos

Equals(Object)	Determina se o objeto especificado é igual ao objeto atual. (Herdado de Object)
GetHashCode()	Serve como a função de hash padrão. (Herdado de Object)
GetType()	Obtém o Type da instância atual. (Herdado de Object)
MemberwiseClone()	Cria uma cópia superficial do Object atual. (Herdado de Object)
ToString()	Retorna uma cadeia de caracteres que representa o objeto atual. (Herdado de Object)

Aplica-se a

Confira também

Provedor de Autenticação de Formulários