Skip to content

Conversation

spoiicy
Copy link
Member

@spoiicy spoiicy commented Oct 28, 2024

Description

Adding Androguard analyzer which is a python tool to reverse engineer APKs.

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue).
  • [ x] New feature (non-breaking change which adds functionality).
  • Breaking change (fix or feature that would cause existing functionality to not work as expected).

Checklist

  • [ x] I have read and understood the rules about how to Contribute to this project
  • [ x] The pull request is for the branch develop
  • [ x] A new plugin (analyzer, connector, visualizer, playbook, pivot or ingestor) was added or changed, in which case:
    • [ x] I strictly followed the documentation "How to create a Plugin"
    • Usage file was updated.
    • Advanced-Usage was updated (in case the plugin provides additional optional configuration).
    • [ x] I have dumped the configuration from Django Admin using the dumpplugin command and added it in the project as a data migration. ("How to share a plugin with the community")
    • If a File analyzer was added and it supports a mimetype which is not already supported, you added a sample of that type inside the archive test_files.zip and you added the default tests for that mimetype in test_classes.py.
    • [ x] If you created a new analyzer and it is free (does not require any API key), please add it in the FREE_TO_USE_ANALYZERS playbook by following this guide.
    • Check if it could make sense to add that analyzer/connector to other freely available playbooks.
    • [ x] I have provided the resulting raw JSON of a finished analysis and a screenshot of the results.
    • If the plugin interacts with an external service, I have created an attribute called precisely url that contains this information. This is required for Health Checks.
    • If the plugin requires mocked testing, _monkeypatch() was used in its class to apply the necessary decorators.
    • I have added that raw JSON sample to the MockUpResponse of the _monkeypatch() method. This serves us to provide a valid sample for testing.
  • If external libraries/packages with restrictive licenses were used, they were added in the Legal Notice section.
  • [ x] Linters (Black, Flake, Isort) gave 0 errors. If you have correctly installed pre-commit, it does these checks and adjustments on your behalf.
  • I have added tests for the feature/bug I solved (see tests folder). All the tests (new and old ones) gave 0 errors.
  • If changes were made to an existing model/serializer/view, the docs were updated and regenerated (check CONTRIBUTE.md).
  • If the GUI has been modified:
    • I have a provided a screenshot of the result in the PR.
    • I have created new frontend tests for the new component or updated existing ones.
  • After you had submitted the PR, if DeepSource, Django Doctors or other third-party linters have triggered any alerts during the CI checks, I have solved those alerts.

Important Rules

  • If you miss to compile the Checklist properly, your PR won't be reviewed by the maintainers.
  • Everytime you make changes to the PR and you think the work is done, you should explicitly ask for a review. After being reviewed and received a "change request", you should explicitly ask for a review again once you have made the requested changes.

Screenshot

Screenshot 2024-10-28 at 11 50 03 AM

Full Report

job#6_report (1).json

@spoiicy spoiicy marked this pull request as draft October 28, 2024 07:50
@mlodic mlodic linked an issue Oct 28, 2024 that may be closed by this pull request
@spoiicy spoiicy marked this pull request as ready for review October 28, 2024 07:58
Copy link
Member

@mlodic mlodic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cool! I'll add some other useful functions:

  • get_receivers()
  • get_services()
  • is_valid_APK()
  • get_min_sdk_version()
  • get_max_sdk_version()
  • get_target_sdk_version()
  • get_androidversion_code()
  • get_androidversion_name()
    In that way we can have a more broader overview of the analyzed file

@spoiicy spoiicy force-pushed the analyzer/androguard branch from 9bdb50d to 74d817a Compare October 28, 2024 12:26
Copy link
Member Author

@spoiicy spoiicy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The additional functionalities mentioned by @mlodic have been implemented along with modifications to TLP value and accepted file mime-types.

Copy link
Member

@mlodic mlodic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please open a PR for the docs alongside this one then I guess we are done

@spoiicy
Copy link
Member Author

spoiicy commented Oct 28, 2024

@mlodic, I've opened a PR (intelowlproject/docs#9) for the addition of Androguard usage details.

@mlodic
Copy link
Member

mlodic commented Oct 28, 2024

just the last thing requested from deepsource: you should create the update method with a pass to respect the abstract method

@spoiicy
Copy link
Member Author

spoiicy commented Oct 28, 2024

@mlodic I've added the update method with a pass. Hopefully, this will resolve the issue and we can merge this PR :)

@mlodic
Copy link
Member

mlodic commented Oct 28, 2024

there's left an unrelated error in the tests. I'll check it before merging

@mlodic mlodic merged commit 1a3c051 into intelowlproject:develop Oct 29, 2024
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Analyzer] Androguard
2 participants