Commit 1b961050 authored by Thomas Boni's avatar Thomas Boni
Browse files

Merge branch '11-trivy_job' into 'latest' 

Resolve "Trivy_job"

Closes #11

See merge request go2scale/hub!2
parents 894fe478 f6595345

Jobs/mkdocs/mkdocs.yml

+1 −1
Original line number Diff line number Diff line 
# Job from g2s hub. See https://go2scale.gitlab.io/hub/ for more informations

# Job from go2scale hub --> hub.go2scale.io



documentation:

  image:

Jobs/trivy/trivy.yml

0 → 100644
+76 −0
Original line number Diff line number Diff line 
# Job from go2scale hub --> hub.go2scale.io



# Run trivy on any commit

trivy:

  stage: dynamic_tests

  image: docker:19.03

  services:

    - name: docker:19.03-dind

      entrypoint: ["env", "-u", "DOCKER_HOST"]

      command: ["dockerd-entrypoint.sh"]



  variables:



    IMAGE: $CI_REGISTRY_IMAGE:$CI_COMMIT_SHA

    TRIVY_SEVERITY: "LOW,MEDIUM,HIGH,CRITICAL"

    TRIVY_EXIT_CODE: 0

    TRIVY_VULN_TYPE: "os,library"

    TRIVY_NO_PROGRESS: "false"

    TRIVY_OUTPUT: "junit-report.xml"

    TRIVY_IGNOREFILE: .trivyignore

    TRIVY_CACHE_DIR: .trivycache/

    TRIVY_FORMAT: "template"

    TEMPLATE_NAME: "junit.tpl"

    TRIVY_CLEAR_CACHE: "false"

    TRIVY_IGNORE_UNFIXED: "false"

    TRIVY_DEBUG: "false"





    DOCKER_HOST: tcp://docker:2375

    DOCKER_DRIVER: overlay2

    DOCKER_TLS_CERTDIR: ""

    TRIVY_VERSION: "0.9.2"

    TRIVY_REMOTE: ""

    TRIVY_TIMEOUT: ""

    TRIVY_LIGHT: "false"

    TRIVY_DOWNLOAD_DB_ONLY: "false"

    TRIVY_TOKEN: ""

    TRIVY_QUIET: "false"

    TRIVY_SKIP_UPDATE: "false"





  before_script:

    - apk add --no-cache curl

    - wget https://github.com/aquasecurity/trivy/releases/download/v${TRIVY_VERSION}/trivy_${TRIVY_VERSION}_Linux-64bit.tar.gz

    - tar zxvf trivy_${TRIVY_VERSION}_Linux-64bit.tar.gz

    - curl -sSL -o $TEMPLATE_NAME https://github.com/aquasecurity/trivy/raw/v${TRIVY_VERSION}/contrib/junit.tpl



  script:

    - docker info

    - docker login -u gitlab-ci-token -p $CI_JOB_TOKEN $CI_REGISTRY

    - docker build -t $IMAGE .

    - docker push $IMAGE



    - ./trivy --template "@$TEMPLATE_NAME" -o $TRIVY_OUTPUT $IMAGE



  cache:

    paths:

      - "$TRIVY_CACHE_DIR"



  artifacts:

    reports:

      junit: "$TRIVY_OUTPUT"

    expire_in: 30 days

    when: always

  dependencies: []



  rules:

    - if: "$CI_COMMIT_BRANCH"



# Run trivy on tag commit

trivy_tag:

  extends: trivy

  variables:

    IMAGE: $CI_REGISTRY_IMAGE:$CI_COMMIT_TAG

  rules:

    - if: "$CI_COMMIT_TAG"

docs/Jobs/trivy/README.md

0 → 100644
+120 −0
Original line number Diff line number Diff line 
# 🛡️ Trivy



## Description



[Trivy](https://github.com/aquasecurity/trivy) is a Simple and Comprehensive Vulnerability Scanner for Containers and other Artifacts, Suitable for CI



##### By default, this job



 - Is avaible for any edition of GitLab



 - Is 100% autonom - you don't have any updates or config to do, but obviously you can change the values of the variables or configure your own script



 - Analysis with [Trivy](https://github.com/aquasecurity/trivy) the GitLab's repo (image or/and filesystem) at every commit to detect vulnerabilities



 - Displays a report in pipeline window and merge request (junit.xml format)





## How to use it



 1. Please check supported OS and packages (see list below)

 2. Please check variables config (see list below)

 3. Add the corresponding url to your `.gitlab-ci.yml` file



    ```yaml

    include:

      - remote: 'https://jobs.go2scale.io/trivy'

    ```



4. Well done, it's finished ! 😀





### Variables Description





#### Main Variables



| VARIABLE NAME | DESCRIPTION | DEFAULT VALUE |

| ------------- | ----------- | ------------- |

| `IMAGE` | Target name or target path | `$CI_REGISTRY_IMAGE:$CI_COMMIT_SHA` or `$CI_REGISTRY_IMAGE:$CI_COMMIT_TAG` if the pipeline is run following a tag creation |

| `TRIVY_VERSION` | Version of trivy to use. Releases version are available [here](https://github.com/aquasecurity/trivy/releases) | `0.9.2` |

| `TRIVY_SEVERITY` | Severities of vulnerabilities to be displayed | UNKNOWN,LOW,MEDIUM,HIGH,CRITICAL |

| `TRIVY_EXIT_CODE` | Exit code when vulnerabilities were found | 0 |

| `TRIVY_VULN_TYPE` | List of vulnerability types | os,library |

| `TRIVY_OUTPUT` | Output file name | junit-report.xml |

| `TRIVY_IGNOREFILE` | Specify .trivyignore file | .trivyignore |

| `TRIVY_CACHE_DIR` | cache directory | .trivycache/

| `TRIVY_FORMAT` | Format (table, json, template) | template |

| `TEMPLATE_NAME` | Name of used template | junit.tpl |

| `TRIVY_CLEAR_CACHE` | Clear image caches without scanning | false |





#### Secondary Variables



| VARIABLE NAME | DESCRIPTION | DEFAULT VALUE |

| ------------- | ----------- | ------------- |

| `TRIVY_IGNORE_UNFIXED` | Display only fixed vulnerabilities | false |

| `TRIVY_DEBUG` | Debug mode | false |

| `DOCKER_HOST` | Daemon socket to connect to | tcp://docker:2375 |

| `TRIVY_TIMEOUT` | Docker timeout | 2m0s |

| `TRIVY_LIGHT` | Trivy faster without descriptions and refs | false |

| `TRIVY_DOWNLOAD_DB_ONLY` | Download vulnerability database without scan | false |

| `TRIVY_NO_PROGRESS` | Suppress progress bar | false |

| `TRIVY_QUIET` | Suppress progress bar and log output | false |

| `TRIVY_SKIP_UPDATE` | Skip vulnerability database update | false |

| `TRIVY_REMOVED_PKGS` | Detect vulns of Alpine removed packages | false |





### Reports



By default we use [Junit](https://junit.org/junit5/)'s xml report



1. When you launch this Trivy job, a `junit.tpl` file is downloaded from [Trivy](https://github.com/aquasecurity/trivy)'s repo in current directory

2. This template is used to display report in pipeline window and merge request



##### Default reporting config



```yaml

  artifacts:

    reports:

      junit: junit-report.xml

    expire_in: 30 days

    when: always

```





### OS Packages Vulnerabilities Detection



| OS Packages                  | Supported Versions                       | Target Packages               | Detection of unfixed vulnerabilities |

| ---------------------------- | ---------------------------------------- | ----------------------------- | :----------------------------------: |

| `Alpine Linux`                | 2.2 - 2.7, 3.0 - 3.12                    |   apk                         |                  NO                  |

| `Red Hat Universal Base Image` | 7, 8                                     |   yum/rpm                     |                 YES                  |

| `Red Hat Enterprise Linux`     | 6, 7, 8                                  |   yum/rpm                     |                 YES                  |

| `CentOS`                       | 6, 7                                     |   yum/rpm                     |                 YES                  |

| `Oracle Linux`                 | 5, 6, 7, 8                               |   yum/rpm                     |                  NO                  |

| `Amazon Linux`                 | 1, 2                                     |   yum/rpm                     |                  NO                  |

| `openSUSE Leap`                | 42, 15                                   |   zypper/rpm                  |                  NO                  |

| `SUSE Enterprise Linux`       | 11, 12, 15                               |   zypper/rpm                  |                  NO                  |

| `Photon OS`                    | 1.0, 2.0, 3.0                            |   tdnf/yum/rpm                |                  NO                  |

| `Debian GNU/Linux`             | wheezy, jessie, stretch, buster          |   apt/apt-get/dpkg            |                 YES                  |

| `Ubuntu`                       | 12.04, 14.04, 16.04, 18.04, 18.10, 19.04 |   apt/apt-get/dpkg            |                 YES                  |

| `Distroless`                   | Any                                      |   apt/apt-get/dpkg            |                 YES                  |





### Application Dependencies Vulnerabilities Detection



| Application Dependencies |

|--------------------------|

| `Bundler`                  |

| `Composer`                 |

| `Pipenv`                   |

| `Poetry`                   |

| `npm`                      |

| `yarn`                     |

| `Cargo`                    |





## Version



* **Latest** : `https://jobs.go2scale.io/trivy/latest`

* **Tag `2020-07-22_1`** (initial version) : `https://jobs.go2scale.io/trivy/2020-07-22_1`