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