summaryrefslogtreecommitdiff
path: root/docs/manual/mod/mod_setenvif.xml.fr
blob: 406d3af6e31aa2dcc48726eba6f9b21255a88b75 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
<?xml version="1.0"?>
<!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
<?xml-stylesheet type="text/xsl" href="../style/manual.fr.xsl"?>
<!-- English Revision: 1331227:1479264 (outdated) -->
<!-- French translation : Lucien GENTIS -->
<!-- Reviewed by : Vincent Deffontaines -->

<!--
 Licensed to the Apache Software Foundation (ASF) under one or more
 contributor license agreements.  See the NOTICE file distributed with
 this work for additional information regarding copyright ownership.
 The ASF licenses this file to You under the Apache License, Version 2.0
 (the "License"); you may not use this file except in compliance with
 the License.  You may obtain a copy of the License at

     http://www.apache.org/licenses/LICENSE-2.0

 Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
-->

<modulesynopsis metafile="mod_setenvif.xml.meta">

<name>mod_setenvif</name>
<description>Permet de d&eacute;finir des variables d'environnement en fonction
de caract&eacute;ristiques de la requ&ecirc;te</description>
<status>Base</status>
<sourcefile>mod_setenvif.c</sourcefile>
<identifier>setenvif_module</identifier>

<summary>

    <p>Le module <module>mod_setenvif</module> vous permet de d&eacute;finir
    des variables d'environnement internes en fonction du fait que telle ou telle
    caract&eacute;ristique de la requ&ecirc;te correspond ou non aux expressions
    rationnelles que vous sp&eacute;cifiez. Ces variables d'environnement
    peuvent &ecirc;tre utilis&eacute;es par d'autres parties du serveur pour prendre
    des d&eacute;cisions quant aux actions &agrave; entreprendre, et pour d&eacute;terminer
    si les scripts CGI et les pages SSI doivent pouvoir y acc&eacute;der.</p>

    <p>Les directives sont interpr&eacute;t&eacute;es selon l'ordre dans lequel elles
    appara&icirc;ssent dans les fichiers de configuration. Ainsi, des
    s&eacute;quences plus complexes peuvent &ecirc;tre utilis&eacute;es, comme dans cet
    exemple qui d&eacute;finit netscape si le navigateur est Mozilla et non
    MSIE.</p>

<highlight language="config">
BrowserMatch ^Mozilla netscape
BrowserMatch MSIE !netscape
</highlight>
</summary>

<seealso><a href="../env.html">Les variables d'environnement et le
serveur HTTP Apache</a></seealso>

<directivesynopsis>
<name>BrowserMatch</name>
<description>D&eacute;finit des variables d'environnement en fonction du
contenu de l'en-t&ecirc;te HTTP User-Agent</description>
<syntax>BrowserMatch <em>regex [!]env-variable</em>[=<em>valeur</em>]
[[!]<em>env-variable</em>[=<em>valeur</em>]] ...</syntax>
<contextlist><context>server config</context>
<context>virtual host</context><context>directory</context>
<context>.htaccess</context></contextlist>
<override>FileInfo</override>

<usage>
  <p>La directive <directive>BrowserMatch</directive> est un cas
  particulier de la directive <directive
  module="mod_setenvif">SetEnvIf</directive>, qui d&eacute;finit des variables
  d'environnement en fonction du contenu de l'en-t&ecirc;te de requ&ecirc;te HTTP
  <code>User-Agent</code>. Les deux lignes suivantes produisent le m&ecirc;me
  effet :</p>
<highlight language="config">
BrowserMatchNoCase Robot is_a_robot
SetEnvIfNoCase User-Agent Robot is_a_robot
</highlight>

    <p>Quelques exemples suppl&eacute;mentaires :</p>
<highlight language="config">
BrowserMatch ^Mozilla forms jpeg=yes browser=netscape
BrowserMatch "^Mozilla/[2-3]" tables agif frames javascript
BrowserMatch MSIE !javascript
</highlight>
</usage>
</directivesynopsis>

