WCF – Tracing

Toda e qualquer tipo de aplicação sempre exige uma forma de armazenar possíveis erros que possam acontecer durante a sua execução. Isso irá ajudar imensamente para diagnosticarmos problemas que ocorrem e, conseqüentemente, facilitar na sua solução. Isso não é diferente em serviços WCF. Esse artigo tem a finalidade de demonstrar a integração que os serviços WCF possibilitam para a captura e persistência dos erros para uma posterior análise.

Felizmente, o WCF já têm embutido em sua infraestrutura uma integração muito forte com o namespace System.Diagnostics que, por sua vez, fornece toda a parte de monitoramento da “saúde” das aplicações construídas sob a plataforma .NET. O monitoramento não está habilitado por padrão e, para isso, basta configurarmos algumas informações necessárias para o funcionamento do mesmo dentro do arquivo *.config.

É bom informar que, como pré-requisito para este artigo, você precisa conhecer as principais funcionalidades que são disponibilizadas pelo System.Diagnostics. O WCF já define alguns trace sources que você pode estar utilizando para efetuar os logs. Entre os trace sources disponíveis temos um chamado System.ServiceModel. Este trace source loga todos os estágios de um processamento de um serviço WCF, que vai desde a criação do mesmo, passando pela autenticação e transporte da mensagem, até o retorno do método. O código abaixo trata-se de um trecho do arquivo App.Config, que foi extraído de uma aplicação que consome o serviço WCF:

<system.diagnostics>
  <sources>
    <source
      name="System.ServiceModel"
      switchValue="All"
      propagateActivity="true">
      <listeners>
        <add
            name="TraceInXml"
            type="System.Diagnostics.XmlWriterTraceListener"
            initializeData="C:AppLog.svclog" />
      </listeners>
    </source>
  </sources>
  <trace autoflush="true" />
</system.diagnostics>

Analisando o trecho de código acima, especificamos o source como sendo System.ServiceModel para ser capaz de capturar todos os estágios do processamento do WCF. O elemento source possui dois outros atributos, chamados: switchValue e propagateActivity. O primeiro deles, switchValue, recebe uma combinação de valores (separados por vírgula) que especifica quais serão os tipos de informações que serão capturadas, ou seja, uma espécie de filtro. Como há várias possibilidades, a tabela abaixo descreve cada uma delas:

Nível Descrição
Off

Nenhum tipo de informação é capturada.

Critical

Somente eventos considerados “negativos” são capturados, ou seja, eventos que indicam um processamento inesperado ou um erro condicional. Neste cenário, algumas exceções não tratadas são capturadas e devidamente logadas. Entre essas exceções temos: OutOfMemoryException, ThreadAbortException, StackOverflowException, entre algumas outras.

Error

Somente eventos considerados “negativos” são capturados, ou seja, eventos que indicam um processamento inesperado ou um erro condicional. Neste cenário, todo e qualquer tipo de exceção não tratada é capturada e devidamente logada.

Warning

Somente eventos considerados “negativos” são capturados, ou seja, eventos que indicam um processamento inesperado ou um erro condicional. Refere-se a problemas que acontecem na sua aplicação, mas ela é capaz de continuar trabalhando.

Information

Somente eventos considerados “positivos” são capturados, ou seja, eventos que indicam o sucesso de uma determinada tarefa.

Verbose

Somente eventos considerados “positivos” são capturados, mas com a diferença em relação ao Information, de que estes eventos são considerados de “baixo nível”, úteis em procedimento de debugging ou otimização.

ActivityTracing

Permite capturar eventos que estão contidos dentro uma determinada atividade. As atividades são abordadas de forma mais detalhada logo abaixo.

All

Todo e qualquer tipo de evento (que vimos acima) são capturados e devidamente logados.

Observação: Atente-se aos tipos de evento (filtro) que se aplica ao tracing. Utilize isso com uma restrição muito grande, definindo somente o que você precisa realmente capturar em sua aplicação/serviço. Dependendo, você pode estar forçando o runtime a salvar informações desnecessárias, comprometendo a performance da aplicação.

O segundo atributo é o propagateActivity. Ele é utilizado quando o atributo switchValue estiver definido como ActivityTracing, e recebe um valor booleano indicando se a atividade deve ou não ser propagada para os endpoints que participam do processo. Veremos mais detalhes sobre atividades e propagações a seguir. E, finalmente, depois do source configurado, devemos definir um listener (ou vários) que será responsável por persistir as informações em formato XML (quando utilizar o XmlWriterTraceListener) mas, como o WCF se utiliza dos listeners contidos dentro do namespace System.Diagnostics, nada impede de utilizar o TextWriterTraceListener e gerar o output em formato texto.

Atividades

As atividades são unidades de processamento que nos ajudam no processo de identificação de uma possível falha. Essas atividades agrupam todos os traces para cada unidade de processamento, facilitando o rastreamento de possíveis falhas que possam vir a ocorrer durante a execução de um determinado serviço WCF. As atividades estão sempre relacionadas e com o auxílio de uma ferramenta chamada Service Trace Viewer (mais abaixo falaremos sobre ela) poderemos visualizar o processo de forma gráfica.

Quando falamos de atividades, é importante saber que elas podem acontecer tanto no cliente quanto no servidor. Sendo assim, é importante que as atividades entre cliente e servidor também estejam relacionadas para conseguirmos mesclá-las e, conseqüentemente, termos uma visualização completa do processo. Para que isso seja possível, há uma técnica chamada propagação de atividade. Quando esse recurso é habilitado, uma espécie de ID é gerado e enviado no header da mensagem, justamente para correlacionar as atividades através das aplicações. Como vimos no exemplo acima, para habilitarmos a propagação, definimos como True o atributo propagateActivity do elemento source.

