Intro

testssl.sh is a free command line tool which checks a server's service on any port for the support of TLS/SSL ciphers, protocols as well as some cryptographic flaws.

Key features

• Clear output: you can tell easily whether anything is good or bad.
• Machine readable output (CSV, two JSON formats)
• No need to install or to configure something. No gems, CPAN, pip or the like.
• Works out of the box: Linux, OSX/Darwin, FreeBSD, NetBSD, MSYS2/Cygwin, WSL (bash on Windows). Only OpenBSD needs bash.
• A Dockerfile is provided, there's also an offical container @ dockerhub.
• Flexibility: You can test any SSL/TLS enabled and STARTTLS service, not only web servers at port 443.
• Toolbox: Several command line options help you to run your test and configure your output.
• Reliability: features are tested thoroughly.
• Privacy: It's only you who sees the result, not a third party.
• Freedom: It's 100% open source. You can look at the code, see what's going on.
• The development is open (github) and participation is welcome.

License

This software is free. You can use it under the terms of GPLv2, see LICENSE. In addition starting from version 3.0rc1 if you're offering a scanner based on testssl.sh as a public and / or paid service in the internet you need to mention to your audience that you're using this program and where to get this program from.

Compatibility

testssl.sh is working on every Linux/BSD distribution out of the box. Latest by 2.9dev most of the limitations of disabled features from the openssl client are gone due to bash-socket-based checks. As a result you can also use e.g. LibreSSL or OpenSSL 1.1.1 . testssl.sh also works on other unixoid system out of the box, supposed they have /bin/bash >= version 3.2 and standard tools like sed and awk installed. An implicit (silent) check for binaries is done when you start testssl.sh . System V needs probably to have GNU grep installed. MacOS X and Windows (using MSYS2, Cygwin or WSL) work too.

Update notification here or @ twitter.

Installation

You can download testssl.sh by cloning this git repository:

git clone --depth 1 https://github.com/drwetter/testssl.sh.git

Or help yourself downloading the ZIP archive https://github.com/drwetter/testssl.sh/archive/3.0.zip. Just cd to the directory created (=INSTALLDIR) and run it off there.

Docker

Testssl.sh has minimal requirements. As stated you don't have to install or build anything. You can just run it from the pulled/cloned directory. Still if you don't want to pull the github repo to your directory of choice you can pull a container from dockerhub and run it:

docker run --rm -ti drwetter/testssl.sh <your_cmd_line>

Or if you have cloned this repo you also can just cd to the INSTALLDIR and run

docker build .

followed by docker exec -ti <ID> <your_cmd_line> where ID is the identifier in the last line from the build command like

 ---> 889fa2f99933
Successfully built 889fa2f99933

Status

We're currently in the developement pase of 3.1dev. That means occasionally things can break. But we plan to keep it usable, think more of a rolling development. For missing critical purposes or when you don't like changes you should wait a bit until we're in the release phase. As soon as we reach that or the "dev" disappears in the branch you should rather use this version.

Support for 2.9.5 has been dropped. Supported is 3.0 only.

Documentation

• .. it is there for reading. Please do so :-) -- at least before asking questions. See man page in groff, html and markdown format in ~/doc/.
• https://testssl.sh/ will help to get you started.
• Will Hunt provides a longer, good description for the (older) version 2.8, including useful background info.

Contributing

Contributions are welcome! See CONTRIBUTING.md for details.

Bug reports

Bug reports are important. It makes this project more robust.

Please file bugs in the issue tracker @ github. Do not forget to provide detailed information, see template for issue, and further details @ https://github.com/drwetter/testssl.sh/wiki/Bug-reporting. Nobody can read your thoughts -- yet. And only agencies your screen ;-)

You can also debug yourself, see here.

---

External/related projects

Please address questions not specifically to the code of testssl.sh to the respective projects below.

Cool web frontend

• https://github.com/TKCERT/testssl.sh-webfrontend

Mass scanner w parallel scans and elastic searching the results

• https://github.com/TKCERT/testssl.sh-masscan

Another ready-to-go docker image is at:

• https://quay.io/repository/jumanjiman/testssl

Privacy checker using testssl.sh

• https://privacyscore.org

Brew package

• see #233 and https://github.com/Homebrew/homebrew

Daemon for batch execution of testssl.sh command files

• https://github.com/bitsofinfo/testssl.sh-processor

Daemon for batch processing of testssl.sh JSON result files for sending Slack alerts, reactive copying etc

• https://github.com/bitsofinfo/testssl.sh-alerts