Klockwork Docker Service Setup

Enviroment Setup

• install docker on ubuntu 20.04, refer to:https://docs.docker.com/engine/install/ubuntu/
• install docker composer
  sudo curl -L "https://github.com/docker/compose/releases/download/1.24.1/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
sudo chmod +x /usr/local/bin/docker-compose

Deployment

• cd kw-status-monitor/docker-for-klockwork
• ./run.sh

Config

• docker-for-klockwork/cs_ase/settings.py
• docker-compose.yml

REST api

List all projects of USERNAME

• GET /rest/klocwork/apps/USERNAME/
• Return

[
    {
        "id": 1,
        "name": "tpm2-software"
    }
]

List all subproject of project_id

• GET /rest/klocwork/app/project_id/comps/
• Return

[
    {
        "app_id": 1,
        "comp_id": "4",
        "name": "tpm2-tss"
    },
    {
        "app_id": 1,
        "comp_id": "3",
        "name": "tpm2-pytss"
    },
    {
        "app_id": 1,
        "comp_id": "2",
        "name": "tpm2-tools"
    },
    {
        "app_id": 1,
        "comp_id": "1",
        "name": "tpm2-abrmd"
    }
]

List klockwork scan result

• GET /rest/klocwork/app/project_id/comp/subpro_id/prods/
• Return

[
    {
        "app_id": 1,
        "comp_id": 1,
        "prod_id": 2,
        "name": "2",
        "updated_time": "2019-01-01(ww01.2)",
        "issues": "0",
        "critical": "0",
        "error": "0",
        "warning": "0",
        "review": "0"
    },
    {
        "app_id": 1,
        "comp_id": 1,
        "prod_id": 1,
        "name": "1",
        "updated_time": "2019-01-01(ww01.2)",
        "issues": "0",
        "critical": "0",
        "error": "0",
        "warning": "0",
        "review": "0"
    }
]

Insert scan result

• POST /rest/klocwork/submit/USERNAME

{"url":"https://github.com/tpm2-software/tpm2-tss","kw_scan_link":"https://<link-of-scan-result>.html"}

or

{"url":"https://github.com/tpm2-software/tpm2-tss","file":<SELECTED FILE>}

• Return

{"id":0,"op":"create","result":"ok","error":""}