Взаимодействие с прошивкой

28 Jun 2017

Есть несколько способов взаимодействия с ядром NDMS, сводящихся к эмуляции интерактивного CLI-сеанса. Вариант telnet-сессии со скриптами expect/empty отложу как совсем костыльный и опишу два других, имеющих свои достоинства и недостатки.

RESTful control interface

Для использования не требуется ничего, кроме клиента, способного на http-запросы. Ответы ядро присылает в формате JSON:

# wget -qO - http://127.0.0.1:79/rci/show/cloud
{
  "agent": {
    "service": {
      "state": "ACTIVE",
      "token_alias": "c0c004b7bcf6ed7bd12382a0381fc0c00",
      "since": 0,
      "loop_delay": 0,
      "loop_interval": 17,
      "loop_limit": 9,
      "loop_sleep": 30,
      "tcp_connect_timeout": 15,
      "serial_in": 0,
      "serial_out": 890,
      "direct_access": false,
      "target_host": "188.227.18.199",
      "target_port": "9",
      "target_list": "46.105.148.92, 91.218.112.172, 88.198.177.103, 188.227.18.199",
      "transport": "udp"
    }
  }
}

Следственно, для его разбора можно воспользоваться утилитой jq, имеющейся и в Entware и в Debian:

# wget -qO - http://127.0.0.1:79/rci/show/cloud | \
jq '.agent.service.target_host'
"188.227.18.199"

rci-интерфейс на порту TCP79 отвечает только для localhost’а. По адресу http://my.keenetic.net/rci интерфейс отвечает на запросы с любого адреса, но требует digest-авторизацию. Именно его использует веб-интерфейс прошивки для взаимодействия с ядром.

Утилита ndmq

Утилита зависит от libndmq, которую в случае с Debian предварительно надо собрать и установить и лишь затем собрать саму утилиту:

# cd ~
# git clone https://github.com/ndmsystems/ndmq.git
# cd ndmq
# make 
# strip ndmq
# cp ndmq /usr/local/bin
# chown root:root /usr/local/bin/ndmq

Ключи вызова можно посмотреть здесь, ответ утилита возвращает в XML-формате:

# ndmq -p 'show interface' -x 
<response>
    <interface name="GigabitEthernet0">
        <id>GigabitEthernet0</id>
        <index>0</index>
        <type>GigabitEthernet</type>
        <description/>
        <interface-name>GigabitEthernet0</interface-name>
        <link>down</link>
        <connected>no</connected>
        <state>up</state>
        <mtu>1500</mtu>
        <tx-queue>1000</tx-queue>
        <port name="1">
            <id>GigabitEthernet0/0</id>
            <index>0</index>
            <interface-name>1</interface-name>
            <type>Port</type>
            <link>down</link>
            <last-change>16151.087824</last-change>
            <last-overflow>0</last-overflow>
            <public>no</public>
        </port>
        <port name="2">
            <id>GigabitEthernet0/1</id>
            <index>1</index>
            <interface-name>2</interface-name>
            <type>Port</type>
            <link>down</link>
            <last-change>16151.086143</last-change>
            <last-overflow>0</last-overflow>
            <public>no</public>
...

Анализировать это в bash’e лучше не браться, в Debian и Entware для этого есть подходящая утилита xmlstarlet. В примере ниже отфильтрованы сетевые интерфейсы со свойствами connected=yes, state=up, link=up, вывод собран в виде таблички:

# ndmq -p 'show interface' -x | xmlstarlet sel -t \
-m '//interface[link="up"][state="up"][connected="yes"]' \
-v '@name' -o ': ' -v 'address' -o '/' -v 'mask' -n

WifiMaster0/WifiStation0: 192.168.6.4/255.255.255.0
Home: 192.168.11.1/255.255.255.0
Guest: 10.1.30.1/255.255.255.0

Для разбора XML-портянок придётся познакомиться с XPath.

Обратите внимание: ndmq в chroot-среде работает не через UNIX-socket, а через deprecated TCP-порт, который в будущем может исчезнуть.

И ndmq, и rci-интерфейс могут не только возвращать информацию от прошивки, но и выполнять любые другие команды, предусмотренные CLI.

Удачи в начинаниях.

Related Posts