Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gajjartejas/react-native-lan-port-scanner
A simple port scanner for react native.
https://github.com/gajjartejas/react-native-lan-port-scanner
lan-scan lan-scanner port-scanner react-native wifi-scanner
Last synced: about 2 months ago
JSON representation
A simple port scanner for react native.
- Host: GitHub
- URL: https://github.com/gajjartejas/react-native-lan-port-scanner
- Owner: gajjartejas
- License: mit
- Created: 2022-02-01T17:54:14.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-06-06T17:00:05.000Z (7 months ago)
- Last Synced: 2024-11-03T11:47:53.450Z (2 months ago)
- Topics: lan-scan, lan-scanner, port-scanner, react-native, wifi-scanner
- Language: TypeScript
- Homepage: https://gajjartejas.me
- Size: 1.39 MB
- Stars: 26
- Watchers: 2
- Forks: 8
- Open Issues: 2
-
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-lan-port-scanner
A simple port scanner for react native.
[](https://www.npmjs.org/package/react-native-lan-port-scanner)
[](https://www.npmjs.org/package/react-native-lan-port-scanner)
[](https://opensource.org/licenses/MIT)
[](https://www.android.com)
[](https://developer.apple.com/ios)
## Installation
This package requires [react-native-tcp](https://github.com/gajjartejas/react-native-tcp) as dependency. Please follow
below steps to install:
```sh
yarn add gajjartejas/react-native-tcp react-native-lan-port-scanner
```
or
```sh
npm install gajjartejas/react-native-tcp react-native-lan-port-scanner
```
after you have to install pods
```sh
npx pod-install
```
## For Android
You have to add below permission to `AndroidManifest.xml` file
```xml
```
## For iOS
Make a sure you have to add `NSExceptionAllowsInsecureHTTPLoads` to `localhost` in case of insecure
connection `info.plist`.
```xml
NSExceptionDomains
localhost
NSExceptionAllowsInsecureHTTPLoads
```
## Usage
### Scan network's hosts with specific ports
```js
import LanPortScanner, { LSScanConfig } from 'react-native-lan-port-scanner';
//Returns `LSNetworkInfo`
const networkInfo = await LanPortScanner.getNetworkInfo();
const config1: LSScanConfig = {
networkInfo: networkInfo,
ports: [80, 8085], //Specify port here
timeout: 1000, //Timeout for each thread in ms
threads: 150, //Number of threads
};
//OR
const ipRange = ['192.168.1.1', '192.168.1.112'];
let config2: LSScanConfig = {
ipRange: ipRange, //If you provide this params then it will only scan provided ipRange.
ports: [80, 8085], //Specify port here
timeout: 1000, //Timeout for each thread in ms
threads: 150, //Number of threads
};
//Either config1 or config2 required
const cancelScanHandle = LanPortScanner.startScan(
config1, //or config2
(totalHosts: number, hostScanned: number) => {
console.log(hostScanned / totalHosts); //Show progress
},
(result) => {
console.log(result); //This will call after new ip/port found.
},
(results) => {
console.log(results); // This will call after scan end.
}
);
//You can cancel scan later
setTimeout(() => {
cancelScanHandle();
}, 5000);
```
### To scan specific host with port
```js
//Returns `LSSingleScanResult`
let result = await LanPortScanner.scanHost('192.168.1.1', 80, 1000);
```
### To get network info
```js
//Returns `LSNetworkInfo`
const networkInfo = await LanPortScanner.getNetworkInfo();
```
## API
- **Types:**
- [`LSScanConfig`](#LSScanConfig)
- [`LSNetworkInfo`](#lsnetworkinfo)
- [`LSNetworkInfoExtra`](#lsnetworkinfoextra)
- [`LSSingleScanResult`](#lssinglescanresult)
- [`LSScanResult`](#lsscanresult)
- **Methods:**
- [`getNetworkInfo()`](#getnetworkinfo)
- [`generateIPRange()`](#generateiprange)
- [`startScan()`](#startscan)
- [`scanHost()`](#scanhost)
### Types
#### `LSScanConfig`
Used to scan multiple hosts/ports.
| Property | Type | Description |
| ------------- | ------------------------- | ------------------------------------------------- |
| `networkInfo` | `LSNetworkInfo` | Contains ip address and subnet mask to scan. |
| `ports` | `number[]` or `undefined` | Ports to scan, default: `[80, 443]` |
| `timeout` | `number` or `undefined` | Timeout for each thread in ms, default: `1000 ms` |
| `threads` | `number` or `undefined` | Number of threads, default: `150` |
| `logging` | `boolean` | Enable or disable logging, default: `false` |
#### `LSNetworkInfo`
Used to generate ip ranges for scanning.
| Property | Type | Description |
| ------------ | -------- | ----------- |
| `ipAddress` | `string` | IP Address |
| `subnetMask` | `string` | Subnet mask |
#### `LSNetworkInfoExtra`
Contains ip ranges for scanning purpose.
| Property | Type | Description |
| -------------- | ---------------- | ---------------------------------------------------------------------------------- |
| `ipAddress` | `string` | IP Address |
| `subnetMask` | `string` | Subnet mask. |
| `subnetConv` | `string or null` | A CIDR prefix length for a valid IPv4 netmask or null if the netmask is not valid. |
| `firstHost` | `string` | The network address for a given IPv4 interface and netmask in CIDR notation. |
| `lastHost ` | `string` | The broadcast address for a given IPv4 interface and netmask in CIDR notation. |
| `firstHostHex` | `string` | First host address in hex representation. |
| `lastHostHex` | `string` | Last host address in hex representation. |
| `ipRange` | `string[]` | Array of ip addresses. |
#### `LSSingleScanResult`
Returns after host/port found.
| Property | Type | Description |
| -------- | -------- | ----------- |
| `ip` | `string` | IP Address |
| `port` | `number` | Subnet mask |
#### `LSScanResult`
Returns after scan complete.
| Property | Type | Description |
| -------- | ---------- | ----------- |
| `ip` | `string` | IP Address |
| `ports` | `number[]` | Subnet mask |
### Methods
#### `getNetworkInfo()`
Returns `LSNetworkInfo` object.
**Example:**
```javascript
const networkInfo = await LanPortScanner.getNetworkInfo();
```
#### `getNetworkInfo()`
Takes `LSNetworkInfo` and scan all hosts for specified ports.
#### `generateIPRange()`
Takes `LSNetworkInfo`, generates ip address, ports array and return `LSNetworkInfoExtra` object.
**Example:**
```javascript
const networkInfo = await LanPortScanner.getNetworkInfo();
const ipRangeInfo = generateIPRange(config.networkInfo);
```
#### `scanHost()`
Scan single host with port, returns `LSSingleScanResult`
**Example:**
```javascript
const result = await LanPortScanner.scanHost('192.168.1.1', 80, 1000);
```
## TODO
- Better scan handling and canceling.
- Add abort signal for cancelling.
## Contributing
See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.
## License
MIT
## Credits
[Shift8 Web](https://shift8web.ca/2019/03/how-to-build-a-port-scanner-with-javascript-using-react-native/) for awsome
tutorial.
[react-native-netinfo](https://github.com/react-native-netinfo/react-native-netinfo) by [The React Native Community
](https://reactnative.dev/help)
Local area icons created by Eucalyp -
Flaticon
---
Made with [create-react-native-library](https://github.com/callstack/react-native-builder-bob)