Merge branch 'master' into master

Author: thisIsTheFoxe

.github/workflows/codeql-analysis.yml

@@ -0,0 +1,71 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ master ]
+  schedule:
+    - cron: '23 14 * * 0'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'javascript' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python' ]
+        # Learn more:
+        # https://docs.github.com/en/free-pro-team@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning#changing-the-languages-that-are-analyzed
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v1
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+        # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v1
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 https://git.io/JvXDl
+
+    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+    #    and modify them (or add more) to build your code if your project
+    #    uses a compiled language
+
+    #- run: |
+    #   make bootstrap
+    #   make release
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v1

.github/workflows/node.js.yml

@@ -0,0 +1,31 @@
+# This workflow will do a clean install of node dependencies, cache/restore them, build the source code and run tests across different versions of node
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
+
+name: Node.js CI
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+    name: Test
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      fail-fast: false
+      matrix:
+        node-version: [10.x, 12.x, 14.x, 16.x]
+        os: [ubuntu-latest, macOS-latest, windows-latest]
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Use Node.js ${{ matrix.node-version }} on ${{ matrix.os }}
+      uses: actions/setup-node@v2
+      with:
+        node-version: ${{ matrix.node-version }}
+        cache: 'npm'
+    - run: npx npm@7 ci
+    - run: npm test

.gitignore

@@ -1,4 +1,5 @@
-node_modules/*
-npm-debug.log
+node_modules/
+npm-debug.log*
+.nyc_*/
 .dir-locals.el
 .DS_Store

.travis.yml

@@ -1,4 +1,5 @@
-Copyright (c) 2011-2019 Charlie Robbins, Marak Squires, and the Contributors.
+Copyright (c) 2011-2021 Charlie Robbins, Marak Squires, Jade Michael Thornton
+and the Contributors.
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

LICENSE

