Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@nabla-c0d3
nabla-c0d3 committed Apr 16, 2017
1 parent 15ac27b commit 13a2ad8
Show file tree
Hide file tree
Showing 9 changed files with 34 additions and 125 deletions.
7 changes: 1 addition & 6 deletions docs/available-scan-commands.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,14 +41,9 @@ Additional helper classes

.. autoclass:: PathValidationResult()
.. autoclass:: PathValidationError()
.. automodule:: sslyze.plugins.utils.certificate
.. autoclass:: Certificate()
.. automodule:: sslyze.plugins.utils.trust_store.trust_store
.. autoclass:: TrustStore()
.. module:: nassl.x509_certificate
.. autoclass:: HostnameValidationResultEnum
:undoc-members:
:members:


OpenSslCipherSuitesPlugin
=========================
Expand Down
93 changes: 18 additions & 75 deletions docs/documentation/available-scan-commands.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -94,17 +94,13 @@ <h3>CertificateInfoScanCommand<a class="headerlink" href="#certificateinfoscanco
check for OCSP stapling support.</p>
<dl class="method">
<dt id="sslyze.plugins.certificate_info_plugin.CertificateInfoScanCommand.__init__">
<code class="descname">__init__</code><span class="sig-paren">(</span><em>ca_file=None</em>, <em>print_full_certificate=False</em><span class="sig-paren">)</span><a class="headerlink" href="#sslyze.plugins.certificate_info_plugin.CertificateInfoScanCommand.__init__" title="Permalink to this definition"></a></dt>
<code class="descname">__init__</code><span class="sig-paren">(</span><em>ca_file=None</em><span class="sig-paren">)</span><a class="headerlink" href="#sslyze.plugins.certificate_info_plugin.CertificateInfoScanCommand.__init__" title="Permalink to this definition"></a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
<li><strong>ca_file</strong> (<em>Text</em>) &#8211; The path to a custom trust store file to use for certificate validation. The file should
contain PEM-formatted root certificates.</li>
<li><strong>print_full_certificate</strong> (<em>bool</em>) &#8211; Deprecated - do not use.</li>
</ul>
</td>
<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>ca_file</strong> (<em>Text</em>) &#8211; The path to a custom trust store file to use for certificate validation. The file should
contain PEM-formatted root certificates.</td>
</tr>
</tbody>
</table>
Expand All @@ -119,8 +115,9 @@ <h3>CertificateInfoScanCommand<a class="headerlink" href="#certificateinfoscanco
<dl class="attribute">
<dt id="sslyze.plugins.certificate_info_plugin.CertificateInfoScanResult.certificate_chain">
<code class="descname">certificate_chain</code><a class="headerlink" href="#sslyze.plugins.certificate_info_plugin.CertificateInfoScanResult.certificate_chain" title="Permalink to this definition"></a></dt>
<dd><p><em>List[Certificate]</em> &#8211; The certificate chain sent by the server; index 0 is the leaf
certificate.</p>
<dd><p><em>List[cryptography.x509.Certificate]</em> &#8211; The certificate chain sent by the server; index 0 is
the leaf certificate. Each certificate is parsed using the cryptography module; documentation is available
at <a class="reference external" href="https://cryptography.io/en/latest/x509/reference/#x-509-certificate-object">https://cryptography.io/en/latest/x509/reference/#x-509-certificate-object</a>.</p>
</dd></dl>

<dl class="attribute">
Expand Down Expand Up @@ -151,16 +148,18 @@ <h3>CertificateInfoScanCommand<a class="headerlink" href="#certificateinfoscanco
<dl class="attribute">
<dt id="sslyze.plugins.certificate_info_plugin.CertificateInfoScanResult.verified_certificate_chain">
<code class="descname">verified_certificate_chain</code><a class="headerlink" href="#sslyze.plugins.certificate_info_plugin.CertificateInfoScanResult.verified_certificate_chain" title="Permalink to this definition"></a></dt>
<dd><p><em>List[Certificate]</em> &#8211; The verified certificate chain built using the
<dd><p><em>List[cryptography.x509.Certificate]</em> &#8211; The verified certificate chain built using the
successful_trust_store; index 0 is the leaf certificate and the last element is the anchor/CA certificate
from the trust store. Will be empty if the validation failed with all available trust store, or the
verified chain could not be built.</p>
verified chain could not be built. Each certificate is parsed using the cryptography module; documentation
is available at <a class="reference external" href="https://cryptography.io/en/latest/x509/reference/#x-509-certificate-object">https://cryptography.io/en/latest/x509/reference/#x-509-certificate-object</a>.</p>
</dd></dl>

