From b0c00749a65f5eeb817eef45f60285caf3db0c6e Mon Sep 17 00:00:00 2001 From: Joe Testa Date: Sun, 27 Sep 2020 13:24:37 -0400 Subject: [PATCH] Improved formatting of usage examples. Added link to web front-end. --- README.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 3fa1fc2..3cd9f41 100644 --- a/README.md +++ b/README.md @@ -68,13 +68,13 @@ 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]): +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 anything@localhost"): +To audit a client configuration (listens on port 2222 by default; connect using `ssh anything@localhost`): ``` ssh-audit -c @@ -85,7 +85,7 @@ 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 file paths with -P/--policy): +To list all official built-in policies (hint: use resulting file paths with `-P`/`--policy`): ``` ssh-audit -L ``` @@ -128,7 +128,7 @@ Below is a screen shot of the client-auditing output when an unhardened OpenSSH ### 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 Pre-built packages are available for Windows (see the releases page), on PyPI, Snap, and Homebrew. To install from PyPI: @@ -146,6 +146,9 @@ To install on Homebrew: $ brew install ssh-audit ``` +### 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.3.0 (???) - Added new policy auditing functionality to test adherence to a hardening guide/standard configuration. For an in-depth tutorial, see .