scua

An exploration into distributed identity, addressing the Bluesky 'Satellite' challenge.

scua is the Old English word for cloud, which ended up as today's word sky. I couldn't pass up a word containing UA (User-Agent).

See DISCUSSION.md for a response to the Satellite prompt and some discussion of the approach taken.

See DESIGN.md for an overview of the solution implemented in this repo and some brief analysis of other systems.

Caveats

This project is an experiment. It has not been vetted by experts, it cuts corners in implementation, and is likely to be cryptographically unsound. Be warned.

Note particularly that this system generates private key material for DIDs and stores it in the browser's storage layer. Those private keys can be trivially exported. Do not use valuable private keys when evaluating this system.

Tooling

This project uses:

DIDs as stable service- and resource-independent identifiers.
ION as an identity network that uses DIDs and Sidetree to provide DPKI.
Verifiable Credentials as a document format to make and verify assertions.

The (extremely rough and ready) WebExtension uses Svelte.

Dependencies

macOS

For development you should install HomeBrew, then the following:

NodeJS

NodeJS is at v16 now. Some systems (e.g., ION) are only tested with NodeJS 14. Use nvm to manage your NodeJS versions:

brew install nvm
nvm install 14
nvm install 16
nvm use 16

Getting started

npm install
npm run build

Now add the WebExtension to Chrome via chrome://extensions/: choose "Load unpacked" and pick the webextension directory. You can test similarly in Firefox via about:debugging

You can also package the extension to load via the Add-ons UI:

npm install --global web-ext
web-ext build

There is a second package.json inside the src/lib directory, which allows for some of this code to run in a plain Node environment. This is now secondary to the build process that generates the WebExtension.

Trying it out

Load one of:

A Twitter profile page
A GitHub project page
A Reddit user page

Now click the icon in the toolbar. You'll see any claimed identity, and you are also able to generate your own DID and claim an existing page.

Critique of tooling

IPFS packages

A number of the IFPS packages have broken dependencies, missing dependencies, or other issues; for example, @chris.troutner/ipfs-core-types depends on ipld-dag-pb which is deprecated (replaced by @ipld/dag-pb) and broken:

node_modules/ipld-dag-pb/dist/src/genCid.d.ts:15:37 - error TS2307: Cannot find module 'multihashes/dist/src/constants' or its corresponding type declarations.

15 export const defaultHashAlg: import("multihashes/dist/src/constants").HashCode;
                                       ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

This makes it difficult to keep a client working, and indeed the non-browser part of this repo is currently broken by this IPFS code.

Content Security Policy

Additionally, IPFS and ION both require connections to various nodes, and that set is not guaranteed to remain unchanged. This is in tension with the need for WebExtensions to specify an exhaustive and tight Content Security Policy; a client that connects to the ION network and IPFS essentially needs to allow for arbitrary websockets, which I did not do in this experiment for security reasons. Changing this assumption is necessary to achieve true decentralization, but requires a great deal more scrutiny around security.

Pinning

Storage in IPFS is not persistent unless a node pins content on your behalf. Control over pinning from a fully decentralized, client-only piece of software is a challenge to say the least. This could be partly addressed by re-adding credentials each time the client connects to IPFS, and allowing credentials to be unavailable for some period of time while client nodes are absent. This problem is a challenge for IPFS as a whole.

License, and how I built this

Scua is an experimental side project, built entirely in my spare time on my personal devices. It has a single contributor: Richard Newman. It has no relationship to my employer.

Scua is licensed under the MIT License.

rnewman/scua