Pingus

Пингус

Простой инструмент для проверки связи. Поддерживает протокол TCP/UDP/ICMP.

Пингус может...

Отправьте эхо-запрос ICMP и трассировку ttl.
Отправляйте пинг, сканируйте порты TCP/UDP и захватывайте баннеры.
Отправьте волшебный пакет (Wake on LAN), используя UDP-пинг.

Содержание

• Установка
• Простой пример
• API
  • Класс: pingus.Ping
    • Событие: 'ready'
    • Событие: 'result'
    • Событие: 'error'
    • ping.send()
  • Класс: pingus.PingTCP Расширяет: pingus.Ping
    • new PingTCP(options)
    • pingtcp.send()
    • pingtcp.scan()
  • Класс: pingus.PingUDP Расширяет: pingus.Ping
    • new PingUDP(options)
    • pingudp.send()
    • pingudp.scan()
  • Класс: pingus.PingICMP Расширяет: pingus.Ping
    • new PingICMP(options)
    • pingicmp.send()
    • pingicmp.traceroute()
  • Использование Callback или Promise ( async/await )
    • pingus.tcp(options[, callback])
    • pingus.tcpscan(options[, callback])
    • pingus.udp(options[, callback])
    • pingus.udpscan(options[, callback])
    • pingus.wol(mac, options[, callback])
    • pingus.icmp(options[, callback])
    • pingus.traceroute(options[, callback])
• Использование
  • Используйте Пингус
  • Отправка стилей Ping
  • TCP-пинг
  • Сканировать TCP-порты
  • UDP-пинг
  • Сканировать UDP-порты
  • Пробуждение по локальной сети
  • ICMP-пинг
  • Трассировка

Установка

 npm i pingus

Если во время установки возникает ошибка, это может быть связано с ошибкой установки следующих пакетов.

• сырая розетка

Это можно исправить, установив компилятор GCC.

• В Убунту:

  sudo apt-get install -y build-essential

• В Windows:

  Установите Visual Studio , включая Desktop development with C++ .

Простой пример

 // TCP Ping to localhost:22
import pingus from 'pingus' ; // ESM, Typescript
const pingus = require ( 'pingus' ) ; // CJS

pingus . 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'
  toPrimitiveJSON : [ Function ( anonymous ) ]
}

API

Класс: pingus.Ping

pingus.Ping — это EventEmitter со следующими событиями:

Событие: 'ready'

• result <Object>

Выдается при готовности (разрешение DNS, фильтрация IP-адреса Богона) для отправки ping после вызова ping.send() .

 import pingus from 'pingus' ;

const ping = new pingus . PingTCP ( {
  host : 'example.com' ,
} ) ;
ping . on ( 'ready' , ( result ) => {
  const data = result . toPrimitiveJSON ( ) ;
  console . log ( 'pingttarget:t' , data . host ) ;
  console . log ( 'tips:t' , data . ips ) ;
} ) ;
ping . send ( ) ;

Результат (вывод консоли)

 ping    target:  example.com
        ips:     [ '93.184.215.14', '2606:2800:021f:cb07:6820:80da:af6b:8b2c' ]

Событие: 'result'

• result <Object>

Результат данных ping.

 import pingus from 'pingus' ;

const ping = new pingus . PingTCP ( {
  host : 'example.com' ,
} ) ;
ping . on ( 'result' , ( result ) => {
  const data = result . toPrimitiveJSON ( ) ;
  console . log ( result ) ;
} ) ;
ping . send ( ) ;

Результат (вывод консоли)

 {
  type : 'ping/tcp' ,
  status : 'open' ,
  host : 'example.com' ,
  ip : '93.184.215.14' ,
  ips : [ '93.184.215.14' , '2606:2800:021f:cb07:6820:80da:af6b:8b2c' ] ,
  time : 134 ,
  port : 80 ,
  name : 'http' ,
  banner : ''
}

Событие: 'error'

• <Error>
• result <Object>

