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