Getting Started
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
Reference
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
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
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
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
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()
API Documentation
ModelField
ModelField.clean()
ManyToManyField
ManyToManyField.clean()
ManyToManyField.convert_id()
ManyToManyField.to_internal_value()
ManyToManyField.to_representation()
ManyToManySerializer
ManyToManySerializer.rel_fields
_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()
StringConverter
listconverters()
FirstTimeMiddleware
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
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()
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()
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()
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
get_app_info()
get_app_net_info()
NetworkSecurityHandler
get_manifest_info()
run_manifest_scan()
AndroidManifestHandler
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
apply()
DataTableRequest
DataTableRequest.columns
DataTableRequest.length
DataTableRequest.order_column
DataTableRequest.order_direction
DataTableRequest.search_value
DataTableRequest.start
StringEnum
Role
Visibility
Severity
State
Platform
PackageType
Relation
HostType
DataProtectionLevel
ProtectionLevel
visitor()
apply_rules()
_Visitor
_FileDesc
checksum_from_path()
get_file_checksum()
handle_scan_file_upload()
Core API
Observer
Observer.create_meta()
Observer.exception()
Observer.fail()
Observer.increment()
Observer.logger
Observer.pos
Observer.success()
Observer.task
Observer.update()
TaskFileHandler
TaskFileHandler.apply()
TaskFileHandler.from_scan()
PermissionDefItem
GroupDefItem
AppPermissionList
parse()
load()
Android API
_AXmlElement
_AXmlElement.add()
AXmlVisitorBase
AXmlVisitor
AXmlVisitor.end
AXmlVisitor.start
AXmlVisitor.visit_document()
AXmlVisitor.visit_element()
decompile()
to_java()
Additional middleware classes that intercept requests before any view can handle them.
Used to redirect to the setup page when starting this framework for the first time.
Note that this middleware will return a rendered setup page for all incoming request if the framework has not been initialized.