コンテンツにスキップ
2.x保守ブランチのドキュメントです。最新リリースタグは v2.7.12。導入例の対象バージョンを確認してください。開発中の3.xは、3.xのドキュメントを読んでください。

ngx_mruby v2.7.8

Nginx.redirectはIntegerでないステータスコードに、add_listenerはStringでない:addressにTypeErrorを出します(#813)

Section titled “Nginx.redirectはIntegerでないステータスコードに、add_listenerはStringでない:addressにTypeErrorを出します(#813)”

アドバイザリ(URLへのNginx.redirectのステータスコードについて):GHSA-8j8w-mcp5-xp3h

  • 変更前:Nginx.redirectは、URLへのリダイレクトのステータスコードである第2引数を、型を確かめずにIntegerとして読んでいました。StringかFloatを渡すと、応答にはLocationヘッダが付き、ステータスラインにはステータスコードではない数が入り、理由のフレーズはありませんでした。nilを渡すと、クライアントには応答が返らず、接続が閉じられました。Nginx::Server#add_listenerとNginx::Stream.add_listenerは、Hashの:addressを、型を確かめずにStringとして読んでいました。:addressが無いか、nilか、IntegerのようにStringでない値だと、nginxは設定を読み込む途中でセグメンテーション違反で終わりました。nginx -tでも同じでした。
  • 変更後:URLへのリダイレクトで、ステータスコードがIntegerでないと、Nginx.redirectはTypeErrorを出します。メッセージは、値のクラスを入れたString cannot be converted to Integerか、nil cannot be converted to Integerです。スクリプトのほかの例外と同じに、この例外でもハンドラは終わります。スクリプトはrescueでこの例外を捕まえられます。捕まえなければ、ngx_mrubyは例外をログに書き、リクエストは500になります。リダイレクトはせず、Locationヘッダも付けません。内部リダイレクトにはステータスコードが無く、これまでどおり第2引数を使いません。add_listenerはTypeErrorを出します。メッセージは、値のクラスを入れたInteger cannot be converted to Stringか、:addressが無いかnilのときのnil cannot be converted to Stringです。この例外はmruby_server_context_handler_codeかmruby_stream_server_context_codeのコードに届き、nginxは設定の読み込みを止めます。nginx -tは失敗し、mrb_run failedの後に例外を表示します。
  • 変更の理由:
    • 不具合:これらのメソッドは、引数を型を確かめずに読んでいました。そのため、ほかの型の値を渡すと、有効なステータスの無い応答になるか、応答が返らないか、nginxのプロセスが終わりました。URLへのリダイレクトでは、Stringのようなヒープに置かれたステータスコードを渡すと、ワーカープロセスのヒープのアドレスがステータスラインに入り、ASLRが弱まりました。詳細は、上にリンクしたアドバイザリが示します。この項目のadd_listenerの確認は、同じ見直しによる運用者向けの堅牢化で、クライアントからは到達しません。Requestのセッター、Nginx::Async::HTTP.sub_request、Nginx::Headers_in/out#[]=は、2.7.7で同じ確認をするようになりました。Nginx.redirectは、2.7.6から第1引数を確かめています(#775)。
    • 前の挙動を残せなかった理由:Integerでない値にはステータスコードが無く、Stringでない値にはアドレスが無いので、そのように読んだ結果は決まりません。変換して受け付けると、これらのメソッドがこれまで受け付けていなかった型を受け付けることになります。2.x系では、そのような変更はしません。
    • ドキュメントが示していた挙動:2.7.7のNginx.redirectは、第2引数をhttp_statusと呼び、既定の値にIntegerの定数を示していました。ほかの値については、何も書いていませんでした。Nginx::Server#add_listenerとNginx::Stream.add_listenerは、どの例でもStringの:addressを示していました。ほかの値については、何も書いていませんでした。
  • 影響の範囲:Integerでない第2引数を渡す、URLへのNginx.redirectの呼び出しと、Hashに:addressが無いか、Stringでない:addressを渡す、Nginx::Server#add_listenerとNginx::Stream.add_listenerの呼び出しです。内部リダイレクト、Integerのステータスコード、Stringの:addressは、前と同じに動きます。
  • 必要な対応:Nginx.redirectには、Nginx::HTTP_MOVED_PERMANENTLYのようなIntegerのステータスコードを渡すか、302にするなら省いてください。add_listenerの:addressは、port.to_sのようにStringで渡してください。ほかの値を渡すコードは、2.7.7でも動いていませんでした。

Nginx.redirectは3つ目の引数にArgumentErrorを出します(#813)

Section titled “Nginx.redirectは3つ目の引数にArgumentErrorを出します(#813)”
  • 変更前:Nginx.redirectは、URLか内部のlocationと、省略できるステータスコードを取ります。しかし、引数を3つ渡してもエラーになりませんでした。このメソッドがmrubyに渡す引数の形式は3つの引数を許し、受け取る変数は2つしか渡していませんでした。形式と変数の数が合っておらず、引数を3つ渡したときの結果は定まっていませんでした。引数を4つ以上渡すと、今と同じくArgumentErrorが出ていました。
  • 変更後:引数を3つ渡すと、Nginx.redirectは何もする前にArgumentErrorを出します。メッセージはwrong number of arguments (given 3, expected 1..2)です。URLでも内部のlocationでも同じです。スクリプトのほかの例外と同じに、この例外でもハンドラは終わります。スクリプトはrescueでこの例外を捕まえられます。捕まえなければ、ngx_mrubyは例外をログに書き、リクエストは500になります。リダイレクトはしません。
  • 変更の理由:
    • 不具合:ngx_mrb_redirectの引数の形式は3つの引数を挙げていて、受け取る変数は2つしか渡していませんでした(#813)。
    • 前の挙動を残せなかった理由:引数を3つ渡したときの結果は定まっていなかったので、残すことはできませんでした。このメソッドには、意味を与えられる3つ目の引数がありません。また、メソッドが取るより多い引数を渡されたとき、mrubyはArgumentErrorを出します。
    • ドキュメントが示していた挙動:2.7.7のNginx.redirectの見出しは、2つの引数を挙げていました。3つ目の引数については、何も書いていませんでした。
  • 影響の範囲:引数を3つ渡すNginx.redirectの呼び出しです。
  • 必要な対応:Nginx.redirectには、引数を1つか2つ渡してください。URLか内部のlocationと、URLで302以外にするならステータスコードです。

ありません。

  • URLへのNginx.redirectはステータスコードがIntegerであることを、Nginx::Server#add_listenerとNginx::Stream.add_listenerは:addressがStringであることを確かめるようになりました。ほかの型の値にはTypeErrorを出します。これまでは、ほかの型のステータスコードでは有効なステータスの無い応答になるか応答が返らず、ほかの型の:addressか:addressが無いと、設定を読み込む途中でnginxが終わりました(#813)。
  • Nginx.redirectは引数を1つか2つ取り、3つ目の引数にはArgumentErrorを出します。これまでは、引数の形式と受け取る変数の数が合っておらず、引数を3つ渡したときの結果は定まっていませんでした(#813)。
  • 新しいテストのケースとして、test/t/cases/argument_types.rbと、ポート18200のtest/conf/conf.d/96-argument-types.confのサーバーを加えました(#813)。
  • ディレクティブの追加、名前の変更、削除はありません。2.7.7と同じ方法でこのリリースのモジュールをビルドし、バイナリか動的モジュールを置き換えてください。

アップグレードの前に、次の点を確かめてください。各行は、項目の「必要な対応」です。

  • URLへのNginx.redirectにIntegerでないステータスコードを渡す呼び出しと、Stringの:addressを渡さないadd_listenerの呼び出し:Integerのステータスコードを渡すか、302にするなら省いてください。:addressはStringで渡してください。
  • 引数を3つ渡すNginx.redirectの呼び出し:1つか2つにしてください。