2 * nmrpflash - Netgear Unbrick Utility
3 * Copyright (C) 2016 Joseph Lehner <joseph.c.lehner@gmail.com>
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.
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.
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/>.
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)
33 #define NMRP_MAX_OPT_SIZE 12
34 #define NMRP_MAX_OPT_NUM 3
36 #define NMRP_OPT_NEXT(x) ((struct nmrp_opt*)(((char*)x) + x->len))
38 #define ETH_P_NMRP 0x0912
40 #define MAX_LOOP_RECV 1024
43 #define PACKED __attribute__((__packed__))
46 #ifdef NMRPFLASH_WINDOWS
47 #define setenv(name, value, overwrite) SetEnvironmentVariable(name, value)
57 NMRP_C_KEEP_ALIVE_REQ = 6,
58 NMRP_C_KEEP_ALIVE_ACK = 7,
59 NMRP_C_TFTP_UL_REQ = 16
63 NMRP_O_MAGIC_NO = 0x0001,
64 NMRP_O_DEV_IP = 0x0002,
65 NMRP_O_DEV_REGION = 0x0004,
66 NMRP_O_FW_UP = 0x0101,
67 NMRP_O_ST_UP = 0x0102,
68 NMRP_O_FILE_NAME = 0x0181
89 /* only opts[0] is valid! think of this as a char* */
90 struct nmrp_opt opts[NMRP_MAX_OPT_NUM];
91 /* this is NOT part of the transmitted packet */
100 static const char *msg_code_str(uint16_t code)
102 #define CASE_CODE(x) case NMRP_C_ ## x: return #x
106 CASE_CODE(ADVERTISE);
109 CASE_CODE(CLOSE_REQ);
110 CASE_CODE(CLOSE_ACK);
111 CASE_CODE(KEEP_ALIVE_REQ);
112 CASE_CODE(KEEP_ALIVE_ACK);
113 CASE_CODE(TFTP_UL_REQ);
115 snprintf(buf, sizeof(buf), "%04x", code);
121 static uint16_t to_region_code(const char *region)
123 #define REGION_CODE(r, c) if (!strcasecmp(region, r)) return c
124 REGION_CODE("NA", 0x0001);
125 REGION_CODE("WW", 0x0002);
126 REGION_CODE("GR", 0x0003);
127 REGION_CODE("PR", 0x0004);
128 REGION_CODE("RU", 0x0005);
129 REGION_CODE("BZ", 0x0006);
130 REGION_CODE("IN", 0x0007);
131 REGION_CODE("KO", 0x0008);
132 REGION_CODE("JP", 0x0009);
137 static void msg_dump(struct nmrp_msg *msg, int dump_opts)
139 struct nmrp_opt *opt;
140 int remain_len, len, i;
142 fprintf(stderr, "res=0x%04x, code=0x%02x, id=0x%02x, len=%u",
143 msg->reserved, msg->code, msg->id, msg->len);
145 remain_len = msg->len - NMRP_HDR_LEN;
146 fprintf(stderr, "%s\n", remain_len ? "" : " (no opts)");
149 static void msg_hton(struct nmrp_msg *msg)
152 struct nmrp_opt *opt = msg->opts, *next;
154 msg->reserved = htons(msg->reserved);
155 msg->len = htons(msg->len);
157 for (; i != msg->num_opts; ++i) {
158 next = NMRP_OPT_NEXT(opt);
159 opt->len = htons(opt->len);
160 opt->type = htons(opt->type);
165 static void msg_hdr_ntoh(struct nmrp_msg *msg)
167 msg->reserved = ntohs(msg->reserved);
168 msg->len = ntohs(msg->len);
171 static int msg_ntoh(struct nmrp_msg *msg)
173 struct nmrp_opt *opt = msg->opts;
176 remaining = msg->len - NMRP_HDR_LEN;
178 // FIXME maximum of two options supported, maximum option
180 if (remaining < NMRP_MAX_OPT_NUM * NMRP_MAX_OPT_SIZE) {
181 while (remaining > 0) {
182 if (remaining < NMRP_OPT_HDR_LEN) {
186 opt->type = ntohs(opt->type);
187 opt->len = ntohs(opt->len);
189 if (!opt->len || opt->len > NMRP_MAX_OPT_SIZE) {
193 remaining -= opt->len;
194 opt = NMRP_OPT_NEXT(opt);
202 fprintf(stderr, "Unexpected message format.\n");
207 static void *msg_opt_data(struct nmrp_msg *msg, uint16_t type, uint16_t *len)
209 static char buf[128];
210 struct nmrp_opt *opt = msg->opts;
211 int remaining = msg->len - NMRP_HDR_LEN;
213 memset(buf, 0, sizeof(buf));
215 while (remaining > 0) {
216 if (opt->type == type) {
217 if (opt->len == NMRP_OPT_HDR_LEN) {
220 *len = opt->len - NMRP_OPT_HDR_LEN;
221 memcpy(buf, &opt->val, MIN(*len, sizeof(buf)-1));
229 remaining -= opt->len;
230 opt = NMRP_OPT_NEXT(opt);
236 static void msg_opt_add(struct nmrp_msg *msg, uint16_t type, void *data,
240 struct nmrp_opt *opt = msg->opts;
242 if (len + NMRP_OPT_HDR_LEN > NMRP_MAX_OPT_SIZE
243 || msg->num_opts == NMRP_MAX_OPT_NUM) {
244 fprintf(stderr, "Invalid option - this is a bug.\n");
247 for (; i <= msg->num_opts; ++i) {
248 opt = NMRP_OPT_NEXT(opt);
251 opt->len = NMRP_OPT_HDR_LEN + len;
255 memcpy(&opt->val, data, len);
258 msg->len += opt->len;
262 static inline void msg_init(struct nmrp_msg *msg, uint16_t code)
264 memset(msg, 0, sizeof(*msg));
265 msg->len = NMRP_HDR_LEN;
269 #ifdef NMRPFLASH_FUZZ
270 #define ethsock_create(a, b) ethsock_create_fake(a, b)
271 #define ethsock_get_hwaddr(a) ethsock_get_hwaddr_fake(a)
272 #define ethsock_recv(a, b, c) ethsock_recv_fake(a, b, c)
273 #define ethsock_send(a, b, c) (0)
274 #define ethsock_set_timeout(a, b) (0)
275 #define ethsock_ip_add(a, b, c, d) (0)
276 #define ethsock_ip_del(a, b) (0)
277 #define ethsock_close(a) (0)
278 #define tftp_put(a) (0)
280 static struct ethsock* ethsock_create_fake(const char *intf, uint16_t protocol)
282 return (struct ethsock*)1;
285 static uint8_t *ethsock_get_hwaddr_fake(struct ethsock* sock)
287 static uint8_t hwaddr[6];
288 memset(hwaddr, 0xfa, 6);
292 static ssize_t ethsock_recv_fake(struct ethsock *sock, void *buf, size_t len)
294 return read(STDIN_FILENO, buf, len);
298 static int pkt_send(struct ethsock *sock, struct nmrp_pkt *pkt)
300 size_t len = ntohs(pkt->msg.len) + sizeof(pkt->eh);
301 return ethsock_send(sock, pkt, len);
304 static int pkt_recv(struct ethsock *sock, struct nmrp_pkt *pkt)
308 memset(pkt, 0, sizeof(*pkt));
309 bytes = ethsock_recv(sock, pkt, sizeof(*pkt));
314 } else if (bytes < NMRP_MIN_PKT_LEN) {
315 fprintf(stderr, "Short packet (%d bytes)\n", (int)bytes);
319 msg_hdr_ntoh(&pkt->msg);
320 len = pkt->msg.len + sizeof(pkt->eh);
323 fprintf(stderr, "Short packet (expected %d, got %d).\n",
324 (int)len, (int)bytes);
328 return msg_ntoh(&pkt->msg);
331 static int mac_parse(const char *str, uint8_t *hwaddr)
336 sscanf(str, "%02x:%02x:%02x:%02x:%02x:%02x%n",
337 data, data + 1, data + 2, data + 3, data + 4, data + 5, &i);
339 if (i == strlen(str)) {
340 for (i = 0; i != 6; ++i) {
345 hwaddr[i] = data[i] & 0xff;
355 struct is_valid_ip_arg
357 struct in_addr *ipaddr;
358 struct in_addr *ipmask;
362 static int is_valid_ip_cb(struct ethsock_ip_callback_args *args)
364 #define SUBNET(x) ((x)->ipaddr->s_addr & (x)->ipmask->s_addr)
365 struct is_valid_ip_arg *arg = args->arg;
366 if (SUBNET(args) == SUBNET(arg)) {
367 arg->result = args->ipaddr->s_addr != arg->ipaddr->s_addr;
375 static int is_valid_ip(struct ethsock *sock, struct in_addr *ipaddr,
376 struct in_addr *ipmask)
379 struct is_valid_ip_arg arg = {
385 status = ethsock_for_each_ip(sock, is_valid_ip_cb, &arg);
386 return status < 0 ? status : arg.result;
389 static struct ethsock *gsock = NULL;
390 static struct ethsock_ip_undo *gundo = NULL;
392 static struct in_addr arpip = { 0 };
393 static uint8_t arpmac[6] = { 0 };
395 static void sigh(int sig)
400 ethsock_arp_del(gsock, arpmac, &arpip);
402 ethsock_ip_del(gsock, &gundo);
403 ethsock_close(gsock);
410 static const char *spinner = "\\|/-";
412 int nmrp_do(struct nmrpd_args *args)
414 struct nmrp_pkt tx, rx;
415 uint8_t *src, dest[6];
416 uint16_t len, region;
419 int i, status, ulreqs, expect, upload_ok, autoip;
420 struct ethsock *sock;
422 void (*sigh_orig)(int);
428 if (args->op != NMRP_UPLOAD_FW) {
429 fprintf(stderr, "Operation not implemented.\n");
433 if (!mac_parse(args->mac, dest)) {
434 fprintf(stderr, "Invalid MAC address '%s'.\n", args->mac);
438 if ((ipconf.mask.s_addr = inet_addr(args->ipmask)) == INADDR_NONE) {
439 fprintf(stderr, "Invalid subnet mask '%s'.\n", args->ipmask);
445 /* The MAC of the device that was used to test this utility starts
446 * with a4:2b:8c, hence 164 (0xa4) and 183 (0x2b + 0x8c)
448 args->ipaddr = "10.164.183.252";
450 if (!args->ipaddr_intf) {
451 args->ipaddr_intf = "10.164.183.253";
453 } else if (args->ipaddr_intf) {
459 if ((ipconf.addr.s_addr = inet_addr(args->ipaddr)) == INADDR_NONE) {
460 fprintf(stderr, "Invalid IP address '%s'.\n", args->ipaddr);
464 if (args->ipaddr_intf && (intf_addr = inet_addr(args->ipaddr_intf)) == INADDR_NONE) {
465 fprintf(stderr, "Invalid IP address '%s'.\n", args->ipaddr_intf);
469 if (args->file_local && strcmp(args->file_local, "-") && access(args->file_local, R_OK) == -1) {
470 fprintf(stderr, "Error accessing file '%s'.\n", args->file_local);
474 if (args->file_remote) {
475 if (!tftp_is_valid_filename(args->file_remote)) {
476 fprintf(stderr, "Invalid remote filename '%s'.\n",
483 region = htons(to_region_code(args->region));
485 fprintf(stderr, "Invalid region code '%s'.\n", args->region);
494 sock = ethsock_create(args->intf, ETH_P_NMRP);
501 sigh_orig = signal(SIGINT, sigh);
504 status = is_valid_ip(sock, &ipconf.addr, &ipconf.mask);
507 fprintf(stderr, "Address %s/%s cannot be used on interface %s.\n",
508 args->ipaddr, args->ipmask, args->intf);
514 printf("Adding %s to interface %s.\n", args->ipaddr_intf, args->intf);
517 if (ethsock_ip_add(sock, intf_addr, ipconf.mask.s_addr, &gundo) != 0) {
522 if (ethsock_set_timeout(sock, args->rx_timeout)) {
526 src = ethsock_get_hwaddr(sock);
531 memcpy(tx.eh.ether_shost, src, 6);
532 memcpy(tx.eh.ether_dhost, dest, 6);
533 tx.eh.ether_type = htons(ETH_P_NMRP);
535 msg_init(&tx.msg, NMRP_C_ADVERTISE);
536 msg_opt_add(&tx.msg, NMRP_O_MAGIC_NO, "NTGR", 4);
541 beg = time_monotonic();
544 printf("\rAdvertising NMRP server on %s ... %c",
545 args->intf, spinner[i]);
549 if (pkt_send(sock, &tx) < 0) {
554 status = pkt_recv(sock, &rx);
555 if (status == 0 && memcmp(rx.eh.ether_dhost, src, 6) == 0) {
557 } else if (status == 1) {
560 if ((time_monotonic() - beg) >= 60) {
561 printf("\nNo response after 60 seconds. Bailing out.\n");
564 #ifdef NMRPFLASH_FUZZ
572 expect = NMRP_C_CONF_REQ;
576 if (expect != NMRP_C_NONE && rx.msg.code != expect) {
577 fprintf(stderr, "Received %s while waiting for %s!\n",
578 msg_code_str(rx.msg.code), msg_code_str(expect));
581 msg_init(&tx.msg, NMRP_C_NONE);
585 switch (rx.msg.code) {
586 case NMRP_C_ADVERTISE:
587 printf("Received NMRP advertisement from %s.\n",
588 mac_to_str(rx.eh.ether_shost));
591 case NMRP_C_CONF_REQ:
592 tx.msg.code = NMRP_C_CONF_ACK;
594 msg_opt_add(&tx.msg, NMRP_O_DEV_IP, &ipconf, 8);
595 msg_opt_add(&tx.msg, NMRP_O_FW_UP, NULL, 0);
597 #ifdef NMRPFLASH_SET_REGION
599 msg_opt_add(&tx.msg, NMRP_O_DEV_REGION, ®ion, 2);
603 expect = NMRP_C_TFTP_UL_REQ;
605 printf("Received configuration request from %s.\n",
606 mac_to_str(rx.eh.ether_shost));
608 memcpy(tx.eh.ether_dhost, rx.eh.ether_shost, 6);
610 printf("Sending configuration: ip %s, mask %s.\n",
611 args->ipaddr, args->ipmask);
613 memcpy(arpmac, rx.eh.ether_shost, 6);
614 memcpy(&arpip, &ipconf.addr, sizeof(ipconf.addr));
616 if (ethsock_arp_add(sock, arpmac, &arpip) != 0) {
623 case NMRP_C_TFTP_UL_REQ:
626 printf("Bailing out after %d upload requests.\n",
628 tx.msg.code = NMRP_C_CLOSE_REQ;
633 printf("Ignoring extra upload request.\n");
635 ethsock_set_timeout(sock, args->ul_timeout);
636 tx.msg.code = NMRP_C_KEEP_ALIVE_REQ;
641 filename = msg_opt_data(&rx.msg, NMRP_O_FILE_NAME, &len);
643 if (!args->file_remote) {
644 args->file_remote = filename;
646 printf("Received upload request: filename '%.*s'.\n",
648 } else if (!args->file_remote) {
649 args->file_remote = args->file_local;
650 printf("Received upload request with empty filename.\n");
656 printf("Executing '%s' ... \n", args->tftpcmd);
657 setenv("IP", inet_ntoa(ipconf.addr), 1);
658 setenv("MAC", mac_to_str(rx.eh.ether_shost), 1);
659 setenv("NETMASK", inet_ntoa(ipconf.mask), 1);
660 status = system(args->tftpcmd);
663 if (!status && args->file_local) {
665 status = is_valid_ip(sock, &ipconf.addr, &ipconf.mask);
668 } else if (!status) {
669 printf("IP address of %s has changed. Please assign a "
670 "static ip to the interface.\n", args->intf);
671 tx.msg.code = NMRP_C_CLOSE_REQ;
677 printf("Using remote filename '%s'.\n",
681 if (!strcmp(args->file_local, "-")) {
682 printf("Uploading from stdin ... ");
684 printf("Uploading %s ... ", leafname(args->file_local));
687 status = tftp_put(args);
691 printf("OK\nWaiting for remote to respond.\n");
693 ethsock_set_timeout(sock, args->ul_timeout);
694 tx.msg.code = NMRP_C_KEEP_ALIVE_REQ;
695 expect = NMRP_C_NONE;
696 } else if (status == -2) {
697 expect = NMRP_C_TFTP_UL_REQ;
703 case NMRP_C_KEEP_ALIVE_REQ:
704 tx.msg.code = NMRP_C_KEEP_ALIVE_ACK;
705 ethsock_set_timeout(sock, args->ul_timeout);
706 printf("Received keep-alive request.\n");
708 case NMRP_C_CLOSE_REQ:
709 tx.msg.code = NMRP_C_CLOSE_ACK;
711 case NMRP_C_CLOSE_ACK:
715 fprintf(stderr, "Unknown message code 0x%02x!\n",
717 msg_dump(&rx.msg, 0);
720 if (tx.msg.code != NMRP_C_NONE) {
723 if (pkt_send(sock, &tx) < 0) {
728 if (tx.msg.code == NMRP_C_CLOSE_REQ) {
733 if (rx.msg.code == NMRP_C_CLOSE_REQ) {
734 printf("Remote finished. Closing connection.\n");
738 status = pkt_recv(sock, &rx);
741 fprintf(stderr, "Timeout while waiting for %s.\n",
742 msg_code_str(expect));
747 ethsock_set_timeout(sock, args->rx_timeout);
754 printf("Reboot your device now.\n");
756 printf("No upload request received.\n");
760 signal(SIGINT, sigh_orig);
762 ethsock_arp_del(sock, arpmac, &arpip);
763 ethsock_ip_del(sock, &gundo);