DSAS開発者の部屋

まず，今回のモジュールのソースコードを次に示します(apxs -g -n denyrandomとして出力したものをベースにしています)．

  #include "httpd.h"

  #include "http_config.h"

  #include "http_protocol.h"

  #include "ap_config.h"



  #include "http_log.h"

  #include "apr_time.h"



  #define RATE 10



  static int denyrandom(request_rec *r){

      int msec = apr_time_msec(r->request_time);

      if(msec % RATE){

          ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r, "deny: msec = %d", msec);

          return HTTP_FORBIDDEN;

      }



      ap_log_rerror(APLOG_MARK, APLOG_DEBUG, 0, r, "allow: msec = %d", msec);

      return OK;

  }



  static void denyrandom_register_hooks(apr_pool_t *p)

  {

      ap_hook_access_checker(denyrandom, NULL, NULL, APR_HOOK_MIDDLE);

  }



  /* Dispatch list for API hooks */

  module AP_MODULE_DECLARE_DATA denyrandom_module = {

      STANDARD20_MODULE_STUFF,

      NULL,                  /* create per-dir    config structures */

      NULL,                  /* merge  per-dir    config structures */

      NULL,                  /* create per-server config structures */

      NULL,                  /* merge  per-server config structures */

      NULL,                  /* table of config file commands       */

      denyrandom_register_hooks  /* register hooks                      */

  }; 

さて，前回のモジュールで hook 登録するのに使った関数は ap_hook_handler() でしたが，今回のは ap_hook_access_checker() になっています．これは mod_access が使うのと同じ hook 登録関数です．hook 登録関数は前回の記事の最後に示した参考文献にもあるように何種類かありますが，引数の数と種類は全て同じです(実は，ap_hook_ という名前で始まるこれらの関数定義は，全てマクロで生成されています)．これら hook登録関数の引数の意味は順に

 ap_hook_***(func, pre, suc, pos);

func

登録する hook 関数

pre

ここで登録する hook 関数より前に実行されているべきモジュールのリスト

suc

ここで登録する hook 関数より後に実行されているべきモジュールのリスト

pos

ここで登録する hook 関数を実行する大体の位置．始めの方か後の方か真ん中か

 static const char * const pre[] = {

   "mod_access.c"

   NULL

 };

• APR_HOOK_REALLY_FIRST


• APR_HOOK_FIRST


• APR_HOOK_MIDDLE


• APR_HOOK_LAST


• APR_HOOK_REALLY_LAST

さて今回のモジュールの本体である denyrandom() ですが，この関数の目的はランダムにアクセスを拒否する，です．はじめは rand_r() 関数(srand() と rand() をいっぺんにやってくれる関数です．srand() と rand() の組み合わせはスレッドセーフじゃないので，マルチスレッドで動作する Apache のモジュールでは使えません)を使おうかと思い，そのための seed に使えるものを探してみました．rand_r() は疑似ランダム関数ですので，seed が固定では意味がありませんからリクエスト毎に異なる整数値を… と request_rec 構造体の中を見てました．

この request_rec 構造体は httpd.h で定義されている，現在のリクエスト情報とそれを処理するための情報，そしてレスポンスの情報を保持する構造体で，リクエスト毎に作成されます．この構造体のメンバに関しては，今後の記事の中で出てくる度に説明を書いていきますが，気になる方は中身を見てみてください．Web 上でしたらこちらに置いてありました．(蛇足ですが，このサイトで Apache の中身を解説してる blog が公開されていました．filter や handler を書く上で重要な bucket brigade や，メモリ管理機構などに関して，その実装も参照しつつ詳細に解説されていますので，module を書こうという方は一読されることをおすすめします．)
さて肝心の seed ですが，丁度良さそうな request_time という変数を見つけました．コメントによれば，これは「リクエスト開始時の時間」だそうです．中身は UNIX 時間の開始からのマイクロ秒になっています．これを seed にして疑似乱数を得よう，と思いましたが，良くよく考えてみたら別にわざわざ疑似乱数を計算するまでもなく，この値をそのまま使えば良いことに気づきました．

