Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/craftzdog/react-native-aes-gcm-crypto
AES-GCM encryption/decryption for React Native
https://github.com/craftzdog/react-native-aes-gcm-crypto
cryptography react-native
Last synced: 14 days ago
JSON representation
AES-GCM encryption/decryption for React Native
- Host: GitHub
- URL: https://github.com/craftzdog/react-native-aes-gcm-crypto
- Owner: craftzdog
- License: mit
- Created: 2021-01-27T11:29:27.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2024-09-25T00:13:59.000Z (about 2 months ago)
- Last Synced: 2024-10-27T09:03:59.637Z (17 days ago)
- Topics: cryptography, react-native
- Language: Java
- Homepage:
- Size: 1.38 MB
- Stars: 248
- Watchers: 4
- Forks: 29
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# react-native-aes-gcm-crypto
AES-GCM encryption/decryption for React Native
## Requirements
- iOS >= 13.0
- Android >= 26
## Installation
```sh
npm install react-native-aes-gcm-crypto
```
## Usage
```js
import AesGcmCrypto from 'react-native-aes-gcm-crypto';
const key = 'Yzg1MDhmNDYzZjRlMWExOGJkNTk5MmVmNzFkOGQyNzk=';
AesGcmCrypto.decrypt(
'LzpSalRKfL47H5rUhqvA',
key,
'131348c0987c7eece60fc0bc',
'5baa85ff3e7eda3204744ec74b71d523',
false
).then((decryptedData) => {
console.log(decryptedData);
});
AesGcmCrypto.encrypt('{"name":"Hoge"}', false, key).then((result) => {
console.log(result);
});
```
### Encrypt data
```ts
type EncryptedData = {
iv: string;
tag: string;
content: string;
};
function encrypt(
plainText: string,
inBinary: boolean,
key: string
): Promise;
```
- **plainText**: A string data to encrypt. If `inBinary` is `true`, it should be encoded in Base64.
- **inBinary**: `true` to encrypt binary data encoded with Base64
- **key**: AES key in Base64
### Encrypt file
```ts
function encryptFile(
inputFilePath: string,
outputFilePath: string,
key: string
): Promise<{
iv: string;
tag: string;
}>;
```
- **inputFilePath**: A file path to encrypt
- **outputFilePath**: An output file path
- **key**: AES key in Base64
### Decrypt data
```ts
function decrypt(
base64Ciphertext: string,
key: string,
iv: string,
tag: string,
isBinary: boolean
): Promise;
```
- **base64Ciphertext**: A base64 data to decrypt.
- **key**: AES key in Base64
- **iv**: An initialization vector (or nonce) in Hex
- **tag**: An auth tag in Hex
- **isBinary**: `true` to return decrypted data in Base64
### Decrypt file
```ts
function decryptFile(
inputFilePath: string,
outputFilePath: string,
key: string,
iv: string,
tag: string
): Promise;
```
- **inputFilePath**: A file path to decrypt
- **outputFilePath**: An output file path
- **key**: AES key in Base64
- **iv**: An initialization vector (or nonce) in Hex
- **tag**: An auth tag in Hex
- **isBinary**: `true` to return decrypted data in Base64
## Contributing
See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.
## Author
Takuya Matsuyama | [@inkdrop_app](https://twitter.com/inkdrop_app)
Made for my app called [Inkdrop - A Markdown note-taking app](https://www.inkdrop.app/)
## License
MIT