## ProFTPD module `mod_xfer`

The `mod_xfer` module handles most of the FTP commands related to file transfers.

## Directives

- AllowOverwrite
- AllowRetrieveRestart
- AllowStoreRestart
- DeleteAbortedStores
- DisplayFileTransfer
- HiddenStores
- MaxRetrieveFileSize
- MaxStoreFileSize
- MaxTransfersPerHost
- MaxTransfersPerUser
- StoreUniquePrefix
- TimeoutNoTransfer
- TimeoutStalled
- TransferPriority
- TransferRate
- UseSendfile

## AllowOverwrite

Syntax: AllowOverwrite on|off
Default: `AllowOverwrite off`
Context: server config, `<VirtualHost>`, `<Global>`, `<Anonymous>`, `<Directory>`, `.ftpaccess`
Module: mod_xfer
Compatibility: 0.99.0 and later

The `AllowOverwrite` directive permits newly transfered files to overwrite existing files. By default, FTP clients cannot overwrite existing files.

## AllowRetrieveRestart

Syntax: AllowRetrieveRestart on|off
Default: `AllowRetrieveRestart on`
Context: server config, `<VirtualHost>`, `<Global>`, `<Anonymous>`, `<Directory>`, `.ftpaccess`
Module: mod_xfer
Compatibility: 0.99.0 and later

The `AllowRetrieveRestart` directive permits (or denies) clients from performing "restart" download (retrieve) file transfers via the FTP `REST` command. By default, restarted downloads are allowed, so that clients may resume interrupted file transfers at a later time without losing previously collected data.

See also: `AllowStoreRestart`

## AllowStoreRestart

Syntax: AllowStoreRestart on|off
Default: `AllowStoreRestart on`
Context: server config, `<VirtualHost>`, `<Global>`, `<Anonymous>`, `<Directory>`, `.ftpaccess`
Module: mod_xfer
Compatibility: 0.99.0 and later

The `AllowStoreRestart` directive permits (or denies) clients from "restarting" interrupted upload (store) transfers. By default restarting (via the FTP `REST` command) is not permitted when uploading files to the server. Care should be taken to disallow anonymous FTP "incoming" transfers to be restarted, as this will allow clients to corrupt or increase the size of previously stored files (even if not their own).

The FTP `REST` command is automatically blocked when `HiddenStores` is enabled, with the server returning a 501 error code to the client.

See also: `AllowRetrieveRestart`, `DeleteAbortedStore`, `HiddenStores`

## DeleteAbortedStores

Syntax: DeleteAbortedStores on|off
Default: `DeleteAbortedStores off`
Context: server config, `<VirtualHost>`, `<Global>`, `<Anonymous>`, `<Directory>`, `.ftpaccess`
Module: mod_xfer
Compatibility: 1.2.0rc2 and later

The `DeleteAbortedStores` directive controls whether ProFTPD deletes partially uploaded files if the transfer is stopped via the FTP `ABOR` command (as opposed to a connection failure). By default, `DeleteAbortedStores` is off; however when `HiddenStores` is enabled, then `DeleteAbortedStores` is automatically enabled as well.

See also: `HiddenStores`

## HiddenStores

Syntax: HiddenStores on|off|prefix [suffix]
Default: `HiddenStores off`
Context: server config, `<VirtualHost>`, `<Global>`, `<Anonymous>`, `<Directory>`
Module: mod_xfer
Compatibility: 1.2.7rc1 and later

The `HiddenStores` directive enables two-step file uploads: files are uploaded as ".in.filename." and once the upload is complete, renamed to just filename. This provides a degree of atomicity and helps prevent 1) incomplete uploads and 2) files being used while they are still being uploaded. When `HiddenStores` is enabled, then `DeleteAbortedStores` is automatically enabled as well.

Note that if the temporary file name is already in use (e.g., a server crash during upload), it will prevent the file from being uploaded.

The FTP `REST` command is automatically blocked when `HiddenStores` is enabled, with the server returning a 501 error code to the client.

In `proftpd-1.3.3rc2` and later, the ".in." prefix can be customised via the `HiddenStores` directive, e.g.:

      # Use a different prefix for HiddenStores
      HiddenStores filepart-

In `proftpd-1.3.5rc2` and later, the "." suffix can be customised using the `HiddenStores` directive as well, e.g.:

      # Use a different prefix and suffix for HiddenStores
      HiddenStores incoming- .lock

