https://github.com/SocialGouv/e2esdk

SDK to build end-to-end encrypted web applications
https://github.com/SocialGouv/e2esdk

crypto e2e end-to-end-encryption typescript web

Last synced: 2 months ago
JSON representation

SDK to build end-to-end encrypted web applications

• Host: GitHub
• URL: https://github.com/SocialGouv/e2esdk
• Owner: SocialGouv
• License: apache-2.0
• Created: 2022-11-18T14:25:40.000Z (almost 2 years ago)
• Default Branch: beta
• Last Pushed: 2024-08-28T08:01:57.000Z (3 months ago)
• Last Synced: 2024-08-28T09:24:35.655Z (3 months ago)
• Topics: crypto, e2e, end-to-end-encryption, typescript, web
• Language: TypeScript
• Homepage: https://socialgouv.github.io/e2esdk
• Size: 5.46 MB
• Stars: 20
• Watchers: 1
• Forks: 0
• Open Issues: 24
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# e2esdk

[![Apache-2.0 License](https://img.shields.io/github/license/SocialGouv/e2esdk.svg?color=blue)](https://github.com/SocialGouv/e2esdk/blob/main/LICENSE)

[![Continuous Integration](https://github.com/SocialGouv/e2esdk/actions/workflows/ci-cd.yml/badge.svg?branch=beta)](https://github.com/SocialGouv/e2esdk/actions/workflows/ci-cd.yml)

SDK to build end-to-end encrypted web applications

## About

This project is made of two parts:

- Client NPM packages to be installed and used in your front-end application code

- A server that manages identities and encryption keys

Users register their cryptographic identities on the server,

and use it to store encrypted keys.

Users can then retrieve those keys to encrypt and decrypt application data.

Users can also choose to securely share keys with others, to access shared

workspaces.

Private workspaces (using forward-secrecy) are planned but not yet available.

The SDK also provides secure ways to ingest structured data from the outside

(eg: forms), using public key cryptography.

### Application layer

This project only deals with cryptographic keys, and the cryptographic

algorithms to encrypt and decrypt data with those keys.

What your data looks like, where it is stored and how it flows through your

application is entirely up to you. This allows easy integration in any kind of

stack.

## Client libraries

- [`@socialgouv/e2esdk-client`](./packages/client) - Main client interface

- [`@socialgouv/e2esdk-crypto`](./packages/crypto) - Cryptographic primitives

- [`@socialgouv/e2esdk-react`](./packages/react) - React bindings (context provider & hooks)

- [`@socialgouv/e2esdk-devtools`](./packages/devtools) - Devtools UI in a WebComponent

> Note: while we do provide React bindings, the `@socialgouv/e2esdk-client` package is

> entirely framework-agnostic, and will work in any modern browser.

>

> We do not yet provide a non-browser (Node.js) client implementation.

## Server

The server is published as a Docker image at

[`ghcr.io/socialgouv/e2esdk/server`](https://github.com/SocialGouv/e2esdk/pkgs/container/e2esdk%2Fserver)

The only external requirement is a PostgreSQL database.

[Server documentation](./packages/server/README.md)

## Documentation

- [Cryptography](./docs/docs/cryptography)

## Contributing

- [How to setup a development environment](./docs/development-environment.md)

- [Monorepo architecture](./docs/monorepo-architecture.md)

## Beta disclaimer

While e2esdk is in beta, all published packages will **not** follow semver,

and be constrained to `1.0.0-beta.n` incremental version numbers on the `beta`

channel on NPM.

The server may also experience data breaking changes while in beta that requires

resetting the database.

---

License: Apache-2.0