MyMesh.cpp 47 KB

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