mirror of
https://github.com/librespot-org/librespot.git
synced 2025-10-03 09:49:31 +02:00
feat: add configurable TLS backend selection with native-tls as default (#1541)
Add support for choosing between native-tls and rustls-tls backends through feature flags, with native-tls as the default for maximum platform compatibility. Key changes: - Add mutually exclusive native-tls and rustls-tls feature flags - Use conditional compilation to select TLS implementation - Configure rustls-tls with platform certificate verifier - Refactor to workspace-based dependency management - Update CI workflows with improved cross-compilation support - Add comprehensive TLS backend documentation The native-tls backend uses system TLS libraries (OpenSSL on Linux, Secure Transport on macOS, SChannel on Windows) while rustls-tls provides a pure Rust implementation with platform certificate stores.
This commit is contained in:
Roderick van Domburg
GitHub
parent
03bcdc6bda
commit
0a4969ffe2
31 changed files with 928 additions and 577 deletions
99
.github/workflows/build.yml
vendored
Normal file
99
.github/workflows/build.yml
vendored
Normal file
|
|
@ -0,0 +1,99 @@
|
|||
---
|
||||
# Note, this is used in the badge URL!
|
||||
name: build
|
||||
|
||||
"on":
|
||||
push:
|
||||
branches: [dev, master]
|
||||
paths-ignore:
|
||||
- "**.md"
|
||||
- "docs/**"
|
||||
- "contrib/**"
|
||||
- "LICENSE"
|
||||
- "*.sh"
|
||||
- "**/Dockerfile*"
|
||||
- "publish.sh"
|
||||
- "test.sh"
|
||||
pull_request:
|
||||
paths-ignore:
|
||||
- "**.md"
|
||||
- "docs/**"
|
||||
- "contrib/**"
|
||||
- "LICENSE"
|
||||
- "*.sh"
|
||||
- "**/Dockerfile*"
|
||||
- "publish.sh"
|
||||
- "test.sh"
|
||||
schedule:
|
||||
# Run CI every week
|
||||
- cron: "00 01 * * 0"
|
||||
|
||||
env:
|
||||
RUST_BACKTRACE: 1
|
||||
RUSTFLAGS: -D warnings
|
||||
|
||||
jobs:
|
||||
test:
|
||||
name: cargo +${{ matrix.toolchain }} test (${{ matrix.os }})
|
||||
runs-on: ${{ matrix.os }}
|
||||
strategy:
|
||||
matrix:
|
||||
os: [ubuntu-latest, windows-latest]
|
||||
toolchain:
|
||||
- "1.85" # MSRV (Minimum supported rust version)
|
||||
- stable
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v5
|
||||
|
||||
- name: Install Rust toolchain
|
||||
uses: dtolnay/rust-toolchain@master
|
||||
with:
|
||||
toolchain: ${{ matrix.toolchain }}
|
||||
|
||||
- name: Cache Rust dependencies
|
||||
uses: Swatinem/rust-cache@v2
|
||||
|
||||
- name: Install developer package dependencies (Linux)
|
||||
if: runner.os == 'Linux'
|
||||
run: >
|
||||
sudo apt-get update && sudo apt-get install -y
|
||||
libpulse-dev portaudio19-dev libasound2-dev libsdl2-dev
|
||||
gstreamer1.0-dev libgstreamer-plugins-base1.0-dev
|
||||
libavahi-compat-libdnssd-dev
|
||||
|
||||
- name: Fetch dependencies
|
||||
run: cargo fetch --locked
|
||||
|
||||
- name: Build workspace with examples
|
||||
run: cargo build --frozen --workspace --examples
|
||||
|
||||
- name: Run tests
|
||||
run: cargo test --workspace
|
||||
|
||||
- name: Install cargo-hack
|
||||
uses: taiki-e/install-action@cargo-hack
|
||||
|
||||
- name: Check packages without TLS requirements
|
||||
run: cargo hack check -p librespot-protocol --each-feature
|
||||
|
||||
- name: Check workspace with native-tls
|
||||
run: >
|
||||
cargo hack check -p librespot --each-feature --exclude-all-features
|
||||
--include-features native-tls --exclude-features rustls-tls
|
||||
|
||||
- name: Check workspace with rustls-tls
|
||||
run: >
|
||||
cargo hack check -p librespot --each-feature --exclude-all-features
|
||||
--include-features rustls-tls --exclude-features native-tls
|
||||
|
||||
- name: Build binary with default features
|
||||
run: cargo build --frozen
|
||||
|
||||
- name: Upload debug artifacts
|
||||
uses: actions/upload-artifact@v4
|
||||
with:
|
||||
name: librespot-${{ matrix.os }}-${{ matrix.toolchain }}
|
||||
path: >
|
||||
target/debug/librespot${{ runner.os == 'Windows' && '.exe' || '' }}
|
||||
if-no-files-found: error
|
||||
78
.github/workflows/cross-compile.yml
vendored
Normal file
78
.github/workflows/cross-compile.yml
vendored
Normal file
|
|
@ -0,0 +1,78 @@
|
|||
---
|
||||
name: cross-compile
|
||||
|
||||
"on":
|
||||
push:
|
||||
branches: [dev, master]
|
||||
paths-ignore:
|
||||
- "**.md"
|
||||
- "docs/**"
|
||||
- "contrib/**"
|
||||
- "LICENSE"
|
||||
- "*.sh"
|
||||
- "**/Dockerfile*"
|
||||
pull_request:
|
||||
paths-ignore:
|
||||
- "**.md"
|
||||
- "docs/**"
|
||||
- "contrib/**"
|
||||
- "LICENSE"
|
||||
- "*.sh"
|
||||
- "**/Dockerfile*"
|
||||
|
||||
env:
|
||||
RUST_BACKTRACE: 1
|
||||
RUSTFLAGS: -D warnings
|
||||
|
||||
jobs:
|
||||
cross-compile:
|
||||
name: cross +${{ matrix.toolchain }} build ${{ matrix.platform.target }}
|
||||
runs-on: ${{ matrix.platform.runs-on }}
|
||||
continue-on-error: false
|
||||
strategy:
|
||||
matrix:
|
||||
platform:
|
||||
- arch: armv7
|
||||
runs-on: ubuntu-latest
|
||||
target: armv7-unknown-linux-gnueabihf
|
||||
|
||||
- arch: aarch64
|
||||
runs-on: ubuntu-latest
|
||||
target: aarch64-unknown-linux-gnu
|
||||
|
||||
- arch: riscv64gc
|
||||
runs-on: ubuntu-latest
|
||||
target: riscv64gc-unknown-linux-gnu
|
||||
|
||||
toolchain:
|
||||
- "1.85" # MSRV (Minimum Supported Rust Version)
|
||||
- stable
|
||||
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v5
|
||||
|
||||
- name: Build binary with default features
|
||||
if: matrix.platform.target != 'riscv64gc-unknown-linux-gnu'
|
||||
uses: houseabsolute/actions-rust-cross@v1
|
||||
with:
|
||||
command: build
|
||||
target: ${{ matrix.platform.target }}
|
||||
toolchain: ${{ matrix.toolchain }}
|
||||
args: --locked --verbose
|
||||
|
||||
- name: Build binary with rustls-tls and no default features
|
||||
if: matrix.platform.target == 'riscv64gc-unknown-linux-gnu'
|
||||
uses: houseabsolute/actions-rust-cross@v1
|
||||
with:
|
||||
command: build
|
||||
target: ${{ matrix.platform.target }}
|
||||
toolchain: ${{ matrix.toolchain }}
|
||||
args: --locked --verbose --no-default-features --features rustls-tls
|
||||
|
||||
- name: Upload debug artifacts
|
||||
uses: actions/upload-artifact@v4
|
||||
with:
|
||||
name: librespot-${{ matrix.platform.runs-on }}-${{ matrix.platform.arch }}-${{ matrix.toolchain }} # yamllint disable-line rule:line-length
|
||||
path: target/${{ matrix.platform.target }}/debug/librespot
|
||||
if-no-files-found: error
|
||||
79
.github/workflows/quality.yml
vendored
Normal file
79
.github/workflows/quality.yml
vendored
Normal file
|
|
@ -0,0 +1,79 @@
|
|||
---
|
||||
name: code-quality
|
||||
|
||||
"on":
|
||||
push:
|
||||
branches: [dev, master]
|
||||
paths-ignore:
|
||||
- "**.md"
|
||||
- "docs/**"
|
||||
- "contrib/**"
|
||||
- "LICENSE"
|
||||
- "*.sh"
|
||||
- "**/Dockerfile*"
|
||||
pull_request:
|
||||
paths-ignore:
|
||||
- "**.md"
|
||||
- "docs/**"
|
||||
- "contrib/**"
|
||||
- "LICENSE"
|
||||
- "*.sh"
|
||||
- "**/Dockerfile*"
|
||||
schedule:
|
||||
# Run CI every week
|
||||
- cron: "00 01 * * 0"
|
||||
|
||||
env:
|
||||
RUST_BACKTRACE: 1
|
||||
RUSTFLAGS: -D warnings
|
||||
|
||||
jobs:
|
||||
fmt:
|
||||
name: cargo fmt
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v5
|
||||
|
||||
- name: Install Rust toolchain
|
||||
uses: dtolnay/rust-toolchain@stable
|
||||
|
||||
- name: Check formatting
|
||||
run: cargo fmt --all -- --check
|
||||
|
||||
clippy:
|
||||
needs: fmt
|
||||
name: cargo clippy
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v5
|
||||
|
||||
- name: Install Rust toolchain
|
||||
uses: dtolnay/rust-toolchain@stable
|
||||
|
||||
- name: Cache Rust dependencies
|
||||
uses: Swatinem/rust-cache@v2
|
||||
|
||||
- name: Install developer package dependencies
|
||||
run: >
|
||||
sudo apt-get update && sudo apt-get install -y
|
||||
libpulse-dev portaudio19-dev libasound2-dev libsdl2-dev
|
||||
gstreamer1.0-dev libgstreamer-plugins-base1.0-dev
|
||||
libavahi-compat-libdnssd-dev
|
||||
|
||||
- name: Install cargo-hack
|
||||
uses: taiki-e/install-action@cargo-hack
|
||||
|
||||
- name: Run clippy on packages without TLS requirements
|
||||
run: cargo hack clippy -p librespot-protocol --each-feature
|
||||
|
||||
- name: Run clippy with native-tls
|
||||
run: >
|
||||
cargo hack clippy -p librespot --each-feature --exclude-all-features
|
||||
--include-features native-tls --exclude-features rustls-tls
|
||||
|
||||
- name: Run clippy with rustls-tls
|
||||
run: >
|
||||
cargo hack clippy -p librespot --each-feature --exclude-all-features
|
||||
--include-features rustls-tls --exclude-features native-tls
|
||||
281
.github/workflows/test.yml
vendored
281
.github/workflows/test.yml
vendored
|
|
@ -1,281 +0,0 @@
|
|||
# Note, this is used in the badge URL!
|
||||
name: test
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [dev, master]
|
||||
paths:
|
||||
[
|
||||
"**.rs",
|
||||
"Cargo.toml",
|
||||
"Cargo.lock",
|
||||
"rustfmt.toml",
|
||||
".github/workflows/*",
|
||||
"!*.md",
|
||||
"!contrib/*",
|
||||
"!docs/*",
|
||||
"!LICENSE",
|
||||
"!*.sh",
|
||||
]
|
||||
pull_request:
|
||||
paths:
|
||||
[
|
||||
"**.rs",
|
||||
"Cargo.toml",
|
||||
"Cargo.lock",
|
||||
"rustfmt.toml",
|
||||
".github/workflows/*",
|
||||
"!*.md",
|
||||
"!contrib/*",
|
||||
"!docs/*",
|
||||
"!LICENSE",
|
||||
"!*.sh",
|
||||
]
|
||||
schedule:
|
||||
# Run CI every week
|
||||
- cron: "00 01 * * 0"
|
||||
|
||||
env:
|
||||
RUST_BACKTRACE: 1
|
||||
RUSTFLAGS: -D warnings
|
||||
|
||||
# The layering here is as follows:
|
||||
# 1. code formatting
|
||||
# 2. absence of lints
|
||||
# 3. absence of errors and warnings on Linux/x86
|
||||
# 4. cross compilation on Windows and Linux/ARM
|
||||
|
||||
jobs:
|
||||
fmt:
|
||||
name: cargo fmt
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v5
|
||||
- name: Install toolchain
|
||||
run: curl https://sh.rustup.rs -sSf | sh -s -- --profile default --default-toolchain stable -y
|
||||
- run: cargo fmt --all -- --check
|
||||
|
||||
clippy:
|
||||
needs: fmt
|
||||
name: cargo +${{ matrix.toolchain }} clippy (${{ matrix.os }})
|
||||
runs-on: ${{ matrix.os }}
|
||||
continue-on-error: false
|
||||
strategy:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
os: [ubuntu-latest]
|
||||
toolchain: [stable]
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Install toolchain
|
||||
run: curl https://sh.rustup.rs -sSf | sh -s -- --profile default --default-toolchain ${{ matrix.toolchain }} -y
|
||||
|
||||
- name: Get Rustc version
|
||||
id: get-rustc-version
|
||||
run: echo "version=$(rustc -V)" >> $GITHUB_OUTPUT
|
||||
shell: bash
|
||||
|
||||
- name: Cache Rust dependencies
|
||||
uses: actions/cache@v4
|
||||
with:
|
||||
path: |
|
||||
~/.cargo/registry/index
|
||||
~/.cargo/registry/cache
|
||||
~/.cargo/git
|
||||
target
|
||||
key: ${{ runner.os }}-${{ steps.get-rustc-version.outputs.version }}-${{ hashFiles('Cargo.lock') }}
|
||||
|
||||
- name: Install developer package dependencies
|
||||
run: sudo apt-get update && sudo apt install -y libunwind-dev && sudo apt-get install libpulse-dev portaudio19-dev libasound2-dev libsdl2-dev gstreamer1.0-dev libgstreamer-plugins-base1.0-dev libavahi-compat-libdnssd-dev
|
||||
|
||||
- run: cargo install cargo-hack
|
||||
- run: cargo hack --workspace --remove-dev-deps
|
||||
- run: cargo clippy -p librespot-core --no-default-features
|
||||
- run: cargo clippy -p librespot-core
|
||||
- run: cargo hack clippy --each-feature -p librespot-discovery
|
||||
- run: cargo hack clippy --each-feature -p librespot-playback
|
||||
- run: cargo hack clippy --each-feature
|
||||
|
||||
test-linux:
|
||||
name: cargo +${{ matrix.toolchain }} check (${{ matrix.os }})
|
||||
runs-on: ${{ matrix.os }}
|
||||
continue-on-error: ${{ matrix.experimental }}
|
||||
needs: clippy
|
||||
strategy:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
os: [ubuntu-latest]
|
||||
toolchain:
|
||||
- "1.85" # MSRV (Minimum supported rust version)
|
||||
- stable
|
||||
experimental: [false]
|
||||
# Ignore failures in beta
|
||||
include:
|
||||
- os: ubuntu-latest
|
||||
toolchain: beta
|
||||
experimental: true
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v5
|
||||
|
||||
- name: Install toolchain
|
||||
run: curl https://sh.rustup.rs -sSf | sh -s -- --profile minimal --default-toolchain ${{ matrix.toolchain }} -y
|
||||
|
||||
- name: Get Rustc version
|
||||
id: get-rustc-version
|
||||
run: echo "version=$(rustc -V)" >> $GITHUB_OUTPUT
|
||||
shell: bash
|
||||
|
||||
- name: Cache Rust dependencies
|
||||
uses: actions/cache@v4
|
||||
with:
|
||||
path: |
|
||||
~/.cargo/registry/index
|
||||
~/.cargo/registry/cache
|
||||
~/.cargo/git
|
||||
target
|
||||
key: ${{ runner.os }}-${{ steps.get-rustc-version.outputs.version }}-${{ hashFiles('Cargo.lock') }}
|
||||
|
||||
- name: Install developer package dependencies
|
||||
run: sudo apt-get update && sudo apt install -y libunwind-dev && sudo apt-get install libpulse-dev portaudio19-dev libasound2-dev libsdl2-dev gstreamer1.0-dev libgstreamer-plugins-base1.0-dev libavahi-compat-libdnssd-dev
|
||||
|
||||
- run: cargo fetch --locked
|
||||
- run: cargo build --frozen --workspace --examples
|
||||
- run: cargo test --workspace
|
||||
|
||||
- run: cargo install cargo-hack
|
||||
- run: cargo hack --workspace --remove-dev-deps
|
||||
- run: cargo check -p librespot-core --no-default-features
|
||||
- run: cargo check -p librespot-core
|
||||
- run: cargo hack check --each-feature -p librespot-discovery
|
||||
- run: cargo hack check --each-feature -p librespot-playback
|
||||
- run: cargo hack check --each-feature
|
||||
|
||||
test-windows:
|
||||
needs: clippy
|
||||
name: cargo +${{ matrix.toolchain }} check (${{ matrix.os }})
|
||||
runs-on: ${{ matrix.os }}
|
||||
continue-on-error: false
|
||||
strategy:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
os: [windows-latest]
|
||||
toolchain:
|
||||
- "1.85" # MSRV (Minimum supported rust version)
|
||||
- stable
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v5
|
||||
|
||||
- name: Install toolchain
|
||||
run: curl https://sh.rustup.rs -sSf | sh -s -- --profile minimal --default-toolchain ${{ matrix.toolchain }} -y
|
||||
|
||||
- name: Get Rustc version
|
||||
id: get-rustc-version
|
||||
run: echo "version=$(rustc -V)" >> $GITHUB_OUTPUT
|
||||
shell: bash
|
||||
|
||||
- name: Cache Rust dependencies
|
||||
uses: actions/cache@v4
|
||||
with:
|
||||
path: |
|
||||
~/.cargo/registry/index
|
||||
~/.cargo/registry/cache
|
||||
~/.cargo/git
|
||||
target
|
||||
key: ${{ runner.os }}-${{ steps.get-rustc-version.outputs.version }}-${{ hashFiles('Cargo.lock') }}
|
||||
|
||||
- run: cargo fetch --locked
|
||||
- run: cargo build --frozen --workspace --examples
|
||||
- run: cargo test --workspace
|
||||
|
||||
- run: cargo install cargo-hack
|
||||
- run: cargo hack --workspace --remove-dev-deps
|
||||
- run: cargo check --no-default-features
|
||||
- run: cargo check
|
||||
|
||||
test-cross-linux:
|
||||
name: cross +${{ matrix.toolchain }} build ${{ matrix.target }}
|
||||
needs: clippy
|
||||
runs-on: ${{ matrix.os }}
|
||||
continue-on-error: false
|
||||
strategy:
|
||||
fail-fast: false
|
||||
matrix:
|
||||
os: [ubuntu-latest]
|
||||
target:
|
||||
- armv7-unknown-linux-gnueabihf
|
||||
- aarch64-unknown-linux-gnu
|
||||
- riscv64gc-unknown-linux-gnu
|
||||
toolchain:
|
||||
- "1.85" # MSRV (Minimum supported rust version)
|
||||
- stable
|
||||
steps:
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v5
|
||||
|
||||
- name: Install toolchain
|
||||
run: curl https://sh.rustup.rs -sSf | sh -s -- --profile minimal --default-toolchain ${{ matrix.toolchain }} -y
|
||||
|
||||
- name: Get Rustc version
|
||||
id: get-rustc-version
|
||||
run: echo "version=$(rustc -V)" >> $GITHUB_OUTPUT
|
||||
shell: bash
|
||||
|
||||
- name: Cache Rust dependencies
|
||||
uses: actions/cache@v4
|
||||
with:
|
||||
path: |
|
||||
~/.cargo/registry/index
|
||||
~/.cargo/registry/cache
|
||||
~/.cargo/git
|
||||
target
|
||||
key: ${{ runner.os }}-${{ matrix.target }}-${{ steps.get-rustc-version.outputs.version }}-${{ hashFiles('Cargo.lock') }}
|
||||
|
||||
- name: Install the cross compiler rust targets
|
||||
run: rustup target add ${{ matrix.target }}
|
||||
|
||||
- name: Update and Install dependencies
|
||||
run: sudo apt-get update && sudo apt-get install -y build-essential cmake libclang1
|
||||
|
||||
- name: Install bindgen-cli
|
||||
run: cargo install --force --locked bindgen-cli
|
||||
|
||||
- name: Install cross compiler
|
||||
run: |
|
||||
if [ ${{ matrix.target }} = "armv7-unknown-linux-gnueabihf" ]; then
|
||||
sudo apt-get install -y gcc-arm-linux-gnueabihf
|
||||
fi
|
||||
if [ ${{ matrix.target }} = "aarch64-unknown-linux-gnu" ]; then
|
||||
sudo apt-get install -y gcc-aarch64-linux-gnu
|
||||
fi
|
||||
if [ ${{ matrix.target }} = "riscv64gc-unknown-linux-gnu" ]; then
|
||||
sudo apt-get install -y gcc-riscv64-linux-gnu
|
||||
fi
|
||||
|
||||
- name: Set target link compiler
|
||||
run: |
|
||||
# Convert target to uppercase and replace - with _
|
||||
target=${{ matrix.target }}
|
||||
target=${target^^}
|
||||
target=${target//-/_}
|
||||
if [ ${{ matrix.target }} = "armv7-unknown-linux-gnueabihf" ]; then
|
||||
echo "CARGO_TARGET_${target}_LINKER=arm-linux-gnueabihf-gcc" >> $GITHUB_ENV
|
||||
fi
|
||||
if [ ${{ matrix.target }} = "aarch64-unknown-linux-gnu" ]; then
|
||||
echo "CARGO_TARGET_${target}_LINKER=aarch64-linux-gnu-gcc" >> $GITHUB_ENV
|
||||
fi
|
||||
if [ ${{ matrix.target }} = "riscv64gc-unknown-linux-gnu" ]; then
|
||||
echo "CARGO_TARGET_${target}_LINKER=riscv64-linux-gnu-gcc" >> $GITHUB_ENV
|
||||
fi
|
||||
|
||||
- name: Fetch
|
||||
run: cargo fetch --locked
|
||||
- name: Build
|
||||
run: cargo build --frozen --verbose --target ${{ matrix.target }} --no-default-features
|
||||
|
||||
- name: Check binary
|
||||
run: file target/${{ matrix.target }}/debug/librespot
|
||||
Loading…
Add table
Add a link
Reference in a new issue