Helmet
Help secure Express apps with various HTTP headers
Install / Use
/learn @helmetjs/HelmetREADME
Helmet
Helmet helps secure Node/Express apps. It sets HTTP response headers such as Content-Security-Policy and Strict-Transport-Security. It aims to be quick to integrate and be low maintenance afterward.
Quick start
import helmet from "helmet";
const app = express();
app.use(helmet());
This will set 13 HTTP response headers in your app.
Helmet can also be used in standalone Node.js, or with other frameworks.
Configuration
Each header can be disabled. To disable a header:
// Disable the Content-Security-Policy and X-Download-Options headers
app.use(
helmet({
contentSecurityPolicy: false,
xDownloadOptions: false,
}),
);
To configure a header, pass header-specific options:
// Configure the Content-Security-Policy header.
app.use(
helmet({
contentSecurityPolicy: {
directives: {
"script-src": ["'self'", "example.com"],
},
},
}),
);
HTTP header reference
<details id="content-security-policy"> <summary><code>Content-Security-Policy</code></summary>Default:
Content-Security-Policy: default-src 'self';base-uri 'self';font-src 'self' https: data:;form-action 'self';frame-ancestors 'self';img-src 'self' data:;object-src 'none';script-src 'self';script-src-attr 'none';style-src 'self' https: 'unsafe-inline';upgrade-insecure-requests
The Content-Security-Policy header mitigates a large number of attacks, such as [cross-site scripting][XSS]. See MDN's introductory article on Content Security Policy.
This header is powerful but likely requires some configuration for your specific app.
To configure this header, pass an object with a nested directives object. Each key is a directive name in camel case (such as defaultSrc) or kebab case (such as default-src). Each value is an array (or other iterable) of strings or functions for that directive. If a function appears in the array, it will be called with the request and response objects.
// Sets all of the defaults, but overrides `script-src`
// and disables the default `style-src`.
app.use(
helmet({
contentSecurityPolicy: {
directives: {
"script-src": ["'self'", "example.com"],
"style-src": null,
},
},
}),
);
// Sets the `script-src` directive to
// "'self' 'nonce-e33cc...'"
// (or similar)
app.use((req, res, next) => {
res.locals.cspNonce = crypto.randomBytes(32).toString("hex");
next();
});
app.use(
helmet({
contentSecurityPolicy: {
directives: {
scriptSrc: ["'self'", (req, res) => `'nonce-${res.locals.cspNonce}'`],
},
},
}),
);
These directives are merged into a default policy, which you can disable by setting useDefaults to false.
// Sets "Content-Security-Policy: default-src 'self';
// script-src 'self' example.com;object-src 'none';
// upgrade-insecure-requests"
app.use(
helmet({
contentSecurityPolicy: {
useDefaults: false,
directives: {
defaultSrc: ["'self'"],
scriptSrc: ["'self'", "example.com"],
objectSrc: ["'none'"],
upgradeInsecureRequests: [],
},
},
}),
);
You can get the default directives object with helmet.contentSecurityPolicy.getDefaultDirectives(). Here is the default policy (formatted for readability):
default-src 'self';
base-uri 'self';
font-src 'self' https: data:;
form-action 'self';
frame-ancestors 'self';
img-src 'self' data:;
object-src 'none';
script-src 'self';
script-src-attr 'none';
style-src 'self' https: 'unsafe-inline';
upgrade-insecure-requests
The default-src directive can be explicitly disabled by setting its value to helmet.contentSecurityPolicy.dangerouslyDisableDefaultSrc, but this is not recommended.
You can set the Content-Security-Policy-Report-Only instead:
// Sets the Content-Security-Policy-Report-Only header
app.use(
helmet({
contentSecurityPolicy: {
directives: {
/* ... */
},
reportOnly: true,
},
}),
);
upgrade-insecure-requests, a directive that causes browsers to upgrade HTTP to HTTPS, is set by default. You may wish to avoid this in development, as you may not be developing with HTTPS. Notably, Safari will upgrade http://localhost to https://localhost, which can cause problems. To work around this, you may wish to disable the upgrade-insecure-requests directive in development. For example:
const isDevelopment = app.get("env") === "development";
app.use(
helmet({
contentSecurityPolicy: {
directives: {
// Disable upgrade-insecure-requests in development.
"upgrade-insecure-requests": isDevelopment ? null : [],
},
},
}),
);
Helmet performs very little validation on your CSP. You should rely on CSP checkers like CSP Evaluator instead.
To disable the Content-Security-Policy header:
app.use(
helmet({
contentSecurityPolicy: false,
}),
);
You can use this as standalone middleware with app.use(helmet.contentSecurityPolicy()).
This header is not set by default.
The Cross-Origin-Embedder-Policy header helps control what resources can be loaded cross-origin. See MDN's article on this header for more.
// Helmet does not set Cross-Origin-Embedder-Policy
// by default.
app.use(helmet());
// Sets "Cross-Origin-Embedder-Policy: require-corp"
app.use(helmet({ crossOriginEmbedderPolicy: true }));
// Sets "Cross-Origin-Embedder-Policy: credentialless"
app.use(helmet({ crossOriginEmbedderPolicy: { policy: "credentialless" } }));
You can use this as standalone middleware with app.use(helmet.crossOriginEmbedderPolicy()).
Default:
Cross-Origin-Opener-Policy: same-origin
The Cross-Origin-Opener-Policy header helps process-isolate your page. For more, see MDN's article on this header.
// Sets "Cross-Origin-Opener-Policy: same-origin"
app.use(helmet());
// Sets "Cross-Origin-Opener-Policy: same-origin-allow-popups"
app.use(
helmet({
crossOriginOpenerPolicy: { policy: "same-origin-allow-popups" },
}),
);
To disable the Cross-Origin-Opener-Policy header:
app.use(
helmet({
crossOriginOpenerPolicy: false,
}),
);
You can use this as standalone middleware with app.use(helmet.crossOriginOpenerPolicy()).
Default:
Cross-Origin-Resource-Policy: same-origin
The Cross-Origin-Resource-Policy header blocks others from loading your resources cross-origin in some cases. For more, see "Consider deploying Cross-Origin Resource Policy" and MDN's article on this header.
// Sets "Cross-Origin-Resource-Policy: same-origin"
app.use(helmet());
// Sets "Cross-Origin-Resource-Policy: same-site"
app.use(helmet({ crossOriginResourcePolicy: { policy: "same-site" } }));
To disable the Cross-Origin-Resource-Policy header:
app.use(
helmet({
crossOriginResourcePolicy: false,
}),
);
You can use this as standalone middleware with app.use(helmet.crossOriginResourcePolicy()).
Default:
Origin-Agent-Cluster: ?1
The Origin-Agent-Cluster header provides a mechanism to allow web applications to isolate their origins from other processes. Read more about it in the spec.
This header takes no options and is set by default.
// Sets "Origin-Agent-Cluster: ?1"
app.use(helmet());
To disable the Origin-Agent-Cluster header:
app.use(
helmet({
originAgentCluster: false,
}),
);
You can use this as standalone middleware with app.use(helmet.originAgentCluster()).
Default:
Referrer-Policy: no-referrer
The Referrer-Policy header which controls what information is set in [the Referer request header][Referer]. See "Referer header: privacy and security concerns" and the header's documentation on MDN for more.
// Sets "Referrer-Policy: no-referrer"
app.use(helmet());
policy is a string or array of strings representing the policy. If passed as an array, it will be joined with commas, which is useful when setting a fallback policy. It defaults to no-referrer.
// Sets "Referrer-Policy: no-referrer"
app.use(
helmet({
referrerPolicy: {
policy: "no-referrer",
},
}),
);
// Sets "Referrer-Policy: origin,unsafe-url"
app.use(
helmet({
referrerPolicy: {
policy: ["origin", "unsafe-url"],
},
}),
);
To disable the Referrer-Policy header:
app.use(
helmet({
referrerPolicy: false,
}),
);
You can use this as standalone midd
