MAST-Framework
0.0

Getting Started

  • Setup with Docker Compose
    • Local Development
    • Service Configuration
      • Database
      • Broker
      • Nginx
        • Configuration Steps
        • Environment Options
      • Django
        • DJANGO_DEBUG
        • DJANGO_SECRET_KEY
        • DJANGO_ALLOWED_HOSTS
        • DJANGO_CSRF_TRUSTED_ORIGINS
        • DJANGO_SESSION_EXPIRE_AT_BROWSER_CLOSE
        • DJANGO_SESSION_COOKIE_AGE
        • DJANGO_HTTPS
        • DJANGO_STORAGE_URL
        • DJANGO_STORAGE_ROOT
        • DJANGO_PORT
  • Development Setup
  • Scaling Container Images
    • Scaling Django Application Containers
    • Scaling Celery Worker Instances
    • Conclusion

Reference

  • Visual Guide
    • Projects
    • Bundles
    • ScanTask design
  • Model Reference
    • Core Models
      • namespace
      • Environment
        • Environment.allow_registration
        • Environment.allow_teams
        • Environment.env()
        • Environment.env_id
        • Environment.first_start
        • Environment.max_bundles
        • Environment.max_projects
        • Environment.max_teams
      • Team
        • Team.get()
        • Team.get_by_owner()
        • Team.name
        • Team.owner
        • Team.users
        • Team.visibility
      • Project
        • Project.dir()
        • Project.directory
        • Project.get_by_user()
        • Project.inspection_type
        • Project.name
        • Project.owner
        • Project.project_uuid
        • Project.risk_level
        • Project.stats()
        • Project.tags
        • Project.team
        • Project.visibility
      • File
        • File.file_name
        • File.file_path
        • File.file_size
        • File.internal_name
        • File.md5
        • File.sha1
        • File.sha256
      • Account
      • Bundle
        • Bundle.bundle_id
        • Bundle.get_by_owner()
        • Bundle.name
        • Bundle.owner
        • Bundle.projects
        • Bundle.risk_level
        • Bundle.stats()
        • Bundle.tags
    • Scan Models
      • Scan
        • Scan.end_date
        • Scan.file
        • Scan.files()
        • Scan.finished
        • Scan.initiator
        • Scan.is_active
        • Scan.last_scan()
        • Scan.origin
        • Scan.project
        • Scan.risk_level
        • Scan.scan_type
        • Scan.scan_uuid
        • Scan.source
        • Scan.start_date
        • Scan.status
      • ScanTask
        • ScanTask.active
        • ScanTask.active_tasks()
        • ScanTask.celery_id
        • ScanTask.finish_scan()
        • ScanTask.name
        • ScanTask.scan
        • ScanTask.scanner
        • ScanTask.task_uuid
      • Certificate
        • Certificate.hash_algorithm
        • Certificate.issuer
        • Certificate.serial_number
        • Certificate.sha1
        • Certificate.sha256
        • Certificate.signature_algorithm
        • Certificate.subject
        • Certificate.version
      • Details
    • Finding Models
      • Snippet
        • Snippet.file_name
        • Snippet.file_size
        • Snippet.language
        • Snippet.lines
        • Snippet.sys_path
      • FindingTemplate
        • FindingTemplate.article
        • FindingTemplate.default_severity
        • FindingTemplate.description
        • FindingTemplate.internal_id
        • FindingTemplate.is_contextual
        • FindingTemplate.is_html
        • FindingTemplate.make_internal_id()
        • FindingTemplate.make_uuid()
        • FindingTemplate.meta_cvss
        • FindingTemplate.meta_cwe
        • FindingTemplate.meta_masvs
        • FindingTemplate.mitigation
        • FindingTemplate.risk
        • FindingTemplate.template_id
        • FindingTemplate.title
      • AbstractBaseFinding
        • AbstractBaseFinding.discovery_date
        • AbstractBaseFinding.finding_id
        • AbstractBaseFinding.scan
        • AbstractBaseFinding.scanner
        • AbstractBaseFinding.severity
        • AbstractBaseFinding.snippet
        • AbstractBaseFinding.stats()
        • AbstractBaseFinding.template
      • Finding
        • Finding.custom_text
        • Finding.discovery_date
        • Finding.finding_id
        • Finding.is_custom
        • Finding.make_uuid()
        • Finding.scan
        • Finding.scanner
        • Finding.severity
        • Finding.snippet
        • Finding.template
      • Vulnerability
        • Vulnerability.discovery_date
        • Vulnerability.finding_id
        • Vulnerability.make_uuid()
        • Vulnerability.scan
        • Vulnerability.scanner
        • Vulnerability.severity
        • Vulnerability.snippet
        • Vulnerability.state
        • Vulnerability.status
        • Vulnerability.template
    • App Permission Models
      • AppPermission
        • AppPermission.create_unknown()
        • AppPermission.dangerous
        • AppPermission.description
        • AppPermission.group
        • AppPermission.identifier
        • AppPermission.name
        • AppPermission.permission_uuid
        • AppPermission.plevel_status
        • AppPermission.protection_level
        • AppPermission.risk
        • AppPermission.short_description
      • PermissionFinding
        • PermissionFinding.discovery_date
        • PermissionFinding.finding_id
        • PermissionFinding.permission
        • PermissionFinding.scan
        • PermissionFinding.scanner
        • PermissionFinding.severity
        • PermissionFinding.snippet
        • PermissionFinding.template
    • Dependency Models
      • Package
        • Package.artifact_id
        • Package.description
        • Package.group_id
        • Package.is_tracker
        • Package.name
        • Package.package_type
        • Package.package_uuid
        • Package.platform
      • PackageVulnerability
        • PackageVulnerability.cve_id
        • PackageVulnerability.identifier
        • PackageVulnerability.package
        • PackageVulnerability.severity
        • PackageVulnerability.version
      • Dependency
        • Dependency.dependency_uuid
        • Dependency.license
        • Dependency.outdated
        • Dependency.package
        • Dependency.project
        • Dependency.relation
        • Dependency.scanner
        • Dependency.version
        • Dependency.vulnerabilities()
  • HTML Templates Guide
  • List of used Frameworks

