メインコンテンツへスキップ
見出し画像

CORSとは?同一オリジンポリシーと、画面とAPIを分けたときに出るエラーの意味

    画面(フロントエンド)と API(バックエンド)を別々のサーバーで動かすと、ブラウザーの開発者ツールに「Access to fetch at … has been blocked by CORS policy」という赤い文が出ることがあります。

    API を直接開くとデータは返ってくるため、何が起きているのか分かりにくいエラーです。これは、ブラウザーが守っている同一オリジンポリシーという決まりと、その決まりを API の側から緩めるCORSという仕組みに関係しています。

    この記事では、同一オリジンポリシーとは何か、なぜ必要なのか、CORS はそれをどのように緩めるのかを説明します。画面と API を別々のオリジンに置き、ブラウザーから API を直接呼ぶ作りでは、CORS の設定が欠かせません。検証用の小さな API サーバーと Chromium(Chrome のもとになっているブラウザー)で実際に動かした結果も、あわせて紹介します。本文の[1]のような番号は、押すと出典のページが開きます。

    同じ「オリジン」を手がかりにする攻撃の CSRF は、以前の記事「CSRFとは?Djangoでの守り方と、開発中に出る「CSRF検証に失敗」画面の意味」で扱いました。この記事は、その続きとして読むこともできます。

    まず用語をそろえる

    • フロントエンドとバックエンド:フロントエンドは、利用者のブラウザーに表示される画面の部分です。バックエンドは、データの保存や計算を受け持つサーバーの部分です。

    • API:プログラムどうしがやり取りするための窓口です。ここでは、画面から呼ばれて、データを JSON(文字で書いたデータの形式)で返すバックエンドの URL を指します。

    • fetch:ブラウザーの JavaScript から、サーバーにリクエストを送るための命令です。

    • ヘッダー:リクエストや応答に付く、本文とは別の付帯情報です。「この応答は誰が読んでよいか」なども、ヘッダーで伝えます。

    • 資格情報:Cookie(サーバーがブラウザーに預ける小さな文字列)など、「誰からのリクエストか」をサーバーに伝える情報です。ログインの状態は、多くの場合 Cookie で保たれています。

    画像
    画面と API を別々に動かしたときに、開発者ツールに出る CORS のエラー。API を直接開くとデータは返ってくる

    オリジン:方式・ホスト・ポートの組み合わせ

    オリジンは、URL のうち「https」などの方式(スキーム)、「example.com」などのホスト、ポート番号の3つの組み合わせです。2つのページで3つがすべて同じとき、同じオリジンと呼びます[1]。パス(「/api/items/」のような部分)は、オリジンには含まれません。

    開発中によくあるのが、画面を「http://localhost:3000」、API を「http://localhost:8000」で動かす形です。ホストはどちらも localhost ですが、ポート番号が違うため、2つは別のオリジンになります。「http」と「https」の違いや、「www.example.com」と「api.example.com」のようなホストの違いも、同じく別のオリジンです。

    画像
    オリジンは方式・ホスト・ポートの3つで決まる。localhost:3000 と localhost:8000 は、ポートが違うため別のオリジン

    同一オリジンポリシー:別のオリジンの中身は読めない

    同一オリジンポリシーは、あるオリジンから読み込まれたページやスクリプトが、別のオリジンにあるものへ近づける方法を制限する、ブラウザーの仕組みです[1]。MDN(ウェブ技術の解説文書)は、別のオリジンとのやり取りを次の3つに分けて説明しています[1]。

    • 書き込み:リンクやリダイレクト、フォームの送信など。概して許可される

    • 埋め込み:別のオリジンの画像、スクリプト、スタイルシートなどを、ページに表示・実行すること。概して許可される

    • 読み込み:別のオリジンの応答の中身を、スクリプトで読むこと。一般に許可されない

    画像
    同一オリジンポリシーは、別のオリジンへの「書き込み」と「埋め込み」はおおむね許し、「読み込み」を止める

    つまり、別のオリジンへのリクエストそのものが禁じられているわけではありません。止められているのは、応答の中身をスクリプトで読むことです。fetch は、この「読み込み」にあたるため、別のオリジンの API を呼ぶと、ブラウザーが応答を渡さずに止めます。

    なぜ「読み込み」を止めるのか

    MDN は、この決まりがない場合の危険として、悪意のあるサイトがブラウザーの中でスクリプトを動かし、利用者がログインしているウェブメールや、外から直接は届かない社内のネットワークのデータを読み取って、攻撃者に送ることを挙げています[1]。

    ブラウザーは、フォームの送信や、資格情報を付けた fetch などで、送り先のサイトの Cookie を付けてリクエストを送ることができます。もし別のオリジンの応答も自由に読めるとすると、利用者が開いた悪意のあるページが、利用者のログイン中の画面の中身を、そのまま読み取れてしまいます。同一オリジンポリシーは、ページを開いただけで、別のサイトの情報が抜き取られることを防いでいます。

    画像
    読み込みを許すと、悪意のあるページが、ログイン中のサイトや社内のネットワークの中身を読み取れてしまう

    送信はできても、中身は読めない

    この「書き込みはできるが、読み込みはできない」という性質は、CSRF の記事でも取り上げました。CSRF は、送信はできることを悪用する攻撃で、トークン(合言葉の値)による CSRF の対策は、攻撃者のページが中身を読めないことを利用しています。CORS の話では、同じ性質を反対の側から見ることになります。自分で作った画面であっても、オリジンが違えば、API の応答はそのままでは読めません。

    同一オリジンポリシーと CORS の移り変わり

    同一オリジンポリシーと CORS は、次のように形づくられてきました。

    • 1990年代:同一オリジンポリシーは、Netscape Navigator 2.0(当時の代表的なブラウザー)にさかのぼる[2]

    • 2014年1月:W3C(ウェブの標準を定める団体)が、CORS の仕様を勧告として公開した[3]

    • 現在:CORS は、WHATWG(ブラウザーの開発者たちが標準を定める団体)の Fetch Standard で定義されている[4]

    画像
    同一オリジンポリシーと CORS の移り変わり。古いブラウザーの時代からの決まりに、2014年に CORS という緩め方が標準として加わった

    CORS:API の側が「このオリジンなら読んでよい」と伝える

    CORS(オリジン間リソース共有)は、HTTP のヘッダーを使い、別のオリジンで動いている画面に、選んだ資源を読ませてよいとブラウザーに伝える仕組みです[4]。

    流れは次のとおりです。

    1. ブラウザーは、別のオリジンへ fetch するとき、リクエストに Origin ヘッダー(送り元のオリジン)を付ける

    2. API は、そのオリジンに読ませてよければ、応答に Access-Control-Allow-Origin ヘッダーを付けて、許可するオリジンを書く

    3. ブラウザーは、応答のヘッダーが送り元のオリジンと合っていれば、応答の中身を画面のスクリプトに渡す。合っていなければ渡さず、開発者ツールに CORS のエラーを出す

    画像
    CORS の流れ。API が応答に Access-Control-Allow-Origin を付けると、ブラウザーは画面のスクリプトに中身を渡す

    実際に、許可するオリジンを「http://localhost:3000」にした API サーバーに、そのオリジンを付けたリクエストを送ると、応答に次のヘッダーが付きました。許可していないオリジンを付けた場合は、このヘッダーが付きませんでした。

    access-control-allow-origin: http://localhost:3000
    Vary: origin

    Vary ヘッダーは、送り元のオリジンによって応答が変わることを、途中のキャッシュに伝えるヘッダーです。

    CORS は、許可する側が自分で選んで加わる「オプトイン」の仕組みになっています。Fetch Standard は、ファイアウォールの内側(社内のネットワークなど)の応答や、資格情報を含むリクエストへの応答から、データが漏れるのを防ぐために、オプトインである必要があると説明しています[5]。

    CORS の判定をするのはブラウザー

    CORS の大事な点は、読ませるかどうかを判定するのがブラウザーだということです。API の側は、許可を表すヘッダーを付けるだけで、リクエストを断っているわけではありません。

    CORS の設定をしていない API サーバーに、localhost:3000 の画面から fetch したところ、ブラウザーには「No 'Access-Control-Allow-Origin' header is present on the requested resource.」と出ました。一方で、サーバーの記録には「"GET /api/items/ HTTP/1.1" 200」と残っていました。リクエストはサーバーに届き、サーバーは普通に応答しているのに、ブラウザーが中身を画面に渡さなかったのです。

    ブラウザーを通さない呼び出しも試しました。curl(コマンドで HTTP のリクエストを送る道具)で同じ API を呼ぶと、CORS の設定がなくても、データがそのまま返りました。CORS は、ブラウザーの同一オリジンポリシーを緩めるための仕組みで、ブラウザー以外からの呼び出しを止めるものではありません。

    画像
    CORS のエラーが出ても、リクエストはサーバーに届いている。中身を画面に渡さないのはブラウザーで、curl やサーバーからの呼び出しには関係しない

    そのため、CORS の設定を、API の守りの代わりにしてはいけません。OWASP(ウェブのセキュリティの国際的な団体)は、Origin ヘッダーはブラウザーの外では偽ることができるため、アクセスの制御を Origin だけに頼らず、大事なデータはアプリケーションの側の仕組みで守るよう求めています[6]。見せてはいけないデータは、ログインの確認や権限の確認で守る必要があります。

    許可するオリジンは、具体的に書くのが基本です。OWASP は、「*」(すべてのオリジン)や、届いた Origin をそのまま返す設定を避け、信頼できるオリジンだけを許すよう勧めています[6]。手軽だからと「*」にすると、どのサイトの画面からでも応答を読めるようになります。

    単純リクエストとプリフライト

    CORS には、もう1つ大事な仕組みがあります。サーバーのデータを変えるおそれのあるリクエストでは、ブラウザーが本番のリクエストの前に、プリフライトと呼ばれる確認のリクエストを送ります[4]。

    プリフライトなしで送られる「単純リクエスト」

    次の主な条件をすべて満たすリクエストは、プリフライトなしで、すぐに送られます。MDN は、古い仕様書にならって、これを単純リクエストと呼んでいます[4]。

    • 方式(メソッド)が GET、HEAD、POST のどれか

    • 手で付けるヘッダーが、Accept、Accept-Language、Content-Language、Content-Type などの決められたものだけ

    • Content-Type が「application/x-www-form-urlencoded」「multipart/form-data」「text/plain」のどれか

    画像
    プリフライトなしで送られる「単純リクエスト」の条件。JSON を送る POST や、独自のヘッダーを付けたリクエストは、条件から外れる

    この条件は、HTML のフォームで昔から送れたリクエストとおおむね重なります。MDN は、フォームはもともとどのオリジンにも送信できたため、サーバーはすでに CSRF への備えをしているはずで、フォームの送信のように見えるリクエストに、事前の確認は求めないという考え方を説明しています[4]。

    注意したいのは、単純リクエストは、CORS で止められても、サーバーでは処理されることです。CORS の設定がない API サーバーに、Content-Type を text/plain にした POST を画面から送ると、ブラウザーではエラーになりましたが、サーバーの記録には「"POST /api/echo/ HTTP/1.1" 200」とあり、送った内容を受け取っていました。CORS のエラーが出たことは、「サーバーでは何も起きなかった」ことを意味しません。

    JSON を送る POST は、まず OPTIONS で確かめる

    画面から API に JSON を送るときは、Content-Type が「application/json」になるため、単純リクエストの条件から外れます。このときブラウザーは、まず OPTIONS という方式で、次の内容を API に尋ねます。

    • Access-Control-Request-Method:本番で使う方式(例:POST)

    • Access-Control-Request-Headers:本番で付けるヘッダー(例:content-type)

    API が「そのオリジン・方式・ヘッダーなら受け付ける」と応答したときにだけ、ブラウザーは本番の POST を送ります。CORS の設定がない API サーバーで試すと、記録には OPTIONS のリクエストしか残らず、本番の POST は送られていませんでした。ブラウザーのエラーも「Response to preflight request doesn't pass access control check」と、確認の段階で止まったことを示していました。

    プリフライトのリクエストには、Cookie などの資格情報は付きません[5]。そのため、OPTIONS のリクエストにもログインを求める作りにすると、プリフライトの段階で断られ、本番のリクエストが送られなくなります。

    画像
    プリフライトの流れ。JSON を送る POST では、ブラウザーがまず OPTIONS で確かめ、許可が返ったときだけ本番の POST を送る

    プリフライトの結果は、Access-Control-Max-Age ヘッダーで決めた秒数だけ、ブラウザーが覚えておけます[4]。その間は、同じ確認を繰り返さずに本番のリクエストを送れます。

    Cookie を付けるときの決まり

    ログインした利用者だけが使える API を、別のオリジンの画面から呼ぶときは、Cookie を付けて送る必要があります。ところが、ブラウザーは、別のオリジンへの fetch には、初期設定では資格情報を付けません[4]。

    Cookie を付けて読むには、画面と API の両方で、次のようにそろえる必要があります[4]。

    1. 画面の fetch で、Cookie などを付けて送る指定 credentials: "include" を書く

    2. API の応答に Access-Control-Allow-Credentials: true を付ける

    3. API の応答の Access-Control-Allow-Origin に、「*」(すべてのオリジン)ではなく、具体的なオリジンを書く(Cookie を付けるときは、「*」は仕様として使えない)

    実験では、2の設定を外した状態で、ログイン中の画面から Cookie を付けて呼ぶと、「The value of the 'Access-Control-Allow-Credentials' header in the response is '' which must be 'true'」というエラーになりました。このときも、サーバーの記録では、ログイン中の利用者として応答を返していました。3の「*」を返す API に Cookie を付けて呼ぶと、「must not be the wildcard '*'」というエラーになりました。

    画像
    Cookie を付けて読むには、画面の credentials: "include"、API の Allow-Credentials: true、具体的なオリジンの3つがそろう必要がある

    「別のオリジン」と「別のサイト」は違う

    Cookie については、もう1つ考えることがあります。Cookie の SameSite という設定は、オリジンではなくサイトを単位に、別のサイトから始まったリクエストに Cookie を付けるかを決めます[7]。

    サイトは、オリジンより広いまとまりです。「example.com」のように登録して使う部分(登録可能なドメイン)が同じなら、「www.example.com」と「api.example.com」は同じサイトです。ポート番号は、サイトの判定では無視されます[8]。そのため、localhost:3000 と localhost:8000 は、別のオリジンだが、同じサイトです。

    SameSite が Lax(ブラウザーによっては、指定がないときの既定の扱いにもなる値[7])の Cookie は、別のサイトから始まった fetch には付きません[7]。実験でも、localhost:3000 の画面から呼ぶと Cookie が付いてログイン中と扱われ、127.0.0.1:3000(localhost とは別のサイト)の画面から呼ぶと Cookie が付かず、ログインしていない扱いになりました。

    画面と API が別のサイトになる場合は、Cookie を SameSite=None にし、Secure(HTTPS でだけ送る指定)も付ける必要があります[7]。それでも、ブラウザーのサードパーティー Cookie(別のサイトの Cookie)の制限によって、Cookie が送られないことがあります[4]。画面と API を同じサイトのサブドメイン(「www.」と「api.」など)にそろえておくと、こうした問題を避けやすくなります。

    画像
    サイトとオリジンの違い。localhost:3000 と localhost:8000 は別のオリジンだが同じサイト。127.0.0.1 と localhost は別のサイトで、Lax の Cookie は付かない

    実験の結果のまとめ

    ここまでの実験の結果を、表にまとめます。画面は localhost:3000(最後の行だけ 127.0.0.1:3000)、API は localhost:8000 で動かしました。「許可あり」は、API が localhost:3000 と 127.0.0.1:3000 からの読み込みを許可する設定です。

    画像
    実験の結果。CORS のエラーが出ても、多くの場合リクエストはサーバーに届いていた。止めるのはブラウザー

    CORS のエラーが出たときの見方

    CORS のエラーの詳しい理由は、安全のため、JavaScript からは分からないようになっています。何が悪かったのかを知る方法は、ブラウザーの開発者ツールのコンソールで、エラーの文を見ることです[4]。よく見る文と、確かめる点は次のとおりです。

    • No 'Access-Control-Allow-Origin' header is present:API が許可のヘッダーを返していない。API の CORS の設定と、許可するオリジンの書き方(方式・ホスト・ポート)を確かめる

    • Response to preflight request doesn't pass access control check:プリフライトの段階で止まっている。OPTIONS のリクエストに、許可のヘッダーが付いているかを確かめる

    • … must be 'true' when the request's credentials mode is 'include':Cookie を付けて呼んでいるのに、API が資格情報を許していない。応答に Access-Control-Allow-Credentials: true が付いているかを確かめる

    • … must not be the wildcard '*' …:Cookie を付けて呼んでいるのに、API が「*」を返している。具体的なオリジンを返すようにする

    あわせて、開発者ツールのネットワークの欄で、リクエストがサーバーに届いたか、応答の番号がいくつかも見ておくと、原因を絞り込みやすくなります。CORS のエラーに見えても、サーバーの側では処理が終わっていたり、403(サーバーが処理を断ったことを示す番号)など、別の理由で断られていたりすることがあるためです。

    画像
    CORS のエラーの文と、確かめる点。理由の文はコンソールにだけ出る

    まとめ

    • オリジンは、方式・ホスト・ポートの3つの組み合わせ。localhost:3000 と localhost:8000 は別のオリジン

    • 同一オリジンポリシーは、別のオリジンの応答の中身をスクリプトで読むことを止める、ブラウザーの決まり

    • CORS は、API が Access-Control-Allow-Origin などのヘッダーで「このオリジンなら読んでよい」と伝え、ブラウザーが判定する仕組み

    • CORS のエラーが出ても、リクエストはサーバーに届いていることが多い。CORS は API の守りの代わりにならない

    • JSON を送る POST などでは、ブラウザーが先に OPTIONS で確かめる(プリフライト)

    • Cookie を使うなら、credentials・Allow-Credentials・具体的なオリジンの3つをそろえる。許可するオリジンは「*」にせず具体的に書く

    画像
    この記事のまとめ。同一オリジンポリシーと CORS の関係と、設定するときの注意

    同一オリジンポリシーは、ページを開いただけで別のサイトの情報が読み取られることを防ぐ、ブラウザーの基本の守りです。CORS は、その守りを、API の側が選んだ相手にだけ緩める仕組みです。CORS のエラーは、ブラウザーがこの守りを働かせた結果として読むことができます。

    免責事項

    この記事は、筆者が個人として調べたことや経験をもとに、執筆時点の内容をまとめたものです。分かりやすさを優先し、細かい条件や例外を省いている場合があります。

    動作は、検証用の API サーバーと Chromium で確かめたもので、バージョンや設定、ブラウザーによって変わることがあります。実際の開発では、公式の文書で最新の内容を確認し、本番の前に検証してください。

    製品の仕様などは変わることがあります。この記事の内容を利用して生じた損害については、責任を負いかねます。

    NDシステムズについて

    NDシステムズは、福岡県久留米市を拠点に、ホームページの制作、業務に合わせた事務のシステムの開発、AI・DX支援を行っています。まずはお気軽に無料相談でご相談ください。

    参考文献

    1. 同一オリジンポリシー(MDN Web Docs)

    2. The Same Origin Policy(Mozilla、アーカイブ)(英語)

    3. Cross-Origin Resource Sharing, W3C Recommendation 16 January 2014(W3C)(英語)

    4. オリジン間リソース共有 (CORS)(MDN Web Docs)

    5. Fetch Standard - CORS protocol(WHATWG)(英語)

    6. HTML5 Security Cheat Sheet(OWASP Cheat Sheet Series)(英語)

    7. Set-Cookie(MDN Web Docs)

    8. Site (サイト)(MDN Web Docs 用語集)

     
     
    福岡県久留米市のNDシステムズです。IT・AI、語学、会計、数学、九州北部の風景などについて、調べて考えたことを書いています。記事は筆者が個人として調べた執筆時点の内容で、専門家の助言ではありません。最新の情報は出典でご確認ください。

    あなたへのおすすめ