Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New Cross-References for all MAS Components, Automation simplified with Hooks, New Tools (MASTG-TOOL-0105, MASTG-TOOL-0106, MASTG-TOOL-0107, MASTG-TOOL-0108) and Apps (MASTG-APP-0028) #2848

Merged
merged 134 commits into from
Aug 4, 2024

Conversation

TheDauntless
Copy link
Collaborator

@TheDauntless TheDauntless commented Jul 30, 2024

Key Highlights

  • Documentation Improvements: Fixed numerous HTTP links, standardized references across techniques, tools, apps, and tests using @MAS-IDs, and removed unused images.
  • New Additions: Added new iOS app (MASTG-APP-0028) and new tools (MASTG-TOOL-0105, MASTG-TOOL-0106, MASTG-TOOL-0107, MASTG-TOOL-0108), along with updating references to these additions.
  • Link Fixes: Resolved broken links across multiple sections including documents, demos, and tests, now using @ for component linking.
  • Script Optimization: Converted scripts to hooks, removing several unnecessary scripts, and simplified the run_web.sh script by removing unnecessary steps and switching to localhost.
  • Configuration Updates: Updated mkdocs.yml to handle absolute links and integrated new hooks for dynamic content generation.
  • New Icons: Each MAS component now has a new icon that is displayed in every link, as a tag and in the sidebar.

This PR fixes all current URL Checker issues as well as all mkdocs INFO and WARN items for broken content.

Co-authored by: @cpholguera

Details

Document

  • Fixed HTTP links (reported by the URL checker)
  • Now techniques, tools, apps, tests are all using @MAS-ID for example:
    • [Frida](0x08a-Testing-Tools.md#frida) -> @MASTG-TOOL-0031
    • [DVIA-v2](0x08b-Reference-Apps.md#dvia-v2) -> @MASTG-APP-0024
  • Removed unused images in Document/Images/
  • The MASTG index.md lives now in Document/index.md

Apps

  • Added NEW apps/ios/MASTG-APP-0028.md (iGoat-Swift) and updated all references to it using @MASTG-APP-0028
  • Fixed links to other components, now using @

Demos

  • Fixed broken links to files in Document/, for example [sensitive data](../../../../Document/0x04b-Mobile-App-Security-Testing.md#identifying-sensitive-data "Sensitive Data")
  • Remove hardcoded tools from the frontmatter (they will be added dynamically)

docs

  • Fixed broken links everywhere (MASVS/index, contributing, donate, etc.)
  • docs/checklists
    • Add placeholder files
    • Content is added via hooks
  • docs/hooks
    • NEW docs/hooks/add-checklists-banner.py
    • NEW docs/hooks/create_dynamic_tables.py
    • NEW docs/hooks/resolve_references.py
    • NEW docs/hooks/update_git_info.py
    • UPDATED docs/hooks/add-cross-references.py
    • UPDATED docs/hooks/update_titles.py (add icons and hide toc in MAS components)

mkdocs.yml

  • Add validation.nav.absolute_links: ignore: due to our use of mkdocs-awesome-pages-plugin, we need to ignore absolute links for nav
  • Add new hooks
  • Added icons to every MAS component to be displayed in every link, as a tag and in the sidebar.

run_web.sh

  • Removed unnecessary steps
  • Uses localhost instead of 0.0.0.0

src/scripts

  • Converted most of the code to hooks removing several scripts

techniques

  • Fixed links to other components, now using @

tests-beta

  • Fixed links to other components, now using @

tests

  • Fixed links to other components, now using @

tools

  • NEW MASTG-TOOL-0105 IPSW
  • NEW MASTG-TOOL-0106 Fridump
  • NEW MASTG-TOOL-0107 JNITrace
  • NEW MASTG-TOOL-0108 Corellium
  • Fixed links to other components, now using @

weaknesses

  • Fixed HTTP links (reported by the URL checker)

Images Validation

@cpholguera cpholguera changed the title File tree refactor2 [MASTG-APP-0028] [MASTG-TOOL-0103] Documentation Improvements, Link Fixes, New Tools (MASTG-TOOL-0105, MASTG-TOOL-0106, MASTG-TOOL-0107) and Apps (MASTG-APP-0028) Aug 4, 2024
@cpholguera cpholguera changed the title Documentation Improvements, Link Fixes, New Tools (MASTG-TOOL-0105, MASTG-TOOL-0106, MASTG-TOOL-0107) and Apps (MASTG-APP-0028) New Cross-References for all MAS Components, Automation simplified with Hooks, New Tools (MASTG-TOOL-0105, MASTG-TOOL-0106, MASTG-TOOL-0107) and Apps (MASTG-APP-0028) Aug 4, 2024
@cpholguera cpholguera changed the title New Cross-References for all MAS Components, Automation simplified with Hooks, New Tools (MASTG-TOOL-0105, MASTG-TOOL-0106, MASTG-TOOL-0107) and Apps (MASTG-APP-0028) New Cross-References for all MAS Components, Automation simplified with Hooks, New Tools (MASTG-TOOL-0105, MASTG-TOOL-0106, MASTG-TOOL-0107, MASTG-TOOL-0108) and Apps (MASTG-APP-0028) Aug 4, 2024
@cpholguera cpholguera merged commit 5d263f5 into master Aug 4, 2024
18 checks passed
@cpholguera cpholguera deleted the fileTreeRefactor2 branch August 4, 2024 17:35
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.

2 participants