Skip to content

Commit f4e7c54

Browse files
nabla-c0d3nabla-c0d3
committed
Re-generate documentation and JSON schema
1 parent ea3689c commit f4e7c54

12 files changed

+50
-101
lines changed

‎docs/documentation/.buildinfo

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: 7ed96ce74548bb7ceae0da1d5b1f50af
3+
config: f71b8d947628f4c16f8ec17ec85934ab
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎docs/documentation/_static/documentation_options.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
const DOCUMENTATION_OPTIONS = {
2-
VERSION: '5.2.0',
2+
VERSION: '6.0.0',
33
LANGUAGE: 'en',
44
COLLAPSE_INDEX: false,
55
BUILDER: 'html',

‎docs/documentation/available-scan-commands.html

Lines changed: 20 additions & 63 deletions
Large diffs are not rendered by default.

‎docs/documentation/genindex.html

Lines changed: 7 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@
44
<head>
55
<meta charset="utf-8" />
66
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
7-
<title>Index &#8212; SSLyze 5.2.0 documentation</title>
7+
<title>Index &#8212; SSLyze 6.0.0 documentation</title>
88
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
99
<link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=039e1c02" />
10-
<script src="_static/documentation_options.js?v=2dde5210"></script>
10+
<script src="_static/documentation_options.js?v=12958129"></script>
1111
<script src="_static/doctools.js?v=888ff710"></script>
1212
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
1313
<link rel="index" title="Index" href="#" />
@@ -132,8 +132,6 @@ <h2 id="E">E</h2>
132132
<li><a href="available-scan-commands.html#sslyze.ScanCommand.ELLIPTIC_CURVES">ELLIPTIC_CURVES (sslyze.ScanCommand attribute)</a>
133133
</li>
134134
<li><a href="available-scan-commands.html#sslyze.EllipticCurve">EllipticCurve (class in sslyze)</a>
135-
</li>
136-
<li><a href="available-scan-commands.html#sslyze.ExpectCtHeader.enforce">enforce (sslyze.ExpectCtHeader attribute)</a>
137135
</li>
138136
</ul></td>
139137
<td style="width: 33%; vertical-align: top;"><ul>
@@ -142,10 +140,6 @@ <h2 id="E">E</h2>
142140
<li><a href="running-a-scan-in-python.html#sslyze.ScanCommandAttempt.error_reason">error_reason (sslyze.ScanCommandAttempt attribute)</a>
143141
</li>
144142
<li><a href="running-a-scan-in-python.html#sslyze.ScanCommandAttempt.error_trace">error_trace (sslyze.ScanCommandAttempt attribute)</a>
145-
</li>
146-
<li><a href="available-scan-commands.html#sslyze.HttpHeadersScanResult.expect_ct_header">expect_ct_header (sslyze.HttpHeadersScanResult attribute)</a>
147-
</li>
148-
<li><a href="available-scan-commands.html#sslyze.ExpectCtHeader">ExpectCtHeader (class in sslyze)</a>
149143
</li>
150144
</ul></td>
151145
</tr></table>
@@ -240,8 +234,6 @@ <h2 id="L">L</h2>
240234
<li><a href="available-scan-commands.html#sslyze.CertificateDeploymentAnalysisResult.leaf_certificate_is_ev">leaf_certificate_is_ev (sslyze.CertificateDeploymentAnalysisResult attribute)</a>
241235
</li>
242236
<li><a href="available-scan-commands.html#sslyze.CertificateDeploymentAnalysisResult.leaf_certificate_signed_certificate_timestamps_count">leaf_certificate_signed_certificate_timestamps_count (sslyze.CertificateDeploymentAnalysisResult attribute)</a>
243-
</li>
244-
<li><a href="available-scan-commands.html#sslyze.CertificateDeploymentAnalysisResult.leaf_certificate_subject_matches_hostname">leaf_certificate_subject_matches_hostname (sslyze.CertificateDeploymentAnalysisResult attribute)</a>
245237
</li>
246238
</ul></td>
247239
</tr></table>
@@ -302,8 +294,6 @@ <h2 id="O">O</h2>
302294
</li>
303295
</ul></td>
304296
<td style="width: 33%; vertical-align: top;"><ul>
305-
<li><a href="available-scan-commands.html#sslyze.PathValidationResult.openssl_error_string">openssl_error_string (sslyze.PathValidationResult attribute)</a>
306-
</li>
307297
<li><a href="available-scan-commands.html#sslyze.EllipticCurve.openssl_nid">openssl_nid (sslyze.EllipticCurve attribute)</a>
308298
</li>
309299
<li><a href="available-scan-commands.html#sslyze.OpenSslCcsInjectionScanResult">OpenSslCcsInjectionScanResult (class in sslyze)</a>
@@ -531,18 +521,20 @@ <h2 id="U">U</h2>
531521
<h2 id="V">V</h2>
532522
<table style="width: 100%" class="indextable genindextable"><tr>
533523
<td style="width: 33%; vertical-align: top;"><ul>
524+
<li><a href="available-scan-commands.html#sslyze.PathValidationResult.validation_error">validation_error (sslyze.PathValidationResult attribute)</a>
525+
</li>
534526
<li><a href="available-scan-commands.html#sslyze.CertificateDeploymentAnalysisResult.verified_certificate_chain">verified_certificate_chain (sslyze.CertificateDeploymentAnalysisResult attribute)</a>
535527

536528
<ul>
537529
<li><a href="available-scan-commands.html#sslyze.PathValidationResult.verified_certificate_chain">(sslyze.PathValidationResult attribute)</a>
538530
</li>
539531
</ul></li>
540532
<li><a href="available-scan-commands.html#sslyze.CertificateDeploymentAnalysisResult.verified_chain_has_legacy_symantec_anchor">verified_chain_has_legacy_symantec_anchor (sslyze.CertificateDeploymentAnalysisResult attribute)</a>
541-
</li>
542-
<li><a href="available-scan-commands.html#sslyze.CertificateDeploymentAnalysisResult.verified_chain_has_sha1_signature">verified_chain_has_sha1_signature (sslyze.CertificateDeploymentAnalysisResult attribute)</a>
543533
</li>
544534
</ul></td>
545535
<td style="width: 33%; vertical-align: top;"><ul>
536+
<li><a href="available-scan-commands.html#sslyze.CertificateDeploymentAnalysisResult.verified_chain_has_sha1_signature">verified_chain_has_sha1_signature (sslyze.CertificateDeploymentAnalysisResult attribute)</a>
537+
</li>
546538
<li><a href="available-scan-commands.html#sslyze.TrustStore.verify_certificate_chain">verify_certificate_chain() (sslyze.TrustStore method)</a>
547539
</li>
548540
<li><a href="available-scan-commands.html#sslyze.TrustStore.version">version (sslyze.TrustStore attribute)</a>
@@ -638,7 +630,7 @@ <h3 id="searchlabel">Quick search</h3>
638630
<div class="clearer"></div>
639631
</div>
640632
<div class="footer">
641-
&copy;Copyright 2023 Alban Diquet.
633+
&copy;Copyright 2024 Alban Diquet.
642634

643635
|
644636
Powered by <a href="http://sphinx-doc.org/">Sphinx 7.2.6</a>

‎docs/documentation/index.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@
55
<meta charset="utf-8" />
66
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
77

8-
<title>SSLyze &#8212; SSLyze 5.2.0 documentation</title>
8+
<title>SSLyze &#8212; SSLyze 6.0.0 documentation</title>
99
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
1010
<link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=039e1c02" />
11-
<script src="_static/documentation_options.js?v=2dde5210"></script>
11+
<script src="_static/documentation_options.js?v=12958129"></script>
1212
<script src="_static/doctools.js?v=888ff710"></script>
1313
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
1414
<link rel="index" title="Index" href="genindex.html" />
@@ -32,7 +32,7 @@
3232

3333
<section id="sslyze">
3434
<h1><a class="toc-backref" href="#id1" role="doc-backlink">SSLyze</a><a class="headerlink" href="#sslyze" title="Link to this heading"></a></h1>
35-
<p>Release 5.2.0</p>
35+
<p>Release 6.0.0</p>
3636
<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>
3737
<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>
3838
<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>
@@ -182,7 +182,7 @@ <h3 id="searchlabel">Quick search</h3>
182182
<div class="clearer"></div>
183183
</div>
184184
<div class="footer">
185-
&copy;Copyright 2023 Alban Diquet.
185+
&copy;Copyright 2024 Alban Diquet.
186186

187187
|
188188
Powered by <a href="http://sphinx-doc.org/">Sphinx 7.2.6</a>

‎docs/documentation/json-output.html

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@
55
<meta charset="utf-8" />
66
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
77

8-
<title>Exporting and processing scan results in JSON &#8212; SSLyze 5.2.0 documentation</title>
8+
<title>Exporting and processing scan results in JSON &#8212; SSLyze 6.0.0 documentation</title>
99
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
1010
<link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=039e1c02" />
11-
<script src="_static/documentation_options.js?v=2dde5210"></script>
11+
<script src="_static/documentation_options.js?v=12958129"></script>
1212
<script src="_static/doctools.js?v=888ff710"></script>
1313
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
1414
<link rel="index" title="Index" href="genindex.html" />
@@ -55,12 +55,12 @@ <h2>Exporting results to JSON when using the API<a class="headerlink" href="#exp
5555
<span class="n">date_scans_completed</span><span class="p">:</span> <span class="n">datetime</span><span class="p">,</span>
5656
<span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
5757
<span class="n">json_output</span> <span class="o">=</span> <span class="n">SslyzeOutputAsJson</span><span class="p">(</span>
58-
<span class="n">server_scan_results</span><span class="o">=</span><span class="p">[</span><span class="n">ServerScanResultAsJson</span><span class="o">.</span><span class="n">from_orm</span><span class="p">(</span><span class="n">result</span><span class="p">)</span> <span class="k">for</span> <span class="n">result</span> <span class="ow">in</span> <span class="n">all_server_scan_results</span><span class="p">],</span>
58+
<span class="n">server_scan_results</span><span class="o">=</span><span class="p">[</span><span class="n">ServerScanResultAsJson</span><span class="o">.</span><span class="n">model_validate</span><span class="p">(</span><span class="n">result</span><span class="p">)</span> <span class="k">for</span> <span class="n">result</span> <span class="ow">in</span> <span class="n">all_server_scan_results</span><span class="p">],</span>
5959
<span class="n">invalid_server_strings</span><span class="o">=</span><span class="p">[],</span> <span class="c1"># Not needed here - specific to the CLI interface</span>
6060
<span class="n">date_scans_started</span><span class="o">=</span><span class="n">date_scans_started</span><span class="p">,</span>
6161
<span class="n">date_scans_completed</span><span class="o">=</span><span class="n">date_scans_completed</span><span class="p">,</span>
6262
<span class="p">)</span>
63-
<span class="n">json_output_as_str</span> <span class="o">=</span> <span class="n">json_output</span><span class="o">.</span><span class="n">json</span><span class="p">()</span> <span class="c1"># TODO(#617): Switch to model_dump_json()</span>
63+
<span class="n">json_output_as_str</span> <span class="o">=</span> <span class="n">json_output</span><span class="o">.</span><span class="n">model_dump_json</span><span class="p">()</span>
6464
<span class="n">json_file_out</span><span class="o">.</span><span class="n">write_text</span><span class="p">(</span><span class="n">json_output_as_str</span><span class="p">)</span>
6565
</pre></div>
6666
</div>
@@ -73,7 +73,7 @@ <h2>Parsing the JSON output<a class="headerlink" href="#parsing-the-json-output"
7373
<span class="n">results_as_json</span> <span class="o">=</span> <span class="n">results_as_json_file</span><span class="o">.</span><span class="n">read_text</span><span class="p">()</span>
7474

7575
<span class="c1"># These results can be parsed</span>
76-
<span class="n">parsed_results</span> <span class="o">=</span> <span class="n">SslyzeOutputAsJson</span><span class="o">.</span><span class="n">parse_raw</span><span class="p">(</span><span class="n">results_as_json</span><span class="p">)</span>
76+
<span class="n">parsed_results</span> <span class="o">=</span> <span class="n">SslyzeOutputAsJson</span><span class="o">.</span><span class="n">model_validate_json</span><span class="p">(</span><span class="n">results_as_json</span><span class="p">)</span>
7777

7878
<span class="c1"># Making it easy to do post-processing and inspection of the results</span>
7979
<span class="nb">print</span><span class="p">(</span><span class="s2">&quot;The following servers were scanned:&quot;</span><span class="p">)</span>
@@ -165,7 +165,7 @@ <h3 id="searchlabel">Quick search</h3>
165165
<div class="clearer"></div>
166166
</div>
167167
<div class="footer">
168-
&copy;Copyright 2023 Alban Diquet.
168+
&copy;Copyright 2024 Alban Diquet.
169169

170170
|
171171
Powered by <a href="http://sphinx-doc.org/">Sphinx 7.2.6</a>

‎docs/documentation/objects.inv

-56 Bytes
Binary file not shown.

‎docs/documentation/py-modindex.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@
44
<head>
55
<meta charset="utf-8" />
66
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
7-
<title>Python Module Index &#8212; SSLyze 5.2.0 documentation</title>
7+
<title>Python Module Index &#8212; SSLyze 6.0.0 documentation</title>
88
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
99
<link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=039e1c02" />
10-
<script src="_static/documentation_options.js?v=2dde5210"></script>
10+
<script src="_static/documentation_options.js?v=12958129"></script>
1111
<script src="_static/doctools.js?v=888ff710"></script>
1212
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
1313
<link rel="index" title="Index" href="genindex.html" />
@@ -110,7 +110,7 @@ <h3 id="searchlabel">Quick search</h3>
110110
<div class="clearer"></div>
111111
</div>
112112
<div class="footer">
113-
&copy;Copyright 2023 Alban Diquet.
113+
&copy;Copyright 2024 Alban Diquet.
114114

115115
|
116116
Powered by <a href="http://sphinx-doc.org/">Sphinx 7.2.6</a>

‎docs/documentation/running-a-scan-in-python.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@
55
<meta charset="utf-8" />
66
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
77

8-
<title>Running a Scan in Python &#8212; SSLyze 5.2.0 documentation</title>
8+
<title>Running a Scan in Python &#8212; SSLyze 6.0.0 documentation</title>
99
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
1010
<link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=039e1c02" />
11-
<script src="_static/documentation_options.js?v=2dde5210"></script>
11+
<script src="_static/documentation_options.js?v=12958129"></script>
1212
<script src="_static/doctools.js?v=888ff710"></script>
1313
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
1414
<link rel="index" title="Index" href="genindex.html" />
@@ -700,7 +700,7 @@ <h3 id="searchlabel">Quick search</h3>
700700
<div class="clearer"></div>
701701
</div>
702702
<div class="footer">
703-
&copy;Copyright 2023 Alban Diquet.
703+
&copy;Copyright 2024 Alban Diquet.
704704

705705
|
706706
Powered by <a href="http://sphinx-doc.org/">Sphinx 7.2.6</a>

‎docs/documentation/search.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@
44
<head>
55
<meta charset="utf-8" />
66
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
7-
<title>Search &#8212; SSLyze 5.2.0 documentation</title>
7+
<title>Search &#8212; SSLyze 6.0.0 documentation</title>
88
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=fa44fd50" />
99
<link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=039e1c02" />
1010

11-
<script src="_static/documentation_options.js?v=2dde5210"></script>
11+
<script src="_static/documentation_options.js?v=12958129"></script>
1212
<script src="_static/doctools.js?v=888ff710"></script>
1313
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
1414
<script src="_static/searchtools.js"></script>
@@ -111,7 +111,7 @@ <h3>Related Topics</h3>
111111
<div class="clearer"></div>
112112
</div>
113113
<div class="footer">
114-
&copy;Copyright 2023 Alban Diquet.
114+
&copy;Copyright 2024 Alban Diquet.
115115

116116
|
117117
Powered by <a href="http://sphinx-doc.org/">Sphinx 7.2.6</a>

‎docs/documentation/searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎json_output_schema.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2127,7 +2127,7 @@
21272127
"type": "string"
21282128
},
21292129
"sslyze_version": {
2130-
"default": "6.0.0b0",
2130+
"default": "6.0.0",
21312131
"title": "Sslyze Version",
21322132
"type": "string"
21332133
},

0 commit comments

Comments
 (0)