Skip to content

Commit 00b3320

Browse files
Whitespotsgitbook-bot
Whitespots
authored andcommitted
GITBOOK-475: No subject
1 parent 64cab15 commit 00b3320

File tree

2 files changed

+34
-0
lines changed

2 files changed

+34
-0
lines changed

.gitbook/assets/image (141).png

72.6 KB
Loading

appsec-portal/scanners/scanner-description/code-scanners/terrascan.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,40 @@ description: >-
66

77
# Terrascan
88

9+
**Auditor Job Name**: Terrascan\
10+
**Auditor image:** registry.gitlab.com/whitespots-public/security-images/terrascan:1.14.0\
11+
**AppSec Portal Importer Name**: Terrascan Scan
12+
913
[Terrascan](https://github.com/tenable/terrascan) ensures that IaC definitions adhere to security best practices and can detect issues that may cause security breaches, data loss, or service disruptions. Terrascan supports several popular IaC frameworks, including **Terraform**, **Kubernetes**, **Helm**, **AWS CloudFormation**, **Azure Resource Manager**, and **Google Cloud Deployment Manager**.
1014

1115
The tool uses a set of **predefined policies** that can be customized to match the organization's specific security and compliance requirements. The policies are based on industry-standard security frameworks such as **NIST**, **CIS**, **PCI-DSS**, and **GDPR**.
16+
17+
#### Curl example
18+
19+
{% code overflow="wrap" %}
20+
```
21+
curl -X POST localhost/api/v1/scan/import/ -H "Authorization: Token a75bb26171cf391671e67b128bfc8ae1c779ff7b" -H "Content-Type: multipart/form-data" -F "file=@./terrascan.json" -F "product_name=Product1" -F "product_type=Application" -F "scanner_name=Terrascan Scan" -F "branch=dev" -F "repository=git@gitlab.com:whitespots-public/appsec-portal.git"
22+
```
23+
{% endcode %}
24+
25+
In this command, the following parameters are used:
26+
27+
1. `-X POST`: specifies the HTTP method to be used (in this case, POST)
28+
2. `-H "Authorization: Token <authorization_token>"`: specifies the [**authorization token**](../../importing-reports-from-scanners-to-appsec-portal/#authorization-token) obtained from AppSec Portal.
29+
3. `-H "Content-Type: multipart/form-data"`: specifies the content type of the request.
30+
4. `-F "file=@<report_file_path>"`: specifies the **path to the report file** generated by the scanner.
31+
5. `-F "product_name=<product_name>"`: specifies the **name of the product** being scanned.
32+
6. `-F "product_type=<product_type>"`: specifies the **type of the product** being scanned.
33+
7. `-F "scanner_name=<scanner_name>"`: specifies the **name of the scanner** used to generate the report (Terrascan Scan)
34+
8. `-F "branch=<branch_name>"`: (_optional_) specifies the name of the branch in the source code repository (if applicable) This parameter is particularly useful when you want to associate the scan results with a specific branch in your repository. If not provided, the scan will be associated with the default branch
35+
36+
Asset information, if an [auditor ](broken-reference)is used
37+
38+
9. `-F "repository=<repository SSH URL>"`: If your product is **code** in a repository enter the address of your **repository** in a specific format, for example: git@gitlab.com:whitespots-public/appsec-portal.git
39+
10. &#x20;\-F "docker\_image=\<registry address>": If your product is **image** enter the address of the **registry** where your product is located, for example: registry.gitlab.com/whitespots-public/appsec-portal/back/auto\_validator:latest
40+
11. \-F "domain=\<domain>": If your product is **web** enter the **domain name** of your product, for example: whitespots.io
41+
12. \-F "host=\<host>": If your product is **web** enter the **IP address** of your product, for example: 0.0.0.0
42+
43+
**Report example:**
44+
45+
<figure><img src="../../../../.gitbook/assets/image (141).png" alt=""><figcaption></figcaption></figure>

0 commit comments

Comments
 (0)