Module Apache mod_proxy

AllowCONNECT Directive

La directive AllowCONNECT permet de spécifier une liste de numéros de ports auxquels la méthode de mandataire CONNECT pourra se connecter. Les navigateurs d'aujourd'hui utilisent cette méthode dans le cas où une connexion https est requise et où le tunneling mandataire sur HTTP est en service.

Par défaut, seuls les ports par défauts https (443) et snews (563) sont pris en compte. Vous pouvez utiliser la directive AllowCONNECT pour outrepasser ces valeurs par défaut et n'autoriser les connexions que vers les ports spécifiés.

Notez que le module mod_proxy_connect doit être chargé dans le serveur pour pouvoir accéder au support de CONNECT.

BalancerMember Directive

Cette directive parmet d'ajouter un membre à un groupe de répartition de charge. Elle peut se trouver dans un conteneur <Proxy balancer://...>, et accepte tous les paramètres de paires clé/valeur que supporte la directive ProxyPass.

L'argument balancerurl n'est requis que s'il ne se trouve pas dèjà dans la directive de conteneur <Proxy balancer://...>. Il correspond à l'URL d'un répartiteur de charge défini par une directive ProxyPass.

NoProxy Directive

Cette directive n'a d'utilité que pour les serveurs mandataires Apache au sein d'Intranets. La directive NoProxy permet de spécifier une liste de sous-réseaux, d'adresses IP, de serveurs et/ou de domaines séparés par des espaces. Une requête pour un serveur qui correspond à un ou plusieurs critères sera toujours servie par ce serveur directement, sans être redirigée vers le(s) serveur(s) mandataire(s) défini(s) par la directive ProxyRemote.

Le type des arguments serveur de la directive NoProxy appartiennent à la liste suivante :

Domaine

Un domaine est ici un nom de domaine DNS partiellement qualifié précédé d'un point. Il représente une liste de serveurs qui appartiennent logiquement au même domaine ou à la même zonz DNS (en d'autres termes, les nom des serveurs se terminent tous par domaine).

Exemple

.com .apache.org.

Pour faire la distinction entre domaines et nom d'hôtes (des points de vue à la fois syntaxique et sémantique, un domaine DNS pouvant aussi avoir un enregistrement DNS de type A !), les domaines sont toujours spécifiés en les préfixant par un point.

Note

Les comparaisons de noms de domaines s'effectuent sans tenir compte de la casse, et les parties droites des Domaines sont toujours censées correspondre à la racine de l'arborescence DNS, si bien que les domaines .ExEmple.com et .example.com. (notez le point à la fin du nom) sont considérés comme identiques. Comme une comparaison de domaines ne nécessite pas de recherche DNS, elle est beaucoup plus efficace qu'une comparaison de sous-réseaux.

Sous-réseau

Un Sous-réseau est une adresse internet partiellement qualifiée sous forme numérique (quatre nombres séparés par des points), optionnellement suivie d'un slash et du masque de sous-réseau spécifiant le nombre de bits significatifs dans le Sous-réseau. Il représente un sous-réseau de serveurs qui peuvent être atteints depuis la même interface réseau. En l'absence de masque de sous-réseau explicite, il est sous-entendu que les digits manquants (ou caractères 0) de fin spécifient le masque de sous-réseau (Dans ce cas, le masque de sous-réseau ne peut être qu'un multiple de 8). Voici quelques exemples :

192.168 ou 192.168.0.0

le sous-réseau 192.168.0.0 avec un masque de sous-réseau implicite de 16 bits significatifs (parfois exprimé sous la forme 255.255.0.0)

192.168.112.0/21

le sous-réseau 192.168.112.0/21 avec un masque de sous-réseau implicite de 21 bits significatifs (parfois exprimé sous la forme255.255.248.0)

Comme cas extrèmes, un Sous-réseau avec un masque de sous-réseau de 32 bits significatifs est équivalent à une adresse IP, alors qu'un Sous-réseau avec un masque de sous-réseau de 0 bit significatif (c'est à dire 0.0.0.0/0) est identique à la constante _Default_, et peut correspondre à toute adresse IP.

Adresse IP

