Git Clone

This source component lets Smithy clone a repository from GitHub, GitLab or BitBucket.

How to use

Open-Source

Most SAST based workflows depend on git-clone. For example:

# file ./my-workflow/workflow.yml
description: Workflow scanning with gosec
name: gosec
components:
- component: ghcr.io/smithy-security/smithy/manifests/components/targets/git-clone:v1.3.2
- component: ghcr.io/smithy-security/smithy/manifests/components/scanners/gosec:v1.2.2
- component: ghcr.io/smithy-security/smithy/manifests/components/scanners/nancy:v1.2.1
- component: ghcr.io/smithy-security/smithy/manifests/components/enrichers/custom-annotation:v0.1.1
- component: ghcr.io/smithy-security/smithy/manifests/components/reporters/json-logger:v1.0.1

2. Configure the run parameters of the component in the overrides file

# file: ./my-workflow/overrides.yaml
git-clone:
- name: "repo_url"
  type: "string"
  value: "https://github.com/0c34/govwa.git"
- name: "reference"
  type: "string"
  value: "master"

SaaS

1. In the Smithy UI, open the page to create a new workflow.
2. Find the Git Clone in the Sources dropdown.
3. Set the URL of your repository on the right. If your repository is private, read below.

All other settings are optional.

Cloning a private repository

Github: If you want to clone a private repository you have two choices:

• install the Smithy github application in your repository or organization, then git-clone receives tokens automatically.
• Create a private github token and set it for every repository as shown below https://<pat>@github.com/<your account or organization>/<repo>.git You can generate a PAT token on GitHub via your account settings. Read the precise instructions here. This is insecure as github tokens are longer lived than necessary

Gitlab: If you want to clone a private repository from Gitlab, currently you can only do so via private tokens in the same way as github

Bitbucket: If you want to clone a private repository from Bitbucket, currently you can only do so via private tokens in the same way as github

Options

You can configure this component with the following options. The options that have a default value are optional:

Option Name	Description	Default	Type
[Required] repo_url	Repository URL to clone	N/A	String
[Required] reference	Ref to clone the repository at (branch,tag or commit sha)	"main"	String