Browse Source

updated readme and whitepaper

merge-requests/20/head
Kevin Froman 3 years ago
parent
commit
456e3f68ad
  1. 44
      README.md
  2. BIN
      docs/onionr-1.png
  3. BIN
      docs/onionr-2.png
  4. BIN
      docs/onionr-3.png
  5. 13
      docs/whitepaper.md

44
README.md

@ -31,15 +31,29 @@ Onionr can be used for mail, as a social network, instant messenger, file sharin
## Main Features
* [X] Fully p2p/decentralized, no trackers or other single points of failure
* [X] End to end encryption of user data
* [X] Optional non-encrypted blocks, useful for blog posts or public file sharing
* [X] Easy API system for integration to websites
* [X] Metadata analysis resistance
* [X] Transport agnosticism (no internet required)
* [X] 🌐 Fully p2p/decentralized, no trackers or other single points of failure
* [X] 🔒 End to end encryption of user data
* [X] 📢 Optional non-encrypted blocks, useful for blog posts or public file sharing
* [X] 👩🏾💻 Easy API system for integration to websites
* [X] 🕵 Metadata analysis resistance and anonymity
* [X] 📡 Transport agnosticism (no internet required)
**Onionr API and functionality is subject to non-backwards compatible change during pre-alpha development**
# Screenshots
<img alt='Node statistics page screenshot' src='docs/onionr-1.png' width=600>
Node statistics
<img alt='Friend/contact manager screenshot' src='docs/onionr-2.png' width=600>
Friend/contact manager
<img alt='Encrypted, metadata-masking mail application screenshot' src='docs/onionr-3.png' width=600>
Encrypted, metadata-masking mail application.
# Install and Run on Linux
The following applies to Ubuntu Bionic. Other distros may have different package or command names.
@ -54,17 +68,27 @@ The following applies to Ubuntu Bionic. Other distros may have different package
Everyone is welcome to help out. Help is wanted for the following:
* Development (Get in touch first)
* Creation of a lib for use from other languages and faster proof-of-work
* Creation of a shared lib for use from other languages and faster proof-of-work
* Android and IOS development
* Windows and Mac support
* Windows and Mac support (already partially supported, testers needed)
* General bug fixes and development of new features
* Testing
* UI/UX design
* Running stable nodes
* Security review/audit
* Automatic I2P setup
Bitcoin: [1onion55FXzm6h8KQw3zFw2igpHcV7LPq](bitcoin:1onion55FXzm6h8KQw3zFw2igpHcV7LPq)
USD: [Ko-Fi](https://www.ko-fi.com/beardogkf)
Contribute money:
Donating at least $5 gets you cool Onionr stickers. Get in touch if you want them.
Bitcoin: [1onion55FXzm6h8KQw3zFw2igpHcV7LPq](bitcoin:1onion55FXzm6h8KQw3zFw2igpHcV7LPq) (Contact us for privacy coins like Monero)
USD (Card/Paypal): [Ko-Fi](https://www.ko-fi.com/beardogkf)
## Contact
beardog [ at ] mailbox.org
## Disclaimer

BIN
docs/onionr-1.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 44 KiB

BIN
docs/onionr-2.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 30 KiB

BIN
docs/onionr-3.png

Binary file not shown.

After

Width:  |  Height:  |  Size: 40 KiB

13
docs/whitepaper.md

@ -5,13 +5,13 @@
# Introduction
One of the most important things in the modern world is information. The ability to communicate freely with others is crucial for maintaining personal liberties. The internet has provided humanity with the ability to spread information globally, but there are many people who try (and sometimes succeed) to stifle the flow of information.
One of the most important things in the modern world is information. The ability to communicate freely with others is crucial for maintaining societal and personal liberty. The internet has provided humanity with the ability to spread information globally, but there are many people who try (and sometimes succeed) to stifle the flow of information.
Internet censorship comes in many forms, state censorship, corporate consolidation of media, threats of violence, network exploitation (e.g. denial of service attacks).
Internet censorship comes in many forms, state censorship, corporate consolidation of media, threats of violence, network exploitation (e.g. denial of service attacks) and other threats.
To prevent censorship or loss of information, these measures must be in place:
To prevent censorship and loss of information, these measures must be in place:
* Resistance to censorship of underlying infrastructure or of network hosts
* Resistance to censorship of underlying infrastructure or of particular network hosts
* Anonymization of users by default
* The Inability to coerce human users (personal threats/"doxxing", or totalitarian regime censorship)
@ -124,10 +124,11 @@ We seek to protect the following information:
* Data specifically inserted as plaintext is available to the public
* The public key of signed plaintext blocks
* The fact that one is using Tor or I2P
* The fact that one is using Onionr can likely be discovered using long term traffic analysis
* The fact that one is using Onionr specifically can likely be discovered using long term traffic analysis
* Intense traffic analysis may be able to discover what node created a block. For this reason we offer a high security setting to only share blocks via uploads that we recommend for those who need the best privacy.
## Assumptions
We assume that Tor onion services (v3) and I2P services cannot be trivially deanonymized, and that the cryptographic algorithms we employ cannot be broken in any manner faster than brute force unless a quantum computer is used.
We assume that Tor onion services (v3) and I2P services cannot be trivially deanonymized, and that the underlying cryptographic primitives we employ cannot be broken in any manner faster than brute force unless a quantum computer is used.
Once quantum safe algorithms are more mature and have relatively high level libraries, they will be deployed.

Loading…
Cancel
Save