@@ -1,5 +1,5 @@
-[![build status](https://img.shields.io/travis/http-party/http-server.svg?style=flat-square)](https://travis-ci.org/http-party/http-server)
-[![npm](https://img.shields.io/npm/v/http-server.svg?style=flat-square)](https://www.npmjs.com/package/http-server) [![homebrew](https://img.shields.io/homebrew/v/http-server?style=flat-square)](https://formulae.brew.sh/formula/http-server) [![npm downloads](https://img.shields.io/npm/dm/http-server?color=blue&label=npm%20downloads&style=flat-square)](https://www.npmjs.com/package/http-server)
+![GitHub Workflow Status (master)](https://img.shields.io/github/workflow/status/http-party/http-server/Node.js%20CI/master?style=flat-square)
+[![npm](https://img.shields.io/npm/v/http-server.svg?style=flat-square)](https://www.npmjs.com/package/http-server) [![homebrew](https://img.shields.io/homebrew/v/http-server?style=flat-square)](https://formulae.brew.sh/formula/http-server) ![GitHub milestone](https://img.shields.io/github/milestones/progress-percent/http-party/http-server/4?label=next%20release%20progress&style=flat-square) [![npm downloads](https://img.shields.io/npm/dm/http-server?color=blue&label=npm%20downloads&style=flat-square)](https://www.npmjs.com/package/http-server)
 [![license](https://img.shields.io/github/license/http-party/http-server.svg?style=flat-square)](https://github.com/http-party/http-server)
 
 # http-server: a command-line http server
@@ -42,7 +42,7 @@ Using `npx` you can run the script without installing it first:
 
 ## Available Options:
 
-`-p` or `--port` Port to use (defaults to 8080)
+`-p` or `--port` Port to use (defaults to 8080). Use `-p 0` to look for an open port, starting at 8080. It will also read from `process.env.PORT`.
 
 `-a` Address to use (defaults to 0.0.0.0)
 
@@ -84,6 +84,8 @@ Using `npx` you can run the script without installing it first:
 
 `--no-dotfiles` Do not show dotfiles
 
+`--mimetypes` Path to a .types file for custom mimetype definition
+
 `-h` or `--help` Print this list and exit.
 
 `-v` or `--version` Print the version and exit.

README.md

@@ -0,0 +1,12 @@
+# Security Policy
+
+## Supported Versions
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 0.12.x   | :white_check_mark: |
+| < 0.12   | :x:                |
+
+## Reporting a Vulnerability
+
+In general, vulnerabilities can be reported as an issue, pull requests are very welcome. If you'd like to report privately, please email jademichael+http-server@jmthornton.net.

SECURITY.md

@@ -8,10 +8,7 @@ var colors     = require('colors/safe'),
     portfinder = require('portfinder'),
     opener     = require('opener'),
     fs         = require('fs'),
-    argv       = require('optimist')
-      .boolean('cors')
-      .boolean('log-ip')
-      .argv;
+    argv       = require('minimist')(process.argv.slice(2));
 var ifaces = os.networkInterfaces();
 
 process.title = 'http-server';
@@ -21,7 +18,7 @@ if (argv.h || argv.help) {
     'usage: http-server [path] [options]',
     '',
     'options:',
-    '  -p --port    Port to use [8080]. If --https-redirect, http and (main) https port [8080,443]',
+    '  -p --port    Port to use. If 0, look for open port. [8080]. If --https-redirect, http and (main) https port [8080,443]',
     '  -a           Address to use [0.0.0.0]',
     '  -d           Show directory listings [true]',
     '  -i           Display autoIndex [true]',
@@ -55,6 +52,7 @@ if (argv.h || argv.help) {
     '',
     '  -r --robots        Respond to /robots.txt [User-agent: *\\nDisallow: /]',
     '  --no-dotfiles      Do not show dotfiles',
+    '  --mimetypes        Path to a .types file for custom mimetype definition',
     '  -h --help          Print this list and exit.',
     '  -v --version       Print the version and exit.'
   ].join('\n'));
@@ -171,6 +169,7 @@ function listen(port, redirectPort) {
     proxy: proxy,
     httpsPort: redirectPort,
     showDotfiles: argv.dotfiles,
+    mimetypes: argv.mimetypes,
     username: argv.username || process.env.NODE_HTTP_SERVER_USERNAME,
     password: argv.password || process.env.NODE_HTTP_SERVER_PASSWORD
   };

bin/http-server

@@ -0,0 +1,160 @@
+.TH http-server 1 "April 2020" GNU "http-server man page"
+
+.SH NAME
+http-server \- a simple zero-configuration command-line http server
+
+.SH SYNOPSIS
+.B http-server
+[\fIPATH\fR]
+[\fIOPTIONS\fR]
+
+.SH DESCRIPTION
+\fBhttp-server\fR is a simple, zero-configuration command-line http server. It is powerful enough for production usage, but it's simple and hackable enough to be used for testing, local development, and learning.
+
+.SH OPTIONS
+
+.TP
+.BI [\fIPATH\fR]
+The directory to serve.
+Defaults to ./public if it exists, and ./ otherwise.
+
+.TP
+.BI \-p ", " \-\-port " " \fIPORT\fR
+Port to use. If 0, look for the first available port, starting at 8080.
+Default is 8080.
+
+.TP
+.BI \-a " " \fIADDRESS\fR
+Address to use.
+Default is 0.0.0.0.
+
+.TP
+.BI \-d
+Show directory listings.
+Default is true.
+
+.TP
+.BI \-i
+Display autoIndex.
+Default is true.
+
+.TP
+.BI \-g ", " \-\-gzip
+Serve gzip files when possible.
+Default is false.
+
+.TP
+.BI \-b ", " \-\-brotli
+Serve brotli files when possible.
+If both brotli and gzip are enabled, brotli takes precedence.
+Default is false.
+
+.TP
+.BI \-e ", " \-\-ext " " \fIEXTENSION\fR
+Default file extension is none is provided.
+
+.TP
+.BI \-s ", " \-\-silent
+Suppress log messages from output.
+
+.TP
+.BI \-\-cors " " [\fIHEADERS\fR]
+Enable CORS via the "Access-Control-Allow-Origin" header.
+Optionally provide CORS headers list separated by commas.
+
+.TP
+.BI \-o " " [\fIPATH\fR]
+Open default browser window after starting the server.
+Optionally provide a URL path to open the browser window to.
+
+.TP
+.BI \-c " " \fITIME\fR
+Cache time (max-age) in seconds.
+To disable caching, use \-c \-1.
+Default is 3600.
+
+.TP
+.BI \-U ", " \-\-utc
+Use UTC time format in log messages.
+
+.TP
+.BI \-\-log\-ip
+Enable logging of the client IP address.
+
+.TP
+.BI \-P ", " \-\-proxy
+Fallback proxy if the request cannot be resolved.
+
+.TP
+.BI \-\-username " " \fIUSERNAME\fR
+Username for basic authentication.
+Can also be specified with the environment variable NODE_HTTP_SERVER_USERNAME.
+Defaults to none.
+
+.TP
+.BI \-\-password " " \fIPASSWORD\fR
+Password for basic authentication.
+Can also be specified with the environment variable NODE_HTTP_SERVER_PASSWORD.
+Defaults to none.
+
+.TP
+.BI \-S ", " \-\-ssl
+Enable https.
+
+.TP
+.BI \-C ", " \-\-cert " " [\fIFILE\fR]
+Path to SSL certificate file.
+If not specified, uses cert.pem.
+
+.TP
+.BI \-K ", " \-\-key " " [\fIFILE\fR]
+Path to SSL key file.
+If not specified, uses key.pem.
+
+.TP
+.BI \-r ", " \-\-robots " " [\fIUSER\-AGENT\fR]
+Respond to /robots.txt request.
+If not specified, uses "User-agent: *\\nDisallow: /]"
+
+.TP
+.BI \-\-no\-dotfiles
+Do not show dotfiles.
+
+.TP
+.BI \-h ", " \-\-help
+Print usage and exit.
+
+.TP
+.BI \-v ", " \-\-version
+Print version and exit.
+
+.SH FILES
+.B index.html
+will be served as the default file to any directory requests.
+
+.B 404.html
+will be served if a file is not found. This can be used for SPA hosting to serve the entry page.
+
+.SH COPYING
+Copyright (c) 2011-2020 Charlie Robbins, Marak Squires, and the Contributors.
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+.SH VERSION
+Version 0.12.2