ENTERPRISEPROFESSIONALCOMMUNITY

Burp Suite documentation - contents

• Last updated: September 21, 2023

• Read time: 28 Minutes

Documentation
Desktop editions
	Getting started
		System requirements
			CPU cores / memory
			Free disk space
			Operating system and architecture
		Download and install
		Intercepting HTTP traffic with Burp Proxy
			Intercepting a request
		Modifying requests in Burp Proxy
			Step 1: Access the vulnerable website in Burp's browser
			Step 2: Log in to your shopping account
			Step 3: Find something to buy
			Step 4: Study the add to cart function
			Step 5: Modify the request
			Step 6: Exploit the vulnerability
		Setting the target scope
		Reissuing requests with Burp Repeater
			Sending a request to Burp Repeater
			Testing different input with Burp Repeater
		Running your first scan
			Scanning a website
		Generating a report
		What next?
			Continue your Burp Suite journey
		Activate license
			Manual activation
		Mac installer
	Extensions
		Creating
			Useful resources for extension developers
			Handling kettled HTTP/2 requests in extensions
			BApp Store acceptance criteria
			Submitting extensions to the BApp Store
				Step 1 - Check the acceptance criteria
				Step 2 - Submit your extension
				Step 3 - We review your extension
				Updating your BApp
			Extender API examples (Legacy)
		Installing extensions
			Installing extensions from the BApp Store
				Requirements
				Installing Jython or JRuby
			Installing an extension from a file
		Managing extensions
		Monitoring system impact
			Cumulative impact of extensions
	Testing workflow
		Stage 1: Map the target application
		Stage 2: Analyze the attack surface
		Stage 3: Test for vulnerabilities
			Input-based vulnerabilities
			Logic and design flaws
			Access control vulnerabilities
		Other vulnerabilities
		Setting a test scope
			Adding URLs to the scope
			Excluding URLs from the scope
		Mapping the website
			Mapping the visible surface
				Before you start
				Steps
			Discovering hidden content
				Automated discovery
					Before you start
					Steps
				Enumerating subdomains
					Steps
		Analyzing the attack surface
			Scoping the effort to audit a website
				Before you start
				Steps
			Identifying high-risk functionality
				Before you start
				Steps
			Identifying supported HTTP methods
				Before you start
				Enumerating supported methods for a single endpoint
				Enumerating supported methods for multiple endpoints
			Checking for hidden inputs
				Before you start
				Steps
			Evaluating inputs
				Before you start
				Steps
					Manually evaluating individual inputs
					Scanning inputs
					Fuzzing inputs
			Analyzing opaque data
				Decoding data
					Investigate opaque data with the Inspector
					Investigate opaque data with Burp Decoder
				Identifying which parts of a token impact the response
					Steps
		Testing authentication mechanisms
			Enumerating usernames
				Steps
			Guessing usernames for known users
				Steps
			Brute-forcing passwords
				Before you start
				Running a dictionary attack
				Running an exhaustive brute-force attack
			Credential stuffing
				Before you start
				Steps
			Brute-forcing logins
				Before you start
				Steps
		Testing session management mechanisms
			Analyzing session token generation
				Before you start
				Steps
			Determining the session timeout
				Steps
			Generating a CSRF proof-of-concept
				Steps
			Working with JWTs
				Before you start
				Viewing JWTs
				Editing JWTs
				Adding a JWT signing key
			Working with GraphQL in Burp Suite
				Before you start
				Viewing and modifying GraphQL requests
				Converting GraphQL request format
				Scanning an API schema
			Maintaining an authenticated session
				Identifying a valid login expression
				Configuring a session handling rule
				Checking the session handling rule
		Testing access controls
			Testing for privilege escalation
				Before you start
				Testing a specific endpoint
				Testing across the entire site
			Testing horizontal access controls
				Before you start
				Testing a specific endpoint
				Testing across the entire site
			Testing for IDORs
				Steps
			Testing for parameter-based access control
				Before you start
				Steps
		Testing input validation
			Bypassing client-side controls
				Steps
			SQL injection
				Testing for SQL injection vulnerabilities
					Steps
						Scanning for SQL injection vulnerabilities
						Manually fuzzing for SQL injection vulnerabilities
			Cross-site scripting
				Identifying reflected input
					Steps
						Scanning for reflected inputs
						Identifying reflected input manually
					Next steps
				Testing for DOM XSS with DOM Invader
					Before you start
					Steps
					Related pages
				Testing for web message DOM XSS with DOM Invader
					Before you start
					Steps
					Related pages
				Testing for reflected XSS manually
					Before you start
					Steps
					Related pages
				Testing for stored XSS
					Steps
				Bypassing XSS filters
					Before you start
					Steps
				Testing for blind XSS
					Steps
					Related pages
			Testing for prototype pollution with DOM Invader
				Before you start
				Steps
			OS command injection
				Testing for command injection vulnerabilities
					Steps
						Scanning for command injection vulnerabilities
						Manually testing for command injection vulnerabilities
				Testing for asynchronous OS command injection vulnerabilities
					Steps
				Exploiting OS command injection vulnerabilities to exfiltrate data
					Before you start
					Steps
			XXE injection
				Testing for XXE injection vulnerabilities
					Steps
						Scanning for XXE vulnerabilities
						Manually testing for XXE vulnerabilities
				Testing for blind XXE injection vulnerabilities
					Steps
						Scanning for blind XXE injection vulnerabilities
						Manually testing for blind XXE injection vulnerabilities
			Testing for directory traversal vulnerabilities
				Steps
					Scanning for directory traversal vulnerabilities
					Fuzzing for directory traversal vulnerabilities
		Testing for clickjacking
			Steps
		Testing for SSRF vulnerabilities
			Testing for SSRF
				Steps
			Testing for blind SSRF
				Steps
		Testing for WebSocket vulnerabilities
			Manipulating WebSocket messages
				Steps
			Manipulating WebSocket handshakes
				Steps
		Complementing manual testing with Burp Scanner
			Scanning specific requests
			Scanning user-defined insertion points
				Scanning a single insertion point
				Scanning multiple insertion points
			Scanning non-standard data structures
			Store HTTP traffic for review
	Tools
		Burp's browser
			Manual testing with Burp's browser
			Scanning websites with Burp's browser
			Health check for Burp's browser
		Burp Proxy
			Proxy intercept
				Controls
				Message display
				Protocol
			HTTP history
				Changing the HTTP history layout
				Viewing a request
				Filter settings
					Adding annotations
			Managing CA certificates
				Exporting and importing the CA certificate
				Creating a custom CA certificate
			Invisible proxying
			WebSockets history
				Changing the WebSockets history layout
				Viewing a request
				Filter settings
					Adding annotations
		Repeater
			Working with HTTP messages
				HTTP Repeater tab
					Adding notes for HTTP Repeater tabs
			Sending grouped HTTP requests
				Sending requests in sequence
					Sending over a single connection
					Sending over separate connections
					Send in sequence prerequisites
				Sending requests in parallel
					Send in parallel prerequisites
			Working with WebSocket messages
				WebSocket Repeater tab
			Managing tabs
				Tab groups
			Managing tab groups
				Creating a new tab group
				Editing existing groups
				Closing tab groups
			Configuring tab-specific settings
		Intruder
			Getting started
				Tutorial
					Step 1: Access the lab
					Step 2: Try to log in
					Step 3: Set the payload position
					Step 4: Select an attack type
					Step 5: Add the payloads
					Step 6: Start the attack
					Step 7: Look for any irregular responses
					Step 8: Study the response
					What next?
				Learn more about Burp Intruder
			Configure attack
				Positions
					Payload positions field
						Target field
					Configuring payload positions
				Attack types
					Sniper
					Battering ram
					Pitchfork
					Cluster bomb
				Payload types
					Payload settings
					Simple list
					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
					Collaborator payloads
				Payload lists
					Using predefined payload lists
					Placeholders
					Processing placeholders
				Processing
					Configuring processing rules
					Types of processing rules
					Configuring payload encoding
				Resource pools
					Creating resource pools
					Resource pool settings
					Moving tasks between resource pools
				Settings
					Save attack
					Request headers
					Error handling
					Attack results
					Grep - match
					Grep - extract
					Grep - payloads
					Redirections
					HTTP/1 connection reuse
					HTTP version
				Managing tabs
			Results
				Editing attacks
					Controlling an attack
					Configuring an attack
				Saving results
					Closing attacks
				Viewing results
					Viewing a request
				Analyzing results
					Sorting results
					Copying results
					Filtering results
					Adding annotations
				Workflow
					Scan
					Send to...
					Show response in browser
					Request in browser
					Generate CSRF PoC
					Add to site map
					Request item again
					Define extract grep from response
					Copy as curl command
					Add comment
					Highlight
					Copy links
					Save item
			Uses
				Enumerating identifiers
					Step 1: Find a request
					Step 2: Set a payload position
					Step 3: Set a payload type
					Step 4: Analyze the results
					Use cases
				Fuzzing
					Step 1: Set the payload positions
					Step 2: Set the payload type
					Step 3: Set the match grep
					Step 4: Analyze the results
				Harvesting data
					Step 1: Find a request
					Step 2: Set a payload position
					Step 3: Set a payload type
					Step 4: Set an extract grep
					Step 5: Analyze the results
					Use cases
		Target
			Site map
				Accessing the site map
				Tree view
					Tree view icons
				Contents pane
				Requests and responses
				Issues pane
					Editing the Issues pane
				Getting started
					Tutorial
						Step 1: Access the lab
						Step 2: Go to the site map
						Step 3: Update the site map
						Step 4: Filter the displayed information
						Step 5: Set the target scope using the site map
				Workflow tools
					Add to scope / Remove from scope
					Send to
					Scan
					Show response in browser
					Request in browser
					Engagement tools
					Compare site maps
					Add comment / Highlight
					Expand / collapse branch / requested items
					Delete items
					Copy URLs
					Copy as curl command
					Copy links
					Save items
					Show new site map window
				Filtering the site map
					Site map annotations
				Comparing site maps
					Site map sources
					Request matching
					Response comparison
				Comparison results
					Viewing comparison results
					Interpreting comparison results
				Site map layout
					Contents and issues layout
					Request and response layout
					Adding a new site map window
			Crawl paths
				Accessing the Crawl paths tab
				Viewing crawl paths
					Example crawl path
				Viewing HTTP requests
				Viewing issues
				Viewing outlinks
			Scope
				URL-matching rules
					Normal scope control
					Advanced scope control
			Issue definitions
			Manual Application mapping
			Reviewing unrequested items
			Analyzing the attack surface
		Inspector
			Configuring the Inspector layout
			Request attributes
			Viewing HTTP message data in the Inspector
				Automatic decoding
			HTTP/2 headers and pseudo-headers
			Selecting a substring
			Getting started with the Inspector
				Tutorial
					Step 1: Access the lab
					Step 2: Log in to a user account
					Step 3: Use the Inspector to examine the request
					Step 4: Use the Inspector to edit the cookie
					Step 5: Using the selection widget
				Learn more about the Inspector
			Modifying requests
				Adding new items to a request
				Removing items from a request
				Reordering items in a request
				Editing the name or value of an item
				Injecting newlines
				Injecting other non-printing characters
				Copying items from the Inspector
		Message editor
			Message analysis toolbar
				Raw tab
				Pretty tab
				Hex tab
				Render tab
				Additional tabs
				Extension-specific tabs
				Actions menu
			Other ways of using the message editor
			HTTP/2 messages in the message editor
			Context-specific actions
			Text editor
				Syntax analysis
				Pretty printing
				Line-wrapping
				Non-printing characters
				Text editor hotkeys
				Quick search
		Collaborator
			Generating payloads
			Viewing results
			Getting started
				Step 1: Access the lab
				Step 2: Browse the target site
				Step 3: Send an interesting request to Repeater
				Step 4: Inject a Collaborator payload into the request
				Step 5: Poll for interactions
				Summary
				What next?
		Logger
			Getting started with Logger
				Step 1: Access the lab
				Step 2: View requests on the Logger tab
				Step 3: Audit a request with Burp Scanner
				Step 4: Examine the requests made by Burp Scanner
				Step 5: Filter the log
				Step 6: Disable and clear the Logger history
				Learn more about Logger
			Working with Logger entries
				Viewing log entries
				Annotating log entries
				Logger workflow tools
			Settings
				Capture settings
				View settings
			Task Logger
		Sequencer
			Getting started
			Token sample
				Configuring a live capture of tokens
					Selecting a token location
				Manually loading tokens
				Live capture
			Results
				Summary
					Overall result
					Effective entropy
					Reliability
					Sample
				Analysis result tabs
					Individual tests
					Character set
					Bit conversion
				Analysis settings tab
				Tests
					How the tests work
					Character-level tests
						Character count analysis
						Character transition analysis
					Bit-level analysis
						FIPS test results
						FIPS monobit test
						FIPS poker test
						FIPS runs test
						FIPS long runs test
						Spectral tests
						Correlation test
						Compression test
		DOM Invader
			Key features
			Enabling DOM Invader
			Testing for DOM XSS
				Injecting a canary
					Injecting a canary into multiple sources
				Identifying controllable sinks
				Determining the XSS context
				Studying the client-side code
			Testing for DOM XSS using web messages
				Enabling web message interception
				Identifying interesting web messages
				Automated web message analysis
				Message details
					Origin accessed
					Data accessed
					Source accessed
				Replaying web messages
				Generating a proof of concept
			Testing for client-side prototype pollution
				Enabling prototype pollution
				Detecting sources for prototype pollution
				Manually confirming sources for prototype pollution
				Scanning for prototype pollution gadgets
				Generating a proof-of-concept exploit
			Testing for DOM clobbering
				Enabling DOM clobbering
			Settings
				Main
					Enable DOM Invader
					Postmessage interception
					Customizing sources and sinks
				Attack types
					Prototype pollution
					DOM clobbering
				Web message settings
					Postmessage origin spoofing
					Canary injection into intercepted messages
					Filter messages with duplicate values
					Generate automated messages
					Detect cross-domain leaks
				Prototype pollution settings
					Scan for gadgets
					Auto-scale amount of properties per frame
					Scan nested properties
					Query string injection
					Hash injection
					JSON injection
					Verify onload
					Remove CSP header
					Remove X-Frame-Options header
					Scan each technique in separate frame
					Disabling prototype pollution techniques
				Misc
					Message filtering by stack trace
					Auto-fire events
					Redirection prevention
					Add breakpoint before redirect
					Inject canary into all sources
					Configuring callbacks
					Remove Permissions-Policy header
				Canary
					Copying the canary
					Changing the canary
		Clickbandit
			Setting up Burp Clickbandit
			Running an attack
			Reviewing an attack
		Comparer
			Carrying out comparisons
			Controls
			Results
		Decoder
			Carrying out transformations
			Operations
		Engagement tools
			Target analyzer
			Content discovery
				Control tab
				Config tab
					Target
					Filenames
					File extensions
					Discovery engine
				Site map tab
			Generate CSRF PoC
				CSRF PoC options
			Manual testing simulator
		Infiltrator
			How Burp Infiltrator works
			Installing Burp Infiltrator
				Non-interactive installation
			Configuration options
		Organizer
			Organizer table
			Viewing HTTP messages
			Annotating items
			Filtering items
		Search
			Text search
			Find comments and scripts
			Find references
	Tutorials
		Video overviews
		Guided tutorials
		Viewing requests sent by Burp extensions using Logger
			Step 1: Send requests using an extension
			Step 2: Go to the Logger tab
			Step 3: Filter the log
			Step 4: View individual requests
			Summary
		Intercepting HTTP requests and responses
		Resending individual requests with Burp Repeater
		Scanning a website
		Using live tasks in Burp Suite
		Using Burp Suite projects
		Touring the Burp Suite user interface
		Using Burp Proxy's interception rules
		Testing WebSockets with Burp Suite
		Reducing noise
			Setting a basic target scope
			Using filters
		Testing for reflected XSS with Burp Repeater
			Step 1: Find an interesting request
			Step 2: Send the request to Burp Repeater
			Step 3: Search the response for your reflected input
			Step 4: Identify the injection context
			Step 5: Test for flawed input sanitization
			Step 6: Send an XSS proof of concept
			Summary
			Read more
		Using match and replace rules
			Step 1: Open the lab
			Step 2: Attempt to access the admin panel
			Step 3: Add a custom match and replace rule
			Step 4: Try to access the admin panel again
			Summary and next steps
		Using Burp Suite project settings
	Automated scanning
		Launching scans
			Running a full crawl and audit
				Step 1: Configure scan details
				Step 2: Select a scan configuration
				Step 3: Configure application logins (optional)
				Step 4: Select a resource pool (optional)
			Scanning specific HTTP messages
				Configuring the scan
		Setting the scan scope in Burp Suite Professional
			Scan type
			URLs to scan
				Wildcards
				Fragment handling
			Protocol settings
			Advanced scan parameters
			Items to scan
		Configuring scans
			Using a preset scan mode
			Using a custom configuration
				Using a configuration from the library
				Creating a new configuration
				Importing a configuration
			Combining custom scan configurations in Burp Suite Professional
		Adding custom scan checks
			Managing BChecks
			Testing BChecks
			Managing BChecks for a specific scan
			Creating BChecks
			Testing BChecks
				Running a BCheck test
				Managing BCheck test cases
				Configuring test scans
		Configuring application logins
			Adding usernames and passwords
				Adding login credentials
				Editing existing login credentials
				Login functions
			Adding recorded login sequences in Burp Suite Professional
				Adding login sequences
				Editing existing recorded logins
			Managing application logins using the configuration library
		Managing resource pools for scans
			Creating new resource pools
			Reassigning resource pools
		Live tasks
			Types of live task
			Live task scope
			Scan configuration and resource pools
			Creating live tasks
			Task details
			Task execution settings
				Task auto-start
				Resource pools
		Viewing scan results
		Issue activity
			Analyzing the issue activity
		Audit items
			Audit phase indicators
		Reporting scan results
			Report settings
				Report format
				Issue details
				HTTP messages
				Selecting issue types
				Report details
	Project files
		Opening an existing project file
			Pause Automated Tasks
			Trust this project file
		Creating project files
			Opening a project file
		Managing project files
			Saving a copy of a project
				Saving the Burp Collaborator identifier
			Importing project files
			Recovering corrupted project files
	Settings
		User and project settings
		Finding settings
		Managing settings
		Settings pages
		Key settings
			Target scope
			Platform-level authentication
			Session handling rules and macros
			Schedule tasks
			HTTP message appearance
		Tools
			Proxy
				Proxy listeners
					Binding
					Request handling
					Certificate
					TLS Protocols
					HTTP
				Request and response interception rules
					Adding an interception rule
					Modifying intercepted messages
				WebSocket interception rules
				Response modification rules
				Match and replace rules
					Adding a match and replace rule
					Matching multi-line regions
					Using regex groups in back-references and replacement strings
				TLS pass through
					Adding TLS passthrough targets
				Proxy history logging
				Default Proxy interception state
				Miscellaneous
			Repeater
				Connections
				Message modification
				Redirects
					Follow redirects
					Process cookies in redirects
					Use selected protocol for cross-domain redirects
				Default tab group
				Tab view
			Sequencer
				Live capture
				Token handling
				Token analysis
			Intruder
				Automatic payload placement
				New tab configuration
				Behavior when closing result windows
				Payload list location
			Burp's browser
				Browser data
				Browser running
		Project
			Collaborator
			Scope
				Target scope
				Out-of-scope request handling
			Tasks
				Resource pools
				New task auto-start
				Schedule tasks
			Automatic backup
			Logging
		Sessions
			Session handling overview
			Session handling rules
				Session handling tracer
			Cookie jar
			Macros
			Session handling 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
					Make requests to validate session
					Inspect responses to determine session validity
					Define behavior dependent on session validity
				Run a macro to obtain a new valid session
					Prompt for in-browser session recovery
					Run a post-request macro
					Invoke a Burp extension
					Set a specific header value
				Tools scope
				URL scope
				Parameter scope
			Macros
				Record macro
				Configure item
					Parameter handling
					Custom parameter locations in response
				Re-analyze macro
				Test macro
		Network
			Connections
				Platform authentication
				Timeouts
				Upstream proxy servers
				Hostname resolution overrides
				SOCKS proxy
			TLS
				TLS negotiation
				Client TLS certificates
				Server TLS certificates
				Java TLS settings
			HTTP
				Allowed redirect types
				Streaming responses
				Status 100 response handling
				HTTP/1
				HTTP/2
		UI
			Inspector and message editor
				Inspector widgets
				Default Inspector panel layout
				Message editor request and response views
				HTTP message display
				Character sets
				HTML rendering
				HTTP message search
			Hotkeys
			Display
				Appearance
				Learn tab display
				Scaling
		Suite
			REST API
				Enabling the REST API
				Service URL
				API key
			Updates
			Becoming an early adopter
			Performance feedback
				Logging exceptions to a local directory
			Temporary files location
			Startup behavior
				Automated tasks on startup
				Untrusted project files
			Shutdown behavior
				Shutdown confirmation
		Extensions
			Startup behavior
			Java environment
			Python environment
			Ruby environment
		Configuration library
			Adding a custom configuration
			Configuration files
		Response extraction rules
	Customizing Burp's layout
		Arranging top-level tabs
		Hiding top-level tabs
		Restoring the default top-level tab layout
	Mobile testing
		Configuring a mobile device
		Configuring an iOS device to work with Burp Suite Professional
			Step 1: Configure the Burp Proxy listener
			Step 2: Configure your device to use the proxy
			Step 3: Install a CA certificate on your iOS device
			Step 4: Test the configuration
		Configuring an Android device to work with Burp Suite Professional
			Step 1: Configure the Burp Proxy listener
			Step 2: Configure your device to use the proxy
			Step 3: Install a CA certificate on your Android device
			Step 4: Test the configuration
		Troubleshooting for mobile devices
			I can't access HTTPS URLs on iOS even after installing Burp's CA certificate
	HTTP/2
		Background concepts
		Default protocol
		Keeping track of which protocol you're using
		Changing the protocol for a request
		Kettled requests
			What can cause a request to become kettled?
			Unkettling a request
			Kettled requests and extensions
		HTTP/2 settings
			Changing the default protocol
			Repeater options for HTTP/2
		Enforce protocol choice on cross-domain redirections
		Enable HTTP/2 connection reuse
		Strip Connection header over HTTP/2
		Allow HTTP/2 ALPN override
			Disabling HTTP/2 for proxy listeners
		Upcoming enhancements for HTTP/2 in Burp
			Increased support for kettled requests
		HTTP/2 basics for Burp users
			Binary protocol
			Frames
			Message length
			Header capitalization
			Pseudo-headers
		Normalization
			What normalization is performed?
				Why can't I move the Host header?
			Sending requests without any normalization
		Performing HTTP/2-exclusive attacks
			Injecting newlines into headers
	Troubleshooting
		Troubleshooting
		Troubleshooting performance issues
			Check the minimum system requirements
			Identify potential bottlenecks: CPU, memory, and network
			Optimize CPU usage
				Disabling pretty printing
				Disabling JavaScript analysis
				Configuring your scans for performance
				Narrowing the scope of your scans
				Scanning a single protocol
			Optimize memory usage
				Disabling extensions
				Allocating more memory to the Java machine
				Using a disk-based project
			Optimize network usage
				Reducing concurrent scans
				Configuring resource pools
		Event log
		Launch from the command line
			Checking your Java version
			Launching the Burp Suite JAR
			Command line arguments
	External browser configuration
		Check proxy listener is active
		Configuring Chrome to work with Burp Suite - Windows
		Configuring Chrome to work with Burp Suite - MacOS
		Firefox
		Safari
		Check your browser configuration
		Installing Burp's CA certificate
			Installing Burp's CA certificate on a mobile device
			Why do I need to install Burp's CA certificate?
			In-browser interface
			Chrome
				Removing Burp's CA certificate from Firefox
			Chrome
			Installing Burp's CA certificate in Chrome - Windows
				Removing the CA certificate from Windows
			Installing Burp's CA certificate in Chrome - Linux
				Removing the Burp Suite CA certificate
			Installing Burp's CA certificate in Chrome - MacOS
				Removing the Burp Suite CA certificate
			Chrome
				Removing Burp's CA certificate from Safari
			Troubleshooting
				Check that Burp is running
				Check your proxy listener is active
				Try a different port
				What next?
	Dashboard
