diff --git a/Usage-Documentation.md b/Usage-Documentation.md index 10e2802..82dd3d6 100644 --- a/Usage-Documentation.md +++ b/Usage-Documentation.md @@ -63,15 +63,16 @@ tuning options (can also be preset via environment variables): --openssl use this openssl binary (default: look in $PATH, $RUN_DIR of testssl.sh --proxy : connect via the specified HTTP proxy -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" 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 - --log, --logging logs stdout to in current working directory - --logfile logs stdout to 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 --show-each for wide outputs: display all ciphers tested -- not only succeeded ones - --warnings "batch" doesn't wait for keypress, "off" or "false" skips connection warning + --mapping 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) - --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. 2: list more what's going on, lists some errors of connections 3: slight hexdumps + other info @@ -79,9 +80,21 @@ tuning options (can also be preset via environment variables): 5: display bytes received via sockets 6: whole 9 yards +file output options (can also be preset via environment variables): + --log, --logging logs stdout to in current working directory + --logfile logs stdout to if file is a dir or to specified log file + --json additional output of findings to JSON file in cwd + --jsonfile additional output to JSON and output JSON to the specified file + --csv additional output of findings to CSV file in cwd + --csvfile set output to CSV and output CSV to the specified file + --append if or 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 . + + All options requiring a value can also be called with `=` (e.g. `testssl.sh -t=smtp --wide --openssl=/usr/bin/openssl `. - is always the last parameter. + is always the last parameter. 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 © 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 @@ -123,5 +136,5 @@ Known ones see https://testssl.sh/bugs ### 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/)