You can also use this capability to configure no prefix, and just a suffix:

      # Use an empty string as the prefix, and a suffix of ".filepart".
      HiddenStores "" ".filepart"

Note that in order to specify the suffix, you must specify a prefix as well.

Discussion
When would you want or need to specify different prefix and suffix values for `HiddenStores`? You might need this when, for example, your `proftpd` writes files to an NFS-mounted filesystem. Another machine mounts that same filesystem remotely using a CIFS client (e.g. a NetApp machine). The trailing "." suffix causes the CIFS client to list the temporary filenames different (e.g. in a Windows 8.3 file format style): "in.test." becomes "INTES~1". This view confuses users/admins.

By changing the default `HiddenStores` suffix, then, that modified CIFS client filename view can be avoided.

See also: `AllowStoreRestart`, `DeleteAbortedStores`

## MaxRetrieveFileSize

Syntax: MaxRetrieveFileSize [number|"*" units ["user"|"group"|"class" expression]]
Default: None
Context: server config, `<VirtualHost>`, `<Global>`, `<Anonymous>`, `<Directory>`, `.ftpaccess`
Module: mod_xfer
Compatibility: 1.2.7rc1 and later

The `MaxRetrieveFileSize` directive sets a maximum limit on the size of a single file downloaded from `proftpd`. If the requested file size is larger than than the configured maximum limit, the data transfer will be rejected.

A single "*" argument configures unlimited file sizes, and is used primarily to override any inherited restrictions from higher-level configuration sections. The given number is the number of bytes for the limit, and is followed by a units specifier of (case-insensitive) "Gb" (Gigabytes), "Mb" (Megabytes), "Kb" (Kilobytes), or "B" (bytes). The given number of bytes is multiplied by the appropriate factor.

The optional parameters are used to restrict the file size limits only to specific users. If the "user" restriction is given, then expression is a user-expression specifying to which users the rule applies. Similarly for the "group" restriction. For the "class" restriction, the expression is simply the name of connection class for whom the rule will apply. If no matching user, group, or class expression (in that order) is found for the current user, then a limit with no expression (i.e. no "user", "group", or "class" identifier) is applied.

Examples:

      # Restrict downloads to only 1 gigabyte
      MaxRetrieveFileSize 1 Gb

      # Restrict downloads for user fred, but allow unlimited download size for
      # everyone else
      MaxRetrieveFileSize 50 Kb user fred
      MaxRetrieveFileSize *

See also: `MaxStoreFileSize`

## MaxStoreFileSize

Syntax: MaxStoreFileSize [number|"*" units ["user"|"group"|"class" expression]]
Default: None
Context: server config, `<VirtualHost>`, `<Global>`, `<Anonymous>`, `<Directory>`, `.ftpaccess`
Module: mod_xfer
Compatibility: 1.2.7rc1 and later

The `MaxStoreFileSize` directive sets a maximum limit on the size of a single file uploaded to `proftpd`. When the configured maximum limit is reached, the data transfer will be aborted.

A single "*" argument configures unlimited file sizes, and is used primarily to override any inherited restrictions from higher-level configuration sections. The given number is the number of bytes for the limit, and is followed by a units specifier of (case-insensitive) "Gb" (Gigabytes), "Mb" (Megabytes), "Kb" (Kilobytes), or "B" (bytes). The given number of bytes is multiplied by the appropriate factor.

The optional parameters are used to restrict the file size limits only to specific users. If the "user" restriction is given, then expression is a user-expression specifying to which users the rule applies. Similarly for the "group" restriction. For the "class" restriction, the expression is simply the name of connection class for whom the rule will apply. If no matching user, group, or class expression (in that order) is found for the current user, then a limit with no expression (i.e. no "user", "group", or "class" identifier) is applied.

Examples:

      # Restrict upload to only 3 megabytes
      MaxStoreFileSize 3 Mb

      # Restrict anonymous uploads to 50k, but allow unlimited upload size for
      # everyone else
      MaxStoreFileSize 50 Kb user anonymous
      MaxStoreFileSize *

NOTE: In FTP uploads, the size of the file being uploaded is not sent to the FTP server first; this means that the FTP server does not know in advance how much data the FTP client is going to send. The FTP server can only count the number of bytes being uploaded, and stop the transfer when a configured limit is reached. This means that `MaxStoreFileSize` cannot be used to prevent an FTP client from even sending the bytes over the network.

