Commit bb31db33 authored by Ondřej Borýsek's avatar Ondřej Borýsek
Browse files

Add additional type hints

parent fb0a2cac

scan2report.py

+15 −15
Original line number Diff line number Diff line
@@ -19,7 +19,7 @@ import urllib.parse 
from copy import deepcopy

from os import path

from xml.etree import ElementTree

from typing import List, Dict

from typing import List, Dict, Any



# External libraries

import pandas
@@ -249,14 +249,14 @@ class Scan2ReportConfig: 


class Scan2ReportData:

    def __init__(self, config: Scan2ReportConfig):

        self.config = config

        self.fidAliases = get_all_aliases(config.rootDir)

        self.findings = {}

        self.missingPlugins = []

        self.services = {}

        self.unknownCounter = 0

        self.plugin_stats = {}

        self.hostnames = {}

        self.config: Scan2ReportConfig = config

        self.fidAliases: Dict[str, List[str]] = get_all_aliases(config.rootDir)

        self.findings: Dict[str, Dict[str, Any]] = {}  # [FID][finding_field] = field_value

        self.missingPlugins: List[str] = []

        self.services: Dict[str, Dict[int, Dict[str, str]]] = {}  # [IP][PORT][TCP/UPD] = service_name

        self.unknownCounter: int = 0

        self.plugin_stats: Dict[str, Dict] = {}

        self.hostnames: Dict[str, str] = {}





# debug messages
@@ -521,7 +521,7 @@ def create_missing_templates(s2r: Scan2ReportData): 
    return missing_as_list





def get_all_aliases(rootDir):

def get_all_aliases(rootDir: str):

    # get finding id aliases

    with open(rootDir + '/plugins/aliases.json', encoding="utf8") as jsonfile:

        try:
@@ -532,7 +532,7 @@ def get_all_aliases(rootDir): 
    return fidAliases





def parse_input_file(debug, s2r: Scan2ReportData, infile: str) -> int:

def parse_input_file(debug: bool, s2r: Scan2ReportData, infile: str):

    if not s2r.config.pluginStatsOnly:

        print('Parsing file ' + infile)

    infileFormat = 'unknown'
@@ -599,7 +599,7 @@ def parse_input_file(debug, s2r: Scan2ReportData, infile: str) -> int: 
    sys.exit(2)





def parse_tns_custom_finding(s2r: Scan2ReportData, infile):

def parse_tns_custom_finding(s2r: Scan2ReportData, infile: str):

    findings = s2r.findings

    ignore = s2r.config.ignore

    include = s2r.config.include
@@ -683,7 +683,7 @@ def parse_tns_custom_finding(s2r: Scan2ReportData, infile): 
            missingPlugins.append(fid)





def parse_tns_audit_windows(s2r: Scan2ReportData, infile):

def parse_tns_audit_windows(s2r: Scan2ReportData, infile: str):

    findings = s2r.findings

    ignore = s2r.config.ignore

    include = s2r.config.include
@@ -807,7 +807,7 @@ def parse_tns_audit_windows(s2r: Scan2ReportData, infile): 
            missingPlugins.append(fid)





def parse_kubeaudit(s2r: Scan2ReportData, infile):

def parse_kubeaudit(s2r: Scan2ReportData, infile: str):

    findings = s2r.findings

    lang = s2r.config.lang

    rootDir = s2r.config.rootDir
@@ -1194,7 +1194,7 @@ def parse_lynis(s2r: Scan2ReportData, infile: str): 
                missingPlugins.append(fid)





def parse_burp(debug, s2r: Scan2ReportData, root):

def parse_burp(debug: bool, s2r: Scan2ReportData, root):

    findings = s2r.findings

    ignore = s2r.config.ignore

    include = s2r.config.include