Une Adresse IP est une adresse internet pleinement qualifiée sous forme numérique (quatre nombres séparés par des points). En général, cette adresse représente un serveur, mais elle ne doit pas nécessairement correspondre à un nom de domaine DNS.

Exemple

192.168.123.7

Note

Une Adresse IP ne nécessite pas de résolution DNS, et peut ainsi s'avérer plus efficace quant aux performances d'Apache.

Nom de serveur

Un Nom de serveur est un nom de domaine DNS pleinement qualifié qui peut être résolu en une ou plusieurs adresses IP par le service de noms de domaines DNS. Il représente un hôte logique (par opposition aux Domaines, voir ci-dessus), et doit pouvoir être résolu en une ou plusieurs adresses IP (ou souvent en une liste d'hôtes avec différentes adresses IP).

Exemples

prep.ai.example.com
www.apache.org

Note

Dans de nombreuses situations, il est plus efficace de spécifier une adresse IP qu'un Nom de serveur car cela évite d'avoir à effectuer une recherche DNS. La résolution de nom dans Apache peut prendre un temps très long lorsque la connexion avec le serveur de noms utilise une liaison PPP lente.

Les comparaisons de Nom de serveur s'effectuent sans tenir compte de la casse, et les parties droites des Noms de serveur sont toujours censées correspondre à la racine de l'arborescence DNS, si bien que les domaines WWW.ExEmple.com et www.example.com. (notez le point à la fin du nom) sont considérés comme identiques.

Voir aussi

• Problèmes liés au DNS

<Proxy> Directive

Les directives situées dans une section <Proxy> ne s'appliquent qu'au contenu mandaté concerné. Les jokers de style shell sont autorisés.

Par eexemple, les lignes suivantes n'autoriseront à accéder à un contenu via votre serveur mandataire que les hôtes appartenant à votre-reseau.example.com :

Dans l'exemple suivant, tous les fichiers du répertoire foo de example.com seront traités par le filtre INCLUDES lorsqu'ils seront envoyés par l'intermédiaire du serveur mandataire :

Voir aussi

• <ProxyMatch>

ProxyBadHeader Directive

La directive ProxyBadHeader permet de déterminer le comportement de mod_proxy lorsqu'il reçoit des lignes d'en-tête de réponse dont la syntaxe n'est pas valide (c'est à dire ne contenant pas de caractère ':') en provenance du serveur original. Les arguments disponibles sont :

IsError

Annule la requête et renvoie une réponse de code 502 (mauvaise passerelle). C'est le comportement par défaut.

Ignore

Traite les lignes d'en-tête incorrectes comme si elles n'avaient pas été envoyées.

StartBody

A la réception de la première ligne d'en-tête incorrecte, les autres en-têtes sont lus et ce qui reste est traité en tant que corps. Ceci facilite la prise en compte des serveurs d'arrière-plan bogués qui oublient d'insérer une ligne vide entre les en-têtes et le corps.

ProxyBlock Directive

La directive ProxyBlock permet de spécifier une liste de termes, serveurs et/ou domaines, séparés par des espaces. Les requêtes de documents HTTP, HTTPS, FTP vers des sites dont les noms contiennent des termes, noms de serveur ou domaine correspondants seront bloqués par le serveur mandataire. La module proxy va aussi tenter de déterminer les adresses IP des items de la liste qui peuvent correspondre à des noms d'hôtes au cours du démarrage, et les mettra en cache à des fins de comparaisons ultérieures. Ceci peut ralentir le démarrage du serveur.

rocky.wotsamattau.edu aurait aussi correspondu s'il avait été spécifié par son adresse IP.

Notez que wotsamattau aurait suffi pour correspondre à wotsamattau.edu.

Notez aussi que

bloque les connexions vers tous les sites.

ProxyDomain Directive

Cette directive n'a d'utilité que pour les serveurs mandataires Apache au sein d'un Intranet. La directive ProxyDomain permet de spécifier le domaine par défaut auquel le serveur mandataire apache appartient. Si le serveur reçoit une requête pour un hôte sans nom de domaine, il va générer une réponse de redirection vers le même hôte suffixé par le Domaine spécifié.

ProxyErrorOverride Directive