Service Trace Viewer Tool (SvcTraceViewer.exe)

Este utilitário nos ajuda a analisar e dignosticar os traces que são gerados pelos serviços WCF disponibilizando, de uma forma bastante simples e intuitiva, a visualização de todo o processo da requisição, dividida em várias atividades. Além disso, ele permite selecionarmos vários arquivos, o que permite escolhermos o trace gerado pelo cliente e servidor, e a própria ferramenta mescla as informações dos arquivos, apresentando-os da forma que elas realmente acontecem.

É importante dizer que essa ferramenta não é disponibilizada apenas com a instalação do .NET Framework 3.0. Para poder obtê-la, é necessário que você faça o download e instale o Microsoft SDK for .NET Framework 3.0, que pode ser encontrado neste endereço.

Figura 1 – Utilizando o utilitário SvcTraceViewer.exe para analisar um tracing gerado pelo cliente e servidor.

Se analisarmos a figura acima, podemos reparar que eu optei por mostrar de forma gráfica todo o processo. Logo na parte superior do gráfico é possível visualizar os processos (cliente e servidor) que fizeram parte da requisição para o serviço. Neste mesmo gráfico ainda é possível analisarmos exatamente o momento da criação do proxy, do host e, o principal, do momento onde a exceção ocorre, que é onde o cursor está posicionado. Ainda a respeito do gráfico, cada um dos ícones que ali consta representa uma determinada ação e, para maiores detalhes sobre cada um deles, consulte este documento.

Esse utilitário permite a criação de projetos (*.stvproj) de forma que podemos agrupar todos os traces relacionados a alguma aplicação/serviço. Além das várias funcionalidades fornecidas por este utilitário, há uma outra que merece uma atenção, que é o Step Forward (F10) ou Step Backward (F9). O primeiro permite você avançar para o próximo trace e o segundo permite voltar para o trace anterior. É bem semelhante ao Step Into e Step Over do debugger do Visual Studio .NET.

Conclusão: Que o trace é essencial em qualquer tipo de aplicação, isso já não é novidade. Felizmente, como pudemos notar neste artigo, o WCF sabe dessa importância e já incorporou em sua infraestrutura todo o procedimento necessário para gerar os logs e disponibilizar para uma posterior análise. Além disso, a utilização da ferramenta Service Trace Viewer torna a compreensão do processo como um todo muito mais legível e fácil de encontrar uma possível falha.

WCF – Orcas

Com o lançamento do primeiro Beta do Orcas, achei muito interessante duas novas features que o WCF fornecerá. Essas features são:

  • WebHttpBinding: Trata-se de um novo tipo de binding que permite a criação de um endpoint para ser consumido por aplicações AJAX. É basicamente algo semelhante ao BasicHttpBinding, com a exceção de que os dados são serializados em formato JSON (JavaScript Object Notation). É bom dizer que esta classe está dentro do namespace System.ServiceModel do Assembly System.ServiceModel.Web.dll.
    • Atentem-se ao blog do Luis Abreu que, possivelmente, ele estará mostrando alguma coisa sobre como consumir serviços WCF em ASP.NET AJAX.
  • WCF Tooling: Como sabemos, é necessário termos um hosting para disponibilizarmos serviços WCF, para que os mesmos possam ser consumidos. O WCF Tooling permite selecionarmos um tipo de projeto (project template) que já inclui um self-hosting. Isso quer dizer que, ao criar um serviço WCF, basta rodar o projeto via F5, que o mesmo já estará disponível para ser referenciado em outras aplicações.

Para maiores informações, consultem o link: http://blogs.msdn.com/mwinkle/archive/2007/02/28/wcf-and-wf-in-quot-orcas-quot.aspx

WCF Dynamic Proxy

Hoje estava navegando e encontrei um exemplo de criação dinamica de proxies para serviços WCF. Trata-se de uma library desenvolvida pela Microsoft que, dado uma URI até o WSDL do serviço, extrai todos os dados dos endpoints que o mesmo disponibiliza.

Além disso, ainda permite a chamada de métodos, leitura e escrita de propriedades que o serviço (contrato) expõe. A sua utilização não me parece muito complicada:

using System.ServiceModel;
using System.ServiceModel.Description;
using WcfSamples.DynamicProxy;

string service = “http://localhost:2969/DevMinds.WebHostingCS/DefaultService.svc?wsdl“;
DynamicProxy proxy = new DynamicProxyFactory(service).CreateProxy(“IServiceContract”);
Console.WriteLine(proxy.CallMethod(“BoasVindas”, null));

Isso me parece muito útil quando desejarmos trabalhar de forma muito dinamica para a criação e testes de serviços WCF, permitindo uma maior flexibilidade. Ao meu ver, é útil para a criação de uma ferramenta que pode ser utilizada pós nós, desenvolvedores.

WCF – Integrando MembershipProvider e RoleProvider

Por padrão, serviços WCF utilizam as identidades e grupos do Windows para autenticação e autorização, respectivamente. Um dos grandes problemas é quando temos isso sendo disponibilizado através de uma aplicação web, pois iria requerer que todos os clientes que acessam via web estivessem devidamente cadastrados dentro do Windows; além disso, há o problema com relação aos grupos de usuários, já que muitas vezes não temos acesso para cadastrá-los e, quando isso não é um problema, podemos ter um problema adicional quando estivermos rodando em culturas de servidores diferentes.

