curium-rocks/mitre-siphon

Syncs the mitre CVE JSON dumps to a PostgreSQL DB using Quartz and Kafka and exposes a rest API for running full text searches against the DB.

Mitre-Siphon

Watches the NVD CVE JSON repositories and on updates publishes to a queue. Queue data is processsed and saved into a database for full text searching across a REST Api.

Prerequisites

• docker
• docker-compose

Running the tests

Tests are run using docker-compose.

docker-compose --file docker-compose.test.yml build
docker-compose --file docker-compose.test.yml run sut

Getting Started

Run docker-compose up to launch the application. Once everything has started up you will be able to access the application at http://localost:8080/, a basic swagger ui is included to show the API endpoints.

You can interact with a live version here.

Built With

• Spring Boot
• Gradle
• Quartz
• Kafka
• PostgreSQL
• FlyWay
• Hibernate
• OpenAPI3

Versioning

SemVer is used for versioning. For the versions available, see the tags on this repository.

Todos

• Increase test coverage and cases covered in tests
• Add a UI for searching the data
• Smarter spring active profile switching based on environment
• More documentation on methods to enrich the data available for javadoc task and OpenAPI3
• More validation of input

License

This project is licensed under the MIT License - see the LICENSE.md file for details