ASP.NET Core Blazor WebAssembly .NET バンドルのキャッシュと整合性チェックの失敗

この記事では、 Blazor WebAssembly の資産キャッシュと、整合性エラーを診断して解決する方法について説明します。

Blazor WebAssembly アプリがブラウザーに読み込まれると、アプリはサーバーからブート リソースをダウンロードします。

• アプリをブートストラップする JavaScript コード
• .NET ランタイムとアセンブリ
• ロケール固有のデータ

ファイルの整合性を管理するための Blazor のアルゴリズム:

• たとえば、ユーザーがアプリケーション ファイルをダウンロードしている間に、Web サーバーに新しい展開が適用された場合などに、アプリによって整合性のないファイルのセットが読み込まれるリスクがないことが保証されます。 ファイルに整合性がないと、アプリが誤動作する可能性があります。
• ユーザーのブラウザーによって不整合のない応答や無効な応答がキャッシュされないことが保証されます。そのようなことがあると、ユーザーがページを手動で更新してもアプリを起動できなくなる可能性があります。
• 応答をキャッシュし、想定される SHA-256 ハッシュ自体の変更までサーバー側の変更をチェックしなくても安全になるため、後続のページ読み込みに伴う要求の数が減り、速く完了するようになります。

想定される SHA-256 ハッシュに一致しない応答が Web サーバーから返された場合、ブラウザーの開発者コンソールに次の例のようなエラーが表示されます。

Failed to find a valid digest in the 'integrity' attribute for resource 'https://myapp.example.com/_framework/MyBlazorApp.dll' with computed SHA-256 integrity 'IIa70iwvmEg5WiDV17OpQ5eCztNYqL186J56852RpJY='. (計算された SHA-256 整合性 'IIa70iwvmEg5WiDV17OpQ5eCztNYqL186J56852RpJY=' を持つリソース 'https://myapp.example.com/_framework/MyBlazorApp.dll' の 'integrity' 属性に有効なダイジェストが見つかりませんでした。) The resource has been blocked. (リソースがブロックされています。)

ほとんどの場合、この警告は整合性チェックに関する問題を示していません。 代わりに、通常、警告は他の問題が存在することを意味します。

Blazor WebAssemblyのブート参照ソースについては、Boot.WebAssembly.ts GitHub リポジトリのdotnet/aspnetcore ファイルを参照してください。

整合性の問題を診断する

アプリがビルドされると、生成されたブート マニフェストは、ビルド出力が生成されたときのブート リソースの SHA-256 ハッシュを記述します。 ブート マニフェストの SHA-256 ハッシュがブラウザーに配信されたファイルと一致する限り、整合性チェックは合格します。

これが失敗する一般的な理由は次のとおりです。

• Web サーバーの応答は、ブラウザーが要求したファイルではなく、エラー (たとえば、 404 - Not Found または 500 - Internal Server Error) です。 これはブラウザーによって、応答エラーとしてではなく整合性チェックの失敗として報告されます。
• ファイルのビルドからブラウザーへの配信の間に、何らかによってファイルの内容が変更された場合。 次のような場合に発生します。
  • ユーザーまたはビルド ツールによって、ビルド出力が手動で変更された場合。
  • 展開プロセスの何らかの側面によってファイルが変更された場合。 たとえば、Git ベースの展開メカニズムを使用する場合は、Windows でファイルをコミットして Linux でチェックアウトすると、Git によって Windows スタイルの改行コードが Unix スタイルの改行コードに透過的に変換されることに注意してください。 ファイルの改行コードを変更すると、SHA-256 ハッシュが変更されます。 この問題を回避するには、.gitattributesを使用してビルド成果物をbinary ファイルとして扱うことを検討してください。
  • Web サーバーによるファイル提供の一環として、その内容が変更された場合。 たとえば、一部のコンテンツ配布ネットワーク (CDN) は HTML の 縮小 を自動的に試み、それによって HTML を変更します。 場合によっては、このような機能を無効にする必要があります。