Выдается при возникновении ошибки. result содержит последний оператор перед возникновением ошибки и код ошибки.

ping.send()

Отправить пинг. См. некоторые примеры в разделе «Использование».

Класс: pingus.PingTCP Расширяет: pingus.Ping

Класс для TCP-пинга.
pingus.PingTCP — это тип pingus.Ping

new PingTCP(options)

• options <Object>
  • host <string> Установите целевое имя хоста (домен) или IP-адрес.
  • port <number> Установите целевой порт при использовании pingtcp.send() . По умолчанию: 80
  • ports <Array> | <string> Установите целевые порты при использовании pingtcp.scan() . Используйте массив номеров портов или строки запроса. См. пример.
  • timeout <number> Установить таймаут. По умолчанию: 2000
  • resolveDNS <boolean> Разрешает записи DNS A и AAAA , когда host является адресом домена. По умолчанию: true
  • dnsServer <string> Установите DNS-сервер для разрешения записей DNS.
  • filterBogon <boolean> Фильтровать IP-адрес богона на host . По умолчанию: true

Пример 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()

См. ping.send() . Некоторые примеры в разделе «Использование».

pingtcp.scan()

Сканирование портов с помощью TCP-ping. Возврат результата по событию: 'result' . См. некоторые примеры в разделе «Использование».

Класс: pingus.PingUDP Расширяет: pingus.Ping

Класс для UDP-пинга.
pingus.PingUDP — это тип pingus.Ping

new PingUDP(options)

• options <Object>
  • host <string> Установите целевое имя хоста (домен) или IP-адрес.
  • port <number> Установите целевой порт при использовании pingudp.send() . По умолчанию: 68
  • ports <Array> | <string> Установите целевые порты при использовании pingudp.scan() . Используйте массив номеров портов или строки запроса. То же, что PingTCP. См. пример.
  • buffer <Buffer> Установить буфер при отправке через подключенный сокет UDP ping.
  • body <string> Устанавливает тело при отправке через подключенный сокет UDP ping. Игнорируется, если установлены параметры buffer .
  • bytes <number> Установить случайную длину в байтах при отправке через подключенный сокет UDP ping. Игнорируется, когда установлены параметры body . По умолчанию: 32
  • timeout <number> Установить таймаут. По умолчанию: 2000
  • resolveDNS <boolean> Разрешает записи DNS A и AAAA , когда host является адресом домена. По умолчанию: true
  • dnsServer <string> Установите DNS-сервер для разрешения записей DNS.
  • filterBogon <boolean> Фильтровать IP-адрес богона на host . По умолчанию: true

pingudp.send()

См. ping.send() . Некоторые примеры в разделе «Использование».

pingudp.scan()

Аналогично с pingtcp.scan() .
Сканируйте порты с помощью UDP-пинга. Возврат результата по событию: 'result' . См. некоторые примеры в разделе «Использование».

Класс: pingus.PingICMP Расширяет: pingus.Ping

Класс для ICMP-пинга.
pingus.PingICMP — это тип pingus.Ping

new PingICMP(options)

• options <Object>
  • host <string> Установите целевое имя хоста (домен) или IP-адрес.
  • ttl <number> Установить срок действия. По умолчанию: 128
  • ttln <number> Установить время начала при использовании pingicmp.traceroute() . По умолчанию: 1
  • ttlx <number> Установите максимальное время жизни при использовании pingicmp.traceroute() . По умолчанию: 64
  • timeout <number> Установить таймаут. По умолчанию: 2000
  • timeoutx <number> Установите максимальный стек таймаута при использовании pingicmp.traceroute() . По умолчанию: 8
  • resolveDNS <boolean> Разрешает записи DNS A и AAAA , когда host является адресом домена. По умолчанию: true
  • dnsServer <string> Установите DNS-сервер для разрешения записей DNS.
  • filterBogon <boolean> Фильтровать IP-адрес богона на host . По умолчанию: true

pingicmp.send()

