Converts CVRF XML documents to CSAF JSON documents
Project description
CVRF-CSAF-Converter
- Introduction
- Getting started
- How to use CVRF-CSAF-converter
- Specifications
- Developing CVRF-CSAF-converter
- Contributing
- Project
Introduction
CVRF-CSAF-converter is a Python tool for converting CSAF CVRF 1.2 documents in CSAF 2.0 documents. It fulfills the conformance target CVRF CSAF converter.
Note: The project is currently still under development. Not all features have been implemented and therefore the conformance goal is not yet fulfilled.
Getting started
Assure that you have Python 3 installed.
Assume your current directory is also avaliable at the environment variable $ROOT_DIR
.
Check out the repository and navigate to the working directory.
git clone https://github.com/csaf-tools/CVRF-CSAF-Converter.git
cd CVRF-CSAF-Converter
Afterwards, create a virtual environment and install the package there:
python3 -m venv venv
. venv/bin/activate
pip install .
Hint: If you would like to get the debugger running, try to install the code as follows: pip install -e .
How to use CVRF-CSAF-converter
Usage as CLI tool
To convert the CVRF CSAF 1.2 document $ROOT_DIR/CVRF-CSAF-Converter/examples/1.2/cvrf_example_a.xml
use the following command:
cvrf2csaf --input-file $ROOT_DIR/CVRF-CSAF-Converter/examples/1.2/cvrf_example_a.xml
The default output directory is ./
, it can be set using --output-dir
.
The output filename is derived from the CSAF field /document/tracking/id
.
If there is an ERROR during conversion, the output file will not be written unless --force
option is used.
The rest of the options can be shown with:
cvrf2csaf -h
Config
To Be Published
Specifications
We follow the official OASIS specifications in order to provide as much acceptance on the user base as possible.
Developing CVRF-CSAF-converter
Developer Guide, Architecture and Technical Design
To Be Published
Security Considerations
Contributing
Please refer to CONTRIBUTING.md
for details about how to contribute to the development of CVRF-CSAF-converter.
Project
CVRF-CSAF-Converter is a project between Deutsche Telekom Security GmbH and the Federal Office for Information Security. It aims to provide a CVRF 1.x to CSAF 2.0 converter.
Realization is taking place 100% Open Source. The final delivery will be in Q1/2022.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.