<directivesynopsis>
<name>BrowserMatchNoCase</name>
<description>D&eacute;finit des variables d'environnement en fonction du
contenu de l'en-t&ecirc;te HTTP User-Agent sans tenir compte de la
casse</description>
<syntax>BrowserMatchNoCase  <em>regex [!]env-variable</em>[=<em>valeur</em>]
    [[!]<em>env-variable</em>[=<em>valeur</em>]] ...</syntax>
<contextlist><context>server config</context>
<context>virtual host</context><context>directory</context>
<context>.htaccess</context></contextlist>
<override>FileInfo</override>

<usage>

    <p>La directive <directive>BrowserMatchNoCase</directive> est
    identique sur le plan s&eacute;mantique &agrave; la directive <directive
    module="mod_setenvif">BrowserMatch</directive>. Elle permet
    cependant une comparaison insensible &agrave; la casse. Par exemple :</p>
<highlight language="config">
BrowserMatchNoCase mac platform=macintosh
BrowserMatchNoCase win platform=windows
</highlight>

    <p>Les directives <directive>BrowserMatch</directive> et
    <directive>BrowserMatchNoCase</directive> sont des cas particuliers
    des directives <directive module="mod_setenvif">SetEnvIf</directive>
    et <directive module="mod_setenvif">SetEnvIfNoCase</directive>.
    Ainsi, les deux lignes suivantes produisent le m&ecirc;me effet :</p>
<highlight language="config">
BrowserMatchNoCase Robot is_a_robot
SetEnvIfNoCase User-Agent Robot is_a_robot
</highlight>
</usage>
</directivesynopsis>

<directivesynopsis>
<name>SetEnvIf</name>
<description>D&eacute;finit des variables d'environnement en fonction des
attributs de la requ&ecirc;te</description>
<syntax>SetEnvIf <em>attribut
    regex [!]env-variable</em>[=<em>valeur</em>]
    [[!]<em>env-variable</em>[=<em>valeur</em>]] ...</syntax>
<contextlist><context>server config</context>
<context>virtual host</context><context>directory</context>
<context>.htaccess</context></contextlist>
<override>FileInfo</override>

<usage>
    <p>La directive <directive>SetEnvIf</directive> permet de d&eacute;finir
    des variables d'environnement en fonction des attributs de la
    requ&ecirc;te. L'<em>attribut</em> sp&eacute;cifi&eacute; comme premier argument peut
    se pr&eacute;senter sous l'une des quatre formes suivantes :</p>

<ol>
<li>Un champ d'en-t&ecirc;te de requ&ecirc;te HTTP (voir la <a
    href="http://www.rfc-editor.org/rfc/rfc2616.txt">RFC2616</a> pour
    plus d'information &agrave; leur propos) ; par exemple : <code>Host</code>,
    <code>User-Agent</code>, <code>Referer</code>, ou
    <code>Accept-Language</code>. Il est possible d'utiliser une
    expression rationnelle pour sp&eacute;cifier un jeu d'en-t&ecirc;tes de
    requ&ecirc;te.</li>

<li>Une des caract&eacute;ristiques de la requ&ecirc;te suivantes :
    <ul>
      <li><code>Remote_Host</code> - le nom d'h&ocirc;te (s'il est disponible)
      du client qui effectue la requ&ecirc;te</li>

      <li><code>Remote_Addr</code> - l'adresse IP du client qui effectue
      la requ&ecirc;te</li>

      <li><code>Server_Addr</code> - l'adresse IP du serveur qui a re&ccedil;u
      la requ&ecirc;te (uniquement &agrave; partir des versions sup&eacute;rieures &agrave;
      2.0.43)</li>

      <li><code>Request_Method</code> - Le nom de la m&eacute;thode HTTP
      utilis&eacute;e (<code>GET</code>, <code>POST</code>, <em>et
      cetera...</em>)</li>

      <li><code>Request_Protocol</code> - le nom et la version du
      protocole utilis&eacute; pour la requ&ecirc;te (par exemple "HTTP/0.9",
      "HTTP/1.1", <em>etc...</em>)</li>

      <li><code>Request_URI</code> - la ressource demand&eacute;e dans la ligne
      de requ&ecirc;te HTTP -- en g&eacute;n&eacute;ral la partie de l'URL suivant le
      protocole et le nom du serveur, sans la cha&icirc;ne d'arguments. Voir
      la directive <directive
      module="mod_rewrite">RewriteCond</directive> du module
      <module>mod_rewrite</module> pour plus d'informations sur la
      mani&egrave;re de mettre en correspondance votre cha&icirc;ne d'arguments.</li>
    </ul>
</li>

<li>Le nom d'une variable d'environnement parmi la liste de celles qui
sont associ&eacute;es &agrave; la requ&ecirc;te. Ceci permet &agrave; la directive
<directive>SetEnvIf</directive> d'effectuer des tests en fonction du
r&eacute;sultat de comparaisons pr&eacute;c&eacute;dentes. Seules les variables
d'environnement d&eacute;finies par des directives
<code>SetEnvIf[NoCase]</code> pr&eacute;c&eacute;dentes sont disponibles pour
effectuer des tests de cette mani&egrave;re. 'Pr&eacute;c&eacute;dentes' signifie qu'elles se
trouvent &agrave; un niveau plus global de la configuration (par exemple au
niveau du serveur principal), ou plus haut chronologiquement dans le
contexte de la directive. Les variables d'environnement ne seront prises
en compte que si aucune correspondance n'a &eacute;t&eacute; trouv&eacute;e parmi les
caract&eacute;ristiques de la requ&ecirc;te, et si <em>attribut</em> n'a pas &eacute;t&eacute;
sp&eacute;cifi&eacute; sous la forme d'une expression rationnelle.</li>

</ol>

<p>Le second argument (<em>regex</em>) est une <glossary
ref="regex">expression rationnelle</glossary>. Si  <em>regex</em>
correspond &agrave; l'<em>attribut</em>, les arguments suivants sont &eacute;valu&eacute;s.</p>

<p>Le reste des arguments constitue les noms des variables &agrave; d&eacute;finir,
ainsi que les valeurs optionnelles qui doivent leur &ecirc;tre affect&eacute;es. Ils
peuvent se pr&eacute;senter sous les formes suivantes :</p>

    <ol>
      <li><code><em>nom-variable</em></code>, or</li>

      <li><code>!<em>nom-variable</em></code>, or</li>

      <li><code><em>nom-variable</em>=<em>valeur</em></code></li>
    </ol>

    <p>Dans la premi&egrave;re forme, la valeur sera d&eacute;finie &agrave; "1". Dans la
    seconde forme, la variable sera supprim&eacute;e si elle a &eacute;t&eacute; d&eacute;finie au
    pr&eacute;alable, et dans la troisi&egrave;me forme, la variable sera d&eacute;finie &agrave; la
    valeur litt&eacute;rale sp&eacute;cifi&eacute;e par <code><em>valeur</em></code>. Depuis
    la version 2.0.51, Apache httpd reconna&icirc;t les occurrences de variables
    <code>$1</code>..<code>$9</code> &agrave; l'int&eacute;rieur de
    <code><em>valeur</em></code>, et les remplace par les
    sous-expressions entre parenth&egrave;ses correspondantes de
    <var>regex</var>.</p>

<highlight language="config">
SetEnvIf Request_URI "\.gif$" object_is_image=gif
SetEnvIf Request_URI "\.jpg$" object_is_image=jpg
SetEnvIf Request_URI "\.xbm$" object_is_image=xbm
    
SetEnvIf Referer www\.mydomain\.example\.com intra_site_referral
    
SetEnvIf object_is_image xbm XBIT_PROCESSING=1
    
SetEnvIf ^TS  ^[a-z]  HAVE_TS
</highlight>

    <p>Les trois premi&egrave;res lignes d&eacute;finissent la variable
    d'environnement <code>objet_est_une_image</code> si l'objet de la
    requ&ecirc;te est un fichier image, et la quatri&egrave;me d&eacute;finit la variable
    <code>r&eacute;f&eacute;rant_intra_site</code> si la page r&eacute;f&eacute;rante se trouve
    quelque part dans le site web
    <code>www.mon-domaine.example.com</code>.</p>

    <p>La derni&egrave;re ligne d&eacute;finit la variable d'environnement
    <code>HAVE_TS</code> si la requ&ecirc;te contient un en-t&ecirc;te dont le nom
    commence par "TS" et dont la valeur commence par tout caract&egrave;re du
    jeu [a-z].</p>
