-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
39 additions
and
36 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,31 +1,44 @@ | ||
|
||
# Ready-To-Go Healthcare CI Pipelines | ||
|
||
<p align="center"> | ||
<img src="img/logo.png" alt="Healthcare CI Pipelines" width="200" height="200"> | ||
</p> | ||
|
||
This project is an open-source collection of Continuous Integration (CI) pipelines | ||
designed to streamline the development of secure and compliant healthcare software. | ||
The project provides CI pipeline configurations that enforce current security best | ||
An open-source collection of Continuous Integration (CI) pipelines designed to | ||
streamline the development of secure and compliant healthcare software. | ||
The project comes with CI pipeline configurations that enforce current security best | ||
practices and compliance standards. Our goal is to enable rapid integration, testing, | ||
and delivery of software that meets stringent regulatory requirements while actually | ||
improving the security of the software stack. | ||
|
||
## Salient Features | ||
## Features | ||
|
||
- **Drop-In Pipelines**: Ready-to-use workflows for common healthcare software scenarios. | ||
- **Compliance as Code**: Ensures that every build adheres to predefined regulatory standards. | ||
- **Security Checks**: Integrates security scanning tools to detect vulnerabilities early. | ||
- **Automated Testing**: Supports unit, integration, and end-to-end testing. | ||
- **Documentation Generation**: Automatically generates compliance reports in various formats. | ||
- **Notification System**: Alerts for build status, security vulnerabilities, and compliance deviations. | ||
- **Drop-In Pipelines**: Ready-to-use workflows for standard scenarios. | ||
- **Extended Support**: Support for several CI providers. Yours missing? Open an issue! | ||
- **Compliance as Code**: Build passes? Regulatory standard is met! | ||
- **Artifact Generation**: Generate compliance reports in standard formats. | ||
- **Free**: All pipelines are based on freely available tools up to certain usage thresholds. | ||
|
||
## Integration | ||
## Pipeline Templates | ||
|
||
| Scan / CI | | Github Actions | Gitlab CI | Bitbucket Pipelines | | ||
|--------------|---|--------------------|--------------|---------------------| | ||
| SBOM/SCA | | [GO](https://github.com/forallsecure/healthcare-ci-pipelines/tree/main/pipelines/github/sbom) $\checkmark$ | [GO](https://github.com/forallsecure/healthcare-ci-pipelines/tree/main/pipelines/gitlab/sbom) $\checkmark$ | [GO](https://github.com/forallsecure/healthcare-ci-pipelines/tree/main/pipelines/bitbucket/sbom) $\checkmark$ | | ||
| API Testing | | [GO](https://github.com/forallsecure/healthcare-ci-pipelines/tree/main/pipelines/github/api) $\checkmark$ | [GO](https://github.com/forallsecure/healthcare-ci-pipelines/tree/main/pipelines/gitlab/api) $\checkmark$ | [GO](https://github.com/forallsecure/healthcare-ci-pipelines/tree/main/pipelines/bitbucket/api) $\checkmark$ | | ||
| Fuzz Testing | | [GO](https://github.com/forallsecure/healthcare-ci-pipelines/tree/main/pipelines/github/fuzz) $\checkmark$ | [GO](https://github.com/forallsecure/healthcare-ci-pipelines/tree/main/pipelines/gitlab/fuzz) $\checkmark$ | [GO](https://github.com/forallsecure/healthcare-ci-pipelines/tree/main/pipelines/bitbucket/fuzz) $\checkmark$ | | ||
|
||
## Artifacts | ||
|
||
All pipelines in this repository generate artifacts in standardized formats. | ||
The general architecture for all our integrations is of the form: | ||
|
||
```mermaid | ||
flowchart LR | ||
Package[Software Package] | ||
Scanner[Security Scanner] | ||
Artifact[Artifact] | ||
Package --> Scanner --> Artifact | ||
``` | ||
|
||
All pipelines within this repo implement standalone security checks that pass/fail | ||
and generate reports. The generic integration pattern looks as follows: | ||
All pipelines implement standalone security checks that pass/fail and generate | ||
reports. The generic integration pattern is as follows: | ||
|
||
```mermaid | ||
flowchart TB | ||
|
@@ -50,7 +63,6 @@ flowchart TB | |
``` | ||
|
||
|
||
Integration within your project's CI system may differ depending on the platform and code development flow you use. | ||
|
||
|
||
|
@@ -70,24 +82,12 @@ In this repository we provide example pipelines that cover multiple categories a | |
1. Software Composition Analysis (SCA) - Static scan, known vulnerability testing. | ||
2. API Testing - Dynamic analysis, unknown vulnerability detection, robustness and fuzz testing. | ||
|
||
## Pipeline Templates | ||
|
||
Table of templates: | ||
|
||
| Scan / CI | Github Actions | Bitbucket Pipelines | Gitlab CI | | ||
|-------------|--------------------|---------------------|-----------| | ||
| SCA | :white_check_mark: | :white_check_mark: | | | ||
| API Testing | :white_check_mark: | :white_check_mark: | | | ||
|
||
|
||
## Support | ||
|
||
For support, email `[email protected]` or open an issue in the GitHub repository. | ||
|
||
## Contributing | ||
|
||
We welcome contributions from the community! Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us. | ||
We welcome contributions from the community! Please read | ||
[our contribution guide](https://github.com/forallsecure/healthcare-ci-pipelines/tree/main/CONTRIBUTING.md) and submit pull requests to us. | ||
|
||
## License | ||
|
||
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details. | ||
This project is licensed under the MIT License - see the [LICENSE](https://github.com/forallsecure/healthcare-ci-pipelines/tree/main/LICENSE.md) for details. |