Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/goliatone/macwatch

Track specific MAC addresses in your network.
https://github.com/goliatone/macwatch

Last synced: 11 days ago
JSON representation

Track specific MAC addresses in your network.

Host: GitHub
URL: https://github.com/goliatone/macwatch
Owner: goliatone
License: mit
Created: 2015-03-30T04:21:54.000Z (over 9 years ago)
Default Branch: master
Last Pushed: 2018-11-20T05:52:21.000Z (almost 6 years ago)
Last Synced: 2024-10-17T13:55:17.862Z (21 days ago)
Language: JavaScript
Size: 20.5 KB
Stars: 3
Watchers: 2
Forks: 1
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE-MIT

Awesome Lists containing this project

README

# macwatch

Track specific MAC addresses in your network, and execute a command when found or lost.

>arpwatch is a computer software tool for monitoring Address Resolution Protocol traffic on a computer network.[1] It generates a log of observed pairing of IP addresses with MAC addresses along with a timestamp when the pairing appeared on the network. It also has the option of sending an email to an administrator when a pairing changes or is added.

## Getting Started
Install the module with: `npm install macwatch`

You can use `macwatch` from the **cli**:
```
$ macwatch -m XX:XX:XX:XX:XX:XX -e 'say on state changed'
```
You might need `sudo`:
```
$ sudo macwatch -m XX:XX:XX:XX:XX:XX -e 'say on state changed'
```

Thie previous command will scan the network for a MAC address that matches the provided address and execute the `say` command when state changes.

```javascript
var macwatch = require('macwatch');
```

## TODO
- Ingress arpscan from file, using stream
- Support multiple MAC addresses
- Execute commands on SEEN/GONE
- Define semantics for state SEEN/GONE
- Make commands pluggable: macwatch-email, macwatch-rest, etc.

## Documentation

```
Usage: macwatch [options]

Options:

-h, --help output usage information
-V, --version output the version number
-m, --mac-address

MAC address to watch for
-e, --exec-cmd Command to execute on state transition
-i, --interval [milliseconds] Interval between scans
-g, --gone-after [minutes] Period of time after which a MAC is considered as not present anymore
```

## Examples
_(Coming soon)_

## TODO
- Explore command/plugin system [see][gh]

## Contributing
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using [Grunt](http://gruntjs.com/).

## Release History
_(Nothing yet)_

[gh]:https://www.npmjs.com/package/gitlike-cli