Com isso, dificilmente uma aplicação ou serviços que são expostos para a internet utilizam as contas e grupos do Windows. A solução é que felizmente o ASP.NET 2.0 fornece uma infraestrutura completa para o gerenciamento de autenticação e autorização, chamada de Provider Model. Ela nos dá uma enorme flexibilidade, onde podemos trocar a fonte de dados/persistência e a aplicação continua trabalhando normalmente. Este provider é um módulo do software que estamos desenvolvendo que fornece uma interface genérica para uma fonte de dados, onde abstraem a base de dados. Além disso ser flexível, a qualquer momento podemos trocar a base de dados (essa arquitetura também é extensível) ou seja, se mais tarde quisermos customizar algo, podemos fazer isso sem maiores problemas.

Com toda essa infraestrutura já bem desenhada e sendo utilizada largamente no mercado, a Microsoft decidiu, em uma das formas de segurança de serviços WCF, integrar com esse modelo disponibilizado pelo ASP.NET 2.0. Este artigo já assume que você tenha conhecimento suficiente nesta infraestrutura e, em alguns pontos, vamos falar de alguns detalhes mais superficialmente. Se você ainda não estiver a vontade nisso, eu aconselho extremamente ler o artigo Entendendo e Implementando Segurança no ASP.NET 2.0 antes de prosseguir.

O transporte da mensagem

Quando estamos em um cenário de internet, as mensagens são enviadas para o serviço através de puro HTTP, porém é extremamente importante proteger o corpo e as credenciais do usuário durante essa “viagem”. A solução para isso é criptografar a mensagem para garantir a integridade e privacidade, utilizando a senha do usuário mas, mais uma vez por questões de segurança, o WCF não utiliza essa forma por ser vulnerável, pois o usuário pode ter uma senha pouco complexa e qualquer um que esteja monitorando a comunicação poderá interceptar e, conseqüentemente, “quebrar” a criptografia.

Para proteger a mensagem, o WCF utiliza um certificado do tipo X.509, que fornece uma proteção extremamente confiável. Este tipo de certificado também autentica unicamente o serviço para o cliente, trabalhando com duas chaves: uma pública e outra privada. Quando criptografamos algo com a chave pública, somente quem tiver a chave privada poderá decriptografar o seu conteúdo e, neste nosso cenário, o detentor da chave pública é o serviço WCF que, por sua vez, deverá manter a chave privada armazenada em algum local seguro para que a mesma não caia em mãos erradas.

A chave pública fica disponível no servidor que expõe o serviço e, sendo assim, qualquer cliente pode acessar os endpoints do serviço WCF e obter a chave pública. Como já sabemos, essa chave pública será utilizada pelo cliente para criptografar todas as mensagens que serão enviadas para o serviço que, por sua vez, quando receber a requisição, irá decriptografá-la utilizando a chave privada e utilizará as credenciais fornecidas pelo usuário para autenticá-lo e, conseqüentemente, permitir o acesso ao serviço.

Para o teste que vamos realizar no decorrer deste artigo, necessitamos de um certificado X.509 para utilizarmos durante a criação do serviço. Como não tenho nenhum certicado disponível, podemos criar um para testes. Para isso, utilizaremos um utilitário chamado Makecert.exe que é fornecido junto com o .NET Framework e pode ser encontrado no seguinte endereço: C:Program FilesMicrosoft Visual Studio 8SDKv2.0Bin. Este utilitário cria um par de chave pública e privada e armazena em um arquivo de certificado. Para criar o certificado, abra o prompt de comando do Visual Studio .NET 2005 (isso para evitar o path completo do utilitário) e digite:

makecert -sr LocalMachine -ss My -sky exchange -pe -a sha1 -n "CN=IACertificate" IACertificate.cer

Basicamente, através da linha acima, criamos um certificado chamado IACertificate e armazenamos ele em um arquivo chamado IACertificate.cer. Mas é importante dizer sobre cada um das opções que são passadas para o utilitário Makecert.exe, opções que são detalhadas através da tabela abaixo:

Opção Descrição
-sr

Especifica o local onde o certificado será armazenado. Entre esses valores temos: currentuser ou localmachine.

-ss

Especifica o nome do certificado onde o output será armazenado.

-sky

Especifica o tipo do certificado, que deve ser signature ou exchange.

-pe

Define como será gerada a chave privada, o que permite que a mesma seja incluída no certificado.

-a

Indica qual será o algoritmo usado pelo certificado. Entre os algoritmos temos o md5 (padrão) ou o sha1.

-n

Especifica o nome do certificado, devendo estar em conformidade com o padrão X.500, que é especifcar o nome entre aspas e precedido por CN=.

Observações: Se quiser uma lista completa de todas as opções fornecidas pelo utilitário Makecert.exe, consulte este link. Depois de criado o certificado, se desejar visualizá-lo, vá até a opção Run do Windows e digite: mmc; em seguida, vá até o menu File, Add/Remove Snap-in…, terá um botão chamado Add no fim da janela; ao clicar nele um novo formulário será apresentado e na listagem terá um item chamado Certificates que, ao selecioná-lo, abrirá um wizard onde você deverá, na primeira tela apresentada, selecionar a opção Computer account. Isso fará com que todos os certificados do seu computador sejam exibidos na console de administração. Ao navegar até Personal, Certificates, verá ali o certificado recém criado.

Como o nosso foco será disponibilizar isso através de uma aplicação que irá correr dentro do IIS, é necessário concedermos direitos de leitura a chave privada do certificado em questão para as contas dos worker process do IIS. Para isso, temos que seguir dois passos que são mostrados abaixo:

  • Através do utilitário FindPrivateKey.exe, conseguimos identificar a chave privada, para que seja possível encontrá-la e, em seguida, conceder os direitos a mesma. Se não tiver o Microsoft SDK for .NET Framework 3.0 instalado, então voce pode baixar os exemplos de WCF da Microsoft que, dentro dele, existe um projeto chamado FindPrivateKey.sln, que é justamente o projeto que gera esse utilitário.

  • Depois de encontrada a chave, voce pode conceder os direitos através do utilitário cacls.exe (como é mostrado neste post) ou via Windows Explorer, através da aba Security.

