From 2abad4c258a561d50f5fe8f799bee935fb879dab Mon Sep 17 00:00:00 2001 From: Dirk Wetter Date: Thu, 5 Nov 2015 08:37:48 +0100 Subject: [PATCH] Update Readme.md --- Readme.md | 21 ++++++++++++++++++--- 1 file changed, 18 insertions(+), 3 deletions(-) diff --git a/Readme.md b/Readme.md index 8504355..1b189ea 100644 --- a/Readme.md +++ b/Readme.md @@ -3,11 +3,26 @@ [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/drwetter/testssl.sh?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) -`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. It's designed to provide clear output in any case. +`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. -It is working on every Linux distribution out of the box with some limitations of disabled features from the openssl client -- some workarounds are done with bash-socket-based checks. It also works on BSD and other Unices out of the box, supposed they have `/bin/bash` and standard tools like sed and awk installed. MacOS X and Windows (using MSYS2 or cygwin) work too. OpenSSL version >= 1 is a must. OpenSSL version >= 1.0.2 is needed for better LOGJAM checks and to display bit strengths for key exchanges. +Key features + +* Clear output: you can tell easily whether anything is good or bad +* Ease of installation: It works for Linux, Darwin, FreeBSD and MSYS2/Cygwin out of the box: no need to install or configure something, no gems, CPAN, pip or the like. +* Flexibility: You can test any SSL/TLS enabled and STARTTLS service, not only webservers at port 443 +* Toolbox: Several command line options help you to run YOUR test and configure YOUR output +* Reliability: features are tested thoroughly +* Verbosity: If a particular check cannot be performed because of a missing capability on your client side, you'll get a warning +* 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 and you can change it. +* Heck, even the development is open (github) + + +Here in the master branch you find the development version of the software -- with new features and maybe some bugs. For the stable version and **a more thorough description of the command line options** please see [testssl.sh](https://testssl.sh/ "Go to the site with the stable version and more documentation"). + + +testssl.sh is working on every Linux/BSD distribution out of the box with some limitations of disabled features from the openssl client -- some workarounds are done with bash-socket-based checks. It also works on other unixoid system out of the box, supposed they have `/bin/bash` and standard tools like sed and awk installed. MacOS X and Windows (using MSYS2 or cygwin) work too. OpenSSL version >= 1 is a must. OpenSSL version >= 1.0.2 is needed for better LOGJAM checks and to display bit strengths for key exchanges. -On github you will find in the master branch the development version of the software -- with new features and maybe some bugs. For the stable version and a more thorough description of the software please see [testssl.sh](https://testssl.sh/ "Go to the site with the stable version and more documentation"). Planned features in the release 2.7dev/2.8 are: