はじめに

このドキュメントは、ajp13として知られていた現在のApache JServプロトコルバージョン1.3の改良の提案です。 ここでは、プロトコルのすべてではなく、ajp13に追加する部分だけを説明します。 この提案は、tomcat-devリストからのコメントと、開発中に発見された誤りを含んでいます。

AJP13に欠けている機能

ajp13は、TomcatのようなServletエンジンとApacheのようなWebサーバを繋ぐのに適したプロトコルで、次のような特徴があります。

• リクエストごとに再接続する時間をなくすために、永続的な接続を使用します。
• ストリームサイズを減らすために、多くのHTTPコマンドをエンコードします。
• WebサーバからServletエンジンに、(SSL認証のような)多くの情報を送信します。

しかし、ajp13は以下に関してサポートしていません。

• WebサーバとServletエンジンの間のセキュリティ。 (ログイン機能がないので)誰でもajp13ポートに接続できます。 たとえば、telnetで接続して、何もデータを送信しなければ、リモートのスレッドを捉えておくことができます(接続にタイムアウトはありません)。
• ServletエンジンからWebサーバに渡されるコンテキスト情報。 Webサーバコネクタであるmod_jkの設定には、どのURLを処理するかをWebサーバに指示するためのものがあります。 mod_jkのJkMount指示子は、WebサーバにどのURLをServletエンジンに転送しなければならないかを指示します。 Servletエンジンは、すでにどのURLを処理しなければならないかがわかっており、Tomcat 3.3には利用可能なコンテキストのリストからmod_jk用の設定ファイルを生成する機能がすでにあります。
  
• ServletエンジンからWebサーバへのコンテキストの状態の更新。 ISPやバーチャルホスト提供サービスのような、多くのTomcatを使用する大規模サイトでは、 管理をおこなうためにあるコンテキストを停止する必要があるかもしれません。 このような場合、手前にあるWebサーバは、そのリクエストを他のTomcatに送るために、 そのコンテキストが現在ダウンしていることを知っていなければなりません。
• リクエストを送信する前の接続状態の確認。 実際には、JKはリクエストをServletエンジンに送信してから、その応答を待ちます。 しかし、Socket APIの良い点の一つは、すでにクローズした接続に対して、 何もエラーをおこさずにwrite()するかもしれないのに、 すでにクローズした接続に対するread()はエラーコードを返すことなのです。

AJP13に対する追加

AJP13に追加されるかもしれない機能を説明します。 本稿は一つの提案にすぎないので、まずは、かなりごちゃごちゃだと思ってかまいません。 Tomcat MLでの議論は論点を明確にし、機能を追加するのには役立ちましたが、 それでも現在挙がっているのは「最低限必要」なものでしかないように思います。

• 高度なログイン機能
• 秘密鍵をWebサーバとServletエンジンで共有する基本的な認証システム、
• 将来的にAJP13に機能を追加する場合に、現在の実装の動作を保証するための、 基本的なプロトコルネゴシエーション。
• 「未知のパケット」の適正な処理。
• WebサーバからServletエンジンへの渡される環境変数の拡張。
• (SSL_KEY_SIZEのように)Servlet 2.3 API で必要な追加SSL情報。

高度なログイン機能

1. WEBサーバはLOGIN INIT CMD + NEGOCIATION DATA + WEB SERVER INFOを送信します。
2. TOMCATは、LOGIN SEED CMD + RANDOM DATAで返答します。
3. WEBサーバはRANDOM DATA+SECRET DATAのMD5を計算します。
4. WEBサーバは、LOGIN COMP CMD + MD5 (SECRET DATA + RANDOM DATA)を送信します。
5. TOMCATはLOGIN STATUS CMD + NEGOCIED DATA + SERVLET ENGINE INFOを返答します。

メッセージストリーム

+----------------+------------------+-----------------+
| LOGIN INIT CMD | NEGOCIATION DATA | WEB SERVER INFO |
+----------------+------------------+-----------------+

+----------------+----------------+
| LOGIN SEED CMD | MD5 of entropy |
+----------------+----------------+

+----------------+----------------------------+
| LOGIN COMP CMD | MD5 of RANDOM + SECRET KEY |
+----------------+----------------------------+

+-----------+---------------+---------------------+
| LOGOK CMD | NEGOCIED DATA | SERVLET ENGINE INFO |
+-----------+---------------+---------------------+

+------------+--------------+
| LOGNOK CMD | FAILURE CODE |
+------------+--------------+

• LOGIN INIT CMD、LOGIN SEED CMD、LOGIN COMP CMD、LOGOK CMD、LOGNOK CMDの長さは1バイトです。
• MD5、MD5 of RANDOM + SECRET KEYの長さは32文字(char)です。
• NEGOCIATION DATA、NEGOCIED DATA、FAILURE CODEの長さは32ビットです。
• WEB SERVER INFO、SERVLET ENGINE INFOはCStringです。

worker.ajp13.port=8009
worker.ajp13.host=localhost
worker.ajp13.type=ajp13
worker.ajp13.secretkey=myverysecretkey

シャットダウン機能

AJP13にはAJP12の機能であるシャットダウンコマンドがありません。 ログアウトで、Servletエンジンにシャットダウンを指示します。

+--------------+----------------------------+
| SHUTDOWN CMD | MD5 of RANDOM + SECRET KEY |
+--------------+----------------------------+

+------------+
| SHUTOK CMD |
+------------+

+-------------+--------------+
| SHUTNOK CMD | FAILURE CODE |
+-------------+--------------+

• SHUTDOWN CMD、SHUTOK CMD、SHUTNOK CMDの長さは1バイトです。
• RANDOM + SECRET KEYのMD5の長さは32文字(char)です。
• FAILURE CODEの長さは32ビットです。

環境変数の拡張

注意: JKでAJP13に関する作業をしていた時に、"JkEnvVar"を発見してしまいました。 以下の"環境変数の拡張"の記述内容は、現在の実装にすでにあるので、 AJP13の拡張時に実装されないかもしれません。 解説: 多くのユーザが、Webサーバのいくつかの環境変数をServletエンジンに渡したいようです。 ネットワークトラフィックを減らすために、 Webサーバは外部変数を示すテーブルを何らかの形で圧縮して送信することになります。 そこで、AJP13の既存の機能である、属性リストを使用したいと思います。 AJP13では次のような情報を送ることができます。

AJP13_FORWARD_REQUEST :=
    prefix_code      2
    method           (byte)
    protocol         (string)
    req_uri          (string)
    remote_addr      (string)
    remote_host      (string)
    server_name      (string)
    server_port      (integer)
    is_ssl           (boolean)
    num_headers      (integer)
    request_headers *(req_header_name req_header_value)

    ?context       (byte string)
    ?servlet_path  (byte string)
    ?remote_user   (byte string)
    ?auth_type     (byte string)
    ?query_string  (byte string)
    ?jvm_route     (byte string)
    ?ssl_cert      (byte string)
    ?ssl_cipher    (byte string)
    ?ssl_session   (byte string)

    ?attributes   *(attribute_name attribute_value)
    request_terminator (byte)

+-------------------+---------------------------+-------------------------------+----+
| EXTENDED VARS CMD | WEB SERVER ATTRIBUTE NAME | SERVLET ENGINE ATTRIBUTE NAME | ES |
+-------------------+---------------------------+-------------------------------+----+

JkExtVars S1 SSL_CLIENT_V_START javax.servlet.request.ssl_start_cert_date
JkExtVars S2 SSL_CLIENT_V_END   javax.servlet.request.ssl_end_cert_date
JkExtVars S3 SSL_SESSION_ID     javax.servlet.request.ssl_session_id


+-------------------+----+-------------------------------------------+
| EXTENDED VARS CMD | S1 | javax.servlet.request.ssl_start_cert_date |
+-------------------+----+-------------------------------------------+
+----+-----------------------------------------+
| S2 | javax.servlet.request.ssl_end_cert_date |
+----+-----------------------------------------+
+----+-----------------------------------------+
| S3 | javax.servlet.request.ssl_end_cert_date |
+----+-----------------------------------------+

• EXTENDED VARS CMDの長さは1バイトです。
• WEB SERVER ATTRIBUTE NAME、SERVLET ENGINE ATTRIBUTE NAMEはCStringです。
• ESは空のCStringです。

ServletエンジンからWebサーバに転送するコンテキスト情報

LOGIN PHASE終了後に、WebサーバはServletエンジンが処理するコンテキストとURLのリストを要求します。 これにより、多くのサイトでインストールが簡単になり、 tomcat-user MLで設定に関する質問が減り、Servlet API 2.3にも対応できるでしょう。 このモードは、新しいJkAutoMount指示子によって有効になるはずです。 例: JkAutoMount examples myworker1 /examples/ もしServletエンジンが処理するコンテキストをすべて取得したいなら、ワイルドカードが使えるでしょう。 例: JkAutoMount * myworker1 * Servletエンジンは、/examples, /admin, /testのような多くのコンテキストを持てるようになるはずです。 あるワーカに対していくつかのコンテキストだけを使用したいかもしれません。 従来は、たとえばApache HTTPサーバでは、 Apacheのそれぞれの[virtual]領域内にJkMountを手動で設定することで実現していました。 また、Webサーバがバーチャルホストをサポートしている場合には、Servletエンジンがバーチャルホストのコンテキストだけを返すように、 バーチャルホストの情報も転送するようにしたいと思います。 この場合、Servletエンジンは、これらの特定の(servlet.xml内で定義された) バーチャルサーバにマッチするURL/URIだけを返します。この機能は、ISP や、負荷分散構成で多くのTomcatを使用している大規模サイトで役に立つと思われます。

+-----------------+-------------------+----------+----------+----+
| CONTEXT QRY CMD | VIRTUAL HOST NAME | CONTEXTA | CONTEXTB | ES |
+-----------------+-------------------+----------+----------+----+

+------------------+-------------------+----------+-------------------+----------+---------------+----+
| CONTEXT INFO CMD | VIRTUAL HOST NAME | CONTEXTA | URL1 URL2 URL3 ES | CONTEXTB | URL1 URL2 ... | ES |
+------------------+-------------------+----------+-------------------+----------+---------------+----+

• CONTEXT QRY CMDとCONTEXT INFO CMDの長さは1バイトです。
• VIRTUAL HOST NAMEはCString、つまり最後がnullバイト(/0)で終了している文字の配列です。
• 空文字列はnullバイト(/0)だけです。
• ESは空のCStringです。URI/URLリストの終わりもしくはCONTEXTリストの終わりを示します。

ServletエンジンからWebサーバのコンテキスト情報の更新

コンテキストの更新は、コンテキストが有効化/無効化されるごとにServletエンジンから送信されるメッセージです。 この更新は、JkUpdateMount指示子を指定した時に使用可能になります。 この指示子で、AJP13_CONTEXT_UPDATE_NEGフラグを設定します。 例: JkUpdateMount myworker1

+--------------------+-------------------+----------+--------+----------+--------+----+
| CONTEXT UPDATE CMD | VIRTUAL HOST NAME | CONTEXTA | STATUS | CONTEXTB | STATUS | ES |
+--------------------+-------------------+----------+--------+----------+--------+----+

• CONTEXT UPDATE CMD、STATUSの長さは1バイトです。
• VIRTUAL HOST NAME、CONTEXTSはCStringです。
• ESは空のCStringです。CONTEXTのリストの終わりを示します。

