https://github.com/ossf/scorecard-visualizer

Tool for visualizing the Open SSF Scorecard Api data in a human friendly way
https://github.com/ossf/scorecard-visualizer

openssf openssf-scorecard

Last synced: 1 day ago
JSON representation

Tool for visualizing the Open SSF Scorecard Api data in a human friendly way

• Host: GitHub
• URL: https://github.com/ossf/scorecard-visualizer
• Owner: ossf
• License: apache-2.0
• Created: 2023-04-14T13:00:48.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-08-20T07:39:41.000Z (3 months ago)
• Last Synced: 2024-08-20T10:29:17.015Z (3 months ago)
• Topics: openssf, openssf-scorecard
• Language: TypeScript
• Homepage: https://ossf.github.io/scorecard-visualizer/#/projects/github.com/ossf/scorecard-visualizer
• Size: 42.2 MB
• Stars: 11
• Watchers: 3
• Forks: 2
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# OSSF Scorecard Visualizer

The OpenSSF Scorecard Monitor Visualizer is a tool that provides a visual representation of the OpenSSF Scorecard data for monitoring the security status of open source projects. It fetches the scorecard data from the [OpenSSF Scorecard API](https://api.securityscorecards.dev/#/results) and presents it in a user-friendly and interactive visual format.

The Visualizer is part of the [OpenSSF Scorecard Monitor](https://github.com/UlisesGascon/openssf-scorecard-monitor), where you can access to the features.

## Features

### Scorecard Data Visualizer

Display the OpenSSF Scorecard data in a visual format for easy understanding and analysis.




    


        

    


### Scorecard Data Comparator

Compare between two commits that reported Scorecard data. See how the scores changed and further details.




    


        

    


### Scorecard Data Comparator Diff

Makes easier the visualization of the differences in the Scorecard comparator reasoning and details.




    


        

    

        


        

    


### Support to GitLab repositories

The project provides support of visualization and diff comparation for GitLab projects. In the GitLab version, deps.dev and step security links are not included, as those platforms don't support GitLab projects yet.




    


        

    


### Discrepancies management

The Scorecard API can provide discrepancies in the data while comparing between two commits due [technical reasons](https://github.com/ossf/scorecard/issues/3438). The visualizer provides a way to showcase the discrepancies found.




    


        

    


## How to use it

The Visualizer and the Comparator can be used outside the Monitor.

You have 3 options of visualization. Depending on which one you want to check, you should craft your own url as:

- Checks the latest Scorecard data available for a project: `https://ossf.github.io/scorecard-visualizer/#/projects/${platform}/${org}/${repo}`

- Checks the Scorecard data for an specific commit (previously reported): `https://ossf.github.io/scorecard-visualizer/#/projects/${platform}/${org}/${repo}/commit/{commitHash}`

- Compares two specific commits, previously reported: `https://ossf.github.io/scorecard-visualizer/#/projects/github.com/nodejs/node/compare/{prevCommitHash}/{currentCommitHash}`

> 👉 Please note that in order to retrieve data from the Scorecard API, it is necessary for organizations or repository owners to report their commits to the Scorecard. However, it's important to keep in mind that not all organizations report their commits, which may result in a `404 error` if the data is not available in the API. Please be aware that this behavior is expected and not indicative of a bug.

### Examples

- [Nodejs latest repository Scorecard](https://ossf.github.io/scorecard-visualizer/#/projects/github.com/nodejs/node)

- [Nodejs specific commit Scorecard](https://ossf.github.io/scorecard-visualizer/#/projects/github.com/nodejs/node/commit/da80964a3d708ef3ae42d4424034f155ad37e07d)

- [Nodejs reported commits comparation](https://ossf.github.io/scorecard-visualizer/#/projects/github.com/nodejs/node/compare/2ac5e9889aba461f5a54d320973d2574980d206b/da80964a3d708ef3ae42d4424034f155ad37e07d)

## Contributing

Contributions are welcome! If you would like to contribute to the OpenSSF Scorecard Monitor Visualizer project, please follow these steps:

1. Fork the repository.

2. Create a new branch for your feature or bug fix.

3. Make your changes and ensure that the code is properly formatted.

4. Write tests to cover your changes if applicable.

5. Commit your changes and push them to your forked repository.

6. Submit a pull request to the main repository, explaining your changes and providing any relevant details.

## License

This project is licensed under the [Apache License Version 2.0](LICENSE).

## Support

If you encounter any issues or have questions about the OpenSSF Scorecard Monitor Visualizer, please [open an issue](https://github.com/ossf/scorecard-visualizer/issues/new) on the GitHub repository.