См. ping.send() . Некоторые примеры в разделе «Использование».

pingicmp.traceroute()

Запустите трассировку. Некоторые примеры в разделе «Использование».

Использование Callback или Promise ( async/await )

См. примеры в разделе «Стили отправки Ping».

pingus.tcp(options[, callback])

Отправить TCP-пинг.

pingus.tcpscan(options[, callback])

Сканирование портов с помощью TCP-ping.

pingus.udp(options[, callback])

Отправьте UDP-пинг.

pingus.udpscan(options[, callback])

Сканируйте порты с помощью UDP-пинга.

pingus.wol(mac, options[, callback])

• mac <string> Установить целевой MAC-адрес.
• options <Object> То же, что и параметры new PingUDP(options)

Отправьте волшебный пакет UDP ping, чтобы использовать функцию WOL.

pingus.icmp(options[, callback])

Отправить ICMP-пинг.

pingus.traceroute(options[, callback])

Запустите трассировку.

Использование

Используйте Пингус

ЕСМ (Типскрипт)

 import pingus from 'pingus' ;

ЗАО

 const pingus = require ( 'pingus' ) ; 

Отправка стилей Ping

Использование Class расширяет EventEmitter

 // TCP ping to localhost:80
new pingus . PingTCP ( { host : 'localhost' } )
  . on ( 'result' , ( result ) => {
    console . log ( result . toPrimitiveJSON ( ) ) ;
  } )
  . on ( 'error' , ( err , result ) => {
    throw err ;
  } )
  . send ( ) ;

Использование Callback

 // TCP ping to localhost:80
pingus . tcp ( { host : 'localhost' } , ( err , result ) => {
  if ( err ) {
    throw err ;
  }
  console . log ( result ) ;
} ) ;

Использование Promise

 // TCP ping to localhost:80
pingus
  . tcp ( { host : 'localhost' } )
  . then ( ( result ) => {
    console . log ( result . toPrimitiveJSON ( ) ) ;
  } )
  . catch ( ( err ) => {
    throw err ;
  } ) ;

Использование async/await

 // TCP ping to localhost:80
const result = await pingus . tcp ( { host : 'localhost' } ) ;
console . log ( result . toPrimitiveJSON ( ) ) ;

Результат (вывод консоли)

 {
  type : 'ping/tcp' ,
  status : 'open' ,
  host : 'localhost' ,
  ip : '127.0.0.1' ,
  ips : [ '127.0.0.1' ] ,
  time : 2 ,
  port : 80 ,
  name : 'http' ,
  banner : ''
} 

TCP-пинг

 // TCP ping to localhost:22
new pingus . PingTCP ( { host : 'localhost' , port : 22 } )
  . on ( 'result' , ( result ) => {
    console . log ( result . toPrimitiveJSON ( ) ) ;
  } )
  . on ( 'error' , ( err , result ) => {
    throw err ;
  } )
  . send ( ) ;

Результат (вывод консоли)

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

Сканировать TCP-порты

 // TCP ping scan to localhost
new pingus . PingTCP ( {
  host : 'localhost' ,
  ports : [ 21 , 22 , 80 , 443 , 3306 , 8080 ] ,
} )
  . on ( 'result' , ( result ) => {
    console . log ( result . toPrimitiveJSON ( ) ) ;
  } )
  . on ( 'error' , ( err , result ) => {
    throw err ;
  } )
  . scan ( ) ;

Результат (вывод консоли)

 {
  type : 'ping/tcp/scan' ,
  status : 'finish' ,
  host : 'localhost' ,
  ip : '127.0.0.1' ,
  ips : [ '127.0.0.1' ] ,
  time : 2009 ,
  port : 80 ,
  name : 'http' ,
  banner : '' ,
  ports : [ 21 , 22 , 80 , 443 , 3306 , 8080 ] ,
  statuses : {
    open : [ 22 , 80 , 8080 ] ,
    reset : [ ] ,
    close : [ 21 , 443 , 3306 ] ,
    filtered : [ ] ,
    error : [ ]
  } ,
  names : {
    '21' : 'ftp' ,
    '22' : 'ssh' ,
    '80' : 'http' ,
    '443' : 'https' ,
    '3306' : 'mysql' ,
    '8080' : 'http-alt'
  } ,
  banners : { '22' : 'SSH-2.0-OpenSSH_8.9p1 Ubuntu-3' } ,
  errors : { }
} 

UDP-пинг

 // UDP ping to localhost:19132
new pingus . PingUDP ( { host : 'localhost' , port : 19132 } )
  . on ( 'result' , ( result ) => {
    console . log ( result . toPrimitiveJSON ( ) ) ;
  } )
  . on ( 'error' , ( err , result ) => {
    throw err ;
  } )
  . send ( ) ;

Результат (вывод консоли)

 {
  type : 'ping/udp' ,
  status : 'close' ,
  host : 'localhost' ,
  ip : '127.0.0.1' ,
  ips : [ '127.0.0.1' ] ,
  time : 2 ,
  port : 19132 ,
  name : 'minecraft-be'
} 

Сканировать UDP-порты

 // UDP ping scan to localhost
new pingus . PingUDP ( {
  host : 'localhost' ,
  ports : [ 67 , 68 , 161 , 162 , 445 ] ,
} )
  . on ( 'result' , ( result ) => {
    console . log ( result . toPrimitiveJSON ( ) ) ;
  } )
  . on ( 'error' , ( err , result ) => {
    throw err ;
  } )
  . scan ( ) ;

Результат (вывод консоли)

 {
  error : undefined ,
  type : 'ping/udp/scan' ,
  status : 'finish' ,
  host : 'localhost' ,
  ip : '127.0.0.1' ,
  ips : [ '127.0.0.1' ] ,
  time : 2003 ,
  ports : [ 67 , 68 , 161 , 162 , 445 ] ,
  statuses : {
    open : [ 68 ] ,
    reset : [ ] ,
    close : [ 67 , 161 , 162 , 445 ] ,
    filtered : [ ] ,
    error : [ ]
  } ,
  names : {
    '67' : 'bootps' ,
    '68' : 'bootpc' ,
    '161' : 'snmp' ,
    '162' : 'snmptrap' ,
    '445' : 'microsoft-ds'
  } ,
  banners : { } ,
  errors : { }
} 

Пробуждение по локальной сети

 // Send magic packet using UDP ping to 00-00-00-00-00-00
pingus
  . wol ( '00-00-00-00-00-00' )
  . then ( ( result ) => {
    console . log ( result . toPrimitiveJSON ( ) ) ;
  } )
  . catch ( ( error ) => {
    throw error ;
  } ) ;

Результат (вывод консоли)

 {
  type : 'ping/udp' ,
  status : 'open' ,
  host : '255.255.255.255' ,
  ip : '255.255.255.255' ,
  ips : [ '255.255.255.255' ] ,
  time : 2 ,
  port : 9 ,
  name : 'discard'
} 

ICMP-пинг

 // ICMP ping to example.com
new pingus . PingICMP ( { host : 'example.com' } )
  . on ( 'result' , ( result ) => {
    console . log ( result . toPrimitiveJSON ( ) ) ;
  } )
  . on ( 'error' , ( err , result ) => {
    throw err ;
  } )
  . send ( ) ;

Результат (вывод консоли)

 {
  type : 'ping/icmp' ,
  status : 'reply' ,
  host : 'example.com' ,
  ip : '93.184.215.14' ,
  ips : [ '93.184.215.14' , '2606:2800:021f:cb07:6820:80da:af6b:8b2c' ] ,
  time : 130 ,
  ttl : 128 ,
  bytes : 32 ,
  reply : {
    source : '93.184.216.34' ,
    type : 0 ,
    code : 0 ,
    typestr : 'ECHO_REPLY' ,
    codestr : 'NO_CODE' ,
    body : '767284c4'
  }
} 

 // ICMP ping to example.com using ttl = 10
