DSAS開発者の部屋

モジュールが，というよりも厳密には各種 hook が，呼び出された際に処理をするべきか否かの判断は，大体の場合そのモジュール用の設定ディレクティブが設定ファイル(httpd.conf)にあるか否かで行います．handler の場合は前々回の記事でも出てきたように，汎用の handler 指定用のディレクティブがあります．(hook ではないですが) filter も，Input/Output filter のための設定用ディレクティブがそれぞれあります．もちろん，必ずこれらのディレクティブを使わなければならない，という訳ではありません．handler や filter の指定はそれを実装しているモジュール以外からでも指定できます．
今回のモジュールが登録する hook はアクセス制御用のものですので，汎用の設定ディレクティブはありません．ですので，専用のディレクティブを登録して，設定ファイル中にそのディレクティブがあれば処理をする形にします．このディレクティブでは，先のコードの RATE マクロで規定していた，アクセスを許可する確率を設定することにします．
前回のコードにディレクティブ処理関連のコードを追加したものを次に示します．またファイルとしてこちらに置いていますので，試される方はご自由にお使い下さい．

  #include "httpd.h"
  #include "http_config.h"
  #include "http_protocol.h"
  #include "ap_config.h"

  #include "http_log.h"
  #include "apr_time.h"
  #include <stdlib.h>

  module AP_MODULE_DECLARE_DATA denyrandom_module;

  static int denyrandom(request_rec *r){
      int msec = apr_time_msec(r->request_time);
      int *rate = (int *)ap_get_module_config(r->per_dir_config, &denyrandom_module);

      if(*rate < 1)
          return DECLINED;

      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 *create_dir_config(apr_pool_t *p, char *dir){
      int *rate = (int *)apr_palloc(p, sizeof(int));
      *rate = 0;
      return (void *)rate;
  }

  static const char *set_rate(cmd_parms *cmd, void *_rate, const char *s_rate){
      int *rate = (int *)_rate;

      *rate = atoi(s_rate);

      if(*rate < 1)
          return "specify natural number for rate";

      return NULL;
  }

  static const command_rec cmds[] = {
      AP_INIT_TAKE1("SetAllowrate",
                    set_rate,
                    NULL,
                    OR_LIMIT,
                    "specify deny access rate"),
      {NULL}
  };

  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,
      create_dir_config,         /* create per-dir    config structures */
      NULL,                      /* merge  per-dir    config structures */
      NULL,                      /* create per-server config structures */
      NULL,                      /* merge  per-server config structures */
      cmds,                      /* table of config file commands       */
      denyrandom_register_hooks  /* register hooks                      */
  }; 

まず cmds[](45行目) に関して．これはこのモジュールが処理するディレクティブを Apache に登録するための配列です．AP_INIT_XXX() というマクロを使ってこのモジュール用のディレクティブ名とそれを処理する関数などを登録します．ご覧のように NULL ターミネートします．XXX の部分はディレクティブが取る引数のパターンによって何種類か定義されています．AP_INIT_TAKE1() の場合，ディレクティブは引数を一つだけ取ることができます．他の AP_INIT_XXX() に関しては長くなるので別の記事でまとめることにします．
AP_INIT_TAKE1() の引数の意味は次のようになっています．

 AP_INIT_TAKE1(directive, func, info, where, help)

directive

設定ファイル中で用いるディレクティブの名前．char *型．大文字小文字は無視されます．

func

ディレクティブ処理用の関数を指定すします．関数の型は，AP_INIT_XXX の種類によって変わります．AP_INIT_TAKE1()の場合については set_rate() の説明の中で述べます．

info

func() を呼び出す時に渡す情報．void *型．特に渡すものがなければ NULL を指定します．

where

このディレクティブが現れてよい場所の指定．int型．指定できる値の種類は次に述べます．

help

このディレクティブに関する説明．char *型．使用時にフォーマットが間違っていた場合に表示されます．

OR_LIMIT

httpd.conf内の <Directory> か <Location> の中か， AllowOverride Limit が指定されていれば .htaccess の中．このタイプのディレクティブの例として，Allow や Deny があります．

OR_OPTIONS

httpd.conf の中か，AllowOverride Options が指定されていれば .htaccess の中．このタイプのディレクティブの例として，XBitHack や CheckSpelling があります．

OR_FILEINFO

httpd.conf の中か，AllowOverride FileInfo が指定されていれば .htaccess の中．このタイプのディレクティブの例として，SetEnvIf や Header があります．

OR_AUTHCFG

httpd.conf 内の <Directory> か <Location> の中か，AllowOverride AuthConfig が指定されていれば .htaccess の中．このタイプのディレクティブの例として，AuthName や AuthDigestFile があります．

OR_INDEXES

httpd.conf の中か，AllowOverride Indexes が指定されていれば .htaccess の中．

OR_ALL

OR_XXX の条件の内いずれかを満たしている箇所．