Cette directive est utile pour les configurations de mandataires inverses, lorsque vous souhaitez que les pages d'erreur envoyées aux utilisateurs finaux présentent un aspect homogène. Elle permet aussi l'inclusion de fichiers (via les SSI de mod_include) pour obtenir le code d'erreur et agir en conséquence (le comportement par défaut afficherait la page d'erreur du serveur mandaté, alors que c'est le message d'erreur SSI qui sera affiché si cette directive est à "on").

Cette directive n'affecte pas le traitement des réponses informatives (1xx), de type succès normal (2xx), ou de redirection (3xx).

ProxyFtpDirCharset Directive

La directive ProxyFtpDirCharset permet de définir le jeu de caractères à utiliser pour les listings FTP en HTML générés par mod_proxy_ftp.

ProxyIOBufferSize Directive

La directive ProxyIOBufferSize permet d'ajuster la taille du tampon interne utilisé comme bloc-note pour les transferts de données entre entrée et sortie. La taille doit être inférieure ou égale à 8192 octets.

Dans la plupart des cas, il n'y a aucune raison de modifier cette valeur.

<ProxyMatch> Directive

La directive <ProxyMatch> est identique à la directive <Proxy>, à l'exception qu'elle définit les URLs auxquelles elle s'applique en utilisant une expression rationnelle.

Voir aussi

• <Proxy>

ProxyMaxForwards Directive

La directive ProxyMaxForwards permet de spécifier le nombre maximum de mandataires à travers lesquels une requête peut passer dans le cas où la la requête ne contient pas d'en-tête Max-Forwards. Ceci permet de se prémunir contre les boucles infinies de mandataires ou contre les attaques de type déni de service.

Notez que la définition de la directive ProxyMaxForwards constitue une violation du protocole HTTP/1.1 (RFC2616), qui interdit à un mandataire de définir Max-Forwards si le client ne l'a pas fait lui-même. Les versions précédentes d'Apache la définissaient systématiquement. Une valeur négative de ProxyMaxForwards, y compris la valeur par défaut -1, implique un comportement compatible avec le protocole, mais vous expose aux bouclages infinis.

ProxyPass Directive

Cette directive permet référencer des serveurs distants depuis l'espace d'URLs du serveur local ; le serveur local n'agit pas en tant que mandataire au sens conventionnel, mais plutôt comme miroir du serveur distant. Le serveur local est souvent nommé mandataire inverse ou passerelle. L'argument chemin est le nom d'un chemin virtuel local ; url est une URL partielle pour le serveur distant et ne doit pas contenir de chaîne d'arguments.

Supposons que le serveur local a pour adresse http://example.com/ ; alors la ligne

va convertir en interne toute requête pour http://example.com/miroir/foo/bar en une requête mandatée pour http://backend.example.com/bar.

Le drapeau ! permet de soustraire un sous-répertoire du mandat inverse, comme dans l'exemple suivant :

va mandater toutes les requêtes pour /miroir/foo vers backend.example.com, sauf les requêtes pour /miroir/foo/i.

Depuis la version 2.1 du serveur HTTP Apache, mod_proxy supporte les jeux de connexions vers un serveur d'arrière-plan. Ainsi, les connexions créées à la demande peuvent être conservées dans un jeu pour une utilisation ultérieure. Les limites de la taille du jeu de connexions et d'autres paramètres peuvent être définis au niveau de la directive ProxyPass via des arguments clé=valeur décrits dans la table ci-dessous.

Par défaut, mod_proxy permettra de conserver le nombre maximum de connexions pouvant être utilisées simultanément par le processus enfant concerné du serveur web. Vous pouvez utiliser le paramètre max pour réduire ce nombre par rapport à la valeur par défaut. Vous pouvez aussi utiliser le paramètre ttl pour définir une durée de vie optionnelle ; ainsi, les connections qui n'ont pas été utilisées au bout de ttl secondes seront fermées. Le paramètre ttl permet aussi d'empêcher l'utilisation d'une connexion susceptible d'être fermée suite à l'expiration de la durée de vie des connexions persistantes sur le serveur d'arrière-plan.

Le jeu de connexions est maintenu au niveau de chaque processus enfant du serveur web, et max et les autres paramètres ne font l'objet d'aucune coordination entre les différents processus enfants, sauf bien sur dans le cas où un seul processus enfant est permis par la configuration du module multiprocessus.

