Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dhairya0907/react-native-encryption
Encryption/Decryption for React Native
https://github.com/dhairya0907/react-native-encryption
decryption encryption encryption-decryption file-encryption large-files npm-package react-native text-encryption
Last synced: about 2 months ago
JSON representation
Encryption/Decryption for React Native
- Host: GitHub
- URL: https://github.com/dhairya0907/react-native-encryption
- Owner: dhairya0907
- License: mit
- Created: 2021-12-04T17:10:48.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2021-12-08T14:44:57.000Z (about 3 years ago)
- Last Synced: 2024-10-16T02:32:29.630Z (3 months ago)
- Topics: decryption, encryption, encryption-decryption, file-encryption, large-files, npm-package, react-native, text-encryption
- Language: Swift
- Homepage: https://www.npmjs.com/package/@dhairyasharma/react-native-encryption
- Size: 4.22 MB
- Stars: 7
- Watchers: 1
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# `@dhairyasharma/react-native-encryption`
 [  ](/LICENSE)  [  ](https://github.com/dhairya0907) [](https://github.com/dhairya0907/react-native-encryption/releases)
[ ](https://twitter.com/dhairya_0907) [  ](https://www.linkedin.com/in/dhairyasharma0907/)
### Encryption/decryption for React Native.
# Benchmark
| |
| :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **File Details** |
| **_File Link_**
http://bit.do/benchmarkfile
**_File Size_**
1.09 GB |
| **IOS Benchmark** |
| **_Average of 100 Encryption_**
4.859 seconds
**_Average of 100 Decryption_**
5.594 seconds
Check Log for all IOS encryption [here](https://github.com/dhairya0907/react-native-encryption/blob/3e267e006f1fd1ed115733da2a86c21437865878/benchmark/IOS_LOGS.txt#L2).
Check Log for all IOS decryption [here](https://github.com/dhairya0907/react-native-encryption/blob/3e267e006f1fd1ed115733da2a86c21437865878/benchmark/IOS_LOGS.txt#L110). |
| **Android Benchmark** |
| **_Average of 100 Encryption_**
20.373 seconds
**_Average of 100 Decryption_**
21.908 seconds
Check Log for all Android encryption [here](https://github.com/dhairya0907/react-native-encryption/blob/3e267e006f1fd1ed115733da2a86c21437865878/benchmark/ANDROID_LOGS.txt#L2).
Check Log for all Android decryption [here](https://github.com/dhairya0907/react-native-encryption/blob/3e267e006f1fd1ed115733da2a86c21437865878/benchmark/ANDROID_LOGS.txt#L109). |
| |
# Features
- Encrypt/decrypt any length of text.
- Encrypt/decrypt any type of file.
- Encrypt/decrypt any size of file.
# Getting started
Install the library using either Yarn:
```
yarn add @dhairyasharma/react-native-encryption
```
or npm:
```sh
npm install --save @dhairyasharma/react-native-encryption
```
or git:
```sh
npm install git+https://github.com/dhairya0907/react-native-encryption.git
```
### Using React Native >= 0.60
Linking the package manually is not required anymore with [Autolinking](https://github.com/react-native-community/cli/blob/master/docs/autolinking.md).
- **iOS Platform:**
```sh
cd ios && pod install && cd ..
```
- **Android Platform:**
Does not require any additional steps.
# Usage
## Import the library
```javascript
import RNEncryptionModule from "@dhairyasharma/react-native-encryption";
```
## Encrypt Text
```typescript
RNEncryptionModule.encryptText(
plainText,
password
).then((res: any) => {
if (res.status == "success") {
console.log("success", res)
} else {
Alert.alert("Error", res);
}
}).catch((err: any) => {
console.log(err);
});
```
- **plainText** : Plain text to be encrypted.
- **password** : Password to encrypt the plain text.
```javascript
returns
// If text encryption is successful, it returns a JSON object with the following structure:
{
"status": "success",
"encryptedText": "encryptedText",
"iv": "iv",
"salt": "salt"
}
or
// If text encryption is unsuccessful, it returns a JSON object with the following structure:
{
"status": "Fail",
"error": "error"
}
```
## Decrypt Text
```typescript
RNEncryptionModule.decryptText(
encryptedText,
password,
iv,
salt).then((res: any) => {
if (res.status == "success") {
console.log("success", res)
} else {
Alert.alert("Error", res);
}
}).catch((err: any) => {
console.log(err);
});
```
- **encryptedText** : Cipher text to be decrypted.
- **password** : Password to decrypt the cipher text.
- **iv** : Initialization vector from encryptText.
- **salt** : Salt from encryptText.
```javascript
returns
// If text decryption is successful, it returns a JSON object with the following structure:
{
"status": "success",
"decryptedText": "decryptedText"
}
or
// If text decryption is unsuccessful, it returns a JSON object with the following structure:
{
"status": "Fail",
"error": "error"
}
```
## Encrypt File
```typescript
RNEncryptionModule.encryptFile(
inputFilePath,
outputEncryptedFilePath,
password
).then((res: any) => {
if (res.status == "success") {
console.log("success", res)
} else {
console.log("error", res);
}
}).catch((err: any) => {
console.log(err);
});
```
- **inputFilePath** : Path of the file to be encrypted.
- **outputEncryptedFilePath** : Path of the encrypted file.
- **password** : Password to encrypt the file.
```javascript
returns
// If file encryption is successful, it returns a JSON object with the following structure:
{
"status": "success",
"iv": "iv",
"salt": "salt"
}
or
// If file encryption is unsuccessful, it returns a JSON object with the following structure:
{
"status": "Fail",
"error": "error"
}
```
## Decrypt File
```typescript
RNEncryptionModule.decryptFile(
encryptedFilePath,
outputDecryptedFilePath,
password,
iv,
salt
).then((res: any) => {
if (res.status == "success") {
console.log("success", res)
} else {
console.log("error", res);
}
}).catch((err: any) => {
console.log(err);
});
```
- **encryptedFilePath** : Path of the file to be decrypted.
- **outputDecryptedFilePath** : Path of the decrypted file.
- **password** : Password to decrypt the file.
- **iv** : Initialization vector from encryptFile.
- **salt** : Salt from encryptFile.
```javascript
returns
// If file decryption is successful, it returns a JSON object with the following structure:
{
"status": "success",
"message" : "File decrypted successfully"
}
or
// If file decryption is unsuccessful, it returns a JSON object with the following structure:
{
"status": "Fail",
"error": "error"
}
```
---
**NOTE**
On android, Input or Output file path does not support **_content://_** type file path. Please use **_file://_** type file path.
You can use [react-native-fetch-blob stat](https://github.com/wkh237/react-native-fetch-blob/wiki/File-System-Access-API#user-content-statpathstringpromisernfetchblobstat) to get original path. See [example](https://github.com/dhairya0907/react-native-encryption/blob/3e267e006f1fd1ed115733da2a86c21437865878/example/src/App.tsx#L115).
**_You will need Files and media permission for this._**
---
# Acknowledgements
- Inspired by [react-native-aes-gcm-crypto](https://github.com/craftzdog/react-native-aes-gcm-crypto)
- Module template by [react-native-module-template](https://github.com/demchenkoalex/react-native-module-template)
- IOS library by [IDZSwiftCommonCrypto](https://github.com/iosdevzone/IDZSwiftCommonCrypto)
- Android library by [bc-java](https://github.com/bcgit/bc-java) edited using [nodejs-mybc-util](https://github.com/jbuhacoff/nodejs-mybc-util)
# Author
Dhairya Sharma | [@dhairya0907](https://github.com/dhairya0907)
# License
The library is released under the MIT license. For more information see [`LICENSE`](/LICENSE).