TPOPS

TPOPS は POP3 サーバです。RFC 1939 に準拠しています。 Ruby で実装されています。 サポートされているメールボックスは Maildir 形式です。 POP ログイン名やメールアドレスなどのユーザ情報は MySQL のテーブルで管理することもできます。

必要なもの

• Ruby 1.8.1
• MySQL 3.23.x (MySQL 認証を使用する場合)
• Ruby/MySQL 0.2.4 (MySQL 認証を使用する場合)

インストール

1. 適当なディレクトリに展開してください。

   # cd /usr/local
   # tar xpfvz /tmp/tpops-0.6.tar.gz
   # chown -R root:root tpops-0.6
   # ln -s tpops-0.6 tpops
   

2. 必要に応じて tpops.conf を編集してください。

   設定できるパラメータは次の通りです。 これらのパラメータはコマンドライン上で --parameter=value としても記述できます。 コマンドラインでの指定が優先されます。

   パラメータ名	デフォルト値	意味
   標準パラメータ
   config	なし(tpopsと同じディレクトリの tpops.conf)	設定ファイルを指定します。通常はコマンドラインで指定します。 設定ファイル中で指定してもおそらく意味はないでしょう。
   port または p	110	tpops が listen するポート番号。 「ホスト名:ポート番号」の形式でホスト名を指定した時は、そのアドレスだけで listen します。
   hostname	なし(「uname -n」の結果)	クライアントの接続時に最初に返されるメッセージ中に含まれるホスト名。
   connection-keep-time	3600	最大接続維持時間(秒数)。 接続開始からこの時間が経過すると、オペレーション中であっても強制的に接続を切断します。
   command-timeout	600	コマンド待ち時間(秒数)。 クライアントからこの時間入力がないと、接続を切断します。
   inetd	なし	指定されている場合は inetd から起動されたものとして動作します。
   fg	なし	指定されている場合はフォアグラウンドで動作します。
   version	なし	指定されている場合はバージョン情報を表示して終了します。
   debug	なし	指定されている場合はクライアントのコマンドとサーバの応答をログに記録します。
   access-log	なし	アクセスログファイル名。
   error-log	なし	エラーログファイル名。
   pid-file	なし	プロセスIDを記録するファイル名。
   user または u	なし(親プロセスと同じ)	子プロセスの UID。passwd 認証に root 権限が必要なシステムでは、このパラメータを設定すると認証できません。
   group または g	なし(親プロセスと同じ)	子プロセスの GID。
   syslog	mail	syslog ファシリティ名。syslog に記録しない場合は「none」を指定します。
   auth-type	passwd	ユーザ認証方式。passwd, mysql のいずれかを指定します。
   domain		ログイン名に「@」「%」「+」のいずれも含まれてない場合に、「@domainname」をログイン名に追加して認証を試みます。
   error-interval	5	クライアントからのコマンドがエラーになった場合に、エラーを返す前に遅延する秒数。
   min-servers	5	最小子プロセス数。子プロセス数がこの値以下になると、この値になるまで子プロセスが起動されます。
   max-servers	50	最大子プロセス数。子プロセス数はこの値以上にはなりません。
   max-use	100	子プロセスが処理する接続数の最大値。この値を超えると子プロセスは終了します。
   max-idle	100	最大接続待ち時間。接続終了後、この時間内に新たな接続がないと子プロセスは終了します。
   maildir-use-filesize	yes	Maildir 形式で保存されているメールファイルのサイズを、メールのサイズとして扱います。 RFCに従わなくなる可能性があるので注意。
   maildir-extended	yes	Maildir 形式で保存されているメールファイルのファイル名中に「S=数値」があれば、それをメールのサイズとして扱います。 maildir-use-filesize よりも優先されます。 RFCに従わなくなる可能性があるので注意。
   maildir-lock	yes	メールボックスをロックします。ログイン中は同じメールボックスを使用する ID ではログインできません。
   auth-type = passwd 時に有効なパラメータ
   apop-passwd-file	なし	APOP 認証時に使用される ID とパスワードの対が DBM 形式で格納されたファイル名。指定された場合は、APOP が使用できます。
   maildir	Maildir	Maildir 形式のメール格納ディレクトリのユーザのホームディレクトリからの相対パス。
   auth-type = mysql 時に有効なパラメータ
   mysql-server	なし	MySQLサーバ名。
   mysql-user	なし	MySQLログインユーザ名。
   mysql-pass	なし	MySQLログインパスワード。
   mysql-db	なし	MySQLデータベース名。
   mysql-auth-query	select login,passwd,maildir from user where login="%s"	ログイン名,パスワード,Maildir を取り出すためのクエリ文字列。 「%s」はクライアントから渡されたログイン名に置き換えられます。

