decentralized-id.github.io/_posts/decentralized-web/2020-01-08-scuttlebot.md
2020-01-08 20:43:17 -05:00

20 KiB
Raw Blame History

title excerpt permalink categories tags
Secure Scuttlebot a gossip protocol that synchronises messages via a vector clock of per-node timestamps or sequences. Dominic got this name from an amazon paper "Efficient Reconciliation and Flow Control for Anti-Entropy Protocols". This is the original scuttlebutt module which should now be known as "insecure scuttlebutt". /decentralized-web/scuttlebot/
Decentralized Web
Scuttlebot

Scuttlebot.io Design Challenge: Avoid Centralization and Singletons

SecureScuttlebutt goes out of it's way to avoid both centralization and singletons.

Show Zero Knowledge, Ep Episode 81: P2P Messaging & Scuttlebutt with Dominic Tarr - Jun 12, 2019

In this weeks episode, we meet with Dominic Tarr, a protocol designer and security auditor at Least Authority who works on Scuttlebutt - a decentralized secure gossip platform. We discuss P2P messaging and the challenges of sending messages within a p2p network in a truly decentralised manner.

Announcing: SSB Rooms - news.ycombinator.com

Today I'm launching something I've been working on since May to help improve the Secure Scuttlebutt (SSB) ecosystem with a new type of server: SSB Rooms. As an alternative or complement to pub servers, rooms are servers intended as meeting places where peers come to discover others and establish network connections with each other.

Secure-scuttlebutt vs scuttlebutt vs scuttlebot vs sbot? - Explanation of terms, repos and project history

scuttlebutt: a gossip protocol that synchronises messages via a vector clock of per-node timestamps or sequences. Dominic got this name from an amazon paper "Efficient Reconciliation and Flow Control for Anti-Entropy Protocols". This is the original scuttlebutt module which should now be known as "insecure scuttlebutt". This repo is generally no longer used by the ssb community.

ssb-db: this is the database part of ssb. Previously this term referred to the protocol/database as a whole.

ssb-server: this repo adds networking behaviour to the database (secure-scuttlebutt).

sbot: short for scuttlebot, previously the CLI command name to control ssb-server. Now also named ssb-server.

Efficient Reconciliation and Flow Control for Anti-Entropy Protocols

The paper shows that anti-entropy protocols can process only a limited rate of updates, and proposes and evaluates a new state reconciliation mechanism as well as a flow control scheme for anti-entropy protocols.

Secure Scuttlebutt Consortium - GitHub Repos

Secure Scuttlebutt Consortium - A distributed and secure peer to peer social network

Info

  • docs

    Scuttlebot implemented by ssb-server: a p2p log store Secure Scuttlebutt implemented by ssb-db: a global database protocol Patchwork: a social messaging app built on ssb-server and ssb-db

  • handbook.scuttlebutt.nz

    ssb handbook: A guide to the Secure Scuttlebutt key concepts and influences (see also, new website: ssbc/scuttlebutt.nz)

  • modules.scuttlebutt.nz - Documentation for the Scuttlebutt module ecosystem

    This is an aggregation of commonly used scuttlebutt modules grouped for your convenience into several sections.

  • ssb-spec-drafts - protocol specifications for Secure Scuttlebutt

    SSB-Drafts are working documents of the Secure Scuttlebutt community. Note that other groups may also distribute working documents as SSB-Drafts.

    SSB-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use SSB-Drafts as reference material or to cite them other than as "work in progress."

    This wording aligns with the IRTF's document track for Internet-Drafts.

  • scuttlebutt-protocol-guide - Protocol documentation for Secure Scuttlebutt

Server

  • ssb-server The gossip and replication server for Secure Scuttlebutt - a distributed social network
  • ssb-minimal-pub-server - A minimal version of ssb-server aimed at pubs
  • multiserver A single interface that can work with multiple protocols, and multiple transforms of those protocols (eg, security layer)
  • ssb-config standard configuration for ssb

Client

Patchwork

Schema

Crypto

  • ssb-keys - keyfile operations for ssb
  • ssb-caps - The default "Caps" keys for accessing the SSB protocol using secret handshake
  • box2-spec

    This is a spec for encrypting messages to groups of people. Initially it will support communication for large groups which share a public key (secret key cryptography / symmetric keys), but it has also been designed to support forward-secure secret-key cryptography (a little like Signal's double-ratchet).

  • ssb-ephemeral-keys - Methods for encrypting messages with ephemeral keys over Secure Scuttlebutt
  • secret-stack - connect peers to each other using secret-handshakes
  • ssb-secret-blob - encrypted blobs over ssb protocol
  • private-box2 - new message encryption for ssb

MuxRPC

  • muxrpc - lightweight multiplexed rpc
  • muxrpc-validation- Forked from pfrazee/muxrpc-validation Validation library for muxrpc apis
  • ssb-plugins

    ssb-plugins is a plugin that provides additional plugin related functionality to a secret-stack instance.

    Without ssb-plugins, plugins can only be loaded explicitly by an ssb-server with the .use() method.

    Generally speaking, this plugin provides the abilility for plugins to be loaded and run as a separate process, with communication over muxrpc.

  • muxrpcli - command-line interface to muxrpc servers

    muxrpc aims to provide remote access to any reasonable node.js api remotely. this means it supports both streaming and async operations. pull-streams are used.

    It may seem at first that it would be logically cleaner to separate this into two concerns, multiplexing and request-response. Indeed, we did just that in multilevel combining mux-demux and rpc-stream however, I realized that multiplexing depends on adding framing to incoming messages, and so does rpc. If rpc is implemented as another layer on top of multiplexing, then the rpc messages end up with a second layer of framing too. By implementing one protocol that supports both streams and rpc, we were able to have both features with only a single layer of framing.

Plugins

  • ssb-search fulltext search as scuttlebot plugin
  • ssb-links ssb-plugin that indexes all the links!
  • ssb-backlinks scuttlebot plugin for indexing all link mentions of messages
  • ssb-identities manage multiple identities as sbot plugin
  • ssb-serve-blobs

    Sbot plugin to serve blobs from a local http server

  • ssb-threads

    Scuttlebot plugin for fetching messages as threads announce a public address for yourself

  • ssb-about scuttlebot plugin for getting reduced 'about' state
  • ssb-social-index scuttlebutt plugin for getting reduced state based on the author's social graph
  • gitbook-plugin-ssb GitBook plugin for Secure Scuttlebutt markdown formatting
  • ssb-private scuttlebot plugin for indexed private messages

Invites

Testing

Assorted