Enterprise Edition
	Getting started with Burp Suite Enterprise Edition
	Working with sites
	Working with scans
	Working with scan results
	Configuring Burp Suite Enterprise Edition infrastructure
	Managing users and permissions
	Integrating with other tools
	Extending capabilities
	Troubleshooting in Burp Suite Enterprise Edition
	API documentation
	Reference
	Getting started
		Additional information
		Preparing to deploy Burp Suite Enterprise Edition
			Decide on your licensing needs
			Choose your deployment type
			Choose your preferred architecture
			Plan your database setup
			Review the system requirements
			Plan your network and firewall setup
			Prepare your organization
		Deployment options
		Prerequisites for a standard installation
			Port
			TLS certificate
			Installation location
			System user
			Scanning machine requirements
			Database setup script
		Configuring your environment network and firewall settings
			Configuring a single-machine deployment
			Configuring a multi-system deployment
		Installing Burp Suite Enterprise Edition
			Before installation
			Step 1: Download the installer
			Step 2: Extract and run the installer
			Step 3: Choose an install location
			Step 4: Select the components to install
			Step 5: Specify a logs directory
			Step 6: Specify a data directory
			Step 7: Select a user to run processes
			Step 8: Select database options
			Step 9: Specify a web server port
			Step 10: Specify a database backups directory
			After installation
		Configuring the application
			Uploading a TLS certificate
			Configuring database details
			Configuring admin user details
		Activating your license
		What next?
			Complete your network settings
			Add more scanning machines
			Import sites in bulk
			Schedule scans
			Set up your email server
			Add more users
			Set up integrations
			Learn more about working with sites
			Learn more about working with scans
			Learn more about analyzing scan results
		Unattended installation
			Performing an unattended installation with Linux
			Performing an unattended installation with Windows
			Varfile field guide
		Deploying Burp Suite Enterprise Edition to Kubernetes
			Support scope for Kubernetes deployments
				PortSwigger Kubernetes support scope
					Not supported
				Kubernetes customer responsibilities
			Deploying Burp Suite Enterprise Edition from scratch
				Setting up a suitable Kubernetes cluster
					Using the reference template
				Installing the application
					Downloading the Helm chart
					Providing custom values for the Helm chart
						Note for Oracle users
					Adding a TLS certificate
					Configuring the database details
					Using the Helm chart
					Installing using a pre-existing values file
				Creating the admin user
			Migrating from a legacy cloud deployment
				Setting up a suitable Kubernetes cluster
					Using the reference template
				Backing up your data and stopping your old service
					Stopping your scans
					Scaling your environment down
					Creating a new database instance
				Installing the application
					Downloading the Helm chart
					Providing custom values for the Helm chart
					Adding a TLS certificate
					Configuring the database details
					Using the Helm chart
				Activating your license after migration
				Checking the new deployment
					Decommission your old deployment
					Next steps with Kubernetes
			Updating Burp Suite Enterprise Edition on Kubernetes
				Preparing to update
				Running the update command
		Trial deployment guide
			Install
				Activating your license
			Run your first scan
			Analyze scan results
		System requirements
			Concurrent scans
			Standard deployments
				General requirements
				Supported operating systems
				Single-machine deployment
				Multi-machine deployment
			External database
				Supported database versions
				Database hardware requirements
			Kubernetes
				Container system requirements
					Minimum requirements for general container limits
					Minimum requirements for a web server container
					Minimum requirements for an Enterprise server container
					Minimum requirements for a scan container
		Setting up the external DB
			Database setup scripts
				PostgreSQL
				Oracle
				MariaDB / MySQL
				Microsoft SQL Server
			Authentication mode
			Additional configuration for Microsoft SQL Server
			Database connection URL format
			Troubleshooting for MySQL databases
			Distributing the public key manually
	Integrating with CI/CD platforms
		CI-driven scans
		CI-driven scans with no dashboard
		CI/CD plugins (legacy)
		Integrating CI-driven scans
			Configuring your scan
			Viewing your scan results
			Getting started with CI-driven scans
				Before you start
				System requirements
				Running a scan
				Setting the public key certificate
				Scan results
				Remediation advice
				Evidence
			System requirements for CI-driven scans
			Creating a configuration file
				Mandatory settings
				Defining the scope
				Public key certificate
				Authentication
					Login credentials
					Recorded logins
				Scan configuration
					Selecting a built-in scan configuration
					Selecting a custom scan configuration
				Viewing scan results in the dashboard
				Ignoring specific vulnerabilities
				Setting the threshold
			Adding a configuration file
			Integrating with Jenkins
				Before you start
				Jenkins server requirements
				Configuring the Jenkins pipeline
				Setting the configuration of your scan
				Creating the Jenkinsfile
				Viewing scan results in Jenkins
				Remediation advice
				Evidence
			Integrating with TeamCity
				Before you start
				TeamCity agent requirements
				Creating the settings file
				Setting the configuration of your scan
				Configuring the TeamCity pipeline
				Viewing scan results in TeamCity
				Remediation advice
				Evidence
			Integrating with GitHub Actions
		Integrating CI-driven scans with no dashboard
			Getting started with CI-driven scans with no dashboard
				Before you start
				System requirements
				Running a scan
				Scan results
				Remediation advice
				Evidence
			System requirements for CI-driven scans with no dashboard
			Creating a configuration file
				Mandatory settings
				Defining the scope
				Authentication
					Login credentials
					Recorded logins
				Selecting a built-in scan configuration
				Ignoring specific vulnerabilities
				Setting the threshold
			Adding a configuration file
			Integrating with Jenkins
				Before you start
				Jenkins server requirements
				Configuring the Jenkins pipeline
				Setting the configuration of your scan
				Creating the Jenkinsfile
				Viewing scan results in Jenkins
				Remediation advice
				Evidence
			Integrating with TeamCity
				Before you start
				TeamCity agent requirements
				Creating the settings file
				Setting the configuration of your scan
				Configuring the TeamCity pipeline
				Viewing scan results in TeamCity
				Remediation advice
				Evidence
			Integrating with GitHub Actions
		Using plugins for CI/CD platform integration
			Overview of CI/CD platform integration
				Integration types
				Detailed instructions
			Integration types
				Site-driven scan
				Burp scan
			Create an API user
				Create a role and group for CI/CD users
				Create the CI/CD API user
			Jenkins
				Create an API user
				Download and install the plugin
				Configure the integration
				Site-driven scan
					Prerequisites
					Whitelist your Jenkins URL
					Create the site-driven scan build step in Jenkins
					Test your integration
				Burp scan
					Prerequisites
					Create the Burp scan build step in Jenkins
					Test your integration
			TeamCity
				Create an API user
				Download and install the plugin
				Configure the integration
				Site-driven scan
					Prerequisites
					Whitelist your TeamCity URL
					Create the site-driven scan build step in TeamCity
					Test your integration
				Burp scan
					Prerequisites
					Create the Burp scan build step in TeamCity
					Test your integration
			Integrating with other CI/CD platforms
				Site-driven scan
					Prerequisites
					Add the build steps to your pipeline
					Test your integration
				Burp scan
					Prerequisites
					Add the build steps to your pipeline
					Test your integration
				Parameter reference
			Optional settings for the CI/CD integration
				Configuring optional settings using the platform plugins
				Configuring optional settings using the generic CI/CD driver
				Overriding the default scan configurations from your CI/CD system
				Ignoring issues
	Working with sites
		Sites section contents
		Adding new sites
			Optional settings for your new site
				Detailed scope configuration
				Protocol settings
				Scan settings
		Setting the site scope
		Performing a pre-scan check
		Importing sites in bulk
			Preparing the import CSV file
			Uploading the CSV file
		Editing existing sites
		Configuring site settings
			Defining the scan configuration for a site
			Defining the scan configuration for a folder
				How scan configurations are combined
				How preset scan modes are combined
			Configuring authentication
				Configuring site login details
				Configuring platform authentication details
				Adding recorded login sequences
					Adding recorded login sequences to Burp Suite Enterprise Edition
					Reviewing a recorded login sequence
				Configuring platform authentication
				Adding usernames and passwords
			Configuring upstream proxy servers
			Adding headers and cookies
			Setting up scan notifications
				Email notifications
					Setting up email notifications when creating a new site
					Setting up email notifications for existing sites
				Slack notifications
					Setting up Slack notifications when creating a new site
					Setting up Slack notifications for existing sites
		Using preset scan modes
		Managing the site tree
			Creating folders and subfolders
			Adding individual sites to a folder
			Moving sites and folders in bulk
			Deleting sites and folders
	Working with scans
		Creating scans
			Create a new scan
			CI-driven scans
		Viewing scan details
		Monitoring scan progress
			Reviewing scan errors
		Managing scheduled scans
			Viewing scheduled scans
			Editing scheduled scans
			Deleting scheduled scans
			Editing schedule scan configurations
		Performing bulk actions with scans
		Using custom scan configurations
			Assign a custom scan configuration to a site
			Create a custom scan configuration
			Exporting scan configurations
			Importing scan configurations
		Configuring default false positive settings
		Configuring sites and scan data
		Downloading logs and debug packs
			Downloading the event log
			Downloading the scan debug pack
			Downloading the verbose debug pack
	Working with scan results
		Tracking issues over time
			Viewing the dashboard for a site
			Viewing the dashboard for a folder
			Viewing the severity trend
		Viewing issue details
			View details for a specific issue
		Handling false positives
			Mark an issue as a false positive
		Raising tickets
			Raising GitLab issues
				Raising GitLab issues for multiple issues
			Raising Jira tickets
				Unlink Jira tickets
				Raising Jira tickets for multiple issues
			Raising Trello cards
				Raising Trello cards for multiple issues
			Raising tickets for multiple issues
				Linking multiple issues to an existing ticket
				Managing linked tickets
		Downloading reports
			Download a standard report
			Download a compliance report
			Send scan summary reports automatically
			Export issue data
	Configuring the infrastructure
		Architecture overview
			Enterprise server
			Web server
			Database
			Services
			Scans and scanning machines
		Single vs. multi-machine deployment
			Single machine deployment
			Multi-machine deployment
			Requirements
		Configuring your web server
			Enabling TLS
		Configuring an HTTP proxy server
		Managing certificates for outbound connections
		Configuring your SMTP server
			Using an HTTP proxy server to connect to the SMTP server
			Connecting to an external email service
			Connecting to an internal email service
			Verifying your SMTP server connection
		Whitelisting an application for CORS
		Managing scanning resources
			Standard deployments
			Kubernetes deployments
			Scanning machines
				Scanning pools
				CI-driven scans
				Managing scanning pools
					Features of scanning pools
					Create a new scanning pool
					Reassign a scanning machine to a different pool
					Reassign a site to a different pool
				Deploying additional scanning machines
					Setting up a new scanning machine
					Authorizing a new scanning machine
				Assigning scan limits
					Additional scans
			Kubernetes scanning resources
				How does scanning work on Kubernetes?
				Configuring scanning resources
				Managing Kubernetes scan resources
					Setting concurrent scan limits
					Disabling scanning
					Amending your license
					Viewing active scans
		Configuring the database
			Configuring database backups
			Migrating to an external database
				Preparing for the migration
					Prerequisite steps for Oracle databases
					Prerequisite steps for PostgreSQL databases
				Migrating your data
					Running the database transfer command manually
				Restarting the Burp Suite Enterprise Edition services
		Managing Services
			Managing Burp Suite Enterprise Edition services
				List running services
				Stop running services
				Start services
		Managing updates
			Configuring automatic updates
			Manually checking for updates
			Manually installing updates
			Downtime during updates
	Managing users and permissions
		Role-based access control
			Vertical segregation of permissions
			Horizontal segregation of permissions
		Restricting access to sites
		Managing users
			Viewing users
			Creating a new user
			Creating an API user
			Editing users
			Suspending a user temporarily
			Deleting a user
		Managing groups
			Creating a new group
			Editing a group
			Restricting access to sites
			Deleting a group
		Managing roles
			Creating a new role
			Modifying roles
			Deleting roles
		Enabling single sign-on
			Configuring user permissions
				Creating groups for SAML
			LDAP
			Configuring SAML single sign-on for Burp Suite Enterprise Edition
				Configuring SAML SSO with ADFS
					Before you start
					Step 1: Add Burp Suite Enterprise Edition to your trusted applications
					Step 2: Obtain key details from ADFS
					Step 3: Enter the key details in Burp Suite Enterprise Edition
					Step 4: Configure how groups are managed
						Create a central claim issuance policy
					Create claim rules for each group individually
				Configuring SAML SSO with Azure Active Directory
					Before you start
					Step 1: Add Burp Suite Enterprise Edition to your trusted applications
					Step 2: Import key details from Azure AD
					Step 3: Configure group membership
				Configuring SAML SSO with Okta
					Before you start
					Step 1: Add Burp Suite Enterprise Edition to your trusted applications
					Step 2: Obtain key details from Okta
					Step 3: Enter the key details in Burp Suite Enterprise Edition
					Step 4: Configure Okta Group Attribute Statements
				Configuring single logout
		Configuring SCIM
			Okta
				Prerequisites
				Set a port for the SCIM URL and generate an API token
				Upload a TLS certificate
				Configure the connection in Okta
					Enable SCIM provisioning
					Enter the connection details
					Configure the provisioning to app settings
				Push your Okta users and groups to Burp Suite Enterprise Edition
			OneLogin
				Prerequisites
				Set a port for the SCIM URL and generate an API token
				Upload a TLS certificate
				Configure the connection in OneLogin
					Enter the connection details
					Configure the parameters
				Enable SCIM provisioning
				Push your OneLogin users to Burp Suite Enterprise Edition
					Troubleshooting provisioning issues in OneLogin
			Managing SCIM users and groups
				Assigning permissions to SCIM users
				Assigning permissions to SCIM groups
				Removing a SCIM user
		Resetting your admin password
			Resetting your admin password (standard deployments)
				Windows
				Linux
			Resetting your admin password (Kubernetes)
	Integrating with issue tracking platforms
		Integrating with GitLab
			Prerequisites
			(Recommended) Create a new GitLab user for the integration
			Generate a GitLab impersonation token
			Connect Burp Suite Enterprise Edition to GitLab
				Enable GitLab issues to be raised manually
				Enable GitLab issues to be raised automatically
			Raising GitLab issues from within Burp Suite Enterprise Edition
		Integrating with Jira
			Supported versions of Jira
			(Recommended) Create a new Jira user for the integration
			Generate a Jira API token (Jira Cloud only)
			Connect Burp Suite Enterprise Edition to Jira
				Enable manual Jira ticket creation
				Enable automatic Jira ticket creation
			Manually creating Jira tickets
		Integrating with Trello
			Prerequisite
			(Recommended) Create a new Trello user for the integration
			Connect Burp Suite Enterprise Edition to Trello
				Enable manual Trello card creation
				Enable automatic Trello card creation
			Raising Trello cards from within Burp Suite Enterprise Edition
	Troubleshooting
		Downloading logs
		Help center
			Diagnostics
			Debug
			Support pack
			Documentation
	Reference
		Technical infrastructure
		Troubleshooting in Burp Suite Enterprise Edition
		API reference
		User interface
		Home page
			Dashboard
			Issues
		Sites page
			Site filters
			Site actions
		Scans page
			Scans
			Scheduled scans
				Schedule scan configurations
		Scan details
			Failed scans
		Custom scan configuration settings
			Connections
				Platform authentication
				Upstream proxy servers
			Request Throttling
			Embedded Browser
			Burp Collaborator Server
		Site and scan data settings
			Automatic site creation for API-generated scans
				How does Burp Suite Enterprise Edition decide which sites to match?
			Scan deltas
		Issue details
			Advisory tab
			Request and response tabs
			Dynamic analysis
		Reports
			Standard reports
				Included severities
				False positives
			Compliance reports
				Compliance report contents
				Uncategorized issues
				Viewing scan details
			Automatic scan summary reports
		Team page
			Users
			Groups
			Roles
		Settings menu
		User activity log
			Enabling user activity logging
			Downloading the user activity log
		Site-level view
			Dashboard
			Scans
			Scheduled scans
			Issues
			Details
				Site details
				Site scope
				Scan settings
		Folder-level view
			Folder-level dashboard
			Scans
			Scheduled scans
			Issues
			Scan settings
		Browser-powered scans
			How to enable browser-powered scanning for Burp Suite Enterprise Edition
				Enabling browser-powered scanning on Linux machines
		Performing bulk actions in the site tree
			Permissions for bulk actions
	Integrating with other tools
		Integrating with Slack
			Prerequisites
			Create a Slack app
			Add the app to your Slack channels
			Connect your Slack app to Burp Suite Enterprise Edition
			Manage which Slack channels are available
	BApps and custom extensions
		Scanning with extensions
			Applying extensions to a new site
			Applying an extension to an existing site
			Removing an extension from a site
		Extensions
			Extension library
		Adding extensions
			Prerequisite permissions for adding extensions
			Adding a BApp to Burp Suite Enterprise Edition
			Creating a custom extension for Burp Suite Enterprise Edition
			Adding a custom extension to Burp Suite Enterprise Edition
		Managing extensions
			Viewing extension details
			Removing an extension from Burp Suite Enterprise Edition
	API documentation
		API overview
			Using the APIs
		Creating API users
		REST API
		GraphQL API documentation
			GraphQL API
			Getting started with the GraphQL API
				Creating an API user
				Structuring the GraphQL call
				Example request
				Using Insomnia
			GraphQL common tasks
				Query and mutation names
				Retrieving a list of scans
				Retrieving the most recent scan for a site
				Retrieving basic details for a specific scan
				Retrieving a list of scan configurations
				Retrieving basic site tree details
				Retrieving scan issue information
				Retrieving all issues for a scan
				Retrieving detailed information about a specific issue
				Generating a scan remediation report
				Creating a site
				Scheduling a new scan
				Moving a site to a new folder
