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_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 2
36 #define ETH_P_NMRP 0x0912
38 #define MAX_LOOP_RECV 1024
41 #define PACKED __attribute__((__packed__))
51 NMRP_C_KEEP_ALIVE_REQ = 6,
52 NMRP_C_KEEP_ALIVE_ACK = 7,
53 NMRP_C_TFTP_UL_REQ = 16
57 NMRP_O_MAGIC_NO = 0x0001,
58 NMRP_O_DEV_IP = 0x0002,
59 NMRP_O_DEV_REGION = 0x0004,
60 NMRP_O_FW_UP = 0x0101,
61 NMRP_O_ST_UP = 0x0102,
62 NMRP_O_FILE_NAME = 0x0181
83 struct nmrp_opt opts[2];
88 uint8_t ether_dhost[6];
89 uint8_t ether_shost[6];
98 static const char *msg_code_str(uint16_t code)
100 #define CASE_CODE(x) case NMRP_C_ ## x: return #x
104 CASE_CODE(ADVERTISE);
107 CASE_CODE(CLOSE_REQ);
108 CASE_CODE(CLOSE_ACK);
109 CASE_CODE(KEEP_ALIVE_REQ);
110 CASE_CODE(KEEP_ALIVE_ACK);
111 CASE_CODE(TFTP_UL_REQ);
113 snprintf(buf, sizeof(buf), "%04x", code);
119 static void msg_update_len(struct nmrp_msg *msg)
122 msg->len = NMRP_HDR_LEN;
123 for (; i != msg->num_opts; ++i) {
124 msg->len += msg->opts[i].len;
128 static void msg_dump(struct nmrp_msg *msg, int dump_opts)
130 struct nmrp_opt *opt;
131 int remain_len, len, i;
133 fprintf(stderr, "res=0x%04x, code=0x%02x, id=0x%02x, len=%u",
134 msg->reserved, msg->code, msg->id, msg->len);
136 remain_len = msg->len - NMRP_HDR_LEN;
137 fprintf(stderr, "%s\n", remain_len ? "" : " (no opts)");
142 while (remain_len > 0) {
144 fprintf(stderr, " opt type=%u, len=%u", opt->type, len);
145 for (i = 0; i != len - NMRP_OPT_LEN; ++i) {
147 fprintf(stderr, "\n ");
150 fprintf(stderr, "%02x ", ((char*)&opt->val)[i] & 0xff);
152 fprintf(stderr, "\n");
154 opt = (struct nmrp_opt*)(((char*)opt) + len);
159 static void msg_hton(struct nmrp_msg *msg)
163 msg->reserved = htons(msg->reserved);
164 msg->len = htons(msg->len);
166 for (; i != msg->num_opts; ++i) {
167 msg->opts[i].len = htons(msg->opts[i].len);
168 msg->opts[i].type = htons(msg->opts[i].type);
172 static void msg_hdr_ntoh(struct nmrp_msg *msg)
174 msg->reserved = ntohs(msg->reserved);
175 msg->len = ntohs(msg->len);
178 static int msg_ntoh(struct nmrp_msg *msg)
180 struct nmrp_opt *opt = msg->opts;
183 remaining = msg->len - NMRP_HDR_LEN;
185 // FIXME maximum of two options supported, maximum option
187 if (remaining < NMRP_MAX_OPT_NUM * NMRP_MAX_OPT_SIZE) {
188 while (remaining > 0) {
189 if (remaining < NMRP_OPT_LEN) {
193 opt->type = ntohs(opt->type);
194 opt->len = ntohs(opt->len);
196 if (opt->len > NMRP_MAX_OPT_SIZE) {
200 remaining -= opt->len;
209 fprintf(stderr, "Unexpected message format.\n");
214 static void *msg_opt_data(struct nmrp_msg *msg, int type, uint16_t *len)
216 struct nmrp_opt *opt = msg->opts;
217 int remaining = msg->len - NMRP_HDR_LEN;
219 while (remaining > 0) {
220 if (opt->type == type) {
221 *len = opt->len - NMRP_OPT_LEN;
222 return (char*)&opt->val;
225 remaining -= opt->len;
226 opt = (struct nmrp_opt*)((char*)opt) + opt->len;
232 static int pkt_send(struct ethsock *sock, struct nmrp_pkt *pkt)
234 size_t len = ntohs(pkt->msg.len) + sizeof(pkt->eh);
235 return ethsock_send(sock, pkt, len);
238 static int pkt_recv(struct ethsock *sock, struct nmrp_pkt *pkt)
242 memset(pkt, 0, sizeof(*pkt));
243 bytes = ethsock_recv(sock, pkt, sizeof(*pkt));
248 } else if (bytes < NMRP_MIN_PKT_LEN) {
249 fprintf(stderr, "Short packet (%d bytes)\n", (int)bytes);
253 msg_hdr_ntoh(&pkt->msg);
254 len = pkt->msg.len + sizeof(pkt->eh);
257 fprintf(stderr, "Short packet (expected %d, got %d).\n",
258 (int)len, (int)bytes);
262 return msg_ntoh(&pkt->msg);
265 static int mac_parse(const char *str, uint8_t *hwaddr)
270 sscanf(str, "%02x:%02x:%02x:%02x:%02x:%02x%n",
271 data, data + 1, data + 2, data + 3, data + 4, data + 5, &i);
273 if (i == strlen(str)) {
274 for (i = 0; i != 6; ++i) {
279 hwaddr[i] = data[i] & 0xff;
289 struct is_valid_ip_arg
291 struct in_addr *ipaddr;
292 struct in_addr *ipmask;
296 static int is_valid_ip_cb(struct ethsock_ip_callback_args *args)
298 #define SUBNET(x) ((x)->ipaddr->s_addr & (x)->ipmask->s_addr)
299 struct is_valid_ip_arg *arg = args->arg;
300 if (SUBNET(args) == SUBNET(arg)) {
301 arg->result = args->ipaddr->s_addr != arg->ipaddr->s_addr;
309 static int is_valid_ip(struct ethsock *sock, struct in_addr *ipaddr,
310 struct in_addr *ipmask)
313 struct is_valid_ip_arg arg = {
319 status = ethsock_for_each_ip(sock, is_valid_ip_cb, &arg);
320 return status < 0 ? status : arg.result;
323 static struct ethsock *gsock = NULL;
325 static void sigh(int sig)
329 ethsock_close(gsock);
335 static const char *spinner = "\\|/-";
337 int nmrp_do(struct nmrpd_args *args)
339 struct nmrp_pkt tx, rx;
340 uint8_t *src, dest[6];
343 struct in_addr ipaddr, ipmask;
345 int i, status, ulreqs, expect;
346 struct ethsock *sock;
347 void (*sigh_orig)(int);
349 if (args->op != NMRP_UPLOAD_FW) {
350 fprintf(stderr, "Operation not implemented.\n");
354 if (!mac_parse(args->mac, dest)) {
355 fprintf(stderr, "Invalid MAC address '%s'.\n", args->mac);
359 if ((ipaddr.s_addr = inet_addr(args->ipaddr)) == INADDR_NONE) {
360 fprintf(stderr, "Invalid IP address '%s'.\n", args->ipaddr);
364 if ((ipmask.s_addr = inet_addr(args->ipmask)) == INADDR_NONE) {
365 fprintf(stderr, "Invalid subnet mask '%s'.\n", args->ipmask);
369 if (strcmp(args->file_local, "-") && access(args->file_local, R_OK) == -1) {
370 fprintf(stderr, "Error accessing file '%s'.\n", args->file_local);
374 if (args->file_remote) {
375 if (!tftp_is_valid_filename(args->file_remote)) {
376 fprintf(stderr, "Invalid remote filename '%s'.\n",
384 sock = ethsock_create(args->intf, ETH_P_NMRP);
389 status = is_valid_ip(sock, &ipaddr, &ipmask);
392 fprintf(stderr, "Address %s/%s cannot be used on interface %s.\n",
393 args->ipaddr, args->ipmask, args->intf);
399 sigh_orig = signal(SIGINT, sigh);
401 if (ethsock_set_timeout(sock, args->rx_timeout)) {
405 src = ethsock_get_hwaddr(sock);
410 memcpy(tx.eh.ether_shost, src, 6);
411 memcpy(tx.eh.ether_dhost, dest, 6);
412 tx.eh.ether_type = htons(ETH_P_NMRP);
415 tx.msg.code = NMRP_C_ADVERTISE;
418 tx.msg.opts[0].type = NMRP_O_MAGIC_NO;
419 tx.msg.opts[0].len = NMRP_OPT_LEN + 4;
420 tx.msg.opts[0].val.magic[0] = 'N';
421 tx.msg.opts[0].val.magic[1] = 'T';
422 tx.msg.opts[0].val.magic[2] = 'G';
423 tx.msg.opts[0].val.magic[3] = 'R';
425 msg_update_len(&tx.msg);
432 printf("\rAdvertising NMRP server on %s ... %c",
433 args->intf, spinner[i]);
437 if (pkt_send(sock, &tx) < 0) {
442 status = pkt_recv(sock, &rx);
443 if (status == 0 && memcmp(rx.eh.ether_dhost, src, 6) == 0) {
445 } else if (status == 1) {
449 if ((time(NULL) - beg) >= 60) {
450 printf("\nNo response after 60 seconds. Bailing out.\n");
458 expect = NMRP_C_CONF_REQ;
462 if (expect != NMRP_C_NONE && rx.msg.code != expect) {
463 fprintf(stderr, "Received %s while waiting for %s!\n",
464 msg_code_str(rx.msg.code), msg_code_str(expect));
467 tx.msg.code = NMRP_C_NONE;
475 switch (rx.msg.code) {
476 case NMRP_C_ADVERTISE:
477 printf("Received NMRP advertisement from %s.\n",
478 mac_to_str(rx.eh.ether_shost));
481 case NMRP_C_CONF_REQ:
482 tx.msg.code = NMRP_C_CONF_ACK;
485 tx.msg.opts[0].type = NMRP_O_DEV_IP;
486 tx.msg.opts[0].len = NMRP_OPT_LEN + 2 * 4;
488 memcpy(tx.msg.opts[0].val.ip.addr, &ipaddr, 4);
489 memcpy(tx.msg.opts[0].val.ip.mask, &ipmask, 4);
491 tx.msg.opts[1].type = NMRP_O_FW_UP;
492 tx.msg.opts[1].len = NMRP_OPT_LEN;
494 #ifdef NMRPFLASH_SET_REGION
497 tx.msg.opts[2].type = NMRP_O_DEV_REGION;
498 tx.msg.opts[2].len = NMRP_OPT_LEN + 2;
499 tx.msg.opts[2].val.region = args->region;
502 expect = NMRP_C_TFTP_UL_REQ;
504 printf("Received configuration request from %s.\n",
505 mac_to_str(rx.eh.ether_shost));
507 memcpy(tx.eh.ether_dhost, rx.eh.ether_shost, 6);
509 printf("Sending configuration: ip %s, mask %s.\n",
510 args->ipaddr, args->ipmask);
513 case NMRP_C_TFTP_UL_REQ:
515 fprintf(stderr, "Device re-requested file upload %d "
516 "times; aborting.\n", ulreqs);
517 tx.msg.code = NMRP_C_CLOSE_REQ;
522 filename = msg_opt_data(&rx.msg, NMRP_O_FILE_NAME, &len);
524 if (!args->file_remote) {
525 args->file_remote = filename;
527 printf("Received upload request: filename '%.*s'.\n",
529 } else if (!args->file_remote) {
530 if (tftp_is_valid_filename(args->file_local)) {
531 args->file_remote = args->file_local;
533 args->file_remote = "firmware";
535 printf("Received upload request with empty filename.");
541 printf("Executing '%s' ... ", args->tftpcmd);
543 status = system(args->tftpcmd);
551 if (!status && args->file_local) {
552 status = is_valid_ip(sock, &ipaddr, &ipmask);
555 } else if (!status) {
556 printf("IP address of %s has changed. Please assign a "
557 "static ip to the interface.\n", args->intf);
558 tx.msg.code = NMRP_C_CLOSE_REQ;
563 printf("Using remote filename '%s'.\n",
567 if (!strcmp(args->file_local, "-")) {
568 printf("Uploading from stdin ... ");
570 printf("Uploading %s ... ", args->file_local);
573 status = tftp_put(args);
577 printf("OK\nWaiting for remote to respond.\n");
578 ethsock_set_timeout(sock, args->ul_timeout);
579 expect = NMRP_C_CLOSE_REQ;
580 } else if (status == -2) {
581 expect = NMRP_C_TFTP_UL_REQ;
587 case NMRP_C_KEEP_ALIVE_REQ:
588 tx.msg.code = NMRP_C_KEEP_ALIVE_ACK;
589 ethsock_set_timeout(sock, 15000);
590 printf("Received keep-alive request.\n");
592 case NMRP_C_CLOSE_REQ:
593 tx.msg.code = NMRP_C_CLOSE_ACK;
595 case NMRP_C_CLOSE_ACK:
599 fprintf(stderr, "Unknown message code 0x%02x!\n",
601 msg_dump(&rx.msg, 0);
604 if (tx.msg.code != NMRP_C_NONE) {
605 msg_update_len(&tx.msg);
608 if (pkt_send(sock, &tx) < 0) {
614 if (rx.msg.code == NMRP_C_CLOSE_REQ) {
615 printf("Remote finished. Closing connection.\n");
619 status = pkt_recv(sock, &rx);
622 fprintf(stderr, "Timeout while waiting for %s.\n",
623 msg_code_str(expect));
628 ethsock_set_timeout(sock, args->rx_timeout);
634 printf("Reboot your device now.\n");
637 signal(SIGINT, sigh_orig);