3.8 KiB
NeoComm
NeoComm is a lightweight completely decentralized and anti-censorship IRC replacement network. The objective of this network is to create a secure form of group instant communication similar to IRC but decentralizing the network, and as a consequence hindering censorship within the network and protecting the network's endurance against malevolent entities that may try to block access to the network.
This repository provides a library with interfaces by which you can access the network, which you are able to use in your own software under the terms & conditions of the library's license.
Network Model
This model moves further from the federated decentralization model, taking one closer to that of torrents with their peer discovery. There are three components to the network: nodes and directory nodes. All connected machines work as nodes, but only those that are not firewalled can function as directory nodes (nodes that other nodes can connect to). With this model the directory nodes would serve the functionality of trackers in a torrent system (those nodes that have enough uptime to be considered directory servers). At first the network will be very much centralized around a single directory server, however when new directory servers start popping up (any directory node with long uptimes) it will help to further remove dependence on a single point of vulnerability and help towards the decentralization of the network. Clients will remember what nodes they connected to so that upon startup they can try other directory nodes and not simply the same one, allowing for the network to quickly move forward from the original directory server.
For more information on the network model, please refer to the wiki.
Roadmap
What follows is a list roadmap of features and the (approximate) versions in which they will be implemented. The API will only change in major versions of the library, while minor versions will be dedicated to internal improvements and patch versions to small fixes that got past the release.
- v1.0-alpha:
- Node connectivity
- Messages properly sent and received
- v1.0-beta:
- Channel functionality
- Message encryption
- Private messages
- v1.0:
- Special snowflake (Winblows) socket support
- SOCKS4a/SOCKS5 proxy support
- HTTP proxy support
- v2.0:
- P2P File transfer
- Memos (with TTL)
API Documentation
NeoComm uses Doxygen to generate its documentation (for NeoComm developers please refer to the contributing section) which generates HTML and man page documentation which you can do so by running doxygen in the root directory of the project or by using their graphical wizard.
Public documentation will be published with every major release.
Clients
There are currently no clients available.
Compiling
To build this project you will need a C99 compatible compiler (GCC is recommended) and the CMake build system. To build run the following commands from the root directory of the project.
$ cd build/
$ cmake ..
$ make
By default this will build a release build, if you require a debug build run the cmake command with the additional flag -DCMAKE_BUILD_TYPE=debug.
Contributing
If you would like to contribute to the project please read over the contribution guide.
License
This project, unless otherwise stated, is licensed under the terms & conditions of the GNU Lesser General Public License version 3 or greater.