Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
Signed-off-by: Khalid <[email protected]>
  • Loading branch information
Hayyaaf committed Nov 11, 2024
1 parent b61b069 commit ec7dd52
Showing 1 changed file with 5 additions and 22 deletions.
27 changes: 5 additions & 22 deletions wireshark/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,10 @@ image allows Wireshark to analyze network traffic encrypted with post-quantum cr
1. [System Requirements](#system-requirements)
2. [Quick Start Guide](#quick-start-guide)
3. [Project Components](#project-components)
4. [Build Instructions](#build-instructions)
5. [Running Wireshark with OQS](#running-wireshark-with-oqs)
4. [Running Wireshark with OQS](#running-wireshark-with-oqs)
- [Explanation of Docker Options](#explanation-of-docker-options)
6. [Testing Quantum-Safe Protocols](#testing-quantum-safe-protocols)
7. [Build Configuration and Updates](#build-configuration-and-updates)
5. [Testing Quantum-Safe Protocols](#testing-quantum-safe-protocols)
6[Build Configuration and Updates](#build-configuration-and-updates)

## System Requirements

Expand Down Expand Up @@ -40,32 +39,16 @@ typically `:0`.
2. **generate_qsc_header.py**: Downloads and processes algorithm definitions from the OQS provider repository,
generating `qsc.h` to define post-quantum cryptographic algorithms for Wireshark.

## Build Instructions
## Running Wireshark

1. Clone the repository and change into the project directory:
```bash
git clone https://github.com/open-quantum-safe/oqs-demos
cd oqs-demos/wireshark
```
2. Build the Docker image:
```bash
docker build -t wireshark-oqs .
```
You can run the Wireshark Docker container on Linux, Windows, or macOS using the following command:

## Running Wireshark with OQS

- **Linux**:
```bash
docker run --rm -it --net=host -e DISPLAY=<your_host_ip>:<your_display_port> -v /tmp/.X11-unix:/tmp/.X11-unix wireshark-oqs
```
Replace `<your_host_ip>` with your IP address (e.g., `192.168.x.x`) and `<your_display_port>` with your display port,
typically `:0`.

- **Windows/macOS**:
```bash
docker run --rm -it --net=host -e DISPLAY=host.docker.internal:0 -v /tmp/.X11-unix:/tmp/.X11-unix wireshark-oqs
```

### Explanation of Docker Options

- `--net=host`: Shares the host network with the container.
Expand Down

0 comments on commit ec7dd52

Please sign in to comment.