https://github.com/shellrow/netscan

Cross-platform network scan library. Written in Rust.
https://github.com/shellrow/netscan

network rust rust-crate rust-library scanner security

Last synced: 13 days ago
JSON representation

Cross-platform network scan library. Written in Rust.

• Host: GitHub
• URL: https://github.com/shellrow/netscan
• Owner: shellrow
• License: mit
• Created: 2021-04-09T14:49:46.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-12-18T13:12:42.000Z (11 months ago)
• Last Synced: 2023-12-18T16:24:50.517Z (11 months ago)
• Topics: network, rust, rust-crate, rust-library, scanner, security
• Language: Rust
• Homepage:
• Size: 450 KB
• Stars: 40
• Watchers: 1
• Forks: 6
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[crates-badge]: https://img.shields.io/crates/v/netscan.svg

[crates-url]: https://crates.io/crates/netscan

[license-badge]: https://img.shields.io/crates/l/netscan.svg

[examples-url]: https://github.com/shellrow/netscan/tree/main/examples

# netscan [![Crates.io][crates-badge]][crates-url] ![License][license-badge]

Cross-platform network scan library  

with the aim of being lightweight and fast. 

## Features

- Port Scan (IPv4, IPv6)

    - TCP SYN scan

    - TCP CONNECT scan

- Host Scan (IPv4, IPv6)

    - ICMP PING scan

    - TCP PING scan

    - UDP PING scan

## Usage

Add `netscan` to your dependencies  

```toml:Cargo.toml

[dependencies]

netscan = "0.28"

```

## Example

See [Examples][examples-url]

## Supported platform

- Linux

- macOS

- Windows

## Privileges

This library requires the ability to create raw sockets.  Execute with administrator privileges.  

## Note for Windows Users

If you are using Windows, please consider the following points before building and running:

- Npcap or WinPcap Installation:

    - Ensure that you have [Npcap](https://npcap.com/#download) or WinPcap installed on your system.

    - If using Npcap, make sure to install it with the "Install Npcap in WinPcap API-compatible Mode" option.

- Build Dependencies:

    - Place the Packet.lib file from the [Npcap SDK](https://npcap.com/#download) or WinPcap Developers pack in a directory named lib at the root of this repository.

    - You can use any of the locations listed in the %LIB% or $Env:LIB environment variables.

    - For the 64-bit toolchain, the Packet.lib is located in /Lib/x64/Packet.lib.

    - For the 32-bit toolchain, the Packet.lib is located in /Lib/Packet.lib.