Les expressions dans le serveur HTTP Apache
Comparer le nom d'hôte avec example.com et rediriger vers
www.example.com si le nom d'hôte correspond Redirect permanent / http://www.example.com/
Forcer le type text/plain si un fichier fait l'objet d'une
requête dont la chaîne de paramètres contient 'forcetext' ForceType text/plain
N'autoriser l'accès à ce contenu que pendant les heures de
travail Require expr %{TIME_HOUR} -gt 9 && %{TIME_HOUR} -lt 17
Historiquement, il existe de nombreuses variantes dans la syntaxe des expressions permettant d'exprimer une condition dans les différents modules du serveur HTTP Apache. À ce titre, des travaux sont en cours pour n'utiliser qu'une seule variante nommée apexpr, pour toutes les directives de configuration. Ce document décrit l'interpréteur d'expressions apexpr.
La Forme de Backus-Naur (souvent abrégée en BNF, de l'anglais Backus-Naur Form) est une notation permettant de décrire les règles syntaxiques des langages de programmation. En général, les expressions représentent des valeurs booléennes. Dans ce cas, le point de départ de la BNF est expr
. Cependant, certaines directives comme
utilisent comme paramètres des expressions qui représentent des chaînes de caractères. Dans ce cas, le point de départ de la BNF est LogMessagestring
expr ::= "true" | "false" | "!" expr | expr "&&" expr | expr "||" expr | "(" expr ")" | comp comp ::= stringcomp | integercomp | unaryop word | word binaryop word | word "in" "{" wordlist "}" | word "in" listfunction | word "=~" regex | word "!~" regex stringcomp ::= word "==" word | word "!=" word | word "<" word | word "<=" word | word ">" word | word ">=" word integercomp ::= word "-eq" word | word "eq" word | word "-ne" word | word "ne" word | word "-lt" word | word "lt" word | word "-le" word | word "le" word | word "-gt" word | word "gt" word | word "-ge" word | word "ge" word wordlist ::= word | wordlist "," word word ::= word "." word | digit | "'" string "'" | """ string """ | variable | rebackref | function string ::= stringpart | string stringpart stringpart ::= cstring | variable | rebackref cstring ::= ... digit ::= [0-9]+ variable ::= "%{" varname "}" | "%{" funcname ":" funcargs "}" rebackref ::= "$" [0-9] function ::= funcname "(" word ")" listfunction ::= listfuncname "(" word ")"
L'interpréteur d'expressions fournit plusieurs variables de la forme %{HTTP_HOST}
. Notez que la valeur d'une variable
peut dépendre de la phase du traitement de la requête au cours de
laquelle elle est évaluée. Par exemple, une expression utilisée dans
une directive
sera évaluée avant la phase d'authentification. Par conséquent, la variable %{REMOTE_USER}
ne sera pas encore définie à ce stade.
Les variables suivantes contiennent la valeur de l'en-tête de requête HTTP correspondant. La fonction req
permet d'extraire les valeurs des autres en-têtes. L'utilisation de ces variables peut provoquer l'ajout du nom d'en-tête correspondant à l'en-tête Vary de la réponse HTTP, sauf spécification contraire pour la directive qui accepte l'expression comme paramètre. La function req_novary
permet de modifier ce comportement.
Autres variables liées aux requêtes
| Nom | Description |
|---|---|
REQUESTMETHOD |
La méthode HTTP de la requête entrante (par exemple
GET ) |
REQUESTSCHEME |
Le protocole associé à l'URI de la requête |
REQUESTURI |
La partie chemin de l'URI de la requête |
DOCUMENTURI |
Idem REQUESTURI |
REQUESTFILENAME |
Le chemin complet dans le système de fichiers local du
fichier ou du script correspondant à la requête, si le serveur
l'a dèjà déterminé à l'instant où REQUESTFILENAME
est référencée. Dans le cas contraire, comme dans un
contexte de serveur virtuel, même valeur que REQUESTURI |
SCRIPTFILENAME |
Identique à REQUESTFILENAME |
LASTMODIFIED |
La date et heure de dernière modification du fichier au
format 20101231235959 , si elle est déjà connue du
serveur au moment où LASTMODIFIED est référencé.
|
SCRIPTUSER |
Le nom d'utilisateur du propriétaire du script. |
SCRIPTGROUP |
Le nom du groupe auquel appartient le script. |
PATHINFO |
L'information relative au nom de chemin située en fin, voir
la directive
|
QUERYSTRING |
La chaîne de paramètres de la requête courante |
ISSUBREQ |
"true " si la requête courante est une
sous-requête, "false " dans le cas contraire |
THEREQUEST |
La requête complète (par exemple "
GET /index.html
HTTP/1.1
") |
REMOTEADDR |
L'adresse IP de l'hôte distant |
REMOTEHOST |
Le nom d'hôte de l'hôte distant |
REMOTEUSER |
Le nom de l'utilisateur authentifié, s'il existe (non
disponible à l'intérieur d'un bloc
" si la requête utilise https, "off
" si la connexion utilise IPv6, "off
| Nom | Description | |---|---| TIMEYEAR | L'année courante (par exemple 2010 ) | TIMEMON | Le mois courant (1 , ..., 12 ) | TIMEDAY | Le jour courant dans le mois | TIMEHOUR | Les heures de la date courante (0 , ..., 23 ) | TIMEMIN | Les minutes de la date courante | TIMESEC | Les secondes de la date courante | TIMEWDAY | Le jour de la semaine (à partir de 0 pour dimanche) | TIME | La date et heure au format 20101231235959 | SERVERSOFTWARE | La chaîne contenant la version du serveur | API_VERSION | La date de la version de l'API (module magic number) |
, définissent des variables supplémentaires.mod_ssl
À l'exception de quelques opérateurs de comparaison internes, les opérateurs binaires sont de la forme "-[a-zA-Z][a-zA-Z0-9_]+
", autrement dit un signe moins et au moins deux caractères. Le nom est insensible à la casse. Les modules peuvent fournir des opérateurs binaires supplémentaires.
| Nom | Description | |---|---| -ipmatch | L'adresse IP correspond à adresse/masque | -strmatch | la chaîne de gauche correspond au modèle constitué par la chaîne de droite (contenant des caractères génériques *, ?, []) | -strcmatch | idem -strmatch , mais insensible à la casse | -fnmatch | idem -strmatch , mais les slashes ne sont pas pris en compte par les caractères génériques |
Les opérateurs unaires acceptent un seul argument et sont de la forme "-[a-zA-Z]
", autrement dit le signe moins et un caractère. Le nom est sensible à la casse. Les modules peuvent fournir des opérateurs unaires supplémentaires.
| Nom | Description | Restreint | |---|---|---| -d | L'argument est traité comme un nom de fichier. Vrai si le fichier existe et correspond à un répertoire | oui | -e | L'argument est traité comme un nom de fichier. Vrai si le fichier (ou dir ou special) existe | oui | -f | L'argument est traité comme un nom de fichier. Vrai si le fichier existe et correspond à un fichier régulier | oui | -s | L'argument est traité comme un nom de fichier. Vrai si le fichier existe et n'est pas vide | oui | -L | L'argument est traité comme un nom de fichier. Vrai si le fichier existe et correspond à un lien symbolique | oui | -h | L'argument est traité comme un nom de fichier. Vrai si le fichier existe et correspond à un lien symbolique (identique à -L ) | oui | -F | Vrai si la chaîne correspond a un fichier valide, accessible avec tous les contrôles d'accès configurés pour ce chemin. A cette fin, une sous-requête effectue la vérification, et vous devez utiliser ce drapeau avec soin car il peut impacter les performances de votre serveur ! | | -U | Vrai si la chaîne correspond a une URL valide, accessible avec tous les contrôles d'accès configurés pour ce chemin. A cette fin, une sous-requête effectue la vérification, et vous devez utiliser ce drapeau avec soin car il peut impacter les performances de votre serveur ! | | -A | Alias pour -U | | -n | Vrai si la chaîne n'est pas vide | | -z | Vrai si la chaîne est vide | | -T | Faux si la chaîne est vide, "0 ", "off ", "false ", ou "no " (insensibilité à la casse). Vrai dans le cas contraire. | | -R | Idem "%{REMOTE_ADDR} -ipmatch ... ", en plus efficace |
Les opérateurs marqués comme "restreints" ne sont pas disponibles avec certains modules comme
Normalement, les fonctions dont la valeur est une chaîne acceptent une chaîne comme argument et renvoient une chaîne. Les noms de fonctions sont insensibles à la casse. Les modules peuvent fournir des fonctions supplémentaires.
| Nom | Description | Restreint | |---|---|---| req , http | Lit l'en-tête de requête HTTP ; les noms d'en-tête correspondants peuvent être ajoutés à l'en-tête Vary, voir ci-dessous | | req_novary | Identique à req , mais aucun nom d'en-tête n'est ajouté à l'en-tête Vary | | resp | Lit l'en-tête de réponse HTTP | | reqenv | Recherche une variable d'environnement de requête (on peut aussi utiliser le raccourci v ). | | osenv | Recherche une variable d'environnement du système d'exploitation | | note | Recherche une note de requête | | env | Renvoie le premier résultat positif de note , reqenv , osenv | | tolower | Convertit une chaîne en minuscules | | toupper | Convertit une chaîne en majuscules | | escape | Echappe les caractères spéciaux en codage hexadécimal | | unescape | "Déséchappe" les chaînes codées en hexadécimal, en ne gardant encodés que les slashes; renvoie la chaîne vide si la séquence %00 est rencontrée | | base64 | Encode la chaîne en base64 | | unbase64 | Décode les chaînes codées en base64, renvoie une chaîne tronquée si le caractère 0x00 est rencontré | | md5 | Génère un hash de la chaîne en utilisant MD5, puis code le hash obtenu en hexadécimal | | sha1 | Génère un hash de la chaîne en utilisant SHA1, puis encode le hash obtenu en hexadécimal | | file | Lit le contenu d'un fichier | oui | filesize | Renvoie la taille d'un fichier (ou 0 si le fichier n'existe pas ou ne correspond pas à un fichier régulier) | oui |
sont utilisées, le nom d'en-tête sera automatiquement ajouté à l'en-tête Vary de la réponse HTTP, sauf spécification contraire pour la directive qui accepte l'expression comme paramètre. La fonction req_novary
En plus des fonctions dont la valeur est une chaîne, il existe aussi des fonctions dont la valeur est une liste, qui acceptent une chaîne comme argument, et renvoient une liste de mots, autrement dit une liste de chaînes. La liste de mot peut être utilisée avec l'opérateur spécial -in
pour plus de détails (notez que la fonction SSLRequirePeerExtList
Les exemples suivants montent comment utiliser les expressions pour évaluer les requêtes :
| Nom | Alternative | Description | |---|---|---| -in | in | chaîne contenue dans une liste de chaînes | /regexp/ | m#regexp# | Expression rationnelle (la seconde forme permet de spécifier des délimiteurs autres que /) | /regexp/i | m#regexp#i | Expression rationnelle insensible à la casse | $0 ... $9 | Références arrières dans les expressions rationnelles |
permettent de référencer les groupes de capture en provenance d'expressions rationnelles précédemment exécutées et mises en correspondance avec succès. Elles ne peuvent normalement être utilisées que dans la même expression que celle mise en correspondance, mais certains modules permettent de les utiliser de manière spéciale.
La syntaxe ap_expr consiste principalement en une surcouche de la syntaxe de la directive obsolète
. Vous pouvez consulter la liste de leur différences dans la documentation de la directive SSLRequire
Modules | Directives | FAQ | Glossaire | Plan du site
Serveur Apache HTTP Version 2.4
Les expressions dans le serveur HTTP Apache
Langues Disponibles: en | fr
Historiquement, il existe de nombreuses variantes dans la syntaxe des expressions permettant d'exprimer une condition dans les différents modules du serveur HTTP Apache. À ce titre, des travaux sont en cours pour n'utiliser qu'une seule variante nommée ap_expr, pour toutes les directives de configuration. Ce document décrit l'interpréteur d'expressions ap_expr.
Le type d'expression ap_expr est appelé à remplacer la plupart des autres types d'expressions dans HTTPD. Par exemple, la directive obsolète SSLRequire peut être remplacée par la directive Require expr.
SSLRequire- Syntaxe en Forme de Backus-Naur
- Variables
- Opérateurs binaires
- Opérateurs unaires
- Fonctions
- Exemples d'expressions
- Autres
- Comparaison avec SSLRequire
- Historique de version
Voir aussi
- If
- AuthBasicFake
- AuthFormLoginRequiredLocation
- AuthFormLoginSuccessLocation
- AuthFormLogoutLocation
- RewriteCond
- SetEnvIfExpr
- Header
- RequestHeader
- FilterProvider
- Require expr
- Require ldap-user
- Require ldap-group
- Require ldap-dn
- Require ldap-attribute
- Require ldap-filter
- Require dbd-group
- Require dbm-group
- Require group
- Require host
- SSLRequire
- LogMessage
- mod_include
If<if></if><elseif></elseif><else></else>AuthBasicFakeAuthFormLoginRequiredLocationAuthFormLoginSuccessLocationAuthFormLogoutLocationRewriteCondSetEnvIfExprHeaderRequestHeaderFilterProviderSSLRequireLogMessagemod_include