Top Related Projects
Nmap - the Network Mapper. Github mirror of official SVN repository.
A command-line reference-implementation client for SSL Labs APIs, designed for automated and/or bulk testing.
Fast and powerful SSL/TLS scanning library.
Quick Overview
testssl.sh is a command-line tool that checks a server's SSL/TLS configuration and vulnerabilities. It provides detailed information about supported protocols, ciphers, and potential security issues, making it valuable for system administrators and security professionals to assess and improve the security of their SSL/TLS implementations.
Pros
- Comprehensive analysis of SSL/TLS configurations
- Supports various protocols and ciphers, including modern and legacy versions
- Regularly updated to include new vulnerabilities and security checks
- Can be run without installation, making it portable and easy to use
Cons
- Requires some technical knowledge to interpret results effectively
- May produce false positives in certain scenarios
- Can be slow when performing extensive scans on multiple hosts
- Limited graphical output options, primarily focused on command-line output
Getting Started
To use testssl.sh, follow these steps:
-
Clone the repository:
git clone https://github.com/drwetter/testssl.sh.git
-
Make the script executable:
chmod +x testssl.sh
-
Run a basic scan on a target host:
./testssl.sh example.com
For more advanced usage and options, refer to the project's documentation on GitHub.
Competitor Comparisons
Nmap - the Network Mapper. Github mirror of official SVN repository.
Pros of Nmap
- Comprehensive network scanning and discovery tool
- Supports a wide range of protocols and scanning techniques
- Large and active community with extensive documentation
Cons of Nmap
- Steeper learning curve for advanced features
- Can be resource-intensive for large-scale scans
- Less focused on SSL/TLS-specific testing
Code Comparison
testssl.sh:
#!/usr/bin/env bash
# testssl.sh - Testing TLS/SSL encryption
Nmap:
-- nmap.lua
local nmap = require "nmap"
local shortport = require "shortport"
Key Differences
- Focus: testssl.sh specializes in SSL/TLS testing, while Nmap is a general-purpose network scanner
- Language: testssl.sh is written in Bash, Nmap uses C++ and Lua
- Scope: testssl.sh is more targeted, Nmap offers broader network analysis capabilities
Use Cases
testssl.sh:
- Detailed SSL/TLS configuration analysis
- Certificate validation and vulnerability checks
Nmap:
- Network discovery and port scanning
- OS detection and service/version identification
Both tools complement each other well in a security professional's toolkit, with testssl.sh providing deep SSL/TLS insights and Nmap offering comprehensive network scanning capabilities.
A command-line reference-implementation client for SSL Labs APIs, designed for automated and/or bulk testing.
Pros of ssllabs-scan
- Leverages Qualys SSL Labs' comprehensive SSL/TLS testing infrastructure
- Provides detailed analysis and grading of server SSL/TLS configuration
- Offers a more user-friendly output format for less technical users
Cons of ssllabs-scan
- Requires an internet connection and relies on external servers
- May have slower scan times due to remote testing
- Limited customization options compared to testssl.sh
Code Comparison
testssl.sh:
#!/usr/bin/env bash
# testssl.sh - Testing TLS/SSL encryption
OPENSSL="/usr/bin/openssl"
HEXDUMP="/usr/bin/hexdump"
ssllabs-scan:
package main
import (
"fmt"
"github.com/ssllabs/ssllabs-scan/v3"
)
testssl.sh is written in Bash, making it easily portable and modifiable on Unix-like systems. ssllabs-scan is written in Go, offering better performance and cross-platform compatibility.
testssl.sh provides more granular control over the testing process, allowing users to customize individual checks. ssllabs-scan relies on the SSL Labs API, which offers a standardized and comprehensive set of tests but with less flexibility for customization.
Both tools are valuable for SSL/TLS testing, with testssl.sh being more suitable for advanced users and offline environments, while ssllabs-scan is ideal for quick, user-friendly assessments leveraging Qualys' extensive testing infrastructure.
Fast and powerful SSL/TLS scanning library.
Pros of sslyze
- Written in Python, making it more accessible for scripting and integration
- Offers a comprehensive GUI for easier visualization of results
- Provides more detailed analysis of certain SSL/TLS aspects
Cons of sslyze
- Generally slower than testssl.sh for large-scale scans
- Less frequent updates compared to testssl.sh
- May require additional dependencies for full functionality
Code Comparison
testssl.sh (Bash):
#!/usr/bin/env bash
[ -z "$TESTSSL_INSTALL_DIR" ] && TESTSSL_INSTALL_DIR="$(dirname "$0")"
. "$TESTSSL_INSTALL_DIR/etc/testssl.cnf"
sslyze (Python):
from sslyze import ServerNetworkLocationViaDirectConnection, ServerConnectivityTester, Scanner, ServerScanRequest
from sslyze.errors import ConnectionToServerFailed
Both tools aim to analyze SSL/TLS configurations, but their implementation differs significantly. testssl.sh is a Bash script that relies on OpenSSL for most of its functionality, while sslyze is a Python-based tool that implements its own SSL/TLS stack.
testssl.sh is generally more lightweight and faster for quick scans, while sslyze offers more detailed analysis and a GUI. The choice between them often depends on the specific use case and user preferences.
Convert designs to code with AI
Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.
Try Visual CopilotREADME
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 official container build @ 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.
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 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 systems 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 @ mastodon (old: twitter)
Installation
You can download testssl.sh branch 3.2 just by cloning this git repository:
git clone --depth 1 https://github.com/drwetter/testssl.sh.git
3.2 is now the latest branch which evolved from 3.1dev. It's in the release candidate phase.
For the former stable version help yourself by downloading the ZIP or tar.gz archive. 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 . -t imagefoo && docker run --rm -t imagefoo example.com
For more please consult Dockerfile.md.
No Warranty
Usage of the program is without any warranty. Use it at yor own risk.
Testssl.sh is intended to be used as a standalone CLI tool. While we tried to apply best practise security measures, we can't guarantee that the program is without any vulnerabilities. Running as a service may pose security risks and you're recommended to apply additional security measures.
Status
We're currently in the release candidate phase for version 3.2. Bigger features will be developed in a separate branch before merged into a 3.3dev to avoid hiccups or inconsistencies.
Version 3.0.X receives bugfixes, labeled as 3.0.1, 3.0.2 and so on. This will happen until 3.2 is released.
Support for 2.9.5 has been dropped. Supported is >= 3.0.x 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.
- For the (older) version 2.8, Will Hunt provides a longer description, including useful background information.
Contributing
Contributions are welcome! See CONTRIBUTING.md for details. Please also have a look at the Coding Convention.
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.
Web frontend
Free to use Web frontend + commercial API
Mass scanner w parallel scans and elastic searching the results
Privacy checker using testssl.sh
Nagios / Icinga Plugins
- https://github.com/dnmvisser/nagios-testssl (Python 3)
- https://gitgud.malvager.net/Wazakindjes/icinga2_plugins/src/master/check_testssl.sh (Shell)
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
Top Related Projects
Nmap - the Network Mapper. Github mirror of official SVN repository.
A command-line reference-implementation client for SSL Labs APIs, designed for automated and/or bulk testing.
Fast and powerful SSL/TLS scanning library.
Convert designs to code with AI
Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.
Try Visual Copilot