Contribute to SRTool

This page summarizes the Security Response Tool (SRTool) development process. We hope this will help you start contributing to the project. The SRTool is based on the Toaster codebase, so many of the process and debugging techniques apply.

Set up the local repository and SRTool instance

1) Host requirements

The required host package installation instructions are the same as Toaster, and the instructions can be found here: Toaster documentation

2) Cloning the SRTool

  git pull ssh://git@push.yoctoproject.org/srtool && cd srtool 

3) Starting the SRTool

Local browser:

  ./bin/srtool start webport=localhost:9000 

Remote browser:

  ./bin/srtool start webport=0.0.0.0:9000 

4) NOTE: The first time you run the SRTool, there will be a delay (30 to 60 minutes) as the default CVE repositories (NIST, Mitre, ...) are scanned and loaded into the database. After that, the updates will be incremental.

5) Open browser to <IPADDR>:9000

Development Workflow

To contribute to the SRTool you will also need authorization to write to the upstream yocto project repository. Contact a member of the SRTool team for details.

1) Download the master branch of the SRTool

  git pull ssh://git@push.yoctoproject.org/srtool && cd srtool 

2) Add poky-contrib to the local repository you set up above

  git remote add poky-contrib ssh://git@git.yoctoproject.org/poky-contrib 

3) Fetch the poky-contrib branches

  git fetch --all 

4) Start your feature branch off of master, name style of branch is convention, but suggested.

  git checkout -b username/srtool/FeatureOrBug origin/master 

5) Do Work

6) Test the changes.

7) Rebase on master. It has probably changed while you were working (unless you are really really fast!)

  git rebase origin/master 

8) Push your feature branch to poky-contrib

 git push -u poky-contrib username/srtool/FeatureOrBug:username/srtool/FeatureOrBug

9) Send to the srtool-mailing list (TBD) using one of the methods outlined below.

10) NOTE: when the patch has been accepted upstream, you can clean up your poy-contrib branch with:

  git push -u poky-contrib :username/srtool/FeatureOrBug 

Developing the SRTool

Design

(in progress)

Data Sources

(in progress)

Tables and pages

(in progress)

Debugging the SRTool

The same basic techniques for debugging Toaster also apply to the SRTool. See this link for details [1].