open-quantum-safe / openssl

UNSUPPORTED Fork of OpenSSL 1.1.1 that includes prototype quantum-resistant algorithms and ciphersuites based on liboqs PLEASE SWITCH TO OQS-Provider for OpenSSL 3
https://openquantumsafe.org/
Other
286 stars 124 forks source link

Add Dockerized Environment for Improved Installation and Usage Experience #462

Closed salmanhiro closed 1 year ago

salmanhiro commented 1 year ago

This PR addresses the challenges faced by users during the installation process by introducing a Dockerized environment for the project. The aim is to provide a consistent and reliable setup that mitigates issues arising from differences in user environments.The installation process of the project in local can encounter various difficulties due to differences in operating systems, dependencies, and configurations across users' environments. These discrepancies could lead to be challenging for users to get the project up and running smoothly.

The PR includes the following changes:

These changes provide users with an easy and reproducible way to set up and run the project in a Docker environment. The Dockerized environment ensures consistent execution and simplifies the installation process.

Checklist
baentsch commented 1 year ago

Thanks for this contribution. I'm afraid it comes a bit too late: We had such image in docker hub in the image openquantumsafe/curl (generated from https://github.com/open-quantum-safe/oqs-demos/tree/main/curl) but replaced this by now with the more future-proof OpenSSL3 version (given the EOL notice for (oqs)openssl111). If you'd like to try it, it still is accessible under the ":0.7.2" tag.

Going forward, would you possibly consider checking out https://hub.docker.com/repository/docker/openquantumsafe/oqs-ossl3/general (and the generating code at https://github.com/open-quantum-safe/oqs-demos/tree/main/openssl3) to state improvements missing there (and maybe add them via PR there)?

salmanhiro commented 1 year ago

Thanks for this contribution. I'm afraid it comes a bit too late: We had such image in docker hub in the image openquantumsafe/curl (generated from https://github.com/open-quantum-safe/oqs-demos/tree/main/curl) but replaced this by now with the more future-proof OpenSSL3 version (given the EOL notice for (oqs)openssl111). If you'd like to try it, it still is accessible under the ":0.7.2" tag.

Going forward, would you possibly consider checking out https://hub.docker.com/repository/docker/openquantumsafe/oqs-ossl3/general (and the generating code at https://github.com/open-quantum-safe/oqs-demos/tree/main/openssl3) to state improvements missing there (and maybe add them via PR there)?

Thanks! I think I will take a look into docker hub image, try it, and apply some improvements

baentsch commented 1 year ago

Thanks! I think I will take a look into docker hub image, try it, and apply some improvements

Thanks very much! May I invite you to also take a look at the Dockerfile in the branch "mb-opensslupdate" to see the state of some experiments for better caching in docker buildx usage....

dstebila commented 1 year ago

The OpenSSL project has indicated that OpenSSL 1.1.1 will reach end-of-life in September 2023. As such, we are discontinuing development on OQS-OpenSSL 1.1.1, and recommend all users switch to OpenSSL 3 and the OQS Provider for OpenSSL 3, which provides all the same functionality that OQS-OpenSSL 1.1.1 does. Hence we are closing open pull requests and issues in OQS-OpenSSL 1.1.1 as won't-fix.