summaryrefslogtreecommitdiffstats
path: root/Readme.md
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-15 17:11:11 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-15 17:11:11 +0000
commitba28aa09cebfba17fd16de2af6fedf7ecc76eea5 (patch)
tree44e2ff1493776a06e95c359c53a1cabca5d8a8d4 /Readme.md
parentInitial commit. (diff)
downloadtestssl.sh-ba28aa09cebfba17fd16de2af6fedf7ecc76eea5.tar.xz
testssl.sh-ba28aa09cebfba17fd16de2af6fedf7ecc76eea5.zip
Adding upstream version 3.2~rc3+dfsg.upstream/3.2_rc3+dfsgupstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'Readme.md')
-rw-r--r--Readme.md137
1 files changed, 137 insertions, 0 deletions
diff --git a/Readme.md b/Readme.md
new file mode 100644
index 0000000..fccbba9
--- /dev/null
+++ b/Readme.md
@@ -0,0 +1,137 @@
+
+## Intro
+
+<!-- [![Travis CI Status](https://img.shields.io/travis/drwetter/testssl.sh)](https://travis-ci.org/drwetter/testssl.sh) -->
+[![Build Status](https://github.com/drwetter/testssl.sh/actions/workflows/test.yml/badge.svg)](https://github.com/drwetter/testssl.sh/actions/workflows/test.yml)
+[![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)
+[![License](https://img.shields.io/github/license/drwetter/testssl.sh)](https://github.com/drwetter/testssl.sh/LICENSE)
+[![Docker](https://img.shields.io/docker/pulls/drwetter/testssl.sh)](https://github.com/drwetter/testssl.sh/blob/3.2/Dockerfile.md)
+
+`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](https://infosec.exchange/@testssl) (old: [twitter](https://twitter.com/drwetter))
+
+### 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](https://codeload.github.com/drwetter/testssl.sh/zip/v3.0.8) or [tar.gz](https://codeload.github.com/drwetter/testssl.sh/tar.gz/v3.0.8) 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](https://github.com/drwetter/testssl.sh/blob/3.2/Dockerfile.md).
+
+
+### 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/](https://testssl.sh/) will help to get you started.
+* For the (older) version 2.8, Will Hunt provides a longer [description](https://www.4armed.com/blog/doing-your-own-ssl-tls-testing/), including useful background information.
+
+### Contributing
+
+Contributions are welcome! See [CONTRIBUTING.md](https://github.com/drwetter/testssl.sh/blob/3.2/CONTRIBUTING.md) for details. Please also have a look at the [Coding Convention](https://github.com/drwetter/testssl.sh/blob/3.2/Coding_Convention.md).
+
+### 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](https://github.com/drwetter/testssl.sh/wiki/Findings-and-HowTo-Fix-them).
+
+----
+
+### External/related projects
+
+Please address questions not specifically to the code of testssl.sh to the respective projects below.
+
+#### Web frontend
+* https://github.com/johannesschaefer/webnettools
+* https://github.com/TKCERT/testssl.sh-webfrontend
+
+#### Free to use Web frontend + commercial API
+* https://inspect.rapydblok.com (see also https://inspect.rapydblok.com/about)
+
+#### Mass scanner w parallel scans and elastic searching the results
+* https://github.com/TKCERT/testssl.sh-masscan
+
+#### Privacy checker using testssl.sh
+* https://privacyscore.org
+
+#### 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
+
+* see [#233](https://github.com/drwetter/testssl.sh/issues/233) and
+ [https://github.com/Homebrew/homebrew](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
+
+#### GitHub Actions
+* https://github.com/marketplace/actions/testssl-sh-scan