nmrp.c

   1 /**
   2  * nmrp-flash - Netgear Unbrick Utility
   3  * Copyright (C) 2016 Joseph Lehner <joseph.c.lehner@gmail.com>
   4  *
   5  * nmrp-flash is free software: you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation, either version 3 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * nmrp-flash is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with nmrp-flash.  If not, see <http://www.gnu.org/licenses/>.
  17  *
  18  */
  19
  20 #define _BSD_SOURCE
  21 #include <netinet/ether.h>
  22 #include <linux/if_packet.h>
  23 #include <arpa/inet.h>
  24 #include <sys/socket.h>
  25 #include <sys/ioctl.h>
  26 #include <net/if.h>
  27 #include <stdlib.h>
  28 #include <string.h>
  29 #include <unistd.h>
  30 #include <errno.h>
  31 #include <stdio.h>
  32 #include <time.h>
  33 #include "nmrpd.h"
  34
  35 #define NMRP_HDR_LEN 6
  36 #define NMRP_OPT_LEN 4
  37 #define NMRP_MIN_PKT_LEN (sizeof(struct ether_header) +  NMRP_HDR_LEN)
  38
  39 #define ETH_P_NMRP 0x0912
  40 #define IP_LEN 4
  41 #define PACKED __attribute__((__packed__))
  42 #define MAX_LOOP_RECV 1024
  43
  44 enum nmrp_code {
  45         NMRP_C_NONE = 0,
  46         NMRP_C_ADVERTISE = 1,
  47         NMRP_C_CONF_REQ = 2,
  48         NMRP_C_CONF_ACK = 3,
  49         NMRP_C_CLOSE_REQ = 4,
  50         NMRP_C_CLOSE_ACK = 5,
  51         NMRP_C_KEEP_ALIVE_REQ = 6,
  52         NMRP_C_KEEP_ALIVE_ACK = 7,
  53         NMRP_C_TFTP_UL_REQ = 16
  54 };
  55
  56 enum nmrp_opt_type {
  57         NMRP_O_MAGIC_NO = 0x0001,
  58         NMRP_O_DEV_IP = 0x0002,
  59         NMRP_O_DEV_REGION = 0x0004,
  60         NMRP_O_FW_UP = 0x0101,
  61         NMRP_O_ST_UP = 0x0102,
  62         NMRP_O_FILE_NAME = 0x0181
  63 };
  64
  65 struct nmrp_opt {
  66         uint16_t type;
  67         uint16_t len;
  68         union {
  69                 uint8_t magic[4];
  70                 struct {
  71                         uint8_t addr[IP_LEN];
  72                         uint8_t mask[IP_LEN];
  73                 } ip;
  74         } val;
  75 } PACKED;
  76
  77 struct nmrp_msg {
  78         uint16_t reserved;
  79         uint8_t code;
  80         uint8_t id;
  81         uint16_t len;
  82         struct nmrp_opt opts[2];
  83         uint32_t num_opts;
  84 } PACKED;
  85
  86 struct nmrp_pkt {
  87         struct ether_header eh;
  88         struct nmrp_msg msg;
  89 } PACKED;
  90
  91 static void msg_update_len(struct nmrp_msg *msg)
  92 {
  93         uint32_t i = 0;
  94         msg->len = NMRP_HDR_LEN;
  95         for (; i != msg->num_opts; ++i) {
  96                 msg->len += msg->opts[i].len;
  97         }
  98 }
  99
 100 static void msg_dump(struct nmrp_msg *msg, int dump_opts)
 101 {
 102         struct nmrp_opt *opt;
 103         int remain_len, len, i;
 104
 105         fprintf(stderr, "res=0x%04x, code=0x%02x, id=0x%02x, len=%u",
 106                         msg->reserved, msg->code, msg->id, msg->len);
 107
 108         remain_len = msg->len - NMRP_HDR_LEN;
 109         fprintf(stderr, "%s\n", remain_len ? "" : " (no opts)");
 110
 111         if (dump_opts) {
 112                 opt = msg->opts;
 113
 114                 while (remain_len > 0) {
 115                         len = opt->len;
 116                         fprintf(stderr, "  opt type=%u, len=%u", opt->type, len);
 117                         for (i = 0; i != len - NMRP_OPT_LEN; ++i) {
 118                                 if (!(i % 16)) {
 119                                         fprintf(stderr, "\n  ");
 120                                 }
 121
 122                                 fprintf(stderr, "%02x ", ((char*)&opt->val)[i] & 0xff);
 123                         }
 124                         fprintf(stderr, "\n");
 125                         remain_len -= len;
 126                         opt = (struct nmrp_opt*)(((char*)opt) + len);
 127                 }
 128         }
 129 }
 130
 131 static void msg_hton(struct nmrp_msg *msg)
 132 {
 133         uint32_t i = 0;
 134
 135         msg->reserved = htons(msg->reserved);
 136         msg->len = htons(msg->len);
 137
 138         for (; i != msg->num_opts; ++i) {
 139                 msg->opts[i].len = htons(msg->opts[i].len);
 140                 msg->opts[i].type = htons(msg->opts[i].type);
 141         }
 142 }
 143
 144 static void msg_hdr_ntoh(struct nmrp_msg *msg)
 145 {
 146         msg->reserved = ntohs(msg->reserved);
 147         msg->len = ntohs(msg->len);
 148 }
 149
 150 static int msg_ntoh(struct nmrp_msg *msg)
 151 {
 152         struct nmrp_opt *opt = msg->opts;
 153         int remaining;
 154
 155         msg_hdr_ntoh(msg);
 156         remaining = msg->len - NMRP_HDR_LEN;
 157
 158         while (remaining > 0) {
 159                 if (remaining < NMRP_OPT_LEN) {
 160                         fprintf(stderr, "Malformed message.\n");
 161                         msg_dump(msg, 0);
 162                         return 1;
 163                 }
 164
 165                 opt->type = ntohs(opt->type);
 166                 opt->len = ntohs(opt->len);
 167
 168                 remaining -= opt->len;
 169                 ++opt;
 170         }
 171
 172         if (remaining) {
 173                 fprintf(stderr, "Trailing data in message.\n");
 174                 msg_dump(msg, 0);
 175                 return 1;
 176         }
 177
 178         return 0;
 179 }
 180
 181 static int intf_get_info(int sock, const char *name, int *index,
 182                 uint8_t *hwaddr)
 183 {
 184         struct ifreq ifr;
 185
 186         memset(&ifr, 0, sizeof(ifr));
 187         strncpy(ifr.ifr_name, name, IFNAMSIZ - 1);
 188
 189         if (ioctl(sock, SIOCGIFINDEX, &ifr) < 0) {
 190                 perror("ioctl(SIOCGIFINDEX)");
 191                 return -1;
 192         }
 193         *index = ifr.ifr_ifindex;
 194
 195         if (ioctl(sock, SIOCGIFHWADDR, &ifr) < 0) {
 196                 perror("ioctl(SIOCGIFHWADDR)");
 197                 return -1;
 198         }
 199         memcpy(hwaddr, ifr.ifr_hwaddr.sa_data, ETH_ALEN);
 200
 201         return 0;
 202 }
 203
 204 static int pkt_send(int sock, struct sockaddr_ll *addr, struct nmrp_pkt *pkt)
 205 {
 206         size_t len = ntohs(pkt->msg.len) + sizeof(pkt->eh);
 207         return sendto(sock, pkt, len, 0, (struct sockaddr*)addr, sizeof(*addr));
 208 }
 209
 210 static int pkt_recv(int sock, struct nmrp_pkt *pkt)
 211 {
 212         struct sockaddr_ll from;
 213         socklen_t addrlen;
 214         ssize_t bytes, len;
 215
 216         memset(pkt, 0, sizeof(*pkt));
 217         bytes = recvfrom(sock, pkt, NMRP_MIN_PKT_LEN, MSG_PEEK,
 218                         (struct sockaddr*)&from, &addrlen);
 219
 220         if (bytes < 0) {
 221                 if (errno == EAGAIN) {
 222                         return 2;
 223                 }
 224                 perror("recvfrom(pkt)");
 225                 return 1;
 226         } else if (ntohs(pkt->eh.ether_type) != ETH_P_NMRP) {
 227                 return 3;
 228         } else if (bytes < NMRP_MIN_PKT_LEN) {
 229                 fprintf(stderr, "Short packet (%zi bytes)\n", bytes);
 230                 return 1;
 231         }
 232
 233         msg_hdr_ntoh(&pkt->msg);
 234         len = pkt->msg.len + sizeof(pkt->eh);
 235
 236         bytes = recvfrom(sock, pkt, len, MSG_DONTWAIT, NULL, NULL);
 237         if (bytes < 0) {
 238                 perror("recvfrom(msg)");
 239                 return 1;
 240         } else if (bytes != len) {
 241                 fprintf(stderr, "Unexpected message length (%zi bytes).\n", len);
 242                 return 1;
 243         } else {
 244                 if (msg_ntoh(&pkt->msg) != 0) {
 245                         return 1;
 246                 }
 247                 return 0;
 248         }
 249
 250         return 1;
 251 }
 252
 253 static int sock_bind_to_intf(int sock, const char *name)
 254 {
 255         struct ifreq ifr;
 256
 257         strncpy(ifr.ifr_name, name, IFNAMSIZ - 1);
 258         if (setsockopt(sock, SOL_SOCKET, SO_BINDTODEVICE, &ifr, sizeof(ifr)) < 0) {
 259                 perror("setsockopt(SO_BINDTODEVICE)");
 260                 return 1;
 261         }
 262
 263         return 0;
 264 }
 265
 266 static int mac_parse(const char *str, uint8_t *hwaddr)
 267 {
 268         int i;
 269         unsigned data[6];
 270
 271         sscanf(str, "%02x:%02x:%02x:%02x:%02x:%02x%n",
 272                         data, data + 1, data + 2, data + 3, data + 4, data + 5, &i);
 273
 274         if (i == strlen(str)) {
 275                 for (i = 0; i != 6; ++i) {
 276                         if (data[i] > 255) {
 277                                 break;
 278                         }
 279
 280                         hwaddr[i] = data[i] & 0xff;
 281                 }
 282
 283                 if (i == 6) {
 284                         return 1;
 285                 }
 286         }
 287         return 0;
 288 }
 289
 290 static const char *spinner = "\\|/-";
 291
 292 int nmrp_do(struct nmrpd_args *args)
 293 {
 294         struct nmrp_pkt tx, rx;
 295         struct sockaddr_ll addr;
 296         uint8_t src[ETH_ALEN], dest[ETH_ALEN];
 297         struct in_addr ipaddr, ipmask;
 298         time_t beg;
 299         int i, sock, err, ulreqs, expect;
 300
 301         if (args->op != NMRP_UPLOAD_FW) {
 302                 fprintf(stderr, "Operation not implemented.\n");
 303                 return 1;
 304         }
 305
 306         if (!mac_parse(args->mac, dest)) {
 307                 fprintf(stderr, "Invalid MAC address '%s'.\n", args->mac);
 308                 return 1;
 309         }
 310
 311         if (!inet_aton(args->ipaddr, &ipaddr)) {
 312                 fprintf(stderr, "Invalid IP address '%s'.\n", args->ipaddr);
 313                 return 1;
 314         }
 315
 316         if (!inet_aton(args->ipmask, &ipmask)) {
 317                 fprintf(stderr, "Invalid subnet mask '%s'.\n", args->ipmask);
 318                 return 1;
 319         }
 320
 321         if (access(args->filename, R_OK) == -1) {
 322                 fprintf(stderr, "Error accessing file '%s'.\n", args->filename);
 323                 return 1;
 324         }
 325
 326         err = 1;
 327
 328         sock = socket(AF_PACKET, SOCK_RAW, htons(ETH_P_NMRP));
 329         if (sock == -1) {
 330                 perror("socket");
 331                 return 1;
 332         }
 333
 334         if (intf_get_info(sock, args->intf, &addr.sll_ifindex, src)) {
 335                 return 1;
 336         }
 337
 338         if (sock_bind_to_intf(sock, args->intf)) {
 339                 return 1;
 340         }
 341
 342         if (sock_set_rx_timeout(sock, args->rx_timeout)) {
 343                 return 1;
 344         }
 345
 346         addr.sll_family = AF_PACKET;
 347         addr.sll_protocol = htons(ETH_P_NMRP);
 348         addr.sll_halen = ETH_ALEN;
 349         memcpy(addr.sll_addr, dest, ETH_ALEN);
 350
 351         memcpy(tx.eh.ether_shost, src, ETH_ALEN);
 352         memcpy(tx.eh.ether_dhost, dest, ETH_ALEN);
 353         tx.eh.ether_type = htons(ETH_P_NMRP);
 354
 355         tx.msg.reserved = 0;
 356         tx.msg.code = NMRP_C_ADVERTISE;
 357         tx.msg.id = 0;
 358         tx.msg.num_opts = 1;
 359         tx.msg.opts[0].type = NMRP_O_MAGIC_NO;
 360         tx.msg.opts[0].len = NMRP_OPT_LEN + 4;
 361         tx.msg.opts[0].val.magic[0] = 'N';
 362         tx.msg.opts[0].val.magic[1] = 'T';
 363         tx.msg.opts[0].val.magic[2] = 'G';
 364         tx.msg.opts[0].val.magic[3] = 'R';
 365
 366         msg_update_len(&tx.msg);
 367         msg_hton(&tx.msg);
 368
 369         i = 0;
 370         beg = time(NULL);
 371
 372         while (1) {
 373                 printf("\rAdvertising NMRP server on %s ... %c", args->intf,
 374                                 spinner[i]);
 375                 fflush(stdout);
 376                 i = (i + 1) & 3;
 377
 378                 if (pkt_send(sock, &addr, &tx) < 0) {
 379                         perror("sendto");
 380                         goto out;
 381                 }
 382
 383                 err = pkt_recv(sock, &rx);
 384                 if (err == 0 && memcmp(rx.eh.ether_dhost, src, ETH_ALEN) == 0) {
 385                         break;
 386                 } else if (err == 1) {
 387                         printf("ERR\n");
 388                         goto out;
 389                 } else {
 390                         if ((time(NULL) - beg) >= 60) {
 391                                 printf("\nNo response after 60 seconds. Bailing out.\n");
 392                                 goto out;
 393                         }
 394                 }
 395         }
 396
 397         printf("\n");
 398
 399         expect = NMRP_C_CONF_REQ;
 400         ulreqs = 0;
 401
 402         do {
 403                 if (expect != NMRP_C_NONE && rx.msg.code != expect) {
 404                         fprintf(stderr, "Received code 0x%02x while waiting for 0x%02x!\n",
 405                                         rx.msg.code, expect);
 406                 }
 407
 408                 tx.msg.code = NMRP_C_NONE;
 409                 tx.msg.reserved = 0;
 410                 tx.msg.id = 0;
 411                 tx.msg.num_opts = 0;
 412                 tx.msg.len = 0;
 413
 414                 err = 1;
 415
 416                 switch (rx.msg.code) {
 417                         case NMRP_C_ADVERTISE:
 418                                 printf("Received NMRP advertisement from "
 419                                                 "%02x:%02x:%02x:%02x:%02x:%02x.\n",
 420                                                 rx.eh.ether_shost[0], rx.eh.ether_shost[1],
 421                                                 rx.eh.ether_shost[2], rx.eh.ether_shost[3],
 422                                                 rx.eh.ether_shost[4], rx.eh.ether_shost[5]);
 423                                 err = 1;
 424                                 goto out;
 425                         case NMRP_C_CONF_REQ:
 426                                 tx.msg.code = NMRP_C_CONF_ACK;
 427                                 tx.msg.num_opts = 2;
 428
 429                                 tx.msg.opts[0].type = NMRP_O_DEV_IP;
 430                                 tx.msg.opts[0].len = NMRP_OPT_LEN + 2 * IP_LEN;
 431
 432                                 memcpy(tx.msg.opts[0].val.ip.addr, &ipaddr, IP_LEN);
 433                                 memcpy(tx.msg.opts[0].val.ip.mask, &ipmask, IP_LEN);
 434
 435                                 tx.msg.opts[1].type = NMRP_O_FW_UP;
 436                                 tx.msg.opts[1].len = NMRP_OPT_LEN;
 437
 438                                 expect = NMRP_C_TFTP_UL_REQ;
 439
 440                                 printf("Received configuration request from "
 441                                                 "%02x:%02x:%02x:%02x:%02x:%02x.\n",
 442                                                 rx.eh.ether_shost[0], rx.eh.ether_shost[1],
 443                                                 rx.eh.ether_shost[2], rx.eh.ether_shost[3],
 444                                                 rx.eh.ether_shost[4], rx.eh.ether_shost[5]);
 445
 446                                 memcpy(tx.eh.ether_dhost, rx.eh.ether_shost, ETH_ALEN);
 447                                 memcpy(addr.sll_addr, rx.eh.ether_shost, ETH_ALEN);
 448
 449                                 printf("Sending configuration: ip %s, mask %s.\n",
 450                                                 args->ipaddr, args->ipmask);
 451
 452                                 break;
 453                         case NMRP_C_TFTP_UL_REQ:
 454                                 if (++ulreqs > 5) {
 455                                         fprintf(stderr, "Device re-requested file upload %d "
 456                                                         "times; aborting.\n", ulreqs);
 457                                         tx.msg.code = NMRP_C_CLOSE_REQ;
 458                                         break;
 459                                 }
 460
 461                                 if (!args->tftpcmd) {
 462                                         printf("Uploading %s ... ", args->filename);
 463                                         fflush(stdout);
 464                                         err = tftp_put(args);
 465                                 } else {
 466                                         printf("Running %s ... ", args->tftpcmd);
 467                                         fflush(stdout);
 468                                         err = system(args->tftpcmd);
 469                                 }
 470
 471                                 if (!err) {
 472                                         printf("OK\nWaiting for remote to respond.\n");
 473                                         sock_set_rx_timeout(sock, args->ul_timeout);
 474                                         expect = NMRP_C_CLOSE_REQ;
 475                                 } else {
 476                                         printf("\n");
 477                                         goto out;
 478                                 }
 479
 480                                 break;
 481                         case NMRP_C_KEEP_ALIVE_REQ:
 482                                 tx.msg.code = NMRP_C_KEEP_ALIVE_ACK;
 483                                 break;
 484                         case NMRP_C_CLOSE_REQ:
 485                                 tx.msg.code = NMRP_C_CLOSE_ACK;
 486                                 break;
 487                         case NMRP_C_CLOSE_ACK:
 488                                 err = 0;
 489                                 goto out;
 490                         default:
 491                                 fprintf(stderr, "Unknown message code 0x%02x!\n",
 492                                                 rx.msg.code);
 493                                 msg_dump(&rx.msg, 0);
 494                 }
 495
 496                 if (tx.msg.code != NMRP_C_NONE) {
 497                         msg_update_len(&tx.msg);
 498                         msg_hton(&tx.msg);
 499
 500                         if (pkt_send(sock, &addr, &tx) < 0) {
 501                                 perror("sendto");
 502                                 goto out;
 503                         }
 504                 }
 505
 506                 if (rx.msg.code == NMRP_C_CLOSE_REQ) {
 507                         printf("Remote finished. Closing connection.\n");
 508                         break;
 509                 }
 510
 511                 err = pkt_recv(sock, &rx);
 512                 if (err) {
 513                         if (err == 2) {
 514                                 fprintf(stderr, "Timeout while waiting for 0x%02x.\n", expect);
 515                         }
 516                         goto out;
 517                 }
 518
 519                 sock_set_rx_timeout(sock, args->rx_timeout);
 520
 521         } while (1);
 522
 523         err = 0;
 524
 525 out:
 526         close(sock);
 527
 528         return err;
 529 }