Update action-test.yml

* fix: set correct vars and cols property

* fix: add cols and rows to session.ssh property

* style: remove const assignment

---------

Co-authored-by: w-v <wtv@protonmail.ch>
Co-authored-by: bc 064 <87337961+bcvort@users.noreply.github.com>

.csslintrc

@@ -0,0 +1,2 @@
+--exclude-exts=.min.css
+--ignore=adjoining-classes,box-model,ids,order-alphabetical,unqualified-attributes

.devcontainer/devcontainer.json

@@ -0,0 +1,37 @@
+{
+	"name": "Node.js & TypeScript",
+	"image": "mcr.microsoft.com/devcontainers/base:jammy",
+
+	"mounts": [
+		"source=${localEnv:HOME}${localEnv:USERPROFILE}/.ssh/personal_id_rsa.pub,target=/home/vscode/.hostssh/id_rsa.pub,readonly,type=bind,consistency=cached"
+	],
+	"features": {
+		"ghcr.io/devcontainers-contrib/features/node-asdf:0": {},
+	},
+	// Configure tool-specific properties.
+	"customizations": {
+		// Configure properties specific to VS Code.
+		"vscode": {
+			// Add the IDs of extensions you want installed when the container is created.
+			"extensions": [
+				"ms-vscode-remote.remote-containers",
+				"dbaeumer.vscode-eslint",
+				"GitHub.copilot",
+				"GitHub.copilot-chat",
+				"esbenp.prettier-vscode",
+				"rvest.vs-code-prettier-eslint",
+				"bierner.markdown-mermaid",
+				"stylelint.vscode-stylelint"
+			]
+		}
+	},
+
+	// Use 'forwardPorts' to make a list of ports inside the container available locally.
+	// "forwardPorts": [],
+
+	// Use 'postCreateCommand' to run commands after the container is created.
+	"postCreateCommand": "/bin/bash ./.devcontainer/scripts/tools.sh >> ~/post-create-tools.log",
+
+	// Comment out to connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
+	"remoteUser": "vscode"
+}

.devcontainer/scripts/tools.sh

@@ -0,0 +1,12 @@
+#!/bin/bash
+
+mkdir -p ~/.ssh && \
+  touch ~/.ssh/known_hosts && \
+  sudo tee ~/.ssh/config > /dev/null << EOF 
+Host github.com
+  HostName github.com
+  PreferredAuthentications publickey
+  IdentityFile ~/.hostssh/id_rsa.pub
+EOF
+
+sudo chown -R vscode:vscode ~/.ssh

.dockerignore

@@ -0,0 +1,9 @@
+.git
+.cache
+app/node_modules
+app/client/src
+app/scripts
+app/.*
+app/*.sample
+app/client/tsconfig.json
+app/CHANGELOG.md

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,75 @@
+name: Bug Report
+description: File a bug report
+title: "[Bug]: "
+labels: ["bug", "triage"]
+assignees:
+  - billchurch
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Depending on the type of issue, please include the follwing information:
+  - type: textarea
+    id: what-happened
+    attributes:
+      label: What happened?
+      description: Also tell us, what did you expect to happen?
+      placeholder: Tell us what you see!
+      value: "A bug happened!"
+    validations:
+      required: true
+  - type: input
+    id: node_ver
+    attributes: 
+      label: Node Version
+      description: version of Node this problem occurs on
+      placeholder: npm -v
+    validations:
+      required: true
+  - type: input
+    id: npm_ver
+    attributes: 
+      label: NPM Version
+      description: version of NPM this problem occurs on
+      placeholder: npm -v
+    validations:
+      required: true
+  - type: input
+    id: server_ver
+    attributes: 
+      label: Server OS Version
+      description: Server OS Version / Distribution / Processor Architecture
+      placeholder: uname -a;cat /etc/os-release
+    validations:
+      required: true
+  - type: input
+    id: webssh2_ver
+    attributes: 
+      label: WebSSH2 release version
+      description: Version of WebSSH you are using 
+      placeholder: grep version app/package.json
+    validations:
+      required: true
+  - type: input
+    id: sshhost_ver
+    attributes: 
+      label: OS and Version of SSH server
+      description: OS and Version of SSH server connecting to
+      placeholder: 'on target server run: uname -a;sshd -v'
+    validations:
+      required: false
+  - type: input
+    id: browser_ver
+    attributes: 
+      label: Browser Version
+      description: Information from brwoser's About... or a screenshot of the about screen.
+      placeholder:
+    validations:
+      required: false
+  - type: textarea
+    id: logs
+    attributes:
+      label: Relevant log output
+      description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
+      render: shell
+

.github/ISSUE_TEMPLATE/custom.md

@@ -0,0 +1,10 @@
+---
+name: Question
+about: General how-to questions
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/workflows/action-test.yml

@@ -0,0 +1,65 @@
+name: Manually Release Previous Tag
+
+on: 
+  workflow_dispatch:
+    inputs:
+      tag:
+        description: 'Repo Branch/Tag'
+        default: 'main'
+        type: 'string'
+        required: true
+
+jobs:
+  docker:
+    runs-on: ubuntu-latest
+    steps:
+      - name: 'Checkout'
+        uses: actions/checkout@v3
+        with: 
+          ref: ${{ inputs.tag }}
+      - name: Prepare
+        id: prep
+        run: |
+          DOCKER_IMAGE=${{ secrets.DOCKER_USERNAME }}/${GITHUB_REPOSITORY#*/}
+
+          VERSION=${{ inputs.tag }}
+          VERSION="${VERSION//v}"
+          TAGS="${DOCKER_IMAGE}:${VERSION},${DOCKER_IMAGE}"
+
+          # If the VERSION looks like a version number, assume that
+          # this is the most recent version of the image and also
+          # tag it 'latest'.
+          if [[ $VERSION =~ ^[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}$ ]]; then
+            TAGS="$TAGS,${DOCKER_IMAGE}"
+          fi
+
+
+          # Set output parameters.
+          echo ::set-output name=tags::${TAGS}
+          echo ::set-output name=docker_image::${DOCKER_IMAGE}
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@master
+        with:
+          platforms: all
+
+      - name: Set up Docker Buildx
+        id: buildx
+        uses: docker/setup-buildx-action@master
+
+      - name: Login to DockerHub
+        if: github.event_name != 'pull_request'
+        uses: docker/login-action@v1
+        with:
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_PASSWORD }}
+
+      - name: Build
+        uses: docker/build-push-action@v2
+        with:
+          builder: ${{ steps.buildx.outputs.name }}
+          context: .
+          file: ./Dockerfile
+          platforms: linux/amd64,linux/arm64,linux/ppc64le
+          push: true
+          tags: ${{ steps.prep.outputs.tags }}

.github/workflows/docker-multiplatform-tag.yml

