diff --git a/rustls-libssl/LICENSE b/LICENSE similarity index 100% rename from rustls-libssl/LICENSE rename to LICENSE diff --git a/README.md b/README.md index 2f82420..864fcd1 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,25 @@ -# rustls-openssl-compat +# Rustls OpenSSL Compatibility Layer -This is the planned home of several rustls to OpenSSL compatibility layers. -Currently here: +OpenSSL consists of several libraries. We offer a safer version of OpenSSL's `libssl` (TLS support), and we intend to eventually offer a safer version of OpenSSL's `libcrypto` (cryptography support). -- **[rustls-libssl](rustls-libssl/)**: an implementation of the OpenSSL libssl ABI in terms of rustls. +## rustls-libssl -Not yet here: +This is ready for use with Nginx on Ubuntu 22.04 and later. Using it is as simple as: -- **rustls-libcrypto**: an implementation of rustls `CryptoProvider` in terms of OpenSSL's libcrypto. +``` +$ wget https://github.com/rustls/rustls-openssl-compat/releases/latest/download/rustls-libssl_amd64.deb +$ sudo dpkg -i rustls-libssl_amd64.deb +$ sudo rustls-libssl-nginx enable +$ sudo systemctl daemon-reload +$ sudo service nginx restart +``` + +Get more information about our implementation of libssl's ABI from the [rustls-libssl README](rustls-libssl/). + +## rustls-libcrypto + +This will be implemented using rustls `CryptoProvider`. + +# Change Log + +We offer a [detailed list of changes](https://github.com/rustls/rustls-openssl-compat/releases) in each release. diff --git a/rustls-libssl/README.md b/rustls-libssl/README.md index bc4f7ce..46d24cc 100644 --- a/rustls-libssl/README.md +++ b/rustls-libssl/README.md @@ -3,15 +3,14 @@

rustls-libssl is a partial reimplementation of the OpenSSL 3 libssl ABI. -It is written in rust and uses rustls. It does not replace libcrypto: +It is written in rust and uses rustls. It does not replace libcrypto: this is still required. [![rustls-libssl](https://github.com/rustls/rustls-openssl-compat/actions/workflows/libssl.yaml/badge.svg)](https://github.com/rustls/rustls-openssl-compat/actions/workflows/libssl.yaml) # Status -This project is experimental. We have aimed for the subset of libssl -used by: +We have aimed for the subset of libssl used by: - curl on Ubuntu 22.04 LTS - nginx on Ubuntu 22.04 LTS and 24.04 LTS @@ -45,10 +44,3 @@ $ sudo service nginx restart `rustls-libssl-nginx enable` installs a systemd drop-in in `/etc/systemd/system/nginx.service.d/`. `rustls-libssl-nginx disable` undoes that. - -# Changelog -The detailed list of changes in each release can be found at -https://github.com/rustls/rustls-openssl-compat/releases. - -# License -rustls-libssl is distributed under the Apache-2.0 license. See [LICENSE](LICENSE).