Servletエンジンへのコンテキストステータスの問い合わせ

この問い合わせは、Webサーバが与えられたコンテキストがUPかDOWNまたはINVALID(削除すべき)かを決定するために使用します。

+-------------------+--------------------+----------+----------+----+
| CONTEXT STATE CMD |  VIRTUAL HOST NAME | CONTEXTA | CONTEXTB | ES |
+-------------------+--------------------+----------+----------+----+

+-------------------------+-------------------+----------+--------+----------+--------+----+
| CONTEXT STATE REPLY CMD | VIRTUAL HOST NAME | CONTEXTA | STATUS | CONTEXTB | STATUS | ES |
+-------------------------+-------------------+----------+-------------------+--------+----+

• CONTEXT STATE CMD、CONTEXT STATE REPLY CMD、STATUSの長さは1バイトです。
• VIRTUAL HOST NAME、CONTEXTはCStringです。
• ESは空のCStringです。

未知のパケットの処理

良く設計されたプロトコルであっても、片側(WebサーバまたはServletエンジン)が、 理解できないメッセージを受け取ることがあるかもしれません。 このような場合に、受信側は処理できなかったメッセージを付加して'UNKNOWN PACKET CMD'を送信します。

+--------------------+------------------------+-------------------+
| UNKNOWN PACKET CMD | UNHANDLED MESSAGE SIZE | UNHANDLED MESSAGE |
+--------------------+------------------------+-------------------+

• UNKNOWN PACKET CMDの長さは1バイトです。
• UNHANDLED MESSAGE SIZEの長さは16ビットです。
• UNHANDLED MESSAGEはバイトの配列です。(配列の長さはUNHANDLED MESSAGE SIZEに含まれます)

リクエストを送信する前の接続の確認

注意: この機能は使われないかもしれません。Webサーバ側において、リクエストの転送前に余分なI/O(読み込み)が必要になり、普通のプロセスが遅くなるためです・・・。 Socket APIの良い点の一つは、半分クローズしたソケットに書き込むことができることです。 Servletエンジンがソケットをクローズした時に、Webサーバはそのソケットに次のread()をおこなった時にだけ、クローズを検出できます。 基本的に、AJP13プロトコルでは、WebサーバはHTTP HEADERとHTTP BODY(POSTでは8Kまで)をServletエンジンに送信して、 それから返答を受信しようとします。 そのコネクションがクローズされた場合は、Webサーバはそれを受信時にしか知ることはできません。 私たちはバッファリング手法を使用することができますが、 8Kを超えるデータのアップロード操作にServletエンジンを使用した時には、何が起るかわかりません。 それに対するAJP13プロトコルの改変案は、そのサービスの終了後に数バイトの読み込みを追加することです。

WebサーバとServletエンジン間のやりとりの例

AJP HTTP-HEADER (+ HTTP-POST)   (WEB->SERVLET)

AJP HTTP-REPLY					(SERVLET->WEB)

AJP END OF DISCUSSION			(SERVLET->WEB)
						
---> AJP STATUS 				(SERVLET->WEB AJP13)

+------------+-------------+
| STATUS CMD | STATUS DATA |
+------------+-------------+

• STATUS CMDとSTATUS DATAの長さは1バイトです。

おわりに

拡張されたAJP13プロトコルの目的は、元のAJP13の制約のいくつかを克服することです。 これには、より簡単な設定、大規模サイトやTomcatの集合に対するよりよりサポート、 簡単な認証システムとプロトコルのバージョンアップへの準備などがあります。 JK(ネイティブ)とServletエンジン (Java) でajp13の安定した実装を使用するので、 よく知られているajp13の無理のない改良となります。

拡張されたAJP13のコマンドとIDのインデックス

AJP13プロトコルに追加されたコマンドとIDのインデックス

コマンドのID

ネゴシエーションフラグ

エラーID

ステータス