This post is aimed at people that have some familiarity with my Helmet Node.js module.
Helmet is a Node.js module that helps you secure your Express applications by setting various HTTP headers. It sets headers like
X-Frame-Options to help prevent a kind of attack called "clickjacking" or
X-XSS-Filter as a basic protection against cross-site scripting attacks. If you're writing an Express app (or a Connect or Koa app), I hope you'll give it a look!
The bulk of the module is pretty straightforward: just set nine HTTP headers. Some of the headers are set every time no matter what, while others have a small amount of logic associated with them. Eight of them are simple and one of them is a beast: the Content Security Policy (CSP) module. I'll spend this post talking about why that module is so much bigger than the rest.
Expect this to be boring.
I certainly feel like the CSP part of Helmet is the biggest. I spend the most time working on it and it's the hardest to wrap my head around. But how much bigger is it?
cloc is a cool program that counts lines of code. I used it to see which module was the biggest, and made sure to exclude
package.json, and test files. To see how big each module was, I ran this command in each directory:
It gave me the following stats:
- helmetjs/helmet - 47 lines
- helmetjs/csp - 199 lines
- helmetjs/content-security-policy-builder - 24 lines
- helmetjs/hide-powered-by - 14 lines
- helmetjs/hpkp - 44 lines
- helmetjs/hsts - 49 lines
- helmetjs/ienoopen - 6 lines
- helmetjs/nocache - 13 lines
- helmetjs/dont-sniff-mimetype - 6 lines
- helmetjs/frameguard - 27 lines
- helmetjs/x-xss-protection - 20 lines
You can think of it this way:
- CSP code: 223 lines
- everything else combined: 226 lines
Why is it so big?
In short, the size of the CSP module comes from browser sniffing.
Every browser supports a slightly different variation of Content Security Policy (or don't support it at all). The simplest example is the name of the header. Newer browsers call the header
Content-Security-Policy and older ones choose
X-WebKit-CSP. There are loads of other browser differences that are much more difficult to deal with.
The CSP module has to inspect user agents to figure out what headers to set and how to set them. This is a nightmare. Without browser sniffing, this module would probably be about 30 lines; with browser sniffing, it's almost 200!
In my opinion, that's the real differentiator of Helmet. The rest of the library could be rewritten from scratch in a pretty short amount of time, but the amount of code and research that went into CSP-related browser quirks is pretty unique. It's the most frustrating to deal with, but it's the most important!