From 5d29bdc4bd84965eb5efe128795467a83af583ea Mon Sep 17 00:00:00 2001 From: Bendik Lynghaug Date: Sun, 16 Aug 2026 15:04:22 +0200 Subject: [PATCH] Pre-0.1 cleanup: fmt, docs, licenses, AUR-ready packaging - cargo fmt across the workspace (the CI gate the last push tripped). - varde-daemon: drop the now-unused bytes dependency. - varde-ctl(1): document push; gc reflects the continuous-sweep reality; subscribe mentions push events. - config.toml example: gc_interval_secs, and an honest note that max_download_bytes_per_sec is currently unenforced. - LICENSE-MIT + LICENSE-APACHE at the root (the declared license now ships as files), bundled into release tarballs and installed by the PKGBUILD. - PKGBUILD: real maintainer, AUR pre-flight note (updpkgsums), license installation. Co-Authored-By: Claude Fable 5 --- .gitea/workflows/release.yml | 2 +- Cargo.lock | 1 - LICENSE-APACHE | 202 ++++++++++++++++++++++++++++++++ LICENSE-MIT | 21 ++++ dist/PKGBUILD | 10 +- dist/config.toml | 8 +- dist/varde-ctl.1.scd | 13 +- varde-daemon/Cargo.toml | 1 - varde-daemon/src/daemon.rs | 8 +- varde-daemon/src/shaped.rs | 9 +- varde-daemon/src/store.rs | 19 ++- varde-daemon/tests/store_ops.rs | 3 +- 12 files changed, 272 insertions(+), 25 deletions(-) create mode 100644 LICENSE-APACHE create mode 100644 LICENSE-MIT diff --git a/.gitea/workflows/release.yml b/.gitea/workflows/release.yml index 3ea3af6..2ac2938 100644 --- a/.gitea/workflows/release.yml +++ b/.gitea/workflows/release.yml @@ -55,7 +55,7 @@ jobs: cp dist/config.toml "$PKG/config.toml.example" scdoc < dist/varde.8.scd > "$PKG/man/varde.8" scdoc < dist/varde-ctl.1.scd > "$PKG/man/varde-ctl.1" - cp README.md SPECS.md "$PKG/" + cp README.md SPECS.md LICENSE-MIT LICENSE-APACHE "$PKG/" tar czf "$PKG.tar.gz" "$PKG" sha256sum "$PKG.tar.gz" > "$PKG.tar.gz.sha256" diff --git a/Cargo.lock b/Cargo.lock index 911ef59..4b93373 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -4507,7 +4507,6 @@ name = "varde-daemon" version = "0.1.0" dependencies = [ "anyhow", - "bytes", "iroh", "iroh-blobs", "iroh-mdns-address-lookup", diff --git a/LICENSE-APACHE b/LICENSE-APACHE new file mode 100644 index 0000000..d645695 --- /dev/null +++ b/LICENSE-APACHE @@ -0,0 +1,202 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/LICENSE-MIT b/LICENSE-MIT new file mode 100644 index 0000000..69be072 --- /dev/null +++ b/LICENSE-MIT @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2026 Bendik Lynghaug + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/dist/PKGBUILD b/dist/PKGBUILD index f92a09f..533a207 100644 --- a/dist/PKGBUILD +++ b/dist/PKGBUILD @@ -1,7 +1,8 @@ -# Maintainer: you +# Maintainer: Bendik Lynghaug # -# UNTESTED SKELETON — best-effort Arch packaging for varde. Review before -# building; in particular pkgver/source must point at a real release. +# Before pushing to AUR: bump pkgver to the released tag and replace +# sha256sums with the real digest of the release tarball +# (`updpkgsums` does both checks in one step). pkgname=varde pkgver=0.1.0 @@ -46,4 +47,7 @@ package() { install -Dm644 varde.8 "$pkgdir/usr/share/man/man8/varde.8" install -Dm644 varde-ctl.1 "$pkgdir/usr/share/man/man1/varde-ctl.1" + + install -Dm644 LICENSE-MIT "$pkgdir/usr/share/licenses/$pkgname/LICENSE-MIT" + install -Dm644 LICENSE-APACHE "$pkgdir/usr/share/licenses/$pkgname/LICENSE-APACHE" } diff --git a/dist/config.toml b/dist/config.toml index be1918b..4247caa 100644 --- a/dist/config.toml +++ b/dist/config.toml @@ -16,9 +16,15 @@ # Upload cap in bytes/sec. 0 disables serving entirely. #max_upload_bytes_per_sec = 10485760 # 10 MiB/s -# Download cap in bytes/sec. 0 means unlimited. +# Download cap in bytes/sec. 0 means unlimited. Currently not +# enforced: the cap rode a seam the iroh-blobs 0.103 downloader does +# not expose yet. #max_download_bytes_per_sec = 0 +# Interval of the store's built-in garbage collector, in seconds. +# Unpinned blobs are swept by this loop; there is no on-demand gc. +#gc_interval_secs = 300 + # LAN peer discovery (mDNS). Discovery is the open tier: being visible # costs nothing; serving is still gated on trust and per-pin policy. #discovery = true diff --git a/dist/varde-ctl.1.scd b/dist/varde-ctl.1.scd index 31526ca..89f2f05 100644 --- a/dist/varde-ctl.1.scd +++ b/dist/varde-ctl.1.scd @@ -67,12 +67,21 @@ subcommand maps 1:1 onto a request. *peer list* Trusted peers and whether they are currently present on the LAN. +*push* _HASH_ _NODE-ID_ + Hand fully-present content to a trusted peer, unprompted. Consent + is mutual: the sender pushes only to trusted peers, and the + receiver accepts only from peers it trusts, pinning what it + accepted. The reply confirms verified delivery. + *gc* - Drop all blobs not reachable from a pin. Never runs implicitly. + Reports unimplemented since the move to iroh-blobs 0.103: garbage + collection runs continuously inside the store (see + *gc_interval_secs* in the config), protecting pins, tags and + in-flight imports on every sweep. *subscribe* Stream daemon events (transfer progress, peer presence, pin - completion) as JSON lines until interrupted. + completion, received pushes) as JSON lines until interrupted. # EXIT STATUS diff --git a/varde-daemon/Cargo.toml b/varde-daemon/Cargo.toml index 9ba7d10..62ece7c 100644 --- a/varde-daemon/Cargo.toml +++ b/varde-daemon/Cargo.toml @@ -22,7 +22,6 @@ iroh-mdns-address-lookup = "0.4" # dependency tree via iroh-blobs. n0-future = "0.1" irpc = "0.17" -bytes = "1" # Feature-gated D-Bus client for NetworkManager metered status. zbus = { version = "5", optional = true, default-features = false, features = ["tokio"] } # Announcement signatures use iroh's own key types; postcard is the diff --git a/varde-daemon/src/daemon.rs b/varde-daemon/src/daemon.rs index e05facf..d617241 100644 --- a/varde-daemon/src/daemon.rs +++ b/varde-daemon/src/daemon.rs @@ -382,7 +382,12 @@ impl Daemon { .present_trusted_peers() .into_iter() .filter(|p| p.connected) - .filter_map(|p| p.node_id.parse::().ok().map(iroh::EndpointAddr::from)) + .filter_map(|p| { + p.node_id + .parse::() + .ok() + .map(iroh::EndpointAddr::from) + }) .collect(); if !present.is_empty() { self.transfer.spawn_fetch( @@ -568,7 +573,6 @@ impl Daemon { Request::Subscribe {} => Ok(ResponseData::Done {}), } } - } fn blob_format(format: StoredFormat) -> BlobFormat { diff --git a/varde-daemon/src/shaped.rs b/varde-daemon/src/shaped.rs index 0a9037f..8e75763 100644 --- a/varde-daemon/src/shaped.rs +++ b/varde-daemon/src/shaped.rs @@ -160,9 +160,8 @@ pub fn provider_events(gate: Gate) -> EventSender { conns.remove(&m.inner.connection_id); } ProviderMessage::GetRequestReceived(m) => { - let allowed = allow(&gate, &conns, m.inner.connection_id, [ - m.inner.request.hash, - ]); + let allowed = + allow(&gate, &conns, m.inner.connection_id, [m.inner.request.hash]); let verdict = if allowed { Ok(()) } else { @@ -200,9 +199,7 @@ pub fn provider_events(gate: Gate) -> EventSender { .map(|i| i.trusted) .unwrap_or(false); let allowed = trusted - || allow(&gate, &conns, m.inner.connection_id, [ - m.inner.request.hash, - ]); + || allow(&gate, &conns, m.inner.connection_id, [m.inner.request.hash]); let verdict = if allowed { Ok(()) } else { diff --git a/varde-daemon/src/store.rs b/varde-daemon/src/store.rs index 3229d10..76f0902 100644 --- a/varde-daemon/src/store.rs +++ b/varde-daemon/src/store.rs @@ -197,10 +197,7 @@ impl BlobStore { Ok((root, total, StoredFormat::HashSeq)) } - async fn import_one( - &self, - path: PathBuf, - ) -> Result<(iroh_blobs::api::TempTag, u64), OpError> { + async fn import_one(&self, path: PathBuf) -> Result<(iroh_blobs::api::TempTag, u64), OpError> { let tag = self .store .add_path_with_opts(AddPathOptions { @@ -211,7 +208,13 @@ impl BlobStore { .temp_tag() .await .map_err(internal)?; - let size = match self.store.blobs().status(tag.hash()).await.map_err(internal)? { + let size = match self + .store + .blobs() + .status(tag.hash()) + .await + .map_err(internal)? + { BlobStatus::Complete { size } => size, _ => { return Err(OpError::Internal(anyhow::anyhow!( @@ -335,7 +338,11 @@ impl BlobStore { // report the bytes actually present and verified. let bitfield = self.store.blobs().observe(hash).await.map_err(internal)?; let total = bitfield.validated_size().or(size); - Ok((bitfield.total_bytes().min(total.unwrap_or(u64::MAX)), total, false)) + Ok(( + bitfield.total_bytes().min(total.unwrap_or(u64::MAX)), + total, + false, + )) } BlobStatus::Complete { size } => Ok((size, Some(size), true)), } diff --git a/varde-daemon/tests/store_ops.rs b/varde-daemon/tests/store_ops.rs index c0ec5c9..aaae39a 100644 --- a/varde-daemon/tests/store_ops.rs +++ b/varde-daemon/tests/store_ops.rs @@ -125,8 +125,7 @@ fn gc_drops_unpinned_and_keeps_pinned() { // Since iroh-blobs 0.103 gc is a periodic loop inside the store, not // an on-demand request; run it fast so the sweep happens in-test. let daemon_dir = tempfile::tempdir().unwrap(); - let daemon = - support::spawn_daemon_with_env(daemon_dir.path(), &[("VARDE_GC_INTERVAL", "1")]); + let daemon = support::spawn_daemon_with_env(daemon_dir.path(), &[("VARDE_GC_INTERVAL", "1")]); let mut client = support::Client::connect(&daemon.socket); let dir = tempfile::tempdir().unwrap();