# mplane_probe

> mPlane generic active probe-

Latest version **0.0.3** (published 2015-03-03) · BSD license · 0 weekly downloads

## Install

```sh
npm install mplane_probe
pnpm add mplane_probe
yarn add mplane_probe
bun add mplane_probe
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.3 |
| Published | 2015-03-03 |
| First published | 2015-03-03 |
| Weekly downloads | 0 |
| License | BSD |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 8 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | f.invernizzi@libero.it |
| Maintainers | finvernizzi |
| Keywords | mplane, measure, pinger |

## Links

- npm: https://www.npmjs.com/package/mplane_probe
- Repository: https://github.com/finvernizzi/mplane_probe
- Issues: https://github.com/finvernizzi/mplane_probe/issues
- npm.io page: https://npm.io/package/mplane_probe

## Dependencies (8)

- [fs](https://npm.io/package/fs.md) >=0.0.2
- [cli](https://npm.io/package/cli.md) >=0.6.5
- [url](https://npm.io/package/url.md) >=0.10.2
- [async](https://npm.io/package/async.md) >=0.9.0
- [lodash](https://npm.io/package/lodash.md) >=3.3.0
- [mplane](https://npm.io/package/mplane.md) >=0.5.7
- [dns-sync](https://npm.io/package/dns-sync.md) >=0.1.1
- [mplane_http_transport](https://npm.io/package/mplane_http_transport.md) >=0.1.12

## Recent versions

- 0.0.3 (latest) — 2015-03-03
- 0.0.2 — 2015-03-03

## README

mplane_probe
=================

[![mPlane](http://www.ict-mplane.eu/sites/default/files//public/mplane_final_256x_0.png)](http://www.ict-mplane.eu/)


This package contains a working examples of a generic [mPlane](http://www.ict-mplane.eu/) acive probe integrate with mPlane protocol stack, over HTTPS transport.
The probe is capable of doing following measures:

	delay.twoway (icmp)
	delay.twoway (HTTP GET)
	hops.ip
	
A complete set of working SSL certificates is provided (with root-CA and signing-CA) [here](https://github.com/stepenta/RI/tree/master/PKI) in order to have a complete, full working environment. 
For security reasons you SHOULD update these files with your own certificates.

#Installation
Get all the code from github

```git clone https://github.com/finvernizzi/mplane_probe.git
```


Now you need to install all the nodejs dependencies

```
cd ./mplane_probe
npm install
```
Done. You are ready to run the three components.



##Configuration


Configuration of this probe can be done in probe.json
 
```json
{
    "main":{
        "logFile":"/var/log/mplane/pinger.log",
        "retryConnect":5000,
        "pingerLabel": "pinger_TI_test",
        "tracerouteLabel": "tracer_TI_test",
        "ipAdresses" : ["192.168.0.1"],
        "tracerouteExec": "/usr/sbin/traceroute",
        "tracerouteOptions": "-q1 -n -w1 -m5"
    },
    "supervisor":{
        "host": "mplane.org",
        "port": 2427
    },
    "ssl":{
        "key": "./ssl/official/Component1/Component-1-plaintext.key"
        ,"cert": "./ssl/official/Component1/Component-1.crt.pem"
        ,"ca": [ "./ssl/official/root-ca.pem" , "./ssl/official/signing-ca.pem" ]
        ,"requestCert" : true
    },
    "registry":{
		"url": "file://../registry.json"
    }
}
```

The implementation is very simple, and tested on FreeBSD (9.3) and Ubuntu 10.4, so some changes may be required in order to fully work on other platform.
In particular two functions should be checked:
- doAPing. This function executes the ping with parameters received in Specifications. The command is 
       ```javascript exec("ping -S " + __MY_IP__ + "  -W "+ Wait  +" -c " + requests + " " + destination  + " | grep from"```
    
- doATrace.This function executes the traceroute with parameters received in Specifications. The command is 
        ```javascript exec(configuration.main.tracerouteExec + " " + configuration.main.tracerouteOptions + " -s " + __MY_IP__ + " " + destination```
         
To run the probe:
```
node ./pinger
```

##LICENSE

This software is released under the [BSD](http://en.wikipedia.org/wiki/BSD_licenses#2-clause_license_.28.22Simplified_BSD_License.22_or_.22FreeBSD_License.22.29) license.

---
_Source: https://npm.io/package/mplane_probe · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._