Hosted Configuration
Hosted Configuration allows you to create, edit, and manage HawkScan configuration files directly within the StackHawk platform. This feature provides an integrated YAML editor with validation and suggestions, making it easier to configure scans. Hosted configurations can be used to run scans directly from anywhere, using the StackHawk command line.
This feature is currently available in closed beta. Please contact product@stackhawk.com if you are interested in helping us test it before release!
Overview
The Hosted Configuration feature streamlines the process of setting up HawkScan configurations by enabling users to manage their configuration files within the platform itself. Key benefits include:
- Centralized Configuration Management: Create and edit scan configurations in a centralized location, reducing the need for local config file management.
- Integrated Editor: The built-in editor supports validation and provides suggestions based on the HawkScan schema, helping avoid configuration errors.
- Easy Scan Setup: Use hosted configuration files directly with HawkScan to run scans from anywhere, with a simple syntax.
Managing Hosted Configurations
To access the Hosted Configuration feature, navigate to Settings -> Org Settings -> Configurations
within the StackHawk platform. From this screen, you can create new configurations, edit existing ones, or delete configurations you no longer need.
Creating a New Configuration
- Click the “Add New” button.
- Provide a name for the configuration file.
- Use the integrated YAML editor to add the desired HawkScan configuration settings.
Once created, the configuration will appear in the list of hosted configurations, and can be used in scan commands.
The Configuration Editor
The integrated editor is designed to make configuration editing straightforward and error-free:
- Schema Validation: The editor validates your configuration against the HawkScan schema, ensuring all required fields are present and correctly formatted.
- Autocomplete and Suggestions: As you type, the editor provides suggestions for configuration options and values, helping you build a valid configuration more quickly.
Using Hosted Configuration Files with HawkScan
To run a scan using a hosted configuration file, use the following syntax from the command line:
$ hawk scan hawk://config-file-name
Replace config-file-name
with the name of the hosted configuration you created. This command will use the specified configuration for the scan, making it easy to initiate scans from any environment without needing a local configuration file.
Renaming and Deleting Configurations
You can rename or delete a hosted configuration via the context menu in the management screen:
- Click the three-dot menu next to the configuration you want to modify.
- Select “Rename” to change the configuration name or “Delete” to remove it.