Update README.md
[oweals/nmrpflash.git] / nmrp.c
1 /**
2  * nmrpflash - Netgear Unbrick Utility
3  * Copyright (C) 2016 Joseph Lehner <joseph.c.lehner@gmail.com>
4  *
5  * nmrpflash 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  * nmrpflash 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 nmrpflash.  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_HDR_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 3
35
36 #define NMRP_OPT_NEXT(x) ((struct nmrp_opt*)(((char*)x) + x->len))
37
38 #define ETH_P_NMRP 0x0912
39 #define IP_LEN 4
40 #define MAX_LOOP_RECV 1024
41
42 #ifndef PACKED
43 #define PACKED __attribute__((__packed__))
44 #endif
45
46 enum nmrp_code {
47         NMRP_C_NONE = 0,
48         NMRP_C_ADVERTISE = 1,
49         NMRP_C_CONF_REQ = 2,
50         NMRP_C_CONF_ACK = 3,
51         NMRP_C_CLOSE_REQ = 4,
52         NMRP_C_CLOSE_ACK = 5,
53         NMRP_C_KEEP_ALIVE_REQ = 6,
54         NMRP_C_KEEP_ALIVE_ACK = 7,
55         NMRP_C_TFTP_UL_REQ = 16
56 };
57
58 enum nmrp_opt_type {
59         NMRP_O_MAGIC_NO = 0x0001,
60         NMRP_O_DEV_IP = 0x0002,
61         NMRP_O_DEV_REGION = 0x0004,
62         NMRP_O_FW_UP = 0x0101,
63         NMRP_O_ST_UP = 0x0102,
64         NMRP_O_FILE_NAME = 0x0181
65 };
66
67 struct nmrp_opt {
68         uint16_t type;
69         uint16_t len;
70         union {
71                 uint8_t magic[4];
72                 uint16_t region;
73                 struct {
74                         uint8_t addr[4];
75                         uint8_t mask[4];
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         /* only opts[0] is valid! think of this as a char* */
86         struct nmrp_opt opts[NMRP_MAX_OPT_NUM];
87         /* this is NOT part of the transmitted packet */
88         uint32_t num_opts;
89 } PACKED;
90
91 struct eth_hdr {
92         uint8_t ether_dhost[6];
93         uint8_t ether_shost[6];
94         uint16_t ether_type;
95 } PACKED;
96
97 struct nmrp_pkt {
98         struct eth_hdr eh;
99         struct nmrp_msg msg;
100 } PACKED;
101
102 static const char *msg_code_str(uint16_t code)
103 {
104 #define CASE_CODE(x) case NMRP_C_ ## x: return #x
105         static char buf[16];
106
107         switch (code) {
108                 CASE_CODE(ADVERTISE);
109                 CASE_CODE(CONF_REQ);
110                 CASE_CODE(CONF_ACK);
111                 CASE_CODE(CLOSE_REQ);
112                 CASE_CODE(CLOSE_ACK);
113                 CASE_CODE(KEEP_ALIVE_REQ);
114                 CASE_CODE(KEEP_ALIVE_ACK);
115                 CASE_CODE(TFTP_UL_REQ);
116                 default:
117                         snprintf(buf, sizeof(buf), "%04x", code);
118                         return buf;
119         }
120 #undef CASE_CODE
121 }
122
123 static uint16_t to_region_code(const char *region)
124 {
125 #define REGION_CODE(r, c) if (!strcasecmp(region, r)) return c
126         REGION_CODE("NA", 0x0001);
127         REGION_CODE("WW", 0x0002);
128         REGION_CODE("GR", 0x0003);
129         REGION_CODE("PR", 0x0004);
130         REGION_CODE("RU", 0x0005);
131         REGION_CODE("BZ", 0x0006);
132         REGION_CODE("IN", 0x0007);
133         REGION_CODE("KO", 0x0008);
134         REGION_CODE("JP", 0x0009);
135 #undef REGION_CODE
136         return 0;
137 }
138
139 static void msg_dump(struct nmrp_msg *msg, int dump_opts)
140 {
141         struct nmrp_opt *opt;
142         int remain_len, len, i;
143
144         fprintf(stderr, "res=0x%04x, code=0x%02x, id=0x%02x, len=%u",
145                         msg->reserved, msg->code, msg->id, msg->len);
146
147         remain_len = msg->len - NMRP_HDR_LEN;
148         fprintf(stderr, "%s\n", remain_len ? "" : " (no opts)");
149
150         if (dump_opts) {
151                 opt = msg->opts;
152
153                 while (remain_len > 0) {
154                         len = opt->len;
155                         fprintf(stderr, "  opt type=%u, len=%u", opt->type, len);
156                         if (len) {
157                                 for (i = 0; i != len - NMRP_OPT_HDR_LEN; ++i) {
158                                         if (!(i % 16)) {
159                                                 fprintf(stderr, "\n  ");
160                                         }
161
162                                         fprintf(stderr, "%02x ", ((char*)&opt->val)[i] & 0xff);
163                                 }
164                                 fprintf(stderr, "\n");
165                         }
166                         remain_len -= len;
167                         opt = NMRP_OPT_NEXT(opt);
168                 }
169         }
170 }
171
172 static void msg_hton(struct nmrp_msg *msg)
173 {
174         uint32_t i = 0;
175         struct nmrp_opt *opt = msg->opts, *next;
176
177         msg->reserved = htons(msg->reserved);
178         msg->len = htons(msg->len);
179
180         for (; i != msg->num_opts; ++i) {
181                 next = NMRP_OPT_NEXT(opt);
182                 opt->len = htons(opt->len);
183                 opt->type = htons(opt->type);
184                 opt = next;
185         }
186 }
187
188 static void msg_hdr_ntoh(struct nmrp_msg *msg)
189 {
190         msg->reserved = ntohs(msg->reserved);
191         msg->len = ntohs(msg->len);
192 }
193
194 static int msg_ntoh(struct nmrp_msg *msg)
195 {
196         struct nmrp_opt *opt = msg->opts;
197         int remaining;
198
199         remaining = msg->len - NMRP_HDR_LEN;
200
201         // FIXME maximum of two options supported, maximum option
202         // size is 12
203         if (remaining < NMRP_MAX_OPT_NUM * NMRP_MAX_OPT_SIZE) {
204                 while (remaining > 0) {
205                         if (remaining < NMRP_OPT_HDR_LEN) {
206                                 break;
207                         }
208
209                         opt->type = ntohs(opt->type);
210                         opt->len = ntohs(opt->len);
211
212                         if (opt->len > NMRP_MAX_OPT_SIZE) {
213                                 break;
214                         }
215
216                         remaining -= opt->len;
217                         opt = NMRP_OPT_NEXT(opt);
218                 }
219
220                 if (!remaining) {
221                         return 0;
222                 }
223         }
224
225         fprintf(stderr, "Unexpected message format.\n");
226         msg_dump(msg, 0);
227         return 1;
228 }
229
230 static void *msg_opt_data(struct nmrp_msg *msg, uint16_t type, uint16_t *len)
231 {
232         static char buf[128];
233         struct nmrp_opt *opt = msg->opts;
234         int remaining = msg->len - NMRP_HDR_LEN;
235
236         memset(buf, 0, sizeof(buf));
237
238         while (remaining > 0) {
239                 if (opt->type == type) {
240                         if (opt->len == NMRP_OPT_HDR_LEN) {
241                                 return NULL;
242                         }
243                         *len = opt->len - NMRP_OPT_HDR_LEN;
244                         memcpy(buf, &opt->val, MIN(*len, sizeof(buf)-1));
245                         return buf;
246                 }
247
248                 remaining -= opt->len;
249                 opt = NMRP_OPT_NEXT(opt);
250         }
251
252         return NULL;
253 }
254
255 static void msg_opt_add(struct nmrp_msg *msg, uint16_t type, void *data,
256                 uint16_t len)
257 {
258         uint32_t i = 0;
259         struct nmrp_opt *opt = msg->opts;
260
261         if (len + NMRP_OPT_HDR_LEN > NMRP_MAX_OPT_SIZE
262                         || msg->num_opts == NMRP_MAX_OPT_NUM) {
263                 fprintf(stderr, "Invalid option - this is a bug.\n");
264         }
265
266         for (; i <= msg->num_opts; ++i) {
267                 opt = NMRP_OPT_NEXT(opt);
268         }
269
270         opt->len = NMRP_OPT_HDR_LEN + len;
271         opt->type = type;
272
273         if (len) {
274                 memcpy(&opt->val, data, len);
275         }
276
277         msg->len += opt->len;
278         ++msg->num_opts;
279 }
280
281 static inline void msg_init(struct nmrp_msg *msg, uint16_t code)
282 {
283         memset(msg, 0, sizeof(*msg));
284         msg->len = NMRP_HDR_LEN;
285         msg->code = code;
286 }
287
288 static int pkt_send(struct ethsock *sock, struct nmrp_pkt *pkt)
289 {
290         size_t len = ntohs(pkt->msg.len) + sizeof(pkt->eh);
291         return ethsock_send(sock, pkt, len);
292 }
293
294 static int pkt_recv(struct ethsock *sock, struct nmrp_pkt *pkt)
295 {
296         ssize_t bytes, len;
297
298         memset(pkt, 0, sizeof(*pkt));
299         bytes = ethsock_recv(sock, pkt, sizeof(*pkt));
300         if (bytes < 0) {
301                 return 1;
302         } else if (!bytes) {
303                 return 2;
304         } else if (bytes < NMRP_MIN_PKT_LEN) {
305                 fprintf(stderr, "Short packet (%d bytes)\n", (int)bytes);
306                 return 1;
307         }
308
309         msg_hdr_ntoh(&pkt->msg);
310         len = pkt->msg.len + sizeof(pkt->eh);
311
312         if (bytes < len) {
313                 fprintf(stderr, "Short packet (expected %d, got %d).\n",
314                                 (int)len, (int)bytes);
315                 return 1;
316         }
317
318         return msg_ntoh(&pkt->msg);
319 }
320
321 static int mac_parse(const char *str, uint8_t *hwaddr)
322 {
323         int i;
324         unsigned data[6];
325
326         sscanf(str, "%02x:%02x:%02x:%02x:%02x:%02x%n",
327                         data, data + 1, data + 2, data + 3, data + 4, data + 5, &i);
328
329         if (i == strlen(str)) {
330                 for (i = 0; i != 6; ++i) {
331                         if (data[i] > 255) {
332                                 break;
333                         }
334
335                         hwaddr[i] = data[i] & 0xff;
336                 }
337
338                 if (i == 6) {
339                         return 1;
340                 }
341         }
342         return 0;
343 }
344
345 struct is_valid_ip_arg
346 {
347         struct in_addr *ipaddr;
348         struct in_addr *ipmask;
349         int result;
350 };
351
352 static int is_valid_ip_cb(struct ethsock_ip_callback_args *args)
353 {
354 #define SUBNET(x) ((x)->ipaddr->s_addr & (x)->ipmask->s_addr)
355         struct is_valid_ip_arg *arg = args->arg;
356         if (SUBNET(args) == SUBNET(arg)) {
357                 arg->result = args->ipaddr->s_addr != arg->ipaddr->s_addr;
358                 return 0;
359         }
360
361         return 1;
362 #undef SUBNET
363 }
364
365 static int is_valid_ip(struct ethsock *sock, struct in_addr *ipaddr,
366                 struct in_addr *ipmask)
367 {
368         int status;
369         struct is_valid_ip_arg arg = {
370                 .ipaddr = ipaddr,
371                 .ipmask = ipmask,
372                 .result = 0
373         };
374
375         status = ethsock_for_each_ip(sock, is_valid_ip_cb, &arg);
376         return status < 0 ? status : arg.result;
377 }
378
379 static struct ethsock *gsock = NULL;
380
381 static void sigh(int sig)
382 {
383         printf("\n");
384         if (gsock) {
385                 ethsock_close(gsock);
386         }
387
388         exit(1);
389 }
390
391 static const char *spinner = "\\|/-";
392
393 int nmrp_do(struct nmrpd_args *args)
394 {
395         struct nmrp_pkt tx, rx;
396         uint8_t *src, dest[6];
397         uint16_t len, region;
398         char *filename;
399         time_t beg;
400         int i, status, ulreqs, expect, upload_ok;
401         struct ethsock *sock;
402         void (*sigh_orig)(int);
403         struct {
404                 struct in_addr addr;
405                 struct in_addr mask;
406         } PACKED ipconf;
407
408         if (args->op != NMRP_UPLOAD_FW) {
409                 fprintf(stderr, "Operation not implemented.\n");
410                 return 1;
411         }
412
413         if (!mac_parse(args->mac, dest)) {
414                 fprintf(stderr, "Invalid MAC address '%s'.\n", args->mac);
415                 return 1;
416         }
417
418         if ((ipconf.addr.s_addr = inet_addr(args->ipaddr)) == INADDR_NONE) {
419                 fprintf(stderr, "Invalid IP address '%s'.\n", args->ipaddr);
420                 return 1;
421         }
422
423         if ((ipconf.mask.s_addr = inet_addr(args->ipmask)) == INADDR_NONE) {
424                 fprintf(stderr, "Invalid subnet mask '%s'.\n", args->ipmask);
425                 return 1;
426         }
427
428         if (strcmp(args->file_local, "-") && access(args->file_local, R_OK) == -1) {
429                 fprintf(stderr, "Error accessing file '%s'.\n", args->file_local);
430                 return 1;
431         }
432
433         if (args->file_remote) {
434                 if (!tftp_is_valid_filename(args->file_remote)) {
435                         fprintf(stderr, "Invalid remote filename '%s'.\n",
436                                         args->file_remote);
437                         return 1;
438                 }
439         }
440
441         if (args->region) {
442                 region = htons(to_region_code(args->region));
443                 if (!region) {
444                         fprintf(stderr, "Invalid region code '%s'.\n", args->region);
445                         return 1;
446                 }
447         } else {
448                 region = 0;
449         }
450
451         status = 1;
452
453         sock = ethsock_create(args->intf, ETH_P_NMRP);
454         if (!sock) {
455                 return 1;
456         }
457
458         status = is_valid_ip(sock, &ipconf.addr, &ipconf.mask);
459         if (status <= 0) {
460                 if (!status) {
461                         fprintf(stderr, "Address %s/%s cannot be used on interface %s.\n",
462                                         args->ipaddr, args->ipmask, args->intf);
463                 }
464                 goto out;
465         }
466
467         gsock = sock;
468         sigh_orig = signal(SIGINT, sigh);
469
470         if (ethsock_set_timeout(sock, args->rx_timeout)) {
471                 goto out;
472         }
473
474         src = ethsock_get_hwaddr(sock);
475         if (!src) {
476                 goto out;
477         }
478
479         memcpy(tx.eh.ether_shost, src, 6);
480         memcpy(tx.eh.ether_dhost, dest, 6);
481         tx.eh.ether_type = htons(ETH_P_NMRP);
482
483         msg_init(&tx.msg, NMRP_C_ADVERTISE);
484         msg_opt_add(&tx.msg, NMRP_O_MAGIC_NO, "NTGR", 4);
485         msg_hton(&tx.msg);
486
487         i = 0;
488         upload_ok = 0;
489         beg = time(NULL);
490
491         while (1) {
492                 printf("\rAdvertising NMRP server on %s ... %c",
493                                 args->intf, spinner[i]);
494                 fflush(stdout);
495                 i = (i + 1) & 3;
496
497                 if (pkt_send(sock, &tx) < 0) {
498                         perror("sendto");
499                         goto out;
500                 }
501
502                 status = pkt_recv(sock, &rx);
503                 if (status == 0 && memcmp(rx.eh.ether_dhost, src, 6) == 0) {
504                         break;
505                 } else if (status == 1) {
506                         printf("ERR\n");
507                         goto out;
508                 } else {
509                         if ((time(NULL) - beg) >= 60) {
510                                 printf("\nNo response after 60 seconds. Bailing out.\n");
511                                 goto out;
512                         }
513                 }
514         }
515
516         printf("\n");
517
518         expect = NMRP_C_CONF_REQ;
519         ulreqs = 0;
520
521         do {
522                 if (expect != NMRP_C_NONE && rx.msg.code != expect) {
523                         fprintf(stderr, "Received %s while waiting for %s!\n",
524                                         msg_code_str(rx.msg.code), msg_code_str(expect));
525                 }
526
527                 msg_init(&tx.msg, NMRP_C_NONE);
528
529                 status = 1;
530
531                 switch (rx.msg.code) {
532                         case NMRP_C_ADVERTISE:
533                                 printf("Received NMRP advertisement from %s.\n",
534                                                 mac_to_str(rx.eh.ether_shost));
535                                 status = 1;
536                                 goto out;
537                         case NMRP_C_CONF_REQ:
538                                 tx.msg.code = NMRP_C_CONF_ACK;
539
540                                 msg_opt_add(&tx.msg, NMRP_O_DEV_IP, &ipconf, 8);
541                                 msg_opt_add(&tx.msg, NMRP_O_FW_UP, NULL, 0);
542
543 #ifdef NMRPFLASH_SET_REGION
544                                 if (region) {
545                                         msg_opt_add(&tx.msg, NMRP_O_DEV_REGION, &region, 2);
546                                 }
547 #endif
548
549                                 expect = NMRP_C_TFTP_UL_REQ;
550
551                                 printf("Received configuration request from %s.\n",
552                                                 mac_to_str(rx.eh.ether_shost));
553
554                                 memcpy(tx.eh.ether_dhost, rx.eh.ether_shost, 6);
555
556                                 printf("Sending configuration: ip %s, mask %s.\n",
557                                                 args->ipaddr, args->ipmask);
558
559                                 break;
560                         case NMRP_C_TFTP_UL_REQ:
561                                 if (!upload_ok) {
562                                         if (++ulreqs > 5) {
563                                                 printf("Bailing out after %d upload requests.\n",
564                                                                 ulreqs);
565                                                 tx.msg.code = NMRP_C_CLOSE_REQ;
566                                                 break;
567                                         }
568                                 } else {
569                                         if (verbosity) {
570                                                 printf("Ignoring extra upload request.\n");
571                                         }
572                                         ethsock_set_timeout(sock, args->ul_timeout);
573                                         tx.msg.code = NMRP_C_KEEP_ALIVE_REQ;
574                                         break;
575                                 }
576
577                                 len = 0;
578                                 filename = msg_opt_data(&rx.msg, NMRP_O_FILE_NAME, &len);
579                                 if (filename) {
580                                         if (!args->file_remote) {
581                                                 args->file_remote = filename;
582                                         }
583                                         printf("Received upload request: filename '%.*s'.\n",
584                                                         len, filename);
585                                 } else if (!args->file_remote) {
586                                         args->file_remote = args->file_local;
587                                         printf("Received upload request with empty filename.\n");
588                                 }
589
590                                 status = 0;
591
592                                 if (args->tftpcmd) {
593                                         printf("Executing '%s' ... ", args->tftpcmd);
594                                         fflush(stdout);
595                                         status = system(args->tftpcmd);
596                                         if (!status) {
597                                                 printf("OK\n");
598                                         } else {
599                                                 printf("ERR\n");
600                                         }
601                                 }
602
603                                 if (!status && args->file_local) {
604                                         status = is_valid_ip(sock, &ipconf.addr, &ipconf.mask);
605                                         if (status < 0) {
606                                                 goto out;
607                                         } else if (!status) {
608                                                 printf("IP address of %s has changed. Please assign a "
609                                                                 "static ip to the interface.\n", args->intf);
610                                                 tx.msg.code = NMRP_C_CLOSE_REQ;
611                                                 break;
612                                         }
613
614                                         if (verbosity) {
615                                                 printf("Using remote filename '%s'.\n",
616                                                                 args->file_remote);
617                                         }
618
619                                         if (!strcmp(args->file_local, "-")) {
620                                                 printf("Uploading from stdin ... ");
621                                         } else {
622                                                 printf("Uploading %s ... ", leafname(args->file_local));
623                                         }
624                                         fflush(stdout);
625                                         status = tftp_put(args);
626                                 }
627
628                                 if (!status) {
629                                         printf("OK\nWaiting for remote to respond.\n");
630                                         upload_ok = 1;
631                                         ethsock_set_timeout(sock, args->ul_timeout);
632                                         tx.msg.code = NMRP_C_KEEP_ALIVE_REQ;
633                                         expect = NMRP_C_NONE;
634                                 } else if (status == -2) {
635                                         expect = NMRP_C_TFTP_UL_REQ;
636                                 } else {
637                                         goto out;
638                                 }
639
640                                 break;
641                         case NMRP_C_KEEP_ALIVE_REQ:
642                                 tx.msg.code = NMRP_C_KEEP_ALIVE_ACK;
643                                 ethsock_set_timeout(sock, 15000);
644                                 printf("Received keep-alive request.\n");
645                                 break;
646                         case NMRP_C_CLOSE_REQ:
647                                 tx.msg.code = NMRP_C_CLOSE_ACK;
648                                 break;
649                         case NMRP_C_CLOSE_ACK:
650                                 status = 0;
651                                 goto out;
652                         default:
653                                 fprintf(stderr, "Unknown message code 0x%02x!\n",
654                                                 rx.msg.code);
655                                 msg_dump(&rx.msg, 0);
656                 }
657
658                 if (tx.msg.code != NMRP_C_NONE) {
659                         msg_hton(&tx.msg);
660
661                         if (pkt_send(sock, &tx) < 0) {
662                                 perror("sendto");
663                                 goto out;
664                         }
665                 }
666
667                 if (rx.msg.code == NMRP_C_CLOSE_REQ) {
668                         printf("Remote finished. Closing connection.\n");
669                         break;
670                 }
671
672                 status = pkt_recv(sock, &rx);
673                 if (status) {
674                         if (status == 2) {
675                                 fprintf(stderr, "Timeout while waiting for %s.\n",
676                                                 msg_code_str(expect));
677                         }
678                         goto out;
679                 }
680
681                 ethsock_set_timeout(sock, args->rx_timeout);
682
683         } while (1);
684
685         status = 0;
686
687         if (ulreqs) {
688                 printf("Reboot your device now.\n");
689         } else {
690                 printf("No upload request received.\n");
691         }
692
693 out:
694         signal(SIGINT, sigh_orig);
695         gsock = NULL;
696         ethsock_close(sock);
697         return status;
698 }