3. auth_type = mysql の場合

   MySQL に TPOPS 用のデータベースを作成し、tpops_auth-mysql.sql を使用してテーブルを作成してください。

   % mysqladmin create tpops
   % mysql tpops < tpops_auth-mysql.sql
   

起動

1. スタンドアロンの場合(デフォルト) /usr/local/tpops/tpops を実行します。
2. inetd を使用する場合

   /etc/inetd.conf に次のように記述します。

   pop3	stream	tcp	nowait	root	/usr/local/tpops/tpops	tpops --inetd

   その後 inetd プロセスに HUP シグナルを通知します。

シグナル

SIGTERM を受信すると終了します。 処理中の子プロセスは処理が終わるまで終了しません。

SIGHUP を受信すると、子プロセスを終了させ、tpops.conf を再読み込みします。 処理中の子プロセスは処理が終わるまで終了しません。 tpops.conf ファイル中の記述よりもコマンドラインで指定したオプションが優先されます。

SIGINT を受信すると終了します。

ユーザ登録

1. auth-type = passwd の場合(デフォルト)

   OS にユーザを登録してください。 メールボックスは、ユーザのホームディレクトリ直下の 'Maildir' が使用されます。

   APOP を使用する場合は、tpops.conf 内に apop-passwd-file を設定してください。 APOP 使用時にはこのファイルから、パスワードが検索されます。 ここで指定するファイルの内容は、ログイン名をキーとしてプレーンパスワードを得られるような DBM 形式です。

   DBM 形式ファイルの編集には、tpops_passwd コマンドを使用できます。

   コマンド	説明
   tpops_passwd pwdfile id password	pwdfile に ID とパスワードを追加する
   tpops_passwd -f filename pwdfile	filename からIDとパスワードのリストを読み込み pwdfile に追加する
   tpops_passwd -d id pwdfile	pwdfile から ID を削除する
   tpops_passwd -l pwdfile	pwdfile 内の ID とパスワードをリストする

2. auth-type = mysql の場合

   user テーブルにユーザ情報を登録してください。

   フィールド名	値
   uid	ユーザID(数値)
   login	POPログイン名
   passwd	POPパスワード
   mail	メールアドレス
   maildir	Maildir の場所

ログファイル

tpops.conf で access-log を指定すると、ログアウト時に指定したファイルにログを書き込みます。 ログの形式は次の通りです。

接続元IP ログイン日 時刻 ログアウト日 時刻 ログイン名 ログイン時メッセージ数 ログイン時メッセージサイズ ログアウト時メッセージ数 ログアウト時メッセージサイズ

syslog を指定すると、指定したファシリティで syslog にログを書き出します。 syslog はファシリティを表わす文字列です。

Maildir 形式を使用する場合の注意

qmail や Postfix の Maildir 形式では、メッセージの改行コードが "\n" としてファイルに格納されます。 しかし POP プロトコルでは改行コードは "\r\n" に定められています。 LIST コマンドなどで通知されるメッセージサイズも POP プロトコル上は、改行コードを２バイトとしてカウントする必要があります。 そのため、メッセージサイズを得るだけでも、メッセージファイルを読み、改行コードを調べる必要があります。

(qmail に付属の qmail-pop3d はこの処理をサボって、ファイルサイズを返しているため、RFC 的には正しくありません。)

Maildir++ 形式のファイル名でメッセージを格納するメール配送エージェントを使用すれば、ファイル名にメッセージサイズが含められているので、ファイルの内容をチェックする必要がなく、高速に処理できます。 メールファイルが Maildir++ 形式のファイル名の場合は、TPOPS は自動的にファイル名からサイズを得ようとします。この動作を無効にしたい場合は tpops.conf に「maildir-extended = no」を設定してください。

ファイル名が Maildir++ 形式でない場合は、ファイルサイズをメッセージサイズとして使用することで高速に処理しようとします(qmail と同じ手法)。 この動作を無効にしたい場合は tpops.conf に「maildir-use-filesize = no」を設定してください。 ただし、メッセージサイズを調べるために、メッセージファイルの内容を読み出すため、遅くなります。注意してください。

注意

正常に動作することを期待して作られていますが、不具合がないことは保証できません。 重要なメールデータが失われたとしても私は責任を負えません。 十分テストした上でご使用ください。

ライセンス

このプログラムは Ruby ライセンスに従います。

履歴

0.6 2004-06-11

