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), 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 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 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!
License
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 the
internet. Thus if you’re offering a scanner based on testssl.sh as a public and/or
paid service in the internet you are strongly encouraged to mention to your audience
that you’re using this program and where to get this program from. That helps us
to get bugfixes, other feedback and more contributions.
Compatibility
Testssl.sh is working on every Linux/BSD distribution and MacOS out of the box. Latest when
the very old version 2.9 was developed, most of the limitations due to disabled features from
the openssl client are gone due to bash-socket-based checks. An old OpenSSL-bad version is
supplied but these days you can also use any 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 performed
when you start testssl.sh . System V Unix needs probably to have GNU grep installed.
Update notifications can be found at github or most important ones @ mastodon or bluesky. twitter is not being used anymore.
Installation
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.
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 -it ghcr.io/testssl/testssl.sh <your_cmd_line>
Or if you have cloned this repo you also can just cd to the INSTALLDIR and run
docker build . -t imagefoo && docker run --rm -t imagefoo testssl.net
For more please consult Dockerfile.md.
No Warranty
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.
Status
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.
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.
- There’s also an AI generated doc, see also below.
- Will Hunt provided a longer description . While it was written for an older version (2.8), it still includes background information.
Contributing
A lot of contributors already helped to push the project where it currently is, see CREDITS.md. Your contribution would be also welcome! There’s an issue list. To get started look for issues which are labeled as good first issue, for grabs or help wanted. The latter is more advanced. You can also lookout for documentation issues, or you can help with unit testing or improving github actions.
It is recommended to read CONTRIBUTING.md and please also have a look at he Coding 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
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, see here.
Security bug reports
See SECURITY.md.
Please address questions not specifically to the code of testssl.sh to the respective projects below.
AI powered docs @ DeepWiki
Web frontend
Mass scanner w parallel scans and elastic searching the results
Nagios / Icinga Plugins
pentest2xlsx: generate Excel sheets from CSV
Brew package
Daemon for batch execution of testssl.sh command files
Daemon for batch processing of testssl.sh JSON result files for sending Slack alerts, reactive copying etc
GitHub Actions
php-ssl Certificate scanning integration
![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)
评论