Last updated: January 29, 2024
Read time: 2 Minutes
You can define BChecks yourself, using our custom definition language. This enables you to target your scans and make your testing workflow as efficient as possible.
When you create a BCheck in Burp, you can work from a range of example definitions. Each definition describes a functional BCheck. Edit these to create new BChecks that meet your requirements.
You can share your BChecks and download new ones via the BChecks GitHub repository. This includes example checks created by PortSwigger, as well as BChecks developed by the Burp Suite community.
For information on contributing to the BChecks repository, see the Contributing readme page.
To create a BCheck from an example definition:
- Go to Extensions > BChecks.
- Click New > From template. The New BCheck dialog opens, which contains various example BCheck definitions.
- Select an example BCheck definition, then click Create using this template. The BS Code editor opens.
- Edit the BCheck to meet your requirements.
- Click Validate. Burp identifies any errors in the BCheck.
- Fix any errors in the BCheck.
- To automatically standardize the indentation and whitespace, right-click the editor and select Format BCheck. You can undo the changes with Cmd+Z or Ctrl+Z if you prefer your original layout.
Save the BCheck:
- To save the BCheck and close the BS Code editor, click Save & close. The BCheck is added to the table and enabled by default. Burp Scanner will use it when you perform an audit.
- To save and enable the BCheck without closing the BS Code editor, click Save. You can then test the check with Burp Scanner and make changes directly to the definition.
You can Save & close a BCheck that contains errors. The BCheck is added to the table, but can't be enabled. To enable the BCheck, first fix any errors in the definition.
You can export BChecks so that you can import them into other instances of Burp. To export a BCheck:
- Select the BCheck and click Export .
- If necessary, select a directory. Click Open to see the contents of the directory.
- Enter a filename and click Save.
You can select and export more than one BCheck at a time. If you choose this option, the BChecks are exported with their current name.
- Testing BChecks - For more information on configuring and running BCheck tests.
- BChecks worked examples - For more information on the example definitions included in the BChecks templates.
- BCheck definition reference - For more information on the custom definition language used for BChecks.
- Submitting BChecks to the community - For contributing your BChecks to the PortSwigger BChecks repository on GitHub.
Was this article helpful?
An error occurred, please try again.