@@ -0,0 +1,69 @@
+---
+name: 'Build Docker On Tag'
+
+on:
+  push:
+    branches:
+      - bigip-server
+    tags:
+      - 'v[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}'
+  workflow_dispatch: # Allows manual triggering from the GitHub UI
+
+jobs:
+  docker:
+    runs-on: ubuntu-latest
+    steps:
+      - name: 'Checkout'
+        uses: actions/checkout@v3
+        
+      - name: Prepare
+        id: prep
+        run: |
+          DOCKER_IMAGE=${{ secrets.DOCKER_USERNAME }}/${GITHUB_REPOSITORY#*/}
+
+          # If this is a git tag, use the tag name as a docker tag
+          if [[ $GITHUB_REF == refs/tags/* ]]; then
+            VERSION=${GITHUB_REF#refs/tags/v}
+            TAGS="${DOCKER_IMAGE}:${VERSION}"
+          fi
+          
+          # If this is a git branch, use the branch name as a docker tag
+          if [[ $GITHUB_REF == refs/heads/* ]]; then
+            VERSION=${GITHUB_REF#refs/heads/}
+            TAGS="${DOCKER_IMAGE}:${VERSION}"
+          fi
+
+          # If the VERSION looks like a version number, also tag as 'latest'
+          if [[ $VERSION =~ ^[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}$ ]]; then
+            TAGS="$TAGS,${DOCKER_IMAGE}:latest"
+          fi
+
+          # Set output parameters
+          echo ::set-output name=tags::${TAGS}
+          echo ::set-output name=docker_image::${DOCKER_IMAGE}
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+        with:
+          platforms: all
+
+      - name: Set up Docker Buildx
+        id: buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Login to DockerHub
+        if: github.event_name != 'pull_request'
+        uses: docker/login-action@v2
+        with:
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_PASSWORD }}
+
+      - name: Build
+        uses: docker/build-push-action@v4
+        with:
+          builder: ${{ steps.buildx.outputs.name }}
+          context: .
+          file: ./Dockerfile
+          platforms: linux/amd64,linux/arm64,linux/ppc64le
+          push: true
+          tags: ${{ steps.prep.outputs.tags }}

.github/workflows/docker-multiplatform.yml

@@ -0,0 +1,67 @@
+---
+name: 'Build Docker Images'
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  docker:
+    runs-on: ubuntu-latest
+    steps:
+      - name: 'Checkout'
+        uses: actions/checkout@v3
+      - name: Prepare
+        id: prep
+        run: |
+          DOCKER_IMAGE=${{ secrets.DOCKER_USERNAME }}/${GITHUB_REPOSITORY#*/}
+
+          # If this is git tag, use the tag name as a docker tag
+          if [[ $GITHUB_REF == refs/tags/* ]]; then
+            VERSION=${GITHUB_REF#refs/tags/webssh2-v}
+            TAGS="${DOCKER_IMAGE}:${VERSION}"
+          fi
+          
+          # If this is git branch, use the branch name as a docker tag
+          if [[ $GITHUB_REF == refs/heads/* ]]; then
+            VERSION=${GITHUB_REF#refs/heads/}
+            TAGS="${DOCKER_IMAGE}:${VERSION}"
+          fi
+
+          # If the VERSION looks like a version number, assume that
+          # this is the most recent version of the image and also
+          # tag it 'latest'. This is done by just specifying the ${DOCKER_IMAGE}
+          # without a tag.
+          if [[ $VERSION =~ ^[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}$ ]]; then
+            TAGS="$TAGS,${DOCKER_IMAGE}"
+          fi
+
+          # Set output parameters.
+          echo ::set-output name=tags::${TAGS}
+          echo ::set-output name=docker_image::${DOCKER_IMAGE}
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@master
+        with:
+          platforms: all
+
+      - name: Set up Docker Buildx
+        id: buildx
+        uses: docker/setup-buildx-action@master
+
+      - name: Login to DockerHub
+        if: github.event_name != 'pull_request'
+        uses: docker/login-action@v1
+        with:
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_PASSWORD }}
+
+      - name: Build
+        uses: docker/build-push-action@v2
+        with:
+          builder: ${{ steps.buildx.outputs.name }}
+          context: .
+          file: ./Dockerfile
+          platforms: linux/amd64,linux/arm64,linux/ppc64le
+          push: true
+          tags: ${{ steps.prep.outputs.tags }}

.github/workflows/release.yml

@@ -0,0 +1,47 @@
+---
+name: 'Create Release'
+on:
+  push:
+    branches:
+      - main
+    paths-ignore:
+      - '.github/**'
+      - '.devcontainer/**'
+      - '.**'
+      - '**.md'
+jobs:
+  release:
+    runs-on: ubuntu-latest
+    outputs:
+      paths_released: ${{ steps.manifest_release.outputs.paths_released }}
+    steps:
+      - uses: google-github-actions/release-please-action@v3
+        id: manifest_release
+        with:
+          token: ${{ secrets.RELEASE_PLEASE_UAT }}
+          command: manifest
+          package-name: webssh2
+          path: app
+          default-branch: main
+          release-type: node
+  publish:
+    runs-on: ubuntu-20.04
+    needs: release
+    strategy:
+      fail-fast: false
+      matrix:
+        path: ${{fromJson(needs.release.outputs.paths_released)}}
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v1
+        with:
+          node-version: 16
+          registry-url: 'https://registry.npmjs.org'
+      - name: publish-to-npm
+        env:
+          NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
+        run: |
+          cd ${{ matrix.path }}
+          npm install
+          npx lerna bootstrap
+          npx lerna publish from-package --no-push --no-private --yes

.gitignore

@@ -1,8 +1,20 @@
+#Docs
+docs
+
+ssl/*
+
+bigip/*
+
+config.json
+
 # Logs
 logs
 *.log
 npm-debug.log*
 
+# Editor preference files
+*.sublime-*
+
 # Runtime data
 pids
 *.pid
@@ -23,9 +35,6 @@ coverage
 # node-waf configuration
 .lock-wscript
 
-# Compiled binary addons (http://nodejs.org/api/addons.html)
-build/Release
-
 # Dependency directories
 node_modules
 jspm_packages
@@ -38,3 +47,6 @@ jspm_packages
 
 #Mac Files
 .DS_Store
+
+Build/Release
+app/bob_rsa

.release-please-manifest.json

@@ -0,0 +1,3 @@
+{
+  "app": "0.5.0-pre-4"
+}

.travis.yml

@@ -0,0 +1,6 @@
+language: node_js
+node_js:
+  - 14
+  - 16
+before_install:
+  - npm i -g snyk

BUILDING.md

@@ -0,0 +1,13 @@
+# Buliding 
+
+To rebuild the client files, you need at least Node v14.
+
+The source of the client files are located in `./app/client/src`
+
+`npm run build` will compile the source files there into `./app/client/public/`. This directory is considered to be volitile and is deleted every time `npm run build` is invoked. 
+
+WebPack is used for building and the configuration is located in `./app/scripts`
+
+If one wishes to make changes to the javascript, the html, or the css it should be done in `./app/client/src` and then complied using `npm run build`
+
+For development purposes, you may also utilize `npm run builddev` which will not minimize the source and allow you to more easily troubleshoot while making customizations. 

CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at wmchurch@gmail.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

@@ -0,0 +1,94 @@
+Guidelines for contributing code:
+
+Make sure code passes linting from (StandardJS)[https://standardjs.com/]
+
+
+# Contributing
+
+When contributing to this repository, please first discuss the change you wish to make via issue,
+email, or any other method with the owners of this repository before making a change. 
+
+Please note we have a code of conduct, please follow it in all your interactions with the project.
+
+## Pull Request Process
+
+1. Ensure any install or build dependencies are removed before the end of the layer when doing a 
+   build.
+2. Make sure code passes linting from (StandardJS)[https://standardjs.com/]
+3. Explain what you're trying to accomplish in your commits
+4. Update changelog and Readme if needed.
+
+## Code of Conduct
+
+### Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+### Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+### Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+### Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+### Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [INSERT EMAIL ADDRESS]. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+### Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

ChangeLog.md

@@ -0,0 +1,3 @@
+# Changelog Moved
+
+See [app/CHANGELOG.md](app/CHANGELOG.md)

Dockerfile

@@ -0,0 +1,9 @@
+FROM node:16-alpine
+
+RUN apk update && apk add bash
+
+WORKDIR /usr/src
+COPY app/ /usr/src/
+RUN npm ci --audit=false --bin-links=false --fund=false
+EXPOSE 2222/tcp
+ENTRYPOINT [ "/usr/local/bin/node", "index.js" ]

LICENSE

@@ -1,674 +1,21 @@
-                    GNU GENERAL PUBLIC LICENSE
+MIT License
-                       Version 3, 29 June 2007
+
-
+Copyright (c) 2017 Bill Church
- Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+
- Everyone is permitted to copy and distribute verbatim copies
+Permission is hereby granted, free of charge, to any person obtaining a copy
- of this license document, but changing it is not allowed.
+of this software and associated documentation files (the "Software"), to deal
-
+in the Software without restriction, including without limitation the rights
-                            Preamble
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-
+copies of the Software, and to permit persons to whom the Software is
-  The GNU General Public License is a free, copyleft license for
+furnished to do so, subject to the following conditions:
-software and other kinds of works.
+
-
+The above copyright notice and this permission notice shall be included in all
-  The licenses for most software and other practical works are designed
+copies or substantial portions of the Software.
-to take away your freedom to share and change the works.  By contrast,
+
-the GNU General Public License is intended to guarantee your freedom to
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-share and change all versions of a program--to make sure it remains free
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-software for all its users.  We, the Free Software Foundation, use the
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-GNU General Public License for most of our software; it applies also to
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-any other work released this way by its authors.  You can apply it to
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-your programs, too.
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-
+SOFTWARE.
-  When we speak of free software, we are referring to freedom, not
-price.  Our General Public Licenses are designed to make sure that you
-have the freedom to distribute copies of free software (and charge for
-them if you wish), that you receive source code or can get it if you
-want it, that you can change the software or use pieces of it in new
-free programs, and that you know you can do these things.
-
-  To protect your rights, we need to prevent others from denying you
-these rights or asking you to surrender the rights.  Therefore, you have
-certain responsibilities if you distribute copies of the software, or if
-you modify it: responsibilities to respect the freedom of others.
-
-  For example, if you distribute copies of such a program, whether
-gratis or for a fee, you must pass on to the recipients the same
-freedoms that you received.  You must make sure that they, too, receive
-or can get the source code.  And you must show them these terms so they
-know their rights.
-
-  Developers that use the GNU GPL protect your rights with two steps:
-(1) assert copyright on the software, and (2) offer you this License
-giving you legal permission to copy, distribute and/or modify it.
-
-  For the developers' and authors' protection, the GPL clearly explains
-that there is no warranty for this free software.  For both users' and
-authors' sake, the GPL requires that modified versions be marked as
-changed, so that their problems will not be attributed erroneously to
-authors of previous versions.
-
-  Some devices are designed to deny users access to install or run
-modified versions of the software inside them, although the manufacturer
-can do so.  This is fundamentally incompatible with the aim of
-protecting users' freedom to change the software.  The systematic
-pattern of such abuse occurs in the area of products for individuals to
-use, which is precisely where it is most unacceptable.  Therefore, we
-have designed this version of the GPL to prohibit the practice for those
-products.  If such problems arise substantially in other domains, we
-stand ready to extend this provision to those domains in future versions
-of the GPL, as needed to protect the freedom of users.
-
-  Finally, every program is threatened constantly by software patents.
-States should not allow patents to restrict development and use of
-software on general-purpose computers, but in those that do, we wish to
-avoid the special danger that patents applied to a free program could
-make it effectively proprietary.  To prevent this, the GPL assures that
-patents cannot be used to render the program non-free.
-
-  The precise terms and conditions for copying, distribution and
-modification follow.
-
-                       TERMS AND CONDITIONS
-
-  0. Definitions.
-
-  "This License" refers to version 3 of the GNU General Public License.
-
-  "Copyright" also means copyright-like laws that apply to other kinds of
-works, such as semiconductor masks.
-
-  "The Program" refers to any copyrightable work licensed under this
-License.  Each licensee is addressed as "you".  "Licensees" and
-"recipients" may be individuals or organizations.
-
-  To "modify" a work means to copy from or adapt all or part of the work
-in a fashion requiring copyright permission, other than the making of an
-exact copy.  The resulting work is called a "modified version" of the
-earlier work or a work "based on" the earlier work.
-
-  A "covered work" means either the unmodified Program or a work based
-on the Program.
-
-  To "propagate" a work means to do anything with it that, without
-permission, would make you directly or secondarily liable for
-infringement under applicable copyright law, except executing it on a
-computer or modifying a private copy.  Propagation includes copying,
-distribution (with or without modification), making available to the
-public, and in some countries other activities as well.
-
-  To "convey" a work means any kind of propagation that enables other
-parties to make or receive copies.  Mere interaction with a user through
-a computer network, with no transfer of a copy, is not conveying.
-
-  An interactive user interface displays "Appropriate Legal Notices"
-to the extent that it includes a convenient and prominently visible
-feature that (1) displays an appropriate copyright notice, and (2)
-tells the user that there is no warranty for the work (except to the
-extent that warranties are provided), that licensees may convey the
-work under this License, and how to view a copy of this License.  If
-the interface presents a list of user commands or options, such as a
-menu, a prominent item in the list meets this criterion.
-
-  1. Source Code.
-
-  The "source code" for a work means the preferred form of the work
-for making modifications to it.  "Object code" means any non-source
-form of a work.
-
-  A "Standard Interface" means an interface that either is an official
-standard defined by a recognized standards body, or, in the case of
-interfaces specified for a particular programming language, one that
-is widely used among developers working in that language.
-
-  The "System Libraries" of an executable work include anything, other
-than the work as a whole, that (a) is included in the normal form of
-packaging a Major Component, but which is not part of that Major
-Component, and (b) serves only to enable use of the work with that
-Major Component, or to implement a Standard Interface for which an
-implementation is available to the public in source code form.  A
-"Major Component", in this context, means a major essential component
-(kernel, window system, and so on) of the specific operating system
-(if any) on which the executable work runs, or a compiler used to
-produce the work, or an object code interpreter used to run it.
-
-  The "Corresponding Source" for a work in object code form means all
-the source code needed to generate, install, and (for an executable
-work) run the object code and to modify the work, including scripts to
-control those activities.  However, it does not include the work's
-System Libraries, or general-purpose tools or generally available free
-programs which are used unmodified in performing those activities but
-which are not part of the work.  For example, Corresponding Source
-includes interface definition files associated with source files for
-the work, and the source code for shared libraries and dynamically
-linked subprograms that the work is specifically designed to require,
-such as by intimate data communication or control flow between those
-subprograms and other parts of the work.
-
-  The Corresponding Source need not include anything that users
-can regenerate automatically from other parts of the Corresponding
-Source.
-
-  The Corresponding Source for a work in source code form is that
-same work.
-
-  2. Basic Permissions.
-
-  All rights granted under this License are granted for the term of
-copyright on the Program, and are irrevocable provided the stated
-conditions are met.  This License explicitly affirms your unlimited
-permission to run the unmodified Program.  The output from running a
-covered work is covered by this License only if the output, given its
-content, constitutes a covered work.  This License acknowledges your
-rights of fair use or other equivalent, as provided by copyright law.
-
-  You may make, run and propagate covered works that you do not
-convey, without conditions so long as your license otherwise remains
-in force.  You may convey covered works to others for the sole purpose
-of having them make modifications exclusively for you, or provide you
-with facilities for running those works, provided that you comply with
-the terms of this License in conveying all material for which you do
-not control copyright.  Those thus making or running the covered works
-for you must do so exclusively on your behalf, under your direction
-and control, on terms that prohibit them from making any copies of
-your copyrighted material outside their relationship with you.
-
-  Conveying under any other circumstances is permitted solely under
-the conditions stated below.  Sublicensing is not allowed; section 10
-makes it unnecessary.
-
-  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
-
-  No covered work shall be deemed part of an effective technological
-measure under any applicable law fulfilling obligations under article
-11 of the WIPO copyright treaty adopted on 20 December 1996, or
-similar laws prohibiting or restricting circumvention of such
-measures.
-
-  When you convey a covered work, you waive any legal power to forbid
-circumvention of technological measures to the extent such circumvention
-is effected by exercising rights under this License with respect to
-the covered work, and you disclaim any intention to limit operation or
-modification of the work as a means of enforcing, against the work's
-users, your or third parties' legal rights to forbid circumvention of
-technological measures.
-
-  4. Conveying Verbatim Copies.
-
-  You may convey verbatim copies of the Program's source code as you
-receive it, in any medium, provided that you conspicuously and
-appropriately publish on each copy an appropriate copyright notice;
-keep intact all notices stating that this License and any
-non-permissive terms added in accord with section 7 apply to the code;
-keep intact all notices of the absence of any warranty; and give all
-recipients a copy of this License along with the Program.
-
-  You may charge any price or no price for each copy that you convey,
-and you may offer support or warranty protection for a fee.
-
-  5. Conveying Modified Source Versions.
-
-  You may convey a work based on the Program, or the modifications to
-produce it from the Program, in the form of source code under the
-terms of section 4, provided that you also meet all of these conditions:
-
-    a) The work must carry prominent notices stating that you modified
-    it, and giving a relevant date.
-
-    b) The work must carry prominent notices stating that it is
-    released under this License and any conditions added under section
-    7.  This requirement modifies the requirement in section 4 to
-    "keep intact all notices".
-
-    c) You must license the entire work, as a whole, under this
-    License to anyone who comes into possession of a copy.  This
-    License will therefore apply, along with any applicable section 7
-    additional terms, to the whole of the work, and all its parts,
-    regardless of how they are packaged.  This License gives no
-    permission to license the work in any other way, but it does not
-    invalidate such permission if you have separately received it.
-
-    d) If the work has interactive user interfaces, each must display
-    Appropriate Legal Notices; however, if the Program has interactive
-    interfaces that do not display Appropriate Legal Notices, your
-    work need not make them do so.
-
-  A compilation of a covered work with other separate and independent
-works, which are not by their nature extensions of the covered work,
-and which are not combined with it such as to form a larger program,
-in or on a volume of a storage or distribution medium, is called an
-"aggregate" if the compilation and its resulting copyright are not
-used to limit the access or legal rights of the compilation's users
-beyond what the individual works permit.  Inclusion of a covered work
-in an aggregate does not cause this License to apply to the other
-parts of the aggregate.
-
-  6. Conveying Non-Source Forms.
-
-  You may convey a covered work in object code form under the terms
-of sections 4 and 5, provided that you also convey the
-machine-readable Corresponding Source under the terms of this License,
-in one of these ways:
-
-    a) Convey the object code in, or embodied in, a physical product
-    (including a physical distribution medium), accompanied by the
-    Corresponding Source fixed on a durable physical medium
-    customarily used for software interchange.
-
-    b) Convey the object code in, or embodied in, a physical product
-    (including a physical distribution medium), accompanied by a
-    written offer, valid for at least three years and valid for as
-    long as you offer spare parts or customer support for that product
-    model, to give anyone who possesses the object code either (1) a
-    copy of the Corresponding Source for all the software in the
-    product that is covered by this License, on a durable physical
-    medium customarily used for software interchange, for a price no
-    more than your reasonable cost of physically performing this
-    conveying of source, or (2) access to copy the
-    Corresponding Source from a network server at no charge.
-
-    c) Convey individual copies of the object code with a copy of the
-    written offer to provide the Corresponding Source.  This
-    alternative is allowed only occasionally and noncommercially, and
-    only if you received the object code with such an offer, in accord
-    with subsection 6b.
-
-    d) Convey the object code by offering access from a designated
-    place (gratis or for a charge), and offer equivalent access to the
-    Corresponding Source in the same way through the same place at no
-    further charge.  You need not require recipients to copy the
-    Corresponding Source along with the object code.  If the place to
-    copy the object code is a network server, the Corresponding Source
-    may be on a different server (operated by you or a third party)
-    that supports equivalent copying facilities, provided you maintain
-    clear directions next to the object code saying where to find the
-    Corresponding Source.  Regardless of what server hosts the
-    Corresponding Source, you remain obligated to ensure that it is
-    available for as long as needed to satisfy these requirements.
-
-    e) Convey the object code using peer-to-peer transmission, provided
-    you inform other peers where the object code and Corresponding
-    Source of the work are being offered to the general public at no
-    charge under subsection 6d.
-
-  A separable portion of the object code, whose source code is excluded
-from the Corresponding Source as a System Library, need not be
-included in conveying the object code work.
-
-  A "User Product" is either (1) a "consumer product", which means any
-tangible personal property which is normally used for personal, family,
-or household purposes, or (2) anything designed or sold for incorporation
-into a dwelling.  In determining whether a product is a consumer product,
-doubtful cases shall be resolved in favor of coverage.  For a particular
-product received by a particular user, "normally used" refers to a
-typical or common use of that class of product, regardless of the status
-of the particular user or of the way in which the particular user
-actually uses, or expects or is expected to use, the product.  A product
-is a consumer product regardless of whether the product has substantial
-commercial, industrial or non-consumer uses, unless such uses represent
-the only significant mode of use of the product.
-
-  "Installation Information" for a User Product means any methods,
-procedures, authorization keys, or other information required to install
-and execute modified versions of a covered work in that User Product from
-a modified version of its Corresponding Source.  The information must
-suffice to ensure that the continued functioning of the modified object
-code is in no case prevented or interfered with solely because
-modification has been made.
-
-  If you convey an object code work under this section in, or with, or
-specifically for use in, a User Product, and the conveying occurs as
-part of a transaction in which the right of possession and use of the
-User Product is transferred to the recipient in perpetuity or for a
-fixed term (regardless of how the transaction is characterized), the
-Corresponding Source conveyed under this section must be accompanied
-by the Installation Information.  But this requirement does not apply
-if neither you nor any third party retains the ability to install
-modified object code on the User Product (for example, the work has
-been installed in ROM).
-
-  The requirement to provide Installation Information does not include a
-requirement to continue to provide support service, warranty, or updates
-for a work that has been modified or installed by the recipient, or for
-the User Product in which it has been modified or installed.  Access to a
-network may be denied when the modification itself materially and
-adversely affects the operation of the network or violates the rules and
-protocols for communication across the network.
-
-  Corresponding Source conveyed, and Installation Information provided,
-in accord with this section must be in a format that is publicly
-documented (and with an implementation available to the public in
-source code form), and must require no special password or key for
-unpacking, reading or copying.
-
-  7. Additional Terms.
-
-  "Additional permissions" are terms that supplement the terms of this
-License by making exceptions from one or more of its conditions.
-Additional permissions that are applicable to the entire Program shall
-be treated as though they were included in this License, to the extent
-that they are valid under applicable law.  If additional permissions
-apply only to part of the Program, that part may be used separately
-under those permissions, but the entire Program remains governed by
-this License without regard to the additional permissions.
-
-  When you convey a copy of a covered work, you may at your option
-remove any additional permissions from that copy, or from any part of
-it.  (Additional permissions may be written to require their own
-removal in certain cases when you modify the work.)  You may place
-additional permissions on material, added by you to a covered work,
-for which you have or can give appropriate copyright permission.
-
-  Notwithstanding any other provision of this License, for material you
-add to a covered work, you may (if authorized by the copyright holders of
-that material) supplement the terms of this License with terms:
-
-    a) Disclaiming warranty or limiting liability differently from the
-    terms of sections 15 and 16 of this License; or
-
-    b) Requiring preservation of specified reasonable legal notices or
-    author attributions in that material or in the Appropriate Legal
-    Notices displayed by works containing it; or
-
-    c) Prohibiting misrepresentation of the origin of that material, or
-    requiring that modified versions of such material be marked in
-    reasonable ways as different from the original version; or
-
-    d) Limiting the use for publicity purposes of names of licensors or
-    authors of the material; or
-
-    e) Declining to grant rights under trademark law for use of some
-    trade names, trademarks, or service marks; or
-
-    f) Requiring indemnification of licensors and authors of that
-    material by anyone who conveys the material (or modified versions of
-    it) with contractual assumptions of liability to the recipient, for
-    any liability that these contractual assumptions directly impose on
-    those licensors and authors.
-
-  All other non-permissive additional terms are considered "further
-restrictions" within the meaning of section 10.  If the Program as you
-received it, or any part of it, contains a notice stating that it is
-governed by this License along with a term that is a further
-restriction, you may remove that term.  If a license document contains
-a further restriction but permits relicensing or conveying under this
-License, you may add to a covered work material governed by the terms
-of that license document, provided that the further restriction does
-not survive such relicensing or conveying.
-
-  If you add terms to a covered work in accord with this section, you
-must place, in the relevant source files, a statement of the
-additional terms that apply to those files, or a notice indicating
-where to find the applicable terms.
-
-  Additional terms, permissive or non-permissive, may be stated in the
-form of a separately written license, or stated as exceptions;
-the above requirements apply either way.
-
-  8. Termination.
-
-  You may not propagate or modify a covered work except as expressly
-provided under this License.  Any attempt otherwise to propagate or
-modify it is void, and will automatically terminate your rights under
-this License (including any patent licenses granted under the third
-paragraph of section 11).
-
-  However, if you cease all violation of this License, then your
-license from a particular copyright holder is reinstated (a)
-provisionally, unless and until the copyright holder explicitly and
-finally terminates your license, and (b) permanently, if the copyright
-holder fails to notify you of the violation by some reasonable means
-prior to 60 days after the cessation.
-
-  Moreover, your license from a particular copyright holder is
-reinstated permanently if the copyright holder notifies you of the
-violation by some reasonable means, this is the first time you have
-received notice of violation of this License (for any work) from that
-copyright holder, and you cure the violation prior to 30 days after
-your receipt of the notice.
-
-  Termination of your rights under this section does not terminate the
-licenses of parties who have received copies or rights from you under
-this License.  If your rights have been terminated and not permanently
-reinstated, you do not qualify to receive new licenses for the same
-material under section 10.
-
-  9. Acceptance Not Required for Having Copies.
-
-  You are not required to accept this License in order to receive or
-run a copy of the Program.  Ancillary propagation of a covered work
-occurring solely as a consequence of using peer-to-peer transmission
-to receive a copy likewise does not require acceptance.  However,
-nothing other than this License grants you permission to propagate or
-modify any covered work.  These actions infringe copyright if you do
-not accept this License.  Therefore, by modifying or propagating a
-covered work, you indicate your acceptance of this License to do so.
-
-  10. Automatic Licensing of Downstream Recipients.
-
-  Each time you convey a covered work, the recipient automatically
-receives a license from the original licensors, to run, modify and
-propagate that work, subject to this License.  You are not responsible
-for enforcing compliance by third parties with this License.
-
-  An "entity transaction" is a transaction transferring control of an
-organization, or substantially all assets of one, or subdividing an
-organization, or merging organizations.  If propagation of a covered
-work results from an entity transaction, each party to that
-transaction who receives a copy of the work also receives whatever
-licenses to the work the party's predecessor in interest had or could
-give under the previous paragraph, plus a right to possession of the
-Corresponding Source of the work from the predecessor in interest, if
-the predecessor has it or can get it with reasonable efforts.
-
-  You may not impose any further restrictions on the exercise of the
-rights granted or affirmed under this License.  For example, you may
-not impose a license fee, royalty, or other charge for exercise of
-rights granted under this License, and you may not initiate litigation
-(including a cross-claim or counterclaim in a lawsuit) alleging that
-any patent claim is infringed by making, using, selling, offering for
-sale, or importing the Program or any portion of it.
-
-  11. Patents.
-
-  A "contributor" is a copyright holder who authorizes use under this
-License of the Program or a work on which the Program is based.  The
-work thus licensed is called the contributor's "contributor version".
-
-  A contributor's "essential patent claims" are all patent claims
-owned or controlled by the contributor, whether already acquired or
-hereafter acquired, that would be infringed by some manner, permitted
-by this License, of making, using, or selling its contributor version,
-but do not include claims that would be infringed only as a
-consequence of further modification of the contributor version.  For
-purposes of this definition, "control" includes the right to grant
-patent sublicenses in a manner consistent with the requirements of
-this License.
-
-  Each contributor grants you a non-exclusive, worldwide, royalty-free
-patent license under the contributor's essential patent claims, to
-make, use, sell, offer for sale, import and otherwise run, modify and
-propagate the contents of its contributor version.
-
-  In the following three paragraphs, a "patent license" is any express
-agreement or commitment, however denominated, not to enforce a patent
-(such as an express permission to practice a patent or covenant not to
-sue for patent infringement).  To "grant" such a patent license to a
-party means to make such an agreement or commitment not to enforce a
-patent against the party.
-
-  If you convey a covered work, knowingly relying on a patent license,
-and the Corresponding Source of the work is not available for anyone
-to copy, free of charge and under the terms of this License, through a
-publicly available network server or other readily accessible means,
-then you must either (1) cause the Corresponding Source to be so
-available, or (2) arrange to deprive yourself of the benefit of the
-patent license for this particular work, or (3) arrange, in a manner
-consistent with the requirements of this License, to extend the patent
-license to downstream recipients.  "Knowingly relying" means you have
-actual knowledge that, but for the patent license, your conveying the
-covered work in a country, or your recipient's use of the covered work
-in a country, would infringe one or more identifiable patents in that
-country that you have reason to believe are valid.
-
-  If, pursuant to or in connection with a single transaction or
-arrangement, you convey, or propagate by procuring conveyance of, a
-covered work, and grant a patent license to some of the parties
-receiving the covered work authorizing them to use, propagate, modify
-or convey a specific copy of the covered work, then the patent license
-you grant is automatically extended to all recipients of the covered
-work and works based on it.
-
-  A patent license is "discriminatory" if it does not include within
-the scope of its coverage, prohibits the exercise of, or is
-conditioned on the non-exercise of one or more of the rights that are
-specifically granted under this License.  You may not convey a covered
-work if you are a party to an arrangement with a third party that is
-in the business of distributing software, under which you make payment
-to the third party based on the extent of your activity of conveying
-the work, and under which the third party grants, to any of the
-parties who would receive the covered work from you, a discriminatory
-patent license (a) in connection with copies of the covered work
-conveyed by you (or copies made from those copies), or (b) primarily
-for and in connection with specific products or compilations that
-contain the covered work, unless you entered into that arrangement,
-or that patent license was granted, prior to 28 March 2007.
-
-  Nothing in this License shall be construed as excluding or limiting
-any implied license or other defenses to infringement that may
-otherwise be available to you under applicable patent law.
-
-  12. No Surrender of Others' Freedom.
-
-  If conditions are imposed on you (whether by court order, agreement or
-otherwise) that contradict the conditions of this License, they do not
-excuse you from the conditions of this License.  If you cannot convey a
-covered work so as to satisfy simultaneously your obligations under this
-License and any other pertinent obligations, then as a consequence you may
-not convey it at all.  For example, if you agree to terms that obligate you
-to collect a royalty for further conveying from those to whom you convey
-the Program, the only way you could satisfy both those terms and this
-License would be to refrain entirely from conveying the Program.
-
-  13. Use with the GNU Affero General Public License.
-
-  Notwithstanding any other provision of this License, you have
-permission to link or combine any covered work with a work licensed
-under version 3 of the GNU Affero General Public License into a single
-combined work, and to convey the resulting work.  The terms of this
-License will continue to apply to the part which is the covered work,
-but the special requirements of the GNU Affero General Public License,
-section 13, concerning interaction through a network will apply to the
-combination as such.
-
-  14. Revised Versions of this License.
-
-  The Free Software Foundation may publish revised and/or new versions of
-the GNU General Public License from time to time.  Such new versions will
-be similar in spirit to the present version, but may differ in detail to
-address new problems or concerns.
-
-  Each version is given a distinguishing version number.  If the
-Program specifies that a certain numbered version of the GNU General
-Public License "or any later version" applies to it, you have the
-option of following the terms and conditions either of that numbered
-version or of any later version published by the Free Software
-Foundation.  If the Program does not specify a version number of the
-GNU General Public License, you may choose any version ever published
-by the Free Software Foundation.
-
-  If the Program specifies that a proxy can decide which future
-versions of the GNU General Public License can be used, that proxy's
-public statement of acceptance of a version permanently authorizes you
-to choose that version for the Program.
-
-  Later license versions may give you additional or different
-permissions.  However, no additional obligations are imposed on any
-author or copyright holder as a result of your choosing to follow a
-later version.
-
-  15. Disclaimer of Warranty.
-
-  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
-APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
-HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
-OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
-THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
-PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
-IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
-ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
-
-  16. Limitation of Liability.
-
-  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
-WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
-THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
-GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
-USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
-DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
-PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
-EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
-SUCH DAMAGES.
-
-  17. Interpretation of Sections 15 and 16.
-
-  If the disclaimer of warranty and limitation of liability provided
-above cannot be given local legal effect according to their terms,
-reviewing courts shall apply local law that most closely approximates
-an absolute waiver of all civil liability in connection with the
-Program, unless a warranty or assumption of liability accompanies a
-copy of the Program in return for a fee.
-
-                     END OF TERMS AND CONDITIONS
-
-            How to Apply These Terms to Your New Programs
-
-  If you develop a new program, and you want it to be of the greatest
-possible use to the public, the best way to achieve this is to make it
-free software which everyone can redistribute and change under these terms.
-
-  To do so, attach the following notices to the program.  It is safest
-to attach them to the start of each source file to most effectively
-state the exclusion of warranty; and each file should have at least
-the "copyright" line and a pointer to where the full notice is found.
-
-    {one line to give the program's name and a brief idea of what it does.}
-    Copyright (C) {year}  {name of author}
-
-    This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program.  If not, see <http://www.gnu.org/licenses/>.
-
-Also add information on how to contact you by electronic and paper mail.
-
-  If the program does terminal interaction, make it output a short
-notice like this when it starts in an interactive mode:
-
-    {project}  Copyright (C) {year}  {fullname}
-    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
-    This is free software, and you are welcome to redistribute it
-    under certain conditions; type `show c' for details.
-
-The hypothetical commands `show w' and `show c' should show the appropriate
-parts of the General Public License.  Of course, your program's commands
-might be different; for a GUI interface, you would use an "about box".
-
-  You should also get your employer (if you work as a programmer) or school,
-if any, to sign a "copyright disclaimer" for the program, if necessary.
-For more information on this, and how to apply and follow the GNU GPL, see
-<http://www.gnu.org/licenses/>.
-
-  The GNU General Public License does not permit incorporating your program
-into proprietary programs.  If your program is a subroutine library, you
-may consider it more useful to permit linking proprietary applications with
-the library.  If this is what you want to do, use the GNU Lesser General
-Public License instead of this License.  But first, please read
-<http://www.gnu.org/philosophy/why-not-lgpl.html>.

Makefile

@@ -0,0 +1,2 @@
+test:
+	cd ./app; npm run test

README.md

@@ -1,35 +1,367 @@
 # WebSSH2
+
+[![Build Status](https://travis-ci.com/billchurch/webssh2.svg?branch=main)](https://travis-ci.com/billchurch/webssh2) [![GitHub version](https://img.shields.io/github/v/release/billchurch/webssh2)](https://github.com/billchurch/webssh2/releases/latest) [![docker build images](https://github.com/billchurch/webssh2/actions/workflows/docker-multiplatform.yml/badge.svg)](https://github.com/billchurch/webssh2/actions/workflows/docker-multiplatform.yml)
+
+[![Buy Me A Coffee](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/billchurch)
+
 Web SSH Client using ssh2, socket.io, xterm.js, and express
 
-Bare bones example of using SSH2 as a client on a host to proxy a Websocket / Socket.io connection to a SSH2 server. 
+A bare bones example of an HTML5 web-based terminal emulator and SSH client. We use SSH2 as a client on a host to proxy a Websocket / Socket.io connection to a SSH2 server.
 
-<img width="1044" alt="screenshot 2016-05-18 13 29 53" src="https://cloud.githubusercontent.com/assets/1668075/15368633/d2c9c4ca-1cfc-11e6-9961-b5b52a07b9ff.png">
+<img width="600" height="340" alt="WebSSH2 v0.2.0 demo" src="https://user-images.githubusercontent.com/1668075/182425293-acc8741e-cc92-4105-afdc-9538e1685d4b.gif">
+
+# Requirements
+Node v14.x or above. If using <v14.x you should be able to run by replacing the "read-config" package to @1 like this (after a clone):
+
+`npm install --save read-config@1
+`
+
+Just keep in mind that there is no intention to ensure compatability with Node < v14
 
 # Instructions
+The instructions previously showed cloning directly from main, while normally safe may include "work in progress". It's recommended that after you clone, you switch to a particular tag.
+
 To install:
 
-1. Clone to a location somewhere and `npm install`
+1. Clone to a location somewhere
 
-2. If desired, edit config.json to change the listener to your liking. There are also some default options which may be definied for a few of the variables.
+2. Checkout to the `current` tag using `git checkout current` or choose a particular [release](https://github.com/billchurch/webssh2/releases/) tag
 
-3. Run `npm start`
+3. `cd app` and `npm install --production`. If you want to develop and rebuild javascript and other files utilize `npm install` instead.
 
-4. Fire up a browser, navigate to IP/port of your choice and specify a host (https isn't used here because it's assumed it will be off-loaded to
+4. If desired, edit app/config.json to change the listener to your liking. There are also some default options which may be definied for a few of the variables.
-some sort of proxy):
+
+5. Run `npm start`
+
+6. Fire up a browser, navigate to IP/port of your choice and specify a host (https isn't used here because it's assumed it will be off-loaded to some sort of proxy):
 
 http://localhost:2222/ssh/host/127.0.0.1
 
 You will be prompted for credentials to use on the SSH server via HTTP Basic authentcaiton. This is to permit usage with some SSO systems that can replay credentials over HTTP basic.
 
-# Options (GET request vars)
+Alternatively in main for testing, you can send credentials via POST with the variables "username" and "userpassword".
 
-port= - port of SSH server (defaults to 22)
+# Customizing client files
 
-header= - optional header to display on page
+See [BUILDING.md](BUILDING.md) for more details.
 
-headerBackground= - optional background color of header to display on page 
+# Docker
+
+## NOTICE
+Docker versions differ from what is in `main` and are release dependant. 
+
+Meaning billchurch/webssh2:latest is the latest official release. This does NOT sync with what is in `main` on this repo. `main` is development and will change until it gets a release tag. 
+
+On occasion, examples or instructions on `main` will drift from what is released. You should refer to the tag of the version you're using to ensure you are following the proper guidance.
+
+That being said the most current release version is [0.4.6](https://github.com/billchurch/webssh2/tree/0.4.6), see that tag for details.
+
+## Instructions
+
+Some configuration options are available as [Environment Variables](#environment-variables). If there is a configuration option you require which does not have an environment variable please [open an issue requesting](../../issues/new/choose).
+
+[webssh2 images are available in docker hub](https://hub.docker.com/repository/docker/billchurch/webssh2).
+
+the `latest` tag will pull the most recent stable release, otherwise you can pull individual tags/releases/versions of this repo by using a particular version in the tag.
+
+For instance:
+
+```docker pull billchurch/webssh2:0.4.6```
+
+or 
+
+```docker pull billchurch/webssh2:0.4.7-alpha.2```
+
+or
+
+```docker pull billchurch/webssh2```
+
+for the most recent
+
+If you want to play around localy:
+
+Copy app/config.json.template to app/config.json and modify the latter:
+
+```js
+{
+  // ...
+  "listen": {
+    "ip": "0.0.0.0",
+    "port": 2222
+  }
+  // ...
+}
+```
+
+Rebuild and run
+
+```bash
+docker build -t webssh2 .
+docker run --name webssh2 -d -p 2222:2222 webssh2
+```
+
+Alternatively if you don't want to rebuild, mount the config at runtime:
+
+```bash
+docker run --name webssh2 -d -p 2222:2222 -v `pwd`/app/config.json:/usr/src/config.json webssh2
+```
+  
+Alternatively if you don't want to build either and mount the config at runtime relying on the community image :
+
+```bash
+docker run --name webssh2 -d -p 2222:2222 -v `pwd`/app/config.json:/usr/src/config.json billchurch/webssh2
+```
+  
+# Options
+
+## Environment Variables 
+Environment variables introduced in 0.4.7 will override anything specified in `config.json`. This is useful for settings that may be per-node, or in a container environment. These are optional and will default to whatever their peer config.json settings are
+
+* **LISTEN** - _string_ - IP address node should listen on for client connections, defaults to `127.0.0.1`. Peer is **listen.ip**
+* **PORT** - _integer_ - Port node should listen on for client connections, defaults to `2222`. Peer is **listen.port**
+* **SOCKETIO_ORIGINS** - _array_ - COORS origins to allow connections from to socket.io server, defaults to `localhost:2222`. Changed in 0.3.1, to enable previous, less secure, default behavior of everything use `*:*` (not recommended). Check [#240](../../issues/240). Peer is **socketio.origins**
+* **SOCKETIO_PATH** _string_ - Path to socket.io client files. Default: `/ssh/socket.io`. Peer is **socketio.path**
+* **SOCKETIO_SERVECLIENT** _boolean_ - serve the socket.io client. This is built into the custom javascript, so you shouldn't need this. Kept as an option just in case. Default: `false`. Peer is **socketio.serveClient**
+
+## POST request vars (in main branch for testing)
+
+* **username** - _string_ - username to log into ssh with
+
+* **userpassword** _string_ password to log into ssh with
+
+* **port=** - _integer_ - port of SSH server (defaults to 22)
+
+* **header=** - _string_ - optional header to display on page
+
+* **headerBackground=** - _string_ - optional background color of header to display on page
+
+* **sshterm=** - _string_ - optional specify terminal emulation to use, defaults to `ssh.term` in `config.json` or `vt100` if that is null
+
+* **readyTimeout=** - _integer_ - How long (in milliseconds) to wait for the SSH handshake to complete. **Default:** 20000. **Enforced Values:** Min: 1, Max: 300000
+
+* **cursorBlink** - _boolean_ - Cursor blinks (true), does not (false) **Default:** true.
+
+* **scrollback** - _integer_ - Lines in the scrollback buffer. **Default:** 10000. **Enforced Values:** Min: 1, Max: 200000
+
+* **tabStopWidth** - _integer_ - Tab stops at _n_ characters **Default:** 8. **Enforced Values:** Min: 1, Max: 100
+
+* **bellStyle** - _string_ - Style of terminal bell: ("sound"|"none"). **Default:** "sound". **Enforced Values:** "sound", "none"
+
+* **fontSize** - _number_ - Size of terminal font. **Default:** 12
+
+* **fontFamily** - _string_ - Font family
+
+* **letterSpacing** - _number_ - Letter spacing
+
+* **lineHeight** - _number_ - Line height
+
+## GET request vars
+
+* **port=** - _integer_ - port of SSH server (defaults to 22)
+
+* **header=** - _string_ - optional header to display on page
+
+* **headerBackground=** - _string_ - optional background color of header to display on page
+
+* **sshterm=** - _string_ - optional specify terminal emulation to use, defaults to `ssh.term` in `config.json` or `vt100` if that is null
+
+* **readyTimeout=** - _integer_ - How long (in milliseconds) to wait for the SSH handshake to complete. **Default:** 20000. **Enforced Values:** Min: 1, Max: 300000
+
+* **cursorBlink** - _boolean_ - Cursor blinks (true), does not (false) **Default:** true.
+
+* **scrollback** - _integer_ - Lines in the scrollback buffer. **Default:** 10000. **Enforced Values:** Min: 1, Max: 200000
+
+* **tabStopWidth** - _integer_ - Tab stops at _n_ characters **Default:** 8. **Enforced Values:** Min: 1, Max: 100
+
+* **bellStyle** - _string_ - Style of terminal bell: ("sound"|"none"). **Default:** "sound". **Enforced Values:** "sound", "none"
+
+* **fontSize** - _number_ - Size of terminal font. **Default:** "12"
+
+* **fontFamily** - _string_ - Font family
+
+* **letterSpacing** - _number_ - Letter spacing
+
+* **lineHeight** - _integer_ - Line height
+
+## Headers
+
+* **allowreplay** - _boolean_ - Allow use of password replay feature, example `allowreplay: true`
+
+* **mrhsession** - _string_ - Can be used to pass APM session for event correlation `mrhsession: abc123`
+
+## Config File Options
+`config.json` contains several options which may be specified to customize to your needs, vs editing the javascript directly. This is JSON format so mind your spacing, brackets, etc...
+
+* **listen.ip** - _string_ - IP address node should listen on for client connections, defaults to `127.0.0.1`
+
+* **listen.port** - _integer_ - Port node should listen on for client connections, defaults to `2222`
+
+* **socketio.serveClient** - _boolean_ - serve the socket.io client. This is built into the custom javascript, so you shouldn't need this. Kept as an option just in case. Default: `false`
+
+* **socketio.path** - _string_ - Path to socket.io client files. Default: `/ssh/socket.io`
+
+* **socketio.origins** - _array_ - COORS origins to allow connections from to socket.io server, defaults to `localhost:2222`. Changed in 0.3.1, to enable previous, less secure, default behavior of everything use `*:*` (not recommended). Check [#240](../../issues/240)
+
+* **user.name** - _string_ - Specify user name to authenticate with. In normal cases this should be left to the default `null` setting.
+
+* **user.password** - _string_ - Specify password to authenticate with. In normal cases this should be left to the default `null` setting.
+
+* **user.overridebasic** - _boolean_ - When set to `true` ignores `Authorization: Basic` header sent from client and use credentials defined in `user.name` and `user.password` instead. Defaults to `false`. [issue 242](../../issues/242) for more information.
+
+* **ssh.host** - _string_ - Specify host to connect to. May be either hostname or IP address. Defaults to `null`.
+
+* **ssh.port** - _integer_ - Specify SSH port to connect to, defaults to `22`
+
+* **ssh.term** - _string_ - Specify terminal emulation to use, defaults to `vt100` if null
+
+* **ssh.readyTimeout** - _integer_ - How long (in milliseconds) to wait for the SSH handshake to complete. **Default:** 20000.
+
+* **ssh.keepaliveInterval** - _integer_ - How often (in milliseconds) to send SSH-level keepalive packets to the server (in a similar way as OpenSSH's ServerAliveInterval config option). Set to 0 to disable. **Default:** 120000.
+
+* **ssh.keepaliveCountMax** - _integer_ - How many consecutive, unanswered SSH-level keepalive packets that can be sent to the server before disconnection (similar to OpenSSH's ServerAliveCountMax config option). **Default:** 10.
+
+* **allowedSubnets** - _array_ - A list of subnets that the server is allowed to connect to via SSH. An empty array means all subnets are permitted; no restriction. **Default:** empty array.
+
+* **terminal.cursorBlink** - _boolean_ - Cursor blinks (true), does not (false) **Default:** true.
+
+* **terminal.scrollback** - _integer_ - Lines in the scrollback buffer. **Default:** 10000.
+
+* **terminal.tabStopWidth** - _integer_ - Tab stops at _n_ characters **Default:** 8.
+
+* **terminal.bellStyle** - _string_ - Style of terminal bell: (sound|none). **Default:** "sound".
+
+* **terminal.fontSize** - _number_ - Size of terminal font. **Default:** 14.
+
+* **terminal.fontFamily** - _string_ - Font family
+
+* **terminal.letterSpacing** - _number_ - Letter spacing
+
+* **terminal.lineHeight** - _number_ - Line height
+
+* **header.text** - _string_ - Specify header text, defaults to `My Header` but may also be set to `null`. When set to `null` no header bar will be displayed on the client.
+
+* **header.background** - _string_ - Header background, defaults to `green`.
+
+* **session.name** - _string_ - Name of session ID cookie. it's not a horrible idea to make this something unique.
+
+* **session.secret** - _string_ - Secret key for cookie encryption. You should change this in production.
+
+* **options.challengeButton** - _boolean_ - Challenge button. This option, which is still under development, allows the user to resend the password to the server (in cases of step-up authentication for things like `sudo` or a router `enable` command.
+
+* **options.allowreauth** - _boolean_ - Reauth button. This option creates an option to provide a button to create a new session with new credentials. See [issue 51](../../issues/51) and [pull 85](../../pull/85) for more detail.
+
+* **algorithms** - _object_ - This option allows you to explicitly override the default transport layer algorithms used for the connection. Each value must be an array of valid algorithms for that category. The order of the algorithms in the arrays are important, with the most favorable being first. Valid keys:
+
+    * **kex** - _array_ - Key exchange algorithms.
+
+        * Default values:
+
+            1. ecdh-sha2-nistp256 **(node v0.11.14 or newer)**
+            2. ecdh-sha2-nistp384 **(node v0.11.14 or newer)**
+            3. ecdh-sha2-nistp521 **(node v0.11.14 or newer)**
+            4. diffie-hellman-group-exchange-sha256 **(node v0.11.12 or newer)**
+            5. diffie-hellman-group14-sha1
+
+        * Supported values:
+
+            * ecdh-sha2-nistp256 **(node v0.11.14 or newer)**
+            * ecdh-sha2-nistp384 **(node v0.11.14 or newer)**
+            * ecdh-sha2-nistp521 **(node v0.11.14 or newer)**
+            * diffie-hellman-group-exchange-sha256 **(node v0.11.12 or newer)**
+            * diffie-hellman-group14-sha1
+            * diffie-hellman-group-exchange-sha1 **(node v0.11.12 or newer)**
+            * diffie-hellman-group1-sha1
+
+    * **cipher** - _array_ - Ciphers.
+
+        * Default values:
+
+            1. aes128-ctr
+            2. aes192-ctr
+            3. aes256-ctr
+            4. aes128-gcm **(node v0.11.12 or newer)**
+            5. aes128-gcm@openssh.com **(node v0.11.12 or newer)**
+            6. aes256-gcm **(node v0.11.12 or newer)**
+            7. aes256-gcm@openssh.com **(node v0.11.12 or newer)**
+
+        * Supported values:
+
+            * aes128-ctr
+            * aes192-ctr
+            * aes256-ctr
+            * aes128-gcm **(node v0.11.12 or newer)**
+            * aes128-gcm@openssh.com **(node v0.11.12 or newer)**
+            * aes256-gcm **(node v0.11.12 or newer)**
+            * aes256-gcm@openssh.com **(node v0.11.12 or newer)**
+            * aes256-cbc
+            * aes192-cbc
+            * aes128-cbc
+            * blowfish-cbc
+            * 3des-cbc
+            * arcfour256
+            * arcfour128
+            * cast128-cbc
+            * arcfour
+
+    * **hmac** - _array_ - (H)MAC algorithms.
+
+        * Default values:
+
+            1. hmac-sha2-256
+            2. hmac-sha2-512
+            3. hmac-sha1
+
+        * Supported values:
+
+            * hmac-sha2-256
+            * hmac-sha2-512
+            * hmac-sha1
+            * hmac-md5
+            * hmac-sha2-256-96
+            * hmac-sha2-512-96
+            * hmac-ripemd160
+            * hmac-sha1-96
+            * hmac-md5-96
+
+    * **compress** - _array_ - Compression algorithms.
+
+        * Default values:
+
+            1. none
+            2. zlib@openssh.com
+            3. zlib
+
+        * Supported values:
+
+            * none
+            * zlib@openssh.com
+            * zlib
+
+* **serverlog.client** - _boolean_ - Enables client command logging on server log (console.log). Very simple at this point, buffers data from client until it receives a line-feed then dumps buffer to console.log with session information for tracking. Will capture anything send from client, including passwords, so use for testing only... Default: false. Example:
+  * _serverlog.client: GcZDThwA4UahDiKO2gkMYd7YPIfVAEFW/mnf0NUugLMFRHhsWAAAA host: 192.168.99.80 command: ls -lat_
+
+* **serverlog.server** - _boolean_ - not implemented, default: false.
+
+* **accesslog** - _boolean_ - http style access logging to console.log, default: false
+
+* **safeShutdownDuration** - _integer_ - maximum delay, in seconds, given to users before the server stops when doing a safe shutdown
+
+# Client-side logging
+Clicking `Start logging` on the status bar will log all data to the client. A `Download log` option will appear after starting the logging. You may download at any time to the client. You may stop logging at any time my pressing the `Logging - STOP LOG`. Note that clicking the `Start logging` option again will cause the current log to be overwritten, so be sure to download first.
 
 # Example:
 
-http://localhost:2222/ssh/host/192.168.1.1?port=2244&header=My%20Header&color=red
+http://localhost:2222/ssh/host/192.168.1.1?port=2244&header=My%20Header&headerBackground=red
 
+# CONTRIBUTING
+As of 0.4.0, we're trying our best to conform to the [Airbnb Javascript Style Guide](https://airbnb.io/projects/javascript/). I'm hoping this will make contributions easier and keep the code readable. I love shortcuts more than anyone but I've found when making changes to code I've not looked at in a while, it can take me a few momements to deconstruct what was being done due to readbility issues. While I don't agree with every decision in the style guide (semi-colons, yuk), it is a good base to keep the code consistent.
+
+If you've not used it before, I recommend installing the [vscode extensions](https://blog.echobind.com/integrating-prettier-eslint-airbnb-style-guide-in-vscode-47f07b5d7d6a) for that and [Prettier](https://prettier.io/) and getting familiar. The autocorrections are great (especially if you hate dealing with semi-colons...)
+
+All contributions are welcome, all may not make it into a release... To increase the chances of your contribution making it into a release, try your best to conform to the style guides and targets of the project.
+
+# Tips
+* You can enable extended debug messages in the browser Java console using:
+  * `localStorage.debug = '*';` - Debug Everything (a lot of messages)
+  * `localStorage.debug = 'WebSSH2';` - Debug potentially interesting WebSSH2 related messages (replaying credentials, resizing data, other control messages)
+* If you want to add custom JavaScript to the browser client you can either modify `./src/client.html` and add a **\<script\>** element, modify `./src/index.js` directly, or check out `webpack.*.js` and add your custom javascript file to a task there (best option).

SECURITY.md

@@ -0,0 +1,16 @@
+# Security Policy
+
+## Supported Versions
+
+The following versions will get security updates. 
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 0.4.x   | :white_check_mark: |
+| 0.3.x   | :x:                |
+| 0.2.x   | :x:                |
+| 0.1.x   | :x:                |
+
+## Reporting a Vulnerability
+
+If you find a vulnerability, simply [open an issue](../../issues/new) with the details, use the label `security`. 

app/.eslintrc.json

@@ -0,0 +1,24 @@
+{
+    "ignorePatterns": ["**/*{.,-}min.js"],
+    "env": {
+        "browser": true,
+        "es2021": true,
+        "node": true
+    },
+    "extends": [
+        "airbnb-base", 
+        "prettier"
+    ],
+    "parser": "@typescript-eslint/parser",
+    "parserOptions": {
+        "ecmaVersion": 12,
+        "sourceType": "module"
+    },
+    "plugins": [
+        "@typescript-eslint",
+        "prettier"
+    ],
+    "rules": {
+        "prettier/prettier": ["error"]
+    }
+}

app/.npmrc

@@ -0,0 +1 @@
+tag-version-prefix=""

app/.prettierrc

@@ -0,0 +1,4 @@
+{
+  "printWidth": 100,
+  "singleQuote": true
+}

app/.snyk

@@ -0,0 +1,4 @@
+# Snyk (https://snyk.io) policy file, patches or ignores known vulnerabilities.
+version: v1.22.1
+ignore: {}
+patch: {}

app/CHANGELOG.md

@@ -0,0 +1,461 @@
+# Changelog
+
+All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
+
+## [0.5.0-pre-4](https://github.com/billchurch/webssh2/compare/webssh2-v0.4.7-pre-4...webssh2-v0.5.0-pre-4) (2022-08-07)
+
+
+### Features
+
+* test change for release ([476b566](https://github.com/billchurch/webssh2/commit/476b566c08a84bd35aaccf847253875b2c3afb10))
+
+## [0.4.7-pre-4](https://github.com/billchurch/webssh2/compare/webssh2-v0.4.7-pre-3...webssh2-v0.4.7-pre-4) (2022-08-03)
+
+
+### Miscellaneous Chores
+
+* release 0.4.7-pre-4 ([7d4ba87](https://github.com/billchurch/webssh2/commit/7d4ba87bc1c198600ea33ee220553ef46ea2a103))
+
+## [0.4.7-pre-3](https://github.com/billchurch/webssh2/compare/webssh2-v0.4.7-pre-2...webssh2-v0.4.7-pre-3) (2022-08-03)
+
+
+### Miscellaneous Chores
+
+* release 0.4.7-pre-3 ([0c78c1f](https://github.com/billchurch/webssh2/commit/0c78c1f31cc6380b7f0706822fc418cfede11413))
+
+## [0.4.7-pre-2](https://github.com/billchurch/webssh2/compare/webssh2-v0.4.6...webssh2-v0.4.7-pre-2) (2022-08-02)
+
+
+### ⚠ BREAKING CHANGES
+
+* validate referer to /reauth is valid
+* bump xterm to 4.18.0
+* consistent logging messages see #286
+* config system changes #284 (#285)
+
+### Features
+
+* add additional params for POST requests [#290](https://github.com/billchurch/webssh2/issues/290) ([46c1560](https://github.com/billchurch/webssh2/commit/46c1560e3c126376e18124e14e5c7fb8c029a0a1))
+* add additional vars to POST requests [#290](https://github.com/billchurch/webssh2/issues/290) ([0a4e419](https://github.com/billchurch/webssh2/commit/0a4e419fb371ae95340fa890497022a2aa9d063a))
+* add fontFamily, letterSpacing, lineHeight ([97f3088](https://github.com/billchurch/webssh2/commit/97f3088780744e13a6724a4967a4896aac3f20d8))
+* add fontSize option [#292](https://github.com/billchurch/webssh2/issues/292) ([5e78812](https://github.com/billchurch/webssh2/commit/5e788129744d326e78ec91bda86ed5cecfd70d3f))
+* config system changes [#284](https://github.com/billchurch/webssh2/issues/284) ([#285](https://github.com/billchurch/webssh2/issues/285)) ([9c99b09](https://github.com/billchurch/webssh2/commit/9c99b0940ec726193deae3c4999d25a297874d67))
+* consistent logging messages see [#286](https://github.com/billchurch/webssh2/issues/286) ([50cfcb9](https://github.com/billchurch/webssh2/commit/50cfcb97788cbd3409b4605adceef3d47e370e38))
+* credentials over http post for [#290](https://github.com/billchurch/webssh2/issues/290) ([5b8f88c](https://github.com/billchurch/webssh2/commit/5b8f88cfef1745c88748277217204e6c38c7ff7e))
+* reorder viewport setup at ssh handshake [#292](https://github.com/billchurch/webssh2/issues/292) ([140e1e2](https://github.com/billchurch/webssh2/commit/140e1e24b14d6b74848e9d250c2b44f806ad627d))
+* validate referer to /reauth is valid ([0dcaa6e](https://github.com/billchurch/webssh2/commit/0dcaa6e15062cdc3252ce52abd9057caf4c00a30))
+
+
+### Bug Fixes
+
+* Fix the parameter passing problem of setDefaultCredentials to make it perform data initialization normally ([#288](https://github.com/billchurch/webssh2/issues/288)) ([40cbb35](https://github.com/billchurch/webssh2/commit/40cbb35616fa17c1c36520690f40ebce0b488153))
+* invalid css in style.css ([ffab534](https://github.com/billchurch/webssh2/commit/ffab5345dcb568fa2bb50a96f403174ad3728286))
+
+
+### package
+
+* bump xterm to 4.18.0 ([84c09ec](https://github.com/billchurch/webssh2/commit/84c09ec8a1909e4bbd0051debdbb905276a4245e))
+
+### [0.4.6](https://github.com/billchurch/WebSSH2/compare/v0.2.10-0...v0.4.6) (2022-04-17)
+
+
+### Features
+
+* add SIGTERM to safe shutdown feature ([675b4f5](https://github.com/billchurch/WebSSH2/commit/675b4f5a3a92b187b620684eb1ce1b7afa0e2e08))
+* **auth:** ssh private key auth implemented via config.json ([#161](https://github.com/billchurch/WebSSH2/issues/161)) ([342df8e](https://github.com/billchurch/WebSSH2/commit/342df8eb9cafba52eb63b50a60e11e1431d6fbd4))
+* **config:** specify local source address and port for client connections fixes [#152](https://github.com/billchurch/WebSSH2/issues/152) ([#158](https://github.com/billchurch/WebSSH2/issues/158)) ([65d6ec6](https://github.com/billchurch/WebSSH2/commit/65d6ec68452b80c42fd62534355e456ce1f16a32))
+* CORS support ([b324f33](https://github.com/billchurch/WebSSH2/commit/b324f338adeb3518322941639fb83ba9370814cc)), closes [#240](https://github.com/billchurch/WebSSH2/issues/240)
+
+
+### Bug Fixes
+
+* deprecated term.setOption ([d903da8](https://github.com/billchurch/WebSSH2/commit/d903da87c41882a3736683c7de497cb8bd37f885))
+* dockerignore ([#272](https://github.com/billchurch/WebSSH2/issues/272)) ([8a68cca](https://github.com/billchurch/WebSSH2/commit/8a68ccaffa374584b5d9531f9dbeae616bd971f5))
+* fixes default for allowreauth ([#239](https://github.com/billchurch/WebSSH2/issues/239)) ([dcfd81b](https://github.com/billchurch/WebSSH2/commit/dcfd81b454b9fe66edec489266dc35a765464c6b)), closes [#238](https://github.com/billchurch/WebSSH2/issues/238)
+* missing ENTRYPOINT for Dockerfile ([6a3a47a](https://github.com/billchurch/WebSSH2/commit/6a3a47a13de3cd70d603379a27e055f08a6ee62c))
+* obey host ssh.host in config fixes [#190](https://github.com/billchurch/WebSSH2/issues/190) ([7b7e8e7](https://github.com/billchurch/WebSSH2/commit/7b7e8e753358ed48f52eb9aa2fc359bf758f304b))
+* subnet unauthorized now emits "ssherror" which persists across websocket termination ([e796f9f](https://github.com/billchurch/WebSSH2/commit/e796f9fb5874d6557433f25e8976b7aa58fa8144))
+* update config.json.sample ([#177](https://github.com/billchurch/WebSSH2/issues/177)) ([42f973b](https://github.com/billchurch/WebSSH2/commit/42f973b4796f7f50237dc8ce613e477aa89352ca))
+* update read-config-ng to 3.0.5, fixes [#277](https://github.com/billchurch/WebSSH2/issues/277) ([3e82c0d](https://github.com/billchurch/WebSSH2/commit/3e82c0dc4d31d1c97a7cf98139ef8e6dc0213b22))
+* update xterm.js fixes [#261](https://github.com/billchurch/WebSSH2/issues/261) ([c801ef9](https://github.com/billchurch/WebSSH2/commit/c801ef9e5826e13a403a6462241cf8a4ff456d45))
+
+## 0.4.5 [20220417]
+### Fixes
+- update read-config-ng to 3.0.5, fixes [#277](../../issues/277)
+## 0.4.5 [20220331]
+### Fixes
+- Update socket.io to 4.2.0
+- Update read-config-ng to 3.0.4
+
+## 0.4.4 [20211209]
+### Fixes
+- Add ./node_modules to .dockerignore [#240](../../issues/240) thanks @UncleSamSwiss
+- validator to 13.7.0 [to mitigate potential Regular Expression Denial of Service (ReDoS)](https://snyk.io/vuln/SNYK-JS-VALIDATOR-1090600)
+- cidr-matcher should be [re-installed to pickup >json-schema@4.0.0 due to prototype pollution vulnerability](https://snyk.io/vuln/SNYK-JS-JSONSCHEMA-1920922)
+- Update xterm.js to 4.15.0 [#261](../../issues/261)
+- Replace deprecated term.setOptions with term.options
+### Changes
+- update README.md for additional Docker methods thanks @Utopiah
+
+## 0.4.3 [20211019]
+- update dependencies
+  - ssh2 to 1.4.0 [to mitigate potential command injection in windows](https://snyk.io/vuln/SNYK-JS-SSH2-1656673)
+## 0.4.2 [20210813]
+### changes
+- update dependencies
+  - socket.io to 4.1.1
+  - read-config-ng to 3.0.2
+  - debug to 4.3.1
+## 0.4.1 [20210703]
+### Fixes
+- lost comma in config.json.sample 71fe377
+### Changes
+- bump ws@7.4.6 to [mitigate potential ReDoS vulnerability](https://github.com/websockets/ws/releases/tag/7.4.6)
+- dev: update CI tools
+- dev: update dev tools
+- dev: update build tools 
+
+## 0.4.0 [20210519]
+### BREAKING
+- Disabled ssh.serverlog.client option, this disables the POC which allowed for logging of the data sent between the client/server to the console.log. 
+- Dropping support for node versions under 14
+### Changes
+- Removed HTML menu code from ./app/server/socket.js, the menu is now fully laid out in the ./app/client/src/index.html and the option elements are hidden by default. Not sure why it wasn't done this way from the start, but there it is.
+- Updated socket.io to v4.1.1
+- Client javascript `./app/client/src/js/index.ts` is now built on TypeScript (`npm run build` will generate javascript for client and place into `app/client/public/webssh2.bundle.js` as before)
+- Build environment changes
+  - removed unused xterm-addon-search, xterm-addon-weblinks, standard, postcss-discard-comments
+  - added prettier 2.3.0, typescript modules, socket.io-client 4.1.1, airbnb linting tools
+### Added
+- Lookup ip address for hostname in URL, fixes #199 thanks to @zwiy
+- Ability to override `Authorization: Basic` header and replace with credentials specified in `config.json` fixes #243. New config.json option `user.overridebasic`
+### CONTRIBUTING
+In this release, we're trying our best to conform to the [Airbnb Javascript Style Guide](https://airbnb.io/projects/javascript/). I'm hoping this will make contributions easier and keep the code readable. I love shortcuts more than anyone but I've found when making changes to code I've not looked at in a while, it can take me a few momements to deconstruct what was being done due to readbility issues. While I don't agree with every decision in the style guide (semi-colons, yuk), it is a good base to keep the code consistent.
+
+If you've not used it before, I recommend installing the [vscode extensions](https://blog.echobind.com/integrating-prettier-eslint-airbnb-style-guide-in-vscode-47f07b5d7d6a) for that and [Prettier](https://prettier.io/) and getting familiar. The autocorrections are great (especially if you hate dealing with semi-colons...)
+
+As of 0.4.0-testing-0, the client code is written in [TypeScript](https://www.typescriptlang.org/docs/handbook/typescript-in-5-minutes.html). It's not that much different from JavaScript, and the introduction strong typing will ultimately help to produce better code. Eventually we want to move the whole project to TypeScript but that make take a bit more time. Take a moment to look at ./app/client/src/js/index.ts to see what TypeScript looks like.
+## 0.3.1 [20210513]
+### BREAKING
+- Ability to configure CORS settings for socket.io see [#240](../../issues/240) for more information on how this may break existing deployments. Default settings in example `config.json` are currently permissive `http.origins: ["*:*"]` please note that if a `config.json` is not present, the default is `http.origins: ["localhost:2222"]
+### Added
+- Safe Shutdown Feature - thanks to @edgarogh
+  - Sending SIGINT or SIGTERM to node process responsible for WebSSH2 or Docker process will result in a "safe" shutdown
+  - Timer is configured in config.safeShutdownDuration
+- feat: Use docker build to create multi-arch images (#202)
+### Fixed
+- obey host ssh.host in config fixes #190
+### Changed
+- `config.json.sample`: `allowreauth` now defaults to `false` fixes #238
+- update ssh2 to 0.8.8 -> 0.8.9 - [comparison at ssh2 repo](https://github.com/mscdex/ssh2/compare/v0.8.8...v0.8.9)
+- update xterm to 4.12.0 [comparison at xtermjs repo](https://github.com/xtermjs/xterm.js/compare/4.4.0...4.12.0)
+- update read-config-ng to 3.0.2
+- update morgan to 1.10.0
+- update debug to 4.3.1
+- update express-session to 1.17.1
+- update validator to 13.6.0
+- development tools updates (build environment requires minimum of Node 10, only needed for customization)
+  - update @fortawesome/fontawesome-svg-core to 1.2.35
+  - update @fortawesome/free-solid-svg-icons to 5.15.3
+  - update copy-webpack-plugin to 8.1.1
+  - update cross-env to 7.0.3
+  - update css-loader to 5.2.4
+  - update file-loader to 6.2.0
+  - update mini-css-extract-plugin to 1.6.0
+  - update postcss-discard-comments to 5.0.0
+  - update snazzy to 9.0.0
+  - update standard to 16.0.3
+  - update standard-version to 9.3.0
+  - update style-loader to 2.0.0
+  - update terser-webpack-plugin to 5.1.1
+  - update url-loader to 4.1.1
+  - update webpack to 5.37.0
+  - update webpack-cli to 4.7.0
+  - update webpack-merge to 5.7.3
+  - update webpack-stream to 6.1.2
+  - update xterm-addon-fit to 0.5.0
+  - update xterm-addon-search to 0.8.0
+  - update xterm-addon-web-links to 0.4.0
+  - update ssri from 6.0.1 to 6.0.2 [#233](../../pull/233)
+  - update hosted-git-info from 2.8.5 to 2.8.9 [#237](../../pull/237)
+  - update lodash from 4.17.19 to 4.17.21 [#236](../../pull/236)
+  - update handlebars from 4.7.6 to 4.7.7 [#235](../../pull/235)
+  - update y18n from 4.0.0 to 4.0.1 [#230](../../pull/230)
+  - update elliptic from 6.5.3 to 6.5.4 [#228](../../pull/222833)
+  - update ini from 1.3.5 to 1.3.8 [#217](../../pull/217)
+## 0.3.0 [20200315]
+🍀🍀🍀
+### Added
+- Add configuration option to restrict connections to specified subnets thanks to @Mierdin
+- favicon
+  - added module `serve-favicon` to serve favicon from root if pre-fetched by browser
+  - added `link rel=icon` line in client.htm to serve favico.ico out of /ssh/
+
+### Changed
+- Using new repo for read-config -> read-config-ng-
+- removed express compression feature, added no real value.
+- module updates
+  - ssh2 to 0.8.6 -> 0.8.8 - [comparison at ssh2 repo](https://github.com/mscdex/ssh2/compare/v0.8.6...v0.8.8)
+  - xterm 4.2.0 -> 4.4.0 - [comparison at xtermjs repo](https://github.com/xtermjs/xterm.js/compare/4.2.0...4.4.0)
+  - read-config-ng 3.0.1 - (taking over abandoned repo)n
+- development module updates (does not impact production, only for development and rebuilding)
+  - fortawesome/fontawesome-svg-core 1.2.27
+  - fortawesome/free-solid-svg-icons 5.12.1
+  - standard-version 7.1.0
+  - webpack 4.42.0
+    - webpack-cli 3.3.11
+    - terser-webpack-plugin 2.3.5
+    - copy-webpack-plugin 5.1.1
+    - cross-env 7.0.2
+    - css-loader 3.4.2
+    - file-loader 5.1.0
+    - style-loader 1.1.3
+    - url-loader 3.0.0
+
+### Potentially Breaking Changes
+- Move all child resources to start from under /ssh
+  - /socket.io -> /ssh/socket.io
+  - /webssh2.css -> /ssh/webssh2.css
+  - /webssh2.bundle.js -> /ssh/webssh2.bundle.js
+  - /reauth -> /ssh/reauth
+  - perhaps more
+
+### Fixes
+- Typo in config.json.sample, thanks @wuchihsu, fixes #173
+
+### Housekeeping
+- Removed irrelavant build scripts from /scripts
+
+## 0.2.9 [2019-06-13]
+### Changes
+- Missing require('fs') in `server/app.js` See issue [#135](../../issues/135)
+- Patched read-config to mitigate vulnerability in js-yaml
+  - issue not exploitable on webssh2 implementation
+  - patched anyway
+  - sending my patch upstream to read-config, webssh2 package.json points to patched version in my repository https://github.com/billchurch/nodejs-read-config
+  - See https://github.com/nodeca/js-yaml/issues/475 for more detail
+
+## 0.2.8 [2019-05-25]
+### Changes
+- Fixes issue if no password is entered, browser must be closed and restart to attempt to re-auth. See issue [#118](../../issues/118). Thanks @smilesm2 for the idea.
+- fixes broken `npm run (build|builddev)`
+  - update font-awesome fonts to 5.6.3
+  - update webpack and dependancies
+  - update xterm to 3.8.0
+
+### Fixes
+- ILX workspace may not always import properly due to symbolic links (specifically ./node_modules/.bin). This is removed from the ILX package
+
+## 0.2.7 [2018-11-11]
+### Changes
+- `config.reauth` was not respected if initial auth presented was incorrect, regardless of `reauth` setting in `config.json` reauth would always be attempted. fixes [#117](../../issues/117) 
+- **BREAKING** moved app files to /app, this may be a breaking change
+- Updated dockerfile for new app path
+- Updated app dependancies
+  - xterm v3.8.0
+    - https://github.com/xtermjs/xterm.js/releases/tag/3.8.0
+  - basic-auth v2.0.1
+    - https://github.com/jshttp/basic-auth/releases/tag/v2.0.1
+  - express v4.16.4
+    - https://github.com/expressjs/express/releases/tag/4.16.4
+  - validator v10.9.0
+    - https://github.com/chriso/validator.js/releases/tag/10.9.0
+- Updated dev dependancies
+  - snazzy v8.0.0 
+  - standard v12.0.1 
+  - uglifyjs-webpack-plugin v2.0.1 
+  - ajv v6.5.5 
+  - copy-webpack-plugin v4.6.0 
+  - css-loader v1.0.1 
+  - nodemon v1.18.6 
+  - postcss-discard-comments v4.0.1 
+  - snyk v1.108.2 
+  - url-loader v1.1.2 
+  - webpack v4.25.1 
+  - webpack-cli v3.1.2 
+
+## 0.2.6 [2018-11-09]
+### Changes
+- Reauth didn't work if intial auth presented was incorrect, (see issue #112) fixed thanks @vvalchev
+- Update node version supported to >=6 (PR #115) thanks @perlun
+- Update packages
+  - developer dependencies
+
+## 0.2.5 [2018-09-11]
+### Added
+- Reauth function thanks to @vbeskrovny and @vvalchev (9bbc116)
+  - Controlled by `config.json` option `options.allowreauth` true presents reauth dialog and false hides dialog
+
+### Changed
+- `options.challengeButton` enabled
+  - previously this configuration option did nothing, this now enables the Credentials button site-wide regardless of the `allowreplay` header value
+- Updated debug module to v4
+
+## 0.2.4 [2018-07-18]
+### Added
+- Browser title window now changes with xterm escape sequences (see http://tldp.org/HOWTO/Xterm-Title-3.html)
+- Added bellStyle options
+  - `GET var`: **bellStyle** - _string_ - Style of terminal bell: ("sound"|"none"). **Default:** "sound". **Enforced Values:** "sound "none"
+  - `config.json`: **terminal.bellStyle** - _string_ - Style of terminal bell: (sound|none). **Default:** "sound".
+  - `workspace` folder on GITHUB for BIG-IP specific fixes/changes
+### Changed
+- Updated xterm.js to 3.1.0
+  - https://github.com/xtermjs/xterm.js/releases/tag/3.1.0
+- Default listen IP in `config.json` changed back to 127.0.0.1 
+### Fixed
+- ESC]0; is now removed from log files when using the browser-side logging feature
+
+## 0.2.3 unreleased
+
+### Fixed
+- ESC]0; is now removed from log files when using the browser-side logging feature
+
+## 0.2.0 [2018-02-10]
+Mostly client (browser) related changes in this release
+
+### Added
+- Menu system
+- Fontawesome icons
+- Resizing browser window sends resize events to terminal container as well as SSH session (pty)
+- New terminal options (config.json as well as GET vars)
+  - terminal.cursorBlink - boolean - Cursor blinks (true), does not (false) Default: true.
+  - terminal.scrollback - integer - Lines in the scrollback buffer. Default: 10000.
+  - terminal.tabStopWidth - integer - Tab stops at n characters Default: 8.
+- New serverside (nodejs) terminal configuration options (cursorBlink, scrollback, tabStopWidth)
+- Logging of MRH session (unassigned if not present)
+- Express compression feature
+
+### Changed
+- Updated xterm.js to 3.0.2
+  - See https://github.com/xtermjs/xterm.js/releases/tag/3.0.2
+  - See https://github.com/xtermjs/xterm.js/releases/tag/3.0.1
+  - See https://github.com/xtermjs/xterm.js/releases/tag/3.0.0
+- Moved javascript events out of html into javascript
+- Changed asset packaging from grunt to Webpack to be inline with xterm.js direction
+- Moved logging and credentials buttons to menu system
+- Removed non-minified options (if you need to disable minification, modify webpack scripts and 'npm run build')
+
+### Fixed
+- Resolved loss of terminal foucs when interacting with option buttons (Logging, etc...)
+
+## 0.1.4 [2018-01-30]
+### Changed
+- Moved socket and util out of folders into .js in root.
+- added keepaliveInterval and keepaliveCountMax config options
+
+## 0.1.3 [2017-09-28]
+### Changed
+- Upgrade to debug@3.1 to eliminate ReDoS in %o formatter
+- Upgrade Express to 4.15.5 for ReDOS
+- Upgrade basic-auth to v2.0
+## 0.1.2 [2017-07-31]
+### Added
+- ssh.readyTimeout option in config.json (time in ms, default 20000, 20sec)
+### Changed
+- Updated xterm.js to 2.9.2 from 2.6.0
+  - See https://github.com/sourcelair/xterm.js/releases/tag/2.9.2
+  - See https://github.com/sourcelair/xterm.js/releases/tag/2.9.1
+  - See https://github.com/sourcelair/xterm.js/releases/tag/2.9.0
+  - See https://github.com/sourcelair/xterm.js/releases/tag/2.8.1
+  - See https://github.com/sourcelair/xterm.js/releases/tag/2.8.0
+  - See https://github.com/sourcelair/xterm.js/releases/tag/2.7.0
+- Updated ssh2 to 0.5.5 to keep current, no fixes impacting WebSSH2
+  - ssh-streams to 0.1.19 from 0.1.16
+- Updated validator.js to 8.0.0, no fixes impacting WebSSH2
+  - https://github.com/chriso/validator.js/releases/tag/8.0.0
+- Updated Express to 4.15.4, no fixes impacting WebSSH2
+  - https://github.com/expressjs/express/releases/tag/4.15.4
+- Updated Express-session to 1.15.5, no fixes impacting WebSSH2
+  - https://github.com/expressjs/session/releases/tag/v1.15.5
+- Updated Debug to 3.0.0, no fixes impacting WebSSH2
+  - https://github.com/visionmedia/debug/releases/tag/3.0.0
+- Running in strict mode ('use strict';)
+
+
+## 0.1.1 [2017-06-03]
+### Added
+- `serverlog.client` and `serverlog.server` options added to `config.json` to enable logging of client commands to server log (only client portion implemented at this time)
+- morgan express middleware for logging
+### Changed
+- Updated socket.io to 1.7.4
+- continued refactoring, breaking up `index.js`
+- revised error handling methods
+- revised session termination methods
+### Fixed
+### Removed
+- color console decorations from `util/index.js`
+- SanatizeHeaders function from `util/index.js`
+
+## 0.1.0 [2017-05-27]
+### Added
+- This ChangeLog.md file
+- Support for UTF-8 characters (thanks @bara666)
+- Snyk, Bithound, Travis CI
+- Cross platform improvements (path mappings)
+- Session fixup between Express and Socket.io
+- Session secret settings in `config.json`
+- env variable `DEBUG=ssh2` will put the `ssh2` module into debug mode
+- env variable `DEBUG=WebSSH2` will output additional debug messages for functions
+and events in the application (not including the ssh2 module debug)
+- using Grunt to pull js and css source files from other modules `npm run build` to rebuild these if changed or updated.
+- `useminified` option in `config.json` to enable using minified client side javascript (true) defaults to false (non-minified)
+- sshterm= query option to specify TERM environment variable for host, valid strings are alpha-numeric with a hypen (validated). Otherwise the default ssh.term variable from `config.json` will be used.
+- validation for host (v4,v6,fqdn,hostname), port (integer 2-65535), and header (sanitized) from URL input
+
+### Changed
+- error handling in public/client.js
+- moved socket.io operations to their own file /socket/index.js, more changes like this to come (./socket/index.js)
+- all session based variables are now under the req.session.ssh property or socket.request.ssh (./index.js)
+- moved SSH algorithms to `config.json` and defined as a session variable (..session.ssh.algorithms)
+-- prep for future feature to define algorithms in header or some other method to enable separate ciphers per host
+- minified and combined all js files to a single js in `./public/webssh2.min.js` also included a sourcemap `./public/webssh2.min.js` which maps to `./public/webssh2.js` for easier troubleshooting.
+- combined all css files to a single css in `./public/webssh2.css`
+- minified all css files to a single css in `./public/webssh2.min.css`
+- copied all unmodified source css and js to /public/src/css and /public/src/js respectively (for troubleshooting/etc)
+- sourcemaps of all minified code (in /public/src and /public/src/js)
+- renamed `client.htm` to `client-full.htm`
+- created `client-min.htm` to serve minified javascript
+- if header.text is null in `config.json` and header is not defined as a get parameter the Header will not be displayed. Both of these must be null / undefined and not specified as get parameters.
+
+### Fixed
+- Multiple errors may overwrite status bar which would cause confusion as to what originally caused the error. Example, ssh server disconnects which prompts a cascade of events (conn.on('end'), socket.on('disconnect'), conn.on('close')) and the original reason (conn.on('end')) would be lost and the user would erroneously receive a WEBSOCKET error as the last event to fire would be the websocket connection closing from the app.
+- ensure ssh session is closed when a browser disconnects from the websocket
+- if headerBackground is changed, status background is changed to the same color (typo, fixed)
+
+### Removed
+- Express Static References directly to module source directories due to concatenating and minifying js/css
+
+## 0.0.5 - [2017-03-23]
+### Added
+- Added experimental support for logging (see Readme)
+
+### Fixed
+- Terminal geometry now properly fills the browser screen and communicates this to the ssh session. Tested with IE 11 and recent versions of Chrome/Safari/Firefox.
+
+## 0.0.4 - [2017-03-23]
+### Added
+- Set default terminal to xterm-color
+- Mouse event support
+- New config option, config.ssh.term to set terminal
+
+### Changed
+- Update to Xterm.js 2.4.0
+- Minor code formatting cleanup
+
+## 0.0.3 - [2017-02-16]
+### Changed
+- Update xterm to latest (2.3.0)
+### Fixed
+- Fixed misspelled config.ssh.port property
+
+## 0.0.2 - [2017-02-01]
+### Changed
+- Moving terminal emulation to xterm.js
+- updating module version dependencies
+
+### Fixed
+- Fixed issue with banners not being displayed properly from UNIX hosts when only lf is used
+
+## 0.0.1 - [2016-06-28]
+### Added
+- Initial proof of concept and release. For historical purposes only.

app/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Bill Church
+
+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.

app/client/public/client.htm

@@ -0,0 +1,32 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>WebSSH2</title>
+  <style>
+    html, body {background-color: #000;height: 100%;margin: 0;}.dropup-content {display: none;}
+  </style>
+  <link rel="stylesheet" href="/ssh/webssh2.css" />
+  <link rel="icon" href="/ssh/favicon.ico" />
+</head>
+<body>
+  <div class="box">
+    <div id="header"></div>
+    <div id="terminal-container" class="terminal"></div>
+    <div id="bottomdiv">
+      <div class="dropup" id="menu">
+        <i class="fas fa-bars fa-fw"></i> Menu
+        <div id="dropupContent" class="dropup-content">
+          <a id="logBtn"><i class="fas fa-clipboard fa-fw"></i> Start Log</a>
+          <a id="downloadLogBtn"><i class="fas fa-download fa-fw"></i> Download Log</a>
+          <a id="reauthBtn" style="display: none;"><i class="fas fa-key fa-fw"></i> Switch User</a>
+          <a id="credentialsBtn" style="display: none;"><i class="fas fa-key fa-fw"></i> Credentials</a>
+        </div>
+      </div>
+      <div id="footer"></div>
+      <div id="status"></div>
+      <div id="countdown"></div>
+    </div>
+  </div>
+<script src="/ssh/webssh2.bundle.js" defer></script>
+</body>
+</html>

app/client/public/webssh2.css

@@ -0,0 +1,366 @@
+/**
+ * Copyright (c) 2014 The xterm.js authors. All rights reserved.
+ * Copyright (c) 2012-2013, Christopher Jeffrey (MIT License)
+ * https://github.com/chjj/term.js
+ * @license MIT
+ *
+ * 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.
+ *
+ * Originally forked from (with the author's permission):
+ *   Fabrice Bellard's javascript vt100 for jslinux:
+ *   http://bellard.org/jslinux/
+ *   Copyright (c) 2011 Fabrice Bellard
+ *   The original design remains. The terminal itself
+ *   has been extended to include xterm CSI codes, among
+ *   other features.
+ */
+
+/**
+ *  Default styles for xterm.js
+ */
+
+.xterm {
+    cursor: text;
+    position: relative;
+    user-select: none;
+    -ms-user-select: none;
+    -webkit-user-select: none;
+}
+
+.xterm.focus,
+.xterm:focus {
+    outline: none;
+}
+
+.xterm .xterm-helpers {
+    position: absolute;
+    top: 0;
+    /**
+     * The z-index of the helpers must be higher than the canvases in order for
+     * IMEs to appear on top.
+     */
+    z-index: 5;
+}
+
+.xterm .xterm-helper-textarea {
+    padding: 0;
+    border: 0;
+    margin: 0;
+    /* Move textarea out of the screen to the far left, so that the cursor is not visible */
+    position: absolute;
+    opacity: 0;
+    left: -9999em;
+    top: 0;
+    width: 0;
+    height: 0;
+    z-index: -5;
+    /** Prevent wrapping so the IME appears against the textarea at the correct position */
+    white-space: nowrap;
+    overflow: hidden;
+    resize: none;
+}
+
+.xterm .composition-view {
+    /* TODO: Composition position got messed up somewhere */
+    background: #000;
+    color: #FFF;
+    display: none;
+    position: absolute;
+    white-space: nowrap;
+    z-index: 1;
+}
+
+.xterm .composition-view.active {
+    display: block;
+}
+
+.xterm .xterm-viewport {
+    /* On OS X this is required in order for the scroll bar to appear fully opaque */
+    background-color: #000;
+    overflow-y: scroll;
+    cursor: default;
+    position: absolute;
+    right: 0;
+    left: 0;
+    top: 0;
+    bottom: 0;
+}
+
+.xterm .xterm-screen {
+    position: relative;
+}
+
+.xterm .xterm-screen canvas {
+    position: absolute;
+    left: 0;
+    top: 0;
+}
+
+.xterm .xterm-scroll-area {
+    visibility: hidden;
+}
+
+.xterm-char-measure-element {
+    display: inline-block;
+    visibility: hidden;
+    position: absolute;
+    top: 0;
+    left: -9999em;
+    line-height: normal;
+}
+
+.xterm.enable-mouse-events {
+    /* When mouse events are enabled (eg. tmux), revert to the standard pointer cursor */
+    cursor: default;
+}
+
+.xterm.xterm-cursor-pointer,
+.xterm .xterm-cursor-pointer {
+    cursor: pointer;
+}
+
+.xterm.column-select.focus {
+    /* Column selection mode */
+    cursor: crosshair;
+}
+
+.xterm .xterm-accessibility:not(.debug),
+.xterm .xterm-message {
+    position: absolute;
+    left: 0;
+    top: 0;
+    bottom: 0;
+    right: 0;
+    z-index: 10;
+    color: transparent;
+    pointer-events: none;
+}
+
+.xterm .xterm-accessibility-tree:not(.debug) *::selection {
+  color: transparent;
+}
+
+.xterm .xterm-accessibility-tree {
+  user-select: text;
+  white-space: pre;
+}
+
+.xterm .live-region {
+    position: absolute;
+    left: -9999px;
+    width: 1px;
+    height: 1px;
+    overflow: hidden;
+}
+
+.xterm-dim {
+    /* Dim should not apply to background, so the opacity of the foreground color is applied
+     * explicitly in the generated class and reset to 1 here */
+    opacity: 1 !important;
+}
+
+.xterm-underline-1 { text-decoration: underline; }
+.xterm-underline-2 { text-decoration: double underline; }
+.xterm-underline-3 { text-decoration: wavy underline; }
+.xterm-underline-4 { text-decoration: dotted underline; }
+.xterm-underline-5 { text-decoration: dashed underline; }
+
+.xterm-overline {
+    text-decoration: overline;
+}
+
+.xterm-overline.xterm-underline-1 { text-decoration: overline underline; }
+.xterm-overline.xterm-underline-2 { text-decoration: overline double underline; }
+.xterm-overline.xterm-underline-3 { text-decoration: overline wavy underline; }
+.xterm-overline.xterm-underline-4 { text-decoration: overline dotted underline; }
+.xterm-overline.xterm-underline-5 { text-decoration: overline dashed underline; }
+
+.xterm-strikethrough {
+    text-decoration: line-through;
+}
+
+.xterm-screen .xterm-decoration-container .xterm-decoration {
+	z-index: 6;
+	position: absolute;
+}
+
+.xterm-screen .xterm-decoration-container .xterm-decoration.xterm-decoration-top-layer {
+	z-index: 7;
+}
+
+.xterm-decoration-overview-ruler {
+    z-index: 8;
+    position: absolute;
+    top: 0;
+    right: 0;
+    pointer-events: none;
+}
+
+.xterm-decoration-top {
+    z-index: 2;
+    position: relative;
+}
+
+body, html  {
+  font-family: helvetica, sans-serif, arial;
+  font-size: 1em;
+  background-color: rgb(0, 0, 0);
+  color: rgb(240, 240, 240);
+  height: 100%;
+  margin: 0;
+}
+#header {
+    color: rgb(240, 240, 240);
+    background-color: rgb(0, 128, 0);
+    width: 100%;
+    border-color: white;
+    border-style: none none solid none;
+    border-width: 1px;
+    text-align: center;
+    flex: 0 1 auto;
+    z-index: 99;
+    height:19px;
+    display: none;
+}
+.box {
+    display: block;
+    height: 100%;
+}
+#terminal-container {
+    display: block;
+    width: calc(100% - 1px);
+    margin: 0 auto;
+    padding: 2px;
+    height: calc(100% - 19px);
+}
+#terminal-container .terminal {
+    background-color: #000000;
+    color: #fafafa;
+    padding: 2px;
+    height: calc(100% - 19px);
+}
+#terminal-container .terminal:focus .terminal-cursor {
+    background-color: #fafafa;
+}
+#bottomdiv {
+    position: fixed;
+    left: 0;
+    bottom: 0;
+    width: 100%;
+    background-color: rgb(50, 50, 50);
+    border-color: white;
+    border-style: solid none none none;
+    border-width: 1px;
+    z-index: 99;
+    height: 19px;
+}
+#footer {
+    display: inline-block;
+    color: rgb(240, 240, 240);
+    background-color: rgb(50, 50, 50);
+    padding-left: 5px;
+    padding-right: 5px;
+    border-color: white;
+    border-style: none none none solid;
+    border-width: 1px;
+    text-align: left;
+}
+#status {
+    display: inline-block;
+    color: rgb(240, 240, 240);
+    background-color: rgb(50, 50, 50);
+    padding-left: 10px;
+    padding-right: 10px;
+    border-color: white;
+    border-style: none solid none solid;
+    border-width: 1px;
+    text-align: left;
+    z-index: 100;
+}
+#countdown {
+    display: none;
+    color: rgb(240, 240, 240);
+    background-color: rgb(50, 50, 50);
+    padding-left: 10px;
+    padding-right: 10px;
+    border-color: white;
+    border-style: none solid none solid;
+    border-width: 1px;
+    text-align: left;
+    z-index: 100;
+}
+#countdown.active {
+    display: inline-block;
+    animation: countdown infinite alternate 200ms;
+}
+@keyframes countdown {
+    from {
+        background-color: rgb(255, 255, 0);
+    }
+    to {
+        background-color: inherit;
+    }
+}
+#menu {
+    display: inline-block;
+    font-size: 16px;
+    color: rgb(255, 255, 255);
+    padding-left: 10px;
+    z-index: 100;
+}
+#menu:hover .dropup-content {
+    display: block;
+}
+#logBtn, #credentialsBtn, #reauthBtn {
+    color: #000;
+}
+
+.dropup {
+    position: relative;
+    display: inline-block;
+    cursor: pointer;
+}
+.dropup-content {
+  display: none;
+  position: absolute;
+  background-color: #f1f1f1;
+  font-size: 16px;
+  min-width: 160px;
+  bottom: 18px;
+  z-index: 101;
+}
+.dropup-content a {
+    color: #777;
+    padding: 12px 16px;
+    text-decoration: none;
+    display: block;
+}
+.dropup-content a:hover {
+    background-color: #ccc
+}
+.dropup:hover .dropup-content {
+    display: block;
+}
+.dropup:active .dropup-content {
+    display: block;
+}
+.dropup:hover .dropbtn {
+    background-color: #3e8e41;
+}
+

app/client/src/README.md

@@ -0,0 +1 @@
+Customizations and modifications to the client (browser) go here. Then run "npm run build" to integrate into ../public (where client files are served from). Note that ../public is a flat directory structure. ../public directory is deleted and refreshed eatch thime "npm run build" is run.

app/client/src/client.htm

@@ -0,0 +1,32 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>WebSSH2</title>
+  <style>
+    html, body {background-color: #000;height: 100%;margin: 0;}.dropup-content {display: none;}
+  </style>
+  <link rel="stylesheet" href="/ssh/webssh2.css" />
+  <link rel="icon" href="/ssh/favicon.ico" />
+</head>
+<body>
+  <div class="box">
+    <div id="header"></div>
+    <div id="terminal-container" class="terminal"></div>
+    <div id="bottomdiv">
+      <div class="dropup" id="menu">
+        <i class="fas fa-bars fa-fw"></i> Menu
+        <div id="dropupContent" class="dropup-content">
+          <a id="logBtn"><i class="fas fa-clipboard fa-fw"></i> Start Log</a>
+          <a id="downloadLogBtn"><i class="fas fa-download fa-fw"></i> Download Log</a>
+          <a id="reauthBtn" style="display: none;"><i class="fas fa-key fa-fw"></i> Switch User</a>
+          <a id="credentialsBtn" style="display: none;"><i class="fas fa-key fa-fw"></i> Credentials</a>
+        </div>
+      </div>
+      <div id="footer"></div>
+      <div id="status"></div>
+      <div id="countdown"></div>
+    </div>
+  </div>
+<script src="/ssh/webssh2.bundle.js" defer></script>
+</body>
+</html>

app/client/src/css/style.css

@@ -0,0 +1,146 @@
+body, html  {
+  font-family: helvetica, sans-serif, arial;
+  font-size: 1em;
+  background-color: rgb(0, 0, 0);
+  color: rgb(240, 240, 240);
+  height: 100%;
+  margin: 0;
+}
+#header {
+    color: rgb(240, 240, 240);
+    background-color: rgb(0, 128, 0);
+    width: 100%;
+    border-color: white;
+    border-style: none none solid none;
+    border-width: 1px;
+    text-align: center;
+    flex: 0 1 auto;
+    z-index: 99;
+    height:19px;
+    display: none;
+}
+.box {
+    display: block;
+    height: 100%;
+}
+#terminal-container {
+    display: block;
+    width: calc(100% - 1px);
+    margin: 0 auto;
+    padding: 2px;
+    height: calc(100% - 19px);
+}
+#terminal-container .terminal {
+    background-color: #000000;
+    color: #fafafa;
+    padding: 2px;
+    height: calc(100% - 19px);
+}
+#terminal-container .terminal:focus .terminal-cursor {
+    background-color: #fafafa;
+}
+#bottomdiv {
+    position: fixed;
+    left: 0;
+    bottom: 0;
+    width: 100%;
+    background-color: rgb(50, 50, 50);
+    border-color: white;
+    border-style: solid none none none;
+    border-width: 1px;
+    z-index: 99;
+    height: 19px;
+}
+#footer {
+    display: inline-block;
+    color: rgb(240, 240, 240);
+    background-color: rgb(50, 50, 50);
+    padding-left: 5px;
+    padding-right: 5px;
+    border-color: white;
+    border-style: none none none solid;
+    border-width: 1px;
+    text-align: left;
+}
+#status {
+    display: inline-block;
+    color: rgb(240, 240, 240);
+    background-color: rgb(50, 50, 50);
+    padding-left: 10px;
+    padding-right: 10px;
+    border-color: white;
+    border-style: none solid none solid;
+    border-width: 1px;
+    text-align: left;
+    z-index: 100;
+}
+#countdown {
+    display: none;
+    color: rgb(240, 240, 240);
+    background-color: rgb(50, 50, 50);
+    padding-left: 10px;
+    padding-right: 10px;
+    border-color: white;
+    border-style: none solid none solid;
+    border-width: 1px;
+    text-align: left;
+    z-index: 100;
+}
+#countdown.active {
+    display: inline-block;
+    animation: countdown infinite alternate 200ms;
+}
+@keyframes countdown {
+    from {
+        background-color: rgb(255, 255, 0);
+    }
+    to {
+        background-color: inherit;
+    }
+}
+#menu {
+    display: inline-block;
+    font-size: 16px;
+    color: rgb(255, 255, 255);
+    padding-left: 10px;
+    z-index: 100;
+}
+#menu:hover .dropup-content {
+    display: block;
+}
+#logBtn, #credentialsBtn, #reauthBtn {
+    color: #000;
+}
+
+.dropup {
+    position: relative;
+    display: inline-block;
+    cursor: pointer;
+}
+.dropup-content {
+  display: none;
+  position: absolute;
+  background-color: #f1f1f1;
+  font-size: 16px;
+  min-width: 160px;
+  bottom: 18px;
+  z-index: 101;
+}
+.dropup-content a {
+    color: #777;
+    padding: 12px 16px;
+    text-decoration: none;
+    display: block;
+}
+.dropup-content a:hover {
+    background-color: #ccc
+}
+.dropup:hover .dropup-content {
+    display: block;
+}
+.dropup:active .dropup-content {
+    display: block;
+}
+.dropup:hover .dropbtn {
+    background-color: #3e8e41;
+}

app/client/src/js/index.ts

@@ -0,0 +1,285 @@
+/* eslint-disable import/no-extraneous-dependencies */
+import { io } from 'socket.io-client';
+import { Terminal } from '@xterm/xterm';
+import { FitAddon } from '@xterm/addon-fit';
+import { library, dom } from '@fortawesome/fontawesome-svg-core';
+import { faBars, faClipboard, faDownload, faKey, faCog } from '@fortawesome/free-solid-svg-icons';
+
+library.add(faBars, faClipboard, faDownload, faKey, faCog);
+dom.watch();
+
+const debug = require('debug')('WebSSH2');
+require('@xterm/xterm/css/xterm.css');
+require('../css/style.css');
+
+/* global Blob, logBtn, credentialsBtn, reauthBtn, downloadLogBtn */ // eslint-disable-line
+let sessionLogEnable = false;
+let loggedData = false;
+let allowreplay = false;
+let allowreauth = false;
+let sessionLog: string;
+let sessionFooter: any;
+let logDate: {
+  getFullYear: () => any;
+  getMonth: () => number;
+  getDate: () => any;
+  getHours: () => any;
+  getMinutes: () => any;
+  getSeconds: () => any;
+};
+let currentDate: Date;
+let myFile: string;
+let errorExists: boolean;
+const term = new Terminal();
+// DOM properties
+const logBtn = document.getElementById('logBtn');
+const credentialsBtn = document.getElementById('credentialsBtn');
+const reauthBtn = document.getElementById('reauthBtn');
+const downloadLogBtn = document.getElementById('downloadLogBtn');
+const status = document.getElementById('status');
+const header = document.getElementById('header');
+const footer = document.getElementById('footer');
+const countdown = document.getElementById('countdown');
+const fitAddon = new FitAddon();
+const terminalContainer = document.getElementById('terminal-container');
+term.loadAddon(fitAddon);
+term.open(terminalContainer);
+term.focus();
+fitAddon.fit();
+
+const socket = io({
+  path: '/ssh/socket.io',
+});
+
+// reauthenticate
+function reauthSession () { // eslint-disable-line
+  debug('re-authenticating');
+  socket.emit('control', 'reauth');
+  window.location.href = '/ssh/reauth';
+  return false;
+}
+
+// cross browser method to "download" an element to the local system
+// used for our client-side logging feature
+function downloadLog () { // eslint-disable-line
+  if (loggedData === true) {
+    myFile = `WebSSH2-${logDate.getFullYear()}${
+      logDate.getMonth() + 1
+    }${logDate.getDate()}_${logDate.getHours()}${logDate.getMinutes()}${logDate.getSeconds()}.log`;
+    // regex should eliminate escape sequences from being logged.
+    const blob = new Blob(
+      [
+        sessionLog.replace(
+          // eslint-disable-next-line no-control-regex
+          /[\u001b\u009b][[\]()#;?]*(?:\d{1,4}(?:;\d{0,4})*)?[0-9A-ORZcf-nqry=><;]/g,
+          ''
+        ),
+      ],
+      {
+        // eslint-disable-line no-control-regex
+        type: 'text/plain',
+      }
+    );
+    const elem = window.document.createElement('a');
+    elem.href = window.URL.createObjectURL(blob);
+    elem.download = myFile;
+    document.body.appendChild(elem);
+    elem.click();
+    document.body.removeChild(elem);
+  }
+  term.focus();
+}
+// Set variable to toggle log data from client/server to a varialble
+// for later download
+function toggleLog () { // eslint-disable-line
+  if (sessionLogEnable === true) {
+    sessionLogEnable = false;
+    loggedData = true;
+    logBtn.innerHTML = '<i class="fas fa-clipboard fa-fw"></i> Start Log';
+    currentDate = new Date();
+    sessionLog = `${sessionLog}\r\n\r\nLog End for ${sessionFooter}: ${currentDate.getFullYear()}/${
+      currentDate.getMonth() + 1
+    }/${currentDate.getDate()} @ ${currentDate.getHours()}:${currentDate.getMinutes()}:${currentDate.getSeconds()}\r\n`;
+    logDate = currentDate;
+    term.focus();
+    return false;
+  }
+  sessionLogEnable = true;
+  loggedData = true;
+  logBtn.innerHTML = '<i class="fas fa-cog fa-spin fa-fw"></i> Stop Log';
+  downloadLogBtn.style.color = '#000';
+  downloadLogBtn.addEventListener('click', downloadLog);
+  currentDate = new Date();
+  sessionLog = `Log Start for ${sessionFooter}: ${currentDate.getFullYear()}/${
+    currentDate.getMonth() + 1
+  }/${currentDate.getDate()} @ ${currentDate.getHours()}:${currentDate.getMinutes()}:${currentDate.getSeconds()}\r\n\r\n`;
+  logDate = currentDate;
+  term.focus();
+  return false;
+}
+
+// replay password to server, requires
+function replayCredentials () { // eslint-disable-line
+  socket.emit('control', 'replayCredentials');
+  debug(`control: replayCredentials`);
+  term.focus();
+  return false;
+}
+
+// draw/re-draw menu and reattach listeners
+// when dom is changed, listeners are abandonded
+function drawMenu() {
+  logBtn.addEventListener('click', toggleLog);
+  if (allowreauth) {
+    reauthBtn.addEventListener('click', reauthSession);
+    reauthBtn.style.display = 'block';
+  }
+  if (allowreplay) {
+    credentialsBtn.addEventListener('click', replayCredentials);
+    credentialsBtn.style.display = 'block';
+  }
+  if (loggedData) {
+    downloadLogBtn.addEventListener('click', downloadLog);
+    downloadLogBtn.style.display = 'block';
+  }
+}
+
+function resizeScreen() {
+  fitAddon.fit();
+  socket.emit('resize', { cols: term.cols, rows: term.rows });
+  debug(`resize: ${JSON.stringify({ cols: term.cols, rows: term.rows })}`);
+}
+
+window.addEventListener('resize', resizeScreen, false);
+
+term.onData((data) => {
+  socket.emit('data', data);
+});
+
+socket.on('data', (data: string | Uint8Array) => {
+  term.write(data);
+  if (sessionLogEnable) {
+    sessionLog += data;
+  }
+});
+
+socket.on('connect', () => {
+  socket.emit('geometry', term.cols, term.rows);
+  debug(`geometry: ${term.cols}, ${term.rows}`);
+});
+
+socket.on(
+  'setTerminalOpts',
+  (data: {
+    cursorBlink: boolean;
+    scrollback: number;
+    tabStopWidth: number;
+    bellStyle: 'none' | 'sound';
+    fontSize: number;
+    fontFamily: string;
+    letterSpacing: number;
+    lineHeight: number;
+  }) => {
+    term.options = data;
+  }
+);
+
+socket.on('title', (data: string) => {
+  document.title = data;
+});
+
+socket.on('menu', () => {
+  drawMenu();
+});
+
+socket.on('status', (data: string) => {
+  status.innerHTML = data;
+});
+
+socket.on('ssherror', (data: string) => {
+  status.innerHTML = data;
+  status.style.backgroundColor = 'red';
+  errorExists = true;
+});
+
+socket.on('headerBackground', (data: string) => {
+  header.style.backgroundColor = data;
+});
+
+socket.on('header', (data: string) => {
+  if (data) {
+    header.innerHTML = data;
+    header.style.display = 'block';
+    // header is 19px and footer is 19px, recaculate new terminal-container and resize
+    terminalContainer.style.height = 'calc(100% - 38px)';
+    resizeScreen();
+  }
+});
+
+socket.on('footer', (data: string) => {
+  sessionFooter = data;
+  footer.innerHTML = data;
+});
+
+socket.on('statusBackground', (data: string) => {
+  status.style.backgroundColor = data;
+});
+
+socket.on('allowreplay', (data: boolean) => {
+  if (data === true) {
+    debug(`allowreplay: ${data}`);
+    allowreplay = true;
+    drawMenu();
+  } else {
+    allowreplay = false;
+    debug(`allowreplay: ${data}`);
+  }
+});
+
+socket.on('allowreauth', (data: boolean) => {
+  if (data === true) {
+    debug(`allowreauth: ${data}`);
+    allowreauth = true;
+    drawMenu();
+  } else {
+    allowreauth = false;
+    debug(`allowreauth: ${data}`);
+  }
+});
+
+socket.on('disconnect', (err: any) => {
+  if (!errorExists) {
+    status.style.backgroundColor = 'red';
+    status.innerHTML = `WEBSOCKET SERVER DISCONNECTED: ${err}`;
+  }
+  socket.io.reconnection(false);
+  countdown.classList.remove('active');
+});
+
+socket.on('error', (err: any) => {
+  if (!errorExists) {
+    status.style.backgroundColor = 'red';
+    status.innerHTML = `ERROR: ${err}`;
+  }
+});
+
+socket.on('reauth', () => {
+  if (allowreauth) {
+    reauthSession();
+  }
+});
+
+// safe shutdown
+let hasCountdownStarted = false;
+
+socket.on('shutdownCountdownUpdate', (remainingSeconds: any) => {
+  if (!hasCountdownStarted) {
+    countdown.classList.add('active');
+    hasCountdownStarted = true;
+  }
+  countdown.innerText = `Shutting down in ${remainingSeconds}s`;
+});
+
+term.onTitleChange((title) => {
+  document.title = title;
+});

app/client/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "compilerOptions": {
+    "outDir": "./built",
+    "allowJs": true,
+    "target": "es6",
+    "moduleResolution": "node"
+  },
+  "include": ["./src/**/*"],
+}

app/config.json.sample

@@ -0,0 +1,83 @@
+{
+  "listen": {
+    "ip": "0.0.0.0",
+    "port": 2224
+  },
+  "socketio": {
+    "serveClient": false,
+    "path": "/ssh/socket.io",
+    "origins": ["localhost:2222"],
+  },
+  "user": {
+    "name": null,
+    "password": null,
+    "privatekey": null,
+    "overridebasic": false
+  },
+  "ssh": {
+    "host": null,
+    "port": 22,
+    "localAddress": null,
+    "localPort": null,
+    "term": "xterm-color",
+    "readyTimeout": 20000,
+    "keepaliveInterval": 120000,
+    "keepaliveCountMax": 10,
+    "allowedSubnets": []
+  },
+  "terminal": {
+    "cursorBlink": true,
+    "scrollback": 10000,
+    "tabStopWidth": 8,
+    "bellStyle": "sound",
+    "fontSize": 14
+  },
+  "header": {
+    "text": null,
+    "background": "green"
+  },
+  "session": {
+    "name": "WebSSH2",
+    "secret": "mysecret"
+  },
+  "options": {
+    "challengeButton": true,
+    "allowreauth": false
+  },
+  "algorithms": {
+    "kex": [
+      "ecdh-sha2-nistp256",
+      "ecdh-sha2-nistp384",
+      "ecdh-sha2-nistp521",
+      "diffie-hellman-group-exchange-sha256",
+      "diffie-hellman-group14-sha1"
+    ],
+    "cipher": [
+      "aes128-ctr",
+      "aes192-ctr",
+      "aes256-ctr",
+      "aes128-gcm",
+      "aes128-gcm@openssh.com",
+      "aes256-gcm",
+      "aes256-gcm@openssh.com",
+      "aes256-cbc"
+    ],
+    "hmac": [
+      "hmac-sha2-256",
+      "hmac-sha2-512",
+      "hmac-sha1"
+    ],
+    "compress": [
+      "none",
+      "zlib@openssh.com",
+      "zlib"
+    ]
+  },
+  "serverlog": {
+    "client": false,
+    "server": false
+  },
+  "accesslog": false,
+  "verify": false,
+  "safeShutdownDuration": 300
+}

app/index.js

@@ -0,0 +1,32 @@
+/* eslint no-console: ["error", { allow: ["warn", "error"] }] */
+/* jshint esversion: 6, asi: true, node: true */
+/*
+ * index.js
+ *
+ * WebSSH2 - Web to SSH2 gateway
+ * Bill Church - https://github.com/billchurch/WebSSH2 - May 2017
+ * See LICENSE file
+ *
+ * test change
+ */
+
+const { config } = require('./server/app');
+const { server } = require('./server/app');
+
+server.listen({ host: config.listen.ip, port: config.listen.port });
+
+// eslint-disable-next-line no-console
+console.log(`WebSSH2 service listening on ${config.listen.ip}:${config.listen.port}`);
+
+server.on('error', (err) => {
+  if (err.code === 'EADDRINUSE') {
+    config.listen.port += 1;
+    console.warn(`WebSSH2 Address in use, retrying on port ${config.listen.port}`);
+    setTimeout(() => {
+      server.listen(config.listen.port);
+    }, 250);
+  } else {
+    // eslint-disable-next-line no-console
+    console.log(`WebSSH2 server.listen ERROR: ${err.code}`);
+  }
+});

app/jsconfig.json

@@ -0,0 +1,17 @@
+{
+  "compilerOptions": {
+    "module": "ESNext",
+    "moduleResolution": "Node",
+    "target": "ES2020",
+    "jsx": "preserve",
+    "strictFunctionTypes": true
+  },
+  "exclude": [
+    "node_modules",
+    "**/node_modules/*"
+  ],
+  "include": [
+    "server/*.js",
+    "index.js"
+  ]
+}

app/package.json

@@ -0,0 +1,89 @@
+{
+  "name": "webssh2",
+  "version": "0.6.0-pre-1",
+  "ignore": [
+    ".gitignore"
+  ],
+  "bin": "./index.js",
+  "description": "A Websocket to SSH2 gateway using term.js, socket.io, ssh2, and express",
+  "homepage": "https://github.com/billchurch/WebSSH2",
+  "keywords": [
+    "ssh",
+    "webssh",
+    "terminal",
+    "webterminal"
+  ],
+  "license": "SEE LICENSE IN FILE - LICENSE",
+  "private": false,
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/billchurch/WebSSH2.git"
+  },
+  "contributors": [
+    {
+      "name": "Bill Church",
+      "email": "wmchurch@gmail.com"
+    }
+  ],
+  "engines": {
+    "node": ">= 14"
+  },
+  "bugs": {
+    "url": "https://github.com/billchurch/WebSSH2/issues"
+  },
+  "dependencies": {
+    "basic-auth": "~2.0.1",
+    "cidr-matcher": "^2.1.1",
+    "debug": "^4.3.4",
+    "express": "^4.19.2",
+    "express-session": "^1.18.0",
+    "morgan": "~1.10.0",
+    "read-config-ng": "^3.0.7",
+    "serve-favicon": "^2.5.0",
+    "socket.io": "^4.7.5",
+    "ssh2": "^1.15.0",
+    "validator": "^13.11.0",
+    "winston": "^3.13.0"
+  },
+  "scripts": {
+    "start": "node index.js",
+    "build": "webpack --progress --config scripts/webpack.prod.js",
+    "builddev": "webpack --progress --config scripts/webpack.dev.js",
+    "analyze": "webpack --json --config scripts/webpack.prod.js | webpack-bundle-size-analyzer",
+    "test": "snyk test",
+    "watch": "nodemon index.js",
+    "cleanmac": "find . -name '.DS_Store' -type f -delete",
+    "release": "standard-version"
+  },
+  "devDependencies": {
+    "@fortawesome/fontawesome-svg-core": "^6.5.2",
+    "@fortawesome/free-solid-svg-icons": "^6.5.2",
+    "@typescript-eslint/eslint-plugin": "^7.7.1",
+    "@typescript-eslint/parser": "^7.7.1",
+    "@xterm/addon-fit": "^0.10.0",
+    "@xterm/xterm": "^5.5.0",
+    "clean-webpack-plugin": "^4.0.0",
+    "copy-webpack-plugin": "^12.0.2",
+    "css-loader": "^7.1.1",
+    "eslint": "^8.56.0",
+    "eslint-config-airbnb-base": "^15.0.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-import": "^2.29.1",
+    "eslint-plugin-prettier": "^5.1.3",
+    "mini-css-extract-plugin": "^2.9.0",
+    "nodaemon": "0.0.5",
+    "npm-check-updates": "^16.14.20",
+    "prettier": "^3.2.5",
+    "snazzy": "^9.0.0",
+    "snyk": "^1.1290.0",
+    "socket.io-client": "^4.7.5",
+    "source-map-loader": "^5.0.0",
+    "standard-version": "^9.5.0",
+    "terser-webpack-plugin": "^5.3.10",
+    "ts-loader": "^9.5.1",
+    "typescript": "^5.4.5",
+    "webpack": "^5.91.0",
+    "webpack-cli": "^5.1.4",
+    "webpack-merge": "^5.10.0"
+  }
+}

app/scripts/webpack.common.js

@@ -0,0 +1,45 @@
+/* eslint-disable import/no-extraneous-dependencies */
+const path = require('path');
+const { CleanWebpackPlugin } = require('clean-webpack-plugin');
+const CopyWebpackPlugin = require('copy-webpack-plugin');
+const MiniCssExtractPlugin = require('mini-css-extract-plugin');
+
+module.exports = {
+  context: path.resolve('__dirname', '../'),
+  resolve: {
+    // Add '.ts' and '.tsx' as resolvable extensions.
+    extensions: ['', '.webpack.js', '.web.js', '.ts', '.tsx', '.js'],
+  },
+  entry: {
+    webssh2: './client/src/js/index.ts',
+  },
+  plugins: [
+    new CleanWebpackPlugin(),
+    new CopyWebpackPlugin({
+      patterns: ['./client/src/client.htm', './client/src/favicon.ico'],
+    }),
+    new MiniCssExtractPlugin(),
+  ],
+  output: {
+    filename: '[name].bundle.js',
+    path: path.resolve(__dirname, '../client/public'),
+  },
+  module: {
+    rules: [
+      {
+        test: /\.css$/,
+        use: [MiniCssExtractPlugin.loader, 'css-loader'],
+      },
+      // All files with a '.ts' or '.tsx' extension will be handled by 'ts-loader'.
+      {
+        test: /\.tsx?$/,
+        loader: 'ts-loader',
+      },
+      // All output '.js' files will have any sourcemaps re-processed by 'source-map-loader'.
+      {
+        test: /\.js$/,
+        loader: 'source-map-loader',
+      },
+    ],
+  },
+};

app/scripts/webpack.dev.js

@@ -0,0 +1,10 @@
+/* eslint-disable import/no-extraneous-dependencies */
+const merge = require('webpack-merge');
+const common = require('./webpack.common.js');
+
+module.exports = merge(common, {
+  devtool: 'inline-source-map',
+  devServer: {
+    contentBase: '../client/public',
+  },
+});

app/scripts/webpack.prod.js

@@ -0,0 +1,19 @@
+/* eslint-disable import/no-extraneous-dependencies */
+const TerserPlugin = require('terser-webpack-plugin');
+const { merge } = require('webpack-merge');
+const common = require('./webpack.common.js');
+
+module.exports = merge(common, {
+  mode: 'production',
+  optimization: {
+    minimize: true,
+    minimizer: [
+      new TerserPlugin({
+        terserOptions: {
+          ie8: false,
+          safari10: false,
+        },
+      }),
+    ],
+  },
+});

app/server/app.js

@@ -0,0 +1,111 @@
+/* jshint esversion: 6, asi: true, node: true */
+/* eslint no-unused-expressions: ["error", { "allowShortCircuit": true, "allowTernary": true }],
+   no-console: ["error", { allow: ["warn", "error", "info"] }] */
+// app.js
+
+// eslint-disable-next-line import/order
+const config = require('./config');
+const path = require('path');
+
+const nodeRoot = path.dirname(require.main.filename);
+const publicPath = path.join(nodeRoot, 'client', 'public');
+const express = require('express');
+const logger = require('morgan');
+
+const app = express();
+const server = require('http').createServer(app);
+const favicon = require('serve-favicon');
+const io = require('socket.io')(server, config.socketio);
+const session = require('express-session')(config.express);
+
+const appSocket = require('./socket');
+const { setDefaultCredentials, basicAuth } = require('./util');
+const { webssh2debug } = require('./logging');
+const { reauth, connect, notfound, handleErrors } = require('./routes');
+
+setDefaultCredentials(config.user);
+
+// safe shutdown
+let remainingSeconds = config.safeShutdownDuration;
+let shutdownMode = false;
+let shutdownInterval;
+let connectionCount = 0;
+// eslint-disable-next-line consistent-return
+function safeShutdownGuard(req, res, next) {
+  if (!shutdownMode) return next();
+  res.status(503).end('Service unavailable: Server shutting down');
+}
+// express
+app.use(safeShutdownGuard);
+app.use(session);
+if (config.accesslog) app.use(logger('common'));
+app.disable('x-powered-by');
+app.use(favicon(path.join(publicPath, 'favicon.ico')));
+app.use(express.urlencoded({ extended: true }));
+app.post('/ssh/host/:host?', connect);
+app.post('/ssh', express.static(publicPath, config.express.ssh));
+app.use('/ssh', express.static(publicPath, config.express.ssh));
+app.use(basicAuth);
+app.get('/ssh/reauth', reauth);
+app.get('/ssh/host/:host?', connect);
+app.use(notfound);
+app.use(handleErrors);
+
+// clean stop
+function stopApp(reason) {
+  shutdownMode = false;
+  if (reason) console.info(`Stopping: ${reason}`);
+  clearInterval(shutdownInterval);
+  io.close();
+  server.close();
+}
+
+// bring up socket
+io.on('connection', appSocket);
+
+// socket.io
+// expose express session with socket.request.session
+io.use((socket, next) => {
+  socket.request.res ? session(socket.request, socket.request.res, next) : next(next); // eslint disable-line
+});
+
+function countdownTimer() {
+  if (!shutdownMode) clearInterval(shutdownInterval);
+  remainingSeconds -= 1;
+  if (remainingSeconds <= 0) {
+    stopApp('Countdown is over');
+  } else io.emit('shutdownCountdownUpdate', remainingSeconds);
+}
+
+const signals = ['SIGTERM', 'SIGINT'];
+signals.forEach((signal) =>
+  process.on(signal, () => {
+    if (shutdownMode) stopApp('Safe shutdown aborted, force quitting');
+    if (!connectionCount > 0) stopApp('All connections ended');
+    shutdownMode = true;
+    console.error(
+      `\r\n${connectionCount} client(s) are still connected.\r\nStarting a ${remainingSeconds} seconds countdown.\r\nPress Ctrl+C again to force quit`
+    );
+    if (!shutdownInterval) shutdownInterval = setInterval(countdownTimer, 1000);
+  })
+);
+
+module.exports = { server, config };
+
+const onConnection = (socket) => {
+  connectionCount += 1;
+  socket.on('disconnect', () => {
+    connectionCount -= 1;
+    if (connectionCount <= 0 && shutdownMode) {
+      stopApp('All clients disconnected');
+    }
+  });
+  socket.on('geometry', (cols, rows) => {
+    // TODO need to rework how we pass settings to ssh2, this is less than ideal
+    socket.request.session.ssh.cols = cols;
+    socket.request.session.ssh.rows = rows;
+    webssh2debug(socket, `SOCKET GEOMETRY: termCols = ${cols}, termRows = ${rows}`);
+  });
+};
+
+io.on('connection', onConnection);

app/server/config.js

@@ -0,0 +1,136 @@
+/* eslint no-unused-expressions: ["error", { "allowShortCircuit": true, "allowTernary": true }],
+   no-console: ["error", { allow: ["warn", "error", "info"] }] */
+const fs = require('fs');
+const path = require('path');
+const debugWebSSH2 = require('debug')('WebSSH2');
+const crypto = require('crypto');
+const util = require('util');
+const readconfig = require('read-config-ng');
+
+const nodeRoot = path.dirname(require.main.filename);
+const configPath = path.join(nodeRoot, 'config.json');
+
+let myConfig;
+// establish defaults
+const configDefault = {
+  listen: {
+    ip: '0.0.0.0',
+    port: 2222,
+  },
+  socketio: {
+    serveClient: false,
+    path: '/ssh/socket.io',
+    origins: ['localhost:2222'],
+  },
+  express: {
+    secret: crypto.randomBytes(20).toString('hex'),
+    name: 'WebSSH2',
+    resave: true,
+    saveUninitialized: false,
+    unset: 'destroy',
+    ssh: {
+      dotfiles: 'ignore',
+      etag: false,
+      extensions: ['htm', 'html'],
+      index: false,
+      maxAge: '1s',
+      redirect: false,
+      setHeaders(res) {
+        res.set('x-timestamp', Date.now());
+      },
+    },
+  },
+  user: {
+    name: null,
+    password: null,
+    privatekey: null,
+    overridebasic: false,
+  },
+  ssh: {
+    host: null,
+    port: 22,
+    term: 'xterm-color',
+    readyTimeout: 20000,
+    keepaliveInterval: 120000,
+    keepaliveCountMax: 10,
+    allowedSubnets: [],
+  },
+  terminal: {
+    cursorBlink: true,
+    scrollback: 10000,
+    tabStopWidth: 8,
+    bellStyle: 'sound',
+  },
+  header: {
+    text: null,
+    background: 'green',
+  },
+  options: {
+    challengeButton: true,
+    allowreauth: true,
+  },
+  algorithms: {
+    kex: [
+      'ecdh-sha2-nistp256',
+      'ecdh-sha2-nistp384',
+      'ecdh-sha2-nistp521',
+      'diffie-hellman-group-exchange-sha256',
+      'diffie-hellman-group14-sha1',
+    ],
+    cipher: [
+      'aes128-ctr',
+      'aes192-ctr',
+      'aes256-ctr',
+      'aes128-gcm',
+      'aes128-gcm@openssh.com',
+      'aes256-gcm',
+      'aes256-gcm@openssh.com',
+      'aes256-cbc',
+    ],
+    hmac: ['hmac-sha2-256', 'hmac-sha2-512', 'hmac-sha1'],
+    compress: ['none', 'zlib@openssh.com', 'zlib'],
+  },
+  serverlog: {
+    client: false,
+    server: false,
+  },
+  accesslog: false,
+  verify: false,
+  safeShutdownDuration: 300,
+};
+
+// test if config.json exists, if not provide error message but try to run anyway
+try {
+  if (!fs.existsSync(configPath)) {
+    console.error(
+      `\n\nERROR: Missing config.json for WebSSH2. Current config: ${util.inspect(myConfig)}`
+    );
+    console.error('\n  See config.json.sample for details\n\n');
+  }
+  console.info(`WebSSH2 service reading config from: ${configPath}`);
+  const configFile = readconfig(configPath, { override: true });
+  // myConfig = merger.mergeObjects([configDefault, configFile]);
+  myConfig = { ...configDefault, ...configFile };
+  debugWebSSH2(`\nCurrent config: ${util.inspect(myConfig)}`);
+} catch (err) {
+  myConfig = configDefault;
+  console.error(
+    `\n\nERROR: Missing config.json for WebSSH2. Current config: ${util.inspect(myConfig)}`
+  );
+  console.error('\n  See config.json.sample for details\n\n');
+  console.error(`ERROR:\n\n  ${err}`);
+}
+const config = myConfig;
+
+if (process.env.LISTEN) config.listen.ip = process.env.LISTEN;
+
+if (process.env.PORT) config.listen.port = process.env.PORT;
+
+if (process.env.SOCKETIO_ORIGINS) config.socketio.origins = process.env.SOCKETIO_ORIGINS;
+
+if (process.env.SOCKETIO_PATH) config.socketio.path = process.env.SOCKETIO_PATH;
+
+if (process.env.SOCKETIO_SERVECLIENT)
+  config.socketio.serveClient = process.env.SOCKETIO_SERVECLIENT;
+
+module.exports = config;

app/server/form.html

@@ -0,0 +1,36 @@
+<head><title>Post Test</title></head>
+<html>
+<body>
+    <h1>Credentials over HTTP POST test</h1>
+    <p>This is a test to demonstrate sending credentials over POST instead of requiring HTTP Basic. If you use this, be sure to secure the app/site with HTTPS!</p>
+    <form method="POST" action="http://localhost:2222/ssh/host/192.168.0.1">
+        <p>
+            <label for="username">Username</label>
+            <input name="username">
+        </p>
+            <label for="userpassword">Password</label>
+            <input name="userpassword" type="password">
+        </p>
+        <p> 
+            <label for="header">Header text</label>
+            <input name="header" value="This is a test">
+        <p>
+            <label for="headerBackground">Header Background Color</label>
+            <input name="headerBackground" value="red">
+        </p>
+        <fieldset>
+            <legend>Cursor Blink:</legend>
+            <div>
+              <input type="radio" id="false" name="cursorBlink" value="false"
+                     checked>
+              <label for="false">False</label>
+            </div>
+            <div>
+              <input type="radio" id="true" name="cursorBlink" value="true">
+              <label for="true">True</label>
+            </div>
+        </fieldset>
+        <button>Login</button>
+    </form>
+</body>
+</html>

app/server/logging.js

@@ -0,0 +1,47 @@
+/* eslint no-unused-expressions: ["error", { "allowShortCircuit": true, "allowTernary": true }],
+   no-console: ["error", { allow: ["warn", "error", "info"] }] */
+/* jshint esversion: 6, asi: true, node: true */
+// logging.js
+// private
+
+const debug = require('debug');
+const util = require('util');
+
+/**
+ * generate consistent prefix for log messages
+ * with epress session id and socket session id
+ * @param {object} socket Socket information
+ */
+function prefix(socket) {
+  return `(${socket.request.sessionID}/${socket.id})`;
+}
+
+// public
+function webssh2debug(socket, msg) {
+  debug('WebSSH2')(`${prefix(socket)} ${msg}`);
+}
+
+/**
+ * audit log to console
+ * @param {object} socket Socket information
+ * @param {object} msg    log message
+ */
+function auditLog(socket, msg) {
+  console.info(`WebSSH2 ${prefix(socket)} AUDIT: ${msg}`);
+}
+
+/**
+ * logs error to socket client (if connected)
+ * and console.
+ * @param {object} socket Socket information
+ * @param {string} myFunc Function calling this function
+ * @param {object} err    error object or error message
+ */
+function logError(socket, myFunc, err) {
+  console.error(`WebSSH2 ${prefix(socket)} ERROR: ${myFunc}: ${err}`);
+  webssh2debug(socket, `logError: ${myFunc}: ${util.inspect(err)}`);
+  if (!socket.request.session) return;
+  socket.emit('ssherror', `SSH ${myFunc}: ${err}`);
+}
+
+module.exports = { logError, auditLog, webssh2debug };

app/server/routes.js

@@ -0,0 +1,203 @@
+/* eslint-disable no-console */
+// ssh.js
+const validator = require('validator');
+const path = require('path');
+
+const nodeRoot = path.dirname(require.main.filename);
+
+const publicPath = path.join(nodeRoot, 'client', 'public');
+const { parseBool } = require('./util');
+const config = require('./config');
+
+exports.reauth = function reauth(req, res) {
+  let { referer } = req.headers;
+  if (!validator.isURL(referer, { host_whitelist: ['localhost'] })) {
+    console.error(
+      `WebSSH2 (${req.sessionID}) ERROR: Referrer '${referer}' for '/reauth' invalid. Setting to '/' which will probably fail.`
+    );
+    referer = '/';
+  }
+  res
+    .status(401)
+    .send(
+      `<!DOCTYPE html><html><head><meta http-equiv="refresh" content="0; url=${referer}"></head><body bgcolor="#000"></body></html>`
+    );
+};
+
+exports.connect = function connect(req, res) {
+  res.sendFile(path.join(path.join(publicPath, 'client.htm')));
+
+  let { host, port } = config.ssh;
+  let { text: header, background: headerBackground } = config.header;
+  let { term: sshterm, readyTimeout } = config.ssh;
+  let {
+    cursorBlink,
+    scrollback,
+    tabStopWidth,
+    bellStyle,
+    fontSize,
+    fontFamily,
+    letterSpacing,
+    lineHeight,
+  } = config.terminal;
+
+  // capture, assign, and validate variables
+
+  if (req.params?.host) {
+    if (
+      validator.isIP(`${req.params.host}`) ||
+      validator.isFQDN(req.params.host) ||
+      /^(([a-z]|[A-Z]|\d|[!^(){}\-_~])+)?\w$/.test(req.params.host)
+    ) {
+      host = req.params.host;
+    }
+  }
+
+  if (req.method === 'POST' && req.body.username && req.body.userpassword) {
+    req.session.username = req.body.username;
+    req.session.userpassword = req.body.userpassword;
+
+    if (req.body.port && validator.isInt(`${req.body.port}`, { min: 1, max: 65535 }))
+      port = req.body.port;
+
+    if (req.body.header) header = req.body.header;
+
+    if (req.body.headerBackground) {
+      headerBackground = req.body.headerBackground;
+      console.log(`background: ${req.body.headerBackground}`);
+    }
+
+    if (req.body.sshterm && /^(([a-z]|[A-Z]|\d|[!^(){}\-_~])+)?\w$/.test(req.body.sshterm))
+      sshterm = req.body.sshterm;
+
+    if (req.body.cursorBlink && validator.isBoolean(`${req.body.cursorBlink}`))
+      cursorBlink = parseBool(req.body.cursorBlink);
+
+    if (req.body.scrollback && validator.isInt(`${req.body.scrollback}`, { min: 1, max: 200000 }))
+      scrollback = req.body.scrollback;
+
+    if (req.body.tabStopWidth && validator.isInt(`${req.body.tabStopWidth}`, { min: 1, max: 100 }))
+      tabStopWidth = req.body.tabStopWidth;
+
+    if (req.body.bellStyle && ['sound', 'none'].indexOf(req.body.bellStyle) > -1)
+      bellStyle = req.body.bellStyle;
+
+    if (
+      req.body.readyTimeout &&
+      validator.isInt(`${req.body.readyTimeout}`, { min: 1, max: 300000 })
+    )
+      readyTimeout = req.body.readyTimeout;
+
+    if (req.body.fontSize && validator.isNumeric(`${req.body.fontSize}`))
+      fontSize = req.body.fontSize;
+
+    if (req.body.fontFamily) fontFamily = req.body.fontFamily;
+
+    if (req.body.letterSpacing && validator.isNumeric(`${req.body.letterSpacing}`))
+      letterSpacing = req.body.letterSpacing;
+
+    if (req.body.lineHeight && validator.isNumeric(`${req.body.lineHeight}`))
+      lineHeight = req.body.lineHeight;
+  }
+
+  if (req.method === 'GET') {
+    if (req.query?.port && validator.isInt(`${req.query.port}`, { min: 1, max: 65535 }))
+      port = req.query.port;
+
+    if (req.query?.header) header = req.query.header;
+
+    if (req.query?.headerBackground) headerBackground = req.query.headerBackground;
+
+    if (req.query?.sshterm && /^(([a-z]|[A-Z]|\d|[!^(){}\-_~])+)?\w$/.test(req.query.sshterm))
+      sshterm = req.query.sshterm;
+
+    if (req.query?.cursorBlink && validator.isBoolean(`${req.query.cursorBlink}`))
+      cursorBlink = parseBool(req.query.cursorBlink);
+
+    if (
+      req.query?.scrollback &&
+      validator.isInt(`${req.query.scrollback}`, { min: 1, max: 200000 })
+    )
+      scrollback = req.query.scrollback;
+
+    if (
+      req.query?.tabStopWidth &&
+      validator.isInt(`${req.query.tabStopWidth}`, { min: 1, max: 100 })
+    )
+      tabStopWidth = req.query.tabStopWidth;
+
+    if (req.query?.bellStyle && ['sound', 'none'].indexOf(req.query.bellStyle) > -1)
+      bellStyle = req.query.bellStyle;
+
+    if (
+      req.query?.readyTimeout &&
+      validator.isInt(`${req.query.readyTimeout}`, { min: 1, max: 300000 })
+    )
+      readyTimeout = req.query.readyTimeout;
+
+    if (req.query?.fontSize && validator.isNumeric(`${req.query.fontSize}`))
+      fontSize = req.query.fontSize;
+
+    if (req.query?.fontFamily) fontFamily = req.query.fontFamily;
+
+    if (req.query?.lineHeight && validator.isNumeric(`${req.query.lineHeight}`))
+      lineHeight = req.query.lineHeight;
+
+    if (req.query?.letterSpacing && validator.isNumeric(`${req.query.letterSpacing}`))
+      letterSpacing = req.query.letterSpacing;
+  }
+
+  req.session.ssh = {
+    host,
+    port,
+    localAddress: config.ssh.localAddress,
+    localPort: config.ssh.localPort,
+    header: {
+      name: header,
+      background: headerBackground,
+    },
+    algorithms: config.algorithms,
+    keepaliveInterval: config.ssh.keepaliveInterval,
+    keepaliveCountMax: config.ssh.keepaliveCountMax,
+    allowedSubnets: config.ssh.allowedSubnets,
+    term: sshterm,
+    terminal: {
+      cursorBlink,
+      scrollback,
+      tabStopWidth,
+      bellStyle,
+      fontSize,
+      fontFamily,
+      letterSpacing,
+      lineHeight,
+    },
+    cols: null,
+    rows: null,
+    allowreplay:
+      config.options.challengeButton ||
+      (validator.isBoolean(`${req.headers.allowreplay}`)
+        ? parseBool(req.headers.allowreplay)
+        : false),
+    allowreauth: config.options.allowreauth || false,
+    mrhsession:
+      validator.isAlphanumeric(`${req.headers.mrhsession}`) && req.headers.mrhsession
+        ? req.headers.mrhsession
+        : 'none',
+    serverlog: {
+      client: config.serverlog.client || false,
+      server: config.serverlog.server || false,
+    },
+    readyTimeout,
+  };
+  if (req.session.ssh.header.name) validator.escape(req.session.ssh.header.name);
+  if (req.session.ssh.header.background) validator.escape(req.session.ssh.header.background);
+};
+
+exports.notfound = function notfound(_req, res) {
+  res.status(404).send("Sorry, can't find that!");
+};
+
+exports.handleErrors = function handleErrors(err, _req, res) {
+  console.error(err.stack);
+  res.status(500).send('Something broke!');
+};

app/server/socket.js

@@ -0,0 +1,241 @@
+/* eslint-disable complexity */
+/* eslint no-unused-expressions: ["error", { "allowShortCircuit": true, "allowTernary": true }],
+   no-console: ["error", { allow: ["warn", "error"] }] */
+/* jshint esversion: 6, asi: true, node: true */
+// socket.js
+
+// private
+const debug = require('debug');
+const SSH = require('ssh2').Client;
+const CIDRMatcher = require('cidr-matcher');
+const validator = require('validator');
+const dnsPromises = require('dns').promises;
+const util = require('util');
+const { webssh2debug, auditLog, logError } = require('./logging');
+
+/**
+ * parse conn errors
+ * @param {object} socket Socket object
+ * @param {object} err    Error object
+ */
+function connError(socket, err) {
+  let msg = util.inspect(err);
+  const { session } = socket.request;
+  if (err?.level === 'client-authentication') {
+    msg = `Authentication failure user=${session.username} from=${socket.handshake.address}`;
+    socket.emit('allowreauth', session.ssh.allowreauth);
+    socket.emit('reauth');
+  }
+  if (err?.code === 'ENOTFOUND') {
+    msg = `Host not found: ${err.hostname}`;
+  }
+  if (err?.level === 'client-timeout') {
+    msg = `Connection Timeout: ${session.ssh.host}`;
+  }
+  logError(socket, 'CONN ERROR', msg);
+}
+
+/**
+ * check ssh host is in allowed subnet
+ * @param {object} socket Socket information
+ */
+async function checkSubnet(socket) {
+  let ipaddress = socket.request.session.ssh.host;
+  if (!validator.isIP(`${ipaddress}`)) {
+    try {
+      const result = await dnsPromises.lookup(socket.request.session.ssh.host);
+      ipaddress = result.address;
+    } catch (err) {
+      logError(
+        socket,
+        'CHECK SUBNET',
+        `${err.code}: ${err.hostname} user=${socket.request.session.username} from=${socket.handshake.address}`
+      );
+      socket.emit('ssherror', '404 HOST IP NOT FOUND');
+      socket.disconnect(true);
+      return;
+    }
+  }
+
+  const matcher = new CIDRMatcher(socket.request.session.ssh.allowedSubnets);
+  if (!matcher.contains(ipaddress)) {
+    logError(
+      socket,
+      'CHECK SUBNET',
+      `Requested host ${ipaddress} outside configured subnets / REJECTED user=${socket.request.session.username} from=${socket.handshake.address}`
+    );
+    socket.emit('ssherror', '401 UNAUTHORIZED');
+    socket.disconnect(true);
+  }
+}
+
+// public
+module.exports = function appSocket(socket) {
+  let login = false;
+
+  socket.once('disconnecting', (reason) => {
+    webssh2debug(socket, `SOCKET DISCONNECTING: ${reason}`);
+    if (login === true) {
+      auditLog(
+        socket,
+        `LOGOUT user=${socket.request.session.username} from=${socket.handshake.address} host=${socket.request.session.ssh.host}:${socket.request.session.ssh.port}`
+      );
+      login = false;
+    }
+  });
+
+  async function setupConnection() {
+    // if websocket connection arrives without an express session, kill it
+    if (!socket.request.session) {
+      socket.emit('401 UNAUTHORIZED');
+      webssh2debug(socket, 'SOCKET: No Express Session / REJECTED');
+      socket.disconnect(true);
+      return;
+    }
+
+    // If configured, check that requsted host is in a permitted subnet
+    if (socket.request.session?.ssh?.allowedSubnets?.length > 0) {
+      checkSubnet(socket);
+    }
+
+    const conn = new SSH();
+
+    conn.on('banner', (data) => {
+      // need to convert to cr/lf for proper formatting
+      socket.emit('data', data.replace(/\r?\n/g, '\r\n').toString('utf-8'));
+    });
+
+    conn.on('handshake', () => {
+      socket.emit('setTerminalOpts', socket.request.session.ssh.terminal);
+      socket.emit('menu');
+      socket.emit('allowreauth', socket.request.session.ssh.allowreauth);
+      socket.emit('title', `ssh://${socket.request.session.ssh.host}`);
+      if (socket.request.session.ssh.header.background)
+        socket.emit('headerBackground', socket.request.session.ssh.header.background);
+      if (socket.request.session.ssh.header.name)
+        socket.emit('header', socket.request.session.ssh.header.name);
+      socket.emit(
+        'footer',
+        `ssh://${socket.request.session.username}@${socket.request.session.ssh.host}:${socket.request.session.ssh.port}`
+      );
+    });
+
+    conn.on('ready', () => {
+      webssh2debug(
+        socket,
+        `CONN READY: LOGIN: user=${socket.request.session.username} from=${socket.handshake.address} host=${socket.request.session.ssh.host} port=${socket.request.session.ssh.port} allowreplay=${socket.request.session.ssh.allowreplay} term=${socket.request.session.ssh.term}`
+      );
+      auditLog(
+        socket,
+        `LOGIN user=${socket.request.session.username} from=${socket.handshake.address} host=${socket.request.session.ssh.host}:${socket.request.session.ssh.port}`
+      );
+      login = true;
+      socket.emit('status', 'SSH CONNECTION ESTABLISHED');
+      socket.emit('statusBackground', 'green');
+      socket.emit('allowreplay', socket.request.session.ssh.allowreplay);
+      const { term, cols, rows } = socket.request.session.ssh;
+      conn.shell({ term, cols, rows }, (err, stream) => {
+        if (err) {
+          logError(socket, `EXEC ERROR`, err);
+          conn.end();
+          socket.disconnect(true);
+          return;
+        }
+        socket.once('disconnect', (reason) => {
+          webssh2debug(socket, `CLIENT SOCKET DISCONNECT: ${util.inspect(reason)}`);
+          conn.end();
+          socket.request.session.destroy();
+        });
+        socket.on('error', (errMsg) => {
+          webssh2debug(socket, `SOCKET ERROR: ${errMsg}`);
+          logError(socket, 'SOCKET ERROR', errMsg);
+          conn.end();
+          socket.disconnect(true);
+        });
+        socket.on('control', (controlData) => {
+          if (controlData === 'replayCredentials' && socket.request.session.ssh.allowreplay) {
+            stream.write(`${socket.request.session.userpassword}\n`);
+          }
+          if (controlData === 'reauth' && socket.request.session.username && login === true) {
+            auditLog(
+              socket,
+              `LOGOUT user=${socket.request.session.username} from=${socket.handshake.address} host=${socket.request.session.ssh.host}:${socket.request.session.ssh.port}`
+            );
+            login = false;
+            conn.end();
+            socket.disconnect(true);
+          }
+          webssh2debug(socket, `SOCKET CONTROL: ${controlData}`);
+        });
+        socket.on('resize', (data) => {
+          stream.setWindow(data.rows, data.cols);
+          webssh2debug(socket, `SOCKET RESIZE: ${JSON.stringify([data.rows, data.cols])}`);
+        });
+        socket.on('data', (data) => {
+          stream.write(data);
+        });
+        stream.on('data', (data) => {
+          socket.emit('data', data.toString('utf-8'));
+        });
+        stream.on('close', (code, signal) => {
+          webssh2debug(socket, `STREAM CLOSE: ${util.inspect([code, signal])}`);
+          if (socket.request.session?.username && login === true) {
+            auditLog(
+              socket,
+              `LOGOUT user=${socket.request.session.username} from=${socket.handshake.address} host=${socket.request.session.ssh.host}:${socket.request.session.ssh.port}`
+            );
+            login = false;
+          }
+          if (code !== 0 && typeof code !== 'undefined')
+            logError(socket, 'STREAM CLOSE', util.inspect({ message: [code, signal] }));
+          socket.disconnect(true);
+          conn.end();
+        });
+        stream.stderr.on('data', (data) => {
+          console.error(`STDERR: ${data}`);
+        });
+      });
+    });
+
+    conn.on('end', (err) => {
+      if (err) logError(socket, 'CONN END BY HOST', err);
+      webssh2debug(socket, 'CONN END BY HOST');
+      socket.disconnect(true);
+    });
+    conn.on('close', (err) => {
+      if (err) logError(socket, 'CONN CLOSE', err);
+      webssh2debug(socket, 'CONN CLOSE');
+      socket.disconnect(true);
+    });
+    conn.on('error', (err) => connError(socket, err));
+
+    conn.on('keyboard-interactive', (_name, _instructions, _instructionsLang, _prompts, finish) => {
+      webssh2debug(socket, 'CONN keyboard-interactive');
+      finish([socket.request.session.userpassword]);
+    });
+    if (
+      socket.request.session.username &&
+      (socket.request.session.userpassword || socket.request.session.privatekey) &&
+      socket.request.session.ssh
+    ) {
+      // console.log('hostkeys: ' + hostkeys[0].[0])
+      const { ssh } = socket.request.session;
+      ssh.username = socket.request.session.username;
+      ssh.password = socket.request.session.userpassword;
+      ssh.tryKeyboard = true;
+      ssh.debug = debug('ssh2');
+      conn.connect(ssh);
+    } else {
+      webssh2debug(
+        socket,
+        `CONN CONNECT: Attempt to connect without session.username/password or session varialbles defined, potentially previously abandoned client session. disconnecting websocket client.\r\nHandshake information: \r\n  ${util.inspect(
+          socket.handshake
+        )}`
+      );
+      socket.emit('ssherror', 'WEBSOCKET ERROR - Refresh the browser and try again');
+      socket.request.session.destroy();
+      socket.disconnect(true);
+    }
+  }
+  setupConnection();
+};

app/server/util.js

@@ -0,0 +1,47 @@
+/* jshint esversion: 6, asi: true, node: true */
+// util.js
+
+// private
+const debug = require('debug')('WebSSH2');
+const Auth = require('basic-auth');
+
+let defaultCredentials = { username: null, password: null, privatekey: null };
+
+exports.setDefaultCredentials = function setDefaultCredentials({
+  name: username,
+  password,
+  privatekey,
+  overridebasic,
+}) {
+  defaultCredentials = { username, password, privatekey, overridebasic };
+};
+
+exports.basicAuth = function basicAuth(req, res, next) {
+  const myAuth = Auth(req);
+  // If Authorize: Basic header exists and the password isn't blank
+  // AND config.user.overridebasic is false, extract basic credentials
+  // from client]
+  const { username, password, privatekey, overridebasic } = defaultCredentials;
+  if (myAuth && myAuth.pass !== '' && !overridebasic) {
+    req.session.username = myAuth.name;
+    req.session.userpassword = myAuth.pass;
+    debug(`myAuth.name: ${myAuth.name} and password ${myAuth.pass ? 'exists' : 'is blank'}`);
+  } else {
+    req.session.username = username;
+    req.session.userpassword = password;
+    req.session.privatekey = privatekey;
+  }
+  if (!req.session.userpassword && !req.session.privatekey) {
+    res.statusCode = 401;
+    debug('basicAuth credential request (401)');
+    res.setHeader('WWW-Authenticate', 'Basic realm="WebSSH"');
+    res.end('Username and password required for web SSH service.');
+    return;
+  }
+  next();
+};
+
+// takes a string, makes it boolean (true if the string is true, false otherwise)
+exports.parseBool = function parseBool(str) {
+  return str.toLowerCase() === 'true';
+};

config.json

@@ -1,21 +0,0 @@
-{
-  "listen": {
-    "ip": "127.0.0.1",
-    "port": 2222
-  },
-  "user": {
-    "name": null,
-    "password": null
-  },
-  "ssh": {
-    "host": null,
-    "port": 22
-  },
-  "header": {
-    "text": "My Header",
-    "background": "green"
-  },
-  "options": {
-    "challengeButton": true
-  }
-}

index.js

@@ -1,117 +0,0 @@
-/*
- * WebSSH2 - Web to SSH2 gateway
- * Bill Church - https://github.com/billchurch - April 2016
- * 
- */ 
-
-var express = require('express');
-var app = express();
-var cookieParser = require('cookie-parser')
-var server = require('http').Server(app);
-var io = require('socket.io')(server);
-var path = require('path');
-
-var basicAuth = require('basic-auth');
-var ssh = require('ssh2');
-var readConfig = require('read-config'),
-    config = readConfig(__dirname + '/config.json');
-
-function logErrors(err, req, res, next) {
-  console.error(err.stack);
-  next(err);
-}
-
-server.listen({
-    host: config.listen.ip,
-    port: config.listen.port
-}).on('error', function (err) {
-    if (err.code === 'EADDRINUSE') {
-        config.listen.port++;
-        console.log('Address in use, retrying on port ' + config.listen.port);
-        setTimeout(function () {
-            server.listen(config.listen.port);
-        }, 250);
-    }
-});
-
-app.use(express.static(__dirname + '/public')).use(function(req, res, next) {
-    var myAuth = basicAuth(req);
-    if (myAuth === undefined) {
-        res.statusCode = 401;
-        res.setHeader('WWW-Authenticate', 'Basic realm="WebSSH"');
-        res.end('Username and password required for web SSH service.');
-    } else {
-        config.user.name = myAuth.name;
-        config.user.password = myAuth.pass;
-        next();
-    }
-}).use(cookieParser()).get('/ssh/host/:host?', function(req, res) {
-    res.sendFile(path.join(__dirname + '/public/client.htm'));
-    config.ssh.host = req.params.host;
-    if (typeof req.query.port !== 'undefined' && req.query.port !== null){ config.host.port = req.query.port;}
-    if (typeof req.query.header !== 'undefined' && req.query.header !== null){ config.header.text = req.query.header;}
-    if (typeof req.query.headerBackground !== 'undefined' && req.query.headerBackground !== null){ config.header.background = req.query.headerBackground;}
-    console.log ('webssh2 Login: user=' + config.user.name + ' from=' + req.ip + ' host=' + config.ssh.host + ' port=' + config.ssh.port + ' sessionID=' + req.headers['sessionid'] + ' allowreplay=' + req.headers['allowreplay']);
-    console.log ('Headers: ' + JSON.stringify(req.headers));
-    config.options.allowreplay = req.headers['allowreplay'];
-
-}).use('/style',express.static(__dirname + '/public')).use('/src',express.static(__dirname + '/node_modules/xterm/dist')).use('/addons',express.static(__dirname + '/node_modules/xterm/dist/addons'));
-
-io.on('connection', function(socket) {
-    var conn = new ssh();
-    conn.on('banner', function(d) {
-        //need to convert to cr/lf for proper formatting
-        d = d.replace(/\n/g, "\r\n");
-        socket.emit('data', d.toString('binary'));
-    }).on('ready', function() {
-        socket.emit('title', 'ssh://' + config.ssh.host);
-        socket.emit('headerBackground', config.header.background);
-        socket.emit('header', config.header.text);
-        socket.emit('footer', 'ssh://' + config.user.name + '@' + config.ssh.host + ':' + config.ssh.port);
-        socket.emit('status', 'SSH CONNECTION ESTABLISHED');
-        socket.emit('statusBackground', 'green');
-        socket.emit('allowreplay', config.options.allowreplay)
-        conn.shell(function(err, stream) {
-            if (err) return socket.emit('status', 'SSH EXEC ERROR: ' + err.message).emit('statusBackground', 'red');
-            socket.on('data', function(data) {
-                stream.write(data);
-            });
-            socket.on('control', function(controlData) {
-                switch(controlData) {
-                    case 'replayCredentials':
-                        stream.write(config.user.password + '\n');
-                    default:
-                        console.log ('controlData: '+ controlData);
-                };
-            });
-            stream.on('data', function(d) {
-                socket.emit('data', d.toString('binary'));
-            }).on('close', function() {
-                conn.end();
-            });
-        });
-    }).on('end', function() {
-        socket.emit('status', 'SSH CONNECTION CLOSED BY HOST');
-        socket.emit('statusBackground', 'red');
-    }).on('close', function() {
-        socket.emit('status', 'SSH CONNECTION CLOSED');
-        socket.emit('statusBackground', 'red');
-    }).on('error', function(error) {
-        socket.emit('status', 'SSH CONNECTION ERROR - ' + error);
-        socket.emit('statusBackground', 'red');
-    }).on('keyboard-interactive', function(name, instructions, instructionsLang, prompts, finish) {
-        console.log('Connection :: keyboard-interactive');
-        finish([config.user.password]);
-    }).connect({
-        host: config.ssh.host,
-        port: config.ssh.port,
-        username: config.user.name,
-        password: config.user.password,
-        tryKeyboard: true,
-// some cisco routers need the these cipher strings
-        algorithms: {
-            'cipher': ['aes128-cbc', '3des-cbc', 'aes256-cbc'],
-            'hmac': ['hmac-sha1', 'hmac-sha1-96', 'hmac-md5-96']
-        }
-    });
-});

package.json

@@ -1,41 +1,6 @@
 {
-  "name": "WebSSH2",
+  "dependencies": {},
-  "version": "0.0.2",
+  "devDependencies": {
-  "ignore": [
+    "bun-types": "^1.0.1"
-    ".gitignore"
-  ],
-  "bin": "./index.js",
-  "description": "A Websocket to SSH2 gateway using term.js, socket.io, ssh2, and express",
-  "homepage": "https://github.com/billchurch/WebSSH2",
-  "keywords": "ssh webssh terminal webterminal",
-  "license": "SEE LICENSE IN FILE - LICENSE",
-  "private": true,
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/billchurch/WebSSH2.git"
-  },
-  "contributors": [
-    {
-      "name": "Bill Church",
-      "email": "wmchurch@gmail.com"
-    }
-  ],
-  "engines": {
-    "node": "0.12.7"
-  },
-  "bugs": {
-    "url" : "https://github.com/billchurch/WebSSH2/issues"
-  },
-  "dependencies": {
-    "basic-auth": "^1.1.0",
-    "cookie-parser": "^1.4.3",
-    "express": "^4.14.1",
-    "read-config": "^1.6.0",
-    "socket.io": "^1.6.0",
-    "ssh2": "^0.5.4",
-    "xterm": "^2.2.3"
-  },
-  "scripts": {
-    "start": "node index"
   }
-}
+}

public/client.htm

@@ -1,22 +0,0 @@
-<html>
-<head>
-  <title>Web SSH</title>
-  <link rel="stylesheet" href="/src/xterm.css" />
-  <link rel="stylesheet" href="/style/style.css" />
-  <script src="/socket.io/socket.io.js"></script>
-  <script src="/src/xterm.js"></script>
-  <script src="/addons/fit/fit.js"></script>
-  <script src="/client.js" defer></script>
-</head>
-<body>
-  <div class="box">
-    <div id="header"></div>
-    <div id="terminal-container" class="terminal"></div>
-    <div id="bottomdiv">
-      <div id="footer"></div>
-      <div id="status"></div>
-      <div id="credentials"><a class="credentials" href="" onclick="return false;">CREDENTIALS</a></div>
-    </div>
-  </div>
-</body>
-</html>

public/client.js

@@ -1,71 +0,0 @@
-var terminalContainer = document.getElementById('terminal-container'),
-    term = new Terminal({
-	cursorBlink: true
-    }),
-    socket,
-    termid;
-term.open(terminalContainer);
-term.fit();
-var cols = term.cols,
-    rows = term.rows;
-if (document.location.pathname) {
-    var parts = document.location.pathname.split('/'),
-        base = parts.slice(0, parts.length - 1).join('/') + '/',
-        resource = base.substring(1) + 'socket.io';
-    socket = io.connect(null, {
-        resource: resource
-    });
-} else {
-    socket = io.connect();
-}
-var credentialReplay = document.getElementById('credentials')
-credentialReplay.onclick = replayCredentials;
-
-function replayCredentials() {
-    socket.emit('control', 'replayCredentials');
-    //term.writeln('sending credentials');
-    return true;
-}
-socket.emit('create', term.cols, term.rows, function(err, data) {
-    if (err) return self._destroy();
-    self.pty = data.pty;
-    self.id = data.id;
-    termid = self.id;
-    term.emit('open tab', self);
-});
-socket.on('connect', function() {
-    term.on('data', function(data) {
-        socket.emit('data', data);
-    });
-    socket.on('title', function(data) {
-        document.title = data;
-    }).on('status', function(data) {
-        document.getElementById('status').innerHTML = data;
-    }).on('headerBackground', function(data) {
-        document.getElementById('header').style.backgroundColor = data;
-    }).on('header', function(data) {
-        document.getElementById('header').innerHTML = data;
-    }).on('footer', function(data) {
-        document.getElementById('footer').innerHTML = data;
-    }).on('statusBackground', function(data) {
-        document.getElementById('status').style.backgroundColor = data;
-    }).on('allowreplay', function(data) {
-        console.log ('allowreplay: ' + data);
-        if (data == 'true') {
-            document.getElementById('credentials').style.display = 'inline';
-            console.log ('display: block');
-        } else {
-            document.getElementById('credentials').style.display = 'none';
-	    console.log ('display: none');
-        }
-    }).on('data', function(data) {
-        term.write(data);
-    }).on('disconnect', function() {
-        document.getElementById('status').style.backgroundColor = 'red';
-        document.getElementById('status').innerHTML = 'WEBSOCKET SERVER DISCONNECTED';
-        socket.io.reconnection(false);
-    }).on('error', function(err) {
-        document.getElementById('status').style.backgroundColor = 'red';
-        document.getElementById('status').innerHTML = 'ERROR ' + err;
-    });
-});

public/style.css

@@ -1,92 +0,0 @@
-body {
-    font-family: helvetica, sans-serif, arial;
-    font-size: 1em;
-    color: #111;
-    background-color: rgb(0, 0, 0);
-    color: rgb(240, 240, 240);
-    height: 100%;
-    margin: 0;
-}
-
-#header {
-    color: rgb(240, 240, 240);
-    background-color: rgb(0, 128, 0);
-    width: 100%;
-    border-color: white;
-    border-style: none none solid none;
-    border-width: 1px;
-    text-align: center;
-    flex: 0 1 auto;
-    z-index: 99;
-}
-
-.box {
-  display: flex;
-  flex-flow: column;
-  height: 100%;
-}
-
-#terminal-container {
-    flex: 1 1 auto;
-    width: 100%;
-    margin: 0 auto;
-    padding: 2px;
-}
-
-#terminal-container .terminal {
-    background-color: #000000;
-    color: #fafafa;
-    padding: 2px;
-}
-
-#terminal-container .terminal:focus .terminal-cursor {
-    background-color: #fafafa;
-}
-
-#bottomdiv {
-    width: 100%;
-    background-color: rgb(50, 50, 50);
-    border-color: white;
-    border-style: solid none none none;
-    border-width: 1px;
-    z-index: 99;
-    flex: 0 1 30px;
-}
-
-#footer {
-    display: inline-block;
-    color: rgb(240, 240, 240);
-    background-color: rgb(50, 50, 50);
-    padding-left: 10px;
-    padding-right: 10px;
-    text-align: left;
-}
-
-#status {
-    display: inline-block;
-    color: rgb(240, 240, 240);
-    background-color: rgb(50, 50, 50);
-    padding-left: 10px;
-    padding-right: 10px;
-    border-color: white;
-    border-style: none solid none solid;
-    border-width: 1px;
-    text-align: left;
-    z-index: 100;
-}
-#credentials {
-    display: inline-block;
-    color: rgb(51, 51, 51);
-    background-color: rgb(255, 127, 0);
-    padding-left: 10px;
-    padding-right: 10px;
-    border-color: white;
-    border-style: none solid none none;
-    border-width: 1px;
-    text-align: left;
-    z-index: 100;
-}
-a.credentials {
-    color: rgb(51, 51, 51);
-    text-decoration: none;    
-}

release-please-config.json

@@ -0,0 +1,14 @@
+{
+  "changelogPath": "CHANGELOG.md",
+  "include-v-in-tags": false,
+  "prerelease": true,
+  "packages": {
+    "app": {
+      "releaseType": "node",
+      "draft": false,
+      "bumpMinorPreMajor": false,
+      "bumpPatchForMinorPreMajor": false,
+      "versioning": "default"
+    }
+  }
+}