Skip to content

Commit

Permalink
Improved formatting of usage examples. Added link to web front-end.
Browse files Browse the repository at this point in the history
  • Loading branch information
jtesta committed Sep 27, 2020
1 parent 6e3e8ba commit b0c0074
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
```
Expand Down Expand Up @@ -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:
Expand All @@ -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 <link_goes_here>.
Expand Down

0 comments on commit b0c0074

Please sign in to comment.