Repository files navigation

[

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

• Clear output: you can tell easily whether anything is good or bad.
• Machine readable output (CSV, two JSON formats), also HTML output.
• No need to install or to configure something. No gems, CPAN, pip or the like.
• Works out of the box: Linux, MacOS, FreeBSD, NetBSD, WSL2, MSYS2/Cygwin, OpenBSD needs bash.
• A Dockerfile is provided, there's also an official container build @ dockerhub and GHCR.
• 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 runyour test and configureyour 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 free and open @ GitHub. Participation and contributions are welcome.
• Unit tests ensure maturity: check for consistency, whether JSON is valid, runs under Linux+MacOS, and a lot more!

This software is free. You can use it under the terms of GPLv2, see LICENSE.

Attribution is important for the future of this project -- also in theinternet. Thus if you're offering a scanner based on testssl.sh as a public and/orpaid service in the internet you are strongly encouraged to mention to your audiencethat you're using this program and where to get this program from. That helps usto get bugfixes, other feedback and more contributions.

Testssl.sh is working on every Linux/BSD distribution and MacOS out of the box. Latest whenthe very old version 2.9 was developed, most of the limitations due to disabled features fromthe openssl client are gone due to bash-socket-based checks. An old OpenSSL-bad version issupplied but these days you can also useany LibreSSL or OpenSSL version.testssl.sh also works on other unixoid systems out of the box, supposed they have/bin/bash >= version 3.2 and standard tools like sed and awk installed. Windows(using MSYS2, Cygwin or WSL/WSL2) work too. An implicit (silent) check for binaries is performedwhen you start testssl.sh . System V Unix needs probably to have GNU grep installed.

Update notifications can be found atgithub or most important ones @mastodon orbluesky.twitter is not being used anymore.

You can download testssl.sh branch 3.3dev just by cloning this git repository:

git clone --depth 1 https://github.com/testssl/testssl.sh.git --branch 3.3dev

3.3dev is the latest development branch which evolved from 3.2 stable. We're trying not to do big experiments in the dev branch, however the point of development is that there will be changes and changes might need a bit time to mature.

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 -it ghcr.io/testssl/testssl.sh <your_cmd_line>

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

docker build . -t imagefoo && docker run --rm -t imagefoo testssl.net

For more please consultDockerfile.md.

Usage of the program is without any warranty. Use it at your own risk.

Testssl.sh is intended to be used as a standalone CLI tool. While we tried to apply best practise security measures and sanitize external input, we can't guarantee that the program is without any vulnerabilities. Running as a web service may pose security risks and you're advised to apply additional security measures. Validate input from the user and from all services which are queried.

Given the current manpower we only support n-1 versions. You're looking at the 3.3.dev branch where further development takes place before 3.4 becomes the stable version and 3.2 becomes old-stable. If you are hestitant with respect to changes, you need to use 3.2. The version 3.0.10 was the last one, there won't be any more updates.

• .. 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.
• There's also anAI generated doc, see also below.
• Will Hunt provided a longerdescription . While it was written for an older version (2.8), it still includes background information.

A lot of contributors already helped to push the project where it currently is, seeCREDITS.md. Your contribution would be also welcome! There's anissue list. To get started look for issues which are labeled asgood first issue,for grabs orhelp wanted. The latter is more advanced. You can also lookout fordocumentation issues, or you can help withunit testing or improving github actions.

It is recommended to readCONTRIBUTING.md and please also have a look at heCoding Convention. Before you start writing PRs with hundreds of lines, better create an issue first.

In general there's also some maintenance burden, like maintaining handshakes and CA stores etc. . If you believe you can contribute and be responsible to one of those maintenance task, please speak up. That would free resources that we could use for development.

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 the template for issues, and further details @https://github.com/testssl/testssl.sh/wiki/Bug-reporting. Nobody can read your thoughts -- yet. And only agencies your screen ;-)

You can also debug yourself, seehere.

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

• https://deepwiki.com/testssl/testssl.sh

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

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

• https://privacyscore.org

• https://github.com/dnmvisser/nagios-testssl (Python 3)
• https://gitgud.malvager.net/Wazakindjes/icinga2_plugins/src/master/check_testssl.sh (Shell)

• https://github.com/AresS31/pentest2xlsx (python)

• see#233 andhttps://github.com/Homebrew/homebrew

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

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

• https://github.com/marketplace/actions/testssl-sh-scan