vsftpd.confのヘルプ・マニュアル
日本語 英語
vsftpd.conf --help
man vsftpd.conf
VSFTPD.CONF(5) VSFTPD.CONF(5)
名前
vfstpd.conf - vsftpd の設定ファイル
説明
vsftpd.conf は vsftpd の動作の様々な側面を制御するのに使用する。デフォ
ルトでは、vsftpd は /etc/vsftpd.conf という場所を探す。しか し 、vsftpd
の コマンドライン引数で上書きできる。コマンドライン引数は vsftpd の設定
ファイルのパスである。設定ファイルを指定できることで、 xinetd のよう な
高 等 な inetd に おいて、バーチャルホストごとに異なる設定ファイルで
vsftpdを起動したい場合には便利である。
書式
vsftpd.conf の書式はとても単純である。各行はコメントかディレクティブ(指
示 語)のどちらかである。 # で始まる行はコメントであり、無視される。ディ
レクティブ行は次のフォーマットである。
option=value
オプション(option)、=、値(value)の間に空白を入れるとエラーになるので 注
意すること。
各 設定はコンパイル時に指定されたデフォルト値を持つが、設定ファイルによ
って変更することが可能である。
真偽値オプション
以下は引数に真偽値をとるオプションのリストである。真偽値は YES ま た は
NO である。
anon_mkdir_write_enable
YES に設定した場合、anonymous(匿名)ユーザはある条件の下でディレ
クトリを新規に作成することが許可される。実際に機能さ せ る に は
write_enable オ プ シ ョンが有効になっていなければならず、また
anonymous ftp ユーザが親ディレクトリに対する書き込み権限を持って
いる必要がある。
デフォルト: NO
anon_other_write_enable
YES に設定した場合、anonymous ユーザにファイルのアップロードとデ
ィレクトリの作成以外の書き込み操作、すなわち削除と名前の変更を許
可する。一般的には推奨されないが、オプションの完全性のために含ま
れている。
デフォルト: NO
anon_upload_enable
YES に設定した場合、ある条件の下で anonymous ユーザにファイル の
アップロードを許可する。実際に機能させるには、 write_enable オプ
ションを有効にしなければならず、また anonymous ftp ユーザが親 デ
ィレクトリに対する書き込み権限を持っている必要がある。
デフォルト: NO
anon_world_readable_only
YES に設定した場合、 anonymous ユーザには誰でも読み込み可になっ
ているファイルのダウンロードのみを許可する。これは、ftp ユーザが
ファイルを所有できることを (特にアップロードされたファイルがある
場合に) 認めている。
デフォルト: YES
anonymous_enable
anonymous ログインを許可するかどうかを制御する。 YES にした場 合
、ユーザー名 ftp と anonymous の両方を anonoymous ログインとして
認識する。
デフォルト: YES
ascii_download_enable
YES に設定した場合、ダウンロード時の ASCII モードでのデータ転 送
を許可する。
デフォルト: NO
ascii_upload_enable
YES に設定した場合、アップロード時の ASCII モードでのデータ転送
を許可する。
デフォルト: NO
async_abor_enable
YES に設定した場合、特殊な FTP コマンド "非同期 ABOR" を許可する
。 この機能を使用するのは、分別のない FTP クライアントだけである
。さらに、この機能は取り扱いが難しいので、デフォルトで無効にされ
ている。この機能を有効にしなかった場合には、転送を中止したときに
不幸にも固まる FTP クライアントがあるので、これを有効にしたく な
るかもしれない。
デフォルト: NO
background
YES に設定し、vsftpd が "listen" モードで起動された場合、リスナ
ープロセスをバックグラウンドにする。すなわち、vsftpd を起動し た
シェルにすぐに制御が戻る。
デフォルト: NO
check_shell
注意! このオプションは PAM 対応ではない vsftpd でのみ意味を持つ
。 NO に設定した場合、ローカルユーザのログイン時の、シェルが有効
であるかどうかの /etc/shells チェックをしない。
デフォルト: YES
chmod_enable
YES に設定した場合、SITE CHMOD コマンドを許可する。注意! これは
ローカルユーザにのみ適用される。 anonymous ユーザは、決して SITE
CHMOD を使用できない。
デフォルト: YES
chown_uploads
YES に設定した場合、anonymous でアップロードされたファイルの所有
者を chown_username で設定したユーザにする。管理上、そして多分セ
キュリティの観点から便利である。
デフォルト: NO
chroot_list_enable
YES に設定した場合、ログイン後にホームディレクトリへと chroot()
されるローカルユーザのリストを指定できる。 chroot_local_user を
YES に 設 定した場合には、意味が異なってくる。リストはその場合
、chroot() jail へと移動されないユーザのリストとなる。デフォルト
で は 、 このリストは /etc/vsftpd.chroot_list ファイルであるが、
chroot_list_file 設定によってこれを変更することができる。
デフォルト: NO
chroot_local_user
YES に設定した場合、ローカルユーザは(デフォルトで)ログイン後にホ
ー ムディレクトリへと chroot() される。 警告: このオプションはセ
キュリティに密接に関連する。ユーザがアップロード権限を持っていた
り、シェルでのアクセスができる場合は特にである。何をしているかを
理解している場合にのみ有効にすること。これらのセキュリティの問題
は vsftpd に特有の問題ではないことに注意してほしい。ローカルユー
ザを chroot() jail に入れることができるすべての FTP デーモンにお
いて、この問題がある。
デフォルト: NO
connect_from_port_20
PORT で のデータ接続において、サーバが(送信元)ポートに 20(ftp-
data) を使うかどうか制御する。セキュリティ上の理由から、いくつか
のクライアントはポート 20 を要求する。逆に言えば、このオプション
を無効にすることで、わずかではあるが vsftpd をより少ない特権で動
作させることができる。
デフォルト: NO (ただし、サンプルの設定ファイルでは有効になってい
る)
deny_email_enable
YES に設定した場合、anonymous ユーザのパスワード(e-mail ア ド レ
ス) のうち、ログインを拒否したいもののリストを設定できる。デフォ
ルトでは、このリストは /etc/vsftpd.banned_emails ファイルであ る
が、 banned_email_file 設定によってこれを変更することができる。
デフォルト: NO
dirlist_enable
NO に設定した場合、すべてのディレクトリ表示コマンドは、アクセス
拒否 (permission denied) になる。
デフォルト: YES
dirmessage_enable
YES に設定した場合、FTP サーバ上のユーザが新たなディレクトリに初
めて入ったときに、メッセージを見せることができる。デフォルトでは
、ディレクトリの .message というファイルが調べられる が 、 mes-
sage_file 設定によってこれを変更することができる。
デフォルト: NO (ただし、サンプルの設定ファイルでは有効になってい
る)
download_enable
NO に設定した場合、すべてのダウンロード要求はアクセス拒否にな る
。
デフォルト: YES
dual_log_enable
YES に 設 定 し た 場 合 、 デ フ ォルトで /var/log/xferlog と
/var/log/vsftpd.log という二つのログファイルを同時に生成する。前
者 は wu-ftpd 形式の転送ログで、標準的なツールによって解析するこ
とができる。後者は vsftpd 独自形式のログである。
デフォルト: NO
force_dot_files
YES に設定した場合、クライアントが "a" フラグを使用していなく て
も 、ドット (.) で始まるファイルとディレクトリも、ディレクトリリ
ストに表示する。
デフォルト: NO
guest_enable
YES に設定した場合、anonymous でないログインすべてを "guest" に
ク ラス分けする。 guest ログインは、 guest_username 設定で指定し
たユーザにマッピングする。
デフォルト: NO
hide_ids
YES に設定した場合、ディレクトリリストでのユーザ・グループの情報
を "ftp" と表示する。
デフォルト: NO
listen YES に設定した場合、スタンドアロンモードで起動する。これは inetd
などのスーパーサーバから起動してはいけないということを意味する。
そ の 代 わりに、vsftpd プログラムを一度だけ直接実行すればよい。
vsftpd 自身が、入ってくる接続を待ち、処理する面倒をみる。
デフォルト: NO
listen_ipv6
IPv4 ソケットの代わりに IPv6 ソケットを待ち受ける点を除 け ば 、
listen オプションと同じである。このオプションと listen オプショ
ンは、どちらか一方しか指定することができない。
デフォルト: NO
local_enable
ローカルユーザのログインを許可するかどうかを制御する。 YES に 設
定した場合、/etc/passwd にある普通のユーザアカウントをログインに
使う。
デフォルト: NO
log_ftp_protocol
YES に設定した場合、FTP のすべての要求と応答を記 録 し 、 xfer-
log_std_format オプションを無効にする。デバッグに便利である。
デフォルト: NO
ls_recurse_enable
YES に設定した場合、"ls -R" の使用を許可するようになる。大きなサ
イトの一番上のレベルで ls -R を実行されると、多くの資源を消費 し
てしまうので、これはセキュリティ上のちょっとしたリスクである。
デフォルト: NO
no_anon_password
YES に設定した場合、anonymous のパスワードを尋ねるのを止める。す
なわち、anonymous ユーザーはパスワード無しでログインする。
デフォルト: NO
one_process_model
もし Linux 2.4 カーネルを使用しているならば、一つの接続に一つ の
プロセスを使用するという、異なったセキュリティモデルを使用するこ
とができる。これは純粋なセキュリティモデルから少し外れるが、性能
を得ることができる。自サイトで非常に多いユーザの同時接続をサポー
トし、自分が何をしているか知っている人だけが、このオプションを有
効にしたくなる。
デフォルト: NO
passwd_chroot_enable
chroot_local_user と共に YES に設定した場合、 chroot() jail の場
所はユーザごとになる。 jail は /etc/passwd にある各人のホーム デ
ィ レ クトリから得られる。ホームディレクトリを表わす文字列に /./
があれば、そのパスの場所が jail になる。
デフォルト: NO
pasv_enable
NO に設定した場合、データ接続の開始において PASV を許可しない。
デフォルト: YES
pasv_promiscuous
YES に設定した場合、 PASV セキュリティーチェックを無効にし、制御
用の接続と異なる IP アドレスからのデータ接続を許可する。何をして
いるかを理解している場合にのみ有効にすること。唯一の道理にかなっ
た利用法は、安全なトンネルの中で使うか、そうでなければ、おそらく
は FXP(訳注: リモートホスト間転送) を容易にするためのものであ る
。
デフォルト: NO
port_enable
NO に設定した場合、データ接続の開始において PORT を許可しない。
デフォルト: YES
port_promiscuous
YES に設定した場合、 PORT セキュリティーチェックを無効にし、制御
用の接続と異なる IP アドレスへのデータ接続を許可する。何をしてい
るかを理解している場合にのみ有効にすること。
デフォルト: NO
secure_email_list_enable
匿名ログインで許可する e-mail パスワードのリストを指定したい場合
にだけ YES に設定すること。仮想的なユーザーを必要とせずに、低 セ
キュリティなコンテンツへのアクセスを制限する、面倒の少ないやり方
として便利である。 YES に設定した場合には、 email_password_file
で指定されるファイルに書かれているパスワードが与えられない限り、
匿名ログインを許可しない。このファイルのフォーマットは 1 行に 1
パスワードで、余分な空白があってはいけない。デフォルトのファイル
名は /etc/vsftpd.email_passwords である。
デフォルト: NO
session_support
vsftpd がログインセッションを維持しようとするかどうかを制御す る
。 vsftpd がセッションを維持する場合、utmp と wtmp を更新しよう
と試みる。認証に PAM を使用している場合には、さらに pam_session
を open し、ログアウト時に close する。セッションのログ取得が必
要なく、vsftpd をより少ない処理で動作させ、かつ(または)より少 な
い権限で動作させたいならば、これを NO に設定することができる。注
- utmp と wtmp のサポートは PAM を有効にしてビルドした場合に限ら
れる。
デフォルト: YES
setproctitle_enable
有効にした場合、システムのプロセスリスト(例えば ps aux コマンド)
にセッションの状態に関する情報を表示する。つまり、表示されるプロ
セ ス名が vsftpd のセッションがどうなっているか (idle, download-
ing など)に応じて変化する。セキュリティ上、これを off のままにし
ておきたいと思うのが普通である。
デフォルト: NO
syslog_enable
YES に設定した場合、/var/log/vsftpd.log に行くはずだったすべての
ログ出力を、代わりにシステムログに出力する。 FTPD ファシリティで
ログ出力をする。
デフォルト: NO
tcp_wrappers
有効にした場合、 vsftpd を tcp_wrappers をサポートしてコンパイル
してあれば、外から来る接続は tcp_wrappers のアクセス制御が適用さ
れる。さらに IP ごとの設定のための仕組みがある。 tcp_wrappers で
環境 変 数 VSFTPD_LOAD_CONF を セ ッ ト し た 場 合 ( 訳 注:
/etc/hosts.allow で指定することが可能)、その環境変数で指定したフ
ァイルを vsftpd の設定ファイルとして読み込む。
デフォルト: NO
text_userdb_names
ディレクトリリストを表示した場合、デフォルトではユーザとグループ
の フィールドが ID の数値で表示される。このオプションを YES にす
れば、名前を示す文字列になる。性能上の理由から、デフォルトは NO
である。
デフォルト: NO
use_localtime
有効にした場合、ディレクトリリストの表示にローカルのタイムゾーン
を使用する。デフォルトは GMT での表示である。 FTP の MDTM コマン
ドが返す時刻もこのオプションの影響を受ける。
デフォルト: NO
use_sendfile
使用しているプラットフォーム上で sendfile() システムコールを使う
場合の相対的効果を確認するための、内部的な設定。
デフォルト: YES
userlist_deny
このオプションは userlist_enable が有効な場合にのみ意味を持つ 。
NO にした場合、 userlist_file で指定したファイルに明示的にリスト
されたユーザ以外はログインが拒否される。ログインを拒否する場合、
ユーザにパスワードを尋ねる前に拒否をする。
デフォルト: YES
userlist_enable
有 効にした場合、 userlist_file で指定したファイルをユーザ名のリ
ストとして読み込む。このファイルに名前のあるユーザでのログインし
ようとすると、パスワードを尋ねられる前に拒否される。これは暗号化
されていないパスワードが(ネットワーク上を) 転送されてしまうの を
防ぐのに効果的である。 userlist_deny も参照のこと。
デフォルト: NO
virtual_use_local_privs
YES に設定した場合、仮想ユーザにローカルユーザと同じ権限を使用す
る。デフォルトでは、仮想ユーザは anonymous ユーザと同じ権限を 持
ち、それは(特に書き込み権限に関して)より制限されたものになりがち
である。
デフォルト: NO
write_enable
ファイルシステムを変更するようなすべての FTP コマンドを許可す る
かどうかを制御する。対象となるコマンドは STOR, DELE, RNFR, RNTO,
MKD, RMD, APPE, SITE である。
デフォルト: NO
xferlog_enable
有効にした場合、ログファイルにはアップロードとダウンロードの詳細
が記録される。デフォルトでは、ログファイルは /var/log/vsftpd.log
として置かれるが、 vsftpd_log_file の設定によって変更すること が
可能である。
デフォルト: NO (ただし、サンプルの設定ファイルでは有効になってい
る)
xferlog_std_format
有効にした場合、wu-ftpd で使われているような標準的な xferlog フ
ォーマットで転送ログファイルを作成する。既存の統計情報を生成する
プログラムを再利用できるので、これは便利である。しかしデフォルト
の書式は、より読み易いものである。この形式のログファイルのデフォ
ルトの場所は /var/log/xferlog であるが、 xferlog_file の設定によ
って、これを変更することが可能である。
デフォルト: NO
数値オプション
以 下は引数に数値をとるオプションである。数値は非負整数でなければならな
い。 8 進数は umask オプションで便利なのでサポートされている。 8 進数で
指定するには、先頭の数字を 0 にする。
accept_timeout
リモートのクライアントが PASV でデータ接続を確立するまでのタイム
アウト秒数。
デフォルト: 60
anon_max_rate
anonymous (匿名) クライアントの最大データ転送レート。秒あたり の
バイト数。
デフォルト: 0 (無制限)
anon_umask
anonymous ( 匿名) ユーザが生成したファイルの umask 値。注意! 8
進数で指定したければ、先頭の "0" を忘れないように。そうしない と
、指定した値は 10 進数の値として扱われてしまう。
デフォルト: 077
connect_timeout
PORT でのデータ接続において、リモートクライアントが応答するまで
のタイムアウト秒数。
デフォルト: 60
data_connection_timeout
データ転送に何ら進捗がない場合に、タイムアウトと見なすまでの秒数
。タイムアウトが発生した場合、リモートクライアントは蹴り出される
。
デフォルト: 300
file_open_mode
ファイルがアップロードで作成された場合のファイル・パーミッション
。 この値の上に umask がさらに適用される。実行可能なファイルのア
ップロードを許可したければ 0777 に変更すればよい。
デフォルト: 0666
ftp_data_port
PORT での接続の場合の、送信元のポート (かっこう悪い名前 の con-
nect_from_port_20 が有効である場合のみ)。
デフォルト: 20
idle_session_timeout
制御接続において、FTP コマンドが何もない場合にタイムアウトと見な
すまでの秒数。タイムアウトが発生した場合、リモートクライアントは
蹴り出される。
デフォルト: 300
listen_port
スタンドアロンモードの場合の、 FTP 接続を待ち受けるポート番号。
デフォルト: 21
local_max_rate
ローカルユーザの最大データ転送レート。秒あたりのバイト数。
デフォルト: 0 (無制限)
local_umask
ローカルユーザが生成したファイルの umask 値。注意! 8 進数で指定
したければ、先頭の "0" を忘れないように。そうしないと、指定し た
値は 10 進数の値として扱われてしまう。
デフォルト: 077
max_clients
スタンドアロンモードの場合に、接続可能なクライアントの最大数を指
定する。最大数を越えて接続したクライアントには、エラーメッセージ
を渡す。
デフォルト: 0 (無制限)
max_per_ip
スタンドアロンモードの場合に、同じ送信元 IP アドレスからの接続の
最大数を指定する。この制限を越えて接続したクライアントには、エラ
ーメッセージを渡す。
デフォルト: 0 (無制限)
pasv_max_port
PASV でのデータ接続に割り当てるポートの最大値。ファイアウォール
で指定するポートの範囲を狭めるのに使用できる。
デフォルト: 0 (任意のポートを使用)
pasv_min_port
PASV でのデータ接続に割り当てるポートの最小値。ファイアウォー ル
で指定するポートの範囲を狭めるのに使用できる。
デフォルト: 0 (任意のポートを使用)
trans_chunk_size
これを変更したいとは思わないだろうが、しかし、より滑らかな帯域制
御をしたければ、これを 8192 のような値に設定してみること。
デフォルト: 0 (vsftpd がふさわしい値を選ぶ)
文字列オプション
以下は引数に文字列をとるオプションである。
anon_root
このオプションは、anonymous (匿名) ログイン後に変更するディレ ク
トリ名を表す。ディレクトリ変更の失敗は、静かに無視する。
デフォルト: (なし)
banned_email_file
anonymous ユーザのパスワード (e-mail アドレス) のうち、許可しな
いもののリストの フ ァ イ ル 名 を 指 定 す る 。 オ プ シ ョ ン
deny_email_enable が有効の場合にのみ、このファイルは参照される。
デフォルト: /etc/vsftpd.banned_emails
banner_file
誰かがサーバに接続したときに表示するテキストを格納するファイル名
を 指定する。このオプションが設定された場合、 ftpd_banner で指定
される文字列よりも優先される。
デフォルト: (なし)
chown_username
anonymous (匿名) でアップロードされたファイルの所有者となるユ ー
ザのユーザ名を指定する。このオプションは、関連するもう一つのオプ
ション chown_uploads が有効な場合にのみ意味を持つ。
デフォルト: root
chroot_list_file
ホームディレクトリ内の choot() jail に入れられるローカルユーザの
リ ス ト を 示 す フ ァ イ ル 名 を 指定する。このオプションは、
chroot_list_enable が有効な場合 に の み 意 味 を 持 つ 。 も し
chroot_local_user が有効であれば、このリストは chroot() jail に
入れられ*ない* ユーザのリストになる。
デフォルト: /etc/vsftpd.chroot_list
cmds_allowed
(ログイン後に)許可する FTP コマンドのリストを、コンマで区切っ て
指定する (USER, PASS, QUIT は、ログイン前なら常に許可する)。指定
しなかったコマンドは拒否する。本当に FTP サーバを閉じ込めるの に
強力な手段となる。例: cmds_allowed=PASV,RETR,QUIT
デフォルト: (なし)
deny_file
すべての手段でアクセスを許可しない、ファイル名(やディレクトリ名)
のパターンを指定する。この影響をうけるファイル/ディレクトリを 隠
しはしないが、それらに対するあらゆる試み (ダウンロード、そのディ
レクトリへの変更、ディレクトリ内で何か影響するものなど) を拒否す
る。このオプションはとても単純なので、本格的なアクセス制御に用い
るべきではない。そのような場合には、まず先にファイルシステムのア
クセス制御を用いること。しかしながら、ある種の仮想ユーザの設定に
は便利である。
deny_file で指定した文字列を含むか、deny_file で指定した正規表現
にマッチする名前を持つものへのアクセスが拒否される。 vsftpd の正
規表現のコードは単純な実装で、完全な正規表現の部分集合になってい
るので、注意すること。よって、このオプションの使用するときは、注
意深く、徹底的にテストする必要がある。また、あらゆる重要なセキュ
リティティーポリシーに対し、ファイルシステムのパーミッションを使
用することを 、 そ の 偉 大 な 信 頼 性 か ら 推 奨 す る 。 例:
deny_file={*.mp3,*.mov,.private}
デフォルト: (なし)
email_password_file
secure_email_list_enable を設定したときの代替ファイルを設定する
。
デフォルト: /etc/vsftpd.email_passwords
ftp_username
anonymous FTP を取り扱うときに使用するユーザのユーザ名を指定する
。 指定したユーザのホームディレクトリが anonymous FTP のルートと
して使用される。
デフォルト: ftp
ftpd_banner
接続が最初に来たときに vsftpd が表示する挨拶メッセージを指定する
。
デフォルト: (なし。vsftpd のデフォルトのバナーが表示される)
guest_username
guest ログインの説明については、真偽値設定の guest_enable を参照
して欲しい。このオプションでは、guest ユーザが実際に割り当てられ
るユーザ名を指定する。
デフォルト: ftp
hide_file
デ ィレクトリリストから隠すべきファイル名(やディレクトリ名) のパ
ターンを指定する。ファイル / ディレクトリは隠されているが、フ ァ
イ ル 名を知っているクライアントからは自由にアクセス可能である。
hide_file で指定した文字列を含むか、hide_file で指定した正規表現
にマッチする名前を持つものが隠される。 vsftpd の正規表現のコード
は単純な実装で、完全な正規表現の部分集合になっているので、注意す
ること。例: hide_file={*.mp3,.hidden,hide*,h?}
デフォルト: (なし)
listen_address
ス タンドアロンモードの場合に、listen するアドレスを指定する。デ
フォルトは、すべてのローカルインタフェースである。 IP アド レ ス
を(数値で)指定すること。
デフォルト: (なし)
listen_address6
listen_address と同様だが、(listen_ipv6 が指定された場合に使用さ
れる) IPv6 での接続を待つアドレスを指定する。フォーマットは、 標
準的な IPv6 アドレスである。
デフォルト: (なし)
local_root
ロ ーカルログイン(すなわち、非 anonymous ログイン)の後に変更する
ディレクトリを指定する。ディレクトリ変更の失敗は、静かに無視する
。
デフォルト: (なし)
message_file
ユーザが新たなディレクトリに入った場合に探すファイルの名前を指定
する。中身がリモートのユーザに表示される。この オ プ シ ョ ン は
dirmessage_enable オプションが有効の場合にのみ意味を持つ。
デフォルト: .message
nopriv_user
特権を必要としなくなった場合に vsftpd が使用するユーザのユーザ名
を指定する。注意: nobody を使うのではなく、専用のユーザを使用 す
べきである。多くのマシンでは、どちらかと言えば、むしろ多くの重要
な事に
nobody ユーザが使われる。
デフォルト: nobody
pam_service_name
vsftpd が使用する PAM サービス名を指定する。
デフォルト: ftp
pasv_address
PASV コマンドへの応答において、vsftpd が伝える IP アドレスを指定
する。 IP アドレスを(数値で)指定すること。
デフォルト: (なし。接続されたソケットからアドレスが決められる)
secure_chroot_dir
このオプションは空のディレクトリの名前にすべきである。また、その
ディレクトリは ftp ユーザが書き込めてはいけない。ここで指定す る
ディレクトリは、ファイルシステムへのアクセスが必要ないときに使用
する、安全な chroot() jail に使われる。
デフォルト: /usr/share/empty
user_config_dir
この強力なオプションによって、マニュアルページにあるいかなる設定
オプションもユーザーごとに上書きすることができる。使い方は簡単で
、以下の例で示す。 user_config_dir を /etc/vsftpd_userr_conf に
設 定 し 、ユーザ "chris" がログインした場合、そのセッションの間
/etc/vsftpd_user_conf/chris というファイルにある設定が適用される
。このファイルの書式は、このマニュアルページにかかれているものと
同じである。ただし、すべての設定がユーザーごとに効果があるわけで
はないことに注意してほしい。例えば、多くの設定はユーザーのセッシ
ョンが開始される前に使用される。設定例の中で、ユーザーごとの動作
に 影響しないものには、 listen_address, banner_file, max_per_ip,
max_clients, xferlog_file などが含まれる。
デフォルト: (なし)
user_sub_token
このオプションは、仮想ユーザーと組み合わせるときに便利である。テ
ンプレートを元に、各仮想ユーザーのホームディレクトリを自動的に生
成するのに使用する。例えば、 guest_username によって実ユーザーの
ホ ー ム デ ィ レクトリが /home/virtual/$USER に設定されていて、
user_sub_token が $USER に設定されていれば、仮想ユーザー fred が
ロ グ イ ン すると、最終的に (通常は chroot() されて) /home/vir-
tual/fred ディレクトリに移動される 。 こ の オ プ シ ョ ン は 、
local_root が user_sub_token を含んでいる場合にも効果がある。
デフォルト: (なし)
userlist_file
userlist_enable オプションが有効な場合に読み込まれるファイルのフ
ァイル名を指定する。
デフォルト: /etc/vsftpd.user_list
vsftpd_log_file
vsftpd スタイルの転送ログを記録するファイルのファイル名を指定 す
る。 xferlog_enable が設定されていて、かつ xferlog_std_format が
設定されていない場合にのみ、このログは記録され る 。 も し く は
dual_log_enable オプションを設定すれば記録される。もう一つさらに
複雑なこととして、 syslog_enable を設定した場合にはファイルに は
出力されず、出力はシステムログへと送られる。
デフォルト: /var/log/vsftpd.log
xferlog_file
wu-ftpd スタイルの転送ログを記録するファイルのファイル名を指定す
る。転送ログは xferlog_enable と xferlog_std_format が設定されて
い る場合にのみ記録される。もしくは dual_log_enable オプションを
設定すれば記録される。
デフォルト: /var/log/xfer.log
著者
chris@scary.beasts.org
VSFTPD.CONF(5)
VSFTPD.CONF(5) VSFTPD.CONF(5)
NAME
vsftpd.conf - config file for vsftpd
DESCRIPTION
vsftpd.conf may be used to control various aspects of vsftpd’s
behaviour. By default, vsftpd looks for this file at the location
/etc/vsftpd/vsftpd.conf. However, you may override this by specifying
a command line argument to vsftpd. The command line argument is the
pathname of the configuration file for vsftpd. This behaviour is useful
because you may wish to use an advanced inetd such as xinetd to launch
vsftpd with different configuration files on a per virtual host basis.
FORMAT
The format of vsftpd.conf is very simple. Each line is either a comment
or a directive. Comment lines start with a # and are ignored. A direc-
tive line has the format:
option=value
It is important to note that it is an error to put any space between
the option, = and value.
Each setting has a compiled in default which may be modified in the
configuration file.
BOOLEAN OPTIONS
Below is a list of boolean options. The value for a boolean option may
be set to YES or NO.
allow_anon_ssl
Only applies if ssl_enable is active. If set to YES, anonymous
users will be allowed to use secured SSL connections.
Default: NO
anon_mkdir_write_enable
If set to YES, anonymous users will be permitted to create new
directories under certain conditions. For this to work, the
option write_enable must be activated, and the anonymous ftp
user must have write permission on the parent directory.
Default: NO
anon_other_write_enable
If set to YES, anonymous users will be permitted to perform
write operations other than upload and create directory, such as
deletion and renaming. This is generally not recommended but
included for completeness.
Default: NO
anon_upload_enable
If set to YES, anonymous users will be permitted to upload files
under certain conditions. For this to work, the option
write_enable must be activated, and the anonymous ftp user must
have write permission on desired upload locations. This setting
is also required for virtual users to upload; by default, vir-
tual users are treated with anonymous (i.e. maximally
restricted) privilege.
Default: NO
anon_world_readable_only
When enabled, anonymous users will only be allowed to download
files which are world readable. This is recognising that the ftp
user may own files, especially in the presence of uploads.
Default: YES
anonymous_enable
Controls whether anonymous logins are permitted or not. If
enabled, both the usernames ftp and anonymous are recognised as
anonymous logins.
Default: YES
ascii_download_enable
When enabled, ASCII mode data transfers will be honoured on
downloads. When disabled, the server will pretend to allow
ASCII mode but in fact ignore requests to activate it. So the
client will think the ASCII mode is active and therefore may
still translate any character sequences in the received
file. See the following article for a detailed explanation of
the behaviour: https://access.redhat.com/articles/3250241.
Turn this option on to have the server actually do ASCII man-
gling on files when in ASCII mode.
Default: NO
ascii_upload_enable
When enabled, ASCII mode data transfers will be honoured on
uploads. When disabled, the server will pretend to allow ASCII
mode but in fact ignore requests to activate it. So the client
will think the ASCII mode is active and will translate native
line terminators to the standard line terminators for
transmission, but the server will not do any translation. See
the following article for a detailed explanation of the
behaviour: https://access.redhat.com/articles/3250241.
Turn this option on to have the server actually do ASCII man-
gling on files when in ASCII mode.
Default: NO
async_abor_enable
When enabled, a special FTP command known as "async ABOR" will
be enabled. Only ill advised FTP clients will use this feature.
Additionally, this feature is awkward to handle, so it is dis-
abled by default. Unfortunately, some FTP clients will hang when
cancelling a transfer unless this feature is available, so you
may wish to enable it.
Default: NO
background
When enabled, and vsftpd is started in "listen" mode, vsftpd
will background the listener process. i.e. control will immedi-
ately be returned to the shell which launched vsftpd.
Default: YES
check_shell
Note! This option only has an effect for non-PAM builds of
vsftpd. If disabled, vsftpd will not check /etc/shells for a
valid user shell for local logins.
Default: YES
chmod_enable
When enabled, allows use of the SITE CHMOD command. NOTE! This
only applies to local users. Anonymous users never get to use
SITE CHMOD.
Default: YES
chown_uploads
If enabled, all anonymously uploaded files will have the owner-
ship changed to the user specified in the setting chown_user-
name. This is useful from an administrative, and perhaps secu-
rity, standpoint.
Default: NO
chroot_list_enable
If activated, you may provide a list of local users who are
placed in a chroot() jail in their home directory upon login.
The meaning is slightly different if chroot_local_user is set to
YES. In this case, the list becomes a list of users which are
NOT to be placed in a chroot() jail. By default, the file con-
taining this list is /etc/vsftpd/chroot_list, but you may over-
ride this with the chroot_list_file setting.
Default: NO
chroot_local_user
If set to YES, local users will be (by default) placed in a
chroot() jail in their home directory after login. Warning:
This option has security implications, especially if the users
have upload permission, or shell access. Only enable if you know
what you are doing. Note that these security implications are
not vsftpd specific. They apply to all FTP daemons which offer
to put local users in chroot() jails.
Default: NO
connect_from_port_20
This controls whether PORT style data connections use port 20
(ftp-data) on the server machine. For security reasons, some
clients may insist that this is the case. Conversely, disabling
this option enables vsftpd to run with slightly less privilege.
Default: NO (but the sample config file enables it)
debug_ssl
If true, OpenSSL connection diagnostics are dumped to the vsftpd
log file. (Added in v2.0.6).
Default: NO
delete_failed_uploads
If true, any failed upload files are deleted. (Added in
v2.0.7).
Default: NO
deny_email_enable
If activated, you may provide a list of anonymous password e-
mail responses which cause login to be denied. By default, the
file containing this list is /etc/vsftpd/banned_emails, but you
may override this with the banned_email_file setting.
Default: NO
dirlist_enable
If set to NO, all directory list commands will give permission
denied.
Default: YES
dirmessage_enable
If enabled, users of the FTP server can be shown messages when
they first enter a new directory. By default, a directory is
scanned for the file .message, but that may be overridden with
the configuration setting message_file.
Default: NO (but the sample config file enables it)
download_enable
If set to NO, all download requests will give permission denied.
Default: YES
dual_log_enable
If enabled, two log files are generated in parallel, going by
default to /var/log/xferlog and /var/log/vsftpd.log. The former
is a wu-ftpd style transfer log, parseable by standard tools.
The latter is vsftpd’s own style log.
Default: NO
force_dot_files
If activated, files and directories starting with . will be
shown in directory listings even if the "a" flag was not used by
the client. This override excludes the "." and ".." entries.
Default: NO
force_anon_data_ssl
Only applies if ssl_enable is activated. If activated, all
anonymous logins are forced to use a secure SSL connection in
order to send and receive data on data connections.
Default: NO
force_anon_logins_ssl
Only applies if ssl_enable is activated. If activated, all
anonymous logins are forced to use a secure SSL connection in
order to send the password.
Default: NO
force_local_data_ssl
Only applies if ssl_enable is activated. If activated, all non-
anonymous logins are forced to use a secure SSL connection in
order to send and receive data on data connections.
Default: YES
force_local_logins_ssl
Only applies if ssl_enable is activated. If activated, all non-
anonymous logins are forced to use a secure SSL connection in
order to send the password.
Default: YES
guest_enable
If enabled, all non-anonymous logins are classed as "guest"
logins. A guest login is remapped to the user specified in the
guest_username setting.
Default: NO
hide_ids
If enabled, all user and group information in directory listings
will be displayed as "ftp".
Default: NO
implicit_ssl
If enabled, an SSL handshake is the first thing expect on all
connections (the FTPS protocol). To support explicit SSL and/or
plain text too, a separate vsftpd listener process should be
run.
Default: NO
listen If enabled, vsftpd will run in standalone mode. This means that
vsftpd must not be run from an inetd of some kind. Instead, the
vsftpd executable is run once directly. vsftpd itself will then
take care of listening for and handling incoming connections.
Default: NO
listen_ipv6
Like the listen parameter, except vsftpd will listen on an IPv6
socket instead of an IPv4 one. This parameter and the listen
parameter are mutually exclusive.
Default: NO
local_enable
Controls whether local logins are permitted or not. If enabled,
normal user accounts in /etc/passwd (or wherever your PAM config
references) may be used to log in. This must be enable for any
non-anonymous login to work, including virtual users.
Default: NO
lock_upload_files
When enabled, all uploads proceed with a write lock on the
upload file. All downloads proceed with a shared read lock on
the download file. WARNING! Before enabling this, be aware that
malicious readers could starve a writer wanting to e.g. append a
file.
Default: YES
log_ftp_protocol
When enabled, all FTP requests and responses are logged, provid-
ing the option xferlog_std_format is not enabled. Useful for
debugging.
Default: NO
ls_recurse_enable
When enabled, this setting will allow the use of "ls -R". This
is a minor security risk, because a ls -R at the top level of a
large site may consume a lot of resources.
Default: NO
mdtm_write
When enabled, this setting will allow MDTM to set file modifica-
tion times (subject to the usual access checks).
Default: YES
no_anon_password
When enabled, this prevents vsftpd from asking for an anonymous
password - the anonymous user will log straight in.
Default: NO
no_log_lock
When enabled, this prevents vsftpd from taking a file lock when
writing to log files. This option should generally not be
enabled. It exists to workaround operating system bugs such as
the Solaris / Veritas filesystem combination which has been
observed to sometimes exhibit hangs trying to lock log files.
Default: NO
one_process_model
If you have a Linux 2.4 kernel, it is possible to use a differ-
ent security model which only uses one process per connection.
It is a less pure security model, but gains you performance. You
really don’t want to enable this unless you know what you are
doing, and your site supports huge numbers of simultaneously
connected users.
Default: NO
passwd_chroot_enable
If enabled, along with chroot_local_user , then a chroot() jail
location may be specified on a per-user basis. Each user’s jail
is derived from their home directory string in /etc/passwd. The
occurrence of /./ in the home directory string denotes that the
jail is at that particular location in the path.
Default: NO
pasv_addr_resolve
Set to YES if you want to use a hostname (as opposed to IP
address) in the pasv_address option.
Default: NO
pasv_enable
Set to NO if you want to disallow the PASV method of obtaining a
data connection.
Default: YES
pasv_promiscuous
Set to YES if you want to disable the PASV security check that
ensures the data connection originates from the same IP address
as the control connection. Only enable if you know what you are
doing! The only legitimate use for this is in some form of
secure tunnelling scheme, or perhaps to facilitate FXP support.
Default: NO
port_enable
Set to NO if you want to disallow the PORT method of obtaining a
data connection.
Default: YES
port_promiscuous
Set to YES if you want to disable the PORT security check that
ensures that outgoing data connections can only connect to the
client. Only enable if you know what you are doing!
Default: NO
require_cert
If set to yes, all SSL client connections are required to
present a client certificate. The degree of validation applied
to this certificate is controlled by validate_cert (Added in
v2.0.6).
Default: NO
require_ssl_reuse
If set to yes, all SSL data connections are required to exhibit
SSL session reuse (which proves that they know the same master
secret as the control channel). Although this is a secure
default, it may break many FTP clients, so you may want to dis-
able it. For a discussion of the consequences, see http://scary-
beastsecurity.blogspot.com/2009/02/vsftpd-210-released.html
(Added in v2.1.0).
Default: YES
reverse_lookup_enable
Set to YES if you want vsftpd to transform the ip address into
the hostname, before pam authentication. This is useful if you
use pam_access including the hostname. If you want vsftpd to run
on the environment where the reverse lookup for some hostname is
available and the name server doesn’t respond for a while, you
should set this to NO to avoid a performance issue.
Default: YES
run_as_launching_user
Set to YES if you want vsftpd to run as the user which launched
vsftpd. This is useful where root access is not available. MAS-
SIVE WARNING! Do NOT enable this option unless you totally know
what you are doing, as naive use of this option can create mas-
sive security problems. Specifically, vsftpd does not / cannot
use chroot technology to restrict file access when this option
is set (even if launched by root). A poor substitute could be to
use a deny_file setting such as {/*,*..*}, but the reliability
of this cannot compare to chroot, and should not be relied on.
If using this option, many restrictions on other options apply.
For example, options requiring privilege such as non-anonymous
logins, upload ownership changing, connecting from port 20 and
listen ports less than 1024 are not expected to work. Other
options may be impacted.
Default: NO
secure_email_list_enable
Set to YES if you want only a specified list of e-mail passwords
for anonymous logins to be accepted. This is useful as a low-
hassle way of restricting access to low-security content without
needing virtual users. When enabled, anonymous logins are pre-
vented unless the password provided is listed in the file speci-
fied by the email_password_file setting. The file format is one
password per line, no extra whitespace. The default filename is
/etc/vsftpd/email_passwords.
Default: NO
session_support
This controls whether vsftpd attempts to maintain sessions for
logins. If vsftpd is maintaining sessions, it will try and
update utmp and wtmp. It will also open a pam_session if using
PAM to authenticate, and only close this upon logout. You may
wish to disable this if you do not need session logging, and you
wish to give vsftpd more opportunity to run with less processes
and / or less privilege. NOTE - utmp and wtmp support is only
provided with PAM enabled builds.
Default: NO
setproctitle_enable
If enabled, vsftpd will try and show session status information
in the system process listing. In other words, the reported name
of the process will change to reflect what a vsftpd session is
doing (idle, downloading etc). You probably want to leave this
off for security purposes.
Default: NO
ssl_enable
If enabled, and vsftpd was compiled against OpenSSL, vsftpd will
support secure connections via SSL. This applies to the control
connection (including login) and also data connections. You’ll
need a client with SSL support too. NOTE!! Beware enabling this
option. Only enable it if you need it. vsftpd can make no guar-
antees about the security of the OpenSSL libraries. By enabling
this option, you are declaring that you trust the security of
your installed OpenSSL library.
Default: NO
ssl_request_cert
If enabled, vsftpd will request (but not necessarily require;
see require_cert) a certificate on incoming SSL connections.
Normally this should not cause any trouble at all, but IBM zOS
seems to have issues. (New in v2.0.7).
Default: YES
ssl_sslv2
Only applies if ssl_enable is activated. If enabled, this option
will permit SSL v2 protocol connections. TLS v1.2 connections
are preferred.
Default: NO
ssl_sslv3
Only applies if ssl_enable is activated. If enabled, this option
will permit SSL v3 protocol connections. TLS v1.2 connections
are preferred.
Default: NO
ssl_tlsv1
Only applies if ssl_enable is activated. If enabled, this option
will permit TLS v1 protocol connections. TLS v1.2 connections
are preferred.
Default: YES
ssl_tlsv1_1
Only applies if ssl_enable is activated. If enabled, this option
will permit TLS v1.1 protocol connections. TLS v1.2 connections
are preferred.
Default: YES
ssl_tlsv1_2
Only applies if ssl_enable is activated. If enabled, this option
will permit TLS v1.2 protocol connections. TLS v1.2 connections
are preferred.
Default: YES
strict_ssl_read_eof
If enabled, SSL data uploads are required to terminate via SSL,
not an EOF on the socket. This option is required to be sure
that an attacker did not terminate an upload prematurely with a
faked TCP FIN. Unfortunately, it is not enabled by default
because so few clients get it right. (New in v2.0.7).
Default: NO
strict_ssl_write_shutdown
If enabled, SSL data downloads are required to terminate via
SSL, not an EOF on the socket. This is off by default as I was
unable to find a single FTP client that does this. It is minor.
All it affects is our ability to tell whether the client con-
firmed full receipt of the file. Even without this option, the
client is able to check the integrity of the download. (New in
v2.0.7).
Default: NO
syslog_enable
If enabled, then any log output which would have gone to
/var/log/vsftpd.log goes to the system log instead. Logging is
done under the FTPD facility.
Default: NO
tcp_wrappers
If enabled, and vsftpd was compiled with tcp_wrappers support,
incoming connections will be fed through tcp_wrappers access
control. Furthermore, there is a mechanism for per-IP based con-
figuration. If tcp_wrappers sets the VSFTPD_LOAD_CONF environ-
ment variable, then the vsftpd session will try and load the
vsftpd configuration file specified in this variable.
Default: NO
text_userdb_names
By default, numeric IDs are shown in the user and group fields
of directory listings. You can get textual names by enabling
this parameter. It is off by default for performance reasons.
Default: NO
tilde_user_enable
If enabled, vsftpd will try and resolve pathnames such as
~chris/pics, i.e. a tilde followed by a username. Note that
vsftpd will always resolve the pathnames ~ and ~/something (in
this case the ~ resolves to the initial login directory). Note
that ~user paths will only resolve if the file /etc/passwd may
be found within the _current_ chroot() jail.
Default: NO
use_localtime
If enabled, vsftpd will display directory listings with the time
in your local time zone. The default is to display GMT. The
times returned by the MDTM FTP command are also affected by this
option.
Default: NO
use_sendfile
An internal setting used for testing the relative benefit of
using the sendfile() system call on your platform.
Default: YES
userlist_deny
This option is examined if userlist_enable is activated. If you
set this setting to NO, then users will be denied login unless
they are explicitly listed in the file specified by
userlist_file. When login is denied, the denial is issued
before the user is asked for a password.
Default: YES
userlist_enable
If enabled, vsftpd will load a list of usernames, from the file-
name given by userlist_file. If a user tries to log in using a
name in this file, they will be denied before they are asked for
a password. This may be useful in preventing cleartext passwords
being transmitted. See also userlist_deny.
Default: NO
validate_cert
If set to yes, all SSL client certificates received must vali-
date OK. Self-signed certs do not constitute OK validation.
(New in v2.0.6).
Default: NO
userlist_log
This option is examined if userlist_enable is activated. If
enabled, every login denial based on the user list will be
logged.
Default: NO
virtual_use_local_privs
If enabled, virtual users will use the same privileges as local
users. By default, virtual users will use the same privileges as
anonymous users, which tends to be more restrictive (especially
in terms of write access).
Default: NO
write_enable
This controls whether any FTP commands which change the filesys-
tem are allowed or not. These commands are: STOR, DELE, RNFR,
RNTO, MKD, RMD, APPE and SITE.
Default: NO
xferlog_enable
If enabled, a log file will be maintained detailling uploads and
downloads. By default, this file will be placed at
/var/log/vsftpd.log, but this location may be overridden using
the configuration setting vsftpd_log_file.
Default: NO (but the sample config file enables it)
xferlog_std_format
If enabled, the transfer log file will be written in standard
xferlog format, as used by wu-ftpd. This is useful because you
can reuse existing transfer statistics generators. The default
format is more readable, however. The default location for this
style of log file is /var/log/xferlog, but you may change it
with the setting xferlog_file.
Default: NO
isolate_network
If enabled, use CLONE_NEWNET to isolate the untrusted processes
so that they can’t do arbitrary connect() and instead have to
ask the privileged process for sockets ( port_promiscuous have
to be disabled).
Default: YES
isolate
If enabled, use CLONE_NEWPID and CLONE_NEWIPC to isolate pro-
cesses to their ipc and pid namespaces. So separated processes
can not interact with each other.
Default: YES
NUMERIC OPTIONS
Below is a list of numeric options. A numeric option must be set to a
non negative integer. Octal numbers are supported, for convenience of
the umask options. To specify an octal number, use 0 as the first digit
of the number.
accept_timeout
The timeout, in seconds, for a remote client to establish con-
nection with a PASV style data connection.
Default: 60
anon_max_rate
The maximum data transfer rate permitted, in bytes per second,
for anonymous clients.
Default: 0 (unlimited)
anon_umask
The value that the umask for file creation is set to for anony-
mous users. NOTE! If you want to specify octal values, remember
the "0" prefix otherwise the value will be treated as a base 10
integer!
Default: 077
chown_upload_mode
The file mode to force for chown()ed anonymous uploads. (Added
in v2.0.6).
Default: 0600
connect_timeout
The timeout, in seconds, for a remote client to respond to our
PORT style data connection.
Default: 60
data_connection_timeout
The timeout, in seconds, which is roughly the maximum time we
permit data transfers to stall for with no progress. If the
timeout triggers, the remote client is kicked off.
Default: 300
delay_failed_login
The number of seconds to pause prior to reporting a failed
login.
Default: 1
delay_successful_login
The number of seconds to pause prior to allowing a successful
login.
Default: 0
file_open_mode
The permissions with which uploaded files are created. Umasks
are applied on top of this value. You may wish to change to 0777
if you want uploaded files to be executable.
Default: 0666
ftp_data_port
The port from which PORT style connections originate (as long as
the poorly named connect_from_port_20 is enabled).
Default: 20
idle_session_timeout
The timeout, in seconds, which is the maximum time a remote
client may spend between FTP commands. If the timeout triggers,
the remote client is kicked off.
Default: 300
listen_port
If vsftpd is in standalone mode, this is the port it will listen
on for incoming FTP connections.
Default: 21
local_max_rate
The maximum data transfer rate permitted, in bytes per second,
for local authenticated users.
Default: 0 (unlimited)
local_umask
The value that the umask for file creation is set to for local
users. NOTE! If you want to specify octal values, remember the
"0" prefix otherwise the value will be treated as a base 10
integer!
Default: 077
max_clients
If vsftpd is in standalone mode, this is the maximum number of
clients which may be connected. Any additional clients connect-
ing will get an error message. The value 0 switches off the
limit.
Default: 2000
max_login_fails
After this many login failures, the session is killed.
Default: 3
max_per_ip
If vsftpd is in standalone mode, this is the maximum number of
clients which may be connected from the same source internet
address. A client will get an error message if they go over this
limit. The value 0 switches off the limit.
Default: 50
pasv_max_port
The maximum port to allocate for PASV style data connections.
Can be used to specify a narrow port range to assist fire-
walling.
Default: 0 (use any port)
pasv_min_port
The minimum port to allocate for PASV style data connections.
Can be used to specify a narrow port range to assist fire-
walling.
Default: 0 (use any port)
trans_chunk_size
You probably don’t want to change this, but try setting it to
something like 8192 for a much smoother bandwidth limiter.
Default: 0 (let vsftpd pick a sensible setting)
STRING OPTIONS
Below is a list of string options.
anon_root
This option represents a directory which vsftpd will try to
change into after an anonymous login. Failure is silently
ignored.
Default: (none)
banned_email_file
This option is the name of a file containing a list of anonymous
e-mail passwords which are not permitted. This file is consulted
if the option deny_email_enable is enabled.
Default: /etc/vsftpd/banned_emails
banner_file
This option is the name of a file containing text to display
when someone connects to the server. If set, it overrides the
banner string provided by the ftpd_banner option.
Default: (none)
ca_certs_file
This option is the name of a file to load Certificate Authority
certs from, for the purpose of validating client certs. The
loaded certs are also advertised to the client, to cater for
TLSv1.0 clients such as the z/OS FTP client. Regrettably, the
default SSL CA cert paths are not used, because of vsftpd’s use
of restricted filesystem spaces (chroot). (Added in v2.0.6).
Default: (none)
chown_username
This is the name of the user who is given ownership of anony-
mously uploaded files. This option is only relevant if another
option, chown_uploads, is set.
Default: root
chroot_list_file
The option is the name of a file containing a list of local
users which will be placed in a chroot() jail in their home
directory. This option is only relevant if the option
chroot_list_enable is enabled. If the option chroot_local_user
is enabled, then the list file becomes a list of users to NOT
place in a chroot() jail.
Default: /etvsftpd.confc/vsftpd.chroot_list
cmds_allowed
This options specifies a comma separated list of allowed FTP
commands (post login. USER, PASS and QUIT and others are always
allowed pre-login). Other commands are rejected. This is a pow-
erful method of really locking down an FTP server. Example:
cmds_allowed=PASV,RETR,QUIT
Default: (none)
cmds_denied
This options specifies a comma separated list of denied FTP com-
mands (post login. USER, PASS, QUIT and others are always
allowed pre-login). If a command appears on both this and
cmds_allowed then the denial takes precedence. (Added in
v2.1.0).
Default: (none)
deny_file
This option can be used to set a pattern for filenames (and
directory names etc.) which should not be accessible in any way.
The affected items are not hidden, but any attempt to do any-
thing to them (download, change into directory, affect something
within directory etc.) will be denied. This option is very sim-
ple, and should not be used for serious access control - the
filesystem’s permissions should be used in preference. However,
this option may be useful in certain virtual user setups. In
particular aware that if a filename is accessible by a variety
of names (perhaps due to symbolic links or hard links), then
care must be taken to deny access to all the names. Access will
be denied to items if their name contains the string given by
hide_file, or if they match the regular expression specified by
hide_file. Note that vsftpd’s regular expression matching code
is a simple implementation which is a subset of full regular
expression functionality. Because of this, you will need to
carefully and exhaustively test any application of this option.
And you are recommended to use filesystem permissions for any
important security policies due to their greater reliability.
Supported regex syntax is any number of *, ? and unnested {,}
operators. Regex matching is only supported on the last compo-
nent of a path, e.g. a/b/? is supported but a/?/c is not. Exam-
ple: deny_file={*.mp3,*.mov,.private}
Default: (none)
dsa_cert_file
This option specifies the location of the DSA certificate to use
for SSL encrypted connections.
Default: (none - an RSA certificate suffices)
dsa_private_key_file
This option specifies the location of the DSA private key to use
for SSL encrypted connections. If this option is not set, the
private key is expected to be in the same file as the certifi-
cate.
Default: (none)
dh_param_file
This option specifies the location of the custom parameters used
for ephemeral Diffie-Hellman key exchange in SSL.
Default: (none - use built in parameters appropriate for cer-
tificate key size)
ecdh_param_file
This option specifies the location of custom parameters for
ephemeral Elliptic Curve Diffie-Hellman (ECDH) key exchange.
Default: (none - use built in parameters, NIST P-256 with
OpenSSL 1.0.1 and automatically selected curve based on client
preferences with OpenSSL 1.0.2 and later)
email_password_file
This option can be used to provide an alternate file for usage
by the secure_email_list_enable setting.
Default: /etc/vsftpd/email_passwords
ftp_username
This is the name of the user we use for handling anonymous FTP.
The home directory of this user is the root of the anonymous FTP
area.
Default: ftp
ftpd_banner
This string option allows you to override the greeting banner
displayed by vsftpd when a connection first comes in.
Default: (none - default vsftpd banner is displayed)
guest_username
See the boolean setting guest_enable for a description of what
constitutes a guest login. This setting is the real username
which guest users are mapped to.
Default: ftp
hide_file
This option can be used to set a pattern for filenames (and
directory names etc.) which should be hidden from directory
listings. Despite being hidden, the files / directories etc. are
fully accessible to clients who know what names to actually use.
Items will be hidden if their names contain the string given by
hide_file, or if they match the regular expression specified by
hide_file. Note that vsftpd’s regular expression matching code
is a simple implementation which is a subset of full regular
expression functionality. See deny_file for details of exactly
what regex syntax is supported. Example: hide_file={*.mp3,.hid-
den,hide*,h?}
Default: (none)
listen_address
If vsftpd is in standalone mode, the default listen address (of
all local interfaces) may be overridden by this setting. Provide
a numeric IP address.
Default: (none)
listen_address6
Like listen_address, but specifies a default listen address for
the IPv6 listener (which is used if listen_ipv6 is set). Format
is standard IPv6 address format.
Default: (none)
local_root
This option represents a directory which vsftpd will try to
change into after a local (i.e. non-anonymous) login. Failure is
silently ignored.
Default: (none)
message_file
This option is the name of the file we look for when a new
directory is entered. The contents are displayed to the remote
user. This option is only relevant if the option dirmes-
sage_enable is enabled.
Default: .message
nopriv_user
This is the name of the user that is used by vsftpd when it
wants to be totally unprivileged. Note that this should be a
dedicated user, rather than nobody. The user nobody tends to be
used for rather a lot of important things on most machines.
Default: nobody
pam_service_name
This string is the name of the PAM service vsftpd will use.
Default: ftp
pasv_address
Use this option to override the IP address that vsftpd will
advertise in response to the PASV command. Provide a numeric IP
address, unless pasv_addr_resolve is enabled, in which case you
can provide a hostname which will be DNS resolved for you at
startup.
Default: (none - the address is taken from the incoming con-
nected socket)
rsa_cert_file
This option specifies the location of the RSA certificate to use
for SSL encrypted connections.
Default: /usr/share/ssl/certs/vsftpd.pem
rsa_private_key_file
This option specifies the location of the RSA private key to use
for SSL encrypted connections. If this option is not set, the
private key is expected to be in the same file as the certifi-
cate.
Default: (none)
secure_chroot_dir
This option should be the name of a directory which is empty.
Also, the directory should not be writable by the ftp user. This
directory is used as a secure chroot() jail at times vsftpd does
not require filesystem access.
Default: /usr/share/empty
ssl_ciphers
This option can be used to select which SSL ciphers vsftpd will
allow for encrypted SSL connections. See the ciphers man page
for further details. Note that restricting ciphers can be a use-
ful security precaution as it prevents malicious remote parties
forcing a cipher which they have found problems with.
Default: AES128-SHA:DES-CBC3-SHA:DHE-RSA-AES256-SHA:ECDHE-RSA-
AES128-SHA:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-AES256-GCM-
SHA384
user_config_dir
This powerful option allows the override of any config option
specified in the manual page, on a per-user basis. Usage is sim-
ple, and is best illustrated with an example. If you set
user_config_dir to be /etc/vsftpd/user_conf and then log on as
the user "chris", then vsftpd will apply the settings in the
file /etc/vsftpd/user_conf/chris for the duration of the ses-
sion. The format of this file is as detailed in this manual
page! PLEASE NOTE that not all settings are effective on a per-
user basis. For example, many settings only prior to the user’s
session being started. Examples of settings which will not
affect any behviour on a per-user basis include listen_address,
banner_file, max_per_ip, max_clients, xferlog_file, etc.
Default: (none)
user_sub_token
This option is useful is conjunction with virtual users. It is
used to automatically generate a home directory for each virtual
user, based on a template. For example, if the home directory of
the real user specified via guest_username is /home/vir-
tual/$USER, and user_sub_token is set to $USER, then when vir-
tual user fred logs in, he will end up (usually chroot()’ed) in
the directory /home/virtual/fred. This option also takes affect
if local_root contains user_sub_token.
Default: (none)
userlist_file
This option is the name of the file loaded when the
userlist_enable option is active.
Default: /etc/vsftpd/user_list
vsftpd_log_file
This option is the name of the file to which we write the vsftpd
style log file. This log is only written if the option xfer-
log_enable is set, and xferlog_std_format is NOT set. Alterna-
tively, it is written if you have set the option
dual_log_enable. One further complication - if you have set
syslog_enable, then this file is not written and output is sent
to the system log instead.
Default: /var/log/vsftpd.log
xferlog_file
This option is the name of the file to which we write the wu-
ftpd style transfer log. The transfer log is only written if the
option xferlog_enable is set, along with xferlog_std_format.
Alternatively, it is written if you have set the option
dual_log_enable.
Default: /var/log/xferlog
AUTHOR
scarybeasts@gmail.com
VSFTPD.CONF(5)