API Documentation

  • REST API
  • Enhanced Forms
    • Enhanced Fields
      • ModelField
        • ModelField.clean()
      • ManyToManyField
        • ManyToManyField.clean()
        • ManyToManyField.convert_id()
  • Serializer Extensions
    • Enhanced Fields and Serializers
      • ManyToManyField
        • ManyToManyField.to_internal_value()
        • ManyToManyField.to_representation()
      • ManyToManySerializer
        • ManyToManySerializer.rel_fields
  • Permission System
    • Classes
      • _Method
        • _Method.has_permission()
      • BoundPermission
        • BoundPermission.assign_to()
        • BoundPermission.codename
        • BoundPermission.create()
        • BoundPermission.errors
        • BoundPermission.get()
        • BoundPermission.has_object_permission()
        • BoundPermission.is_runtime
        • BoundPermission.model
        • BoundPermission.name
        • BoundPermission.remove_from()
  • Converters
    • Components
      • StringConverter
      • listconverters()
  • Middleware
    • FirstTimeMiddleware
  • Web Mixins
    • View Classes
      • TemplateAPIView
        • TemplateAPIView.check_object_permissions()
        • TemplateAPIView.check_permissions()
        • TemplateAPIView.default_redirect
        • TemplateAPIView.get_object()
        • TemplateAPIView.keep_redirect_kwargs
        • TemplateAPIView.on_dispatch_error()
        • TemplateAPIView.permission_classes
    • Mixin Classes
      • ContextMixinBase
        • ContextMixinBase.login_url
        • ContextMixinBase.prepare_context_data()
      • VulnContextMixin
        • VulnContextMixin.apply_vuln_context()
        • VulnContextMixin.get_vuln_context()
      • UserProjectMixin
      • TopVulnerableProjectsMixin
        • TopVulnerableProjectsMixin.get_top_vulnerable_projects()
      • ScanTimelineMixin
        • ScanTimelineMixin.get_scan_timeline()
  • Scanner Plugin
    • Basics
      • Plugin()
      • Extension
      • ScannerPlugin
        • ScannerPlugin.context()
        • ScannerPlugin.extensions
        • ScannerPlugin.help
        • ScannerPlugin.name
        • ScannerPlugin.task
        • ScannerPlugin.title
      • ScannerPluginTask
        • ScannerPluginTask.get_item()
        • ScannerPluginTask.prepare_scan()
        • ScannerPluginTask.run_scan()
    • Default Mixins
      • DetailsMixin
        • DetailsMixin.charts
        • DetailsMixin.ctx_details()
      • PermissionsMixin
        • PermissionsMixin.ctx_permissions()
      • VulnerabilitiesMixin
        • VulnerabilitiesMixin.ctx_vulnerabilities()
      • FindingsMixins
        • FindingsMixins.ctx_findings()
      • HostsMixin
        • HostsMixin.ctx_hosts()
        • HostsMixin.res_hosts()
      • ComponentsMixin
        • ComponentsMixin.ctx_components()
        • ComponentsMixin.res_hosts()
    • Android Plugin
      • AndroidTask
        • AndroidTask.do_app_info_scan()
        • AndroidTask.do_code_scan()
        • AndroidTask.do_manifest_scan()
        • AndroidTask.do_package_scan()
        • AndroidTask.do_semgrep_scan()
        • AndroidTask.do_yara_scan()
        • AndroidTask.prepare_scan()
      • AndroidScannerPlugin
        • AndroidScannerPlugin.extensions
        • AndroidScannerPlugin.help
        • AndroidScannerPlugin.name
        • AndroidScannerPlugin.task
        • AndroidScannerPlugin.title
      • Android Scan Tasks
        • get_app_info()
        • get_app_net_info()
        • NetworkSecurityHandler
        • get_manifest_info()
        • run_manifest_scan()
        • AndroidManifestHandler
    • SAST Interface
      • yara_scan_file()
      • yara_code_analysis()
      • sast_scan_file()
      • sast_code_analysis()
      • add_finding()
      • YaraResult
        • YaraResult.get_template()
        • YaraResult.get_template_data()
        • YaraResult.internal_id
        • YaraResult.severity
        • YaraResult.template_id
  • Utilities
    • DataTables
      • apply()
      • DataTableRequest
        • DataTableRequest.columns
        • DataTableRequest.length
        • DataTableRequest.order_column
        • DataTableRequest.order_direction
        • DataTableRequest.search_value
        • DataTableRequest.start
    • Enums
      • StringEnum
      • User-Related Classes
        • Role
        • Visibility
      • Finding-Related Classes
        • Severity
        • State
      • Dependency-Related Classes
        • Platform
        • PackageType
        • Relation
      • Other Enum Classes
        • HostType
        • DataProtectionLevel
        • ProtectionLevel
    • FileTree Plugin
      • visitor()
      • apply_rules()
      • Classes
        • _Visitor
        • _FileDesc
    • File Utilities
      • checksum_from_path()
      • get_file_checksum()
      • handle_scan_file_upload()

