diff --git a/.dockerignore b/.dockerignore new file mode 100644 index 0000000..4670fbc --- /dev/null +++ b/.dockerignore @@ -0,0 +1,5 @@ +target +tests/work +**/*.mwid2 +**/*.mwid2.lock +.git diff --git a/.drone.yml b/.drone.yml new file mode 100644 index 0000000..56a3123 --- /dev/null +++ b/.drone.yml @@ -0,0 +1,49 @@ +# Meow v2 (Rust workspace): checks, then the meowsrv image on Docker Hub. +# +# Repository secrets (same names as the Go meowsrv pipeline): +# dockerhub-user, dockerhub-pw Docker Hub credentials (an access token is better) +# dockerhub-repo e.g. "yourname/meowsrv" +# Images are tagged "v2" and "v2-", never "latest": the v1 server can keep +# using the same Docker Hub repository during the migration. + +kind: pipeline +type: docker +name: meowsrv + +services: + - name: redis + image: redis:7-alpine + +steps: + - name: check + image: rust:1 + environment: + MEOW_TEST_REDIS: redis://redis:6379/15 + commands: + - rustup component add rustfmt clippy + - scripts/check.sh + + - name: e2e + image: rust:1 + commands: + # CLI + two servers, in memory then on Redis. + - tests/e2e.sh + - E2E_STORAGE=redis://redis:6379/14 tests/e2e.sh + + - name: publish + image: plugins/docker + settings: + username: + from_secret: dockerhub-user + password: + from_secret: dockerhub-pw + repo: + from_secret: dockerhub-repo + dockerfile: Dockerfile + context: . + tags: + - v2 + - v2-${DRONE_COMMIT_SHA:0:8} + when: + branch: [main] + event: [push] diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..b4ac3a2 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,24 @@ +# Meow v2 relay server (meowsrv): static musl binary in a scratch image (no shell, no libc). +# docker build -t meowsrv:v2 . +FROM rust:1-alpine AS builder +RUN apk add --no-cache musl-dev +WORKDIR /src +COPY . . +RUN cargo build --release --locked -p meow-server --bin meowsrv \ + && mkdir -p /out/data \ + && cp target/release/meowsrv /out/meowsrv + +FROM scratch +COPY --from=builder /out/meowsrv /usr/bin/meowsrv +# Owned by the unprivileged user: a named volume mounted on /data inherits it. +COPY --from=builder --chown=10001:10001 /out/data /data +USER 10001:10001 +ENV MEOWSRV_LISTEN=0.0.0.0:8080 \ + MEOWSRV_KEY_FILE=/data/server.key \ + MEOWSRV_STORAGE=memory \ + MEOWSRV_LOG=info +VOLUME ["/data"] +EXPOSE 8080 +HEALTHCHECK --interval=30s --timeout=5s --start-period=10s --retries=3 \ + CMD ["/usr/bin/meowsrv", "healthcheck"] +ENTRYPOINT ["/usr/bin/meowsrv"] diff --git a/ROADMAP.md b/ROADMAP.md index 1959e15..692eaab 100644 --- a/ROADMAP.md +++ b/ROADMAP.md @@ -14,11 +14,17 @@ Pour reprendre le travail : lire ce fichier, prendre le premier lot ⬜ dont les ### Ordre conseillé pour la suite -1. ~~**3.8** livraison au moins une fois~~ ✅ -2. ~~**4.5** brancher `meow-store` dans le client et la CLI~~ ✅ -3. ~~5.5, 5.6, 5.9, 5.10~~ ✅ -4. ~~7.1 → 7.7~~ ✅, puis **7.8** (retrait de la v1). -5. Le reste (phases 8–10) selon les priorités. +Fait : phases 0 à 7.7 (bibliothèque, serveur, CLI, store, client, FFI, application). + +1. **7.9** essais réels sur appareils et build de release : valider ce qui n'a été testé qu'en + simulation (Bluetooth, Wi-Fi local, service de premier plan). +2. **5.7** fichiers en plusieurs morceaux (limite actuelle : 4 Mio) et **4.4** aperçus d'images. +3. **3.9** offre publiée chiffrée (aujourd'hui le serveur voit le nom et le message de + l'invitation) et **7.8** liens profonds. +4. **3.6** packaging du serveur, puis **10.1** déploiement d'un `meowsrv` v2 en parallèle du v1. +5. Durcissement : **5.8** trafic leurre, **2.5** rotation des clés de mailbox, **3.5** limites + et rate limiting, **9.x**. +6. Fonctions avancées (phase 8), dont Matriochka (8.2). ### Journal @@ -108,7 +114,7 @@ Pour reprendre le travail : lire ce fichier, prendre le premier lot ⬜ dont les | 5.4 | Réception : un pull par serveur regroupant toutes les mailbox, long-poll, traitement, événements | e2e | ✅ | | 5.5 | File d'envoi persistante avec retries et backoff, envoi hors ligne | Tests | ✅ | | 5.6 | Accusés de réception et de lecture chiffrés (dans le ratchet) | e2e | ✅ | -| 5.7 | Fichiers : découpage en morceaux, reprise, déduplication, limite de taille. Le contenu reçu doit être écrit sur disque **avant** l'ack : aujourd'hui, la CLI écrit les fichiers après `sync`, alors que les acks sont déjà partis | e2e (`send-file`) | 🟡 envoi en un seul morceau | +| 5.7 | Fichiers : découpage en morceaux (au-delà de 4 Mio), reprise, déduplication, limite de taille configurable. (Depuis 4.5, le contenu reçu est enregistré dans le store **avant** l'ack : plus de risque de perte.) | e2e (`send-file`) | 🟡 envoi en un seul morceau, 4 Mio au plus | | 5.8 | Trafic leurre : mailbox fictives dans les pulls, ordre aléatoire, padding des requêtes | Tests | ⬜ | | 5.9 | Stream d'événements (`tokio::broadcast`) et tâche de synchronisation en arrière-plan | Tests | ✅ | | 5.10 | Inviter directement dans un espace caché (le contact ne passe jamais par l'espace principal) | Tests | ✅ | @@ -127,11 +133,13 @@ Pour reprendre le travail : lire ce fichier, prendre le premier lot ⬜ dont les ## Phase 7 — `meow-ffi` + nouvelle application Flutter L'application est **refaite de zéro** dans `../bastet` (gabarit vide), l'ancienne étant -conservée dans `../bastet_v1`. On n'utilise plus `bastet_chatview` (trop lourd) : l'écran de +conservée dans `../bastet_v1`. La nouvelle n'utilise ni `meowjsonlib` ni `meowwrapper.dart` : +rien à « retirer » dans cette phase. L'arrêt de la v1 (app, `meowjsonlib`, `meowsrv` Go) relève +de la phase 10 (lot 10.4). On n'utilise plus `bastet_chatview` (trop lourd) : l'écran de conversation est un widget maison, léger. On réutilise de la v1 : * `peer_secure`, `ble_connect` et `lan_connect` pour les invitations en présentiel ; -* le thème (`lib/theme/`), les icônes et images (`assets/images`) et les traductions - (`assets/translations`). +* la palette (Papyrus, retravaillée en thème sable), le logo et les icônes (`assets/images`). + Les traductions de la v1 étaient vides : la v2 utilise les fichiers ARB de Flutter (en, fr). | Lot | Contenu | Fin | État | |---|---|---|---| @@ -143,7 +151,8 @@ conversation est un widget maison, léger. On réutilise de la v1 : | 7.5b | **En présentiel (Wi-Fi local / Bluetooth)** : `peer_secure` corrigé (engagement avant révélation des clés, données chiffrées et authentifiées, stockage de confiance en mémoire par défaut), code SAS de 6 chiffres à comparer, puis les 3 messages de l'invitation v2 sur le canal chiffré ; l'acquittement final passe par les serveurs. Bluetooth sur mobile, Wi-Fi local partout | Tests `peer_secure` (4), test du protocole (2), test d'intégration UI | ✅ (essai réel entre deux appareils à faire) | | 7.6 | Espaces cachés dans l'UI : « Ouvrir un espace » (conversations, réglages ; réponse neutre si rien ne s'ouvre), cacher et révéler un contact depuis sa fiche, inviter dans un espace caché (7.5) ; verrouillage automatique en arrière-plan (immédiat, 1 min, 5 min ou jamais) ; au verrouillage, fermeture de tout ce qui est ouvert au-dessus | Test d'intégration : cacher, verrouiller, absent, ouvrir, présent | ✅ | | 7.7 | Veille en arrière-plan sans mot de passe (fichier de veille de l'espace principal, chiffré par une clé de l'appareil, avec leurres ; pull sans ack avec curseur `after`) ; WorkManager (15 min) et service instantané au choix ; veille dans l'application verrouillée ; notifications neutres | Test Rust, test d'intégration Linux (notification verrouillée, contact caché ignoré, message intact), test Android sur émulateur (Keystore, WorkManager, notification) | ✅ (service instantané non essayé sur un vrai appareil) | -| 7.8 | Retrait de `meowjsonlib`, `meowwrapper.dart` et `bastet_v1` | | ⬜ | +| 7.8 | Liens profonds : ouvrir l'app sur `bastet://invite/…` et `https:///inv/…` (Android : intent filters ; Linux : gestionnaire d'URL), partage d'un fichier ou d'un texte vers Bastet | Test | ⬜ | +| 7.9 | Essais réels entre deux appareils : présentiel (Bluetooth et Wi-Fi local), notifications instantanées (service de premier plan), WorkManager sur un vrai téléphone ; build de release signé | Recette manuelle | ⬜ | ## Phase 8 — Fonctionnalités avancées @@ -184,7 +193,11 @@ conversation est un widget maison, léger. On réutilise de la v1 : --- -## Annexe A — Correspondance meowjsonlib → API v2 +## Annexe A — Correspondance meowjsonlib → API v2 (référence) + +Table écrite au début, quand l'ancienne application devait être portée : elle sert désormais +seulement à retrouver l'équivalent v2 d'une fonction v1. + | meowjsonlib (v1) | v2 (`meow-client` / FFI) | |---|---| diff --git a/crates/meow-server/src/main.rs b/crates/meow-server/src/main.rs index 3e9c2c1..c699ade 100644 --- a/crates/meow-server/src/main.rs +++ b/crates/meow-server/src/main.rs @@ -1,4 +1,7 @@ //! `meowsrv`: Meow v2 relay server. +//! +//! `meowsrv healthcheck` exits 0 when the local server answers `/healthz` (used by the +//! container image, which has no shell nor curl). use std::sync::Arc; @@ -10,8 +13,54 @@ use tokio::sync::broadcast; const MAX_PER_MAILBOX: usize = 10_000; +/// `meowsrv healthcheck`: GET /healthz on the local listen port (MEOWSRV_LISTEN). +fn healthcheck() -> i32 { + use std::io::{Read, Write}; + let listen = std::env::var("MEOWSRV_LISTEN").unwrap_or_else(|_| "127.0.0.1:8080".into()); + let port = listen.rsplit(':').next().unwrap_or("8080"); + let addr = format!("127.0.0.1:{port}"); + let Ok(sock) = addr.parse() else { return 2 }; + let timeout = std::time::Duration::from_secs(3); + let Ok(mut s) = std::net::TcpStream::connect_timeout(&sock, timeout) else { + return 1; + }; + let _ = s.set_read_timeout(Some(timeout)); + if s.write_all(b"GET /healthz HTTP/1.0\r\nHost: localhost\r\n\r\n").is_err() { + return 1; + } + let mut buf = [0u8; 16]; + match s.read(&mut buf) { + Ok(n) if buf[..n].starts_with(b"HTTP/1.1 200") || buf[..n].starts_with(b"HTTP/1.0 200") => 0, + _ => 1, + } +} + +/// Ctrl+C or SIGTERM (`docker stop`). +async fn shutdown_signal() { + #[cfg(unix)] + { + let mut term = match tokio::signal::unix::signal(tokio::signal::unix::SignalKind::terminate()) { + Ok(s) => s, + Err(_) => { + let _ = tokio::signal::ctrl_c().await; + return; + } + }; + tokio::select! { + _ = tokio::signal::ctrl_c() => {} + _ = term.recv() => {} + } + } + #[cfg(not(unix))] + let _ = tokio::signal::ctrl_c().await; + tracing::info!("shutting down"); +} + #[tokio::main] async fn main() -> anyhow::Result<()> { + if std::env::args().nth(1).as_deref() == Some("healthcheck") { + std::process::exit(healthcheck()); + } let cfg = Config::resolve(Args::parse())?; tracing_subscriber::fmt() .with_env_filter(tracing_subscriber::EnvFilter::new(&cfg.log)) @@ -42,9 +91,7 @@ async fn main() -> anyhow::Result<()> { let listener = tokio::net::TcpListener::bind(&cfg.listen).await?; tracing::info!("listening on {}", cfg.listen); axum::serve(listener, router(state)) - .with_graceful_shutdown(async { - let _ = tokio::signal::ctrl_c().await; - }) + .with_graceful_shutdown(shutdown_signal()) .await?; Ok(()) } diff --git a/deploy/.env.example b/deploy/.env.example new file mode 100644 index 0000000..43f743e --- /dev/null +++ b/deploy/.env.example @@ -0,0 +1,9 @@ +# Image published by the Drone pipeline (Docker Hub repository : tag v2). +MEOWSRV_IMAGE=yourname/meowsrv:v2 +# URL announced to clients (through your HTTPS reverse proxy). +MEOWSRV_PUBLIC_URL=https://meow2.example.org +MEOWSRV_NAME=meow +MEOWSRV_DESCRIPTION= +MEOWSRV_PORT=8081 +MEOWSRV_MAILBOX_TTL_DAYS=30 +MEOWSRV_LOG=info diff --git a/deploy/docker-compose.yml b/deploy/docker-compose.yml new file mode 100644 index 0000000..db0f735 --- /dev/null +++ b/deploy/docker-compose.yml @@ -0,0 +1,51 @@ +# Meow v2 relay server + Redis. +# +# cp .env.example .env # then edit +# docker compose up -d +# +# Put an HTTPS reverse proxy in front (MEOWSRV_PUBLIC_URL must be the URL clients use). +# Runs next to the v1 server (8080) by default: host port 8081. + +services: + meowsrv: + image: ${MEOWSRV_IMAGE:-meowsrv:v2} + container_name: meowsrv2 + restart: unless-stopped + depends_on: + redis: + condition: service_healthy + ports: + - "${MEOWSRV_PORT:-8081}:8080" + environment: + MEOWSRV_LISTEN: 0.0.0.0:8080 + MEOWSRV_PUBLIC_URL: ${MEOWSRV_PUBLIC_URL:?set MEOWSRV_PUBLIC_URL in .env} + MEOWSRV_NAME: ${MEOWSRV_NAME:-meow} + MEOWSRV_DESCRIPTION: ${MEOWSRV_DESCRIPTION:-} + MEOWSRV_STORAGE: redis://redis:6379/0 + MEOWSRV_KEY_FILE: /data/server.key + MEOWSRV_MAILBOX_TTL_DAYS: ${MEOWSRV_MAILBOX_TTL_DAYS:-30} + MEOWSRV_LOG: ${MEOWSRV_LOG:-info} + volumes: + # The server's identity (its key is pinned by every client: back it up). + - meowsrv-data:/data + read_only: true + cap_drop: [ALL] + security_opt: ["no-new-privileges:true"] + + redis: + image: redis:7-alpine + container_name: meowsrv2-redis + restart: unless-stopped + # Not published on the host: only meowsrv talks to it. + command: ["redis-server", "--appendonly", "yes", "--save", "", "--maxmemory-policy", "noeviction"] + volumes: + - redis-data:/data + healthcheck: + test: ["CMD", "redis-cli", "ping"] + interval: 10s + timeout: 3s + retries: 5 + +volumes: + meowsrv-data: + redis-data: