unseenet 0.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (34) hide show
  1. unseenet-0.1.0/LICENSE +177 -0
  2. unseenet-0.1.0/NOTICE +11 -0
  3. unseenet-0.1.0/PKG-INFO +247 -0
  4. unseenet-0.1.0/README.md +211 -0
  5. unseenet-0.1.0/pyproject.toml +57 -0
  6. unseenet-0.1.0/setup.cfg +4 -0
  7. unseenet-0.1.0/src/unseenet/__init__.py +12 -0
  8. unseenet-0.1.0/src/unseenet/cli.py +363 -0
  9. unseenet-0.1.0/src/unseenet/client/__init__.py +1 -0
  10. unseenet-0.1.0/src/unseenet/client/session.py +432 -0
  11. unseenet-0.1.0/src/unseenet/client/tui.py +663 -0
  12. unseenet-0.1.0/src/unseenet/core/__init__.py +1 -0
  13. unseenet-0.1.0/src/unseenet/core/article.py +245 -0
  14. unseenet-0.1.0/src/unseenet/core/crypto.py +155 -0
  15. unseenet-0.1.0/src/unseenet/core/encoding.py +35 -0
  16. unseenet-0.1.0/src/unseenet/core/groups.py +275 -0
  17. unseenet-0.1.0/src/unseenet/core/pow.py +50 -0
  18. unseenet-0.1.0/src/unseenet/core/store.py +196 -0
  19. unseenet-0.1.0/src/unseenet/core/tor.py +171 -0
  20. unseenet-0.1.0/src/unseenet/core/vault.py +125 -0
  21. unseenet-0.1.0/src/unseenet/nntp.py +121 -0
  22. unseenet-0.1.0/src/unseenet/node/__init__.py +1 -0
  23. unseenet-0.1.0/src/unseenet/node/peering.py +68 -0
  24. unseenet-0.1.0/src/unseenet/node/server.py +423 -0
  25. unseenet-0.1.0/src/unseenet.egg-info/PKG-INFO +247 -0
  26. unseenet-0.1.0/src/unseenet.egg-info/SOURCES.txt +32 -0
  27. unseenet-0.1.0/src/unseenet.egg-info/dependency_links.txt +1 -0
  28. unseenet-0.1.0/src/unseenet.egg-info/entry_points.txt +4 -0
  29. unseenet-0.1.0/src/unseenet.egg-info/requires.txt +10 -0
  30. unseenet-0.1.0/src/unseenet.egg-info/top_level.txt +1 -0
  31. unseenet-0.1.0/tests/test_node.py +106 -0
  32. unseenet-0.1.0/tests/test_protocol.py +125 -0
  33. unseenet-0.1.0/tests/test_session.py +95 -0
  34. unseenet-0.1.0/tests/test_tui.py +108 -0
