From 5ecf2d2056501c664842ac33199c4d026b1e1ffc Mon Sep 17 00:00:00 2001 From: Alban Diquet Date: Sun, 21 Sep 2014 13:11:28 -0700 Subject: [PATCH] Revert "Move SSLyze to new repo" This reverts commit 452fb5fd66c1f29c66c2d8eec8efc25a318d7b5c. --- README.md | 83 +++++++++++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 75 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 085704fa..79f214fe 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,79 @@ -SSLyze has moved! -================= +SSLyze +====== -SSLyze has moved to a different GitHub account at -[https://github.com/nabla-c0d3/sslyze](https://github.com/nabla-c0d3/sslyze). +Fast and full-featured SSL scanner. -This repository will no longer be updated... please update your bookmarks. If -you cloned the repo, you can update the repo's origin using the following -command: - git remote set-url origin https://github.com/nabla-c0d3/sslyze.git +Description +----------- +SSLyze is a Python tool that can analyze the SSL configuration of a server by +connecting to it. It is designed to be fast and comprehensive, and should help +organizations and testers identify misconfigurations affecting their SSL +servers. + +Key features include: +* Multi-processed and multi-threaded scanning (it's fast) +* SSL 2.0/3.0 and TLS 1.0/1.1/1.2 compatibility +* Performance testing: session resumption and TLS tickets support +* Security testing: weak cipher suites, insecure renegotiation, CRIME, Heartbleed and more +* Server certificate validation and revocation checking through OCSP stapling +* Support for StartTLS handshakes on SMTP, XMPP, LDAP, POP, IMAP, RDP and FTP +* Support for client certificates when scanning servers that perform mutual authentication +* XML output to further process the scan results +* And much more ! + + +Installation +------------ + +SSLyze requires Python 2.7; the supported platforms are Windows 7 32/64 bits, +Linux 32/64 bits and OS X 64 bits. + +SSLyze is statically linked with OpenSSL. For this reason, the easiest +way to run SSLyze is to download one the pre-compiled packages available in +the GitHub releases section for this project, at +https://github.com/iSECPartners/sslyze/releases. + + +Usage +----- + +### Command line options + +The following command will provide the list of available command line options: + $ python sslyze.py -h + + +### Sample command line: + + $ python sslyze.py --regular www.isecpartners.com:443 www.google.com + +See the test folder for additional examples. + + +Build / nassl +------------- + +SSLyze is all Python code but since version 0.7, it uses a custom OpenSSL +wrapper written in C called nassl. The pre-compiled packages for SSLyze +contain a compiled version of this wrapper in sslyze/nassl. If you want to +clone the SSLyze repo, you will have to get a compiled version of nassl from +one of the SSLyze packages and copy it to sslyze-master/nassl, in order to get +SSLyze to run. + +The source code for nassl is hosted at https://github.com/nabla-c0d3/nassl. + + +Py2exe Build +------------ + +SSLyze can be packaged as a Windows executable by running the following command: + + $ python.exe setup_py2exe.py py2exe + + +License +-------- + +GPLv2 - See LICENSE.txt.