Skip to content

Commit

Permalink
Re-generate documentation and JSON schema
Browse files Browse the repository at this point in the history
  • Loading branch information
nabla-c0d3 committed Mar 30, 2024
1 parent ea3689c commit f4e7c54
Show file tree
Hide file tree
Showing 12 changed files with 50 additions and 101 deletions.
2 changes: 1 addition & 1 deletion docs/documentation/.buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 7ed96ce74548bb7ceae0da1d5b1f50af
config: f71b8d947628f4c16f8ec17ec85934ab
tags: 645f666f9bcd5a90fca523b33c5a78b7
2 changes: 1 addition & 1 deletion docs/documentation/_static/documentation_options.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
const DOCUMENTATION_OPTIONS = {
VERSION: '5.2.0',
VERSION: '6.0.0',
LANGUAGE: 'en',
COLLAPSE_INDEX: false,
BUILDER: 'html',
Expand Down
83 changes: 20 additions & 63 deletions docs/documentation/available-scan-commands.html

Large diffs are not rendered by default.

22 changes: 7 additions & 15 deletions docs/documentation/genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Index &#8212; SSLyze 5.2.0 documentation</title>
<title>Index &#8212; 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=2dde5210"></script>
<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="#" />
Expand Down Expand Up @@ -132,8 +132,6 @@ <h2 id="E">E</h2>
<li><a href="available-scan-commands.html#sslyze.ScanCommand.ELLIPTIC_CURVES">ELLIPTIC_CURVES (sslyze.ScanCommand attribute)</a>
</li>
<li><a href="available-scan-commands.html#sslyze.EllipticCurve">EllipticCurve (class in sslyze)</a>
</li>
<li><a href="available-scan-commands.html#sslyze.ExpectCtHeader.enforce">enforce (sslyze.ExpectCtHeader attribute)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
Expand All @@ -142,10 +140,6 @@ <h2 id="E">E</h2>
<li><a href="running-a-scan-in-python.html#sslyze.ScanCommandAttempt.error_reason">error_reason (sslyze.ScanCommandAttempt attribute)</a>
</li>
<li><a href="running-a-scan-in-python.html#sslyze.ScanCommandAttempt.error_trace">error_trace (sslyze.ScanCommandAttempt attribute)</a>
</li>
<li><a href="available-scan-commands.html#sslyze.HttpHeadersScanResult.expect_ct_header">expect_ct_header (sslyze.HttpHeadersScanResult attribute)</a>
</li>
<li><a href="available-scan-commands.html#sslyze.ExpectCtHeader">ExpectCtHeader (class in sslyze)</a>
</li>
</ul></td>
</tr></table>
Expand Down Expand Up @@ -240,8 +234,6 @@ <h2 id="L">L</h2>
<li><a href="available-scan-commands.html#sslyze.CertificateDeploymentAnalysisResult.leaf_certificate_is_ev">leaf_certificate_is_ev (sslyze.CertificateDeploymentAnalysisResult attribute)</a>
</li>
<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>
</li>
<li><a href="available-scan-commands.html#sslyze.CertificateDeploymentAnalysisResult.leaf_certificate_subject_matches_hostname">leaf_certificate_subject_matches_hostname (sslyze.CertificateDeploymentAnalysisResult attribute)</a>
</li>
</ul></td>
</tr></table>
Expand Down Expand Up @@ -302,8 +294,6 @@ <h2 id="O">O</h2>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="available-scan-commands.html#sslyze.PathValidationResult.openssl_error_string">openssl_error_string (sslyze.PathValidationResult attribute)</a>
</li>
<li><a href="available-scan-commands.html#sslyze.EllipticCurve.openssl_nid">openssl_nid (sslyze.EllipticCurve attribute)</a>
</li>
<li><a href="available-scan-commands.html#sslyze.OpenSslCcsInjectionScanResult">OpenSslCcsInjectionScanResult (class in sslyze)</a>
Expand Down Expand Up @@ -531,18 +521,20 @@ <h2 id="U">U</h2>
<h2 id="V">V</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="available-scan-commands.html#sslyze.PathValidationResult.validation_error">validation_error (sslyze.PathValidationResult attribute)</a>
</li>
<li><a href="available-scan-commands.html#sslyze.CertificateDeploymentAnalysisResult.verified_certificate_chain">verified_certificate_chain (sslyze.CertificateDeploymentAnalysisResult attribute)</a>

<ul>
<li><a href="available-scan-commands.html#sslyze.PathValidationResult.verified_certificate_chain">(sslyze.PathValidationResult attribute)</a>
</li>
</ul></li>
<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>
</li>
<li><a href="available-scan-commands.html#sslyze.CertificateDeploymentAnalysisResult.verified_chain_has_sha1_signature">verified_chain_has_sha1_signature (sslyze.CertificateDeploymentAnalysisResult attribute)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="available-scan-commands.html#sslyze.CertificateDeploymentAnalysisResult.verified_chain_has_sha1_signature">verified_chain_has_sha1_signature (sslyze.CertificateDeploymentAnalysisResult attribute)</a>
</li>
<li><a href="available-scan-commands.html#sslyze.TrustStore.verify_certificate_chain">verify_certificate_chain() (sslyze.TrustStore method)</a>
</li>
<li><a href="available-scan-commands.html#sslyze.TrustStore.version">version (sslyze.TrustStore attribute)</a>
Expand Down Expand Up @@ -638,7 +630,7 @@ <h3 id="searchlabel">Quick search</h3>
<div class="clearer"></div>
</div>
<div class="footer">
&copy;Copyright 2023 Alban Diquet.
&copy;Copyright 2024 Alban Diquet.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 7.2.6</a>
Expand Down
8 changes: 4 additions & 4 deletions docs/documentation/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@
<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 &#8212; SSLyze 5.2.0 documentation</title>
<title>SSLyze &#8212; 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=2dde5210"></script>
<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" />
Expand All @@ -32,7 +32,7 @@

<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 5.2.0</p>
<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>
Expand Down Expand Up @@ -182,7 +182,7 @@ <h3 id="searchlabel">Quick search</h3>
<div class="clearer"></div>
</div>
<div class="footer">
&copy;Copyright 2023 Alban Diquet.
&copy;Copyright 2024 Alban Diquet.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 7.2.6</a>
Expand Down
12 changes: 6 additions & 6 deletions docs/documentation/json-output.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@
<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>Exporting and processing scan results in JSON &#8212; SSLyze 5.2.0 documentation</title>
<title>Exporting and processing scan results in JSON &#8212; 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=2dde5210"></script>
<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" />
Expand Down Expand Up @@ -55,12 +55,12 @@ <h2>Exporting results to JSON when using the API<a class="headerlink" href="#exp
<span class="n">date_scans_completed</span><span class="p">:</span> <span class="n">datetime</span><span class="p">,</span>
<span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<span class="n">json_output</span> <span class="o">=</span> <span class="n">SslyzeOutputAsJson</span><span class="p">(</span>
<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>
<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>
<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>
<span class="n">date_scans_started</span><span class="o">=</span><span class="n">date_scans_started</span><span class="p">,</span>
<span class="n">date_scans_completed</span><span class="o">=</span><span class="n">date_scans_completed</span><span class="p">,</span>
<span class="p">)</span>
<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>
<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>
<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>
</pre></div>
</div>
Expand All @@ -73,7 +73,7 @@ <h2>Parsing the JSON output<a class="headerlink" href="#parsing-the-json-output"
<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>

<span class="c1"># These results can be parsed</span>
<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>
<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>

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

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 7.2.6</a>
Expand Down
Binary file modified docs/documentation/objects.inv
Binary file not shown.
6 changes: 3 additions & 3 deletions docs/documentation/py-modindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Python Module Index &#8212; SSLyze 5.2.0 documentation</title>
<title>Python Module Index &#8212; 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=2dde5210"></script>
<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" />
Expand Down Expand Up @@ -110,7 +110,7 @@ <h3 id="searchlabel">Quick search</h3>
<div class="clearer"></div>
</div>
<div class="footer">
&copy;Copyright 2023 Alban Diquet.
&copy;Copyright 2024 Alban Diquet.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 7.2.6</a>
Expand Down
6 changes: 3 additions & 3 deletions docs/documentation/running-a-scan-in-python.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@
<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>Running a Scan in Python &#8212; SSLyze 5.2.0 documentation</title>
<title>Running a Scan in Python &#8212; 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=2dde5210"></script>
<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" />
Expand Down Expand Up @@ -700,7 +700,7 @@ <h3 id="searchlabel">Quick search</h3>
<div class="clearer"></div>
</div>
<div class="footer">
&copy;Copyright 2023 Alban Diquet.
&copy;Copyright 2024 Alban Diquet.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 7.2.6</a>
Expand Down
6 changes: 3 additions & 3 deletions docs/documentation/search.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Search &#8212; SSLyze 5.2.0 documentation</title>
<title>Search &#8212; 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=2dde5210"></script>
<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>
<script src="_static/searchtools.js"></script>
Expand Down Expand Up @@ -111,7 +111,7 @@ <h3>Related Topics</h3>
<div class="clearer"></div>
</div>
<div class="footer">
&copy;Copyright 2023 Alban Diquet.
&copy;Copyright 2024 Alban Diquet.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 7.2.6</a>
Expand Down
2 changes: 1 addition & 1 deletion docs/documentation/searchindex.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion json_output_schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -2127,7 +2127,7 @@
"type": "string"
},
"sslyze_version": {
"default": "6.0.0b0",
"default": "6.0.0",
"title": "Sslyze Version",
"type": "string"
},
Expand Down

0 comments on commit f4e7c54

Please sign in to comment.