<dl class="attribute">
<dt id="sslyze.plugins.certificate_info_plugin.CertificateInfoScanResult.hostname_validation_result">
<code class="descname">hostname_validation_result</code><a class="headerlink" href="#sslyze.plugins.certificate_info_plugin.CertificateInfoScanResult.hostname_validation_result" title="Permalink to this definition"></a></dt>
<dd><p><em>HostnameValidationResultEnum</em> &#8211; Validation result of the certificate hostname.</p>
<dt id="sslyze.plugins.certificate_info_plugin.CertificateInfoScanResult.certificate_matches_hostname">
<code class="descname">certificate_matches_hostname</code><a class="headerlink" href="#sslyze.plugins.certificate_info_plugin.CertificateInfoScanResult.certificate_matches_hostname" title="Permalink to this definition"></a></dt>
<dd><p><em>bool</em> &#8211; True if hostname validation was successful ie. the leaf certificate was
issued for the server&#8217;s hostname.</p>
</dd></dl>

<dl class="attribute">
Expand All @@ -172,8 +171,8 @@ <h3>CertificateInfoScanCommand<a class="headerlink" href="#certificateinfoscanco
<dl class="attribute">
<dt id="sslyze.plugins.certificate_info_plugin.CertificateInfoScanResult.ocsp_response">
<code class="descname">ocsp_response</code><a class="headerlink" href="#sslyze.plugins.certificate_info_plugin.CertificateInfoScanResult.ocsp_response" title="Permalink to this definition"></a></dt>
<dd><p><em>Optional[Dict]</em> &#8211; The OCSP response returned by the server. None if no response was sent by the
server.</p>
<dd><p><em>Optional[Dict[Text, Any]]</em> &#8211; The OCSP response returned by the server. None if no response was
sent by the server.</p>
</dd></dl>

<dl class="attribute">
Expand Down Expand Up @@ -245,43 +244,6 @@ <h3>Additional helper classes<a class="headerlink" href="#additional-helper-clas

</dd></dl>

<span class="target" id="module-sslyze.plugins.utils.certificate"></span><dl class="class">
<dt id="sslyze.plugins.utils.certificate.Certificate">
<em class="property">class </em><code class="descclassname">sslyze.plugins.utils.certificate.</code><code class="descname">Certificate</code><a class="headerlink" href="#sslyze.plugins.utils.certificate.Certificate" title="Permalink to this definition"></a></dt>
<dd><p>An X509 certificate.</p>
<dl class="attribute">
<dt id="sslyze.plugins.utils.certificate.Certificate.as_pem">
<code class="descname">as_pem</code><a class="headerlink" href="#sslyze.plugins.utils.certificate.Certificate.as_pem" title="Permalink to this definition"></a></dt>
<dd><p><em>Text</em> &#8211; The certificate in PEM format.</p>
</dd></dl>

<dl class="attribute">
<dt id="sslyze.plugins.utils.certificate.Certificate.as_text">
<code class="descname">as_text</code><a class="headerlink" href="#sslyze.plugins.utils.certificate.Certificate.as_text" title="Permalink to this definition"></a></dt>
<dd><p><em>Text</em> &#8211; The certificate in human-readable format.</p>
</dd></dl>

<dl class="attribute">
<dt id="sslyze.plugins.utils.certificate.Certificate.as_dict">
<code class="descname">as_dict</code><a class="headerlink" href="#sslyze.plugins.utils.certificate.Certificate.as_dict" title="Permalink to this definition"></a></dt>
<dd><p><em>Dict</em> &#8211; The certificate as a dictionary.</p>
</dd></dl>

<dl class="attribute">
<dt id="sslyze.plugins.utils.certificate.Certificate.sha1_fingerprint">
<code class="descname">sha1_fingerprint</code><a class="headerlink" href="#sslyze.plugins.utils.certificate.Certificate.sha1_fingerprint" title="Permalink to this definition"></a></dt>
<dd><p><em>Text</em> &#8211; The SHA1 fingerprint of the certificate.</p>
</dd></dl>

