Skip to content

Commit

Permalink
Update README files to include more information in the top level README.
Browse files Browse the repository at this point in the history
  • Loading branch information
bdaehlie committed Aug 12, 2024
1 parent 4eebe9c commit f031419
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 16 deletions.
File renamed without changes.
27 changes: 21 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.
12 changes: 2 additions & 10 deletions rustls-libssl/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,14 @@
</p>

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
Expand Down Expand Up @@ -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).

0 comments on commit f031419

Please sign in to comment.