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