Bumped version to v2.5.0.

* Debug Logging and visibility of SSH Connection errors

* Updated date in man page

.appveyor.yml

@@ -1,4 +1,4 @@
-version: '1.7.1.dev.{build}'
+version: 'v2.2.1-dev.{build}'
 
 build: off
 branches:
@@ -8,18 +8,14 @@ branches:
 
 environment:
   matrix:
-    - PYTHON: "C:\\Python26"
-    - PYTHON: "C:\\Python26-x64"
-    - PYTHON: "C:\\Python27"
-    - PYTHON: "C:\\Python27-x64"
-    - PYTHON: "C:\\Python33"
-    - PYTHON: "C:\\Python33-x64"
-    - PYTHON: "C:\\Python34"
-    - PYTHON: "C:\\Python34-x64"
     - PYTHON: "C:\\Python35"
     - PYTHON: "C:\\Python35-x64"
     - PYTHON: "C:\\Python36"
     - PYTHON: "C:\\Python36-x64"
+    - PYTHON: "C:\\Python37"
+    - PYTHON: "C:\\Python37-x64"
+    - PYTHON: "C:\\Python38"
+    - PYTHON: "C:\\Python38-x64"
 matrix:
   fast_finish: true 
 

.dockerignore

@@ -0,0 +1,3 @@
+src/ssh_audit/__pycache__/
+src/ssh_audit.egg-info/
+src/ssh_audit/*~

.github/workflows/tox.yaml

@@ -0,0 +1,24 @@
+name: ssh-audit
+on: [push, pull_request]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [3.6, 3.7, 3.8, 3.9]
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install codecov coveralls flake8 mypy pylint tox vulture
+      - name: Run Tox
+        run: |
+          tox

.gitignore

@@ -1,13 +1,27 @@
 *~
-*.pyc
+*.py[cod]
 *.exe
 *.asc
 venv*/
 .cache/
+.mypy_cache/
 .tox
 .coverage*
 reports/
 .scannerwork/
-pypi/sshaudit/LICENSE
+
-pypi/sshaudit/README.md
+# PyPI packaging
-pypi/sshaudit/sshaudit.py
+/build/
+/dist/
+*.egg-info/
+*.egg
+
+# Snap packaging
+/parts/
+/prime/
+/snap/
+/stage/
+/ssh-audit_*.snap
+
+# Your local server config
+servers.txt

.travis.yml

@@ -1,80 +1,25 @@
 language: python
-sudo: false
+
-matrix:
+arch:
-  include:
+  - arm64
-    # (default)
+  - amd64
-    - os: linux
+  - ppc64le
-      python: 2.6
+
-    - os: linux
+python:
-      python: 2.7
+  - "3.6"
-      env: SQ=1
+  - "3.7"
-    - os: linux
+  - "3.8"
-      python: 3.3
+  - "3.9"
-    - os: linux
+  - "3.10"
-      python: 3.4
-    - os: linux
-      python: 3.5
-    - os: linux
-      python: 3.6
-    - os: linux
-      python: pypy
-    - os: linux
-      python: pypy3
-    - os: linux
-      python: 3.7-dev
-    # Ubuntu 12.04
-    - os: linux
-      dist: precise
-      language: generic
-      env: PY_VER=py26,py27,py33,py34,py35,py36,pypy,pypy3 PY_ORIGIN=pyenv
-    # Ubuntu 14.04
-    - os: linux
-      dist: trusty
-      language: generic
-      env: PY_VER=py26,py27,py33,py34,py35,py36,pypy,pypy3 PY_ORIGIN=pyenv
-    # macOS 10.12 Sierra
-    - os: osx
-      osx_image: xcode8.3
-      language: generic
-      env: PY_VER=py26,py27,py33,py34,py35,py36,pypy,pypy3
-    # Mac OS X 10.11 El Capitan
-    - os: osx
-      osx_image: xcode7.3
-      language: generic
-      env: PY_VER=py26,py27,py33,py34,py35,py36,pypy,pypy3
-    # Mac OS X 10.10 Yosemite
-    - os: osx
-      osx_image: xcode6.4
-      language: generic
-      env: PY_VER=py26,py27,py33,py34,py35,py36,pypy,pypy3
-  allow_failures:
-    # PyPy3 on Travis CI is out of date
-    - python: pypy3
-    # Python nightly could fail
-    - python: 3.7-dev
-    - env: PY_VER=py37
-    - env: PY_VER=py37/pyenv
-    - env: PY_VER=py37 PY_ORIGIN=pyenv
-  fast_finish: true
 
 cache:
   - pip
-  - directories:
-    - $HOME/.pyenv.cache
-    - $HOME/.bin
-
-before_install:
-  - source test/tools/ci-linux.sh
-  - ci_step_before_install
 
 install:
-  - ci_step_install
+  - pip install -U pip tox tox-travis coveralls codecov
 
 script:
-  - ci_step_script
+  - tox
 
 after_success:
-  - ci_step_success
+  - codecov
-
-after_failure:
-  - ci_step_failure

CONTRIBUTING.md

@@ -0,0 +1,26 @@
+# Contributing to ssh-audit
+
+We are very much open to receiving patches from the community!  To encourage participation, passing Travis tests, unit tests, etc., *is OPTIONAL*.  As long as the patch works properly, it can be merged.
+
+However, if you can submit patches that pass all of our automated tests, then you'll lighten the load for the project maintainer (who already has enough to do!).  This document describes what tests are done and what documentation is maintained.
+
+*Anything extra you can do is appreciated!*
+
+
+## Tox Tests
+
+Tox is used to do unit testing, linting with [pylint](http://pylint.pycqa.org/en/latest/) & [flake8](https://flake8.pycqa.org/en/latest/), and static type-checking with [mypy](https://mypy.readthedocs.io/en/stable/).
+
+For Ubuntu 18.04 or later, install tox with `apt install tox`, then simply run `tox` in the top-level directory.  Look for any error messages in the (verbose) output.
+
+
+## Docker Tests
+
+Docker is used to run ssh-audit against various real SSH servers (OpenSSH, Dropbear, and TinySSH).  The output is then diff'ed against the expected result.  Any differences result in failure.
+
+The docker tests are run with `./docker_test.sh`.  The first time it is run, it will download and compile the SSH servers; this may take awhile.  Subsequent runs, however, will take only a minute to complete, as the docker image will already be up-to-date.
+
+
+## Man Page
+
+The `ssh-audit.1` man page documents the various features of ssh-audit.  If features are added, or significant behavior is modified, the man page needs to be updated.

Dockerfile

@@ -0,0 +1,10 @@
+FROM python:3.9-slim
+
+WORKDIR /
+
+COPY ssh-audit.py .
+COPY src/ .
+
+ENTRYPOINT ["python3", "/ssh-audit.py"]
+
+EXPOSE 2222

LICENSE

@@ -1,7 +1,7 @@
 The MIT License (MIT)
 
+Copyright (C) 2017-2020 Joe Testa (jtesta@positronsecurity.com)
 Copyright (C) 2017 Andris Raugulis (moo@arthepsy.eu)
-Copyright (C) 2017-2019 Joe Testa (jtesta@positronsecurity.com)
 
 
 Permission is hereby granted, free of charge, to any person obtaining a copy

Makefile.docker

@@ -0,0 +1,13 @@
+VERSION = $(shell grep VERSION src/ssh_audit/globals.py | grep -E -o "'(v.*)'" | tr -d "'")
+ifeq ($(VERSION),)
+  $(error "could not determine version!")
+endif
+
+all:
+	docker build -t positronsecurity/ssh-audit:${VERSION} .
+	docker tag positronsecurity/ssh-audit:${VERSION} positronsecurity/ssh-audit:latest
+
+upload:
+	docker login
+	docker push positronsecurity/ssh-audit:${VERSION}
+	docker push positronsecurity/ssh-audit:latest

Makefile.pypi

@@ -0,0 +1,15 @@
+all:
+	rm -rf /tmp/pypi_upload
+	virtualenv -p /usr/bin/python3 /tmp/pypi_upload/
+	cp -R src /tmp/pypi_upload/
+	cp setup.py setup.cfg README.md LICENSE /tmp/pypi_upload/
+	/bin/bash -c "pushd /tmp/pypi_upload/; source bin/activate; pip3 install setuptools twine; python3 setup.py sdist bdist_wheel"
+
+uploadtest:
+	/bin/bash -c "pushd /tmp/pypi_upload; source bin/activate; twine upload --repository-url https://test.pypi.org/legacy/ /tmp/pypi_upload/dist/*"
+
+uploadprod:
+	/bin/bash -c "pushd /tmp/pypi_upload; source bin/activate; twine upload /tmp/pypi_upload/dist/*"
+
+clean:
+	rm -rf /tmp/pypi_upload/

Makefile.snap

@@ -0,0 +1,6 @@
+all:
+	echo -e "\n\nDid you remember to bump the version number in snapcraft.yaml?\n\n"
+	snapcraft --use-lxd
+
+clean:
+	rm -rf parts/ prime/ snap/ stage/ build/ dist/ src/*.egg-info/ ssh-audit*.snap

PACKAGING.md

@@ -0,0 +1,97 @@
+# Windows
+
+An executable can only be made on a Windows host because the PyInstaller tool (https://www.pyinstaller.org/) does not support cross-compilation.
+
+1.) Install Python v3.9.x from https://www.python.org/.  To make life easier, check the option to add Python to the PATH environment variable.
+
+2.) Using pip, install pyinstaller and colorama:
+
+```
+    pip install pyinstaller colorama
+```
+
+3.) Install Cygwin (https://www.cygwin.com/).
+
+4.) Create the executable with:
+
+```
+    $ ./build_windows_executable.sh
+```
+
+
+# PyPI
+
+To create package and upload to test server:
+
+```
+    $ sudo apt install python3-virtualenv
+    $ make -f Makefile.pypi
+    $ make -f Makefile.pypi uploadtest
+```
+
+To download from test server and verify:
+
+```
+    $ virtualenv -p /usr/bin/python3 /tmp/pypi_test
+    $ cd /tmp/pypi_test; source bin/activate
+    $ pip3 install --index-url https://test.pypi.org/simple ssh-audit
+```
+
+To upload to production server (hint: use username '\_\_token\_\_' and API token):
+
+```
+    $ make -f Makefile.pypi uploadprod
+```
+
+To download from production server and verify:
+
+```
+    $ virtualenv -p /usr/bin/python3 /tmp/pypi_prod
+    $ cd /tmp/pypi_prod; source bin/activate
+    $ pip3 install ssh-audit
+```
+
+# Snap
+
+To create the snap package, run a fully-updated Ubuntu Server 20.04 VM.
+
+Install pre-requisites with:
+
+```
+    $ sudo apt install make snapcraft
+    $ sudo snap install review-tools lxd
+```
+
+Initialize LXD (leave all options default):
+
+```
+    $ sudo lxd init
+```
+
+Bump the version number in snapcraft.yaml.  Then run:
+
+```
+    $ make -f Makefile.snap
+```
+
+Upload the snap with:
+
+```
+    $ snapcraft login
+    $ snapcraft upload --release=stable ssh-audit_*.snap
+```
+
+
+# Docker
+
+Build image with:
+
+```
+    $ make -f Makefile.docker
+```
+
+Then upload it to Dockerhub with:
+
+```
+    $ make -f Makefile.docker upload
+```

README.md

@@ -1,12 +1,25 @@
 # ssh-audit
-<!--
+[![License](https://img.shields.io/badge/license-MIT-brightgreen.svg)](https://github.com/jtesta/ssh-audit/blob/master/LICENSE)
-[![travis build status](https://api.travis-ci.org/arthepsy/ssh-audit.svg?branch=develop)](https://travis-ci.org/arthepsy/ssh-audit)
+[![PyPI Downloads](https://img.shields.io/pypi/dm/ssh-audit)](https://pypi.org/project/ssh-audit/)
-[![appveyor build status](https://ci.appveyor.com/api/projects/status/4m5r73m0r023edil/branch/develop?svg=true)](https://ci.appveyor.com/project/arthepsy/ssh-audit)
+[![Docker Pulls](https://img.shields.io/docker/pulls/positronsecurity/ssh-audit)](https://hub.docker.com/r/positronsecurity/ssh-audit)
-[![codecov](https://codecov.io/gh/arthepsy/ssh-audit/branch/develop/graph/badge.svg)](https://codecov.io/gh/arthepsy/ssh-audit)
+[![Build Status](https://github.com/jtesta/ssh-audit/actions/workflows/tox.yaml/badge.svg)](https://github.com/jtesta/ssh-audit/actions)
-[![Quality Gate](https://sonarqube.com/api/badges/gate?key=arthepsy-github%3Assh-audit%3Adevelop&template=ROUNDED)](https://sq.evolutiongaming.com/dashboard?id=arthepsy-github%3Assh-audit%3Adevelop)  
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/jtesta/ssh-audit/blob/master/CONTRIBUTING.md)
--->
+
 **ssh-audit** is a tool for ssh server & client configuration auditing.
 
+[jtesta/ssh-audit](https://github.com/jtesta/ssh-audit/) (v2.0+) is the updated and maintained version of ssh-audit forked from [arthepsy/ssh-audit](https://github.com/arthepsy/ssh-audit) (v1.x) due to inactivity.
+
+- [Features](#features)
+- [Usage](#usage)
+- [Screenshots](#screenshots)
+    - [Server Standard Audit Example](#server-standard-audit-example)
+    - [Server Policy Audit Example](#server-policy-audit-example)
+    - [Client Standard Audit Example](#client-standard-audit-example)
+- [Hardening Guides](#hardening-guides)
+- [Pre-Built Packages](#pre-built-packages)
+- [Web Front-End](#web-front-end)
+- [ChangeLog](#changelog)
+
 ## Features
 - SSH1 and SSH2 protocol server support;
 - analyze SSH client configuration;
@@ -17,45 +30,201 @@
 - output security information (related issues, assigned CVE list, etc);
 - analyze SSH version compatibility based on algorithm information;
 - historical information from OpenSSH, Dropbear SSH and libssh;
+- policy scans to ensure adherence to a hardened/standard configuration;
 - runs on Linux and Windows;
+- supports Python 3.6 - 3.9;
 - no dependencies
 
 ## Usage
 ```
-usage: ssh-audit.py [-1246pbcnjvlt] <host>
+usage: ssh-audit.py [options] <host>
 
+   -h,  --help             print this help
    -1,  --ssh1             force ssh version 1 only
    -2,  --ssh2             force ssh version 2 only
    -4,  --ipv4             enable IPv4 (order of precedence)
    -6,  --ipv6             enable IPv6 (order of precedence)
-   -p,  --port=<port>      port to connect
    -b,  --batch            batch output
    -c,  --client-audit     starts a server on port 2222 to audit client
                                software config (use -p to change port;
                                use -t to change timeout)
-   -n,  --no-colors        disable colors
+   -d,  --debug            Enable debug output.
-   -j,  --json             JSON output
+   -j,  --json             JSON output (use -jj to enable indents)
-   -v,  --verbose          verbose output
    -l,  --level=<level>    minimum output level (info|warn|fail)
+   -L,  --list-policies    list all the official, built-in policies
+        --lookup=<alg1,alg2,...>    looks up an algorithm(s) without
+                                    connecting to a server
+   -m,  --manual           print the man page (Windows only)
+   -M,  --make-policy=<policy.txt>  creates a policy based on the target server
+                                    (i.e.: the target server has the ideal
+                                    configuration that other servers should
+                                    adhere to)
+   -n,  --no-colors        disable colors
+   -p,  --port=<port>      port to connect
+   -P,  --policy=<"policy name" | policy.txt>  run a policy test using the
+                                                   specified policy
    -t,  --timeout=<secs>   timeout (in seconds) for connection and reading
                                (default: 5)
+   -T,  --targets=<hosts.txt>  a file containing a list of target hosts (one
+                                   per line, format HOST[:PORT])
+        --threads=<threads>    number of threads to use when scanning multiple
+                                   targets (-T/--targets) (default: 32)
+   -v,  --verbose          verbose output
 ```
 * if both IPv4 and IPv6 are used, order of precedence can be set by using either `-46` or `-64`.  
 * batch flag `-b` will output sections without header and without empty lines (implies verbose flag).  
 * verbose flag `-v` will prefix each line with section type and algorithm name.  
+* an exit code of 0 is returned when all algorithms are considered secure (for a standard audit), or when a policy check passes (for a policy audit).
 
-### Server Audit Example
+Basic server auditing:
-Below is a screen shot of the server-auditing output when connecting to an unhardened OpenSSH v5.3 service:
+```
+ssh-audit localhost
+ssh-audit 127.0.0.1
+ssh-audit 127.0.0.1:222
+ssh-audit ::1
+ssh-audit [::1]:222
+```
+
+To run a standard audit against many servers (place targets into servers.txt, one on each line in the format of `HOST[:PORT]`):
+
+```
+ssh-audit -T servers.txt
+```
+
+To audit a client configuration (listens on port 2222 by default; connect using `ssh -p 2222 anything@localhost`):
+
+```
+ssh-audit -c
+```
+
+To audit a client configuration, with a listener on port 4567:
+```
+ssh-audit -c -p 4567
+```
+
+To  list all official built-in policies (hint: use resulting policy names with `-P`/`--policy`):
+```
+ssh-audit -L
+```
+
+To run a policy audit against a server:
+```
+ssh-audit -P ["policy name" | path/to/server_policy.txt] targetserver
+```
+
+To run a policy audit against a client:
+```
+ssh-audit -c -P ["policy name" | path/to/client_policy.txt]
+```
+
+To run a policy audit against many servers:
+```
+ssh-audit -T servers.txt -P ["policy name" | path/to/server_policy.txt]
+```
+
+To create a policy based on a target server (which can be manually edited):
+```
+ssh-audit -M new_policy.txt targetserver
+```
+
+## Screenshots
+
+### Server Standard Audit Example
+Below is a screen shot of the standard server-auditing output when connecting to an unhardened OpenSSH v5.3 service:
 ![screenshot](https://user-images.githubusercontent.com/2982011/64388792-317e6f80-d00e-11e9-826e-a4934769bb07.png)
 
-### Client Audit Example
+### Server Policy Audit Example
+Below is a screen shot of the policy auditing output when connecting to an un-hardened Ubuntu Server 20.04 machine (hint: use `-L`/`--list-policies` to see names of built-in policies to use with `-P`/`--policy`):
+![screenshot](https://user-images.githubusercontent.com/2982011/94370881-95178700-00c0-11eb-8705-3157a4669dc0.png)
+
+After applying the steps in the hardening guide (see below), the output changes to the following:
+![screenshot](https://user-images.githubusercontent.com/2982011/94370873-87620180-00c0-11eb-9a59-469f61a56ce1.png)
+
+### Client Standard Audit Example
 Below is a screen shot of the client-auditing output when an unhardened OpenSSH v7.2 client connects:
 ![client_screenshot](https://user-images.githubusercontent.com/2982011/68867998-b946c100-06c4-11ea-975f-1f47e4178a74.png)
 
-### Hardening Guides
+## Hardening Guides
 Guides to harden server & client configuration can be found here: [https://www.ssh-audit.com/hardening_guides.html](https://www.ssh-audit.com/hardening_guides.html)
 
+## Pre-Built Packages
+Pre-built packages are available for Windows (see the releases page), on PyPI, Snap, and Homebrew.
+
+To install from PyPI:
+```
+$ pip3 install ssh-audit
+```
+
+To install the Snap package:
+```
+$ snap install ssh-audit
+```
+
+To install on Homebrew:
+```
+$ brew install ssh-audit
+```
+
+To install from Dockerhub:
+```
+$ docker pull positronsecurity/ssh-audit
+```
+(Then run with: `docker run -it -p 2222:2222 positronsecurity/ssh-audit 10.1.1.1`)
+
+## Web Front-End
+For convenience, a web front-end on top of the command-line tool is available at [https://www.ssh-audit.com/](https://www.ssh-audit.com/).
+
 ## ChangeLog
+### v2.5.0 (2021-08-26)
+ - Fixed crash when running host key tests.
+ - Handles server connection failures more gracefully.
+ - Now prints JSON with indents when `-jj` is used (useful for debugging).
+ - Added MD5 fingerprints to verbose output.
+ - Added `-d`/`--debug` option for getting debugging output; credit [Adam Russell](https://github.com/thecliguy).
+ - Updated JSON output to include MD5 fingerprints.  Note that this results in a breaking change in the 'fingerprints' dictionary format.
+ - Updated OpenSSH 8.1 (and earlier) policies to include `rsa-sha2-512` and `rsa-sha2-256`.
+ - Added OpenSSH v8.6 & v8.7 policies.
+ - Added 3 new key exchanges: `gss-gex-sha1-eipGX3TCiQSrx573bT1o1Q==`, `gss-group1-sha1-eipGX3TCiQSrx573bT1o1Q==`, and `gss-group14-sha1-eipGX3TCiQSrx573bT1o1Q==`.
+ - Added 3 new MACs: `hmac-ripemd160-96`, `AEAD_AES_128_GCM`, and `AEAD_AES_256_GCM`.
+
+### v2.4.0 (2021-02-23)
+ - Added multi-threaded scanning support.
+ - Added built-in Windows manual page (see `-m`/`--manual`); credit [Adam Russell](https://github.com/thecliguy).
+ - Added version check for OpenSSH user enumeration (CVE-2018-15473).
+ - Added deprecation note to host key types based on SHA-1.
+ - Added extra warnings for SSHv1.
+ - Added built-in hardened OpenSSH v8.5 policy.
+ - Upgraded warnings to failures for host key types based on SHA-1.
+ - Fixed crash when receiving unexpected response during host key test.
+ - Fixed hang against older Cisco devices during host key test & gex test.
+ - Fixed improper termination while scanning multiple targets when one target returns an error.
+ - Dropped support for Python 3.5 (which reached EOL in Sept. 2020).
+ - Added 1 new key exchange: `sntrup761x25519-sha512@openssh.com`.
+
+### v2.3.1 (2020-10-28)
+ - Now parses public key sizes for `rsa-sha2-256-cert-v01@openssh.com` and `rsa-sha2-512-cert-v01@openssh.com` host key types.
+ - Flag `ssh-rsa-cert-v01@openssh.com` as a failure due to SHA-1 hash.
+ - Fixed bug in recommendation output which suppressed some algorithms inappropriately.
+ - Built-in policies now include CA key requirements (if certificates are in use).
+ - Lookup function (`--lookup`) now performs case-insensitive lookups of similar algorithms; credit [Adam Russell](https://github.com/thecliguy).
+ - Migrated pre-made policies from external files to internal database.
+ - Split single 3,500 line script into many files (by class).
+ - Added setup.py support; credit [Ganden Schaffner](https://github.com/gschaffner).
+ - Added 1 new cipher: `des-cbc@ssh.com`.
+
+### v2.3.0 (2020-09-27)
+ - Added new policy auditing functionality to test adherence to a hardening guide/standard configuration (see `-L`/`--list-policies`, `-M`/`--make-policy` and `-P`/`--policy`).  For an in-depth tutorial, see <https://www.positronsecurity.com/blog/2020-09-27-ssh-policy-configuration-checks-with-ssh-audit/>.
+ - Created new man page (see `ssh-audit.1` file).
+ - 1024-bit moduli upgraded from warnings to failures.
+ - Many Python 2 code clean-ups, testing framework improvements, pylint & flake8 fixes, and mypy type comments; credit [Jürgen Gmach](https://github.com/jugmac00).
+ - Added feature to look up algorithms in internal database (see `--lookup`); credit [Adam Russell](https://github.com/thecliguy).
+ - Suppress recommendation of token host key types.
+ - Added check for use-after-free vulnerability in PuTTY v0.73.
+ - Added 11 new host key types: `ssh-rsa1`, `ssh-dss-sha256@ssh.com`, `ssh-gost2001`, `ssh-gost2012-256`, `ssh-gost2012-512`, `spki-sign-rsa`, `ssh-ed448`, `x509v3-ecdsa-sha2-nistp256`, `x509v3-ecdsa-sha2-nistp384`, `x509v3-ecdsa-sha2-nistp521`, `x509v3-rsa2048-sha256`.
+ - Added 8 new key exchanges: `diffie-hellman-group1-sha256`, `kexAlgoCurve25519SHA256`, `Curve25519SHA256`, `gss-group14-sha256-`, `gss-group15-sha512-`, `gss-group16-sha512-`, `gss-nistp256-sha256-`, `gss-curve25519-sha256-`.
+ - Added 5 new ciphers: `blowfish`, `AEAD_AES_128_GCM`, `AEAD_AES_256_GCM`, `crypticore128@ssh.com`, `seed-cbc@ssh.com`.
+ - Added 3 new MACs: `chacha20-poly1305@openssh.com`, `hmac-sha3-224`, `crypticore-mac@ssh.com`.
+
 ### v2.2.0 (2020-03-11)
  - Marked host key type `ssh-rsa` as weak due to [practical SHA-1 collisions](https://eprint.iacr.org/2020/014.pdf).
  - Added Windows builds.

build_windows_executable.sh

@@ -0,0 +1,130 @@
+#!/bin/bash
+
+#
+#   The MIT License (MIT)
+#
+#   Copyright (C) 2021 Joe Testa (jtesta@positronsecurity.com)
+#
+#   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.
+#
+
+################################################################################
+# build_windows_executable.sh
+#
+# Builds a Windows executable using PyInstaller.
+################################################################################
+
+
+PLATFORM="$(uname -s)"
+
+# This script is intended for use on Cygwin only.
+case "$PLATFORM" in
+    CYGWIN*) ;;
+    *)
+	echo "Platform not supported ($PLATFORM).  This must be run in Cygwin only."
+	exit 1
+	;;
+esac
+
+# Ensure that Python 3.x is installed.
+if [[ "$(python -V)" != "Python 3."* ]]; then
+    echo "Python v3.x not found.  Install the latest stable version from: https://www.python.org/"
+    exit 1
+fi
+
+# Ensure that pyinstaller is installed.
+command -v pyinstaller >/dev/null 2>&1 || { echo >&2 "pyinstaller not found.  Install with: 'pip install pyinstaller'"; exit 1; }
+
+# Ensure that the colorama module is installed.
+X=`pip show colorama` 2> /dev/null
+if [[ $? != 0 ]]; then
+    echo "Colorama module not found.  Install with: 'pip install colorama'"
+    exit 1
+fi
+
+# Prompt for the version to release.
+echo -n "Enter the version to release, using format 'vX.X.X': "
+read -r version
+
+# Ensure that entered version fits required format.
+if [[ ! $version =~ ^v[0-9]\.[0-9]\.[0-9]$ ]]; then
+   echo "Error: version string does not match format vX.X.X!"
+   exit 1
+fi
+
+# Verify that version is correct.
+echo -n "Version will be set to '${version}'.  Is this correct? (y/n): "
+read -r yn
+echo
+
+if [[ $yn != "y" ]]; then
+   echo "Build cancelled."
+   exit 1
+fi
+
+# Reset any local changes made to globals.py from a previous run.
+git checkout src/ssh_audit/globals.py 2> /dev/null
+
+# Update the man page.
+./update_windows_man_page.sh
+if [[ $? != 0 ]]; then
+    echo "Failed to run ./update_windows_man_page.sh"
+    exit 1
+fi
+
+# Do all operations from this point from the main source directory.
+pushd src/ssh_audit > /dev/null
+
+# Delete the existing VERSION variable and add the value that the user entered, above.
+sed -i '/^VERSION/d' globals.py
+echo "VERSION = '$version'" >> globals.py
+
+# Delete cached files if they exist from a prior run.
+rm -rf dist/ build/ ssh-audit.spec
+
+# Create a hard link from ssh_audit.py to ssh-audit.py.
+if [[ ! -f ssh-audit.py ]]; then
+    ln ssh_audit.py ssh-audit.py
+fi
+
+echo -e "\nRunning pyinstaller...\n"
+pyinstaller -F --icon ../../windows_icon.ico ssh-audit.py
+
+if [[ -f dist/ssh-audit.exe ]]; then
+    echo -e "\nExecutable created in $(pwd)/dist/ssh-audit.exe\n"
+else
+    echo -e "\nFAILED to create $(pwd)/dist/ssh-audit.exe!\n"
+    exit 1
+fi
+
+# Ensure that the version string doesn't have '-dev' in it.
+X=`dist/ssh-audit.exe | grep -E 'ssh-audit.exe v.+\-dev'` > /dev/null
+if [[ $? == 0 ]]; then
+    echo -e "\nError: executable's version number includes '-dev'."
+    exit 1
+fi
+
+# Remove the cache files created during the build process, along with the link we created, above.
+rm -rf build/ ssh-audit.spec ssh-audit.py
+
+# Reset the changes we made to globals.py.
+git checkout globals.py 2> /dev/null
+
+popd > /dev/null
+exit 0

docker_test.sh

@@ -18,16 +18,27 @@
 IMAGE_VERSION=3
 
 # This is the name of our docker image.
-IMAGE_NAME=ssh-audit-test
+IMAGE_NAME=positronsecurity/ssh-audit-test-framework
 
 
 # Terminal colors.
 CLR="\033[0m"
 RED="\033[0;31m"
+YELLOW="\033[0;33m"
 GREEN="\033[0;32m"
 REDB="\033[1;31m"   # Red + bold
 GREENB="\033[1;32m" # Green + bold
 
+# Program return values.
+PROGRAM_RETVAL_FAILURE=3
+PROGRAM_RETVAL_WARNING=2
+PROGRAM_RETVAL_CONNECTION_ERROR=1
+PROGRAM_RETVAL_GOOD=0
+
+
+# Counts the number of test failures.
+num_failures=0
+
 
 # Returns 0 if current docker image exists.
 function check_if_docker_image_exists {
@@ -237,7 +248,7 @@ function get_release_key {
 
     # The TinySSH release key isn't on any website, apparently.
     if [[ $project == 'TinySSH' ]]; then
-	gpg --recv-key $key_id
+	gpg --keyserver keys.gnupg.net --recv-key $key_id
     else
 	echo -e "\nGetting ${project} release key...\n"
 	wget -O key.asc $2
@@ -347,14 +358,27 @@ function get_source {
 }
 
 
+# Pulls the defined image from Dockerhub.
+function pull_docker_image {
+    docker pull $IMAGE_NAME:$IMAGE_VERSION
+    if [[ $? == 0 ]]; then
+        echo -e "${GREEN}Successfully downloaded image ${IMAGE_NAME}:${IMAGE_VERSION} from Dockerhub.${CLR}\n"
+    else
+        echo -e "${REDB}Failed to pull image ${IMAGE_NAME}:${IMAGE_VERSION} from Dockerhub!  Error code: $?${CLR}\n"
+        exit -1
+    fi
+}
+
+
 # Runs a Dropbear test.  Upon failure, a diff between the expected and actual results
 # is shown, then the script immediately terminates.
 function run_dropbear_test {
     dropbear_version=$1
     test_number=$2
     options=$3
+    expected_retval=$4
 
-    run_test 'Dropbear' $dropbear_version $test_number "$options"
+    run_test 'Dropbear' $dropbear_version $test_number "$options" $expected_retval
 }
 
 
@@ -363,8 +387,9 @@ function run_dropbear_test {
 function run_openssh_test {
     openssh_version=$1
     test_number=$2
+    expected_retval=$3
 
-    run_test 'OpenSSH' $openssh_version $test_number ''
+    run_test 'OpenSSH' $openssh_version $test_number '' $expected_retval
 }
 
 
@@ -373,8 +398,9 @@ function run_openssh_test {
 function run_tinyssh_test {
     tinyssh_version=$1
     test_number=$2
+    expected_retval=$3
 
-    run_test 'TinySSH' $tinyssh_version $test_number ''
+    run_test 'TinySSH' $tinyssh_version $test_number '' $expected_retval
 }
 
 
@@ -383,7 +409,9 @@ function run_test {
     version=$2
     test_number=$3
     options=$4
+    expected_retval=$5
 
+    failed=0  # Set to 1 if this test fails.
     server_exec=
     test_result_stdout=
     test_result_json=
@@ -415,21 +443,24 @@ function run_test {
     fi
 
     cid=`docker run -d -p 2222:22 ${IMAGE_NAME}:${IMAGE_VERSION} ${server_exec}`
+    #echo "Running: docker run -d -p 2222:22 ${IMAGE_NAME}:${IMAGE_VERSION} ${server_exec}"
     if [[ $? != 0 ]]; then
 	echo -e "${REDB}Failed to run docker image! (exit code: $?)${CLR}"
 	exit 1
     fi
 
     ./ssh-audit.py localhost:2222 > $test_result_stdout
-    if [[ $? != 0 ]]; then
+    actual_retval=$?
-	echo -e "${REDB}Failed to run ssh-audit.py! (exit code: $?)${CLR}"
+    if [[ $actual_retval != $expected_retval ]]; then
+	echo -e "${REDB}Unexpected return value.  Expected: ${expected_retval}; Actual: ${actual_retval}${CLR}"
 	docker container stop -t 0 $cid > /dev/null
 	exit 1
     fi
 
     ./ssh-audit.py -j localhost:2222 > $test_result_json
-    if [[ $? != 0 ]]; then
+    actual_retval=$?
-	echo -e "${REDB}Failed to run ssh-audit.py! (exit code: $?)${CLR}"
+    if [[ $actual_retval != $expected_retval ]]; then
+	echo -e "${REDB}Unexpected return value.  Expected: ${expected_retval}; Actual: ${actual_retval}${CLR}"
 	docker container stop -t 0 $cid > /dev/null
 	exit 1
     fi
@@ -450,6 +481,115 @@ function run_test {
 	mv "${test_result_json}.tmp" ${test_result_json}
     fi
 
+    diff=`diff -u ${expected_result_stdout} ${test_result_stdout}`
+    if [[ $? != 0 ]]; then
+	echo -e "${test_name} ${REDB}FAILED${CLR}.\n\n${diff}\n"
+	failed=1
+	num_failures=$((num_failures+1))
+    fi
+
+    diff=`diff -u ${expected_result_json} ${test_result_json}`
+    if [[ $? != 0 ]]; then
+	echo -e "${test_name} ${REDB}FAILED${CLR}.\n\n${diff}\n"
+	failed=1
+	num_failures=$((num_failures+1))
+    fi
+
+    if [[ $failed == 0 ]]; then
+	echo -e "${test_name} ${GREEN}passed${CLR}."
+    fi
+}
+
+function run_builtin_policy_test {
+    policy_name=$1         # The built-in policy name to use.
+    version=$2             # Version of OpenSSH to test with.
+    test_number=$3         # The test number to run.
+    server_options=$4      # The options to start the server with (i.e.: "-o option1,options2,...")
+    expected_exit_code=$5  # The expected exit code of ssh-audit.py.
+
+    server_exec="/openssh/sshd-${version} -D -f /etc/ssh/sshd_config-8.0p1_test1 ${server_options}"
+    test_result_stdout="${TEST_RESULT_DIR}/openssh_${version}_builtin_policy_${test_number}.txt"
+    test_result_json="${TEST_RESULT_DIR}/openssh_${version}_builtin_policy_${test_number}.json"
+    expected_result_stdout="test/docker/expected_results/openssh_${version}_builtin_policy_${test_number}.txt"
+    expected_result_json="test/docker/expected_results/openssh_${version}_builtin_policy_${test_number}.json"
+    test_name="OpenSSH ${version} built-in policy ${test_number}"
+
+    run_policy_test "${test_name}" "${server_exec}" "${policy_name}" "${test_result_stdout}" "${test_result_json}" "${expected_exit_code}"
+}
+
+
+function run_custom_policy_test {
+    config_number=$1  # The configuration number to use.
+    test_number=$2    # The policy test number to run.
+    expected_exit_code=$3  # The expected exit code of ssh-audit.py.
+
+    version=
+    config=
+    if [[ ${config_number} == 'config1' ]]; then
+        version='5.6p1'
+        config='sshd_config-5.6p1_test1'
+    elif [[ ${config_number} == 'config2' ]]; then
+        version='8.0p1'
+        config='sshd_config-8.0p1_test1'
+    elif [[ ${config_number} == 'config3' ]]; then
+        version='5.6p1'
+        config='sshd_config-5.6p1_test4'
+    fi
+
+    server_exec="/openssh/sshd-${version} -D -f /etc/ssh/${config}"
+    policy_path="test/docker/policies/policy_${test_number}.txt"
+    test_result_stdout="${TEST_RESULT_DIR}/openssh_${version}_custom_policy_${test_number}.txt"
+    test_result_json="${TEST_RESULT_DIR}/openssh_${version}_custom_policy_${test_number}.json"
+    expected_result_stdout="test/docker/expected_results/openssh_${version}_custom_policy_${test_number}.txt"
+    expected_result_json="test/docker/expected_results/openssh_${version}_custom_policy_${test_number}.json"
+    test_name="OpenSSH ${version} custom policy ${test_number}"
+
+    run_policy_test "${test_name}" "${server_exec}" "${policy_path}" "${test_result_stdout}" "${test_result_json}" "${expected_exit_code}"
+}
+
+
+function run_policy_test {
+    test_name=$1
+    server_exec=$2
+    policy_path=$3
+    test_result_stdout=$4
+    test_result_json=$5
+    expected_exit_code=$6
+
+
+    #echo "Running: docker run -d -p 2222:22 ${IMAGE_NAME}:${IMAGE_VERSION} ${server_exec}"
+    cid=`docker run -d -p 2222:22 ${IMAGE_NAME}:${IMAGE_VERSION} ${server_exec}`
+    if [[ $? != 0 ]]; then
+	echo -e "${REDB}Failed to run docker image! (exit code: $?)${CLR}"
+	exit 1
+    fi
+
+    #echo "Running: ./ssh-audit.py -P \"${policy_path}\" localhost:2222 > ${test_result_stdout}"
+    ./ssh-audit.py -P "${policy_path}" localhost:2222 > ${test_result_stdout}
+    actual_exit_code=$?
+    if [[ ${actual_exit_code} != ${expected_exit_code} ]]; then
+	echo -e "${test_name} ${REDB}FAILED${CLR} (expected exit code: ${expected_exit_code}; actual exit code: ${actual_exit_code}\n"
+        cat ${test_result_stdout}
+	docker container stop -t 0 $cid > /dev/null
+	exit 1
+    fi
+
+    #echo "Running: ./ssh-audit.py -P \"${policy_path}\" -j localhost:2222 > ${test_result_json}"
+    ./ssh-audit.py -P "${policy_path}" -j localhost:2222 > ${test_result_json}
+    actual_exit_code=$?
+    if [[ ${actual_exit_code} != ${expected_exit_code} ]]; then
+	echo -e "${test_name} ${REDB}FAILED${CLR} (expected exit code: ${expected_exit_code}; actual exit code: ${actual_exit_code}\n"
+        cat ${test_result_json}
+	docker container stop -t 0 $cid > /dev/null
+	exit 1
+    fi
+
+    docker container stop -t 0 $cid > /dev/null
+    if [[ $? != 0 ]]; then
+       echo -e "${REDB}Failed to stop docker container ${cid}! (exit code: $?)${CLR}"
+       exit 1
+    fi
+
     diff=`diff -u ${expected_result_stdout} ${test_result_stdout}`
     if [[ $? != 0 ]]; then
 	echo -e "${test_name} ${REDB}FAILED${CLR}.\n\n${diff}\n"
@@ -461,6 +601,7 @@ function run_test {
 	echo -e "${test_name} ${REDB}FAILED${CLR}.\n\n${diff}\n"
 	exit 1
     fi
+
     echo -e "${test_name} ${GREEN}passed${CLR}."
 }
 
@@ -472,40 +613,104 @@ if [[ $? != 0 ]]; then
     exit 1
 fi
 
-# Check if the docker image is the most up-to-date version.  If not, create it.
+
+# Check if the docker image is the most up-to-date version.
+docker_image_exists=0
 check_if_docker_image_exists
 if [[ $? == 0 ]]; then
-    echo -e "\n${GREEN}Docker image $IMAGE_NAME:$IMAGE_VERSION already exists.${CLR}"
+    docker_image_exists=1
-else
-    echo -e "\nCreating docker image $IMAGE_NAME:$IMAGE_VERSION..."
-    create_docker_image
-    echo -e "\n${GREEN}Done creating docker image!${CLR}"
 fi
 
+
+# Check if the user specified --create to build a new image.
+if [[ ($# == 1) && ($1 == "--create") ]]; then
+    # Ensure that the image name doesn't already exist before building.
+    if [[ $docker_image_exists == 1 ]]; then
+        echo -e "${REDB}Error: --create specified, but $IMAGE_NAME:$IMAGE_VERSION already exists!${CLR}"
+        exit 1
+    else
+        echo -e "\nCreating docker image $IMAGE_NAME:$IMAGE_VERSION..."
+        create_docker_image
+        echo -e "\n${GREEN}Done creating docker image!${CLR}"
+        exit 0
+    fi
+fi
+
+
+# If we weren't explicitly told to create a new image, and it doesn't exist, then pull it from Dockerhub.
+if [[ $docker_image_exists == 0 ]]; then
+    echo -e "\nPulling docker image $IMAGE_NAME:$IMAGE_VERSION..."
+    pull_docker_image
+fi
+
+
+echo -e "\n${GREEN}Starting tests...${CLR}"
+
 # Create a temporary directory to write test results to.
 TEST_RESULT_DIR=`mktemp -d /tmp/ssh-audit_test-results_XXXXXXXXXX`
 
 # Now run all the tests.
 echo -e "\nRunning tests..."
-run_openssh_test '4.0p1' 'test1'
+run_openssh_test '4.0p1' 'test1' $PROGRAM_RETVAL_FAILURE
 echo
-run_openssh_test '5.6p1' 'test1'
+run_openssh_test '5.6p1' 'test1' $PROGRAM_RETVAL_FAILURE
-run_openssh_test '5.6p1' 'test2'
+run_openssh_test '5.6p1' 'test2' $PROGRAM_RETVAL_FAILURE
-run_openssh_test '5.6p1' 'test3'
+run_openssh_test '5.6p1' 'test3' $PROGRAM_RETVAL_FAILURE
-run_openssh_test '5.6p1' 'test4'
+run_openssh_test '5.6p1' 'test4' $PROGRAM_RETVAL_FAILURE
-run_openssh_test '5.6p1' 'test5'
+run_openssh_test '5.6p1' 'test5' $PROGRAM_RETVAL_FAILURE
 echo
-run_openssh_test '8.0p1' 'test1'
+run_openssh_test '8.0p1' 'test1' $PROGRAM_RETVAL_FAILURE
-run_openssh_test '8.0p1' 'test2'
+run_openssh_test '8.0p1' 'test2' $PROGRAM_RETVAL_FAILURE
-run_openssh_test '8.0p1' 'test3'
+run_openssh_test '8.0p1' 'test3' $PROGRAM_RETVAL_GOOD
 echo
-run_dropbear_test '2019.78' 'test1' '-r /etc/dropbear/dropbear_rsa_host_key_1024 -r /etc/dropbear/dropbear_dss_host_key -r /etc/dropbear/dropbear_ecdsa_host_key'
+run_dropbear_test '2019.78' 'test1' '-r /etc/dropbear/dropbear_rsa_host_key_1024 -r /etc/dropbear/dropbear_dss_host_key -r /etc/dropbear/dropbear_ecdsa_host_key' 3
 echo
-run_tinyssh_test '20190101' 'test1'
+run_tinyssh_test '20190101' 'test1' $PROGRAM_RETVAL_WARNING
+echo
+echo
+run_custom_policy_test 'config1' 'test1' $PROGRAM_RETVAL_GOOD
+run_custom_policy_test 'config1' 'test2' $PROGRAM_RETVAL_FAILURE
+run_custom_policy_test 'config1' 'test3' $PROGRAM_RETVAL_FAILURE
+run_custom_policy_test 'config1' 'test4' $PROGRAM_RETVAL_FAILURE
+run_custom_policy_test 'config1' 'test5' $PROGRAM_RETVAL_FAILURE
+run_custom_policy_test 'config2' 'test6' $PROGRAM_RETVAL_GOOD
 
-# The test functions above will terminate the script on failure, so if we reached here,
+# Passing test with host key certificate and CA key certificates.
-# all tests are successful.
+run_custom_policy_test 'config3' 'test7' $PROGRAM_RETVAL_GOOD
-echo -e "\n${GREENB}ALL TESTS PASS!${CLR}\n"
+
+# Failing test with host key certificate and non-compliant CA key length.
+run_custom_policy_test 'config3' 'test8' $PROGRAM_RETVAL_FAILURE
+
+# Failing test with non-compliant host key certificate and CA key certificate.
+run_custom_policy_test 'config3' 'test9' $PROGRAM_RETVAL_FAILURE
+
+# Failing test with non-compliant host key certificate and non-compliant CA key certificate.
+run_custom_policy_test 'config3' 'test10' $PROGRAM_RETVAL_FAILURE
+
+# Passing test with host key size check.
+run_custom_policy_test 'config2' 'test11' $PROGRAM_RETVAL_GOOD
+
+# Failing test with non-compliant host key size check.
+run_custom_policy_test 'config2' 'test12' $PROGRAM_RETVAL_FAILURE
+
+# Passing test with DH modulus test.
+run_custom_policy_test 'config2' 'test13' $PROGRAM_RETVAL_GOOD
+
+# Failing test with DH modulus test.
+run_custom_policy_test 'config2' 'test14' $PROGRAM_RETVAL_FAILURE
+
+# Passing test for built-in OpenSSH 8.0p1 server policy.
+run_builtin_policy_test "Hardened OpenSSH Server v8.0 (version 1)" "8.0p1" "test1" "-o HostKeyAlgorithms=rsa-sha2-512,rsa-sha2-256,ssh-ed25519 -o KexAlgorithms=curve25519-sha256,curve25519-sha256@libssh.org,diffie-hellman-group16-sha512,diffie-hellman-group18-sha512,diffie-hellman-group-exchange-sha256 -o Ciphers=chacha20-poly1305@openssh.com,aes256-gcm@openssh.com,aes128-gcm@openssh.com,aes256-ctr,aes192-ctr,aes128-ctr -o MACs=hmac-sha2-256-etm@openssh.com,hmac-sha2-512-etm@openssh.com,umac-128-etm@openssh.com" $PROGRAM_RETVAL_GOOD
+
+# Failing test for built-in OpenSSH 8.0p1 server policy (MACs not hardened).
+run_builtin_policy_test "Hardened OpenSSH Server v8.0 (version 1)" "8.0p1" "test2" "-o HostKeyAlgorithms=rsa-sha2-512,rsa-sha2-256,ssh-ed25519 -o KexAlgorithms=curve25519-sha256,curve25519-sha256@libssh.org,diffie-hellman-group16-sha512,diffie-hellman-group18-sha512,diffie-hellman-group-exchange-sha256 -o Ciphers=chacha20-poly1305@openssh.com,aes256-gcm@openssh.com,aes128-gcm@openssh.com,aes256-ctr,aes192-ctr,aes128-ctr" $PROGRAM_RETVAL_FAILURE
+
+
+if [[ $num_failures == 0 ]]; then
+    echo -e "\n${GREENB}ALL TESTS PASS!${CLR}\n"
+    rm -rf $TEST_RESULT_DIR
+else
+    echo -e "\n${REDB}${num_failures} TESTS FAILED!${CLR}\n"
+fi
 
-rm -rf $TEST_RESULT_DIR
 exit 0

pypi/MANIFEST.in

@@ -1 +0,0 @@
-include sshaudit/LICENSE

pypi/Makefile

@@ -1,14 +0,0 @@
-all:
-	cp ../ssh-audit.py sshaudit/sshaudit.py
-	cp ../LICENSE sshaudit/LICENSE
-	cp ../README.md sshaudit/README.md
-	python3 setup.py sdist bdist_wheel
-
-uploadtest:
-	twine upload --repository-url https://test.pypi.org/legacy/ dist/*
-
-uploadprod:
-	twine upload dist/*
-
-clean:
-	rm -rf build/ dist/ *.egg-info/ sshaudit/sshaudit.py sshaudit/LICENSE sshaudit/README.md

pypi/notes.txt

@@ -1,17 +0,0 @@
-To create package and upload to test server:
-
-# apt install virtualenv
-$ virtualenv -p /usr/bin/python3 /tmp/pypi_upload
-$ cd /tmp/pypi_upload; source bin/activate
-$ pip3 install twine
-$ cp -R path/to/ssh-audit .
-$ cd ssh-audit/pypi
-$ make
-$ make uploadtest
-
-
-To download from test server and verify:
-
-$ virtualenv -p /usr/bin/python3 /tmp/pypi_test
-$ cd /tmp/pypi_test; source bin/activate
-$ pip3 install --index-url https://test.pypi.org/simple ssh-audit

pypi/setup.py

@@ -1,38 +0,0 @@
-# -*- coding: utf-8 -*-
-
-
-import re
-from setuptools import setup
-
-
-version = re.search('^VERSION\s*=\s*\'v(\d\.\d\.\d)\'', open('sshaudit/sshaudit.py').read(), re.M).group(1)
-print("\n\nPackaging ssh-audit v%s...\n\n" % version)
-
-with open("sshaudit/README.md", "rb") as f:
-    long_descr = f.read().decode("utf-8")
-
-
-setup(
-    name = "ssh-audit",
-    packages = ["sshaudit"],
-    license = 'MIT',
-    entry_points = {
-        "console_scripts": ['ssh-audit = sshaudit.sshaudit:main']
-    },
-    version = version,
-    description = "An SSH server & client configuration security auditing tool",
-    long_description = long_descr,
-    long_description_content_type = "text/markdown",
-    author = "Joe Testa",
-    author_email = "jtesta@positronsecurity.com",
-    url = "https://github.com/jtesta/ssh-audit",
-    classifiers = [
-        "Development Status :: 5 - Production/Stable",
-        "Intended Audience :: Information Technology",
-        "Intended Audience :: System Administrators",
-        "License :: OSI Approved :: MIT License",
-        "Operating System :: OS Independent",
-        "Programming Language :: Python :: 3",
-        "Topic :: Security",
-        "Topic :: Security :: Cryptography"
-    ])

pypi/sshaudit/__main__.py

@@ -1,4 +0,0 @@
-# -*- coding: utf-8 -*-
-
-from .sshaudit import main
-main()

pyproject.toml

@@ -0,0 +1,7 @@
+[build-system]
+# https://pip.pypa.io/en/stable/reference/pip/#pep-517-and-518-support
+requires = [
+    "setuptools>=40.8.0",
+    "wheel"
+]
+build-backend = "setuptools.build_meta"

setup.cfg

@@ -0,0 +1,41 @@
+[metadata]
+name = ssh-audit
+version = attr: ssh_audit.globals.VERSION
+author = Joe Testa
+author_email = jtesta@positronsecurity.com
+description = An SSH server & client configuration security auditing tool
+long_description = file: README.md
+long_description_content_type = text/markdown
+license_file = LICENSE
+url = https://github.com/jtesta/ssh-audit
+project_urls =
+    Source Code = https://github.com/jtesta/ssh-audit
+    Bug Tracker = https://github.com/jtesta/ssh-audit/issues
+classifiers =
+    Development Status :: 5 - Production/Stable
+    Intended Audience :: Information Technology
+    Intended Audience :: System Administrators
+    License :: OSI Approved :: MIT License
+    Operating System :: OS Independent
+    Programming Language :: Python :: 3
+    Programming Language :: Python :: 3.6
+    Programming Language :: Python :: 3.7
+    Programming Language :: Python :: 3.8
+    Programming Language :: Python :: 3.9
+    Programming Language :: Python :: Implementation :: CPython
+    Programming Language :: Python :: Implementation :: PyPy
+    Topic :: Security
+    Topic :: Security :: Cryptography
+
+[options]
+packages = find:
+package_dir =
+     = src
+python_requires = >=3.6,<4
+
+[options.packages.find]
+where = src
+
+[options.entry_points]
+console_scripts =
+    ssh-audit = ssh_audit.ssh_audit:main

setup.py

@@ -0,0 +1,23 @@
+import re
+import sys
+from setuptools import setup
+
+print_warning = False
+m = re.search(r'^VERSION\s*=\s*\'v(\d\.\d\.\d)\'', open('src/ssh_audit/globals.py').read(), re.M)
+if m is None:
+    # If we failed to parse the stable version, see if this is the development version.
+    m = re.search(r'^VERSION\s*=\s*\'v(\d\.\d\.\d-dev)\'', open('src/ssh_audit/globals.py').read(), re.M)
+    if m is None:
+        print("Error: could not parse VERSION variable from ssh_audit.py.")
+        sys.exit(1)
+    else:  # Continue with the development version, but print a warning later.
+        print_warning = True
+
+version = m.group(1)
+print("\n\nPackaging ssh-audit v%s...\n\n" % version)
+
+# see setup.cfg
+setup()
+
+if print_warning:
+    print("\n\n    !!! WARNING: development version detected (%s).  Are you sure you want to package this version?  Probably not...\n" % version)

snapcraft.yaml

@@ -0,0 +1,21 @@
+name: ssh-audit
+version: '2.4.0-1'
+license: 'MIT'
+summary: ssh-audit
+description: |
+  SSH server and client security configuration auditor.  Official repository: <https://github.com/jtesta/ssh-audit>
+
+base: core20
+grade: stable
+confinement: strict
+
+apps:
+  ssh-audit:
+    command: bin/ssh-audit
+    plugs: [network,network-bind]
+
+parts:
+  ssh-audit:
+    plugin: python
+    # python-version: python3
+    source: .

src/ssh_audit/__main__.py

@@ -0,0 +1,16 @@
+import sys
+import traceback
+
+from ssh_audit.ssh_audit import main
+from ssh_audit import exitcodes
+
+
+exit_code = exitcodes.GOOD
+
+try:
+    exit_code = main()
+except Exception:
+    exit_code = exitcodes.UNKNOWN_ERROR
+    print(traceback.format_exc())
+
+sys.exit(exit_code)

src/ssh_audit/algorithm.py

@@ -0,0 +1,61 @@
+"""
+   The MIT License (MIT)
+
+   Copyright (C) 2017 Andris Raugulis (moo@arthepsy.eu)
+
+   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.
+"""
+# pylint: disable=unused-import
+from typing import Dict, List, Set, Sequence, Tuple, Iterable  # noqa: F401
+from typing import Callable, Optional, Union, Any  # noqa: F401
+
+from ssh_audit.product import Product
+
+
+class Algorithm:
+
+    @staticmethod
+    def get_ssh_version(version_desc: str) -> Tuple[str, str, bool]:
+        is_client = version_desc.endswith('C')
+        if is_client:
+            version_desc = version_desc[:-1]
+        if version_desc.startswith('d'):
+            return Product.DropbearSSH, version_desc[1:], is_client
+        elif version_desc.startswith('l1'):
+            return Product.LibSSH, version_desc[2:], is_client
+        else:
+            return Product.OpenSSH, version_desc, is_client
+
+    @classmethod
+    def get_since_text(cls, versions: List[Optional[str]]) -> Optional[str]:
+        tv = []
+        if len(versions) == 0 or versions[0] is None:
+            return None
+        for v in versions[0].split(','):
+            ssh_prod, ssh_ver, is_cli = cls.get_ssh_version(v)
+            if not ssh_ver:
+                continue
+            if ssh_prod in [Product.LibSSH]:
+                continue
+            if is_cli:
+                ssh_ver = '{} (client only)'.format(ssh_ver)
+            tv.append('{} {}'.format(ssh_prod, ssh_ver))
+        if len(tv) == 0:
+            return None
+        return 'available since ' + ', '.join(tv).rstrip(', ')

src/ssh_audit/algorithms.py

@@ -0,0 +1,223 @@
+"""
+   The MIT License (MIT)
+
+   Copyright (C) 2017-2021 Joe Testa (jtesta@positronsecurity.com)
+   Copyright (C) 2017 Andris Raugulis (moo@arthepsy.eu)
+
+   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.
+"""
+# pylint: disable=unused-import
+from typing import Dict, List, Set, Sequence, Tuple, Iterable  # noqa: F401
+from typing import Callable, Optional, Union, Any  # noqa: F401
+
+from ssh_audit.algorithm import Algorithm
+from ssh_audit.product import Product
+from ssh_audit.software import Software
+from ssh_audit.ssh1_kexdb import SSH1_KexDB
+from ssh_audit.ssh1_publickeymessage import SSH1_PublicKeyMessage
+from ssh_audit.ssh2_kex import SSH2_Kex
+from ssh_audit.ssh2_kexdb import SSH2_KexDB
+from ssh_audit.timeframe import Timeframe
+from ssh_audit.utils import Utils
+
+
+class Algorithms:
+    def __init__(self, pkm: Optional[SSH1_PublicKeyMessage], kex: Optional[SSH2_Kex]) -> None:
+        self.__ssh1kex = pkm
+        self.__ssh2kex = kex
+
+    @property
+    def ssh1kex(self) -> Optional[SSH1_PublicKeyMessage]:
+        return self.__ssh1kex
+
+    @property
+    def ssh2kex(self) -> Optional[SSH2_Kex]:
+        return self.__ssh2kex
+
+    @property
+    def ssh1(self) -> Optional['Algorithms.Item']:
+        if self.ssh1kex is None:
+            return None
+        item = Algorithms.Item(1, SSH1_KexDB.ALGORITHMS)
+        item.add('key', ['ssh-rsa1'])
+        item.add('enc', self.ssh1kex.supported_ciphers)
+        item.add('aut', self.ssh1kex.supported_authentications)
+        return item
+
+    @property
+    def ssh2(self) -> Optional['Algorithms.Item']:
+        if self.ssh2kex is None:
+            return None
+        item = Algorithms.Item(2, SSH2_KexDB.ALGORITHMS)
+        item.add('kex', self.ssh2kex.kex_algorithms)
+        item.add('key', self.ssh2kex.key_algorithms)
+        item.add('enc', self.ssh2kex.server.encryption)
+        item.add('mac', self.ssh2kex.server.mac)
+        return item
+
+    @property
+    def values(self) -> Iterable['Algorithms.Item']:
+        for item in [self.ssh1, self.ssh2]:
+            if item is not None:
+                yield item
+
+    @property
+    def maxlen(self) -> int:
+        def _ml(items: Sequence[str]) -> int:
+            return max(len(i) for i in items)
+        maxlen = 0
+        if self.ssh1kex is not None:
+            maxlen = max(_ml(self.ssh1kex.supported_ciphers),
+                         _ml(self.ssh1kex.supported_authentications),
+                         maxlen)
+        if self.ssh2kex is not None:
+            maxlen = max(_ml(self.ssh2kex.kex_algorithms),
+                         _ml(self.ssh2kex.key_algorithms),
+                         _ml(self.ssh2kex.server.encryption),
+                         _ml(self.ssh2kex.server.mac),
+                         maxlen)
+        return maxlen
+
+    def get_ssh_timeframe(self, for_server: Optional[bool] = None) -> 'Timeframe':
+        timeframe = Timeframe()
+        for alg_pair in self.values:
+            alg_db = alg_pair.db
+            for alg_type, alg_list in alg_pair.items():
+                for alg_name in alg_list:
+                    alg_name_native = Utils.to_text(alg_name)
+                    alg_desc = alg_db[alg_type].get(alg_name_native)
+                    if alg_desc is None:
+                        continue
+                    versions = alg_desc[0]
+                    timeframe.update(versions, for_server)
+        return timeframe
+
+    def get_recommendations(self, software: Optional['Software'], for_server: bool = True) -> Tuple[Optional['Software'], Dict[int, Dict[str, Dict[str, Dict[str, int]]]]]:
+        # pylint: disable=too-many-locals,too-many-statements
+        vproducts = [Product.OpenSSH,
+                     Product.DropbearSSH,
+                     Product.LibSSH,
+                     Product.TinySSH]
+        # Set to True if server is not one of vproducts, above.
+        unknown_software = False
+        if software is not None:
+            if software.product not in vproducts:
+                unknown_software = True
+
+        # The code below is commented out because it would try to guess what the server is,
+        # usually resulting in wild & incorrect recommendations.
+        # if software is None:
+        #     ssh_timeframe = self.get_ssh_timeframe(for_server)
+        #     for product in vproducts:
+        #         if product not in ssh_timeframe:
+        #             continue
+        #         version = ssh_timeframe.get_from(product, for_server)
+        #         if version is not None:
+        #             software = SSH.Software(None, product, version, None, None)
+        #             break
+        rec: Dict[int, Dict[str, Dict[str, Dict[str, int]]]] = {}
+        if software is None:
+            unknown_software = True
+        for alg_pair in self.values:
+            sshv, alg_db = alg_pair.sshv, alg_pair.db
+            rec[sshv] = {}
+            for alg_type, alg_list in alg_pair.items():
+                if alg_type == 'aut':
+                    continue
+                rec[sshv][alg_type] = {'add': {}, 'del': {}, 'chg': {}}
+                for n, alg_desc in alg_db[alg_type].items():
+                    versions = alg_desc[0]
+                    empty_version = False
+                    if len(versions) == 0 or versions[0] is None:
+                        empty_version = True
+                    else:
+                        matches = False
+                        if unknown_software:
+                            matches = True
+                        for v in versions[0].split(','):
+                            ssh_prefix, ssh_version, is_cli = Algorithm.get_ssh_version(v)
+                            if not ssh_version:
+                                continue
+                            if (software is not None) and (ssh_prefix != software.product):
+                                continue
+                            if is_cli and for_server:
+                                continue
+                            if (software is not None) and (software.compare_version(ssh_version) < 0):
+                                continue
+                            matches = True
+                            break
+                        if not matches:
+                            continue
+                    adl, faults = len(alg_desc), 0
+                    for i in range(1, 3):
+                        if not adl > i:
+                            continue
+                        fc = len(alg_desc[i])
+                        if fc > 0:
+                            faults += pow(10, 2 - i) * fc
+                    if n not in alg_list:
+                        # Don't recommend certificate or token types; these will only appear in the server's list if they are fully configured & functional on the server.
+                        if faults > 0 or (alg_type == 'key' and (('-cert-' in n) or (n.startswith('sk-')))) or empty_version:
+                            continue
+                        rec[sshv][alg_type]['add'][n] = 0
+                    else:
+                        if faults == 0:
+                            continue
+                        if n in ['diffie-hellman-group-exchange-sha256', 'rsa-sha2-256', 'rsa-sha2-512', 'rsa-sha2-256-cert-v01@openssh.com', 'rsa-sha2-512-cert-v01@openssh.com']:
+                            rec[sshv][alg_type]['chg'][n] = faults
+                        else:
+                            rec[sshv][alg_type]['del'][n] = faults
+                # If we are working with unknown software, drop all add recommendations, because we don't know if they're valid.
+                if unknown_software:
+                    rec[sshv][alg_type]['add'] = {}
+                add_count = len(rec[sshv][alg_type]['add'])
+                del_count = len(rec[sshv][alg_type]['del'])
+                chg_count = len(rec[sshv][alg_type]['chg'])
+
+                if add_count == 0:
+                    del rec[sshv][alg_type]['add']
+                if del_count == 0:
+                    del rec[sshv][alg_type]['del']
+                if chg_count == 0:
+                    del rec[sshv][alg_type]['chg']
+                if len(rec[sshv][alg_type]) == 0:
+                    del rec[sshv][alg_type]
+            if len(rec[sshv]) == 0:
+                del rec[sshv]
+        return software, rec
+
+    class Item:
+        def __init__(self, sshv: int, db: Dict[str, Dict[str, List[List[Optional[str]]]]]) -> None:
+            self.__sshv = sshv
+            self.__db = db
+            self.__storage: Dict[str, List[str]] = {}
+
+        @property
+        def sshv(self) -> int:
+            return self.__sshv
+
+        @property
+        def db(self) -> Dict[str, Dict[str, List[List[Optional[str]]]]]:
+            return self.__db
+
+        def add(self, key: str, value: List[str]) -> None:
+            self.__storage[key] = value
+
+        def items(self) -> Iterable[Tuple[str, List[str]]]:
+            return self.__storage.items()

src/ssh_audit/auditconf.py

@@ -0,0 +1,98 @@
+"""
+   The MIT License (MIT)
+
+   Copyright (C) 2017-2021 Joe Testa (jtesta@positronsecurity.com)
+   Copyright (C) 2017 Andris Raugulis (moo@arthepsy.eu)
+
+   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.
+"""
+# pylint: disable=unused-import
+from typing import Dict, List, Set, Sequence, Tuple, Iterable  # noqa: F401
+from typing import Callable, Optional, Union, Any  # noqa: F401
+
+from ssh_audit.policy import Policy
+from ssh_audit.utils import Utils
+
+
+class AuditConf:
+    # pylint: disable=too-many-instance-attributes
+    def __init__(self, host: str = '', port: int = 22) -> None:
+        self.host = host
+        self.port = port
+        self.ssh1 = True
+        self.ssh2 = True
+        self.batch = False
+        self.client_audit = False
+        self.colors = True
+        self.json = False
+        self.json_print_indent = False
+        self.verbose = False
+        self.level = 'info'
+        self.ip_version_preference: List[int] = []  # Holds only 5 possible values: [] (no preference), [4] (use IPv4 only), [6] (use IPv6 only), [46] (use both IPv4 and IPv6, but prioritize v4), and [64] (use both IPv4 and IPv6, but prioritize v6).
+        self.ipv4 = False
+        self.ipv6 = False
+        self.make_policy = False  # When True, creates a policy file from an audit scan.
+        self.policy_file: Optional[str] = None   # File system path to a policy
+        self.policy: Optional[Policy] = None  # Policy object
+        self.timeout = 5.0
+        self.timeout_set = False  # Set to True when the user explicitly sets it.
+        self.target_file: Optional[str] = None
+        self.target_list: List[str] = []
+        self.threads = 32
+        self.list_policies = False
+        self.lookup = ''
+        self.manual = False
+        self.debug = False
+
+    def __setattr__(self, name: str, value: Union[str, int, float, bool, Sequence[int]]) -> None:
+        valid = False
+        if name in ['batch', 'client_audit', 'colors', 'json', 'json_print_indent', 'list_policies', 'manual', 'make_policy', 'ssh1', 'ssh2', 'timeout_set', 'verbose', 'debug']:
+            valid, value = True, bool(value)
+        elif name in ['ipv4', 'ipv6']:
+            valid, value = True, bool(value)
+            if len(self.ip_version_preference) == 2:  # Being called more than twice is not valid.
+                valid = False
+            elif value:
+                self.ip_version_preference.append(4 if name == 'ipv4' else 6)
+        elif name == 'port':
+            valid, port = True, Utils.parse_int(value)
+            if port < 1 or port > 65535:
+                raise ValueError('invalid port: {}'.format(value))
+            value = port
+        elif name in ['level']:
+            if value not in ('info', 'warn', 'fail'):
+                raise ValueError('invalid level: {}'.format(value))
+            valid = True
+        elif name == 'host':
+            valid = True
+        elif name == 'timeout':
+            value = Utils.parse_float(value)
+            if value == -1.0:
+                raise ValueError('invalid timeout: {}'.format(value))
+            valid = True
+        elif name in ['ip_version_preference', 'lookup', 'policy_file', 'policy', 'target_file', 'target_list']:
+            valid = True
+        elif name == "threads":
+            valid, num_threads = True, Utils.parse_int(value)
+            if num_threads < 1:
+                raise ValueError('invalid number of threads: {}'.format(value))
+            value = num_threads
+
+        if valid:
+            object.__setattr__(self, name, value)

src/ssh_audit/banner.py

@@ -0,0 +1,92 @@
+"""
+   The MIT License (MIT)
+
+   Copyright (C) 2017 Andris Raugulis (moo@arthepsy.eu)
+
+   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.
+"""
+import re
+
+# pylint: disable=unused-import
+from typing import Dict, List, Set, Sequence, Tuple, Iterable  # noqa: F401
+from typing import Callable, Optional, Union, Any  # noqa: F401
+
+from ssh_audit.utils import Utils
+
+
+class Banner:
+    _RXP, _RXR = r'SSH-\d\.\s*?\d+', r'(-\s*([^\s]*)(?:\s+(.*))?)?'
+    RX_PROTOCOL = re.compile(re.sub(r'\\d(\+?)', r'(\\d\g<1>)', _RXP))
+    RX_BANNER = re.compile(r'^({0}(?:(?:-{0})*)){1}$'.format(_RXP, _RXR))
+
+    def __init__(self, protocol: Tuple[int, int], software: Optional[str], comments: Optional[str], valid_ascii: bool) -> None:
+        self.__protocol = protocol
+        self.__software = software
+        self.__comments = comments
+        self.__valid_ascii = valid_ascii
+
+    @property
+    def protocol(self) -> Tuple[int, int]:
+        return self.__protocol
+
+    @property
+    def software(self) -> Optional[str]:
+        return self.__software
+
+    @property
+    def comments(self) -> Optional[str]:
+        return self.__comments
+
+    @property
+    def valid_ascii(self) -> bool:
+        return self.__valid_ascii
+
+    def __str__(self) -> str:
+        r = 'SSH-{}.{}'.format(self.protocol[0], self.protocol[1])
+        if self.software is not None:
+            r += '-{}'.format(self.software)
+        if bool(self.comments):
+            r += ' {}'.format(self.comments)
+        return r
+
+    def __repr__(self) -> str:
+        p = '{}.{}'.format(self.protocol[0], self.protocol[1])
+        r = 'protocol={}'.format(p)
+        if self.software is not None:
+            r += ', software={}'.format(self.software)
+        if bool(self.comments):
+            r += ', comments={}'.format(self.comments)
+        return '<{}({})>'.format(self.__class__.__name__, r)
+
+    @classmethod
+    def parse(cls, banner: str) -> Optional['Banner']:
+        valid_ascii = Utils.is_print_ascii(banner)
+        ascii_banner = Utils.to_print_ascii(banner)
+        mx = cls.RX_BANNER.match(ascii_banner)
+        if mx is None:
+            return None
+        protocol = min(re.findall(cls.RX_PROTOCOL, mx.group(1)))
+        protocol = (int(protocol[0]), int(protocol[1]))
+        software = (mx.group(3) or '').strip() or None
+        if software is None and (mx.group(2) or '').startswith('-'):
+            software = ''
+        comments = (mx.group(4) or '').strip() or None
+        if comments is not None:
+            comments = re.sub(r'\s+', ' ', comments)
+        return cls(protocol, software, comments, valid_ascii)

src/ssh_audit/exitcodes.py

@@ -0,0 +1,6 @@
+# The program return values corresponding to failure(s) encountered, warning(s) encountered, connection errors, and no problems found, respectively.
+FAILURE = 3
+WARNING = 2
+CONNECTION_ERROR = 1
+GOOD = 0
+UNKNOWN_ERROR = -1

src/ssh_audit/fingerprint.py

@@ -0,0 +1,43 @@
+"""
+   The MIT License (MIT)
+
+   Copyright (C) 2017-2021 Joe Testa (jtesta@positronsecurity.com)
+   Copyright (C) 2017 Andris Raugulis (moo@arthepsy.eu)
+
+   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.
+"""
+import base64
+import hashlib
+
+
+class Fingerprint:
+    def __init__(self, fpd: bytes) -> None:
+        self.__fpd = fpd
+
+    @property
+    def md5(self) -> str:
+        h = hashlib.md5(self.__fpd).hexdigest()
+        r = ':'.join(h[i:i + 2] for i in range(0, len(h), 2))
+        return 'MD5:{}'.format(r)
+
+    @property
+    def sha256(self) -> str:
+        h = base64.b64encode(hashlib.sha256(self.__fpd).digest())
+        r = h.decode('ascii').rstrip('=')
+        return 'SHA256:{}'.format(r)

src/ssh_audit/gextest.py

@@ -0,0 +1,162 @@
+"""
+   The MIT License (MIT)
+
+   Copyright (C) 2017-2021 Joe Testa (jtesta@positronsecurity.com)
+
+   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.
+"""
+
+# pylint: disable=unused-import
+from typing import Dict, List, Set, Sequence, Tuple, Iterable  # noqa: F401
+from typing import Callable, Optional, Union, Any  # noqa: F401
+
+import traceback
+
+from ssh_audit.kexdh import KexGroupExchange_SHA1, KexGroupExchange_SHA256
+from ssh_audit.ssh2_kexdb import SSH2_KexDB
+from ssh_audit.ssh2_kex import SSH2_Kex
+from ssh_audit.ssh_socket import SSH_Socket
+from ssh_audit.outputbuffer import OutputBuffer
+
+
+# Performs DH group exchanges to find what moduli are supported, and checks
+# their size.
+class GEXTest:
+
+    # Creates a new connection to the server.  Returns True on success, or False.
+    @staticmethod
+    def reconnect(out: 'OutputBuffer', s: 'SSH_Socket', kex: 'SSH2_Kex', gex_alg: str) -> bool:
+        if s.is_connected():
+            return True
+
+        err = s.connect()
+        if err is not None:
+            out.v(err, write_now=True)
+            return False
+
+        _, _, err = s.get_banner()
+        if err is not None:
+            out.v(err, write_now=True)
+            s.close()
+            return False
+
+        # Send our KEX using the specified group-exchange and most of the
+        # server's own values.
+        s.send_kexinit(key_exchanges=[gex_alg], hostkeys=kex.key_algorithms, ciphers=kex.server.encryption, macs=kex.server.mac, compressions=kex.server.compression, languages=kex.server.languages)
+
+        try:
+            # Parse the server's KEX.
+            _, payload = s.read_packet(2)
+            SSH2_Kex.parse(payload)
+        except Exception:
+            out.v("Failed to parse server's kex.  Stack trace:\n%s" % str(traceback.format_exc()), write_now=True)
+            return False
+
+        return True
+
+    # Runs the DH moduli test against the specified target.
+    @staticmethod
+    def run(out: 'OutputBuffer', s: 'SSH_Socket', kex: 'SSH2_Kex') -> None:
+        GEX_ALGS = {
+            'diffie-hellman-group-exchange-sha1': KexGroupExchange_SHA1,
+            'diffie-hellman-group-exchange-sha256': KexGroupExchange_SHA256,
+        }
+
+        # The previous RSA tests put the server in a state we can't
+        # test.  So we need a new connection to start with a clean
+        # slate.
+        if s.is_connected():
+            s.close()
+
+        # Check if the server supports any of the group-exchange
+        # algorithms.  If so, test each one.
+        for gex_alg, kex_group_class in GEX_ALGS.items():
+            if gex_alg in kex.kex_algorithms:
+                out.d('Preparing to perform DH group exchange using ' + gex_alg + '...', write_now=True)
+
+                if GEXTest.reconnect(out, s, kex, gex_alg) is False:
+                    break
+
+                kex_group = kex_group_class()
+                smallest_modulus = -1
+
+                # First try a range of weak sizes.
+                try:
+                    kex_group.send_init_gex(s, 512, 1024, 1536)
+                    kex_group.recv_reply(s, False)
+
+                    # Its been observed that servers will return a group
+                    # larger than the requested max.  So just because we
+                    # got here, doesn't mean the server is vulnerable...
+                    smallest_modulus = kex_group.get_dh_modulus_size()
+
+                except Exception:
+                    pass
+                finally:
+                    s.close()
+
+                # Try an array of specific modulus sizes... one at a time.
+                reconnect_failed = False
+                for bits in [512, 768, 1024, 1536, 2048, 3072, 4096]:
+
+                    # If we found one modulus size already, but we're about
+                    # to test a larger one, don't bother.
+                    if bits >= smallest_modulus > 0:
+                        break
+
+                    out.d('Preparing to perform DH group exchange using ' + gex_alg + ' with modulus size ' + str(bits) + '...', write_now=True)
+
+                    if GEXTest.reconnect(out, s, kex, gex_alg) is False:
+                        reconnect_failed = True
+                        break
+
+                    try:
+                        kex_group.send_init_gex(s, bits, bits, bits)
+                        kex_group.recv_reply(s, False)
+                        smallest_modulus = kex_group.get_dh_modulus_size()
+                    except Exception:
+                        # import traceback
+                        # print(traceback.format_exc())
+                        pass
+                    finally:
+                        # The server is in a state that is not re-testable,
+                        # so there's nothing else to do with this open
+                        # connection.
+                        s.close()
+
+                if smallest_modulus > 0:
+                    kex.set_dh_modulus_size(gex_alg, smallest_modulus)
+
+                    # We flag moduli smaller than 2048 as a failure.
+                    if smallest_modulus < 2048:
+                        text = 'using small %d-bit modulus' % smallest_modulus
+                        lst = SSH2_KexDB.ALGORITHMS['kex'][gex_alg]
+                        # For 'diffie-hellman-group-exchange-sha256', add
+                        # a failure reason.
+                        if len(lst) == 1:
+                            lst.append([text])
+                        # For 'diffie-hellman-group-exchange-sha1', delete
+                        # the existing failure reason (which is vague), and
+                        # insert our own.
+                        else:
+                            del lst[1]
+                            lst.insert(1, [text])
+
+                if reconnect_failed:
+                    break

src/ssh_audit/globals.py

@@ -0,0 +1,27 @@
+"""
+   The MIT License (MIT)
+
+   Copyright (C) 2017-2021 Joe Testa (jtesta@positronsecurity.com)
+
+   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.
+"""
+VERSION = 'v2.5.0'
+SSH_HEADER = 'SSH-{0}-OpenSSH_8.2'  # SSH software to impersonate
+GITHUB_ISSUES_URL = 'https://github.com/jtesta/ssh-audit/issues'  # The URL to the Github issues tracker.
+WINDOWS_MAN_PAGE = ''

src/ssh_audit/hostkeytest.py

@@ -0,0 +1,188 @@
+"""
+   The MIT License (MIT)
+
+   Copyright (C) 2017-2021 Joe Testa (jtesta@positronsecurity.com)
+
+   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.
+"""
+
+# pylint: disable=unused-import
+from typing import Dict, List, Set, Sequence, Tuple, Iterable  # noqa: F401
+from typing import Callable, Optional, Union, Any  # noqa: F401
+
+import traceback
+
+from ssh_audit.kexdh import KexDH, KexGroup1, KexGroup14_SHA1, KexGroup14_SHA256, KexCurve25519_SHA256, KexGroup16_SHA512, KexGroup18_SHA512, KexGroupExchange_SHA1, KexGroupExchange_SHA256, KexNISTP256, KexNISTP384, KexNISTP521
+from ssh_audit.ssh2_kex import SSH2_Kex
+from ssh_audit.ssh2_kexdb import SSH2_KexDB
+from ssh_audit.ssh_socket import SSH_Socket
+from ssh_audit.outputbuffer import OutputBuffer
+
+
+# Obtains host keys, checks their size, and derives their fingerprints.
+class HostKeyTest:
+    # Tracks the RSA host key types.  As of this writing, testing one in this family yields valid results for the rest.
+    RSA_FAMILY = ['ssh-rsa', 'rsa-sha2-256', 'rsa-sha2-512']
+
+    # Dict holding the host key types we should extract & parse.  'cert' is True to denote that a host key type handles certificates (thus requires additional parsing).  'variable_key_len' is True for host key types that can have variable sizes (True only for RSA types, as the rest are of fixed-size).  After the host key type is fully parsed, the key 'parsed' is added with a value of True.
+    HOST_KEY_TYPES = {
+        'ssh-rsa':      {'cert': False, 'variable_key_len': True},
+        'rsa-sha2-256': {'cert': False, 'variable_key_len': True},
+        'rsa-sha2-512': {'cert': False, 'variable_key_len': True},
+
+        'ssh-rsa-cert-v01@openssh.com':      {'cert': True, 'variable_key_len': True},
+        'rsa-sha2-256-cert-v01@openssh.com': {'cert': True, 'variable_key_len': True},
+        'rsa-sha2-512-cert-v01@openssh.com': {'cert': True, 'variable_key_len': True},
+
+        'ssh-ed25519':                      {'cert': False, 'variable_key_len': False},
+        'ssh-ed25519-cert-v01@openssh.com': {'cert': True, 'variable_key_len': False},
+    }
+
+    @staticmethod
+    def run(out: 'OutputBuffer', s: 'SSH_Socket', server_kex: 'SSH2_Kex') -> None:
+        KEX_TO_DHGROUP = {
+            'diffie-hellman-group1-sha1': KexGroup1,
+            'diffie-hellman-group14-sha1': KexGroup14_SHA1,
+            'diffie-hellman-group14-sha256': KexGroup14_SHA256,
+            'curve25519-sha256': KexCurve25519_SHA256,
+            'curve25519-sha256@libssh.org': KexCurve25519_SHA256,
+            'diffie-hellman-group16-sha512': KexGroup16_SHA512,
+            'diffie-hellman-group18-sha512': KexGroup18_SHA512,
+            'diffie-hellman-group-exchange-sha1': KexGroupExchange_SHA1,
+            'diffie-hellman-group-exchange-sha256': KexGroupExchange_SHA256,
+            'ecdh-sha2-nistp256': KexNISTP256,
+            'ecdh-sha2-nistp384': KexNISTP384,
+            'ecdh-sha2-nistp521': KexNISTP521,
+            # 'kexguess2@matt.ucc.asn.au': ???
+        }
+
+        # Pick the first kex algorithm that the server supports, which we
+        # happen to support as well.
+        kex_str = None
+        kex_group = None
+        for server_kex_alg in server_kex.kex_algorithms:
+            if server_kex_alg in KEX_TO_DHGROUP:
+                kex_str = server_kex_alg
+                kex_group = KEX_TO_DHGROUP[kex_str]()
+                break
+
+        if kex_str is not None and kex_group is not None:
+            HostKeyTest.perform_test(out, s, server_kex, kex_str, kex_group, HostKeyTest.HOST_KEY_TYPES)
+
+    @staticmethod
+    def perform_test(out: 'OutputBuffer', s: 'SSH_Socket', server_kex: 'SSH2_Kex', kex_str: str, kex_group: 'KexDH', host_key_types: Dict[str, Dict[str, bool]]) -> None:
+        hostkey_modulus_size = 0
+        ca_modulus_size = 0
+
+        # If the connection still exists, close it so we can test
+        # using a clean slate (otherwise it may exist in a non-testable
+        # state).
+        if s.is_connected():
+            s.close()
+
+        # For each host key type...
+        for host_key_type in host_key_types:
+            # Skip those already handled (i.e.: those in the RSA family, as testing one tests them all).
+            if 'parsed' in host_key_types[host_key_type] and host_key_types[host_key_type]['parsed']:
+                continue
+
+            # If this host key type is supported by the server, we test it.
+            if host_key_type in server_kex.key_algorithms:
+                out.d('Preparing to obtain ' + host_key_type + ' host key...', write_now=True)
+
+                cert = host_key_types[host_key_type]['cert']
+                variable_key_len = host_key_types[host_key_type]['variable_key_len']
+
+                # If the connection is closed, re-open it and get the kex again.
+                if not s.is_connected():
+                    err = s.connect()
+                    if err is not None:
+                        out.v(err, write_now=True)
+                        return
+
+                    _, _, err = s.get_banner()
+                    if err is not None:
+                        out.v(err, write_now=True)
+                        s.close()
+                        return
+
+                    # Send our KEX using the specified group-exchange and most of the server's own values.
+                    s.send_kexinit(key_exchanges=[kex_str], hostkeys=[host_key_type], ciphers=server_kex.server.encryption, macs=server_kex.server.mac, compressions=server_kex.server.compression, languages=server_kex.server.languages)
+
+                    try:
+                        # Parse the server's KEX.
+                        _, payload = s.read_packet()
+                        SSH2_Kex.parse(payload)
+                    except Exception:
+                        out.v("Failed to parse server's kex.  Stack trace:\n%s" % str(traceback.format_exc()), write_now=True)
+                        return
+
+                # Do the initial DH exchange.  The server responds back
+                # with the host key and its length.  Bingo.  We also get back the host key fingerprint.
+                kex_group.send_init(s)
+                try:
+                    host_key = kex_group.recv_reply(s, variable_key_len)
+                    if host_key is not None:
+                        server_kex.set_host_key(host_key_type, host_key)
+                except Exception:
+                    pass
+
+                hostkey_modulus_size = kex_group.get_hostkey_size()
+                ca_modulus_size = kex_group.get_ca_size()
+
+                # Close the socket, as the connection has
+                # been put in a state that later tests can't use.
+                s.close()
+
+                # If the host key modulus or CA modulus was successfully parsed, check to see that its a safe size.
+                if hostkey_modulus_size > 0 or ca_modulus_size > 0:
+                    # Set the hostkey size for all RSA key types since 'ssh-rsa',
+                    # 'rsa-sha2-256', etc. are all using the same host key.
+                    # Note, however, that this may change in the future.
+                    if cert is False and host_key_type in HostKeyTest.RSA_FAMILY:
+                        for rsa_type in HostKeyTest.RSA_FAMILY:
+                            server_kex.set_rsa_key_size(rsa_type, hostkey_modulus_size)
+                    elif cert is True:
+                        server_kex.set_rsa_key_size(host_key_type, hostkey_modulus_size, ca_modulus_size)
+
+                    # Keys smaller than 2048 result in a failure.  Update the database accordingly.
+                    if (cert is False) and (hostkey_modulus_size < 2048):
+                        for rsa_type in HostKeyTest.RSA_FAMILY:
+                            alg_list = SSH2_KexDB.ALGORITHMS['key'][rsa_type]
+
+                            # If no failure list exists, add an empty failure list.
+                            if len(alg_list) < 2:
+                                alg_list.append([])
+                            alg_list[1].append('using small %d-bit modulus' % hostkey_modulus_size)
+                    elif (cert is True) and ((hostkey_modulus_size < 2048) or (ca_modulus_size > 0 and ca_modulus_size < 2048)):  # pylint: disable=chained-comparison
+                        alg_list = SSH2_KexDB.ALGORITHMS['key'][host_key_type]
+                        min_modulus = min(hostkey_modulus_size, ca_modulus_size)
+                        min_modulus = min_modulus if min_modulus > 0 else max(hostkey_modulus_size, ca_modulus_size)
+
+                        # If no failure list exists, add an empty failure list.
+                        if len(alg_list) < 2:
+                            alg_list.append([])
+                        alg_list[1].append('using small %d-bit modulus' % min_modulus)
+
+                # If this host key type is in the RSA family, then mark them all as parsed (since results in one are valid for them all).
+                if host_key_type in HostKeyTest.RSA_FAMILY:
+                    for rsa_type in HostKeyTest.RSA_FAMILY:
+                        host_key_types[rsa_type]['parsed'] = True
+                else:
+                    host_key_types[host_key_type]['parsed'] = True

src/ssh_audit/kexdh.py

@@ -0,0 +1,365 @@
+"""
+   The MIT License (MIT)
+
+   Copyright (C) 2017-2021 Joe Testa (jtesta@positronsecurity.com)
+   Copyright (C) 2017 Andris Raugulis (moo@arthepsy.eu)
+
+   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.
+"""
+import binascii
+import os
+import random
+import struct
+
+# pylint: disable=unused-import
+from typing import Dict, List, Set, Sequence, Tuple, Iterable  # noqa: F401
+from typing import Callable, Optional, Union, Any  # noqa: F401
+
+from ssh_audit.protocol import Protocol
+from ssh_audit.ssh_socket import SSH_Socket
+
+
+class KexDH:  # pragma: nocover
+    def __init__(self, kex_name: str, hash_alg: str, g: int, p: int) -> None:
+        self.__kex_name = kex_name  # pylint: disable=unused-private-member
+        self.__hash_alg = hash_alg  # pylint: disable=unused-private-member
+        self.__g = 0
+        self.__p = 0
+        self.__q = 0
+        self.__x = 0
+        self.__e = 0
+        self.set_params(g, p)
+
+        self.__ed25519_pubkey: Optional[bytes] = None  # pylint: disable=unused-private-member
+        self.__hostkey_type: Optional[bytes] = None
+        self.__hostkey_e = 0  # pylint: disable=unused-private-member
+        self.__hostkey_n = 0  # pylint: disable=unused-private-member
+        self.__hostkey_n_len = 0  # Length of the host key modulus.
+        self.__ca_n_len = 0  # Length of the CA key modulus (if hostkey is a cert).
+
+    def set_params(self, g: int, p: int) -> None:
+        self.__g = g
+        self.__p = p
+        self.__q = (self.__p - 1) // 2
+        self.__x = 0
+        self.__e = 0
+
+    def send_init(self, s: SSH_Socket, init_msg: int = Protocol.MSG_KEXDH_INIT) -> None:
+        r = random.SystemRandom()
+        self.__x = r.randrange(2, self.__q)
+        self.__e = pow(self.__g, self.__x, self.__p)
+        s.write_byte(init_msg)
+        s.write_mpint2(self.__e)
+        s.send_packet()
+
+    # Parse a KEXDH_REPLY or KEXDH_GEX_REPLY message from the server.  This
+    # contains the host key, among other things.  Function returns the host
+    # key blob (from which the fingerprint can be calculated).
+    def recv_reply(self, s: 'SSH_Socket', parse_host_key_size: bool = True) -> Optional[bytes]:
+        packet_type, payload = s.read_packet(2)
+
+        # Skip any & all MSG_DEBUG messages.
+        while packet_type == Protocol.MSG_DEBUG:
+            packet_type, payload = s.read_packet(2)
+
+        if packet_type != -1 and packet_type not in [Protocol.MSG_KEXDH_REPLY, Protocol.MSG_KEXDH_GEX_REPLY]:  # pylint: disable=no-else-raise
+            # TODO: change Exception to something more specific.
+            raise Exception('Expected MSG_KEXDH_REPLY (%d) or MSG_KEXDH_GEX_REPLY (%d), but got %d instead.' % (Protocol.MSG_KEXDH_REPLY, Protocol.MSG_KEXDH_GEX_REPLY, packet_type))
+        elif packet_type == -1:
+            # A connection error occurred.  We can't parse anything, so just
+            # return.  The host key modulus (and perhaps certificate modulus)
+            # will remain at length 0.
+            return None
+
+        hostkey_len = 0  # pylint: disable=unused-variable
+        hostkey_type_len = hostkey_e_len = 0  # pylint: disable=unused-variable
+        key_id_len = principles_len = 0  # pylint: disable=unused-variable
+        critical_options_len = extensions_len = 0  # pylint: disable=unused-variable
+        nonce_len = ca_key_len = ca_key_type_len = 0  # pylint: disable=unused-variable
+        ca_key_len = ca_key_type_len = ca_key_e_len = 0  # pylint: disable=unused-variable
+
+        key_id = principles = None  # pylint: disable=unused-variable
+        critical_options = extensions = None  # pylint: disable=unused-variable
+        nonce = ca_key = ca_key_type = None  # pylint: disable=unused-variable
+        ca_key_e = ca_key_n = None  # pylint: disable=unused-variable
+
+        # Get the host key blob, F, and signature.
+        ptr = 0
+        hostkey, hostkey_len, ptr = KexDH.__get_bytes(payload, ptr)
+
+        # If we are not supposed to parse the host key size (i.e.: it is a type that is of fixed size such as ed25519), then stop here.
+        if not parse_host_key_size:
+            return hostkey
+
+        _, _, ptr = KexDH.__get_bytes(payload, ptr)
+        _, _, ptr = KexDH.__get_bytes(payload, ptr)
+
+        # Now pick apart the host key blob.
+        # Get the host key type (i.e.: 'ssh-rsa', 'ssh-ed25519', etc).
+        ptr = 0
+        self.__hostkey_type, hostkey_type_len, ptr = KexDH.__get_bytes(hostkey, ptr)
+
+        # If this is an RSA certificate, skip over the nonce.
+        if self.__hostkey_type.startswith(b'ssh-rsa-cert-v0'):
+            nonce, nonce_len, ptr = KexDH.__get_bytes(hostkey, ptr)
+
+        # The public key exponent.
+        hostkey_e, hostkey_e_len, ptr = KexDH.__get_bytes(hostkey, ptr)
+        self.__hostkey_e = int(binascii.hexlify(hostkey_e), 16)  # pylint: disable=unused-private-member
+
+        # Here is the modulus size & actual modulus of the host key public key.
+        hostkey_n, self.__hostkey_n_len, ptr = KexDH.__get_bytes(hostkey, ptr)
+        self.__hostkey_n = int(binascii.hexlify(hostkey_n), 16)  # pylint: disable=unused-private-member
+
+        # If this is an RSA certificate, continue parsing to extract the CA
+        # key.
+        if self.__hostkey_type.startswith(b'ssh-rsa-cert-v0'):
+            # Skip over the serial number.
+            ptr += 8
+
+            # Get the certificate type.
+            cert_type = int(binascii.hexlify(hostkey[ptr:ptr + 4]), 16)
+            ptr += 4
+
+            # Only SSH2_CERT_TYPE_HOST (2) makes sense in this context.
+            if cert_type == 2:
+
+                # Skip the key ID (this is the serial number of the
+                # certificate).
+                key_id, key_id_len, ptr = KexDH.__get_bytes(hostkey, ptr)
+
+                # The principles, which are... I don't know what.
+                principles, principles_len, ptr = KexDH.__get_bytes(hostkey, ptr)
+
+                # Skip over the timestamp that this certificate is valid after.
+                ptr += 8
+
+                # Skip over the timestamp that this certificate is valid before.
+                ptr += 8
+
+                # TODO: validate the principles, and time range.
+
+                # The critical options.
+                critical_options, critical_options_len, ptr = KexDH.__get_bytes(hostkey, ptr)
+
+                # Certificate extensions.
+                extensions, extensions_len, ptr = KexDH.__get_bytes(hostkey, ptr)
+
+                # Another nonce.
+                nonce, nonce_len, ptr = KexDH.__get_bytes(hostkey, ptr)
+
+                # Finally, we get to the CA key.
+                ca_key, ca_key_len, ptr = KexDH.__get_bytes(hostkey, ptr)
+
+                # Last in the host key blob is the CA signature.  It isn't
+                # interesting to us, so we won't bother parsing any further.
+                # The CA key has the modulus, however...
+                ptr = 0
+
+                # 'ssh-rsa', 'rsa-sha2-256', etc.
+                ca_key_type, ca_key_type_len, ptr = KexDH.__get_bytes(ca_key, ptr)
+
+                # CA's public key exponent.
+                ca_key_e, ca_key_e_len, ptr = KexDH.__get_bytes(ca_key, ptr)
+
+                # CA's modulus.  Bingo.
+                ca_key_n, self.__ca_n_len, ptr = KexDH.__get_bytes(ca_key, ptr)
+
+        return hostkey
+
+    @staticmethod
+    def __get_bytes(buf: bytes, ptr: int) -> Tuple[bytes, int, int]:
+        num_bytes = struct.unpack('>I', buf[ptr:ptr + 4])[0]
+        ptr += 4
+        return buf[ptr:ptr + num_bytes], num_bytes, ptr + num_bytes
+
+    # Converts a modulus length in bytes to its size in bits, after some
+    # possible adjustments.
+    @staticmethod
+    def __adjust_key_size(size: int) -> int:
+        size = size * 8
+        # Actual keys are observed to be about 8 bits bigger than expected
+        # (i.e.: 1024-bit keys have a 1032-bit modulus).  Check if this is
+        # the case, and subtract 8 if so.  This simply improves readability
+        # in the UI.
+        if (size >> 3) % 2 != 0:
+            size = size - 8
+        return size
+
+    # Returns the size of the hostkey, in bits.
+    def get_hostkey_size(self) -> int:
+        return KexDH.__adjust_key_size(self.__hostkey_n_len)
+
+    # Returns the size of the CA key, in bits.
+    def get_ca_size(self) -> int:
+        return KexDH.__adjust_key_size(self.__ca_n_len)
+
+    # Returns the size of the DH modulus, in bits.
+    def get_dh_modulus_size(self) -> int:
+        # -2 to account for the '0b' prefix in the string.
+        return len(bin(self.__p)) - 2
+
+
+class KexGroup1(KexDH):  # pragma: nocover
+    def __init__(self) -> None:
+        # rfc2409: second oakley group
+        p = int('ffffffffffffffffc90fdaa22168c234c4c6628b80dc1cd129024e088a67cc74020bbea63b139b22514a08798e3404ddef9519b3cd3a431b302b0a6df25f14374fe1356d6d51c245e485b576625e7ec6f44c42e9a637ed6b0bff5cb6f406b7edee386bfb5a899fa5ae9f24117c4b1fe649286651ece65381ffffffffffffffff', 16)
+        super(KexGroup1, self).__init__('KexGroup1', 'sha1', 2, p)
+
+
+class KexGroup14(KexDH):  # pragma: nocover
+    def __init__(self, hash_alg: str) -> None:
+        # rfc3526: 2048-bit modp group
+        p = int('ffffffffffffffffc90fdaa22168c234c4c6628b80dc1cd129024e088a67cc74020bbea63b139b22514a08798e3404ddef9519b3cd3a431b302b0a6df25f14374fe1356d6d51c245e485b576625e7ec6f44c42e9a637ed6b0bff5cb6f406b7edee386bfb5a899fa5ae9f24117c4b1fe649286651ece45b3dc2007cb8a163bf0598da48361c55d39a69163fa8fd24cf5f83655d23dca3ad961c62f356208552bb9ed529077096966d670c354e4abc9804f1746c08ca18217c32905e462e36ce3be39e772c180e86039b2783a2ec07a28fb5c55df06f4c52c9de2bcbf6955817183995497cea956ae515d2261898fa051015728e5a8aacaa68ffffffffffffffff', 16)
+        super(KexGroup14, self).__init__('KexGroup14', hash_alg, 2, p)
+
+
+class KexGroup14_SHA1(KexGroup14):
+    def __init__(self) -> None:
+        super(KexGroup14_SHA1, self).__init__('sha1')
+
+
+class KexGroup14_SHA256(KexGroup14):
+    def __init__(self) -> None:
+        super(KexGroup14_SHA256, self).__init__('sha256')
+
+
+class KexGroup16_SHA512(KexDH):
+    def __init__(self) -> None:
+        # rfc3526: 4096-bit modp group
+        p = int('ffffffffffffffffc90fdaa22168c234c4c6628b80dc1cd129024e088a67cc74020bbea63b139b22514a08798e3404ddef9519b3cd3a431b302b0a6df25f14374fe1356d6d51c245e485b576625e7ec6f44c42e9a637ed6b0bff5cb6f406b7edee386bfb5a899fa5ae9f24117c4b1fe649286651ece45b3dc2007cb8a163bf0598da48361c55d39a69163fa8fd24cf5f83655d23dca3ad961c62f356208552bb9ed529077096966d670c354e4abc9804f1746c08ca18217c32905e462e36ce3be39e772c180e86039b2783a2ec07a28fb5c55df06f4c52c9de2bcbf6955817183995497cea956ae515d2261898fa051015728e5a8aaac42dad33170d04507a33a85521abdf1cba64ecfb850458dbef0a8aea71575d060c7db3970f85a6e1e4c7abf5ae8cdb0933d71e8c94e04a25619dcee3d2261ad2ee6bf12ffa06d98a0864d87602733ec86a64521f2b18177b200cbbe117577a615d6c770988c0bad946e208e24fa074e5ab3143db5bfce0fd108e4b82d120a92108011a723c12a787e6d788719a10bdba5b2699c327186af4e23c1a946834b6150bda2583e9ca2ad44ce8dbbbc2db04de8ef92e8efc141fbecaa6287c59474e6bc05d99b2964fa090c3a2233ba186515be7ed1f612970cee2d7afb81bdd762170481cd0069127d5b05aa993b4ea988d8fddc186ffb7dc90a6c08f4df435c934063199ffffffffffffffff', 16)
+        super(KexGroup16_SHA512, self).__init__('KexGroup16_SHA512', 'sha512', 2, p)
+
+
+class KexGroup18_SHA512(KexDH):
+    def __init__(self) -> None:
+        # rfc3526: 8192-bit modp group
+        p = int('ffffffffffffffffc90fdaa22168c234c4c6628b80dc1cd129024e088a67cc74020bbea63b139b22514a08798e3404ddef9519b3cd3a431b302b0a6df25f14374fe1356d6d51c245e485b576625e7ec6f44c42e9a637ed6b0bff5cb6f406b7edee386bfb5a899fa5ae9f24117c4b1fe649286651ece45b3dc2007cb8a163bf0598da48361c55d39a69163fa8fd24cf5f83655d23dca3ad961c62f356208552bb9ed529077096966d670c354e4abc9804f1746c08ca18217c32905e462e36ce3be39e772c180e86039b2783a2ec07a28fb5c55df06f4c52c9de2bcbf6955817183995497cea956ae515d2261898fa051015728e5a8aaac42dad33170d04507a33a85521abdf1cba64ecfb850458dbef0a8aea71575d060c7db3970f85a6e1e4c7abf5ae8cdb0933d71e8c94e04a25619dcee3d2261ad2ee6bf12ffa06d98a0864d87602733ec86a64521f2b18177b200cbbe117577a615d6c770988c0bad946e208e24fa074e5ab3143db5bfce0fd108e4b82d120a92108011a723c12a787e6d788719a10bdba5b2699c327186af4e23c1a946834b6150bda2583e9ca2ad44ce8dbbbc2db04de8ef92e8efc141fbecaa6287c59474e6bc05d99b2964fa090c3a2233ba186515be7ed1f612970cee2d7afb81bdd762170481cd0069127d5b05aa993b4ea988d8fddc186ffb7dc90a6c08f4df435c93402849236c3fab4d27c7026c1d4dcb2602646dec9751e763dba37bdf8ff9406ad9e530ee5db382f413001aeb06a53ed9027d831179727b0865a8918da3edbebcf9b14ed44ce6cbaced4bb1bdb7f1447e6cc254b332051512bd7af426fb8f401378cd2bf5983ca01c64b92ecf032ea15d1721d03f482d7ce6e74fef6d55e702f46980c82b5a84031900b1c9e59e7c97fbec7e8f323a97a7e36cc88be0f1d45b7ff585ac54bd407b22b4154aacc8f6d7ebf48e1d814cc5ed20f8037e0a79715eef29be32806a1d58bb7c5da76f550aa3d8a1fbff0eb19ccb1a313d55cda56c9ec2ef29632387fe8d76e3c0468043e8f663f4860ee12bf2d5b0b7474d6e694f91e6dbe115974a3926f12fee5e438777cb6a932df8cd8bec4d073b931ba3bc832b68d9dd300741fa7bf8afc47ed2576f6936ba424663aab639c5ae4f5683423b4742bf1c978238f16cbe39d652de3fdb8befc848ad922222e04a4037c0713eb57a81a23f0c73473fc646cea306b4bcbc8862f8385ddfa9d4b7fa2c087e879683303ed5bdd3a062b3cf5b3a278a66d2a13f83f44f82ddf310ee074ab6a364597e899a0255dc164f31cc50846851df9ab48195ded7ea1b1d510bd7ee74d73faf36bc31ecfa268359046f4eb879f924009438b481c6cd7889a002ed5ee382bc9190da6fc026e479558e4475677e9aa9e3050e2765694dfc81f56e880b96e7160c980dd98edd3dfffffffffffffffff', 16)
+        super(KexGroup18_SHA512, self).__init__('KexGroup18_SHA512', 'sha512', 2, p)
+
+
+class KexCurve25519_SHA256(KexDH):
+    def __init__(self) -> None:
+        super(KexCurve25519_SHA256, self).__init__('KexCurve25519_SHA256', 'sha256', 0, 0)
+
+    # To start an ED25519 kex, we simply send a random 256-bit number as the
+    # public key.
+    def send_init(self, s: 'SSH_Socket', init_msg: int = Protocol.MSG_KEXDH_INIT) -> None:
+        self.__ed25519_pubkey = os.urandom(32)
+        s.write_byte(init_msg)
+        s.write_string(self.__ed25519_pubkey)
+        s.send_packet()
+
+
+class KexNISTP256(KexDH):
+    def __init__(self) -> None:
+        super(KexNISTP256, self).__init__('KexNISTP256', 'sha256', 0, 0)
+
+    # Because the server checks that the value sent here is valid (i.e.: it lies
+    # on the curve, among other things), we would have to write a lot of code
+    # or import an elliptic curve library in order to randomly generate a
+    # valid elliptic point each time.  Hence, we will simply send a static
+    # value, which is enough for us to extract the server's host key.
+    def send_init(self, s: 'SSH_Socket', init_msg: int = Protocol.MSG_KEXDH_INIT) -> None:
+        s.write_byte(init_msg)
+        s.write_string(b'\x04\x0b\x60\x44\x9f\x8a\x11\x9e\xc7\x81\x0c\xa9\x98\xfc\xb7\x90\xaa\x6b\x26\x8c\x12\x4a\xc0\x09\xbb\xdf\xc4\x2c\x4c\x2c\x99\xb6\xe1\x71\xa0\xd4\xb3\x62\x47\x74\xb3\x39\x0c\xf2\x88\x4a\x84\x6b\x3b\x15\x77\xa5\x77\xd2\xa9\xc9\x94\xf9\xd5\x66\x19\xcd\x02\x34\xd1')
+        s.send_packet()
+
+
+class KexNISTP384(KexDH):
+    def __init__(self) -> None:
+        super(KexNISTP384, self).__init__('KexNISTP384', 'sha256', 0, 0)
+
+    # See comment for KexNISTP256.send_init().
+    def send_init(self, s: 'SSH_Socket', init_msg: int = Protocol.MSG_KEXDH_INIT) -> None:
+        s.write_byte(init_msg)
+        s.write_string(b'\x04\xe2\x9b\x84\xce\xa1\x39\x50\xfe\x1e\xa3\x18\x70\x1c\xe2\x7a\xe4\xb5\x6f\xdf\x93\x9f\xd4\xf4\x08\xcc\x9b\x02\x10\xa4\xca\x77\x9c\x2e\x51\x44\x1d\x50\x7a\x65\x4e\x7e\x2f\x10\x2d\x2d\x4a\x32\xc9\x8e\x18\x75\x90\x6c\x19\x10\xda\xcc\xa8\xe9\xf4\xc4\x3a\x53\x80\x35\xf4\x97\x9c\x04\x16\xf9\x5a\xdc\xcc\x05\x94\x29\xfa\xc4\xd6\x87\x4e\x13\x21\xdb\x3d\x12\xac\xbd\x20\x3b\x60\xff\xe6\x58\x42')
+        s.send_packet()
+
+
+class KexNISTP521(KexDH):
+    def __init__(self) -> None:
+        super(KexNISTP521, self).__init__('KexNISTP521', 'sha256', 0, 0)
+
+    # See comment for KexNISTP256.send_init().
+    def send_init(self, s: 'SSH_Socket', init_msg: int = Protocol.MSG_KEXDH_INIT) -> None:
+        s.write_byte(init_msg)
+        s.write_string(b'\x04\x01\x02\x90\x29\xe9\x8f\xa8\x04\xaf\x1c\x00\xf9\xc6\x29\xc0\x39\x74\x8e\xea\x47\x7e\x7c\xf7\x15\x6e\x43\x3b\x59\x13\x53\x43\xb0\xae\x0b\xe7\xe6\x7c\x55\x73\x52\xa5\x2a\xc1\x42\xde\xfc\xf4\x1f\x8b\x5a\x8d\xfa\xcd\x0a\x65\x77\xa8\xce\x68\xd2\xc6\x26\xb5\x3f\xee\x4b\x01\x7b\xd2\x96\x23\x69\x53\xc7\x01\xe1\x0d\x39\xe9\x87\x49\x3b\xc8\xec\xda\x0c\xf9\xca\xad\x89\x42\x36\x6f\x93\x78\x78\x31\x55\x51\x09\x51\xc0\x96\xd7\xea\x61\xbf\xc2\x44\x08\x80\x43\xed\xc6\xbb\xfb\x94\xbd\xf8\xdf\x2b\xd8\x0b\x2e\x29\x1b\x8c\xc4\x8a\x04\x2d\x3a')
+        s.send_packet()
+
+
+class KexGroupExchange(KexDH):
+    def __init__(self, classname: str, hash_alg: str) -> None:
+        super(KexGroupExchange, self).__init__(classname, hash_alg, 0, 0)
+
+    def send_init(self, s: 'SSH_Socket', init_msg: int = Protocol.MSG_KEXDH_GEX_REQUEST) -> None:
+        self.send_init_gex(s)
+
+    # The group exchange starts with sending a message to the server with
+    # the minimum, maximum, and preferred number of bits are for the DH group.
+    # The server responds with a generator and prime modulus that matches that,
+    # then the handshake continues on like a normal DH handshake (except the
+    # SSH message types differ).
+    def send_init_gex(self, s: 'SSH_Socket', minbits: int = 1024, prefbits: int = 2048, maxbits: int = 8192) -> None:
+
+        # Send the initial group exchange request.  Tell the server what range
+        # of modulus sizes we will accept, along with our preference.
+        s.write_byte(Protocol.MSG_KEXDH_GEX_REQUEST)
+        s.write_int(minbits)
+        s.write_int(prefbits)
+        s.write_int(maxbits)
+        s.send_packet()
+
+        packet_type, payload = s.read_packet(2)
+        if packet_type not in [Protocol.MSG_KEXDH_GEX_GROUP, Protocol.MSG_DEBUG]:
+            # TODO: replace with a better exception type.
+            raise Exception('Expected MSG_KEXDH_GEX_REPLY (%d), but got %d instead.' % (Protocol.MSG_KEXDH_GEX_REPLY, packet_type))
+
+        # Skip any & all MSG_DEBUG messages.
+        while packet_type == Protocol.MSG_DEBUG:
+            packet_type, payload = s.read_packet(2)
+
+        # Parse the modulus (p) and generator (g) values from the server.
+        ptr = 0
+        p_len = struct.unpack('>I', payload[ptr:ptr + 4])[0]
+        ptr += 4
+
+        p = int(binascii.hexlify(payload[ptr:ptr + p_len]), 16)
+        ptr += p_len
+
+        g_len = struct.unpack('>I', payload[ptr:ptr + 4])[0]
+        ptr += 4
+
+        g = int(binascii.hexlify(payload[ptr:ptr + g_len]), 16)
+        ptr += g_len
+
+        # Now that we got the generator and modulus, perform the DH exchange
+        # like usual.
+        super(KexGroupExchange, self).set_params(g, p)
+        super(KexGroupExchange, self).send_init(s, Protocol.MSG_KEXDH_GEX_INIT)
+
+
+class KexGroupExchange_SHA1(KexGroupExchange):
+    def __init__(self) -> None:
+        super(KexGroupExchange_SHA1, self).__init__('KexGroupExchange_SHA1', 'sha1')
+
+
+class KexGroupExchange_SHA256(KexGroupExchange):
+    def __init__(self) -> None:
+        super(KexGroupExchange_SHA256, self).__init__('KexGroupExchange_SHA256', 'sha256')

src/ssh_audit/outputbuffer.py

@@ -0,0 +1,185 @@
+"""
+   The MIT License (MIT)
+
+   Copyright (C) 2021 Joe Testa (jtesta@positronsecurity.com)
+   Copyright (C) 2017 Andris Raugulis (moo@arthepsy.eu)
+
+   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.
+"""
+import os
+import sys
+
+# pylint: disable=unused-import
+from typing import Dict, List, Set, Sequence, Tuple, Iterable  # noqa: F401
+from typing import Callable, Optional, Union, Any  # noqa: F401
+
+from ssh_audit.utils import Utils
+
+
+class OutputBuffer:
+    LEVELS: Sequence[str] = ('info', 'warn', 'fail')
+    COLORS = {'head': 36, 'good': 32, 'warn': 33, 'fail': 31}
+
+    # Use brighter colors on Windows for better readability.
+    if Utils.is_windows():
+        COLORS = {'head': 96, 'good': 92, 'warn': 93, 'fail': 91}
+
+    def __init__(self, buffer_output: bool = True) -> None:
+        self.buffer_output = buffer_output
+        self.buffer: List[str] = []
+        self.in_section = False
+        self.section: List[str] = []
+        self.batch = False
+        self.verbose = False
+        self.debug = False
+        self.use_colors = True
+        self.json = False
+        self.__level = 0
+        self.__is_color_supported = ('colorama' in sys.modules) or (os.name == 'posix')
+        self.line_ended = True
+
+    def _print(self, level: str, s: str = '', line_ended: bool = True) -> None:
+        '''Saves output to buffer (if in buffered mode), or immediately prints to stdout otherwise.'''
+
+        # If we're logging only 'warn' or above, and this is an 'info', ignore message.
+        if self.get_level(level) < self.__level:
+            return
+
+        if self.use_colors and self.colors_supported and len(s) > 0 and level != 'info':
+            s = "\033[0;%dm%s\033[0m" % (self.COLORS[level], s)
+
+        if self.buffer_output:
+            # Select which list to add to.  If we are in a 'with' statement, then this goes in the section buffer, otherwise the general buffer.
+            buf = self.section if self.in_section else self.buffer
+
+            # Determine if a new line should be added, or if the last line should be appended.
+            if not self.line_ended:
+                last_entry = -1 if len(buf) > 0 else 0
+                buf[last_entry] = buf[last_entry] + s
+            else:
+                buf.append(s)
+
+            # When False, this tells the next call to append to the last line we just added.
+            self.line_ended = line_ended
+        else:
+            print(s)
+
+    def get_buffer(self) -> str:
+        '''Returns all buffered output, then clears the buffer.'''
+        self.flush_section()
+
+        buffer_str = "\n".join(self.buffer)
+        self.buffer = []
+        return buffer_str
+
+    def write(self) -> None:
+        '''Writes the output to stdout.'''
+        self.flush_section()
+        print(self.get_buffer(), flush=True)
+
+    def reset(self) -> None:
+        self.flush_section()
+        self.get_buffer()
+
+    @property
+    def level(self) -> str:
+        '''Returns the minimum level for output.'''
+        if self.__level < len(self.LEVELS):
+            return self.LEVELS[self.__level]
+        return 'unknown'
+
+    @level.setter
+    def level(self, name: str) -> None:
+        '''Sets the minimum level for output (one of: 'info', 'warn', 'fail').'''
+        self.__level = self.get_level(name)
+
+    def get_level(self, name: str) -> int:
+        cname = 'info' if name == 'good' else name
+        if cname not in self.LEVELS:
+            return sys.maxsize
+        return self.LEVELS.index(cname)
+
+    @property
+    def colors_supported(self) -> bool:
+        '''Returns True if the system supports color output.'''
+        return self.__is_color_supported
+
+    # When used in a 'with' block, the output to goes into a section; this can be sorted separately when add_section_to_buffer() is later called.
+    def __enter__(self) -> 'OutputBuffer':
+        self.in_section = True
+        return self
+
+    def __exit__(self, *args: Any) -> None:
+        self.in_section = False
+
+    def flush_section(self, sort_section: bool = False) -> None:
+        '''Appends section output (optionally sorting it first) to the end of the buffer, then clears the section output.'''
+        if sort_section:
+            self.section.sort()
+
+        self.buffer.extend(self.section)
+        self.section = []
+
+    def is_section_empty(self) -> bool:
+        '''Returns True if the section buffer is empty, otherwise False.'''
+        return len(self.section) == 0
+
+    def head(self, s: str, line_ended: bool = True) -> 'OutputBuffer':
+        if not self.batch:
+            self._print('head', s, line_ended)
+        return self
+
+    def fail(self, s: str, line_ended: bool = True) -> 'OutputBuffer':
+        self._print('fail', s, line_ended)
+        return self
+
+    def warn(self, s: str, line_ended: bool = True) -> 'OutputBuffer':
+        self._print('warn', s, line_ended)
+        return self
+
+    def info(self, s: str, line_ended: bool = True) -> 'OutputBuffer':
+        self._print('info', s, line_ended)
+        return self
+
+    def good(self, s: str, line_ended: bool = True) -> 'OutputBuffer':
+        self._print('good', s, line_ended)
+        return self
+
+    def sep(self) -> 'OutputBuffer':
+        if not self.batch:
+            self._print('info')
+        return self
+
+    def v(self, s: str, write_now: bool = False) -> 'OutputBuffer':
+        '''Prints a message if verbose output is enabled.'''
+        if self.verbose or self.debug:
+            self.info(s)
+            if write_now:
+                self.write()
+
+        return self
+
+    def d(self, s: str, write_now: bool = False) -> 'OutputBuffer':
+        '''Prints a message if verbose output is enabled.'''
+        if self.debug:
+            self.info(s)
+            if write_now:
+                self.write()
+
+        return self

src/ssh_audit/policy.py

@@ -0,0 +1,521 @@
+"""
+   The MIT License (MIT)
+
+   Copyright (C) 2020-2021 Joe Testa (jtesta@positronsecurity.com)
+
+   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.
+"""
+import sys
+
+from typing import Dict, List, Tuple
+from typing import Optional, Any, Union, cast
+from datetime import date
+
+from ssh_audit import exitcodes
+from ssh_audit.ssh2_kex import SSH2_Kex  # pylint: disable=unused-import
+from ssh_audit.banner import Banner  # pylint: disable=unused-import
+
+
+# Validates policy files and performs policy testing
+class Policy:
+
+    # Each field maps directly to a private member variable of the Policy class.
+    BUILTIN_POLICIES: Dict[str, Dict[str, Union[Optional[str], Optional[List[str]], bool, Dict[str, int]]]] = {
+
+        # Ubuntu Server policies
+
+        'Hardened Ubuntu Server 16.04 LTS (version 1)': {'version': '1', 'banner': None, 'compressions': None, 'host_keys': ['ssh-ed25519'], 'optional_host_keys': ['ssh-ed25519-cert-v01@openssh.com', 'rsa-sha2-256-cert-v01@openssh.com', 'rsa-sha2-512-cert-v01@openssh.com'], 'kex': ['curve25519-sha256@libssh.org', 'diffie-hellman-group-exchange-sha256'], 'ciphers': ['chacha20-poly1305@openssh.com', 'aes256-gcm@openssh.com', 'aes128-gcm@openssh.com', 'aes256-ctr', 'aes192-ctr', 'aes128-ctr'], 'macs': ['hmac-sha2-256-etm@openssh.com', 'hmac-sha2-512-etm@openssh.com', 'umac-128-etm@openssh.com'], 'hostkey_sizes': None, 'cakey_sizes': None, 'dh_modulus_sizes': {'diffie-hellman-group-exchange-sha256': 2048}, 'server_policy': True},
+
+        'Hardened Ubuntu Server 18.04 LTS (version 1)': {'version': '1', 'banner': None, 'compressions': None, 'host_keys': ['ssh-ed25519'], 'optional_host_keys': ['ssh-ed25519-cert-v01@openssh.com', 'rsa-sha2-256-cert-v01@openssh.com', 'rsa-sha2-512-cert-v01@openssh.com'], 'kex': ['curve25519-sha256', 'curve25519-sha256@libssh.org', 'diffie-hellman-group16-sha512', 'diffie-hellman-group18-sha512', 'diffie-hellman-group-exchange-sha256'], 'ciphers': ['chacha20-poly1305@openssh.com', 'aes256-gcm@openssh.com', 'aes128-gcm@openssh.com', 'aes256-ctr', 'aes192-ctr', 'aes128-ctr'], 'macs': ['hmac-sha2-256-etm@openssh.com', 'hmac-sha2-512-etm@openssh.com', 'umac-128-etm@openssh.com'], 'hostkey_sizes': None, 'cakey_sizes': None, 'dh_modulus_sizes': {'diffie-hellman-group-exchange-sha256': 2048}, 'server_policy': True},
+
+        'Hardened Ubuntu Server 20.04 LTS (version 1)': {'version': '1', 'banner': None, 'compressions': None, 'host_keys': ['rsa-sha2-512', 'rsa-sha2-256', 'ssh-ed25519'], 'optional_host_keys': ['sk-ssh-ed25519@openssh.com', 'ssh-ed25519-cert-v01@openssh.com', 'sk-ssh-ed25519-cert-v01@openssh.com', 'rsa-sha2-256-cert-v01@openssh.com', 'rsa-sha2-512-cert-v01@openssh.com'], 'kex': ['curve25519-sha256', 'curve25519-sha256@libssh.org', 'diffie-hellman-group16-sha512', 'diffie-hellman-group18-sha512', 'diffie-hellman-group-exchange-sha256'], 'ciphers': ['chacha20-poly1305@openssh.com', 'aes256-gcm@openssh.com', 'aes128-gcm@openssh.com', 'aes256-ctr', 'aes192-ctr', 'aes128-ctr'], 'macs': ['hmac-sha2-256-etm@openssh.com', 'hmac-sha2-512-etm@openssh.com', 'umac-128-etm@openssh.com'], 'hostkey_sizes': {'rsa-sha2-256': 4096, 'rsa-sha2-512': 4096}, 'cakey_sizes': {'rsa-sha2-256-cert-v01@openssh.com': 4096, 'rsa-sha2-512-cert-v01@openssh.com': 4096}, 'dh_modulus_sizes': {'diffie-hellman-group-exchange-sha256': 2048}, 'server_policy': True},
+
+
+        # Generic OpenSSH Server policies
+
+        'Hardened OpenSSH Server v7.7 (version 1)': {'version': '1', 'banner': None, 'compressions': None, 'host_keys': ['rsa-sha2-512', 'rsa-sha2-256', 'ssh-ed25519'], 'optional_host_keys': ['ssh-ed25519-cert-v01@openssh.com', 'rsa-sha2-256-cert-v01@openssh.com', 'rsa-sha2-512-cert-v01@openssh.com'], 'kex': ['curve25519-sha256', 'curve25519-sha256@libssh.org', 'diffie-hellman-group16-sha512', 'diffie-hellman-group18-sha512', 'diffie-hellman-group-exchange-sha256'], 'ciphers': ['chacha20-poly1305@openssh.com', 'aes256-gcm@openssh.com', 'aes128-gcm@openssh.com', 'aes256-ctr', 'aes192-ctr', 'aes128-ctr'], 'macs': ['hmac-sha2-256-etm@openssh.com', 'hmac-sha2-512-etm@openssh.com', 'umac-128-etm@openssh.com'], 'hostkey_sizes': None, 'cakey_sizes': None, 'dh_modulus_sizes': {'diffie-hellman-group-exchange-sha256': 2048}, 'server_policy': True},
+
+        'Hardened OpenSSH Server v7.8 (version 1)': {'version': '1', 'banner': None, 'compressions': None, 'host_keys': ['rsa-sha2-512', 'rsa-sha2-256', 'ssh-ed25519'], 'optional_host_keys': ['ssh-ed25519-cert-v01@openssh.com', 'rsa-sha2-256-cert-v01@openssh.com', 'rsa-sha2-512-cert-v01@openssh.com'], 'kex': ['curve25519-sha256', 'curve25519-sha256@libssh.org', 'diffie-hellman-group16-sha512', 'diffie-hellman-group18-sha512', 'diffie-hellman-group-exchange-sha256'], 'ciphers': ['chacha20-poly1305@openssh.com', 'aes256-gcm@openssh.com', 'aes128-gcm@openssh.com', 'aes256-ctr', 'aes192-ctr', 'aes128-ctr'], 'macs': ['hmac-sha2-256-etm@openssh.com', 'hmac-sha2-512-etm@openssh.com', 'umac-128-etm@openssh.com'], 'hostkey_sizes': None, 'cakey_sizes': None, 'dh_modulus_sizes': {'diffie-hellman-group-exchange-sha256': 2048}, 'server_policy': True},
+
+        'Hardened OpenSSH Server v7.9 (version 1)': {'version': '1', 'banner': None, 'compressions': None, 'host_keys': ['rsa-sha2-512', 'rsa-sha2-256', 'ssh-ed25519'], 'optional_host_keys': ['ssh-ed25519-cert-v01@openssh.com', 'rsa-sha2-256-cert-v01@openssh.com', 'rsa-sha2-512-cert-v01@openssh.com'], 'kex': ['curve25519-sha256', 'curve25519-sha256@libssh.org', 'diffie-hellman-group16-sha512', 'diffie-hellman-group18-sha512', 'diffie-hellman-group-exchange-sha256'], 'ciphers': ['chacha20-poly1305@openssh.com', 'aes256-gcm@openssh.com', 'aes128-gcm@openssh.com', 'aes256-ctr', 'aes192-ctr', 'aes128-ctr'], 'macs': ['hmac-sha2-256-etm@openssh.com', 'hmac-sha2-512-etm@openssh.com', 'umac-128-etm@openssh.com'], 'hostkey_sizes': None, 'cakey_sizes': None, 'dh_modulus_sizes': {'diffie-hellman-group-exchange-sha256': 2048}, 'server_policy': True},
+
+        'Hardened OpenSSH Server v8.0 (version 1)': {'version': '1', 'banner': None, 'compressions': None, 'host_keys': ['rsa-sha2-512', 'rsa-sha2-256', 'ssh-ed25519'], 'optional_host_keys': ['ssh-ed25519-cert-v01@openssh.com', 'rsa-sha2-256-cert-v01@openssh.com', 'rsa-sha2-512-cert-v01@openssh.com'], 'kex': ['curve25519-sha256', 'curve25519-sha256@libssh.org', 'diffie-hellman-group16-sha512', 'diffie-hellman-group18-sha512', 'diffie-hellman-group-exchange-sha256'], 'ciphers': ['chacha20-poly1305@openssh.com', 'aes256-gcm@openssh.com', 'aes128-gcm@openssh.com', 'aes256-ctr', 'aes192-ctr', 'aes128-ctr'], 'macs': ['hmac-sha2-256-etm@openssh.com', 'hmac-sha2-512-etm@openssh.com', 'umac-128-etm@openssh.com'], 'hostkey_sizes': None, 'cakey_sizes': None, 'dh_modulus_sizes': {'diffie-hellman-group-exchange-sha256': 2048}, 'server_policy': True},
+
+        'Hardened OpenSSH Server v8.1 (version 1)': {'version': '1', 'banner': None, 'compressions': None, 'host_keys': ['rsa-sha2-512', 'rsa-sha2-256', 'ssh-ed25519'], 'optional_host_keys': ['sk-ssh-ed25519@openssh.com', 'ssh-ed25519-cert-v01@openssh.com', 'sk-ssh-ed25519-cert-v01@openssh.com', 'rsa-sha2-256-cert-v01@openssh.com', 'rsa-sha2-512-cert-v01@openssh.com'], 'kex': ['curve25519-sha256', 'curve25519-sha256@libssh.org', 'diffie-hellman-group16-sha512', 'diffie-hellman-group18-sha512', 'diffie-hellman-group-exchange-sha256'], 'ciphers': ['chacha20-poly1305@openssh.com', 'aes256-gcm@openssh.com', 'aes128-gcm@openssh.com', 'aes256-ctr', 'aes192-ctr', 'aes128-ctr'], 'macs': ['hmac-sha2-256-etm@openssh.com', 'hmac-sha2-512-etm@openssh.com', 'umac-128-etm@openssh.com'], 'hostkey_sizes': None, 'cakey_sizes': None, 'dh_modulus_sizes': {'diffie-hellman-group-exchange-sha256': 2048}, 'server_policy': True},
+
+        'Hardened OpenSSH Server v8.2 (version 1)': {'version': '1', 'banner': None, 'compressions': None, 'host_keys': ['rsa-sha2-512', 'rsa-sha2-256', 'ssh-ed25519'], 'optional_host_keys': ['sk-ssh-ed25519@openssh.com', 'ssh-ed25519-cert-v01@openssh.com', 'sk-ssh-ed25519-cert-v01@openssh.com', 'rsa-sha2-256-cert-v01@openssh.com', 'rsa-sha2-512-cert-v01@openssh.com'], 'kex': ['curve25519-sha256', 'curve25519-sha256@libssh.org', 'diffie-hellman-group16-sha512', 'diffie-hellman-group18-sha512', 'diffie-hellman-group-exchange-sha256'], 'ciphers': ['chacha20-poly1305@openssh.com', 'aes256-gcm@openssh.com', 'aes128-gcm@openssh.com', 'aes256-ctr', 'aes192-ctr', 'aes128-ctr'], 'macs': ['hmac-sha2-256-etm@openssh.com', 'hmac-sha2-512-etm@openssh.com', 'umac-128-etm@openssh.com'], 'hostkey_sizes': {'rsa-sha2-256': 4096, 'rsa-sha2-512': 4096}, 'cakey_sizes': {'rsa-sha2-256-cert-v01@openssh.com': 4096, 'rsa-sha2-512-cert-v01@openssh.com': 4096}, 'dh_modulus_sizes': {'diffie-hellman-group-exchange-sha256': 2048}, 'server_policy': True},
+
+        'Hardened OpenSSH Server v8.3 (version 1)': {'version': '1', 'banner': None, 'compressions': None, 'host_keys': ['rsa-sha2-512', 'rsa-sha2-256', 'ssh-ed25519'], 'optional_host_keys': ['sk-ssh-ed25519@openssh.com', 'ssh-ed25519-cert-v01@openssh.com', 'sk-ssh-ed25519-cert-v01@openssh.com', 'rsa-sha2-256-cert-v01@openssh.com', 'rsa-sha2-512-cert-v01@openssh.com'], 'kex': ['curve25519-sha256', 'curve25519-sha256@libssh.org', 'diffie-hellman-group16-sha512', 'diffie-hellman-group18-sha512', 'diffie-hellman-group-exchange-sha256'], 'ciphers': ['chacha20-poly1305@openssh.com', 'aes256-gcm@openssh.com', 'aes128-gcm@openssh.com', 'aes256-ctr', 'aes192-ctr', 'aes128-ctr'], 'macs': ['hmac-sha2-256-etm@openssh.com', 'hmac-sha2-512-etm@openssh.com', 'umac-128-etm@openssh.com'], 'hostkey_sizes': {'rsa-sha2-256': 4096, 'rsa-sha2-512': 4096}, 'cakey_sizes': {'rsa-sha2-256-cert-v01@openssh.com': 4096, 'rsa-sha2-512-cert-v01@openssh.com': 4096}, 'dh_modulus_sizes': {'diffie-hellman-group-exchange-sha256': 2048}, 'server_policy': True},
+
+        'Hardened OpenSSH Server v8.4 (version 1)': {'version': '1', 'banner': None, 'compressions': None, 'host_keys': ['rsa-sha2-512', 'rsa-sha2-256', 'ssh-ed25519'], 'optional_host_keys': ['sk-ssh-ed25519@openssh.com', 'ssh-ed25519-cert-v01@openssh.com', 'sk-ssh-ed25519-cert-v01@openssh.com', 'rsa-sha2-256-cert-v01@openssh.com', 'rsa-sha2-512-cert-v01@openssh.com'], 'kex': ['curve25519-sha256', 'curve25519-sha256@libssh.org', 'diffie-hellman-group16-sha512', 'diffie-hellman-group18-sha512', 'diffie-hellman-group-exchange-sha256'], 'ciphers': ['chacha20-poly1305@openssh.com', 'aes256-gcm@openssh.com', 'aes128-gcm@openssh.com', 'aes256-ctr', 'aes192-ctr', 'aes128-ctr'], 'macs': ['hmac-sha2-256-etm@openssh.com', 'hmac-sha2-512-etm@openssh.com', 'umac-128-etm@openssh.com'], 'hostkey_sizes': {'rsa-sha2-256': 4096, 'rsa-sha2-512': 4096}, 'cakey_sizes': {'rsa-sha2-256-cert-v01@openssh.com': 4096, 'rsa-sha2-512-cert-v01@openssh.com': 4096}, 'dh_modulus_sizes': {'diffie-hellman-group-exchange-sha256': 2048}, 'server_policy': True},
+
+        'Hardened OpenSSH Server v8.5 (version 1)': {'version': '1', 'banner': None, 'compressions': None, 'host_keys': ['rsa-sha2-512', 'rsa-sha2-256', 'ssh-ed25519'], 'optional_host_keys': ['sk-ssh-ed25519@openssh.com', 'ssh-ed25519-cert-v01@openssh.com', 'sk-ssh-ed25519-cert-v01@openssh.com', 'rsa-sha2-256-cert-v01@openssh.com', 'rsa-sha2-512-cert-v01@openssh.com'], 'kex': ['curve25519-sha256', 'curve25519-sha256@libssh.org', 'diffie-hellman-group16-sha512', 'diffie-hellman-group18-sha512', 'diffie-hellman-group-exchange-sha256'], 'ciphers': ['chacha20-poly1305@openssh.com', 'aes256-gcm@openssh.com', 'aes128-gcm@openssh.com', 'aes256-ctr', 'aes192-ctr', 'aes128-ctr'], 'macs': ['hmac-sha2-256-etm@openssh.com', 'hmac-sha2-512-etm@openssh.com', 'umac-128-etm@openssh.com'], 'hostkey_sizes': {'rsa-sha2-256': 4096, 'rsa-sha2-512': 4096}, 'cakey_sizes': {'rsa-sha2-256-cert-v01@openssh.com': 4096, 'rsa-sha2-512-cert-v01@openssh.com': 4096}, 'dh_modulus_sizes': {'diffie-hellman-group-exchange-sha256': 2048}, 'server_policy': True},
+
+        'Hardened OpenSSH Server v8.6 (version 1)': {'version': '1', 'banner': None, 'compressions': None, 'host_keys': ['rsa-sha2-512', 'rsa-sha2-256', 'ssh-ed25519'], 'optional_host_keys': ['sk-ssh-ed25519@openssh.com', 'ssh-ed25519-cert-v01@openssh.com', 'sk-ssh-ed25519-cert-v01@openssh.com', 'rsa-sha2-256-cert-v01@openssh.com', 'rsa-sha2-512-cert-v01@openssh.com'], 'kex': ['curve25519-sha256', 'curve25519-sha256@libssh.org', 'diffie-hellman-group16-sha512', 'diffie-hellman-group18-sha512', 'diffie-hellman-group-exchange-sha256'], 'ciphers': ['chacha20-poly1305@openssh.com', 'aes256-gcm@openssh.com', 'aes128-gcm@openssh.com', 'aes256-ctr', 'aes192-ctr', 'aes128-ctr'], 'macs': ['hmac-sha2-256-etm@openssh.com', 'hmac-sha2-512-etm@openssh.com', 'umac-128-etm@openssh.com'], 'hostkey_sizes': {'rsa-sha2-256': 4096, 'rsa-sha2-512': 4096}, 'cakey_sizes': {'rsa-sha2-256-cert-v01@openssh.com': 4096, 'rsa-sha2-512-cert-v01@openssh.com': 4096}, 'dh_modulus_sizes': {'diffie-hellman-group-exchange-sha256': 2048}, 'server_policy': True},
+
+        'Hardened OpenSSH Server v8.7 (version 1)': {'version': '1', 'banner': None, 'compressions': None, 'host_keys': ['rsa-sha2-512', 'rsa-sha2-256', 'ssh-ed25519'], 'optional_host_keys': ['sk-ssh-ed25519@openssh.com', 'ssh-ed25519-cert-v01@openssh.com', 'sk-ssh-ed25519-cert-v01@openssh.com', 'rsa-sha2-256-cert-v01@openssh.com', 'rsa-sha2-512-cert-v01@openssh.com'], 'kex': ['curve25519-sha256', 'curve25519-sha256@libssh.org', 'diffie-hellman-group16-sha512', 'diffie-hellman-group18-sha512', 'diffie-hellman-group-exchange-sha256'], 'ciphers': ['chacha20-poly1305@openssh.com', 'aes256-gcm@openssh.com', 'aes128-gcm@openssh.com', 'aes256-ctr', 'aes192-ctr', 'aes128-ctr'], 'macs': ['hmac-sha2-256-etm@openssh.com', 'hmac-sha2-512-etm@openssh.com', 'umac-128-etm@openssh.com'], 'hostkey_sizes': {'rsa-sha2-256': 4096, 'rsa-sha2-512': 4096}, 'cakey_sizes': {'rsa-sha2-256-cert-v01@openssh.com': 4096, 'rsa-sha2-512-cert-v01@openssh.com': 4096}, 'dh_modulus_sizes': {'diffie-hellman-group-exchange-sha256': 2048}, 'server_policy': True},
+
+
+        # Ubuntu Client policies
+
+        'Hardened Ubuntu Client 16.04 LTS (version 2)': {'version': '2', 'banner': None, 'compressions': None, 'host_keys': ['ssh-ed25519', 'ssh-ed25519-cert-v01@openssh.com', 'rsa-sha2-256', 'rsa-sha2-512'], 'optional_host_keys': None, 'kex': ['curve25519-sha256@libssh.org', 'diffie-hellman-group-exchange-sha256', 'ext-info-c'], 'ciphers': ['chacha20-poly1305@openssh.com', 'aes256-gcm@openssh.com', 'aes128-gcm@openssh.com', 'aes256-ctr', 'aes192-ctr', 'aes128-ctr'], 'macs': ['hmac-sha2-256-etm@openssh.com', 'hmac-sha2-512-etm@openssh.com', 'umac-128-etm@openssh.com'], 'hostkey_sizes': None, 'cakey_sizes': None, 'dh_modulus_sizes': None, 'server_policy': False},
+
+        'Hardened Ubuntu Client 18.04 LTS (version 2)': {'version': '2', 'banner': None, 'compressions': None, 'host_keys': ['ssh-ed25519', 'ssh-ed25519-cert-v01@openssh.com', 'rsa-sha2-256', 'rsa-sha2-512'], 'optional_host_keys': None, 'kex': ['curve25519-sha256', 'curve25519-sha256@libssh.org', 'diffie-hellman-group16-sha512', 'diffie-hellman-group18-sha512', 'diffie-hellman-group-exchange-sha256', 'ext-info-c'], 'ciphers': ['chacha20-poly1305@openssh.com', 'aes256-gcm@openssh.com', 'aes128-gcm@openssh.com', 'aes256-ctr', 'aes192-ctr', 'aes128-ctr'], 'macs': ['hmac-sha2-256-etm@openssh.com', 'hmac-sha2-512-etm@openssh.com', 'umac-128-etm@openssh.com'], 'hostkey_sizes': None, 'cakey_sizes': None, 'dh_modulus_sizes': None, 'server_policy': False},
+
+        'Hardened Ubuntu Client 20.04 LTS (version 2)': {'version': '2', 'banner': None, 'compressions': None, 'host_keys': ['ssh-ed25519', 'ssh-ed25519-cert-v01@openssh.com', 'sk-ssh-ed25519@openssh.com', 'sk-ssh-ed25519-cert-v01@openssh.com', 'rsa-sha2-256', 'rsa-sha2-256-cert-v01@openssh.com', 'rsa-sha2-512', 'rsa-sha2-512-cert-v01@openssh.com'], 'optional_host_keys': None, 'kex': ['curve25519-sha256', 'curve25519-sha256@libssh.org', 'diffie-hellman-group16-sha512', 'diffie-hellman-group18-sha512', 'diffie-hellman-group-exchange-sha256', 'ext-info-c'], 'ciphers': ['chacha20-poly1305@openssh.com', 'aes256-gcm@openssh.com', 'aes128-gcm@openssh.com', 'aes256-ctr', 'aes192-ctr', 'aes128-ctr'], 'macs': ['hmac-sha2-256-etm@openssh.com', 'hmac-sha2-512-etm@openssh.com', 'umac-128-etm@openssh.com'], 'hostkey_sizes': None, 'cakey_sizes': None, 'dh_modulus_sizes': None, 'server_policy': False},
+
+    }
+
+
+    def __init__(self, policy_file: Optional[str] = None, policy_data: Optional[str] = None, manual_load: bool = False) -> None:
+        self._name: Optional[str] = None
+        self._version: Optional[str] = None
+        self._banner: Optional[str] = None
+        self._compressions: Optional[List[str]] = None
+        self._host_keys: Optional[List[str]] = None
+        self._optional_host_keys: Optional[List[str]] = None
+        self._kex: Optional[List[str]] = None
+        self._ciphers: Optional[List[str]] = None
+        self._macs: Optional[List[str]] = None
+        self._hostkey_sizes: Optional[Dict[str, int]] = None
+        self._cakey_sizes: Optional[Dict[str, int]] = None
+        self._dh_modulus_sizes: Optional[Dict[str, int]] = None
+        self._server_policy = True
+
+        self._name_and_version: str = ''
+
+        # Ensure that only one mode was specified.
+        num_modes = 0
+        if policy_file is not None:
+            num_modes += 1
+        if policy_data is not None:
+            num_modes += 1
+        if manual_load is True:
+            num_modes += 1
+
+        if num_modes != 1:
+            raise RuntimeError('Exactly one of the following can be specified only: policy_file, policy_data, or manual_load')
+
+        if manual_load:
+            return
+
+        if policy_file is not None:
+            try:
+                with open(policy_file, "r", encoding='utf-8') as f:
+                    policy_data = f.read()
+            except FileNotFoundError:
+                print("Error: policy file not found: %s" % policy_file)
+                sys.exit(exitcodes.UNKNOWN_ERROR)
+
+        lines = []
+        if policy_data is not None:
+            lines = policy_data.split("\n")
+
+        for line in lines:
+            line = line.strip()
+            if (len(line) == 0) or line.startswith('#'):
+                continue
+
+            key = None
+            val = None
+            try:
+                key, val = line.split('=')
+            except ValueError as ve:
+                raise ValueError("could not parse line: %s" % line) from ve
+
+            key = key.strip()
+            val = val.strip()
+
+            if key not in ['name', 'version', 'banner', 'compressions', 'host keys', 'optional host keys', 'key exchanges', 'ciphers', 'macs', 'client policy'] and not key.startswith('hostkey_size_') and not key.startswith('cakey_size_') and not key.startswith('dh_modulus_size_'):
+                raise ValueError("invalid field found in policy: %s" % line)
+
+            if key in ['name', 'banner']:
+
+                # If the banner value is blank, set it to "" so that the code below handles it.
+                if len(val) < 2:
+                    val = "\"\""
+
+                if (val[0] != '"') or (val[-1] != '"'):
+                    raise ValueError('the value for the %s field must be enclosed in quotes: %s' % (key, val))
+
+                # Remove the surrounding quotes, and unescape quotes & newlines.
+                val = val[1:-1]. replace("\\\"", "\"").replace("\\n", "\n")
+
+                if key == 'name':
+                    self._name = val
+                elif key == 'banner':
+                    self._banner = val
+            elif key == 'version':
+                self._version = val
+            elif key in ['compressions', 'host keys', 'optional host keys', 'key exchanges', 'ciphers', 'macs']:
+                try:
+                    algs = val.split(',')
+                except ValueError:
+                    # If the value has no commas, then set the algorithm list to just the value.
+                    algs = [val]
+
+                # Strip whitespace in each algorithm name.
+                algs = [alg.strip() for alg in algs]
+
+                if key == 'compressions':
+                    self._compressions = algs
+                elif key == 'host keys':
+                    self._host_keys = algs
+                elif key == 'optional host keys':
+                    self._optional_host_keys = algs
+                elif key == 'key exchanges':
+                    self._kex = algs
+                elif key == 'ciphers':
+                    self._ciphers = algs
+                elif key == 'macs':
+                    self._macs = algs
+            elif key.startswith('hostkey_size_'):
+                hostkey_type = key[13:]
+                if self._hostkey_sizes is None:
+                    self._hostkey_sizes = {}
+                self._hostkey_sizes[hostkey_type] = int(val)
+            elif key.startswith('cakey_size_'):
+                cakey_type = key[11:]
+                if self._cakey_sizes is None:
+                    self._cakey_sizes = {}
+                self._cakey_sizes[cakey_type] = int(val)
+            elif key.startswith('dh_modulus_size_'):
+                dh_modulus_type = key[16:]
+                if self._dh_modulus_sizes is None:
+                    self._dh_modulus_sizes = {}
+                self._dh_modulus_sizes[dh_modulus_type] = int(val)
+            elif key.startswith('client policy') and val.lower() == 'true':
+                self._server_policy = False
+
+
+        if self._name is None:
+            raise ValueError('The policy does not have a name field.')
+        if self._version is None:
+            raise ValueError('The policy does not have a version field.')
+
+        self._name_and_version = "%s (version %s)" % (self._name, self._version)
+
+
+    @staticmethod
+    def _append_error(errors: List[Any], mismatched_field: str, expected_required: Optional[List[str]], expected_optional: Optional[List[str]], actual: List[str]) -> None:
+        if expected_required is None:
+            expected_required = ['']
+        if expected_optional is None:
+            expected_optional = ['']
+        errors.append({'mismatched_field': mismatched_field, 'expected_required': expected_required, 'expected_optional': expected_optional, 'actual': actual})
+
+
+    @staticmethod
+    def create(source: Optional[str], banner: Optional['Banner'], kex: Optional['SSH2_Kex'], client_audit: bool) -> str:
+        '''Creates a policy based on a server configuration.  Returns a string.'''
+
+        today = date.today().strftime('%Y/%m/%d')
+        compressions = None
+        host_keys = None
+        kex_algs = None
+        ciphers = None
+        macs = None
+        rsa_hostkey_sizes_str = ''
+        rsa_cakey_sizes_str = ''
+        dh_modulus_sizes_str = ''
+        client_policy_str = ''
+
+        if client_audit:
+            client_policy_str = "\n# Set to true to signify this is a policy for clients, not servers.\nclient policy = true\n"
+
+        if kex is not None:
+            if kex.server.compression is not None:
+                compressions = ', '.join(kex.server.compression)
+            if kex.key_algorithms is not None:
+                host_keys = ', '.join(kex.key_algorithms)
+            if kex.kex_algorithms is not None:
+                kex_algs = ', '.join(kex.kex_algorithms)
+            if kex.server.encryption is not None:
+                ciphers = ', '.join(kex.server.encryption)
+            if kex.server.mac is not None:
+                macs = ', '.join(kex.server.mac)
+            if kex.rsa_key_sizes():
+                rsa_key_sizes_dict = kex.rsa_key_sizes()
+                for host_key_type in sorted(rsa_key_sizes_dict):
+                    hostkey_size, cakey_size = rsa_key_sizes_dict[host_key_type]
+
+                    rsa_hostkey_sizes_str = "%shostkey_size_%s = %d\n" % (rsa_hostkey_sizes_str, host_key_type, hostkey_size)
+                    if cakey_size != -1:
+                        rsa_cakey_sizes_str = "%scakey_size_%s = %d\n" % (rsa_cakey_sizes_str, host_key_type, cakey_size)
+
+                if len(rsa_hostkey_sizes_str) > 0:
+                    rsa_hostkey_sizes_str = "\n# RSA host key sizes.\n%s" % rsa_hostkey_sizes_str
+                if len(rsa_cakey_sizes_str) > 0:
+                    rsa_cakey_sizes_str = "\n# RSA CA key sizes.\n%s" % rsa_cakey_sizes_str
+            if kex.dh_modulus_sizes():
+                dh_modulus_sizes_dict = kex.dh_modulus_sizes()
+                for gex_type in sorted(dh_modulus_sizes_dict):
+                    modulus_size, _ = dh_modulus_sizes_dict[gex_type]
+                    dh_modulus_sizes_str = "%sdh_modulus_size_%s = %d\n" % (dh_modulus_sizes_str, gex_type, modulus_size)
+                if len(dh_modulus_sizes_str) > 0:
+                    dh_modulus_sizes_str = "\n# Group exchange DH modulus sizes.\n%s" % dh_modulus_sizes_str
+
+
+        policy_data = '''#
+# Custom policy based on %s (created on %s)
+#
+%s
+# The name of this policy (displayed in the output during scans).  Must be in quotes.
+name = "Custom Policy (based on %s on %s)"
+
+# The version of this policy (displayed in the output during scans).  Not parsed, and may be any value, including strings.
+version = 1
+
+# The banner that must match exactly.  Commented out to ignore banners, since minor variability in the banner is sometimes normal.
+# banner = "%s"
+
+# The compression options that must match exactly (order matters).  Commented out to ignore by default.
+# compressions = %s
+%s%s%s
+# The host key types that must match exactly (order matters).
+host keys = %s
+
+# Host key types that may optionally appear.
+#optional host keys = ssh-ed25519-cert-v01@openssh.com,sk-ssh-ed25519@openssh.com,sk-ssh-ed25519-cert-v01@openssh.com,rsa-sha2-256-cert-v01@openssh.com,rsa-sha2-512-cert-v01@openssh.com
+
+# The key exchange algorithms that must match exactly (order matters).
+key exchanges = %s
+
+# The ciphers that must match exactly (order matters).
+ciphers = %s
+
+# The MACs that must match exactly (order matters).
+macs = %s
+''' % (source, today, client_policy_str, source, today, banner, compressions, rsa_hostkey_sizes_str, rsa_cakey_sizes_str, dh_modulus_sizes_str, host_keys, kex_algs, ciphers, macs)
+
+        return policy_data
+
+
+    def evaluate(self, banner: Optional['Banner'], kex: Optional['SSH2_Kex']) -> Tuple[bool, List[Dict[str, str]], str]:
+        '''Evaluates a server configuration against this policy.  Returns a tuple of a boolean (True if server adheres to policy) and an array of strings that holds error messages.'''
+
+        ret = True
+        errors: List[Any] = []
+
+        banner_str = str(banner)
+        if (self._banner is not None) and (banner_str != self._banner):
+            ret = False
+            self._append_error(errors, 'Banner', [self._banner], None, [banner_str])
+
+        # All subsequent tests require a valid kex, so end here if we don't have one.
+        if kex is None:
+            return ret, errors, self._get_error_str(errors)
+
+        if (self._compressions is not None) and (kex.server.compression != self._compressions):
+            ret = False
+            self._append_error(errors, 'Compression', self._compressions, None, kex.server.compression)
+
+        # If a list of optional host keys was given in the policy, remove any of its entries from the list retrieved from the server.  This allows us to do an exact comparison with the expected list below.
+        pruned_host_keys = kex.key_algorithms
+        if self._optional_host_keys is not None:
+            pruned_host_keys = [x for x in kex.key_algorithms if x not in self._optional_host_keys]
+
+        if (self._host_keys is not None) and (pruned_host_keys != self._host_keys):
+            ret = False
+            self._append_error(errors, 'Host keys', self._host_keys, self._optional_host_keys, kex.key_algorithms)
+
+        if self._hostkey_sizes is not None:
+            hostkey_types = list(self._hostkey_sizes.keys())
+            hostkey_types.sort()  # Sorted to make testing output repeatable.
+            for hostkey_type in hostkey_types:
+                expected_hostkey_size = self._hostkey_sizes[hostkey_type]
+                if hostkey_type in kex.rsa_key_sizes():
+                    actual_hostkey_size, actual_cakey_size = kex.rsa_key_sizes()[hostkey_type]
+                    if actual_hostkey_size != expected_hostkey_size:
+                        ret = False
+                        self._append_error(errors, 'RSA host key (%s) sizes' % hostkey_type, [str(expected_hostkey_size)], None, [str(actual_hostkey_size)])
+
+        if self._cakey_sizes is not None:
+            hostkey_types = list(self._cakey_sizes.keys())
+            hostkey_types.sort()  # Sorted to make testing output repeatable.
+            for hostkey_type in hostkey_types:
+                expected_cakey_size = self._cakey_sizes[hostkey_type]
+                if hostkey_type in kex.rsa_key_sizes():
+                    actual_hostkey_size, actual_cakey_size = kex.rsa_key_sizes()[hostkey_type]
+                    if actual_cakey_size != expected_cakey_size:
+                        ret = False
+                        self._append_error(errors, 'RSA CA key (%s) sizes' % hostkey_type, [str(expected_cakey_size)], None, [str(actual_cakey_size)])
+
+        if kex.kex_algorithms != self._kex:
+            ret = False
+            self._append_error(errors, 'Key exchanges', self._kex, None, kex.kex_algorithms)
+
+        if (self._ciphers is not None) and (kex.server.encryption != self._ciphers):
+            ret = False
+            self._append_error(errors, 'Ciphers', self._ciphers, None, kex.server.encryption)
+
+        if (self._macs is not None) and (kex.server.mac != self._macs):
+            ret = False
+            self._append_error(errors, 'MACs', self._macs, None, kex.server.mac)
+
+        if self._dh_modulus_sizes is not None:
+            dh_modulus_types = list(self._dh_modulus_sizes.keys())
+            dh_modulus_types.sort()  # Sorted to make testing output repeatable.
+            for dh_modulus_type in dh_modulus_types:
+                expected_dh_modulus_size = self._dh_modulus_sizes[dh_modulus_type]
+                if dh_modulus_type in kex.dh_modulus_sizes():
+                    actual_dh_modulus_size, _ = kex.dh_modulus_sizes()[dh_modulus_type]
+                    if expected_dh_modulus_size != actual_dh_modulus_size:
+                        ret = False
+                        self._append_error(errors, 'Group exchange (%s) modulus sizes' % dh_modulus_type, [str(expected_dh_modulus_size)], None, [str(actual_dh_modulus_size)])
+
+        return ret, errors, self._get_error_str(errors)
+
+
+    @staticmethod
+    def _get_error_str(errors: List[Any]) -> str:
+        '''Transforms an error struct to a flat string of error messages.'''
+
+        error_list = []
+        spacer = ''
+        for e in errors:
+            e_str = "  * %s did not match.\n" % e['mismatched_field']
+            if ('expected_optional' in e) and (e['expected_optional'] != ['']):
+                e_str += "    - Expected (required): %s\n    - Expected (optional): %s\n" % (Policy._normalize_error_field(e['expected_required']), Policy._normalize_error_field(e['expected_optional']))
+                spacer = '              '
+            else:
+                e_str += "    - Expected: %s\n" % Policy._normalize_error_field(e['expected_required'])
+                spacer = '   '
+            e_str += "    - Actual:%s%s\n" % (spacer, Policy._normalize_error_field(e['actual']))
+            error_list.append(e_str)
+
+        error_list.sort()  # To ensure repeatable results for testing.
+
+        error_str = ''
+        if len(error_list) > 0:
+            error_str = "\n".join(error_list)
+
+        return error_str
+
+
+    def get_name_and_version(self) -> str:
+        '''Returns a string of this Policy's name and version.'''
+        return self._name_and_version
+
+
+    def is_server_policy(self) -> bool:
+        '''Returns True if this is a server policy, or False if this is a client policy.'''
+        return self._server_policy
+
+
+    @staticmethod
+    def list_builtin_policies() -> Tuple[List[str], List[str]]:
+        '''Returns two lists: a list of names of built-in server policies, and a list of names of built-in client policies, respectively.'''
+        server_policy_names = []
+        client_policy_names = []
+
+        for policy_name, policy in Policy.BUILTIN_POLICIES.items():
+            if policy['server_policy']:
+                server_policy_names.append(policy_name)
+            else:
+                client_policy_names.append(policy_name)
+
+        server_policy_names.sort()
+        client_policy_names.sort()
+        return server_policy_names, client_policy_names
+
+
+    @staticmethod
+    def load_builtin_policy(policy_name: str) -> Optional['Policy']:
+        '''Returns a Policy with the specified built-in policy name loaded, or None if no policy of that name exists.'''
+        p = None
+        if policy_name in Policy.BUILTIN_POLICIES:
+            policy_struct = Policy.BUILTIN_POLICIES[policy_name]
+            p = Policy(manual_load=True)
+            policy_name_without_version = policy_name[0:policy_name.rfind(' (')]
+            p._name = policy_name_without_version  # pylint: disable=protected-access
+            p._version = cast(str, policy_struct['version'])  # pylint: disable=protected-access
+            p._banner = cast(Optional[str], policy_struct['banner'])  # pylint: disable=protected-access
+            p._compressions = cast(Optional[List[str]], policy_struct['compressions'])  # pylint: disable=protected-access
+            p._host_keys = cast(Optional[List[str]], policy_struct['host_keys'])  # pylint: disable=protected-access
+            p._optional_host_keys = cast(Optional[List[str]], policy_struct['optional_host_keys'])  # pylint: disable=protected-access
+            p._kex = cast(Optional[List[str]], policy_struct['kex'])  # pylint: disable=protected-access
+            p._ciphers = cast(Optional[List[str]], policy_struct['ciphers'])  # pylint: disable=protected-access
+            p._macs = cast(Optional[List[str]], policy_struct['macs'])  # pylint: disable=protected-access
+            p._hostkey_sizes = cast(Optional[Dict[str, int]], policy_struct['hostkey_sizes'])  # pylint: disable=protected-access
+            p._cakey_sizes = cast(Optional[Dict[str, int]], policy_struct['cakey_sizes'])  # pylint: disable=protected-access
+            p._dh_modulus_sizes = cast(Optional[Dict[str, int]], policy_struct['dh_modulus_sizes'])  # pylint: disable=protected-access
+            p._server_policy = cast(bool, policy_struct['server_policy'])  # pylint: disable=protected-access
+
+            p._name_and_version = "%s (version %s)" % (p._name, p._version)  # pylint: disable=protected-access
+
+        return p
+
+
+    @staticmethod
+    def _normalize_error_field(field: List[str]) -> Any:
+        '''If field is an array with a string parsable as an integer, return that integer.  Otherwise, return the field joined with commas.'''
+        if len(field) == 1:
+            try:
+                return int(field[0])
+            except ValueError:
+                return field[0]
+        else:
+            return ', '.join(field)
+
+
+    def __str__(self) -> str:
+        undefined = '{undefined}'
+
+        name = undefined
+        version = undefined
+        banner = undefined
+        compressions_str = undefined
+        host_keys_str = undefined
+        optional_host_keys_str = undefined
+        kex_str = undefined
+        ciphers_str = undefined
+        macs_str = undefined
+        hostkey_sizes_str = undefined
+        cakey_sizes_str = undefined
+        dh_modulus_sizes_str = undefined
+
+
+        if self._name is not None:
+            name = '[%s]' % self._name
+        if self._version is not None:
+            version = '[%s]' % self._version
+        if self._banner is not None:
+            banner = '[%s]' % self._banner
+
+        if self._compressions is not None:
+            compressions_str = ', '.join(self._compressions)
+        if self._host_keys is not None:
+            host_keys_str = ', '.join(self._host_keys)
+        if self._optional_host_keys is not None:
+            optional_host_keys_str = ', '.join(self._optional_host_keys)
+        if self._kex is not None:
+            kex_str = ', '.join(self._kex)
+        if self._ciphers is not None:
+            ciphers_str = ', '.join(self._ciphers)
+        if self._macs is not None:
+            macs_str = ', '.join(self._macs)
+        if self._hostkey_sizes is not None:
+            hostkey_sizes_str = str(self._hostkey_sizes)
+        if self._cakey_sizes is not None:
+            cakey_sizes_str = str(self._cakey_sizes)
+        if self._dh_modulus_sizes is not None:
+            dh_modulus_sizes_str = str(self._dh_modulus_sizes)
+
+        return "Name: %s\nVersion: %s\nBanner: %s\nCompressions: %s\nHost Keys: %s\nOptional Host Keys: %s\nKey Exchanges: %s\nCiphers: %s\nMACs: %s\nHost Key Sizes: %s\nCA Key Sizes: %s\nDH Modulus Sizes: %s\nServer Policy: %r" % (name, version, banner, compressions_str, host_keys_str, optional_host_keys_str, kex_str, ciphers_str, macs_str, hostkey_sizes_str, cakey_sizes_str, dh_modulus_sizes_str, self._server_policy)

src/ssh_audit/product.py

@@ -0,0 +1,31 @@
+"""
+   The MIT License (MIT)
+
+   Copyright (C) 2017 Andris Raugulis (moo@arthepsy.eu)
+
+   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.
+"""
+
+
+class Product:  # pylint: disable=too-few-public-methods
+    OpenSSH = 'OpenSSH'
+    DropbearSSH = 'Dropbear SSH'
+    LibSSH = 'libssh'
+    TinySSH = 'TinySSH'
+    PuTTY = 'PuTTY'

src/ssh_audit/protocol.py

@@ -0,0 +1,36 @@
+"""
+   The MIT License (MIT)
+
+   Copyright (C) 2017 Andris Raugulis (moo@arthepsy.eu)
+
+   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.
+"""
+
+
+class Protocol:  # pylint: disable=too-few-public-methods
+    SMSG_PUBLIC_KEY = 2
+    MSG_DEBUG = 4
+    MSG_KEXINIT = 20
+    MSG_NEWKEYS = 21
+    MSG_KEXDH_INIT = 30
+    MSG_KEXDH_REPLY = 31
+    MSG_KEXDH_GEX_REQUEST = 34
+    MSG_KEXDH_GEX_GROUP = 31
+    MSG_KEXDH_GEX_INIT = 32
+    MSG_KEXDH_GEX_REPLY = 33

src/ssh_audit/readbuf.py

@@ -0,0 +1,92 @@
+"""
+   The MIT License (MIT)
+
+   Copyright (C) 2017 Andris Raugulis (moo@arthepsy.eu)
+
+   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.
+"""
+import io
+import struct
+
+# pylint: disable=unused-import
+from typing import Dict, List, Set, Sequence, Tuple, Iterable  # noqa: F401
+from typing import Callable, Optional, Union, Any  # noqa: F401
+
+
+class ReadBuf:
+    def __init__(self, data: Optional[bytes] = None) -> None:
+        super(ReadBuf, self).__init__()
+        self._buf = io.BytesIO(data) if data is not None else io.BytesIO()
+        self._len = len(data) if data is not None else 0
+
+    @property
+    def unread_len(self) -> int:
+        return self._len - self._buf.tell()
+
+    def read(self, size: int) -> bytes:
+        return self._buf.read(size)
+
+    def read_byte(self) -> int:
+        v: int = struct.unpack('B', self.read(1))[0]
+        return v
+
+    def read_bool(self) -> bool:
+        return self.read_byte() != 0
+
+    def read_int(self) -> int:
+        v: int = struct.unpack('>I', self.read(4))[0]
+        return v
+
+    def read_list(self) -> List[str]:
+        list_size = self.read_int()
+        return self.read(list_size).decode('utf-8', 'replace').split(',')
+
+    def read_string(self) -> bytes:
+        n = self.read_int()
+        return self.read(n)
+
+    @classmethod
+    def _parse_mpint(cls, v: bytes, pad: bytes, f: str) -> int:
+        r = 0
+        if len(v) % 4 != 0:
+            v = pad * (4 - (len(v) % 4)) + v
+        for i in range(0, len(v), 4):
+            r = (r << 32) | struct.unpack(f, v[i:i + 4])[0]
+        return r
+
+    def read_mpint1(self) -> int:
+        # NOTE: Data Type Enc @ http://www.snailbook.com/docs/protocol-1.5.txt
+        bits = struct.unpack('>H', self.read(2))[0]
+        n = (bits + 7) // 8
+        return self._parse_mpint(self.read(n), b'\x00', '>I')
+
+    def read_mpint2(self) -> int:
+        # NOTE: Section 5 @ https://www.ietf.org/rfc/rfc4251.txt
+        v = self.read_string()
+        if len(v) == 0:
+            return 0
+        pad, f = (b'\xff', '>i') if ord(v[0:1]) & 0x80 != 0 else (b'\x00', '>I')
+        return self._parse_mpint(v, pad, f)
+
+    def read_line(self) -> str:
+        return self._buf.readline().rstrip().decode('utf-8', 'replace')
+
+    def reset(self) -> None:
+        self._buf = io.BytesIO()
+        self._len = 0

src/ssh_audit/software.py

@@ -0,0 +1,227 @@
+"""
+   The MIT License (MIT)
+
+   Copyright (C) 2017 Andris Raugulis (moo@arthepsy.eu)
+
+   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.
+"""
+import re
+
+# pylint: disable=unused-import
+from typing import Dict, List, Set, Sequence, Tuple, Iterable  # noqa: F401
+from typing import Callable, Optional, Union, Any  # noqa: F401
+
+from ssh_audit.banner import Banner
+from ssh_audit.product import Product
+
+
+class Software:
+    def __init__(self, vendor: Optional[str], product: str, version: str, patch: Optional[str], os_version: Optional[str]) -> None:
+        self.__vendor = vendor
+        self.__product = product
+        self.__version = version
+        self.__patch = patch
+        self.__os = os_version
+
+    @property
+    def vendor(self) -> Optional[str]:
+        return self.__vendor
+
+    @property
+    def product(self) -> str:
+        return self.__product
+
+    @property
+    def version(self) -> str:
+        return self.__version
+
+    @property
+    def patch(self) -> Optional[str]:
+        return self.__patch
+
+    @property
+    def os(self) -> Optional[str]:
+        return self.__os
+
+    def compare_version(self, other: Union[None, 'Software', str]) -> int:
+        # pylint: disable=too-many-branches,too-many-return-statements
+        if other is None:
+            return 1
+        if isinstance(other, Software):
+            other = '{}{}'.format(other.version, other.patch or '')
+        else:
+            other = str(other)
+        mx = re.match(r'^([\d\.]+\d+)(.*)$', other)
+        if mx is not None:
+            oversion, opatch = mx.group(1), mx.group(2).strip()
+        else:
+            oversion, opatch = other, ''
+        if self.version < oversion:
+            return -1
+        elif self.version > oversion:
+            return 1
+        spatch = self.patch or ''
+        if self.product == Product.DropbearSSH:
+            if not re.match(r'^test\d.*$', opatch):
+                opatch = 'z{}'.format(opatch)
+            if not re.match(r'^test\d.*$', spatch):
+                spatch = 'z{}'.format(spatch)
+        elif self.product == Product.OpenSSH:
+            mx1 = re.match(r'^p(\d).*', opatch)
+            mx2 = re.match(r'^p(\d).*', spatch)
+            if not (bool(mx1) and bool(mx2)):
+                if mx1 is not None:
+                    opatch = mx1.group(1)
+                if mx2 is not None:
+                    spatch = mx2.group(1)
+            # OpenBSD version and p1 versions are considered the same.
+            if ((spatch == '') and (opatch == '1')) or ((spatch == '1') and (opatch == '')):
+                return 0
+        if spatch < opatch:
+            return -1
+        elif spatch > opatch:
+            return 1
+        return 0
+
+    def between_versions(self, vfrom: str, vtill: str) -> bool:
+        if bool(vfrom) and self.compare_version(vfrom) < 0:
+            return False
+        if bool(vtill) and self.compare_version(vtill) > 0:
+            return False
+        return True
+
+    def display(self, full: bool = True) -> str:
+        r = '{} '.format(self.vendor) if bool(self.vendor) else ''
+        r += self.product
+        if bool(self.version):
+            r += ' {}'.format(self.version)
+        if full:
+            patch = self.patch or ''
+            if self.product == Product.OpenSSH:
+                mx = re.match(r'^(p\d)(.*)$', patch)
+                if mx is not None:
+                    r += mx.group(1)
+                    patch = mx.group(2).strip()
+            if bool(patch):
+                r += ' ({})'.format(patch)
+            if bool(self.os):
+                r += ' running on {}'.format(self.os)
+        return r
+
+    def __str__(self) -> str:
+        return self.display()
+
+    def __repr__(self) -> str:
+        r = 'vendor={}, '.format(self.vendor) if bool(self.vendor) else ''
+        r += 'product={}'.format(self.product)
+        if bool(self.version):
+            r += ', version={}'.format(self.version)
+        if bool(self.patch):
+            r += ', patch={}'.format(self.patch)
+        if bool(self.os):
+            r += ', os={}'.format(self.os)
+        return '<{}({})>'.format(self.__class__.__name__, r)
+
+    @staticmethod
+    def _fix_patch(patch: str) -> Optional[str]:
+        return re.sub(r'^[-_\.]+', '', patch) or None
+
+    @staticmethod
+    def _fix_date(d: Optional[str]) -> Optional[str]:
+        if d is not None and len(d) == 8:
+            return '{}-{}-{}'.format(d[:4], d[4:6], d[6:8])
+        else:
+            return None
+
+    @classmethod
+    def _extract_os_version(cls, c: Optional[str]) -> Optional[str]:
+        if c is None:
+            return None
+        mx = re.match(r'^NetBSD(?:_Secure_Shell)?(?:[\s-]+(\d{8})(.*))?$', c)
+        if mx is not None:
+            d = cls._fix_date(mx.group(1))
+            return 'NetBSD' if d is None else 'NetBSD ({})'.format(d)
+        mx = re.match(r'^FreeBSD(?:\slocalisations)?[\s-]+(\d{8})(.*)$', c)
+        if not bool(mx):
+            mx = re.match(r'^[^@]+@FreeBSD\.org[\s-]+(\d{8})(.*)$', c)
+        if mx is not None:
+            d = cls._fix_date(mx.group(1))
+            return 'FreeBSD' if d is None else 'FreeBSD ({})'.format(d)
+        w = ['RemotelyAnywhere', 'DesktopAuthority', 'RemoteSupportManager']
+        for win_soft in w:
+            mx = re.match(r'^in ' + win_soft + r' ([\d\.]+\d)$', c)
+            if mx is not None:
+                ver = mx.group(1)
+                return 'Microsoft Windows ({} {})'.format(win_soft, ver)
+        generic = ['NetBSD', 'FreeBSD']
+        for g in generic:
+            if c.startswith(g) or c.endswith(g):
+                return g
+        return None
+
+    @classmethod
+    def parse(cls, banner: 'Banner') -> Optional['Software']:
+        # pylint: disable=too-many-return-statements
+        software = str(banner.software)
+        mx = re.match(r'^dropbear_([\d\.]+\d+)(.*)', software)
+        v: Optional[str] = None
+        if mx is not None:
+            patch = cls._fix_patch(mx.group(2))
+            v, p = 'Matt Johnston', Product.DropbearSSH
+            v = None
+            return cls(v, p, mx.group(1), patch, None)
+        mx = re.match(r'^OpenSSH[_\.-]+([\d\.]+\d+)(.*)', software)
+        if mx is not None:
+            patch = cls._fix_patch(mx.group(2))
+            v, p = 'OpenBSD', Product.OpenSSH
+            v = None
+            os_version = cls._extract_os_version(banner.comments)
+            return cls(v, p, mx.group(1), patch, os_version)
+        mx = re.match(r'^libssh-([\d\.]+\d+)(.*)', software)
+        if mx is not None:
+            patch = cls._fix_patch(mx.group(2))
+            v, p = None, Product.LibSSH
+            os_version = cls._extract_os_version(banner.comments)
+            return cls(v, p, mx.group(1), patch, os_version)
+        mx = re.match(r'^libssh_([\d\.]+\d+)(.*)', software)
+        if mx is not None:
+            patch = cls._fix_patch(mx.group(2))
+            v, p = None, Product.LibSSH
+            os_version = cls._extract_os_version(banner.comments)
+            return cls(v, p, mx.group(1), patch, os_version)
+        mx = re.match(r'^RomSShell_([\d\.]+\d+)(.*)', software)
+        if mx is not None:
+            patch = cls._fix_patch(mx.group(2))
+            v, p = 'Allegro Software', 'RomSShell'
+            return cls(v, p, mx.group(1), patch, None)
+        mx = re.match(r'^mpSSH_([\d\.]+\d+)', software)
+        if mx is not None:
+            v, p = 'HP', 'iLO (Integrated Lights-Out) sshd'
+            return cls(v, p, mx.group(1), None, None)
+        mx = re.match(r'^Cisco-([\d\.]+\d+)', software)
+        if mx is not None:
+            v, p = 'Cisco', 'IOS/PIX sshd'
+            return cls(v, p, mx.group(1), None, None)
+        mx = re.match(r'^tinyssh_(.*)', software)
+        if mx is not None:
+            return cls(None, Product.TinySSH, mx.group(1), None, None)
+        mx = re.match(r'^PuTTY_Release_(.*)', software)
+        if mx:
+            return cls(None, Product.PuTTY, mx.group(1), None, None)
+        return None

src/ssh_audit/ssh1.py

@@ -0,0 +1,40 @@
+"""
+   The MIT License (MIT)
+
+   Copyright (C) 2017 Andris Raugulis (moo@arthepsy.eu)
+
+   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.
+"""
+# pylint: disable=unused-import
+from typing import Dict, List, Set, Sequence, Tuple, Iterable  # noqa: F401
+from typing import Callable, Optional, Union, Any  # noqa: F401
+
+from ssh_audit.ssh1_crc32 import SSH1_CRC32
+
+
+class SSH1:
+    _crc32: Optional[SSH1_CRC32] = None
+    CIPHERS = ['none', 'idea', 'des', '3des', 'tss', 'rc4', 'blowfish']
+    AUTHS = ['none', 'rhosts', 'rsa', 'password', 'rhosts_rsa', 'tis', 'kerberos']
+
+    @classmethod
+    def crc32(cls, v: bytes) -> int:
+        if cls._crc32 is None:
+            cls._crc32 = SSH1_CRC32()
+        return cls._crc32.calc(v)

src/ssh_audit/ssh1_crc32.py

@@ -0,0 +1,47 @@
+"""
+   The MIT License (MIT)
+
+   Copyright (C) 2017 Andris Raugulis (moo@arthepsy.eu)
+
+   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.
+"""
+# pylint: disable=unused-import
+from typing import Dict, List, Set, Sequence, Tuple, Iterable  # noqa: F401
+from typing import Callable, Optional, Union, Any  # noqa: F401
+
+
+class SSH1_CRC32:
+    def __init__(self) -> None:
+        self._table = [0] * 256
+        for i in range(256):
+            crc = 0
+            n = i
+            for _ in range(8):
+                x = (crc ^ n) & 1
+                crc = (crc >> 1) ^ (x * 0xedb88320)
+                n = n >> 1
+                self._table[i] = crc
+
+    def calc(self, v: bytes) -> int:
+        crc, length = 0, len(v)
+        for i in range(length):
+            n = ord(v[i:i + 1])
+            n = n ^ (crc & 0xff)
+            crc = (crc >> 8) ^ self._table[n]
+        return crc

src/ssh_audit/ssh1_kexdb.py

@@ -0,0 +1,58 @@
+"""
+   The MIT License (MIT)
+
+   Copyright (C) 2017 Andris Raugulis (moo@arthepsy.eu)
+
+   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.
+"""
+# pylint: disable=unused-import
+from typing import Dict, List, Set, Sequence, Tuple, Iterable  # noqa: F401
+from typing import Callable, Optional, Union, Any  # noqa: F401
+
+
+class SSH1_KexDB:  # pylint: disable=too-few-public-methods
+
+    FAIL_PLAINTEXT = 'no encryption/integrity'
+    FAIL_OPENSSH37_REMOVE = 'removed since OpenSSH 3.7'
+    FAIL_NA_BROKEN = 'not implemented in OpenSSH, broken algorithm'
+    FAIL_NA_UNSAFE = 'not implemented in OpenSSH (server), unsafe algorithm'
+    TEXT_CIPHER_IDEA = 'cipher used by commercial SSH'
+
+    ALGORITHMS: Dict[str, Dict[str, List[List[Optional[str]]]]] = {
+        'key': {
+            'ssh-rsa1': [['1.2.2']],
+        },
+        'enc': {
+            'none': [['1.2.2'], [FAIL_PLAINTEXT]],
+            'idea': [[None], [], [], [TEXT_CIPHER_IDEA]],
+            'des': [['2.3.0C'], [FAIL_NA_UNSAFE]],
+            '3des': [['1.2.2']],
+            'tss': [[''], [FAIL_NA_BROKEN]],
+            'rc4': [[], [FAIL_NA_BROKEN]],
+            'blowfish': [['1.2.2']],
+        },
+        'aut': {
+            'rhosts': [['1.2.2', '3.6'], [FAIL_OPENSSH37_REMOVE]],
+            'rsa': [['1.2.2']],
+            'password': [['1.2.2']],
+            'rhosts_rsa': [['1.2.2']],
+            'tis': [['1.2.2']],
+            'kerberos': [['1.2.2', '3.6'], [FAIL_OPENSSH37_REMOVE]],
+        }
+    }

src/ssh_audit/ssh1_publickeymessage.py

@@ -0,0 +1,144 @@
+"""
+   The MIT License (MIT)
+
+   Copyright (C) 2017 Andris Raugulis (moo@arthepsy.eu)
+
+   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.
+"""
+# pylint: disable=unused-import
+from typing import Dict, List, Set, Sequence, Tuple, Iterable  # noqa: F401
+from typing import Callable, Optional, Union, Any  # noqa: F401
+
+from ssh_audit.ssh1 import SSH1
+from ssh_audit.readbuf import ReadBuf
+from ssh_audit.utils import Utils
+from ssh_audit.writebuf import WriteBuf
+
+
+class SSH1_PublicKeyMessage:
+    def __init__(self, cookie: bytes, skey: Tuple[int, int, int], hkey: Tuple[int, int, int], pflags: int, cmask: int, amask: int) -> None:
+        if len(skey) != 3:
+            raise ValueError('invalid server key pair: {}'.format(skey))
+        if len(hkey) != 3:
+            raise ValueError('invalid host key pair: {}'.format(hkey))
+        self.__cookie = cookie
+        self.__server_key = skey
+        self.__host_key = hkey
+        self.__protocol_flags = pflags
+        self.__supported_ciphers_mask = cmask
+        self.__supported_authentications_mask = amask
+
+    @property
+    def cookie(self) -> bytes:
+        return self.__cookie
+
+    @property
+    def server_key_bits(self) -> int:
+        return self.__server_key[0]
+
+    @property
+    def server_key_public_exponent(self) -> int:
+        return self.__server_key[1]
+
+    @property
+    def server_key_public_modulus(self) -> int:
+        return self.__server_key[2]
+
+    @property
+    def host_key_bits(self) -> int:
+        return self.__host_key[0]
+
+    @property
+    def host_key_public_exponent(self) -> int:
+        return self.__host_key[1]
+
+    @property
+    def host_key_public_modulus(self) -> int:
+        return self.__host_key[2]
+
+    @property
+    def host_key_fingerprint_data(self) -> bytes:
+        # pylint: disable=protected-access
+        mod = WriteBuf._create_mpint(self.host_key_public_modulus, False)
+        e = WriteBuf._create_mpint(self.host_key_public_exponent, False)
+        return mod + e
+
+    @property
+    def protocol_flags(self) -> int:
+        return self.__protocol_flags
+
+    @property
+    def supported_ciphers_mask(self) -> int:
+        return self.__supported_ciphers_mask
+
+    @property
+    def supported_ciphers(self) -> List[str]:
+        ciphers = []
+        for i in range(len(SSH1.CIPHERS)):  # pylint: disable=consider-using-enumerate
+            if self.__supported_ciphers_mask & (1 << i) != 0:
+                ciphers.append(Utils.to_text(SSH1.CIPHERS[i]))
+        return ciphers
+
+    @property
+    def supported_authentications_mask(self) -> int:
+        return self.__supported_authentications_mask
+
+    @property
+    def supported_authentications(self) -> List[str]:
+        auths = []
+        for i in range(1, len(SSH1.AUTHS)):
+            if self.__supported_authentications_mask & (1 << i) != 0:
+                auths.append(Utils.to_text(SSH1.AUTHS[i]))
+        return auths
+
+    def write(self, wbuf: 'WriteBuf') -> None:
+        wbuf.write(self.cookie)
+        wbuf.write_int(self.server_key_bits)
+        wbuf.write_mpint1(self.server_key_public_exponent)
+        wbuf.write_mpint1(self.server_key_public_modulus)
+        wbuf.write_int(self.host_key_bits)
+        wbuf.write_mpint1(self.host_key_public_exponent)
+        wbuf.write_mpint1(self.host_key_public_modulus)
+        wbuf.write_int(self.protocol_flags)
+        wbuf.write_int(self.supported_ciphers_mask)
+        wbuf.write_int(self.supported_authentications_mask)
+
+    @property
+    def payload(self) -> bytes:
+        wbuf = WriteBuf()
+        self.write(wbuf)
+        return wbuf.write_flush()
+
+    @classmethod
+    def parse(cls, payload: bytes) -> 'SSH1_PublicKeyMessage':
+        buf = ReadBuf(payload)
+        cookie = buf.read(8)
+        server_key_bits = buf.read_int()
+        server_key_exponent = buf.read_mpint1()
+        server_key_modulus = buf.read_mpint1()
+        skey = (server_key_bits, server_key_exponent, server_key_modulus)
+        host_key_bits = buf.read_int()
+        host_key_exponent = buf.read_mpint1()
+        host_key_modulus = buf.read_mpint1()
+        hkey = (host_key_bits, host_key_exponent, host_key_modulus)
+        pflags = buf.read_int()
+        cmask = buf.read_int()
+        amask = buf.read_int()
+        pkm = cls(cookie, skey, hkey, pflags, cmask, amask)
+        return pkm

src/ssh_audit/ssh2_kex.py

@@ -0,0 +1,136 @@
+"""
+   The MIT License (MIT)
+
+   Copyright (C) 2017-2020 Joe Testa (jtesta@positronsecurity.com)
+   Copyright (C) 2017 Andris Raugulis (moo@arthepsy.eu)
+
+   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.
+"""
+# pylint: disable=unused-import
+from typing import Dict, List, Set, Sequence, Tuple, Iterable  # noqa: F401
+from typing import Callable, Optional, Union, Any  # noqa: F401
+
+from ssh_audit.ssh2_kexparty import SSH2_KexParty
+from ssh_audit.readbuf import ReadBuf
+from ssh_audit.writebuf import WriteBuf
+
+
+class SSH2_Kex:
+    def __init__(self, cookie: bytes, kex_algs: List[str], key_algs: List[str], cli: 'SSH2_KexParty', srv: 'SSH2_KexParty', follows: bool, unused: int = 0) -> None:
+        self.__cookie = cookie
+        self.__kex_algs = kex_algs
+        self.__key_algs = key_algs
+        self.__client = cli
+        self.__server = srv
+        self.__follows = follows
+        self.__unused = unused
+
+        self.__rsa_key_sizes: Dict[str, Tuple[int, int]] = {}
+        self.__dh_modulus_sizes: Dict[str, Tuple[int, int]] = {}
+        self.__host_keys: Dict[str, bytes] = {}
+
+    @property
+    def cookie(self) -> bytes:
+        return self.__cookie
+
+    @property
+    def kex_algorithms(self) -> List[str]:
+        return self.__kex_algs
+
+    @property
+    def key_algorithms(self) -> List[str]:
+        return self.__key_algs
+
+    # client_to_server
+    @property
+    def client(self) -> 'SSH2_KexParty':
+        return self.__client
+
+    # server_to_client
+    @property
+    def server(self) -> 'SSH2_KexParty':
+        return self.__server
+
+    @property
+    def follows(self) -> bool:
+        return self.__follows
+
+    @property
+    def unused(self) -> int:
+        return self.__unused
+
+    def set_rsa_key_size(self, rsa_type: str, hostkey_size: int, ca_size: int = -1) -> None:
+        self.__rsa_key_sizes[rsa_type] = (hostkey_size, ca_size)
+
+    def rsa_key_sizes(self) -> Dict[str, Tuple[int, int]]:
+        return self.__rsa_key_sizes
+
+    def set_dh_modulus_size(self, gex_alg: str, modulus_size: int) -> None:
+        self.__dh_modulus_sizes[gex_alg] = (modulus_size, -1)
+
+    def dh_modulus_sizes(self) -> Dict[str, Tuple[int, int]]:
+        return self.__dh_modulus_sizes
+
+    def set_host_key(self, key_type: str, hostkey: bytes) -> None:
+        self.__host_keys[key_type] = hostkey
+
+    def host_keys(self) -> Dict[str, bytes]:
+        return self.__host_keys
+
+    def write(self, wbuf: 'WriteBuf') -> None:
+        wbuf.write(self.cookie)
+        wbuf.write_list(self.kex_algorithms)
+        wbuf.write_list(self.key_algorithms)
+        wbuf.write_list(self.client.encryption)
+        wbuf.write_list(self.server.encryption)
+        wbuf.write_list(self.client.mac)
+        wbuf.write_list(self.server.mac)
+        wbuf.write_list(self.client.compression)
+        wbuf.write_list(self.server.compression)
+        wbuf.write_list(self.client.languages)
+        wbuf.write_list(self.server.languages)
+        wbuf.write_bool(self.follows)
+        wbuf.write_int(self.__unused)
+
+    @property
+    def payload(self) -> bytes:
+        wbuf = WriteBuf()
+        self.write(wbuf)
+        return wbuf.write_flush()
+
+    @classmethod
+    def parse(cls, payload: bytes) -> 'SSH2_Kex':
+        buf = ReadBuf(payload)
+        cookie = buf.read(16)
+        kex_algs = buf.read_list()
+        key_algs = buf.read_list()
+        cli_enc = buf.read_list()
+        srv_enc = buf.read_list()
+        cli_mac = buf.read_list()
+        srv_mac = buf.read_list()
+        cli_compression = buf.read_list()
+        srv_compression = buf.read_list()
+        cli_languages = buf.read_list()
+        srv_languages = buf.read_list()
+        follows = buf.read_bool()
+        unused = buf.read_int()
+        cli = SSH2_KexParty(cli_enc, cli_mac, cli_compression, cli_languages)
+        srv = SSH2_KexParty(srv_enc, srv_mac, srv_compression, srv_languages)
+        kex = cls(cookie, kex_algs, key_algs, cli, srv, follows, unused)
+        return kex

src/ssh_audit/ssh2_kexdb.py

@@ -0,0 +1,280 @@
+"""
+   The MIT License (MIT)
+
+   Copyright (C) 2017-2021 Joe Testa (jtesta@positronsecurity.com)
+   Copyright (C) 2017 Andris Raugulis (moo@arthepsy.eu)
+
+   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.
+"""
+# pylint: disable=unused-import
+from typing import Dict, List, Set, Sequence, Tuple, Iterable  # noqa: F401
+from typing import Callable, Optional, Union, Any  # noqa: F401
+
+
+class SSH2_KexDB:  # pylint: disable=too-few-public-methods
+    WARN_OPENSSH74_UNSAFE = 'disabled (in client) since OpenSSH 7.4, unsafe algorithm'
+    WARN_OPENSSH72_LEGACY = 'disabled (in client) since OpenSSH 7.2, legacy algorithm'
+    FAIL_OPENSSH70_LEGACY = 'removed since OpenSSH 7.0, legacy algorithm'
+    FAIL_OPENSSH70_WEAK = 'removed (in server) and disabled (in client) since OpenSSH 7.0, weak algorithm'
+    FAIL_OPENSSH70_LOGJAM = 'disabled (in client) since OpenSSH 7.0, logjam attack'
+    INFO_OPENSSH69_CHACHA = 'default cipher since OpenSSH 6.9.'
+    FAIL_OPENSSH67_UNSAFE = 'removed (in server) since OpenSSH 6.7, unsafe algorithm'
+    FAIL_OPENSSH61_REMOVE = 'removed since OpenSSH 6.1, removed from specification'
+    FAIL_OPENSSH31_REMOVE = 'removed since OpenSSH 3.1'
+    INFO_OPENSSH82_FUTURE_DEPRECATION = 'a future deprecation notice has been issued in OpenSSH 8.2: https://www.openssh.com/txt/release-8.2'
+    FAIL_DBEAR67_DISABLED = 'disabled since Dropbear SSH 2015.67'
+    FAIL_DBEAR53_DISABLED = 'disabled since Dropbear SSH 0.53'
+    FAIL_DEPRECATED_CIPHER = 'deprecated cipher'
+    FAIL_WEAK_CIPHER = 'using weak cipher'
+    FAIL_WEAK_ALGORITHM = 'using weak/obsolete algorithm'
+    FAIL_PLAINTEXT = 'no encryption/integrity'
+    FAIL_DEPRECATED_MAC = 'deprecated MAC'
+    FAIL_1024BIT_MODULUS = 'using small 1024-bit modulus'
+    FAIL_UNPROVEN = 'using unproven algorithm'
+    FAIL_HASH_WEAK = 'using weak hashing algorithm'
+    WARN_CURVES_WEAK = 'using weak elliptic curves'
+    WARN_RNDSIG_KEY = 'using weak random number generator could reveal the key'
+    WARN_HASH_WEAK = 'using weak hashing algorithm'
+    WARN_CIPHER_MODE = 'using weak cipher mode'
+    WARN_BLOCK_SIZE = 'using small 64-bit block size'
+    WARN_CIPHER_WEAK = 'using weak cipher'
+    WARN_ENCRYPT_AND_MAC = 'using encrypt-and-MAC mode'
+    WARN_TAG_SIZE = 'using small 64-bit tag size'
+    WARN_TAG_SIZE_96 = 'using small 96-bit tag size'
+    WARN_EXPERIMENTAL = 'using experimental algorithm'
+    WARN_OBSOLETE = 'using obsolete algorithm'
+    WARN_UNTRUSTED = 'using untrusted algorithm'
+
+    ALGORITHMS: Dict[str, Dict[str, List[List[Optional[str]]]]] = {
+        # Format: 'algorithm_name': [['version_first_appeared_in'], [reason_for_failure1, reason_for_failure2, ...], [warning1, warning2, ...]]
+        'kex': {
+            'diffie-hellman-group1-sha1': [['2.3.0,d0.28,l10.2', '6.6', '6.9'], [FAIL_1024BIT_MODULUS, FAIL_OPENSSH67_UNSAFE, FAIL_OPENSSH70_LOGJAM], [WARN_HASH_WEAK]],
+            'gss-group1-sha1-toWM5Slw5Ew8Mqkay+al2g==': [[], [FAIL_1024BIT_MODULUS, FAIL_OPENSSH67_UNSAFE, FAIL_OPENSSH70_LOGJAM], [WARN_HASH_WEAK]],
+            'gss-gex-sha1-eipGX3TCiQSrx573bT1o1Q==': [[], [], [WARN_HASH_WEAK]],
+            'gss-gex-sha1-toWM5Slw5Ew8Mqkay+al2g==': [[], [], [WARN_HASH_WEAK]],
+            'gss-gex-sha1-': [[], [], [WARN_HASH_WEAK]],
+            'gss-group1-sha1-eipGX3TCiQSrx573bT1o1Q==': [[], [FAIL_1024BIT_MODULUS], [WARN_HASH_WEAK]],
+            'gss-group1-sha1-': [[], [FAIL_1024BIT_MODULUS], [WARN_HASH_WEAK]],
+            'gss-group14-sha1-': [[], [], [WARN_HASH_WEAK]],
+            'gss-group14-sha1-eipGX3TCiQSrx573bT1o1Q==': [[], [], [WARN_HASH_WEAK]],
+            'gss-group14-sha1-toWM5Slw5Ew8Mqkay+al2g==': [[], [], [WARN_HASH_WEAK]],
+            'gss-group14-sha256-': [[]],
+            'gss-group14-sha256-toWM5Slw5Ew8Mqkay+al2g==': [[]],
+            'gss-group15-sha512-': [[]],
+            'gss-group15-sha512-toWM5Slw5Ew8Mqkay+al2g==': [[]],
+            'gss-group16-sha512-': [[]],
+            'gss-nistp256-sha256-': [[], [WARN_CURVES_WEAK]],
+            'gss-curve25519-sha256-': [[]],
+            'diffie-hellman-group1-sha256': [[], [FAIL_1024BIT_MODULUS]],
+            'diffie-hellman-group14-sha1': [['3.9,d0.53,l10.6.0'], [], [WARN_HASH_WEAK]],
+            'diffie-hellman-group14-sha256': [['7.3,d2016.73']],
+            'diffie-hellman-group14-sha256@ssh.com': [[]],
+            'diffie-hellman-group15-sha256': [[]],
+            'diffie-hellman-group15-sha256@ssh.com': [[]],
+            'diffie-hellman-group15-sha384@ssh.com': [[]],
+            'diffie-hellman-group15-sha512': [[]],
+            'diffie-hellman-group16-sha256': [[]],
+            'diffie-hellman-group16-sha384@ssh.com': [[]],
+            'diffie-hellman-group16-sha512': [['7.3,d2016.73']],
+            'diffie-hellman-group16-sha512@ssh.com': [[]],
+            'diffie-hellman-group17-sha512': [[]],
+            'diffie-hellman-group18-sha512': [['7.3']],
+            'diffie-hellman-group18-sha512@ssh.com': [[]],
+            'diffie-hellman-group-exchange-sha1': [['2.3.0', '6.6', None], [FAIL_OPENSSH67_UNSAFE], [WARN_HASH_WEAK]],
+            'diffie-hellman-group-exchange-sha256': [['4.4']],
+            'diffie-hellman-group-exchange-sha256@ssh.com': [[]],
+            'diffie-hellman-group-exchange-sha512@ssh.com': [[]],
+            'ecdh-sha2-curve25519': [[], []],
+            'ecdh-sha2-nistb233': [[], [WARN_CURVES_WEAK]],
+            'ecdh-sha2-nistb409': [[], [WARN_CURVES_WEAK]],
+            'ecdh-sha2-nistk163': [[], [WARN_CURVES_WEAK]],
+            'ecdh-sha2-nistk233': [[], [WARN_CURVES_WEAK]],
+            'ecdh-sha2-nistk283': [[], [WARN_CURVES_WEAK]],
+            'ecdh-sha2-nistk409': [[], [WARN_CURVES_WEAK]],
+            'ecdh-sha2-nistp192': [[], [WARN_CURVES_WEAK]],
+            'ecdh-sha2-nistp224': [[], [WARN_CURVES_WEAK]],
+            'ecdh-sha2-nistp256': [['5.7,d2013.62,l10.6.0'], [WARN_CURVES_WEAK]],
+            'ecdh-sha2-nistp384': [['5.7,d2013.62'], [WARN_CURVES_WEAK]],
+            'ecdh-sha2-nistp521': [['5.7,d2013.62'], [WARN_CURVES_WEAK]],
+            'ecdh-sha2-nistt571': [[], [WARN_CURVES_WEAK]],
+            'ecdh-sha2-1.3.132.0.10': [[]],  # ECDH over secp256k1 (i.e.: the Bitcoin curve)
+            'curve25519-sha256@libssh.org': [['6.5,d2013.62,l10.6.0']],
+            'curve25519-sha256': [['7.4,d2018.76']],
+            'curve448-sha512': [[]],
+            'kexguess2@matt.ucc.asn.au': [['d2013.57']],
+            'rsa1024-sha1': [[], [FAIL_1024BIT_MODULUS], [WARN_HASH_WEAK]],
+            'rsa2048-sha256': [[]],
+            'sntrup4591761x25519-sha512@tinyssh.org': [['8.0', '8.4'], [], [WARN_EXPERIMENTAL]],
+            'sntrup761x25519-sha512@openssh.com': [['8.5'], [], [WARN_EXPERIMENTAL]],
+            'kexAlgoCurve25519SHA256': [[]],
+            'Curve25519SHA256': [[]],
+            'ext-info-c': [[]],  # Extension negotiation (RFC 8308)
+            'ext-info-s': [[]],  # Extension negotiation (RFC 8308)
+        },
+        'key': {
+            'ssh-rsa1': [[], [FAIL_WEAK_ALGORITHM]],
+            'rsa-sha2-256': [['7.2']],
+            'rsa-sha2-512': [['7.2']],
+            'ssh-ed25519': [['6.5,l10.7.0']],
+            'ssh-ed25519-cert-v01@openssh.com': [['6.5']],
+            'ssh-rsa': [['2.5.0,d0.28,l10.2'], [FAIL_HASH_WEAK], [], [INFO_OPENSSH82_FUTURE_DEPRECATION]],
+            'ssh-dss': [['2.1.0,d0.28,l10.2', '6.9'], [FAIL_1024BIT_MODULUS, FAIL_OPENSSH70_WEAK], [WARN_RNDSIG_KEY]],
+            'ecdsa-sha2-nistp256': [['5.7,d2013.62,l10.6.4'], [WARN_CURVES_WEAK], [WARN_RNDSIG_KEY]],
+            'ecdsa-sha2-nistp384': [['5.7,d2013.62,l10.6.4'], [WARN_CURVES_WEAK], [WARN_RNDSIG_KEY]],
+            'ecdsa-sha2-nistp521': [['5.7,d2013.62,l10.6.4'], [WARN_CURVES_WEAK], [WARN_RNDSIG_KEY]],
+            'ecdsa-sha2-1.3.132.0.10': [[], [], [WARN_RNDSIG_KEY]],  # ECDSA over secp256k1 (i.e.: the Bitcoin curve)
+            'x509v3-sign-dss': [[], [FAIL_1024BIT_MODULUS, FAIL_OPENSSH70_WEAK], [WARN_RNDSIG_KEY]],
+            'x509v3-sign-rsa': [[], [FAIL_HASH_WEAK], [], [INFO_OPENSSH82_FUTURE_DEPRECATION]],
+            'x509v3-sign-rsa-sha256@ssh.com': [[]],
+            'x509v3-ssh-dss': [[], [FAIL_1024BIT_MODULUS, FAIL_OPENSSH70_WEAK], [WARN_RNDSIG_KEY]],
+            'x509v3-ssh-rsa': [[], [FAIL_HASH_WEAK], [], [INFO_OPENSSH82_FUTURE_DEPRECATION]],
+            'ssh-rsa-cert-v00@openssh.com': [['5.4', '6.9'], [FAIL_OPENSSH70_LEGACY, FAIL_HASH_WEAK], [], [INFO_OPENSSH82_FUTURE_DEPRECATION]],
+            'ssh-dss-cert-v00@openssh.com': [['5.4', '6.9'], [FAIL_1024BIT_MODULUS, FAIL_OPENSSH70_LEGACY], [WARN_RNDSIG_KEY]],
+            'ssh-rsa-cert-v01@openssh.com': [['5.6'], [FAIL_HASH_WEAK], [], [INFO_OPENSSH82_FUTURE_DEPRECATION]],
+            'ssh-dss-cert-v01@openssh.com': [['5.6', '6.9'], [FAIL_1024BIT_MODULUS, FAIL_OPENSSH70_WEAK], [WARN_RNDSIG_KEY]],
+            'ecdsa-sha2-nistp256-cert-v01@openssh.com': [['5.7'], [WARN_CURVES_WEAK], [WARN_RNDSIG_KEY]],
+            'ecdsa-sha2-nistp384-cert-v01@openssh.com': [['5.7'], [WARN_CURVES_WEAK], [WARN_RNDSIG_KEY]],
+            'ecdsa-sha2-nistp521-cert-v01@openssh.com': [['5.7'], [WARN_CURVES_WEAK], [WARN_RNDSIG_KEY]],
+            'rsa-sha2-256-cert-v01@openssh.com': [['7.8']],
+            'rsa-sha2-512-cert-v01@openssh.com': [['7.8']],
+            'ssh-rsa-sha256@ssh.com': [[]],
+            'ssh-dss-sha256@ssh.com': [[], [FAIL_1024BIT_MODULUS]],
+            'sk-ecdsa-sha2-nistp256-cert-v01@openssh.com': [['8.2'], [WARN_CURVES_WEAK], [WARN_RNDSIG_KEY]],
+            'sk-ecdsa-sha2-nistp256@openssh.com': [['8.2'], [WARN_CURVES_WEAK], [WARN_RNDSIG_KEY]],
+            'sk-ssh-ed25519-cert-v01@openssh.com': [['8.2']],
+            'sk-ssh-ed25519@openssh.com': [['8.2']],
+            'ssh-gost2001': [[], [], [WARN_UNTRUSTED]],
+            'ssh-gost2012-256': [[], [], [WARN_UNTRUSTED]],
+            'ssh-gost2012-512': [[], [], [WARN_UNTRUSTED]],
+            'spi-sign-rsa': [[]],
+            'ssh-ed448': [[]],
+            'x509v3-ecdsa-sha2-nistp256': [[], [WARN_CURVES_WEAK]],
+            'x509v3-ecdsa-sha2-nistp384': [[], [WARN_CURVES_WEAK]],
+            'x509v3-ecdsa-sha2-nistp521': [[], [WARN_CURVES_WEAK]],
+            'x509v3-rsa2048-sha256': [[]],
+        },
+        'enc': {
+            'none': [['1.2.2,d2013.56,l10.2'], [FAIL_PLAINTEXT]],
+            'des': [[], [FAIL_WEAK_CIPHER], [WARN_CIPHER_MODE, WARN_BLOCK_SIZE]],
+            'des-cbc': [[], [FAIL_WEAK_CIPHER], [WARN_CIPHER_MODE, WARN_BLOCK_SIZE]],
+            'des-cbc@ssh.com': [[], [FAIL_WEAK_CIPHER], [WARN_CIPHER_MODE, WARN_BLOCK_SIZE]],
+            'des-cbc-ssh1': [[], [FAIL_WEAK_CIPHER], [WARN_CIPHER_MODE, WARN_BLOCK_SIZE]],
+            '3des': [[], [FAIL_OPENSSH67_UNSAFE], [WARN_OPENSSH74_UNSAFE, WARN_CIPHER_WEAK, WARN_CIPHER_MODE, WARN_BLOCK_SIZE]],
+            '3des-cbc': [['1.2.2,d0.28,l10.2', '6.6', None], [FAIL_OPENSSH67_UNSAFE], [WARN_OPENSSH74_UNSAFE, WARN_CIPHER_WEAK, WARN_CIPHER_MODE, WARN_BLOCK_SIZE]],
+            '3des-ctr': [['d0.52'], [FAIL_WEAK_CIPHER]],
+            'blowfish': [[], [FAIL_WEAK_ALGORITHM], [WARN_BLOCK_SIZE]],
+            'blowfish-cbc': [['1.2.2,d0.28,l10.2', '6.6,d0.52', '7.1,d0.52'], [FAIL_OPENSSH67_UNSAFE, FAIL_DBEAR53_DISABLED], [WARN_OPENSSH72_LEGACY, WARN_CIPHER_MODE, WARN_BLOCK_SIZE]],
+            'blowfish-ctr': [[], [FAIL_OPENSSH67_UNSAFE, FAIL_DBEAR53_DISABLED], [WARN_OPENSSH72_LEGACY, WARN_CIPHER_MODE, WARN_BLOCK_SIZE]],
+            'twofish-cbc': [['d0.28', 'd2014.66'], [FAIL_DBEAR67_DISABLED], [WARN_CIPHER_MODE]],
+            'twofish128-cbc': [['d0.47', 'd2014.66'], [FAIL_DBEAR67_DISABLED], [WARN_CIPHER_MODE]],
+            'twofish192-cbc': [[], [], [WARN_CIPHER_MODE]],
+            'twofish256-cbc': [['d0.47', 'd2014.66'], [FAIL_DBEAR67_DISABLED], [WARN_CIPHER_MODE]],
+            'twofish-ctr': [[]],
+            'twofish128-ctr': [['d2015.68']],
+            'twofish192-ctr': [[]],
+            'twofish256-ctr': [['d2015.68']],
+            'serpent128-cbc': [[], [FAIL_DEPRECATED_CIPHER], [WARN_CIPHER_MODE]],
+            'serpent192-cbc': [[], [FAIL_DEPRECATED_CIPHER], [WARN_CIPHER_MODE]],
+            'serpent256-cbc': [[], [FAIL_DEPRECATED_CIPHER], [WARN_CIPHER_MODE]],
+            'serpent128-ctr': [[], [FAIL_DEPRECATED_CIPHER]],
+            'serpent192-ctr': [[], [FAIL_DEPRECATED_CIPHER]],
+            'serpent256-ctr': [[], [FAIL_DEPRECATED_CIPHER]],
+            'idea-cbc': [[], [FAIL_DEPRECATED_CIPHER], [WARN_CIPHER_MODE]],
+            'idea-ctr': [[], [FAIL_DEPRECATED_CIPHER]],
+            'cast128-ctr': [[], [FAIL_DEPRECATED_CIPHER]],
+            'cast128-cbc': [['2.1.0', '6.6', '7.1'], [FAIL_OPENSSH67_UNSAFE], [WARN_OPENSSH72_LEGACY, WARN_CIPHER_MODE, WARN_BLOCK_SIZE]],
+            'arcfour': [['2.1.0', '6.6', '7.1'], [FAIL_OPENSSH67_UNSAFE], [WARN_OPENSSH72_LEGACY, WARN_CIPHER_WEAK]],
+            'arcfour128': [['4.2', '6.6', '7.1'], [FAIL_OPENSSH67_UNSAFE], [WARN_OPENSSH72_LEGACY, WARN_CIPHER_WEAK]],
+            'arcfour256': [['4.2', '6.6', '7.1'], [FAIL_OPENSSH67_UNSAFE], [WARN_OPENSSH72_LEGACY, WARN_CIPHER_WEAK]],
+            'aes128-cbc': [['2.3.0,d0.28,l10.2', '6.6', None], [FAIL_OPENSSH67_UNSAFE], [WARN_CIPHER_MODE]],
+            'aes192-cbc': [['2.3.0,l10.2', '6.6', None], [FAIL_OPENSSH67_UNSAFE], [WARN_CIPHER_MODE]],
+            'aes256-cbc': [['2.3.0,d0.47,l10.2', '6.6', None], [FAIL_OPENSSH67_UNSAFE], [WARN_CIPHER_MODE]],
+            'rijndael128-cbc': [['2.3.0', '3.0.2'], [FAIL_OPENSSH31_REMOVE], [WARN_CIPHER_MODE]],
+            'rijndael192-cbc': [['2.3.0', '3.0.2'], [FAIL_OPENSSH31_REMOVE], [WARN_CIPHER_MODE]],
+            'rijndael256-cbc': [['2.3.0', '3.0.2'], [FAIL_OPENSSH31_REMOVE], [WARN_CIPHER_MODE]],
+            'rijndael-cbc@lysator.liu.se': [['2.3.0', '6.6', '7.1'], [FAIL_OPENSSH67_UNSAFE], [WARN_OPENSSH72_LEGACY, WARN_CIPHER_MODE]],
+            'aes128-ctr': [['3.7,d0.52,l10.4.1']],
+            'aes192-ctr': [['3.7,l10.4.1']],
+            'aes256-ctr': [['3.7,d0.52,l10.4.1']],
+            'aes128-gcm': [[]],
+            'aes256-gcm': [[]],
+            'AEAD_AES_128_GCM': [[]],
+            'AEAD_AES_256_GCM': [[]],
+            'aes128-gcm@openssh.com': [['6.2']],
+            'aes256-gcm@openssh.com': [['6.2']],
+            'chacha20-poly1305': [[], [], [], [INFO_OPENSSH69_CHACHA]],
+            'chacha20-poly1305@openssh.com': [['6.5'], [], [], [INFO_OPENSSH69_CHACHA]],
+            'camellia128-cbc': [[], [], [WARN_CIPHER_MODE]],
+            'camellia128-ctr': [[]],
+            'camellia192-cbc': [[], [], [WARN_CIPHER_MODE]],
+            'camellia192-ctr': [[]],
+            'camellia256-cbc': [[], [], [WARN_CIPHER_MODE]],
+            'camellia256-ctr': [[]],
+            'crypticore128@ssh.com': [[], [FAIL_UNPROVEN]],
+            'seed-cbc@ssh.com': [[], [], [WARN_OBSOLETE, WARN_CIPHER_MODE]],
+        },
+        'mac': {
+            'none': [['d2013.56'], [FAIL_PLAINTEXT]],
+            'hmac-sha1': [['2.1.0,d0.28,l10.2'], [], [WARN_ENCRYPT_AND_MAC, WARN_HASH_WEAK]],
+            'hmac-sha1-96': [['2.5.0,d0.47', '6.6', '7.1'], [FAIL_OPENSSH67_UNSAFE], [WARN_OPENSSH72_LEGACY, WARN_ENCRYPT_AND_MAC, WARN_HASH_WEAK]],
+            'hmac-sha2-56': [[], [], [WARN_TAG_SIZE, WARN_ENCRYPT_AND_MAC]],
+            'hmac-sha2-224': [[], [], [WARN_TAG_SIZE, WARN_ENCRYPT_AND_MAC]],
+            'hmac-sha2-256': [['5.9,d2013.56,l10.7.0'], [], [WARN_ENCRYPT_AND_MAC]],
+            'hmac-sha2-256-96': [['5.9', '6.0'], [FAIL_OPENSSH61_REMOVE], [WARN_ENCRYPT_AND_MAC]],
+            'hmac-sha2-384': [[], [], [WARN_ENCRYPT_AND_MAC]],
+            'hmac-sha2-512': [['5.9,d2013.56,l10.7.0'], [], [WARN_ENCRYPT_AND_MAC]],
+            'hmac-sha2-512-96': [['5.9', '6.0'], [FAIL_OPENSSH61_REMOVE], [WARN_ENCRYPT_AND_MAC]],
+            'hmac-sha3-224': [[], [], [WARN_ENCRYPT_AND_MAC]],
+            'hmac-sha3-256': [[], [], [WARN_ENCRYPT_AND_MAC]],
+            'hmac-sha3-384': [[], [], [WARN_ENCRYPT_AND_MAC]],
+            'hmac-sha3-512': [[], [], [WARN_ENCRYPT_AND_MAC]],
+            'hmac-sha256': [[], [], [WARN_ENCRYPT_AND_MAC]],
+            'hmac-sha256-96@ssh.com': [[], [], [WARN_ENCRYPT_AND_MAC, WARN_TAG_SIZE]],
+            'hmac-sha256@ssh.com': [[], [], [WARN_ENCRYPT_AND_MAC]],
+            'hmac-sha512': [[], [], [WARN_ENCRYPT_AND_MAC]],
+            'hmac-sha512@ssh.com': [[], [], [WARN_ENCRYPT_AND_MAC]],
+            'hmac-md5': [['2.1.0,d0.28', '6.6', '7.1'], [FAIL_OPENSSH67_UNSAFE], [WARN_OPENSSH72_LEGACY, WARN_ENCRYPT_AND_MAC, WARN_HASH_WEAK]],
+            'hmac-md5-96': [['2.5.0', '6.6', '7.1'], [FAIL_OPENSSH67_UNSAFE], [WARN_OPENSSH72_LEGACY, WARN_ENCRYPT_AND_MAC, WARN_HASH_WEAK]],
+            'hmac-ripemd': [[], [FAIL_DEPRECATED_MAC], [WARN_OPENSSH72_LEGACY, WARN_ENCRYPT_AND_MAC]],
+            'hmac-ripemd160': [['2.5.0', '6.6', '7.1'], [FAIL_OPENSSH67_UNSAFE], [WARN_OPENSSH72_LEGACY, WARN_ENCRYPT_AND_MAC]],
+            'hmac-ripemd160-96': [[], [FAIL_DEPRECATED_MAC], [WARN_ENCRYPT_AND_MAC, WARN_TAG_SIZE]],
+            'hmac-ripemd160@openssh.com': [['2.1.0', '6.6', '7.1'], [FAIL_OPENSSH67_UNSAFE], [WARN_OPENSSH72_LEGACY, WARN_ENCRYPT_AND_MAC]],
+            'umac-64@openssh.com': [['4.7'], [], [WARN_ENCRYPT_AND_MAC, WARN_TAG_SIZE]],
+            'umac-128@openssh.com': [['6.2'], [], [WARN_ENCRYPT_AND_MAC]],
+            'hmac-sha1-etm@openssh.com': [['6.2'], [], [WARN_HASH_WEAK]],
+            'hmac-sha1-96-etm@openssh.com': [['6.2', '6.6', None], [FAIL_OPENSSH67_UNSAFE], [WARN_HASH_WEAK]],
+            'hmac-sha2-256-96-etm@openssh.com': [[], [], [WARN_TAG_SIZE_96]],  # Despite the @openssh.com tag, it doesn't appear that this was ever shipped with OpenSSH; it is only implemented in AsyncSSH (?).
+            'hmac-sha2-512-96-etm@openssh.com': [[], [], [WARN_TAG_SIZE_96]],  # Despite the @openssh.com tag, it doesn't appear that this was ever shipped with OpenSSH; it is only implemented in AsyncSSH (?).
+            'hmac-sha2-256-etm@openssh.com': [['6.2']],
+            'hmac-sha2-512-etm@openssh.com': [['6.2']],
+            'hmac-md5-etm@openssh.com': [['6.2', '6.6', '7.1'], [FAIL_OPENSSH67_UNSAFE], [WARN_OPENSSH72_LEGACY, WARN_HASH_WEAK]],
+            'hmac-md5-96-etm@openssh.com': [['6.2', '6.6', '7.1'], [FAIL_OPENSSH67_UNSAFE], [WARN_OPENSSH72_LEGACY, WARN_HASH_WEAK]],
+            'hmac-ripemd160-etm@openssh.com': [['6.2', '6.6', '7.1'], [FAIL_OPENSSH67_UNSAFE], [WARN_OPENSSH72_LEGACY]],
+            'umac-32@openssh.com': [[], [], [WARN_ENCRYPT_AND_MAC, WARN_TAG_SIZE]],  # Despite having the @openssh.com suffix, this may never have shipped with OpenSSH (!).
+            'umac-64-etm@openssh.com': [['6.2'], [], [WARN_TAG_SIZE]],
+            'umac-96@openssh.com': [[], [], [WARN_ENCRYPT_AND_MAC]],  # Despite having the @openssh.com suffix, this may never have shipped with OpenSSH (!).
+            'umac-128-etm@openssh.com': [['6.2']],
+            'aes128-gcm': [[]],
+            'aes256-gcm': [[]],
+            'chacha20-poly1305@openssh.com': [[]],  # Despite the @openssh.com tag, this was never shipped as a MAC in OpenSSH (only as a cipher); it is only implemented as a MAC in Syncplify.
+            'crypticore-mac@ssh.com': [[], [FAIL_UNPROVEN]],
+            'AEAD_AES_128_GCM': [[]],
+            'AEAD_AES_256_GCM': [[]],
+        }
+    }

src/ssh_audit/ssh2_kexparty.py

@@ -0,0 +1,50 @@
+"""
+   The MIT License (MIT)
+
+   Copyright (C) 2017 Andris Raugulis (moo@arthepsy.eu)
+
+   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.
+"""
+# pylint: disable=unused-import
+from typing import Dict, List, Set, Sequence, Tuple, Iterable  # noqa: F401
+from typing import Callable, Optional, Union, Any  # noqa: F401
+
+
+class SSH2_KexParty:
+    def __init__(self, enc: List[str], mac: List[str], compression: List[str], languages: List[str]) -> None:
+        self.__enc = enc
+        self.__mac = mac
+        self.__compression = compression
+        self.__languages = languages
+
+    @property
+    def encryption(self) -> List[str]:
+        return self.__enc
+
+    @property
+    def mac(self) -> List[str]:
+        return self.__mac
+
+    @property
+    def compression(self) -> List[str]:
+        return self.__compression
+
+    @property
+    def languages(self) -> List[str]:
+        return self.__languages

src/ssh_audit/ssh_socket.py

@@ -0,0 +1,343 @@
+"""
+   The MIT License (MIT)
+
+   Copyright (C) 2017-2021 Joe Testa (jtesta@positronsecurity.com)
+   Copyright (C) 2017 Andris Raugulis (moo@arthepsy.eu)
+
+   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.
+"""
+import errno
+import os
+import select
+import socket
+import struct
+import sys
+
+# pylint: disable=unused-import
+from typing import Dict, List, Set, Sequence, Tuple, Iterable  # noqa: F401
+from typing import Callable, Optional, Union, Any  # noqa: F401
+
+from ssh_audit import exitcodes
+from ssh_audit.banner import Banner
+from ssh_audit.globals import SSH_HEADER
+from ssh_audit.outputbuffer import OutputBuffer
+from ssh_audit.protocol import Protocol
+from ssh_audit.readbuf import ReadBuf
+from ssh_audit.ssh1 import SSH1
+from ssh_audit.ssh2_kex import SSH2_Kex
+from ssh_audit.ssh2_kexparty import SSH2_KexParty
+from ssh_audit.utils import Utils
+from ssh_audit.writebuf import WriteBuf
+
+
+class SSH_Socket(ReadBuf, WriteBuf):
+    class InsufficientReadException(Exception):
+        pass
+
+    SM_BANNER_SENT = 1
+
+    def __init__(self, outputbuffer: 'OutputBuffer', host: Optional[str], port: int, ip_version_preference: List[int] = [], timeout: Union[int, float] = 5, timeout_set: bool = False) -> None:  # pylint: disable=dangerous-default-value
+        super(SSH_Socket, self).__init__()
+        self.__outputbuffer = outputbuffer
+        self.__sock: Optional[socket.socket] = None
+        self.__sock_map: Dict[int, socket.socket] = {}
+        self.__block_size = 8
+        self.__state = 0
+        self.__header: List[str] = []
+        self.__banner: Optional[Banner] = None
+        if host is None:
+            raise ValueError('undefined host')
+        nport = Utils.parse_int(port)
+        if nport < 1 or nport > 65535:
+            raise ValueError('invalid port: {}'.format(port))
+        self.__host = host
+        self.__port = nport
+        self.__ip_version_preference = ip_version_preference  # Holds only 5 possible values: [] (no preference), [4] (use IPv4 only), [6] (use IPv6 only), [46] (use both IPv4 and IPv6, but prioritize v4), and [64] (use both IPv4 and IPv6, but prioritize v6).
+        self.__timeout = timeout
+        self.__timeout_set = timeout_set
+        self.client_host: Optional[str] = None
+        self.client_port = None
+
+    def _resolve(self) -> Iterable[Tuple[int, Tuple[Any, ...]]]:
+        # If __ip_version_preference has only one entry, then it means that ONLY that IP version should be used.
+        if len(self.__ip_version_preference) == 1:
+            family = socket.AF_INET if self.__ip_version_preference[0] == 4 else socket.AF_INET6
+        else:
+            family = socket.AF_UNSPEC
+        try:
+            stype = socket.SOCK_STREAM
+            r = socket.getaddrinfo(self.__host, self.__port, family, stype)
+
+            # If the user has a preference for using IPv4 over IPv6 (or vice-versa), then sort the list returned by getaddrinfo() so that the preferred address type comes first.
+            if len(self.__ip_version_preference) == 2:
+                r = sorted(r, key=lambda x: x[0], reverse=(self.__ip_version_preference[0] == 6))
+            for af, socktype, _proto, _canonname, addr in r:
+                if socktype == socket.SOCK_STREAM:
+                    yield af, addr
+        except socket.error as e:
+            self.__outputbuffer.fail('[exception] {}'.format(e)).write()
+            sys.exit(exitcodes.CONNECTION_ERROR)
+
+    # Listens on a server socket and accepts one connection (used for
+    # auditing client connections).
+    def listen_and_accept(self) -> None:
+
+        try:
+            # Socket to listen on all IPv4 addresses.
+            s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
+            s.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
+            s.bind(('0.0.0.0', self.__port))
+            s.listen()
+            self.__sock_map[s.fileno()] = s
+        except Exception:
+            print("Warning: failed to listen on any IPv4 interfaces.")
+
+        try:
+            # Socket to listen on all IPv6 addresses.
+            s = socket.socket(socket.AF_INET6, socket.SOCK_STREAM)
+            s.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
+            s.setsockopt(socket.IPPROTO_IPV6, socket.IPV6_V6ONLY, 1)
+            s.bind(('::', self.__port))
+            s.listen()
+            self.__sock_map[s.fileno()] = s
+        except Exception:
+            print("Warning: failed to listen on any IPv6 interfaces.")
+
+        # If we failed to listen on any interfaces, terminate.
+        if len(self.__sock_map.keys()) == 0:
+            print("Error: failed to listen on any IPv4 and IPv6 interfaces!")
+            sys.exit(exitcodes.CONNECTION_ERROR)
+
+        # Wait for an incoming connection.  If a timeout was explicitly
+        # set by the user, terminate when it elapses.
+        fds = None
+        time_elapsed = 0.0
+        interval = 1.0
+        while True:
+            # Wait for a connection on either socket.
+            fds = select.select(self.__sock_map.keys(), [], [], interval)
+            time_elapsed += interval
+
+            # We have incoming data on at least one of the sockets.
+            if len(fds[0]) > 0:
+                break
+
+            if self.__timeout_set and time_elapsed >= self.__timeout:
+                print("Timeout elapsed.  Terminating...")
+                sys.exit(exitcodes.CONNECTION_ERROR)
+
+        # Accept the connection.
+        c, addr = self.__sock_map[fds[0][0]].accept()
+        self.client_host = addr[0]
+        self.client_port = addr[1]
+        c.settimeout(self.__timeout)
+        self.__sock = c
+
+    def connect(self) -> Optional[str]:
+        '''Returns None on success, or an error string.'''
+        err = None
+        for af, addr in self._resolve():
+            s = None
+            try:
+                s = socket.socket(af, socket.SOCK_STREAM)
+                s.settimeout(self.__timeout)
+                self.__outputbuffer.d(("Connecting to %s:%d..." % ('[%s]' % addr[0] if Utils.is_ipv6_address(addr[0]) else addr[0], addr[1])), write_now=True)
+                s.connect(addr)
+                self.__sock = s
+                return None
+            except socket.error as e:
+                err = e
+                self._close_socket(s)
+        if err is None:
+            errm = 'host {} has no DNS records'.format(self.__host)
+        else:
+            errt = (self.__host, self.__port, err)
+            errm = 'cannot connect to {} port {}: {}'.format(*errt)
+        return '[exception] {}'.format(errm)
+
+    def get_banner(self, sshv: int = 2) -> Tuple[Optional['Banner'], List[str], Optional[str]]:
+        self.__outputbuffer.d('Getting banner...', write_now=True)
+
+        if self.__sock is None:
+            return self.__banner, self.__header, 'not connected'
+        if self.__banner is not None:
+            return self.__banner, self.__header, None
+
+        banner = SSH_HEADER.format('1.5' if sshv == 1 else '2.0')
+        if self.__state < self.SM_BANNER_SENT:
+            self.send_banner(banner)
+
+        s = 0
+        e = None
+        while s >= 0:
+            s, e = self.recv()
+            if s < 0:
+                continue
+            while self.unread_len > 0:
+                line = self.read_line()
+                if len(line.strip()) == 0:
+                    continue
+                self.__banner = Banner.parse(line)
+                if self.__banner is not None:
+                    return self.__banner, self.__header, None
+                self.__header.append(line)
+
+        return self.__banner, self.__header, e
+
+    def recv(self, size: int = 2048) -> Tuple[int, Optional[str]]:
+        if self.__sock is None:
+            return -1, 'not connected'
+        try:
+            data = self.__sock.recv(size)
+        except socket.timeout:
+            return -1, 'timed out'
+        except socket.error as e:
+            if e.args[0] in (errno.EAGAIN, errno.EWOULDBLOCK):
+                return 0, 'retry'
+            return -1, str(e.args[-1])
+        if len(data) == 0:
+            return -1, None
+        pos = self._buf.tell()
+        self._buf.seek(0, 2)
+        self._buf.write(data)
+        self._len += len(data)
+        self._buf.seek(pos, 0)
+        return len(data), None
+
+    def send(self, data: bytes) -> Tuple[int, Optional[str]]:
+        if self.__sock is None:
+            return -1, 'not connected'
+        try:
+            self.__sock.send(data)
+            return 0, None
+        except socket.error as e:
+            return -1, str(e.args[-1])
+
+    # Send a KEXINIT with the lists of key exchanges, hostkeys, ciphers, MACs, compressions, and languages that we "support".
+    def send_kexinit(self, key_exchanges: List[str] = ['curve25519-sha256', 'curve25519-sha256@libssh.org', 'ecdh-sha2-nistp256', 'ecdh-sha2-nistp384', 'ecdh-sha2-nistp521', 'diffie-hellman-group-exchange-sha256', 'diffie-hellman-group16-sha512', 'diffie-hellman-group18-sha512', 'diffie-hellman-group14-sha256'], hostkeys: List[str] = ['rsa-sha2-512', 'rsa-sha2-256', 'ssh-rsa', 'ecdsa-sha2-nistp256', 'ssh-ed25519'], ciphers: List[str] = ['chacha20-poly1305@openssh.com', 'aes128-ctr', 'aes192-ctr', 'aes256-ctr', 'aes128-gcm@openssh.com', 'aes256-gcm@openssh.com'], macs: List[str] = ['umac-64-etm@openssh.com', 'umac-128-etm@openssh.com', 'hmac-sha2-256-etm@openssh.com', 'hmac-sha2-512-etm@openssh.com', 'hmac-sha1-etm@openssh.com', 'umac-64@openssh.com', 'umac-128@openssh.com', 'hmac-sha2-256', 'hmac-sha2-512', 'hmac-sha1'], compressions: List[str] = ['none', 'zlib@openssh.com'], languages: List[str] = ['']) -> None:  # pylint: disable=dangerous-default-value
+        '''Sends the list of supported host keys, key exchanges, ciphers, and MACs.  Emulates OpenSSH v8.2.'''
+
+        self.__outputbuffer.d('KEX initialisation...', write_now=True)
+
+        kexparty = SSH2_KexParty(ciphers, macs, compressions, languages)
+        kex = SSH2_Kex(os.urandom(16), key_exchanges, hostkeys, kexparty, kexparty, False, 0)
+
+        self.write_byte(Protocol.MSG_KEXINIT)
+        kex.write(self)
+        self.send_packet()
+
+    def send_banner(self, banner: str) -> None:
+        self.send(banner.encode() + b'\r\n')
+        if self.__state < self.SM_BANNER_SENT:
+            self.__state = self.SM_BANNER_SENT
+
+    def ensure_read(self, size: int) -> None:
+        while self.unread_len < size:
+            s, e = self.recv()
+            if s < 0:
+                raise SSH_Socket.InsufficientReadException(e)
+
+    def read_packet(self, sshv: int = 2) -> Tuple[int, bytes]:
+        try:
+            header = WriteBuf()
+            self.ensure_read(4)
+            packet_length = self.read_int()
+            header.write_int(packet_length)
+            # XXX: validate length
+            if sshv == 1:
+                padding_length = 8 - packet_length % 8
+                self.ensure_read(padding_length)
+                padding = self.read(padding_length)
+                header.write(padding)
+                payload_length = packet_length
+                check_size = padding_length + payload_length
+            else:
+                self.ensure_read(1)
+                padding_length = self.read_byte()
+                header.write_byte(padding_length)
+                payload_length = packet_length - padding_length - 1
+                check_size = 4 + 1 + payload_length + padding_length
+            if check_size % self.__block_size != 0:
+                self.__outputbuffer.fail('[exception] invalid ssh packet (block size)').write()
+                sys.exit(exitcodes.CONNECTION_ERROR)
+            self.ensure_read(payload_length)
+            if sshv == 1:
+                payload = self.read(payload_length - 4)
+                header.write(payload)
+                crc = self.read_int()
+                header.write_int(crc)
+            else:
+                payload = self.read(payload_length)
+                header.write(payload)
+            packet_type = ord(payload[0:1])
+            if sshv == 1:
+                rcrc = SSH1.crc32(padding + payload)
+                if crc != rcrc:
+                    self.__outputbuffer.fail('[exception] packet checksum CRC32 mismatch.').write()
+                    sys.exit(exitcodes.CONNECTION_ERROR)
+            else:
+                self.ensure_read(padding_length)
+                padding = self.read(padding_length)
+            payload = payload[1:]
+            return packet_type, payload
+        except SSH_Socket.InsufficientReadException as ex:
+            if ex.args[0] is None:
+                header.write(self.read(self.unread_len))
+                e = header.write_flush().strip()
+            else:
+                e = ex.args[0].encode('utf-8')
+            return -1, e
+
+    def send_packet(self) -> Tuple[int, Optional[str]]:
+        payload = self.write_flush()
+        padding = -(len(payload) + 5) % 8
+        if padding < 4:
+            padding += 8
+        plen = len(payload) + padding + 1
+        pad_bytes = b'\x00' * padding
+        data = struct.pack('>Ib', plen, padding) + payload + pad_bytes
+        return self.send(data)
+
+    def is_connected(self) -> bool:
+        """Returns true if this Socket is connected, False otherwise."""
+        return self.__sock is not None
+
+    def close(self) -> None:
+        self.__cleanup()
+        self.reset()
+        self.__state = 0
+        self.__header = []
+        self.__banner = None
+
+    def _close_socket(self, s: Optional[socket.socket]) -> None:  # pylint: disable=no-self-use
+        try:
+            if s is not None:
+                s.shutdown(socket.SHUT_RDWR)
+                s.close()  # pragma: nocover
+        except Exception:
+            pass
+
+    def __del__(self) -> None:
+        self.__cleanup()
+
+    def __cleanup(self) -> None:
+        self._close_socket(self.__sock)
+        for sock in self.__sock_map.values():
+            self._close_socket(sock)
+        self.__sock = None

src/ssh_audit/timeframe.py

@@ -0,0 +1,77 @@
+"""
+   The MIT License (MIT)
+
+   Copyright (C) 2017 Andris Raugulis (moo@arthepsy.eu)
+
+   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.
+"""
+# pylint: disable=unused-import
+from typing import Dict, List, Set, Sequence, Tuple, Iterable  # noqa: F401
+from typing import Callable, Optional, Union, Any  # noqa: F401
+
+from ssh_audit.algorithm import Algorithm
+
+
+class Timeframe:
+    def __init__(self) -> None:
+        self.__storage: Dict[str, List[Optional[str]]] = {}
+
+    def __contains__(self, product: str) -> bool:
+        return product in self.__storage
+
+    def __getitem__(self, product: str) -> Sequence[Optional[str]]:
+        return tuple(self.__storage.get(product, [None] * 4))
+
+    def __str__(self) -> str:
+        return self.__storage.__str__()
+
+    def __repr__(self) -> str:
+        return self.__str__()
+
+    def get_from(self, product: str, for_server: bool = True) -> Optional[str]:
+        return self[product][0 if bool(for_server) else 2]
+
+    def get_till(self, product: str, for_server: bool = True) -> Optional[str]:
+        return self[product][1 if bool(for_server) else 3]
+
+    def _update(self, versions: Optional[str], pos: int) -> None:
+        ssh_versions: Dict[str, str] = {}
+        for_srv, for_cli = pos < 2, pos > 1
+        for v in (versions or '').split(','):
+            ssh_prod, ssh_ver, is_cli = Algorithm.get_ssh_version(v)
+            if not ssh_ver or (is_cli and for_srv) or (not is_cli and for_cli and ssh_prod in ssh_versions):
+                continue
+            ssh_versions[ssh_prod] = ssh_ver
+        for ssh_product, ssh_version in ssh_versions.items():
+            if ssh_product not in self.__storage:
+                self.__storage[ssh_product] = [None] * 4
+            prev = self[ssh_product][pos]
+            if (prev is None or (prev < ssh_version and pos % 2 == 0) or (prev > ssh_version and pos % 2 == 1)):
+                self.__storage[ssh_product][pos] = ssh_version
+
+    def update(self, versions: List[Optional[str]], for_server: Optional[bool] = None) -> 'Timeframe':
+        for_cli = for_server is None or for_server is False
+        for_srv = for_server is None or for_server is True
+        vlen = len(versions)
+        for i in range(min(3, vlen)):
+            if for_srv and i < 2:
+                self._update(versions[i], i)
+            if for_cli and (i % 2 == 0 or vlen == 2):
+                self._update(versions[i], 3 - 0**i)
+        return self

src/ssh_audit/utils.py

@@ -0,0 +1,165 @@
+"""
+   The MIT License (MIT)
+
+   Copyright (C) 2017-2020 Joe Testa (jtesta@positronsecurity.com)
+   Copyright (C) 2017 Andris Raugulis (moo@arthepsy.eu)
+
+   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.
+"""
+import ipaddress
+import re
+import sys
+
+# pylint: disable=unused-import
+from typing import Dict, List, Set, Sequence, Tuple, Iterable  # noqa: F401
+from typing import Callable, Optional, Union, Any  # noqa: F401
+
+
+class Utils:
+    @classmethod
+    def _type_err(cls, v: Any, target: str) -> TypeError:
+        return TypeError('cannot convert {} to {}'.format(type(v), target))
+
+    @classmethod
+    def to_bytes(cls, v: Union[bytes, str], enc: str = 'utf-8') -> bytes:
+        if isinstance(v, bytes):
+            return v
+        elif isinstance(v, str):
+            return v.encode(enc)
+        raise cls._type_err(v, 'bytes')
+
+    @classmethod
+    def to_text(cls, v: Union[str, bytes], enc: str = 'utf-8') -> str:
+        if isinstance(v, str):
+            return v
+        elif isinstance(v, bytes):
+            return v.decode(enc)
+        raise cls._type_err(v, 'unicode text')
+
+    @classmethod
+    def _is_ascii(cls, v: str, char_filter: Callable[[int], bool] = lambda x: x <= 127) -> bool:
+        r = False
+        if isinstance(v, str):
+            for c in v:
+                i = cls.ctoi(c)
+                if not char_filter(i):
+                    return r
+            r = True
+        return r
+
+    @classmethod
+    def _to_ascii(cls, v: str, char_filter: Callable[[int], bool] = lambda x: x <= 127, errors: str = 'replace') -> str:
+        if isinstance(v, str):
+            r = bytearray()
+            for c in v:
+                i = cls.ctoi(c)
+                if char_filter(i):
+                    r.append(i)
+                else:
+                    if errors == 'ignore':
+                        continue
+                    r.append(63)
+            return cls.to_text(r.decode('ascii'))
+        raise cls._type_err(v, 'ascii')
+
+    @classmethod
+    def is_ascii(cls, v: str) -> bool:
+        return cls._is_ascii(v)
+
+    @classmethod
+    def to_ascii(cls, v: str, errors: str = 'replace') -> str:
+        return cls._to_ascii(v, errors=errors)
+
+    @classmethod
+    def is_print_ascii(cls, v: str) -> bool:
+        return cls._is_ascii(v, lambda x: 126 >= x >= 32)
+
+    @classmethod
+    def to_print_ascii(cls, v: str, errors: str = 'replace') -> str:
+        return cls._to_ascii(v, lambda x: 126 >= x >= 32, errors)
+
+    @classmethod
+    def unique_seq(cls, seq: Sequence[Any]) -> Sequence[Any]:
+        seen: Set[Any] = set()
+
+        def _seen_add(x: Any) -> bool:
+            seen.add(x)
+            return False
+
+        if isinstance(seq, tuple):
+            return tuple(x for x in seq if x not in seen and not _seen_add(x))
+        else:
+            return [x for x in seq if x not in seen and not _seen_add(x)]
+
+    @classmethod
+    def ctoi(cls, c: Union[str, int]) -> int:
+        if isinstance(c, str):
+            return ord(c[0])
+        else:
+            return c
+
+    @staticmethod
+    def parse_int(v: Any) -> int:
+        try:
+            return int(v)
+        except ValueError:
+            return 0
+
+    @staticmethod
+    def parse_float(v: Any) -> float:
+        try:
+            return float(v)
+        except ValueError:
+            return -1.0
+
+    @staticmethod
+    def parse_host_and_port(host_and_port: str, default_port: int = 0) -> Tuple[str, int]:
+        '''Parses a string into a tuple of its host and port.  The port is 0 if not specified.'''
+        host = host_and_port
+        port = default_port
+
+        mx = re.match(r'^\[([^\]]+)\](?::(\d+))?$', host_and_port)
+        if mx is not None:
+            host = mx.group(1)
+            port_str = mx.group(2)
+            if port_str is not None:
+                port = int(port_str)
+        else:
+            s = host_and_port.split(':')
+            if len(s) == 2:
+                host = s[0]
+                if len(s[1]) > 0:
+                    port = int(s[1])
+
+        return host, port
+
+    @staticmethod
+    def is_ipv6_address(address: str) -> bool:
+        '''Returns True if address is an IPv6 address, otherwise False.'''
+        is_ipv6 = True
+        try:
+            ipaddress.IPv6Address(address)
+        except ipaddress.AddressValueError:
+            is_ipv6 = False
+
+        return is_ipv6
+
+    @staticmethod
+    def is_windows() -> bool:
+        return sys.platform in ['win32', 'cygwin']

src/ssh_audit/versionvulnerabilitydb.py

@@ -0,0 +1,151 @@
+"""
+   The MIT License (MIT)
+
+   Copyright (C) 2017-2020 Joe Testa (jtesta@positronsecurity.com)
+   Copyright (C) 2017 Andris Raugulis (moo@arthepsy.eu)
+
+   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.
+"""
+# pylint: disable=unused-import
+from typing import Dict, List, Set, Sequence, Tuple, Iterable  # noqa: F401
+from typing import Callable, Optional, Union, Any  # noqa: F401
+
+
+class VersionVulnerabilityDB:  # pylint: disable=too-few-public-methods
+    # Format: [starting_vuln_version, last_vuln_version, affected, CVE_ID, CVSSv2, description]
+    #   affected: 1 = server, 2 = client, 4 = local
+    #   Example:  if it affects servers, both remote & local, then affected
+    #             = 1.  If it affects servers, but is a local issue only,
+    #             then affected = 1 + 4 = 5.
+    CVE: Dict[str, List[List[Any]]] = {
+        'Dropbear SSH': [
+            ['0.0', '2018.76', 1, 'CVE-2018-15599', 5.0, 'remote users may enumerate users on the system'],
+            ['0.0', '2017.74', 5, 'CVE-2017-9079', 4.7, 'local users can read certain files as root'],
+            ['0.0', '2017.74', 5, 'CVE-2017-9078', 9.3, 'local users may elevate privileges to root under certain conditions'],
+            ['0.0', '2016.73', 5, 'CVE-2016-7409', 2.1, 'local users can read process memory under limited conditions'],
+            ['0.0', '2016.73', 1, 'CVE-2016-7408', 6.5, 'remote users can execute arbitrary code'],
+            ['0.0', '2016.73', 5, 'CVE-2016-7407', 10.0, 'local users can execute arbitrary code'],
+            ['0.0', '2016.73', 1, 'CVE-2016-7406', 10.0, 'remote users can execute arbitrary code'],
+            ['0.44', '2015.71', 1, 'CVE-2016-3116', 5.5, 'bypass command restrictions via xauth command injection'],
+            ['0.28', '2013.58', 1, 'CVE-2013-4434', 5.0, 'discover valid usernames through different time delays'],
+            ['0.28', '2013.58', 1, 'CVE-2013-4421', 5.0, 'cause DoS via a compressed packet (memory consumption)'],
+            ['0.52', '2011.54', 1, 'CVE-2012-0920', 7.1, 'execute arbitrary code or bypass command restrictions'],
+            ['0.40', '0.48.1',  1, 'CVE-2007-1099', 7.5, 'conduct a MitM attack (no warning for hostkey mismatch)'],
+            ['0.28', '0.47',    1, 'CVE-2006-1206', 7.5, 'cause DoS via large number of connections (slot exhaustion)'],
+            ['0.39', '0.47',    1, 'CVE-2006-0225', 4.6, 'execute arbitrary commands via scp with crafted filenames'],
+            ['0.28', '0.46',    1, 'CVE-2005-4178', 6.5, 'execute arbitrary code via buffer overflow vulnerability'],
+            ['0.28', '0.42',    1, 'CVE-2004-2486', 7.5, 'execute arbitrary code via DSS verification code']],
+        'libssh': [
+            ['0.6.4',   '0.6.4',  1, 'CVE-2018-10933', 6.4, 'authentication bypass'],
+            ['0.7.0',   '0.7.5',  1, 'CVE-2018-10933', 6.4, 'authentication bypass'],
+            ['0.8.0',   '0.8.3',  1, 'CVE-2018-10933', 6.4, 'authentication bypass'],
+            ['0.1',   '0.7.2',  1, 'CVE-2016-0739', 4.3, 'conduct a MitM attack (weakness in DH key generation)'],
+            ['0.5.1', '0.6.4',  1, 'CVE-2015-3146', 5.0, 'cause DoS via kex packets (null pointer dereference)'],
+            ['0.5.1', '0.6.3',  1, 'CVE-2014-8132', 5.0, 'cause DoS via kex init packet (dangling pointer)'],
+            ['0.4.7', '0.6.2',  1, 'CVE-2014-0017', 1.9, 'leak data via PRNG state reuse on forking servers'],
+            ['0.4.7', '0.5.3',  1, 'CVE-2013-0176', 4.3, 'cause DoS via kex packet (null pointer dereference)'],
+            ['0.4.7', '0.5.2',  1, 'CVE-2012-6063', 7.5, 'cause DoS or execute arbitrary code via sftp (double free)'],
+            ['0.4.7', '0.5.2',  1, 'CVE-2012-4562', 7.5, 'cause DoS or execute arbitrary code (overflow check)'],
+            ['0.4.7', '0.5.2',  1, 'CVE-2012-4561', 5.0, 'cause DoS via unspecified vectors (invalid pointer)'],
+            ['0.4.7', '0.5.2',  1, 'CVE-2012-4560', 7.5, 'cause DoS or execute arbitrary code (buffer overflow)'],
+            ['0.4.7', '0.5.2',  1, 'CVE-2012-4559', 6.8, 'cause DoS or execute arbitrary code (double free)']],
+        'OpenSSH': [
+            ['1.0',     '7.7',     1, 'CVE-2018-15473', 5.3, 'enumerate usernames due to timing discrepencies'],
+            ['7.2',     '7.2p2',   1, 'CVE-2016-6515',  7.8, 'cause DoS via long password string (crypt CPU consumption)'],
+            ['1.2.2',   '7.2',     1, 'CVE-2016-3115',  5.5, 'bypass command restrictions via crafted X11 forwarding data'],
+            ['5.4',     '7.1',     1, 'CVE-2016-1907',  5.0, 'cause DoS via crafted network traffic (out of bounds read)'],
+            ['5.4',     '7.1p1',   2, 'CVE-2016-0778',  4.6, 'cause DoS via requesting many forwardings (heap based buffer overflow)'],
+            ['5.0',     '7.1p1',   2, 'CVE-2016-0777',  4.0, 'leak data via allowing transfer of entire buffer'],
+            ['6.0',     '7.2p2',   5, 'CVE-2015-8325',  7.2, 'privilege escalation via triggering crafted environment'],
+            ['6.8',     '6.9',     5, 'CVE-2015-6565',  7.2, 'cause DoS via writing to a device (terminal disruption)'],
+            ['5.0',     '6.9',     5, 'CVE-2015-6564',  6.9, 'privilege escalation via leveraging sshd uid'],
+            ['5.0',     '6.9',     5, 'CVE-2015-6563',  1.9, 'conduct impersonation attack'],
+            ['6.9p1',   '6.9p1',   1, 'CVE-2015-5600',  8.5, 'cause Dos or aid in conduct brute force attack (CPU consumption)'],
+            ['6.0',     '6.6',     1, 'CVE-2015-5352',  4.3, 'bypass access restrictions via a specific connection'],
+            ['6.0',     '6.6',     2, 'CVE-2014-2653',  5.8, 'bypass SSHFP DNS RR check via unacceptable host certificate'],
+            ['5.0',     '6.5',     1, 'CVE-2014-2532',  5.8, 'bypass environment restrictions via specific string before wildcard'],
+            ['1.2',     '6.4',     1, 'CVE-2014-1692',  7.5, 'cause DoS via triggering error condition (memory corruption)'],
+            ['6.2',     '6.3',     1, 'CVE-2013-4548',  6.0, 'bypass command restrictions via crafted packet data'],
+            ['1.2',     '5.6',     1, 'CVE-2012-0814',  3.5, 'leak data via debug messages'],
+            ['1.2',     '5.8',     1, 'CVE-2011-5000',  3.5, 'cause DoS via large value in certain length field (memory consumption)'],
+            ['5.6',     '5.7',     2, 'CVE-2011-0539',  5.0, 'leak data or conduct hash collision attack'],
+            ['1.2',     '6.1',     1, 'CVE-2010-5107',  5.0, 'cause DoS via large number of connections (slot exhaustion)'],
+            ['1.2',     '5.8',     1, 'CVE-2010-4755',  4.0, 'cause DoS via crafted glob expression (CPU and memory consumption)'],
+            ['1.2',     '5.6',     1, 'CVE-2010-4478',  7.5, 'bypass authentication check via crafted values'],
+            ['4.3',     '4.8',     1, 'CVE-2009-2904',  6.9, 'privilege escalation via hard links to setuid programs'],
+            ['4.0',     '5.1',     1, 'CVE-2008-5161',  2.6, 'recover plaintext data from ciphertext'],
+            ['1.2',     '4.6',     1, 'CVE-2008-4109',  5.0, 'cause DoS via multiple login attempts (slot exhaustion)'],
+            ['1.2',     '4.8',     1, 'CVE-2008-1657',  6.5, 'bypass command restrictions via modifying session file'],
+            ['1.2.2',   '4.9',     1, 'CVE-2008-1483',  6.9, 'hijack forwarded X11 connections'],
+            ['4.0',     '4.6',     1, 'CVE-2007-4752',  7.5, 'privilege escalation via causing an X client to be trusted'],
+            ['4.3p2',   '4.3p2',   1, 'CVE-2007-3102',  4.3, 'allow attacker to write random data to audit log'],
+            ['1.2',     '4.6',     1, 'CVE-2007-2243',  5.0, 'discover valid usernames through different responses'],
+            ['4.4',     '4.4',     1, 'CVE-2006-5794',  7.5, 'bypass authentication'],
+            ['4.1',     '4.1p1',   1, 'CVE-2006-5229',  2.6, 'discover valid usernames through different time delays'],
+            ['1.2',     '4.3p2',   1, 'CVE-2006-5052',  5.0, 'discover valid usernames through different responses'],
+            ['1.2',     '4.3p2',   1, 'CVE-2006-5051',  9.3, 'cause DoS or execute arbitrary code (double free)'],
+            ['4.5',     '4.5',     1, 'CVE-2006-4925',  5.0, 'cause DoS via invalid protocol sequence (crash)'],
+            ['1.2',     '4.3p2',   1, 'CVE-2006-4924',  7.8, 'cause DoS via crafted packet (CPU consumption)'],
+            ['3.8.1p1', '3.8.1p1', 1, 'CVE-2006-0883',  5.0, 'cause DoS via connecting multiple times (client connection refusal)'],
+            ['3.0',     '4.2p1',   1, 'CVE-2006-0225',  4.6, 'execute arbitrary code'],
+            ['2.1',     '4.1p1',   1, 'CVE-2005-2798',  5.0, 'leak data about authentication credentials'],
+            ['3.5',     '3.5p1',   1, 'CVE-2004-2760',  6.8, 'leak data through different connection states'],
+            ['2.3',     '3.7.1p2', 1, 'CVE-2004-2069',  5.0, 'cause DoS via large number of connections (slot exhaustion)'],
+            ['3.0',     '3.4p1',   1, 'CVE-2004-0175',  4.3, 'leak data through directoy traversal'],
+            ['1.2',     '3.9p1',   1, 'CVE-2003-1562',  7.6, 'leak data about authentication credentials'],
+            ['3.1p1',   '3.7.1p1', 1, 'CVE-2003-0787',  7.5, 'privilege escalation via modifying stack'],
+            ['3.1p1',   '3.7.1p1', 1, 'CVE-2003-0786', 10.0, 'privilege escalation via bypassing authentication'],
+            ['1.0',     '3.7.1',   1, 'CVE-2003-0695',  7.5, 'cause DoS or execute arbitrary code'],
+            ['1.0',     '3.7',     1, 'CVE-2003-0693', 10.0, 'execute arbitrary code'],
+            ['3.0',     '3.6.1p2', 1, 'CVE-2003-0386',  7.5, 'bypass address restrictions for connection'],
+            ['3.1p1',   '3.6.1p1', 1, 'CVE-2003-0190',  5.0, 'discover valid usernames through different time delays'],
+            ['3.2.2',   '3.2.2',   1, 'CVE-2002-0765',  7.5, 'bypass authentication'],
+            ['1.2.2',   '3.3p1',   1, 'CVE-2002-0640', 10.0, 'execute arbitrary code'],
+            ['1.2.2',   '3.3p1',   1, 'CVE-2002-0639', 10.0, 'execute arbitrary code'],
+            ['2.1',     '3.2',     1, 'CVE-2002-0575',  7.5, 'privilege escalation'],
+            ['2.1',     '3.0.2p1', 2, 'CVE-2002-0083', 10.0, 'privilege escalation'],
+            ['3.0',     '3.0p1',   1, 'CVE-2001-1507',  7.5, 'bypass authentication'],
+            ['1.2.3',   '3.0.1p1', 5, 'CVE-2001-0872',  7.2, 'privilege escalation via crafted environment variables'],
+            ['1.2.3',   '2.1.1',   1, 'CVE-2001-0361',  4.0, 'recover plaintext from ciphertext'],
+            ['1.2',     '2.1',     1, 'CVE-2000-0525', 10.0, 'execute arbitrary code (improper privileges)']],
+        'PuTTY': [
+            ['0.54', '0.73', 2, 'CVE-2020-XXXX', 5.0, 'out of bounds memory read'],
+            ['0.0', '0.72', 2, 'CVE-2019-17069', 5.0, 'potential DOS by remote SSHv1 server'],
+            ['0.71', '0.72', 2, 'CVE-2019-17068', 5.0, 'xterm bracketed paste mode command injection'],
+            ['0.52', '0.72', 2, 'CVE-2019-17067', 7.5, 'port rebinding weakness in port forward tunnel handling'],
+            ['0.0', '0.71', 2, 'CVE-2019-XXXX', 5.0, 'undefined vulnerability in obsolete SSHv1 protocol handling'],
+            ['0.0', '0.71', 6, 'CVE-2019-XXXX', 5.0, 'local privilege escalation in Pageant'],
+            ['0.0', '0.70', 2, 'CVE-2019-9898', 7.5, 'potential recycling of random numbers'],
+            ['0.0', '0.70', 2, 'CVE-2019-9897', 5.0, 'multiple denial-of-service issues from writing to the terminal'],
+            ['0.0', '0.70', 6, 'CVE-2019-9896', 4.6, 'local application hijacking through malicious Windows help file'],
+            ['0.0', '0.70', 2, 'CVE-2019-9894', 6.4, 'buffer overflow in RSA key exchange'],
+            ['0.0', '0.69', 6, 'CVE-2016-6167', 4.4, 'local application hijacking through untrusted DLL loading'],
+            ['0.0', '0.67', 2, 'CVE-2017-6542', 7.5, 'buffer overflow in UNIX client that can result in privilege escalation or denial-of-service'],
+            ['0.0', '0.66', 2, 'CVE-2016-2563', 7.5, 'buffer overflow in SCP command-line utility'],
+            ['0.0', '0.65', 2, 'CVE-2015-5309', 4.3, 'integer overflow in terminal-handling code'],
+        ]
+    }
+    TXT: Dict[str, List[List[Any]]] = {
+        'Dropbear SSH': [
+            ['0.28', '0.34', 1, 'remote root exploit', 'remote format string buffer overflow exploit (exploit-db#387)']],
+        'libssh': [
+            ['0.3.3', '0.3.3', 1, 'null pointer check', 'missing null pointer check in "crypt_set_algorithms_server"'],
+            ['0.3.3', '0.3.3', 1, 'integer overflow',   'integer overflow in "buffer_get_data"'],
+            ['0.3.3', '0.3.3', 3, 'heap overflow',      'heap overflow in "packet_decrypt"']]
+    }

src/ssh_audit/writebuf.py

@@ -0,0 +1,108 @@
+"""
+   The MIT License (MIT)
+
+   Copyright (C) 2017 Andris Raugulis (moo@arthepsy.eu)
+
+   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.
+"""
+import io
+import struct
+
+# pylint: disable=unused-import
+from typing import Dict, List, Set, Sequence, Tuple, Iterable  # noqa: F401
+from typing import Callable, Optional, Union, Any  # noqa: F401
+
+
+class WriteBuf:
+    def __init__(self, data: Optional[bytes] = None) -> None:
+        super(WriteBuf, self).__init__()
+        self._wbuf = io.BytesIO(data) if data is not None else io.BytesIO()
+
+    def write(self, data: bytes) -> 'WriteBuf':
+        self._wbuf.write(data)
+        return self
+
+    def write_byte(self, v: int) -> 'WriteBuf':
+        return self.write(struct.pack('B', v))
+
+    def write_bool(self, v: bool) -> 'WriteBuf':
+        return self.write_byte(1 if v else 0)
+
+    def write_int(self, v: int) -> 'WriteBuf':
+        return self.write(struct.pack('>I', v))
+
+    def write_string(self, v: Union[bytes, str]) -> 'WriteBuf':
+        if not isinstance(v, bytes):
+            v = bytes(bytearray(v, 'utf-8'))
+        self.write_int(len(v))
+        return self.write(v)
+
+    def write_list(self, v: List[str]) -> 'WriteBuf':
+        return self.write_string(','.join(v))
+
+    @classmethod
+    def _bitlength(cls, n: int) -> int:
+        try:
+            return n.bit_length()
+        except AttributeError:
+            return len(bin(n)) - (2 if n > 0 else 3)
+
+    @classmethod
+    def _create_mpint(cls, n: int, signed: bool = True, bits: Optional[int] = None) -> bytes:
+        if bits is None:
+            bits = cls._bitlength(n)
+        length = bits // 8 + (1 if n != 0 else 0)
+        ql = (length + 7) // 8
+        fmt, v2 = '>{}Q'.format(ql), [0] * ql
+        for i in range(ql):
+            v2[ql - i - 1] = n & 0xffffffffffffffff
+            n >>= 64
+        data = bytes(struct.pack(fmt, *v2)[-length:])
+        if not signed:
+            data = data.lstrip(b'\x00')
+        elif data.startswith(b'\xff\x80'):
+            data = data[1:]
+        return data
+
+    def write_mpint1(self, n: int) -> 'WriteBuf':
+        # NOTE: Data Type Enc @ http://www.snailbook.com/docs/protocol-1.5.txt
+        bits = self._bitlength(n)
+        data = self._create_mpint(n, False, bits)
+        self.write(struct.pack('>H', bits))
+        return self.write(data)
+
+    def write_mpint2(self, n: int) -> 'WriteBuf':
+        # NOTE: Section 5 @ https://www.ietf.org/rfc/rfc4251.txt
+        data = self._create_mpint(n)
+        return self.write_string(data)
+
+    def write_line(self, v: Union[bytes, str]) -> 'WriteBuf':
+        if not isinstance(v, bytes):
+            v = bytes(bytearray(v, 'utf-8'))
+        v += b'\r\n'
+        return self.write(v)
+
+    def write_flush(self) -> bytes:
+        payload = self._wbuf.getvalue()
+        self._wbuf.truncate(0)
+        self._wbuf.seek(0)
+        return payload
+
+    def reset(self) -> None:
+        self._wbuf = io.BytesIO()

ssh-audit.1

@@ -0,0 +1,245 @@
+.TH SSH-AUDIT 1 "March 2, 2021"
+.SH NAME
+\fBssh-audit\fP \- SSH server & client configuration auditor
+.SH SYNOPSIS
+.B ssh-audit
+.RI [ options ] " <target_host>"
+.SH DESCRIPTION
+.PP
+\fBssh-audit\fP analyzes the configuration of SSH servers & clients, then warns the user of weak, obsolete, and/or un-tested cryptographic primitives.  It is very useful for hardening SSH tunnels, which by default tend to be optimized for compatibility, not security.
+.PP
+See <https://www.ssh\-audit.com/> for official hardening guides for common platforms.
+
+.SH OPTIONS
+.TP
+.B -h, \-\-help
+.br
+Print short summary of options.
+
+.TP
+.B -1, \-\-ssh1
+.br
+Only perform an audit using SSH protocol version 1.
+
+.TP
+.B -2, \-\-ssh2
+.br
+Only perform an audit using SSH protocol version 2.
+
+.TP
+.B -4, \-\-ipv4
+.br
+Prioritize the usage of IPv4.
+
+.TP
+.B -6, \-\-ipv6
+.br
+Prioritize the usage of IPv6.
+
+.TP
+.B -b, \-\-batch
+.br
+Enables grepable output.
+
+.TP
+.B -c, \-\-client\-audit
+.br
+Starts a server on port 2222 to audit client software configuration.  Use -p/--port=<port> to change port and -t/--timeout=<secs> to change listen timeout.
+
+.TP
+.B -d, \-\-debug
+.br
+Enable debug output.
+
+.TP
+.B -j, \-\-json
+.br
+Output results in JSON format.  Specify twice (-jj) to enable indent printing (useful for debugging).
+
+.TP
+.B -l, \-\-level=<info|warn|fail>
+.br
+Specify the minimum output level.  Default is info.
+
+.TP
+.B -L, \-\-list-policies
+.br
+List all official, built-in policies for common systems.  Their full names can then be passed to -P/--policy.
+
+.TP
+.B \-\-lookup=<alg1,alg2,...>
+.br
+Look up the security information of an algorithm(s) in the internal database.  Does not connect to a server.
+
+.TP
+.B -m, \-\-manual
+.br
+Print the man page (Windows only).
+
+.TP
+.B -M, \-\-make-policy=<custom_policy.txt>
+.br
+Creates a policy based on the target server.  Useful when other servers should be compared to the target server's custom configuration (i.e.: a cluster environment).  Note that the resulting policy can be edited manually.
+
+.TP
+.B -n, \-\-no-colors
+.br
+Disable color output.
+
+.TP
+.B -p, \-\-port=<port>
+.br
+The TCP port to connect to when auditing a server, or the port to listen on when auditing a client.
+
+.TP
+.B -P, \-\-policy=<"built-in policy name" | path/to/custom_policy.txt>
+.br
+Runs a policy audit against a target using the specified policy (see \fBPOLICY AUDIT\fP section for detailed description of this mode of operation).  Combine with -c/--client-audit to audit a client configuration instead of a server.  Use -L/--list-policies to list all official, built-in policies for common systems.
+
+.TP
+.B -t, \-\-timeout=<secs>
+.br
+The timeout, in seconds, for creating connections and reading data from the socket.  Default is 5.
+
+.TP
+.B -T, \-\-targets=<hosts.txt>
+.br
+A file containing a list of target hosts.  Each line must have one host, in the format of HOST[:PORT].  Use --threads to control concurrent scans.
+
+.TP
+.B     \-\-threads=<threads>
+.br
+The number of threads to use when scanning multiple targets (with -T/--targets).  Default is 32.
+
+.TP
+.B -v, \-\-verbose
+.br
+Enable verbose output.
+
+
+.SH STANDARD AUDIT
+.PP
+By default, \fBssh-audit\fP performs a standard audit.  That is, it enumerates all host key types, key exchanges, ciphers, MACs, and other information, then color-codes them in output to the user.  Cryptographic primitives with potential issues are displayed in yellow; primitives with serious flaws are displayed in red.
+
+
+.SH POLICY AUDIT
+.PP
+When the -P/--policy option is used, \fBssh-audit\fP performs a policy audit.  The target's host key types, key exchanges, ciphers, MACs, and other information is compared to a set of expected values defined in the specified policy file.  If everything matches, only a short message stating a passing result is reported.  Otherwise, the field(s) that did not match are reported.
+
+.PP
+Policy auditing is helpful for ensuring a group of related servers are properly hardened to an exact specification.
+
+.PP
+The set of official built-in policies can be viewed with -L/--list-policies.  Multiple servers can be audited with -T/--targets=<servers.txt>.  Custom policies can be made from an ideal target server with -M/--make-policy=<custom_policy.txt>.
+
+
+.SH EXAMPLES
+.LP
+Basic server auditing:
+.RS
+.nf
+ssh-audit localhost
+ssh-audit 127.0.0.1
+ssh-audit 127.0.0.1:222
+ssh-audit ::1
+ssh-audit [::1]:222
+.fi
+.RE
+
+.LP
+To run a standard audit against many servers (place targets into servers.txt, one on each line in the format of HOST[:PORT]):
+.RS
+.nf
+ssh-audit -T servers.txt
+.fi
+.RE
+
+.LP
+To audit a client configuration (listens on port 2222 by default; connect using "ssh -p 2222 anything@localhost"):
+.RS
+.nf
+ssh-audit -c
+.fi
+.RE
+
+.LP
+To audit a client configuration, with a listener on port 4567:
+.RS
+.nf
+ssh-audit -c -p 4567
+.fi
+.RE
+
+.LP
+To list all official built-in policies (hint: use their full names with -P/--policy):
+.RS
+.nf
+ssh-audit -L
+.fi
+.RE
+
+.LP
+To run a built-in policy audit against a server (hint: use -L to see list of built-in policies):
+.RS
+.nf
+ssh-audit -P "Hardened Ubuntu Server 20.04 LTS (version 1)" targetserver
+.fi
+.RE
+
+
+.LP
+To run a custom policy audit against a server (hint: use -M/--make-policy to create a custom policy file):
+.RS
+.nf
+ssh-audit -P path/to/server_policy.txt targetserver
+.fi
+.RE
+
+.LP
+To run a policy audit against a client:
+.RS
+.nf
+ssh-audit -c -P ["policy name" | path/to/client_policy.txt]
+.fi
+.RE
+
+.LP
+To run a policy audit against many servers:
+.RS
+.nf
+ssh-audit -T servers.txt -P ["policy name" | path/to/server_policy.txt]
+.fi
+.RE
+
+.LP
+To create a policy based on a target server (which can be manually edited; see official built-in policies for syntax examples):
+.RS
+.nf
+ssh-audit -M new_policy.txt targetserver
+.fi
+.RE
+
+.SH RETURN VALUES
+When a successful connection is made and all algorithms are rated as "good", \fBssh-audit\fP returns 0.  Other possible return values are:
+
+.RS
+.nf
+1 = connection error
+2 = at least one algorithm warning was found
+3 = at least one algorithm failure was found
+<any other non-zero value> = unknown error
+.fi
+.RE
+
+.SH SSH HARDENING GUIDES
+Hardening guides for common platforms can be found at: <https://www.ssh\-audit.com/>
+
+.SH BUG REPORTS
+Please file bug reports as a Github Issue at: <https://github.com/jtesta/ssh\-audit/issues>
+
+.SH AUTHOR
+.LP
+\fBssh-audit\fP was originally written by Andris Raugulis <moo@arthepsy.eu>, and maintained from 2015 to 2017.
+.br
+.LP
+Maintainership was assumed and development was resumed in 2017 by Joe Testa <jtesta@positronsecurity.com>.

test/conftest.py

@@ -1,156 +1,145 @@
-#!/usr/bin/env python
-# -*- coding: utf-8 -*-
-import os
 import io
 import sys
 import socket
 import pytest
 
 
-if sys.version_info[0] == 2:
-	import StringIO  # pylint: disable=import-error
-	StringIO = StringIO.StringIO
-else:
-	StringIO = io.StringIO
-
-
 @pytest.fixture(scope='module')
 def ssh_audit():
-	__rdir = os.path.join(os.path.dirname(os.path.abspath(__file__)), '..')
+    import ssh_audit.ssh_audit
-	sys.path.append(os.path.abspath(__rdir))
+    return ssh_audit.ssh_audit
-	return __import__('ssh-audit')
 
 
 # pylint: disable=attribute-defined-outside-init
 class _OutputSpy(list):
-	def begin(self):
+    def begin(self):
-		self.__out = StringIO()
+        self.__out = io.StringIO()
-		self.__old_stdout = sys.stdout
+        self.__old_stdout = sys.stdout
-		sys.stdout = self.__out
+        sys.stdout = self.__out
 
-	def flush(self):
+    def flush(self):
-		lines = self.__out.getvalue().splitlines()
+        lines = self.__out.getvalue().splitlines()
-		sys.stdout = self.__old_stdout
+        sys.stdout = self.__old_stdout
-		self.__out = None
+        self.__out = None
-		return lines
+        return lines
 
 
 @pytest.fixture(scope='module')
 def output_spy():
-	return _OutputSpy()
+    return _OutputSpy()
 
 
-class _VirtualGlobalSocket(object):
+class _VirtualGlobalSocket:
-	def __init__(self, vsocket):
+    def __init__(self, vsocket):
-		self.vsocket = vsocket
+        self.vsocket = vsocket
-		self.addrinfodata = {}
+        self.addrinfodata = {}
 
-	# pylint: disable=unused-argument
+    # pylint: disable=unused-argument
-	def create_connection(self, address, timeout=0, source_address=None):
+    def create_connection(self, address, timeout=0, source_address=None):
-		# pylint: disable=protected-access
+        # pylint: disable=protected-access
-		return self.vsocket._connect(address, True)
+        return self.vsocket._connect(address, True)
 
-	# pylint: disable=unused-argument
+    # pylint: disable=unused-argument
-	def socket(self,
+    def socket(self,
-	           family=socket.AF_INET,
+               family=socket.AF_INET,
-	           socktype=socket.SOCK_STREAM,
+               socktype=socket.SOCK_STREAM,
-	           proto=0,
+               proto=0,
-	           fileno=None):
+               fileno=None):
-		return self.vsocket
+        return self.vsocket
 
-	def getaddrinfo(self, host, port, family=0, socktype=0, proto=0, flags=0):
+    def getaddrinfo(self, host, port, family=0, socktype=0, proto=0, flags=0):
-		key = '{0}#{1}'.format(host, port)
+        key = '{}#{}'.format(host, port)
-		if key in self.addrinfodata:
+        if key in self.addrinfodata:
-			data = self.addrinfodata[key]
+            data = self.addrinfodata[key]
-			if isinstance(data, Exception):
+            if isinstance(data, Exception):
-				raise data
+                raise data
-			return data
+            return data
-		if host == 'localhost':
+        if host == 'localhost':
-			r = []
+            r = []
-			if family in (0, socket.AF_INET):
+            if family in (0, socket.AF_INET):
-				r.append((socket.AF_INET, 1, 6, '', ('127.0.0.1', port)))
+                r.append((socket.AF_INET, 1, 6, '', ('127.0.0.1', port)))
-			if family in (0, socket.AF_INET6):
+            if family in (0, socket.AF_INET6):
-				r.append((socket.AF_INET6, 1, 6, '', ('::1', port)))
+                r.append((socket.AF_INET6, 1, 6, '', ('::1', port)))
-			return r
+            return r
-		return []
+        return []
 
 
-class _VirtualSocket(object):
+class _VirtualSocket:
-	def __init__(self):
+    def __init__(self):
-		self.sock_address = ('127.0.0.1', 0)
+        self.sock_address = ('127.0.0.1', 0)
-		self.peer_address = None
+        self.peer_address = None
-		self._connected = False
+        self._connected = False
-		self.timeout = -1.0
+        self.timeout = -1.0
-		self.rdata = []
+        self.rdata = []
-		self.sdata = []
+        self.sdata = []
-		self.errors = {}
+        self.errors = {}
-		self.gsock = _VirtualGlobalSocket(self)
+        self.gsock = _VirtualGlobalSocket(self)
 
-	def _check_err(self, method):
+    def _check_err(self, method):
-		method_error = self.errors.get(method)
+        method_error = self.errors.get(method)
-		if method_error:
+        if method_error:
-			raise method_error
+            raise method_error
 
-	def connect(self, address):
+    def connect(self, address):
-		return self._connect(address, False)
+        return self._connect(address, False)
 
-	def _connect(self, address, ret=True):
+    def _connect(self, address, ret=True):
-		self.peer_address = address
+        self.peer_address = address
-		self._connected = True
+        self._connected = True
-		self._check_err('connect')
+        self._check_err('connect')
-		return self if ret else None
+        return self if ret else None
 
-	def settimeout(self, timeout):
+    def settimeout(self, timeout):
-		self.timeout = timeout
+        self.timeout = timeout
 
-	def gettimeout(self):
+    def gettimeout(self):
-		return self.timeout
+        return self.timeout
 
-	def getpeername(self):
+    def getpeername(self):
-		if self.peer_address is None or not self._connected:
+        if self.peer_address is None or not self._connected:
-			raise socket.error(57, 'Socket is not connected')
+            raise OSError(57, 'Socket is not connected')
-		return self.peer_address
+        return self.peer_address
 
-	def getsockname(self):
+    def getsockname(self):
-		return self.sock_address
+        return self.sock_address
 
-	def bind(self, address):
+    def bind(self, address):
-		self.sock_address = address
+        self.sock_address = address
 
-	def listen(self, backlog):
+    def listen(self, backlog):
-		pass
+        pass
 
-	def accept(self):
+    def accept(self):
-		# pylint: disable=protected-access
+        # pylint: disable=protected-access
-		conn = _VirtualSocket()
+        conn = _VirtualSocket()
-		conn.sock_address = self.sock_address
+        conn.sock_address = self.sock_address
-		conn.peer_address = ('127.0.0.1', 0)
+        conn.peer_address = ('127.0.0.1', 0)
-		conn._connected = True
+        conn._connected = True
-		return conn, conn.peer_address
+        return conn, conn.peer_address
 
-	def recv(self, bufsize, flags=0):
+    def recv(self, bufsize, flags=0):
-		# pylint: disable=unused-argument
+        # pylint: disable=unused-argument
-		if not self._connected:
+        if not self._connected:
-			raise socket.error(54, 'Connection reset by peer')
+            raise OSError(54, 'Connection reset by peer')
-		if not len(self.rdata) > 0:
+        if not len(self.rdata) > 0:
-			return b''
+            return b''
-		data = self.rdata.pop(0)
+        data = self.rdata.pop(0)
-		if isinstance(data, Exception):
+        if isinstance(data, Exception):
-			raise data
+            raise data
-		return data
+        return data
 
-	def send(self, data):
+    def send(self, data):
-		if self.peer_address is None or not self._connected:
+        if self.peer_address is None or not self._connected:
-			raise socket.error(32, 'Broken pipe')
+            raise OSError(32, 'Broken pipe')
-		self._check_err('send')
+        self._check_err('send')
-		self.sdata.append(data)
+        self.sdata.append(data)
 
 
 @pytest.fixture()
 def virtual_socket(monkeypatch):
-	vsocket = _VirtualSocket()
+    vsocket = _VirtualSocket()
-	gsock = vsocket.gsock
+    gsock = vsocket.gsock
-	monkeypatch.setattr(socket, 'create_connection', gsock.create_connection)
+    monkeypatch.setattr(socket, 'create_connection', gsock.create_connection)
-	monkeypatch.setattr(socket, 'socket', gsock.socket)
+    monkeypatch.setattr(socket, 'socket', gsock.socket)
-	monkeypatch.setattr(socket, 'getaddrinfo', gsock.getaddrinfo)
+    monkeypatch.setattr(socket, 'getaddrinfo', gsock.getaddrinfo)
-	return vsocket
+    return vsocket

test/docker/expected_results/dropbear_2019.78_test1.json

@@ -1 +1 @@
-{"banner": {"comments": null, "protocol": [2, 0], "raw": "SSH-2.0-dropbear_2019.78", "software": "dropbear_2019.78"}, "compression": ["zlib@openssh.com", "none"], "enc": ["aes128-ctr", "aes256-ctr", "aes128-cbc", "aes256-cbc", "3des-ctr", "3des-cbc"], "fingerprints": [{"fp": "SHA256:CDfAU12pjQS7/91kg7gYacza0U/6PDbE04Ic3IpYxkM", "type": "ssh-rsa"}], "kex": [{"algorithm": "curve25519-sha256"}, {"algorithm": "curve25519-sha256@libssh.org"}, {"algorithm": "ecdh-sha2-nistp521"}, {"algorithm": "ecdh-sha2-nistp384"}, {"algorithm": "ecdh-sha2-nistp256"}, {"algorithm": "diffie-hellman-group14-sha256"}, {"algorithm": "diffie-hellman-group14-sha1"}, {"algorithm": "kexguess2@matt.ucc.asn.au"}], "key": [{"algorithm": "ecdsa-sha2-nistp256"}, {"algorithm": "ssh-rsa", "keysize": 1024}, {"algorithm": "ssh-dss"}], "mac": ["hmac-sha1-96", "hmac-sha1", "hmac-sha2-256"]}
+{"banner": {"comments": null, "protocol": [2, 0], "raw": "SSH-2.0-dropbear_2019.78", "software": "dropbear_2019.78"}, "compression": ["zlib@openssh.com", "none"], "enc": ["aes128-ctr", "aes256-ctr", "aes128-cbc", "aes256-cbc", "3des-ctr", "3des-cbc"], "fingerprints": [{"hash": "CDfAU12pjQS7/91kg7gYacza0U/6PDbE04Ic3IpYxkM", "hash_alg": "SHA256", "hostkey": "ssh-rsa"}, {"hash": "63:7f:54:f7:0a:28:7f:75:0b:f4:07:0b:fc:66:51:a2", "hash_alg": "MD5", "hostkey": "ssh-rsa"}], "kex": [{"algorithm": "curve25519-sha256"}, {"algorithm": "curve25519-sha256@libssh.org"}, {"algorithm": "ecdh-sha2-nistp521"}, {"algorithm": "ecdh-sha2-nistp384"}, {"algorithm": "ecdh-sha2-nistp256"}, {"algorithm": "diffie-hellman-group14-sha256"}, {"algorithm": "diffie-hellman-group14-sha1"}, {"algorithm": "kexguess2@matt.ucc.asn.au"}], "key": [{"algorithm": "ecdsa-sha2-nistp256"}, {"algorithm": "ssh-rsa", "keysize": 1024}, {"algorithm": "ssh-dss"}], "mac": ["hmac-sha1-96", "hmac-sha1", "hmac-sha2-256"], "target": "localhost"}

test/docker/expected_results/dropbear_2019.78_test1.txt

@@ -23,10 +23,11 @@
                                      `- [warn] using weak random number generator could reveal the key
                                      `- [info] available since OpenSSH 5.7, Dropbear SSH 2013.62
 (key) ssh-rsa (1024-bit)             -- [fail] using weak hashing algorithm
-                                     `- [warn] using small 1024-bit modulus
+                                     `- [fail] using small 1024-bit modulus
                                      `- [info] available since OpenSSH 2.5.0, Dropbear SSH 0.28
-(key) ssh-dss                        -- [fail] removed (in server) and disabled (in client) since OpenSSH 7.0, weak algorithm
+                                     `- [info] a future deprecation notice has been issued in OpenSSH 8.2: https://www.openssh.com/txt/release-8.2
-                                     `- [warn] using small 1024-bit modulus
+(key) ssh-dss                        -- [fail] using small 1024-bit modulus
+                                     `- [fail] removed (in server) and disabled (in client) since OpenSSH 7.0, weak algorithm
                                      `- [warn] using weak random number generator could reveal the key
                                      `- [info] available since OpenSSH 2.1.0, Dropbear SSH 0.28
 
@@ -71,13 +72,16 @@
 (rec) -ecdh-sha2-nistp256            -- kex algorithm to remove 
 (rec) -ecdh-sha2-nistp384            -- kex algorithm to remove 
 (rec) -ecdh-sha2-nistp521            -- kex algorithm to remove 
+(rec) -ecdsa-sha2-nistp256           -- key algorithm to remove 
 (rec) -hmac-sha1-96                  -- mac algorithm to remove 
 (rec) -ssh-dss                       -- key algorithm to remove 
+(rec) -ssh-rsa                       -- key algorithm to remove 
 (rec) +diffie-hellman-group16-sha512 -- kex algorithm to append 
 (rec) +twofish128-ctr                -- enc algorithm to append 
 (rec) +twofish256-ctr                -- enc algorithm to append 
 (rec) -diffie-hellman-group14-sha1   -- kex algorithm to remove 
 (rec) -hmac-sha1                     -- mac algorithm to remove 
+(rec) -hmac-sha2-256                 -- mac algorithm to remove 
 
 # additional info
 (nfo) For hardening guides on common OSes, please see: <https://www.ssh-audit.com/hardening_guides.html>

test/docker/expected_results/openssh_4.0p1_test1.json

@@ -1 +1 @@
-{"banner": {"comments": null, "protocol": [1, 99], "raw": "SSH-1.99-OpenSSH_4.0", "software": "OpenSSH_4.0"}, "compression": ["none", "zlib"], "enc": ["aes128-cbc", "3des-cbc", "blowfish-cbc", "cast128-cbc", "arcfour", "aes192-cbc", "aes256-cbc", "rijndael-cbc@lysator.liu.se", "aes128-ctr", "aes192-ctr", "aes256-ctr"], "fingerprints": [{"fp": "SHA256:YZ457EBcJTSxRKI3yXRgtAj3PBf5B9/F36b1SVooml4", "type": "ssh-rsa"}], "kex": [{"algorithm": "diffie-hellman-group-exchange-sha1", "keysize": 1024}, {"algorithm": "diffie-hellman-group14-sha1"}, {"algorithm": "diffie-hellman-group1-sha1"}], "key": [{"algorithm": "ssh-rsa", "keysize": 1024}, {"algorithm": "ssh-dss"}], "mac": ["hmac-md5", "hmac-sha1", "hmac-ripemd160", "hmac-ripemd160@openssh.com", "hmac-sha1-96", "hmac-md5-96"]}
+{"banner": {"comments": null, "protocol": [1, 99], "raw": "SSH-1.99-OpenSSH_4.0", "software": "OpenSSH_4.0"}, "compression": ["none", "zlib"], "enc": ["aes128-cbc", "3des-cbc", "blowfish-cbc", "cast128-cbc", "arcfour", "aes192-cbc", "aes256-cbc", "rijndael-cbc@lysator.liu.se", "aes128-ctr", "aes192-ctr", "aes256-ctr"], "fingerprints": [{"hash": "YZ457EBcJTSxRKI3yXRgtAj3PBf5B9/F36b1SVooml4", "hash_alg": "SHA256", "hostkey": "ssh-rsa"}, {"hash": "3c:c3:38:f8:55:39:c0:4a:5a:17:89:60:2c:a1:fc:6a", "hash_alg": "MD5", "hostkey": "ssh-rsa"}], "kex": [{"algorithm": "diffie-hellman-group-exchange-sha1", "keysize": 1024}, {"algorithm": "diffie-hellman-group14-sha1"}, {"algorithm": "diffie-hellman-group1-sha1"}], "key": [{"algorithm": "ssh-rsa", "keysize": 1024}, {"algorithm": "ssh-dss"}], "mac": ["hmac-md5", "hmac-sha1", "hmac-ripemd160", "hmac-ripemd160@openssh.com", "hmac-sha1-96", "hmac-md5-96"], "target": "localhost"}

test/docker/expected_results/openssh_4.0p1_test1.txt

@@ -1,11 +1,12 @@
 # general
-(gen) banner: SSH-1.99-OpenSSH_4.0
+(gen) banner: SSH-1.99-OpenSSH_4.0
 (gen) protocol SSH1 enabled
 (gen) software: OpenSSH 4.0
 (gen) compatibility: OpenSSH 3.9-6.6, Dropbear SSH 0.53+ (some functionality from 0.52)
 (gen) compression: enabled (zlib)
 
 # security
+(cve) CVE-2018-15473                      -- (CVSSv2: 5.3) enumerate usernames due to timing discrepencies
 (cve) CVE-2016-3115                       -- (CVSSv2: 5.5) bypass command restrictions via crafted X11 forwarding data
 (cve) CVE-2014-1692                       -- (CVSSv2: 7.5) cause DoS via triggering error condition (memory corruption)
 (cve) CVE-2012-0814                       -- (CVSSv2: 3.5) leak data via debug messages
@@ -24,6 +25,7 @@
 (cve) CVE-2006-4924                       -- (CVSSv2: 7.8) cause DoS via crafted packet (CPU consumption)
 (cve) CVE-2006-0225                       -- (CVSSv2: 4.6) execute arbitrary code
 (cve) CVE-2005-2798                       -- (CVSSv2: 5.0) leak data about authentication credentials
+(sec) SSH v1 enabled                      -- SSH v1 can be exploited to recover plaintext passwords
 
 # key exchange algorithms
 (kex) diffie-hellman-group-exchange-sha1 (1024-bit) -- [fail] using small 1024-bit modulus
@@ -31,18 +33,19 @@
                                                     `- [info] available since OpenSSH 2.3.0
 (kex) diffie-hellman-group14-sha1         -- [warn] using weak hashing algorithm
                                           `- [info] available since OpenSSH 3.9, Dropbear SSH 0.53
-(kex) diffie-hellman-group1-sha1          -- [fail] removed (in server) since OpenSSH 6.7, unsafe algorithm
+(kex) diffie-hellman-group1-sha1          -- [fail] using small 1024-bit modulus
+                                          `- [fail] removed (in server) since OpenSSH 6.7, unsafe algorithm
                                           `- [fail] disabled (in client) since OpenSSH 7.0, logjam attack
-                                          `- [warn] using small 1024-bit modulus
                                           `- [warn] using weak hashing algorithm
                                           `- [info] available since OpenSSH 2.3.0, Dropbear SSH 0.28
 
 # host-key algorithms
 (key) ssh-rsa (1024-bit)                  -- [fail] using weak hashing algorithm
-                                          `- [warn] using small 1024-bit modulus
+                                          `- [fail] using small 1024-bit modulus
                                           `- [info] available since OpenSSH 2.5.0, Dropbear SSH 0.28
-(key) ssh-dss                             -- [fail] removed (in server) and disabled (in client) since OpenSSH 7.0, weak algorithm
+                                          `- [info] a future deprecation notice has been issued in OpenSSH 8.2: https://www.openssh.com/txt/release-8.2
-                                          `- [warn] using small 1024-bit modulus
+(key) ssh-dss                             -- [fail] using small 1024-bit modulus
+                                          `- [fail] removed (in server) and disabled (in client) since OpenSSH 7.0, weak algorithm
                                           `- [warn] using weak random number generator could reveal the key
                                           `- [info] available since OpenSSH 2.1.0, Dropbear SSH 0.28
 
@@ -133,6 +136,9 @@
 (rec) -hmac-sha1-96                       -- mac algorithm to remove 
 (rec) -rijndael-cbc@lysator.liu.se        -- enc algorithm to remove 
 (rec) -ssh-dss                            -- key algorithm to remove 
+(rec) -ssh-rsa                            -- key algorithm to remove 
+(rec) -diffie-hellman-group14-sha1        -- kex algorithm to remove 
+(rec) -hmac-sha1                          -- mac algorithm to remove 
 
 # additional info
 (nfo) For hardening guides on common OSes, please see: <https://www.ssh-audit.com/hardening_guides.html>

test/docker/expected_results/openssh_5.6p1_custom_policy_test1.json

@@ -0,0 +1 @@
+{"errors": [], "host": "localhost", "passed": true, "policy": "Docker policy: test1 (version 1)"}

test/docker/expected_results/openssh_5.6p1_custom_policy_test1.txt

@@ -0,0 +1,3 @@
+Host:   localhost:2222
+Policy: Docker policy: test1 (version 1)
+Result: ✔ Passed

test/docker/expected_results/openssh_5.6p1_custom_policy_test10.json

@@ -0,0 +1 @@
+{"errors": [{"actual": ["3072"], "expected_optional": [""], "expected_required": ["4096"], "mismatched_field": "RSA host key (ssh-rsa-cert-v01@openssh.com) sizes"}, {"actual": ["1024"], "expected_optional": [""], "expected_required": ["4096"], "mismatched_field": "RSA CA key (ssh-rsa-cert-v01@openssh.com) sizes"}], "host": "localhost", "passed": false, "policy": "Docker poliicy: test10 (version 1)"}

test/docker/expected_results/openssh_5.6p1_custom_policy_test10.txt

@@ -0,0 +1,13 @@
+Host:   localhost:2222
+Policy: Docker poliicy: test10 (version 1)
+Result: ❌ Failed!
+
+Errors:
+  * RSA CA key (ssh-rsa-cert-v01@openssh.com) sizes did not match.
+    - Expected: 4096
+    - Actual:   1024
+
+  * RSA host key (ssh-rsa-cert-v01@openssh.com) sizes did not match.
+    - Expected: 4096
+    - Actual:   3072
+

test/docker/expected_results/openssh_5.6p1_custom_policy_test2.json

@@ -0,0 +1 @@
+{"errors": [{"actual": ["diffie-hellman-group-exchange-sha256", "diffie-hellman-group-exchange-sha1", "diffie-hellman-group14-sha1", "diffie-hellman-group1-sha1"], "expected_optional": [""], "expected_required": ["kex_alg1", "kex_alg2"], "mismatched_field": "Key exchanges"}], "host": "localhost", "passed": false, "policy": "Docker policy: test2 (version 1)"}

test/docker/expected_results/openssh_5.6p1_custom_policy_test2.txt

@@ -0,0 +1,9 @@
+Host:   localhost:2222
+Policy: Docker policy: test2 (version 1)
+Result: ❌ Failed!
+
+Errors:
+  * Key exchanges did not match.
+    - Expected: kex_alg1, kex_alg2
+    - Actual:   diffie-hellman-group-exchange-sha256, diffie-hellman-group-exchange-sha1, diffie-hellman-group14-sha1, diffie-hellman-group1-sha1
+

test/docker/expected_results/openssh_5.6p1_custom_policy_test3.json

@@ -0,0 +1 @@
+{"errors": [{"actual": ["ssh-rsa", "ssh-dss"], "expected_optional": [""], "expected_required": ["ssh-rsa", "ssh-dss", "key_alg1"], "mismatched_field": "Host keys"}], "host": "localhost", "passed": false, "policy": "Docker policy: test3 (version 1)"}

test/docker/expected_results/openssh_5.6p1_custom_policy_test3.txt

@@ -0,0 +1,9 @@
+Host:   localhost:2222
+Policy: Docker policy: test3 (version 1)
+Result: ❌ Failed!
+
+Errors:
+  * Host keys did not match.
+    - Expected: ssh-rsa, ssh-dss, key_alg1
+    - Actual:   ssh-rsa, ssh-dss
+

test/docker/expected_results/openssh_5.6p1_custom_policy_test4.json

@@ -0,0 +1 @@
+{"errors": [{"actual": ["aes128-ctr", "aes192-ctr", "aes256-ctr", "arcfour256", "arcfour128", "aes128-cbc", "3des-cbc", "blowfish-cbc", "cast128-cbc", "aes192-cbc", "aes256-cbc", "arcfour", "rijndael-cbc@lysator.liu.se"], "expected_optional": [""], "expected_required": ["cipher_alg1", "cipher_alg2"], "mismatched_field": "Ciphers"}], "host": "localhost", "passed": false, "policy": "Docker policy: test4 (version 1)"}

test/docker/expected_results/openssh_5.6p1_custom_policy_test4.txt

@@ -0,0 +1,9 @@
+Host:   localhost:2222
+Policy: Docker policy: test4 (version 1)
+Result: ❌ Failed!
+
+Errors:
+  * Ciphers did not match.
+    - Expected: cipher_alg1, cipher_alg2
+    - Actual:   aes128-ctr, aes192-ctr, aes256-ctr, arcfour256, arcfour128, aes128-cbc, 3des-cbc, blowfish-cbc, cast128-cbc, aes192-cbc, aes256-cbc, arcfour, rijndael-cbc@lysator.liu.se
+

test/docker/expected_results/openssh_5.6p1_custom_policy_test5.json

@@ -0,0 +1 @@
+{"errors": [{"actual": ["hmac-md5", "hmac-sha1", "umac-64@openssh.com", "hmac-ripemd160", "hmac-ripemd160@openssh.com", "hmac-sha1-96", "hmac-md5-96"], "expected_optional": [""], "expected_required": ["hmac-md5", "hmac-sha1", "umac-64@openssh.com", "hmac-ripemd160", "hmac-ripemd160@openssh.com", "hmac_alg1", "hmac-md5-96"], "mismatched_field": "MACs"}], "host": "localhost", "passed": false, "policy": "Docker policy: test5 (version 1)"}

test/docker/expected_results/openssh_5.6p1_custom_policy_test5.txt

@@ -0,0 +1,9 @@
+Host:   localhost:2222
+Policy: Docker policy: test5 (version 1)
+Result: ❌ Failed!
+
+Errors:
+  * MACs did not match.
+    - Expected: hmac-md5, hmac-sha1, umac-64@openssh.com, hmac-ripemd160, hmac-ripemd160@openssh.com, hmac_alg1, hmac-md5-96
+    - Actual:   hmac-md5, hmac-sha1, umac-64@openssh.com, hmac-ripemd160, hmac-ripemd160@openssh.com, hmac-sha1-96, hmac-md5-96
+

test/docker/expected_results/openssh_5.6p1_custom_policy_test7.json

@@ -0,0 +1 @@
+{"errors": [], "host": "localhost", "passed": true, "policy": "Docker poliicy: test7 (version 1)"}

test/docker/expected_results/openssh_5.6p1_custom_policy_test7.txt

@@ -0,0 +1,3 @@
+Host:   localhost:2222
+Policy: Docker poliicy: test7 (version 1)
+Result: ✔ Passed

test/docker/expected_results/openssh_5.6p1_custom_policy_test8.json

@@ -0,0 +1 @@
+{"errors": [{"actual": ["1024"], "expected_optional": [""], "expected_required": ["2048"], "mismatched_field": "RSA CA key (ssh-rsa-cert-v01@openssh.com) sizes"}], "host": "localhost", "passed": false, "policy": "Docker poliicy: test8 (version 1)"}

test/docker/expected_results/openssh_5.6p1_custom_policy_test8.txt

@@ -0,0 +1,9 @@
+Host:   localhost:2222
+Policy: Docker poliicy: test8 (version 1)
+Result: ❌ Failed!
+
+Errors:
+  * RSA CA key (ssh-rsa-cert-v01@openssh.com) sizes did not match.
+    - Expected: 2048
+    - Actual:   1024
+

test/docker/expected_results/openssh_5.6p1_custom_policy_test9.json

@@ -0,0 +1 @@
+{"errors": [{"actual": ["3072"], "expected_optional": [""], "expected_required": ["4096"], "mismatched_field": "RSA host key (ssh-rsa-cert-v01@openssh.com) sizes"}], "host": "localhost", "passed": false, "policy": "Docker poliicy: test9 (version 1)"}

test/docker/expected_results/openssh_5.6p1_custom_policy_test9.txt

@@ -0,0 +1,9 @@
+Host:   localhost:2222
+Policy: Docker poliicy: test9 (version 1)
+Result: ❌ Failed!
+
+Errors:
+  * RSA host key (ssh-rsa-cert-v01@openssh.com) sizes did not match.
+    - Expected: 4096
+    - Actual:   3072
+

test/docker/expected_results/openssh_5.6p1_test1.json

@@ -1 +1 @@
-{"banner": {"comments": null, "protocol": [2, 0], "raw": "SSH-2.0-OpenSSH_5.6", "software": "OpenSSH_5.6"}, "compression": ["none", "zlib@openssh.com"], "enc": ["aes128-ctr", "aes192-ctr", "aes256-ctr", "arcfour256", "arcfour128", "aes128-cbc", "3des-cbc", "blowfish-cbc", "cast128-cbc", "aes192-cbc", "aes256-cbc", "arcfour", "rijndael-cbc@lysator.liu.se"], "fingerprints": [{"fp": "SHA256:YZ457EBcJTSxRKI3yXRgtAj3PBf5B9/F36b1SVooml4", "type": "ssh-rsa"}], "kex": [{"algorithm": "diffie-hellman-group-exchange-sha256", "keysize": 1024}, {"algorithm": "diffie-hellman-group-exchange-sha1", "keysize": 1024}, {"algorithm": "diffie-hellman-group14-sha1"}, {"algorithm": "diffie-hellman-group1-sha1"}], "key": [{"algorithm": "ssh-rsa", "keysize": 1024}, {"algorithm": "ssh-dss"}], "mac": ["hmac-md5", "hmac-sha1", "umac-64@openssh.com", "hmac-ripemd160", "hmac-ripemd160@openssh.com", "hmac-sha1-96", "hmac-md5-96"]}
+{"banner": {"comments": null, "protocol": [2, 0], "raw": "SSH-2.0-OpenSSH_5.6", "software": "OpenSSH_5.6"}, "compression": ["none", "zlib@openssh.com"], "enc": ["aes128-ctr", "aes192-ctr", "aes256-ctr", "arcfour256", "arcfour128", "aes128-cbc", "3des-cbc", "blowfish-cbc", "cast128-cbc", "aes192-cbc", "aes256-cbc", "arcfour", "rijndael-cbc@lysator.liu.se"], "fingerprints": [{"hash": "YZ457EBcJTSxRKI3yXRgtAj3PBf5B9/F36b1SVooml4", "hash_alg": "SHA256", "hostkey": "ssh-rsa"}, {"hash": "3c:c3:38:f8:55:39:c0:4a:5a:17:89:60:2c:a1:fc:6a", "hash_alg": "MD5", "hostkey": "ssh-rsa"}], "kex": [{"algorithm": "diffie-hellman-group-exchange-sha256", "keysize": 1024}, {"algorithm": "diffie-hellman-group-exchange-sha1", "keysize": 1024}, {"algorithm": "diffie-hellman-group14-sha1"}, {"algorithm": "diffie-hellman-group1-sha1"}], "key": [{"algorithm": "ssh-rsa", "keysize": 1024}, {"algorithm": "ssh-dss"}], "mac": ["hmac-md5", "hmac-sha1", "umac-64@openssh.com", "hmac-ripemd160", "hmac-ripemd160@openssh.com", "hmac-sha1-96", "hmac-md5-96"], "target": "localhost"}

test/docker/expected_results/openssh_5.6p1_test1.txt

@@ -5,6 +5,7 @@
 (gen) compression: enabled (zlib@openssh.com)
 
 # security
+(cve) CVE-2018-15473                        -- (CVSSv2: 5.3) enumerate usernames due to timing discrepencies
 (cve) CVE-2016-3115                         -- (CVSSv2: 5.5) bypass command restrictions via crafted X11 forwarding data
 (cve) CVE-2016-1907                         -- (CVSSv2: 5.0) cause DoS via crafted network traffic (out of bounds read)
 (cve) CVE-2015-6564                         -- (CVSSv2: 6.9) privilege escalation via leveraging sshd uid
@@ -25,18 +26,19 @@
                                                     `- [info] available since OpenSSH 2.3.0
 (kex) diffie-hellman-group14-sha1           -- [warn] using weak hashing algorithm
                                             `- [info] available since OpenSSH 3.9, Dropbear SSH 0.53
-(kex) diffie-hellman-group1-sha1            -- [fail] removed (in server) since OpenSSH 6.7, unsafe algorithm
+(kex) diffie-hellman-group1-sha1            -- [fail] using small 1024-bit modulus
+                                            `- [fail] removed (in server) since OpenSSH 6.7, unsafe algorithm
                                             `- [fail] disabled (in client) since OpenSSH 7.0, logjam attack
-                                            `- [warn] using small 1024-bit modulus
                                             `- [warn] using weak hashing algorithm
                                             `- [info] available since OpenSSH 2.3.0, Dropbear SSH 0.28
 
 # host-key algorithms
 (key) ssh-rsa (1024-bit)                    -- [fail] using weak hashing algorithm
-                                            `- [warn] using small 1024-bit modulus
+                                            `- [fail] using small 1024-bit modulus
                                             `- [info] available since OpenSSH 2.5.0, Dropbear SSH 0.28
-(key) ssh-dss                               -- [fail] removed (in server) and disabled (in client) since OpenSSH 7.0, weak algorithm
+                                            `- [info] a future deprecation notice has been issued in OpenSSH 8.2: https://www.openssh.com/txt/release-8.2
-                                            `- [warn] using small 1024-bit modulus
+(key) ssh-dss                               -- [fail] using small 1024-bit modulus
+                                            `- [fail] removed (in server) and disabled (in client) since OpenSSH 7.0, weak algorithm
                                             `- [warn] using weak random number generator could reveal the key
                                             `- [info] available since OpenSSH 2.1.0, Dropbear SSH 0.28
 
@@ -141,7 +143,10 @@
 (rec) -hmac-sha1-96                         -- mac algorithm to remove 
 (rec) -rijndael-cbc@lysator.liu.se          -- enc algorithm to remove 
 (rec) -ssh-dss                              -- key algorithm to remove 
+(rec) -ssh-rsa                              -- key algorithm to remove 
 (rec) -diffie-hellman-group14-sha1          -- kex algorithm to remove 
+(rec) -hmac-sha1                            -- mac algorithm to remove 
+(rec) -umac-64@openssh.com                  -- mac algorithm to remove 
 
 # additional info
 (nfo) For hardening guides on common OSes, please see: <https://www.ssh-audit.com/hardening_guides.html>

test/docker/expected_results/openssh_5.6p1_test2.json

@@ -1 +1 @@
-{"banner": {"comments": null, "protocol": [2, 0], "raw": "SSH-2.0-OpenSSH_5.6", "software": "OpenSSH_5.6"}, "compression": ["none", "zlib@openssh.com"], "enc": ["aes128-ctr", "aes192-ctr", "aes256-ctr", "arcfour256", "arcfour128", "aes128-cbc", "3des-cbc", "blowfish-cbc", "cast128-cbc", "aes192-cbc", "aes256-cbc", "arcfour", "rijndael-cbc@lysator.liu.se"], "fingerprints": [{"fp": "SHA256:YZ457EBcJTSxRKI3yXRgtAj3PBf5B9/F36b1SVooml4", "type": "ssh-rsa"}], "kex": [{"algorithm": "diffie-hellman-group-exchange-sha256", "keysize": 1024}, {"algorithm": "diffie-hellman-group-exchange-sha1", "keysize": 1024}, {"algorithm": "diffie-hellman-group14-sha1"}, {"algorithm": "diffie-hellman-group1-sha1"}], "key": [{"algorithm": "ssh-rsa", "keysize": 1024}, {"algorithm": "ssh-rsa-cert-v01@openssh.com", "casize": 1024, "keysize": 1024}], "mac": ["hmac-md5", "hmac-sha1", "umac-64@openssh.com", "hmac-ripemd160", "hmac-ripemd160@openssh.com", "hmac-sha1-96", "hmac-md5-96"]}
+{"banner": {"comments": null, "protocol": [2, 0], "raw": "SSH-2.0-OpenSSH_5.6", "software": "OpenSSH_5.6"}, "compression": ["none", "zlib@openssh.com"], "enc": ["aes128-ctr", "aes192-ctr", "aes256-ctr", "arcfour256", "arcfour128", "aes128-cbc", "3des-cbc", "blowfish-cbc", "cast128-cbc", "aes192-cbc", "aes256-cbc", "arcfour", "rijndael-cbc@lysator.liu.se"], "fingerprints": [{"hash": "YZ457EBcJTSxRKI3yXRgtAj3PBf5B9/F36b1SVooml4", "hash_alg": "SHA256", "hostkey": "ssh-rsa"}, {"hash": "3c:c3:38:f8:55:39:c0:4a:5a:17:89:60:2c:a1:fc:6a", "hash_alg": "MD5", "hostkey": "ssh-rsa"}], "kex": [{"algorithm": "diffie-hellman-group-exchange-sha256", "keysize": 1024}, {"algorithm": "diffie-hellman-group-exchange-sha1", "keysize": 1024}, {"algorithm": "diffie-hellman-group14-sha1"}, {"algorithm": "diffie-hellman-group1-sha1"}], "key": [{"algorithm": "ssh-rsa", "keysize": 1024}, {"algorithm": "ssh-rsa-cert-v01@openssh.com", "casize": 1024, "keysize": 1024}], "mac": ["hmac-md5", "hmac-sha1", "umac-64@openssh.com", "hmac-ripemd160", "hmac-ripemd160@openssh.com", "hmac-sha1-96", "hmac-md5-96"], "target": "localhost"}

test/docker/expected_results/openssh_5.6p1_test2.txt

@@ -5,6 +5,7 @@
 (gen) compression: enabled (zlib@openssh.com)
 
 # security
+(cve) CVE-2018-15473                        -- (CVSSv2: 5.3) enumerate usernames due to timing discrepencies
 (cve) CVE-2016-3115                         -- (CVSSv2: 5.5) bypass command restrictions via crafted X11 forwarding data
 (cve) CVE-2016-1907                         -- (CVSSv2: 5.0) cause DoS via crafted network traffic (out of bounds read)
 (cve) CVE-2015-6564                         -- (CVSSv2: 6.9) privilege escalation via leveraging sshd uid
@@ -25,18 +26,21 @@
                                                     `- [info] available since OpenSSH 2.3.0
 (kex) diffie-hellman-group14-sha1           -- [warn] using weak hashing algorithm
                                             `- [info] available since OpenSSH 3.9, Dropbear SSH 0.53
-(kex) diffie-hellman-group1-sha1            -- [fail] removed (in server) since OpenSSH 6.7, unsafe algorithm
+(kex) diffie-hellman-group1-sha1            -- [fail] using small 1024-bit modulus
+                                            `- [fail] removed (in server) since OpenSSH 6.7, unsafe algorithm
                                             `- [fail] disabled (in client) since OpenSSH 7.0, logjam attack
-                                            `- [warn] using small 1024-bit modulus
                                             `- [warn] using weak hashing algorithm
                                             `- [info] available since OpenSSH 2.3.0, Dropbear SSH 0.28
 
 # host-key algorithms
 (key) ssh-rsa (1024-bit)                    -- [fail] using weak hashing algorithm
-                                            `- [warn] using small 1024-bit modulus
+                                            `- [fail] using small 1024-bit modulus
                                             `- [info] available since OpenSSH 2.5.0, Dropbear SSH 0.28
-(key) ssh-rsa-cert-v01@openssh.com (1024-bit cert/1024-bit CA) -- [fail] using small 1024-bit modulus
+                                            `- [info] a future deprecation notice has been issued in OpenSSH 8.2: https://www.openssh.com/txt/release-8.2
+(key) ssh-rsa-cert-v01@openssh.com (1024-bit cert/1024-bit CA) -- [fail] using weak hashing algorithm
+                                                               `- [fail] using small 1024-bit modulus
                                                                `- [info] available since OpenSSH 5.6
+                                                               `- [info] a future deprecation notice has been issued in OpenSSH 8.2: https://www.openssh.com/txt/release-8.2
 
 # encryption algorithms (ciphers)
 (enc) aes128-ctr                            -- [info] available since OpenSSH 3.7, Dropbear SSH 0.52
@@ -121,7 +125,6 @@
 
 # algorithm recommendations (for OpenSSH 5.6)
 (rec) !diffie-hellman-group-exchange-sha256 -- kex algorithm to change (increase modulus size to 2048 bits or larger) 
-(rec) !ssh-rsa-cert-v01@openssh.com         -- key algorithm to change (increase modulus size to 2048 bits or larger) 
 (rec) -3des-cbc                             -- enc algorithm to remove 
 (rec) -aes128-cbc                           -- enc algorithm to remove 
 (rec) -aes192-cbc                           -- enc algorithm to remove 
@@ -140,7 +143,10 @@
 (rec) -hmac-sha1-96                         -- mac algorithm to remove 
 (rec) -rijndael-cbc@lysator.liu.se          -- enc algorithm to remove 
 (rec) -ssh-rsa                              -- key algorithm to remove 
+(rec) -ssh-rsa-cert-v01@openssh.com         -- key algorithm to remove 
 (rec) -diffie-hellman-group14-sha1          -- kex algorithm to remove 
+(rec) -hmac-sha1                            -- mac algorithm to remove 
+(rec) -umac-64@openssh.com                  -- mac algorithm to remove 
 
 # additional info
 (nfo) For hardening guides on common OSes, please see: <https://www.ssh-audit.com/hardening_guides.html>

test/docker/expected_results/openssh_5.6p1_test3.json

@@ -1 +1 @@
-{"banner": {"comments": null, "protocol": [2, 0], "raw": "SSH-2.0-OpenSSH_5.6", "software": "OpenSSH_5.6"}, "compression": ["none", "zlib@openssh.com"], "enc": ["aes128-ctr", "aes192-ctr", "aes256-ctr", "arcfour256", "arcfour128", "aes128-cbc", "3des-cbc", "blowfish-cbc", "cast128-cbc", "aes192-cbc", "aes256-cbc", "arcfour", "rijndael-cbc@lysator.liu.se"], "fingerprints": [{"fp": "SHA256:YZ457EBcJTSxRKI3yXRgtAj3PBf5B9/F36b1SVooml4", "type": "ssh-rsa"}], "kex": [{"algorithm": "diffie-hellman-group-exchange-sha256", "keysize": 1024}, {"algorithm": "diffie-hellman-group-exchange-sha1", "keysize": 1024}, {"algorithm": "diffie-hellman-group14-sha1"}, {"algorithm": "diffie-hellman-group1-sha1"}], "key": [{"algorithm": "ssh-rsa", "keysize": 1024}, {"algorithm": "ssh-rsa-cert-v01@openssh.com", "casize": 3072, "keysize": 1024}], "mac": ["hmac-md5", "hmac-sha1", "umac-64@openssh.com", "hmac-ripemd160", "hmac-ripemd160@openssh.com", "hmac-sha1-96", "hmac-md5-96"]}
+{"banner": {"comments": null, "protocol": [2, 0], "raw": "SSH-2.0-OpenSSH_5.6", "software": "OpenSSH_5.6"}, "compression": ["none", "zlib@openssh.com"], "enc": ["aes128-ctr", "aes192-ctr", "aes256-ctr", "arcfour256", "arcfour128", "aes128-cbc", "3des-cbc", "blowfish-cbc", "cast128-cbc", "aes192-cbc", "aes256-cbc", "arcfour", "rijndael-cbc@lysator.liu.se"], "fingerprints": [{"hash": "YZ457EBcJTSxRKI3yXRgtAj3PBf5B9/F36b1SVooml4", "hash_alg": "SHA256", "hostkey": "ssh-rsa"}, {"hash": "3c:c3:38:f8:55:39:c0:4a:5a:17:89:60:2c:a1:fc:6a", "hash_alg": "MD5", "hostkey": "ssh-rsa"}], "kex": [{"algorithm": "diffie-hellman-group-exchange-sha256", "keysize": 1024}, {"algorithm": "diffie-hellman-group-exchange-sha1", "keysize": 1024}, {"algorithm": "diffie-hellman-group14-sha1"}, {"algorithm": "diffie-hellman-group1-sha1"}], "key": [{"algorithm": "ssh-rsa", "keysize": 1024}, {"algorithm": "ssh-rsa-cert-v01@openssh.com", "casize": 3072, "keysize": 1024}], "mac": ["hmac-md5", "hmac-sha1", "umac-64@openssh.com", "hmac-ripemd160", "hmac-ripemd160@openssh.com", "hmac-sha1-96", "hmac-md5-96"], "target": "localhost"}

test/docker/expected_results/openssh_5.6p1_test3.txt

@@ -5,6 +5,7 @@
 (gen) compression: enabled (zlib@openssh.com)
 
 # security
+(cve) CVE-2018-15473                        -- (CVSSv2: 5.3) enumerate usernames due to timing discrepencies
 (cve) CVE-2016-3115                         -- (CVSSv2: 5.5) bypass command restrictions via crafted X11 forwarding data
 (cve) CVE-2016-1907                         -- (CVSSv2: 5.0) cause DoS via crafted network traffic (out of bounds read)
 (cve) CVE-2015-6564                         -- (CVSSv2: 6.9) privilege escalation via leveraging sshd uid
@@ -25,18 +26,21 @@
                                                     `- [info] available since OpenSSH 2.3.0
 (kex) diffie-hellman-group14-sha1           -- [warn] using weak hashing algorithm
                                             `- [info] available since OpenSSH 3.9, Dropbear SSH 0.53
-(kex) diffie-hellman-group1-sha1            -- [fail] removed (in server) since OpenSSH 6.7, unsafe algorithm
+(kex) diffie-hellman-group1-sha1            -- [fail] using small 1024-bit modulus
+                                            `- [fail] removed (in server) since OpenSSH 6.7, unsafe algorithm
                                             `- [fail] disabled (in client) since OpenSSH 7.0, logjam attack
-                                            `- [warn] using small 1024-bit modulus
                                             `- [warn] using weak hashing algorithm
                                             `- [info] available since OpenSSH 2.3.0, Dropbear SSH 0.28
 
 # host-key algorithms
 (key) ssh-rsa (1024-bit)                    -- [fail] using weak hashing algorithm
-                                            `- [warn] using small 1024-bit modulus
+                                            `- [fail] using small 1024-bit modulus
                                             `- [info] available since OpenSSH 2.5.0, Dropbear SSH 0.28
-(key) ssh-rsa-cert-v01@openssh.com (1024-bit cert/3072-bit CA) -- [fail] using small 1024-bit modulus
+                                            `- [info] a future deprecation notice has been issued in OpenSSH 8.2: https://www.openssh.com/txt/release-8.2
+(key) ssh-rsa-cert-v01@openssh.com (1024-bit cert/3072-bit CA) -- [fail] using weak hashing algorithm
+                                                               `- [fail] using small 1024-bit modulus
                                                                `- [info] available since OpenSSH 5.6
+                                                               `- [info] a future deprecation notice has been issued in OpenSSH 8.2: https://www.openssh.com/txt/release-8.2
 
 # encryption algorithms (ciphers)
 (enc) aes128-ctr                            -- [info] available since OpenSSH 3.7, Dropbear SSH 0.52
@@ -121,7 +125,6 @@
 
 # algorithm recommendations (for OpenSSH 5.6)
 (rec) !diffie-hellman-group-exchange-sha256 -- kex algorithm to change (increase modulus size to 2048 bits or larger) 
-(rec) !ssh-rsa-cert-v01@openssh.com         -- key algorithm to change (increase modulus size to 2048 bits or larger) 
 (rec) -3des-cbc                             -- enc algorithm to remove 
 (rec) -aes128-cbc                           -- enc algorithm to remove 
 (rec) -aes192-cbc                           -- enc algorithm to remove 
@@ -140,7 +143,10 @@
 (rec) -hmac-sha1-96                         -- mac algorithm to remove 
 (rec) -rijndael-cbc@lysator.liu.se          -- enc algorithm to remove 
 (rec) -ssh-rsa                              -- key algorithm to remove 
+(rec) -ssh-rsa-cert-v01@openssh.com         -- key algorithm to remove 
 (rec) -diffie-hellman-group14-sha1          -- kex algorithm to remove 
+(rec) -hmac-sha1                            -- mac algorithm to remove 
+(rec) -umac-64@openssh.com                  -- mac algorithm to remove 
 
 # additional info
 (nfo) For hardening guides on common OSes, please see: <https://www.ssh-audit.com/hardening_guides.html>

test/docker/expected_results/openssh_5.6p1_test4.json

@@ -1 +1 @@
-{"banner": {"comments": null, "protocol": [2, 0], "raw": "SSH-2.0-OpenSSH_5.6", "software": "OpenSSH_5.6"}, "compression": ["none", "zlib@openssh.com"], "enc": ["aes128-ctr", "aes192-ctr", "aes256-ctr", "arcfour256", "arcfour128", "aes128-cbc", "3des-cbc", "blowfish-cbc", "cast128-cbc", "aes192-cbc", "aes256-cbc", "arcfour", "rijndael-cbc@lysator.liu.se"], "fingerprints": [{"fp": "SHA256:nsWtdJ9Z67Vrf7OsUzQov7esXhsWAfVppArGh25u244", "type": "ssh-rsa"}], "kex": [{"algorithm": "diffie-hellman-group-exchange-sha256", "keysize": 1024}, {"algorithm": "diffie-hellman-group-exchange-sha1", "keysize": 1024}, {"algorithm": "diffie-hellman-group14-sha1"}, {"algorithm": "diffie-hellman-group1-sha1"}], "key": [{"algorithm": "ssh-rsa", "keysize": 3072}, {"algorithm": "ssh-rsa-cert-v01@openssh.com", "casize": 1024, "keysize": 3072}], "mac": ["hmac-md5", "hmac-sha1", "umac-64@openssh.com", "hmac-ripemd160", "hmac-ripemd160@openssh.com", "hmac-sha1-96", "hmac-md5-96"]}
+{"banner": {"comments": null, "protocol": [2, 0], "raw": "SSH-2.0-OpenSSH_5.6", "software": "OpenSSH_5.6"}, "compression": ["none", "zlib@openssh.com"], "enc": ["aes128-ctr", "aes192-ctr", "aes256-ctr", "arcfour256", "arcfour128", "aes128-cbc", "3des-cbc", "blowfish-cbc", "cast128-cbc", "aes192-cbc", "aes256-cbc", "arcfour", "rijndael-cbc@lysator.liu.se"], "fingerprints": [{"hash": "nsWtdJ9Z67Vrf7OsUzQov7esXhsWAfVppArGh25u244", "hash_alg": "SHA256", "hostkey": "ssh-rsa"}, {"hash": "18:e2:51:fe:21:6c:78:d0:b8:cf:32:d4:bd:56:42:e1", "hash_alg": "MD5", "hostkey": "ssh-rsa"}], "kex": [{"algorithm": "diffie-hellman-group-exchange-sha256", "keysize": 1024}, {"algorithm": "diffie-hellman-group-exchange-sha1", "keysize": 1024}, {"algorithm": "diffie-hellman-group14-sha1"}, {"algorithm": "diffie-hellman-group1-sha1"}], "key": [{"algorithm": "ssh-rsa", "keysize": 3072}, {"algorithm": "ssh-rsa-cert-v01@openssh.com", "casize": 1024, "keysize": 3072}], "mac": ["hmac-md5", "hmac-sha1", "umac-64@openssh.com", "hmac-ripemd160", "hmac-ripemd160@openssh.com", "hmac-sha1-96", "hmac-md5-96"], "target": "localhost"}

test/docker/expected_results/openssh_5.6p1_test4.txt

@@ -5,6 +5,7 @@
 (gen) compression: enabled (zlib@openssh.com)
 
 # security
+(cve) CVE-2018-15473                        -- (CVSSv2: 5.3) enumerate usernames due to timing discrepencies
 (cve) CVE-2016-3115                         -- (CVSSv2: 5.5) bypass command restrictions via crafted X11 forwarding data
 (cve) CVE-2016-1907                         -- (CVSSv2: 5.0) cause DoS via crafted network traffic (out of bounds read)
 (cve) CVE-2015-6564                         -- (CVSSv2: 6.9) privilege escalation via leveraging sshd uid
@@ -25,17 +26,20 @@
                                                     `- [info] available since OpenSSH 2.3.0
 (kex) diffie-hellman-group14-sha1           -- [warn] using weak hashing algorithm
                                             `- [info] available since OpenSSH 3.9, Dropbear SSH 0.53
-(kex) diffie-hellman-group1-sha1            -- [fail] removed (in server) since OpenSSH 6.7, unsafe algorithm
+(kex) diffie-hellman-group1-sha1            -- [fail] using small 1024-bit modulus
+                                            `- [fail] removed (in server) since OpenSSH 6.7, unsafe algorithm
                                             `- [fail] disabled (in client) since OpenSSH 7.0, logjam attack
-                                            `- [warn] using small 1024-bit modulus
                                             `- [warn] using weak hashing algorithm
                                             `- [info] available since OpenSSH 2.3.0, Dropbear SSH 0.28
 
 # host-key algorithms
 (key) ssh-rsa (3072-bit)                    -- [fail] using weak hashing algorithm
                                             `- [info] available since OpenSSH 2.5.0, Dropbear SSH 0.28
-(key) ssh-rsa-cert-v01@openssh.com (3072-bit cert/1024-bit CA) -- [fail] using small 1024-bit modulus
+                                            `- [info] a future deprecation notice has been issued in OpenSSH 8.2: https://www.openssh.com/txt/release-8.2
+(key) ssh-rsa-cert-v01@openssh.com (3072-bit cert/1024-bit CA) -- [fail] using weak hashing algorithm
+                                                               `- [fail] using small 1024-bit modulus
                                                                `- [info] available since OpenSSH 5.6
+                                                               `- [info] a future deprecation notice has been issued in OpenSSH 8.2: https://www.openssh.com/txt/release-8.2
 
 # encryption algorithms (ciphers)
 (enc) aes128-ctr                            -- [info] available since OpenSSH 3.7, Dropbear SSH 0.52
@@ -120,7 +124,6 @@
 
 # algorithm recommendations (for OpenSSH 5.6)
 (rec) !diffie-hellman-group-exchange-sha256 -- kex algorithm to change (increase modulus size to 2048 bits or larger) 
-(rec) !ssh-rsa-cert-v01@openssh.com         -- key algorithm to change (increase modulus size to 2048 bits or larger) 
 (rec) -3des-cbc                             -- enc algorithm to remove 
 (rec) -aes128-cbc                           -- enc algorithm to remove 
 (rec) -aes192-cbc                           -- enc algorithm to remove 
@@ -139,7 +142,10 @@
 (rec) -hmac-sha1-96                         -- mac algorithm to remove 
 (rec) -rijndael-cbc@lysator.liu.se          -- enc algorithm to remove 
 (rec) -ssh-rsa                              -- key algorithm to remove 
+(rec) -ssh-rsa-cert-v01@openssh.com         -- key algorithm to remove 
 (rec) -diffie-hellman-group14-sha1          -- kex algorithm to remove 
+(rec) -hmac-sha1                            -- mac algorithm to remove 
+(rec) -umac-64@openssh.com                  -- mac algorithm to remove 
 
 # additional info
 (nfo) For hardening guides on common OSes, please see: <https://www.ssh-audit.com/hardening_guides.html>

test/docker/expected_results/openssh_5.6p1_test5.json

@@ -1 +1 @@
-{"banner": {"comments": null, "protocol": [2, 0], "raw": "SSH-2.0-OpenSSH_5.6", "software": "OpenSSH_5.6"}, "compression": ["none", "zlib@openssh.com"], "enc": ["aes128-ctr", "aes192-ctr", "aes256-ctr", "arcfour256", "arcfour128", "aes128-cbc", "3des-cbc", "blowfish-cbc", "cast128-cbc", "aes192-cbc", "aes256-cbc", "arcfour", "rijndael-cbc@lysator.liu.se"], "fingerprints": [{"fp": "SHA256:nsWtdJ9Z67Vrf7OsUzQov7esXhsWAfVppArGh25u244", "type": "ssh-rsa"}], "kex": [{"algorithm": "diffie-hellman-group-exchange-sha256", "keysize": 1024}, {"algorithm": "diffie-hellman-group-exchange-sha1", "keysize": 1024}, {"algorithm": "diffie-hellman-group14-sha1"}, {"algorithm": "diffie-hellman-group1-sha1"}], "key": [{"algorithm": "ssh-rsa", "keysize": 3072}, {"algorithm": "ssh-rsa-cert-v01@openssh.com", "casize": 3072, "keysize": 3072}], "mac": ["hmac-md5", "hmac-sha1", "umac-64@openssh.com", "hmac-ripemd160", "hmac-ripemd160@openssh.com", "hmac-sha1-96", "hmac-md5-96"]}
+{"banner": {"comments": null, "protocol": [2, 0], "raw": "SSH-2.0-OpenSSH_5.6", "software": "OpenSSH_5.6"}, "compression": ["none", "zlib@openssh.com"], "enc": ["aes128-ctr", "aes192-ctr", "aes256-ctr", "arcfour256", "arcfour128", "aes128-cbc", "3des-cbc", "blowfish-cbc", "cast128-cbc", "aes192-cbc", "aes256-cbc", "arcfour", "rijndael-cbc@lysator.liu.se"], "fingerprints": [{"hash": "nsWtdJ9Z67Vrf7OsUzQov7esXhsWAfVppArGh25u244", "hash_alg": "SHA256", "hostkey": "ssh-rsa"}, {"hash": "18:e2:51:fe:21:6c:78:d0:b8:cf:32:d4:bd:56:42:e1", "hash_alg": "MD5", "hostkey": "ssh-rsa"}], "kex": [{"algorithm": "diffie-hellman-group-exchange-sha256", "keysize": 1024}, {"algorithm": "diffie-hellman-group-exchange-sha1", "keysize": 1024}, {"algorithm": "diffie-hellman-group14-sha1"}, {"algorithm": "diffie-hellman-group1-sha1"}], "key": [{"algorithm": "ssh-rsa", "keysize": 3072}, {"algorithm": "ssh-rsa-cert-v01@openssh.com", "casize": 3072, "keysize": 3072}], "mac": ["hmac-md5", "hmac-sha1", "umac-64@openssh.com", "hmac-ripemd160", "hmac-ripemd160@openssh.com", "hmac-sha1-96", "hmac-md5-96"], "target": "localhost"}

test/docker/expected_results/openssh_5.6p1_test5.txt

@@ -5,6 +5,7 @@
 (gen) compression: enabled (zlib@openssh.com)
 
 # security
+(cve) CVE-2018-15473                        -- (CVSSv2: 5.3) enumerate usernames due to timing discrepencies
 (cve) CVE-2016-3115                         -- (CVSSv2: 5.5) bypass command restrictions via crafted X11 forwarding data
 (cve) CVE-2016-1907                         -- (CVSSv2: 5.0) cause DoS via crafted network traffic (out of bounds read)
 (cve) CVE-2015-6564                         -- (CVSSv2: 6.9) privilege escalation via leveraging sshd uid
@@ -25,16 +26,19 @@
                                                     `- [info] available since OpenSSH 2.3.0
 (kex) diffie-hellman-group14-sha1           -- [warn] using weak hashing algorithm
                                             `- [info] available since OpenSSH 3.9, Dropbear SSH 0.53
-(kex) diffie-hellman-group1-sha1            -- [fail] removed (in server) since OpenSSH 6.7, unsafe algorithm
+(kex) diffie-hellman-group1-sha1            -- [fail] using small 1024-bit modulus
+                                            `- [fail] removed (in server) since OpenSSH 6.7, unsafe algorithm
                                             `- [fail] disabled (in client) since OpenSSH 7.0, logjam attack
-                                            `- [warn] using small 1024-bit modulus
                                             `- [warn] using weak hashing algorithm
                                             `- [info] available since OpenSSH 2.3.0, Dropbear SSH 0.28
 
 # host-key algorithms
 (key) ssh-rsa (3072-bit)                    -- [fail] using weak hashing algorithm
                                             `- [info] available since OpenSSH 2.5.0, Dropbear SSH 0.28
-(key) ssh-rsa-cert-v01@openssh.com (3072-bit cert/3072-bit CA) -- [info] available since OpenSSH 5.6
+                                            `- [info] a future deprecation notice has been issued in OpenSSH 8.2: https://www.openssh.com/txt/release-8.2
+(key) ssh-rsa-cert-v01@openssh.com (3072-bit cert/3072-bit CA) -- [fail] using weak hashing algorithm
+                                                               `- [info] available since OpenSSH 5.6
+                                                               `- [info] a future deprecation notice has been issued in OpenSSH 8.2: https://www.openssh.com/txt/release-8.2
 
 # encryption algorithms (ciphers)
 (enc) aes128-ctr                            -- [info] available since OpenSSH 3.7, Dropbear SSH 0.52
@@ -137,7 +141,10 @@
 (rec) -hmac-sha1-96                         -- mac algorithm to remove 
 (rec) -rijndael-cbc@lysator.liu.se          -- enc algorithm to remove 
 (rec) -ssh-rsa                              -- key algorithm to remove 
+(rec) -ssh-rsa-cert-v01@openssh.com         -- key algorithm to remove 
 (rec) -diffie-hellman-group14-sha1          -- kex algorithm to remove 
+(rec) -hmac-sha1                            -- mac algorithm to remove 
+(rec) -umac-64@openssh.com                  -- mac algorithm to remove 
 
 # additional info
 (nfo) For hardening guides on common OSes, please see: <https://www.ssh-audit.com/hardening_guides.html>

test/docker/expected_results/openssh_8.0p1_builtin_policy_test1.json

@@ -0,0 +1 @@
+{"errors": [], "host": "localhost", "passed": true, "policy": "Hardened OpenSSH Server v8.0 (version 1)"}

test/docker/expected_results/openssh_8.0p1_builtin_policy_test1.txt

@@ -0,0 +1,3 @@
+Host:   localhost:2222
+Policy: Hardened OpenSSH Server v8.0 (version 1)
+Result: ✔ Passed

test/docker/expected_results/openssh_8.0p1_builtin_policy_test2.json

@@ -0,0 +1 @@
+{"errors": [{"actual": ["umac-64-etm@openssh.com", "umac-128-etm@openssh.com", "hmac-sha2-256-etm@openssh.com", "hmac-sha2-512-etm@openssh.com", "hmac-sha1-etm@openssh.com", "umac-64@openssh.com", "umac-128@openssh.com", "hmac-sha2-256", "hmac-sha2-512", "hmac-sha1"], "expected_optional": [""], "expected_required": ["hmac-sha2-256-etm@openssh.com", "hmac-sha2-512-etm@openssh.com", "umac-128-etm@openssh.com"], "mismatched_field": "MACs"}], "host": "localhost", "passed": false, "policy": "Hardened OpenSSH Server v8.0 (version 1)"}

test/docker/expected_results/openssh_8.0p1_builtin_policy_test2.txt

@@ -0,0 +1,9 @@
+Host:   localhost:2222
+Policy: Hardened OpenSSH Server v8.0 (version 1)
+Result: ❌ Failed!
+
+Errors:
+  * MACs did not match.
+    - Expected: hmac-sha2-256-etm@openssh.com, hmac-sha2-512-etm@openssh.com, umac-128-etm@openssh.com
+    - Actual:   umac-64-etm@openssh.com, umac-128-etm@openssh.com, hmac-sha2-256-etm@openssh.com, hmac-sha2-512-etm@openssh.com, hmac-sha1-etm@openssh.com, umac-64@openssh.com, umac-128@openssh.com, hmac-sha2-256, hmac-sha2-512, hmac-sha1
+

test/docker/expected_results/openssh_8.0p1_custom_policy_test11.json

@@ -0,0 +1 @@
+{"errors": [], "host": "localhost", "passed": true, "policy": "Docker policy: test11 (version 1)"}

test/docker/expected_results/openssh_8.0p1_custom_policy_test11.txt

@@ -0,0 +1,3 @@
+Host:   localhost:2222
+Policy: Docker policy: test11 (version 1)
+Result: ✔ Passed

test/docker/expected_results/openssh_8.0p1_custom_policy_test12.json

@@ -0,0 +1 @@
+{"errors": [{"actual": ["3072"], "expected_optional": [""], "expected_required": ["4096"], "mismatched_field": "RSA host key (rsa-sha2-256) sizes"}, {"actual": ["3072"], "expected_optional": [""], "expected_required": ["4096"], "mismatched_field": "RSA host key (rsa-sha2-512) sizes"}, {"actual": ["3072"], "expected_optional": [""], "expected_required": ["4096"], "mismatched_field": "RSA host key (ssh-rsa) sizes"}], "host": "localhost", "passed": false, "policy": "Docker policy: test12 (version 1)"}

test/docker/expected_results/openssh_8.0p1_custom_policy_test12.txt

@@ -0,0 +1,17 @@
+Host:   localhost:2222
+Policy: Docker policy: test12 (version 1)
+Result: ❌ Failed!
+
+Errors:
+  * RSA host key (rsa-sha2-256) sizes did not match.
+    - Expected: 4096
+    - Actual:   3072
+
+  * RSA host key (rsa-sha2-512) sizes did not match.
+    - Expected: 4096
+    - Actual:   3072
+
+  * RSA host key (ssh-rsa) sizes did not match.
+    - Expected: 4096
+    - Actual:   3072
+

test/docker/expected_results/openssh_8.0p1_custom_policy_test13.json

@@ -0,0 +1 @@
+{"errors": [], "host": "localhost", "passed": true, "policy": "Docker policy: test13 (version 1)"}

test/docker/expected_results/openssh_8.0p1_custom_policy_test13.txt

@@ -0,0 +1,3 @@
+Host:   localhost:2222
+Policy: Docker policy: test13 (version 1)
+Result: ✔ Passed