Visão geral de módulos do IIS

pela Equipe dos IIS, Mike Volodarsky

Compatibilidade

Introdução

O conjunto de recursos do servidor Web dos IIS 7 e posteriores é componentizado em mais de trinta módulos independentes.

Um módulo é uma DLL Win32 (módulo nativo) ou um tipo .NET 2.0 contido em um assembly (módulo gerenciado). Semelhante a um conjunto de blocos de construção, os módulos são adicionados ao servidor para fornecer a funcionalidade desejada para seus aplicativos. Da mesma forma, todos os módulos dos IIS podem ser removidos ou substituídos por módulos personalizados desenvolvidos usando as APIs C++ dos IIS ou as conhecidas APIs do ASP.NET 2.0.

Este artigo descreve tarefas comuns de gerenciamento de módulo dos IIS e detalha cada módulo, incluindo suas configurações e o potencial efeito que uma remoção de módulo tem no servidor Web. Os exemplos de gerenciamento são fornecidos tanto usando o gerenciador gráfico dos IIS quanto a ferramenta de linha de comando AppCmd.

Pré-requisitos

Para seguir as etapas neste documento, é melhor fazer uma instalação completa dos IIS.

Para executar uma instalação completa dos IIS no Windows Vista, Windows 7, Windows 8, Windows 10 ou Windows 11

1. Clique em Iniciar e em Painel de Controle.
2. No Painel de Controle, clique em Programas.
3. Em Programas e Recursos, clique em Ativar ou desativar recursos do Windows.
4. Na caixa de diálogo Recursos do Windows, expanda os Serviços de Informações da Internet e selecione todos os recursos.
   Talvez seja necessário expandir algumas categorias para selecionar todos os recursos nessa categoria.
5. Clique em OK.

Para executar uma instalação completa dos IIS no Windows Server 2008/R2, no Windows Server 2012/R2 ou no Windows Server 2016

1. Abra Gerenciador do Servidor>Funções e selecione Servidor Web (IIS).
2. Verifique todos os recursos em Servidor Web.

Introdução aos Módulos

Para adicionar um módulo ao servidor, você deve executar duas etapas:

1. Instale um módulo no servidor (somente módulos nativos).
2. Habilite o módulo em um aplicativo.

A primeira etapa registra o módulo globalmente com o servidor, disponibilizando-o em cada processo de trabalho do servidor. É necessário apenas para módulos nativos devido à natureza confiável do código nativo e está disponível apenas para os administradores.

A segunda etapa permite que o módulo seja executado em um aplicativo específico e efetivamente permite que o administrador do aplicativo controle os recursos do servidor habilitados para o aplicativo. Esta etapa permite que módulos nativos instalados e módulos gerenciados sejam habilitados para cada aplicativo.

Para instalar um módulo nativo

Para instalar um módulo nativo, ele deve ser registrado no servidor usando uma das opções abaixo:

• Editando manualmente o repositório de configuração dos IIS. Nos IIS 7.5 e posteriores, você pode usar o Editor de Configuração no Gerenciador dos IIS.
• Usando o Gerenciador dos IIS
• Usando a ferramenta de linha de comando AppCmd.exe

Todas essas três opções resultam na entrada do módulo sendo adicionada à seção de configuração dos IIS <globalModules>, que pode ser definida apenas no nível do servidor. Para examinar o conteúdo desta seção, abra o arquivo de configuração raiz localizado em %windir%\system32\inetsrv\config\applicationhost.config e pesquise a cadeia de caracteres "<globalModules>".

Após uma instalação completa dos IIS, esta seção contém uma entrada para cada um dos módulos nativos enviados com os IIS, especificando um nome e o caminho para a DLL do módulo:

<globalModules>
    <add name="DefaultDocumentModule" image="%windir%\system32\inetsrv\defdoc.dll" />
    <add name="DirectoryListingModule" image="%windir%\system32\inetsrv\dirlist.dll" />
    <add name="StaticFileModule" image="%windir%\system32\inetsrv\static.dll" />
    ...

</globalModules>

Todos esses módulos são descritos em detalhes mais adiante neste documento.

Para desinstalar um módulo nativo

Você pode desinstalar um módulo nativo se esse módulo não estiver mais em uso no servidor ou se quiser substituí-lo por outro módulo. Remova a entrada do módulo correspondente da lista de configuração <globalModules> e a entrada associada na lista de configuração <modules> usando uma das seguintes opções:

• Editando manualmente o repositório de configuração dos IIS. Nos IIS 7.5 e superiores, você pode usar o Editor de Configuração.
• Usando o Gerenciador dos IIS
• Usando a ferramenta de linha de comando AppCmd.exe

Habilitar um módulo para um aplicativo

Um módulo deve ser habilitado antes de fornecer serviço para um aplicativo específico. Para habilitar um módulo nativo, ele deve primeiro ser instalado no servidor (consulte a seção anterior, Para instalar um módulo nativo).

