Report.py

"""
Report: Writes an analysis text file of the various over/under priviliged
        permissions found during analysis.
"""
from Permissions import Permissions

class Report:
    """Report object to be printed."""

    def __init__(self, package_name, permissions, third_party_permissions):
        self.package_name = package_name
        self.permissions = permissions
        self.third_party_permissions = third_party_permissions
        self.report_filename = "reports/report_" + package_name + ".txt"
        self.analysis_report_filename = "reports/analysis_" + package_name + ".txt"

    def print_analysis(self, requested_permissions, source_file):
        """Diffs the requested permissions against occurrences in source."""

        # Get permissions object
        permission = Permissions()

        permissions = set()
        for perm in requested_permissions:
            permissions.add(perm.rsplit('.', 1)[-1])

        requested_permissions_dict = permission.get_dangerous_permission_group(permissions)
        requested_permissions = set()
        for requested_perm_group in requested_permissions_dict.values():
            for requested in requested_perm_group:
                requested_permissions.add(requested)

        over_requested = requested_permissions_dict.copy()

        normal_permissions = set()
        dangerous_permissions = set()
        groups_to_remove = set()
        not_requested_files = set()
        not_requested_source_lines = set()

        # Reading source report for findings.
        with open(source_file) as source:
            for line in source:
                if "android.permission." in line:

                    # Skip line if it's commented
                    if line.lstrip().startswith("//"):
                        continue

                    # Check each line for normal permissions
                    for normal in permission.normal_permissions:
                        if normal in line:
                            normal_permissions.add(normal + ": " + line)

                    # Check each line to see if dangerous permission may exist
                    for dangerous_list in permission.dangerous_permissions.values():
                        for dangerous in dangerous_list:
                            if dangerous in line:
                                dangerous_permissions.add(dangerous + ": " + line)

                                # Possible not requested in Manifest
                                if dangerous not in requested_permissions:
                                    not_requested_files.add(source_file)
                                    not_requested_source_lines.add(line)
                                else:
                                    # Check for the group
                                    for permissions in requested_permissions_dict.values():
                                        if dangerous in permissions:
                                            for group, permissions in over_requested.items():
                                                if dangerous in permissions:
                                                    groups_to_remove.add(group)

            # Now remove those groups from requested groups
            for group in groups_to_remove:
                over_requested.pop(group)

        # Now print results to analysis file
        with open(self.analysis_report_filename, "w+") as analysis:
            print(" Analysis Report ".center(50, '-'), file=analysis)
            print("{}".format("Package: " + self.package_name), file=analysis)
            print(file=analysis)

            print(" Permissions from Manifest ".center(50, '-'), file=analysis)
            for index, non_system_permission in enumerate(self.permissions):
                print('{:>4} {}'.format(index, non_system_permission), file=analysis)
            print(file=analysis)

            print(" Third Party Permissions ".center(50, '-'), file=analysis)
            for index, permission in enumerate(self.third_party_permissions):
                print('{:>4} {}'.format(index, permission), file=analysis)
            print(file=analysis)

            print(" Requested Dangerous Permissions ".center(50, '-'), file=analysis)
            for group, permissions in requested_permissions_dict.items():
                for permission in permissions:
                    print(group + ": " + permission, file=analysis)
            print(file=analysis)

            print(" Dangerous Permissions ".center(50, '-'), file=analysis)
            print("{}".format("Total found: " + str(len(dangerous_permissions))), file=analysis)
            print(file=analysis)
            for permission in dangerous_permissions:
                print(permission, file=analysis)
            print(file=analysis)

            print(" Unrequested Dangerous (Under) ".center(50, '-'), file=analysis)
            for permission in not_requested_source_lines:
                print(permission, file=analysis)
            print(file=analysis)

            print(" Requested Dangerous (Over) ".center(50, '-'), file=analysis)
            for requested in over_requested.values():
                print(requested, file=analysis)
            print(file=analysis)
        print("Analysis printed! Location: " + self.analysis_report_filename)