Criação do contrato e configuração da autorização

Neste momento, vamos nos concentrar na criação e configuração do serviço WCF. Mais uma vez, vou considerar como conhecimento prévio o procedimento para a criação de serviço básico de WCF, principalmente no que diz respeito aos atributos que devem ser aplicados aos tipos para torná-lo um serviço WCF. Para o exemplo, vamos criar um contrato padrão, chamado de IServiceContract, que será implementado pelos serviços concretos. Esse contrato (uma Interface) terá dois métodos simples, chamados de BoasVindas e HoraAtual. Essa Interface está exibida abaixo:

using System;
using System.ServiceModel;

namespace DevMinds.ComponentCS
{
    [ServiceContract]
    public interface IServiceContract
    {
        [OperationContract]
        string BoasVindas();

        [OperationContract]
        DateTime DataAtual();
    }
}

Como estamos falando sobre a integração com a segurança do ASP.NET, esse serviço utilizará como hosting o IIS. Sendo assim, temos uma arquivo com extensão *.svc que implementa a Interface definida acima. A única exceção para um exemplo simples, é que os métodos são decorados com o atributo PrincipalPermissionAttribute. Esse atributo, contido dentro do namespace System.Security.Permissions, permite você configurar as informações de segurança, mais especificamente de autorização, utilizando o padrão declarativo e, como podemos notar no exemplo abaixo, cada um dos métodos pode ser invocado por um grupo específico:

using System;
using System.Threading;
using System.Security.Permissions;
using DevMinds.ComponentCS;

public class DefaultService : IServiceContract
{
    [PrincipalPermission(SecurityAction.Demand, Role = "User")]
    public string BoasVindas()
    {
        return string.Format("Ola {0}!",
            Thread.CurrentPrincipal.Identity.Name);
    }

    [PrincipalPermission(SecurityAction.Demand, Role = "Manager")]
    public DateTime DataAtual()
    {
        return DateTime.Now;
    }
}

Um detalhe para a autorização é que se um determinado método é permitido ser invocado por mais de um grupo, você pode adicionar múltiplos atributos PrincipalPermission. Além disso, esse atributo permite a definição de um nome de usuário que tem acesso ao membro. Segurança declarativa força definirmos o nome dos grupos e usuários em hardcode. Se esses valores são dinâmicos, o ideal é estar fazendo isso a partir da segurança imperativa, ou seja, via código. Além deste detalhe, a declaração imperativa permite uma melhor customização, pois podemos ter condicionais para determinar se a segurança será ou não aplicada.

A autorização imperativa ou declarativa não é exclusividade do Windows Communication Foundation ou mesmo da plataforma 2.0 do .NET, mas já existe desde a primeira versão e foi adequado ao sistema de autorização do WCF.

Configuração do serviço

Como já estou assumindo que você tenha os devidos conhecimentos sobre a configuração do Membership e RoleProvider, vou ocultar aqui a explicação deles, mas no final desta seção, mostrarei o Web.Config na íntegra. Basicamente teremos na seção connectionStrings a conexão com a base de dados SQL Server onde estarão as tabelas utilizadas pela infraestrutura do Membership e RoleProvider.

As configurações no serviço que devemos efetuar se resume às seções de bindings e behaviors, as quais iremos analisar individualmente cada um dos elementos e atributos que constituem essa configuração de segurança com integração ao ASP.NET 2.0.

Em um ambiente de internet, as mensagens devem ser transferidas com as credenciais (login e password) informadas pelo usuário. Sendo assim, neste caso utilizaremos o binding WSHttpBinding. Este, por sua vez, representa um binding que pode utilizar HTTP ou HTTPs para transporte, suportando transações distribuídas, confiabilidade e segurança nas mensagens. É bom lembrar que a classe BasicHttpBinding é utilizada para a comunicação com Web Services (ASMX) e não fornece segurança. Se desejarmos ter um canal seguro utilizando este binding, devemos recorrer ao HTTPs. Já o WSHttpBinding possui segurança a nível de mensagem e é isso que veremos a seguir, ou seja, como configurar essa segurança.

A classe WSHttpBinding possui uma propriedade chamada Security que expõe um objeto do tipo WSHttpSecurity. Este objeto possui duas propriedades importantes que utilizaremos na configuração do binding. A primeira delas é a propriedade Mode, que aceita uma das opções fornecidas pelo enumerador SecurityMode. As opções estão descritas na tabela abaixo:

Opção Descrição
Message

Nesta opção, a segurança é fornecida utilizando a segurança do protocolo SOAP.

None

A segurança está desabilitada.

Transport

A segurança será fornecida utilizando HTTPs.

TransportWithMessageCredential

Esta opção permite efetuar um mix das opções anteriores: utilizará um endpoint HTTPs para fornecer autenticação, integridade e confidenciabilidade, enquanto as credenciais do usuário continua sendo enviada através da mensagem SOAP (header) por questões de flexibilidade. Um dos benefícios desta técnica é que todo envelope SOAP é criptografado durante o transporte, incluindo os headers.

Já a segunda propriedade, chamada Message, é onde configuramos o nível de segurança para o transporte da mensagem. Essa propriedade expõe um objeto do tipo NonDualMessageSecurityOverHttp que possui uma propriedade chamada ClientCredentialType. Através desta propriedade especificamos o tipo da credencial do cliente que é utilizada para a autenticação do mesmo quando estamos utilizando o WsHttpBinding binding. Essa propriedade recebe uma das opções contidas no enumerador MessageCredentialType, que estão abaixo descritos:

Opção Descrição
Certificate

Especifica que a autenticação do cliente será efetuada utilizando um certificado.

IssuedToken

Especifica que a autenticação do cliente será efetuada utilizando um issued token.

None

Especifica a autenticação anônima.

UserName

Especifica que a autenticação do cliente será efetuada através de um username.

Windows

Especifica que a autenticação do cliente será efetuada através do Windows.

Como já conhecemos as opções disponíveis para a configuração do binding WSHttpBinding, é necessário neste momento analisarmos os behaviors que também são uma peça fundamental neste processo. Através dos behaviors do serviço, iremos especificar o certificado que criamos acima e, além disso, vamos determinar qual será a forma de autenticação (Membership Provider) e autorização (Role Provider) que o serviço irá utilizar.

Já falando de arquivo de configuração (Web.Config), através do elemento serviceBehaviors vamos customizar a autenticação e autorização. A autenticação (juntamente com o certificado) é realizada dentro do elemento serviceCredentials e a autorização através do elemento serviceAuthorization. O elemento serviceCredentials, responsável pela autenticação, possui dois sub-elementos, a saber: userNameAuthentication e serviceCertificate onde, no primeiro, especificamos a forma da autenticação e o segundo, informações relacionadas ao certificado que será utilizado.

Antes de dar maiores detalhes sobre a configuração da autenticação e autorização, vamos visualizar na íntegra o arquivo Web.Config da aplicação web que hosperará o serviço WCF:

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
  <connectionStrings>
    <add
      name="SqlServerConnString"
      connectionString="Data Source=.;Initial Catalog=DBWCF;Integrated Security=SSPI;"
      providerName="System.Data.SqlClient"/>
  </connectionStrings>
  <system.serviceModel>
    <services>
      <service name="DefaultService" behaviorConfiguration="ServiceBehavior">
        <endpoint
          name="DevMindsEndpoint"
          contract="DevMinds.ComponentCS.IServiceContract"
          binding="wsHttpBinding"
          bindingConfiguration="ServiceBinding" />
      </service>
    </services>
    <bindings>
      <wsHttpBinding>
        <binding name="ServiceBinding">
          <security mode="Message">
            <message clientCredentialType="UserName" />
          </security>
        </binding>
      </wsHttpBinding>
    </bindings>
    <behaviors>
      <serviceBehaviors>
        <behavior name="ServiceBehavior">
          <serviceCredentials>
            <userNameAuthentication
                userNamePasswordValidationMode="MembershipProvider"
                membershipProviderName="SqlMembershipProvider"/>
            <serviceCertificate
                storeLocation="LocalMachine"
                storeName="My"
                x509FindType="FindBySubjectName"
                findValue="IACertificate" />
          </serviceCredentials>
          <serviceAuthorization
              principalPermissionMode="UseAspNetRoles"
              roleProviderName="SqlRoleProvider" />
          <serviceDebug includeExceptionDetailInFaults="true"/>
          <serviceMetadata httpGetEnabled="true" />
        </behavior>
      </serviceBehaviors>
    </behaviors>
  </system.serviceModel>
  <system.web>
    <membership
      defaultProvider="SqlMembershipProvider"
      userIsOnlineTimeWindow="15">
      <providers>
        <clear />
        <add
          name="SqlMembershipProvider"
          type="System.Web.Security.SqlMembershipProvider"
          connectionStringName="SqlServerConnString"
          applicationName="WCFApp" />
      </providers>
    </membership>
    <roleManager enabled="true" defaultProvider="SqlRoleProvider" >
      <providers>
        <add
          name ="SqlRoleProvider"
          type="System.Web.Security.SqlRoleProvider"
          connectionStringName="SqlServerConnString"
          applicationName="WCFApp"/>
      </providers>
    </roleManager>
  </system.web>
</configuration>

Como explicar a configuração dos providers está fora do escopo deste artigo, vamos abordar diretamente o elemento userNameAuthentication. Ele possui dois atributos: userNamePasswordValidationMode e membershipProviderName. O primeiro deles determina qual será a forma de validar o username/password. As opções possíveis são fornecidas através do enumerador UserNamePasswordValidationMode. As opções que ele fornece estão descritas na tabela abaixo:

Opção Descrição
Custom

A validação do usuário será baseada em uma forma customizada. Esse modo exige que você crie seu próprio “validador” e, para isso, herde a classe UsernamePasswordValidator e customize os membros necessários.

MembershipProvider

Especifica que a validação da autenticação do usuário será efetuada utilizando a estrutura de Membership Provider do ASP.NET 2.0.

Windows

Os userNames são mapeados para os usuários do Windows.

Como o foco do artigo é a integração de serviços WCF e a estrutura de autenticação do ASP.NET 2.0, o atributo userNamePasswordValidationMode será definido como MembershipProvider, o que nos obriga a definir o atributo membershipProviderName que, por sua vez, receberá uma string contendo o nome do membership provider que irá consistir a validação do usuário. Se reparar, ele recebe o mesmo valor definido no atributo name do elemento membership.

Antes de abordarmos a autorização, é necessário entender como configurar o certificado. Como falamos mais acima e você pode notar no Web.Config, existe um elemento chamado serviceCertificate, que é onde definimos o certificado que o serviço irá utilizar. Esse elemento possui basicamente quatro atributos que utilizamos para determinar o critério de busca pelo mesmo dentro do computador onde o serviço está rodando. Cada um desses atributos estão descritos na tabela abaixo:

Atributo Descrição
FindValue