See also: `MaxRetrieveFileSize`

## TimeoutNoTransfer

Syntax: TimeoutNoTransfer seconds
Default: 300 seconds
Context: server config, `<VirtualHost>`, `<Global>`
Module: mod_xfer
Compatibility: 0.99.0 and later

The `TimeoutNoTransfer` directive configures the maximum number of seconds a client is allowed to spend connected, after authentication, without issuing a data transfer command which results in a data connection (i.e. sending/receiving a file, or requesting a directory listing). The maximum allowed seconds value is 65535 (108 minutes).

See also: `TimeoutIdle`, `TimeoutLogin`, `TimeoutStalled`.

## TimeoutStalled

Syntax: TimeoutStalled seconds
Default: 3600 seconds
Context: server config, `<VirtualHost>`, `<Global>`
Module: mod_xfer
Compatibility: 1.1.6 and later

The `TimeoutStalled` directive sets the maximum number of seconds a data connection between `proftpd` and a client can exist but have no actual data transferred (i.e. "stalled"). If the seconds parameter is set to zero, data transfers are allowed to stall indefinitely; note that this is not a recommended configuration. The maximum allowed seconds value is 65535 (108 minutes).

## TransferPriority

Syntax: TransferPriority cmd-list "low"|"medium"|"high"|number
Default: None
Context: server config, `<VirtualHost>`, `<Global>`, `<Anonymous>`
Module: mod_xfer
Compatibility: 1.3.2rc1 and later

The `TransferPriority` directive is used to tweak the process priority (a la `nice(1)`) of the session during data transfers. For example, large (or anonymous) data transfers can be configured to have lower priorities, so as to get lower priority than other applications from the kernel.

The priority parameter can one of the convenient "high", "medium", or "low" keywords, or it can be an explicit number. As per the `nice(1)` man page, the higher the number, the lower the priority; the highest priority is -20, and the lower priority is 19.

Examples:

      # All data transfers get a low priority
      TransferPriority APPE,RETR,STOR low

Or maybe only downloads should have lower priorities, but uploads should be fine:

      TransferPriority RETR low

## TransferRate

Syntax: TransferRate cmd-list kbytes-per-sec[:free-bytes]
Default: None
Context: server config, `<VirtualHost>`, `<Global>`, `<Anonymous>`, `<Directory>`, .ftpaccess
Module: mod_xfer
Compatibility: 1.2.8rc1 and later

The `TransferRate` directive is used to set transfer rate limits on the transfer of data. This directive allows for transfer rates to be set in a wide variety of contexts, on a per-command basis, and for certain subsets of users (via `mod_ifsession`). Note that these limits only apply to an individual session, and do not apply to the overall transfer rate of the entire daemon.

The cmd-list parameter may be an comma-separated list of any of the following commands: `APPE`, `RETR`, `STOR`, and `STOU`.

The kbytes-per-sec parameter is the actual transfer rate to be applied.

The free-bytes parameter, if configured, allows that number of bytes to be transferred before the rate limit is applied. This allows for clients transferring small files to be unthrottled, but for larger files, such as MP3s and ISO images, to be throttled.

Here are some examples:

      # Limit downloads for everyone
      TransferRate RETR 1.5

      # Limit uploads (and appends!) to the prolific users in the
      # lotsofuploadfiles.net domain. This presumes that a Class has been defined
      # for that domain, and that that Class has been named "uploaders". Let them
      # upload small files without throttling, though.

      <IfClass uploaders>
        TransferRate APPE,STOR 8.0:1024
      </IfClass>

## UseSendfile

Syntax: UseSendfile on|off|len units|percentage
Default: None
Context: server config, `<VirtualHost>`, `<Global>`, `<Anonymous>`, `<Directory>`, .ftpaccess
Module: mod_xfer
Compatibility: 1.3.0rc1 and later

The `UseSendfile` directive controls use of `sendfile(2)` functionality, which is an optimization for sending files to clients. Use of `sendfile(2)` functionality avoids separate read and send kernel operations, and buffer allocations. Read this howto for more details.

## Installation

The `mod_xfer`module is always installed.

Author: $Author: castaglia $
Last Updated: $Date: 2013-03-13 18:08:28 $

© Copyright 2000-2013 The ProFTPD Project
All Rights Reserved