Si l'URL de la directive ProxyPass débute par balancer:// (par exemple: balancer://cluster/, toute information relative au chemin est ignorée), alors un serveur cible virtuel ne communiquant pas réellement avec le serveur d'arrière-plan sera créé. Celui-ci sera en fait responsable de la gestion de plusieurs serveurs cibles "réels". Dans ce cas, un jeu de paramètres particuliers s'applique à ce serveur cible virtuel. Voir mod_proxy_balancer pour plus d'informations à propos du fonctionnement du répartiteur de charge.

Exemple de configuration d'un répartiteur

Configuration d'un serveur cible de réserve qui ne sera utilisé que si aucun autre serveur cible n'est disponible

Normalement, mod_proxy va mettre sous leur forme canonique les URLs traitées par ProxyPass. Mais ceci peut être incompatible avec certains serveurs d'arrière-plan, et en particulier avec ceux qui utilisent PATH_INFO. Le mot-clé optionnel nocanon modifie ce comportement et permet de transmettre le chemin d'URL sous sa forme brute au serveur d'arrière-plan. Notez que ceci peut affecter la sécurité de votre serveur d'arrière-plan, car la protection limitée contre les attaques à base d'URL que fournit le mandataire est alors supprimée.

Le mot-clé optionnel interpolate (disponible depuis httpd 2.2.9), en combinaison avec la directive ProxyPassInterpolateEnv, permet à ProxyPass d'interpoler les variables d'environnement à l'aide de la syntaxe ${VARNAME}. Notez que de nombreuses variables d'environnement standard dérivées de CGI n'existeront pas lorsque l'interpolation se produit ; vous devrez alors encore avoir avoir recours à mod_rewrite pour des règles complexes.

Lorsque la directive ProxyPass est utilisée à l'intérieur d'une section <Location>, le premier argument est omis et le répertoire local est obtenu à partir de la section <Location>. Il en est de même à l'intérieur d'une section <LocationMatch> ; cependant, ProxyPass n'interprète pas les expressions rationnelles, et dans ce cas, il est nécessaire d'utiliser la directive ProxyPassMatch.

Cette directive ne peut pas être placée dans une section <Directory> ou <Files>.

Si vous avez besoin d'un configuration de mandataire inverse plus souple, reportez-vous à la documentaion de la directive RewriteRule et son drapeau [P].

ProxyPassInterpolateEnv Directive

