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.

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

Move rustls-libssl/ to the repo root #42

Merged
merged 1 commit into from
Sep 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 1 addition & 5 deletions .github/workflows/libssl.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,6 @@ on:
schedule:
- cron: '15 12 * * 3'

defaults:
run:
working-directory: rustls-libssl

jobs:
build:
name: Build+test
Expand Down Expand Up @@ -263,5 +259,5 @@ jobs:
uses: actions/upload-artifact@v4
with:
name: ${{ matrix.package }} package built on ${{ matrix.container }} ${{ matrix.version }}
path: rustls-libssl/target/dist/*.${{ matrix.package }}
path: target/dist/*.${{ matrix.package }}
if-no-files-found: error
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
66 changes: 60 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,64 @@
# rustls-openssl-compat
<p align="center">
<img width="460" height="300" src="https://raw.githubusercontent.com/rustls/rustls/main/admin/rustls-logo-web.png">
</p>

This is the planned home of several rustls to OpenSSL compatibility layers.
Currently here:
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:
this is still required.

- **[rustls-libssl](rustls-libssl/)**: an implementation of the OpenSSL libssl ABI in terms of rustls.
[![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)

Not yet here:
# Status

- **rustls-libcrypto**: an implementation of rustls `CryptoProvider` in terms of OpenSSL's libcrypto.
This project is experimental. 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
- nginx on Fedora 40

We have a [compatibility matrix](MATRIX.md) and
[known issues](https://github.com/rustls/rustls-openssl-compat/issues).

# Usage

## Installation
Ubuntu/Debian users:

```shell
$ wget https://github.com/rustls/rustls-openssl-compat/releases/latest/download/rustls-libssl_amd64.deb
$ sudo dpkg -i rustls-libssl_amd64.deb
```

or Fedora/Redhat users:

```shell
$ wget https://github.com/rustls/rustls-openssl-compat/releases/latest/download/rustls-libssl.x86_64.rpm
$ sudo yum localinstall -y rustls-libssl.x86_64.rpm
```

Using curl:

```shell
$ with-rustls-libssl curl https://google.com/
```

`with-rustls-libssl` just sets `LD_LIBRARY_PATH` and executes the given process.

Using nginx:

```shell
$ sudo rustls-libssl-nginx enable
$ sudo systemctl daemon-reload
$ 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).
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
64 changes: 0 additions & 64 deletions rustls-libssl/README.md

This file was deleted.

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.