siepra / react-native-e2ee

(WIP) End-to-End Encryption (E2EE) made easy for react-native projects

React Native E2E Encryption (WIP)

Handling cryptography easily with JS interfaces.

Description

This projects addresses the purpose of providing a developer friendly JS interface for generating, safely storing and serving cryptographic keys for end-to-end encryption on Android and iOS devices. Of course, the server (or another handy way of distributing data between devices) is needed, but the point of this package is to provide a developer with clients' public key and all the necessary methods to use in end-to-end encrypted communication without forcing him/her to dive into native implementations for generating and storing cryptohgraphic data.

Security

The project encrypts with RSA (Ultimately it'll use hybrid encryption with RSA and AES).

Installation

Open a Terminal in your project's folder and run:

Using yarn

yarn add react-native-e2ee

Using npm

npm install react-native-e2ee

Usage/API

• generateKeyPair(): Promise<string> - generates/fetches key pair for fixed alias and returns the public key.
• getOwnPublicKey(): Promise<string | null> - returns own public key or null if non existing.
• encryptMessage( message: string, publicKey: string ): Promise<string | null> - encrypts message for the given public key.
• decryptMessage(message: string): Promise<string | null> - decrypts message using own public key.

Key progress so far

• Full API coverage for Android
• Full API coverage for iOS

Roadmap

Examine the upcoming changes here.

Contributing

See the contributing guide to learn how to contribute to the repository and the development workflow.

License

MIT

---

Made with create-react-native-library

react-native-e2ee's Issues

[DOCS] Roadmap

This is the proposition and plan for the upcoming development of the package.

MVP

1. Prepare basic cryptographic (RSA) methods natively on mobile platforms:

   • Android
   • iOS

2. Bind native methods to the exposed React interfaces:

   • Android
   • iOS

3. Publish the package on NPM registry

v2.x

Use hybrid encryption with RSA and AES.

v3.x

Enhance API with keys management features.

v4.x

Handle encryption of other data types.

Support for Expo using config plugins

So that we can use it with the expo dev client without manually doing the native changes

https://docs.expo.dev/config-plugins/introduction/

A problem occurred evaluating project ':react-native-e2ee'.

A problem occurred evaluating project ':react-native-e2ee'.

Failed to apply plugin 'kotlin-android'.
Extension of type 'JavaPluginExtension' does not exist. Currently registered extension types: [ExtraPropertiesExtension, LibrariesForReactAndroidLibs, VersionCatalogsExtension, KotlinAndroidProjectExtension, KotlinTestsRegistry]

Problem occured

•⁠ ### ⁠What went wrong:

A problem occurred evaluating project ':react-native-e2ee'.
	⁠Failed to apply plugin 'kotlin-android'.
   > Extension of type 'JavaPluginExtension' does not exist. Currently registered extension types: [ExtraPropertiesExtension, LibrariesForReactAndroidLibs, VersionCatalogsExtension, KotlinAndroidProjectExtension, KotlinTestsRegistry]