<dl class="attribute">
<dt id="sslyze.plugins.utils.certificate.Certificate.hpkp_pin">
<code class="descname">hpkp_pin</code><a class="headerlink" href="#sslyze.plugins.utils.certificate.Certificate.hpkp_pin" title="Permalink to this definition"></a></dt>
<dd><p><em>Text</em> &#8211; The HPKP pin (ie. base64-encoded SHA256 of the SPKI, as described in RFC 7469) of the
certificate.</p>
</dd></dl>

</dd></dl>

<span class="target" id="module-sslyze.plugins.utils.trust_store.trust_store"></span><dl class="class">
<dt id="sslyze.plugins.utils.trust_store.trust_store.TrustStore">
<em class="property">class </em><code class="descclassname">sslyze.plugins.utils.trust_store.trust_store.</code><code class="descname">TrustStore</code><a class="headerlink" href="#sslyze.plugins.utils.trust_store.trust_store.TrustStore" title="Permalink to this definition"></a></dt>
Expand All @@ -307,27 +269,6 @@ <h3>Additional helper classes<a class="headerlink" href="#additional-helper-clas

</dd></dl>

<span class="target" id="module-nassl.x509_certificate"></span><dl class="class">
<dt id="nassl.x509_certificate.HostnameValidationResultEnum">
<em class="property">class </em><code class="descclassname">nassl.x509_certificate.</code><code class="descname">HostnameValidationResultEnum</code><a class="headerlink" href="#nassl.x509_certificate.HostnameValidationResultEnum" title="Permalink to this definition"></a></dt>
<dd><p>Hostname validation result constants.</p>
<dl class="attribute">
<dt id="nassl.x509_certificate.HostnameValidationResultEnum.NAME_DOES_NOT_MATCH">
<code class="descname">NAME_DOES_NOT_MATCH</code><em class="property"> = 0</em><a class="headerlink" href="#nassl.x509_certificate.HostnameValidationResultEnum.NAME_DOES_NOT_MATCH" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

<dl class="attribute">
<dt id="nassl.x509_certificate.HostnameValidationResultEnum.NAME_MATCHES_SAN">
<code class="descname">NAME_MATCHES_SAN</code><em class="property"> = 1</em><a class="headerlink" href="#nassl.x509_certificate.HostnameValidationResultEnum.NAME_MATCHES_SAN" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

<dl class="attribute">
<dt id="nassl.x509_certificate.HostnameValidationResultEnum.NAME_MATCHES_CN">
<code class="descname">NAME_MATCHES_CN</code><em class="property"> = 2</em><a class="headerlink" href="#nassl.x509_certificate.HostnameValidationResultEnum.NAME_MATCHES_CN" title="Permalink to this definition"></a></dt>
<dd></dd></dl>

</dd></dl>

</div>
</div>
<div class="section" id="module-sslyze.plugins.openssl_cipher_suites_plugin">
Expand Down Expand Up @@ -660,7 +601,9 @@ <h3>HttpHeadersScanCommand<a class="headerlink" href="#httpheadersscancommand" t
<dd><p><em>List[Certificate]</em> &#8211; The verified certificate chain; index 0 is the leaf
certificate and the last element is the anchor/CA certificate from the Mozilla trust store. Will be empty if
validation failed or the verified chain could not be built. The HPKP pin for each certificate is available
in the certificate&#8217;s hpkp_pin attribute. None if the verified chain could not be built.</p>
in the certificate&#8217;s hpkp_pin attribute. None if the verified chain could not be built. Each certificate is
parsed using the cryptography module; documentation is available at
<a class="reference external" href="https://cryptography.io/en/latest/x509/reference/#x-509-certificate-object">https://cryptography.io/en/latest/x509/reference/#x-509-certificate-object</a>.</p>
</dd></dl>

