Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update(docs): updated missing technologies supported in docs #5223

Merged
merged 1 commit into from
Apr 21, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 0 additions & 37 deletions docs/cdk.md

This file was deleted.

55 changes: 49 additions & 6 deletions docs/platforms.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,24 +10,67 @@ KICS can decrypt Ansible Vault files on the fly. For that, you need to define th

## Azure Resource Manager

KICS supports scanning Azure Resource Manager (ARM) templates with `.json` extension. To build ARM JSON templates from Bicep code check the [official ARM documentation](https://docs.microsoft.com/en-us/azure/azure-resource-manager/bicep/bicep-cli#build) and [here](https://docs.microsoft.com/en-us/azure/azure-resource-manager/bicep/compare-template-syntax) to understand the differences between ARM JSON templates and Bicep
KICS supports scanning Azure Resource Manager (ARM) templates with `.json` extension. To build ARM JSON templates from Bicep code check the [official ARM documentation](https://docs.microsoft.com/en-us/azure/azure-resource-manager/bicep/bicep-cli#build) and [here](https://docs.microsoft.com/en-us/azure/azure-resource-manager/bicep/compare-template-syntax) to understand the differences between ARM JSON templates and Bicep.

## Buildah
## CDK
[AWS Cloud Development Kit](https://docs.aws.amazon.com/cdk/latest/guide/home.html) is a software development framework for defining cloud infrastructure in code and provisioning it through AWS CloudFormation.

KICS supports scanning Buildah files with `.sh` extension.
It has all the advantages of using [AWS CloudFormation](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

KICS currently support scanning AWS Cloudformation templates. In this guide, we will describe how to scan a simple CDK defined infrastructure following the [Working With the AWS CDK in Go](https://docs.aws.amazon.com/cdk/latest/guide/work-with-cdk-go.html) documentation.

Make sure all [prerequisites](https://docs.aws.amazon.com/cdk/latest/guide/work-with-cdk-go.html#go-prerequisites) are met.

### Create a project

1. Create a new CDK project using the CLI. e.g:

```bash
mkdir test-cdk
cd test-cdk
cdk init app --language go
```

2. Download dependencies

```bash
go mod download
```

3. Synthetize CloudFormation template

```bash
cdk synth > cfn-stack.yaml
```

4. Execute KICS against the template and check the results. Note that KICS will recognized it as CloudFormation (for queries purpose).

```bash
docker run -v $PWD/cfn-stack.yaml:/path/cfn-stack.yaml -it checkmarx/kics:latest scan -p /path/cfn-stack.yaml
```

## CloudFormation

KICS supports scanning CloudFormation templates with `.json` or `.yaml` extension.

## Azure Blueprints

KICS supports scanning Azure Blueprints files, including Azure Blueprints Policy Assignment Artifacts, Azure Blueprints Role Assignment Artifacts, and Azure Blueprints Template Artifacts with `.json` extension.

Note that KICS recognizes this technology as Azure Resource Manager (for queries purpose).

## Docker

KICS supports scanning Docker files named `Dockerfile` or with `.dockerfile` extension.

## DockerCompose
## Docker Compose

KICS supports scanning DockerCompose files with `.yaml` extension.

## gRPC

KICS supports scanning gRPC files with `.proto` extension.

## Helm

KICS supports scanning Helm by rendering charts and running Kubernetes queries against the rendered manifest.
Expand Down Expand Up @@ -61,9 +104,9 @@ KICS supports scanning Swagger 2.0 and OpenAPI 3.0 specs with `.json` and `.yaml

KICS supports scanning Google Deployment Manager files with `.yaml` extension.

## gRPC
## SAM

KICS supports scanning gRPC files with `.proto` extension.
KICS supports AWS Serverless Application Model (AWS SAM) files with `.yaml` extension. Note that KICS recognizes this technology as CloudFormation (for queries purpose).

## Terraform

Expand Down
6 changes: 5 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -50,13 +50,17 @@ nav:
- Bill of Materials: bom.md
- Queries List:
- All: queries/all-queries.md
- Common: queries/common-queries.md
- Ansible: queries/ansible-queries.md
- Azure Resource Manager: queries/azureresourcemanager-queries.md
- CloudFormation: queries/cloudformation-queries.md
- Dockerfile: queries/dockerfile-queries.md
- Docker Compose: queries/dockercompose-queries.md
- Kubernetes: queries/kubernetes-queries.md
- Terraform: queries/terraform-queries.md
- OpenAPI: queries/openapi-queries.md
- Google Deployment Manager: queries/googledeploymentmanager-queries.md
- gRPC: queries/grpc-queries.md
- Terraform: queries/terraform-queries.md
- Integrations:
- Overview: integrations.md
- Azure DevOps: integrations_azurepipelines.md
Expand Down