livestorejs/livestore

Create encrypted sync example

Open

#184 opened on Sep 10, 2024

View on GitHub
 (0 comments) (2 reactions) (0 assignees)TypeScript (128 forks)github user discovery
encryptionexamplehelp wantedsyncing

Repository metrics

Stars
 (3,599 stars)
PR merge metrics
 (PR metrics pending)

Description

Many apps dealing with personal data would like to still be able to sync data between devices while also ensuring that only the user can read their own data.

Livestore could have support in its sync implementation for code that encrypts data on the way out and decrypts it as it comes in e.g. two new parameters encrypt and decrypt which take a function which does the work.

This doesn't solve the problem of how to share a key between clients but would be a useful building block for that.

Contributor guide

Research direction
Investigate how to add encrypt and decrypt parameters to Livestore's sync function, enabling data encryption at rest and in transit. Explore key sharing mechanisms between clients and provide an example implementation.
Tech stack
typescriptsqlite
Domain
backenddatabasesecurity
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
TypeScriptencryption basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60