dbus-broker(1) — Arch manual pages(日本語訳)

名前

dbus-broker - D-Bus メッセージ・ブローカーである。(D-Bus メッセージを仲介するアプリケーションである。)

書式

dbus-broker [ OPTIONS ]
dbus-broker --version
dbus-broker --help

説明

dbus-broker は、D-Bus メッセージ・バス仕様[1]の実装の１つである。各インスタンスは単一の、独立した(unique)メッセージ・バスを提供し、クライアントはこれに接続したり、これを通じてメッセージを送信したりすることができる。このブローカーは、D-Bus 仕様に基いて、メッセージの中継処理、アクセス制御、(シグナル等の)購読処理(subscription)、及びバスの制御を行う。

dbus-broker は「純粋な」(pure)実装であり、メッセージの中継処理しか実装していない。dbus-broker は自身を制御するプロセスを必要としており、このプロセスがバスの設定と全ての外部通信を実行する。dbus-broker-launch(1) は、そのようなコントローラーの１つであり、D-Bus の参考実装である dbus-daemon(1) との完全な互換性を持つよう狙って開発されている。メッセージ・バスを起動する方法については dbus-broker-launch(1) を見よ。

このマニュアル・ページは、dbus-broker とそのコントローラー(例えば dbus-broker-launch(1))との間のインターフェイスについても記述している。

オプション

以下のコマンド・ライン・オプションを使用することができる。ここに挙げられていないオプションを渡した場合、このブローカーは起動を拒否し、エラーで終了する。

-h, --help

使用方法を表示して直ちに終了する。

--version

ビルドのバージョン(build-version)を表示して直ちに終了する。

--audit

Linux の監査サブシステムへログを記録する機能を有効にする。監査機能がコンパイル時に組み込まれていなければ何も行わない。デフォルトでは無効である。

--controller=FD

指定された番号のファイル記述子を親プロセスから継承して制御用ソケットとして使用する。コントローラーの節を参照。このオプションの指定は必須である。

--log FD

指定された番号のファイル記述子を親プロセスから継承し、これを使ってシステム・ログにアクセスする。ログ収集の節を参照。デフォルトではログ収集は行わない。

--machine-id=ID

このブローカーがインターフェイス org.freedesktop.DBus を介して弘報することになるマシン ID を設定する。このオプションの指定は必須であり、通常は /etc/machine-id から得たものを使用する。

--max-bytes=BYTES

このブローカーにおいて各ユーザが割り当てを受けられるバイト数の最大値。デフォルトは 16 MiB。

--max-fds=FDS

このブローカーにて各ユーザが割り当てを受けられるファイル記述子の個数の最大値。デフォルトは 64。

--max-matches=MATCHES

このブローカーにて各ユーザが割り当てを受けられるマッチ規則の個数の最大値。デフォルトは 16k。

--max-objects=OBJECTS

このブローカーにて各ユーザが割り当てを受けられる資源(名前、ピア(peer)、未送信のリプライ(返答)など)の合計数の最大値。デフォルトは 16k。

コントローラー(controller)

dbus-broker の全てのインスタンスは、unix(7) ソケット１つを自身の親プロセスから引き継ぐ。このソケットはオプション --controller を使って必ず指定しなければならない。ブローカーはこのソケットを使って自身の親プロセス(あるいはこのソケットの反対側を所有する者、即ち「コントローラー」(The Controller))から制御コマンドを受け取る。このソケットは通常の D-Bus P2P 通信を用いる。このソケットで提供されるインターフェイスについては API の節で述べる。

初期状態では、ブローカーのインスタンスはアイドル状態である。別の言い方をすると、ブローカーを fork して exec した直後は、ブローカーの「管理すべきバス・ソケット」のリストは空であり、クライアントがブローカーに接続する術は無いということである。コントローラーは、コントローラー・インターフェイスを使って、待ち受けソケット(listener socket)を作成し、バス・ポリシーを指定し、アクティベート可能な名前を作成し、バス・イベントに対応しなければならない。