Um módulo gerenciado não requer instalação e pode ser habilitado diretamente para cada aplicativo. Isso permite que os aplicativos incluam seus módulos gerenciados diretamente no aplicativo registrando-os no arquivo web.config do aplicativo e fornecendo a implementação em diretórios /BIN ou /App_Code.

Para habilitar um módulo, siga um destes procedimentos:

• Edite manualmente o repositório de configuração dos IIS, globalmente para habilitar o módulo para todos os aplicativos no servidor ou em um arquivo web.config específico localizado em cada aplicativo para o qual você gostaria de habilitar este módulo. Nos IIS 7.5 ou posteriores, você pode usar o Editor de Configuração.
• Usar o Gerenciador dos IIS
• Usar a ferramenta de linha de comando AppCmd.exe

Todas essas três opções adicionam a entrada do módulo à seção de configuração <modules> dos IIS, que pode ser definida no nível do servidor e do aplicativo. Examine o conteúdo desta seção abrindo o arquivo de configuração raiz localizado em %windir%\system32\inetsrv\config\applicationhost.config e pesquisando a cadeia de caracteres "<modules>".

Ao contrário dos módulos nativos, um módulo gerenciado não requer a adição de uma entrada à seção de configuração <globalModules>.

Após uma instalação completa dos IIS, a seção de configuração contém uma entrada para cada um dos módulos (gerenciados e nativos) que foram enviados com os IIS. A entrada indica que todos esses módulos estão habilitados por padrão para todos os aplicativos no servidor. Cada entrada nesta seção especifica o nome de um módulo nativo que foi instalado anteriormente no servidor ou o nome e o tipo .NET de um módulo gerenciado:

<modules>
<add name="DefaultDocumentModule" />
<add name="DirectoryListingModule" />
<add name="StaticFileModule"/>
 ...

</modules>

Desabilitar um módulo em um aplicativo

Desabilite um módulo se ele não estiver mais em uso no aplicativo ou se você quiser substituí-lo por outro módulo. Para desabilitar um módulo, remova a entrada de módulo correspondente da coleção de configurações <modules> de um aplicativo específico no qual você não deseja que este módulo seja executado. Se o módulo estiver habilitado no nível do servidor, remova-o para desabilitá-lo em todos os aplicativos no servidor por padrão. Use uma das seguintes opções para remover o módulo no nível do servidor:

• Edite manualmente a seção de configuração <system.webServer>/<modules> em seu aplicativo.
• Use o Gerenciador dos IIS.
• Use a ferramenta de linha de comando AppCmd.exe.

Depois que o módulo for removido do aplicativo, ele não estará ativo nesse aplicativo. No entanto, se o módulo for nativo, ele ainda será carregado no processo de trabalho do servidor e poderá ser usado por outros aplicativos que não o removeram.

Precondições

Há outro atributo em uma entrada de módulo chamada pré-condição. O mecanismo principal dos IIS usa pré-condições para determinar quando habilitar um módulo específico. Os motivos de desempenho, por exemplo, podem determinar que você só deseja executar módulos gerenciados para solicitações que também vão para um manipulador gerenciado. A pré-condição no exemplo a seguir (precondition="managedHandler") habilita apenas o módulo de autenticação de formulários para solicitações que também são tratadas por um manipulador gerenciado, como solicitações para .aspx ou arquivos .asmx:

<add name="FormsAuthentication"type="System.Web.Security.FormsAuthenticationModule" preCondition="managedHandler" />

Se você remover o atributo precondition="managedHandler", a autenticação de formulários também se aplicará ao conteúdo que não é atendido por manipuladores gerenciados, como extensões .html, .jpg, .doc, mas também para extensões ASP clássicas (.asp) ou PHP (.php). Consulte "Como aproveitar o pipeline integrado dos IIS" para obter um exemplo de como habilitar os módulos do ASP.NET a serem executados para todo o conteúdo.

Você também pode usar um atalho para permitir que todos os módulos gerenciados (ASP.NET) sejam executados para todas as solicitações em seu aplicativo, independentemente da pré-condição "managedHandler". Para permitir que todos os módulos gerenciados sejam executados para todas as solicitações sem configurar cada entrada de módulo para remover a pré-condição "managedHandler", use a propriedade runAllManagedModulesForAllRequests na seção <modules>:

<modules runAllManagedModulesForAllRequests="true"/>

Quando você usa essa propriedade, a pré-condição "managedHandler" não tem efeito e todos os módulos gerenciados serão executados para todas as solicitações.

Consultar, adicionar e remover módulos usando o Gerenciador dos IIS

O Gerenciador dos IIS fornece uma maneira fácil de consultar, adicionar ou remover módulos.

