Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vexcited/libpcap
[WIP] Node.js bindings for libpcap using koffi, supports Windows, macOS and Linux !
https://github.com/vexcited/libpcap
ffi ffi-bindings javascript koffi libpcap network node-js nodejs npcap packet pcap typescript wpcap
Last synced: 3 days ago
JSON representation
[WIP] Node.js bindings for libpcap using koffi, supports Windows, macOS and Linux !
- Host: GitHub
- URL: https://github.com/vexcited/libpcap
- Owner: Vexcited
- Created: 2023-10-28T07:24:11.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-10T23:14:51.000Z (3 months ago)
- Last Synced: 2024-11-13T18:18:48.142Z (2 months ago)
- Topics: ffi, ffi-bindings, javascript, koffi, libpcap, network, node-js, nodejs, npcap, packet, pcap, typescript, wpcap
- Language: TypeScript
- Homepage:
- Size: 111 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# `libpcap-ffi` - [`libpcap`](https://github.com/the-tcpdump-group/libpcap) FFI wrapper for Node.js
Supports **Windows**, **macOS** and **Linux**.
This project was made possible thanks to [`koffi`](https://koffi.dev/), an awesome and fast C FFI module for Node.js.
Since `koffi` is made for Node.js, compatibility with Bun or Deno is not guaranteed but could be possible.
## Prerequisites
### Windows
You'll need to install [Npcap](https://npcap.com/#download).
Check that you have the `wpcap.dll` file at `C:\Windows\System32\Npcap\wpcap.dll` - should be the default location.
Note that `libpcap-ffi` may not be compatible with [WinPcap](https://www.winpcap.org/)
so if you had WinPcap installed before, you'll need to uninstall it or
find a way to use the `wpcap.dll` from Npcap instead of the one from WinPcap.
### macOS
You need to have `libpcap.dylib` installed on your system.
It's apparently already installed on macOS, but if it's not, you can install it using Homebrew:
```sh
brew install libpcap
```
### Linux
You need to have `libpcap.so` installed on your system.
## Usage
Every functions can be directly imported from `libpcap-ffi`, so if you want to use `findAllDevs`, you can simply do:
```js
// ESM
import { findAllDevs } from "libpcap-ffi";
// CJS
const { findAllDevs } = require("libpcap-ffi");
// Just use it !
const devices = await findAllDevs();
console.log(devices);
/** >>> Returns the following array:
* [
* {
* name: '\\Device\\...',
* description: '...',
* addresses: [ ... ],
* flags: 22
* },
* ...
* ]
*/
```
## Contributing
### Commands
Note that we use `pnpm` to manage dependencies.
| Command | Description |
| ------- | ----------- |
| `pnpm install` | Install the dependencies |
| `pnpm build` | Bundle `src` directory into `dist` |
### Run examples
You should install globally [`tsx`](https://www.npmjs.com/package/tsx).
```sh
npm i -g tsx
# Now you can run the examples.
tsx ./examples/devices.ts
```
### TO-DO
A list of things to do to make the library more complete.
- [ ] `pcap_open_live` (work in progress)
- [ ] `pcap_datalink`
- [ ] `pcap_loop`
- [ ] `pcap_close`