From f4e7c54109084e1dc965ae8fe641e93af110b4b6 Mon Sep 17 00:00:00 2001 From: Alban Diquet Date: Sat, 30 Mar 2024 16:12:03 +0100 Subject: [PATCH] Re-generate documentation and JSON schema --- docs/documentation/.buildinfo | 2 +- .../_static/documentation_options.js | 2 +- .../available-scan-commands.html | 83 +++++------------- docs/documentation/genindex.html | 22 ++--- docs/documentation/index.html | 8 +- docs/documentation/json-output.html | 12 +-- docs/documentation/objects.inv | Bin 2857 -> 2801 bytes docs/documentation/py-modindex.html | 6 +- .../running-a-scan-in-python.html | 6 +- docs/documentation/search.html | 6 +- docs/documentation/searchindex.js | 2 +- json_output_schema.json | 2 +- 12 files changed, 50 insertions(+), 101 deletions(-) diff --git a/docs/documentation/.buildinfo b/docs/documentation/.buildinfo index 8cc545c5..50304dbd 100644 --- a/docs/documentation/.buildinfo +++ b/docs/documentation/.buildinfo @@ -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 diff --git a/docs/documentation/_static/documentation_options.js b/docs/documentation/_static/documentation_options.js index f9bbedc6..7cebf3b0 100644 --- a/docs/documentation/_static/documentation_options.js +++ b/docs/documentation/_static/documentation_options.js @@ -1,5 +1,5 @@ const DOCUMENTATION_OPTIONS = { - VERSION: '5.2.0', + VERSION: '6.0.0', LANGUAGE: 'en', COLLAPSE_INDEX: false, BUILDER: 'html', diff --git a/docs/documentation/available-scan-commands.html b/docs/documentation/available-scan-commands.html index dae3d56c..14baa54b 100644 --- a/docs/documentation/available-scan-commands.html +++ b/docs/documentation/available-scan-commands.html @@ -5,10 +5,10 @@ - Appendix: Scan Commands — SSLyze 5.2.0 documentation + Appendix: Scan Commands — SSLyze 6.0.0 documentation - + @@ -205,7 +205,7 @@

Result class
-class sslyze.CertificateDeploymentAnalysisResult(received_certificate_chain, leaf_certificate_subject_matches_hostname, leaf_certificate_has_must_staple_extension, leaf_certificate_is_ev, leaf_certificate_signed_certificate_timestamps_count, received_chain_contains_anchor_certificate, received_chain_has_valid_order, path_validation_results, verified_chain_has_sha1_signature, verified_chain_has_legacy_symantec_anchor, ocsp_response, ocsp_response_is_trusted)
+class sslyze.CertificateDeploymentAnalysisResult(received_certificate_chain, leaf_certificate_has_must_staple_extension, leaf_certificate_is_ev, leaf_certificate_signed_certificate_timestamps_count, received_chain_contains_anchor_certificate, received_chain_has_valid_order, path_validation_results, verified_chain_has_sha1_signature, verified_chain_has_legacy_symantec_anchor, ocsp_response, ocsp_response_is_trusted)

The result of analyzing a server’s certificate to verify its validity.

Any certificate available within the fields that follow is parsed as a Certificate object using the cryptography module; documentation is available at @@ -230,15 +230,10 @@

Result classpath_validation_results

The result of validating the server’s certificate chain using each trust store that is packaged with SSLyze (Mozilla, Apple, etc.). -If for a given trust store, the validation was successful, the verified certificate chain built by OpenSSL -can be retrieved from the PathValidationResult.

-
- -
-
-leaf_certificate_subject_matches_hostname
-

True if the leaf certificate’s Common Name or Subject Alternative -Names match the server’s hostname.

+If for a given trust store, the validation was successful, the verified certificate chain can be

+
+

retrieved from the PathValidationResult.

+
@@ -313,7 +308,6 @@

Result classParameters:

@@ -421,10 +415,14 @@

Result class
-verify_certificate_chain(certificate_chain_as_pem)
+verify_certificate_chain(certificate_chain_as_pem, server_hostname, validation_time=None)
Parameters:
-

certificate_chain_as_pem (List[str]) –

+
    +
  • certificate_chain_as_pem (List[str]) –

  • +
  • server_hostname (str) –

  • +
  • validation_time (Optional[datetime]) –

  • +
Return type:

PathValidationResult

@@ -943,7 +941,7 @@

HTTP Security Header

Result class

-class sslyze.HttpHeadersScanResult(http_request_sent, http_error_trace, http_path_redirected_to, strict_transport_security_header, expect_ct_header=None)
+class sslyze.HttpHeadersScanResult(http_request_sent, http_error_trace, http_path_redirected_to, strict_transport_security_header)

The result of testing a server for the presence of security-related HTTP headers.

Each HTTP header described below will be None if the server did not return a valid HTTP response, or if the server returned an HTTP response without the HTTP header.

@@ -972,13 +970,6 @@

Result class

The Strict-Transport-Security header returned by the server.

-
-
-expect_ct_header
-

DEPRECATED - will always be None. This is because the Expect-CT header has officially -been deprecated.

-
-
Parameters:
@@ -1025,39 +1015,6 @@

Result class

-
-
-class sslyze.ExpectCtHeader(max_age, report_uri, enforce)
-

An Expect-CT header parsed from a server’s HTTP response.

-
-
-max-age
-

The content of the max-age field.

-
- -
-
-report-uri
-

The content of report-uri field.

-
- -
-
-enforce
-

True if enforce directive is set.

-
- -
-
Parameters:
-
    -
  • max_age (Optional[int]) –

  • -
  • report_uri (Optional[str]) –

  • -
  • enforce (bool) –

  • -
-
-
-
-
@@ -1192,7 +1149,7 @@

Quick search