Update Wireshark Demo

[Hayyaaf]

Summary

This update enhances the Wireshark demo in the oqs-demos repository by integrating OpenSSL 3 with the OQS provider for quantum-safe cryptography support. Key improvements include:

• Updated Dockerfile:

  • Builds Wireshark 4.4.1 (latest version) with OpenSSL 3 with the OQS provider.
  • Consolidates the entire build process within the Dockerfile, simplifying configuration and maintenance.

• Automated Header Generation:

  • Added generate_qsc_header.py, a Python script that automates the generation of qsc.h, defining post-quantum cryptographic algorithms for Wireshark.
  • The script fetches algorithm definitions from the ALGORITHMS.md file in the OQS provider repository to ensure support for the latest algorithms.

• Project Cleanup and Expanded Documentation:

  • Expanded README.md with comprehensive setup instructions, configuration options, and cross-platform usage guidelines.
  • Removed outdated files (USAGE.md, build.sh, and wolfssl-qsc.h) to streamline the project structure.

Cross-Platform Notes:

Guidance for Linux and macOS display setup was drawn from documentation. Further testing on these platforms is recommended to ensure full functionality and compatibility.

Testing Summary

The updated Wireshark demo has been verified on Windows 11 with Docker 4.35.1 (latest version). Testing confirmed a successful build and functionality of Wireshark with post-quantum cryptography support.

Test Screenshots

The following screenshots show the successful integration of post-quantum cryptography in Wireshark. The tests capture traffic using the Kyber1024 and Frodo640aes algorithms.

[Hayyaaf]

Current image size is around 900 MB, and I'm aiming to reduce it further. Would you recommend stripping debug symbols, or are there other techniques you’d suggest? Any advice would be appreciated.

[baentsch]

Yikes -- this is complicated. Is there no other way to generate a suitable qsc,h file? E.g. by configuring oqs-provider in the intermediate image and throwing all else away?

[Hayyaaf]

Yikes -- this is complicated. Is there no other way to generate a suitable qsc,h file? E.g. by configuring oqs-provider in the intermediate image and throwing all else away?

I wasn’t aware of this method, so I initially tried parsing the algorithms.md file from oqs-provider, which was difficult. Could you share more on setting up an intermediate Docker image to generate and isolate the qsc.h file?

[baentsch]

I have to apologize: I mistook "qsc.h" for "oqs.h". Indeed, recreating the contents of the old "qsc.h" would need to be done by way of a jinja2 script (and then running it in a checked-out version of oqsprovider in the intermediate image). But that also requires additional code --- and in that case, your solution above is just an alternative approach and I'd be fine with it if/for as long as it works: It's fragile in the face of possible future changes to the file ALGORITHMS.md, though.

[Hayyaaf]

I agree that the current solution lacks robustness; I'll work on a more sustainable approach, as you suggested.

[baentsch]

Current image size is around 900 MB, and I'm aiming to reduce it further. Would you recommend stripping debug symbols, or are there other techniques you’d suggest? Any advice would be appreciated.

Well, what elements are largest? The chose baseline image (ubuntu) isn't exactly small to begin with. Any chance to use alpine?

[Hayyaaf]

Well, what elements are largest? The chose baseline image (ubuntu) isn't exactly small to begin with. Any chance to use alpine?

I initially started with Alpine to keep the image small, but ran into numerous issues with Wireshark and its complex dependencies, which made it the largest component. That’s why I switched to Ubuntu. However, I’ll give Alpine another shot after automating the generation of qsc.h as you suggested.

[Hayyaaf]

I apologize for the mistake. I unintentionally pushed a commit to the main branch of my fork, and although I have removed it and force-pushed, the commit still appears in this pull request. I will close this pull request and open a new one with the correct changes. I appreciate your understanding.