Desabilitar o protocolo de documentação dos serviços Web ASP.NET

  • Artigo

Este artigo descreve como desabilitar o protocolo de documentação para ASP.NET serviços Web.

Versão original do produto: ASP.NET
Número de KB original: 815149

Resumo

ASP.NET serviços Web facilitam o desenvolvimento de clientes de serviços Web gerando automaticamente documentação que descreve como se comunicar com o serviço Web. Os serviços Web que têm o protocolo de documentação habilitado geram uma página formatada em HTML quando uma solicitação de navegador é recebida. Esta página formatada em HTML descreve as seguintes informações:

  • As operações com suporte
  • Os parâmetros que cada operação aceita
  • O tipo de dados que devem ser passados nestes parâmetros

O protocolo de documentação também gera um arquivo WSDL (Linguagem de Descrição dos Serviços Web) formatado por XML. Esse arquivo foi projetado para permitir que os aplicativos entendam como estruturar solicitações para o serviço Web.

Essas informações podem ser úteis para desenvolvedores, especialmente desenvolvedores que criam clientes para serviços Web públicos. No entanto, revelar informações detalhadas sobre a funcionalidade de serviços Web privados aumenta o risco de que o serviço Web seja usado indevidamente por um invasor mal-intencionado. O protocolo de documentação sempre descreve todas as funções e parâmetros de um serviço Web, mesmo que apenas um subconjunto dessas funções se destine a ser acessível publicamente.

Remover o protocolo de documentação

Para desabilitar o protocolo de serviços Web de documentação de um aplicativo ASP.NET, siga estas etapas:

  1. Abra o arquivo web.config do diretório raiz do aplicativo Web em um editor de texto (por exemplo, Bloco de Notas). Se o arquivo web.config não existir, crie um arquivo deweb.config para o aplicativo ASP.NET.

  2. Adicione o <webServices> elemento de configuração ao system.web elemento no arquivo web.config .

  3. <webServices> No elemento, adicione o <protocols> elemento de configuração.

  4. <protocols> No elemento, adicione o remove name="Documentation" elemento.

    O exemplo a seguir mostra o <webServices> elemento de configuração adicionado a um arquivo web.config para desabilitar a geração automática de documentação amigável ao navegador:

    <webServices>
    <protocols>
        <remove name="Documentation"/>
    </protocols>
</webServices>

  5. Salve o arquivo web.config .

Referências