Skip to content

Latest commit

 

History

History
131 lines (92 loc) · 5.83 KB

README.md

File metadata and controls

131 lines (92 loc) · 5.83 KB

UPDATE

I recently presented this tool at blackhat hacksmith in Vietnam and got some good feedbacks from the judges. My slide for this tool can be found here .

Unfortunately I am working fulltime + 2 kids and don't have much time to invest into this project so if you like the idea of giving risk score for dependencies and want to write more parsers for other languages, improve existing ones or support other type of code management api (gitlab, bitbucket), enrich the scoring logic - please feel free to make pull request or just build ontop of this tool.

Dependency Risk Analysis Tool - DRAT - TLDR

DRAT aims to provide risk indicator for libraries used by the developer for a given project.

DRAT will help you answer questions like which dependencies has not been updated for more than a year?, which dependencies has low reputation?, which dependencies are being managed by single individual? ...

These answers can then be used to help you making the decision of what your local artifactory should cache or you could build some logic to scan and add high risk dependencies to a watchlist that you would monitor for new update. This way, you can catch any sign of compromised dependencies before the code make it to your system.

Below is what the result looks like after running against a python project. Note that these are just potential risks associate with these dependencies being identified and not actually vulnerabilities.

drat-cli gui image

Try it out yourself:

Open cmd/drat-cli/static/index.html in chrome and drag cmd/drat-cli/static/example.json into the site.

Known issues:

  • Duplicate results
  • No caching for previous results
  • Difficult to map relationships between result entries
  • Rate limiting force the use of git personal token

DRAT-cli

The app can be found under cmd/drat-cli.

To run the app, you will need a github auth token to overcome the rate limit for github api. This token can be generated here. Unless you need private repository access for your project, a token without any permission should work fine.

To check out how it works, you can try running it with the following commands

To get a report for a single repository:

export GITHUB_AUTH_TOKEN={YOURGITHUBTOKEN GOES HERE}
cd cmd/drat-cli
go run main.go -d 2 -v -r "https://github.com/AusDTO/dto-digitalmarketplace-supplier-frontend" -o output.json

To get a report for a list of repository:

cd cmd/drat-cli
go run main.go -d 5 -v -f examplelist.lst -o output.json

Below is an example of the app's output. You can then open cmd/drat-cli/static/index.html in a browser and drag&drop output.json into the site to visualise the output and navigate around.

[
    {
        "Ownername": "santrancisco",
        "Name": "cque",
        "URL": "https://api.github.com/repos/santrancisco/cque",
        "Dependencies": null,
        "RiskNotes": [
            "[INFO] Repository is not managed under an organisation",
            "[MEDIUM] Size of collaborator for the repository is 1 which is less than 3",
            "[MEDIUM] Repository has only been created for less than 30 days",
            "[GOOD] Repository has a wiki"
        ]
    },
    {
        "Ownername": "google",
        "Name": "go-github",
        "URL": "https://api.github.com/repos/google/go-github",
        "Dependencies": null,
        "RiskNotes": [
            "[MEDIUM] Repository has only been created for less than 30 days",
            "[GOOD] Repository has been forked 100 times",
            "[GOOD] Repository has been stared 3762 times",
            "[GOOD] Repository is being watched by 3762 people"
        ]
    },
    {
        "Ownername": "beorn7",
        "Name": "perks",
        "URL": "https://api.github.com/repos/beorn7/perks",
        "Dependencies": null,
        "RiskNotes": [
            "[INFO] Repository is not managed under an organisation",
            "[MEDIUM] Repository has only been created for less than 30 days",
            "[GOOD] Repository has a wiki"
        ]
    }
]

This app currently support 3 types of crawler plugins for github projects: NPM, go-dep, pip and ruby-gem

DRAT Webapp (drat-web)

Development for this app is currently on hold in favour of the drat-cli tool.

This tool's application design with multiple worker nodes (eg containers/lambda functions) using postgresql as job queue (leveraging ACID property of postgresql and i wanted to learn advisory lock). It was inspired by the certificate transparency work done by Adam Eijdenberg from Cloud.gov.au team. You can find the repository for that here

Running locally in docker with latest code

Start postgresql server for job queue and storing result

docker run -p 5432:5432 --name dratpg -e POSTGRES_USER=dratpg -e POSTGRES_PASSWORD=dratpg -d postgres
export VCAP_SERVICES='{"postgres": [{"credentials": {"username": "certpg", "host": "localhost", "password": "certpg", "name": "certpg", "port": 5434}, "tags": ["postgres"]}]}'

Run the lastest code. (*fingers crosses* here)

GOOS=linux GOARCH=amd64 go build -o bin/drat cmd/drat-web/main.go
docker-compose up

To checkout database manually:

psql "dbname=dratpg host=localhost user=dratpg password=dratpg port=5432"

History of DRAT

DRAT was a project i wrote as a proof of concept while working for a government gig. The project was approved to be opensourced under MIT license and since i left the organisation, I will, hopefully, continue to work on this side project when I have more time. Any contribution is welcomed and feel free to take the idea, concept or the code to make even better security products. :)