diff --git a/Man-page.md b/Man-page.md index 73f49c1..6662d6f 100644 --- a/Man-page.md +++ b/Man-page.md @@ -4,7 +4,7 @@ ### SYNOPSIS -testssl.sh [OPTIONS]... [FILE|URI]... +``testssl.sh [OPTIONS]... [FILE|URI]...`` ### DESCRIPTION @@ -12,7 +12,7 @@ testssl.sh is a free command line tool which checks a server's service on any po Options are either short or long options. All options requiring a value can be called with or without '=' e.g. ``testssl.sh -t=smtp --wide --openssl=/usr/bin/openssl `` is equivalent to ``testssl.sh --starttls smtp --wide --openssl /usr/bin/openssl ``. Some options can also be preset via ENV variables. ``WIDE=true OPENSSL=/usr/bin/openssl testssl.sh --starttls smtp `` would be the equivalent to the aforementioned examples. Preference has the command line over ENV. -\ or \ needs always to be the last parameter. +``\`` or ``\`` needs always to be the last parameter. ##### BANNER OPTIONS ``-h, --help`` command line help @@ -21,22 +21,20 @@ Options are either short or long options. All options requiring a value can be c ``-v, --version`` same as before -``-V, --local `` -``-V, --local`` pretty print all local ciphers supported by openssl version. If a pattern is supplied it performs a match (ignore case) on any of the strings supplied in the wide output, see below. The pattern will be searched in the any of the columns: hexcode, cipher suite name (OpenSSL or RFC), key exchange, encryption, bits. It does a word pattern match for non-numbers, for number just a normal match applies. Numbers here are defined as [0-9,A-F]. This means (attention: catch) that the pattern CBC is matched as non-word, but AES as word. +``-V, --local `` or ``-V, --local`` pretty print all local ciphers supported by openssl version. If a pattern is supplied it performs a match (ignore case) on any of the strings supplied in the wide output, see below. The pattern will be searched in the any of the columns: hexcode, cipher suite name (OpenSSL or RFC), key exchange, encryption, bits. It does a word pattern match for non-numbers, for number just a normal match applies. Numbers here are defined as [0-9,A-F]. This means (attention: catch) that the pattern CBC is matched as non-word, but AES as word. ##### INPUT PARAMETERS -``URI`` can be a hostname, an IPv4 or IPv6 address (restriction see below) or an URL. For any given parameter port 443 is assumed unless otherwise specified as <:port>. The only preceding protocol specifier allowed is ``https``. You need to be aware that checks for an IP address might not hit the vhost you want. DNS resolution (A/AAAA record) is being performed unless you have an ``/etc/hosts`` entry for the hostname. +``URI`` can be a hostname, an IPv4 or IPv6 address (restriction see below) or an URL. For any given parameter port 443 is assumed unless otherwise specified by appending a colon and a port number. The only preceding protocol specifier allowed is ``https``. You need to be aware that checks for an IP address might not hit the vhost you want. DNS resolution (A/AAAA record) is being performed unless you have an ``/etc/hosts`` entry for the hostname. ``--file `` is the mass testing option. Per default it implicitly turns on ``--warnings batch``. -In its first incarnation the mass testing option reads command lines from \. \ consists of command lines of testssl, one line per instance. Comments after ``#`` are ignored, EOF signals the end of \. When invoking ``testssl.sh --file `` you can also supply additional options which will be inherited to each child. The commands are parsed upon execution. So if there's a conflicting option and serial mass testing option is being performed the check will be aborted at the time it occurs and depending on the output option potentially leaving you with an output file without footer. In parallel mode the mileage varies. +In its first incarnation the mass testing option reads command lines from ``\``. ``\`` consists of command lines of testssl, one line per instance. Comments after ``#`` are ignored, ``EOF`` signals the end of \ any subsequent lines will be ignored too. You can also supply additional options which will be inherited to each child, e.g. When invoking ``testssl.sh --wide --log --file `` . Each single line in ``\`` is parsed upon execution. If there's a conflicting option and serial mass testing option is being performed the check will be aborted at the time it occurs and depending on the output option potentially leaving you with an output file without footer. In parallel mode the mileage varies. -Alternatively ```` can be in ``nmap``'s grep(p)able output format (-oG). Only open ports will be considered. Multiple ports per line are allowed. The ports can be different and will be tested by testssl.sh according to common practice in the internet, .i.e. if nmap shows in its output an open port 25, automatically ``-t smtp`` will be added before the URI whereas port 465 will be treated as a plain TLS/SSL port, not requiring an STARTTLS SMTP handshake upfront. +Alternatively ``\\`` can be in ``nmap``'s grep(p)able output format (``-oG``). Only open ports will be considered. Multiple ports per line are allowed. The ports can be different and will be tested by testssl.sh according to common practice in the internet, .i.e. if nmap shows in its output an open port 25, automatically ``-t smtp`` will be added before the URI whereas port 465 will be treated as a plain TLS/SSL port, not requiring an STARTTLS SMTP handshake upfront. -The nmap output always returns IP addresses and -- only if there's a PTR DNS record available -- a hostname. Unfortunately it is not checked by nmap whether it matches the IP (A or AAAA record). testssl.sh does this for you -and if the A record of the hostname matches the IP address, the hostname is used and not the IP address. As stated above, checks against an IP address might not hit the vhost you maybe was aiming at. +The nmap output always returns IP addresses and -- only if there's a PTR DNS record available -- a hostname. As it is not checked by nmap whether the hostname matches the IP (A or AAAA record), testssl.sh does this for you. If the A record of the hostname matches the IP address, the hostname is used and not the IP address. As stated above, checks against an IP address might not hit the vhost you maybe were aiming at. -``--mode ``. Mass testing to be done serial (default) or parallel (``--parallel ``is shortcut for the latter, ``--serial`` is the opposite option). Per default mass testing is being run in serial mode, i.e. one line after the other is processed and invoked. +``--mode ``. Mass testing to be done serial (default) or parallel (``--parallel ``is shortcut for the latter, ``--serial`` is the opposite option). Per default mass testing is being run in serial mode, i.e. one line after the other is processed and invoked. The variable MASS_TESTING_MODE can be defined to be either equal ``serial`` or ``parallel``. ##### SPECIAL INVOCATIONS: @@ -47,7 +45,9 @@ and if the A record of the hostname matches the IP address, the hostname is used ``--mx `` tests all MX records (STARTTLS, port 25) from high to low priority one after the other. -``--ip `` a) tests either the supplied IPv4 or IPv6 address instead of resolving host(s) in URI. b) ``--ip=one`` means: just test the first DNS returns (useful for multiple IPs). It's also useful if you want to resolve the supplied hostname to a different IP, similar as if you would edit ``/etc/hosts``. +``--ip `` Tests either the supplied IPv4 or IPv6 address instead of resolving host(s) in URI. ``--ip=one`` means: just test the first DNS returns (useful for multiple IPs). It's also useful if you want to resolve the supplied hostname to a different IP, similar as if you would edit ``/etc/hosts``. ``--ip=proxy`` tries a DNS resolution via proxy. + +``--proxy :`` Does the whole check via the specified HTTP proxy. ``--proxy=auto`` inherits the proxy setting from the environment variablenm,./. ##### DEFAULT CHECKS