Dastardly
	Scanning
	Scan length limit
	Results
	Build failures
	Integrating Dastardly with your existing CI/CD platform
	Dastardly system and network requirements
	Troubleshooting Dastardly
	Jenkins
		Jenkins server requirements
		Configuring the Jenkins pipeline
		Creating the Jenkinsfile
		Viewing Dastardly scan results in Jenkins
	GitHub Actions
	TeamCity
		TeamCity agent requirements
		Creating the settings file
		Configuring the TeamCity pipeline
		Viewing Dastardly scan results in TeamCity
	Platform independent
		Dastardly scan results
	FAQs
		Authentication
		Browser sandbox
		Scanning APIs
Scanner
	How do scans work?
	Crawling
		Core approach
		Session handling
		Detecting changes in application state
		Authenticated scanning
		Application login credentials
		Crawling volatile content
		Crawling with Burp's browser
		Viewing crawl paths
	Auditing
		Audit phases
		Issue types found
		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
	Authenticated scanning
		Login credentials
			How does Burp Scanner use login credentials?
			Login settings
		Identifying login and registration forms
			Why is Burp Scanner not filling in my login forms?
		Recorded login sequences
			Using recorded login sequences
		Best practice for recording login sequences
			Limitations of recorded login sequences
				Tips for recording successful login sequences
				Troubleshooting recorded login sequences for Burp Suite Enterprise Edition
		Recording login sequences
			Preparing the Burp Suite Navigation Recorder extension
				Using the extension without incognito mode
			Recording a login sequence
			Adding recorded login sequences to Burp
		Troubleshooting recorded login sequences
	Scan configurations
		Preset scan modes
			Setting preset scan modes for folders
		Custom scan configurations
			Scan configuration structure
			Combining custom configurations
			Setting scan configurations for folders
		Built-in configurations
			Audit checks - all except JavaScript analysis
			Audit checks - all except time-based detection methods
			Audit checks - BChecks only
			Audit checks - critical issues only
			Audit checks - extensions only
			Audit checks - light active
			Audit checks - medium active
			Audit checks - passive
			Audit coverage - maximum
			Audit coverage - thorough
			Crawl and Audit - Balanced
			Crawl and Audit - CICD optimized
			Crawl and Audit - Deep
			Crawl and Audit - Fast
			Crawl and Audit - Lightweight
			Crawl limit - 10 minutes
			Crawl limit - 30 minutes
			Crawl limit - 60 minutes
			Crawl strategy - faster
			Crawl strategy - fastest
			Crawl strategy - more complete
			Crawl strategy - most complete
			Minimize false negatives
			Minimize false positives
			Never stop audit due to application errors
			Never stop crawl due to application errors
		Crawl options
			Crawl optimization
				Crawl strategy
			Crawl limits
			Login functions
			Handling application errors during crawl
			Crawl project option overrides
			Miscellaneous crawl settings
				Burp's browser options
		Audit options
			Audit optimization
			Issues reported
			Handling application errors during audit
			Insertion point types
			Modifying parameter locations
			Ignored insertion points
			Frequently occurring insertion points
			Misc insertion point options
			JavaScript analysis options
			Audit project option overrides
	Browser-powered scanning
		Use cases for browser-powered scanning
	Scanning APIs
		Starting an API scan
		Prerequisites for API definitions
		Deciding what parameters to send in the crawl
		Scannable endpoint definition
		Crawling GraphQL APIs
	Scanning single-page apps
		Configuring scans of SPAs
		Crawl strategy
		Routing fragments
		Non-standard clickable elements
	Burp Scanner error reference
		Burp Scanner errors in Burp Suite Professional
		Burp Scanner errors in Burp Suite Enterprise Edition
	Vulnerabilities list
	BCheck definitions
		BCheck definition reference
			Metadata
			Control flow
			Conditionals
			Actions
			Reserved variables
			Functions
				Combining functions
			Misc
				Strings
				Character escaping
				Regex
				Comments
				Special characters
			BCheck structure
		Worked examples
			In this section
			Example host check
				Step 1: Add metadata
				Step 2: Configure potential paths
				Step 3: Configure the request
				Step 4: Report issues
			Example passive check
				Step 1: Add metadata
				Step 2: Add a string for the check to match
				Step 3: Report the issue
				Test this BCheck
			Example insertion point check
				Step 1: Add metadata
				Step 2: Define the calculation
				Step 3: Send the request
				Step 4: Report issues
			Example Collaborator-based check
				Step 1: Add metadata
				Step 2: Configure the request
				Step 3: Analyze the results
				Test this BCheck
			Example Log4Shell check
				Step 1: Add metadata
				Step 2: Declare variables
				Step 3: Send the request
				Step 4: Send a follow-up request
				Step 5: Report issues
			Example server-side prototype pollution check
				Step 1: Add metadata
				Step 2: Declare variables
				Step 3: Attempt to inject SSPP
				Step 4: Force an error to check for SSPP
				Step 5: Evaluate results and send follow-up request
				Step 6: Do a second check for SSPP
				Step 7: Report issues
				Test this BCheck
Burp Collaborator
	Uses
		External service interaction
		Out-of-band resource load
		Blind SQL injection
		Blind cross-site scripting
	Server
		Private or public server
		Data security
			Data storage
			Data retrieval
			Collaborator-based email addresses
		Deploying a private server
			General setup
			Setting up the domain and DNS records
			Setting up the ports and firewall
			Setting up your server resources
			Setting up the configuration file
			Launching the Collaborator server
			Health check and troubleshooting
			Basic setup
			Configuring your private server
				Configure TLS certificates
				Add a polling interface
				Use CNAME settings
				Truncate interaction messages
				Collect usage metrics
				Log interaction information
				Add custom HTTP content
				Add custom DNS records
			Example configuration file
				Configuration file fields
				Alternative configuration fields:
			Troubleshooting
				Collaborator health check
				Server domain resolution
Contents
Search results