graph LR
Application_Entry_Setup["Application Entry & Setup"]
Scan_Orchestration["Scan Orchestration"]
Code_Analysis_Engine["Code Analysis Engine"]
Results_Management_Reporting["Results Management & Reporting"]
Core_Utilities["Core Utilities"]
Application_Entry_Setup -- "initializes and configures" --> Scan_Orchestration
Scan_Orchestration -- "coordinates analysis with" --> Code_Analysis_Engine
Scan_Orchestration -- "collects and outputs results via" --> Results_Management_Reporting
Code_Analysis_Engine -- "reports issues to" --> Results_Management_Reporting
Application_Entry_Setup -- "uses" --> Core_Utilities
Scan_Orchestration -- "uses" --> Core_Utilities
Code_Analysis_Engine -- "uses" --> Core_Utilities
Results_Management_Reporting -- "uses" --> Core_Utilities
click Application_Entry_Setup href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/bandit/Application Entry & Setup.md" "Details"
click Scan_Orchestration href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/bandit/Scan Orchestration.md" "Details"
click Code_Analysis_Engine href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/bandit/Code Analysis Engine.md" "Details"
click Results_Management_Reporting href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/bandit/Results Management & Reporting.md" "Details"
click Core_Utilities href "https://github.com/CodeBoarding/GeneratedOnBoardings/blob/main/bandit/Core Utilities.md" "Details"
Bandit is a security linter for Python code that identifies common security issues by analyzing the Abstract Syntax Tree (AST) of source files. The main flow involves an initial setup phase where configurations and extensions are loaded, followed by a scan orchestration process that coordinates the code analysis engine to detect vulnerabilities. Identified issues are then managed and reported through various output formats.
Manages the initial startup of the Bandit application, including command-line argument parsing, logging initialization, loading and validating configurations, and dynamically loading security plugins, output formatters, and blacklists. It prepares the environment for the security scan.
Related Classes/Methods:
bandit.bandit.cli.main:main(134:693)bandit.bandit.cli.main:_init_logger(23:43)bandit.bandit.cli.main:_get_options_from_ini(46:75)bandit.bandit.cli.main:_get_profile(111:122)bandit.core.config.BanditConfig(25:271)bandit.core.config.BanditConfig.__init__(26:82)bandit.core.config.BanditConfig.get_option(84:101)bandit.core.config.BanditConfig.validate(235:271)bandit.core.extension_loader.Manager(13:107)bandit.core.extension_loader.Manager.load_formatters(28:35)bandit.core.extension_loader.Manager.load_plugins(37:57)bandit.core.extension_loader.Manager.load_blacklists(66:84)
Oversees the entire security scanning workflow. It discovers files to be analyzed, manages the baseline issues, initiates the AST traversal and test execution, and coordinates the final output of the scan results.
Related Classes/Methods:
bandit.core.manager.BanditManager(32:367)bandit.core.manager.BanditManager.discover_files(200:259)bandit.core.manager.BanditManager.run_tests(261:299)bandit.core.manager.BanditManager.output_results(141:198)
The core of Bandit's vulnerability detection. It performs Abstract Syntax Tree (AST) traversal of Python source code, applies a suite of security plugins (tests) to identify specific vulnerabilities, and utilizes predefined blacklists of insecure constructs.
Related Classes/Methods:
bandit.core.node_visitor.BanditNodeVisitor(16:297)bandit.core.node_visitor.BanditNodeVisitor.visit_Call(80:96)bandit.core.tester.BanditTester(17:166)bandit.core.tester.BanditTester.run_tests(26:123)bandit.bandit.plugins.injection_paramiko:paramiko_calls(50:63)bandit.bandit.blacklists.imports:gen_blacklist(234:425)
Handles the lifecycle of identified security issues, from their creation and storage to aggregation and final presentation. It defines the structure of issues, calculates scan metrics, and formats the results into various output formats.
Related Classes/Methods:
bandit.core.issue.Issue(78:232)bandit.core.issue.Cwe(10:75)bandit.core.metrics.Metrics(10:106)bandit.core.metrics.Metrics.count_issues(77:78)bandit.bandit.formatters.text:report(151:198)bandit.bandit.formatters.text:get_results(118:147)
Provides a foundational set of general-purpose helper functions and classes used across various components of Bandit. These utilities support tasks such as file parsing, string manipulation, and path resolution.
Related Classes/Methods: