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)
141 fprintf(stderr, "res=0x%04x, code=0x%02x, id=0x%02x, len=%u",
142 msg->reserved, msg->code, msg->id, msg->len);
144 remain_len = msg->len - NMRP_HDR_LEN;
145 fprintf(stderr, "%s\n", remain_len ? "" : " (no opts)");
148 static void msg_hton(struct nmrp_msg *msg)
151 struct nmrp_opt *opt = msg->opts, *next;
153 msg->reserved = htons(msg->reserved);
154 msg->len = htons(msg->len);
156 for (; i != msg->num_opts; ++i) {
157 next = NMRP_OPT_NEXT(opt);
158 opt->len = htons(opt->len);
159 opt->type = htons(opt->type);
164 static void msg_hdr_ntoh(struct nmrp_msg *msg)
166 msg->reserved = ntohs(msg->reserved);
167 msg->len = ntohs(msg->len);
170 static int msg_ntoh(struct nmrp_msg *msg)
172 struct nmrp_opt *opt = msg->opts;
175 remaining = msg->len - NMRP_HDR_LEN;
177 // FIXME maximum of two options supported, maximum option
179 if (remaining < NMRP_MAX_OPT_NUM * NMRP_MAX_OPT_SIZE) {
180 while (remaining > 0) {
181 if (remaining < NMRP_OPT_HDR_LEN) {
185 opt->type = ntohs(opt->type);
186 opt->len = ntohs(opt->len);
188 if (!opt->len || opt->len > NMRP_MAX_OPT_SIZE) {
192 remaining -= opt->len;
193 opt = NMRP_OPT_NEXT(opt);
201 fprintf(stderr, "Unexpected message format.\n");
206 static void *msg_opt_data(struct nmrp_msg *msg, uint16_t type, uint16_t *len)
208 static char buf[128];
209 struct nmrp_opt *opt = msg->opts;
210 int remaining = msg->len - NMRP_HDR_LEN;
212 memset(buf, 0, sizeof(buf));
214 while (remaining > 0) {
215 if (opt->type == type) {
216 if (opt->len == NMRP_OPT_HDR_LEN) {
219 *len = opt->len - NMRP_OPT_HDR_LEN;
220 memcpy(buf, &opt->val, MIN(*len, sizeof(buf)-1));
228 remaining -= opt->len;
229 opt = NMRP_OPT_NEXT(opt);
235 static void msg_opt_add(struct nmrp_msg *msg, uint16_t type, void *data,
239 struct nmrp_opt *opt = msg->opts;
241 if (len + NMRP_OPT_HDR_LEN > NMRP_MAX_OPT_SIZE
242 || msg->num_opts == NMRP_MAX_OPT_NUM) {
243 fprintf(stderr, "Invalid option - this is a bug.\n");
246 for (; i <= msg->num_opts; ++i) {
247 opt = NMRP_OPT_NEXT(opt);
250 opt->len = NMRP_OPT_HDR_LEN + len;
254 memcpy(&opt->val, data, len);
257 msg->len += opt->len;
261 static inline void msg_init(struct nmrp_msg *msg, uint16_t code)
263 memset(msg, 0, sizeof(*msg));
264 msg->len = NMRP_HDR_LEN;
268 #ifdef NMRPFLASH_FUZZ
269 #define NMRP_INITIAL_TIMEOUT 0
270 #define ethsock_create(a, b) ((struct ethsock*)1)
271 #define ethsock_get_hwaddr(a) ethsock_get_hwaddr_fake(a)
272 #define ethsock_recv(sock, buf, len) read(STDIN_FILENO, buf, len)
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 uint8_t *ethsock_get_hwaddr_fake(struct ethsock* sock)
282 static uint8_t hwaddr[6] = { 0xfa, 0xfa, 0xfa, 0xfa, 0xfa, 0xfa };
286 #define NMRP_INITIAL_TIMEOUT 60
289 static int pkt_send(struct ethsock *sock, struct nmrp_pkt *pkt)
291 size_t len = ntohs(pkt->msg.len) + sizeof(pkt->eh);
292 return ethsock_send(sock, pkt, len);
295 static int pkt_recv(struct ethsock *sock, struct nmrp_pkt *pkt)
299 memset(pkt, 0, sizeof(*pkt));
300 bytes = ethsock_recv(sock, pkt, sizeof(*pkt));
305 } else if (bytes < NMRP_MIN_PKT_LEN) {
306 fprintf(stderr, "Short packet (%d bytes)\n", (int)bytes);
310 msg_hdr_ntoh(&pkt->msg);
311 len = pkt->msg.len + sizeof(pkt->eh);
314 fprintf(stderr, "Short packet (expected %d, got %d).\n",
315 (int)len, (int)bytes);
319 return msg_ntoh(&pkt->msg);
322 static int mac_parse(const char *str, uint8_t *hwaddr)
327 sscanf(str, "%02x:%02x:%02x:%02x:%02x:%02x%n",
328 data, data + 1, data + 2, data + 3, data + 4, data + 5, &i);
330 if (i == strlen(str)) {
331 for (i = 0; i != 6; ++i) {
336 hwaddr[i] = data[i] & 0xff;
346 struct is_valid_ip_arg
348 struct in_addr *ipaddr;
349 struct in_addr *ipmask;
353 static int is_valid_ip_cb(struct ethsock_ip_callback_args *args)
355 #define SUBNET(x) ((x)->ipaddr->s_addr & (x)->ipmask->s_addr)
356 struct is_valid_ip_arg *arg = args->arg;
357 if (SUBNET(args) == SUBNET(arg)) {
358 arg->result = args->ipaddr->s_addr != arg->ipaddr->s_addr;
366 static int is_valid_ip(struct ethsock *sock, struct in_addr *ipaddr,
367 struct in_addr *ipmask)
370 struct is_valid_ip_arg arg = {
376 status = ethsock_for_each_ip(sock, is_valid_ip_cb, &arg);
377 return status < 0 ? status : arg.result;
380 static void sigh(int sig)
385 static const char *spinner = "\\|/-";
387 int nmrp_do(struct nmrpd_args *args)
389 struct nmrp_pkt tx, rx;
390 uint8_t *src, dest[6];
391 uint16_t len, region;
394 int i, status, ulreqs, expect, upload_ok, autoip;
395 struct ethsock *sock;
396 struct ethsock_ip_undo *ip_undo = NULL;
397 struct ethsock_arp_undo *arp_undo = NULL;
399 void (*sigh_orig)(int);
405 if (args->op != NMRP_UPLOAD_FW) {
406 fprintf(stderr, "Operation not implemented.\n");
410 if (!mac_parse(args->mac, dest)) {
411 fprintf(stderr, "Invalid MAC address '%s'.\n", args->mac);
415 ipconf.mask.s_addr = inet_addr(args->ipmask);
416 if (ipconf.mask.s_addr == INADDR_NONE
417 || netmask(bitcount(ipconf.mask.s_addr)) != ipconf.mask.s_addr) {
418 fprintf(stderr, "Invalid subnet mask '%s'.\n", args->ipmask);
424 /* The MAC of the device that was used to test this utility starts
425 * with a4:2b:8c, hence 164 (0xa4) and 183 (0x2b + 0x8c)
427 args->ipaddr = "10.164.183.252";
429 if (!args->ipaddr_intf) {
430 args->ipaddr_intf = "10.164.183.253";
432 } else if (args->ipaddr_intf) {
438 if ((ipconf.addr.s_addr = inet_addr(args->ipaddr)) == INADDR_NONE) {
439 fprintf(stderr, "Invalid IP address '%s'.\n", args->ipaddr);
443 if (args->ipaddr_intf && (intf_addr = inet_addr(args->ipaddr_intf)) == INADDR_NONE) {
444 fprintf(stderr, "Invalid IP address '%s'.\n", args->ipaddr_intf);
448 if (args->file_local && strcmp(args->file_local, "-") && access(args->file_local, R_OK) == -1) {
449 fprintf(stderr, "Error accessing file '%s'.\n", args->file_local);
453 if (args->file_remote) {
454 if (!tftp_is_valid_filename(args->file_remote)) {
455 fprintf(stderr, "Invalid remote filename '%s'.\n",
462 region = htons(to_region_code(args->region));
464 fprintf(stderr, "Invalid region code '%s'.\n", args->region);
473 sock = ethsock_create(args->intf, ETH_P_NMRP);
478 sigh_orig = signal(SIGINT, sigh);
481 status = is_valid_ip(sock, &ipconf.addr, &ipconf.mask);
484 fprintf(stderr, "Address %s/%s cannot be used on interface %s.\n",
485 args->ipaddr, args->ipmask, args->intf);
491 printf("Adding %s to interface %s.\n", args->ipaddr_intf, args->intf);
494 if (ethsock_ip_add(sock, intf_addr, ipconf.mask.s_addr, &ip_undo) != 0) {
499 if (ethsock_set_timeout(sock, args->rx_timeout)) {
503 src = ethsock_get_hwaddr(sock);
508 memcpy(tx.eh.ether_shost, src, 6);
509 memcpy(tx.eh.ether_dhost, dest, 6);
510 tx.eh.ether_type = htons(ETH_P_NMRP);
512 msg_init(&tx.msg, NMRP_C_ADVERTISE);
513 msg_opt_add(&tx.msg, NMRP_O_MAGIC_NO, "NTGR", 4);
518 beg = time_monotonic();
520 while (!g_interrupted) {
521 printf("\rAdvertising NMRP server on %s ... %c",
522 args->intf, spinner[i]);
526 if (pkt_send(sock, &tx) < 0) {
531 status = pkt_recv(sock, &rx);
532 if (status == 0 && memcmp(rx.eh.ether_dhost, src, 6) == 0) {
534 } else if (status == 1) {
537 /* because we don't want nmrpflash's exit status to be zero */
539 if ((time_monotonic() - beg) >= NMRP_INITIAL_TIMEOUT) {
540 printf("\nNo response after 60 seconds. Bailing out.\n");
548 expect = NMRP_C_CONF_REQ;
551 while (!g_interrupted) {
552 if (expect != NMRP_C_NONE && rx.msg.code != expect) {
553 fprintf(stderr, "Received %s while waiting for %s!\n",
554 msg_code_str(rx.msg.code), msg_code_str(expect));
557 msg_init(&tx.msg, NMRP_C_NONE);
561 switch (rx.msg.code) {
562 case NMRP_C_ADVERTISE:
563 printf("Received NMRP advertisement from %s.\n",
564 mac_to_str(rx.eh.ether_shost));
567 case NMRP_C_CONF_REQ:
568 tx.msg.code = NMRP_C_CONF_ACK;
570 msg_opt_add(&tx.msg, NMRP_O_DEV_IP, &ipconf, 8);
571 msg_opt_add(&tx.msg, NMRP_O_FW_UP, NULL, 0);
573 #ifdef NMRPFLASH_SET_REGION
575 msg_opt_add(&tx.msg, NMRP_O_DEV_REGION, ®ion, 2);
579 expect = NMRP_C_TFTP_UL_REQ;
581 printf("Received configuration request from %s.\n",
582 mac_to_str(rx.eh.ether_shost));
584 memcpy(tx.eh.ether_dhost, rx.eh.ether_shost, 6);
586 printf("Sending configuration: %s, netmask %s.\n",
587 args->ipaddr, args->ipmask);
589 if (ethsock_arp_add(sock, rx.eh.ether_shost, ipconf.addr.s_addr, &arp_undo) != 0) {
594 case NMRP_C_TFTP_UL_REQ:
597 printf("Bailing out after %d upload requests.\n",
599 tx.msg.code = NMRP_C_CLOSE_REQ;
604 printf("Ignoring extra upload request.\n");
606 ethsock_set_timeout(sock, args->ul_timeout);
607 tx.msg.code = NMRP_C_KEEP_ALIVE_REQ;
612 filename = msg_opt_data(&rx.msg, NMRP_O_FILE_NAME, &len);
614 if (!args->file_remote) {
615 args->file_remote = filename;
617 printf("Received upload request: filename '%.*s'.\n",
619 } else if (!args->file_remote) {
620 args->file_remote = args->file_local;
621 printf("Received upload request with empty filename.\n");
627 printf("Executing '%s' ... \n", args->tftpcmd);
628 setenv("IP", inet_ntoa(ipconf.addr), 1);
629 setenv("PORT", lltostr(args->port, 10), 1);
630 setenv("MAC", mac_to_str(rx.eh.ether_shost), 1);
631 setenv("NETMASK", inet_ntoa(ipconf.mask), 1);
632 //setenv("FILENAME", args->file_remote ? args->file_remote : "", 1);
633 status = system(args->tftpcmd);
636 if (!status && args->file_local) {
638 status = is_valid_ip(sock, &ipconf.addr, &ipconf.mask);
641 } else if (!status) {
642 printf("IP address of %s has changed. Please assign a "
643 "static ip to the interface.\n", args->intf);
644 tx.msg.code = NMRP_C_CLOSE_REQ;
650 printf("Using remote filename '%s'.\n",
654 if (!strcmp(args->file_local, "-")) {
655 printf("Uploading from stdin ... ");
657 printf("Uploading %s ... ", leafname(args->file_local));
660 if (!(status = tftp_put(args))) {
667 printf("Waiting for remote to respond.\n");
669 ethsock_set_timeout(sock, args->ul_timeout);
670 tx.msg.code = NMRP_C_KEEP_ALIVE_REQ;
671 expect = NMRP_C_NONE;
672 } else if (status == -2) {
673 expect = NMRP_C_TFTP_UL_REQ;
679 case NMRP_C_KEEP_ALIVE_REQ:
680 tx.msg.code = NMRP_C_KEEP_ALIVE_ACK;
681 ethsock_set_timeout(sock, args->ul_timeout);
682 printf("Received keep-alive request.\n");
684 case NMRP_C_CLOSE_REQ:
685 tx.msg.code = NMRP_C_CLOSE_ACK;
687 case NMRP_C_CLOSE_ACK:
691 fprintf(stderr, "Unknown message code 0x%02x!\n",
696 if (tx.msg.code != NMRP_C_NONE) {
699 if (pkt_send(sock, &tx) < 0) {
704 if (tx.msg.code == NMRP_C_CLOSE_REQ) {
709 if (rx.msg.code == NMRP_C_CLOSE_REQ) {
710 printf("Remote finished. Closing connection.\n");
714 status = pkt_recv(sock, &rx);
717 fprintf(stderr, "Timeout while waiting for %s.\n",
718 msg_code_str(expect));
723 ethsock_set_timeout(sock, args->rx_timeout);
727 if (!g_interrupted) {
730 printf("Reboot your device now.\n");
732 printf("No upload request received.\n");
737 signal(SIGINT, sigh_orig);
738 ethsock_arp_del(sock, &arp_undo);
739 ethsock_ip_del(sock, &ip_undo);