diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..84d6be6 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,113 @@ +# Changelog + +The version lives in `CAMEX_VERSION` in `src/version.h`. From 3.0.2 on, binaries are +published only as the [`latest`](https://github.com/OpenIPC/camex/releases/tag/latest) +release, rebuilt from every push to `master`; this file is the change history. + +## 3.0.2 — 2026-10-17 + +- Linux release binaries (`arm`, `mipsel`, `aarch64`, `x86_64`) are static and linked + against musl, and no longer packed with UPX (#54, PR #56). The 3.0.1 ones were linked + dynamically against glibc 2.38 and did not start on OpenIPC firmware (musl or uClibc, + no glibc). Toolchains: OpenIPC (arm), OpenWrt soft-float (mipsel, runs without an + FPU), Bootlin musl (aarch64, x86_64); `ci/build-musl.sh` builds them and runs the unit + tests under qemu-user. Checked on OpenIPC ARM and MIPS cameras. +- Android: the APK is 517 KB instead of 2.5 MB (#55). Release resources are shrunk and + only the `en`, `ru` and `zh-rCN` translations of the libraries are kept (PR #57); + AppCompat and Material are gone, the app uses platform classes and themes (PR #58). + The settings are a separate screen instead of a bottom sheet, with the same fields + and checks; "Show the key" replaces the password toggle. +- Releases: one release, `latest`, with stable file names and `SHA256SUMS` (#60); the + versioned releases `v2.3.8`, `v3.0.0` and `v3.0.1` are replaced by this file (#59). + +## 3.0.1 — 2026-10-16 + +- A changed auto-mode CONFIG (address, gateway, MTU, routes) is applied to the live + tunnel without restarting the client (#49, PR #50). Failed routes are retried on the + next handshake; a `CAMEX_TUN_FD` tunnel is kept and the log asks for a restart; on + macOS the new utun gets the new address and MTU. +- Client: a stop request while connecting (for example a slow TCP connect) is seen within + a second (PR #53). +- Tests: the #23 gaps are closed (#12 end to end, #15 expiry and reuse, #10 one-way + loss); the Android device test runs its server in its own Docker network (PR #50). + +## 3.0.0 — 2026-10-15 + +**Breaking: protocol v2 replaces v1** (#17, PR #48). A 3.x client or server does not +talk to 2.x, and there is no unencrypted mode. Update the server and all clients +together. + +- Protocol v2: a `Noise_NKpsk0_25519_ChaChaPoly_BLAKE2b` handshake (PR #46), rekeying + under traffic, replay protection. The server has a key pair (`--genkey`); clients + need the server public key and the pre-shared key. Keys are raw 32-byte values or + Argon2id passphrases (#14, PR #47). Closes #13 and #14. +- Server: client keys are bound to client IDs and spoofed tunnel source addresses are + dropped (#5, #6, PR #29); REGISTER is replay-checked and a session is bound to the + client's nonce prefix (#7, PR #35); TCP connections hold a limited pre-auth slot until + they register (#9, PR #37); the auto pool hands out unique .2–.254 addresses, and + `allow_unknown_clients` controls clients without a config block (#15, PR #38). +- Hardening (#16, PR #39): rate-limited peer-triggered logs, keys revoked on reload, an + `FD_SETSIZE` guard, a TCP connect timeout. CONFIG addresses are validated, and macOS + runs `/sbin/route` without a shell (#12, PR #28). +- Networking: per-connection TCP send buffers, pending data dropped on close (#8, + PR #25); TCP frames no longer desync on partial reads under bursts (PR #4); the + client detects a lost server and recovers after a server restart (#10, PR #26). +- Kernel module: `/dev/camex` is restricted to `CAP_NET_ADMIN`, and the module builds + against current kernels (#11, PR #27). +- Android: the VPN interface is created from the server's CONFIG and the app's own + traffic stays outside it (#18, #19, PR #30); the APK of every new release is posted to + the OpenIPC Telegram channel (#43, PR #44). +- Internal: a packet backend interface instead of direct TUN calls (#20, PR #41). +- Docs: README in Russian and Simplified Chinese (PR #32), the security model (#22, + PR #40), Android screenshots (#42, PR #45). + +## 2.3.8 — 2026-06-19 + +- Android: OpenIPC launcher icon and more connection settings (PR #3). +- CI: secrets are no longer used in `if:` conditions. + +## 2.3.7 — 2026-06-16 + +- Android: the APK can be signed and runs; connection settings in a bottom sheet (PR #2). +- One version source (`src/version.h`) for all targets; `make apk` handles a signed APK. + +## 2.3.6 — 2026-06-15 + +- Fixes from a code review (11 items); out-of-tree builds with `BUILD_DIR`. + +## 2.3.5 — 2026-06-15 + +- Windows builds for x86_64 and i686, checked under Wine in CI. + +## 2.3.4 — 2026-06-15 + +- Keepalive packets and a configurable server timeout. + +## 2.3.3 — 2026-06-15 + +- Automatic addresses for clients without a config block; REGISTER is rate-limited. + +## 2.3.2 — 2026-06-15 + +- `EINTR` handling, less log noise from rate limiting, `accept()` retried, PID file + removed on exit. + +## 2.3.1 — 2026-06-15 + +- Fixes: a TCP buffer overflow, data loss with several clients, the send nonce prefix + rotated on reconnect, the encrypted DATA sequence number on the server. +- MinGW builds fixed; release asset names normalized. + +## 2.3.0 — 2026-06-14 + +- MinGW build warnings fixed. + +## 2.2.0 — 2026-06-14 + +- Sources moved to `src/`; WinTUN adapter for Windows and release packaging; UDP NAT + handling and TCP registration fixes; macOS, Windows and Android CI builds. + +## Before 2.2.0 + +- 2026-04-28 onwards: the initial camex code — userspace TUN tunnel over UDP and TCP + with a server, clients and the optional `camex.ko` kernel module. diff --git a/README.md b/README.md index 776bb33..796eeda 100644 --- a/README.md +++ b/README.md @@ -705,6 +705,9 @@ memory is unavailable in this context the packet is dropped ## Versioning & Release Process +The change history of every version is in [CHANGELOG.md](CHANGELOG.md); a version +bump adds its section there in the same PR. + ### Single source of truth The **only** place to change the software version is `src/version.h`: diff --git a/README.ru.md b/README.ru.md index 32c5c53..1307f6f 100644 --- a/README.ru.md +++ b/README.ru.md @@ -711,6 +711,9 @@ sudo rmmod camex ## Версионирование и процесс релиза +История изменений по версиям — в [CHANGELOG.md](CHANGELOG.md) (на английском); при смене +версии её раздел добавляется туда в том же PR. + ### Единый источник истины **Единственное** место, где меняется версия ПО, — `src/version.h`: diff --git a/README.zh-CN.md b/README.zh-CN.md index 0ed85ea..056ad16 100644 --- a/README.zh-CN.md +++ b/README.zh-CN.md @@ -682,6 +682,9 @@ sudo rmmod camex ## 版本管理与发布流程 +各版本的变更历史见 [CHANGELOG.md](CHANGELOG.md)（英文）；每次修改版本号时， +在同一个 PR 中向其中添加对应章节。 + ### 唯一的版本来源 修改软件版本的**唯一**位置是 `src/version.h`：