@pkg-nec/http-server 14.1.1-pkgnec.0

package/lib/http-server.js

@@ -0,0 +1,192 @@
+'use strict';
+
+var fs = require('fs'),
+  union = require('union'),
+  httpServerCore = require('./core'),
+  auth = require('basic-auth'),
+  httpProxy = require('http-proxy'),
+  corser = require('corser'),
+  secureCompare = require('secure-compare');
+
+//
+// Remark: backwards compatibility for previous
+// case convention of HTTP
+//
+exports.HttpServer = exports.HTTPServer = HttpServer;
+
+/**
+ * Returns a new instance of HttpServer with the
+ * specified `options`.
+ */
+exports.createServer = function (options) {
+  return new HttpServer(options);
+};
+
+/**
+ * Constructor function for the HttpServer object
+ * which is responsible for serving static files along
+ * with other HTTP-related features.
+ */
+function HttpServer(options) {
+  options = options || {};
+
+  if (options.root) {
+    this.root = options.root;
+  } else {
+    try {
+      // eslint-disable-next-line no-sync
+      fs.lstatSync('./public');
+      this.root = './public';
+    } catch (err) {
+      this.root = './';
+    }
+  }
+
+  this.headers = options.headers || {};
+  this.headers['Accept-Ranges'] = 'bytes';
+
+  this.cache = (
+    // eslint-disable-next-line no-nested-ternary
+    options.cache === undefined ? 3600 :
+    // -1 is a special case to turn off caching.
+    // https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cache-Control#Preventing_caching
+      options.cache === -1 ? 'no-cache, no-store, must-revalidate' :
+        options.cache // in seconds.
+  );
+  this.showDir = options.showDir !== 'false';
+  this.autoIndex = options.autoIndex !== 'false';
+  this.showDotfiles = options.showDotfiles;
+  this.gzip = options.gzip === true;
+  this.brotli = options.brotli === true;
+  if (options.ext) {
+    this.ext = options.ext === true
+      ? 'html'
+      : options.ext;
+  }
+  this.contentType = options.contentType ||
+    this.ext === 'html' ? 'text/html' : 'application/octet-stream';
+
+  var before = options.before ? options.before.slice() : [];
+
+  if (options.logFn) {
+    before.push(function (req, res) {
+      options.logFn(req, res);
+      res.emit('next');
+    });
+  }
+
+  if (options.username || options.password) {
+    before.push(function (req, res) {
+      var credentials = auth(req);
+
+      // We perform these outside the if to avoid short-circuiting and giving
+      // an attacker knowledge of whether the username is correct via a timing
+      // attack.
+      if (credentials) {
+        // if credentials is defined, name and pass are guaranteed to be string
+        // type
+        var usernameEqual = secureCompare(options.username.toString(), credentials.name);
+        var passwordEqual = secureCompare(options.password.toString(), credentials.pass);
+        if (usernameEqual && passwordEqual) {
+          return res.emit('next');
+        }
+      }
+
+      res.statusCode = 401;
+      res.setHeader('WWW-Authenticate', 'Basic realm=""');
+      res.end('Access denied');
+    });
+  }
+
+  if (options.cors) {
+    this.headers['Access-Control-Allow-Origin'] = '*';
+    this.headers['Access-Control-Allow-Headers'] = 'Origin, X-Requested-With, Content-Type, Accept, Range';
+    if (options.corsHeaders) {
+      options.corsHeaders.split(/\s*,\s*/)
+        .forEach(function (h) { this.headers['Access-Control-Allow-Headers'] += ', ' + h; }, this);
+    }
+    before.push(corser.create(options.corsHeaders ? {
+      requestHeaders: this.headers['Access-Control-Allow-Headers'].split(/\s*,\s*/)
+    } : null));
+  }
+
+  if (options.robots) {
+    before.push(function (req, res) {
+      if (req.url === '/robots.txt') {
+        res.setHeader('Content-Type', 'text/plain');
+        var robots = options.robots === true
+          ? 'User-agent: *\nDisallow: /'
+          : options.robots.replace(/\\n/, '\n');
+
+        return res.end(robots);
+      }
+
+      res.emit('next');
+    });
+  }
+
+  before.push(httpServerCore({
+    root: this.root,
+    cache: this.cache,
+    showDir: this.showDir,
+    showDotfiles: this.showDotfiles,
+    autoIndex: this.autoIndex,
+    defaultExt: this.ext,
+    gzip: this.gzip,
+    brotli: this.brotli,
+    contentType: this.contentType,
+    mimetypes: options.mimetypes,
+    handleError: typeof options.proxy !== 'string'
+  }));
+
+  if (typeof options.proxy === 'string') {
+    var proxyOptions = options.proxyOptions || {};
+    var proxy = httpProxy.createProxyServer(proxyOptions);
+    before.push(function (req, res) {
+      proxy.web(req, res, {
+        target: options.proxy,
+        changeOrigin: true
+      }, function (err, req, res) {
+        if (options.logFn) {
+          options.logFn(req, res, {
+            message: err.message,
+            status: res.statusCode });
+        }
+        res.emit('next');
+      });
+    });
+  }
+
+  var serverOptions = {
+    before: before,
+    headers: this.headers,
+    onError: function (err, req, res) {
+      if (options.logFn) {
+        options.logFn(req, res, err);
+      }
+
+      res.end();
+    }
+  };
+
+  if (options.https) {
+    serverOptions.https = options.https;
+  }
+
+  this.server = serverOptions.https && serverOptions.https.passphrase
+    // if passphrase is set, shim must be used as union does not support
+    ? require('./shims/https-server-shim')(serverOptions)
+    : union.createServer(serverOptions);
+
+  if (options.timeout !== undefined) {
+    this.server.setTimeout(options.timeout);
+  }
+}
+
+HttpServer.prototype.listen = function () {
+  this.server.listen.apply(this.server, arguments);
+};
+
+HttpServer.prototype.close = function () {
+  return this.server.close();
+};

package/lib/shims/https-server-shim.js

@@ -0,0 +1,67 @@
+/* eslint-disable no-process-env */
+/* eslint-disable no-sync */
+var https = require('https');
+var fs = require('fs');
+var core = require('union/lib/core');
+var RoutingStream = require('union/lib/routing-stream');
+
+module.exports = function (options) {
+  var isArray = Array.isArray(options.after);
+  var credentials;
+
+  if (!options) {
+    throw new Error('options is required to create a server');
+  }
+
+  function requestHandler(req, res) {
+    var routingStream = new RoutingStream({
+      before: options.before,
+      buffer: options.buffer,
+      after:
+        isArray &&
+        options.after.map(function (After) {
+          return new After();
+        }),
+      request: req,
+      response: res,
+      limit: options.limit,
+      headers: options.headers
+    });
+
+    routingStream.on('error', function (err) {
+      var fn = options.onError || core.errorHandler;
+      fn(err, routingStream, routingStream.target, function () {
+        routingStream.target.emit('next');
+      });
+    });
+
+    req.pipe(routingStream);
+  }
+
+  var serverOptions;
+
+  serverOptions = options.https;
+  if (!serverOptions.key || !serverOptions.cert) {
+    throw new Error(
+      'Both options key and cert are required.'
+    );
+  }
+
+  credentials = {
+    key: fs.readFileSync(serverOptions.key),
+    cert: fs.readFileSync(serverOptions.cert),
+    passphrase: process.env.NODE_HTTP_SERVER_SSL_PASSPHRASE
+  };
+
+  if (serverOptions.ca) {
+    serverOptions.ca = !Array.isArray(serverOptions.ca)
+      ? [serverOptions.ca]
+      : serverOptions.ca;
+
+    credentials.ca = serverOptions.ca.map(function (ca) {
+      return fs.readFileSync(ca);
+    });
+  }
+
+  return https.createServer(credentials, requestHandler);
+};

package/package.json

@@ -0,0 +1,122 @@
+{
+  "name": "@pkg-nec/http-server",
+  "version": "14.1.1-pkgnec.0",
+  "description": "A simple zero-configuration command-line http server",
+  "main": "./lib/http-server",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/pkg-nec/http-server.git"
+  },
+  "keywords": [
+    "cli",
+    "command",
+    "static",
+    "http",
+    "https",
+    "http-server",
+    "https-server",
+    "server"
+  ],
+  "scripts": {
+    "start": "node ./bin/http-server",
+    "test": "tap --reporter=spec test/*.test.js",
+    "test-watch": "tap --reporter=spec --watch test/*.test.js"
+  },
+  "files": [
+    "lib",
+    "bin",
+    "doc"
+  ],
+  "man": "./doc/http-server.1",
+  "engines": {
+    "node": ">=12"
+  },
+  "contributors": [
+    {
+      "name": "Charlie Robbins",
+      "email": "charlie.robbins@gmail.com"
+    },
+    {
+      "name": "Marak Squires",
+      "email": "marak.squires@gmail.com"
+    },
+    {
+      "name": "Charlie McConnell",
+      "email": "charlie@charlieistheman.com"
+    },
+    {
+      "name": "Joshua Holbrook",
+      "email": "josh.holbrook@gmail.com"
+    },
+    {
+      "name": "Maciej Małecki",
+      "email": "maciej.malecki@notimplemented.org"
+    },
+    {
+      "name": "Matthew Bergman",
+      "email": "mzbphoto@gmail.com"
+    },
+    {
+      "name": "brad dunbar",
+      "email": "dunbarb2@gmail.com"
+    },
+    {
+      "name": "Dominic Tarr"
+    },
+    {
+      "name": "Travis Person",
+      "email": "travis.person@gmail.com"
+    },
+    {
+      "name": "Jinkwon Lee",
+      "email": "master@bdyne.net"
+    },
+    {
+      "name": "BigBlueHat",
+      "email": "byoung@bigbluehat.com"
+    },
+    {
+      "name": "Daniel Dalton",
+      "email": "daltond2@hawkmail.newpaltz.edu"
+    },
+    {
+      "name": "Jade Michael Thornton",
+      "email": "jademichael@jmthornton.net"
+    }
+  ],
+  "dependencies": {
+    "basic-auth": "^2.0.1",
+    "chalk": "^4.1.2",
+    "corser": "^2.0.1",
+    "he": "^1.2.0",
+    "html-encoding-sniffer": "^3.0.0",
+    "http-proxy": "^1.18.1",
+    "mime": "^1.6.0",
+    "minimist": "^1.2.6",
+    "opener": "^1.5.1",
+    "portfinder": "^1.0.28",
+    "secure-compare": "3.0.1",
+    "union": "~0.5.0",
+    "url-join": "^4.0.1"
+  },
+  "devDependencies": {
+    "eol": "^0.9.1",
+    "eslint": "^4.19.1",
+    "eslint-config-populist": "^4.2.0",
+    "express": "^4.17.1",
+    "request": "^2.88.2",
+    "tap": "^14.11.0"
+  },
+  "bugs": {
+    "url": "https://github.com/pkg-nec/http-server/issues"
+  },
+  "homepage": "https://github.com/pkg-nec/http-server#readme",
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
+  "preferGlobal": true,
+  "bin": {
+    "http-server": "./bin/http-server"
+  }
+}