<-
Apache > Serveur HTTP > Documentation > Version 2.2 > Modules

Module Apache mod_rewrite

Langues Disponibles:  en  |  fr 

Description:Ce module fournit un moteur de réécriture à base de règles permettant de réécrire les URLs des requêtes à la volée
Statut:Extension
Identificateur de Module:rewrite_module
Fichier Source:mod_rewrite.c
Compatibilité:Disponible à partir de la version 1.3 d'Apache

Sommaire

Ce module utilise un moteur de réécriture à base de règles (basé sur un interpréteur d'expressions rationnelles) pour réécrire les URLs des requêtes à la volée. Il accepte un nombre illimité de règles, ainsi q'un nombre illimité de conditions attachées à chaque règle, fournissant ainsi un mécanisme de manipulation d'URL vraiment souple et puissant. Les manipulations d'URL peuvent dépendre de nombreux tests, des variables du serveur, des variables d'environnement, des en-têtes HTTP ou de l'horodatage. On peut même lancer des requêtes vers une base de données externe sous divers formats, afin d'obtenir une sélection d'URL très fine.

Ce module agit sur l'ensemble de l'URL (la partie concernant le chemin incluse) au niveau du serveur (httpd.conf) mais aussi au niveau du répertoire (.htaccess), et peut générer des parties de chaîne de requête comme résultat. Le résultat de la réécriture peut renvoyer vers un sous-traitement interne, une redirection vers une requête externe, ou même vers le flux d'un proxy interne.

Vous trouverez d'avantage de détails, discussions et exemples dans la documentation détaillée sur mod_rewrite.

Directives

Sujets

Voir aussi

top

Marquage des caractères spéciaux

Depuis Apache 1.3.20, les caractères spéciaux dans les chaînes de test et les chaînes de Substitution peuvent être échappés (c'est à dire traités comme des caractères normaux sans tenir compte de leur signification en tant que caractère spécial), en les faisant précéder d'un caractère anti-slash ('\'). En d'autres termes, vous pouvez inclure un véritable signe "dollar" dans une chaîne de Substitution en utilisant '\$' ; ceci empêche mod_rewrite de le traiter comme une référence arrière.

top

Variables d'environnement

Ce module conserve le contenu de deux variables d'environnement CGI/SSI additionnelles (non standards) nommées SCRIPT_URL et SCRIPT_URI. Celles-ci contiennent l'adresse logique vue du Web de la ressource concernée, tandis que les variables CGI/SSI standards SCRIPT_NAME et SCRIPT_FILENAME contiennent l'adresse physique de la ressource vue du système.

Note : ces variables conservent l'URI/URL telle qu'elle était à l'arrivée de la requête, c'est à dire avant tout processus de réécriture. Il est important de le savoir car le processus de réécriture est principalement utilisé pour réécrire des URLs logiques en chemins physiques.

Exemple

SCRIPT_NAME=/sw/lib/w3s/tree/global/u/rse/.www/index.html
SCRIPT_FILENAME=/u/rse/.www/index.html
SCRIPT_URL=/u/rse/
SCRIPT_URI=http://en1.engelschall.com/u/rse/
top

Réécriture et hôtes virtuels

Par défaut, les hôtes virtuels n'héritent pas de la configuration de mod_rewrite telle qu'elle est définie dans le contexte du serveur principal. Pour que la configuration du serveur principal s'applique aux hôtes virtuels, vous devez insérez les directives suivantes dans chaque section <VirtualHost> :

RewriteEngine On
RewriteOptions Inherit

top

Solutions pratiques

Vous trouverez de nombreux exemples d'utilisation courante (et moins courante) de mod_rewrite dans la documentation spécifique à la réécriture.

top

RewriteBase Directive

Description:Définit l'URL de base pour les réécritures au niveau répertoire
Syntaxe:RewriteBase chemin URL
Défaut:None
Contexte:répertoire, .htaccess
AllowOverride:FileInfo
Statut:Extension
Module:mod_rewrite

La directive RewriteBase permet de spécifier le préfixe d'URL à utiliser dans un contexte de répertoire (htaccess) pour les directives RewriteRule qui réécrivent vers un chemin relatif.

Cette directive est obligatoire si vous utilisez un chemin relatif dans une substitution, et dans un contexte de répertoire (htaccess), sauf si au moins une de ces conditions est vérifiée :

Dans l'exemple ci-dessous, la directive RewriteBase est nécessaire afin d'éviter une réécriture en http://example.com/opt/myapp-1.2.3/welcome.html car la ressource n'était pas relative à la racine des documents. Cette erreur de configuration aurait conduit le serveur à rechercher un répertoire "opt" à la racine des documents.

DocumentRoot /var/www/example.com
Alias /myapp /opt/myapp-1.2.3
<Directory /opt/myapp-1.2.3>
RewriteEngine On
RewriteBase /myapp/
RewriteRule ^index\.html$  welcome.html 
</Directory>
top

RewriteCond Directive

Description:Définit une condition qui devra être satisfaite pour que la réécriture soit effectuée
Syntaxe: RewriteCond chaîne de test expression de comparaison
Contexte:configuration du serveur, serveur virtuel, répertoire, .htaccess
AllowOverride:FileInfo
Statut:Extension
Module:mod_rewrite

La directive RewriteCond définit une condition d'application d'une certaine règle. Une ou plusieurs directives RewriteCond peuvent précéder une directive RewriteRule. La règle qui suit n'est appliquée que si l'état actuel de l'URI correspond à son modèle, et si les conditions sont satisfaites.

chaîne de test est une chaîne de caractères qui peut contenir, en plus du plein texte, les constructions étendues suivantes :

Autres points à connaître :

  1. Les variables SCRIPT_FILENAME et REQUEST_FILENAME ont la même valeur - celle du champ filename de la structure interne du serveur Apache request_rec. Le premier nom est bien connu en tant que variable CGI, alors que le second est équivalent à REQUEST_URI (qui contient la valeur du champ uri de la structure request_rec).

    Si une substitution survient, et si la réécriture se poursuit, la valeur des deux variables est mise à jour en conséquence.

    Dans un contexte de serveur principal (c'est à dire avant que la requête n'ait été mise en relation avec le système de fichiers), SCRIPT_FILENAME et REQUEST_FILENAME ne peuvent pas contenir le chemin local entier dans le système de fichiers, car celui-ci n'a pas encore été déterminé à ce stade du traitement. Les deux variables contiennent alors la valeur de REQUEST_URI. Pour obtenir le chemin local entier associé à la requête dans le système de fichiers dans un contexte de serveur principal, utilisez une recherche avant %{LA-U:REQUEST_FILENAME} pour déterminer la valeur finale de REQUEST_FILENAME.

  2. On peut aussi utiliser %{ENV:variable}, où variable peut être remplacé par toute variable d'environnement. Ces variables sont recherchées dans les structures internes d'Apache, et (si elles n'y figurent pas) via getenv() depuis le processus du serveur Apache.
  3. Que mod_ssl soit chargé ou non, on peut utiliser %{SSL:variable}, où variable peut être remplacé par le nom d'une variable d'environnement SSL, mais la valeur produite sera toujours une chaîne de caractères vide si mod_ssl n'est pas chargé. Exemple : %{SSL:SSL_CIPHER_USEKEYSIZE} peut correspondre à 128.
  4. Pour obtenir la valeur d'un en-tête contenu dans une requête HTTP, on peut toujours utiliser %{HTTP:header}, où header peut être remplacé par tout nom d'en-tête MIME HTTP. Exemple : %{HTTP:Proxy-Connection} est la valeur de l'en-tête HTTP ``Proxy-Connection:''.

    Si une condition contient un en-tête HTTP, il est ajouté à l'en-tête Vary de la réponse dans le cas où la condition est évaluée à true pour la requête. Dans le cas contraire, il n'est pas ajouté. L'ajout de l'en-tête HTTP à l'en-tête Vary de la réponse s'avère nécessaire pour une mise en cache correcte.

    Il faut garder à l'esprit que les conditions suivent une logique de court-circuit en cas de présence du drapeau 'ornext|OR', si bien que certaines d'entre elles sont susceptibles de ne pas être évaluées du tout.

  5. On peut utiliser %{LA-U:variable} pour les recherches en avant qui effectuent une sous-requête interne (basée sur l'URL), pour déterminer la valeur finale de variable. Cela peut servir à accéder à une variable (nécessaire pour une réécriture) qui n'est pas disponible dans la situation présente, mais le sera dans une phase ultérieure.

    Par exemple, pour effectuer une réécriture qui tient compte de la variable REMOTE_USER dans un contexte niveau serveur (fichier httpd.conf), vous devez utiliser %{LA-U:REMOTE_USER} ; cette variable est définie au cours des phases d'autorisation, qui interviennent après la phase de traduction de l'URL (pendant laquelle agit mod_rewrite).

    Par contre, comme mod_rewrite implémente son contexte niveau répertoire (fichier .htaccess) via la phase Fixup de l'API, et comme les phases d'autorisation interviennent avant cette phase, vous ne pouvez utiliser %{REMOTE_USER} que dans le contexte niveau serveur.

  6. On peut utiliser %{LA-F:variable} pour effectuer une sous-requête interne (basée sur un nom de fichier), pour déterminer la valeur finale de variable. La plupart du temps, elle est identique à LA-U vue précédemment.

expression de comparaison est une expression rationnelle qui est appliquée à l'instance actuelle de chaîne de test. chaîne de test est d'abord évaluée, puis comparée à l'expression de comparaison.

A savoir : expression de comparaison est une expression rationnelle compatible perl avec quelques extensions :

  1. Vous pouvez préfixer l'expression avec un caractère '!' (point d'exclamation) pour indiquer une expression de non-correspondance.
  2. Il existe certaines variantes spéciales d'expressions de comparaison. A la place d'une expression rationnelle, vous pouvez utiliser :
    • '<expression' (inférieur au sens lexicographique)
      Traite l'expression comme une chaîne de caractères et la compare lexicographiquement à chaîne de test. La condition est satisfaite si chaîne de test est inférieure au sens lexicographique à l'expression.
    • '>expression' (supérieur au sens lexicographique)
      Traite l'expression comme une chaîne de caractères et la compare lexicographiquement à chaîne de test. La condition est satisfaite si chaîne de test est supérieure au sens lexicographique à l'expression.
    • '>expression' (égal au sens lexicographique)
      Traite l'expression comme une chaîne de caractères et la compare lexicographiquement à chaîne de test. La condition est satisfaite si chaîne de test est égale au sens lexicographique à l'expression (les deux chaînes sont exactement identiques, caractère pour caractère). Si expression est "" (deux guillemets), chaîne de test est comparée à la chaîne vide.
    • '-d' (est un répertoire)
      Traite chaîne de test comme un chemin et vérifie s'il existe ou pas, et s'il s'agit d'un répertoire.
    • '-f' (est un fichier régulier)
      Traite chaîne de test comme un chemin et vérifie s'il existe ou pas, et s'il s'agit d'un fichier régulier.
    • '-s' (est un fichier régulier d'une certaine taille)
      Traite chaîne de test comme un chemin et vérifie s'il existe ou pas, et s'il s'agit d'un fichier régulier dont la taille est supérieure à zéro.
    • '-l' (est un lien symbolique)
      Traite chaîne de test comme un chemin et vérifie s'il existe ou pas, et s'il s'agit d'un lien symbolique.
    • '-x' (a le droit d'exécussion)
      Traite chaîne de test comme un chemin et vérifie s'il existe ou pas, et a le droit d'exécution. Ce droit est déterminé en accord avec le système d'exploitation sous-jacent.
    • '-F' (test de l'existence d'un fichier via une sous-requête)
      Vérifie si chaîne de test est un fichier valide, accessible à travers tous les contrôles d'accès du serveur actuellement configurés pour ce chemin. C'est une sous-requête interne qui effectue cette vérification - à utiliser avec précautions car les performances du serveur peuvent s'en trouver affectées !
    • '-U' (test de l'existence d'une URL via une sous-requête)
      Vérifie si chaîne de test est une URL valide, accessible à travers tous les contrôles d'accès du serveur actuellement configurés pour ce chemin. C'est une sous-requête interne qui effectue cette vérification - à utiliser avec précautions car les performances du serveur peuvent s'en trouver affectées !

      Ce drapeau ne renvoie que des informations concernant le contrôle d'accès, l'authentification et l'autorisation. Il ne renvoie pas d'informations concernant le code d'état que le gestionnaire configuré (static file, CGI, proxy, etc...) aurait, quant à lui, retourné.

    Note :

    Tous ces tests peuvent aussi être préfixés par un point d'exclamation ('!') pour inverser leur signification.
  3. Vous pouvez aussi définir certains drapeaux pour l'expression de comparaison en ajoutant ces [drapeaux] comme troisième argument de la directive RewriteCond, où drapeaux est un sous-ensemble séparé par des virgules des drapeaux suivants :
    • 'nocase|NC' (no case)
      Rend le test insensible à la casse - il n'est pas fait de distinction entre majuscules et minuscules, à la fois dans le développement de chaîne de test et dans expression de comparaison. Ce drapeau n'est pris en compte que lors d'une comparaison entre chaîne de test et expression de comparaison. Il ne l'est pas pour les vérification par sous-requêtes ou sur le système de fichiers.
    • 'ornext|OR' (ou condition suivante)
      Permet de chaîner les conditions de règles avec un OU au lieu du AND implicite. Exemple typique :
      RewriteCond %{REMOTE_HOST}  ^hote1  [OR]
      RewriteCond %{REMOTE_HOST}  ^hote2  [OR]
      RewriteCond %{REMOTE_HOST}  ^hote3
      RewriteRule ...règles concernant tous ces hôtes...
      Sans ce drapeau, les paires condition/règle devraient être écrites trois fois.
    • 'novary|NV' (no vary)
      Si la condition contient un en-tête HTTP, ce drapeau empêche ce dernier d'être ajouté à l'en-tête Vary de la réponse.
      L'utilisation de ce drapeau peut provoquer une mise en cache incorrecte de la réponse, si la représentation de cette réponse varie avec la valeur de l'en-tête considéré. Ce drapeau ne devrait donc être utilisé que si l'on maîtrise parfaitement le fonctionnement de l'en-tête Vary.

Exemple :

Pour réécrire la page d'accueil d'un site en fonction de l'en-tête ``User-Agent:'' de la requête, vous pouvez utiliser ce qui suit :

RewriteCond  %{HTTP_USER_AGENT}  ^Mozilla
RewriteRule  ^/$                 /homepage.max.html  [L]

RewriteCond  %{HTTP_USER_AGENT}  ^Lynx
RewriteRule  ^/$                 /homepage.min.html  [L]

RewriteRule  ^/$                 /homepage.std.html  [L]

Explications : si vous utilisez un navigateur (Netscape Navigator, Mozilla etc) qui s'identifie comme 'Mozilla', vous accèderez à la page d'accueil max (qui peut contenir des frames, ou d'autres ressources particulières). Si vous utilisez le navigateur Lynx (qui est un navigateur basé sur le texte), vous accèderez à une page d'accueil min (qui peut être une version conçue pour une navigation simple basée sur le texte). Si aucune de ces conditions n'est satisfaite (vous utilisez tout autre navigateur, ou votre navigateur s'identifie de manière non standard), vous accèderez à la page d'accueil std (standard).

top

RewriteEngine Directive

Description:Active ou désactive l'exécution du moteur de réécriture
Syntaxe:RewriteEngine on|off
Défaut:RewriteEngine off
Contexte:configuration du serveur, serveur virtuel, répertoire, .htaccess
AllowOverride:FileInfo
Statut:Extension
Module:mod_rewrite

La directive RewriteEngine active ou désactive l'exécution du moteur de réécriture. Si sa valeur est off, ce module n'exécutera aucun traitement et ne mettra pas à jour les variables d'environnement SCRIPT_URx.

Pour désactiver le module, il vaut mieux utiliser cette directive que commenter toutes les directives RewriteRule !

Notez que les hôtes virtuels n'héritent pas des configurations de réécriture. Ceci implique que vous devez insérer une directive RewriteEngine on dans chaque hôte virtuel pour lequel vous souhaitez utiliser des règles de réécriture.

Les directives RewriteMap du type prg ne sont pas prises en compte au cours de l'initialisation du serveur si elle ont été définies dans un contexte où la directive RewriteEngine n'a pas été définie à on.

top

RewriteLock Directive

Description:Définit le nom du fichier verrou utilisé pour la synchronisation de RewriteMap
Syntaxe:RewriteLock chemin du fichier verrou
Contexte:configuration du serveur
Statut:Extension
Module:mod_rewrite

Cette directive définit le nom du fichier utilisé comme fichier verrou de synchronisation nécessaire à mod_rewrite pour communiquer avec les programmes liés à RewriteMap. Définissez ce fichier verrou dans un chemin local (et non sur un montage NFS) si vous voulez utiliser un programme de comparaison pour la réécriture. Il n'est pas nécessaire pour les autres types de comparaison pour la réécriture.

top

RewriteLog Directive

Description:Définit le nom du fichier utilisé pour la journalisation des traitements du moteur de réécriture
Syntaxe:RewriteLog chemin du fichier journal|redirection vers un pipe
Contexte:configuration du serveur, serveur virtuel
Statut:Extension
Module:mod_rewrite

La directive RewriteLog définit le nom du fichier dans lequel le serveur journalise tout processus de réécriture qu'il effectue. Si le nom ne commence pas par un slash ('/'), il est considéré comme relatif à la Racine du serveur. Cette directive ne doit apparaître qu'une seule fois dans la configuration du serveur.

Il est déconseillé de positionner chemin du fichier journal à /dev/null pour désactiver la journalisation des processus de réécriture, car même si le moteur de réécriture n'envoie plus sa sortie dans un fichier, il continue à créer un fichier journal en interne, ce qui va avoir pour effet de ralentir le serveur sans fournir aucun avantage à l'administrateur ! Pour désactiver la journalisation, vous pouvez soit supprimer ou commenter la directive RewriteLog, soit utiliser RewriteLogLevel 0 !

Le format de fichier journal RewriteLog se présente comme suit :

Description Exemple
Adresse IP de l'hôte distant 192.168.200.166
Nom de login didtanten général "-"
nom d'authentification de l'utilisateur HTTPnom d'utilisateur, ou "-" si non authentifié
Date et heure de la requête[28/Aug/2009:13:09:09 --0400]
Serveur virtuel et son identifiant[www.example.com/sid#84a650]
Identifiant de la requête et indication éventuelle qu'il s'agit d'une sous-requête[rid#9f0e58/subreq]
Niveau de sévérité de l'entrée du journal(2)
Message d'erreur au format texteforcing proxy-throughput with http://127.0.0.1:8080/index.html

Sécurité

Se référer au document Conseils à propos de la sécurité dans Apache pour plus de détails sur la manière dont votre sécurité pourrait être compromise si le répertoire où se trouvent les fichiers journaux est inscriptible par quiconque autre que l'utilisateur qui démarre le serveur.

Exemple

# Journalisation dans un fichier :
RewriteLog "/usr/local/var/apache/logs/rewrite.log"

# Journalisation redirigée vers un pipe:
RewriteLog "|/path/to/parser.pl"

top

RewriteLogLevel Directive

Description:Définit la verbosité du fichier journal utilisé par le moteur de réécriture
Syntaxe:RewriteLogLevel niveau
Défaut:RewriteLogLevel 0
Contexte:configuration du serveur, serveur virtuel
Statut:Extension
Module:mod_rewrite

La directive RewriteLogLevel définit le niveau de verbosité du fichier journal de réécriture. Le niveau par défaut 0 signifie aucune journalisation, tandis que 9 ou plus signifie que pratiquement toutes les actions sont journalisées.

Pour désactiver la journalisation des actions de réécriture, positionnez simplement niveau à 0. Ceci désactive toute journalisation des actions de réécriture.

Utiliser une valeur élevée pour niveau va ralentir considérablement votre serveur Apache ! N'utilisez une journalisation de la réécriture à un niveau supérieur à 2 qu'à des fins de débogage !

Exemple

RewriteLogLevel 3

top

RewriteMap Directive

Description:Définit une fonction de mise en correspondance pour la recherche de mots-clés
Syntaxe:RewriteMap nom de la correspondance type de correspondance:source de la correspondance
Contexte:configuration du serveur, serveur virtuel
Statut:Extension
Module:mod_rewrite
Compatibilité:Il est possible de choisir entre plusieurs types de bases de données depuis la version 2.0.41 d'Apache

La directive RewriteMap définit une Table de correspondance pour la réécriture que les fonctions de mise en correspondance peuvent utiliser dans les chaînes de substitution des règles pour insérer/substituer des champs en recherchant des mots-clés. La source utilisée pour cette recherche peut être de plusieurs types.

nom de la correspondance est le nom de la table de correspondance et servira à spécifier une fonction de mise en correspondance pour les chaînes de substitution d'une règle de réécriture selon une des constructions suivantes :

${ nom de la correspondance : mot-clé }
${ nom de la correspondance : mot-clé | valeur par défaut }

Lorsqu'une telle construction est rencontrée, la table de correspondance Nom de la correspondance est consultée et la clé mot-clé recherchée. Si la clé est trouvée, la construction est remplacée par la valeur de remplacement. Si la clé n'est pas trouvée, elle est remplacée par la valeur par défaut, ou par une chaîne vide si aucune valeur par défaut n'est spécifiée. La valeur vide se comporte comme si la clé était absente ; il est donc impossible de distinguer une valeur vide d'une absence de clé.

Par exemple, vous pouvez définir une directive RewriteMap comme suit

RewriteMap map-exemple txt:/chemin/vers/fichier/map.txt

Vous pourrez ensuite utiliser cette table dans une directive RewriteRule comme suit :

RewriteRule ^/ex/(.*) ${map-exemple:$1}

Les combinaisons suivantes pour type de correspondance et source de la correspondance peuvent être utilisées :

La directive RewriteMap peut apparaître plusieurs fois. Utilisez une directive RewriteMap par fonction de correspondance pour déclarer son fichier de correspondance pour la réécriture. Bien que vous ne puissiez pas déclarer une table de correspondance dans un contexte de répertoire, vous pouvez bien entendu utiliser cette table dans un contexte de répertoire.

Note

En ce qui concerne les fichiers au format DBM et plein texte, les clés de recherches sont mises en cache en interne jusqu'à ce que le mtime (date de modification) du fichier soit modifié, ou que le serveur soit redémarré. Ainsi, certaines fonctions de correspondance dans les règles peuvent être utilisées pour chaque requête. Cela ne pose pas problème, car la recherche externe n'intervient qu'une seule fois !
top

RewriteOptions Directive

Description:Configure certaines options spéciales pour le moteur de réécriture
Syntaxe:RewriteOptions Options
Contexte:configuration du serveur, serveur virtuel, répertoire, .htaccess
AllowOverride:FileInfo
Statut:Extension
Module:mod_rewrite
Compatibilité:MaxRedirects n'est plus disponible depuis la version version 2.1

La directive RewriteOptions définit certaines options spéciales pour la configuration au niveau du serveur ou du répertoire. La chaîne de caractères Option ne peut actuellement prendre qu'une des valeurs suivantes :

inherit

Ceci force la configuration locale à hériter de la configuration du niveau supérieur. Dans le contexte des hôtes virtuels, cela signifie que les correspondances, conditions et règles du serveur principal sont héritées. Dans le contexte des répertoires, cela signifie que les conditions et règles de la configuration .htaccess du répertoire parent sont héritées.

Les règles héritées du niveau parent sont appliquées after après les règles spécifiées dans le niveau enfant.
AllowAnyURI

A partir de la version 2.2.23 de httpd, lorsqu'une directive RewriteRule est utilisée dans un contexte de serveur virtuel ou de serveur principal, mod_rewrite ne la traitera que si l'URI de la requête correspond à un chemin d'URL. Ceci permet d'éviter certains problèmes de sécurité où certaines règles peuvent permettre l'expansion de modèles inattendus (voir CVE-2011-3368 et CVE-2011-4317). Pour lever cette restriction, on peut activer l'option AllowAnyURI, et mod_rewrite va alors appliquer le jeu de règles à tout URI de requête, sans vérifier si la chaîne respecte la grammaire des chemins d'URL définie dans la spécification HTTP.

Avertissement en matière de sécurité

L'activation de cette option expose le serveur à des problèmes de sécurité si les règles de réécriture n'ont pas été rédigées avec soin. Il est donc fortement recommandé de ne pas utiliser cette option. En particulier, prenez garde aux chaînes d'entrée contenant le caractère '@' qui peut modifier l'interprétation de l'URI transformé, comme indiqué dans les CVE ci-dessus.

MergeBase

Avec cette option, la valeur de RewriteBase est copiée depuis une origine explicitement définie dans tout sous-répertoire qui ne définit pas sa propre RewriteBase. Par défaut, jusqu'à la version 2.2.22, cette valeur n'était pas copiée, alors qu'elle l'était avec la version 2.2.23 du serveur HTTP Apache. Le drapeau permettant de contrôler explicitement ce comportement est disponible depuis la version 2.2.24.

top

RewriteRule Directive

Description:Définit les règles pour le moteur de réécriture
Syntaxe:RewriteRule Modèle Substitution [drapeaux]
Contexte:configuration du serveur, serveur virtuel, répertoire, .htaccess
AllowOverride:FileInfo
Statut:Extension
Module:mod_rewrite

La directive RewriteRule est le véritable cheval de trait de la réécriture. La directive peut apparaître plusieurs fois, chaque instance définissant une règle de réécriture particulière. L'ordre dans lequel ces règles sont définies est important - il s'agit de l'ordre dans lequel les règles seront appliquées au cours du processus de réécriture.

Modèle est une expression rationnelle compatible perl. Dans la première règle de réécriture, l'expression est comparée au chemin de l'URL de la requête (%-decoded) ; les expressions suivantes sont comparées à la sortie de la dernière règle de réécriture qui a été appliquée.

Qu'est-ce qui est comparé ?

Dans un contexte de serveur virtuel VirtualHost, le modèle est tout d'abord comparé à la portion de l'URL située entre le nom d'hôte éventuellement accompagné du port, et la chaîne de paramètres (par exemple "/app1/index.html").

Dans les contextes de répertoire Directory et htaccess, le modèle est tout d'abord comparé au chemin du système de fichiers, après suppression du préfixe ou chemin de base ayant conduit à la règle RewriteRule (par exemple "app1/index.html" ou "index.html" selon l'endroit où les directives sont définies).

Si vous voulez effectuer une comparaison en tenant compte du nom d'hôte, du port ou de la chaîne de paramètres, utilisez une directive RewriteCond comportant les variables %{HTTP_HOST}, %{SERVER_PORT}, ou %{QUERY_STRING}.

Réécritures dans un contexte de répertoire

  • L'utilisation du moteur de réécriture dans les fichiers .htaccess et les sections <Directory> est un peu plus complexe.
  • Pour activer le moteur de réécriture dans ces contextes, vous devez définir "RewriteEngine On" et "Options FollowSymLinks". Si l'administrateur a désactivé la possibilité de modifier l'option FollowSymLinks au niveau du répertoire d'un utilisateur, vous ne pouvez pas utiliser le moteur de réécriture. Cette restriction a été instaurée à des fins de sécurité.
  • Lorsqu'on utilise le moteur de réécriture dans un fichier .htaccess, le chemin de base du répertoire courant (qui est toujours le même pour ce même répertoire) est automatiquement supprimé au cours de la comparaison avec le modèle de la règle de réécriture, et automatiquement ajouté lorsqu'une substitution relative (ne débutant pas par un slash ou un nom de protocole) arrive à la fin d'un jeu de règles. Voir la directive RewriteBase pour plus de détails à propos de l'ajout du préfixe après les substitutions relatives.
  • Si vous souhaitez effectuer une comparaison en prenant en compte l'intégralité du chemin de l'URL dans un contexte de répertoire (htaccess), vous devez utiliser la variable %{REQUEST_URI} dans la directive RewriteCond.
  • Le prefixe supprimé se termine toujours par un slash, ce qui signifie que la comparaison s'effectue avec une chaîne qui ne comporte jamais de slash de début. Ainsi, un modèle contenant ^/ ne correspondra jamais dans un contexte de répertoire.
  • Bien que les règles de réécriture soient permises du point de vue de la syntaxe dans les sections <Location> et <Files>, elles n'y sont pas prises en compte, et n'y sont à priori d'aucune utilité.

Pour quelques conseils à propos des expressions rationnelles, voir le document Introduction à mod_rewrite.

Dans mod_rewrite, on peut aussi utiliser le caractère NON ('!') comme préfixe de modèle. Ceci vous permet d'inverser la signification d'un modèle, soit pour dire ``si l'URL considérée ne correspond PAS à ce modèle''. Le caractère NON peut donc être utilisé à titre exceptionnel, lorsqu'il est plus simple d'effectuer une comparaison avec le modèle inversé, ou dans la dernière règle par défaut.

Note

Si vous utilisez le caractère NON pour inverser la signification d'un modèle, vous ne pouvez pas inclure de parties génériques groupées dans le modèle. Ceci est dû au fait que, lorsque le modèle ne correspond pas (autrement dit, sa négation correspond), les groupes sont vides. Ainsi, si vous utilisez des modèles inversés, vous ne pouvez pas vous référer aux groupes par $N dans la chaîne de substitution !

Dans une règle de réécriture, Substitution est la chaîne de caractères qui remplace le chemin de l'URL original qui correspondait au Modèle. Substitution peut être :

un chemin du système de fichiers
Il indique alors la localisation dans le système de fichiers de la ressource qui doit être envoyée au client. Les substitutions ne sont traitées en tant que chemin du système de fichiers que si les règles sont définies dans un contexte de serveur (virtualhost), et si le premier élément de ce chemin existe dans le système de fichiers.
chemin d'URL
Un chemin relatif à la valeur de DocumentRoot vers la ressource qui doit être servie. Notez que mod_rewrite essaie de deviner si vous avez spécifié un chemin du système de fichiers ou un chemin d'URL en vérifiant si la première partie du chemin existe à la racine du système de fichiers. Par exemple, si vous avez spécifié comme chaîne de Substitution /www/file.html, cette dernière sera traitée comme un chemin d'URL à moins qu'un répertoire nommé www n'existe à la racine de votre système de fichiers (ou dans le cas d'une réécriture au sein d'un fichier .htaccess, relativement à la racine des documents), auquel cas la chaîne de substitution sera traitée comme un chemin du système de fichiers. Si vous désirez que d'autres directives de correspondance d'URL (comme la directive Alias) soient appliquées au chemin d'URL résultant, utilisez le drapeau [PT] comme décrit ci-dessous.
URL absolue
Si une URL absolue est spécifiée, mod_rewrite vérifie si le nom d'hôte correspond à celui de l'hôte local. Si c'est le cas, le protocole et le nom d'hôte sont supprimés, et ce qui reste est traité comme un chemin d'URL. Dans le cas contraire, une redirection externe vers l'URL indiquée est effectuée. Pour forcer une redirection externe vers l'hôte local, voir le drapeau [R] ci-dessous.
- (tiret)
Un tiret indique qu'aucune substitution ne doit être effectuée (le chemin considéré est transmis sans changement). Ceci est utile quand un drapeau doit être appliqué sans modifier le chemin (voir ci-dessous).

En plus du texte, la chaîne Substition peut comporter :

  1. des références arrières ($N) vers le modèle d'une directive RewriteRule
  2. des références arrières (%N) vers le dernier modèle d'une directive RewriteCond qui correspondait
  3. des variables du serveur comme dans les chaînes de test de condition d'une règle (%{VARNAME})
  4. des appels de fonctions de comparaison (${nom correspondance:clé|défaut})

Les références arrières sont des identificateurs de la forme $N (N=0..9), qui seront remplacés par le contenu du Nème groupe du Modèle qui correspondait. Les variables du serveur sont les mêmes que dans la Chaîne de test d'une directive RewriteCond. Les fonctions de comparaison sont issues de la directive RewriteMap dans la section de laquelle elles sont décrites. Ces trois types de variables sont évaluées dans l'ordre ci-dessus.

Chaque règle de réécriture s'applique au résultat de la règle précédente, selon l'ordre dans lequel elles ont été définies dans le fichier de configuration. L'URL est intégralement remplacée par la chaîne de Substitution et le processus de réécriture se poursuit jusqu'à ce que toutes les règles aient été appliquées, ou qu'il soit explicitement stoppé par un drapeau L, ou par un autre drapeau qui implique un arrêt immédiat, comme END ou F.

Modifier la chaîne de requête

Par défaut, la chaîne de requête est transmise sans modification. Vous pouvez cependant créer dans la chaîne de substitution des URLs dont une partie constitue une chaîne de requête. Pour cela, ajoutez simplement un point d'interrogation dans la chaîne de substitution pour indiquer que le texte qui suit doit être réinjecté dans la chaîne de requête. Pour supprimer une chaîne de requête, terminez simplement la chaîne de substitution par un point d'interrogation. Pour combiner les nouvelles chaînes de requête avec les anciennes, utilisez le drapeau [QSA].

En outre, vous pouvez spécifier des actions spéciales à effectuer en ajoutant des [drapeaux] comme troisième argument de la directive RewriteRule. Flags est une liste de valeurs déparées par des virgules, délimitée par des crochets, choisies parmi les drapeaux de la table suivante. Vous trouverez plus de détails et d'exemples, pour chaque drapeau, dans la documentation sur les drapeaux de réécriture.

Drapeaux et syntaxe Fonction
B Echappe les caractères non-alphanumériques avant d'appliquer la transformation. détails ...
chain|C La règle est chaînée avec la règle suivante. Si la règle échoue, la ou les règles avec lesquelles elle est est chaînée seront sautées. détails ...
cookie|CO=NAME:VAL Définit un cookie au niveau du navigateur client. La syntaxe complète est : CO=NAME:VAL:domain[:lifetime[:path[:secure[:httponly]]]] details ... détails ...
discardpath|DPI Supprime la partie PATH_INFO de l'URI réécrit. détails ...
env|E=[!]VAR[:VAL] Définit la variable d'environnement VAR (à la valeur VAL si elle est fournie). La variante !VAR annule la définition de la variable VAR.détails ...
forbidden|F Renvoie une réponse 403 FORBIDDEN au navigateur client. détails ...
gone|G Renvoie un message d'erreur 410 GONE au navigateur client. détails ...
Handler|H=Gestionnaire de contenu L'URI résultant est envoyé au Gestionnaire de contenu pour traitement. détails ...
last|L Arrête le processus de réécriture immédiatement et n'applique plus aucune règle. Prêtez une attention particulière aux mises en garde concernant les contextes de niveau répertoire et .htaccess (voir aussi le drapeau END). détails ...
next|N Réexécute le processus de réécriture à partir de la première règle, en utilisant le résultat du jeu de règles, sous réserve qu'il y ait un point de départ. détails ...
nocase|NC Rend la comparaison entre modèles insensible à la casse. détails ...
noescape|NE Empêche mod_rewrite d'effectuer un échappement hexadécimal des caractères spéciaux dans le résultat de la réécriture. détails ...
nosubreq|NS La règle est sautée si la requête courante est une sous-requête interne. détails ...
proxy|P Force l'envoi en interne de l'URL de substitution en tant que requête mandataire. détails ...
passthrough|PT L'URI résultant est repassé au moteur de mise en correspondance des URLs pour y être traité par d'autres traducteurs URI-vers-nom de fichier, comme Alias ou Redirect. détails ...
qsappend|QSA Ajoute toute chaîne de paramètres présente dans l'URL de la requête originale à toute chaîne de paramètres créée dans la cible de réécriture. détails ...
qsdiscard|QSD Supprime toute chaîne de paramètres de l'URI entrant. détails ...
redirect|R[=code] Force une redirection externe, avec un code de statut HTTP optionnel. détails ...
END Arrête le processus de réécriture immédiatement et n'applique plus aucune règle. Empêche aussi l'exécution ultérieure de règles de réécriture dans des contextes de répertoire et des fichiers .htaccess (disponible depuis la version 2.3.9) détails ...
skip|S=nombre Si la règle courante s'applique, le moteur de réécriture doit sauter les nombre règles suivantes. détails ...
type|T=MIME-type Force l'attribution du Type-MIME spécifié au fichier cible. détails ...

Développement du répertoire home

Quand la chaîne de substitution commence par quelque chose comme "/~user" (de manière explicite ou par références arrières), mod_rewrite développe le répertoire home sans tenir compte de la présence ou de la configuration du module mod_userdir.

Ce développement n'est pas effectué si le drapeau PT est utilisé dans la directive RewriteRule

Voici toutes les combinaisons de substitution et leurs significations :

Dans la configuration au niveau du serveur principal (httpd.conf)
pour la requête ``GET /chemin/infochemin'':

Règle                          Résultat de la substitution
----------------------------------------------  ----------------------------------
^/chemin(.*) autre-chemin$1                      non valide, non supporté

^/chemin(.*) autre-chemin$1  [R]                 non valide, non supporté

^/chemin(.*) autre-chemin$1  [P]                 non valide, non supporté
----------------------------------------------  ----------------------------------
^/chemin(.*) /autre-chemin$1                     /autre-chemin/infochemin

^/chemin(.*) /autre-chemin$1 [R]                 http://cet-hôte/autre-chemin/infochemin
                                                via redirection externe

^/chemin(.*) /autre-chemin$1 [P]                 n'a pas lieu d'être, non supporté
----------------------------------------------  ----------------------------------
^/chemin(.*) http://cet-hôte/autre-chemin$1      /autre-chemin/infochemin

^/chemin(.*) http://cet-hôte/autre-chemin$1 [R]  http://cet-hôte/autre-chemin/infochemin
                                                via redirection externe

^/chemin(.*) http://cet-hôte/autre-chemin$1 [P]  n'a pas lieu d'être, non supporté
----------------------------------------------  ----------------------------------
^/chemin(.*) http://autre hôte/autre-chemin$1     http://autre hôte/autre-chemin/infochemin
                                                via redirection externe

^/chemin(.*) http://autre hôte/autre-chemin$1 [R] http://autre hôte/autre-chemin/infochemin
                                                via redirection externe
                                                (le drapeau [R] est
						redondant)

^/chemin(.*) http://autre hôte/autre-chemin$1 [P] http://autre hôte/autre-chemin/infochemin
                                                via un mandataire interne

Dans une configuration de niveau répertoire pour /chemin
(/chemin/physique/vers/chemin/.htacccess, avec RewriteBase /chemin)
pour la requête ``GET /chemin/chemin-local/infochemin'':

Règle                          Résultat de la substitution
----------------------------------------------  ----------------------------------
^chemin-local(.*) autre-chemin$1                      /chemin/autre-chemin/infochemin

^chemin-local(.*) autre-chemin$1  [R]                 http://cet-hôte/chemin/autre-chemin/infochemin
                                                via redirection externe

^chemin-local(.*) autre-chemin$1  [P]                 n'a pas lieu d'être, non supporté
----------------------------------------------  ----------------------------------
^chemin-local(.*) /autre-chemin$1                     /autre-chemin/infochemin

^chemin-local(.*) /autre-chemin$1 [R]                 http://cet-hôte/autre-chemin/infochemin
                                                via redirection externe

^chemin-local(.*) /autre-chemin$1 [P]                 n'a pas lieu d'être, non supporté
----------------------------------------------  ----------------------------------
^chemin-local(.*) http://cet-hôte/autre-chemin$1      /autre-chemin/infochemin

^chemin-local(.*) http://cet-hôte/autre-chemin$1 [R]  http://cet-hôte/autre-chemin/infochemin
                                                via redirection externe

^chemin-local(.*) http://cet-hôte/autre-chemin$1 [P]  n'a pas lieu d'être, non supporté
----------------------------------------------  ----------------------------------
^chemin-local(.*) http://autre hôte/autre-chemin$1     http://autre hôte/autre-chemin/infochemin
                                                via redirection externe

^chemin-local(.*) http://autre hôte/autre-chemin$1 [R] http://autre hôte/autre-chemin/infochemin
                                                via redirection externe
                                                (le drapeau [R] est
						redondant)

^chemin-local(.*) http://autre hôte/autre-chemin$1 [P] http://autre hôte/autre-chemin/infochemin
                                                via un mandataire interne

Langues Disponibles:  en  |  fr 

top

Commentaires

Notice:
This is not a Q&A section. Comments placed here should be pointed towards suggestions on improving the documentation or server, and may be removed again by our moderators if they are either implemented or considered invalid/off-topic. Questions on how to manage the Apache HTTP Server should be directed at either our IRC channel, #httpd, on Freenode, or sent to our mailing lists.