https://github.com/jim3/wireshark-upload-app

Upload your Wireshark JSON packets
https://github.com/jim3/wireshark-upload-app

fastapi json python rest-api wireshark

Last synced: 11 days ago
JSON representation

Upload your Wireshark JSON packets

• Host: GitHub
• URL: https://github.com/jim3/wireshark-upload-app
• Owner: jim3
• Created: 2023-07-29T01:34:20.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-07-12T00:14:03.000Z (6 months ago)
• Last Synced: 2024-07-12T02:05:39.473Z (6 months ago)
• Topics: fastapi, json, python, rest-api, wireshark
• Language: Python
• Homepage:
• Size: 64.5 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
### Wireshark Uploader App

Uses the FastAPI framework that allows users to upload their exported Wireshark files (in JSON format) to a MongoDB Atlas database. After each upload, the `packets` endpoint returns an extracted version of the results to the client. 

The `packets.py` file is to be customized to whatever protocol you want to analyze, the choices seem to be endless...

The app uses the PyMongo library to connect to MongoDB Atlas.

Uses Python's Poetry package manager to manage dependencies.

## Requirements

-   Poetry

-   MongoDB Atlas account (and connection string)

-   Wireshark JSON file

-   MongoDB Atlas db/collection names (these are to be created in the MongoDB Atlas dashboard)

## Installation

1. Clone the repository

2. Install Poetry

3. Run `poetry install` to install dependencies from the `pyproject.toml` file

4. Run `poetry shell` to activate the virtual environment

5. Run `uvicorn app:app --reload` to start the server

## Usage

1. Open a browser and navigate to `http://127.0.0.1:8000/`

2. Upload a Wireshark JSON file

3. After the upload is complete, you'll be redirected to the `packets` endpoint, which will display the extracted results from the uploaded file.

4. To view the results in MongoDB Atlas, you can use MongoDB Compass (my favorite way to do it) or the MongoDB Atlas dashboard.