/
index.test.ts
370 lines (319 loc) · 13.3 KB
/
index.test.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
import { IncomingMessage, ServerResponse } from "http";
import { check } from "./helpers";
import connect from "connect";
import supertest from "supertest";
import * as helmet from "..";
import contentSecurityPolicy from "../middlewares/content-security-policy";
import crossOriginEmbedderPolicy from "../middlewares/cross-origin-embedder-policy";
import crossOriginOpenerPolicy from "../middlewares/cross-origin-opener-policy";
import crossOriginResourcePolicy from "../middlewares/cross-origin-resource-policy";
import expectCt from "../middlewares/expect-ct";
import referrerPolicy from "../middlewares/referrer-policy";
import originAgentCluster from "../middlewares/origin-agent-cluster";
import strictTransportSecurity from "../middlewares/strict-transport-security";
import xContentTypeOptions from "../middlewares/x-content-type-options";
import xDnsPrefetchControl from "../middlewares/x-dns-prefetch-control";
import xDownloadOptions from "../middlewares/x-download-options";
import xFrameOptions from "../middlewares/x-frame-options";
import xPermittedCrossDomainPolicies from "../middlewares/x-permitted-cross-domain-policies";
import xPoweredBy from "../middlewares/x-powered-by";
import xXssProtection from "../middlewares/x-xss-protection";
describe("helmet", () => {
const topLevel = helmet.default;
it("includes all middleware, except Expect-CT, with their default options", async () => {
// NOTE: This test relies on the CSP object being ordered a certain way,
// which could change (and be non-breaking). If that becomes a problem,
// we should update this test to be more robust.
const expectedHeaders = {
"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",
"cross-origin-embedder-policy": "require-corp",
"cross-origin-opener-policy": "same-origin",
"cross-origin-resource-policy": "same-origin",
// In Helmet 7, we can remove this Expect-CT assertion.
"expect-ct": null,
"origin-agent-cluster": "?1",
"referrer-policy": "no-referrer",
"strict-transport-security": "max-age=15552000; includeSubDomains",
"x-content-type-options": "nosniff",
"x-dns-prefetch-control": "off",
"x-download-options": "noopen",
"x-frame-options": "SAMEORIGIN",
"x-permitted-cross-domain-policies": "none",
"x-powered-by": null,
"x-xss-protection": "0",
};
await check(topLevel(), expectedHeaders);
await check(topLevel({}), expectedHeaders);
await check(topLevel(Object.create(null)), expectedHeaders);
});
it("allows individual middlewares to be disabled", async () => {
await check(topLevel({ contentSecurityPolicy: false }), {
"content-security-policy": null,
});
await check(topLevel({ dnsPrefetchControl: false }), {
"x-dns-prefetch-control": null,
});
});
// In Helmet 7, this test should be removed.
it("allows Expect-CT to be enabled", async () => {
await check(topLevel({ expectCt: true }), {
"expect-ct": "max-age=0",
});
await check(topLevel({ expectCt: { maxAge: 123 } }), {
"expect-ct": "max-age=123",
});
});
it("works with all default middlewares disabled", async () => {
await check(
topLevel({
contentSecurityPolicy: false,
dnsPrefetchControl: false,
expectCt: false,
frameguard: false,
hidePoweredBy: false,
hsts: false,
ieNoOpen: false,
noSniff: false,
originAgentCluster: false,
permittedCrossDomainPolicies: false,
referrerPolicy: false,
xssFilter: false,
crossOriginEmbedderPolicy: false,
}),
{
"content-security-policy": null,
"x-frame-options": null,
}
);
});
it("errors when `use`d directly", () => {
const fakeRequest = {
constructor: {
name: "IncomingMessage",
},
};
expect(() => {
topLevel(fakeRequest as any);
}).toThrow();
});
it("allows default middleware to be explicitly enabled (a no-op)", async () => {
await check(topLevel({ frameguard: true }), {
"x-frame-options": "SAMEORIGIN",
});
});
it("allows Cross-Origin-Embedder-Policy middleware to be enabled", async () => {
await check(topLevel({ crossOriginEmbedderPolicy: true }), {
"cross-origin-embedder-policy": "require-corp",
});
});
it("allows Cross-Origin-Embedder-Policy middleware to be explicitly disabled", async () => {
await check(topLevel({ crossOriginEmbedderPolicy: false }), {
"cross-origin-embedder-policy": null,
});
});
it("allows Cross-Origin-Opener-Policy middleware to be enabled with its default", async () => {
await check(topLevel({ crossOriginOpenerPolicy: true }), {
"cross-origin-opener-policy": "same-origin",
});
});
it("allows Cross-Origin-Opener-Policy middleware to be enabled with custom arguments", async () => {
await check(
topLevel({
crossOriginOpenerPolicy: { policy: "same-origin-allow-popups" },
}),
{
"cross-origin-opener-policy": "same-origin-allow-popups",
}
);
});
it("allows Cross-Origin-Opener-Policy middleware to be explicitly disabled", async () => {
await check(topLevel({ crossOriginOpenerPolicy: false }), {
"cross-origin-opener-policy": null,
});
});
it("allows Cross-Origin-Resource-Policy middleware to be enabled with its default", async () => {
await check(topLevel({ crossOriginResourcePolicy: true }), {
"cross-origin-resource-policy": "same-origin",
});
});
it("allows Cross-Origin-Resource-Policy middleware to be enabled with custom arguments", async () => {
await check(
topLevel({ crossOriginResourcePolicy: { policy: "same-site" } }),
{
"cross-origin-resource-policy": "same-site",
}
);
});
it("allows Cross-Origin-Resource-Policy middleware to be explicitly disabled", async () => {
await check(topLevel({ crossOriginResourcePolicy: false }), {
"cross-origin-resource-policy": null,
});
});
it("allows Origin-Agent-Cluster middleware to be enabled", async () => {
await check(topLevel({ originAgentCluster: true }), {
"origin-agent-cluster": "?1",
});
});
it("allows Origin-Agent-Cluster middleware to be explicitly disabled", async () => {
await check(topLevel({ originAgentCluster: false }), {
"origin-agent-cluster": null,
});
});
it("properly handles a middleware calling `next()` with an error", async () => {
const app = connect()
.use(
topLevel({
contentSecurityPolicy: {
directives: {
defaultSrc: ["'self'", () => "bad;value"],
},
},
})
)
.use(
(
err: Error,
_req: IncomingMessage,
res: ServerResponse,
// eslint-disable-next-line @typescript-eslint/no-unused-vars
_next: () => void
) => {
res.statusCode = 500;
res.setHeader("Content-Type", "application/json");
res.end(JSON.stringify({ message: err.message }));
}
);
await supertest(app).get("/").expect(500, {
message:
'Content-Security-Policy received an invalid directive value for "default-src"',
});
});
describe("warnings", () => {
beforeEach(() => {
jest.spyOn(console, "warn").mockImplementation(() => {});
});
it("logs a warning when passing options to crossOriginEmbedderPolicy", () => {
topLevel({ crossOriginEmbedderPolicy: { option: "foo" } as any });
expect(console.warn).toHaveBeenCalledTimes(1);
expect(console.warn).toHaveBeenCalledWith(
"crossOriginEmbedderPolicy does not take options. Remove the property to silence this warning."
);
});
it("logs a warning when passing options to hidePoweredBy", () => {
topLevel({ hidePoweredBy: { setTo: "deprecated option" } as any });
expect(console.warn).toHaveBeenCalledTimes(1);
expect(console.warn).toHaveBeenCalledWith(
"hidePoweredBy does not take options. Remove the property to silence this warning."
);
});
it("logs a warning when passing options to ieNoOpen", () => {
topLevel({ ieNoOpen: { option: "foo" } as any });
expect(console.warn).toHaveBeenCalledTimes(1);
expect(console.warn).toHaveBeenCalledWith(
"ieNoOpen does not take options. Remove the property to silence this warning."
);
});
it("logs a warning when passing options to originAgentCluster", () => {
topLevel({ originAgentCluster: { option: "foo" } as any });
expect(console.warn).toHaveBeenCalledTimes(1);
expect(console.warn).toHaveBeenCalledWith(
"originAgentCluster does not take options. Remove the property to silence this warning."
);
});
it("logs a warning when passing options to noSniff", () => {
topLevel({ noSniff: { option: "foo" } as any });
expect(console.warn).toHaveBeenCalledTimes(1);
expect(console.warn).toHaveBeenCalledWith(
"noSniff does not take options. Remove the property to silence this warning."
);
});
it("logs a warning when passing options to xssFilter", () => {
topLevel({ xssFilter: { setOnOldIe: true } as any });
expect(console.warn).toHaveBeenCalledTimes(1);
expect(console.warn).toHaveBeenCalledWith(
"xssFilter does not take options. Remove the property to silence this warning."
);
});
});
describe("module aliases", () => {
it("aliases the X-DNS-Prefetch-Control middleware to helmet.dnsPrefetchControl", () => {
expect(helmet.dnsPrefetchControl.name).toBe(xDnsPrefetchControl.name);
expect(helmet.dnsPrefetchControl.name).toBe("xDnsPrefetchControl");
});
it("aliases the Cross-Origin-Embedder-Policy middleware to helmet.crossOriginEmbedderPolicy", () => {
expect(helmet.crossOriginEmbedderPolicy.name).toBe(
crossOriginEmbedderPolicy.name
);
expect(helmet.crossOriginEmbedderPolicy.name).toBe(
"crossOriginEmbedderPolicy"
);
});
it("aliases the Cross-Origin-Opener-Policy middleware to helmet.crossOriginOpenerPolicy", () => {
expect(helmet.crossOriginOpenerPolicy.name).toBe(
crossOriginOpenerPolicy.name
);
expect(helmet.crossOriginOpenerPolicy.name).toBe(
"crossOriginOpenerPolicy"
);
});
it("aliases the Cross-Origin-Resource-Policy middleware to helmet.crossOriginResourcePolicy", () => {
expect(helmet.crossOriginResourcePolicy.name).toBe(
crossOriginResourcePolicy.name
);
expect(helmet.crossOriginResourcePolicy.name).toBe(
"crossOriginResourcePolicy"
);
});
it("aliases the X-Content-Type-Options middleware to helmet.noSniff", () => {
expect(helmet.noSniff.name).toBe(xContentTypeOptions.name);
expect(helmet.noSniff.name).toBe("xContentTypeOptions");
});
it("aliases the Expect-CT middleware to helmet.expectCt", () => {
expect(helmet.expectCt.name).toBe(expectCt.name);
expect(helmet.expectCt.name).toBe("expectCt");
});
it("aliases the X-Permitted-Cross-Domain-Policies middleware to helmet.crossdomain", () => {
expect(helmet.permittedCrossDomainPolicies.name).toBe(
xPermittedCrossDomainPolicies.name
);
expect(helmet.permittedCrossDomainPolicies.name).toBe(
"xPermittedCrossDomainPolicies"
);
});
it("aliases the X-Frame-Options middleware to helmet.frameguard", () => {
expect(helmet.frameguard.name).toBe(xFrameOptions.name);
expect(helmet.frameguard.name).toBe("xFrameOptions");
});
it("aliases the Content-Security-Policy middleware to helmet.contentSecurityPolicy", () => {
expect(helmet.contentSecurityPolicy.name).toBe(
contentSecurityPolicy.name
);
expect(helmet.contentSecurityPolicy.name).toBe("contentSecurityPolicy");
});
it("aliases the X-Powered-By middleware to helmet.hidePoweredBy", () => {
expect(helmet.hidePoweredBy.name).toBe(xPoweredBy.name);
expect(helmet.hidePoweredBy.name).toBe("xPoweredBy");
});
it("aliases the Strict-Transport-Security middleware to helmet.hsts", () => {
expect(helmet.hsts.name).toBe(strictTransportSecurity.name);
expect(helmet.hsts.name).toBe("strictTransportSecurity");
});
it("aliases the X-Download-Options middleware to helmet.ieNoOpen", () => {
expect(helmet.ieNoOpen.name).toBe(xDownloadOptions.name);
expect(helmet.ieNoOpen.name).toBe("xDownloadOptions");
});
it("aliases the Referrer-Policy middleware to helmet.referrerPolicy", () => {
expect(helmet.referrerPolicy.name).toBe(referrerPolicy.name);
expect(helmet.referrerPolicy.name).toBe("referrerPolicy");
});
it("aliases the Origin-Agent-Cluster middleware to helmet.originAgentCluster", () => {
expect(helmet.originAgentCluster.name).toBe(originAgentCluster.name);
expect(helmet.originAgentCluster.name).toBe("originAgentCluster");
});
it("aliases the X-XSS-Protection middleware to helmet.xssFilter", () => {
expect(helmet.xssFilter.name).toBe(xXssProtection.name);
expect(helmet.xssFilter.name).toBe("xXssProtection");
});
});
});