ということで，request_time から整数値を得る必要があります．request_time の型は apr_time_t になっていますが，実際のところは 64bit の整数値のようです．このマイクロ秒をそのまま使っても良いのですが，もうちょっと人間がコントロールしやすそうな単位のミリ秒に変換することにしました．手で変換しても良いのですが，何か用意されていないか探してみたところ，apr_time.h の中にミリ秒を返してくれる apr_time_msec() マクロがありました．
今回のモジュールでは，このリクエスト(の処理)が開始された時間のミリ秒を 10(RATE マクロ)で割った余りが 0 の場合アクセスを許可し，それ以外の場合は拒否することにします(13行目の if文です)．アクセスを拒否する場合は，返値として HTTP_FORBIDDEN を返します(15行目)．これは httpd.h で定義されたマクロです．この他に，HTTP の各ステータスコードに相当する値が一通り定義されています．許可する場合は HTTP_OK ではなく OK を返します．HTTP_OK を返さないのは，他のモジュールでの判断が入る可能性があるので，このモジュールの判断は OK だよ，と返すわけです．

アクセスを許可する場合も拒否する場合も，ap_log_rerror() を呼び出しています．これはその名前の通り，エラーログを出力する関数です．ErrorLog ディレクティブで指定した先にログが出力されます．この関数は http_log.h で定義されていて，次のような形で呼び出します．

   ap_log_rerror(APLOG_MARK, level, status, r, fmt, args...); 

APLOG_MARK

マクロです．実際にはファイル名と行番号に展開されます．何も考えずにこれを指定してください

level

ログのレベルです．こでは APLOG_DEBUG を指定しています．低い方から順に，_DEBUG, _INFO, _NOTICE, _WARNING, _ERR, _CRIT, _ALERT, _EMERG が定義されてます

status

他の関数呼び出しで報告されたエラー情報を指定します．特になければ 0 を指定しておきます

r

request_rec 構造体のポインタを渡します

fmt

printf 形式で，出力フォーマットを指定します

args...

fmt に対する引数です

ap_log_cerror()

request_req* の代わりに conn_rec* を取る．コネクション単位の処理時に使用する．

ap_log_error()

request_req* の代わりに server_rec* を取る．ディレクティブの設定時に使用する．

ap_log_perror()

request_req* の代わりに apr_pool_t* を取る．それ以外の処理時に使用する．

中身が分かったところで，実際に動かしてみましょう．ただし，後で理由を述べますが，くれぐれも何かに実用していて自分以外の人も使っているサーバには組み込まないでください．今回のモジュールのソースはこちらに置いてます．前回の記事で説明したように，apxs コマンドを使って

 apxs -c -i -a mod_denyrandom.c

 [Fri Jul 14 13:49:40 2006] [debug] mod_denyrandom.c(18): [client 127.0.0.1] allow: msec = 120

 [Fri Jul 14 13:49:41 2006] [debug] mod_denyrandom.c(14): [client 127.0.0.1] deny: msec = 498

さて今回のモジュールでは，httpd.conf にはモジュールを読み込む設定(LoadModule)は(apxs コマンドで)追加しましたが，前回の SetHandler のような，このモジュールと実際のリクエストとの結びつけを指定していません．実は，このモジュールを組み込んだ Apache が処理する全てのリクエストがこのモジュールのアクセス制御判断を受けます ＝ denyrandom()が起動されます．VirutalServer を設定している場合でも，全 VirtualServer に適用されます(なので，実用している Apache にこのモジュールを組み込むと簡単に障害になります (^^;)．つまり，どのリクエストに対して動作するべきか，というのは Apache 側が判断するのではなくて，モジュール側が判断する必要があるのです．では何を基準にその判断をするのか，というのは次の稿のテーマとしたいと思います．