MyMesh.cpp 48 KB

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