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__))
53 NMRP_C_KEEP_ALIVE_REQ = 6,
54 NMRP_C_KEEP_ALIVE_ACK = 7,
55 NMRP_C_TFTP_UL_REQ = 16
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
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 */
92 uint8_t ether_dhost[6];
93 uint8_t ether_shost[6];
102 static const char *msg_code_str(uint16_t code)
104 #define CASE_CODE(x) case NMRP_C_ ## x: return #x
108 CASE_CODE(ADVERTISE);
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);
117 snprintf(buf, sizeof(buf), "%04x", code);
123 static uint16_t to_region_code(const char *region)
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);
139 static void msg_dump(struct nmrp_msg *msg, int dump_opts)
141 struct nmrp_opt *opt;
142 int remain_len, len, i;
144 fprintf(stderr, "res=0x%04x, code=0x%02x, id=0x%02x, len=%u",
145 msg->reserved, msg->code, msg->id, msg->len);
147 remain_len = msg->len - NMRP_HDR_LEN;
148 fprintf(stderr, "%s\n", remain_len ? "" : " (no opts)");
153 while (remain_len > 0) {
155 fprintf(stderr, " opt type=%u, len=%u", opt->type, len);
157 for (i = 0; i != len - NMRP_OPT_HDR_LEN; ++i) {
159 fprintf(stderr, "\n ");
162 fprintf(stderr, "%02x ", ((char*)&opt->val)[i] & 0xff);
164 fprintf(stderr, "\n");
167 opt = NMRP_OPT_NEXT(opt);
172 static void msg_hton(struct nmrp_msg *msg)
175 struct nmrp_opt *opt = msg->opts, *next;
177 msg->reserved = htons(msg->reserved);
178 msg->len = htons(msg->len);
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);
188 static void msg_hdr_ntoh(struct nmrp_msg *msg)
190 msg->reserved = ntohs(msg->reserved);
191 msg->len = ntohs(msg->len);
194 static int msg_ntoh(struct nmrp_msg *msg)
196 struct nmrp_opt *opt = msg->opts;
199 remaining = msg->len - NMRP_HDR_LEN;
201 // FIXME maximum of two options supported, maximum option
203 if (remaining < NMRP_MAX_OPT_NUM * NMRP_MAX_OPT_SIZE) {
204 while (remaining > 0) {
205 if (remaining < NMRP_OPT_HDR_LEN) {
209 opt->type = ntohs(opt->type);
210 opt->len = ntohs(opt->len);
212 if (opt->len > NMRP_MAX_OPT_SIZE) {
216 remaining -= opt->len;
217 opt = NMRP_OPT_NEXT(opt);
225 fprintf(stderr, "Unexpected message format.\n");
230 static void *msg_opt_data(struct nmrp_msg *msg, uint16_t type, uint16_t *len)
232 static char buf[128];
233 struct nmrp_opt *opt = msg->opts;
234 int remaining = msg->len - NMRP_HDR_LEN;
236 memset(buf, 0, sizeof(buf));
238 while (remaining > 0) {
239 if (opt->type == type) {
240 if (opt->len == NMRP_OPT_HDR_LEN) {
243 *len = opt->len - NMRP_OPT_HDR_LEN;
244 memcpy(buf, &opt->val, MIN(*len, sizeof(buf)-1));
248 remaining -= opt->len;
249 opt = NMRP_OPT_NEXT(opt);
255 static void msg_opt_add(struct nmrp_msg *msg, uint16_t type, void *data,
259 struct nmrp_opt *opt = msg->opts;
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");
266 for (; i <= msg->num_opts; ++i) {
267 opt = NMRP_OPT_NEXT(opt);
270 opt->len = NMRP_OPT_HDR_LEN + len;
274 memcpy(&opt->val, data, len);
277 msg->len += opt->len;
281 static inline void msg_init(struct nmrp_msg *msg, uint16_t code)
283 memset(msg, 0, sizeof(*msg));
284 msg->len = NMRP_HDR_LEN;
288 static int pkt_send(struct ethsock *sock, struct nmrp_pkt *pkt)
290 size_t len = ntohs(pkt->msg.len) + sizeof(pkt->eh);
291 return ethsock_send(sock, pkt, len);
294 static int pkt_recv(struct ethsock *sock, struct nmrp_pkt *pkt)
298 memset(pkt, 0, sizeof(*pkt));
299 bytes = ethsock_recv(sock, pkt, sizeof(*pkt));
304 } else if (bytes < NMRP_MIN_PKT_LEN) {
305 fprintf(stderr, "Short packet (%d bytes)\n", (int)bytes);
309 msg_hdr_ntoh(&pkt->msg);
310 len = pkt->msg.len + sizeof(pkt->eh);
313 fprintf(stderr, "Short packet (expected %d, got %d).\n",
314 (int)len, (int)bytes);
318 return msg_ntoh(&pkt->msg);
321 static int mac_parse(const char *str, uint8_t *hwaddr)
326 sscanf(str, "%02x:%02x:%02x:%02x:%02x:%02x%n",
327 data, data + 1, data + 2, data + 3, data + 4, data + 5, &i);
329 if (i == strlen(str)) {
330 for (i = 0; i != 6; ++i) {
335 hwaddr[i] = data[i] & 0xff;
345 struct is_valid_ip_arg
347 struct in_addr *ipaddr;
348 struct in_addr *ipmask;
352 static int is_valid_ip_cb(struct ethsock_ip_callback_args *args)
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;
365 static int is_valid_ip(struct ethsock *sock, struct in_addr *ipaddr,
366 struct in_addr *ipmask)
369 struct is_valid_ip_arg arg = {
375 status = ethsock_for_each_ip(sock, is_valid_ip_cb, &arg);
376 return status < 0 ? status : arg.result;
379 static struct ethsock *gsock = NULL;
381 static struct in_addr arpip = { 0 };
382 static uint8_t arpmac[6] = { 0 };
384 static void sigh(int sig)
389 ethsock_arp_del(gsock, arpmac, &arpip);
391 ethsock_close(gsock);
398 static const char *spinner = "\\|/-";
400 int nmrp_do(struct nmrpd_args *args)
402 struct nmrp_pkt tx, rx;
403 uint8_t *src, dest[6];
404 uint16_t len, region;
407 int i, status, ulreqs, expect, upload_ok;
408 struct ethsock *sock;
409 void (*sigh_orig)(int);
415 if (args->op != NMRP_UPLOAD_FW) {
416 fprintf(stderr, "Operation not implemented.\n");
420 if (!mac_parse(args->mac, dest)) {
421 fprintf(stderr, "Invalid MAC address '%s'.\n", args->mac);
425 if ((ipconf.addr.s_addr = inet_addr(args->ipaddr)) == INADDR_NONE) {
426 fprintf(stderr, "Invalid IP address '%s'.\n", args->ipaddr);
430 if ((ipconf.mask.s_addr = inet_addr(args->ipmask)) == INADDR_NONE) {
431 fprintf(stderr, "Invalid subnet mask '%s'.\n", args->ipmask);
435 if (args->file_local && strcmp(args->file_local, "-") && access(args->file_local, R_OK) == -1) {
436 fprintf(stderr, "Error accessing file '%s'.\n", args->file_local);
440 if (args->file_remote) {
441 if (!tftp_is_valid_filename(args->file_remote)) {
442 fprintf(stderr, "Invalid remote filename '%s'.\n",
449 region = htons(to_region_code(args->region));
451 fprintf(stderr, "Invalid region code '%s'.\n", args->region);
460 sock = ethsock_create(args->intf, ETH_P_NMRP);
465 status = is_valid_ip(sock, &ipconf.addr, &ipconf.mask);
468 fprintf(stderr, "Address %s/%s cannot be used on interface %s.\n",
469 args->ipaddr, args->ipmask, args->intf);
476 sigh_orig = signal(SIGINT, sigh);
478 if (ethsock_set_timeout(sock, args->rx_timeout)) {
482 src = ethsock_get_hwaddr(sock);
487 memcpy(tx.eh.ether_shost, src, 6);
488 memcpy(tx.eh.ether_dhost, dest, 6);
489 tx.eh.ether_type = htons(ETH_P_NMRP);
491 msg_init(&tx.msg, NMRP_C_ADVERTISE);
492 msg_opt_add(&tx.msg, NMRP_O_MAGIC_NO, "NTGR", 4);
500 printf("\rAdvertising NMRP server on %s ... %c",
501 args->intf, spinner[i]);
505 if (pkt_send(sock, &tx) < 0) {
510 status = pkt_recv(sock, &rx);
511 if (status == 0 && memcmp(rx.eh.ether_dhost, src, 6) == 0) {
513 } else if (status == 1) {
517 if ((time(NULL) - beg) >= 60) {
518 printf("\nNo response after 60 seconds. Bailing out.\n");
526 expect = NMRP_C_CONF_REQ;
530 if (expect != NMRP_C_NONE && rx.msg.code != expect) {
531 fprintf(stderr, "Received %s while waiting for %s!\n",
532 msg_code_str(rx.msg.code), msg_code_str(expect));
535 msg_init(&tx.msg, NMRP_C_NONE);
539 switch (rx.msg.code) {
540 case NMRP_C_ADVERTISE:
541 printf("Received NMRP advertisement from %s.\n",
542 mac_to_str(rx.eh.ether_shost));
545 case NMRP_C_CONF_REQ:
546 tx.msg.code = NMRP_C_CONF_ACK;
548 msg_opt_add(&tx.msg, NMRP_O_DEV_IP, &ipconf, 8);
549 msg_opt_add(&tx.msg, NMRP_O_FW_UP, NULL, 0);
551 #ifdef NMRPFLASH_SET_REGION
553 msg_opt_add(&tx.msg, NMRP_O_DEV_REGION, ®ion, 2);
557 expect = NMRP_C_TFTP_UL_REQ;
559 printf("Received configuration request from %s.\n",
560 mac_to_str(rx.eh.ether_shost));
562 memcpy(tx.eh.ether_dhost, rx.eh.ether_shost, 6);
564 printf("Sending configuration: ip %s, mask %s.\n",
565 args->ipaddr, args->ipmask);
567 memcpy(arpmac, rx.eh.ether_shost, 6);
568 memcpy(&arpip, &ipconf.addr, sizeof(ipconf.addr));
570 if (ethsock_arp_add(sock, arpmac, &arpip) != 0) {
577 case NMRP_C_TFTP_UL_REQ:
580 printf("Bailing out after %d upload requests.\n",
582 tx.msg.code = NMRP_C_CLOSE_REQ;
587 printf("Ignoring extra upload request.\n");
589 ethsock_set_timeout(sock, args->ul_timeout);
590 tx.msg.code = NMRP_C_KEEP_ALIVE_REQ;
595 filename = msg_opt_data(&rx.msg, NMRP_O_FILE_NAME, &len);
597 if (!args->file_remote) {
598 args->file_remote = filename;
600 printf("Received upload request: filename '%.*s'.\n",
602 } else if (!args->file_remote) {
603 args->file_remote = args->file_local;
604 printf("Received upload request with empty filename.\n");
610 printf("Executing '%s' ... ", args->tftpcmd);
612 status = system(args->tftpcmd);
620 if (!status && args->file_local) {
621 status = is_valid_ip(sock, &ipconf.addr, &ipconf.mask);
624 } else if (!status) {
625 printf("IP address of %s has changed. Please assign a "
626 "static ip to the interface.\n", args->intf);
627 tx.msg.code = NMRP_C_CLOSE_REQ;
632 printf("Using remote filename '%s'.\n",
636 if (!strcmp(args->file_local, "-")) {
637 printf("Uploading from stdin ... ");
639 printf("Uploading %s ... ", leafname(args->file_local));
642 status = tftp_put(args);
646 printf("OK\nWaiting for remote to respond.\n");
648 ethsock_set_timeout(sock, args->ul_timeout);
649 tx.msg.code = NMRP_C_KEEP_ALIVE_REQ;
650 expect = NMRP_C_NONE;
651 } else if (status == -2) {
652 expect = NMRP_C_TFTP_UL_REQ;
658 case NMRP_C_KEEP_ALIVE_REQ:
659 tx.msg.code = NMRP_C_KEEP_ALIVE_ACK;
660 ethsock_set_timeout(sock, 15000);
661 printf("Received keep-alive request.\n");
663 case NMRP_C_CLOSE_REQ:
664 tx.msg.code = NMRP_C_CLOSE_ACK;
666 case NMRP_C_CLOSE_ACK:
670 fprintf(stderr, "Unknown message code 0x%02x!\n",
672 msg_dump(&rx.msg, 0);
675 if (tx.msg.code != NMRP_C_NONE) {
678 if (pkt_send(sock, &tx) < 0) {
684 if (rx.msg.code == NMRP_C_CLOSE_REQ) {
685 printf("Remote finished. Closing connection.\n");
689 status = pkt_recv(sock, &rx);
692 fprintf(stderr, "Timeout while waiting for %s.\n",
693 msg_code_str(expect));
698 ethsock_set_timeout(sock, args->rx_timeout);
705 printf("Reboot your device now.\n");
707 printf("No upload request received.\n");
711 signal(SIGINT, sigh_orig);
713 ethsock_arp_del(sock, arpmac, &arpip);