Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Update README to match the CLI settings and output
  • Loading branch information
juerkkil authored Oct 20, 2024
1 parent 46ef8ad commit ea8f981
Showing 1 changed file with 17 additions and 17 deletions.
34 changes: 17 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,33 +29,33 @@ The following assumes you have Python installed and command `python` refers to
### Usage
```
$ secheaders --help
usage: secheaders [-h] [--max-redirects N] [--no-check-certificate] URL
usage: secheaders [-h] [--max-redirects N] [--insecure] [--verbose] URL
Check HTTP security headers
positional arguments:
URL Target URL
URL Target URL
options:
-h, --help show this help message and exit
--max-redirects N Max redirects, set 0 to disable (default: 2)
--no-check-certificate
Do not verify TLS certificate chain (default: False)
-h, --help show this help message and exit
--max-redirects N Max redirects, set 0 to disable (default: 2)
--insecure Do not verify TLS certificate chain (default: False)
--verbose, -v Verbose output (default: False)
```


### Example output
```
$ secheaders example.com
Header 'x-frame-options' is missing ... [ WARN ]
Header 'strict-transport-security' is missing ... [ WARN ]
Header 'content-security-policy' is missing ... [ WARN ]
Header 'x-content-type-options' is missing ... [ WARN ]
Header 'x-xss-protection' is missing ... [ OK ]
Header 'referrer-policy' is missing ... [ WARN ]
Header 'permissions-policy' is missing ... [ WARN ]
Header 'server' contains value 'ECAcc (nyd/D187) ... [ WARN ]
HTTPS supported ... [ OK ]
HTTPS valid certificate ... [ OK ]
HTTP -> HTTPS redirect ... [ WARN ]
Header 'x-frame-options' is missing [ WARN ]
Header 'strict-transport-security' is missing [ WARN ]
Header 'content-security-policy' is missing [ WARN ]
Header 'x-content-type-options' is missing [ WARN ]
Header 'x-xss-protection' is missing [ OK ]
Header 'referrer-policy' is missing [ WARN ]
Header 'permissions-policy' is missing [ WARN ]
server: ECAcc (nyd/D124) [ WARN ]
HTTPS supported [ OK ]
HTTPS valid certificate [ OK ]
HTTP -> HTTPS automatic redirect [ WARN ]
```

0 comments on commit ea8f981

Please sign in to comment.