-
Notifications
You must be signed in to change notification settings - Fork 436
/
index.html
200 lines (163 loc) · 10.6 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
<!DOCTYPE html>
<html lang="en" data-content_root="./">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
<title>SSLyze — SSLyze 6.0.0 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=039e1c02" />
<script src="_static/documentation_options.js?v=12958129"></script>
<script src="_static/doctools.js?v=888ff710"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Running a Scan in Python" href="running-a-scan-in-python.html" />
<link rel="stylesheet" href="_static/custom.css" type="text/css" />
<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
</head><body>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<section id="sslyze">
<h1><a class="toc-backref" href="#id1" role="doc-backlink">SSLyze</a><a class="headerlink" href="#sslyze" title="Link to this heading">¶</a></h1>
<p>Release 6.0.0</p>
<a class="reference external image-reference" href="https://pepy.tech/project/sslyze"><img alt="https://pepy.tech/badge/sslyze" src="https://pepy.tech/badge/sslyze" /></a>
<a class="reference external image-reference" href="https://pypi.org/project/sslyze/"><img alt="https://img.shields.io/pypi/l/sslyze.svg" src="https://img.shields.io/pypi/l/sslyze.svg" /></a>
<a class="reference external image-reference" href="https://pypi.org/project/sslyze/"><img alt="https://img.shields.io/pypi/pyversions/sslyze.svg" src="https://img.shields.io/pypi/pyversions/sslyze.svg" /></a>
<p>SSLyze is a fast and powerful SSL/TLS scanning tool and Python library.</p>
<p>SSLyze can analyze the SSL/TLS configuration of a server by connecting to it, in order to ensure that it uses strong
encryption settings (certificate, cipher suites, elliptic curves, etc.), and that it is not vulnerable to known TLS
attacks (Heartbleed, ROBOT, OpenSSL CCS injection, etc.).</p>
<nav class="contents" id="contents">
<p class="topic-title">Contents</p>
<ul class="simple">
<li><p><a class="reference internal" href="#sslyze" id="id1">SSLyze</a></p>
<ul>
<li><p><a class="reference internal" href="#installation-quick-start" id="id2">Installation & Quick Start</a></p></li>
<li><p><a class="reference internal" href="#running-scans-using-the-python-api" id="id3">Running scans using the Python API</a></p></li>
<li><p><a class="reference internal" href="#exporting-and-processing-scan-results-in-json" id="id4">Exporting and processing scan results in JSON</a></p></li>
<li><p><a class="reference internal" href="#appendix-scan-commands" id="id5">Appendix: Scan Commands</a></p></li>
<li><p><a class="reference internal" href="#indices-and-tables" id="id6">Indices and tables</a></p></li>
</ul>
</li>
</ul>
</nav>
<section id="installation-quick-start">
<h2><a class="toc-backref" href="#id2" role="doc-backlink">Installation & Quick Start</a><a class="headerlink" href="#installation-quick-start" title="Link to this heading">¶</a></h2>
<p>Instructions on how to install and use SSLyze are available in
the <a class="reference external" href="https://github.com/nabla-c0d3/sslyze#quick-start">README</a>.</p>
</section>
<section id="running-scans-using-the-python-api">
<h2><a class="toc-backref" href="#id3" role="doc-backlink">Running scans using the Python API</a><a class="headerlink" href="#running-scans-using-the-python-api" title="Link to this heading">¶</a></h2>
<p>The Python API gives full access to SSLyze’s scanning engine in order to make it easy to implement SSL/TLS scanning as
part of a continuous security testing platform, and detect any misconfiguration across a range of public and/or internal
endpoints.</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="running-a-scan-in-python.html">Running a Scan in Python</a><ul>
<li class="toctree-l2"><a class="reference internal" href="running-a-scan-in-python.html#overview">Overview</a></li>
<li class="toctree-l2"><a class="reference internal" href="running-a-scan-in-python.html#full-example">Full Example</a></li>
<li class="toctree-l2"><a class="reference internal" href="running-a-scan-in-python.html#classes-for-starting-a-scan">Classes for Starting a Scan</a></li>
<li class="toctree-l2"><a class="reference internal" href="running-a-scan-in-python.html#classes-for-processing-scan-results">Classes for Processing Scan Results</a></li>
</ul>
</li>
</ul>
</div>
</section>
<section id="exporting-and-processing-scan-results-in-json">
<h2><a class="toc-backref" href="#id4" role="doc-backlink">Exporting and processing scan results in JSON</a><a class="headerlink" href="#exporting-and-processing-scan-results-in-json" title="Link to this heading">¶</a></h2>
<p>The result of SSLyze scans can be serialized to JSON for further processing. SSLyze also provides a helper class to
parse JSON scan results; it can be used to process the results of SSLyze scans in a separate Python program.</p>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="json-output.html">Exporting and processing scan results in JSON</a><ul>
<li class="toctree-l2"><a class="reference internal" href="json-output.html#exporting-results-to-json-when-using-the-cli">Exporting results to JSON when using the CLI</a></li>
<li class="toctree-l2"><a class="reference internal" href="json-output.html#exporting-results-to-json-when-using-the-api">Exporting results to JSON when using the API</a></li>
<li class="toctree-l2"><a class="reference internal" href="json-output.html#parsing-the-json-output">Parsing the JSON output</a></li>
</ul>
</li>
</ul>
</div>
</section>
<section id="appendix-scan-commands">
<h2><a class="toc-backref" href="#id5" role="doc-backlink">Appendix: Scan Commands</a><a class="headerlink" href="#appendix-scan-commands" title="Link to this heading">¶</a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="available-scan-commands.html">Appendix: Scan Commands</a><ul>
<li class="toctree-l2"><a class="reference internal" href="available-scan-commands.html#sslyze.ScanCommand"><code class="docutils literal notranslate"><span class="pre">ScanCommand</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="available-scan-commands.html#certificate-information">Certificate Information</a></li>
<li class="toctree-l2"><a class="reference internal" href="available-scan-commands.html#cipher-suites">Cipher Suites</a></li>
<li class="toctree-l2"><a class="reference internal" href="available-scan-commands.html#supported-elliptic-curves">Supported Elliptic Curves</a></li>
<li class="toctree-l2"><a class="reference internal" href="available-scan-commands.html#robot">ROBOT</a></li>
<li class="toctree-l2"><a class="reference internal" href="available-scan-commands.html#session-resumption-support">Session Resumption Support</a></li>
<li class="toctree-l2"><a class="reference internal" href="available-scan-commands.html#crime">CRIME</a></li>
<li class="toctree-l2"><a class="reference internal" href="available-scan-commands.html#tls-1-3-early-data">TLS 1.3 Early Data</a></li>
<li class="toctree-l2"><a class="reference internal" href="available-scan-commands.html#downgrade-prevention">Downgrade Prevention</a></li>
<li class="toctree-l2"><a class="reference internal" href="available-scan-commands.html#heartbleed">Heartbleed</a></li>
<li class="toctree-l2"><a class="reference internal" href="available-scan-commands.html#http-security-headers">HTTP Security Headers</a></li>
<li class="toctree-l2"><a class="reference internal" href="available-scan-commands.html#openssl-ccs-injection">OpenSSL CCS Injection</a></li>
<li class="toctree-l2"><a class="reference internal" href="available-scan-commands.html#insecure-renegotiation">Insecure Renegotiation</a></li>
</ul>
</li>
</ul>
</div>
</section>
<section id="indices-and-tables">
<h2><a class="toc-backref" href="#id6" role="doc-backlink">Indices and tables</a><a class="headerlink" href="#indices-and-tables" title="Link to this heading">¶</a></h2>
<ul class="simple">
<li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li>
<li><p><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></p></li>
<li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li>
</ul>
</section>
</section>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="#">SSLyze</a></h1>
<h3>Navigation</h3>
<ul>
<li class="toctree-l1"><a class="reference internal" href="running-a-scan-in-python.html">Running a Scan in Python</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="json-output.html">Exporting and processing scan results in JSON</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="available-scan-commands.html">Appendix: Scan Commands</a></li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="#">Documentation overview</a><ul>
<li>Next: <a href="running-a-scan-in-python.html" title="next chapter">Running a Scan in Python</a></li>
</ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>document.getElementById('searchbox').style.display = "block"</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
©Copyright 2024 Alban Diquet.
|
Powered by <a href="http://sphinx-doc.org/">Sphinx 7.2.6</a>
& <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.13</a>
|
<a href="_sources/index.rst.txt"
rel="nofollow">Page source</a>
</div>
</body>
</html>