granicus.if.org Git - apache/blob - docs/manual/mod/mod_proxy_ftp.html.en

   1 <?xml version="1.0" encoding="ISO-8859-1"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
   4 <meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type" />
   5 <!--
   6         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   7               This file is generated from xml source: DO NOT EDIT
   8         XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
   9       -->
  10 <title>mod_proxy_ftp - Apache HTTP Server Version 2.5</title>
  11 <link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
  12 <link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
  13 <link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" /><link rel="stylesheet" type="text/css" href="../style/css/prettify.css" />
  14 <script src="../style/scripts/prettify.min.js" type="text/javascript">
  15 </script>
  16
  17 <link href="../images/favicon.ico" rel="shortcut icon" /></head>
  18 <body>
  19 <div id="page-header">
  20 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/quickreference.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
  21 <p class="apache">Apache HTTP Server Version 2.5</p>
  22 <img alt="" src="../images/feather.png" /></div>
  23 <div class="up"><a href="./"><img title="&lt;-" alt="&lt;-" src="../images/left.gif" /></a></div>
  24 <div id="path">
  25 <a href="http://www.apache.org/">Apache</a> &gt; <a href="http://httpd.apache.org/">HTTP Server</a> &gt; <a href="http://httpd.apache.org/docs/">Documentation</a> &gt; <a href="../">Version 2.5</a> &gt; <a href="./">Modules</a></div>
  26 <div id="page-content">
  27 <div id="preamble"><h1>Apache Module mod_proxy_ftp</h1>
  28 <div class="toplang">
  29 <p><span>Available Languages: </span><a href="../en/mod/mod_proxy_ftp.html" title="English">&nbsp;en&nbsp;</a> |
  30 <a href="../fr/mod/mod_proxy_ftp.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a></p>
  31 </div>
  32 <table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>FTP support module for
  33 <code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code></td></tr>
  34 <tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
  35 <tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>proxy_ftp_module</td></tr>
  36 <tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_proxy_ftp.c</td></tr></table>
  37 <h3>Summary</h3>
  38
  39     <p>This module <em>requires</em> the service of <code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code>. It provides support for the proxying
  40     FTP sites.  Note that FTP support is currently limited to
  41     the GET method.</p>
  42
  43     <p>Thus, in order to get the ability of handling FTP proxy requests,
  44     <code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code> and <code class="module"><a href="../mod/mod_proxy_ftp.html">mod_proxy_ftp</a></code>
  45     have to be present in the server.</p>
  46
  47     <div class="warning"><h3>Warning</h3>
  48       <p>Do not enable proxying until you have <a href="mod_proxy.html#access">secured your server</a>. Open proxy
  49       servers are dangerous both to your network and to the Internet at
  50       large.</p>
  51     </div>
  52 </div>
  53 <div id="quickview"><h3>Topics</h3>
  54 <ul id="topics">
  55 <li><img alt="" src="../images/down.gif" /> <a href="#mimetypes">Why doesn't file type <var>xxx</var>
  56     download via FTP?</a></li>
  57 <li><img alt="" src="../images/down.gif" /> <a href="#type">How can I force an FTP ASCII download of
  58     File <var>xxx</var>?</a></li>
  59 <li><img alt="" src="../images/down.gif" /> <a href="#ftpnonget">How can I do FTP upload?</a></li>
  60 <li><img alt="" src="../images/down.gif" /> <a href="#percent2fhck">How can I access FTP files outside
  61     of my home directory?</a></li>
  62 <li><img alt="" src="../images/down.gif" /> <a href="#ftppass">How can I hide the FTP cleartext password
  63     in my browser's URL line?</a></li>
  64 <li><img alt="" src="../images/down.gif" /> <a href="#wildcard">Why do I get a file listing when I expected
  65         a file to be downloaded?</a></li>
  66 </ul><h3 class="directives">Directives</h3>
  67 <ul id="toc">
  68 <li><img alt="" src="../images/down.gif" /> <a href="#proxyftpdircharset">ProxyFtpDirCharset</a></li>
  69 <li><img alt="" src="../images/down.gif" /> <a href="#proxyftpescapewildcards">ProxyFtpEscapeWildcards</a></li>
  70 <li><img alt="" src="../images/down.gif" /> <a href="#proxyftplistonwildcard">ProxyFtpListOnWildcard</a></li>
  71 </ul>
  72 <h3>Bugfix checklist</h3><ul class="seealso"><li><a href="https://www.apache.org/dist/httpd/CHANGES_2.4">httpd changelog</a></li><li><a href="https://bz.apache.org/bugzilla/buglist.cgi?bug_status=__open__&amp;list_id=144532&amp;product=Apache%20httpd-2&amp;query_format=specific&amp;order=changeddate%20DESC%2Cpriority%2Cbug_severity&amp;component=mod_proxy_ftp">Known issues</a></li><li><a href="https://bz.apache.org/bugzilla/enter_bug.cgi?product=Apache%20httpd-2&amp;component=mod_proxy_ftp">Report a bug</a></li></ul><h3>See also</h3>
  73 <ul class="seealso">
  74 <li><code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code></li>
  75 <li><a href="#comments_section">Comments</a></li></ul></div>
  76 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  77 <div class="section">
  78 <h2><a name="mimetypes" id="mimetypes">Why doesn't file type <var>xxx</var>
  79     download via FTP?</a></h2>
  80       <p>You probably don't have that particular file type defined as
  81       <code>application/octet-stream</code> in your proxy's mime.types
  82       configuration file. A useful line can be</p>
  83
  84       <div class="example"><pre>application/octet-stream   bin dms lha lzh exe class tgz taz</pre></div>
  85     <p>Alternatively you may prefer to default everything to binary:</p>
  86       <div class="example"><pre class="prettyprint lang-config">ForceType application/octet-stream</pre>
  87 </div>
  88     </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  89 <div class="section">
  90 <h2><a name="type" id="type">How can I force an FTP ASCII download of
  91     File <var>xxx</var>?</a></h2>
  92       <p>In the rare situation where you must download a specific file using the
  93       FTP <code>ASCII</code> transfer method (while the default transfer is in
  94       <code>binary</code> mode), you can override <code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code>'s
  95       default by suffixing the request with <code>;type=a</code> to force an
  96       ASCII transfer. (FTP Directory listings are always executed in ASCII mode,
  97       however.)</p>
  98     </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
  99 <div class="section">
 100 <h2><a name="ftpnonget" id="ftpnonget">How can I do FTP upload?</a></h2>
 101     <p>Currently, only GET is supported for FTP in mod_proxy.  You can
 102     of course use HTTP upload (POST or PUT) through an Apache proxy.</p>
 103     </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 104 <div class="section">
 105 <h2><a name="percent2fhck" id="percent2fhck">How can I access FTP files outside
 106     of my home directory?</a></h2>
 107       <p>An FTP URI is interpreted relative to the home directory of the user
 108       who is logging in. Alas, to reach higher directory levels you cannot
 109       use /../, as the dots are interpreted by the browser and not actually
 110       sent to the FTP server. To address this problem, the so called <dfn>Squid
 111       %2f hack</dfn> was implemented in the Apache FTP proxy; it is a
 112       solution which is also used by other popular proxy servers like the <a href="http://www.squid-cache.org/">Squid Proxy Cache</a>. By
 113       prepending <code>/%2f</code> to the path of your request, you can make
 114       such a proxy change the FTP starting directory to <code>/</code> (instead
 115       of the home directory). For example, to retrieve the file
 116       <code>/etc/motd</code>, you would use the URL:</p>
 117
 118       <div class="example"><p><code>
 119         ftp://<var>user</var>@<var>host</var>/%2f/etc/motd
 120       </code></p></div>
 121     </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 122 <div class="section">
 123 <h2><a name="ftppass" id="ftppass">How can I hide the FTP cleartext password
 124     in my browser's URL line?</a></h2>
 125       <p>To log in to an FTP server by username and password, Apache uses
 126       different strategies. In absence of a user name and password in the URL
 127       altogether, Apache sends an anonymous login to the FTP server,
 128       <em>i.e.</em>,</p>
 129
 130       <div class="example"><p><code>
 131         user: anonymous<br />
 132         password: apache_proxy@
 133       </code></p></div>
 134
 135       <p>This works for all popular FTP servers which are configured for
 136       anonymous access.</p>
 137
 138       <p>For a personal login with a specific username, you can embed the user
 139       name into the URL, like in:</p>
 140
 141       <div class="example"><p><code>
 142         ftp://<var>username</var>@<var>host</var>/myfile
 143       </code></p></div>
 144
 145       <p>If the FTP server asks for a password when given this username (which
 146       it should), then Apache will reply with a <code>401</code> (Authorization
 147       required) response, which causes the Browser to pop up the
 148       username/password dialog. Upon entering the password, the connection
 149       attempt is retried, and if successful, the requested resource is
 150       presented. The advantage of this procedure is that your browser does not
 151       display the password in cleartext (which it would if you had used</p>
 152
 153       <div class="example"><p><code>
 154         ftp://<var>username</var>:<var>password</var>@<var>host</var>/myfile
 155       </code></p></div>
 156
 157       <p>in the first place).</p>
 158
 159       <div class="note"><h3>Note</h3>
 160         <p>The password which is transmitted in such a way is not encrypted on
 161         its way. It travels between your browser and the Apache proxy server in
 162         a base64-encoded cleartext string, and between the Apache proxy and the
 163         FTP server as plaintext. You should therefore think twice before
 164         accessing your FTP server via HTTP (or before accessing your personal
 165         files via FTP at all!) When using insecure channels, an eavesdropper
 166         might intercept your password on its way.</p>
 167       </div>
 168     </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 169 <div class="section">
 170 <h2><a name="wildcard" id="wildcard">Why do I get a file listing when I expected
 171         a file to be downloaded?</a></h2>
 172       <p>In order to allow both browsing the directories on an FTP server and
 173         downloading files, Apache looks at the request URL.  If it looks like
 174         a directory, or contains wildcard characters ("*?[{~"), then it
 175         guesses that a listing is wanted instead of a download.</p>
 176       <p>You can disable the special handling of names with wildcard characters.
 177         See the <code class="directive">ProxyFtpListOnWildcard</code> directive.
 178       </p>
 179     </div>
 180 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 181 <div class="directive-section"><h2><a name="ProxyFtpDirCharset" id="ProxyFtpDirCharset">ProxyFtpDirCharset</a> <a name="proxyftpdircharset" id="proxyftpdircharset">Directive</a></h2>
 182 <table class="directive">
 183 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Define the character set for proxied FTP listings</td></tr>
 184 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxyFtpDirCharset <var>character set</var></code></td></tr>
 185 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>ProxyFtpDirCharset ISO-8859-1</code></td></tr>
 186 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>
 187 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 188 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_proxy_ftp</td></tr>
 189 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Moved from <code class="module"><a href="../mod/mod_proxy.html">mod_proxy</a></code> in Apache 2.3.5.</td></tr>
 190 </table>
 191     <p>The <code class="directive">ProxyFtpDirCharset</code> directive defines the
 192     character set to be set for FTP directory listings in HTML generated by
 193     <code class="module"><a href="../mod/mod_proxy_ftp.html">mod_proxy_ftp</a></code>.</p>
 194
 195 </div>
 196 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 197 <div class="directive-section"><h2><a name="ProxyFtpEscapeWildcards" id="ProxyFtpEscapeWildcards">ProxyFtpEscapeWildcards</a> <a name="proxyftpescapewildcards" id="proxyftpescapewildcards">Directive</a></h2>
 198 <table class="directive">
 199 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Whether wildcards in requested filenames are escaped when sent to the FTP server</td></tr>
 200 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxyFtpEscapeWildcards [on|off]</code></td></tr>
 201 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>on</code></td></tr>
 202 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>
 203 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 204 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_proxy_ftp</td></tr>
 205 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache 2.3.3 and later</td></tr>
 206 </table>
 207   <p>The <code class="directive">ProxyFtpEscapeWildcards</code> directive
 208     controls whether wildcard characters ("*?[{~") in requested
 209     filenames are escaped with backslash before sending them to the
 210     FTP server.  That is the default behavior, but many FTP servers
 211     don't know about the escaping and try to serve the literal filenames
 212     they were sent, including the backslashes in the names.  </p>
 213     <p>Set to "off" to allow downloading files with wildcards
 214     in their names from FTP servers that don't understand wildcard
 215     escaping.</p>
 216
 217 </div>
 218 <div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
 219 <div class="directive-section"><h2><a name="ProxyFtpListOnWildcard" id="ProxyFtpListOnWildcard">ProxyFtpListOnWildcard</a> <a name="proxyftplistonwildcard" id="proxyftplistonwildcard">Directive</a></h2>
 220 <table class="directive">
 221 <tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Whether wildcards in requested filenames trigger a file listing</td></tr>
 222 <tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>ProxyFtpListOnWildcard [on|off]</code></td></tr>
 223 <tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>on</code></td></tr>
 224 <tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory</td></tr>
 225 <tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
 226 <tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_proxy_ftp</td></tr>
 227 <tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache 2.3.3 and later</td></tr>
 228 </table>
 229   <p>The <code class="directive">ProxyFtpListOnWildcard</code> directive
 230     controls whether wildcard characters ("*?[{~") in requested
 231     filenames cause <code class="module"><a href="../mod/mod_proxy_ftp.html">mod_proxy_ftp</a></code> to return a listing
 232     of files instead of downloading a file.  By default (value on),
 233     they do.  Set to "off" to allow downloading files even if they
 234     have wildcard characters in their names.</p>
 235
 236 </div>
 237 </div>
 238 <div class="bottomlang">
 239 <p><span>Available Languages: </span><a href="../en/mod/mod_proxy_ftp.html" title="English">&nbsp;en&nbsp;</a> |
 240 <a href="../fr/mod/mod_proxy_ftp.html" hreflang="fr" rel="alternate" title="Français">&nbsp;fr&nbsp;</a></p>
 241 </div><div class="top"><a href="#page-header"><img src="../images/up.gif" alt="top" /></a></div><div class="section"><h2><a id="comments_section" name="comments_section">Comments</a></h2><div class="warning"><strong>Notice:</strong><br />This is not a Q&amp;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 <a href="http://httpd.apache.org/lists.html">mailing lists</a>.</div>
 242 <script type="text/javascript"><!--//--><![CDATA[//><!--
 243 var comments_shortname = 'httpd';
 244 var comments_identifier = 'http://httpd.apache.org/docs/trunk/mod/mod_proxy_ftp.html';
 245 (function(w, d) {
 246     if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
 247         d.write('<div id="comments_thread"><\/div>');
 248         var s = d.createElement('script');
 249         s.type = 'text/javascript';
 250         s.async = true;
 251         s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
 252         (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
 253     }
 254     else {
 255         d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
 256     }
 257 })(window, document);
 258 //--><!]]></script></div><div id="footer">
 259 <p class="apache">Copyright 2017 The Apache Software Foundation.<br />Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p>
 260 <p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/quickreference.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div><script type="text/javascript"><!--//--><![CDATA[//><!--
 261 if (typeof(prettyPrint) !== 'undefined') {
 262     prettyPrint();
 263 }
 264 //--><!]]></script>
 265 </body></html>