MyMesh.cpp 44 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201
  1. #include "MyMesh.h"
  2. #include <algorithm>
  3. /* ------------------------------ Config -------------------------------- */
  4. #ifndef LORA_FREQ
  5. #define LORA_FREQ 915.0
  6. #endif
  7. #ifndef LORA_BW
  8. #define LORA_BW 250
  9. #endif
  10. #ifndef LORA_SF
  11. #define LORA_SF 10
  12. #endif
  13. #ifndef LORA_CR
  14. #define LORA_CR 5
  15. #endif
  16. #ifndef LORA_TX_POWER
  17. #define LORA_TX_POWER 20
  18. #endif
  19. #ifndef ADVERT_NAME
  20. #define ADVERT_NAME "repeater"
  21. #endif
  22. #ifndef ADVERT_LAT
  23. #define ADVERT_LAT 0.0
  24. #endif
  25. #ifndef ADVERT_LON
  26. #define ADVERT_LON 0.0
  27. #endif
  28. #ifndef ADMIN_PASSWORD
  29. #define ADMIN_PASSWORD "password"
  30. #endif
  31. #ifndef SERVER_RESPONSE_DELAY
  32. #define SERVER_RESPONSE_DELAY 300
  33. #endif
  34. #ifndef TXT_ACK_DELAY
  35. #define TXT_ACK_DELAY 200
  36. #endif
  37. #define FIRMWARE_VER_LEVEL 2
  38. #define REQ_TYPE_GET_STATUS 0x01 // same as _GET_STATS
  39. #define REQ_TYPE_KEEP_ALIVE 0x02
  40. #define REQ_TYPE_GET_TELEMETRY_DATA 0x03
  41. #define REQ_TYPE_GET_ACCESS_LIST 0x05
  42. #define REQ_TYPE_GET_NEIGHBOURS 0x06
  43. #define REQ_TYPE_GET_OWNER_INFO 0x07 // FIRMWARE_VER_LEVEL >= 2
  44. #define RESP_SERVER_LOGIN_OK 0 // response to ANON_REQ
  45. #define ANON_REQ_TYPE_REGIONS 0x01
  46. #define ANON_REQ_TYPE_OWNER 0x02
  47. #define ANON_REQ_TYPE_BASIC 0x03 // just remote clock
  48. #define CLI_REPLY_DELAY_MILLIS 600
  49. #define LAZY_CONTACTS_WRITE_DELAY 5000
  50. void MyMesh::putNeighbour(const mesh::Identity &id, uint32_t timestamp, float snr) {
  51. #if MAX_NEIGHBOURS // check if neighbours enabled
  52. // find existing neighbour, else use least recently updated
  53. uint32_t oldest_timestamp = 0xFFFFFFFF;
  54. NeighbourInfo *neighbour = &neighbours[0];
  55. for (int i = 0; i < MAX_NEIGHBOURS; i++) {
  56. // if neighbour already known, we should update it
  57. if (id.matches(neighbours[i].id)) {
  58. neighbour = &neighbours[i];
  59. break;
  60. }
  61. // otherwise we should update the least recently updated neighbour
  62. if (neighbours[i].heard_timestamp < oldest_timestamp) {
  63. neighbour = &neighbours[i];
  64. oldest_timestamp = neighbour->heard_timestamp;
  65. }
  66. }
  67. // update neighbour info
  68. neighbour->id = id;
  69. neighbour->advert_timestamp = timestamp;
  70. neighbour->heard_timestamp = getRTCClock()->getCurrentTime();
  71. neighbour->snr = (int8_t)(snr * 4);
  72. #endif
  73. }
  74. uint8_t MyMesh::handleLoginReq(const mesh::Identity& sender, const uint8_t* secret, uint32_t sender_timestamp, const uint8_t* data, bool is_flood) {
  75. ClientInfo* client = NULL;
  76. if (data[0] == 0) { // blank password, just check if sender is in ACL
  77. client = acl.getClient(sender.pub_key, PUB_KEY_SIZE);
  78. if (client == NULL) {
  79. #if MESH_DEBUG
  80. MESH_DEBUG_PRINTLN("Login, sender not in ACL");
  81. #endif
  82. }
  83. }
  84. if (client == NULL) {
  85. uint8_t perms;
  86. if (strcmp((char *)data, _prefs.password) == 0) { // check for valid admin password
  87. perms = PERM_ACL_ADMIN;
  88. } else if (strcmp((char *)data, _prefs.guest_password) == 0) { // check guest password
  89. perms = PERM_ACL_GUEST;
  90. } else {
  91. #if MESH_DEBUG
  92. MESH_DEBUG_PRINTLN("Invalid password: %s", data);
  93. #endif
  94. return 0;
  95. }
  96. client = acl.putClient(sender, 0); // add to contacts (if not already known)
  97. if (sender_timestamp <= client->last_timestamp) {
  98. MESH_DEBUG_PRINTLN("Possible login replay attack!");
  99. return 0; // FATAL: client table is full -OR- replay attack
  100. }
  101. MESH_DEBUG_PRINTLN("Login success!");
  102. client->last_timestamp = sender_timestamp;
  103. client->last_activity = getRTCClock()->getCurrentTime();
  104. client->permissions &= ~0x03;
  105. client->permissions |= perms;
  106. memcpy(client->shared_secret, secret, PUB_KEY_SIZE);
  107. if (perms != PERM_ACL_GUEST) { // keep number of FS writes to a minimum
  108. dirty_contacts_expiry = futureMillis(LAZY_CONTACTS_WRITE_DELAY);
  109. }
  110. }
  111. if (is_flood) {
  112. client->out_path_len = -1; // need to rediscover out_path
  113. }
  114. uint32_t now = getRTCClock()->getCurrentTimeUnique();
  115. memcpy(reply_data, &now, 4); // response packets always prefixed with timestamp
  116. reply_data[4] = RESP_SERVER_LOGIN_OK;
  117. reply_data[5] = 0; // Legacy: was recommended keep-alive interval (secs / 16)
  118. reply_data[6] = client->isAdmin() ? 1 : 0;
  119. reply_data[7] = client->permissions;
  120. getRNG()->random(&reply_data[8], 4); // random blob to help packet-hash uniqueness
  121. reply_data[12] = FIRMWARE_VER_LEVEL; // New field
  122. return 13; // reply length
  123. }
  124. uint8_t MyMesh::handleAnonRegionsReq(const mesh::Identity& sender, uint32_t sender_timestamp, const uint8_t* data) {
  125. if (anon_limiter.allow(rtc_clock.getCurrentTime())) {
  126. // request data has: {reply-path-len}{reply-path}
  127. reply_path_len = *data++ & 0x3F;
  128. memcpy(reply_path, data, reply_path_len);
  129. // data += reply_path_len;
  130. memcpy(reply_data, &sender_timestamp, 4); // prefix with sender_timestamp, like a tag
  131. uint32_t now = getRTCClock()->getCurrentTime();
  132. memcpy(&reply_data[4], &now, 4); // include our clock (for easy clock sync, and packet hash uniqueness)
  133. return 8 + region_map.exportNamesTo((char *) &reply_data[8], sizeof(reply_data) - 12, REGION_DENY_FLOOD); // reply length
  134. }
  135. return 0;
  136. }
  137. uint8_t MyMesh::handleAnonOwnerReq(const mesh::Identity& sender, uint32_t sender_timestamp, const uint8_t* data) {
  138. if (anon_limiter.allow(rtc_clock.getCurrentTime())) {
  139. // request data has: {reply-path-len}{reply-path}
  140. reply_path_len = *data++ & 0x3F;
  141. memcpy(reply_path, data, reply_path_len);
  142. // data += reply_path_len;
  143. memcpy(reply_data, &sender_timestamp, 4); // prefix with sender_timestamp, like a tag
  144. uint32_t now = getRTCClock()->getCurrentTime();
  145. memcpy(&reply_data[4], &now, 4); // include our clock (for easy clock sync, and packet hash uniqueness)
  146. sprintf((char *) &reply_data[8], "%s\n%s", _prefs.node_name, _prefs.owner_info);
  147. return 8 + strlen((char *) &reply_data[8]); // reply length
  148. }
  149. return 0;
  150. }
  151. uint8_t MyMesh::handleAnonClockReq(const mesh::Identity& sender, uint32_t sender_timestamp, const uint8_t* data) {
  152. if (anon_limiter.allow(rtc_clock.getCurrentTime())) {
  153. // request data has: {reply-path-len}{reply-path}
  154. reply_path_len = *data++ & 0x3F;
  155. memcpy(reply_path, data, reply_path_len);
  156. // data += reply_path_len;
  157. memcpy(reply_data, &sender_timestamp, 4); // prefix with sender_timestamp, like a tag
  158. uint32_t now = getRTCClock()->getCurrentTime();
  159. memcpy(&reply_data[4], &now, 4); // include our clock (for easy clock sync, and packet hash uniqueness)
  160. reply_data[8] = 0; // features
  161. #ifdef WITH_RS232_BRIDGE
  162. reply_data[8] |= 0x01; // is bridge, type UART
  163. #elif WITH_ESPNOW_BRIDGE
  164. reply_data[8] |= 0x03; // is bridge, type ESP-NOW
  165. #endif
  166. if (_prefs.disable_fwd) { // is this repeater currently disabled
  167. reply_data[8] |= 0x80; // is disabled
  168. }
  169. // TODO: add some kind of moving-window utilisation metric, so can query 'how busy' is this repeater
  170. return 9; // reply length
  171. }
  172. return 0;
  173. }
  174. int MyMesh::handleRequest(ClientInfo *sender, uint32_t sender_timestamp, uint8_t *payload, size_t payload_len) {
  175. // uint32_t now = getRTCClock()->getCurrentTimeUnique();
  176. // memcpy(reply_data, &now, 4); // response packets always prefixed with timestamp
  177. memcpy(reply_data, &sender_timestamp, 4); // reflect sender_timestamp back in response packet (kind of like a 'tag')
  178. if (payload[0] == REQ_TYPE_GET_STATUS) { // guests can also access this now
  179. RepeaterStats stats;
  180. stats.batt_milli_volts = board.getBattMilliVolts();
  181. stats.curr_tx_queue_len = _mgr->getOutboundCount(0xFFFFFFFF);
  182. stats.noise_floor = (int16_t)_radio->getNoiseFloor();
  183. stats.last_rssi = (int16_t)radio_driver.getLastRSSI();
  184. stats.n_packets_recv = radio_driver.getPacketsRecv();
  185. stats.n_packets_sent = radio_driver.getPacketsSent();
  186. stats.total_air_time_secs = getTotalAirTime() / 1000;
  187. stats.total_up_time_secs = uptime_millis / 1000;
  188. stats.n_sent_flood = getNumSentFlood();
  189. stats.n_sent_direct = getNumSentDirect();
  190. stats.n_recv_flood = getNumRecvFlood();
  191. stats.n_recv_direct = getNumRecvDirect();
  192. stats.err_events = _err_flags;
  193. stats.last_snr = (int16_t)(radio_driver.getLastSNR() * 4);
  194. stats.n_direct_dups = ((SimpleMeshTables *)getTables())->getNumDirectDups();
  195. stats.n_flood_dups = ((SimpleMeshTables *)getTables())->getNumFloodDups();
  196. stats.total_rx_air_time_secs = getReceiveAirTime() / 1000;
  197. memcpy(&reply_data[4], &stats, sizeof(stats));
  198. return 4 + sizeof(stats); // reply_len
  199. }
  200. if (payload[0] == REQ_TYPE_GET_TELEMETRY_DATA) {
  201. uint8_t perm_mask = ~(payload[1]); // NEW: first reserved byte (of 4), is now inverse mask to apply to permissions
  202. telemetry.reset();
  203. telemetry.addVoltage(TELEM_CHANNEL_SELF, (float)board.getBattMilliVolts() / 1000.0f);
  204. // query other sensors -- target specific
  205. if ((sender->permissions & PERM_ACL_ROLE_MASK) == PERM_ACL_GUEST) {
  206. perm_mask = 0x00; // just base telemetry allowed
  207. }
  208. sensors.querySensors(perm_mask, telemetry);
  209. // This default temperature will be overridden by external sensors (if any)
  210. float temperature = board.getMCUTemperature();
  211. if(!isnan(temperature)) { // Supported boards with built-in temperature sensor. ESP32-C3 may return NAN
  212. telemetry.addTemperature(TELEM_CHANNEL_SELF, temperature); // Built-in MCU Temperature
  213. }
  214. uint8_t tlen = telemetry.getSize();
  215. memcpy(&reply_data[4], telemetry.getBuffer(), tlen);
  216. return 4 + tlen; // reply_len
  217. }
  218. if (payload[0] == REQ_TYPE_GET_ACCESS_LIST && sender->isAdmin()) {
  219. uint8_t res1 = payload[1]; // reserved for future (extra query params)
  220. uint8_t res2 = payload[2];
  221. if (res1 == 0 && res2 == 0) {
  222. uint8_t ofs = 4;
  223. for (int i = 0; i < acl.getNumClients() && ofs + 7 <= sizeof(reply_data) - 4; i++) {
  224. auto c = acl.getClientByIdx(i);
  225. if (c->permissions == 0) continue; // skip deleted entries
  226. memcpy(&reply_data[ofs], c->id.pub_key, 6); ofs += 6; // just 6-byte pub_key prefix
  227. reply_data[ofs++] = c->permissions;
  228. }
  229. return ofs;
  230. }
  231. }
  232. if (payload[0] == REQ_TYPE_GET_NEIGHBOURS) {
  233. uint8_t request_version = payload[1];
  234. if (request_version == 0) {
  235. // reply data offset (after response sender_timestamp/tag)
  236. int reply_offset = 4;
  237. // get request params
  238. uint8_t count = payload[2]; // how many neighbours to fetch (0-255)
  239. uint16_t offset;
  240. memcpy(&offset, &payload[3], 2); // offset from start of neighbours list (0-65535)
  241. uint8_t order_by = payload[5]; // how to order neighbours. 0=newest_to_oldest, 1=oldest_to_newest, 2=strongest_to_weakest, 3=weakest_to_strongest
  242. uint8_t pubkey_prefix_length = payload[6]; // how many bytes of neighbour pub key we want
  243. // we also send a 4 byte random blob in payload[7...10] to help packet uniqueness
  244. MESH_DEBUG_PRINTLN("REQ_TYPE_GET_NEIGHBOURS count=%d, offset=%d, order_by=%d, pubkey_prefix_length=%d", count, offset, order_by, pubkey_prefix_length);
  245. // clamp pub key prefix length to max pub key length
  246. if(pubkey_prefix_length > PUB_KEY_SIZE){
  247. pubkey_prefix_length = PUB_KEY_SIZE;
  248. MESH_DEBUG_PRINTLN("REQ_TYPE_GET_NEIGHBOURS invalid pubkey_prefix_length=%d clamping to %d", pubkey_prefix_length, PUB_KEY_SIZE);
  249. }
  250. // create copy of neighbours list, skipping empty entries so we can sort it separately from main list
  251. int16_t neighbours_count = 0;
  252. NeighbourInfo* sorted_neighbours[MAX_NEIGHBOURS];
  253. for (int i = 0; i < MAX_NEIGHBOURS; i++) {
  254. auto neighbour = &neighbours[i];
  255. if (neighbour->heard_timestamp > 0) {
  256. sorted_neighbours[neighbours_count] = neighbour;
  257. neighbours_count++;
  258. }
  259. }
  260. // sort neighbours based on order
  261. if (order_by == 0) {
  262. // sort by newest to oldest
  263. MESH_DEBUG_PRINTLN("REQ_TYPE_GET_NEIGHBOURS sorting newest to oldest");
  264. std::sort(sorted_neighbours, sorted_neighbours + neighbours_count, [](const NeighbourInfo* a, const NeighbourInfo* b) {
  265. return a->heard_timestamp > b->heard_timestamp; // desc
  266. });
  267. } else if (order_by == 1) {
  268. // sort by oldest to newest
  269. MESH_DEBUG_PRINTLN("REQ_TYPE_GET_NEIGHBOURS sorting oldest to newest");
  270. std::sort(sorted_neighbours, sorted_neighbours + neighbours_count, [](const NeighbourInfo* a, const NeighbourInfo* b) {
  271. return a->heard_timestamp < b->heard_timestamp; // asc
  272. });
  273. } else if (order_by == 2) {
  274. // sort by strongest to weakest
  275. MESH_DEBUG_PRINTLN("REQ_TYPE_GET_NEIGHBOURS sorting strongest to weakest");
  276. std::sort(sorted_neighbours, sorted_neighbours + neighbours_count, [](const NeighbourInfo* a, const NeighbourInfo* b) {
  277. return a->snr > b->snr; // desc
  278. });
  279. } else if (order_by == 3) {
  280. // sort by weakest to strongest
  281. MESH_DEBUG_PRINTLN("REQ_TYPE_GET_NEIGHBOURS sorting weakest to strongest");
  282. std::sort(sorted_neighbours, sorted_neighbours + neighbours_count, [](const NeighbourInfo* a, const NeighbourInfo* b) {
  283. return a->snr < b->snr; // asc
  284. });
  285. }
  286. // build results buffer
  287. int results_count = 0;
  288. int results_offset = 0;
  289. uint8_t results_buffer[130];
  290. for(int index = 0; index < count && index + offset < neighbours_count; index++){
  291. // stop if we can't fit another entry in results
  292. int entry_size = pubkey_prefix_length + 4 + 1;
  293. if(results_offset + entry_size > sizeof(results_buffer)){
  294. MESH_DEBUG_PRINTLN("REQ_TYPE_GET_NEIGHBOURS no more entries can fit in results buffer");
  295. break;
  296. }
  297. // add next neighbour to results
  298. auto neighbour = sorted_neighbours[index + offset];
  299. uint32_t heard_seconds_ago = getRTCClock()->getCurrentTime() - neighbour->heard_timestamp;
  300. memcpy(&results_buffer[results_offset], neighbour->id.pub_key, pubkey_prefix_length); results_offset += pubkey_prefix_length;
  301. memcpy(&results_buffer[results_offset], &heard_seconds_ago, 4); results_offset += 4;
  302. memcpy(&results_buffer[results_offset], &neighbour->snr, 1); results_offset += 1;
  303. results_count++;
  304. }
  305. // build reply
  306. MESH_DEBUG_PRINTLN("REQ_TYPE_GET_NEIGHBOURS neighbours_count=%d results_count=%d", neighbours_count, results_count);
  307. memcpy(&reply_data[reply_offset], &neighbours_count, 2); reply_offset += 2;
  308. memcpy(&reply_data[reply_offset], &results_count, 2); reply_offset += 2;
  309. memcpy(&reply_data[reply_offset], &results_buffer, results_offset); reply_offset += results_offset;
  310. return reply_offset;
  311. }
  312. } else if (payload[0] == REQ_TYPE_GET_OWNER_INFO) {
  313. sprintf((char *) &reply_data[4], "%s\n%s\n%s", FIRMWARE_VERSION, _prefs.node_name, _prefs.owner_info);
  314. return 4 + strlen((char *) &reply_data[4]);
  315. }
  316. return 0; // unknown command
  317. }
  318. mesh::Packet *MyMesh::createSelfAdvert() {
  319. uint8_t app_data[MAX_ADVERT_DATA_SIZE];
  320. uint8_t app_data_len = _cli.buildAdvertData(ADV_TYPE_REPEATER, app_data);
  321. return createAdvert(self_id, app_data, app_data_len);
  322. }
  323. File MyMesh::openAppend(const char *fname) {
  324. #if defined(NRF52_PLATFORM) || defined(STM32_PLATFORM)
  325. return _fs->open(fname, FILE_O_WRITE);
  326. #elif defined(RP2040_PLATFORM)
  327. return _fs->open(fname, "a");
  328. #else
  329. return _fs->open(fname, "a", true);
  330. #endif
  331. }
  332. bool MyMesh::allowPacketForward(const mesh::Packet *packet) {
  333. if (_prefs.disable_fwd) return false;
  334. if (packet->isRouteFlood() && packet->path_len >= _prefs.flood_max) return false;
  335. if (packet->isRouteFlood() && recv_pkt_region == NULL) {
  336. MESH_DEBUG_PRINTLN("allowPacketForward: unknown transport code, or wildcard not allowed for FLOOD packet");
  337. return false;
  338. }
  339. return true;
  340. }
  341. const char *MyMesh::getLogDateTime() {
  342. static char tmp[32];
  343. uint32_t now = getRTCClock()->getCurrentTime();
  344. DateTime dt = DateTime(now);
  345. sprintf(tmp, "%02d:%02d:%02d - %d/%d/%d U", dt.hour(), dt.minute(), dt.second(), dt.day(), dt.month(),
  346. dt.year());
  347. return tmp;
  348. }
  349. void MyMesh::logRxRaw(float snr, float rssi, const uint8_t raw[], int len) {
  350. #if MESH_PACKET_LOGGING
  351. Serial.print(getLogDateTime());
  352. Serial.print(" RAW: ");
  353. mesh::Utils::printHex(Serial, raw, len);
  354. Serial.println();
  355. #endif
  356. }
  357. void MyMesh::logRx(mesh::Packet *pkt, int len, float score) {
  358. #ifdef WITH_BRIDGE
  359. if (_prefs.bridge_pkt_src == 1) {
  360. bridge.sendPacket(pkt);
  361. }
  362. #endif
  363. if (_logging) {
  364. File f = openAppend(PACKET_LOG_FILE);
  365. if (f) {
  366. f.print(getLogDateTime());
  367. f.printf(": RX, len=%d (type=%d, route=%s, payload_len=%d) SNR=%d RSSI=%d score=%d", len,
  368. pkt->getPayloadType(), pkt->isRouteDirect() ? "D" : "F", pkt->payload_len,
  369. (int)_radio->getLastSNR(), (int)_radio->getLastRSSI(), (int)(score * 1000));
  370. if (pkt->getPayloadType() == PAYLOAD_TYPE_PATH || pkt->getPayloadType() == PAYLOAD_TYPE_REQ ||
  371. pkt->getPayloadType() == PAYLOAD_TYPE_RESPONSE || pkt->getPayloadType() == PAYLOAD_TYPE_TXT_MSG) {
  372. f.printf(" [%02X -> %02X]\n", (uint32_t)pkt->payload[1], (uint32_t)pkt->payload[0]);
  373. } else {
  374. f.printf("\n");
  375. }
  376. f.close();
  377. }
  378. }
  379. }
  380. void MyMesh::logTx(mesh::Packet *pkt, int len) {
  381. #ifdef WITH_BRIDGE
  382. if (_prefs.bridge_pkt_src == 0) {
  383. bridge.sendPacket(pkt);
  384. }
  385. #endif
  386. if (_logging) {
  387. File f = openAppend(PACKET_LOG_FILE);
  388. if (f) {
  389. f.print(getLogDateTime());
  390. f.printf(": TX, len=%d (type=%d, route=%s, payload_len=%d)", len, pkt->getPayloadType(),
  391. pkt->isRouteDirect() ? "D" : "F", pkt->payload_len);
  392. if (pkt->getPayloadType() == PAYLOAD_TYPE_PATH || pkt->getPayloadType() == PAYLOAD_TYPE_REQ ||
  393. pkt->getPayloadType() == PAYLOAD_TYPE_RESPONSE || pkt->getPayloadType() == PAYLOAD_TYPE_TXT_MSG) {
  394. f.printf(" [%02X -> %02X]\n", (uint32_t)pkt->payload[1], (uint32_t)pkt->payload[0]);
  395. } else {
  396. f.printf("\n");
  397. }
  398. f.close();
  399. }
  400. }
  401. }
  402. void MyMesh::logTxFail(mesh::Packet *pkt, int len) {
  403. if (_logging) {
  404. File f = openAppend(PACKET_LOG_FILE);
  405. if (f) {
  406. f.print(getLogDateTime());
  407. f.printf(": TX FAIL!, len=%d (type=%d, route=%s, payload_len=%d)\n", len, pkt->getPayloadType(),
  408. pkt->isRouteDirect() ? "D" : "F", pkt->payload_len);
  409. f.close();
  410. }
  411. }
  412. }
  413. int MyMesh::calcRxDelay(float score, uint32_t air_time) const {
  414. if (_prefs.rx_delay_base <= 0.0f) return 0;
  415. return (int)((pow(_prefs.rx_delay_base, 0.85f - score) - 1.0) * air_time);
  416. }
  417. uint32_t MyMesh::getRetransmitDelay(const mesh::Packet *packet) {
  418. uint32_t t = (_radio->getEstAirtimeFor(packet->path_len + packet->payload_len + 2) * _prefs.tx_delay_factor);
  419. return getRNG()->nextInt(0, 5*t + 1);
  420. }
  421. uint32_t MyMesh::getDirectRetransmitDelay(const mesh::Packet *packet) {
  422. uint32_t t = (_radio->getEstAirtimeFor(packet->path_len + packet->payload_len + 2) * _prefs.direct_tx_delay_factor);
  423. return getRNG()->nextInt(0, 5*t + 1);
  424. }
  425. bool MyMesh::filterRecvFloodPacket(mesh::Packet* pkt) {
  426. // just try to determine region for packet (apply later in allowPacketForward())
  427. if (pkt->getRouteType() == ROUTE_TYPE_TRANSPORT_FLOOD) {
  428. recv_pkt_region = region_map.findMatch(pkt, REGION_DENY_FLOOD);
  429. } else if (pkt->getRouteType() == ROUTE_TYPE_FLOOD) {
  430. if (region_map.getWildcard().flags & REGION_DENY_FLOOD) {
  431. recv_pkt_region = NULL;
  432. } else {
  433. recv_pkt_region = &region_map.getWildcard();
  434. }
  435. } else {
  436. recv_pkt_region = NULL;
  437. }
  438. // do normal processing
  439. return false;
  440. }
  441. void MyMesh::onAnonDataRecv(mesh::Packet *packet, const uint8_t *secret, const mesh::Identity &sender,
  442. uint8_t *data, size_t len) {
  443. if (packet->getPayloadType() == PAYLOAD_TYPE_ANON_REQ) { // received an initial request by a possible admin
  444. // client (unknown at this stage)
  445. uint32_t timestamp;
  446. memcpy(&timestamp, data, 4);
  447. data[len] = 0; // ensure null terminator
  448. uint8_t reply_len;
  449. reply_path_len = -1;
  450. if (data[4] == 0 || data[4] >= ' ') { // is password, ie. a login request
  451. reply_len = handleLoginReq(sender, secret, timestamp, &data[4], packet->isRouteFlood());
  452. } else if (data[4] == ANON_REQ_TYPE_REGIONS && packet->isRouteDirect()) {
  453. reply_len = handleAnonRegionsReq(sender, timestamp, &data[5]);
  454. } else if (data[4] == ANON_REQ_TYPE_OWNER && packet->isRouteDirect()) {
  455. reply_len = handleAnonOwnerReq(sender, timestamp, &data[5]);
  456. } else if (data[4] == ANON_REQ_TYPE_BASIC && packet->isRouteDirect()) {
  457. reply_len = handleAnonClockReq(sender, timestamp, &data[5]);
  458. } else {
  459. reply_len = 0; // unknown/invalid request type
  460. }
  461. if (reply_len == 0) return; // invalid request
  462. if (packet->isRouteFlood()) {
  463. // let this sender know path TO here, so they can use sendDirect(), and ALSO encode the response
  464. mesh::Packet* path = createPathReturn(sender, secret, packet->path, packet->path_len,
  465. PAYLOAD_TYPE_RESPONSE, reply_data, reply_len);
  466. if (path) sendFlood(path, SERVER_RESPONSE_DELAY);
  467. } else if (reply_path_len < 0) {
  468. mesh::Packet* reply = createDatagram(PAYLOAD_TYPE_RESPONSE, sender, secret, reply_data, reply_len);
  469. if (reply) sendFlood(reply, SERVER_RESPONSE_DELAY);
  470. } else {
  471. mesh::Packet* reply = createDatagram(PAYLOAD_TYPE_RESPONSE, sender, secret, reply_data, reply_len);
  472. if (reply) sendDirect(reply, reply_path, reply_path_len, SERVER_RESPONSE_DELAY);
  473. }
  474. }
  475. }
  476. int MyMesh::searchPeersByHash(const uint8_t *hash) {
  477. int n = 0;
  478. for (int i = 0; i < acl.getNumClients(); i++) {
  479. if (acl.getClientByIdx(i)->id.isHashMatch(hash)) {
  480. matching_peer_indexes[n++] = i; // store the INDEXES of matching contacts (for subsequent 'peer' methods)
  481. }
  482. }
  483. return n;
  484. }
  485. void MyMesh::getPeerSharedSecret(uint8_t *dest_secret, int peer_idx) {
  486. int i = matching_peer_indexes[peer_idx];
  487. if (i >= 0 && i < acl.getNumClients()) {
  488. // lookup pre-calculated shared_secret
  489. memcpy(dest_secret, acl.getClientByIdx(i)->shared_secret, PUB_KEY_SIZE);
  490. } else {
  491. MESH_DEBUG_PRINTLN("getPeerSharedSecret: Invalid peer idx: %d", i);
  492. }
  493. }
  494. static bool isShare(const mesh::Packet *packet) {
  495. if (packet->hasTransportCodes()) {
  496. return packet->transport_codes[0] == 0 && packet->transport_codes[1] == 0; // codes { 0, 0 } means 'send to nowhere'
  497. }
  498. return false;
  499. }
  500. void MyMesh::onAdvertRecv(mesh::Packet *packet, const mesh::Identity &id, uint32_t timestamp,
  501. const uint8_t *app_data, size_t app_data_len) {
  502. mesh::Mesh::onAdvertRecv(packet, id, timestamp, app_data, app_data_len); // chain to super impl
  503. // if this a zero hop advert (and not via 'Share'), add it to neighbours
  504. if (packet->path_len == 0 && !isShare(packet)) {
  505. AdvertDataParser parser(app_data, app_data_len);
  506. if (parser.isValid() && parser.getType() == ADV_TYPE_REPEATER) { // just keep neigbouring Repeaters
  507. putNeighbour(id, timestamp, packet->getSNR());
  508. }
  509. }
  510. }
  511. void MyMesh::onPeerDataRecv(mesh::Packet *packet, uint8_t type, int sender_idx, const uint8_t *secret,
  512. uint8_t *data, size_t len) {
  513. int i = matching_peer_indexes[sender_idx];
  514. if (i < 0 || i >= acl.getNumClients()) { // get from our known_clients table (sender SHOULD already be known in this context)
  515. MESH_DEBUG_PRINTLN("onPeerDataRecv: invalid peer idx: %d", i);
  516. return;
  517. }
  518. ClientInfo* client = acl.getClientByIdx(i);
  519. if (type == PAYLOAD_TYPE_REQ) { // request (from a Known admin client!)
  520. uint32_t timestamp;
  521. memcpy(&timestamp, data, 4);
  522. if (timestamp > client->last_timestamp) { // prevent replay attacks
  523. int reply_len = handleRequest(client, timestamp, &data[4], len - 4);
  524. if (reply_len == 0) return; // invalid command
  525. client->last_timestamp = timestamp;
  526. client->last_activity = getRTCClock()->getCurrentTime();
  527. if (packet->isRouteFlood()) {
  528. // let this sender know path TO here, so they can use sendDirect(), and ALSO encode the response
  529. mesh::Packet *path = createPathReturn(client->id, secret, packet->path, packet->path_len,
  530. PAYLOAD_TYPE_RESPONSE, reply_data, reply_len);
  531. if (path) sendFlood(path, SERVER_RESPONSE_DELAY);
  532. } else {
  533. mesh::Packet *reply =
  534. createDatagram(PAYLOAD_TYPE_RESPONSE, client->id, secret, reply_data, reply_len);
  535. if (reply) {
  536. if (client->out_path_len >= 0) { // we have an out_path, so send DIRECT
  537. sendDirect(reply, client->out_path, client->out_path_len, SERVER_RESPONSE_DELAY);
  538. } else {
  539. sendFlood(reply, SERVER_RESPONSE_DELAY);
  540. }
  541. }
  542. }
  543. } else {
  544. MESH_DEBUG_PRINTLN("onPeerDataRecv: possible replay attack detected");
  545. }
  546. } else if (type == PAYLOAD_TYPE_TXT_MSG && len > 5 && client->isAdmin()) { // a CLI command
  547. uint32_t sender_timestamp;
  548. memcpy(&sender_timestamp, data, 4); // timestamp (by sender's RTC clock - which could be wrong)
  549. uint8_t flags = (data[4] >> 2); // message attempt number, and other flags
  550. if (!(flags == TXT_TYPE_PLAIN || flags == TXT_TYPE_CLI_DATA)) {
  551. MESH_DEBUG_PRINTLN("onPeerDataRecv: unsupported text type received: flags=%02x", (uint32_t)flags);
  552. } else if (sender_timestamp >= client->last_timestamp) { // prevent replay attacks
  553. bool is_retry = (sender_timestamp == client->last_timestamp);
  554. client->last_timestamp = sender_timestamp;
  555. client->last_activity = getRTCClock()->getCurrentTime();
  556. // len can be > original length, but 'text' will be padded with zeroes
  557. data[len] = 0; // need to make a C string again, with null terminator
  558. if (flags == TXT_TYPE_PLAIN) { // for legacy CLI, send Acks
  559. uint32_t ack_hash; // calc truncated hash of the message timestamp + text + sender pub_key, to prove
  560. // to sender that we got it
  561. mesh::Utils::sha256((uint8_t *)&ack_hash, 4, data, 5 + strlen((char *)&data[5]), client->id.pub_key,
  562. PUB_KEY_SIZE);
  563. mesh::Packet *ack = createAck(ack_hash);
  564. if (ack) {
  565. if (client->out_path_len < 0) {
  566. sendFlood(ack, TXT_ACK_DELAY);
  567. } else {
  568. sendDirect(ack, client->out_path, client->out_path_len, TXT_ACK_DELAY);
  569. }
  570. }
  571. }
  572. uint8_t temp[166];
  573. char *command = (char *)&data[5];
  574. char *reply = (char *)&temp[5];
  575. if (is_retry) {
  576. *reply = 0;
  577. } else {
  578. handleCommand(sender_timestamp, command, reply);
  579. }
  580. int text_len = strlen(reply);
  581. if (text_len > 0) {
  582. uint32_t timestamp = getRTCClock()->getCurrentTimeUnique();
  583. if (timestamp == sender_timestamp) {
  584. // WORKAROUND: the two timestamps need to be different, in the CLI view
  585. timestamp++;
  586. }
  587. memcpy(temp, &timestamp, 4); // mostly an extra blob to help make packet_hash unique
  588. temp[4] = (TXT_TYPE_CLI_DATA << 2); // NOTE: legacy was: TXT_TYPE_PLAIN
  589. auto reply = createDatagram(PAYLOAD_TYPE_TXT_MSG, client->id, secret, temp, 5 + text_len);
  590. if (reply) {
  591. if (client->out_path_len < 0) {
  592. sendFlood(reply, CLI_REPLY_DELAY_MILLIS);
  593. } else {
  594. sendDirect(reply, client->out_path, client->out_path_len, CLI_REPLY_DELAY_MILLIS);
  595. }
  596. }
  597. }
  598. } else {
  599. MESH_DEBUG_PRINTLN("onPeerDataRecv: possible replay attack detected");
  600. }
  601. }
  602. }
  603. bool MyMesh::onPeerPathRecv(mesh::Packet *packet, int sender_idx, const uint8_t *secret, uint8_t *path,
  604. uint8_t path_len, uint8_t extra_type, uint8_t *extra, uint8_t extra_len) {
  605. // TODO: prevent replay attacks
  606. int i = matching_peer_indexes[sender_idx];
  607. if (i >= 0 && i < acl.getNumClients()) { // get from our known_clients table (sender SHOULD already be known in this context)
  608. MESH_DEBUG_PRINTLN("PATH to client, path_len=%d", (uint32_t)path_len);
  609. auto client = acl.getClientByIdx(i);
  610. memcpy(client->out_path, path, client->out_path_len = path_len); // store a copy of path, for sendDirect()
  611. client->last_activity = getRTCClock()->getCurrentTime();
  612. } else {
  613. MESH_DEBUG_PRINTLN("onPeerPathRecv: invalid peer idx: %d", i);
  614. }
  615. // NOTE: no reciprocal path send!!
  616. return false;
  617. }
  618. #define CTL_TYPE_NODE_DISCOVER_REQ 0x80
  619. #define CTL_TYPE_NODE_DISCOVER_RESP 0x90
  620. void MyMesh::onControlDataRecv(mesh::Packet* packet) {
  621. uint8_t type = packet->payload[0] & 0xF0; // just test upper 4 bits
  622. if (type == CTL_TYPE_NODE_DISCOVER_REQ && packet->payload_len >= 6
  623. && !_prefs.disable_fwd && discover_limiter.allow(rtc_clock.getCurrentTime())
  624. ) {
  625. int i = 1;
  626. uint8_t filter = packet->payload[i++];
  627. uint32_t tag;
  628. memcpy(&tag, &packet->payload[i], 4); i += 4;
  629. uint32_t since;
  630. if (packet->payload_len >= i+4) { // optional since field
  631. memcpy(&since, &packet->payload[i], 4); i += 4;
  632. } else {
  633. since = 0;
  634. }
  635. if ((filter & (1 << ADV_TYPE_REPEATER)) != 0 && _prefs.discovery_mod_timestamp >= since) {
  636. bool prefix_only = packet->payload[0] & 1;
  637. uint8_t data[6 + PUB_KEY_SIZE];
  638. data[0] = CTL_TYPE_NODE_DISCOVER_RESP | ADV_TYPE_REPEATER; // low 4-bits for node type
  639. data[1] = packet->_snr; // let sender know the inbound SNR ( x 4)
  640. memcpy(&data[2], &tag, 4); // include tag from request, for client to match to
  641. memcpy(&data[6], self_id.pub_key, PUB_KEY_SIZE);
  642. auto resp = createControlData(data, prefix_only ? 6 + 8 : 6 + PUB_KEY_SIZE);
  643. if (resp) {
  644. sendZeroHop(resp, getRetransmitDelay(resp)*4); // apply random delay (widened x4), as multiple nodes can respond to this
  645. }
  646. }
  647. }
  648. }
  649. MyMesh::MyMesh(mesh::MainBoard &board, mesh::Radio &radio, mesh::MillisecondClock &ms, mesh::RNG &rng,
  650. mesh::RTCClock &rtc, mesh::MeshTables &tables)
  651. : mesh::Mesh(radio, ms, rng, rtc, *new StaticPoolPacketManager(32), tables),
  652. _cli(board, rtc, sensors, acl, &_prefs, this), telemetry(MAX_PACKET_PAYLOAD - 4), region_map(key_store), temp_map(key_store),
  653. discover_limiter(4, 120), // max 4 every 2 minutes
  654. anon_limiter(4, 180) // max 4 every 3 minutes
  655. #if defined(WITH_RS232_BRIDGE)
  656. , bridge(&_prefs, WITH_RS232_BRIDGE, _mgr, &rtc)
  657. #endif
  658. #if defined(WITH_ESPNOW_BRIDGE)
  659. , bridge(&_prefs, _mgr, &rtc)
  660. #endif
  661. {
  662. last_millis = 0;
  663. uptime_millis = 0;
  664. next_local_advert = next_flood_advert = 0;
  665. dirty_contacts_expiry = 0;
  666. set_radio_at = revert_radio_at = 0;
  667. _logging = false;
  668. region_load_active = false;
  669. #if MAX_NEIGHBOURS
  670. memset(neighbours, 0, sizeof(neighbours));
  671. #endif
  672. // defaults
  673. memset(&_prefs, 0, sizeof(_prefs));
  674. _prefs.airtime_factor = 1.0; // one half
  675. _prefs.rx_delay_base = 0.0f; // turn off by default, was 10.0;
  676. _prefs.tx_delay_factor = 0.5f; // was 0.25f
  677. _prefs.direct_tx_delay_factor = 0.2f; // was zero
  678. StrHelper::strncpy(_prefs.node_name, ADVERT_NAME, sizeof(_prefs.node_name));
  679. _prefs.node_lat = ADVERT_LAT;
  680. _prefs.node_lon = ADVERT_LON;
  681. StrHelper::strncpy(_prefs.password, ADMIN_PASSWORD, sizeof(_prefs.password));
  682. _prefs.freq = LORA_FREQ;
  683. _prefs.sf = LORA_SF;
  684. _prefs.bw = LORA_BW;
  685. _prefs.cr = LORA_CR;
  686. _prefs.tx_power_dbm = LORA_TX_POWER;
  687. _prefs.advert_interval = 1; // default to 2 minutes for NEW installs
  688. _prefs.flood_advert_interval = 12; // 12 hours
  689. _prefs.flood_max = 64;
  690. _prefs.interference_threshold = 0; // disabled
  691. // bridge defaults
  692. _prefs.bridge_enabled = 1; // enabled
  693. _prefs.bridge_delay = 500; // milliseconds
  694. _prefs.bridge_pkt_src = 0; // logTx
  695. _prefs.bridge_baud = 115200; // baud rate
  696. _prefs.bridge_channel = 1; // channel 1
  697. StrHelper::strncpy(_prefs.bridge_secret, "LVSITANOS", sizeof(_prefs.bridge_secret));
  698. // GPS defaults
  699. _prefs.gps_enabled = 0;
  700. _prefs.gps_interval = 0;
  701. _prefs.advert_loc_policy = ADVERT_LOC_PREFS;
  702. _prefs.adc_multiplier = 0.0f; // 0.0f means use default board multiplier
  703. }
  704. void MyMesh::begin(FILESYSTEM *fs) {
  705. mesh::Mesh::begin();
  706. _fs = fs;
  707. // load persisted prefs
  708. _cli.loadPrefs(_fs);
  709. acl.load(_fs);
  710. // TODO: key_store.begin();
  711. region_map.load(_fs);
  712. #if defined(WITH_BRIDGE)
  713. if (_prefs.bridge_enabled) {
  714. bridge.begin();
  715. }
  716. #endif
  717. radio_set_params(_prefs.freq, _prefs.bw, _prefs.sf, _prefs.cr);
  718. radio_set_tx_power(_prefs.tx_power_dbm);
  719. updateAdvertTimer();
  720. updateFloodAdvertTimer();
  721. board.setAdcMultiplier(_prefs.adc_multiplier);
  722. #if ENV_INCLUDE_GPS == 1
  723. applyGpsPrefs();
  724. #endif
  725. }
  726. void MyMesh::applyTempRadioParams(float freq, float bw, uint8_t sf, uint8_t cr, int timeout_mins) {
  727. set_radio_at = futureMillis(2000); // give CLI reply some time to be sent back, before applying temp radio params
  728. pending_freq = freq;
  729. pending_bw = bw;
  730. pending_sf = sf;
  731. pending_cr = cr;
  732. revert_radio_at = futureMillis(2000 + timeout_mins * 60 * 1000); // schedule when to revert radio params
  733. }
  734. bool MyMesh::formatFileSystem() {
  735. #if defined(NRF52_PLATFORM) || defined(STM32_PLATFORM)
  736. return InternalFS.format();
  737. #elif defined(RP2040_PLATFORM)
  738. return LittleFS.format();
  739. #elif defined(ESP32)
  740. return SPIFFS.format();
  741. #else
  742. #error "need to implement file system erase"
  743. return false;
  744. #endif
  745. }
  746. void MyMesh::sendSelfAdvertisement(int delay_millis) {
  747. mesh::Packet *pkt = createSelfAdvert();
  748. if (pkt) {
  749. sendFlood(pkt, delay_millis);
  750. } else {
  751. MESH_DEBUG_PRINTLN("ERROR: unable to create advertisement packet!");
  752. }
  753. }
  754. void MyMesh::updateAdvertTimer() {
  755. if (_prefs.advert_interval > 0) { // schedule local advert timer
  756. next_local_advert = futureMillis(((uint32_t)_prefs.advert_interval) * 2 * 60 * 1000);
  757. } else {
  758. next_local_advert = 0; // stop the timer
  759. }
  760. }
  761. void MyMesh::updateFloodAdvertTimer() {
  762. if (_prefs.flood_advert_interval > 0) { // schedule flood advert timer
  763. next_flood_advert = futureMillis(((uint32_t)_prefs.flood_advert_interval) * 60 * 60 * 1000);
  764. } else {
  765. next_flood_advert = 0; // stop the timer
  766. }
  767. }
  768. void MyMesh::dumpLogFile() {
  769. #if defined(RP2040_PLATFORM)
  770. File f = _fs->open(PACKET_LOG_FILE, "r");
  771. #else
  772. File f = _fs->open(PACKET_LOG_FILE);
  773. #endif
  774. if (f) {
  775. while (f.available()) {
  776. int c = f.read();
  777. if (c < 0) break;
  778. Serial.print((char)c);
  779. }
  780. f.close();
  781. }
  782. }
  783. void MyMesh::setTxPower(uint8_t power_dbm) {
  784. radio_set_tx_power(power_dbm);
  785. }
  786. void MyMesh::formatNeighborsReply(char *reply) {
  787. char *dp = reply;
  788. #if MAX_NEIGHBOURS
  789. // create copy of neighbours list, skipping empty entries so we can sort it separately from main list
  790. int16_t neighbours_count = 0;
  791. NeighbourInfo* sorted_neighbours[MAX_NEIGHBOURS];
  792. for (int i = 0; i < MAX_NEIGHBOURS; i++) {
  793. auto neighbour = &neighbours[i];
  794. if (neighbour->heard_timestamp > 0) {
  795. sorted_neighbours[neighbours_count] = neighbour;
  796. neighbours_count++;
  797. }
  798. }
  799. // sort neighbours newest to oldest
  800. std::sort(sorted_neighbours, sorted_neighbours + neighbours_count, [](const NeighbourInfo* a, const NeighbourInfo* b) {
  801. return a->heard_timestamp > b->heard_timestamp; // desc
  802. });
  803. for (int i = 0; i < neighbours_count && dp - reply < 134; i++) {
  804. NeighbourInfo *neighbour = sorted_neighbours[i];
  805. // add new line if not first item
  806. if (i > 0) *dp++ = '\n';
  807. char hex[10];
  808. // get 4 bytes of neighbour id as hex
  809. mesh::Utils::toHex(hex, neighbour->id.pub_key, 4);
  810. // add next neighbour
  811. uint32_t secs_ago = getRTCClock()->getCurrentTime() - neighbour->heard_timestamp;
  812. sprintf(dp, "%s:%d:%d", hex, secs_ago, neighbour->snr);
  813. while (*dp)
  814. dp++; // find end of string
  815. }
  816. #endif
  817. if (dp == reply) { // no neighbours, need empty response
  818. strcpy(dp, "-none-");
  819. dp += 6;
  820. }
  821. *dp = 0; // null terminator
  822. }
  823. void MyMesh::removeNeighbor(const uint8_t *pubkey, int key_len) {
  824. #if MAX_NEIGHBOURS
  825. for (int i = 0; i < MAX_NEIGHBOURS; i++) {
  826. NeighbourInfo *neighbour = &neighbours[i];
  827. if (memcmp(neighbour->id.pub_key, pubkey, key_len) == 0) {
  828. neighbours[i] = NeighbourInfo(); // clear neighbour entry
  829. }
  830. }
  831. #endif
  832. }
  833. void MyMesh::formatStatsReply(char *reply) {
  834. StatsFormatHelper::formatCoreStats(reply, board, *_ms, _err_flags, _mgr);
  835. }
  836. void MyMesh::formatRadioStatsReply(char *reply) {
  837. StatsFormatHelper::formatRadioStats(reply, _radio, radio_driver, getTotalAirTime(), getReceiveAirTime());
  838. }
  839. void MyMesh::formatPacketStatsReply(char *reply) {
  840. StatsFormatHelper::formatPacketStats(reply, radio_driver, getNumSentFlood(), getNumSentDirect(),
  841. getNumRecvFlood(), getNumRecvDirect());
  842. }
  843. void MyMesh::saveIdentity(const mesh::LocalIdentity &new_id) {
  844. self_id = new_id;
  845. #if defined(NRF52_PLATFORM) || defined(STM32_PLATFORM)
  846. IdentityStore store(*_fs, "");
  847. #elif defined(ESP32)
  848. IdentityStore store(*_fs, "/identity");
  849. #elif defined(RP2040_PLATFORM)
  850. IdentityStore store(*_fs, "/identity");
  851. #else
  852. #error "need to define saveIdentity()"
  853. #endif
  854. store.save("_main", self_id);
  855. }
  856. void MyMesh::clearStats() {
  857. radio_driver.resetStats();
  858. resetStats();
  859. ((SimpleMeshTables *)getTables())->resetStats();
  860. }
  861. void MyMesh::handleCommand(uint32_t sender_timestamp, char *command, char *reply) {
  862. if (region_load_active) {
  863. if (StrHelper::isBlank(command)) { // empty/blank line, signal to terminate 'load' operation
  864. region_map = temp_map; // copy over the temp instance as new current map
  865. region_load_active = false;
  866. sprintf(reply, "OK - loaded %d regions", region_map.getCount());
  867. } else {
  868. char *np = command;
  869. while (*np == ' ') np++; // skip indent
  870. int indent = np - command;
  871. char *ep = np;
  872. while (RegionMap::is_name_char(*ep)) ep++;
  873. if (*ep) { *ep++ = 0; } // set null terminator for end of name
  874. while (*ep && *ep != 'F') ep++; // look for (optional) flags
  875. if (indent > 0 && indent < 8 && strlen(np) > 0) {
  876. auto parent = load_stack[indent - 1];
  877. if (parent) {
  878. auto old = region_map.findByName(np);
  879. auto nw = temp_map.putRegion(np, parent->id, old ? old->id : 0); // carry-over the current ID (if name already exists)
  880. if (nw) {
  881. nw->flags = old ? old->flags : (*ep == 'F' ? 0 : REGION_DENY_FLOOD); // carry-over flags from curr
  882. load_stack[indent] = nw; // keep pointers to parent regions, to resolve parent_id's
  883. }
  884. }
  885. }
  886. reply[0] = 0;
  887. }
  888. return;
  889. }
  890. while (*command == ' ') command++; // skip leading spaces
  891. if (strlen(command) > 4 && command[2] == '|') { // optional prefix (for companion radio CLI)
  892. memcpy(reply, command, 3); // reflect the prefix back
  893. reply += 3;
  894. command += 3;
  895. }
  896. // handle ACL related commands
  897. if (memcmp(command, "setperm ", 8) == 0) { // format: setperm {pubkey-hex} {permissions-int8}
  898. char* hex = &command[8];
  899. char* sp = strchr(hex, ' '); // look for separator char
  900. if (sp == NULL) {
  901. strcpy(reply, "Err - bad params");
  902. } else {
  903. *sp++ = 0; // replace space with null terminator
  904. uint8_t pubkey[PUB_KEY_SIZE];
  905. int hex_len = min(sp - hex, PUB_KEY_SIZE*2);
  906. if (mesh::Utils::fromHex(pubkey, hex_len / 2, hex)) {
  907. uint8_t perms = atoi(sp);
  908. if (acl.applyPermissions(self_id, pubkey, hex_len / 2, perms)) {
  909. dirty_contacts_expiry = futureMillis(LAZY_CONTACTS_WRITE_DELAY); // trigger acl.save()
  910. strcpy(reply, "OK");
  911. } else {
  912. strcpy(reply, "Err - invalid params");
  913. }
  914. } else {
  915. strcpy(reply, "Err - bad pubkey");
  916. }
  917. }
  918. } else if (sender_timestamp == 0 && strcmp(command, "get acl") == 0) {
  919. Serial.println("ACL:");
  920. for (int i = 0; i < acl.getNumClients(); i++) {
  921. auto c = acl.getClientByIdx(i);
  922. if (c->permissions == 0) continue; // skip deleted (or guest) entries
  923. Serial.printf("%02X ", c->permissions);
  924. mesh::Utils::printHex(Serial, c->id.pub_key, PUB_KEY_SIZE);
  925. Serial.printf("\n");
  926. }
  927. reply[0] = 0;
  928. } else if (memcmp(command, "region", 6) == 0) {
  929. reply[0] = 0;
  930. const char* parts[4];
  931. int n = mesh::Utils::parseTextParts(command, parts, 4, ' ');
  932. if (n == 1 && sender_timestamp == 0) {
  933. region_map.exportTo(Serial);
  934. } else if (n >= 2 && strcmp(parts[1], "load") == 0) {
  935. temp_map.resetFrom(region_map); // rebuild regions in a temp instance
  936. memset(load_stack, 0, sizeof(load_stack));
  937. load_stack[0] = &temp_map.getWildcard();
  938. region_load_active = true;
  939. } else if (n >= 2 && strcmp(parts[1], "save") == 0) {
  940. _prefs.discovery_mod_timestamp = rtc_clock.getCurrentTime(); // this node is now 'modified' (for discovery info)
  941. savePrefs();
  942. bool success = region_map.save(_fs);
  943. strcpy(reply, success ? "OK" : "Err - save failed");
  944. } else if (n >= 3 && strcmp(parts[1], "allowf") == 0) {
  945. auto region = region_map.findByNamePrefix(parts[2]);
  946. if (region) {
  947. region->flags &= ~REGION_DENY_FLOOD;
  948. strcpy(reply, "OK");
  949. } else {
  950. strcpy(reply, "Err - unknown region");
  951. }
  952. } else if (n >= 3 && strcmp(parts[1], "denyf") == 0) {
  953. auto region = region_map.findByNamePrefix(parts[2]);
  954. if (region) {
  955. region->flags |= REGION_DENY_FLOOD;
  956. strcpy(reply, "OK");
  957. } else {
  958. strcpy(reply, "Err - unknown region");
  959. }
  960. } else if (n >= 3 && strcmp(parts[1], "get") == 0) {
  961. auto region = region_map.findByNamePrefix(parts[2]);
  962. if (region) {
  963. auto parent = region_map.findById(region->parent);
  964. if (parent && parent->id != 0) {
  965. sprintf(reply, " %s (%s) %s", region->name, parent->name, (region->flags & REGION_DENY_FLOOD) ? "" : "F");
  966. } else {
  967. sprintf(reply, " %s %s", region->name, (region->flags & REGION_DENY_FLOOD) ? "" : "F");
  968. }
  969. } else {
  970. strcpy(reply, "Err - unknown region");
  971. }
  972. } else if (n >= 3 && strcmp(parts[1], "home") == 0) {
  973. auto home = region_map.findByNamePrefix(parts[2]);
  974. if (home) {
  975. region_map.setHomeRegion(home);
  976. sprintf(reply, " home is now %s", home->name);
  977. } else {
  978. strcpy(reply, "Err - unknown region");
  979. }
  980. } else if (n == 2 && strcmp(parts[1], "home") == 0) {
  981. auto home = region_map.getHomeRegion();
  982. sprintf(reply, " home is %s", home ? home->name : "*");
  983. } else if (n >= 3 && strcmp(parts[1], "put") == 0) {
  984. auto parent = n >= 4 ? region_map.findByNamePrefix(parts[3]) : &region_map.getWildcard();
  985. if (parent == NULL) {
  986. strcpy(reply, "Err - unknown parent");
  987. } else {
  988. auto region = region_map.putRegion(parts[2], parent->id);
  989. if (region == NULL) {
  990. strcpy(reply, "Err - unable to put");
  991. } else {
  992. strcpy(reply, "OK");
  993. }
  994. }
  995. } else if (n >= 3 && strcmp(parts[1], "remove") == 0) {
  996. auto region = region_map.findByName(parts[2]);
  997. if (region) {
  998. if (region_map.removeRegion(*region)) {
  999. strcpy(reply, "OK");
  1000. } else {
  1001. strcpy(reply, "Err - not empty");
  1002. }
  1003. } else {
  1004. strcpy(reply, "Err - not found");
  1005. }
  1006. } else {
  1007. strcpy(reply, "Err - ??");
  1008. }
  1009. } else{
  1010. _cli.handleCommand(sender_timestamp, command, reply); // common CLI commands
  1011. }
  1012. }
  1013. void MyMesh::loop() {
  1014. #ifdef WITH_BRIDGE
  1015. bridge.loop();
  1016. #endif
  1017. mesh::Mesh::loop();
  1018. if (next_flood_advert && millisHasNowPassed(next_flood_advert)) {
  1019. mesh::Packet *pkt = createSelfAdvert();
  1020. if (pkt) sendFlood(pkt);
  1021. updateFloodAdvertTimer(); // schedule next flood advert
  1022. updateAdvertTimer(); // also schedule local advert (so they don't overlap)
  1023. } else if (next_local_advert && millisHasNowPassed(next_local_advert)) {
  1024. mesh::Packet *pkt = createSelfAdvert();
  1025. if (pkt) sendZeroHop(pkt);
  1026. updateAdvertTimer(); // schedule next local advert
  1027. }
  1028. if (set_radio_at && millisHasNowPassed(set_radio_at)) { // apply pending (temporary) radio params
  1029. set_radio_at = 0; // clear timer
  1030. radio_set_params(pending_freq, pending_bw, pending_sf, pending_cr);
  1031. MESH_DEBUG_PRINTLN("Temp radio params");
  1032. }
  1033. if (revert_radio_at && millisHasNowPassed(revert_radio_at)) { // revert radio params to orig
  1034. revert_radio_at = 0; // clear timer
  1035. radio_set_params(_prefs.freq, _prefs.bw, _prefs.sf, _prefs.cr);
  1036. MESH_DEBUG_PRINTLN("Radio params restored");
  1037. }
  1038. // is pending dirty contacts write needed?
  1039. if (dirty_contacts_expiry && millisHasNowPassed(dirty_contacts_expiry)) {
  1040. acl.save(_fs);
  1041. dirty_contacts_expiry = 0;
  1042. }
  1043. // update uptime
  1044. uint32_t now = millis();
  1045. uptime_millis += now - last_millis;
  1046. last_millis = now;
  1047. }
  1048. // To check if there is pending work
  1049. bool MyMesh::hasPendingWork() const {
  1050. return _mgr->getOutboundCount(0xFFFFFFFF) > 0;
  1051. }