• ブート マニフェストが正しく読み込みに失敗するか、クライアントに正しくキャッシュされません。 一般的な原因は次のどちらかです。
  • 正しく構成されていないか、誤動作しているカスタム開発者コード。
  • 1 つ以上の正しく構成されていない中間キャッシュ レイヤー。

これらのうちどれが自分のケースに当てはまるか診断するには:

サーバーから正しいと思われるデータが返されていることを確認した場合は、ファイルのビルドと配布の間で何か別の原因によって内容が変更されています。 これを調査するには:

• ファイルがビルドされた後にファイルが変更される場合に備えて、ビルド ツールチェーンと展開メカニズムを調べます。 この例としては、前に説明したように、Git によってファイルの改行コードが変換される場合が挙げられます。
• 応答を動的に変更する (たとえば、HTML を縮小しようとする) ように設定されている場合があるため、Web サーバーまたは CDN の構成を確認します。 Web サーバーに HTTP 圧縮が実装されていても問題ありません (たとえば content-encoding: br や content-encoding: gzip が返される場合)。これは展開後の結果には影響しないためです。 ただし、Web サーバーが圧縮されていないデータを変更することは許されません。

.\integrity.ps1 {BASE URL} {PUBLISH OUTPUT FOLDER}

.\integrity.ps1 https://localhost:5001/ C:\TestApps\BlazorSample\bin\Release\net6.0\publish\

C:\Users\{USER}\Documents\GitHub\AspNetCore.Docs\aspnetcore\blazor\host-and-deploy\webassembly\_samples\integrity.ps1

CertUtil -hashfile {PATH AND FILE NAME} {SHA256|MD5}

非 PWA アプリの整合性チェックを無効にする

ほとんどの場合、整合性チェックを無効にしないでください。 整合性チェックを無効にしても、予期しない応答の原因となった根本的な問題は解決されず、前述の利点が失われる結果になります。

Web サーバーから一貫した応答が返されるとは限らないため、基になっている問題が解決されるまで、整合性チェックを一時的に無効にするしかないケースがあります。

<BlazorCacheBootResources>false</BlazorCacheBootResources>

整合性チェックを無効にする必要があるシナリオの完全な一覧を提供することはできません。 サーバーは、Blazor フレームワークの範囲外の任意の方法で要求に応答できます。 このフレームワークでは、アプリが 提供できる整合性の保証を失う代償でアプリを実行できるようにする上記のアプローチを許可します。 ここでも、整合性チェックを無効にしないことをお勧めします (特に運用展開の場合)。 開発者は、整合性チェックが失敗する原因になっている、根本的な整合性の問題を解決する必要があります。

整合性の問題が発生する可能性があるいくつかの一般的なケースを次に示します。

• 整合性をチェックできない HTTP での実行。
• 展開プロセスによって、発行後のファイルに何らかの変更が加えられる場合。
• ホストによってファイルに何らかの変更が行われる場合。

PWA の整合性チェックを無効にする

Blazor のプログレッシブ Web アプリケーション (PWA) テンプレートには、オフライン使用のためにアプリケーション ファイルをフェッチおよび格納するための推奨される service-worker.published.js ファイルが含まれています。 これは通常のアプリの起動メカニズムとは別のプロセスであり、独自の整合性チェック ロジックを備えています。

service-worker.published.js ファイル内に、次の行があります。

.map(asset => new Request(asset.url, { integrity: asset.hash }));

整合性チェックを無効にするには、行を次のように変更して integrity パラメーターを削除します。

.map(asset => new Request(asset.url));

ここでも、整合性チェックを無効にすることは、整合性チェックによって提供される安全性の保証が失われることを意味します。 たとえば、ユーザーのブラウザーでアプリをキャッシュしている瞬間に、新しいバージョンを展開した場合、古い展開から一部のファイルがキャッシュされ、新しい展開から別のファイルがキャッシュされるリスクがあります。 そのような場合、さらなる更新プログラムを展開するまで、アプリは破損した状態のままになります。