dbus-broker プロセスは、コマンド・ラインもしくはコントローラー・インターフェイスを通じて渡されたものを除き、外部の資源には一切アクセスしない。すなわち、このブローカーは、ファイル・システムへのアクセス、nss(5) の呼び出し、外部プロセスとの通信を一切行わない。それどころか、このブローカーは、コントローラーから渡されたソケット以外には、いかなる資源にもアクセスしない。これは実装によって保証されていることである。これは同時に、外部資源の獲得や外部通信が必要な場合、コントローラーがブローカーのためにそれらを全て実行する必要があるということをも意味する。

ログ収集

コマンド・ライン・オプション「--log」を使ってログ収集用の FD (ファイル記述子)を指定した場合、ブローカーはこの FD を通じて情報を記録することになる。利用できるログは２種類存在する。

1.

指定した FD が unix(7) SOCK_STREAM ソケットである場合、情報は人間にも読みやすい、行を単位とするデータで記録される。

2.

指定した FD が unix(7) SOCK_DGRAM ソケットである場合、情報は、鍵/値の対を単位とする註釈付きデータ・ブロックで記録される。この形式は、systemd-journal で使用される形式と互換性がある(但し systemd に依存しているわけではない)。この鍵/値の対を単位とするログ・データは、ストリームに基く(訳註：行を単位とする)ログ・データよりもはるかに詳細である。個別の鍵を用いて多くのメタデータが提供されるため、記録されたデータの正確な追跡や解釈が可能である。

ブローカーには、データを記録する際の厳格な決まりがある。ブローカーは、起動時と終了時に１つづつ、自身の設定と環境に関する情報の入ったメッセージを記録する。実行中には、ブローカーは予期せぬ状況が起きた場合にしかログを取らない。すなわち、ブローカーが実行時にログを取ったメッセージは全て、不具合のあるクライアントが引き起こしたものである。システムが適切に設定されていれば、実行時のログ・メッセージは一切発生しない。

ブローカーがログを取るのは次の場合である。

1.

起動時と終了時、ブローカーは、自身のコントローラー、自身の環境、及び自身の設定に関するメタデータの入った短いメッセージを１つ記録する。

2.

クライアント・リクエストがポリシーによって拒否される度にメッセージを１つ記録する。このメッセージには、影響を受けるクライアントとポリシーに関する情報も含まれる。

3.

クライアントが自身に割り当てられた資源量を超過する度にメッセージを１つ記録する。このメッセージには、同クライアントの情報が含まれる。

API

ブローカーは、以下に挙げる各ノードにおいて、それぞれ下記のインターフェイスを実装する。コントローラーはいつでもこれらのインターフェイスを呼び出すことができる。コントローラーの接続は信頼できるものと見做される。資源の勘定やアクセス制御は行わない。

コントローラー自身も、ブローカーが使用するインターフェイスを実装する必要がある。コントローラー側のインターフェイスの一覧は後の節で述べる。

コントローラー自身も、以下に挙げるノードにおいて、下記のインターフェイスを実装する必要がある。このインターフェイスは、D-Bus 仕様で定義されているドライバ・インターフェイスの一部を実装するために、ブローカーによって呼び出される。

ブローカーが実行する全てのメソッド・コールは常にまるまる非同期であることに注意。すなわち、どれだけリクエストの処理に時間が掛かっても、ブローカーは依然として問題なく動作している状態であり、同者はさらなるリクエストをコントローラーへ送信することすら可能であるということである。

コントローラーは、このようなメソッド・コールをブロッキング(blocking)する形で実装してもよい。しかしながら、(どのような手段によるにせよ)ブロッキングを伴い且つブローカーへと戻っていくような再帰的な呼び出しを実行しないようにするのは、コントローラーの責任である。

関連項目

dbus-broker-launch(1) dbus-daemon(1)

注意

[1]

D-Bus 仕様: https://dbus.freedesktop.org/doc/dbus-specification.html