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 #include <signal.h>
  21 #include <stdlib.h>
  22 #include <string.h>
  23 #include <unistd.h>
  24 #include <errno.h>
  25 #include <stdio.h>
  26 #include <time.h>
  27 #include "nmrpd.h"
  28
  29 #define NMRP_HDR_LEN 6
  30 #define NMRP_OPT_LEN 4
  31 #define NMRP_MIN_PKT_LEN (sizeof(struct eth_hdr) +  NMRP_HDR_LEN)
  32
  33 #define NMRP_MAX_OPT_SIZE 12
  34 #define NMRP_MAX_OPT_NUM 2
  35
  36 #define ETH_P_NMRP 0x0912
  37 #define IP_LEN 4
  38 #define MAX_LOOP_RECV 1024
  39
  40 #ifndef PACKED
  41 #define PACKED __attribute__((__packed__))
  42 #endif
  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[4];
  72                         uint8_t mask[4];
  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 eth_hdr {
  87         uint8_t ether_dhost[6];
  88         uint8_t ether_shost[6];
  89         uint16_t ether_type;
  90 } PACKED;
  91
  92 struct nmrp_pkt {
  93         struct eth_hdr eh;
  94         struct nmrp_msg msg;
  95 } PACKED;
  96
  97 static void msg_update_len(struct nmrp_msg *msg)
  98 {
  99         uint32_t i = 0;
 100         msg->len = NMRP_HDR_LEN;
 101         for (; i != msg->num_opts; ++i) {
 102                 msg->len += msg->opts[i].len;
 103         }
 104 }
 105
 106 static void msg_dump(struct nmrp_msg *msg, int dump_opts)
 107 {
 108         struct nmrp_opt *opt;
 109         int remain_len, len, i;
 110
 111         fprintf(stderr, "res=0x%04x, code=0x%02x, id=0x%02x, len=%u",
 112                         msg->reserved, msg->code, msg->id, msg->len);
 113
 114         remain_len = msg->len - NMRP_HDR_LEN;
 115         fprintf(stderr, "%s\n", remain_len ? "" : " (no opts)");
 116
 117         if (dump_opts) {
 118                 opt = msg->opts;
 119
 120                 while (remain_len > 0) {
 121                         len = opt->len;
 122                         fprintf(stderr, "  opt type=%u, len=%u", opt->type, len);
 123                         for (i = 0; i != len - NMRP_OPT_LEN; ++i) {
 124                                 if (!(i % 16)) {
 125                                         fprintf(stderr, "\n  ");
 126                                 }
 127
 128                                 fprintf(stderr, "%02x ", ((char*)&opt->val)[i] & 0xff);
 129                         }
 130                         fprintf(stderr, "\n");
 131                         remain_len -= len;
 132                         opt = (struct nmrp_opt*)(((char*)opt) + len);
 133                 }
 134         }
 135 }
 136
 137 static void msg_hton(struct nmrp_msg *msg)
 138 {
 139         uint32_t i = 0;
 140
 141         msg->reserved = htons(msg->reserved);
 142         msg->len = htons(msg->len);
 143
 144         for (; i != msg->num_opts; ++i) {
 145                 msg->opts[i].len = htons(msg->opts[i].len);
 146                 msg->opts[i].type = htons(msg->opts[i].type);
 147         }
 148 }
 149
 150 static void msg_hdr_ntoh(struct nmrp_msg *msg)
 151 {
 152         msg->reserved = ntohs(msg->reserved);
 153         msg->len = ntohs(msg->len);
 154 }
 155
 156 static int msg_ntoh(struct nmrp_msg *msg)
 157 {
 158         struct nmrp_opt *opt = msg->opts;
 159         int remaining;
 160
 161         remaining = msg->len - NMRP_HDR_LEN;
 162
 163         // FIXME maximum of two options supported, maximum option
 164         // size is 12
 165         if (remaining < NMRP_MAX_OPT_NUM * NMRP_MAX_OPT_SIZE) {
 166                 while (remaining > 0) {
 167                         if (remaining < NMRP_OPT_LEN) {
 168                                 break;
 169                         }
 170
 171                         opt->type = ntohs(opt->type);
 172                         opt->len = ntohs(opt->len);
 173
 174                         if (opt->len > NMRP_MAX_OPT_SIZE) {
 175                                 break;
 176                         }
 177
 178                         remaining -= opt->len;
 179                         ++opt;
 180                 }
 181
 182                 if (!remaining) {
 183                         return 0;
 184                 }
 185         }
 186
 187         fprintf(stderr, "Unexpected message format.\n");
 188         msg_dump(msg, 0);
 189         return 1;
 190 }
 191
 192 static int pkt_send(struct ethsock *sock, struct nmrp_pkt *pkt)
 193 {
 194         size_t len = ntohs(pkt->msg.len) + sizeof(pkt->eh);
 195         return ethsock_send(sock, pkt, len);
 196 }
 197
 198 static int pkt_recv(struct ethsock *sock, struct nmrp_pkt *pkt)
 199 {
 200         ssize_t bytes, len;
 201
 202         memset(pkt, 0, sizeof(*pkt));
 203         bytes = ethsock_recv(sock, pkt, sizeof(*pkt));
 204         if (bytes < 0) {
 205                 return 1;
 206         } else if (!bytes) {
 207                 return 2;
 208         } else if (bytes < NMRP_MIN_PKT_LEN) {
 209                 fprintf(stderr, "Short packet (%d bytes)\n", (int)bytes);
 210                 return 1;
 211         }
 212
 213         msg_hdr_ntoh(&pkt->msg);
 214         len = pkt->msg.len + sizeof(pkt->eh);
 215
 216         if (bytes != len) {
 217                 fprintf(stderr, "Unexpected message length (%d bytes).\n", (int)len);
 218                 return 1;
 219         }
 220
 221         return msg_ntoh(&pkt->msg);
 222 }
 223
 224 static int mac_parse(const char *str, uint8_t *hwaddr)
 225 {
 226         int i;
 227         unsigned data[6];
 228
 229         sscanf(str, "%02x:%02x:%02x:%02x:%02x:%02x%n",
 230                         data, data + 1, data + 2, data + 3, data + 4, data + 5, &i);
 231
 232         if (i == strlen(str)) {
 233                 for (i = 0; i != 6; ++i) {
 234                         if (data[i] > 255) {
 235                                 break;
 236                         }
 237
 238                         hwaddr[i] = data[i] & 0xff;
 239                 }
 240
 241                 if (i == 6) {
 242                         return 1;
 243                 }
 244         }
 245         return 0;
 246 }
 247
 248 static struct ethsock *gsock = NULL;
 249
 250 static void sigh(int sig)
 251 {
 252         printf("\n");
 253         if (gsock) {
 254                 ethsock_close(gsock);
 255         }
 256
 257         exit(1);
 258 }
 259
 260 static const char *spinner = "\\|/-";
 261
 262 int nmrp_do(struct nmrpd_args *args)
 263 {
 264         struct nmrp_pkt tx, rx;
 265         uint8_t *src, dest[6];
 266         struct in_addr ipaddr, ipmask;
 267         time_t beg;
 268         int i, err, ulreqs, expect;
 269         struct ethsock *sock;
 270         void (*sigh_orig)(int);
 271
 272         if (args->op != NMRP_UPLOAD_FW) {
 273                 fprintf(stderr, "Operation not implemented.\n");
 274                 return 1;
 275         }
 276
 277         if (!mac_parse(args->mac, dest)) {
 278                 fprintf(stderr, "Invalid MAC address '%s'.\n", args->mac);
 279                 return 1;
 280         }
 281
 282         if ((ipaddr.s_addr = inet_addr(args->ipaddr)) == INADDR_NONE) {
 283                 fprintf(stderr, "Invalid IP address '%s'.\n", args->ipaddr);
 284                 return 1;
 285         }
 286
 287         if ((ipmask.s_addr = inet_addr(args->ipmask)) == INADDR_NONE) {
 288                 fprintf(stderr, "Invalid subnet mask '%s'.\n", args->ipmask);
 289                 return 1;
 290         }
 291
 292         if (access(args->filename, R_OK) == -1) {
 293                 fprintf(stderr, "Error accessing file '%s'.\n", args->filename);
 294                 return 1;
 295         }
 296
 297         err = 1;
 298
 299         sock = ethsock_create(args->intf, ETH_P_NMRP);
 300         if (!sock) {
 301                 return 1;
 302         }
 303
 304         gsock = sock;
 305         sigh_orig = signal(SIGINT, sigh);
 306
 307         if (ethsock_set_timeout(sock, args->rx_timeout)) {
 308                 goto out;
 309         }
 310
 311         src = ethsock_get_hwaddr(sock);
 312         if (!src) {
 313                 goto out;
 314         }
 315
 316         memcpy(tx.eh.ether_shost, src, 6);
 317         memcpy(tx.eh.ether_dhost, dest, 6);
 318         tx.eh.ether_type = htons(ETH_P_NMRP);
 319
 320         tx.msg.reserved = 0;
 321         tx.msg.code = NMRP_C_ADVERTISE;
 322         tx.msg.id = 0;
 323         tx.msg.num_opts = 1;
 324         tx.msg.opts[0].type = NMRP_O_MAGIC_NO;
 325         tx.msg.opts[0].len = NMRP_OPT_LEN + 4;
 326         tx.msg.opts[0].val.magic[0] = 'N';
 327         tx.msg.opts[0].val.magic[1] = 'T';
 328         tx.msg.opts[0].val.magic[2] = 'G';
 329         tx.msg.opts[0].val.magic[3] = 'R';
 330
 331         msg_update_len(&tx.msg);
 332         msg_hton(&tx.msg);
 333
 334         i = 0;
 335         beg = time(NULL);
 336
 337         while (1) {
 338                 printf("\rAdvertising NMRP server on interface ... %c",
 339                                 spinner[i]);
 340                 fflush(stdout);
 341                 i = (i + 1) & 3;
 342
 343                 if (pkt_send(sock, &tx) < 0) {
 344                         perror("sendto");
 345                         goto out;
 346                 }
 347
 348                 err = pkt_recv(sock, &rx);
 349                 if (err == 0 && memcmp(rx.eh.ether_dhost, src, 6) == 0) {
 350                         break;
 351                 } else if (err == 1) {
 352                         printf("ERR\n");
 353                         goto out;
 354                 } else {
 355                         if ((time(NULL) - beg) >= 60) {
 356                                 printf("\nNo response after 60 seconds. Bailing out.\n");
 357                                 goto out;
 358                         }
 359                 }
 360         }
 361
 362         printf("\n");
 363
 364         expect = NMRP_C_CONF_REQ;
 365         ulreqs = 0;
 366
 367         do {
 368                 if (expect != NMRP_C_NONE && rx.msg.code != expect) {
 369                         fprintf(stderr, "Received code 0x%02x while waiting for 0x%02x!\n",
 370                                         rx.msg.code, expect);
 371                 }
 372
 373                 tx.msg.code = NMRP_C_NONE;
 374                 tx.msg.reserved = 0;
 375                 tx.msg.id = 0;
 376                 tx.msg.num_opts = 0;
 377                 tx.msg.len = 0;
 378
 379                 err = 1;
 380
 381                 switch (rx.msg.code) {
 382                         case NMRP_C_ADVERTISE:
 383                                 printf("Received NMRP advertisement from "
 384                                                 "%02x:%02x:%02x:%02x:%02x:%02x.\n",
 385                                                 rx.eh.ether_shost[0], rx.eh.ether_shost[1],
 386                                                 rx.eh.ether_shost[2], rx.eh.ether_shost[3],
 387                                                 rx.eh.ether_shost[4], rx.eh.ether_shost[5]);
 388                                 err = 1;
 389                                 goto out;
 390                         case NMRP_C_CONF_REQ:
 391                                 tx.msg.code = NMRP_C_CONF_ACK;
 392                                 tx.msg.num_opts = 2;
 393
 394                                 tx.msg.opts[0].type = NMRP_O_DEV_IP;
 395                                 tx.msg.opts[0].len = NMRP_OPT_LEN + 2 * 4;
 396
 397                                 memcpy(tx.msg.opts[0].val.ip.addr, &ipaddr, 4);
 398                                 memcpy(tx.msg.opts[0].val.ip.mask, &ipmask, 4);
 399
 400                                 tx.msg.opts[1].type = NMRP_O_FW_UP;
 401                                 tx.msg.opts[1].len = NMRP_OPT_LEN;
 402
 403                                 expect = NMRP_C_TFTP_UL_REQ;
 404
 405                                 printf("Received configuration request from "
 406                                                 "%02x:%02x:%02x:%02x:%02x:%02x.\n",
 407                                                 rx.eh.ether_shost[0], rx.eh.ether_shost[1],
 408                                                 rx.eh.ether_shost[2], rx.eh.ether_shost[3],
 409                                                 rx.eh.ether_shost[4], rx.eh.ether_shost[5]);
 410
 411                                 memcpy(tx.eh.ether_dhost, rx.eh.ether_shost, 6);
 412
 413                                 printf("Sending configuration: ip %s, mask %s.\n",
 414                                                 args->ipaddr, args->ipmask);
 415
 416                                 break;
 417                         case NMRP_C_TFTP_UL_REQ:
 418                                 if (++ulreqs > 5) {
 419                                         fprintf(stderr, "Device re-requested file upload %d "
 420                                                         "times; aborting.\n", ulreqs);
 421                                         tx.msg.code = NMRP_C_CLOSE_REQ;
 422                                         break;
 423                                 }
 424
 425                                 if (!args->tftpcmd) {
 426                                         printf("Uploading %s ... ", args->filename);
 427                                         fflush(stdout);
 428                                         err = tftp_put(args);
 429                                 } else {
 430                                         printf("Running %s ... ", args->tftpcmd);
 431                                         fflush(stdout);
 432                                         err = system(args->tftpcmd);
 433                                 }
 434
 435                                 if (!err) {
 436                                         printf("OK\nWaiting for remote to respond.\n");
 437                                         ethsock_set_timeout(sock, args->ul_timeout);
 438                                         expect = NMRP_C_CLOSE_REQ;
 439                                 } else {
 440                                         printf("\n");
 441                                         goto out;
 442                                 }
 443
 444                                 break;
 445                         case NMRP_C_KEEP_ALIVE_REQ:
 446                                 tx.msg.code = NMRP_C_KEEP_ALIVE_ACK;
 447                                 break;
 448                         case NMRP_C_CLOSE_REQ:
 449                                 tx.msg.code = NMRP_C_CLOSE_ACK;
 450                                 break;
 451                         case NMRP_C_CLOSE_ACK:
 452                                 err = 0;
 453                                 goto out;
 454                         default:
 455                                 fprintf(stderr, "Unknown message code 0x%02x!\n",
 456                                                 rx.msg.code);
 457                                 msg_dump(&rx.msg, 0);
 458                 }
 459
 460                 if (tx.msg.code != NMRP_C_NONE) {
 461                         msg_update_len(&tx.msg);
 462                         msg_hton(&tx.msg);
 463
 464                         if (pkt_send(sock, &tx) < 0) {
 465                                 perror("sendto");
 466                                 goto out;
 467                         }
 468                 }
 469
 470                 if (rx.msg.code == NMRP_C_CLOSE_REQ) {
 471                         printf("Remote finished. Closing connection.\n");
 472                         break;
 473                 }
 474
 475                 err = pkt_recv(sock, &rx);
 476                 if (err) {
 477                         if (err == 2) {
 478                                 fprintf(stderr, "Timeout while waiting for 0x%02x.\n", expect);
 479                         }
 480                         goto out;
 481                 }
 482
 483                 ethsock_set_timeout(sock, args->rx_timeout);
 484
 485         } while (1);
 486
 487         err = 0;
 488
 489 out:
 490         signal(SIGINT, sigh_orig);
 491         gsock = NULL;
 492         ethsock_close(sock);
 493         return err;
 494 }