Wim Lewis e5a7baf2b0 Add a minimal man page for cjdroute. 4 lat temu
..
bugs f909b96070 typos, spacing, and capitaliztion fixes 5 lat temu
cjdns f909b96070 typos, spacing, and capitaliztion fixes 5 lat temu
faq f909b96070 typos, spacing, and capitaliztion fixes 5 lat temu
install b59c1ed83a Tun device now readily there. 5 lat temu
man e5a7baf2b0 Add a minimal man page for cjdroute. 4 lat temu
meshlocals f909b96070 typos, spacing, and capitaliztion fixes 5 lat temu
notes f909b96070 typos, spacing, and capitaliztion fixes 5 lat temu
CjdnsModules.odg 016fac012c Moved ControlHandler up above UpperDistributor in order to make CTRL frames tappable and also updated schematic 8 lat temu
CjdnsModules.png 016fac012c Moved ControlHandler up above UpperDistributor in order to make CTRL frames tappable and also updated schematic 8 lat temu
README.md adb476eac6 Added spanish translation and links to same, thanks @rjmalagon for the work. 8 lat temu
README_ES.md adb476eac6 Added spanish translation and links to same, thanks @rjmalagon for the work. 8 lat temu
Seccomp.md 3b3c9f2e69 Add C and bash syntax highlighting 9 lat temu
Sign.md e00f73e2f0 Document Sign_admin.c 4 lat temu
SmartOS.md acc6a5f20c doc: add SmartOS 11 lat temu
SocketInterface.md d9eef7fb2d Added configuration and documentation for the SocketInterface 5 lat temu
TrafficAnalysis.md ecaf12711c correct the file name 8 lat temu
Whitepaper.md f909b96070 typos, spacing, and capitaliztion fixes 5 lat temu
achievements.md f909b96070 typos, spacing, and capitaliztion fixes 5 lat temu
admin-api.md f909b96070 typos, spacing, and capitaliztion fixes 5 lat temu
autostart-at-login.md d2c025bf11 Add documentation to run as normal user 10 lat temu
benchmark.txt f909b96070 typos, spacing, and capitaliztion fixes 5 lat temu
cjdns.pac 27e72fdb64 Merge commit 'f9a5124ea0273c5a3ff448aa3157d10b44ebab2b' 9 lat temu
configure.md 3fe55c4187 Merged UDPbcastInterface into UDPInterface and made it beacon on a different port 6 lat temu
configure_ES.md f00c2bde0e Fix typo in configure document 7 lat temu
contributing.md bc1600897d Add CodeTriage link to cjdelisle/cjdns 6 lat temu
coverage.md 2933584235 Add documentation for fuzz testing and use of gcov to check code coverage 9 lat temu
ctrls.md 3718ba2584 Merge commit '9ef45d9d8fb5b86da848b0ec3da0938c6c9644ff' 9 lat temu
debugging_memory_leaks.md 7d8dbd75fb Revert "doc: remove doc/ in preparation for git subtree-add" 9 lat temu
djc_layer_model.md f106779615 Further defined the next protocol version 10 lat temu
fuzzing.md 2933584235 Add documentation for fuzz testing and use of gcov to check code coverage 9 lat temu
index.md f909b96070 typos, spacing, and capitaliztion fixes 5 lat temu
intro.md 6f658cc4a3 Merge commit '1f62015d7f88eb0eb261df2e38bca34def674004' as 'doc' 9 lat temu
nat-gateway.md f909b96070 typos, spacing, and capitaliztion fixes 5 lat temu
network-services.md 4ab2d81e25 documentation on looking at open ports 9 lat temu
non-root-user.md d2c025bf11 Add documentation to run as normal user 10 lat temu
non-root-user_ru.md a18758dac4 Update translation 9 lat temu
open-indiana.md 9caa52321b doc: factored OpenIndiana install into file 11 lat temu
projectGoals.md f909b96070 typos, spacing, and capitaliztion fixes 5 lat temu
projectGoals_ru.md 021c001abb update the russian readme to reflect the changes in english 10 lat temu
proxying.md f909b96070 typos, spacing, and capitaliztion fixes 5 lat temu
quickstart.md f909b96070 typos, spacing, and capitaliztion fixes 5 lat temu
security_specification.md 80d95740ef Update security_specification.md 5 lat temu
shorewall_and_vpn_gateway_howto.md f909b96070 typos, spacing, and capitaliztion fixes 5 lat temu
switchfun.txt 3f7f1c98f6 Documenting how to walk the network using keypings 10 lat temu
tipsAndTricks.md 3d2ce14e7c Merge commit '562cd8ac1f17f8c5e9640bbc6a5365a33e3af749' 9 lat temu
tunnel.md f909b96070 typos, spacing, and capitaliztion fixes 5 lat temu

README.md

Hyperboria/docs

Español

What is Hyperboria?

Hyperboria is test network built of cjdns nodes.

What is cjdns?

Cjdns is an experimental, cryptographic mesh networking suite.

What is notable about cjdns? Why should I use it?

Cjdns builds an end-to-end encrypted IPv6 mesh network that utilizes the fc00::/8 address space.

Encryption

Cjdns provides an encrypted tunnel which utilizes a private/public keypair to encrypt everything that passes through it with the SALSA20 stream cypher, which affords the user perfect forward secrecy.

Address Allocation

The ipv6 assigned to the TUN interface is composed of the first 16 bytes of the SHA512 hash of the SHA512 hash of your public key. Keypairs are generated via a brute force method until a corresponding address is found with a starting byte FC. The FC00::/8 address space has been allocated as a Unique Local Address space, and so these addresses should not conflict with ICANN assigned IPv6 addresses or any other conventional internet operation.

Hybrid topology

Cjdns was designed to be used with a friend of a friend topology. It builds an overlay network which traverses NAT (Network Address Translation), exposing all ports of every node to every other node within the network. Those who are used to relying on NAT to protect their devices may find this troublesome.

At one point it was expected that each person who peered would do so with only trusted friends. You need not trust relaying nodes with the confidentiality or integrity of your packets, however, if you wish to restrict access to certain services, it is your responsibility to implement effective access control rules.

Links between nodes may be established over deliberate UDP links across the internet, or over deliberate or automatic connections across Ethernet, Wireless access points, Ad-hoc connections, or various system-specific transmission and addressing protocols.

Cryptographic verification and routing

Establishing a link between two nodes includes a cryptographic authorization process, after which other nodes within the network can establish a connection with the new node.

Due to the relationship between each node's public key and its ipv6, and the fact that this relationship is verified upon connecting to a node, a user can be sure that if it connects to an IPv6 address and receives a response then the node that responded possesses the requisite private key to decrypt the response.

If you are able to connect at all over cjdns, then you can be quite sure that the node you connected to possesses the private key that corresponds to the IPv6.

How can I get involved?

If you are totally new to cjdns, you'll want to start by installing it somewhere and familiarizing yourself with how it works. Take notes of anything that you find difficult, unintuitive, or poorly documented, and share your knowledge so the next person who installs cjdns after reading the documentation has an easier time.

Also, read our contributing document for notes on our policies for accepting contributions.