@middy/http-security-headers 3.0.0-alpha.0 → 3.0.0-alpha.4

package/README.md

@@ -36,18 +36,26 @@ To install this middleware you can use NPM:
 npm install --save @middy/http-security-headers
 ```
 
-
 ## Options
-
- - `dnsPrefetchControl` controls browser DNS prefetching
- - `expectCt` for handling Certificate Transparency (Future Feature)
- - `frameguard` to prevent clickjacking
- - `hidePoweredBy` to remove the Server/X-Powered-By header
- - `hsts` for HTTP Strict Transport Security
- - `ieNoOpen` sets X-Download-Options for IE8+
- - `noSniff` to keep clients from sniffing the MIME type
- - `referrerPolicy` to hide the Referer header
- - `xssFilter` adds some small XSS protections
+Setting an option to `false` to cause that rule to be ignored.
+
+### All Responses
+- `originAgentCluster`: Default to `{}` to include
+- `referrerPolicy`: Default to `{ policy: 'no-referrer' }`
+- `strictTransportSecurity`: Default to `{ maxAge: 15552000, includeSubDomains: true, preload: true }`
+- X-`dnsPrefetchControl`: Default to `{ allow: false }`
+- X-`downloadOptions`: Default to `{ action: 'noopen' }`
+- X-`poweredBy`: Default to `{ server: '' }` to remove `Server` and `X-Powered-By`
+- X-`contentTypeOptions`: Default to `{ action: 'nosniff' }`
+### HTML Responses
+- `contentSecurityPolicy`: Default to `{ 'default-src': "'none'", 'base-uri':"'none'", 'sandbox':'', 'form-action':"'none'", 'frame-ancestors':"'none'", 'navigate-to':"'none'", 'report-to':'csp', 'require-trusted-types-for':"'script'", 'trusted-types':"'none'", 'upgrade-insecure-requests':'' }`
+- `crossOriginEmbedderPolicy`: Default to `{ policy: 'require-corp' }`
+- `crossOriginOpenerPolicy`: Default to `{ policy: 'same-origin' }`
+- `crossOriginResourcePolicy`: Default to `{ policy: 'same-origin' }`
+- `permissionsPolicy`: Default to `{ *:'', ... }` where all allowed values are set to disable
+- `reportTo`: Defaults to `{ maxAge: 31536000, default: '', includeSubdomains: true, csp: '', staple:'', xss: '' }` which won't report by default, needs setting
+- X-`frameOptions`: Default to `{ action: 'deny' }`
+- X-`xssProtection`: Defaults to `{ reportUri: '' }'`
 
 
 ## Sample usage

package/index.d.ts

@@ -4,32 +4,28 @@ interface Options {
   dnsPrefetchControl?: {
     allow?: boolean
   }
-  expectCT?: {
-    enforce?: boolean
-    maxAge?: number
-    reportUri?: string
-  }
-  frameguard?: {
+  frameOptions?: {
     action?: string
   }
-  hidePoweredBy?: {
-    setTo: string
+  poweredBy?: {
+    server: string
   }
-  hsts?: {
+  strictTransportSecurity?: {
     maxAge?: number
     includeSubDomains?: boolean
     preload?: boolean
   }
-  ieNoOpen?: {
+  downloadOptions?: {
     action?: string
   }
-  noSniff?: {
+  contentTypeOptions?: {
     action?: string
   }
+  originAgentCluster?: boolean
   referrerPolicy?: {
     policy?: string
   }
-  xssFilter?: {
+  xssProtection?: {
     reportUri?: string
   }
 }

package/index.js

@@ -0,0 +1,243 @@
+import { normalizeHttpResponse } from '@middy/util';
+const defaults = {
+  contentSecurityPolicy: {
+    'default-src': "'none'",
+    'base-uri': "'none'",
+    sandbox: '',
+    'form-action': "'none'",
+    'frame-ancestors': "'none'",
+    'navigate-to': "'none'",
+    'report-to': 'csp',
+    'require-trusted-types-for': "'script'",
+    'trusted-types': "'none'",
+    'upgrade-insecure-requests': ''
+  },
+  contentTypeOptions: {
+    action: 'nosniff'
+  },
+  crossOriginEmbedderPolicy: {
+    policy: 'require-corp'
+  },
+  crossOriginOpenerPolicy: {
+    policy: 'same-origin'
+  },
+  crossOriginResourcePolicy: {
+    policy: 'same-origin'
+  },
+  dnsPrefetchControl: {
+    allow: false
+  },
+  downloadOptions: {
+    action: 'noopen'
+  },
+  frameOptions: {
+    action: 'deny'
+  },
+  originAgentCluster: {},
+  permissionsPolicy: {
+    accelerometer: '',
+    'ambient-light-sensor': '',
+    autoplay: '',
+    battery: '',
+    camera: '',
+    'cross-origin-isolated': '',
+    'display-capture': '',
+    'document-domain': '',
+    'encrypted-media': '',
+    'execution-while-not-rendered': '',
+    'execution-while-out-of-viewport': '',
+    fullscreen: '',
+    geolocation: '',
+    gyroscope: '',
+    'keyboard-map': '',
+    magnetometer: '',
+    microphone: '',
+    midi: '',
+    'navigation-override': '',
+    payment: '',
+    'picture-in-picture': '',
+    'publickey-credentials-get': '',
+    'screen-wake-lock': '',
+    'sync-xhr': '',
+    usb: '',
+    'web-share': '',
+    'xr-spatial-tracking': '',
+    'clipboard-read': '',
+    'clipboard-write': '',
+    gamepad: '',
+    'speaker-selection': '',
+    'conversion-measurement': '',
+    'focus-without-user-activation': '',
+    hid: '',
+    'idle-detection': '',
+    'interest-cohort': '',
+    serial: '',
+    'sync-script': '',
+    'trust-token-redemption': '',
+    'window-placement': '',
+    'vertical-scroll': ''
+  },
+  permittedCrossDomainPolicies: {
+    policy: 'none'
+  },
+  poweredBy: {
+    server: ''
+  },
+  referrerPolicy: {
+    policy: 'no-referrer'
+  },
+  reportTo: {
+    maxAge: 365 * 24 * 60 * 60,
+    default: '',
+    includeSubdomains: true,
+    csp: '',
+    staple: '',
+    xss: ''
+  },
+  strictTransportSecurity: {
+    maxAge: 180 * 24 * 60 * 60,
+    includeSubDomains: true,
+    preload: true
+  },
+  xssProtection: {
+    reportTo: 'xss'
+  }
+};
+const helmet = {};
+const helmetHtmlOnly = {};
+
+helmetHtmlOnly.contentSecurityPolicy = (headers, config) => {
+  let header = Object.keys(config).map(policy => config[policy] ? `${policy} ${config[policy]}` : '').filter(str => str).join('; ');
+
+  if (config.sandbox === '') {
+    header += '; sandbox';
+  }
+
+  if (config['upgrade-insecure-requests'] === '') {
+    header += '; upgrade-insecure-requests';
+  }
+
+  headers['Content-Security-Policy'] = header;
+};
+
+helmetHtmlOnly.crossOriginEmbedderPolicy = (headers, config) => {
+  headers['Cross-Origin-Embedder-Policy'] = config.policy;
+};
+
+helmetHtmlOnly.crossOriginOpenerPolicy = (headers, config) => {
+  headers['Cross-Origin-Opener-Policy'] = config.policy;
+};
+
+helmetHtmlOnly.crossOriginResourcePolicy = (headers, config) => {
+  headers['Cross-Origin-Resource-Policy'] = config.policy;
+};
+
+helmetHtmlOnly.permissionsPolicy = (headers, config) => {
+  headers['Permissions-Policy'] = Object.keys(config).map(policy => `${policy}=${policy === '*' ? '*' : `(${config[policy]})`}`).join(', ');
+};
+
+helmet.originAgentCluster = (headers, config) => {
+  headers['Origin-Agent-Cluster'] = '?1';
+};
+
+helmet.referrerPolicy = (headers, config) => {
+  headers['Referrer-Policy'] = config.policy;
+};
+
+helmetHtmlOnly.reportTo = (headers, config) => {
+  headers['Report-To'] = Object.keys(config).map(group => config[group] && group !== 'includeSubdomains' ? `{ "group": "default", "max_age": ${config.maxAge}, "endpoints": [ { "url": "${config[group]}" } ]${group === 'default' ? `, "include_subdomains": ${config.includeSubdomains}` : ''} }` : '').filter(str => str).join(', ');
+};
+
+helmet.strictTransportSecurity = (headers, config) => {
+  let header = 'max-age=' + Math.round(config.maxAge);
+
+  if (config.includeSubDomains) {
+    header += '; includeSubDomains';
+  }
+
+  if (config.preload) {
+    header += '; preload';
+  }
+
+  headers['Strict-Transport-Security'] = header;
+};
+
+helmet.contentTypeOptions = (headers, config) => {
+  headers['X-Content-Type-Options'] = config.action;
+};
+
+helmet.dnsPrefetchControl = (headers, config) => {
+  headers['X-DNS-Prefetch-Control'] = config.allow ? 'on' : 'off';
+};
+
+helmet.downloadOptions = (headers, config) => {
+  headers['X-Download-Options'] = config.action;
+};
+
+helmetHtmlOnly.frameOptions = (headers, config) => {
+  headers['X-Frame-Options'] = config.action.toUpperCase();
+};
+
+helmet.permittedCrossDomainPolicies = (headers, config) => {
+  headers['X-Permitted-Cross-Domain-Policies'] = config.policy;
+};
+
+helmet.poweredBy = (headers, config) => {
+  if (config.server) {
+    headers['X-Powered-By'] = config.server;
+  } else {
+    delete headers.Server;
+    delete headers['X-Powered-By'];
+  }
+};
+
+helmetHtmlOnly.xssProtection = (headers, config) => {
+  let header = '1; mode=block';
+
+  if (config.reportTo) {
+    header += '; report=' + config.reportTo;
+  }
+
+  headers['X-XSS-Protection'] = header;
+};
+
+const httpSecurityHeadersMiddleware = (opts = {}) => {
+  const options = { ...defaults,
+    ...opts
+  };
+
+  const httpSecurityHeadersMiddlewareAfter = async request => {
+    var _request$response$hea;
+
+    normalizeHttpResponse(request);
+    Object.keys(helmet).forEach(key => {
+      if (!options[key]) return;
+      const config = { ...defaults[key],
+        ...options[key]
+      };
+      helmet[key](request.response.headers, config);
+    });
+
+    if ((_request$response$hea = request.response.headers['Content-Type']) !== null && _request$response$hea !== void 0 && _request$response$hea.includes('text/html')) {
+      Object.keys(helmetHtmlOnly).forEach(key => {
+        if (!options[key]) return;
+        const config = { ...defaults[key],
+          ...options[key]
+        };
+        helmetHtmlOnly[key](request.response.headers, config);
+      });
+    }
+  };
+
+  const httpSecurityHeadersMiddlewareOnError = async request => {
+    if (request.response === undefined) return;
+    return httpSecurityHeadersMiddlewareAfter(request);
+  };
+
+  return {
+    after: httpSecurityHeadersMiddlewareAfter,
+    onError: httpSecurityHeadersMiddlewareOnError
+  };
+};
+
+export default httpSecurityHeadersMiddleware;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@middy/http-security-headers",
-  "version": "3.0.0-alpha.0",
+  "version": "3.0.0-alpha.4",
   "description": "Applies best practice security headers to responses. It's a simplified port of HelmetJS",
   "type": "module",
   "engines": {
@@ -13,11 +13,13 @@
   "exports": "./index.js",
   "types": "index.d.ts",
   "files": [
+    "index.js",
     "index.d.ts"
   ],
   "scripts": {
     "test": "npm run test:unit",
-    "test:unit": "ava"
+    "test:unit": "ava",
+    "test:benchmark": "node __benchmarks__/index.js"
   },
   "license": "MIT",
   "keywords": [
@@ -48,11 +50,11 @@
     "url": "https://github.com/middyjs/middy/issues"
   },
   "homepage": "https://github.com/middyjs/middy#readme",
-  "gitHead": "c533f62841c8a39d061d7b94f30ba178f002c8db",
+  "gitHead": "d4bea7f4e21f6a9bbb1f6f6908361169598b9e53",
   "dependencies": {
-    "@middy/util": "^3.0.0-alpha.0"
+    "@middy/util": "^3.0.0-alpha.4"
   },
   "devDependencies": {
-    "@middy/core": "^3.0.0-alpha.0"
+    "@middy/core": "^3.0.0-alpha.4"
   }
 }