Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/yadamvinay369/cve_server

Backend code providing APIs for CVE dashboard
https://github.com/yadamvinay369/cve_server

api-rest cors expressjs jest mongoose mvc-pattern nodejs supertest unit-testing

Last synced: about 16 hours ago
JSON representation

Backend code providing APIs for CVE dashboard

Host: GitHub
URL: https://github.com/yadamvinay369/cve_server
Owner: YadamVinay369
Created: 2024-12-17T13:31:45.000Z (about 1 month ago)
Default Branch: main
Last Pushed: 2025-01-10T18:00:41.000Z (10 days ago)
Last Synced: 2025-01-10T18:55:29.467Z (10 days ago)
Topics: api-rest, cors, expressjs, jest, mongoose, mvc-pattern, nodejs, supertest, unit-testing
Language: JavaScript
Homepage: https://securinserver.onrender.com
Size: 560 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# CVE server

This project mainly aims to utilize the CVE data available in National Vulnerability Database, perform data cleansing,data de-duplication and store it in mongoose database and perform daily updates.Provides APIs to fetch, store, and manage CVE (Common Vulnerabilities and Exposures) data.

- API link used: https://services.nvd.nist.gov/rest/json/cves/2.0
- Fetched the CVE data in chunks of around 2000 records per request synchronously
- API request is being hit 3 times per each chunk to establish proper connection
- fetching and auto-update of records will be scheduled automatically daily at 02:00 AM(customizable)
- stored the data using bulkWrite into monogoDB(mongoose) database.

Deployed link: https://securinserver.onrender.com/

## Salient Features

- RESTful APIs to fetch CVE data.
- Pagination support for large datasets.
- Filter data based on parameters
- Get sorted data based on published year or lastModified year
- Customizable results per page.
- Auto-Update of records daily at 02:00 AM using node-cron
- Data storage using MongoDB(mongoose).
- Environment variable support for secure configurations

## Tech Stack

- Node.js - JavaScript runtime.
- Express.js - Web framework for Node.js.
- MongoDB - NoSQL database.
- Mongoose - online version of MongoDB.
- dotenv - Environment variable management.
- Jest - JavaScript testing framework.

## Install Packages and Run the App

- Clone the repository

```bash
git clone https://github.com/YadamVinay369/SecurinServer.git
```

- Install dependencies

```bash
npm install
```

- Create a `.env` file in the root directory.
- Add the following configuration:

```bash
PORT=8000
MONGODB_URI=your_mongodb_connection_string
```

- Run the server

```bash
npm start
```

- Or for development:

```bash
npm run dev
```

- Server will run at: http://localhost:8000

## API Reference

#### Get all CVEs

```http
GET /api/cve
```

![Screenshot of getCVE postman ](./screenshots/getCVE.png)

#### Get all CVEs with page and limit

```http
GET /api/cve?page=1&limit=10
```

![Screenshot of getCVEbyPageAndLimit postman ](./screenshots/getCVEbyPageAndLimit.png)

#### Get CVE based on `id`

```http
GET /api/cve/:id
```

| Parameter | Type | Description |
| :-------- | :------- | :------------------------------- |
| `id` | `string` | **Required**. Id of CVE to fetch |

![Screenshot of getCVEbyID postman ](./screenshots/getCVEbyID.png)

#### Get CVE based on published `year`

```http
GET /api/cve/year/:year
```

![Screenshot of getCVEbyYear postman ](./screenshots/getCVEbyYear.png)

#### Get CVE based on `baseScore`

```http
GET /api/cve/score/:score
```

![Screenshot of getCVEbyBaseScore postman ](./screenshots/getCVEbyBaseScore.png)

#### Get CVE based on `range`

```http
GET /api/cve/lastModified/:range
```

![Screenshot of getCVEbyBaseScore postman ](./screenshots/getCVEbyRange.png)

#### filter CVEs by passing queries in the API

```http
GET /api/cve?page=1&limit=3&score=10&year=1988&days=65
```

![Screenshot of getCVEbyPageAndLimit postman ](./screenshots/filterCVE.png)

## Running Tests

- Install Jest (if not already installed):

```bash
npm install jest --save-dev
```

- Run the tests:

```bash
npm test
```

- Tests are located in the `__tests__` folder, including:

- Unit tests for `getCVEController` logic is present in `__tests__\getCVEController.test.js`.
- Unit tests for `getCVEControllerByID` logic is present in `__tests__\getCVEControllerByID.test.js`.
- Unit tests for `getCVEControllerByYear` logic is present in `__tests__\getCVEControllerByYear.test.js`.
- Unit tests for `getCVEControllerByScore` logic is present in `__tests__\getCVEControllerByScore.test.js`.
- Unit tests for `getCVEControllerByRange` logic is present in `__tests__\getCVEControllerByRange.test.js`.

![Screenshot of unit tests ](./screenshots/unitTests.png)

## Dependencies

- express: Fast and minimal web framework.
- mongoose: MongoDB object modeling.
- dotenv: Load environment variables.
- axios: For external API requests.
- jest: JavaScript testing framework for unit testing.
- supertest: For testing HTTP requests.
- node-cron: For time-scheduling and auto-update in the database