![]() |
![]() |
![]() |
milter managerリファレンスマニュアル | ![]() |
---|
ここでは/usr/local/以下にインストールされたものとして説明します。configure時に--prefix=/usr/local/オプションを指定するか、--prefixオプションを省略した場合は/usr/local/以下にインストールされます。
この場合は、設定ファイルは/usr/local/etc/milter-manager/milter-manager.confになります。インストールが成功していれば、もうすでにファイルが存在するはずです。
設定ファイルの先頭は以下のようになっています。
# -*- ruby -*- load("applicable-conditions/*.conf") load_default load_if_exist("milter-manager.local.conf")
通常は、この部分はそのままにしておき、milter-manager.confと同じディレクトリにmilter-manager.local.confというファイルを作成し、そのファイルに設定を記述します。
設定項目は以下のように分類されています。
このうち、適用条件関連とデータベース関連はRubyの知識が必要になります。 S25R などの有用な適用条件は標準で提供されているので、必ずしも自分で適用条件を定義できる必要はありません。そのため、適用条件の説明は一番最後にあります。適用条件を定義する必要がない場合は、適用条件関連の部分は読み飛ばしても構いません。
それぞれ順に説明する前に、設定をする上で便利なmilter-manager機能を紹介します。milter-managerを--show-configオプションを付きで起動すると、現在の設定内容が表示されます。
% /usr/local/sbin/milter-manager --show-config package.platform = "debian" package.options = nil security.privilege_mode = false security.effective_user = nil security.effective_group = nil log.level = "default" log.use_syslog = true log.syslog_facility = "mail" manager.connection_spec = nil manager.unix_socket_mode = 0660 manager.unix_socket_group = nil manager.remove_unix_socket_on_create = true manager.remove_unix_socket_on_close = true manager.daemon = false manager.pid_file = nil manager.maintenance_interval = 100 manager.suspend_time_on_unacceptable = 5 manager.max_connections = 0 manager.custom_configuration_directory = nil manager.fallback_status = "accept" manager.fallback_status_at_disconnect = "temporary-failure" manager.event_loop_backend = "glib" manager.n_workers = 0 manager.packet_buffer_size = 0 manager.connection_check_interval = 0 controller.connection_spec = nil controller.unix_socket_mode = 0660 controller.remove_unix_socket_on_create = true controller.remove_unix_socket_on_close = true define_applicable_condition("S25R") do |condition| condition.description = "Selective SMTP Rejection" end define_applicable_condition("Remote Network") do |condition| condition.description = "Check only remote network" end
この内容で設定内容を確認することができます。
また、この書式はそのまま設定ファイルの書式になっているので、設定の書き方を忘れたときにはこの内容をヒントにすることができます。
それでは、それぞれの分類毎に説明します。
この項目は通常は変更する必要はありません。 milterの自動検出方法はプラットフォーム毎に異なります。自動検出はmilterがプラットフォームで用いているパッケージシステムでインストールされていることを前提としています。そのため、実際のプラットフォームとmilter-managerが認識しているプラットフォームが異なると、自動検出がうまく動きません。 プラットフォームはビルド時に検出しています。検出結果が間違っている場合は、ビルド時に修正することができます。検出結果が間違っているが、ビルドをやり直すことができない場合に、この設定項目を利用します。 現在、標準で利用可能なプラットフォームは以下の通りです。
プラットフォーム名は「"」で囲んて"debian"というように指定します。 注意: 変更する場合はload_defaultの 前 に行って下さい。 例: package.platform = "pkgsrc" 既定値: package.platform = "debian" # 環境に依存 |
|
この項目は通常は変更する必要はありません。 package.platformと同様にビルド時に決定しています。 milter自動検出処理へ付加情報を渡すための項目です。"名前1=値1,名前2=値2,.."という形式で複数の情報を渡すことができます。 現在、この付加情報を使っているのはpkgsrcプラットフォームのときだけで、"prefix=rc.dがあるディレクトリのパス"という情報を使っています。例えば、/etc/rc.d/以下に起動スクリプトをインストールしている時は、"prefix=/etc"と指定します。 注意: 変更する場合はload_defaultの 前 に行って下さい。 例: package.options = "prefix=/etc,name=value" 既定値: package.options = nil # 環境に依存 |
特権モードで動作するかどうかを指定します。子milter自動起動機能を利用する場合は有効にする必要があります。 有効にする場合はtrueを指定します。無効にする場合はfalseを指定します。 例: security.privilege_mode = true 既定値: security.privilege_mode = false |
|
milter-managerプロセスの実効ユーザを指定します。ユーザを切り替えるにはmilter-managerコマンドをroot権限で起動する必要があります。 実効ユーザは「"」で囲んて"nobody"というように指定します。ユーザを指定しない場合はnilを指定します。 例: security.effective_user = "nobody" 既定値: security.effective_user = nil |
|
milter-managerプロセスの実効グループを指定します。グループを切り替えるにはmilter-managerコマンドをroot権限で起動する必要があります。 実効グループは「"」で囲んで"nogroup"というように指定します。グループを指定しない場合はnilを指定します。 例: security.effective_group = "nogroup" 既定値: security.effective_group = nil |
1.6.6から使用可能。
ログレベルを指定します。ログレベルはすべて独立しているので、必要なログレベルを組み合わせて指定します。例えば、「infoとdebugとerrorレベルのログを出力する」というような指定になります 指定可能なログレベルは以下の通りです。
ログレベルは「"」で囲んで"all"というように指定します。複数のログレベルを指定する場合は"critical|error|warning"というように「|」で区切ります。 例: log.level = "all" # すべてのログを出力 既定値: log.level = "default" |
|||||||||||||||||||||||||||||||||||
syslogにもログを出力するかどうかを指定します。 出力する場合はtrueを指定します。出力しない場合はfalseを指定します。 例: log.use_syslog = false # syslogに出力しない 既定値: log.use_syslog = true |
|||||||||||||||||||||||||||||||||||
syslog出力時に利用するファシリティを指定します。 指定可能なファシリティと対応するsyslogの定数は以下の通りです。
ファシリティは「"」で囲んで"mail"というように指定します。 例: log.syslog_facility = "local4" # LOG_LOCAL4を使う 既定値: log.syslog_facility = "mail" |
milter-managerが接続を受け付けるソケットを指定します。 ソケットは「"」で囲んて"inet:10025"というように指定します。指定できる書式は以下の通りです。
もし、security.effective_user, security.effective_groupを指定している場合は、その権限でUNIXドメインソケットを作成します。ソケットを作成するディレクトリのパーミッションに注意してください。 IPv4ソケット・IPv6ソケットでホスト名を省略した場合は、すべてのネットワークインターフェイスから接続を受け付けます。ホスト名やアドレスを指定した場合はそのアドレスからのみ接続を受け付けます。 例: manager.connection_spec = "unix:/var/run/milter/milter-manager.sock" 既定値: manager.connection_spec = "inet:10025@[127.0.0.1]" |
|||||||||
milter-managerが接続を受け付けるUNIXドメインソケットのパーミッションを指定します。manager.connection_specでUNIXドメインソケットを使用している場合のみ利用されます。 8進数で値を指定するために、先頭に「0」をつけることを忘れないでください。 例: manager.unix_socket_mode = 0600 既定値: manager.unix_socket_mode = 0660 |
|||||||||
milter-managerが接続を受け付けるUNIXドメインソケットのグループを指定します。manager.connection_specでUNIXドメインソケットを使用している場合のみ利用されます。 ソケットのグループはsecurity.effective_user/security.effective_group権限で作成された後に、chown(2)で変更します。そのため、指定するグループはsecurity.effective_userの補助グループである必要があります。 グループは「"」で囲んて"nogroup"というように指定します。グループを指定しない場合はnilを指定します。 例: manager.unix_socket_group = "nobody" 既定値: manager.unix_socket_group = nil |
|||||||||
milter-managerが接続を受け付けるUNIXドメインソケットを作成する前にすでにファイルが存在した場合、削除するかどうかを指定します。manager.connection_specでUNIXドメインソケットを使用している場合のみ利用されます。 削除する場合はtrueを指定します。削除しない場合はfalseを指定します。 例: manager.remove_unix_socket_on_create = false 既定値: manager.remove_unix_socket_on_create = true |
|||||||||
milter-managerが終了するときに、接続を受け付けていたUNIXドメインソケットを削除するかどうかを指定します。manager.connection_specでUNIXドメインソケットを使用している場合のみ利用されます。 削除する場合はtrueを指定します。削除しない場合はfalseを指定します。 例: manager.remove_unix_socket_on_close = false 既定値: manager.remove_unix_socket_on_close = true |
|||||||||
デーモンプロセスとして動作するかどうかを指定します。デーモンプロセスで動作する場合は、端末を切り離し、バックグラウンドで動作します。運用時はバックグラウンドで起動することをお勧めします。この設定項目はmilter-managerの--daemonコマンドラインオプションで上書きできるため、必ずしも設定ファイル内で設定する必要はありません。 デーモンプロセスとして動作する場合はtrueを指定します。そうでない場合はfalseを指定します。 例: manager.daemon = true 既定値: manager.daemon = false |
|||||||||
起動したmilter-managerのプロセスIDを保存するファイルを指定します。 もし、security.effective_user, security.effective_groupを指定して場合は、その権限でファイルへ書き込みます。ファイルのパーミッションに注意してください。 ファイルのパスは「"」で囲んで"/var/run/milter/milter-manager.pid"というように指定します。保存しない場合はnilを指定します。 例: manager.pid_file = "/var/run/milter/milter-manager.pid" 既定値: manager.pid_file = nil |
|||||||||
何セッション終了毎にメンテナンス処理を実行するかを指定します。 現時点でのメンテナンス処理とはメモリ解放処理のことです。同時アクセス数が少ない環境では各セッション終了毎にメンテナンス処理を実行することによりメモリ使用量を抑えることができます。同時アクセス数が多い環境では複数セッション終了毎にまとめてメンテナンス処理を実行することにより処理効率をあげることができます。 0またはnilを指定した場合はメンテナンス処理を実行しません。 例: manager.maintenance_interval = nil 既定値: manager.maintenance_interval = 100 |
|||||||||
同時に多数の接続があり、MTAからの接続を受け付けることができないときに何秒待つかを指定します。ulimitやlimitで同時に開くことができるファイルディスクリプタ数を増やすことも検討してください。 例: manager.suspend_time_on_unacceptable = 10 既定値: manager.suspend_time_on_unacceptable = 5 |
|||||||||
1.3.1から使用可能。 最大同時接続数を指定します。0を指定すると無制限になります。既定値では無制限です。 最大同時接続数の処理を行っているときに新しく接続要求があると、処理中の接続が終了するのを待ちます。処理中の接続が終了したかどうかは manager.suspend_time_on_unacceptable で指定した秒数毎に確認します。 例: manager.max_connections = 10 # 同時に最大10接続のみ受け付ける 既定値: manager.max_connections = 0 # 制限無し |
|||||||||
1.3.1から使用可能。 プロセスが開くことができるファイルディスクリプタ数を指定します。0を指定するとシステムの既定値を変更しません。既定値は0なので、システムの既定値をそのまま使います。 milter-managerは1つのリクエストに対して「子milter数 + 1(MTAとの接続用)」個のファイルディスクリプタを開きます。milter-manager内部でも数個のファイルディスクリプタを開くので少なくとも以下の個数のファイルディスクリプタが開けるようにしてください。 (子milter数 + 1) * 最大同時接続数 + 10(milter-manager内部で使用 + α) プロセスが開くことができるファイルディスクリプタ数はsetrlimit(2)でソフトリミットとハードリミットを変更します。 例: manager.max_file_descriptors = 65535 既定値: manager.max_file_descriptors = 0 |
|||||||||
Webインターフェイスから変更した設定内容を保存するディレクトリを指定します。 ディレクトリのパスは「"」で囲んで"/tmp/milter-manager/"というように指定します。 nilを指定した場合は実効ユーザのホームディレクトリ直下に".milter-manager"というディレクトリを作成し、そのディレクトリを利用します。 例: manager.custom_configuration_directory = "/tmp/milter-manager/" 既定値: manager.custom_configuration_directory = nil |
|||||||||
1.6.3から使用可能。 milter-manager内部で問題があったときにSMTPサーバへ返すステータスを指定します。milter-manager内部で問題が起こるのは以下のような場合です。
指定できる値は以下のいずれかの値です。
例: manager.fallback_status = "reject" 既定値: manager.fallback_status = "accept" |
|||||||||
1.6.3から使用可能。 SMTPクライアントがSMTPセッションの途中でSMTPサーバとの接続を切断したことを検出した時に返すステータスを指定します。切断の検出は既定値では無効になっているので、既定値ではこの設定が利用されることがありません。切断の検出を有効にする場合は manager.use_netstat_connection_checker を利用してください。 指定できる値は以下のいずれかの値です。
例: manager.fallback_status_at_disconnect = "discard" 既定値: manager.fallback_status_at_disconnect = "temporary-failure" |
|||||||||
この項目は通常は使用する必要はありません。 1.6.3から使用可能。 イベントループのバックエンドを指定します。100メール/秒以下のメール流量を処理するような中小規模のメールシステムではこの値を変更する必要はありません。100メール/秒以上のメール流量を処理するような大規模のメールシステムではこの値を"libev"に設定する必要があります。 指定できる値は以下のいずれかの値です。
注意: この項目は実験的な機能扱いです。 例: manager.event_loop_backend = "libev" 既定値: manager.event_loop_backend = "glib" |
|||||||||
この項目は通常は使用する必要はありません。 1.6.3から使用可能。 メールを処理するプロセス数を指定します。100メール/秒以下のメール流量を処理するような中小規模のメールシステムや、非常に重いmilterを使用しないようなメールシステムではこの値を変更する必要はありません。非常に重いmilterを使用しながら100メール/秒以上のメール流量を処理するような大規模のメールシステムではこの値を増やす必要があります。 指定できる値は0以上、1000以下です。0のときはワーカープロセスを使用しません。 注意: この項目は実験的な機能扱いです。 例: manager.n_workers = 10 既定値: manager.n_workers = 0 # ワーカープロセスを使用しない |
|||||||||
この項目は通常は使用する必要はありません。 1.6.3から使用可能。 end-of-message時に送信パケットをバッファリングするためのバッファサイズを指定します。バッファリングしているパケットの量が指定したバイト以上になるとまとめてパケットを送信します。0を指定するとバッファリングしません。 end-of-message時にadd_headerやdelete_recipientなどメッセージ変更操作を多くする場合にパフォーマンスがよくなる可能性があります。通常はほとんど影響がありません。 例: manager.packet_buffer_size = 4096 # 4KB溜まるまで送信しない。 既定値: manager.packet_buffer_size = 0 # バッファリングを無効にする。 |
|||||||||
1.5.0から使用可能。 netstat コマンドの出力を解析してSMTPクライアントがまだSMTPサーバと接続しているかを確認します。 この機能はmilter(milter-greylist)を用いた taRgrey を実現しているときなど、SMTPクライアントが自発的に切断したことを検出して途中で処理を止めたい場合に有用です。この機能を用いることによりtaRgreyの問題点の1つであるSMTPサーバのプロセス数増大を抑えることができます。プロセス数が増大するとメモリ使用量が増えるため、プロセス数増大を抑えることはメモリ使用量を抑えることにつながります。 接続は5秒毎に確認します。この間隔は変更することも可能ですが、通常は変更する必要はありません。 例: manager.use_netstat_connection_checker # 5秒間隔で確認 manager.use_netstat_connection_checker(1) # 1秒間隔で確認 初期値: 確認しない |
|||||||||
この項目は通常は直接使用する必要はありません。 1.5.0から使用可能。 SMTPクライアントがまだSMTPサーバと接続しているかどうかを確認する間隔を秒単位で指定します。 0を指定すると確認しません。 どのようにして接続しているかどうかを確認するかは manager.define_connection_checker で定義します。 例: manager.connection_check_interval = 5 # 5秒間隔で確認 既定値: manager.connection_check_interval = 0 |
|||||||||
manager.define_connection_checker(name) {|context| ... # -> true/false} |
この項目は通常は直接使用する必要はありません。 1.5.0から使用可能。 manager.connection_check_interval で指定した秒毎にSMTPクライアントがまだSMTPサーバと接続しているかを確認します。ブロックがtrueを返したときはまだ接続していることを示し、falseを返したときは接続が切れたことを示します。
例: # ローカルネットワーク以外からの接続は強制的に切断したとみなす manager.define_connection_checker("netstat-check") do |context| context.smtp_client_address.local? end |
||||||||
1.5.0から使用可能。 メンテナンス処理が実行される度にメモリ使用量をログに出力します。 現在は以下のようなフォーマットで出力されますが、変更される可能性があります。 Mar 28 15:16:58 mail milter-manager[19026]: [statistics] [maintain][memory] (28048KB) total:6979 Proc:44 GLib::Object:18 使用例: manager.report_memory_statistics |
|||||||||
この項目は通常は直接使用する必要はありません。 1.5.0から使用可能。 メンテナンス処理が実行される度に指定した処理を実行します。 以下の例はメンテナンス処理が実行する度にログを出力する設定です。 使用例: manager.maintained do Milter::Logger.info("maintained!") end |
|||||||||
この項目は通常は直接使用する必要はありません。 1.6.8から使用可能。 イベントループが作成されたときに指定した処理を実行します。イベントループが作成されるのは初期化時のみです。時のみ指定した実行します。 以下の例は1秒ごとにログを出力するコールバックを登録する設定です。 使用例: manager.event_loop_created do |loop| loop.add_timeout(1) do Milter::Logger.info("timeout!") true end end |
milter-managerを制御するための接続を受け付けるソケットを指定します。 書式はmanager.connection_specと同じです。 例: controller.connection_spec = "inet:10026@localhost" 既定値: controller.connection_spec = nil |
|
milter-managerを制御するための接続を受け付けるUNIXドメインソケットのパーミッションを指定します。controller.connection_specでUNIXドメインソケットを使用している場合のみ利用されます。 8進数で値を指定するために、先頭に「0」をつけることを忘れないでください。 例: controller.unix_socket_mode = 0600 既定値: controller.unix_socket_mode = 0660 |
|
milter-managerを制御するための接続を受け付けるUNIXドメインソケットを作成する前にすでにファイルが存在した場合、削除するかどうかを指定します。controller.connection_specでUNIXドメインソケットを使用している場合のみ利用されます。 削除する場合はtrueを指定します。削除しない場合はfalseを指定します。 例: controller.remove_unix_socket_on_create = false 既定値: controller.remove_unix_socket_on_create = true |
|
milter-managerが終了するときに、milter-managerを制御するための接続を受け付けていたUNIXドメインソケットを削除するかどうかを指定します。controller.connection_specでUNIXドメインソケットを使用している場合のみ利用されます。 削除する場合はtrueを指定します。削除しない場合はfalseを指定します。 例: controller.remove_unix_socket_on_close = false 既定値: controller.remove_unix_socket_on_close = true |
子milterに関連する設定項目について説明します。
子milterは以下の書式で登録します。
define_milter("名前") do |milter| milter.XXX = ... milter.YYY = ... milter.ZZZ = ... end
例えば、「inet:10026@localhost」で接続待ちしているmilterを「test-milter」という名前で登録する場合は以下のようになります。
define_milter("test-milter") do |milter| milter.connection_spec = "inet:10026@localhost" end
define_milter do ... end内で設定できる項目は以下の通りです。
必須の項目はmilter.connection_specだけです。
子milterが接続待ちしているソケットを指定します。 必須項目 です。 書式はmanager.connection_specと同じです。 例: milter.connection_spec = "inet:10026@localhost" 既定値: milter.connection_spec = nil |
|
子milterの説明を指定します。 説明は「"」で囲んで"test milter"というように指定します。 例: milter.description = "test milter" 既定値: milter.description = nil |
|
子milterを利用するかどうかを指定します。 利用する場合はtrueを指定します。利用しない場合はfalseを指定します。 例: milter.enabled = false 既定値: milter.enabled = true |
|
子milterに問題があったとき、指定したステータスを返したとして扱います。 指定できる値は以下のいずれかの値です。
例: milter.fallback_status = "temporary-failure" 既定値: milter.fallback_status = "accept" |
|
1.3.1から使用可能。 評価モードにするかどうかを指定します。評価モードでは子milterの結果をMTAに返さないので、既存のメールシステムには影響を与えません。 評価モードでも統計用のログが出力されるため、本来なら子milterがMTAにどのような結果を返していたかを視覚化できます。 評価モードにする場合はtrueを指定します。 false(既定値)の場合は、子milterがrejectを返すとMTAにrejectと返し、処理が終了してします。trueの場合は子milterがrejectを返してもMTAにはrejectを返さず、処理が継続します。継続している処理の中では「子milterがrejectを返した」という情報を利用できます。その情報を利用して適用条件を記述することができます。 例: milter.evaluation_mode = true 既定値: milter.evaluation_mode = false |
|
子milterを適用する条件を指定します。条件は複数指定できます。1つでも条件を満たさない場合は子milterの適用は中止されます。 利用可能は適用条件は以下のコマンドで確認できます。 % /usr/local/sbin/milter-manager --show-config | grep define_applicable_condition define_applicable_condition("S25R") do |condition| define_applicable_condition("Remote Network") do |condition| この場合は"S25R"と"Remote Network"が利用可能です。 適用条件は標準で提供されているだけではなく、独自に定義することもできます。定義方法については 適用条件定義 を見てください。ただし、独自に定義する場合にはRubyの知識が必要になります。 適用条件は以下のように「,」でくぎって複数指定できます。 milter.applicable_conditions = ["S25R", "Remote Network"] 例: milter.applicable_conditions = ["S25R"] 既定値: milter.applicable_conditions = [] |
|
子milterを適用する条件を追加します。適用する条件についてはmilter.applicable_conditionsを見てください。 例: milter.add_applicable_condition("S25R") |
|
子milterを起動するコマンドを指定します。security.privilege_modeがtrueでmilter-managerコマンドがroot権限で実行されている場合、milter.connection_specへの接続が失敗した時に、子milterを自動で起動します。そのときに利用するコマンドです。 /etc/init.d/以下や/usr/local/etc/rc.d/以下にある起動スクリプトを指定することを想定しています。 コマンドは「"」で囲んで"/etc/init.d/milter-greylist"というように指定します。自動で起動しない場合はnilを指定します。 例: milter.command = "/etc/init.d/milter-greylist" 既定値: milter.command = nil |
|
milter.commandに渡すオプションを指定します。 オプションは「"」で囲んで"start"というように指定します。複数のオプションを指定するときは"--option1 --option2"というように指定します。あるいは、全体を「[]」で囲み、それぞれのオプションを「,」で区切り、["--option1", "--option2"]というように指定することもできます。 例: milter.command_options = "start" milter.command_options = ["--option1", "--option2"] 既定値: milter.command_options = nil |
|
milter.commandを実行するユーザ名を指定します。 ユーザ名は「"」で囲んで"nobody"というように指定します。root権限で実行する場合はnilを指定します。 例: milter.user_name = "nobody" 既定値: milter.user_name = nil |
|
子milterに接続したときのタイムアウト時間を秒単位で指定します。 例: milter.connection_timeout = 60 既定値: milter.connection_timeout = 297.0 |
|
子milterへデータを送信したときのタイムアウト時間を秒単位で指定します。 例: milter.writing_timeout = 15 既定値: milter.writing_timeout = 7.0 |
|
子milterからデータを受信するときのタイムアウト時間を秒単位で指定します。 例: milter.reading_timeout = 15 既定値: milter.reading_timeout = 7.0 |
|
子milterからxxfi_eom()のレスポンスを受信するときのタイムアウト時間を秒単位で指定します。 例: milter.end_of_message_timeout = 60 既定値: milter.end_of_message_timeout = 297.0 |
定義された子milterを操作するために便利な機能があります。ただし、これらの機能を利用するには多少Rubyの知識が必要になります。
定義されている子milter名の一覧を取得することができます。
define_milter("milter1") do |milter| ... end define_milter("milter2") do |milter| ... end defined_milters # => ["milter1", "milter2"]
これを利用することにより、すべての子milterの設定をまとめて変更するということが簡単にできるようになります。
以下はすべての子milterを無効にする例です。
defined_milters.each do |name| define_milter(name) do |milter| milter.enabled = false end end
以下はすべての子milterの定義を削除にする例です。無効にした場合と違い、再び子milterを使いたい場合は一から定義しなおす必要があります。
defined_milters.each do |name| remove_milter(name) end
以下はすべての子milterの適用条件にS25Rを追加する例です。
defined_milters.each do |name| define_milter(name) do |milter| milter.add_applicable_condition("S25R") end end
定義されている子milterの名前の一覧を返します。返される値は文字列の配列です。 例: defined_milters # => ["milter1", "milter2"] |
|
定義されているnameという名前のmilterを削除します。milter定義を削除せずに、単に無効にするだけでよいなら milter.enabled を使ってください。 例: # "milter1"という名前で定義されたmilterの定義を削除 remove_milter("milter1") |
組み込みの適用条件を説明します。
この適用条件を使うと、MTAっぽいSMTPクライアントには子milterを適用せず、一般PCっぽいSMTPクライアントにのみ子milterを適用します。
以下の例では一般PCっぽいSMTPクライアントにのみGreylistingを適用することで、Greylistingによる遅延の悪影響を軽減しています。これは Rgrey と呼ばれる手法です。(milter-greylistで"racl greylist default"と設定している場合)
使用例:
define_milter("milter-greylist") do |milter| milter.add_applicable_condition("S25R") end
SMTPクライアントが一般PCっぽいかどうかは S25R の一般規則を用います。
S25Rの一般規則は一般PC以外のホストにもマッチしてしまいます。そのため、明示的にホワイトリストを設定して誤検出を防ぐことができます。デフォルトではgoogle.comドメインのホストとobsmtp.comドメインのホストはS25Rの一般規則にマッチしても子milterを適用しません。
また、逆にS25Rの一般規則に規則を追加して例外的なホスト名に対応することもできます。
S25R適用条件は以下の設定でカスタマイズできます。
1.5.2から使用可能。
例えば、google.comドメインをホワイトリストに入れる場合は以下のようにします。 s25r.add_whitelist(/\.google\.com\z/) mx.example.comというホストをホワイトリストに入れる場合は以下のようにします。 s25r.add_whitelist("mx.example.com") [上級者向け] 複雑な条件を指定したい場合はブロックを指定することができます。ブロックにはホスト名が引数として渡されます。例えば、午前8:00から午後7:59までの間だけ.jpトップレベルドメインをホワイトリストに入れる場合は以下のようにします。 s25r.add_whitelist do |host| (8..19).include?(Time.now.hour) and /\.jp\z/ === host end |
|
1.5.2から使用可能。
例えば、evil.example.comドメインをブラックリストに入れる場合は以下のようにします。 s25r.add_blacklist(/\.evil\.example\.com\z/) black.example.comというホストをブラックリストに入れる場合は以下のようにします。 s25r.add_blacklist("black.example.com") [上級者向け] 複雑な条件を指定したい場合はブロックを指定することができます。ブロックにはホスト名が引数として渡されます。例えば、午後8:00から午前7:59までの間だけ.jpトップレベルドメインをブラックリストに入れる場合は以下のようにします。 s25r.add_blacklist do |host| !(8..19).include?(Time.now.hour) and /\.jp\z/ === host end |
|
1.6.6から使用可能。
例: s25r.check_only_ipv4 = false # IPv4以外のときもチェック 初期値: IPv4の場合のみチェックする |
この適用条件を使うと、外部ネットワークからアクセスしてきたSMTPクライアントにのみ子milterを適用します。
以下の例ではローカルネットワークからのメールにはスパムチェックを行わない事で誤検出を回避しています。
使用例:
define_milter("spamass-milter") do |milter| milter.add_applicable_condition("Remote Network") end
192.168.0.0/24などのプライベートIPアドレス以外を外部ネットワークとして扱います。プライベートIPアドレス以外もローカルネットワークとして扱いたい場合は以下の設定で追加することができます。
1.5.0から使用可能。 指定したIPv4/IPv6アドレスまたはIPv4/IPv6ネットワークをローカルネットワークに追加します。ローカルネットワークに追加したアドレス・ネットワークには子milterを適用しません。 使用例: # 160.29.167.10からのアクセスは子milterを適用しない remote_network.add_local_address("160.29.167.10") # 160.29.167.0/24のネットワークからのアクセスは子milterを適用しない remote_network.add_local_address("160.29.167.0/24") # 2001:2f8:c2:201::fff0からのアクセスは子milterを適用しない remote_network.add_local_address("2001:2f8:c2:201::fff0") # 2001:2f8:c2:201::/64からのアクセスは子milterを適用しない remote_network.add_local_address("2001:2f8:c2:201::/64") |
SMTP Authで認証済みのSMTPクライアントにのみ子milterを適用します。この適用条件を利用する場合は、MTAが認証関連のマクロをmilterに渡すようにしなければいけません。Sendmailは特に設定をする必要はありません。Postfixの場合は以下の設定を追加する必要があります。
main.cf:
milter_mail_macros = {auth_author} {auth_type} {auth_authen}
以下の例は認証済みのSMTPクライアントが送ったメール(内部から送信したメール)を監査用にBccする設定です。
使用例:
define_milter("milter-bcc") do |milter| milter.add_applicable_condition("Authentication") end
SMTP Authで認証されていないSMTPクライアントにのみ子milterを適用します。 Authentication と同様に、MTAが認証関連のマクロをmilterに渡すようにしなければいけません。
以下の例は認証されていないSMTPクライアントからのメールにのみスパムチェックを行い、誤検出を回避する設定です。
使用例:
define_milter("spamass-milter") do |milter| milter.add_applicable_condition("Unauthentication") end
この適用条件は少し変わっています。この適用条件を設定してもすべての子milterを適用します。では何をするのかというと、SendmailとPostfixのmilter実装の非互換を吸収し、Sendmailでしか動かないmilterをPostfixでも動くようにします。
SendmailとPostfixではmilterの実装に互換性がない部分があります。例えば、マクロ名が異なったり、マクロを渡すタイミングが異なったりします。
この適用条件を設定すると、それらの差異を吸収し、同じmilterがSendmailでもPostfixでも動作するようになります。ただし、最近のmilterはどちらでも動くように作られているのでこの適用条件が必要なくなる日は近いでしょう。これはとてもよいことです。
MTAがPostfixの場合にこの適用条件を設定しても悪影響はないので、安心してください。
以下の例はSendmail用にビルドしたmilter-greylistをPostfixでも使えるようにする設定です。
使用例:
define_milter("milter-greylist") do |milter| milter.add_applicable_condition("Sendmail Compatible") end
1.5.0から使用可能。
負荷に応じて動的に処理を変更する適用条件をいくつか提供しています。負荷は同時接続数で判断します。
1.5.0から使用可能。 負荷が高いと判断する同時接続数を返します。 Postfixを利用している場合はsmtpdの最大プロセス数を自動検出し、自動検出した最大プロセス数の3/4以上の同時接続数がある場合に負荷が高いと判断します。 Sendmailの場合は自動検出されないので、 stress.threshold_n_connections= で手動で設定する必要があります。 例: # Postfixのデフォルト設定の場合(環境によって異なる) stress.threshold_n_connections # => 75 |
|
stress.threshold_n_connections=(n) |
1.5.0から使用可能。 負荷が高いと判断する同時接続数を設定します。 0を指定すると常に負荷が低いと判断します。 例: # 同時接続数が75以上の場合、負荷が高いと判断 stress.threshold_n_connections = 75 |
1.5.0から使用可能。
負荷が小さいときのみ、子milterを適用する適用条件です。
以下の例は負荷が高いときはspamass-milterを適用しない設定です。
使用例:
define_milter("spamass-milter") do |milter| milter.add_applicable_condition("No Stress") end
1.5.0から使用可能。
負荷が高いときに"{stress}=yes"マクロを設定し、子milterに負荷が高いことを通知する適用条件です。この適用条件は通知するだけなので、設定しても常にすべての子milterは適用されます。
以下の例は負荷が高いときはmilter-greylistにマクロで通知をする設定です。
使用例:
define_milter("milter-greylist") do |milter| milter.add_applicable_condition("Stress Notify") end
milter-greylist側で「負荷が高いときはGreylisting、負荷が低いときはTarpittingを使う」設定は以下のようになります。この設定を使う場合はmilter-greylist 4.3.4以降が必要です。
greylist.conf:
sm_macro "no_stress" "{stress}" unset racl whitelist sm_macro "no_stress" tarpit 125s racl greylist default
1.6.0から使用可能。
信用できるセッションには「trusted_XXX=yes」というマクロを設定します。設定されるマクロの一覧は以下の通りです。
以下は信用するドメインに対しては、SPFの検証が成功したらそのまま受信し、失敗したらGreylistを適用する例です。
milter-manager.local.conf:
define_milter("milter-greylist") do |milter| milter.add_applicable_condition("Trust") end
greylist.conf:
sm_macro "trusted_domain" "{trusted_domain}" "yes" racl whitelist sm_macro "trusted_domain" spf pass racl greylist sm_macro "trusted_domain" not spf pass
どの情報を使って信用するかどうかを判断するかは、以下の設定を使ってカスタマイズできます。
ここからは本格的にRubyの知識が必要になります。標準でS25Rなどの有用な適用条件は用意されています。それらで十分ではない場合は、適用条件を定義することができます。適用条件を定義することにより、子milterを適用するかを動的に判断することができます。
適用条件は以下の書式で定義します。適用条件の定義にはRubyの知識が必要になります。
define_applicable_condition("名前") do |condition| condition.description = ... condition.define_connect_stopper do |...| ... end ... end
例えば、S25Rを実現する適用条件は以下のようになります。
define_applicable_condition("S25R") do |condition| condition.description = "Selective SMTP Rejection" condition.define_connect_stopper do |context, host, socket_address| case host when "unknown", /\A\[.+\]\z/, /\A[^.]*\d[^\d.]+\d.*\./, /\A[^.]*\d{5}/, /\A(?:[^.]+\.)?\d[^.]*\.[^.]+\..+\.[a-z]/i, /\A[^.]*\d\.[^.]*\d-\d/, /\A[^.]*\d\.[^.]*\d\.[^.]+\..+\./, /\A(?:dhcp|dialup|ppp|[achrsvx]?dsl)[^.]*\d/i false else true end end end
名前解決ができなかったときはhostは"unknown"ではなく、"[IPアドレス]"になります。そのため、本当は"unknown"は必要なく、/\A\[.+\]\z/で十分ですが、念のため入れています。 :-)
define_applicable_condition do ... end内で設定できる項目は以下の通りです。
必須の項目はありません。
子milterを適用するかどうかを判断する時点での様々な情報を持ったオブジェクトです。(クラスはMilter::Manager::ChildContextです。)
以下の情報を持っています。
子milterの名前です。define_milterで使った名前になります。 例: context.name # -> "clamav-milter" |
|
context[name] |
子milterが利用可能なマクロの値を返します。libmilterのAPIでは1文字より長いマクロ名の場合は「{}」で囲まなければいけませんが、context[]では囲んでも囲まなくてもどちらでも構いません。 例: context["j"] # -> "mail.example.com" context["rcpt_address"] # -> "receiver@example.com" context["{rcpt_address}"] # -> "receiver@example.com" |
子milterがrejectを返したときにtrueを返します。子milterは milter.evaluation_mode を有効にしてください。 引数として渡ってくるcontextは処理中のため、context.reject?がtrueを返すことはありません。context.children[]で取得した別の子milterの結果を利用するときに有用です。 例: context.reject? # -> false context.children["milter-greylist"].reject? # -> true or false |
|
子milterがtemporary failureを返したときにtrueを返します。子milterは milter.evaluation_mode を有効にしてください。 引数として渡ってくるcontextは処理中のため、context.temporary_failure?がtrueを返すことはありません。context.children[]で取得した別の子milterの結果を利用するときに有用です。 例: context.temporary_failure? # -> false context.children["milter-greylist"].temporary_failure? # -> true or false |
|
子milterがacceptを返したときにtrueを返します。 引数として渡ってくるcontextは処理中のため、context.accept?がtrueを返すことはありません。context.children[]で取得した別の子milterの結果を利用するときに有用です。 例: context.accept? # -> false context.children["milter-greylist"].accept? # -> true or false |
|
子milterがdiscardを返したときにtrueを返します。子milterは milter.evaluation_mode を有効にしてください。 引数として渡ってくるcontextは処理中のため、context.discard?がtrueを返すことはありません。context.children[]で取得した別の子milterの結果を利用するときに有用です。 例: context.discard? # -> false context.children["milter-greylist"].discard? # -> true or false |
|
子milterの処理が終了している場合にtrueを返します。 引数として渡ってくるcontextは処理中のため、context.quitted?は常にfalseです。context.children[]で取得した別の子milterの結果を利用するときに有用です。 例: context.quitted? # -> false context.children["milter-greylist"].quitted? # -> true or false |
|
別の子milterのcontextを取得します。 別の子milterを参照するときに利用する名前はdefine_milterで使った名前(context.nameで取得できる名前)になります。 存在しない名前で参照しようとした場合はnilが返ります。 例: context.children["milter-greylist"] # -> milter-greylistのcontext context.children["nonexistent"] # -> nil context.children[context.name] # -> 自分のcontext |
|
MTAがPostfixの場合に真を返します。Postfixかどうかは「v」マクロの値に「Postfix」という文字列が含まれるかどうかで判断します。 Postfixの場合はtrue、そうでない場合はfalseが返ります。 例: context["v"] # -> "Postfix 2.5.5" context.postfix? # -> true context["v"] # -> "2.5.5" context.postfix? # -> false context["v"] # -> nil context.postfix? # -> false |
|
送信元が認証されている場合に真を返します。認証されているかどうかは「auto_type」マクロか「auth_authen」マクロの値があるかで判断します。これらのマクロはMAIL FROM以降でのみ使えるので、それ以前の場合は常に偽を返します。Postfixの場合はmain.cfに以下を追加することを忘れないで下さい。 milter_mail_macros = {auth_author} {auth_type} {auth_authen} 認証されている場合はtrue、そうでない場合はfalseが返ります。 Example: context["auth_type"] # -> nil context["auth_authen"] # -> nil context.authenticated? # -> false context["auth_type"] # -> "CRAM-MD5" context["auth_authen"] # -> nil context.authenticated? # -> true context["auth_type"] # -> nil context["auth_authen"] # -> "sender" context.authenticated? # -> true |
IPv4ソケットのアドレスを表現するオブジェクトです。以下のメソッドを持ちます。
ドット表記のIPv4アドレスを返します。 例: socket_address.address # -> "192.168.1.1" |
|
ポート番号を返します。 例: socket_address.port # -> 12345 |
|
connection_specと同じ書式で表現したIPv4アドレスを返します。 例: socket_address.to_s # -> "inet:12345@[192.168.1.1]" |
|
プライベートなネットワークのアドレスの場合はtrueを返します。 例: socket_address.to_s # -> "inet:12345@[127.0.0.1]" socket_address.local? # -> true socket_address.to_s # -> "inet:12345@[192.168.1.1]" socket_address.local? # -> true socket_address.to_s # -> "inet:12345@[160.XXX.XXX.XXX]" socket_address.local? # -> false |
|
対応するIPAddrオブジェクトを返します。 例: socket_address.to_s # -> "inet:12345@[127.0.0.1]" socket_address.to_ip_address # -> #<IPAddr: IPv4:127.0.0.1/255.255.255.255> |
IPv6ソケットのアドレスを表現するオブジェクトです。以下のメソッドを持ちます。
address |
コロン表記のIPv6アドレスを返します。 例: socket_address.address # -> "::1" |
port |
ポート番号を返します。 例: socket_address.port # -> 12345 |
to_s |
connection_specと同じ書式で表現したIPv6アドレスを返します。 例: socket_address.to_s # -> "inet6:12345@[::1]" |
local? |
プライベートなネットワークのアドレスの場合はtrueを返します。 例: socket_address.to_s # -> "inet6:12345@[::1]" socket_address.local? # -> true socket_address.to_s # -> "inet6:12345@[fe80::XXXX]" socket_address.local? # -> true socket_address.to_s # -> "inet6:12345@[2001::XXXX]" socket_address.local? # -> false |
to_ip_address |
対応するIPAddrオブジェクトを返します。 例: socket_address.to_s # -> "inet6:12345@[::1]" socket_address.to_ip_address # -> #<IPAddr: IPv6:0000:0000:0000:0000:0000:0000:0000:0001/ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff> |
UNIXドメインソケットのアドレスを表現するオブジェクトです。以下のメソッドを持ちます。
ソケットのパスを返します。 例: socket_address.path # -> "/tmp/local.sock" |
|
to_s |
connection_specと同じ書式で表現したUNIXドメインソケットアドレスを返します。 例: socket_address.to_s # -> "unix:/tmp/local.sock" |
local? |
常にtrueを返します。 例: socket_address.local? # -> true |
to_ip_address |
常にnilを返します。 例: socket_address.to_s # -> "unix:/tmp/local.sock" socket_address.to_ip_address # -> nil |
1.6.6から使用可能。
データベース操作機能を利用する場合はRubyの知識が必要になります。データベース操作ライブラリとして ActiveRecord を採用しています。そのため、MySQLやSQLite3など多くのRDBを操作することができます。
データベース接続機能を利用する場合はActiveRecordを別途インストールする必要があります。ActiveRecordのインストールにはRuby用のパッケージ管理システム RubyGems を用います。RubyGemsとActiveRecordのインストール方法は インストール ページにあるインストールドキュメントのうち、「(任意)」の方のインストールドキュメントを参照してください。それぞれの環境でのRubyGemsとActiveRecordのインストール方法とを説明しています。
ActiveRecordをインストールしたらデータベース操作機能を利用することができます。
MySQLのusersテーブルの値を操作する場合の例を示します。
MySQLの接続情報は以下の通りとします。
まず、この接続情報をmilter-manager.local.confで指定します。ここでは、milter-manager.local.confは/etc/milter-manager/milter-manager.local.confにあるとします。
/etc/milter-manager/milter-manager.local.conf:
database.type = "mysql2" database.name = "mail-system" database.user = "milter-manager" database.password = "secret"
次に、usersテーブルに接続するためのActiveRecrodオブジェクトを定義します。定義ファイルはmilter-manager.local.confが置いてあるディレクトリと同じパスにあるmodels/ディレクトリ以下に置きます。今回はusersテーブル用の定義ファイルなのでmodels/user.rbを作成します。
/etc/milter-manager/models/user.rb:
class User < ActiveRecord::Base end
これで準備は整ったので、再び、milter-manager.local.confへ戻ります。以下のように書いてデータベースへ接続し、データを操作します。
/etc/milter-manager/milter-manager.local.conf:
database.setup database.load_models("models/*.rb") User.all.each do |user| p user.name # => "alice", "bob", ... end
まとめると以下のようになります。
/etc/milter-manager/milter-manager.local.conf:
# 接続情報設定 database.type = "mysql2" database.name = "mail-system" database.user = "milter-manager" database.password = "secret" # 接続 database.setup # 定義を読み込み database.load_models("models/*.rb") # データを操作 User.all.each do |user| p user.name # => "alice", "bob", ... end
/etc/milter-manager/models/user.rb:
class User < ActiveRecord::Base end
以下は設定項目です。
データベースの種類を指定します。 指定可能な種類は以下の通りです。
例: database.type = "mysql2" # MySQLを利用 |
|||||||
接続するデータベース名を指定します。
SQLite3ではデータベースのパスまたは
例: database.name = "configurations" # configurationsデータベースへ接続 |
|||||||
接続するデータベースサーバのホスト名を指定します。 MySQLなどでは規定値として"localhost"を利用します。 SQLite3では無視されます。 例: database.host = "192.168.0.1" # 192.168.0.1で動いているサーバへ接続 |
|||||||
接続するデータベースサーバのポート番号を指定します。 それぞれのRDBごとに規定値が設定されているため、多くの場合、明示的に指定する必要はありません。 SQLite3では無視されます。 例: database.port = 3306 # 3306番ポートで動いているサーバへ接続 |
|||||||
接続するデータベースサーバのUNIXドメインソケットのパスを指定します。 SQLite3の場合はデータベースのパスになります。ただし、 .#database.name の設定の方が優先されるため、 .#database.path ではなく、 .#database.name を使うことを推奨します。 例: database.path = "/var/run/mysqld/mysqld.sock" # UNIXドメインソケットでMySQLへ接続 |
|||||||
データベース接続ユーザを指定します。 SQLite3では無視されます。 例: database.user = "milter-manager" # milter-managerユーザでサーバへ接続 |
|||||||
データベース接続時に使うパスワードを指定します。 SQLite3では無視されます。 例: database.password = "secret" |
|||||||
1.6.9から使用可能。
追加のオプションを指定します。例えば、ActiveRecordのMySQL2アダプタにある
database.type = "mysql2" database.extra_options[:reconnect] = true 指定できるオプションはデータベース毎に異なります。 例: database.extra_options[:reconnect] = true |
|||||||
データベースへ接続します。 この時点ではじめてデータベースへ接続します。この後からデータベースを操作できるようになります。 例: database.setup |
|||||||
ActiveRecord用のクラス定義が書かれたRubyスクリプトを読み込みます。
例: # /etc/milter-manager/models/user.rb # /etc/milter-manager/models/group.rb # などを読み込む。 # (/etc/milter-manager/milter-manager.confを使っている場合) database.load_models("models/*.rb") |