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

The SRTool was developed and tested with:

 * Ubuntu 16.04
 * Django 1.11 LTS 

Later versions of the host or Django should work, but they have not been tested yet.

2) Cloning the SRTool

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

3) Starting the SRTool

Option #1: Restrict to the local browser:

  $ ./bin/srtool start webport=localhost:9000 

Option #2: Enable remote browsers:

  $ ./bin/srtool start webport=0.0.0.0:9000 

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, scored, and loaded into the database. After that, the updates will be incremental.

4) Create a superuser

You will need to create at least one super user account to promote users to higher permission levels:

  $ ./bin/srt manage createsuperuser 

5) Open browser to <IPADDR>:9000

This will bring up the SRTool page.

6) Read the "Guided Tour"

Click on the "Guided Tour" button on the home page to see the on-line tool and user information.

7) Create your guest account

Click on the "Login" button in the top bar, select "Request Account", fill in the information, Click "Sign Up", and then log in.

8) Promote your account to Admin level

Login as the superuser, click "Management > Manage Users", click the edit icon for your guest account row, change the "Group" to "Admin", and click "Submit Changes".

You can now log out of the superuser account and into your own account.

First Time Bring-up

• When you first start, you will have the CVEs from 2015 to 2018
• You will not have any Vulnerabilities, Investigations, or Defects until you (a) create them, and/or (b) integrate your defect system or other sustaining data.
• All CVEs will by default get the status "Historical".
  • The CVEs that were created in the previous 30 days will instead get the status "New"
  • This will allow you to immediately test the CVE triage features
  • The status settings are normally preset by your defect system or other sustaining data
• You can create a Vulnerability by:
  • Selecting a CVE
  • Click on "Create Vulnerability"
  • Follow the new link to the new Vulnerability
• You can create an Investigation by:
  • Open a Vulnerability record
  • Click on "Add Product"
  • Select one or more Products, and click "Submit"
  • Observe that the products are added together with new respective Investigations
  • Follow the new link to the new Investigations

SRTool Primary Goals and Workflows

• Goals
  • A common system to track and share security issues, combining community CVE's
  • A simple yet flexible interface for reporting and exploring the security issues
  • A place to upload and share attachments, including patches, fixes, emails, and documents
  • The ability to generate accurate and up-to-date reports and exports
  • A modular design for easy extension and adoption

• Primary Workflows
  • Guide and manage the incoming CVE triage process
  • Attach CVEs to specific company products and defects
  • Automated updates from upstream CVEs and internal defect system
  • Ability to generate reports
  • Correlate CVEs with products and release
  • Correlate CVEs with specific customer builds

SRTool CVE Lifecycle

• CVE are imported
  • New CVEs are imported and triaged from upstream (NIST/MITRE, 1000+/month)
  • Specific CVEs are requested by customers
• CVEs are managed
  • CVEs are investigated
  • Vulnerable CVEs are assigned to products via defects
  • SRTool manager tracks the progress of open CVEs
  • SRTool manager produces reports as required by customers, field, and management
• CVEs are resolved
  • CVEs are either fixed or declared not vulnerable
  • Releases are updated with the CVE fixes
  • Resolved CVEs are reported to customers, public website

Adapting SRTool to your Organization

1) Out of the box setup (NIST/MITRE)

 (a) When SRTool starts up, it will automatically load the preset data sources.

 (b) NIST and MITRE are examples of preset data sources, by default to import 2015 to 2018.

To extend the coverage for these sources you just need to edit the NIST and MITRE data source JSON files.

2) Instantiate your Organization

 (a) Create a directory under "bin", parallel to the "yp" directory

 (b) Create a "datasource.json" file for the organizations settings

 (c) Define this "srtsetting" in the ""datasource.json" file to make this the default organization (not 'yp')

   {
     "name" : "datasource_org",
     "helptext" : "Bin directory for the ACME Organization",
     "value" : "acme"
   },

 (d) Instantiate the organization's product list, and user list (if any)

 (e) Adapt a copy of the the "bin/yp/srtool_yp.py" to manage the resources

3) Add defect system import

You will implement a defect integration backend script (e.g. "bin/acme/srtool_defect.py") to scan your defect system and instantiate the CVE defects in SRTool database.

 (a) Add the "--init" command

• This is the command that will initialize the SRTool database with your SRT related defects. Specifically, this command can used to bootstrap the SRTool database for you company's data.

• It should create an "Investigation" for each defects, and attach it to the respective product.

• It should create a "Vulnerability" to wrap the "Investigation".

• If should find the respective CVE record, and attach that to the created "Vunerability".

• If a "Vulnerability" record already exists for the defect;s CVE, then this script should attach the new "Investigation" to that "Vulnerability" record.

 (b) Add the "--update" command

• This should scan your CVE related defects

• If the matching defect record in the SRTool database does not exist, then treat it like the "--init" command.

• Update the SRTool defect record with the current defect system state

• If the defect has changed priority (or any other important state information), consider creating a "Notification" event to the respective manager so that they can know that they need to act on the change.

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) Commit your change

NOTE: The format of the commit message should be like this

    srtool: <module> <short one line summary>

    long(er) description

    [YOCTO #0000]

    Signed-off-by: First Last <name@domain.com>

Where YOCTO #0000 is the related bug number if there is one. Signed off by with your git commit -s credentials.

9) Push your feature branch to poky-contrib

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

10) Send to the srtool-mailing list:

We accept patches on the Security mailing list ( yocto-security@yoctoproject.org ) by "git send-email".

e.g.

   $ git send-email HEAD^ 

11) 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].