nccgroup/ScoutSuite

Improve error handling across all resources

Open

#873 opened on Sep 23, 2020

View on GitHub
 (2 comments) (0 reactions) (1 assignee)Python (978 forks)batch import
component-provider-alibabacomponent-provider-awscomponent-provider-azurecomponent-provider-gcpcomponent-provider-ocienhancementgood first issue

Repository metrics

Stars
 (5,904 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Currently, facades implement good exception handling, but resource parsing does not. That means that for a given resource type, if parsing fails for any given resource, the fetch_all method fails and stops, hence not parsing any additional resources.

All resources should be reviewed and updated, to ensure they handle parsing errors.

e.g., for AWS IAM roles (https://github.com/nccgroup/ScoutSuite/blob/master/ScoutSuite/providers/aws/resources/iam/roles.py#L8) the method should be updated as so:

for raw_role in raw_roles:
    try:
        name, resource = self._parse_role(raw_role)
        self[name] = resource
    except Exception as e:
        print_exception('Failed to parse {} resource: {}'.format(self.__class__.__name__, e))

Contributor guide

Research direction
Inspect all resource parsing methods in the providers directory, identify where try except is missing, and wrap parsing calls with try except blocks to handle exceptions gracefully. Ensure fetch all continues on failure. Follow the pattern shown in the AWS IAM roles example.
Tech stack
python
Domain
backendsecuritycloud
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Python
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80