1. Support Center
  2. Documentation
  3. Contents

Burp Suite documentation - contents

Documentation
Desktop editions
     Getting started
          Next steps
          Installing Burp Suite
               Downloading Burp Suite Professional
               Downloading Burp Suite Community Edition
               Installing Burp Suite
                    Burp Suite system requirements
                    Error running the installer on MacOS
          Launching Burp Suite
               Startup wizard
               Command line
                    Command line arguments
               Activate license
                    Manual activation
               Select project
                    Opening a project from a different Burp installation
               Select configuration
               Check display settings
               Configurations
                    Configuration library
                    User and project configuration files
                    Loading and saving configuration files
                    Configuration file format
               Working with Burp projects
                    Project files
                         Saving a copy of a project
                         Saving the Burp Collaborator identifier
                         Importing projects
          Configure Burp Proxy to work with an external browser
               Check listener is active
               Configuring your browser
                    Check your browser proxy configuration
                    Firefox
                    Chrome
                    Safari
                    Internet Explorer
               Installing Burp's CA certificate
                    Installing Burp's CA certificate on a mobile device
                    Why do I need to install Burp's CA certificate?
                    Firefox
                         Removing Burp's CA certificate from Firefox
                    Chrome
                         Installing Burp's CA certificate in Chrome - Windows and MacOS
                         Installing Burp's CA certificate in Chrome - Linux
                    Safari
                         Removing Burp's CA certificate from Safari
                    Internet Explorer
                         Removing Burp's CA certificate from Internet Explorer
          Downloading Burp's CA certificate
               Check that Burp is running
               Check your proxy listener is active
               Try a different port
               What next?
     Scanning web sites
          Launching scans
               Configuring scans
          Monitoring scan activity
          Reporting
          Browser-powered scanning
               How to enable browser-powered scanning
               System requirements for browser-powered scanning
               Browser-powered scanning on Linux
          Recorded logins
               How to record a login sequence for Burp Scanner
          Scan launcher
               Scan details
               Scan configuration
               Application login options
                    Use login credentials
                    Use recorded login sequences
               Resource pool options
          Live scans
               Live scan configuration
               Live audit
               Live passive crawl
          Crawl options
               Crawl optimization
                    Maximum link depth
                    Crawl strategy
               Crawl limits
               Login functions
                    How does the crawler identify login and registration forms?
                    Why is the crawler not filling my login forms?
               Handling application errors during crawl
               Miscellaneous crawl settings
                    Embedded browser options
          Audit options
               Audit optimization
               Issues reported
               Handling application errors during audit
               Insertion point types
               Modifying parameter locations options
               Ignored insertion points
               Frequently occurring insertion points
               Misc insertion point options
               JavaScript analysis options
          Audit items
               Audit phase indicators
               Audit items annotations
          Reporting
               Report format
               Issue details
               HTTP messages
               Selecting issue types
               Report details
     Penetration testing
          Testing workflow
          Recon and analysis
          Tool configuration
          Vulnerability detection and exploitation
          Read more
     Mobile testing
     Extensibility
     Troubleshooting
     Dashboard
          Task details
          Task execution settings
               Task auto-start
               Resource pools
          Issue activity
               Issue activity annotations
     Tools
          Target
               Using
                    Manual application mapping
                    Defining Target scope
                    Reviewing unrequested items
                    Discovering hidden content
                    Analyzing the attack surface
                    Target tool testing workflow
               Target site map
                    Target information
                         Site map views
                         Contents view
                         Issues view
                    Site map display filter
                    Site map annotations
                    Site map testing workflow
                    Comparing site maps
                         Site map sources
                         Request matching
                         Response comparison
                         Comparison results
               Scope
          Proxy
               Getting started
               Using Burp Proxy
                    Getting set up
                    Intercepting requests and responses
                    Using the Proxy history
                    Burp Proxy testing workflow
                    Key configuration options for Burp Proxy
               Intercepting messages
                    Controls
                    Message display
               History
                    History table
                    Proxy history display filter
                    Proxy history annotations
                    Proxy history testing workflow
               Options
                    Proxy listeners
                         Binding
                         Request handling
                         Certificate
                         Exporting and importing the CA certificate
                         Creating a custom CA certificate
                         TLS protocols
                    Intercepting HTTP requests and responses
                    Intercepting WebSocket messages
                    Response modification
                    Match and replace
                    TLS pass through
                    Miscellaneous
                    Invisible proxying
               In-browser interface
          Intruder
               Getting started
               Using Burp Intruder
                    How Intruder works
                    Typical uses
                         Enumerating identifiers
                         Harvesting useful data
                         Fuzzing for vulnerabilities
               Target
               Positions
                    Request template
                    Payload markers
                    Attack type
               Payloads
                    Types
                         Simple list
                              Predefined payload lists
                         Runtime file
                         Custom iterator
                         Character substitution
                         Case modification
                         Recursive grep
                         Illegal Unicode
                         Character blocks
                         Numbers
                         Dates
                         Brute forcer
                         Null payloads
                         Character frobber
                         Bit flipper
                         Username generator
                         ECB block shuffler
                         Extension-generated
                         Copy other payload
                    Processing
                         Payload processing rules
                         Payload encoding
               Options
                    Attack request headers
                    Request engine
                    Attack results options
                    Grep - match
                    Grep - extract
                    Grep - payloads
                    Handling redirections during attacks
               Configure attack
                    Launching an attack
               Attack results
                    Results table
                         Intruder attacks display filter
                         Annotations
                         Burp Intruder testing workflow
                    Attack configuration tabs
                    Results menus
                         Attack menu
                         Save menu
                         Columns menu
               Analyzing results
          Repeater
               Using Burp Repeater
                    Using Burp Repeater with HTTP messages
                         Sending HTTP requests
                         HTTP request history
                    Using Burp Repeater with WebSocket messages
                    Repeater options
                    Managing request tabs
               Options
          Sequencer
               Getting started
               Randomness tests
                    Character-level analysis
                    Bit-level analysis
               Samples
                    Live capture
                         Select live capture request
                         Token location within response
                         Live capture options
                         Running the live capture
                    Manual load
               Analysis options
                    Token handling
                    Token analysis
               Results
                    Summary
                    Character-level analysis results
                    Bit-level analysis results
                    Results analysis options
          Decoder
               Loading data into Decoder
               Transformations
               Working manually
               Smart decoding
          Comparer
               Loading data into Comparer
               Performing comparisons
          Extender
               Loading and managing extensions
               Extension details
               BApp store
               Burp Extender API
               Extender options
                    Settings
                    Java environment
                    Python environment
                    Ruby environment
          Clickbandit
               Running Burp Clickbandit
               Record mode
               Review mode
          Collaborator client
               Using Burp Collaborator client
          Mobile Assistant
               Routing traffic through Burp Suite
               Bypassing certificate pinning
                    Adding injected apps
                    Injected apps list
                    Recovering from crashes
               Installing Burp Suite Mobile Assistant
     Useful functions
          Message editor
               Message analysis tabs
                    Raw
                    Params
                    Headers
                    Hex
                    HTML
                    XML
                    Render
                    ViewState
               Context-specific actions
               Text editor
                    Syntax analysis
                    Pretty printing
                    Non-printing characters
                    Text editor hotkeys
                    Quick search
          Embedded browser
               Manual testing with Burp's embedded browser
               Scanning websites with Burp's embedded browser
               Embedded browser health check
          Search
               Text search
               Find comments and scripts
               Find references
          Target analyzer
          Content discovery
               Control
               Target
               Filenames
               File extensions
               Discovery engine
               Site map
          Task scheduler
          Generate CSRF PoC
               CSRF PoC options
          URL-matching rules
               Normal scope control
               Advanced scope control
          Response extraction rules
          Manual testing simulator
     Options
          Project options
          User options
          Key
          Connections
               Platform authentication
               Upstream proxy servers
               SOCKS proxy
               Timeouts
               Hostname resolution
               Out-of-scope requests
          HTTP
               Redirections
               Streaming responses
               Status 100 responses
               HTTP/2 (experimental)
          TLS
               TLS negotiation
               Java TLS options
               Client TLS certificates
               Server TLS certificates
          Sessions
               Session handling challenges
               Session handling rules
                    Session handling tracer
               Cookie jar
               Macros
               Integration with Burp tools
               Rule editor
                    Rule description
                    Rule actions
                         Use cookies from the session handling cookie jar
                         Set a specific cookie or parameter value
                         Check session is valid
                         Prompt for in-browser session recovery
                         Run a macro
                         Run a post-request macro
                         Invoke a Burp extension
                    Tools scope
                    URL scope
                    Parameter scope
               Macro editor
                    Record macro
                    Configuring macro items
                         Cookie handling
                         Parameter handling
                         Custom parameter locations in response
                    Re-analyze macro
                    Test macro
          Misc project options
               Scheduled tasks
               Burp Collaborator server
               Logging
               Embedded browser project options
          Display
               User interface
                    How to enable dark mode in Burp Suite
               HTTP message display
               Character sets
               HTML rendering
          Misc user options
               Hotkeys
               Automatic project backup
               REST API options
               Proxy interception
               Proxy history logging
               Temporary files location
               Performance feedback
                    Logging exceptions to a local directory
