From 6feb32c214d1f494687c8af630124cdcc06c6cad Mon Sep 17 00:00:00 2001 From: PAN-Ziyue Date: Mon, 3 Oct 2022 16:08:53 +0800 Subject: [PATCH] [refactor] v3 --- README.md | 27 +++++++++++++++++++++++++-- 1 file changed, 25 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 48104ea..2a78216 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,11 @@ [![Build](https://github.com/ZJU-SEC/CIAnalyser/actions/workflows/build.yml/badge.svg)](https://github.com/ZJU-SEC/CIAnalyser/actions/workflows/build.yml) + +> `CIAnalyser` is a tool developed for our paper: _Understanding Security Threats in Open Source Software CI/CD Scripts_. It is intended to crawl repositories with OSS CI configured and analyze the meta information. + +For the latest release and the dataset, check [here](https://github.com/ZJU-SEC/CIAnalyser/releases/tag/v3). + ## :gear: Prerequisite - Docker @@ -35,7 +40,25 @@ $ go build CIAnalyser ## :rocket: Run +``` +$ ./CIAnalyser -```bash -$ ./CIAnalyser +These are common stage code used in various situations: + +crawl data: + index-repo crawl repos via GitHub API + clone-repo Git clone the crawled repos + clone-script Git clone the CI scripts + crawl-verified crawl the verified CI scripts + +prepare for analysis: + extract-script extract the CI scripts dependency + categorize-script categorize CI scripts to find + parse-using get runtime environment of each CI script + label-usage count the reference type of the script usage + label-lag calculate reference lag of the script usage + extract-credential extract credential usage in repos + +generate analysis report: + analyze ```