Recebe uma string contendo o nome do certificado a ser procurado no repositório.

StoreLocation

Especifica o local do repositório onde o certificado está armazenado. Os possíveis valores para este campo são:

  • CurrentUser: especifica que a busca será realizada no repositório de certificados do usuário corrente.
  • LocalMachine: especifica que a busca será realizada no repositório de certificados da máquina local.
StoreName

Especifica o nome (tipo) do repositório. No nosso caso, utilizaremos a opção My, que indica que deve ser efetuada a busca no repositório de certificados pessoais.

X509FindType

Especifica por qual campo o valor informado na propriedade FindValue será procurado. No nosso caso, utilizaremos a opção FindBySubjectName que indica que a busca pelo certificado deverá ser realizada comparando o valor definido na propriedade FindValue com o subject name dos certificados armazenados no local especificado.

Com a autenticação devidamente configurada, chega o momento de analisarmos a autorização. Ainda dentro dos behaviors do serviço, temos um elemento chamado serviceAuthorization, que é utilizado para a configuração da autorização dentro do serviço WCF. Esse elemento possui dois atributos chamados principalPermissionMode e roleProviderName. O primeiro deles determina qual será o modo de autorização utilizado pelo serviço para controlar o acesso aos membros que utilizam a segurança declarativa (atributo PrincipalPermissionAttribute) ou imperativa. As opções possíveis são fornecidas através do enumerador PrincipalPermissionMode. As opções que ele fornece estão descritas na tabela abaixo:

Opção Descrição
Custom

Permite ao desenvolvedor especificar uma forma customizada de autorização, baseando-se em uma classe que implementa a interface IPrincipal, que deve ser vinculada à propriedade CurrentPrincipal.

None

CurrentPrincipal não definida.

UseAspNetRoles

Especifica que a autorização será baseada na Role Provider fornecida pelo ASP.NET 2.0.

UseWindowsGroups

A autorização será baseada nos grupos do Windows.

Como o foco do artigo é a integração de serviços WCF e a estrutura de autorização do ASP.NET 2.0, o atributo principalPermissionMode será definido como UseAspNetRoles, o que nos obriga a definir o atributo roleProviderName que, por sua vez, receberá uma string contendo o nome da role provider que irá consistir a autorização do usuário. Atente-se que ele recebe o mesmo valor definido no atributo name do elemento roleManager.

Observação: Quando habilitamos a segurança baseada em roles no ASP.NET 2.0, utilizando a arquitetura de Role Provider, o ASP.NET cria um objeto do tipo RolePrincipal e define o mesmo na propriedade CurrentPrincipal da classe Thread que está cuidando da execução do pedido. Quando o método IsInRole da classe RolePrincipal for invocado, ela ainda não possui conhecimentos das roles do usuário e invoca o método GetRolesForUser do provider, recuperando as roles do repositório para o usuário em questão e, em seguida, cria um cache internamente que evitará ir até o repositório toda vez que este método for chamado. Isso tem um comportamento ligeiramente diferente quando configuramos o serviço WCF para utilizar a arquitetura de roles do ASP.NET 2.0, pois o WCF utilizará uma classe customizada, chamada RoleProviderPrincipal, que está contida dentro do namespace System.ServiceModel.Security e implementa a Interface IPrincipal. Durante a execução de um serviço WCF, uma instância dessa classe é anexada à propriedade CurrentPrincipal da classe Thread. O grande problema com ela é que, ao invocar o método IsInRole a chamada é encaminhada para o método IsUserInRole do provider especificado. Isso quer dizer que, no caso do SqlRoleProvider, não será efetuado o cache das roles do usuário, aumentando assim o número de round-trips no banco de dados.

Com essa configuração relizada e o serviço já disponível no servidor (incluindo a instalação do certificado), o mesmo já pode ser invocado pelos clientes interessados em consumí-lo. Superficialmente, o que acontece nos bastidores durante a chamada ao serviço WCF, é que o cliente utilizará a chave pública (fornecida pelo serviço) para criptografar todas as mensagens que enviará ao serviço. Quando o serviço recebe essa mensagem, ele utiliza a chave privada para decriptografar a mensagem e, feito isso, o serviço WCF lê as credenciais do usuário e o autentica, permitindo assim, o acesso ao serviço.

Configuração do cliente

Assim como o serviço, também é necessário configurarmos o binding e o behavior do serviço WCF do lado do cliente e, além disso, necessitamos ter a chave pública do certificado exposta pelo serviço.

Para suportar a autenticação e proteção de mensagens mútuas, os serviços devem fornecer as credenciais para o chamador. Quando utilizamos a segurança a nível de transporte, as credenciais do serviço são negociadas através do protocolo de transporte. Quando utilizamos a segurança baseada em mensagens, podemos também especificar as credenciais do Windows ou um certificado, através do elemento serviceCredentials, como já vimos acima. Esse processo, chamado de negociação, pode ser realizado de forma out-of-band ou através de um handshake inicial.

Se desejar, você pode desabilitar a negociação das credenciais definindo para False o atributo negotiateServiceCredential do elemento message.

Para os tipos de credenciais diferentes de Windows, de alguma forma é necessário que o cliente tenha acesso à chave pública do certificado para que ele possa criptografar as requisições para o serviço. Isso é gerado automaticamente quando você adicionar uma referência para um serviço através do Visual Studio .NET 2005 (ou através do utilitário svcutil.exe) que, nas configurações do arquivo App.Config já está codificada uma versão pública do certificado, que é informada através do atributo encodedValue do elemento certificate que, por sua vez, está contido dentro da seção identity.

