Skip to main content

Code Validation

FINOS projects validate their code with tools that are built into GitHub or that are free and open source.

Security baseline​

Every FINOS lifecycle stage requires adherence to a maturity level of the Open Source Project Security Baseline (OSPS Baseline) from the OpenSSF:

StageOSPS Baseline level
LabsMaturity Level 1
IncubatingMaturity Level 2
GraduatedMaturity Level 3

The tools on this page help you meet Baseline controls such as multi-factor authentication and branch protection (OSPS-AC), keeping secrets out of the repository (OSPS-BR-07), private vulnerability reporting (OSPS-VM-03), and automated dependency (SCA) and static analysis (SAST) checks on every change (OSPS-VM-05, OSPS-VM-06). Read the Baseline checklist for the full list of controls at each level.

Security vulnerabilities responsible disclosure​

Read the FINOS security vulnerabilities responsible disclosure document to know how security incidents are managed across FINOS projects. Enable private vulnerability reporting so that people can report vulnerabilities to maintainers privately, and use repository security advisories to publish fixes and request CVEs.

FeatureToolHow to enable
Dependencies
List and track dependenciesGitHub dependency graphOn by default for public repositories
Alert on vulnerable dependenciesDependabot alertsRepository Settings > Advanced Security
Open PRs that fix vulnerable dependenciesDependabot security updatesRepository Settings > Advanced Security
Keep dependencies up to dateDependabot version updatesAdd a .github/dependabot.yml file
Scan dependencies for known vulnerabilities in CIOSV-ScannerAdd the OSV-Scanner GitHub Action
Block PRs that add vulnerable dependencies or disallowed licensesDependency review actionAdd a workflow on pull_request; set allow-licenses to FINOS approved licenses
Code
Scan code for security vulnerabilities and bugsGitHub CodeQL code scanningDefault setup in Settings > Advanced Security
Detect committed secrets and block pushes that contain themSecret scanning and push protectionRepository Settings > Advanced Security
Project security posture
Check repository security practices (branch protection, pinned dependencies, token permissions and more)OpenSSF ScorecardAdd the Scorecard GitHub Action
Self-assess against open source best practicesOpenSSF Best Practices BadgeRegister the project on bestpractices.dev

These features are free for public repositories. Results from CodeQL, OSV-Scanner, and Scorecard are uploaded in SARIF format and appear together in the repository's Security tab, so maintainers can triage them in one place.

OSV-Scanner​

OSV-Scanner checks your lockfiles and manifests against the OSV.dev vulnerability database. The GitHub Action provides two reusable workflows:

  • osv-scanner-reusable-pr.yml runs on pull requests and reports only the vulnerabilities that the pull request introduces.
  • osv-scanner-reusable.yml scans the whole repository on a schedule or on pushes to the default branch.

Docusaurus website dependencies are excluded from OSV scans by default with an osv-scanner.toml file; see Project Documentation.

OpenSSF Scorecard​

OpenSSF Scorecard runs automated checks on a repository's security practices and gives each check a score from 0 to 10. To run it on every push to the default branch, either choose the OSSF Scorecard workflow from Security > Code scanning > Explore workflows, or add .github/workflows/scorecard.yml by following the Scorecard Action instructions. You can then add the Scorecard badge to your README.md.

Continuous validation​

Contributor sign-off​

FINOS software projects use the Developer Certificate of Origin (DCO) by default, enforced on pull requests by the DCO2 GitHub App. Projects that use a Contributor License Agreement instead are checked by EasyCLA. See the contribution compliance requirements for details.