Overview

URL Rewrite Module provides a rule-based rewriting mechanism for changing requested URLs before they get processed by web server. The module can be used to express URL rewriting logic that can use regular expressions or wildcards and can make rewriting decisions based on HTTP headers and server variables. While the primary purpose of the module is to rewrite requested URLs, it also has functionality to perform redirects, send custom responses or abort requests based on the logic expressed in the rewrite rules.

The installation package includes several additional components and hotfixes required by URL Rewrite Module. Refer to the KB articles for the hotfixes to get more details. In order to apply the hotfixes correctly without restarting the server, it is recommended that the WAS service is stopped before installing URL Rewrite Module. The following hotfixes will be installed with URL Rewrite Module:

• Update for IIS 7.0 FastCGI module (KB 954946);
• Hotfix for IIS 7.0 SetUri function (KB 949172)
• Hotfix for ASP.NET System.Web.dll (KB 957660)
• Microsoft Visual C++ 2008 SP1 Redistributable Package

If you already have URL Rewrite Module version 1.0 installed then the installation package will upgrade it to version 1.1. All rewrite rules in applicationHost.config and web.config files will be preserved during upgrade.

Important: In order to avoid reboot of the machine during upgrade, stop the IIS services by using the command as below:

net stop was /y & net stop wmsvc

After the upgrade is completed, run this command:

net start w3svc

If Web Management Service was running before installing URL Rewrite then start it by using the command below:

net start wmsvc

Features

The Microsoft URL Rewrite Module includes these key features:

• Rules-based URL rewriting engine. Rewrite rules are used to express the logic of what to compare/match the request URL with and what to do if comparison was successful. Web server and site administrators can use rewrite rule sets to define URL rewriting logic.

• Regular expression pattern matching. Rewrite rules can use ECMA-262 compatible regular expression syntax for pattern matching.

• Wildcard pattern matching. Rewrite rules can use Wildcard syntax for pattern matching

• Global and distributed rewrite rules. Global rules are used to define server-wide URL rewriting logic. These rules are defined within applicationHost.config file and they cannot be overridden or disabled on any lower configuration levels. Distributed rules are used to define URL rewriting logic specific to a particular configuration scope. This type of rules can be defined on any configuration level by using web.config files.

• Access to server variables and http headers. Server variables and HTTP headers provide additional information about current HTTP request. This information can be used to make rewriting decisions or to compose the output URL.

• Various rule actions. Instead of rewriting a URL, a rule may perform other actions, such as issue an HTTP redirect, abort the request, or send a custom status code to HTTP client.

• Support for IIS kernel mode and user mode output caching. IIS 7.0 output caching provides significant performance improvements for web applications. URL rewrite module is fully compatible with both types of output caching. This means that it is possible to safely cache responses for rewritten URL's and thus boost the performance of web applications that rely on URL rewriting.

• String manipulation functions. Built-in string manipulation functions can be used to convert URLs to lowercase and to perform URL encoding and decoding.

• Rewrite maps. Rewrite map is an arbitrary collection of name-value pairs that can be used within rewrite rules to generate the substitution URL during rewriting. Rewrite maps are particularly useful when you have a large set of rewrite rules, all of which use static strings (i.e. there is no pattern matching used). In those cases, instead of defining a large set of simple rewrite rules, you can put all the mappings between input URL and substitution URL as keys and values into the rewrite map, and then have one rewrite rule which references this rewrite map to look up substitution URL based on the input URL.

• Failed Request Tracing support. IIS7.0 Failed Request Tracing can be used to troubleshoot errors related to URL rewriting.

• Rule templates. Rule template is an extension for URL rewrite module user interface, that simplifies creation of rewrite rules for a particular task.  The GoLive release of the module includes 3 built-in rule templates, plus it allows plugging in any number of custom templates.

• UI for testing of regular expression and wildcard patterns. A GUI tool for testing rule patterns is included into the module's user interface. The tool can be used to quickly check how the regular expression or wildcard pattern works. Also, it can be used for troubleshooting and debugging of problems related to pattern matching.

• UI for managing rewrite rules and rewrite maps. Rewrite rules and rewrite maps can be added, removed and edited by using "URL Rewrite Module" feature in IIS Manager.

• GUI tool for importing of mod_rewrite rules. URL rewrite module includes a GUI tool for converting rewrite rules from mod_rewrite format into an IIS format.

Benefits

The Microsoft URL Rewrite Module 1.1 for IIS 7 provides flexible rules-based rewrite engine that can be used to perform broad spectrum of URL manipulation tasks, including, but not limited to:

• Enabling user friendly and search engine friendly URL with dynamic web applications;
• Rewriting URL’s based on HTTP headers and server variables;
• Web site content management;
• Controlling access to web site content.
  

Requirements

• Windows Server 2008 or Windows Vista SP1; Windows Server 2008 R2 or Windows 7
• Internet Information Services 7 must be installed
• IIS 7 supports a new shared configuration environment, which must be disabled on each server in a web farm before installing the URL Rewrite Module for each node. Note: shared configuration can be re-enabled after the URL Rewrite Module has been installed.