コンテンツにスキップ

信頼境界

ngx_mrubyは、nginxのサーバーの運用者が書いたRubyのコードを実行し、クライアントが送るものを、そのコードへの入力として扱います。ngx_mrubyはサンドボックスではありません。設定で読み込むコードの動作を制限しません。このページでは、境界の両側に何があるか、ngx_mrubyが何に責任を持つか、運用者のコードが何に責任を持つかを説明します。また、それがSECURITY.mdの対象の範囲にどう対応するかも説明します。

  • nginxの設定と、設定で読み込むすべてのRubyのコードを信頼します。このコードは、ディレクティブで指定するスクリプトのファイル、*_codeのディレクティブのインラインのコード、build_config.rbでモジュールに組み込むgemです。スクリプトのファイルを指定するディレクティブには、mruby_content_handler /path/to/handler.rbなどがあります。ngx_mrubyはこのコードをそのままコンパイルして実行し、コードが何をするかを確かめません。
  • mruby_add_handler onでは、リクエストのURIで、どのファイルを実行するかが決まります。ngx_mrubyはURIをlocationのrootの下のパスに対応させ、そのファイルをcontentハンドラとして実行します。そのrootの下でlocationにマッチするすべてのファイルが、この種類のコードです。
  • 初期化のコードと、serverの設定のコードは、nginxが設定を読む間にmasterプロセスで動きます。初期化のコードは、mruby_init、mruby_init_code、mruby_stream_init、mruby_stream_init_codeのコードです。serverの設定のコードは、mruby_server_context_handler_codeとmruby_stream_server_context_codeのコードです。これらのコードは、nginxを起動したときの権限で動きます。nginxをrootで起動したなら、rootの権限です。ほかのすべてのコードは、ワーカープロセスで、ワーカーの権限で動きます。ほかのコードとは、init_workerとexit_workerのコード、すべてのハンドラとフィルタ、SSLのハンドシェイクのハンドラ、streamのハンドラです。masterがrootで動くとき、ワーカーの権限は、userディレクティブのユーザーの権限です。
  • http {}のブロックのすべてのコードは、ワーカーごとに1つのmrb_stateで動きます。stream {}のブロックにも、ワーカーごとに別のmrb_stateが1つあります。そのmrb_stateを、ブロックのすべてのserver、location、クライアントが共有します。詳しくはワーカーがリクエストをまたいで保つものにあります。あるlocationのコードは、別のserverやlocationのコードが定義したグローバル変数、定数、クラス、メソッドを読み、変えられます。ngx_mrubyは、1つのブロックのスクリプトを互いに隔離しません。
  • デフォルトのビルドでは、このコードは、build_config.rbのNGX_MRUBY_CORE_GEMSに挙げたmrubyのコアのgemと、build_config.rbのほかのgemを使えます。詳しくはコアのgemにあります。使える機能には、次のものがあります。mruby-evalのevalとinstance_eval、mruby-ioのファイルと、シェルのコマンドを実行するIO.popenとバッククォート、mruby-socketのソケット、mruby-sleepのsleep、シグナルを送るProcess.killを持つmruby-processのProcess、ENV、Dirです。スクリプトは、そのプロセスのユーザーにできることなら何でもできます。

そのため、nginxの設定、設定で読み込むスクリプト、そのスクリプトを置くディレクトリ、build_config.rbのどれかを変えられる人は、ワーカーとして任意のコードを実行できます。その人は、初期化のコードを通して、masterとしても任意のコードを実行できます。運用者が信頼しない相手からnginxの設定やRubyのコードを受け取る構成では、コードを渡す相手のそれぞれが、この権限を持ちます。その権限は、nginx全体と、ほかの相手のトラフィックに及びます。顧客ごとにスニペットを動かすマルチテナントのサービスは、この構成の例です。ngx_mrubyには、そのようなコードの動作を制限する手段がありません。この使い方はサポート外です。

クライアントから受け取るデータは、すべて信頼しない入力として扱います。対象には、リクエストライン、URIとその引数、ヘッダとクッキー、リクエストのボディ、nginxがそれらから導く値があります。スクリプトは、これらの値をNginx::Request、Nginx::Headers_in、Nginx::Varで読みます。Nginx::Requestのメソッドには、uri、unparsed_uri、args、uri_args、post_args、method、headers_in、get_body、userなどがあります。Nginx::Varで読む変数には、たとえば$http_*、$arg_*、$cookie_*、$request_uriがあります。クライアントがTLSのハンドシェイクで送るサーバー名も、同じように信頼しない入力です。スクリプトはこの名前をNginx::SSL#servernameで読みます。upstreamのサーバーからのレスポンスは、そのサーバー自身と同じ程度にだけ信頼できます。サブリクエストや出力フィルタが読むレスポンスも同じです。

  • ngx_mrubyがリクエストを受け取る前に、nginxがリクエストをパースします。ngx_mrubyのsrc/のCのコードと、mrbgems/の同梱のgemは、リクエストの値をRubyの文字列などのオブジェクトとしてスクリプトに渡します。スクリプトが返す値は、データとして受け取ります。ディレクティブとメソッドをドキュメントのとおりに使う設定では、次のことが起きないようにngx_mrubyを作っています。ngx_mrubyがバッファの外のメモリを読み書きすること、ワーカーが終了するかハングすること、あるリクエストに別のリクエストのデータが渡ることです。クライアントが何を送っても、スクリプトがクライアントの入力をngx_mrubyのメソッドに渡しても、同じです。これが起きたなら、ngx_mrubyの不具合です。クライアントの値が関わらず、スクリプト自身の呼び出しだけで起きた場合も、ngx_mrubyの不具合です。
  • 2.7.1と2.7.2では、設定のコード自身の呼び出しで起きる、この種類の不具合を直しました。そのうちのいくつかには、クライアントの値が関わっていませんでした。2.7.0では、Nginx.rputsかNginx.echoで書いたボディをボディフィルタが短くすると、新しいボディの終わりより後ろのバイトが送られました。また、リクエストのスコープのメソッドをリクエストの外で呼ぶと、そのメソッドが別のリクエストのデータを使うことがありました。詳しくは、2.7.1のリリースノートのエントリー2と8と、アドバイザリのGHSA-h7fw-wf49-8rv5にあります。2.7.1では、Nginx::Varが、名前か引数の外のメモリを読むことがありました。読んだのは、名前が空のとき、名前が=だけでできているとき、値の無いセッターを呼んだときです。また、Nginx::Var#setは、名前として渡したStringかSymbolを変えていました。詳しくは2.7.2のリリースノートのエントリー1と2にあります。今のアクセサは、名前と引数を読む前に確かめます。#setは、名前を小文字にしたコピーで変数を探します。スクリプトがどんな値を渡しても同じで、クライアントから受け取った値を渡しても同じです。