unseenet-0.1.0/LICENSE ADDED
@@ -0,0 +1,177 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
unseenet-0.1.0/NOTICE ADDED
@@ -0,0 +1,11 @@
1
+ Unseenet
2
+ Copyright 2026 Andreas Lorensen and Unseenet contributors
3
+
4
+ The source code is licensed under the Apache License, Version 2.0 (LICENSE).
5
+
6
+ The protocol specification in rfc/ and the logo in assets/ are licensed
7
+ under the Creative Commons Attribution 4.0 International License
8
+ (CC BY 4.0), see rfc/LICENSE.md and assets/LICENSE.md.
9
+
10
+ The logo wordmark is DejaVu Sans Mono Bold converted to outlines
11
+ (Bitstream Vera / DejaVu font license).
@@ -0,0 +1,247 @@
1
+ Metadata-Version: 2.4
2
+ Name: unseenet
3
+ Version: 0.1.0
4
+ Summary: A Usenet-style, decentralized and encrypted discussion network over Tor onion services
5
+ Author: Andreas Lorensen
6
+ License-Expression: Apache-2.0
7
+ Project-URL: Homepage, https://github.com/andlo/unseenet
8
+ Project-URL: Documentation, https://andlo.github.io/unseenet/
9
+ Project-URL: Changelog, https://github.com/andlo/unseenet/blob/main/CHANGELOG.md
10
+ Project-URL: Specification, https://github.com/andlo/unseenet/tree/main/rfc
11
+ Keywords: usenet,nntp,tor,onion,decentralized,encryption,bbs,privacy
12
+ Classifier: Development Status :: 2 - Pre-Alpha
13
+ Classifier: Environment :: Console
14
+ Classifier: Operating System :: POSIX :: Linux
15
+ Classifier: Operating System :: MacOS
16
+ Classifier: Programming Language :: Python :: 3
17
+ Classifier: Programming Language :: Python :: 3.11
18
+ Classifier: Programming Language :: Python :: 3.12
19
+ Classifier: Programming Language :: Python :: 3.13
20
+ Classifier: Programming Language :: Python :: 3.14
21
+ Classifier: Topic :: Communications :: Usenet News
22
+ Classifier: Topic :: Security :: Cryptography
23
+ Requires-Python: >=3.11
24
+ Description-Content-Type: text/markdown
25
+ License-File: LICENSE
26
+ License-File: NOTICE
27
+ Requires-Dist: pynacl>=1.5
28
+ Requires-Dist: python-socks[asyncio]>=2.4
29
+ Provides-Extra: tui
30
+ Requires-Dist: textual>=0.80; extra == "tui"
31
+ Provides-Extra: dev
32
+ Requires-Dist: pytest>=8; extra == "dev"
33
+ Requires-Dist: pytest-asyncio>=0.23; extra == "dev"
34
+ Requires-Dist: textual>=0.80; extra == "dev"
35
+ Dynamic: license-file
36
+
37
+ <p align="center">
38
+ <picture>
39
+ <source media="(prefers-color-scheme: dark)" srcset="assets/logo-dark.svg">
40
+ <img src="assets/logo-light.svg" alt="Unseenet" width="440">
41
+ </picture>
42
+ </p>
43
+
44
+ **📖 Documentation: [andlo.github.io/unseenet](https://andlo.github.io/unseenet/)**
45
+
46
+ **Usenet, unseen.** A decentralized, encrypted discussion network in the
47
+ spirit of old Usenet and BBSes — groups and chats you can reach by
48
+ running one program from a USB stick, carried between independently run
49
+ nodes over Tor onion services.
50
+
51
+ > Status: **pre-alpha / design phase.** The protocol is being written
52
+ > down in the [UN-RFC series](rfc/). The Python code here is a first
53
+ > working skeleton of it. Nothing is stable yet, and it has not had a
54
+ > security review. Do not rely on it to protect anyone yet.
55
+
56
+ ---
57
+
58
+ ## The idea
59
+
60
+ In the old days, you connected to *your* news server. Your server
61
+ exchanged articles with other servers, and before long your post had
62
+ travelled around the world. Nobody owned Usenet. Anyone could run a
63
+ server. You could read it with any newsreader.
64
+
65
+ Unseenet brings that model back, with what we have learned since:
66
+
67
+ - **Easy access.** One program, no installation, no account, no public
68
+ IP, no port forwarding. Put it on a USB stick and go.
69
+ - **Decentralized.** Anyone can run a node — on a Raspberry Pi, a
70
+ homelab container, a VPS. Nodes replicate groups to each other the
71
+ way Usenet servers did. There is no central server and no company.
72
+ - **Encrypted where it matters.** Closed groups are end-to-end
73
+ encrypted. The nodes that carry them see only ciphertext.
74
+ - **Hard to seize.** The client keeps everything in one encrypted
75
+ vault. Nodes never hold group keys. A stolen stick or a seized server
76
+ reveals as little as possible.
77
+ - **Hidden.** Every node is a Tor onion service. Nobody needs to know
78
+ where a node is, or who is reading.
79
+ - **Open protocol.** Specified in numbered RFC-style documents, so
80
+ others can write their own nodes and clients — exactly like in the
81
+ old days.
82
+
83
+ ## How it works
84
+
85
+ ```
86
+ you (USB stick) the network
87
+ +-----------+ Tor +--------+ Tor +--------+
88
+ | unseenet | <---------> | node A | <---> | node B | <---> ...
89
+ | client | ONNTP +--------+ +--------+
90
+ +-----------+ ^ ^
91
+ encrypted vault +---- node C -----+
92
+ ```
93
+
94
+ - **Articles** are signed with the author's key. Their Message-ID is a
95
+ hash of their content, so they cannot be forged or altered in transit.
96
+ - **Groups** are owned. A group's name includes a fingerprint of its
97
+ owner's key (`dk.snak@ab3k5x7qwe2rtz4m`), so nobody can hijack it, and
98
+ its settings live in a signed *manifest*.
99
+ - **Group types** are chosen by the owner:
100
+
101
+ | Type | Read | Post | Encrypted |
102
+ |-------------|--------------|-----------------------------------|-----------|
103
+ | `open` | anyone | anyone | no |
104
+ | `moderated` | anyone | moderators, or with approval | no |
105
+ | `channel` | anyone | owner and chosen posters | no |
106
+ | `closed` | members only | members only | yes |
107
+
108
+ - **Spam** is priced, not policed: every post carries a small
109
+ proof-of-work ("postage"), a fraction of a second for a person, costly
110
+ in bulk.
111
+ - **Three authorities, no rulers.** Group owners decide who may post in
112
+ their group. Node operators decide which groups and peers they carry.
113
+ Readers decide what they see.
114
+ - **Text only.** No binaries. Articles are at most 64 KiB. That keeps
115
+ nodes small and their operators out of trouble.
116
+ - **Standard tools.** The wire protocol, ONNTP, is a strict profile of
117
+ NNTP. Classic newsreaders can talk to a node.
118
+
119
+ ## The specification
120
+
121
+ The protocol is defined in the **UN-RFC** series. The documents are the
122
+ authority; this code is just one implementation.
123
+
124
+ | No. | Title |
125
+ |-----|-------|
126
+ | [0000](rfc/un-rfc-0000.md) | The Unseenet Request for Comments Process |
127
+ | [0001](rfc/un-rfc-0001.md) | Architecture and Terminology |
128
+ | [0002](rfc/un-rfc-0002.md) | Article Format |
129
+ | [0003](rfc/un-rfc-0003.md) | Identities, Keys and Cryptographic Primitives |
130
+ | [0004](rfc/un-rfc-0004.md) | Groups, Manifests and Access Control |
131
+ | [0005](rfc/un-rfc-0005.md) | ONNTP: Transport and Peering over Onion Services |
132
+ | [0006](rfc/un-rfc-0006.md) | Proof-of-Work Postage |
133
+ | [0007](rfc/un-rfc-0007.md) | Protecting Data at Rest |
134
+
135
+ Want to change the protocol or build something compatible? Read
136
+ [UN-RFC 0000](rfc/un-rfc-0000.md) for how.
137
+
138
+ ## Trying it
139
+
140
+ Requires Python 3.11+ and the `tor` binary (`dnf install tor` / `apt install tor`).
141
+
142
+ ### The client
143
+
144
+ ```bash
145
+ pipx install "unseenet[tui]"
146
+ unseenet-tui
147
+ ```
148
+
149
+ (or from a clone: `pip install -e ".[tui]"`)
150
+
151
+ On first start you choose a passphrase for your vault, a display name, and
152
+ the node to connect to (its `.onion` address). Then:
153
+
154
+ | Key | |
155
+ |-----|---|
156
+ | `g` | browse the node's groups and subscribe |
157
+ | `n` / `r` | new post / reply (Ctrl+S sends) |
158
+ | `c` | create a group (open, moderated, channel or closed) |
159
+ | `k` | show your key, so a group owner can invite you |
160
+ | `i` | invite someone to a closed group you own |
161
+ | `j` | join a group by ID or `unseenet:join` link |
162
+ | `F5` | refresh (also happens every 30 seconds) |
163
+
164
+ Everything is kept in `unseenet.vault`, encrypted, next to where you run it,
165
+ and the posts you have fetched stay readable offline.
166
+ There is also a plain command line client, `unseenet --help`.
167
+
168
+ ### A node
169
+
170
+ On Debian or Ubuntu (a Proxmox LXC or a Raspberry Pi is plenty):
171
+
172
+ ```bash
173
+ curl -fsSL https://raw.githubusercontent.com/andlo/unseenet/main/deploy/install-node.sh | sudo bash
174
+ ```
175
+
176
+ It installs Tor and the node as a systemd service and prints the node's
177
+ `.onion` address. The full guide - configuration, peering, backup,
178
+ security and troubleshooting - is in the
179
+ [documentation](https://andlo.github.io/unseenet/node/install/). To peer with a friend's node, add a `[[peer]]` section
180
+ to `/home/unseenet/node.toml` on both nodes (same `password`, each using
181
+ the other's `name` and address) and restart with
182
+ `systemctl restart unseenet-node`.
183
+
184
+ For development, a node can run without Tor:
185
+ `unseenet-node --no-tor --data /tmp/node --listen 127.0.0.1:1119`.
186
+
187
+ ## Talk about Unseenet - on Unseenet
188
+
189
+ Two open groups are carried by the project's test nodes:
190
+
191
+ | Group | For |
192
+ |-------|-----|
193
+ | `unseenet@ph5fc5hop5232qsz` | The project: protocol, software, ideas, questions |
194
+ | `unseenet.test@ph5fc5hop5232qsz` | Test posts - say hello, try replies |
195
+
196
+ Both are owned by the project key
197
+ `ed25519:det5dxevwbk36eds2indrzlazyri3fq3bgdzw6kx4ems3o267sya`.
198
+ Connect to the test node
199
+ `f6vnchi5p7ll4yn6yot6cz4ohzuxy3uhc3kztafuwn3zlyoup6tn64qd.onion`,
200
+ press `j` in the TUI and paste a group ID (or `g` to browse).
201
+ The test nodes may be reset at any time while Unseenet is pre-alpha.
202
+
203
+ ## Roadmap
204
+
205
+ - [x] Protocol drafts UN-RFC 0000–0007
206
+ - [x] Article signing, content-derived Message-IDs, postage
207
+ - [x] Manifests, four group types, moderation approvals, cancels
208
+ - [x] Closed groups: epochs, member keys, sealed envelopes, E2E encryption
209
+ - [x] Node: ONNTP server, validation, streaming feeds to peers
210
+ - [x] Tor: own process, onion service via control port, SOCKS
211
+ - [x] Client: encrypted vault, command line
212
+ - [x] First real test: two nodes peering over Tor
213
+ - [x] TUI client (first version): groups, threads, posting, closed groups, invites
214
+ - [x] Node install script and systemd service
215
+ - [x] Encrypted offline cache; documentation site; releases on PyPI
216
+ - [ ] Pull catch-up between nodes (NEWNEWS)
217
+ - [ ] Chat view in the TUI
218
+ - [ ] Portable builds with bundled Tor for USB (Linux, Windows, macOS)
219
+ - [ ] Low-latency chat delivery (UN-RFC 0008)
220
+ - [ ] Moderation submission queue (UN-RFC 0009)
221
+ - [ ] Node discovery (UN-RFC 0010)
222
+ - [ ] Independent security review
223
+ - [ ] A second, independent implementation
224
+
225
+ ## Contributing
226
+
227
+ Ideas, criticism and code are welcome. Protocol changes go through the
228
+ UN-RFC process; code changes through ordinary pull requests. See
229
+ [docs/development.md](docs/development.md) for architecture and design
230
+ decisions.
231
+
232
+ ## På dansk
233
+
234
+ Unseenet er et decentralt og krypteret diskussionsnet i stil med det
235
+ gamle Usenet og BBS'erne. Du kører én klient, gerne fra en USB-pind,
236
+ kobler dig på en node over Tor, og noderne udveksler grupper med
237
+ hinanden. Åbne grupper er som det gamle Usenet; lukkede grupper er
238
+ end-to-end-krypterede, så noderne kun ser støj. Protokollen beskrives i
239
+ RFC-lignende dokumenter, så alle kan lave kompatible noder og klienter.
240
+
241
+ ## License
242
+
243
+ - Code: [Apache License 2.0](LICENSE)
244
+ - Protocol specification (`rfc/`) and logo (`assets/`):
245
+ [CC BY 4.0](rfc/LICENSE.md) — copy, quote and implement freely, with credit
246
+
247
+ Anyone may implement the protocol; no license is needed for that.
@@ -0,0 +1,211 @@
1
+ <p align="center">
2
+ <picture>
3
+ <source media="(prefers-color-scheme: dark)" srcset="assets/logo-dark.svg">
4
+ <img src="assets/logo-light.svg" alt="Unseenet" width="440">
5
+ </picture>
6
+ </p>
7
+
8
+ **📖 Documentation: [andlo.github.io/unseenet](https://andlo.github.io/unseenet/)**
9
+
10
+ **Usenet, unseen.** A decentralized, encrypted discussion network in the
11
+ spirit of old Usenet and BBSes — groups and chats you can reach by
12
+ running one program from a USB stick, carried between independently run
13
+ nodes over Tor onion services.
14
+
15
+ > Status: **pre-alpha / design phase.** The protocol is being written
16
+ > down in the [UN-RFC series](rfc/). The Python code here is a first
17
+ > working skeleton of it. Nothing is stable yet, and it has not had a
18
+ > security review. Do not rely on it to protect anyone yet.
19
+
20
+ ---
21
+
22
+ ## The idea
23
+
24
+ In the old days, you connected to *your* news server. Your server
25
+ exchanged articles with other servers, and before long your post had
26
+ travelled around the world. Nobody owned Usenet. Anyone could run a
27
+ server. You could read it with any newsreader.
28
+
29
+ Unseenet brings that model back, with what we have learned since:
30
+
31
+ - **Easy access.** One program, no installation, no account, no public
32
+ IP, no port forwarding. Put it on a USB stick and go.
33
+ - **Decentralized.** Anyone can run a node — on a Raspberry Pi, a
34
+ homelab container, a VPS. Nodes replicate groups to each other the
35
+ way Usenet servers did. There is no central server and no company.
36
+ - **Encrypted where it matters.** Closed groups are end-to-end
37
+ encrypted. The nodes that carry them see only ciphertext.
38
+ - **Hard to seize.** The client keeps everything in one encrypted
39
+ vault. Nodes never hold group keys. A stolen stick or a seized server
40
+ reveals as little as possible.
41
+ - **Hidden.** Every node is a Tor onion service. Nobody needs to know
42
+ where a node is, or who is reading.
43
+ - **Open protocol.** Specified in numbered RFC-style documents, so
44
+ others can write their own nodes and clients — exactly like in the
45
+ old days.
46
+
47
+ ## How it works
48
+
49
+ ```
50
+ you (USB stick) the network
51
+ +-----------+ Tor +--------+ Tor +--------+
52
+ | unseenet | <---------> | node A | <---> | node B | <---> ...
53
+ | client | ONNTP +--------+ +--------+
54
+ +-----------+ ^ ^
55
+ encrypted vault +---- node C -----+
56
+ ```
57
+
58
+ - **Articles** are signed with the author's key. Their Message-ID is a
59
+ hash of their content, so they cannot be forged or altered in transit.
60
+ - **Groups** are owned. A group's name includes a fingerprint of its
61
+ owner's key (`dk.snak@ab3k5x7qwe2rtz4m`), so nobody can hijack it, and
62
+ its settings live in a signed *manifest*.
63
+ - **Group types** are chosen by the owner:
64
+
65
+ | Type | Read | Post | Encrypted |
66
+ |-------------|--------------|-----------------------------------|-----------|
67
+ | `open` | anyone | anyone | no |
68
+ | `moderated` | anyone | moderators, or with approval | no |
69
+ | `channel` | anyone | owner and chosen posters | no |
70
+ | `closed` | members only | members only | yes |
71
+
72
+ - **Spam** is priced, not policed: every post carries a small
73
+ proof-of-work ("postage"), a fraction of a second for a person, costly
74
+ in bulk.
75
+ - **Three authorities, no rulers.** Group owners decide who may post in
76
+ their group. Node operators decide which groups and peers they carry.
77
+ Readers decide what they see.
78
+ - **Text only.** No binaries. Articles are at most 64 KiB. That keeps
79
+ nodes small and their operators out of trouble.
80
+ - **Standard tools.** The wire protocol, ONNTP, is a strict profile of
81
+ NNTP. Classic newsreaders can talk to a node.
82
+
83
+ ## The specification
84
+
85
+ The protocol is defined in the **UN-RFC** series. The documents are the
86
+ authority; this code is just one implementation.
87
+
88
+ | No. | Title |
89
+ |-----|-------|
90
+ | [0000](rfc/un-rfc-0000.md) | The Unseenet Request for Comments Process |
91
+ | [0001](rfc/un-rfc-0001.md) | Architecture and Terminology |
92
+ | [0002](rfc/un-rfc-0002.md) | Article Format |
93
+ | [0003](rfc/un-rfc-0003.md) | Identities, Keys and Cryptographic Primitives |
94
+ | [0004](rfc/un-rfc-0004.md) | Groups, Manifests and Access Control |
95
+ | [0005](rfc/un-rfc-0005.md) | ONNTP: Transport and Peering over Onion Services |
96
+ | [0006](rfc/un-rfc-0006.md) | Proof-of-Work Postage |
97
+ | [0007](rfc/un-rfc-0007.md) | Protecting Data at Rest |
98
+
99
+ Want to change the protocol or build something compatible? Read
100
+ [UN-RFC 0000](rfc/un-rfc-0000.md) for how.
101
+
102
+ ## Trying it
103
+
104
+ Requires Python 3.11+ and the `tor` binary (`dnf install tor` / `apt install tor`).
105
+
106
+ ### The client
107
+
108
+ ```bash
109
+ pipx install "unseenet[tui]"
110
+ unseenet-tui
111
+ ```
112
+
113
+ (or from a clone: `pip install -e ".[tui]"`)
114
+
115
+ On first start you choose a passphrase for your vault, a display name, and
116
+ the node to connect to (its `.onion` address). Then:
117
+
118
+ | Key | |
119
+ |-----|---|
120
+ | `g` | browse the node's groups and subscribe |
121
+ | `n` / `r` | new post / reply (Ctrl+S sends) |
122
+ | `c` | create a group (open, moderated, channel or closed) |
123
+ | `k` | show your key, so a group owner can invite you |
124
+ | `i` | invite someone to a closed group you own |
125
+ | `j` | join a group by ID or `unseenet:join` link |
126
+ | `F5` | refresh (also happens every 30 seconds) |
127
+
128
+ Everything is kept in `unseenet.vault`, encrypted, next to where you run it,
129
+ and the posts you have fetched stay readable offline.
130
+ There is also a plain command line client, `unseenet --help`.
131
+
132
+ ### A node
133
+
134
+ On Debian or Ubuntu (a Proxmox LXC or a Raspberry Pi is plenty):
135
+
136
+ ```bash
137
+ curl -fsSL https://raw.githubusercontent.com/andlo/unseenet/main/deploy/install-node.sh | sudo bash
138
+ ```
139
+
140
+ It installs Tor and the node as a systemd service and prints the node's
141
+ `.onion` address. The full guide - configuration, peering, backup,
142
+ security and troubleshooting - is in the
143
+ [documentation](https://andlo.github.io/unseenet/node/install/). To peer with a friend's node, add a `[[peer]]` section
144
+ to `/home/unseenet/node.toml` on both nodes (same `password`, each using
145
+ the other's `name` and address) and restart with
146
+ `systemctl restart unseenet-node`.
147
+
148
+ For development, a node can run without Tor:
149
+ `unseenet-node --no-tor --data /tmp/node --listen 127.0.0.1:1119`.
150
+
151
+ ## Talk about Unseenet - on Unseenet
152
+
153
+ Two open groups are carried by the project's test nodes:
154
+
155
+ | Group | For |
156
+ |-------|-----|
157
+ | `unseenet@ph5fc5hop5232qsz` | The project: protocol, software, ideas, questions |
158
+ | `unseenet.test@ph5fc5hop5232qsz` | Test posts - say hello, try replies |
159
+
160
+ Both are owned by the project key
161
+ `ed25519:det5dxevwbk36eds2indrzlazyri3fq3bgdzw6kx4ems3o267sya`.
162
+ Connect to the test node
163
+ `f6vnchi5p7ll4yn6yot6cz4ohzuxy3uhc3kztafuwn3zlyoup6tn64qd.onion`,
164
+ press `j` in the TUI and paste a group ID (or `g` to browse).
165
+ The test nodes may be reset at any time while Unseenet is pre-alpha.
166
+
167
+ ## Roadmap
168
+
169
+ - [x] Protocol drafts UN-RFC 0000–0007
170
+ - [x] Article signing, content-derived Message-IDs, postage
171
+ - [x] Manifests, four group types, moderation approvals, cancels
172
+ - [x] Closed groups: epochs, member keys, sealed envelopes, E2E encryption
173
+ - [x] Node: ONNTP server, validation, streaming feeds to peers
174
+ - [x] Tor: own process, onion service via control port, SOCKS
175
+ - [x] Client: encrypted vault, command line
176
+ - [x] First real test: two nodes peering over Tor
177
+ - [x] TUI client (first version): groups, threads, posting, closed groups, invites
178
+ - [x] Node install script and systemd service
179
+ - [x] Encrypted offline cache; documentation site; releases on PyPI
180
+ - [ ] Pull catch-up between nodes (NEWNEWS)
181
+ - [ ] Chat view in the TUI
182
+ - [ ] Portable builds with bundled Tor for USB (Linux, Windows, macOS)
183
+ - [ ] Low-latency chat delivery (UN-RFC 0008)
184
+ - [ ] Moderation submission queue (UN-RFC 0009)
185
+ - [ ] Node discovery (UN-RFC 0010)
186
+ - [ ] Independent security review
187
+ - [ ] A second, independent implementation
188
+
189
+ ## Contributing
190
+
191
+ Ideas, criticism and code are welcome. Protocol changes go through the
192
+ UN-RFC process; code changes through ordinary pull requests. See
193
+ [docs/development.md](docs/development.md) for architecture and design
194
+ decisions.
195
+
196
+ ## På dansk
197
+
198
+ Unseenet er et decentralt og krypteret diskussionsnet i stil med det
199
+ gamle Usenet og BBS'erne. Du kører én klient, gerne fra en USB-pind,
200
+ kobler dig på en node over Tor, og noderne udveksler grupper med
201
+ hinanden. Åbne grupper er som det gamle Usenet; lukkede grupper er
202
+ end-to-end-krypterede, så noderne kun ser støj. Protokollen beskrives i
203
+ RFC-lignende dokumenter, så alle kan lave kompatible noder og klienter.
204
+
205
+ ## License
206
+
207
+ - Code: [Apache License 2.0](LICENSE)
208
+ - Protocol specification (`rfc/`) and logo (`assets/`):
209
+ [CC BY 4.0](rfc/LICENSE.md) — copy, quote and implement freely, with credit
210
+
211
+ Anyone may implement the protocol; no license is needed for that.