</usage>

<seealso><a href="../env.html">Les variables d'environnement et le
serveur HTTP Apache</a> pour des exemples suppl&eacute;mentaires.
</seealso>
</directivesynopsis>

<directivesynopsis>

<name>SetEnvIfExpr</name>
<description>D&eacute;finit des variables d'environnement en fonction d'une expression ap_expr</description>
<syntax>SetEnvIfExpr <em>expr
    [!]env-variable</em>[=<em>valeur</em>]
    [[!]<em>env-variable</em>[=<em>valeur</em>]] ...</syntax>
<contextlist><context>server config</context>
<context>virtual host</context><context>directory</context>
<context>.htaccess</context></contextlist>
<override>FileInfo</override>

<usage>
    <p>La directive <directive>SetEnvIfExpr</directive> permet de
    d&eacute;finir des variables d'environnement en fonction d'une expression
    <directive type="section">If</directive> <code>ap_expr</code>. Cette
    expression est &eacute;valu&eacute;e &agrave; l'ex&eacute;cution, et utilise les variables
    d'environnement <em>env-variable</em> de la m&ecirc;me mani&egrave;re que la
    directive <directive>SetEnvIf</directive>.</p>

<highlight language="config">
    SetEnvIfExpr "tolower(req('X-Sendfile')) == 'd:\images\very_big.iso')" iso_delivered
</highlight>

    <p>Dans cet exemple, la variable d'environnement
    <code>iso_delivered</code> est d&eacute;finie chaque fois que notre
    application tente de l'envoyer via <code>X-Sendfile</code>.</p>

    <p>Il pourrait &ecirc;tre plus utile de d&eacute;finir une variable rfc1918 si
    l'adresse IP distante est une adresse priv&eacute;e au sens de la RFC 1918
    :</p>

<highlight language="config">
    SetEnvIfExpr "-R '10.0.0.0/8' || -R '172.16.0.0/12' || -R '192.168.0.0/16'" rfc1918
</highlight>
</usage>

<seealso><a href="../expr.html">Les expressions dans le serveur HTTP
Apache</a>, pour une r&eacute;f&eacute;rence compl&egrave;te et davantage d'exemples.</seealso>
<seealso>La directive <directive type="section">If</directive> peut &ecirc;tre
utilis&eacute;e pour obtenir des r&eacute;sultats similaires.</seealso>
<seealso><module>mod_filter</module></seealso>
</directivesynopsis>

<directivesynopsis>
<name>SetEnvIfNoCase</name>
<description>D&eacute;finit des variables d'environnement en fonction des
attributs de la requ&ecirc;te sans tenir compte de la casse</description>
<syntax>SetEnvIfNoCase <em>attribut regex
        [!]env-variable</em>[=<em>valeur</em>]
    [[!]<em>env-variable</em>[=<em>valeur</em>]] ...</syntax>
<contextlist><context>server config</context>
<context>virtual host</context><context>directory</context>
<context>.htaccess</context></contextlist>
<override>FileInfo</override>

<usage>

    <p>La directive <directive>SetEnvIfNoCase</directive> est identique
    d'un point de vue s&eacute;mantique &agrave; la directive <directive
    module="mod_setenvif">SetEnvIf</directive>, et ne s'en distingue que
    par le fait que la comparaison des expressions rationnelles est
    effectu&eacute;e sans tenir compte de la casse. Par exemple :</p>
<highlight language="config">
   SetEnvIfNoCase Host Example\.Org site=apache
</highlight>

    <p>Cette ligne va d&eacute;finir la variable d'environnement
    <code>site</code> avec la valeur "<code>example</code>" si le champ
    d'en-t&ecirc;te de requ&ecirc;te HTTP <code>Host:</code> est pr&eacute;sent et contient
    <code>Example.Org</code>, <code>example.org</code>, ou une autre
    combinaison des m&ecirc;mes caract&egrave;res, sans tenir compte de la casse.</p>
</usage>
</directivesynopsis>
</modulesynopsis>