Update JSON reporting schema

[mehrinkiani]

This PR updates JSON reporting schema as outlined in #100. The field timestamp: datetime.datetime.now() has isoformat, i.e. timestamp: datetime.datetime.now().isoformat to make it JSON serializable.

Closes #100

[willarmiros]

LGTM, and no problem on the ISO Format! @mehrinkiani can you possibly post a sample output with the new format (showing 1 or 2 vulns) for our reference?

[mehrinkiani]

Thank you for the review @willarmiros. Here is a JSON report generated by scanning Tensorflow safe and unsafe models from notebooks/tensorflow_fashion_mnist.ipynb

{
    "summary": {
        "total_issues_by_severity": {
            "LOW": 0,
            "MEDIUM": 0,
            "HIGH": 2,
            "CRITICAL": 0
        },
        "total_issues": 2,
        "input_path": "/Users/mehrinkiani/Documents/modelscan/notebooks/TensorFlowModels",
        "modelscan_version": "0.0.0",
        "timestamp": "2024-02-09T11:19:02.261556",
        "scanned": {
            "total_scanned": 6,
            "scanned_files": [
                "/Users/mehrinkiani/Documents/modelscan/notebooks/TensorFlowModels/unsafe_model/fingerprint.pb",
                "/Users/mehrinkiani/Documents/modelscan/notebooks/TensorFlowModels/unsafe_model/keras_metadata.pb",
                "/Users/mehrinkiani/Documents/modelscan/notebooks/TensorFlowModels/unsafe_model/saved_model.pb",
                "/Users/mehrinkiani/Documents/modelscan/notebooks/TensorFlowModels/safe_model/fingerprint.pb",
                "/Users/mehrinkiani/Documents/modelscan/notebooks/TensorFlowModels/safe_model/keras_metadata.pb",
                "/Users/mehrinkiani/Documents/modelscan/notebooks/TensorFlowModels/safe_model/saved_model.pb"
            ]
        }
    },
    "issues": [
        {
            "description": "Use of unsafe operator 'ReadFile' from module 'Tensorflow'",
            "operator": "ReadFile",
            "module": "Tensorflow",
            "source": "/Users/mehrinkiani/Documents/modelscan/notebooks/TensorFlowModels/unsafe_model/saved_model.pb",
            "scanner": "modelscan.scanners.SavedModelTensorflowOpScan",
            "severity": "HIGH"
        },
        {
            "description": "Use of unsafe operator 'WriteFile' from module 'Tensorflow'",
            "operator": "WriteFile",
            "module": "Tensorflow",
            "source": "/Users/mehrinkiani/Documents/modelscan/notebooks/TensorFlowModels/unsafe_model/saved_model.pb",
            "scanner": "modelscan.scanners.SavedModelTensorflowOpScan",
            "severity": "HIGH"
        }
    ],
    "errors": []
}

[willarmiros]

@mehrinkiani thank you for this, it will be super helpful for us! I noticed there is no skipped field in the summar, is that expected when no files are skipped?

[mehrinkiani]

@willarmiros thank you for the feedback. To view skipped files scan command needs a --show-skipped argument. I generated the previous report without --show-skipped. Below is the report with --show-skipped

{
    "summary": {
        "total_issues_by_severity": {
            "LOW": 0,
            "MEDIUM": 0,
            "HIGH": 2,
            "CRITICAL": 0
        },
        "total_issues": 2,
        "input_path": "/Users/mehrinkiani/Documents/modelscan/notebooks/TensorFlowModels",
        "modelscan_version": "0.0.0",
        "timestamp": "2024-02-09T11:31:10.138955",
        "skipped": {
            "total_skipped": 4,
            "skipped_files": [
                "/Users/mehrinkiani/Documents/modelscan/notebooks/TensorFlowModels/unsafe_model/variables/variables.data-00000-of-00001",
                "/Users/mehrinkiani/Documents/modelscan/notebooks/TensorFlowModels/unsafe_model/variables/variables.index",
                "/Users/mehrinkiani/Documents/modelscan/notebooks/TensorFlowModels/safe_model/variables/variables.data-00000-of-00001",
                "/Users/mehrinkiani/Documents/modelscan/notebooks/TensorFlowModels/safe_model/variables/variables.index"
            ]
        },
        "scanned": {
            "total_scanned": 6,
            "scanned_files": [
                "/Users/mehrinkiani/Documents/modelscan/notebooks/TensorFlowModels/unsafe_model/fingerprint.pb",
                "/Users/mehrinkiani/Documents/modelscan/notebooks/TensorFlowModels/unsafe_model/keras_metadata.pb",
                "/Users/mehrinkiani/Documents/modelscan/notebooks/TensorFlowModels/unsafe_model/saved_model.pb",
                "/Users/mehrinkiani/Documents/modelscan/notebooks/TensorFlowModels/safe_model/fingerprint.pb",
                "/Users/mehrinkiani/Documents/modelscan/notebooks/TensorFlowModels/safe_model/keras_metadata.pb",
                "/Users/mehrinkiani/Documents/modelscan/notebooks/TensorFlowModels/safe_model/saved_model.pb"
            ]
        }
    },
    "issues": [
        {
            "description": "Use of unsafe operator 'ReadFile' from module 'Tensorflow'",
            "operator": "ReadFile",
            "module": "Tensorflow",
            "source": "/Users/mehrinkiani/Documents/modelscan/notebooks/TensorFlowModels/unsafe_model/saved_model.pb",
            "scanner": "modelscan.scanners.SavedModelTensorflowOpScan",
            "severity": "HIGH"
        },
        {
            "description": "Use of unsafe operator 'WriteFile' from module 'Tensorflow'",
            "operator": "WriteFile",
            "module": "Tensorflow",
            "source": "/Users/mehrinkiani/Documents/modelscan/notebooks/TensorFlowModels/unsafe_model/saved_model.pb",
            "scanner": "modelscan.scanners.SavedModelTensorflowOpScan",
            "severity": "HIGH"
        }
    ],
    "errors": []
}