Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/CivicActions/component_creator
A Python Flask app for creating OSCAL compliance components.
https://github.com/CivicActions/component_creator
Last synced: 5 days ago
JSON representation
A Python Flask app for creating OSCAL compliance components.
- Host: GitHub
- URL: https://github.com/CivicActions/component_creator
- Owner: CivicActions
- License: gpl-3.0
- Created: 2022-12-29T23:25:44.000Z (almost 2 years ago)
- Default Branch: develop
- Last Pushed: 2023-05-02T00:17:53.000Z (over 1 year ago)
- Last Synced: 2024-08-01T21:55:20.047Z (3 months ago)
- Language: Python
- Size: 425 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Component Creator
A Python Flask app for creating [OSCAL](https://pages.nist.gov/OSCAL/) compliance components.
## Flask
[Flask](https://flask.palletsprojects.com/en/2.2.x/) is a lightweight Python web application framework using the
[Jinja](https://jinja.palletsprojects.com/en/3.1.x/) templating language and the
[Werkzeug](https://palletsprojects.com/p/werkzeug/) WSGI toolkit and [SQLite](https://www.sqlite.org/index.html).
### Poetry
The application's dependencies and virtual environments are managed using [Python Poetry](https://python-poetry.org/).
### Set up
- Clone the repe
- Change directory into the repo: `cd component_creator`
- Run `poetry install` to install the project dependencies.
- Create a directory named `instance` where the databases will be installed.
- Run the application by running `poetry run flask --app app run`,
### Running test
#### With Poetry
To run tests,
```shell
poetry run python -m pytest
```
To run tests with coverage,
```shell
poetry run coverage run -m pytest && poetry run coverage report -m
```
#### Without Poetry
To run tests,
```shell
python -m pytest
```
To run tests with coverage,
```shell
coverage run -m pytest && coverage report -m
```
## Catalogs
This application is designed to [OSCAL formatted Catalog](https://pages.nist.gov/OSCAL/concepts/layer/control/catalog/)
specific [Components](https://pages.nist.gov/OSCAL/concepts/layer/implementation/component-definition/).
You will need to import at least one Catalog. NIST has several resolved catalogs in their
[Github repository](https://github.com/usnistgov/oscal-content/tree/main/nist.gov/SP800-53) which you can use.
Choose a JSON file from either the **rev5** or **rev4** directory, but make sure to choose a Catalog, not a Profile.
For example ***NIST_SP-800-53_rev5_HIGH-baseline-resolved-profile_catalog.json***. These Catalogs are availble to you
but the system should be able to handle any OSCAL formatted Catalog.
### Importing Catalogs
Once you have a Catalog you can import it into the system by clicking **Catalogs** -> **Add a Catalog** from the main
menu and uploading the file. Once you have uploaded the file you will be redirected to the Catalog details page that
show information about the catalog including a list of Controls.
All Catalogs imported into the system will be listed on the `/catalogs` page available from the main menu.
## Major Contributors
* **Tom Camp** - [Tom-Camp](https://github.com/Tom-Camp)
## License
This project is licensed under the GNU General Public License version 3 or any later version - see the LICENSE file for details. Some portions of this code are dedicated to the public domain under the terms of the Creative Commons Zero v1.0 Universal.
SPDX-License-Identifier: `GPL-3.0-or-later`
## Copyright
Copyright 2019-2021 CivicActions, Inc.