Depois da configuração do certificado, vamos falar sobre o binding que irá refletir exatamente a mesma configuração que fizemos no serviço do lado do servidor, ou seja, definiremos o atributo mode do elemento security para Message, e o atributo clientCredentialType do elemento message é definido também como UserName, ficando assim exatamente como a configuração estipulada no serviço.

Finalmente, temos a seção dos behaviors. Essa seção fornece um elemento chamado serviceCertificate. Esse elemento especifica o certificado que será utilizado pelo cliente. Esse elemento tem um sub-elemento chamado authentication que, por sua vez, possui um atributo chamado certificateValidationMode, o qual é extremamente importante na validação do certificado. Esse atributo recebe uma das opções fornecidas pelo enumerador X509CertificateValidationMode. Essas opções estão descritas na tabela abaixo:

Opção Descrição
ChainTrust

Esta opção instrui o WCF a confiar no certificado somente se ele foi emitido através de um orgão como a VeriSign.

Custom

O certificado é validado através de um validador customizado. Esse validador deve ser customizado pelo desenvolvedor, herdando o seu validador a partir da classe X509CertificateValidator.

None

Validação do certificado está desabilitada.

PeerOrChainTrust

Esta opção permite o WCF confiar em um certificado somente se ele foi emitido através de um orgão como a VeriSign ou se ele estiver dentro do repositório Trusted People do cliente.

PeerTrust

O certificado é validado se ele estiver dentro do repositório Trusted People do cliente.

Com isso, o arquivo de configuração do cliente, App.Config, fica da seguinte forma:

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
  <system.serviceModel>
    <client>
      <endpoint
        name="DevMindsService"
        address="http://localhost:2969/DevMinds.WebHostingCS/DefaultService.svc"
        behaviorConfiguration="ClientBehavior"
        binding="wsHttpBinding"
        bindingConfiguration="ClientBinding"
        contract="DevMinds.ClientUICS.localhost.IServiceContract">
        <identity>
          <certificate
            encodedValue="AwAAAAEAAAAUAAAAUJNV9NaKKu1ufLDJSReysIhSHokgAAAAAQAAALkBAAAwgg
                          G1MIIBY6ADAgECAhD8doIP5AdsgEtkMqF7eimCMAkGBSsOAwIdBQAwFjEUMBIG
                          A1UEAxMLUm9vdCBBZ2VuY3kwHhcNMDcwNDAzMTMxNjM3WhcNMzkxMjMxMjM1OT
                          U5WjAYMRYwFAYDVQQDEw1JQUNlcnRpZmljYXRlMIGfMA0GCSqGSIb3DQEBAQUA
                          A4GNADCBiQKBgQC/+fgp/kuwIVmhpJW2XFDdFQKT0hDRhbdsIvV8ikrUANCuii
                          ufPvo10FqMrVPqeowy+c2XxYpQ6lGeMx4QWVeZC9LdGCzli1UNKdarT6wBiBsK
                          qAxmb6lJkKnkL4HycepYckbT2H65oIDDnfFNv1TYUP1/gPHoz6bsIFCa4eXCMw
                          IDAQABo0swSTBHBgNVHQEEQDA+gBAS5AktBh0dTwCNYSHcFmRjoRgwFjEUMBIG
                          A1UEAxMLUm9vdCBBZ2VuY3mCEAY3bACqAGSKEc+41KpcNfQwCQYFKw4DAh0FAA
                          NBAGoc8S3JfsoQPRqwCIO0WYopE8vJ92IYLkxQ5k68BuN1mLUftbVoEv/TO/Y5
                          7ToFWzTsDMT5BfG37G1Y0P5Iq+Q=" />
        </identity>
      </endpoint>
    </client>
    <bindings>
      <wsHttpBinding>
        <binding name="ClientBinding">
          <security mode="Message">
            <message clientCredentialType="UserName" />
          </security>
        </binding>
      </wsHttpBinding>
    </bindings>
    <behaviors>
      <endpointBehaviors>
        <behavior name="ClientBehavior">
          <clientCredentials>
            <serviceCertificate>
              <authentication certificateValidationMode="PeerTrust" />
            </serviceCertificate>
          </clientCredentials>
        </behavior>
      </endpointBehaviors>
    </behaviors>
  </system.serviceModel>
</configuration>

Invocando os métodos

Como as configurações já estão definidas tanto do lado do servidor quanto do cliente, chega o momento em que devemos invocar os métodos que o serviço disponibiliza.

Basicamente, a chamada para os métodos não mudando absolutamente em nada. A única diferença é que devemos, antes de invocar o(s) método(s), informar o nome de usuário e senha para o proxy, que enviará essas credenciais para o serviço quando o método for invocado. O proxy expõe uma propriedade chamada ClientCredentials do tipo ClientCredentials. Essa classe possui uma propriedade chamada UserName do tipo UserNamePasswordClientCredential.

Essa classe habilita o usuário a configurar o userName e o password que o WCF deve utilizar quando estiver efetuando a autenticação. Essa simples classe possui duas propriedades que recebem uma string. Essas propriedades, auto-explicativas, são chamadas de Password e UserName. O exemplo (Windows Application) abaixo ilustra como devemos configurar essas propriedades, informando o userName e password:

using (localhost.ServiceContractClient c = new localhost.ServiceContractClient())
{
    c.ClientCredentials.UserName.UserName = "Claudia";
    c.ClientCredentials.UserName.Password = "123456";
    MessageBox.Show(c.DataAtual().ToString());
    MessageBox.Show(c.BoasVindas());
}

Recapitulando o código de implementação do serviço, o método BoasVindas somente poderá ser executado por usuários que estão contidos dentro da role User. Já o método DataAtual somente pode ser executado por usuários que estão contidos dentro da role Manager.

