From d7db9b5a91ef4ef39709b97b2ffcc1d234c79707 Mon Sep 17 00:00:00 2001 From: Khalid <187553667+Hayyaaf@users.noreply.github.com> Date: Tue, 26 Nov 2024 18:45:31 +0300 Subject: [PATCH] Fix Wireshark Dockerfile and update documentation (#326) - Removed `OQS_MINIMAL_BUILD` flag and unnecessary dependencies - Updated docs to reflect macOS support. Signed-off-by: Khalid <187553667+itsHayyaf@users.noreply.github.com> Co-authored-by: Khalid <187553667+itsHayyaf@users.noreply.github.com> --- wireshark/Dockerfile | 3 +-- wireshark/README.md | 6 +----- wireshark/USAGE.md | 7 ++----- 3 files changed, 4 insertions(+), 12 deletions(-) diff --git a/wireshark/Dockerfile b/wireshark/Dockerfile index 10e2299..5a1815e 100755 --- a/wireshark/Dockerfile +++ b/wireshark/Dockerfile @@ -27,7 +27,7 @@ ARG INSTALLDIR # Install essential build dependencies RUN apt-get update && apt-get install -y --no-install-recommends \ build-essential libtool automake autoconf cmake ninja-build \ - openssl libssl-dev git wget ca-certificates \ + git wget ca-certificates \ python3 python3-pip python3-venv && \ apt-get clean && rm -rf /var/lib/apt/lists/* @@ -53,7 +53,6 @@ RUN cmake -G Ninja /opt/src/liboqs \ -D CMAKE_INSTALL_PREFIX=${INSTALLDIR}/liboqs \ -D BUILD_SHARED_LIBS=ON \ -D OQS_USE_OPENSSL=OFF \ - -D OQS_MINIMAL_BUILD="KEM_kyber_512;KEM_kyber_768;KEM_kyber_1024" \ -D CMAKE_INSTALL_RPATH="${INSTALLDIR}/liboqs/lib" && \ ninja -j$(nproc) && ninja install diff --git a/wireshark/README.md b/wireshark/README.md index 619564c..769a090 100644 --- a/wireshark/README.md +++ b/wireshark/README.md @@ -32,11 +32,7 @@ image allows Wireshark to analyze network traffic encrypted with post-quantum cr export DISPLAY=:0 ``` -**Notes**: - -- **macOS** support has not been tested yet. We welcome your feedback and suggestions. Please reach us through - the [oqs-demos issue section](https://github.com/open-quantum-safe/oqs-demos/issues). -- Replace `` with your system's IP address. Use `:0` as the default display port unless configured +**Note**: Replace `` with your system's IP address. Use `:0` as the default display port unless configured otherwise. ## Building Instructions diff --git a/wireshark/USAGE.md b/wireshark/USAGE.md index a191ff1..7819fa3 100644 --- a/wireshark/USAGE.md +++ b/wireshark/USAGE.md @@ -4,7 +4,7 @@ support through the [Open Quantum Safe (OQS) provider](https://github.com/open-q ## Running Wireshark -You can run the Wireshark Docker container on Linux or Windows using the following command: +You can run the Wireshark Docker container on Linux, Windows, or macOS using the following command: ``` docker run --rm -it --net=host -e DISPLAY=$DISPLAY -v /tmp/.X11-unix:/tmp/.X11-unix oqs-wireshark @@ -13,9 +13,6 @@ docker run --rm -it --net=host -e DISPLAY=$DISPLAY -v /tmp/.X11-unix:/tmp/.X11-u Once Wireshark is running, you can [use it as you normally would](https://www.wireshark.org/docs/), such as selecting a network interface to capture and analyze traffic. -**Note:** **macOS** support has not been tested yet. We welcome your feedback and suggestions. Please reach us through -the [oqs-demos issue section](https://github.com/open-quantum-safe/oqs-demos/issues). - ## Testing quantum-safe Protocols ### 1. Filter by Quantum-Safe Protocols @@ -36,7 +33,7 @@ like `ping` to find the IP). Run the following command to test a quantum-safe TLS connection: ``` -docker run -it openquantumsafe/curl sh -c "curl -k https://test.openquantumsafe.org:6069 --curves kyber1024" +docker run --rm -it openquantumsafe/curl sh -c "curl -k https://test.openquantumsafe.org:6069 --curves kyber1024" ``` **Explanation:**