yes-https 3.0.1 → 4.0.3

package/test/test.js

@@ -1,91 +1,244 @@
-import https from 'node:https';
 import fs from 'node:fs';
-import process from 'node:process';
+import https from 'node:https';
+import { describe, it } from 'node:test';
 import express from 'express';
-import {describe, it} from 'mocha';
 import request from 'supertest';
 import yes from '../lib/index.js';
 
-process.env.NODE_TLS_REJECT_UNAUTHORIZED = 0;
+const TEST_SERVER_CERT = fs.readFileSync('./test/certs/server.crt');
 
 describe('yes', () => {
-	it('should perform the 301 for an http request', done => {
-		// Configure a minimal web server with the defaults
-		const app = express();
-		app.use(yes());
-		app.get('/test', (request_, response) => {
-			response.sendStatus(200);
-		});
-
-		// Verify the request returns a 301
-		request(app)
-			.get('/test')
-			.expect(301)
-			.end(error => {
-				if (error) {
-					throw error;
-				}
-
-				done();
-			});
-	});
-
-	it('should use the correct defaults', done => {
-		// Configure a minimal web server with the defaults
-		const app = express();
-		app.use(yes());
-		app.get('/test', (_request, response) => {
-			response.sendStatus(200);
-		});
-
-		// Verify the request returns the right header when using https
-		const server = createSecureServer(app);
-		request('https://localhost:8443')
-			.get('/test')
-			.expect('Strict-Transport-Security', 'max-age=86400; includeSubDomains')
-			.expect(200)
-			.end(error => {
-				if (error) {
-					throw error;
-				}
-
-				server.close();
-				done();
-			});
-	}).timeout(60_000);
-
-	it('should ignore filtered requests', done => {
-		// Configure a minimal web server with the defaults
-		const app = express();
-		app.use(yes({
-			ignoreFilter: request_ => (request_.url.includes('/_ah/health')),
-		}));
-
-		app.get('/_ah/health', (_request, response) => {
-			response.sendStatus(200);
-		});
-
-		// Verify the request returns a 200 for health checks
-		request(app)
-			.get('/_ah/health')
-			.expect(200)
-			.end(error => {
-				if (error) {
-					throw error;
-				}
-
-				done();
-			});
-	});
+  it('should perform the 301 for an http request', async () => {
+    // Configure a minimal web server with the defaults
+    const app = express();
+    app.use(yes());
+    app.get('/test', (_request_, response) => {
+      response.sendStatus(200);
+    });
+
+    // Verify the request returns a 301
+    await request(app).get('/test').expect(301);
+  });
+
+  it('should use the correct defaults', { timeout: 60_000 }, async () => {
+    // Configure a minimal web server with the defaults
+    const app = express();
+    app.use(yes());
+    app.get('/test', (_request, response) => {
+      response.sendStatus(200);
+    });
+
+    // Verify the request returns the right header when using https
+    const server = createSecureServer(app);
+    await request(server)
+      .get('/test')
+      .ca(TEST_SERVER_CERT)
+      .expect('Strict-Transport-Security', 'max-age=86400; includeSubDomains')
+      .expect(200);
+  });
+
+  it('should allow disabling includeSubDomains with camel case options', {
+    timeout: 60_000,
+  }, async () => {
+    const app = express();
+    app.use(
+      yes({
+        includeSubDomains: false,
+      }),
+    );
+    app.get('/test', (_request, response) => {
+      response.sendStatus(200);
+    });
+
+    const server = createSecureServer(app);
+    await request(server)
+      .get('/test')
+      .ca(TEST_SERVER_CERT)
+      .expect('Strict-Transport-Security', 'max-age=86400')
+      .expect(200);
+  });
+
+  it('should allow disabling includeSubDomains with the legacy lowercase alias', {
+    timeout: 60_000,
+  }, async () => {
+    const app = express();
+    app.use(
+      yes({
+        includeSubdomains: false,
+      }),
+    );
+    app.get('/test', (_request, response) => {
+      response.sendStatus(200);
+    });
+
+    const server = createSecureServer(app);
+    await request(server)
+      .get('/test')
+      .ca(TEST_SERVER_CERT)
+      .expect('Strict-Transport-Security', 'max-age=86400')
+      .expect(200);
+  });
+
+  it('should ignore filtered requests', async () => {
+    // Configure a minimal web server with the defaults
+    const app = express();
+    app.use(
+      yes({
+        ignoreFilter: (request_) => request_.url.includes('/_ah/health'),
+      }),
+    );
+
+    app.get('/_ah/health', (_request, response) => {
+      response.sendStatus(200);
+    });
+
+    // Verify the request returns a 200 for health checks
+    await request(app).get('/_ah/health').expect(200);
+  });
+
+  it('should include preload when configured', {
+    timeout: 60_000,
+  }, async () => {
+    const app = express();
+    app.use(yes({ preload: true }));
+    app.get('/test', (_request, response) => {
+      response.sendStatus(200);
+    });
+
+    const server = createSecureServer(app);
+    await request(server)
+      .get('/test')
+      .ca(TEST_SERVER_CERT)
+      .expect(
+        'Strict-Transport-Security',
+        'max-age=86400; includeSubDomains; preload',
+      )
+      .expect(200);
+  });
+
+  it('should omit includeSubDomains when disabled', {
+    timeout: 60_000,
+  }, async () => {
+    const app = express();
+    app.use(yes({ includeSubDomains: false }));
+    app.get('/test', (_request, response) => {
+      response.sendStatus(200);
+    });
+
+    const server = createSecureServer(app);
+    await request(server)
+      .get('/test')
+      .ca(TEST_SERVER_CERT)
+      .expect('Strict-Transport-Security', 'max-age=86400')
+      .expect(200);
+  });
+
+  it('should include includeSubDomains when explicitly enabled', {
+    timeout: 60_000,
+  }, async () => {
+    const app = express();
+    app.use(yes({ includeSubDomains: true }));
+    app.get('/test', (_request, response) => {
+      response.sendStatus(200);
+    });
+
+    const server = createSecureServer(app);
+    await request(server)
+      .get('/test')
+      .ca(TEST_SERVER_CERT)
+      .expect('Strict-Transport-Security', 'max-age=86400; includeSubDomains')
+      .expect(200);
+  });
+
+  describe('includeSubDomains', () => {
+    it('should include the directive by default over a secure connection', () => {
+      return expectSecureHeader({}, 'max-age=86400; includeSubDomains');
+    });
+
+    it('should include the directive when explicitly enabled over a secure connection', () => {
+      return expectSecureHeader(
+        { includeSubDomains: true },
+        'max-age=86400; includeSubDomains',
+      );
+    });
+
+    it('should omit the directive when disabled over a secure connection', () => {
+      return expectSecureHeader({ includeSubDomains: false }, 'max-age=86400');
+    });
+
+    it('should compose correctly with preload and maxAge when enabled', () => {
+      return expectSecureHeader(
+        { includeSubDomains: true, preload: true, maxAge: 31_536_000 },
+        'max-age=31536000; includeSubDomains; preload',
+      );
+    });
+
+    it('should compose correctly with preload and maxAge when disabled', () => {
+      return expectSecureHeader(
+        { includeSubDomains: false, preload: true, maxAge: 31_536_000 },
+        'max-age=31536000; preload',
+      );
+    });
+
+    it('should include the directive by default for forwarded https requests', () => {
+      return expectForwardedSecureHeader(
+        {},
+        'max-age=86400; includeSubDomains',
+      );
+    });
+
+    it('should honor an explicit true value for forwarded https requests', () => {
+      return expectForwardedSecureHeader(
+        { includeSubDomains: true },
+        'max-age=86400; includeSubDomains',
+      );
+    });
+
+    it('should honor an explicit false value for forwarded https requests', () => {
+      return expectForwardedSecureHeader(
+        { includeSubDomains: false },
+        'max-age=86400',
+      );
+    });
+  });
 });
 
 function createSecureServer(app) {
-	// Server the app over https
-	return https.createServer({
-		key: fs.readFileSync('./test/certs/server.key'),
-		cert: fs.readFileSync('./test/certs/server.crt'),
-		ca: fs.readFileSync('./test/certs/ca.crt'),
-		requestCert: true,
-		rejectUnauthorized: false,
-	}, app).listen('8443');
+  return https.createServer(
+    {
+      key: fs.readFileSync('./test/certs/server.key'),
+      cert: fs.readFileSync('./test/certs/server.crt'),
+    },
+    app,
+  );
+}
+
+function expectSecureHeader(options, expectedHeader) {
+  const app = express();
+  app.use(yes(options));
+  app.get('/test', (_request, response) => {
+    response.sendStatus(200);
+  });
+
+  const server = createSecureServer(app);
+  return request(server)
+    .get('/test')
+    .ca(TEST_SERVER_CERT)
+    .expect('Strict-Transport-Security', expectedHeader)
+    .expect(200);
+}
+
+function expectForwardedSecureHeader(options, expectedHeader) {
+  const app = express();
+  app.use(yes(options));
+  app.get('/test', (_request, response) => {
+    response.sendStatus(200);
+  });
+
+  return request(app)
+    .get('/test')
+    .set('X-Forwarded-Proto', 'https')
+    .set('Host', 'example.com')
+    .expect('Strict-Transport-Security', expectedHeader)
+    .expect(200);
 }

package/.releaserc.json

@@ -1,3 +0,0 @@
-{
-  "branches": ["main"]
-}