tenable/terrascan-rego-editor

Visual Studio Code extension for writing Terrascan Rego policies

Terrascan Rego Editor

Create and test Rego policies for Terrascan in Visual Studio Code.

Features

• Generates standardized JSON configuration used as input to Terrascan's policy engine.
• Generates a pre-populated Rego template using parameters from resources in your IaC files as input.
• Tests Rego policies against IaC files.
• Ability to sync policies with Tenable.cs.

Getting Started

Follow these steps to get started:

1. Install the extension from the VS code marketplace
2. Open an IaC template on VS Code.
3. Highlight an IaC resource, right-click, and select RegoEditor: Generate Config.
4. Select the IaC engine this template uses (e.g. terraform, cft, k8s, etc.). This generates a normalized JSON file including the highlighted resource and its parameters.
5. Right-click the normalized JSON file and select RegoEditor: Generate Rego. This creates a rule JSON and a Rego file.
6. Update relevant fields on the Rule JSON file according to your policy.
7. Update the Rego file to enforce your policy.
8. Right-click the Rego file and click on RegoEditor: Scan to test your policy.

This extension supports multiple configuration options. To view the settings, open the command palette (Ctrl + Shift + P for Windows or CMD + Shift + P on Mac OS) and search for RegoEditor: Configuration.

From the configuration menu you should be able to customize:

• The counter suffixed to policies
• The default cloud provider
• Whether to show the helper text on newly created Rego files
• Credentials for syncing policies with Tenable.cs

Contributing

Contributions are always welcome in the form of documentation, blogs, issues, and pull requests. More details on CONTRIBUTING.md.

terrascan-rego-editor's Issues

add capabilities to compare existing policies(terrascan) with custom policies !

to avoid policy duplication & scanning results !

add web extension support for vscode

Visual Studio Code for the Web (including vscode.dev and github.dev) as well as on the desktop and in services like GitHub Codespaces. currently Terrascan extension don't support for VSCode for web

https://code.visualstudio.com/api/extension-guides/web-extensions

Implement `Generate Config` command

Generate config would deduce the iac type of the file by reading/parsing the contents of the file and generate the standardised json.

The command should also have a keyboard shortcut and should be visible in the context menu for appropriate files.

After the command execution completes without any error, the standardised json file should be opened in a new window.

Implement `Generate Rego` command

The Generate Rego command will read the standardised json and generate rego and its metadata file.

The command should have a keyboard shortcut and should be displayed in the context menu for appropriate files.

After the command execution completes without any error, the metadata and rego files should be opened in a new window.

Support installing terrascan as a docker container

rego editor generateConfig cmd not working on windows

Steps to reproduce:

1. Create terraform file for any resource
2. Right click on terraform file in vscode
3. Click on RegoEditor: Generate Config
4. Follow the prompts to select iac type and cloud provider

Expected Output
Extension generates a config json file

Actual Output
Config file was not generated

No errors are generated in the logs