elie/ssh-audit
1
0
Fork 0
mirror of https://github.com/jtesta/ssh-audit.git synced 2024-12-22 22:15:22 +01:00
Code Issues Packages Projects Releases Wiki Activity

Improved formatting of usage examples. Added link to web front-end.

Browse Source
This commit is contained in:
Joe Testa 2020-09-27 13:24:37 -04:00
parent 6e3e8bac74
commit b0c00749a6
1 changed files with 7 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -68,13 +68,13 @@ ssh-audit ::1
ssh-audit [::1]:222 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 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 ssh-audit -c
@ -85,7 +85,7 @@ To audit a client configuration, with a listener on port 4567:
ssh-audit -c -p 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 ssh-audit -L
``` ```
@ -128,7 +128,7 @@ Below is a screen shot of the client-auditing output when an unhardened OpenSSH
### 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) 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. Pre-built packages are available for Windows (see the releases page), on PyPI, Snap, and Homebrew.
To install from PyPI: To install from PyPI:
@ -146,6 +146,9 @@ To install on Homebrew:
$ brew install ssh-audit $ 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 ## ChangeLog
### v2.3.0 (???) ### v2.3.0 (???)
- Added new policy auditing functionality to test adherence to a hardening guide/standard configuration. For an in-depth tutorial, see <link_goes_here>. - Added new policy auditing functionality to test adherence to a hardening guide/standard configuration. For an in-depth tutorial, see <link_goes_here>.