Core API

  • Progress Observer
    • Usage Example:
      • Observer
        • Observer.create_meta()
        • Observer.exception()
        • Observer.fail()
        • Observer.increment()
        • Observer.logger
        • Observer.pos
        • Observer.success()
        • Observer.task
        • Observer.update()
  • Task File Handlers
    • APK Files
    • IPA Files
    • TaskFileHandler
      • TaskFileHandler.apply()
      • TaskFileHandler.from_scan()
  • App Permissions
    • PermissionDefItem
    • GroupDefItem
    • AppPermissionList
    • Example Usage
      • parse()
      • load()

Android API

  • Android Manifest Visitor
    • _AXmlElement
      • _AXmlElement.add()
    • AXmlVisitorBase
    • AXmlVisitor
      • AXmlVisitor.end
      • AXmlVisitor.start
      • AXmlVisitor.visit_document()
      • AXmlVisitor.visit_element()
  • Android Tools
    • Apktool
    • Baksmali
      • decompile()
      • to_java()
MAST-Framework
  • Overview: module code

All modules for which code is available

  • mastf.MASTF.converters
  • mastf.MASTF.forms.base
  • mastf.MASTF.middleware
  • mastf.MASTF.mixins
  • mastf.MASTF.models.base
  • mastf.MASTF.models.mod_finding
  • mastf.MASTF.models.mod_package
  • mastf.MASTF.models.mod_permission
  • mastf.MASTF.models.mod_scan
  • mastf.MASTF.permissions
  • mastf.MASTF.scanners.android_sast.app_info_scan
  • mastf.MASTF.scanners.android_sast.base
  • mastf.MASTF.scanners.android_sast.manifest_scan
  • mastf.MASTF.scanners.code
  • mastf.MASTF.scanners.mixins
  • mastf.MASTF.scanners.plugin
  • mastf.MASTF.serializers.base
  • mastf.MASTF.utils.datatable
  • mastf.MASTF.utils.enum
  • mastf.MASTF.utils.filetree
  • mastf.MASTF.utils.upload
  • mastf.android.axml
  • mastf.android.tools.baksmali
  • mastf.core.files.apl
  • mastf.core.files.handler
  • mastf.core.progress

© Copyright 2024, MatrixEditor.

Built with Sphinx using a theme provided by Read the Docs.