Skip to content
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
14 changes: 7 additions & 7 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 5 additions & 5 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,12 @@ exclude = ["crates/syauth-core/fuzz"]
resolver = "2"

[workspace.package]
version = "0.1.0"
version = "0.2.0"
edition = "2024"
rust-version = "1.85"
license = "MIT"
authors = ["syauth contributors"]
repository = "https://github.com/sy/syauth"
repository = "https://github.com/Mewplane/syauth"

[workspace.lints.rust]
unsafe_code = "deny"
Expand Down Expand Up @@ -59,15 +59,15 @@ workspace = true
bluer = { version = "0.17", default-features = false, features = ["bluetoothd"] }
tokio = { version = "1", features = ["macros", "rt-multi-thread"] }
# DEV-001 TC-11: pins LESC-derived material → MAC + BondStore round-trip.
syauth-core = { version = "0.1", path = "crates/syauth-core" }
syauth-core = { version = "0.2", path = "crates/syauth-core" }
# DEV-001 TC-11: built-in `Bond` carries `time::OffsetDateTime`.
time = { version = "0.3", features = ["macros"] }
# DEV-003 cross-crate byte-identity: assert the mobile UniFFI
# `session_uuid_for_bond` output matches the desktop transport's
# `session_uuid_for` byte for byte so the phone's scan filter UUID
# set always matches the desktop's advertised service UUID.
syauth-transport = { version = "0.1", path = "crates/syauth-transport" }
syauth-mobile = { version = "0.1", path = "crates/syauth-mobile" }
syauth-transport = { version = "0.2", path = "crates/syauth-transport" }
syauth-mobile = { version = "0.2", path = "crates/syauth-mobile" }
uuid = { version = "1" }

[profile.release]
Expand Down
6 changes: 3 additions & 3 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ lint: scope-discipline
scope-discipline:
@echo "Running scope-discipline grep..."
@if git grep -nE \
'(v0\.[0-9]+ ?(demo|will|follow.?up|reinstates|candidate))|(for the v0\.)|(production (version|will))|(demo only)|(temporary until)|(placeholder until)' \
'(v0\.[0-9]+ ?(demo|will|follow.?up|reinstates|candidate))|(for[ ]the[ ]v0\.)|(production[ ](version|will))|(demo[ ]only)|(temporary[ ]until)|(placeholder[ ]until)' \
-- 'crates/' 'syauth-android/app/src/main/' 'deploy/' \
':!:*tests/*' ':!:*test/*' ':!:*build/*' ':!:*target/*'; then \
echo ""; \
Expand Down Expand Up @@ -279,8 +279,8 @@ endif
# deploy/version.env; the values are duplicated here only to keep the
# Make invocation self-contained.

PACKAGE_VERSION ?= 0.1.0
RPM_RELEASE ?= 3
PACKAGE_VERSION ?= 0.2.0
RPM_RELEASE ?= 5
DEB_REVISION ?= 1
DIST_PREFIX ?= syauth-$(PACKAGE_VERSION)
DIST_TARBALL ?= target/$(DIST_PREFIX).tar.gz
Expand Down
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,53 +4,53 @@

Approve Linux authentication on your Android phone with a fresh strong biometric. syauth connects a Linux PAM module, a desktop Bluetooth daemon, and an Android companion that signs each request through Android Keystore.