ACCESS_CONF

httpd.conf 内の <Directory> か <Location> の中．

RSRC_CONF

httpd.conf 内の <Directory> 及び <Location> の外．

EXEC_ON_READ

httpd.conf の内容を実質的に変更するようなディレクティブの場合指定します．このタイプのディレクティブの例として，IFModule や IfVersion があります．

次に，ディレクティブで設定する値を保持するための領域を確保するための create_dir_config() 関数を見てみます．名前からも分かるとおり，ディレクトリ毎の設定保持用の領域を確保するためのものです．この関数自体は，62行目で denyrandom_module を通して Apache に登録されます．引数は apr_pool_t 型のポインタと char 型のポインタをもらいます．前者に関しては後述します．後者はどのディレクトリ用の設定領域を確保するかを示す文字列が渡されます．具体的には <Directory> や <Location> ディレクティブの引数の文字列がそのまま渡されます．さてこの関数で確保する設定保持用の領域ですが，大概のモジュールでは複数の値を保持するために設定データの保持用の構造体を定義して，1つまたは複数のディレクティブで設定された値をその構造体に保存します．けれども今回のモジュールでは整数値1つを保持しておけばいいので，構造体は定義せずに int 型の変数一つで済ませています．設定保持用のデータ領域はヒープから確保しますが，malloc を使うのではなく apr_palloc() という関数を使っています(※)．
apr_palloc() の第一引数は apr_pool_t型で，create_dir_config() の第一引数として渡されたものを使います．apr_pool_t 型の変数はモジュール内の関数が Apache から呼び出される際に直接的或いは間接的に渡されます．それを apr_palloc() に渡して確保したメモリは，それぞれの場面に適したライフサイクルを持ちます．ですので，確保したメモリを明示的に解放する必要はありません．
データ領域が確保できればそれを 0 に初期化して，そのデータ領域のポインタを呼び出し元に返します．余談ですが apr_palloc() には apr_pcalloc() という亜種があって，これは確保した領域を 0 で初期化してくれます．ですので，実はこの関数の処理は

 return apr_pcalloc(p, sizeof(int));

※ 既に何度か apr_xxx という名前の関数や型が出てきましたが，これらは Apache 2.0 から導入された Apache Portable Runtime ライブラリに属するものです．Apache のソースでは，srclib ディレクトリ以下にあります．独立して配布もされています．これは Apache 1.x 系のソースの中から OS の違いを吸収するためのライブラリ層をまとめて独立化したものです．どのような機能を提供しているのか興味がある方はサイトにあるドキュメントをご覧下さい．

create_dir_config() 関数で確保した領域に具体的な設定をセットするのはディレクティブ処理関数である set_rate() の役割です．この関数の型は次のようになっています．これは AP_INIT_TAKE1() マクロで登録する関数が備えているべき型になります．

 static const char *set_rate(cmd_parms *cmd, void *_rate, const char *s_rate);

以上がディレクティブの処理のためのコードになります．ディレクティブで設定した値を使用するのは，hook や filter になります．このモジュールでは denyrandom() 関数です．前回のコードに対して新たに追加したのは 14 〜 17行目の 4行です．
まず設定データを ap_get_module_config() 関数を使って取り出します(14行目)．この関数への第一引数は設定を取り出す先を指定します．create_dir_config() 関数で作成した設定データを取得するには，request_rec 構造体の per_dir_config メンバを指定します．第二引数には取り出すためのマーカとして denyrandom_module 変数のポインタを渡します．(この変数の定義はこの関数の後ろでしているので，コンパイル時にワーニングが出ないように，宣言をこの関数よりも前でしています(10行目)．)
さて，16行目が今回の本題である "このモジュール(hook)が動作すべきか否か" の判断文になります．set_rate() 関数でディレクティブで設定された値を保存するときに，値が自然数でなければ＝1未満であればエラーにしました．ですので *rate の値は set_rate() で処理されていれば必ず 1 以上になっているはずです．逆に言えば *rate の値が 1 未満であるということは set_rate() で処理されていない ＝ SetAllowrate ディレクティブが設定されなかった，ということです．
もう少し詳しく説明すると，denyrandom() 関数は hook として Apache からリクエストがある度に呼び出されます．Apache が hook を呼び出すにあたって，そのリクエストに対して httpd.conf で記述された設定がかき集められます．例えば，SetAllowrate ディレクティブが次のような形で設定されていたとします．

 <Location "/hoge/">
   SetAllowrate 3
 </Location>

参考文献

• APR のメモリプールの実装に関して，前回も紹介した Code blog で詳しく解説されています．
  • Apacheメモリ管理(その1) (https://www.codeblog.org/blog/inoue/20060120.html)
  • Apacheメモリ管理(その2) (https://www.codeblog.org/blog/inoue/20060206.html)
  • Apacheのメモリ管理(その3) (https://www.codeblog.org/blog/inoue/20060208.html)