Cette directive, ainsi que l'argument interpolate des directives ProxyPass, ProxyPassReverse, ProxyPassReverseCookieDomain et ProxyPassReverseCookiePath, permet de configurer dynamiquement un mandataire inverse à l'aide de variables d'environnement, ces dernières pouvant être définies par un autre module comme mod_rewrite. Elle affecte les directives ProxyPass, ProxyPassReverse, ProxyPassReverseCookieDomain, et ProxyPassReverseCookiePath, en leur indiquant de remplacer la chaîne ${nom_var} dans les directives de configuration par la valeur de la variable d'environnement nom_var (si l'option interpolate est spécifiée).

Conservez cette directive à off (pour les performances du serveur), sauf si vous en avez réellement besoin.

ProxyPassMatch Directive

Cette directive est identique à la directive ProxyPass, mais fait usage des expressions rationnelles, au lieu d'une simple comparaison de préfixes. L'expression rationnelle spécifiée est comparée à l'url, et si elle correspond, le serveur va substituer toute correspondance entre parenthèses dans la chaîne donnée et l'utiliser comme nouvelle url.

Supposons que le serveur local a pour adresse http://example.com/ ; alors

va provoquer la conversion interne de la requête locale http://example.com/foo/bar.gif en une requête mandatée pour http://backend.example.com/foo/bar.gif.

Le drapeau ! vous permet de ne pas mandater un sous-répertoire donné.

Lorsque cette directive se situe à l'intérieur d'une section <LocationMatch>, le premier argument est omis et l'expression rationnelle est obtenue à partir de la directive <LocationMatch>.

Si vous avez besoin d'une configuration de mandataire inverse plus flexible, reportez-vous à la directive RewriteRule avec le drapeau [P].

ProxyPassReverse Directive

Cette directive permet de faire en sorte qu'Apache ajuste l'URL dans les en-têtes Location, Content-Location et URI des réponses de redirection HTTP. Ceci est essentiel lorsqu'Apache est utilisé en tant que mandataire inverse (ou passerelle), afin d'éviter de court-circuiter le mandataire inverse suite aux redirections HTTP sur le serveur d'arrière-plan qui restent derrière le mandataire inverse.

Seuls les en-têtes de réponse HTTP spécialement mentionnés ci-dessus seront réécrits. Apache ne réécrira ni les autres en-têtes de réponse, ni les références d'URLs dans les pages HTML. Cela signifie que dans le cas où un contenu mandaté contient des références à des URLs absolues, elles court-circuiteront le mandataire. Le module mod_proxy_html de Nick Kew est un module tiers qui parcourt le code HTML et réécrit les références d'URL.

chemin est le nom d'un chemin virtuel local. url est une URL partielle pour le serveur distant - ils sont utilisés de la même façon qu'avec la directive ProxyPass.

Supposons par exemple que le serveur local a pour adresse http://example.com/ ; alors

ne va pas seulement provoquer la conversion interne d'une requête locale pour http://example.com/miroir/foo/bar en une requête mandatée pour http://backend.example.com/bar (la fonctionnalité fournie par ProxyPass). Il va aussi s'occuper des redirections que le serveur backend.example.com envoie : lorsque http://backend.example.com/bar est redirigé par celui-ci vers http://backend.example.com/quux, Apache corrige ceci en http://example.com/miroir/foo/quux avant de faire suivre la redirection HTTP au client. Notez que le nom d'hôte utilisé pour construire l'URL est choisi en respectant la définition de la directive UseCanonicalName.

Notez que la directive ProxyPassReverse peut aussi être utilisée en conjonction avec la fonctionnalité pass-through (RewriteRule ... [P]) du module mod_rewrite, car elle ne dépend pas d'une directive ProxyPass correspondante.

Le mot-clé optionnel interpolate (disponible depuis httpd 2.2.9), utilisé en combinaison avec la directive ProxyPassInterpolateEnv, permet l'interpolation des variables d'environnement spécifiées en utilisant le format ${VARNAME}.

Lorsque cette directive est utilisée dans une section <Location>, le premier argument est omis et le répertoire local est obtenu à partir de l'argument de la directive <Location>. Il en est de même à l'intérieur d'une section <LocationMatch>, mais le résultat ne correspondra probablement pas à ce que vous attendez, car ProxyPassReverse interprète l'expression rationnelle littéralement comme un chemin ; si nécessaire dans cette situation, spécifiez la directive ProxyPassReverse en dehors de la section, ou dans une section <Location> séparée.

Cette directive ne peut pas être placée dans une section <Directory> ou <Files>.

ProxyPassReverseCookieDomain Directive

L'utilisation de cette directive est similaire à celle de la directive ProxyPassReverse, mais au lieu de réécrire des en-têtes qui contiennent des URLs, elle réécrit la chaîne correspondant au domaine dans les en-têtes Set-Cookie.

ProxyPassReverseCookiePath Directive

Cette directive s'avère utile en conjonction avec la directive ProxyPassReverse dans les situations où les chemins d'URL d'arrière-plan correspondent à des chemins publics sur le mandataire inverse. Cette directive permet de réécrire la chaîne path dans les en-têtes Set-Cookie. Si le début du chemin du cookie correspond à chemin-interne, le chemin du cookie sera remplacé par chemin-public.

Dans l'exemple fourni avec la directive ProxyPassReverse, la directive :

va réécrire un cookie possédant un chemin d'arrière-plan / (ou /example ou en fait tout chemin) en /mirror/foo/..

ProxyPreserveHost Directive

Lorsqu'elle est activée, cette directive va transmettre l'en-tête Host: de la requête entrante vers le serveur mandaté, au lieu du nom d'hôte spécifié par la directive ProxyPass.

Cette directive est habituellement définie à Off. Elle est principalement utile dans les configurations particulières comme l'hébergement virtuel mandaté en masse à base de nom, où l'en-tête Host d'origine doit être évalué par le serveur d'arrière-plan.

ProxyReceiveBufferSize Directive

La directive ProxyReceiveBufferSize permet de spécifier une taille de tampon réseau explicite (TCP/IP) pour les connexions mandatées HTTP et FTP, afin d'améliorer le débit de données. Elle doit être supérieure à 512 ou définie à 0 pour indiquer que la taille de tampon par défaut du système doit être utilisée.

ProxyRemote Directive

Cette directive permet de définir des mandataires distants pour ce mandataire. comparaison est soit le nom d'un protocole que supporte le serveur distant, soit une URL partielle pour laquelle le serveur distant devra être utilisé, soit * pour indiquer que le serveur distant doit être utilisé pour toutes les requêtes. serveur-distant est une URL partielle correspondant au serveur distant. Syntaxe :

protocole est effectivement le protocole à utiliser pour communiquer avec le serveur distant ; ce module ne supporte que http et https. Avec https, les requêtes sont transmises par le mandataire distant via la méthode HTTP CONNECT.

Dans la dernière ligne de l'exemple, le mandataire va faire suivre les requêtes FTP, encapsulées dans une autre requête mandatée HTTP, vers un autre mandataire capable de les traiter.

Cette directive supporte aussi les configurations de mandataire inverse - un serveur web d'arrière-plan peut être intégré dans l'espace d'URL d'un serveur virtuel, même si ce serveur est caché par un autre mandataire direct.

ProxyRemoteMatch Directive

La directive ProxyRemoteMatch est identique à la directive ProxyRemote, à l'exception que le premier argument est une expression rationnelle à mettre en correspondance avec l'URL de la requête.

ProxyRequests Directive

Cette directive permet d'activer/désactiver la fonctionnalité de serveur mandataire direct d'Apache. Définir ProxyRequests à Off n'interdit pas l'utilisation de la directive ProxyPass.

Pour une configuration typique de mandataire inverse ou passerelle, cette directive doit être définie à Off.

Afin d'activer la fonctionnalité de mandataire pour des sites HTTP et/ou FTP, les modules mod_proxy_http et/ou mod_proxy_ftp doivent aussi être chargés dans le serveur.

mod_proxy_connect doit être activé pour pouvoir mandater (en direct) des sites HTTPS.

Voir aussi

• Mandataires/Passerelles directs et inverses

ProxySet Directive

Cette directive propose une méthode alternative pour définir tout paramètre relatif aux répartiteurs de charge et serveurs cibles de mandataires normalement défini via la directive ProxyPass. Si elle se trouve dans un conteneur <Proxy url de répartiteur|url de serveur cible>, l'argument url n'est pas nécessaire. Comme effet de bord, le répartiteur ou serveur cible respectif est créé. Ceci peut s'avérer utile pour la mise en oeuvre d'un mandataire inverse via une directive RewriteRule au lieu de ProxyPass.

ProxyStatus Directive

Cette directive permet de spécifier si les données d'état du répartiteur de charge du mandataire doivent être affichées via la page d'état du serveur du module mod_status.

ProxyTimeout Directive

Cette directive permet à l'utilisateur de spécifier un délai pour les requêtes mandatées. Ceci s'avère utile dans le cas d'un serveur d'applications lent et bogué qui a tendance à se bloquer, et si vous préférez simplement renvoyer une erreur timeout et abandonner la connexion en douceur plutôt que d'attendre jusqu'à ce que le serveur veuille bien répondre.

ProxyVia Directive

Cette directive permet de contrôler l'utilisation de l'en-tête HTTP Via: par le mandataire. Le but recherché est de contrôler le flux des requêtes mandatées tout au long d'une chaîne de serveurs mandataires. Voir RFC 2616 (HTTP/1.1), section 14.45 pour une description des lignes d'en-tête Via:.

• Si elle est définie à Off, valeur par défaut, cette directive n'effectue aucun traitement particulier. Si une requête ou une réponse contient un en-tête Via:, il est transmis sans modification.
• Si elle est définie à On, chaque requête ou réponse se verra ajouter une ligne d'en-tête Via: pour le serveur courant.
• Si elle est définie à Full, chaque ligne d'en-tête Via: se verra ajouter la version du serveur Apache sous la forme d'un champ de commentaire Via:.
• Si elle est définie à Block, chaque requête mandatée verra ses lignes d'en-tête Via: supprimées. Aucun nouvel en-tête Via: ne sera généré.