Salus: Guardian of Code Safety and Security

🔍 Overview

Salus, named after the Roman goddess of protection, is a tool for coordinating the execution of security scanners. You can run Salus on a repository via the Docker daemon and it will determine which scanners are relevant, run them and provide the output. Most scanners are other mature open source projects which we include directly in the container.

# Navigate to the root directory of the project you want to run Salus oncd /path/to/repo
# Run the following line while in the root directory (No edits necessary)
docker run --rm -t -v $(pwd):/home/repo coinbase/salus

Salus is particularly useful for CI/CD pipelines because it becomes a centralized place to coordinate scanning across a large fleet of repositories. Typically, scanners are configured at the repository level for each project. This means that when making org wide changes to how the scanners are run, each repository must be updated. Instead, you can update Salus and all builds will instantly inherit the change.

Salus supports powerful configuration that allows for global defaults and local tweaks. Finally, Salus can report metrics on each repository, such as what packages are included or what concerns exist. These reports can be centrally evaluated in your infrastructure to allow for scalable security tracking.

Using Salus in your Repo

For your given CI, update the config file to run salus. In circle, it will look like this:

docker run --rm -t -v $(pwd):/home/repo coinbase/salus

coinbase/salus pulls the docker image

Supported Scanners

• BundleAudit - Execution of bundle-audit, looks for CVEs in ruby gem dependencies.
• Brakeman - Execution of Brakeman, looks for vulnerable code in Rails projects.
• npm audit - Execution of npm audit which looks for CVEs in node module dependencies.
• yarn audit - Execution of yarn audit which looks for CVEs in node module dependencies.
• PatternSearch - Looks for certain strings in a project that might be dangerous or could require that certain strings be present.

Salus also parses dependency files and reports on what libraries and version are being used in any given project. This can be useful for tracking dependencies across your fleet.The currently supported languages are:

• Ruby
• Node
• Python
• Go

Sometimes it's necessary to whitelist certain CVEs that Salus detects. The docs/scanners directory explains how to do so for each scanner that Salus supports.

If you would like to build customer scanners or support more languages that are not currenclty supported, you can use this method of building custom Salus images.

CircleCI Integration

Salus can be integrated with CircleCI by using a public orb. All Salus configuration options are supported, and defaults are the same as for Salus itself.

Example CircleCI config.yml:

version: 2.1
orbs:
salus: federacy/salus@2.6.2
workflows:
main:
jobs:
- salus/scan

Using Salus in your Repo

For your given CI, update the config file to run salus. In circle, it will look like this:

docker run --rm -t -v $(pwd):/home/repo coinbase/salus

coinbase/salus pulls the docker image

Detailed Documentation

👷‍♂️ Development

Contribution to this project is extremely welcome and it's our sincere hope that the work we've done to this point only serves as a foundation for allowing the security/development communities as a whole to come together to improve the security of everyone's infrastructure.

You can read more about getting your development environment set up, or the architecture of Salus.

📃 License

This project is available open source under the terms of the Apache 2.0 License.