Apache Moduleのフック関数リスト

モジュールを使うと、いろいろ面白いことができるのですが、いかんせん資料が少ないのが難しいところ。

ということで、少しずつですが、モジュール作りに役立つ情報を載せていこうと思います。

[2021年6月6日追記]Apache 2.4.48で追加された、ssl_add_cert_files, ssl_add_fallback_cert_files, ssl_answer_challenge, ssl_conn_is_ssl, ssl_ocsp_get_resp_hook, ssl_ocsp_prime_hook, ssl_var_lookupの各フック関数を追加しました。

モジュールで使えるフック関数の一覧

Apache HTTPD Webサーバの利点は、自分でモジュールを作りやすいこと。

ということで、モジュールで何ができるのかを知るために、利用できるフック関数の一覧を出してみます。

このフック関数から得られる情報を元に、Webサーバに所望の動作をさせることができます。

ソースを展開した後に、展開したディレクトリに入った後に、以下のコマンドを打つと、フック可能な関数の一覧が出てきます。

# perl support/list_hooks.pl

とコマンドを打つと、モジュールで利用できるフック関数の一覧が出てきます。

フック関数は、返値を返さないVOIDタイプと、返値を返すRUN_FIRSTタイプとRUN_ALLタイプの3種類あります。

VOIDタイプのフック関数は、ロードされたモジュールの同名のフック関数が、全て呼ばれます。

一方、RUN_FIRSTタイプとRUN_ALLタイプのフック関数は、とロードされたモジュールのすべての同名のフック関数が呼ばれるとは限りません。

RUN_FIRSTタイプは、フック関数が「DECLINE（辞退）」を返すと、次のモジュールの同名のフック関数を呼びます。つまり、エラーが帰るか、「OK（成功）」が返るとそれ以上、他のモジュールの同名のフック関数を呼び出しません。

一つのモジュールで成功すれば、他のモジュールでの処理が必要無いフック関数で使用されます。

RUN_ALLタイプは、フック関数が「DECLINE（辞退）もしくは、「OK（成功）」を返すと、次のモジュールの同名のフック関数を呼びます。つまり、エラーが帰ると、他のモジュールの同名のフック関数を呼び出しません。

全てのモジュールが、エラー無く実行する必要のあるいフック関数で使用されます。

どのフック関数がどの順番で呼び出されるかは、以下のページの「Hook and Filter log」を参考にしてください。

httpd-2.4.33の場合、表にしてみると、以下のようになります。

となります。