SDK to build end-to-end encrypted web applications
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.
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.
@socialgouv/e2esdk-client- Main client interface@socialgouv/e2esdk-crypto- Cryptographic primitives@socialgouv/e2esdk-react- React bindings (context provider & hooks)@socialgouv/e2esdk-devtools- Devtools UI in a WebComponent
Note: while we do provide React bindings, the
@socialgouv/e2esdk-clientpackage is entirely framework-agnostic, and will work in any modern browser.We do not yet provide a non-browser (Node.js) client implementation.
The server is published as a Docker image at
ghcr.io/socialgouv/e2esdk/server
The only external requirement is a PostgreSQL database.
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