1. Para abrir o Gerenciador dos IIS, clique em Iniciar, digite inetmgr na caixa Pesquisar e pressione ENTER.
2. Clique no nome do computador do servidor IIS.
3. Clique no ícone Módulos na categoria IIS.

Figura 1: Gerenciador dos IIS

Para gerenciar os módulos habilitados para um aplicativo específico

1. Conecte-se a esse aplicativo usando o modo de exibição de árvore à esquerda.
2. Navegue para painel do recurso Módulos.
3. Clique em Adicionar Módulo Gerenciado para adicionar um Módulo Gerenciado ao seu aplicativo. Adicionar o Módulo Nativo só permite adicionar um módulo que já está registrado no nível do servidor.

Para remover um módulo do aplicativo

1. Clique no módulo na lista. A tarefa Remover é exibida no painel esquerdo.
2. Clique em Remover.

Figura 2: Lista de módulos no Gerenciador dos IIS

Gerenciar módulos pela linha de comando

Para gerenciar rapidamente módulos pela linha de comando ou automatizar tarefas de gerenciamento de módulos, use a ferramenta de linha de comando AppCmd.exe.

Para instalar um módulo usando o AppCmd.exe

No Prompt de Comando, digite o comando a seguir, substituindo valores em itálico pelos valores do módulo em seu computador.

Appcmd.exe install module /name:MODULE_NAME /image:PATH_TO_DLL

Por exemplo, o comando a seguir instala o módulo Default Document.

%windir%\system32\inetsrv\appcmd.exe install module /name:DefaultDocumentModule /image:%windir%\system32\inetsrv\defdoc.dll

Se você executar o comando em um computador onde o módulo já esteja carregado, receberá uma mensagem de erro semelhante à seguinte:

ERROR (message:Falha ao adicionar elemento de coleção duplicado "DefaultDocumentModule".)

Para desinstalar um módulo usando o AppCmd.exe

No Prompt de Comando, digite o comando a seguir, substituindo valores em itálico pelos valores do módulo em seu computador.

Appcmd.exe uninstall module MODULE_NAME

Por exemplo, o comando a seguir desinstala o módulo Default Document. Esse comando é fornecido apenas como exemplo. Você só deve executá-lo em um servidor de teste.

%windir%\system32\inetsrv\appcmd.exe uninstall module DefaultDocumentModule

Para listar os módulos habilitados para um aplicativo ou globalmente

No Prompt de Comando, digite o comando a seguir, substituindo valores no texto itálico pelos valores do módulo em seu computador.

Appcmd.exe list modules [/app.name:APPLICATION_NAME]

Por exemplo, o comando a seguir lista os módulos habilitados para o Site Padrão.

%windir%\system32\inetsrv\appcmd.exe list modules /app.name:"Default Web Site"

E esse comando lista os módulos instalados globalmente.

%windir%\system32\inetsrv\appcmd.exe list modules

Para habilitar um módulo para um aplicativo específico ou globalmente

No Prompt de Comando, digite o comando a seguir, substituindo valores no texto itálico pelos valores do módulo em seu computador.

Appcmd.exe add module /name:MODULE_NAME /type:MGD_TYPE

Por exemplo, o comando a seguir adiciona o módulo Forms Authentication ao Site Padrão.

%windir%\system32\inetsrv\appcmd.exe add module /name:FormsAuthentication /type:System.Web.Security.FormsAuthenticationModule /app.name:"Default Web Site"

E esse comando adiciona o módulo Forms Authentication globalmente.

%windir%\system32\inetsrv\appcmd.exe add module /name:FormsAuthentication /type:System.Web.Security.FormsAuthenticationModule

Para desabilitar um módulo para um aplicativo específico ou globalmente

No Prompt de Comando, digite o comando a seguir, substituindo valores no texto itálico pelos valores do módulo em seu computador.

Appcmd.exe delete module MODULE_NAME [/app.name:APPLICATION_NAME]

Por exemplo, o comando a seguir remove o módulo Forms Authentication do Site Padrão.

%windir%\system32\inetsrv\appcmd.exe delete module FormsAuthentication /app.name:"Default Web Site"

E esse comando remove o módulo Forms Authentication globalmente.

%windir%\system32\inetsrv\appcmd.exe delete module FormsAuthentication

Para obter mais ajuda sobre a sintaxe de cada um dos comandos do AppCmd.exe

Para exibir os comandos com suporte no objeto Module, digite o seguinte comando:

Appcmd.exe module /?

Para exibir o uso de cada comando, digite o seguinte comando:

Appcmd.exe install module /?Appcmd add module /?

Referência do módulo

O servidor IIS está pronto para personalização. Leia a lista a seguir com cuidado para evitar efeitos colaterais, perda de recursos ou remoção de recursos de segurança.

Módulos utilitários

Esses módulos não fornecem serviços de solicitação, mas auxiliam o mecanismo de servidor com sua operação interna.

Módulos gerenciados: