Git/testssl.sh
1
0
Fork 0
mirror of https://github.com/drwetter/testssl.sh.git synced 2024-11-21 18:41:35 +01:00
Code Issues Packages Projects Releases Wiki Activity

Updated Usage Documentation (markdown)

Dirk Wetter 2016-09-10 18:29:22 +02:00
parent e6d7b5223d
commit 595a43db52
1 changed files with 21 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
Usage-Documentation.md

@ -63,15 +63,16 @@ tuning options (can also be preset via environment variables):
--openssl <PATH> use this openssl binary (default: look in $PATH, $RUN_DIR of testssl.sh --openssl <PATH> use this openssl binary (default: look in $PATH, $RUN_DIR of testssl.sh
--proxy <host>:<port> connect via the specified HTTP proxy --proxy <host>:<port> connect via the specified HTTP proxy
-6 use also IPv6 checks, works only with supporting OpenSSL version and IPv6 connectivity -6 use also IPv6 checks, works only with supporting OpenSSL version and IPv6 connectivity
--sneaky leave less traces in target logs: user agent, referer
utput options (can also be preset via environment variables):
--warnings <batch|off|false> "batch" doesn't wait for keypress, "off" or "false" skips connection warning
--quiet don't output the banner. By doing this you acknowledge usage terms normally appearing in the banner --quiet don't output the banner. By doing this you acknowledge usage terms normally appearing in the banner
--log, --logging logs stdout to <NODE-YYYYMMDD-HHMM.log> in current working directory
--logfile <file> logs stdout to <file/NODE-YYYYMMDD-HHMM.log> if file is a dir or to specified file
--wide wide output for tests like RC4, BEAST. PFS also with hexcode, kx, strength, RFC name --wide wide output for tests like RC4, BEAST. PFS also with hexcode, kx, strength, RFC name
--show-each for wide outputs: display all ciphers tested -- not only succeeded ones --show-each for wide outputs: display all ciphers tested -- not only succeeded ones
--warnings <batch|off|false> "batch" doesn't wait for keypress, "off" or "false" skips connection warning --mapping <no-rfc> don't display the RFC Cipher Suite Name
--color <0|1|2> 0: no escape or other codes, 1: b/w escape codes, 2: color (default) --color <0|1|2> 0: no escape or other codes, 1: b/w escape codes, 2: color (default)
--debug <0-6> 0: none --colorblind swap green and blue in the output
--debug <0-6> 0: none
1: screen output normal but debug output in temp files. 1: screen output normal but debug output in temp files.
2: list more what's going on, lists some errors of connections 2: list more what's going on, lists some errors of connections
3: slight hexdumps + other info 3: slight hexdumps + other info
@ -79,9 +80,21 @@ tuning options (can also be preset via environment variables):
5: display bytes received via sockets 5: display bytes received via sockets
6: whole 9 yards 6: whole 9 yards
file output options (can also be preset via environment variables):
--log, --logging logs stdout to <NODE-YYYYMMDD-HHMM.log> in current working directory
--logfile <logfile> logs stdout to <file/NODE-YYYYMMDD-HHMM.log> if file is a dir or to specified log file
--json additional output of findings to JSON file <NODE-YYYYMMDD-HHMM.json> in cwd
--jsonfile <jsonfile> additional output to JSON and output JSON to the specified file
--csv additional output of findings to CSV file <NODE-YYYYMMDD-HHMM.csv> in cwd
--csvfile <csvfile> set output to CSV and output CSV to the specified file
--append if <csvfile> or <jsonfile> exists rather append then overwrite
All options requiring a value can also be called with '=' e.g. testssl.sh -t=smtp --wide --openssl=/usr/bin/openssl <URI>.
All options requiring a value can also be called with `=` (e.g. `testssl.sh -t=smtp --wide --openssl=/usr/bin/openssl <URI>`. All options requiring a value can also be called with `=` (e.g. `testssl.sh -t=smtp --wide --openssl=/usr/bin/openssl <URI>`.
<URI> is always the last parameter. <URI> is always the last parameter.
Need HTML output? Just pipe through "aha" (Ansi HTML Adapter: github.com/theZiz/aha) like Need HTML output? Just pipe through "aha" (Ansi HTML Adapter: github.com/theZiz/aha) like
@ -114,7 +127,7 @@ Developed by Dirk Wetter and others, see https://github.com/drwetter/testssl.sh/
### COPYRIGHT ### COPYRIGHT
Copyright © 2016 Dirk Wetter. License GPLv2: Free Software Foundation, Inc. Copyright © 2016 Dirk Wetter. License GPLv2: Free Software Foundation, Inc.
This is free software: you are free to change and redistribute it. Usage WITHOUT ANY WARRANTY. USE at your OWN RISK. This is free software: you are free to change and redistribute it under the terms of the license. Usage WITHOUT ANY WARRANTY. USE at your OWN RISK!
### BUGS ### BUGS
@ -123,5 +136,5 @@ Known ones see https://testssl.sh/bugs
### SEE ALSO ### SEE ALSO
ciphers(1), openssl(1) ciphers(1), openssl(1), [Will Hunt's description](https://www.4armed.com/blog/doing-your-own-ssl-tls-testing/)