new pingus . PingICMP ( { host : 'example.com' , ttl : 10 } )
  . on ( 'result' , ( result ) => {
    console . log ( result . toPrimitiveJSON ( ) ) ;
  } )
  . on ( 'error' , ( err , result ) => {
    throw err ;
  } )
  . send ( ) ;

Результат (вывод консоли)

 {
  type : 'ping/icmp' ,
  status : 'exception' ,
  host : 'example.com' ,
  ip : '93.184.215.14' ,
  ips : [ '93.184.215.14' , '2606:2800:021f:cb07:6820:80da:af6b:8b2c' ] ,
  time : 133 ,
  ttl : 10 ,
  bytes : 32 ,
  reply : {
    source : '152.195.76.133' ,
    type : 11 ,
    code : 0 ,
    typestr : 'TIME_EXCEEDED' ,
    codestr : 'NO_CODE' ,
    body : ']8X"bx00CQx00x00x00x00'
  }
} 

Трассировка

 // Traceroute to example.com
new pingus . PingICMP ( { host : 'example.com' , timeout : 500 } )
  . on ( 'result' , ( result ) => {
    console . log ( result . toPrimitiveJSON ( ) ) ;
  } )
  . on ( 'error' , ( err , result ) => {
    throw err ;
  } )
  . traceroute ( ) ;

Результат (вывод консоли)

 {
  type : 'ping/icmp/traceroute' ,
  status : 'finish' ,
  host : 'example.com' ,
  ip : '93.184.215.14' ,
  ips : [ '93.184.215.14' , '2606:2800:021f:cb07:6820:80da:af6b:8b2c' ] ,
  time : 7614 ,
  ttl : 128 ,
  bytes : 32 ,
  hops : [
    {
      status : 'time_exceeded' ,
      ip : '172.19.80.1' ,
      ttl : 1 ,
      rtt : { min : 0 , max : 1 , avg : 1 }
    } ,
    {
      status : 'time_exceeded' ,
      ip : '172.30.1.254' ,
      ttl : 2 ,
      rtt : { min : 0 , max : 1 , avg : 1 }
    } ,
    {
      status : 'timeout' ,
      ip : null ,
      ttl : 3 ,
      rtt : { min : 2001 , max : 2002 , avg : 2002 }
    } ,
    {
      status : 'time_exceeded' ,
      ip : '112.188.59.77' ,
      ttl : 4 ,
      rtt : { min : 2 , max : 3 , avg : 3 }
    } ,
    {
      status : 'time_exceeded' ,
      ip : '112.188.53.13' ,
      ttl : 5 ,
      rtt : { min : 1 , max : 2 , avg : 2 }
    } ,
    {
      status : 'time_exceeded' ,
      ip : '112.174.47.177' ,
      ttl : 6 ,
      rtt : { min : 7 , max : 8 , avg : 8 }
    } ,
    {
      status : 'time_exceeded' ,
      ip : '112.174.91.130' ,
      ttl : 7 ,
      rtt : { min : 7 , max : 8 , avg : 8 }
    } ,
    {
      status : 'time_exceeded' ,
      ip : '112.174.87.102' ,
      ttl : 8 ,
      rtt : { min : 129 , max : 130 , avg : 130 }
    } ,
    {
      status : 'time_exceeded' ,
      ip : '206.72.210.112' ,
      ttl : 9 ,
      rtt : { min : 127 , max : 128 , avg : 128 }
    } ,
    {
      status : 'time_exceeded' ,
      ip : '152.195.76.151' ,
      ttl : 10 ,
      rtt : { min : 132 , max : 134 , avg : 133 }
    } ,
    {
      status : 'reply' ,
      ip : '93.184.215.14' ,
      ttl : 11 ,
      rtt : { min : 126 , max : 126 , avg : 126 }
    }
  ]
}