Como podemos reparar, passamos como userName o nome Claudia, que executa os dois métodos com sucesso pois este usuário está contido dentro das duas roles. Se alterarmos o userName para Juliano, que está contido somente dentro da role User, ao tentarmos executar o método DataAtual, que é permitido somente a usuários que estão contidos dentro da role Manager, uma exceção será atirada informando que o acesso foi negado.

Conclusão: O WCF possui uma grande variedade de formas de autenticação e autorização para os serviços. Neste artigo abordamos uma das formas de segurança que o WCF expõe, que é justamente a integração da autenticação e autorização com toda a infraestrutura que o ASP.NET 2.0 já fornece para os desenvolvedores de aplicações web e, como é o intuíto do WCF, toda a configuração para integrar com o ASP.NET 2.0, bem como a maioria da segurança do WCF, baseado em plug-and-play.

Windows RSS Platform

Navegando pela internet acabei achando este artigo, que introduz o Windows RSS Plataform. Essa plataforma permite a interação com os famosos feeds, geralmente utilizado em blogs, para o consumo em aplicações construídas por nós, sendo ela .NET ou não.

Quando instalamos o Internet Explorer 7.0, um novo componente COM, chamado Microsoft Feeds, é criado e, consequentemente, pode ser utilizado dentro de uma aplicação .NET através de Interop. Para exemplificar a utilização do mesmo, o artigo citado ilustra a sua utilização.

Para aqueles que desejam se aprofundar, este link do MSDN possui informações a nível dos tipos (classes, interfaces e enumeradores) disponíveis dentro deste componente.

Microsoft Service Configuration Editor

Entre as várias ferramentas que são adicionadas na máquina quando o Microsoft Windows Software Development Kit, uma delas é a Microsoft Service Configuration Editor.

Essa ferramenta permite, de uma forma visual, configurarmos um serviço WCF. A configuração vai desde a criação dos endpoints até a parte de diagnósticos do serviço. Para acessá-la, depois do SDK devidamente instalado, voce pode acessá-la através do seguinte endereço: C:Program FilesMicrosoft SDKsWindowsv6.0BinSvcConfigEditor.exe. A imagem abaixo exibe a sua interface,  consumindo um arquivo Web.Config (utilizado para quando o serviço utiliza o IIS como hosting):

Definindo a Interface padrão

Quando desejamos expor um componente .NET para o mundo COM, ele deve ter algumas configurações extras em relação aos componentes que são utilizados somente por aplicações .NET.

Uma das configurações necessárias é definirmos o atributo ClassInterfaceAttribute à classe que será acessada via COM. Esse atributo determinará qual será interface que será exposta para que o mundo COM possa consumí-la. O construtor deste atributo recebe como parametro um dos valores contidos no enumerador ClassInterfaceType. Quando o definimos com o valor ClassInterfaceType.None, indicará que a criação da Interface será fornecida por nós. Neste caso, ao registrar o componente com o Type Library Exporter (Tlbexp.exe), o mesmo será exposto com a primeira interface pública visível encontrada pelo utilitário, definindo assim, a interface padrão do componente para o mundo COM.

Mas e quando existerem mais que uma Interface no componente e, por algum motivo, queremos expor não a primeira Interface pública visível, mas a segunda ou a terceira. A versão 2.0 do .NET Framework introduz um novo atributo chamado ComDefaultInterfaceAttribute que, podemos expecificá-lo no componente. Em seu construtor, devemos especificar a Interface (através de um objeto Type) padrão para o mundo COM. O exemplo abaixo exemplifica o componente decorado com este atributo:

[ClassInterface(ClassInterfaceType.None)]
[ComDefaultInterface(typeof(ILogin)]
public class AuthenticationServices : IData, ILogin
{
     //Implementação…
}

Para consumir o componente no mundo COM, podemos fazer (exemplo em VB6):

[ Sem o atributo ComDefaultInterface ]
Dim authService As New AuthenticationServices
Dim login As ILogin
Set login = authService

authService.Update()
MsgBox login.Validate(“IA”, “Pa$$w0rd”)

[ Com o atributo ComDefaultInterface ]
Dim authService As New AuthenticationServices
Dim data As IData
Set data = authService

MsgBox authService.Validate(“IA”, “Pa$$w0rd”)
data.Update()

“VBísses”

Há algumas coisas que são muito mágicas (atalhos? :)) no VB.NET em relação ao C#. Acredito que isso exista justamente por efeitos de compatibilidade em relação ao que já existia no passado, em outras versões do Visual Basic.

Dois detalhes especiais que sempre explico durante os treinamentos e que gera uma boa discussão, é com relação aos módulos e as variávies estáticas do Visual Basic [.NET]:

1 – Módulos: Quando compilado, vira uma classe concreta com todos os seus membros definidos como estáticos (Shared). Bem, concordo que isso acaba sendo uma espécie de “atalho”, mas o grande problema com eles é que não são OO em design-time, ou seja, não é possível herdar de um módulo ou herdar alguma classe em um módulo. É importante dizer que eu não conheço o VB 6 e não sei qual o comportamento (depois da compilação) dos módulos e classes.

2 – Variáveis estáticas: Quando compilado, as variáveis estáticas são elevadas a campos privados da classe corrente. A principal diferença entre as variáveis estáticas e os membros privados do campo é o escopo, pois as variáveis estáticas somente são acessíveis onde foram declaradas; já os membro privados, podem ser acessados dentro de qualquer membro dentro da mesma classe onde o mesmo foi declarado.

Lembrem-se que eu gosto bastante de VB.NET. O post é somente para direcionar as pessoas que estão começando em novos projetos a seguir por um caminho que, ao meu ver (IMHO), é o correto.