[Documentation](https://dmytrogajewski.github.io/syauth/) · [Downloads](https://github.com/dmytrogajewski/syauth/releases/latest) · [How it works](https://dmytrogajewski.github.io/syauth/explanation/mechanics/) · [Security boundaries](https://dmytrogajewski.github.io/syauth/explanation/security/)
[Documentation](https://mewplane.github.io/syauth/) · [Downloads](https://github.com/Mewplane/syauth/releases/latest) · [How it works](https://mewplane.github.io/syauth/explanation/mechanics/) · [Security boundaries](https://mewplane.github.io/syauth/explanation/security/)

## Install

On a supported Linux desktop:

```sh
curl -fsSL https://dmytrogajewski.github.io/syauth/install.sh | sh
curl -fsSL https://mewplane.github.io/syauth/install.sh | sh
```

The installer resolves the latest release, chooses the native package for your distribution and CPU, checks its SHA-256 checksum, and installs it with `apt`, `dnf`, `zypper`, or `pacman`. It requests `sudo` when needed. It leaves PAM configuration and service activation to you.

Prefer to review the script first?

```sh
curl -fsSLo install-syauth.sh https://dmytrogajewski.github.io/syauth/install.sh
curl -fsSLo install-syauth.sh https://mewplane.github.io/syauth/install.sh
less install-syauth.sh
sh install-syauth.sh --dry-run
sh install-syauth.sh
```

Release downloads include DEB, RPM, Arch Linux packages, and manual Linux archives for x86_64 and ARM64, plus a signed [Android APK](https://github.com/dmytrogajewski/syauth/releases/download/v0.1.0/syauth-0.1.0-android.apk), source archive, signing certificate, build metadata, and `SHA256SUMS`. See [installation and verification](https://dmytrogajewski.github.io/syauth/how-to/install/) for direct package commands and version-pinned downloads.
Release downloads include DEB, RPM, Arch Linux packages, and manual Linux archives for x86_64 and ARM64, plus a signed [Android APK](https://github.com/Mewplane/syauth/releases/download/v0.2.0/syauth-0.2.0-android.apk), source archive, signing certificate, build metadata, and `SHA256SUMS`. See [installation and verification](https://mewplane.github.io/syauth/how-to/install/) for direct package commands and version-pinned downloads.

Use Debian 12+, Ubuntu 24.04+, a current Fedora/openSUSE/Arch installation, or a compatible derivative, with glibc 2.36+, PAM, systemd user services, BlueZ, and a BLE adapter capable of advertising. The phone needs Android 13+ with a supported Ed25519 Keystore implementation and an enrolled strong biometric. The APK can install on older Android versions, but that does not establish signing-key support.

## Use

1. Install the desktop package and signed Android companion.
2. Follow [storage and user-service setup](https://dmytrogajewski.github.io/syauth/how-to/install/#prepare-storage-and-the-user-service).
2. Follow [storage and user-service setup](https://mewplane.github.io/syauth/how-to/install/#prepare-storage-and-the-user-service).
3. Run `syauth pair`, complete numeric comparison on both devices, and confirm the bond with `syauth list`.
4. Read the [PAM policy reference](https://dmytrogajewski.github.io/syauth/reference/configuration/#pam-policy), configure one service, and complete [your first unlock](https://dmytrogajewski.github.io/syauth/tutorials/first-unlock/).
4. Read the [PAM policy reference](https://mewplane.github.io/syauth/reference/configuration/#pam-policy), configure one service, and complete [your first unlock](https://mewplane.github.io/syauth/tutorials/first-unlock/).

```sh
syauth pair
syauth list
syauth doctor
```

Being nearby prepares the connection; each authentication still needs explicit approval and a strong biometric. Keep the existing recovery method available while configuring PAM. The [security guide](https://dmytrogajewski.github.io/syauth/explanation/security/) describes the current implementation's differences from the design specification, including bond derivation and desktop key storage.
Being nearby prepares the connection; each authentication still needs explicit approval and a strong biometric. Keep the existing recovery method available while configuring PAM. The [security guide](https://mewplane.github.io/syauth/explanation/security/) describes the current implementation's differences from the design specification, including bond derivation and desktop key storage.

## Documentation

- [First unlock tutorial](https://dmytrogajewski.github.io/syauth/tutorials/first-unlock/)
- [Install](https://dmytrogajewski.github.io/syauth/how-to/install/), [pair and revoke](https://dmytrogajewski.github.io/syauth/how-to/pair-and-revoke/), [troubleshoot](https://dmytrogajewski.github.io/syauth/how-to/troubleshoot/)
- [CLI](https://dmytrogajewski.github.io/syauth/reference/cli/), [configuration](https://dmytrogajewski.github.io/syauth/reference/configuration/), [protocol](https://dmytrogajewski.github.io/syauth/reference/protocol/)
- [Illustrated mechanics](https://dmytrogajewski.github.io/syauth/explanation/mechanics/) with animated pairing, discovery, and unlock
- [Release builds and signing](https://dmytrogajewski.github.io/syauth/contributing/releases/)
- [First unlock tutorial](https://mewplane.github.io/syauth/tutorials/first-unlock/)
- [Install](https://mewplane.github.io/syauth/how-to/install/), [pair and revoke](https://mewplane.github.io/syauth/how-to/pair-and-revoke/), [troubleshoot](https://mewplane.github.io/syauth/how-to/troubleshoot/)
- [CLI](https://mewplane.github.io/syauth/reference/cli/), [configuration](https://mewplane.github.io/syauth/reference/configuration/), [protocol](https://mewplane.github.io/syauth/reference/protocol/)
- [Illustrated mechanics](https://mewplane.github.io/syauth/explanation/mechanics/) with animated pairing, discovery, and unlock
- [Release builds and signing](https://mewplane.github.io/syauth/contributing/releases/)

## Development and contributing

Expand All @@ -64,7 +64,7 @@ python3 -m unittest discover -s tests -p 'test_release_*.py'
python3 -m unittest discover -s tests -p test_installer.py
```

See [documentation development](docs/contributing/documentation.md), [release development](docs/contributing/releases.md), and [AGENTS.md](AGENTS.md) for contributor contracts. Open an [issue](https://github.com/dmytrogajewski/syauth/issues) with reproduction steps and sanitized diagnostics, or a pull request with the user-visible change and relevant test evidence. Avoid posting bond files, private keys, or unreviewed logs.
See [documentation development](docs/contributing/documentation.md), [release development](docs/contributing/releases.md), and [AGENTS.md](AGENTS.md) for contributor contracts. Open an [issue](https://github.com/Mewplane/syauth/issues) with reproduction steps and sanitized diagnostics, or a pull request with the user-visible change and relevant test evidence. Avoid posting bond files, private keys, or unreviewed logs.

## Maintainers

Expand Down
2 changes: 1 addition & 1 deletion crates/syauth-cli/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ serde_json = "1"
# wire shape the PAM module uses to probe the daemon's auth.sock.
# `syauth-presenced` already lives in the workspace; this dependency is
# library-only (no binary linkage).
syauth-presenced = { version = "0.1", path = "../syauth-presenced" }
syauth-presenced = { version = "0.2", path = "../syauth-presenced" }
# S-016 doctor: `geteuid()` for the `/run/user/<uid>` fallback when
# `XDG_RUNTIME_DIR` is unset. `nix` already lives in `Cargo.lock`
# via `syauth-presenced`, so no new transitive surface.
Expand Down
2 changes: 1 addition & 1 deletion crates/syauth-mobile/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ thiserror = "2"
# `syauth-core` re-exports `Frame`, `compute_tag`, `verify_tag`,
# `sign_frame`, `verify_frame`, and the typed errors we wrap into
# `MobileError`. Pinned by path so the workspace resolves to one version.
syauth-core = { version = "0.1", path = "../syauth-core" }
syauth-core = { version = "0.2", path = "../syauth-core" }

# HKDF-SHA256 for `oob_code_for_bond`. The version pins match
# `crates/syauth-cli/Cargo.toml` so the workspace resolves to a single
Expand Down
4 changes: 2 additions & 2 deletions crates/syauth-presenced/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -72,13 +72,13 @@ nix = { version = "0.29", features = ["fs", "signal", "user", "socket"] }
libc = "0.2"
# S-004: the orchestrator reads `Bond` metadata for the rotation
# audit line and reuses `bond_key_from_pubkeys` / `BondStore` shapes.
syauth-core = { version = "0.1", path = "../syauth-core" }
syauth-core = { version = "0.2", path = "../syauth-core" }
# S-004: the `Peripheral` trait + `session_uuid_for` derivation +
# `BOND_KEY_BYTES` width all live in the transport crate. The
# `test-fake` feature ships the radio-free `FakePeripheral` test
# double for the rotation integration test; it is a default feature
# of `syauth-transport` so no explicit `features` list is required.
syauth-transport = { version = "0.1", path = "../syauth-transport" }
syauth-transport = { version = "0.2", path = "../syauth-transport" }
# S-004: 128-bit UUID type for the rotation audit short-hex render.
uuid = { version = "1" }
# S-005: belt-and-suspenders inotify watcher on `bonds.toml`. The
Expand Down
2 changes: 1 addition & 1 deletion crates/syauth-transport/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ test-fake = []
# Shared protocol core. `Frame` and `FrameError` are the only types that cross
# the `BtPeer` trait boundary, so consumers can swap implementations (mock
# today, `bluer` in S-010) without touching the upper layers.
syauth-core = { version = "0.1", path = "../syauth-core" }
syauth-core = { version = "0.2", path = "../syauth-core" }

# Async trait surface. `BtPeer` and `Session` are `async fn` methods on trait
# objects; `async-trait` is the canonical way to do that on stable Rust.
Expand Down
7 changes: 7 additions & 0 deletions deploy/debian/changelog
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
syauth (0.2.0-1) unstable; urgency=medium

* Recover Bluetooth transport after controller loss.
* Report controller and advertising health independently of phone presence.

-- syauth contributors <maintainers@example.invalid> Sat, 07 Nov 2026 00:00:00 +0000

syauth (0.1.0-1) unstable; urgency=medium

* Initial release (Closes: #1).
Expand Down
6 changes: 3 additions & 3 deletions deploy/debian/control
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ Build-Depends: debhelper-compat (= 13),
dbus-daemon,
gzip
Standards-Version: 4.6.2
Homepage: https://github.com/sy/syauth
Vcs-Browser: https://github.com/sy/syauth
Vcs-Git: https://github.com/sy/syauth.git
Homepage: https://github.com/Mewplane/syauth
Vcs-Browser: https://github.com/Mewplane/syauth
Vcs-Git: https://github.com/Mewplane/syauth.git
Rules-Requires-Root: no

Package: syauth
Expand Down
2 changes: 1 addition & 1 deletion deploy/debian/copyright
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
Upstream-Name: syauth
Upstream-Contact: syauth contributors <noreply@anthropic.com>
Source: https://github.com/sy/syauth
Source: https://github.com/Mewplane/syauth

Files: *
Copyright: 2026 syauth contributors
Expand Down
4 changes: 2 additions & 2 deletions deploy/debian/rules
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#!/usr/bin/make -f
#
# Debian rules for syauth v0.1.0 (roadmap item S-021).
# Debian rules for syauth v0.2.0 (roadmap item S-021).
#
# Driven by debhelper-compat 13. The build chain is hand-rolled (not
# dh-cargo) because dh-cargo expects a single-crate package; syauth is
Expand Down Expand Up @@ -43,7 +43,7 @@ override_dh_auto_build:
# so the package surface is identical across distros.
mkdir -p debian/man
printf '%s\n' \
'.TH SYAUTH 8 "2026-05-15" "syauth 0.1.0" "System Administration"' \
'.TH SYAUTH 8 "2026-05-15" "syauth 0.2.0" "System Administration"' \
'.SH NAME' \
'syauth \- phone-as-key PAM authenticator for Linux' \
'.SH SYNOPSIS' \
Expand Down
9 changes: 6 additions & 3 deletions deploy/fedora/syauth.spec
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Fedora RPM spec for syauth v0.1.0 (roadmap item S-021).
# Fedora RPM spec for syauth v0.2.0 (roadmap item S-021).
#
# This spec ships the Linux desktop side of syauth — the PAM cdylib
# under %%{_libdir}/security/pam_syauth.so (mode 0644 per SPEC §6 +
Expand All @@ -12,7 +12,7 @@
# phone. Built under `mock -r fedora-%%{fedora}-x86_64 deploy/fedora/syauth.spec`
# or via `make rpm` (which gates on `which mock`).

%global package_version 0.1.0
%global package_version 0.2.0
%global rpm_release 5
%global debug_package %{nil}
%global min_fedora 39
Expand All @@ -23,7 +23,7 @@ Release: %{rpm_release}%{?dist}
Summary: Phone-as-key PAM authenticator for Linux

License: MIT
URL: https://github.com/sy/syauth
URL: https://github.com/Mewplane/syauth
Source0: %{name}-%{version}.tar.gz

# Cross-reference: deploy/version.env, /Cargo.toml [workspace.package].
Expand Down Expand Up @@ -164,6 +164,9 @@ fi
%{_mandir}/man8/syauth.8.gz

%changelog
* Sat Nov 07 2026 syauth contributors <maintainers@example.invalid> - 0.2.0-5
- Recover Bluetooth transport after controller loss and report transport health.

* Sat Oct 31 2026 syauth contributors <maintainers@example.invalid> - 0.1.0-5
- Select the available BlueZ default adapter when starting the presence daemon.

Expand Down
23 changes: 20 additions & 3 deletions deploy/release-notes.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,31 @@
# syauth 0.2.0

This release restores phone discovery after Bluetooth controller resets and
reports transport health separately from daemon liveness.

- Automatically rebuild GATT and rotating advertising after controller loss,
including controllers renamed from hci0 to hci1. Keep the existing pairing.
- Retry while the controller is unavailable without exhausting the service
restart limit. Bluetooth setup failures request recovery instead of leaving
a socket-only daemon.
- Add `daemon.transport_ready` to `syauth status --json`. Phone absence and an
unanswered approval do not indicate a failed local Bluetooth transport.
- Include patched ctutils and Tokio dependencies.

The companion panel update is in https://github.com/dmytrogajewski/sy/pull/9.
Each authentication still requires explicit phone approval and a strong biometric.

Approve Linux authentication on Android with a fresh strong biometric.

- Native desktop DEB, RPM, and Arch packages and Linux archives for x86_64 and ARM64.
- Signed Android companion with four native ABIs and a published signing certificate.
- Illustrated documentation: https://dmytrogajewski.github.io/syauth/
- Installer: `curl -fsSL https://dmytrogajewski.github.io/syauth/install.sh | sh`
- Illustrated documentation: https://mewplane.github.io/syauth/
- Installer: `curl -fsSL https://mewplane.github.io/syauth/install.sh | sh`

Packages install the CLI, PAM module, presence daemon, and user service. They do not enable PAM or start the service automatically. Follow the installation guide to prepare storage, pair the phone, select a PAM policy, and test your recovery method.

Linux requires glibc 2.36+; supported package paths include Debian 12+, Ubuntu 24.04+, and current Fedora/openSUSE/Arch systems. Android signing requires Android 13+ and a supported Ed25519 Keystore implementation, despite the APK's lower installation minimum.

Verify downloads against `SHA256SUMS`. `release.json` records the source commit and artifact digests. The Android release certificate SHA-256 fingerprint is `25:58:5E:64:1E:DB:3D:A8:7B:98:90:56:B3:D1:65:CA:C2:AF:AF:2A:AE:DD:35:87:56:66:B5:21:EC:C0:22:1C`.

Read the documented security boundaries before enabling PAM: https://dmytrogajewski.github.io/syauth/explanation/security/
Read the documented security boundaries before enabling PAM: https://mewplane.github.io/syauth/explanation/security/
6 changes: 3 additions & 3 deletions deploy/version.env
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,13 @@

# The wire-shipped package version. Mirrors the Rust workspace's
# `[workspace.package].version` field in /Cargo.toml. Bump in lockstep.
PACKAGE_VERSION=0.1.0
PACKAGE_VERSION=0.2.0

# RPM release counter (the `-1` in `syauth-0.1.0-1.fc39.x86_64.rpm`).
# RPM release counter (the `-1` in `syauth-0.2.0-1.fc39.x86_64.rpm`).
# Bump only if a respin is needed without changing the source version.
RPM_RELEASE=5

# Debian revision (the `-1` in `syauth_0.1.0-1_amd64.deb`). Same rule
# Debian revision (the `-1` in `syauth_0.2.0-1_amd64.deb`). Same rule
# as RPM_RELEASE.
DEB_REVISION=1

Expand Down
Loading
Loading