ngx_mrubyは、スクリプトが求めることを実行します。クライアントの入力を先へ渡した結果には、スクリプトが責任を持ちます。

  • クライアントの入力は、その入力を使う処理へ渡す前に検証してください。対象には、evalとinstance_eval、シェルのコマンド、シグナル、ファイルのパス、nginxの変数の名前、upstreamのアドレス、リダイレクトの先、レスポンスヘッダがあります。シェルのコマンドを実行するのは、バッククォートとIO.popenで、シグナルを送るのはProcess.killです。ファイルのパスを使うのは、File、Dir、Nginx::SSL#certificate=、#certificate_key=です。nginxの変数の名前を使うのは、実行時に組み立てた名前を渡すNginx::Varと、Nginx::Var#setです。upstreamのアドレスを使うのは、mruby_set $backendとNginx::Upstream#server=です。入力を許可する値のリストと比べるか、コードが期待する型にパースし、合わないものは拒否してください。たとえば、サーバー名から証明書のパスを組み立てるハンドシェイクのハンドラでは、クライアントがパスを選べます。代わりに名前をテーブルで引き、証明書のある名前だけがパスに届くようにしてください。

    http {
    mruby_init_code '
    CERT_DIRS = {
    "example.com" => "/etc/nginx/certs/example.com",
    "www.example.com" => "/etc/nginx/certs/www.example.com",
    }
    ';
    server {
    listen 443 ssl;
    ssl_certificate /etc/nginx/certs/default.crt;
    ssl_certificate_key /etc/nginx/certs/default.key;
    mruby_ssl_handshake_handler_code '
    ssl = Nginx::SSL.new
    dir = CERT_DIRS[ssl.servername]
    if dir
    ssl.certificate = "#{dir}/cert.pem"
    ssl.certificate_key = "#{dir}/key.pem"
    end
    ';
    }
    }

    コードが証明書を設定しないハンドシェイクでは、serverのssl_certificateとssl_certificate_keyを使います。詳しくはNginx::SSLにあります。certificate=とcertificate_key=を使うと、ワーカーはハンドシェイクの間にファイルを読み、その間ブロックします。次の項目を見てください。この読み込みを避けるには、初期化のコードでPEMのデータを読み込み、certificate_data=とcertificate_key_data=で設定してください。

  • 1つのリクエストのデータを、グローバル変数、定数、mainのインスタンス変数、Userdataに置かないでください。ワーカーが次に受けるリクエストからは、どのクライアントのリクエストでも、そのデータが見えます。詳しくはワーカーがリクエストをまたいで保つものにあります。

  • リクエストの経路で、ブロックする呼び出しを避けてください。ワーカーは多くのクライアントを同時に扱います。スクリプトがsleep、ソケット、ファイル、シェルのコマンド、Process、Redisの呼び出しで待つ間、ワーカーはほかのクライアントを扱えません。そのため、スクリプトを待たせられるクライアントは、そのワーカーのすべてのクライアントを遅くできます。Nginx::Async.sleepとNginx::Async::HTTP.sub_requestは、それぞれのドキュメントに動くと書いてある場面で使ってください。また、スクリプトのファイルをリクエストのたびにディスクから読まないように、スクリプトのディレクティブにcacheを加えるか、mruby_cache onを設定するか、インラインのコードを使ってください。

  • nginxの設定、スクリプト、スクリプトを置くディレクトリ、build_config.rbは、運用者だけが書き込めるようにしてください。mruby_add_handler onを使うときは、そのrootの下にハンドラのスクリプトだけを置き、クライアントがアップロードしたファイルを置かないでください。

ngx_mrubyのsrc/かmrbgems/に次の不具合を見つけたら、SECURITY.mdに書いてある方法で、非公開で報告してください。ディレクティブとメソッドをドキュメントのとおりに使う設定で、ngx_mrubyがバッファの外のメモリを読み書きする不具合、ワーカーが終了するかハングする不具合、別のリクエストのデータが漏れるか変わる不具合です。クライアントが制御する入力で起きる不具合は、特に報告してください。スクリプトがクライアントの入力をngx_mrubyのメソッドに渡して起きる不具合も、報告の対象です。スクリプトがドキュメントのとおりにメソッドを呼び、クライアントの値が無くても起きる不具合も、報告の対象です。同梱のコンポーネントやサードパーティのコンポーネントの不具合は、SECURITY.mdにあるとおり、それぞれのupstreamのプロジェクトにも報告してください。不具合が対象に入るか分からないときは、非公開で報告してください。

信頼するコードと設定が、書いたとおりに動いた結果は、SECURITY.mdの対象の範囲の外です。範囲の外になるのは、次の場合です。スクリプトがクライアントの入力を、eval、シェルのコマンド、ファイルのパスのような、上に挙げた使い道へ渡す場合です。スクリプトが1つのリクエストのデータをグローバル変数に置き、後のリクエストがそのデータを見る場合です。スクリプトのブロックする呼び出しで、ワーカーが止まる場合です。設定、スクリプト、build_config.rbを変えられる人が、コードを実行する場合です。運用者が信頼しない相手から、nginxの設定やRubyのコードを受け取る構成も、範囲の外です。