Enterprise Edition
     Trial setup guide
          Getting started with your trial
          Additional steps
          Install your trial
               Request a trial license
               Check your firewall configuration
               Install Burp Suite Enterprise Edition
          Start Burp Suite Enterprise Edition for the first time
               Open Burp Suite Enterprise Edition
               Configure an HTTP proxy
               Activate your license
          Configure the web server
          Add a website to scan
          Create a scan
               Schedule a recurring scan
          Process your scan results
               Analyze an issue
               Mark an issue as a false positive
               Using the dashboards
               Next steps
          Additional steps
               Running concurrent scans
                    Deploying additional agent machines
               Configuring your email server
               Setting up your team
               Jira
               CI integration
               Creating custom scan configurations
               Migrating to an external database
     Technical infrastructure
          Core components
               Enterprise server
               Web server
               Database
               Agents and agent machines
          Agents
          Agent machines
          Requirements
               Number of machines
               System requirements
                    General requirements
                    Bundled deployment
                    External agent machines
                    Database and storage space
               Network and firewall
                    Fully bundled deployment
                    Multi-system deployment
               Client browsers
     Getting started
          Preparing for the installation
          Setting up the external DB
          Initial installation
               Obtaining a license
                    What if I can't find my license key?
               Installing Burp Suite Enterprise Edition
          Deploying to the cloud
               AWS
                    Set up the IAM roles
                    Set up your database
                    Generate an AWS access key
                    Create the main stack
                    Fetch the DNS name for launching the application
               Azure
                    Set up your database
                    Deploy Burp Suite Enterprise Edition on Azure
          Initial configuration
               Starting Burp Suite Enterprise Edition as an admin
               Activating your license
               Configuring your web server
                    Web server URL and port number
                    Enabling TLS
                    Configuring an HTTP proxy server
               Configuring your email server
                    Sending invites to newly created users
                    Configuring email recipients for scan reports
     Working with Burp Suite Enterprise Edition
          Starting Burp Suite Enterprise Edition
               Home page
          Working with sites
               Sites page
               Creating sites
               Viewing site details
                    Site-level dashboard
                    Scans
                    Issues
                    Details
                         Site URLs
               Folders
                    Viewing folder details
                         Folder-level dashboard
                         Scans
                         Issues
          Working with scans
               Scans page
               Scan configurations
               Creating scans
               Viewing scan details
                    Scheduled scans
                    Running and completed scans
                    Failed scans
          Scan results
               Viewing issue details
                    Advisory
                    Requests and responses
                    Dynamic analysis
               Handling false positives
               Jira tickets
               Monitoring your progress
               Reporting
                    Downloading scan reports
                         Report type
                         Included severities
                         False positives
                    Automatically sending scan summary reports
                    Downloading charts
                    Downloading the event log
     Administration tasks
          Additional configuration and integration tasks
          General administration tasks
          Integrating with Jira
               Creating your Jira API token (cloud only)
               Configuring the integration
                    Configuring automatic ticket creation
               Manually creating Jira tickets
          Integrating with your CI/CD platform
               Creating an API user for the integration
               Integrating Jenkins
               Integrating TeamCity
               Integrating other CI/CD platforms
               Additional configuration (optional)
                    Integration using HTTPS
                    Configuring a detailed scan definition
                    Ignoring issues
          Deploying additional agent machines
               Setting up a new agent machine
               Authorizing a new agent machine
          Assigning agents
               Requesting additional agents
          Migrating to an external database
               Installing the database transfer tool
               Preparing for migration
               Migrating your data
               Restarting services
          Changing your network settings
          Enabling single sign-on
               LDAP
               SAML
                    Add Burp Suite Enterprise Edition to your trusted applications
                    Obtain key details from your identity provider
                    Enter your identity provider details
                    Additional identity provider configuration
                    Configuring single logout
                    Additional ADFS configuration
                         Create a central claim issuance policy
                         Create claim rules for each group individually
                    Additional Okta configuration
                    Additional Azure AD configuration
               Configuring user permissions
          Managing your team
               Users
                    Creating a new user
                    Creating API users
               Roles
               Groups
               Restricting access to sites
          Managing the site tree
               Creating folders and subfolders
               Adding sites to a folder
          Managing sites and scan data
               Automatically create sites for API-generated scans
                    How does Burp Suite Enterprise Edition decide which sites to match?
               Automatically delete old scans
               Scan deltas
               Configuring false positive settings
               Backing up your data
          Managing updates
               Offline updates
               Downtime during updates
     API reference
          GraphQL API
          REST API
Scanner
     Crawling
          Core approach
          Session handling
          Detecting changes in application state
          Application login
          Crawling volatile content
          Crawling with the embedded browser (browser-powered scanning)
     Auditing
          Audit phases
          Issue types
          Insertion points
               Encoding data within insertion points
               Nested insertion points
               Modifying parameter locations
          Automatic session handling
          Avoiding duplication
               Consolidation of frequently occurring passive issues
               Handling of frequently occurring insertion points
          JavaScript analysis
          Handling application errors
Burp Collaborator
     What is Burp Collaborator?
     How Burp Collaborator works
     Security of Collaborator data
     Options for using Burp Collaborator
     Deploying a private server
          Installation and execution
          Basic set-up on a closed network
          Running on non-standard ports
          DNS configuration
          TLS configuration
          Interaction events and polling
          Metrics
          Collaborator logging
          Testing the installation
          Collaborator configuration file format
          Adding custom content to your Collaborator server
Burp Infiltrator
     How Burp Infiltrator works
     Installing Burp Infiltrator
          Non-interactive installation
     Configuration options
Contents