https://github.com/drazail/react-native-hash
native hashing for react-native
https://github.com/drazail/react-native-hash
android hash-algorithm hashing hmac keccak md2 md5 native react react-native react-native-hash sha-1 sha-224 sha-256 sha-384 sha-512
Last synced: 14 days ago
JSON representation
native hashing for react-native
- Host: GitHub
- URL: https://github.com/drazail/react-native-hash
- Owner: Drazail
- License: apache-2.0
- Created: 2019-12-26T22:50:21.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-07-01T02:16:28.000Z (10 months ago)
- Last Synced: 2025-01-17T01:19:17.624Z (3 months ago)
- Topics: android, hash-algorithm, hashing, hmac, keccak, md2, md5, native, react, react-native, react-native-hash, sha-1, sha-224, sha-256, sha-384, sha-512
- Language: HTML
- Homepage: https://github.com/Drazail/react-native-hash#readme
- Size: 789 KB
- Stars: 29
- Watchers: 3
- Forks: 19
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# react-native-hash
## Getting started
`$ npm install react-native-hash --save`
---
## compatibility
| Criteria | Release Version |
| ---------------------- | ------------------ |
| Android API < `16` | unsupported |
| `16` <= Android API < `21` | 1.x |
| Gradle >= `7` | >= 2.0.1 |
---
## Usage
### Constants
```typescript
HashAlgorithms: Record;
```
```typescript
HmacAlgorithms: Record;
```
```typescript
Events: Record;
```
#### Example
```javascript
import { CONSTANTS } from 'react-native-hash';
const hashAlgorithm = CONSTANTS.HashAlgorithms.sha256;
const hmacAlgorithm = CONSTANTS.HmacAlgorithms.HmacSHA512;
const EventName = CONSTANTS.Events.onBatchReccieved;
```
***
# Cross Platform API
[Native hashing](https://github.com/Drazail/react-native-hash/blob/master/README.md#android) is only implemented on Android, however, until I get around writing native modules for other platforms ( or if some kind soul makes a PR), you can use `JSHash` and `JSHmac`:
***
**NOTE**
if you are using expo, `JSHash` and `JSHmac` should work out of the box, native implementations however, will require you to eject the project.
***
#### Hash Algorithm :
`"MD2" | "MD5"| "SHA-1"| "SHA-224" | "SHA-256" | "SHA-384" | "SHA-512"| "keccak"`
#### HMac Algorithm :
`"HmacMD5" | "HmacSHA1" | "HmacSHA224" | "HmacSHA256" | "HmacSHA384" | "HmacSHA512"`
#### API:
```typescript
JSHash(message: string, algorithm: string):Promise;
```
```typescript
JSHmac(message: string, secret: string, algorithm: string): Promise;
```
#### Example :
```javascript
import { JSHash, JSHmac, CONSTANTS } from "react-native-hash";
JSHash("message", CONSTANTS.HashAlgorithms.sha256)
.then(hash => console.log(hash))
.catch(e => console.log(e));
JSHmac("message", "SecretKey", CONSTANTS.HmacAlgorithms.HmacSHA256)
.then(hash => console.log(hash))
.catch(e => console.log(e));
```
- keccak implementation defaults to 512 and is not tested against all attack vectors.
check out the [example](https://github.com/Drazail/react-native-hash/blob/f992bdb09b1df5652a3b1590ca6e903a077ad4e6/example/App.js#L88-L90) for more information.
# React Hooks
Following hooks are available:
```javascript
useHash(
hashAlgo?: string = "MD5",
initialMessage?: string = "hello World",
): [
hashed: string,
setMessage: (message: string) => Promise,
setAlgo: (algo: string) => Promise
];
```
```javascript
useHmac(
hmacAlgo?: string = "HmacMD5",
initialMessage?: string = "hello World",
initialSecret?: string = "SecretKey",
): [
hashed: string,
setMessage: (message: string) => Promise,
setAlgo: (algo: string) => Promise,
setSecret: (secret: string) => Promise
];
```
## Usage
```javascript
const [hashedMessage, setHashAlgo, setHashMessage] = useHash();
const [hmac, setHmacAlgo, setHmacMessage, setHmacSecret] = useHmac();
```
`hashedMessage` and `hmac` will update after a call to one of the setters is resolved.
note that all the setter functions of these two hooks are async and will return a `promise`.
check out the [example] for more information.
***
# Android
#### Hash Algorithm :
`"md2" | "md5" | "sha1" | "sha224" | "sha256" | "sha384" | "sha512"`
#### HMAC Algorithm :
`"HmacMD5" | "HmacSHA1" | "HmacSHA224" | "HmacSHA256" | "HmacSHA384" | "HmacSHA512" | "PBEwithHmacSHA"`
`"PBEwithHmacSHA1" | "PBEwithHmacSHA224" | "PBEwithHmacSHA256" | "PBEwithHmacSHA384" | "PBEwithHmacSHA512"`
#### API
```typescript
hashFile(uri: string, algorithm: string): Promise;
```
```typescript
hashFilesForFolder(uri: string, algorithm: string, minFileSize: number, maxFileSize: number, extensionFilter: string, batchSize: number, delay: number ): Promise<{FilesCount:number, isFinalBatch: bool, batchNumber: number, results: Record}>;
```
* pass an empty string `""` to the hashFilesForFolder as extensionFilter if you dont want to filter the results.
* if you pass -1 as batchSize, the function will return a promise which resolves into an object with all hashes
* if you pass any number other than -1 to batchSize, instead of returning the results, null will be returned, but when each batch is ready an event will be fired.
* the delay parameter determines how many ms should the native thread waits before sending the next batch.
* check `"press to hash Folder with events"` and `"press to hash Folder"` in the example app for more details
```typescript
hashFilesForFolders(uri: string, algorithm: string, minFileSize: number, maxFileSize: number, extensionFilter: string, batchSize: number, delay: number ): Promise<{FilesCount:number, isFinalBatch: bool, batchNumber: number, results: Record}>;
```
* behaves the same as the `hashFilesForFolder`, but reccieves an String array as first argument.
```typescript
hashUrl(url: string, HTTPMethod: string, headers: Record, algorithm: string): Promise;
```
```typescript
hashString(message: string, algorithm: string): Promise;
```
```typescript
generateHmac(message: string, key: string, algorithm: string): Promise;
```
#### Example
```javascript
import RnHash, { CONSTANTS } from "react-native-hash";
RnHash.hashFile("uri", CONSTANTS.HashAlgorithms.sha256)
.then(hash => console.log(hash))
.catch(e => console.log(e));
RNHash.hashFilesForFolders(
["uri", "anotherUri"],
CONSTANTS.HashAlgorithms.sha256,
0,
1048576,
".mp3",
-1,
0
)
.then(b => setFolderString(JSON.stringify(b)))
.catch(er => console.log(er));
RNHash.hashFilesForFolder(
"uri",
CONSTANTS.HashAlgorithms.sha256,
0,
1048576,
".mp3",
-1,
0
)
.then(b => setFolderString(JSON.stringify(b)))
.catch(er => console.log(er));
RnHash.hashUrl(
"url",
"HTTPMethod",
{ "Content-type": "application/json" },
CONSTANTS.HashAlgorithms.sha256
)
.then(hash => console.log(hash))
.catch(e => console.log(e));
RnHash.hashString("message", CONSTANTS.HashAlgorithms.sha256)
.then(hash => console.log(hash))
.catch(e => console.log(e));
RNHash.generateHmac("message", "secretKey", CONSTANTS.HmacAlgorithms.HmacSHA512)
.then(HMAC => console.log(HMAC))
.catch(er => console.log(er));
```
check out the [example](https://github.com/Drazail/react-native-hash/blob/6548c12f61d968aa4c647a1c98f06ca31e591381/example/App.js#L47-L54) for more information.
## Topics
- [documentation](https://github.com/Drazail/react-native-hash/wiki/Documentation)
- [to do](https://github.com/Drazail/react-native-hash/wiki/To-Do)
- [contribution guide](https://github.com/Drazail/react-native-hash/wiki/Contribution-Guide)
- [code of conduct](https://github.com/Drazail/react-native-hash/wiki/Code-of-Conduct)
#### Hashing files and urls are only supported on android at this point
### Todo
- SHA-3
- other Keccak lengths
### Status
| | iOS | Android | windows |
| ---------------------- | ------------------ | ------------------ | ------------------ |
| hash local files | :x: | :heavy_check_mark: | :x: |
| hash network assets | :x: | :heavy_check_mark: | :x: |
| hash network responses | :x: | :heavy_check_mark: | :x: |
| hash bundle assets | :x: | :x: | :x: |
| hash strings | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
| HMAC | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: |
- all PRs are welcome
[](https://packagequality.com/#?package=react-native-hash)
---
#### Credits
JSHash and JSHMac functions use some Open Source code snippets. You can find the source code of their open source projects along with license information below. We acknowledge and are grateful to these developers for their contributions to open source.
- Project: crypto-es https://github.com/entronad/crypto-es
- License (MIT) https://github.com/entronad/crypto-es/blob/master/LICENSE
---