• コマンドラインオプションを変更。
• コンフィグファイルの形式を変更(Rubyスクリプトではなくなった)。
• tpops_passwd コマンドの追加。
• tpops-useradd コマンドの削除。
• passwd-lock-dir のデフォルト値変更。
• maildir パラメータの導入。
• SIGHUP 時にすべての設定パラメータを反映させるようにした。
• apop-passwd-file の形式を BDB::Hash 形式から DBM 形式に変更。
• ロックファイルの形式を変更。
• ruby-shadow を不要にした。
• tserver 0.2.1 を使用。
• plugin ディレクトリの作成。
• mysql-auth-query の検索結果を変更。
• ログイン時に new から cur にメールを移動するようにした。
• RETR したメールに S フラグをつけるようにした。
• LAST コマンド対応。

0.5.5 2004-03-18

• tserver 0.1.1 を使用(kill で終了しないことがあるバグに対応)
• Ruby 1.8.1 に対応

0.5.4 2003-09-10

• syslog が「%」を含む文字列でエラーになっていたバグを修正

0.5.3a 2003-04-27

• tserver 0.0.7 を使用

0.5.3 2003-04-17

• $mysql_auth_query を配列にすることで、複数のクエリを記述できるようにした
• tserver 0.0.6 を使用

0.5.2 2003-01-24

• スタンドアロン時に間違った ID を pid_file に記録していたバグを修正
• SIGTERM, SIGHUP で処理中の子プロセスを終了させないように変更
• SIGINT で子プロセスを強制的に終了させるように変更

0.5.1 2003-01-18

• クライアント切断時にロックが残ったままになることがあるバグを修正
• SIGUSR1 が無視されるバグを修正
• $pid_file パラメータ, --pidfile オプション追加
• SIGHUP 時に $error_log を再オープンするように変更

0.5.0 2002-12-04

• tpops.conf がなくても動くようにした
• tpops.conf 内のパラメータを $パラメータ に変更
• MySQL メールボックスの廃止
• TServer を使用して高速化
• $with_inetd のデフォルト値を false に変更
• $maildir_extended, $maildir_use_filesize のデフォルト値を true に変更
• スタンドアロン時も $error_log を有効にした
• コマンドラインオプションの追加

0.4.8 2002-11-20

• APOP認証失敗時にログにユーザ名が出力されないバグを修正
• syslog 機能追加

0.4.7 2002-11-07

• CommandTimeout,ConnectionKeepTime タイマが働かないことがあるバグを修正
• ログイン時とログアウト時のメール数とサイズをログに記録するようにした
• ロックしたプロセスが存在しない場合にロック解除するようにした
• エラーファイルに時刻を出力するようにした

0.4.6a 2002-08-16

• クライアントが接続を切断した時に無限ループになるバグを修正

0.4.6 2002-08-16

• メールボックスが ENOENT 以外のエラーの場合に異常終了するようにした
• クライアントからの１行の入力が 1024バイトを超えると接続を切断するようにした
• ログインに成功しなくてもログを出力するようにした

0.4.5 2002-08-01

• ログが取れないことがあるバグを修正
• ごく稀に EINTR エラーになることがあるバグを修正
• --domain オプションを追加

0.4.4 2002-07-03

• TOP がエラーになるバグを修正
• MaildirUseFileSize が未定義になるバグを修正

0.4.3 2002-06-27

• 大きなメールの処理速度を向上

0.4.2 2002-04-21

• Maildir++ 形式のファイル名を扱えるようにした (MaildirExtended)
• MaildirCRLF を MaildirUseFileSize に変更
• tpops-pipe: quota に引っ掛かったユーザ以外のメールが配送されないバグを修正

0.4.1 2002-04-11

• 大きなメールの RETR/TOP 時の速度とメモリ効率を向上

0.4 2002-03-21

• 認証方式とメールボックス方式を本体から分離
• OS の /etc/passwd をユーザ認証に使用できるようにした
• MySQL をオプションにした

0.3.3 2002-02-27

• POP before SMTP の仕組みのバグを修正
• TOP がおかしな結果を返していたバグを修正

0.3.2 2002-02-25

• Log ファイルが壊れる可能性があったバグを修正
• POP before SMTP の仕組みを導入
• RETR/TOP 時には MaildirCRLF の値に関わらず "\r\n" のデータを返すようにした（MaildirCRLF はメッセージサイズ値だけに影響する）。

0.3.1 2002-01-29

• WithInetd 時のエラー出力をファイルに変更

0.3 2002-01-25

• WithInetd パラメータの導入
• LogFile パラメータの導入

0.2.2 2001-12-28

• 若干の高速化
• QUIT の応答時のエラーを無視

0.2.1 2001-08-01

• パスワードが MySQL のログに残らないようにした
• AuthQuery パラメータの導入

0.2 2001-07-12

• Maildir 形式を扱えるようにした

0.1 2001-05-20

• 公開

Last modified: Fri Jun 11 11:22:54 JST 2004