Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
This builds a libssl.so.3, with a correct soname and
a handful of basic functions that are correctly versioned:

```
$ readelf -d target/debug/libssl.so.3 | grep SONAME
 0x000000000000000e (SONAME)             Library soname: [libssl.so.3]

$ readelf -Wa --dyn-syms target/debug/libssl.so.3 | grep @@
    62: 00000000000e8600     0 FUNC    GLOBAL DEFAULT   16 TLS_server_method@@OPENSSL_3.0.0
    65: 00000000000e8540     0 FUNC    GLOBAL DEFAULT   16 TLS_method@@OPENSSL_3.0.0
    66: 00000000000e8960     0 FUNC    GLOBAL DEFAULT   16 SSL_CTX_free@@OPENSSL_3.0.0
    67: 00000000000e8a30     0 FUNC    GLOBAL DEFAULT   16 SSL_new@@OPENSSL_3.0.0
    69: 00000000000e86c0     0 FUNC    GLOBAL DEFAULT   16 TLS_client_method@@OPENSSL_3.0.0
    70: 00000000000e8c10     0 FUNC    GLOBAL DEFAULT   16 SSL_free@@OPENSSL_3.0.0
    73: 00000000000e8780     0 FUNC    GLOBAL DEFAULT   16 SSL_CTX_new@@OPENSSL_3.0.0
    74: 00000000000e8870     0 FUNC    GLOBAL DEFAULT   16 SSL_CTX_up_ref@@OPENSSL_3.0.0
    78: 00000000000e8b20     0 FUNC    GLOBAL DEFAULT   16 SSL_up_ref@@OPENSSL_3.0.0
    79: 00000000000e8450     0 FUNC    GLOBAL DEFAULT   16 OPENSSL_init_ssl@@OPENSSL_3.0.0
```

See `build.rs` for how this works roughly, including the requirement for lld.

There are a handful of tests, and these work under miri.
  • Loading branch information
ctz committed Feb 23, 2024
0 parents commit 7b427fa
Show file tree
Hide file tree
Showing 15 changed files with 1,747 additions and 0 deletions.
11 changes: 11 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
version: 2
updates:
- package-ecosystem: cargo
directory: "/"
schedule:
interval: daily
open-pull-requests-limit: 10
- package-ecosystem: github-actions
directory: "/"
schedule:
interval: weekly
156 changes: 156 additions & 0 deletions .github/workflows/libssl.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,156 @@
name: rustls-libssl

permissions:
contents: read

on:
push:
pull_request:
merge_group:
schedule:
- cron: '15 12 * * 3'

defaults:
run:
working-directory: rustls-libssl

jobs:
build:
name: Build+test
runs-on: ${{ matrix.os }}
strategy:
matrix:
rust:
- stable
- beta
- nightly
os: [ubuntu-latest]
steps:
- name: Checkout sources
uses: actions/checkout@v4
with:
persist-credentials: false

- name: Install build dependencies
run: sudo apt-get update && sudo apt-get install -y openssl libssl3 libssl-dev lld

- name: Install ${{ matrix.rust }} toolchain
uses: dtolnay/rust-toolchain@master
with:
toolchain: ${{ matrix.rust }}

- run: make PROFILE=release test

valgrind:
name: Valgrind
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
persist-credentials: false
- name: Install valgrind
run: sudo apt-get update && sudo apt-get install -y valgrind
- name: Install build dependencies
run: sudo apt-get update && sudo apt-get install -y openssl libssl3 libssl-dev lld
- run: export VALGRIND="valgrind -q"
- run: make test

docs:
name: Check for documentation errors
runs-on: ubuntu-latest
steps:
- name: Checkout sources
uses: actions/checkout@v4
with:
persist-credentials: false

- name: Install build dependencies
run: sudo apt-get update && sudo apt-get install -y openssl libssl3 libssl-dev lld

- name: Install rust toolchain
uses: dtolnay/rust-toolchain@nightly

- name: cargo doc (all features)
run: cargo doc --all-features --no-deps --workspace
env:
RUSTDOCFLAGS: -Dwarnings

format:
name: Format
runs-on: ubuntu-latest
steps:
- name: Checkout sources
uses: actions/checkout@v4
with:
persist-credentials: false
- name: Install rust toolchain
uses: dtolnay/rust-toolchain@master
with:
toolchain: 1.67.1
components: rustfmt
- name: Check Rust formatting
run: cargo fmt --all -- --check
- name: Check src/entry.rs formatting
run: ./admin/format --all -- --check
- name: Check C formatting
run: make format-check

clippy:
name: Clippy
runs-on: ubuntu-latest
steps:
- name: Checkout sources
uses: actions/checkout@v4
with:
persist-credentials: false
- name: Install rust toolchain
uses: dtolnay/rust-toolchain@stable
with:
components: clippy
- name: Check clippy
# We allow unknown lints here because sometimes the nightly job
# (below) will have a new lint that we want to suppress.
# If we suppress (e.g. #![allow(clippy::arc_with_non_send_sync)]),
# we would get an unknown-lint error from older clippy versions.
run: cargo clippy --locked --workspace -- -D warnings -A unknown-lints

clippy-nightly-optional:
name: Clippy nightly (optional)
runs-on: ubuntu-latest
steps:
- name: Checkout sources
uses: actions/checkout@v4
with:
persist-credentials: false
- name: Install rust toolchain
uses: dtolnay/rust-toolchain@nightly
with:
components: clippy
- name: Check clippy
run: cargo clippy --locked --workspace -- -D warnings

clang-tidy:
name: Clang Tidy
runs-on: ubuntu-latest
steps:
- name: Checkout sources
uses: actions/checkout@v4
with:
persist-credentials: false
- name: Clang tidy
run: clang-tidy tests/*.c -- -I src/

miri:
name: Miri
runs-on: ubuntu-latest
steps:
- name: Checkout sources
uses: actions/checkout@v4
with:
persist-credentials: false

- name: Install nightly Rust
uses: dtolnay/rust-toolchain@nightly
- run: rustup override set "nightly-$(curl -s https://rust-lang.github.io/rustup-components-history/x86_64-unknown-linux-gnu/miri)"
- run: rustup component add miri
- run: cargo miri test
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# rustls-openssl-compat

This is the planned home of several rustls ↔️ OpenSSL compatibility layers.
Currently here:

- **rustls-libssl**: an implementation of the OpenSSL libssl ABI in terms of rustls.

Not yet here:

- **rustls-libcrypto**: an implementation of rustls `CryptoProvider` in terms of OpenSSL's libcrypto.
1 change: 1 addition & 0 deletions rustls-libssl/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
target/
Loading

0 comments on commit 7b427fa

Please sign in to comment.