Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README with Ubuntu usage instructions and additional information. #39

Closed
wants to merge 1 commit into from
Closed

Update README with Ubuntu usage instructions and additional information. #39

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 17 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,21 @@
# rustls-openssl-compat
# Rustls OpenSSL Compatibility Layer

This is the planned home of several rustls to OpenSSL compatibility layers.
Currently here:
This is an implementation of the OpenSSL libssl ABI which uses [Rustls](https://github.com/rustls/rustls/) for TLS.

- **[rustls-libssl](rustls-libssl/)**: an implementation of the OpenSSL libssl ABI in terms of rustls.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

would be good to retain this link -- somewhere -- as it has a fuller readme that this one. or maybe we should move that file to here? See https://github.com/rustls/rustls-openssl-compat/tree/main/rustls-libssl

## Use With Nginx on Ubuntu

Not yet here:
Initially we targeted support for use with Nginx on Ubuntu 22.04 or higher. It's very simple to replace Nginx usage of OpenSSL with Rustls on Ubuntu:

- **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
```

## Future

* Simple Fedora-based packaging and instructions.
* Additional libssl ABI surface implementation.
* Provide an implementation of OpenSSL's libcrypto ABI which uses rustls `cryptoprovider`.