</dd></dl>
Expand Down
28 changes: 2 additions & 26 deletions docs/documentation/genindex.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -102,15 +102,9 @@ <h2 id="A">A</h2>
<li><a href="available-scan-commands.html#sslyze.plugins.openssl_cipher_suites_plugin.AcceptedCipherSuite">AcceptedCipherSuite (class in sslyze.plugins.openssl_cipher_suites_plugin)</a>
</li>
<li><a href="available-scan-commands.html#sslyze.plugins.session_renegotiation_plugin.SessionRenegotiationScanResult.accepts_client_renegotiation">accepts_client_renegotiation (sslyze.plugins.session_renegotiation_plugin.SessionRenegotiationScanResult attribute)</a>
</li>
<li><a href="available-scan-commands.html#sslyze.plugins.utils.certificate.Certificate.as_dict">as_dict (sslyze.plugins.utils.certificate.Certificate attribute)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="available-scan-commands.html#sslyze.plugins.utils.certificate.Certificate.as_pem">as_pem (sslyze.plugins.utils.certificate.Certificate attribute)</a>
</li>
<li><a href="available-scan-commands.html#sslyze.plugins.utils.certificate.Certificate.as_text">as_text (sslyze.plugins.utils.certificate.Certificate attribute)</a>
</li>
<li><a href="testing-connectivity.html#nassl.ssl_client.OpenSslFileTypeEnum.ASN1">ASN1 (nassl.ssl_client.OpenSslFileTypeEnum attribute)</a>
</li>
<li><a href="available-scan-commands.html#sslyze.plugins.session_resumption_plugin.SessionResumptionRateScanResult.attempted_resumptions_nb">attempted_resumptions_nb (sslyze.plugins.session_resumption_plugin.SessionResumptionRateScanResult attribute)</a>
Expand All @@ -125,9 +119,9 @@ <h2 id="A">A</h2>
<h2 id="C">C</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.plugins.utils.certificate.Certificate">Certificate (class in sslyze.plugins.utils.certificate)</a>
</li>
<li><a href="available-scan-commands.html#sslyze.plugins.certificate_info_plugin.CertificateInfoScanResult.certificate_chain">certificate_chain (sslyze.plugins.certificate_info_plugin.CertificateInfoScanResult attribute)</a>
</li>
<li><a href="available-scan-commands.html#sslyze.plugins.certificate_info_plugin.CertificateInfoScanResult.certificate_matches_hostname">certificate_matches_hostname (sslyze.plugins.certificate_info_plugin.CertificateInfoScanResult attribute)</a>
</li>
<li><a href="available-scan-commands.html#sslyze.plugins.certificate_info_plugin.CertificateInfoScanCommand">CertificateInfoScanCommand (class in sslyze.plugins.certificate_info_plugin)</a>
</li>
Expand Down Expand Up @@ -226,16 +220,10 @@ <h2 id="H">H</h2>
<li><a href="available-scan-commands.html#sslyze.plugins.heartbleed_plugin.HeartbleedScanCommand">HeartbleedScanCommand (class in sslyze.plugins.heartbleed_plugin)</a>
</li>
<li><a href="available-scan-commands.html#sslyze.plugins.heartbleed_plugin.HeartbleedScanResult">HeartbleedScanResult (class in sslyze.plugins.heartbleed_plugin)</a>
</li>
<li><a href="available-scan-commands.html#sslyze.plugins.certificate_info_plugin.CertificateInfoScanResult.hostname_validation_result">hostname_validation_result (sslyze.plugins.certificate_info_plugin.CertificateInfoScanResult attribute)</a>
</li>
<li><a href="available-scan-commands.html#nassl.x509_certificate.HostnameValidationResultEnum">HostnameValidationResultEnum (class in nassl.x509_certificate)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="available-scan-commands.html#sslyze.plugins.http_headers_plugin.HttpHeadersScanResult.hpkp_header">hpkp_header (sslyze.plugins.http_headers_plugin.HttpHeadersScanResult attribute)</a>
</li>
<li><a href="available-scan-commands.html#sslyze.plugins.utils.certificate.Certificate.hpkp_pin">hpkp_pin (sslyze.plugins.utils.certificate.Certificate attribute)</a>
</li>
<li><a href="available-scan-commands.html#sslyze.plugins.http_headers_plugin.HttpHeadersScanResult.hsts_header">hsts_header (sslyze.plugins.http_headers_plugin.HttpHeadersScanResult attribute)</a>
</li>
Expand Down Expand Up @@ -325,15 +313,7 @@ <h2 id="N">N</h2>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="available-scan-commands.html#nassl.x509_certificate.HostnameValidationResultEnum.NAME_DOES_NOT_MATCH">NAME_DOES_NOT_MATCH (nassl.x509_certificate.HostnameValidationResultEnum attribute)</a>
</li>
<li><a href="available-scan-commands.html#nassl.x509_certificate.HostnameValidationResultEnum.NAME_MATCHES_CN">NAME_MATCHES_CN (nassl.x509_certificate.HostnameValidationResultEnum attribute)</a>
</li>
<li><a href="available-scan-commands.html#nassl.x509_certificate.HostnameValidationResultEnum.NAME_MATCHES_SAN">NAME_MATCHES_SAN (nassl.x509_certificate.HostnameValidationResultEnum attribute)</a>
</li>
<li><a href="testing-connectivity.html#module-nassl.ssl_client">nassl.ssl_client (module)</a>
</li>
<li><a href="available-scan-commands.html#module-nassl.x509_certificate">nassl.x509_certificate (module)</a>
</li>
</ul></td>
</tr></table>
Expand Down Expand Up @@ -452,8 +432,6 @@ <h2 id="S">S</h2>
<li><a href="available-scan-commands.html#sslyze.plugins.session_resumption_plugin.SessionResumptionSupportScanCommand">SessionResumptionSupportScanCommand (class in sslyze.plugins.session_resumption_plugin)</a>
</li>
<li><a href="available-scan-commands.html#sslyze.plugins.session_resumption_plugin.SessionResumptionSupportScanResult">SessionResumptionSupportScanResult (class in sslyze.plugins.session_resumption_plugin)</a>
</li>
<li><a href="available-scan-commands.html#sslyze.plugins.utils.certificate.Certificate.sha1_fingerprint">sha1_fingerprint (sslyze.plugins.utils.certificate.Certificate attribute)</a>
</li>
<li><a href="available-scan-commands.html#sslyze.plugins.openssl_cipher_suites_plugin.AcceptedCipherSuite.ssl_version">ssl_version (sslyze.plugins.openssl_cipher_suites_plugin.AcceptedCipherSuite attribute)</a>

