MyMesh.cpp 48 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318
  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. static uint8_t max_loop_minimal[] = { 0, /* 1-byte */ 4, /* 2-byte */ 2, /* 3-byte */ 1 };
  344. static uint8_t max_loop_moderate[] = { 0, /* 1-byte */ 2, /* 2-byte */ 1, /* 3-byte */ 1 };
  345. static uint8_t max_loop_strict[] = { 0, /* 1-byte */ 1, /* 2-byte */ 1, /* 3-byte */ 1 };
  346. bool MyMesh::isLooped(const mesh::Packet* packet, const uint8_t max_counters[]) {
  347. uint8_t hash_size = packet->getPathHashSize();
  348. uint8_t hash_count = packet->getPathHashCount();
  349. uint8_t n = 0;
  350. const uint8_t* path = packet->path;
  351. while (hash_count > 0) { // count how many times this node is already in the path
  352. if (self_id.isHashMatch(path, hash_size)) n++;
  353. hash_count--;
  354. path += hash_size;
  355. }
  356. return n >= max_counters[hash_size];
  357. }
  358. void MyMesh::sendFloodReply(mesh::Packet* packet, unsigned long delay_millis, uint8_t path_hash_size) {
  359. if (recv_pkt_region && !recv_pkt_region->isWildcard()) { // if _request_ packet scope is known, send reply with same scope
  360. TransportKey scope;
  361. if (region_map.getTransportKeysFor(*recv_pkt_region, &scope, 1) > 0) {
  362. sendFloodScoped(scope, packet, delay_millis, path_hash_size);
  363. } else {
  364. sendFlood(packet, delay_millis, path_hash_size); // send un-scoped
  365. }
  366. } else {
  367. sendFlood(packet, delay_millis, path_hash_size); // send un-scoped
  368. }
  369. }
  370. bool MyMesh::allowPacketForward(const mesh::Packet *packet) {
  371. if (_prefs.disable_fwd) return false;
  372. if (packet->isRouteFlood()) {
  373. uint8_t limit = _prefs.flood_max;
  374. if (packet->getRouteType() == ROUTE_TYPE_FLOOD
  375. && _prefs.flood_max_unscoped != FLOOD_MAX_UNSCOPED_UNSET) {
  376. limit = _prefs.flood_max_unscoped;
  377. }
  378. if (packet->getPathHashCount() >= limit) return false;
  379. }
  380. if (packet->isRouteFlood() && recv_pkt_region == NULL) {
  381. MESH_DEBUG_PRINTLN("allowPacketForward: unknown transport code, or wildcard not allowed for FLOOD packet");
  382. return false;
  383. }
  384. if (packet->isRouteFlood() && _prefs.loop_detect != LOOP_DETECT_OFF) {
  385. const uint8_t* maximums;
  386. if (_prefs.loop_detect == LOOP_DETECT_MINIMAL) {
  387. maximums = max_loop_minimal;
  388. } else if (_prefs.loop_detect == LOOP_DETECT_MODERATE) {
  389. maximums = max_loop_moderate;
  390. } else {
  391. maximums = max_loop_strict;
  392. }
  393. if (isLooped(packet, maximums)) {
  394. MESH_DEBUG_PRINTLN("allowPacketForward: FLOOD packet loop detected!");
  395. return false;
  396. }
  397. }
  398. return true;
  399. }
  400. const char *MyMesh::getLogDateTime() {
  401. static char tmp[32];
  402. uint32_t now = getRTCClock()->getCurrentTime();
  403. DateTime dt = DateTime(now);
  404. sprintf(tmp, "%02d:%02d:%02d - %d/%d/%d U", dt.hour(), dt.minute(), dt.second(), dt.day(), dt.month(),
  405. dt.year());
  406. return tmp;
  407. }
  408. void MyMesh::logRxRaw(float snr, float rssi, const uint8_t raw[], int len) {
  409. #if MESH_PACKET_LOGGING
  410. Serial.print(getLogDateTime());
  411. Serial.print(" RAW: ");
  412. mesh::Utils::printHex(Serial, raw, len);
  413. Serial.println();
  414. #endif
  415. }
  416. void MyMesh::logRx(mesh::Packet *pkt, int len, float score) {
  417. #ifdef WITH_BRIDGE
  418. if (_prefs.bridge_pkt_src == 1) {
  419. bridge.sendPacket(pkt);
  420. }
  421. #endif
  422. if (_logging) {
  423. File f = openAppend(PACKET_LOG_FILE);
  424. if (f) {
  425. f.print(getLogDateTime());
  426. f.printf(": RX, len=%d (type=%d, route=%s, payload_len=%d) SNR=%d RSSI=%d score=%d", len,
  427. pkt->getPayloadType(), pkt->isRouteDirect() ? "D" : "F", pkt->payload_len,
  428. (int)_radio->getLastSNR(), (int)_radio->getLastRSSI(), (int)(score * 1000));
  429. if (pkt->getPayloadType() == PAYLOAD_TYPE_PATH || pkt->getPayloadType() == PAYLOAD_TYPE_REQ ||
  430. pkt->getPayloadType() == PAYLOAD_TYPE_RESPONSE || pkt->getPayloadType() == PAYLOAD_TYPE_TXT_MSG) {
  431. f.printf(" [%02X -> %02X]\n", (uint32_t)pkt->payload[1], (uint32_t)pkt->payload[0]);
  432. } else {
  433. f.printf("\n");
  434. }
  435. f.close();
  436. }
  437. }
  438. }
  439. void MyMesh::logTx(mesh::Packet *pkt, int len) {
  440. #ifdef WITH_BRIDGE
  441. if (_prefs.bridge_pkt_src == 0) {
  442. bridge.sendPacket(pkt);
  443. }
  444. #endif
  445. if (_logging) {
  446. File f = openAppend(PACKET_LOG_FILE);
  447. if (f) {
  448. f.print(getLogDateTime());
  449. f.printf(": TX, len=%d (type=%d, route=%s, payload_len=%d)", len, pkt->getPayloadType(),
  450. pkt->isRouteDirect() ? "D" : "F", pkt->payload_len);
  451. if (pkt->getPayloadType() == PAYLOAD_TYPE_PATH || pkt->getPayloadType() == PAYLOAD_TYPE_REQ ||
  452. pkt->getPayloadType() == PAYLOAD_TYPE_RESPONSE || pkt->getPayloadType() == PAYLOAD_TYPE_TXT_MSG) {
  453. f.printf(" [%02X -> %02X]\n", (uint32_t)pkt->payload[1], (uint32_t)pkt->payload[0]);
  454. } else {
  455. f.printf("\n");
  456. }
  457. f.close();
  458. }
  459. }
  460. }
  461. void MyMesh::logTxFail(mesh::Packet *pkt, int len) {
  462. if (_logging) {
  463. File f = openAppend(PACKET_LOG_FILE);
  464. if (f) {
  465. f.print(getLogDateTime());
  466. f.printf(": TX FAIL!, len=%d (type=%d, route=%s, payload_len=%d)\n", len, pkt->getPayloadType(),
  467. pkt->isRouteDirect() ? "D" : "F", pkt->payload_len);
  468. f.close();
  469. }
  470. }
  471. }
  472. int MyMesh::calcRxDelay(float score, uint32_t air_time) const {
  473. if (_prefs.rx_delay_base <= 0.0f) return 0;
  474. return (int)((pow(_prefs.rx_delay_base, 0.85f - score) - 1.0) * air_time);
  475. }
  476. uint32_t MyMesh::getRetransmitDelay(const mesh::Packet *packet) {
  477. uint32_t t = (_radio->getEstAirtimeFor(packet->getPathByteLen() + packet->payload_len + 2) * _prefs.tx_delay_factor);
  478. return getRNG()->nextInt(0, 5*t + 1);
  479. }
  480. uint32_t MyMesh::getDirectRetransmitDelay(const mesh::Packet *packet) {
  481. uint32_t t = (_radio->getEstAirtimeFor(packet->getPathByteLen() + packet->payload_len + 2) * _prefs.direct_tx_delay_factor);
  482. return getRNG()->nextInt(0, 5*t + 1);
  483. }
  484. bool MyMesh::filterRecvFloodPacket(mesh::Packet* pkt) {
  485. // just try to determine region for packet (apply later in allowPacketForward())
  486. if (pkt->getRouteType() == ROUTE_TYPE_TRANSPORT_FLOOD) {
  487. recv_pkt_region = region_map.findMatch(pkt, REGION_DENY_FLOOD);
  488. } else if (pkt->getRouteType() == ROUTE_TYPE_FLOOD) {
  489. if (region_map.getWildcard().flags & REGION_DENY_FLOOD) {
  490. recv_pkt_region = NULL;
  491. } else {
  492. recv_pkt_region = &region_map.getWildcard();
  493. }
  494. } else {
  495. recv_pkt_region = NULL;
  496. }
  497. // do normal processing
  498. return false;
  499. }
  500. void MyMesh::onAnonDataRecv(mesh::Packet *packet, const uint8_t *secret, const mesh::Identity &sender,
  501. uint8_t *data, size_t len) {
  502. if (packet->getPayloadType() == PAYLOAD_TYPE_ANON_REQ) { // received an initial request by a possible admin
  503. // client (unknown at this stage)
  504. uint32_t timestamp;
  505. memcpy(&timestamp, data, 4);
  506. data[len] = 0; // ensure null terminator
  507. uint8_t reply_len;
  508. reply_path_len = -1;
  509. if (data[4] == 0 || data[4] >= ' ') { // is password, ie. a login request
  510. reply_len = handleLoginReq(sender, secret, timestamp, &data[4], packet->isRouteFlood());
  511. } else if (data[4] == ANON_REQ_TYPE_REGIONS && packet->isRouteDirect()) {
  512. reply_len = handleAnonRegionsReq(sender, timestamp, &data[5]);
  513. } else if (data[4] == ANON_REQ_TYPE_OWNER && packet->isRouteDirect()) {
  514. reply_len = handleAnonOwnerReq(sender, timestamp, &data[5]);
  515. } else if (data[4] == ANON_REQ_TYPE_BASIC && packet->isRouteDirect()) {
  516. reply_len = handleAnonClockReq(sender, timestamp, &data[5]);
  517. } else {
  518. reply_len = 0; // unknown/invalid request type
  519. }
  520. if (reply_len == 0) return; // invalid request
  521. if (packet->isRouteFlood()) {
  522. // let this sender know path TO here, so they can use sendDirect(), and ALSO encode the response
  523. mesh::Packet* path = createPathReturn(sender, secret, packet->path, packet->path_len,
  524. PAYLOAD_TYPE_RESPONSE, reply_data, reply_len);
  525. if (path) sendFloodReply(path, SERVER_RESPONSE_DELAY, packet->getPathHashSize());
  526. } else if (reply_path_len < 0) {
  527. mesh::Packet* reply = createDatagram(PAYLOAD_TYPE_RESPONSE, sender, secret, reply_data, reply_len);
  528. if (reply) sendFloodReply(reply, SERVER_RESPONSE_DELAY, packet->getPathHashSize());
  529. } else {
  530. mesh::Packet* reply = createDatagram(PAYLOAD_TYPE_RESPONSE, sender, secret, reply_data, reply_len);
  531. uint8_t path_len = ((reply_path_hash_size - 1) << 6) | (reply_path_len & 63);
  532. if (reply) sendDirect(reply, reply_path, path_len, SERVER_RESPONSE_DELAY);
  533. }
  534. }
  535. }
  536. int MyMesh::searchPeersByHash(const uint8_t *hash) {
  537. int n = 0;
  538. for (int i = 0; i < acl.getNumClients(); i++) {
  539. if (acl.getClientByIdx(i)->id.isHashMatch(hash)) {
  540. matching_peer_indexes[n++] = i; // store the INDEXES of matching contacts (for subsequent 'peer' methods)
  541. }
  542. }
  543. return n;
  544. }
  545. void MyMesh::getPeerSharedSecret(uint8_t *dest_secret, int peer_idx) {
  546. int i = matching_peer_indexes[peer_idx];
  547. if (i >= 0 && i < acl.getNumClients()) {
  548. // lookup pre-calculated shared_secret
  549. memcpy(dest_secret, acl.getClientByIdx(i)->shared_secret, PUB_KEY_SIZE);
  550. } else {
  551. MESH_DEBUG_PRINTLN("getPeerSharedSecret: Invalid peer idx: %d", i);
  552. }
  553. }
  554. static bool isShare(const mesh::Packet *packet) {
  555. if (packet->hasTransportCodes()) {
  556. return packet->transport_codes[0] == 0 && packet->transport_codes[1] == 0; // codes { 0, 0 } means 'send to nowhere'
  557. }
  558. return false;
  559. }
  560. void MyMesh::onAdvertRecv(mesh::Packet *packet, const mesh::Identity &id, uint32_t timestamp,
  561. const uint8_t *app_data, size_t app_data_len) {
  562. mesh::Mesh::onAdvertRecv(packet, id, timestamp, app_data, app_data_len); // chain to super impl
  563. // if this a zero hop advert (and not via 'Share'), add it to neighbours
  564. if (packet->path_len == 0 && !isShare(packet)) {
  565. AdvertDataParser parser(app_data, app_data_len);
  566. if (parser.isValid() && parser.getType() == ADV_TYPE_REPEATER) { // just keep neigbouring Repeaters
  567. putNeighbour(id, timestamp, packet->getSNR());
  568. }
  569. }
  570. }
  571. void MyMesh::onPeerDataRecv(mesh::Packet *packet, uint8_t type, int sender_idx, const uint8_t *secret,
  572. uint8_t *data, size_t len) {
  573. int i = matching_peer_indexes[sender_idx];
  574. if (i < 0 || i >= acl.getNumClients()) { // get from our known_clients table (sender SHOULD already be known in this context)
  575. MESH_DEBUG_PRINTLN("onPeerDataRecv: invalid peer idx: %d", i);
  576. return;
  577. }
  578. ClientInfo* client = acl.getClientByIdx(i);
  579. if (type == PAYLOAD_TYPE_REQ) { // request (from a Known admin client!)
  580. uint32_t timestamp;
  581. memcpy(&timestamp, data, 4);
  582. if (timestamp > client->last_timestamp) { // prevent replay attacks
  583. int reply_len = handleRequest(client, timestamp, &data[4], len - 4);
  584. if (reply_len == 0) return; // invalid command
  585. client->last_timestamp = timestamp;
  586. client->last_activity = getRTCClock()->getCurrentTime();
  587. if (packet->isRouteFlood()) {
  588. // let this sender know path TO here, so they can use sendDirect(), and ALSO encode the response
  589. mesh::Packet *path = createPathReturn(client->id, secret, packet->path, packet->path_len,
  590. PAYLOAD_TYPE_RESPONSE, reply_data, reply_len);
  591. if (path) sendFloodReply(path, SERVER_RESPONSE_DELAY, packet->getPathHashSize());
  592. } else {
  593. mesh::Packet *reply =
  594. createDatagram(PAYLOAD_TYPE_RESPONSE, client->id, secret, reply_data, reply_len);
  595. if (reply) {
  596. if (client->out_path_len != OUT_PATH_UNKNOWN) { // we have an out_path, so send DIRECT
  597. sendDirect(reply, client->out_path, client->out_path_len, SERVER_RESPONSE_DELAY);
  598. } else {
  599. sendFloodReply(reply, SERVER_RESPONSE_DELAY, packet->getPathHashSize());
  600. }
  601. }
  602. }
  603. } else {
  604. MESH_DEBUG_PRINTLN("onPeerDataRecv: possible replay attack detected");
  605. }
  606. } else if (type == PAYLOAD_TYPE_TXT_MSG && len > 5 && client->isAdmin()) { // a CLI command
  607. uint32_t sender_timestamp;
  608. memcpy(&sender_timestamp, data, 4); // timestamp (by sender's RTC clock - which could be wrong)
  609. uint8_t flags = (data[4] >> 2); // message attempt number, and other flags
  610. if (!(flags == TXT_TYPE_PLAIN || flags == TXT_TYPE_CLI_DATA)) {
  611. MESH_DEBUG_PRINTLN("onPeerDataRecv: unsupported text type received: flags=%02x", (uint32_t)flags);
  612. } else if (sender_timestamp >= client->last_timestamp) { // prevent replay attacks
  613. bool is_retry = (sender_timestamp == client->last_timestamp);
  614. client->last_timestamp = sender_timestamp;
  615. client->last_activity = getRTCClock()->getCurrentTime();
  616. // len can be > original length, but 'text' will be padded with zeroes
  617. data[len] = 0; // need to make a C string again, with null terminator
  618. if (flags == TXT_TYPE_PLAIN) { // for legacy CLI, send Acks
  619. uint32_t ack_hash; // calc truncated hash of the message timestamp + text + sender pub_key, to prove
  620. // to sender that we got it
  621. mesh::Utils::sha256((uint8_t *)&ack_hash, 4, data, 5 + strlen((char *)&data[5]), client->id.pub_key,
  622. PUB_KEY_SIZE);
  623. mesh::Packet *ack = createAck(ack_hash);
  624. if (ack) {
  625. if (client->out_path_len == OUT_PATH_UNKNOWN) {
  626. sendFloodReply(ack, TXT_ACK_DELAY, packet->getPathHashSize());
  627. } else {
  628. sendDirect(ack, client->out_path, client->out_path_len, TXT_ACK_DELAY);
  629. }
  630. }
  631. }
  632. uint8_t temp[166];
  633. char *command = (char *)&data[5];
  634. char *reply = (char *)&temp[5];
  635. if (is_retry) {
  636. *reply = 0;
  637. } else {
  638. handleCommand(sender_timestamp, command, reply);
  639. }
  640. int text_len = strlen(reply);
  641. if (text_len > 0) {
  642. uint32_t timestamp = getRTCClock()->getCurrentTimeUnique();
  643. if (timestamp == sender_timestamp) {
  644. // WORKAROUND: the two timestamps need to be different, in the CLI view
  645. timestamp++;
  646. }
  647. memcpy(temp, &timestamp, 4); // mostly an extra blob to help make packet_hash unique
  648. temp[4] = (TXT_TYPE_CLI_DATA << 2); // NOTE: legacy was: TXT_TYPE_PLAIN
  649. auto reply = createDatagram(PAYLOAD_TYPE_TXT_MSG, client->id, secret, temp, 5 + text_len);
  650. if (reply) {
  651. if (client->out_path_len == OUT_PATH_UNKNOWN) {
  652. sendFloodReply(reply, CLI_REPLY_DELAY_MILLIS, packet->getPathHashSize());
  653. } else {
  654. sendDirect(reply, client->out_path, client->out_path_len, CLI_REPLY_DELAY_MILLIS);
  655. }
  656. }
  657. }
  658. } else {
  659. MESH_DEBUG_PRINTLN("onPeerDataRecv: possible replay attack detected");
  660. }
  661. }
  662. }
  663. bool MyMesh::onPeerPathRecv(mesh::Packet *packet, int sender_idx, const uint8_t *secret, uint8_t *path,
  664. uint8_t path_len, uint8_t extra_type, uint8_t *extra, uint8_t extra_len) {
  665. // TODO: prevent replay attacks
  666. int i = matching_peer_indexes[sender_idx];
  667. if (i >= 0 && i < acl.getNumClients()) { // get from our known_clients table (sender SHOULD already be known in this context)
  668. MESH_DEBUG_PRINTLN("PATH to client, path_len=%d", (uint32_t)path_len);
  669. auto client = acl.getClientByIdx(i);
  670. // store a copy of path, for sendDirect()
  671. client->out_path_len = mesh::Packet::copyPath(client->out_path, path, path_len);
  672. client->last_activity = getRTCClock()->getCurrentTime();
  673. } else {
  674. MESH_DEBUG_PRINTLN("onPeerPathRecv: invalid peer idx: %d", i);
  675. }
  676. // NOTE: no reciprocal path send!!
  677. return false;
  678. }
  679. #define CTL_TYPE_NODE_DISCOVER_REQ 0x80
  680. #define CTL_TYPE_NODE_DISCOVER_RESP 0x90
  681. void MyMesh::onControlDataRecv(mesh::Packet* packet) {
  682. uint8_t type = packet->payload[0] & 0xF0; // just test upper 4 bits
  683. if (type == CTL_TYPE_NODE_DISCOVER_REQ && packet->payload_len >= 6
  684. && !_prefs.disable_fwd && discover_limiter.allow(rtc_clock.getCurrentTime())
  685. ) {
  686. int i = 1;
  687. uint8_t filter = packet->payload[i++];
  688. uint32_t tag;
  689. memcpy(&tag, &packet->payload[i], 4); i += 4;
  690. uint32_t since;
  691. if (packet->payload_len >= i+4) { // optional since field
  692. memcpy(&since, &packet->payload[i], 4); i += 4;
  693. } else {
  694. since = 0;
  695. }
  696. if ((filter & (1 << ADV_TYPE_REPEATER)) != 0 && _prefs.discovery_mod_timestamp >= since) {
  697. bool prefix_only = packet->payload[0] & 1;
  698. uint8_t data[6 + PUB_KEY_SIZE];
  699. data[0] = CTL_TYPE_NODE_DISCOVER_RESP | ADV_TYPE_REPEATER; // low 4-bits for node type
  700. data[1] = packet->_snr; // let sender know the inbound SNR ( x 4)
  701. memcpy(&data[2], &tag, 4); // include tag from request, for client to match to
  702. memcpy(&data[6], self_id.pub_key, PUB_KEY_SIZE);
  703. auto resp = createControlData(data, prefix_only ? 6 + 8 : 6 + PUB_KEY_SIZE);
  704. if (resp) {
  705. sendZeroHop(resp, getRetransmitDelay(resp)*4); // apply random delay (widened x4), as multiple nodes can respond to this
  706. }
  707. }
  708. } else if (type == CTL_TYPE_NODE_DISCOVER_RESP && packet->payload_len >= 6) {
  709. uint8_t node_type = packet->payload[0] & 0x0F;
  710. if (node_type != ADV_TYPE_REPEATER) {
  711. return;
  712. }
  713. if (packet->payload_len < 6 + PUB_KEY_SIZE) {
  714. MESH_DEBUG_PRINTLN("onControlDataRecv: DISCOVER_RESP pubkey too short: %d", (uint32_t)packet->payload_len);
  715. return;
  716. }
  717. if (pending_discover_tag == 0 || millisHasNowPassed(pending_discover_until)) {
  718. pending_discover_tag = 0;
  719. return;
  720. }
  721. uint32_t tag;
  722. memcpy(&tag, &packet->payload[2], 4);
  723. if (tag != pending_discover_tag) {
  724. return;
  725. }
  726. mesh::Identity id(&packet->payload[6]);
  727. if (id.matches(self_id)) {
  728. return;
  729. }
  730. putNeighbour(id, rtc_clock.getCurrentTime(), packet->getSNR());
  731. }
  732. }
  733. void MyMesh::sendNodeDiscoverReq() {
  734. uint8_t data[10];
  735. data[0] = CTL_TYPE_NODE_DISCOVER_REQ; // prefix_only=0
  736. data[1] = (1 << ADV_TYPE_REPEATER);
  737. getRNG()->random(&data[2], 4); // tag
  738. memcpy(&pending_discover_tag, &data[2], 4);
  739. pending_discover_until = futureMillis(60000);
  740. uint32_t since = 0;
  741. memcpy(&data[6], &since, 4);
  742. auto pkt = createControlData(data, sizeof(data));
  743. if (pkt) {
  744. sendZeroHop(pkt);
  745. }
  746. }
  747. MyMesh::MyMesh(mesh::MainBoard &board, mesh::Radio &radio, mesh::MillisecondClock &ms, mesh::RNG &rng,
  748. mesh::RTCClock &rtc, mesh::MeshTables &tables)
  749. : mesh::Mesh(radio, ms, rng, rtc, *new StaticPoolPacketManager(32), tables),
  750. region_map(key_store), temp_map(key_store),
  751. _cli(board, rtc, sensors, region_map, acl, &_prefs, this),
  752. telemetry(MAX_PACKET_PAYLOAD - 4),
  753. discover_limiter(4, 120), // max 4 every 2 minutes
  754. anon_limiter(4, 180) // max 4 every 3 minutes
  755. #if defined(WITH_RS232_BRIDGE)
  756. , bridge(&_prefs, WITH_RS232_BRIDGE, _mgr, &rtc)
  757. #endif
  758. #if defined(WITH_ESPNOW_BRIDGE)
  759. , bridge(&_prefs, _mgr, &rtc)
  760. #endif
  761. {
  762. last_millis = 0;
  763. uptime_millis = 0;
  764. next_local_advert = next_flood_advert = 0;
  765. dirty_contacts_expiry = 0;
  766. set_radio_at = revert_radio_at = 0;
  767. _logging = false;
  768. region_load_active = false;
  769. #if MAX_NEIGHBOURS
  770. memset(neighbours, 0, sizeof(neighbours));
  771. #endif
  772. // defaults
  773. memset(&_prefs, 0, sizeof(_prefs));
  774. _prefs.airtime_factor = 1.0;
  775. _prefs.rx_delay_base = 0.0f; // turn off by default, was 10.0;
  776. _prefs.tx_delay_factor = 0.5f; // was 0.25f
  777. _prefs.direct_tx_delay_factor = 0.3f; // was 0.2
  778. StrHelper::strncpy(_prefs.node_name, ADVERT_NAME, sizeof(_prefs.node_name));
  779. _prefs.node_lat = ADVERT_LAT;
  780. _prefs.node_lon = ADVERT_LON;
  781. StrHelper::strncpy(_prefs.password, ADMIN_PASSWORD, sizeof(_prefs.password));
  782. _prefs.freq = LORA_FREQ;
  783. _prefs.sf = LORA_SF;
  784. _prefs.bw = LORA_BW;
  785. _prefs.cr = LORA_CR;
  786. _prefs.tx_power_dbm = LORA_TX_POWER;
  787. _prefs.advert_interval = 1; // default to 2 minutes for NEW installs
  788. _prefs.flood_advert_interval = 47; // 47 hours
  789. _prefs.flood_max = 64;
  790. _prefs.flood_max_unscoped = FLOOD_MAX_UNSCOPED_UNSET;
  791. _prefs.interference_threshold = 0; // disabled
  792. // bridge defaults
  793. _prefs.bridge_enabled = 1; // enabled
  794. _prefs.bridge_delay = 500; // milliseconds
  795. _prefs.bridge_pkt_src = 0; // logTx
  796. _prefs.bridge_baud = 115200; // baud rate
  797. _prefs.bridge_channel = 1; // channel 1
  798. StrHelper::strncpy(_prefs.bridge_secret, "LVSITANOS", sizeof(_prefs.bridge_secret));
  799. // GPS defaults
  800. _prefs.gps_enabled = 0;
  801. _prefs.gps_interval = 0;
  802. _prefs.advert_loc_policy = ADVERT_LOC_PREFS;
  803. _prefs.adc_multiplier = 0.0f; // 0.0f means use default board multiplier
  804. #if defined(USE_SX1262) || defined(USE_SX1268)
  805. #ifdef SX126X_RX_BOOSTED_GAIN
  806. _prefs.rx_boosted_gain = SX126X_RX_BOOSTED_GAIN;
  807. #else
  808. _prefs.rx_boosted_gain = 1; // enabled by default;
  809. #endif
  810. #endif
  811. pending_discover_tag = 0;
  812. pending_discover_until = 0;
  813. memset(default_scope.key, 0, sizeof(default_scope.key));
  814. }
  815. void MyMesh::begin(FILESYSTEM *fs) {
  816. mesh::Mesh::begin();
  817. _fs = fs;
  818. // load persisted prefs
  819. _cli.loadPrefs(_fs);
  820. acl.load(_fs, self_id);
  821. // TODO: key_store.begin();
  822. region_map.load(_fs);
  823. // establish default-scope
  824. {
  825. RegionEntry* r = region_map.getDefaultRegion();
  826. if (r) {
  827. region_map.getTransportKeysFor(*r, &default_scope, 1);
  828. } else {
  829. #ifdef DEFAULT_FLOOD_SCOPE_NAME
  830. r = region_map.findByName(DEFAULT_FLOOD_SCOPE_NAME);
  831. if (r == NULL) {
  832. r = region_map.putRegion(DEFAULT_FLOOD_SCOPE_NAME, 0); // auto-create the default scope region
  833. if (r) { r->flags = 0; } // Allow-flood
  834. }
  835. if (r) {
  836. region_map.setDefaultRegion(r);
  837. region_map.getTransportKeysFor(*r, &default_scope, 1);
  838. }
  839. #endif
  840. }
  841. }
  842. #if defined(WITH_BRIDGE)
  843. if (_prefs.bridge_enabled) {
  844. bridge.begin();
  845. }
  846. #endif
  847. radio_driver.setParams(_prefs.freq, _prefs.bw, _prefs.sf, _prefs.cr);
  848. radio_driver.setTxPower(_prefs.tx_power_dbm);
  849. radio_driver.setRxBoostedGainMode(_prefs.rx_boosted_gain);
  850. MESH_DEBUG_PRINTLN("RX Boosted Gain Mode: %s",
  851. radio_driver.getRxBoostedGainMode() ? "Enabled" : "Disabled");
  852. updateAdvertTimer();
  853. updateFloodAdvertTimer();
  854. board.setAdcMultiplier(_prefs.adc_multiplier);
  855. #if ENV_INCLUDE_GPS == 1
  856. applyGpsPrefs();
  857. #endif
  858. }
  859. void MyMesh::sendFloodScoped(const TransportKey& scope, mesh::Packet* pkt, uint32_t delay_millis, uint8_t path_hash_size) {
  860. if (scope.isNull()) {
  861. sendFlood(pkt, delay_millis, path_hash_size);
  862. } else {
  863. uint16_t codes[2];
  864. codes[0] = scope.calcTransportCode(pkt);
  865. codes[1] = 0; // REVISIT: set to 'home' Region, for sender/return region?
  866. sendFlood(pkt, codes, delay_millis, path_hash_size);
  867. }
  868. }
  869. void MyMesh::applyTempRadioParams(float freq, float bw, uint8_t sf, uint8_t cr, int timeout_mins) {
  870. set_radio_at = futureMillis(2000); // give CLI reply some time to be sent back, before applying temp radio params
  871. pending_freq = freq;
  872. pending_bw = bw;
  873. pending_sf = sf;
  874. pending_cr = cr;
  875. revert_radio_at = futureMillis(2000 + timeout_mins * 60 * 1000); // schedule when to revert radio params
  876. }
  877. bool MyMesh::formatFileSystem() {
  878. #if defined(NRF52_PLATFORM) || defined(STM32_PLATFORM)
  879. return InternalFS.format();
  880. #elif defined(RP2040_PLATFORM)
  881. return LittleFS.format();
  882. #elif defined(ESP32)
  883. return SPIFFS.format();
  884. #else
  885. #error "need to implement file system erase"
  886. return false;
  887. #endif
  888. }
  889. void MyMesh::sendSelfAdvertisement(int delay_millis, bool flood) {
  890. mesh::Packet *pkt = createSelfAdvert();
  891. if (pkt) {
  892. if (flood) {
  893. sendFloodScoped(default_scope, pkt, delay_millis, _prefs.path_hash_mode + 1);
  894. } else {
  895. sendZeroHop(pkt, delay_millis);
  896. }
  897. } else {
  898. MESH_DEBUG_PRINTLN("ERROR: unable to create advertisement packet!");
  899. }
  900. }
  901. void MyMesh::updateAdvertTimer() {
  902. if (_prefs.advert_interval > 0) { // schedule local advert timer
  903. next_local_advert = futureMillis(((uint32_t)_prefs.advert_interval) * 2 * 60 * 1000);
  904. } else {
  905. next_local_advert = 0; // stop the timer
  906. }
  907. }
  908. void MyMesh::updateFloodAdvertTimer() {
  909. if (_prefs.flood_advert_interval > 0) { // schedule flood advert timer
  910. next_flood_advert = futureMillis(((uint32_t)_prefs.flood_advert_interval) * 60 * 60 * 1000);
  911. } else {
  912. next_flood_advert = 0; // stop the timer
  913. }
  914. }
  915. void MyMesh::dumpLogFile() {
  916. #if defined(RP2040_PLATFORM)
  917. File f = _fs->open(PACKET_LOG_FILE, "r");
  918. #else
  919. File f = _fs->open(PACKET_LOG_FILE);
  920. #endif
  921. if (f) {
  922. while (f.available()) {
  923. int c = f.read();
  924. if (c < 0) break;
  925. Serial.print((char)c);
  926. }
  927. f.close();
  928. }
  929. }
  930. void MyMesh::setTxPower(int8_t power_dbm) {
  931. radio_driver.setTxPower(power_dbm);
  932. }
  933. #if defined(USE_SX1262) || defined(USE_SX1268)
  934. void MyMesh::setRxBoostedGain(bool enable) {
  935. radio_driver.setRxBoostedGainMode(enable);
  936. }
  937. #endif
  938. void MyMesh::formatNeighborsReply(char *reply) {
  939. char *dp = reply;
  940. #if MAX_NEIGHBOURS
  941. // create copy of neighbours list, skipping empty entries so we can sort it separately from main list
  942. int16_t neighbours_count = 0;
  943. NeighbourInfo* sorted_neighbours[MAX_NEIGHBOURS];
  944. for (int i = 0; i < MAX_NEIGHBOURS; i++) {
  945. auto neighbour = &neighbours[i];
  946. if (neighbour->heard_timestamp > 0) {
  947. sorted_neighbours[neighbours_count] = neighbour;
  948. neighbours_count++;
  949. }
  950. }
  951. // sort neighbours newest to oldest
  952. std::sort(sorted_neighbours, sorted_neighbours + neighbours_count, [](const NeighbourInfo* a, const NeighbourInfo* b) {
  953. return a->heard_timestamp > b->heard_timestamp; // desc
  954. });
  955. for (int i = 0; i < neighbours_count && dp - reply < 134; i++) {
  956. NeighbourInfo *neighbour = sorted_neighbours[i];
  957. // add new line if not first item
  958. if (i > 0) *dp++ = '\n';
  959. char hex[10];
  960. // get 4 bytes of neighbour id as hex
  961. mesh::Utils::toHex(hex, neighbour->id.pub_key, 4);
  962. // add next neighbour
  963. uint32_t secs_ago = getRTCClock()->getCurrentTime() - neighbour->heard_timestamp;
  964. sprintf(dp, "%s:%d:%d", hex, secs_ago, neighbour->snr);
  965. while (*dp)
  966. dp++; // find end of string
  967. }
  968. #endif
  969. if (dp == reply) { // no neighbours, need empty response
  970. strcpy(dp, "-none-");
  971. dp += 6;
  972. }
  973. *dp = 0; // null terminator
  974. }
  975. void MyMesh::removeNeighbor(const uint8_t *pubkey, int key_len) {
  976. #if MAX_NEIGHBOURS
  977. for (int i = 0; i < MAX_NEIGHBOURS; i++) {
  978. NeighbourInfo *neighbour = &neighbours[i];
  979. if (memcmp(neighbour->id.pub_key, pubkey, key_len) == 0) {
  980. neighbours[i] = NeighbourInfo(); // clear neighbour entry
  981. }
  982. }
  983. #endif
  984. }
  985. void MyMesh::startRegionsLoad() {
  986. temp_map.resetFrom(region_map); // rebuild regions in a temp instance
  987. memset(load_stack, 0, sizeof(load_stack));
  988. load_stack[0] = &temp_map.getWildcard();
  989. region_load_active = true;
  990. }
  991. bool MyMesh::saveRegions() {
  992. return region_map.save(_fs);
  993. }
  994. void MyMesh::onDefaultRegionChanged(const RegionEntry* r) {
  995. if (r) {
  996. region_map.getTransportKeysFor(*r, &default_scope, 1);
  997. } else {
  998. memset(default_scope.key, 0, sizeof(default_scope.key));
  999. }
  1000. }
  1001. void MyMesh::formatStatsReply(char *reply) {
  1002. StatsFormatHelper::formatCoreStats(reply, board, *_ms, _err_flags, _mgr);
  1003. }
  1004. void MyMesh::formatRadioStatsReply(char *reply) {
  1005. StatsFormatHelper::formatRadioStats(reply, _radio, radio_driver, getTotalAirTime(), getReceiveAirTime());
  1006. }
  1007. void MyMesh::formatPacketStatsReply(char *reply) {
  1008. StatsFormatHelper::formatPacketStats(reply, radio_driver, getNumSentFlood(), getNumSentDirect(),
  1009. getNumRecvFlood(), getNumRecvDirect());
  1010. }
  1011. void MyMesh::saveIdentity(const mesh::LocalIdentity &new_id) {
  1012. #if defined(NRF52_PLATFORM) || defined(STM32_PLATFORM)
  1013. IdentityStore store(*_fs, "");
  1014. #elif defined(ESP32)
  1015. IdentityStore store(*_fs, "/identity");
  1016. #elif defined(RP2040_PLATFORM)
  1017. IdentityStore store(*_fs, "/identity");
  1018. #else
  1019. #error "need to define saveIdentity()"
  1020. #endif
  1021. store.save("_main", new_id);
  1022. }
  1023. void MyMesh::clearStats() {
  1024. radio_driver.resetStats();
  1025. resetStats();
  1026. ((SimpleMeshTables *)getTables())->resetStats();
  1027. }
  1028. void MyMesh::handleCommand(uint32_t sender_timestamp, char *command, char *reply) {
  1029. if (region_load_active) {
  1030. if (StrHelper::isBlank(command)) { // empty/blank line, signal to terminate 'load' operation
  1031. region_map = temp_map; // copy over the temp instance as new current map
  1032. region_load_active = false;
  1033. sprintf(reply, "OK - loaded %d regions", region_map.getCount());
  1034. } else {
  1035. char *np = command;
  1036. while (*np == ' ') np++; // skip indent
  1037. int indent = np - command;
  1038. char *ep = np;
  1039. while (RegionMap::is_name_char(*ep)) ep++;
  1040. if (*ep) { *ep++ = 0; } // set null terminator for end of name
  1041. while (*ep && *ep != 'F') ep++; // look for (optional) flags
  1042. if (indent > 0 && indent < 8 && strlen(np) > 0) {
  1043. auto parent = load_stack[indent - 1];
  1044. if (parent) {
  1045. auto old = region_map.findByName(np);
  1046. auto nw = temp_map.putRegion(np, parent->id, old ? old->id : 0); // carry-over the current ID (if name already exists)
  1047. if (nw) {
  1048. nw->flags = old ? old->flags : (*ep == 'F' ? 0 : REGION_DENY_FLOOD); // carry-over flags from curr
  1049. load_stack[indent] = nw; // keep pointers to parent regions, to resolve parent_id's
  1050. }
  1051. }
  1052. }
  1053. reply[0] = 0;
  1054. }
  1055. return;
  1056. }
  1057. while (*command == ' ') command++; // skip leading spaces
  1058. if (strlen(command) > 4 && command[2] == '|') { // optional prefix (for companion radio CLI)
  1059. memcpy(reply, command, 3); // reflect the prefix back
  1060. reply += 3;
  1061. command += 3;
  1062. }
  1063. // handle ACL related commands
  1064. if (memcmp(command, "setperm ", 8) == 0) { // format: setperm {pubkey-hex} {permissions-int8}
  1065. char* hex = &command[8];
  1066. char* sp = strchr(hex, ' '); // look for separator char
  1067. if (sp == NULL) {
  1068. strcpy(reply, "Err - bad params");
  1069. } else {
  1070. *sp++ = 0; // replace space with null terminator
  1071. uint8_t pubkey[PUB_KEY_SIZE];
  1072. int hex_len = min(sp - hex, PUB_KEY_SIZE*2);
  1073. if (mesh::Utils::fromHex(pubkey, hex_len / 2, hex)) {
  1074. uint8_t perms = atoi(sp);
  1075. if (acl.applyPermissions(self_id, pubkey, hex_len / 2, perms)) {
  1076. dirty_contacts_expiry = futureMillis(LAZY_CONTACTS_WRITE_DELAY); // trigger acl.save()
  1077. strcpy(reply, "OK");
  1078. } else {
  1079. strcpy(reply, "Err - invalid params");
  1080. }
  1081. } else {
  1082. strcpy(reply, "Err - bad pubkey");
  1083. }
  1084. }
  1085. } else if (sender_timestamp == 0 && strcmp(command, "get acl") == 0) {
  1086. Serial.println("ACL:");
  1087. for (int i = 0; i < acl.getNumClients(); i++) {
  1088. auto c = acl.getClientByIdx(i);
  1089. if (c->permissions == 0) continue; // skip deleted (or guest) entries
  1090. Serial.printf("%02X ", c->permissions);
  1091. mesh::Utils::printHex(Serial, c->id.pub_key, PUB_KEY_SIZE);
  1092. Serial.printf("\n");
  1093. }
  1094. reply[0] = 0;
  1095. } else if (memcmp(command, "discover.neighbors", 18) == 0) {
  1096. const char* sub = command + 18;
  1097. while (*sub == ' ') sub++;
  1098. if (*sub != 0) {
  1099. strcpy(reply, "Err - discover.neighbors has no options");
  1100. } else {
  1101. sendNodeDiscoverReq();
  1102. strcpy(reply, "OK - Discover sent");
  1103. }
  1104. } else{
  1105. _cli.handleCommand(sender_timestamp, command, reply); // common CLI commands
  1106. }
  1107. }
  1108. void MyMesh::loop() {
  1109. #ifdef WITH_BRIDGE
  1110. bridge.loop();
  1111. #endif
  1112. mesh::Mesh::loop();
  1113. if (next_flood_advert && millisHasNowPassed(next_flood_advert)) {
  1114. mesh::Packet *pkt = createSelfAdvert();
  1115. uint32_t delay_millis = 0;
  1116. if (pkt) sendFloodScoped(default_scope, pkt, delay_millis, _prefs.path_hash_mode + 1);
  1117. updateFloodAdvertTimer(); // schedule next flood advert
  1118. updateAdvertTimer(); // also schedule local advert (so they don't overlap)
  1119. } else if (next_local_advert && millisHasNowPassed(next_local_advert)) {
  1120. mesh::Packet *pkt = createSelfAdvert();
  1121. if (pkt) sendZeroHop(pkt);
  1122. updateAdvertTimer(); // schedule next local advert
  1123. }
  1124. if (set_radio_at && millisHasNowPassed(set_radio_at)) { // apply pending (temporary) radio params
  1125. set_radio_at = 0; // clear timer
  1126. radio_driver.setParams(pending_freq, pending_bw, pending_sf, pending_cr);
  1127. MESH_DEBUG_PRINTLN("Temp radio params");
  1128. }
  1129. if (revert_radio_at && millisHasNowPassed(revert_radio_at)) { // revert radio params to orig
  1130. revert_radio_at = 0; // clear timer
  1131. radio_driver.setParams(_prefs.freq, _prefs.bw, _prefs.sf, _prefs.cr);
  1132. MESH_DEBUG_PRINTLN("Radio params restored");
  1133. }
  1134. // is pending dirty contacts write needed?
  1135. if (dirty_contacts_expiry && millisHasNowPassed(dirty_contacts_expiry)) {
  1136. acl.save(_fs);
  1137. dirty_contacts_expiry = 0;
  1138. }
  1139. // update uptime
  1140. uint32_t now = millis();
  1141. uptime_millis += now - last_millis;
  1142. last_millis = now;
  1143. }
  1144. // To check if there is pending work
  1145. bool MyMesh::hasPendingWork() const {
  1146. #if defined(WITH_BRIDGE)
  1147. if (bridge.isRunning()) return true; // bridge needs WiFi radio, can't sleep
  1148. #endif
  1149. return _mgr->getOutboundTotal() > 0;
  1150. }