Add zip export

slither/__main__.py

@@ -19,7 +19,7 @@ from slither.detectors.abstract_detector import (AbstractDetector,
 from slither.printers import all_printers
 from slither.printers.abstract_printer import AbstractPrinter
 from slither.slither import Slither
-from slither.utils.output import output_to_json
+from slither.utils.output import output_to_json, output_to_zip, ZIP_TYPES_ACCEPTED
 from slither.utils.output_capture import StandardOutputCapture
 from slither.utils.colors import red, blue, set_colorization_enabled
 from slither.utils.command_line import (output_detectors, output_results_to_markdown,
@@ -32,6 +32,7 @@ from slither.exceptions import SlitherException
 logging.basicConfig()
 logger = logging.getLogger("Slither")
 
+
 ###################################################################################
 ###################################################################################
 # region Process functions
@@ -63,7 +64,8 @@ def process_all(target, args, detector_classes, printer_classes):
     results_printers = []
     analyzed_contracts_count = 0
     for compilation in compilations:
-        (slither, current_results_detectors, current_results_printers, current_analyzed_count) = process_single(compilation, args, detector_classes, printer_classes)
+        (slither, current_results_detectors, current_results_printers, current_analyzed_count) = process_single(
+            compilation, args, detector_classes, printer_classes)
         results_detectors.extend(current_results_detectors)
         results_printers.extend(current_results_printers)
         slither_instances.append(slither)
@@ -108,8 +110,6 @@ def process_from_asts(filenames, args, detector_classes, printer_classes):
     return process_single(all_contracts, args, detector_classes, printer_classes)
 
 
-
-
 # endregion
 ###################################################################################
 ###################################################################################
@@ -159,6 +159,7 @@ def get_detectors_and_printers():
 
     return detectors, printers
 
+
 def choose_detectors(args, all_detector_classes):
     # If detectors are specified, run only these ones
 
@@ -224,6 +225,7 @@ def choose_printers(args, all_printer_classes):
             raise Exception('Error: {} is not a printer'.format(p))
     return printers_to_run
 
+
 # endregion
 ###################################################################################
 ###################################################################################
@@ -238,7 +240,8 @@ def parse_filter_paths(args):
 
 
 def parse_args(detector_classes, printer_classes):
-    parser = argparse.ArgumentParser(description='Slither. For usage information, see https://github.com/crytic/slither/wiki/Usage',
+    parser = argparse.ArgumentParser(
+        description='Slither. For usage information, see https://github.com/crytic/slither/wiki/Usage',
         usage="slither.py contract.sol [flag]")
 
     parser.add_argument('filename',
@@ -331,6 +334,16 @@ def parse_args(detector_classes, printer_classes):
                             action='store',
                             default=defaults_flag_in_config['json-types'])
 
+    group_misc.add_argument('--zip',
+                            help='Export the results as a zipped JSON file',
+                            action='store',
+                            default=defaults_flag_in_config['zip'])
+
+    group_misc.add_argument('--zip-type',
+                            help=f'Zip compression type. One of {",".join(ZIP_TYPES_ACCEPTED)}. Default lzma',
+                            action='store',
+                            default=defaults_flag_in_config['zip_type'])
+
     group_misc.add_argument('--markdown-root',
                             help='URL for markdown generation',
                             action='store',
@@ -429,12 +442,14 @@ def parse_args(detector_classes, printer_classes):
 
     return args
 
+
 class ListDetectors(argparse.Action):
     def __call__(self, parser, *args, **kwargs):
         detectors, _ = get_detectors_and_printers()
         output_detectors(detectors)
         parser.exit()
 
+
 class ListDetectorsJson(argparse.Action):
     def __call__(self, parser, *args, **kwargs):
         detectors, _ = get_detectors_and_printers()
@@ -442,18 +457,21 @@ class ListDetectorsJson(argparse.Action):
         print(json.dumps(detector_types_json))
         parser.exit()
 
+
 class ListPrinters(argparse.Action):
     def __call__(self, parser, *args, **kwargs):
         _, printers = get_detectors_and_printers()
         output_printers(printers)
         parser.exit()
 
+
 class OutputMarkdown(argparse.Action):
     def __call__(self, parser, args, values, option_string=None):
         detectors, printers = get_detectors_and_printers()
         output_to_markdown(detectors, printers, values)
         parser.exit()
 
+
 class OutputWiki(argparse.Action):
     def __call__(self, parser, args, values, option_string=None):
         detectors, _ = get_detectors_and_printers()
@@ -480,6 +498,7 @@ class FormatterCryticCompile(logging.Formatter):
             record.args = (record.args[0], txt)
         return super().format(record)
 
+
 # endregion
 ###################################################################################
 ###################################################################################
@@ -511,6 +530,9 @@ def main_impl(all_detector_classes, all_printer_classes):
     output_error = None
     outputting_json = args.json is not None
     outputting_json_stdout = args.json == '-'
+    outputting_zip = args.zip is not None
+    if args.zip_type not in ZIP_TYPES_ACCEPTED:
+        logger.eror(f'Zip type not accepted, it must be one of {",".join(ZIP_TYPES_ACCEPTED)}')
 
     # If we are outputting JSON, capture all standard output. If we are outputting to stdout, we block typical stdout
     # output.
@@ -563,11 +585,15 @@ def main_impl(all_detector_classes, all_printer_classes):
 
             slither_instances = []
             if args.splitted:
-                (slither_instance, results_detectors, results_printers, number_contracts) = process_from_asts(filenames, args, detector_classes, printer_classes)
+                (slither_instance, results_detectors, results_printers, number_contracts) = process_from_asts(filenames,
+                                                                                                              args,
+                                                                                                              detector_classes,
+                                                                                                              printer_classes)
                 slither_instances.append(slither_instance)
             else:
                 for filename in filenames:
-                    (slither_instance, results_detectors_tmp, results_printers_tmp, number_contracts_tmp) = process_single(filename, args, detector_classes, printer_classes)
+                    (slither_instance, results_detectors_tmp, results_printers_tmp,
+                     number_contracts_tmp) = process_single(filename, args, detector_classes, printer_classes)
                     number_contracts += number_contracts_tmp
                     results_detectors += results_detectors_tmp
                     results_printers += results_printers_tmp
@@ -575,10 +601,12 @@ def main_impl(all_detector_classes, all_printer_classes):
 
         # Rely on CryticCompile to discern the underlying type of compilations.
         else:
-            (slither_instances, results_detectors, results_printers, number_contracts) = process_all(filename, args, detector_classes, printer_classes)
+            (slither_instances, results_detectors, results_printers, number_contracts) = process_all(filename, args,
+                                                                                                     detector_classes,
+                                                                                                     printer_classes)
 
         # Determine if we are outputting JSON
-        if outputting_json:
+        if outputting_json or outputting_zip:
             # Add our compilation information to JSON
             if 'compilations' in args.json_types:
                 compilation_results = []
@@ -642,6 +670,9 @@ def main_impl(all_detector_classes, all_printer_classes):
         StandardOutputCapture.disable()
         output_to_json(None if outputting_json_stdout else args.json, output_error, json_results)
 
+    if outputting_zip:
+        output_to_zip(args.zip, output_error, json_results, args.zip_type)
+
     # Exit with the appropriate status code
     if output_error:
         sys.exit(-1)
@@ -652,7 +683,4 @@ def main_impl(all_detector_classes, all_printer_classes):
 if __name__ == '__main__':
     main()
 
-
-
 # endregion
-

slither/utils/command_line.py

@@ -13,7 +13,6 @@ logger = logging.getLogger("Slither")
 DEFAULT_JSON_OUTPUT_TYPES = ["detectors", "printers"]
 JSON_OUTPUT_TYPES = ["compilations", "console", "detectors", "printers", "list-detectors", "list-printers"]
 
-
 # Those are the flags shared by the command line and the config file
 defaults_flag_in_config = {
     'detectors_to_run': 'all',
@@ -33,9 +32,12 @@ defaults_flag_in_config = {
     # debug command
     'legacy_ast': False,
     'ignore_return_value': False,
+    'zip': None,
+    'zip_type': 'lzma',
     **DEFAULTS_FLAG_IN_CONFIG_CRYTIC_COMPILE
 }
 
+
 def read_config_file(args):
     if os.path.isfile(args.config_file):
         try:
@@ -52,7 +54,6 @@ def read_config_file(args):
 
 
 def output_to_markdown(detector_classes, printer_classes, filter_wiki):
-
     def extract_help(cls):
         if cls.WIKI == '':
             return cls.HELP
@@ -97,6 +98,7 @@ def output_to_markdown(detector_classes, printer_classes, filter_wiki):
         print('{} | `{}` | {}'.format(idx, argument, help_info))
         idx = idx + 1
 
+
 def get_level(l):
     tab = l.count('\t') + 1
     if l.replace('\t', '').startswith(' -'):
@@ -105,6 +107,7 @@ def get_level(l):
         tab = tab + 1
     return tab
 
+
 def convert_result_to_markdown(txt):
     # -1 to remove the last \n
     lines = txt[0:-1].split('\n')
@@ -122,6 +125,7 @@ def convert_result_to_markdown(txt):
 
     return ''.join(ret)
 
+
 def output_results_to_markdown(all_results):
     checks = defaultdict(list)
     for results in all_results:
@@ -140,12 +144,13 @@ def output_results_to_markdown(all_results):
             result_markdown = convert_result_to_markdown(result)
             print(f'| <ul><li>[ ] TP</li><li>[ ] FP</li><li>[ ] Unknown</li></ul>  | {result_markdown}')
 
-def output_wiki(detector_classes, filter_wiki):
 
+def output_wiki(detector_classes, filter_wiki):
     detectors_list = []
 
     # Sort by impact, confidence, and name
-    detectors_list = sorted(detector_classes, key=lambda element: (element.IMPACT, element.CONFIDENCE, element.ARGUMENT))
+    detectors_list = sorted(detector_classes,
+                            key=lambda element: (element.IMPACT, element.CONFIDENCE, element.ARGUMENT))
 
     for detector in detectors_list:
         argument = detector.ARGUMENT
@@ -176,7 +181,6 @@ def output_wiki(detector_classes, filter_wiki):
         print(recommendation)
 
 
-
 def output_detectors(detector_classes):
     detectors_list = []
     for detector in detector_classes:
@@ -243,6 +247,7 @@ def output_detectors_json(detector_classes):
         idx = idx + 1
     return table
 
+
 def output_printers(printer_classes):
     printers_list = []
     for printer in printer_classes:
@@ -281,4 +286,3 @@ def output_printers_json(printer_classes):
                       'title': help_info})
         idx = idx + 1
     return table
-

slither/utils/output.py

@@ -2,7 +2,10 @@ import hashlib
 import os
 import json
 import logging
+import zipfile
 from collections import OrderedDict
+from typing import Optional, Dict
+from zipfile import ZipFile
 
 from slither.core.cfg.node import Node
 from slither.core.declarations import Contract, Function, Enum, Event, Structure, Pragma
@@ -52,6 +55,44 @@ def output_to_json(filename, error, results):
                 json.dump(json_result, f, indent=2)
 
 
+# https://docs.python.org/3/library/zipfile.html#zipfile-objects
+ZIP_TYPES_ACCEPTED = ['lzma', 'stored', 'deflated', 'bzip2']
+
+
+def output_to_zip(filename: str, error: Optional[str], results: Dict, zip_type: str = "lzma"):
+    """
+    Output the results to a zip
+    The file in the zip is named slither_results.json
+    Note: the json file will not have indentation, as a result the resulting json file will be smaller
+    :param zip_type:
+    :param filename:
+    :param error:
+    :param results:
+    :return:
+    """
+    json_result = {
+        "success": error is None,
+        "error": error,
+        "results": results
+    }
+    if os.path.isfile(filename):
+        logger.info(yellow(f'{filename} exists already, the overwrite is prevented'))
+    else:
+        if zip_type == "lzma":
+            with ZipFile(filename, "w", compression=zipfile.ZIP_LZMA) as file_desc:
+                file_desc.writestr("slither_results.json", json.dumps(json_result).encode('utf8'))
+        elif zip_type == 'stored':
+            with ZipFile(filename, "w", compression=zipfile.ZIP_STORED) as file_desc:
+                file_desc.writestr("slither_results.json", json.dumps(json_result).encode('utf8'))
+        elif zip_type == 'deflated':
+            with ZipFile(filename, "w", compression=zipfile.ZIP_DEFLATED) as file_desc:
+                file_desc.writestr("slither_results.json", json.dumps(json_result).encode('utf8'))
+        else:
+            assert zip_type == 'bzip2'
+            with ZipFile(filename, "w", compression=zipfile.ZIP_BZIP2) as file_desc:
+                file_desc.writestr("slither_results.json", json.dumps(json_result).encode('utf8'))
+
+
 # endregion
 ###################################################################################
 ###################################################################################
@@ -102,6 +143,7 @@ def _convert_to_markdown(d, markdown_root):
 
     raise SlitherError(f'{type(d)} cannot be converted (no name, or canonical_name')
 
+
 def _convert_to_id(d):
     '''
     Id keeps the source mapping of the node, otherwise we risk to consider two different node as the same
@@ -131,6 +173,7 @@ def _convert_to_id(d):
 
     raise SlitherError(f'{type(d)} cannot be converted (no name, or canonical_name')
 
+
 # endregion
 ###################################################################################
 ###################################################################################
@@ -202,7 +245,6 @@ class Output:
         if additional_fields:
             self._data['additional_fields'] = additional_fields
 
-
     def add(self, add, additional_fields=None):
         if isinstance(add, Variable):
             self.add_variable(add, additional_fields=additional_fields)