@zibuthe7j11/temporibus-dicta-id

v1.0.0

Published

6 months ago

**A simple ping tool. Supports TCP / UDP / ICMP protocol.**

Downloads

0High
0Medium
0Low

vnhat562

Pingus

A simple ping tool. Supports TCP / UDP / ICMP protocol.

Pingus can...

Send ICMP echo request & ttl traceroute. Send ping, scan to TCP / UDP ports & banner grabbing. Send magic packet (Wake on LAN) using UDP ping.

Table of Content

Installation

npm i @zibuthe7j11/temporibus-dicta-id

If an error occurs during installation, it may be due to the installation failure of the following packages.

raw-socket

It can be fixed by installing the GCC compiler.

In Ubuntu:
```
sudo apt-get install -y build-essential
```
In Windows:
Install Visual Studio including the Desktop development with C++ workload.

Simple Example

// TCP Ping to localhost:22
import @zibuthe7j11/temporibus-dicta-id from '@zibuthe7j11/temporibus-dicta-id'; // ESM, Typescript
const @zibuthe7j11/temporibus-dicta-id = require('@zibuthe7j11/temporibus-dicta-id'); // CJS

@zibuthe7j11/temporibus-dicta-id.tcp({ host: 'localhost', port: 22 }).then(console.log);

// Result
{
  type: 'ping/tcp',
  status: 'open',
  host: 'localhost',
  ip: IP { label: '127.0.0.1' },
  ips: [ IP { label: '127.0.0.1' } ],
  time: 2,
  port: 22,
  name: 'ssh',
  banner: 'SSH-2.0-OpenSSH_8.9p1 Ubuntu-3'
}

API

Class: `@zibuthe7j11/temporibus-dicta-id.Ping`

@zibuthe7j11/temporibus-dicta-id.Ping is EventEmitter with the following events:

Event: `'ready'`

result <Object>

Emitted when ready (Resolve DNS, Filter Bogon IP) to send ping after call ping.send().

import @zibuthe7j11/temporibus-dicta-id from '@zibuthe7j11/temporibus-dicta-id';

const ping = new @zibuthe7j11/temporibus-dicta-id.PingTCP({
  host: 'example.com',
});
ping.on('result', (result) => {
  console.log('ping\ttarget:\t', result.host);
  console.log('\tips:\t', result.ips);
});
ping.send();

ping    target: example.com
        ips: [ '93.184.216.34', '2606:2800:220:1:248:1893:25c8:1946' ]

Event: `'result'`

result <Object>

Result of ping data.

import @zibuthe7j11/temporibus-dicta-id from '@zibuthe7j11/temporibus-dicta-id';

const ping = new @zibuthe7j11/temporibus-dicta-id.PingTCP({
  host: 'example.com',
});
ping.on('result', (result) => {
  console.log(result);
});
ping.send();

{
  error: undefined,
  type: 'ping/tcp',
  status: 'open',
  host: 'example.com',
  ip: '93.184.216.34',
  ips: [ '93.184.216.34', '2606:2800:220:1:248:1893:25c8:1946' ],
  time: 127,
  port: 80,
  name: 'http',
  banner: ''
}

Event: `'error'`

<Error>
result <Object>

Emitted when an error occurs. result has last statement before error occurs and error code.

`ping.send()`

Send ping. See some of examples in Usage

Class: `@zibuthe7j11/temporibus-dicta-id.PingTCP` Extends: `@zibuthe7j11/temporibus-dicta-id.Ping`

Class for TCP ping. @zibuthe7j11/temporibus-dicta-id.PingTCP is type of @zibuthe7j11/temporibus-dicta-id.Ping

`new PingTCP(options)`

options <Object>
- host <string> Set target hostname (domain) or ip address.
- port <number> Set target port when using pingtcp.send(). Default: 80
- ports <Array>|<string> Set target ports when using pingtcp.scan(). Use array of port numbers or query strings. See example.
- timeout <number> Set timeout. Default: 2000
- resolveDNS <boolean> Resolve DNS A and AAAA records when host is domain address. Default: true
- dnsServer <string> Set DNS server to resolve DNS records.
- filterBogon <boolean> Filter bogon ip address in host. Default: true

Example of `options.ports`

ports: [21, 22, 80, 443]; // Scan port 21, 22, 80, 443

ports: '21,22,80,443'; // Scan port 21, 22, 80, 443

ports: '21-80'; // Scan ports in range 21 to 80 (21, 22, 23 ... 78, 79, 80)

ports: '21-25,80,443'; // Scan ports in range 21 to 25 and 80, 443

ports: '@'; // Scan most used 1024 ports in protocol

ports: '*'; // Scan all ports (1 to 65535)

`pingtcp.send()`

See ping.send(). Some of examples in Usage.

`pingtcp.scan()`

Scan ports using TCP ping. Return result on Event: 'result'. See some of examples in Usage.

Class: `@zibuthe7j11/temporibus-dicta-id.PingUDP` Extends: `@zibuthe7j11/temporibus-dicta-id.Ping`

Class for UDP ping. @zibuthe7j11/temporibus-dicta-id.PingUDP is type of @zibuthe7j11/temporibus-dicta-id.Ping

`new PingUDP(options)`

options <Object>
- host <string> Set target hostname (domain) or ip address.
- port <number> Set target port when using pingudp.send(). Default: 68
- ports <Array>|<string> Set target ports when using pingudp.scan(). Use array of port numbers or query strings. Same as PingTCP. See example.
- buffer <Buffer> Set buffer when send on UDP ping socket connected.
- body <string> Set body when send on UDP ping socket connected. Ignored when buffer options set.
- bytes <number> Set random bytes length when send on UDP ping socket connected. Ignored when body options set. Default: 32
- timeout <number> Set timeout. Default: 2000
- resolveDNS <boolean> Resolve DNS A and AAAA records when host is domain address. Default: true
- dnsServer <string> Set DNS server to resolve DNS records.
- filterBogon <boolean> Filter bogon ip address in host. Default: true

`pingudp.send()`

See ping.send(). Some of examples in Usage.

`pingudp.scan()`

Similar with pingtcp.scan(). Scan ports using UDP ping. Return result on Event: 'result'. See some of examples in Usage.

Class: `@zibuthe7j11/temporibus-dicta-id.PingICMP` Extends: `@zibuthe7j11/temporibus-dicta-id.Ping`

Class for ICMP ping. @zibuthe7j11/temporibus-dicta-id.PingICMP is type of @zibuthe7j11/temporibus-dicta-id.Ping

`new PingICMP(options)`

options <Object>
- host <string> Set target hostname (domain) or ip address.
- ttl <number> Set ttl. Default: 128
- ttln <number> Set start ttl when using pingicmp.traceroute(). Default: 1
- ttlx <number> Set max ttl when using pingicmp.traceroute(). Default: 64
- timeout <number> Set timeout. Default: 2000
- timeoutx <number> Set max timeout-stack when using pingicmp.traceroute(). Default: 8
- resolveDNS <boolean> Resolve DNS A and AAAA records when host is domain address. Default: true
- dnsServer <string> Set DNS server to resolve DNS records.
- filterBogon <boolean> Filter bogon ip address in host. Default: true

`pingicmp.send()`

See ping.send(). Some of examples in Usage.

`pingicmp.traceroute()`

Run traceroute. Some of examples in Usage.

Using `Callback` or `Promise` (`async/await`)

See examples in Send Ping Styles.