@k8ordo/color-scheme

CSP

ColorSchemeScriptは、最初の描画の前にインラインスクリプトを実行します。Content-Security-Policy(CSP)の下では、nonceかハッシュをポリシーに書いて許可します。

このページの内容

許可しないときの動作

ポリシーが許可していないスクリプトは実行されず、ブラウザは違反をコンソールに出します。ハイドレーションのあとでプロバイダのeffectがクラスを付けるので、最終的な配色は正しくなります。

それまでは<html>にdarkクラスが付かないので、ライトの配色で描かれます。ダークになる訪問者には、ライトの画面が一瞬見えます。themeColorを渡していても、theme-colorのmetaは書かれません。

警告

落とし穴

'unsafe-inline'を足せば動きますが、ページにあるほかのインラインスクリプトもすべて動きます。このスクリプトだけを、nonceかハッシュで許可してください。

nonceでの許可

src/routes/layout.tsx
import {
  ColorSchemeProvider,
  ColorSchemeScript,
} from '@k8ordo/color-scheme';
import { nonce } from '@k8ordo/framework/server';
import type { ReactNode } from 'react';

export default function RootLayout({
  children,
}: {
  children: ReactNode;
}) {
  return (
    <html lang="en" suppressHydrationWarning>
      <head>
        <ColorSchemeScript nonce={nonce()} />
応答ごとのnonce。ポリシーに書いた値と同じもの
      </head>
      <body>
        <ColorSchemeProvider>{children}</ColorSchemeProvider>
      </body>
    </html>
  );
}

ポリシーに書いたnonceを、ColorSchemeScriptのnonce propに渡します。スクリプトのnonce属性にその値が付き、script-src 'nonce-…'の下で実行されます。

@k8ordo/frameworkのserverモードでのポリシーの書き方は@k8ordo/frameworkのCSPを見てください。

ハッシュでの許可

ts
import { colorSchemeScriptHash } from '@k8ordo/color-scheme';

const policy = `script-src 'self' ${await colorSchemeScriptHash()}`;

colorSchemeScriptHash()は、スクリプトのSHA-256をCSPのソースの形('sha256-…')で返します。戻り値はPromiseなのでawaitします。静的なファイルとして配信するページのように応答ごとのnonceが無いときは、この値をscript-srcに書きます。

ハッシュの値は書き写さず、ポリシーを組み立てるコードの中で毎回計算します。スクリプトの文字列はインストールしたバージョンのもので、更新で変わることがあります。

staticモードでframework()のcspオプションに書く方法は@k8ordo/frameworkのCSPを見てください。

渡す値とハッシュ

src/routes/layout.tsx
<head>
  <ColorSchemeScript
    defaultPreference="dark"
    themeColor={themeColor}
  />
</head>
<body>
  <ColorSchemeProvider defaultPreference="dark">
    {children}
  </ColorSchemeProvider>
</body>
ts
const hash = await colorSchemeScriptHash({
  defaultPreference: 'dark',
  themeColor,
});
const policy = `script-src 'self' ${hash}`;

スクリプトの文字列には、既定値とthemeColorの色が入ります。そのため、ハッシュは渡した値ごとに違います。ColorSchemeScriptにdefaultPreferenceやthemeColorを渡しているなら、colorSchemeScriptHash()にも同じ値を渡します。

nonceで許可しているときは、既定値や色を変えてもポリシーはそのままです。

k8ordo

Baselineに入った機能を、制限なく使うReactのライブラリ群。