https://github.com/cabal-club/cable

A lightweight peer-to-peer chat protocol.
https://github.com/cabal-club/cable

p2p p2p-chat specification

Last synced: about 2 months ago
JSON representation

A lightweight peer-to-peer chat protocol.

• Host: GitHub
• URL: https://github.com/cabal-club/cable
• Owner: cabal-club
• Created: 2021-05-07T20:20:48.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-05-02T01:30:35.000Z (8 months ago)
• Last Synced: 2024-10-29T18:47:58.594Z (2 months ago)
• Topics: p2p, p2p-chat, specification
• Homepage: https://cabal.chat
• Size: 681 KB
• Stars: 73
• Watchers: 12
• Forks: 4
• Open Issues: 7
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Cable Protocol

> Version: 1.0-draft8

Cable is a peer-to-peer protocol for private group chats, called *cabals*.

Cable operates differently from the traditional server-client model, where the

server is a centralized authority. Instead, in Cable, every node in the network

is equal to each other. Nodes of a cabal share data with each other in order to

build a view of the state of that cabal.

The purpose of the Cable Protocol is to facilitate the creation and sync of

cabals, by allowing peers to exchange cryptographically signed documents with

each other, such as chat messages, spread across various user-defined channels.

All of this happens over an encrypted channel between each peer.

Cable consists of three protocols:

1. The [Cable Handshake](./handshake.md), which determines if two peers are compatible and establishes a secure channel between them.

2. The [Cable Wire Protocol](./wire.md), which allows two peers to request and exchange signed data (*posts*) from each other by their content hashes.

2. The [Cable Moderation Protocol](./moderation.md), which layers a content moderation system on top of the Cable Wire Protocol.

Cable is designed to be:

1. fairly simple to implement in any language, with minimal dependencies

2. general enough to be used across different network transports

3. useful, even if written as a partial implementation

4. efficient in its use of network resources, by

    1. syncing only the relevant subsets of the full dataset, and

    2. being compact over the wire

5. not specific to any particular kind of database backend

While the overall structure of these protocols is unlikely to change, these

documents are still under active development, and should not be considered

stable.