Skip to content

json-output.rst

Latest commit

 

History

History
36 lines (23 loc) · 1.52 KB

json-output.rst

File metadata and controls

36 lines (23 loc) · 1.52 KB
Raw

Exporting and processing scan results in JSON

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.

A schema of the JSON output is available in the code repository at ./json_output_schema.json.

Exporting results to JSON when using the CLI

When using the CLI, the scan results can be exported to a JSON file using the --json_out option:

$ python -m sslyze www.google.com www.facebook.com --json_out=result.json

The generated JSON file can then be parsed, as described in the "Parsing the JSON output" section.

Exporting results to JSON when using the API

When using the API, the scan results can be exported to a JSON file using the SslyzeOutputAsJson.from_orm() method:

.. literalinclude:: ../api_sample.py
    :pyobject: example_json_result_output

Parsing the JSON output

A JSON results file generated by SSLyze can then be parsed using the SslyzeOutputAsJson.from_file() method:

.. literalinclude:: ../api_sample.py
    :pyobject: example_json_result_parsing

The resulting Python object then contains the scan results. Type annotations are available for all fields, thereby making it easier to process the results.