Expand Down Expand Up @@ -490,8 +468,6 @@ <h2 id="S">S</h2>
<li><a href="available-scan-commands.html#module-sslyze.plugins.session_renegotiation_plugin">sslyze.plugins.session_renegotiation_plugin (module)</a>
</li>
<li><a href="available-scan-commands.html#module-sslyze.plugins.session_resumption_plugin">sslyze.plugins.session_resumption_plugin (module)</a>
</li>
<li><a href="available-scan-commands.html#module-sslyze.plugins.utils.certificate">sslyze.plugins.utils.certificate (module)</a>
</li>
<li><a href="available-scan-commands.html#module-sslyze.plugins.utils.trust_store.trust_store">sslyze.plugins.utils.trust_store.trust_store (module)</a>
</li>
Expand Down
Binary file modified docs/documentation/objects.inv
View file
Binary file not shown.
12 changes: 1 addition & 11 deletions docs/documentation/py-modindex.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -72,11 +72,6 @@ <h1>Python Module Index</h1>
<td>&#160;&#160;&#160;
<a href="testing-connectivity.html#module-nassl.ssl_client"><code class="xref">nassl.ssl_client</code></a></td><td>
<em></em></td></tr>
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
<a href="available-scan-commands.html#module-nassl.x509_certificate"><code class="xref">nassl.x509_certificate</code></a></td><td>
<em></em></td></tr>
<tr class="pcap"><td></td><td>&#160;</td><td></td></tr>
<tr class="cap" id="cap-s"><td></td><td>
<strong>s</strong></td><td></td></tr>
Expand Down Expand Up @@ -129,7 +124,7 @@ <h1>Python Module Index</h1>
<tr class="cg-2">
<td></td>
<td>&#160;&#160;&#160;
<a href="writing-a-plugin.html#module-sslyze.plugins.plugin_base"><code class="xref">sslyze.plugins.plugin_base</code></a></td><td>
<a href="available-scan-commands.html#module-sslyze.plugins.plugin_base"><code class="xref">sslyze.plugins.plugin_base</code></a></td><td>
<em></em></td></tr>
<tr class="cg-2">
<td></td>
Expand All @@ -141,11 +136,6 @@ <h1>Python Module Index</h1>
<td>&#160;&#160;&#160;
<a href="available-scan-commands.html#module-sslyze.plugins.session_resumption_plugin"><code class="xref">sslyze.plugins.session_resumption_plugin</code></a></td><td>
<em></em></td></tr>
<tr class="cg-2">
<td></td>
<td>&#160;&#160;&#160;
<a href="available-scan-commands.html#module-sslyze.plugins.utils.certificate"><code class="xref">sslyze.plugins.utils.certificate</code></a></td><td>
<em></em></td></tr>
<tr class="cg-2">
<td></td>
<td>&#160;&#160;&#160;
Expand Down
2 changes: 1 addition & 1 deletion docs/documentation/searchindex.js
View file

Large diffs are not rendered by default.

Loading

0 comments on commit 13a2ad8

Please sign in to comment.