MyMesh.cpp 33 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855
  1. #include "MyMesh.h"
  2. #define REPLY_DELAY_MILLIS 1500
  3. #define PUSH_NOTIFY_DELAY_MILLIS 2000
  4. #define SYNC_PUSH_INTERVAL 1200
  5. #define PUSH_ACK_TIMEOUT_FLOOD 12000
  6. #define PUSH_TIMEOUT_BASE 4000
  7. #define PUSH_ACK_TIMEOUT_FACTOR 2000
  8. #define POST_SYNC_DELAY_SECS 6
  9. #define FIRMWARE_VER_LEVEL 1
  10. #define REQ_TYPE_GET_STATUS 0x01 // same as _GET_STATS
  11. #define REQ_TYPE_KEEP_ALIVE 0x02
  12. #define REQ_TYPE_GET_TELEMETRY_DATA 0x03
  13. #define REQ_TYPE_GET_ACCESS_LIST 0x05
  14. #define RESP_SERVER_LOGIN_OK 0 // response to ANON_REQ
  15. #define LAZY_CONTACTS_WRITE_DELAY 5000
  16. struct ServerStats {
  17. uint16_t batt_milli_volts;
  18. uint16_t curr_tx_queue_len;
  19. int16_t noise_floor;
  20. int16_t last_rssi;
  21. uint32_t n_packets_recv;
  22. uint32_t n_packets_sent;
  23. uint32_t total_air_time_secs;
  24. uint32_t total_up_time_secs;
  25. uint32_t n_sent_flood, n_sent_direct;
  26. uint32_t n_recv_flood, n_recv_direct;
  27. uint16_t err_events; // was 'n_full_events'
  28. int16_t last_snr; // x 4
  29. uint16_t n_direct_dups, n_flood_dups;
  30. uint16_t n_posted, n_post_push;
  31. };
  32. void MyMesh::addPost(ClientInfo *client, const char *postData) {
  33. // TODO: suggested postData format: <title>/<descrption>
  34. posts[next_post_idx].author = client->id; // add to cyclic queue
  35. StrHelper::strncpy(posts[next_post_idx].text, postData, MAX_POST_TEXT_LEN);
  36. posts[next_post_idx].post_timestamp = getRTCClock()->getCurrentTimeUnique();
  37. next_post_idx = (next_post_idx + 1) % MAX_UNSYNCED_POSTS;
  38. next_push = futureMillis(PUSH_NOTIFY_DELAY_MILLIS);
  39. _num_posted++; // stats
  40. }
  41. void MyMesh::pushPostToClient(ClientInfo *client, PostInfo &post) {
  42. int len = 0;
  43. memcpy(&reply_data[len], &post.post_timestamp, 4);
  44. len += 4; // this is a PAST timestamp... but should be accepted by client
  45. uint8_t attempt;
  46. getRNG()->random(&attempt, 1); // need this for re-tries, so packet hash (and ACK) will be different
  47. reply_data[len++] = (TXT_TYPE_SIGNED_PLAIN << 2) | (attempt & 3); // 'signed' plain text
  48. // encode prefix of post.author.pub_key
  49. memcpy(&reply_data[len], post.author.pub_key, 4);
  50. len += 4; // just first 4 bytes
  51. int text_len = strlen(post.text);
  52. memcpy(&reply_data[len], post.text, text_len);
  53. len += text_len;
  54. // calc expected ACK reply
  55. mesh::Utils::sha256((uint8_t *)&client->extra.room.pending_ack, 4, reply_data, len, client->id.pub_key, PUB_KEY_SIZE);
  56. client->extra.room.push_post_timestamp = post.post_timestamp;
  57. auto reply = createDatagram(PAYLOAD_TYPE_TXT_MSG, client->id, client->shared_secret, reply_data, len);
  58. if (reply) {
  59. if (client->out_path_len < 0) {
  60. sendFlood(reply);
  61. client->extra.room.ack_timeout = futureMillis(PUSH_ACK_TIMEOUT_FLOOD);
  62. } else {
  63. sendDirect(reply, client->out_path, client->out_path_len);
  64. client->extra.room.ack_timeout =
  65. futureMillis(PUSH_TIMEOUT_BASE + PUSH_ACK_TIMEOUT_FACTOR * (client->out_path_len + 1));
  66. }
  67. _num_post_pushes++; // stats
  68. } else {
  69. client->extra.room.pending_ack = 0;
  70. MESH_DEBUG_PRINTLN("Unable to push post to client");
  71. }
  72. }
  73. uint8_t MyMesh::getUnsyncedCount(ClientInfo *client) {
  74. uint8_t count = 0;
  75. for (int k = 0; k < MAX_UNSYNCED_POSTS; k++) {
  76. if (posts[k].post_timestamp > client->extra.room.sync_since // is new post for this Client?
  77. && !posts[k].author.matches(client->id)) { // don't push posts to the author
  78. count++;
  79. }
  80. }
  81. return count;
  82. }
  83. bool MyMesh::processAck(const uint8_t *data) {
  84. for (int i = 0; i < acl.getNumClients(); i++) {
  85. auto client = acl.getClientByIdx(i);
  86. if (client->extra.room.pending_ack && memcmp(data, &client->extra.room.pending_ack, 4) == 0) { // got an ACK from Client!
  87. client->extra.room.pending_ack = 0; // clear this, so next push can happen
  88. client->extra.room.push_failures = 0;
  89. client->extra.room.sync_since = client->extra.room.push_post_timestamp; // advance Client's SINCE timestamp, to sync next post
  90. return true;
  91. }
  92. }
  93. return false;
  94. }
  95. mesh::Packet *MyMesh::createSelfAdvert() {
  96. uint8_t app_data[MAX_ADVERT_DATA_SIZE];
  97. uint8_t app_data_len;
  98. {
  99. AdvertDataBuilder builder(ADV_TYPE_ROOM, _prefs.node_name, _prefs.node_lat, _prefs.node_lon);
  100. app_data_len = builder.encodeTo(app_data);
  101. }
  102. return createAdvert(self_id, app_data, app_data_len);
  103. }
  104. File MyMesh::openAppend(const char *fname) {
  105. #if defined(NRF52_PLATFORM)
  106. return _fs->open(fname, FILE_O_WRITE);
  107. #elif defined(RP2040_PLATFORM)
  108. return _fs->open(fname, "a");
  109. #else
  110. return _fs->open(fname, "a", true);
  111. #endif
  112. }
  113. int MyMesh::handleRequest(ClientInfo *sender, uint32_t sender_timestamp, uint8_t *payload,
  114. size_t payload_len) {
  115. // uint32_t now = getRTCClock()->getCurrentTimeUnique();
  116. // memcpy(reply_data, &now, 4); // response packets always prefixed with timestamp
  117. memcpy(reply_data, &sender_timestamp, 4); // reflect sender_timestamp back in response packet (kind of like a 'tag')
  118. if (payload[0] == REQ_TYPE_GET_STATUS) {
  119. ServerStats stats;
  120. stats.batt_milli_volts = board.getBattMilliVolts();
  121. stats.curr_tx_queue_len = _mgr->getOutboundCount(0xFFFFFFFF);
  122. stats.noise_floor = (int16_t)_radio->getNoiseFloor();
  123. stats.last_rssi = (int16_t)radio_driver.getLastRSSI();
  124. stats.n_packets_recv = radio_driver.getPacketsRecv();
  125. stats.n_packets_sent = radio_driver.getPacketsSent();
  126. stats.total_air_time_secs = getTotalAirTime() / 1000;
  127. stats.total_up_time_secs = _ms->getMillis() / 1000;
  128. stats.n_sent_flood = getNumSentFlood();
  129. stats.n_sent_direct = getNumSentDirect();
  130. stats.n_recv_flood = getNumRecvFlood();
  131. stats.n_recv_direct = getNumRecvDirect();
  132. stats.err_events = _err_flags;
  133. stats.last_snr = (int16_t)(radio_driver.getLastSNR() * 4);
  134. stats.n_direct_dups = ((SimpleMeshTables *)getTables())->getNumDirectDups();
  135. stats.n_flood_dups = ((SimpleMeshTables *)getTables())->getNumFloodDups();
  136. stats.n_posted = _num_posted;
  137. stats.n_post_push = _num_post_pushes;
  138. memcpy(&reply_data[4], &stats, sizeof(stats));
  139. return 4 + sizeof(stats);
  140. }
  141. if (payload[0] == REQ_TYPE_GET_TELEMETRY_DATA) {
  142. uint8_t perm_mask = ~(payload[1]); // NEW: first reserved byte (of 4), is now inverse mask to apply to permissions
  143. telemetry.reset();
  144. telemetry.addVoltage(TELEM_CHANNEL_SELF, (float)board.getBattMilliVolts() / 1000.0f);
  145. // query other sensors -- target specific
  146. sensors.querySensors((sender->isAdmin() ? 0xFF : 0x00) & perm_mask, telemetry);
  147. uint8_t tlen = telemetry.getSize();
  148. memcpy(&reply_data[4], telemetry.getBuffer(), tlen);
  149. return 4 + tlen; // reply_len
  150. }
  151. if (payload[0] == REQ_TYPE_GET_ACCESS_LIST && sender->isAdmin()) {
  152. uint8_t res1 = payload[1]; // reserved for future (extra query params)
  153. uint8_t res2 = payload[2];
  154. if (res1 == 0 && res2 == 0) {
  155. uint8_t ofs = 4;
  156. for (int i = 0; i < acl.getNumClients() && ofs + 7 <= sizeof(reply_data) - 4; i++) {
  157. auto c = acl.getClientByIdx(i);
  158. if (!c->isAdmin()) continue; // skip non-Admin entries
  159. memcpy(&reply_data[ofs], c->id.pub_key, 6); ofs += 6; // just 6-byte pub_key prefix
  160. reply_data[ofs++] = c->permissions;
  161. }
  162. return ofs;
  163. }
  164. }
  165. return 0; // unknown command
  166. }
  167. void MyMesh::logRxRaw(float snr, float rssi, const uint8_t raw[], int len) {
  168. #if MESH_PACKET_LOGGING
  169. Serial.print(getLogDateTime());
  170. Serial.print(" RAW: ");
  171. mesh::Utils::printHex(Serial, raw, len);
  172. Serial.println();
  173. #endif
  174. }
  175. void MyMesh::logRx(mesh::Packet *pkt, int len, float score) {
  176. if (_logging) {
  177. File f = openAppend(PACKET_LOG_FILE);
  178. if (f) {
  179. f.print(getLogDateTime());
  180. f.printf(": RX, len=%d (type=%d, route=%s, payload_len=%d) SNR=%d RSSI=%d score=%d", len,
  181. pkt->getPayloadType(), pkt->isRouteDirect() ? "D" : "F", pkt->payload_len,
  182. (int)_radio->getLastSNR(), (int)_radio->getLastRSSI(), (int)(score * 1000));
  183. if (pkt->getPayloadType() == PAYLOAD_TYPE_PATH || pkt->getPayloadType() == PAYLOAD_TYPE_REQ ||
  184. pkt->getPayloadType() == PAYLOAD_TYPE_RESPONSE || pkt->getPayloadType() == PAYLOAD_TYPE_TXT_MSG) {
  185. f.printf(" [%02X -> %02X]\n", (uint32_t)pkt->payload[1], (uint32_t)pkt->payload[0]);
  186. } else {
  187. f.printf("\n");
  188. }
  189. f.close();
  190. }
  191. }
  192. }
  193. void MyMesh::logTx(mesh::Packet *pkt, int len) {
  194. if (_logging) {
  195. File f = openAppend(PACKET_LOG_FILE);
  196. if (f) {
  197. f.print(getLogDateTime());
  198. f.printf(": TX, len=%d (type=%d, route=%s, payload_len=%d)", len, pkt->getPayloadType(),
  199. pkt->isRouteDirect() ? "D" : "F", pkt->payload_len);
  200. if (pkt->getPayloadType() == PAYLOAD_TYPE_PATH || pkt->getPayloadType() == PAYLOAD_TYPE_REQ ||
  201. pkt->getPayloadType() == PAYLOAD_TYPE_RESPONSE || pkt->getPayloadType() == PAYLOAD_TYPE_TXT_MSG) {
  202. f.printf(" [%02X -> %02X]\n", (uint32_t)pkt->payload[1], (uint32_t)pkt->payload[0]);
  203. } else {
  204. f.printf("\n");
  205. }
  206. f.close();
  207. }
  208. }
  209. }
  210. void MyMesh::logTxFail(mesh::Packet *pkt, int len) {
  211. if (_logging) {
  212. File f = openAppend(PACKET_LOG_FILE);
  213. if (f) {
  214. f.print(getLogDateTime());
  215. f.printf(": TX FAIL!, len=%d (type=%d, route=%s, payload_len=%d)\n", len, pkt->getPayloadType(),
  216. pkt->isRouteDirect() ? "D" : "F", pkt->payload_len);
  217. f.close();
  218. }
  219. }
  220. }
  221. int MyMesh::calcRxDelay(float score, uint32_t air_time) const {
  222. if (_prefs.rx_delay_base <= 0.0f) return 0;
  223. return (int)((pow(_prefs.rx_delay_base, 0.85f - score) - 1.0) * air_time);
  224. }
  225. const char *MyMesh::getLogDateTime() {
  226. static char tmp[32];
  227. uint32_t now = getRTCClock()->getCurrentTime();
  228. DateTime dt = DateTime(now);
  229. sprintf(tmp, "%02d:%02d:%02d - %d/%d/%d U", dt.hour(), dt.minute(), dt.second(), dt.day(), dt.month(),
  230. dt.year());
  231. return tmp;
  232. }
  233. uint32_t MyMesh::getRetransmitDelay(const mesh::Packet *packet) {
  234. uint32_t t = (_radio->getEstAirtimeFor(packet->path_len + packet->payload_len + 2) * _prefs.tx_delay_factor);
  235. return getRNG()->nextInt(0, 6) * t;
  236. }
  237. uint32_t MyMesh::getDirectRetransmitDelay(const mesh::Packet *packet) {
  238. uint32_t t = (_radio->getEstAirtimeFor(packet->path_len + packet->payload_len + 2) * _prefs.direct_tx_delay_factor);
  239. return getRNG()->nextInt(0, 6) * t;
  240. }
  241. bool MyMesh::allowPacketForward(const mesh::Packet *packet) {
  242. if (_prefs.disable_fwd) return false;
  243. if (packet->isRouteFlood() && packet->path_len >= _prefs.flood_max) return false;
  244. return true;
  245. }
  246. void MyMesh::onAnonDataRecv(mesh::Packet *packet, const uint8_t *secret, const mesh::Identity &sender,
  247. uint8_t *data, size_t len) {
  248. if (packet->getPayloadType() == PAYLOAD_TYPE_ANON_REQ) { // received an initial request by a possible admin
  249. // client (unknown at this stage)
  250. uint32_t sender_timestamp, sender_sync_since;
  251. memcpy(&sender_timestamp, data, 4);
  252. memcpy(&sender_sync_since, &data[4], 4); // sender's "sync messags SINCE x" timestamp
  253. data[len] = 0; // ensure null terminator
  254. ClientInfo* client = NULL;
  255. if (data[8] == 0 && !_prefs.allow_read_only) { // blank password, just check if sender is in ACL
  256. client = acl.getClient(sender.pub_key, PUB_KEY_SIZE);
  257. if (client == NULL) {
  258. #if MESH_DEBUG
  259. MESH_DEBUG_PRINTLN("Login, sender not in ACL");
  260. #endif
  261. }
  262. }
  263. if (client == NULL) {
  264. uint8_t perm;
  265. if (strcmp((char *)&data[8], _prefs.password) == 0) { // check for valid admin password
  266. perm = PERM_ACL_ADMIN;
  267. } else {
  268. if (strcmp((char *)&data[8], _prefs.guest_password) == 0) { // check the room/public password
  269. perm = PERM_ACL_READ_WRITE;
  270. } else if (_prefs.allow_read_only) {
  271. perm = PERM_ACL_GUEST;
  272. } else {
  273. MESH_DEBUG_PRINTLN("Incorrect room password");
  274. return; // no response. Client will timeout
  275. }
  276. }
  277. client = acl.putClient(sender, 0); // add to known clients (if not already known)
  278. if (sender_timestamp <= client->last_timestamp) {
  279. MESH_DEBUG_PRINTLN("possible replay attack!");
  280. return;
  281. }
  282. MESH_DEBUG_PRINTLN("Login success!");
  283. client->last_timestamp = sender_timestamp;
  284. client->extra.room.sync_since = sender_sync_since;
  285. client->extra.room.pending_ack = 0;
  286. client->extra.room.push_failures = 0;
  287. client->last_activity = getRTCClock()->getCurrentTime();
  288. client->permissions |= perm;
  289. memcpy(client->shared_secret, secret, PUB_KEY_SIZE);
  290. dirty_contacts_expiry = futureMillis(LAZY_CONTACTS_WRITE_DELAY);
  291. }
  292. uint32_t now = getRTCClock()->getCurrentTimeUnique();
  293. memcpy(reply_data, &now, 4); // response packets always prefixed with timestamp
  294. // TODO: maybe reply with count of messages waiting to be synced for THIS client?
  295. reply_data[4] = RESP_SERVER_LOGIN_OK;
  296. reply_data[5] = 0; // Legacy: was recommended keep-alive interval (secs / 16)
  297. reply_data[6] = (client->isAdmin() ? 1 : (client->permissions == 0 ? 2 : 0));
  298. // LEGACY: reply_data[7] = getUnsyncedCount(client);
  299. reply_data[7] = client->permissions; // NEW
  300. getRNG()->random(&reply_data[8], 4); // random blob to help packet-hash uniqueness
  301. reply_data[12] = FIRMWARE_VER_LEVEL; // New field
  302. next_push = futureMillis(PUSH_NOTIFY_DELAY_MILLIS); // delay next push, give RESPONSE packet time to arrive first
  303. if (packet->isRouteFlood()) {
  304. // let this sender know path TO here, so they can use sendDirect(), and ALSO encode the response
  305. mesh::Packet *path = createPathReturn(sender, client->shared_secret, packet->path, packet->path_len,
  306. PAYLOAD_TYPE_RESPONSE, reply_data, 13);
  307. if (path) sendFlood(path, SERVER_RESPONSE_DELAY);
  308. } else {
  309. mesh::Packet *reply = createDatagram(PAYLOAD_TYPE_RESPONSE, sender, client->shared_secret, reply_data, 13);
  310. if (reply) {
  311. if (client->out_path_len >= 0) { // we have an out_path, so send DIRECT
  312. sendDirect(reply, client->out_path, client->out_path_len, SERVER_RESPONSE_DELAY);
  313. } else {
  314. sendFlood(reply, SERVER_RESPONSE_DELAY);
  315. }
  316. }
  317. }
  318. }
  319. }
  320. int MyMesh::searchPeersByHash(const uint8_t *hash) {
  321. int n = 0;
  322. for (int i = 0; i < acl.getNumClients(); i++) {
  323. if (acl.getClientByIdx(i)->id.isHashMatch(hash)) {
  324. matching_peer_indexes[n++] = i; // store the INDEXES of matching contacts (for subsequent 'peer' methods)
  325. }
  326. }
  327. return n;
  328. }
  329. void MyMesh::getPeerSharedSecret(uint8_t *dest_secret, int peer_idx) {
  330. int i = matching_peer_indexes[peer_idx];
  331. if (i >= 0 && i < acl.getNumClients()) {
  332. // lookup pre-calculated shared_secret
  333. memcpy(dest_secret, acl.getClientByIdx(i)->shared_secret, PUB_KEY_SIZE);
  334. } else {
  335. MESH_DEBUG_PRINTLN("getPeerSharedSecret: Invalid peer idx: %d", i);
  336. }
  337. }
  338. void MyMesh::onPeerDataRecv(mesh::Packet *packet, uint8_t type, int sender_idx, const uint8_t *secret,
  339. uint8_t *data, size_t len) {
  340. int i = matching_peer_indexes[sender_idx];
  341. if (i < 0 || i >= acl.getNumClients()) { // get from our known_clients table (sender SHOULD already be known in this context)
  342. MESH_DEBUG_PRINTLN("onPeerDataRecv: invalid peer idx: %d", i);
  343. return;
  344. }
  345. auto client = acl.getClientByIdx(i);
  346. if (type == PAYLOAD_TYPE_TXT_MSG && len > 5) { // a CLI command or new Post
  347. uint32_t sender_timestamp;
  348. memcpy(&sender_timestamp, data, 4); // timestamp (by sender's RTC clock - which could be wrong)
  349. uint flags = (data[4] >> 2); // message attempt number, and other flags
  350. if (!(flags == TXT_TYPE_PLAIN || flags == TXT_TYPE_CLI_DATA)) {
  351. MESH_DEBUG_PRINTLN("onPeerDataRecv: unsupported command flags received: flags=%02x", (uint32_t)flags);
  352. } else if (sender_timestamp >= client->last_timestamp) { // prevent replay attacks, but send Acks for retries
  353. bool is_retry = (sender_timestamp == client->last_timestamp);
  354. client->last_timestamp = sender_timestamp;
  355. uint32_t now = getRTCClock()->getCurrentTimeUnique();
  356. client->last_activity = now;
  357. client->extra.room.push_failures = 0; // reset so push can resume (if prev failed)
  358. // len can be > original length, but 'text' will be padded with zeroes
  359. data[len] = 0; // need to make a C string again, with null terminator
  360. uint32_t ack_hash; // calc truncated hash of the message timestamp + text + sender pub_key, to prove to
  361. // sender that we got it
  362. mesh::Utils::sha256((uint8_t *)&ack_hash, 4, data, 5 + strlen((char *)&data[5]), client->id.pub_key,
  363. PUB_KEY_SIZE);
  364. uint8_t temp[166];
  365. bool send_ack;
  366. if (flags == TXT_TYPE_CLI_DATA) {
  367. if (client->isAdmin()) {
  368. if (is_retry) {
  369. temp[5] = 0; // no reply
  370. } else {
  371. handleCommand(sender_timestamp, (char *)&data[5], (char *)&temp[5]);
  372. temp[4] = (TXT_TYPE_CLI_DATA << 2); // attempt and flags, (NOTE: legacy was: TXT_TYPE_PLAIN)
  373. }
  374. send_ack = false;
  375. } else {
  376. temp[5] = 0; // no reply
  377. send_ack = false; // and no ACK... user shoudn't be sending these
  378. }
  379. } else { // TXT_TYPE_PLAIN
  380. if ((client->permissions & PERM_ACL_ROLE_MASK) == PERM_ACL_GUEST) {
  381. temp[5] = 0; // no reply
  382. send_ack = false; // no ACK
  383. } else {
  384. if (!is_retry) {
  385. addPost(client, (const char *)&data[5]);
  386. }
  387. temp[5] = 0; // no reply (ACK is enough)
  388. send_ack = true;
  389. }
  390. }
  391. uint32_t delay_millis;
  392. if (send_ack) {
  393. if (client->out_path_len < 0) {
  394. mesh::Packet *ack = createAck(ack_hash);
  395. if (ack) sendFlood(ack, TXT_ACK_DELAY);
  396. delay_millis = TXT_ACK_DELAY + REPLY_DELAY_MILLIS;
  397. } else {
  398. uint32_t d = TXT_ACK_DELAY;
  399. if (getExtraAckTransmitCount() > 0) {
  400. mesh::Packet *a1 = createMultiAck(ack_hash, 1);
  401. if (a1) sendDirect(a1, client->out_path, client->out_path_len, d);
  402. d += 300;
  403. }
  404. mesh::Packet *a2 = createAck(ack_hash);
  405. if (a2) sendDirect(a2, client->out_path, client->out_path_len, d);
  406. delay_millis = d + REPLY_DELAY_MILLIS;
  407. }
  408. } else {
  409. delay_millis = 0;
  410. }
  411. int text_len = strlen((char *)&temp[5]);
  412. if (text_len > 0) {
  413. if (now == sender_timestamp) {
  414. // WORKAROUND: the two timestamps need to be different, in the CLI view
  415. now++;
  416. }
  417. memcpy(temp, &now, 4); // mostly an extra blob to help make packet_hash unique
  418. // calc expected ACK reply
  419. // mesh::Utils::sha256((uint8_t *)&expected_ack_crc, 4, temp, 5 + text_len, self_id.pub_key,
  420. // PUB_KEY_SIZE);
  421. auto reply = createDatagram(PAYLOAD_TYPE_TXT_MSG, client->id, secret, temp, 5 + text_len);
  422. if (reply) {
  423. if (client->out_path_len < 0) {
  424. sendFlood(reply, delay_millis + SERVER_RESPONSE_DELAY);
  425. } else {
  426. sendDirect(reply, client->out_path, client->out_path_len, delay_millis + SERVER_RESPONSE_DELAY);
  427. }
  428. }
  429. }
  430. } else {
  431. MESH_DEBUG_PRINTLN("onPeerDataRecv: possible replay attack detected");
  432. }
  433. } else if (type == PAYLOAD_TYPE_REQ && len >= 5) {
  434. uint32_t sender_timestamp;
  435. memcpy(&sender_timestamp, data, 4); // timestamp (by sender's RTC clock - which could be wrong)
  436. if (sender_timestamp < client->last_timestamp) { // prevent replay attacks
  437. MESH_DEBUG_PRINTLN("onPeerDataRecv: possible replay attack detected");
  438. } else {
  439. client->last_timestamp = sender_timestamp;
  440. uint32_t now = getRTCClock()->getCurrentTime();
  441. client->last_activity = now; // <-- THIS will keep client connection alive
  442. client->extra.room.push_failures = 0; // reset so push can resume (if prev failed)
  443. if (data[4] == REQ_TYPE_KEEP_ALIVE && packet->isRouteDirect()) { // request type
  444. uint32_t forceSince = 0;
  445. if (len >= 9) { // optional - last post_timestamp client received
  446. memcpy(&forceSince, &data[5], 4); // NOTE: this may be 0, if part of decrypted PADDING!
  447. } else {
  448. memcpy(&data[5], &forceSince, 4); // make sure there are zeroes in payload (for ack_hash calc below)
  449. }
  450. if (forceSince > 0) {
  451. client->extra.room.sync_since = forceSince; // force-update the 'sync since'
  452. }
  453. client->extra.room.pending_ack = 0;
  454. // TODO: Throttle KEEP_ALIVE requests!
  455. // if client sends too quickly, evict()
  456. // RULE: only send keep_alive response DIRECT!
  457. if (client->out_path_len >= 0) {
  458. uint32_t ack_hash; // calc ACK to prove to sender that we got request
  459. mesh::Utils::sha256((uint8_t *)&ack_hash, 4, data, 9, client->id.pub_key, PUB_KEY_SIZE);
  460. auto reply = createAck(ack_hash);
  461. if (reply) {
  462. reply->payload[reply->payload_len++] = getUnsyncedCount(client); // NEW: add unsynced counter to end of ACK packet
  463. sendDirect(reply, client->out_path, client->out_path_len, SERVER_RESPONSE_DELAY);
  464. }
  465. }
  466. } else {
  467. int reply_len = handleRequest(client, sender_timestamp, &data[4], len - 4);
  468. if (reply_len > 0) { // valid command
  469. if (packet->isRouteFlood()) {
  470. // let this sender know path TO here, so they can use sendDirect(), and ALSO encode the response
  471. mesh::Packet *path = createPathReturn(client->id, secret, packet->path, packet->path_len,
  472. PAYLOAD_TYPE_RESPONSE, reply_data, reply_len);
  473. if (path) sendFlood(path, SERVER_RESPONSE_DELAY);
  474. } else {
  475. mesh::Packet *reply = createDatagram(PAYLOAD_TYPE_RESPONSE, client->id, secret, reply_data, reply_len);
  476. if (reply) {
  477. if (client->out_path_len >= 0) { // we have an out_path, so send DIRECT
  478. sendDirect(reply, client->out_path, client->out_path_len, SERVER_RESPONSE_DELAY);
  479. } else {
  480. sendFlood(reply, SERVER_RESPONSE_DELAY);
  481. }
  482. }
  483. }
  484. }
  485. }
  486. }
  487. }
  488. }
  489. bool MyMesh::onPeerPathRecv(mesh::Packet *packet, int sender_idx, const uint8_t *secret, uint8_t *path,
  490. uint8_t path_len, uint8_t extra_type, uint8_t *extra, uint8_t extra_len) {
  491. // TODO: prevent replay attacks
  492. int i = matching_peer_indexes[sender_idx];
  493. if (i >= 0 && i < acl.getNumClients()) { // get from our known_clients table (sender SHOULD already be known in this context)
  494. MESH_DEBUG_PRINTLN("PATH to client, path_len=%d", (uint32_t)path_len);
  495. auto client = acl.getClientByIdx(i);
  496. memcpy(client->out_path, path, client->out_path_len = path_len); // store a copy of path, for sendDirect()
  497. client->last_activity = getRTCClock()->getCurrentTime();
  498. } else {
  499. MESH_DEBUG_PRINTLN("onPeerPathRecv: invalid peer idx: %d", i);
  500. }
  501. if (extra_type == PAYLOAD_TYPE_ACK && extra_len >= 4) {
  502. // also got an encoded ACK!
  503. processAck(extra);
  504. }
  505. // NOTE: no reciprocal path send!!
  506. return false;
  507. }
  508. void MyMesh::onAckRecv(mesh::Packet *packet, uint32_t ack_crc) {
  509. if (processAck((uint8_t *)&ack_crc)) {
  510. packet->markDoNotRetransmit(); // ACK was for this node, so don't retransmit
  511. }
  512. }
  513. MyMesh::MyMesh(mesh::MainBoard &board, mesh::Radio &radio, mesh::MillisecondClock &ms, mesh::RNG &rng,
  514. mesh::RTCClock &rtc, mesh::MeshTables &tables)
  515. : mesh::Mesh(radio, ms, rng, rtc, *new StaticPoolPacketManager(32), tables),
  516. _cli(board, rtc, &_prefs, this), telemetry(MAX_PACKET_PAYLOAD - 4) {
  517. next_local_advert = next_flood_advert = 0;
  518. dirty_contacts_expiry = 0;
  519. _logging = false;
  520. set_radio_at = revert_radio_at = 0;
  521. // defaults
  522. memset(&_prefs, 0, sizeof(_prefs));
  523. _prefs.airtime_factor = 1.0; // one half
  524. _prefs.rx_delay_base = 0.0f; // off by default, was 10.0
  525. _prefs.tx_delay_factor = 0.5f; // was 0.25f;
  526. StrHelper::strncpy(_prefs.node_name, ADVERT_NAME, sizeof(_prefs.node_name));
  527. _prefs.node_lat = ADVERT_LAT;
  528. _prefs.node_lon = ADVERT_LON;
  529. StrHelper::strncpy(_prefs.password, ADMIN_PASSWORD, sizeof(_prefs.password));
  530. _prefs.freq = LORA_FREQ;
  531. _prefs.sf = LORA_SF;
  532. _prefs.bw = LORA_BW;
  533. _prefs.cr = LORA_CR;
  534. _prefs.tx_power_dbm = LORA_TX_POWER;
  535. _prefs.disable_fwd = 1;
  536. _prefs.advert_interval = 1; // default to 2 minutes for NEW installs
  537. _prefs.flood_advert_interval = 12; // 12 hours
  538. _prefs.flood_max = 64;
  539. _prefs.interference_threshold = 0; // disabled
  540. #ifdef ROOM_PASSWORD
  541. StrHelper::strncpy(_prefs.guest_password, ROOM_PASSWORD, sizeof(_prefs.guest_password));
  542. #endif
  543. next_post_idx = 0;
  544. next_client_idx = 0;
  545. next_push = 0;
  546. memset(posts, 0, sizeof(posts));
  547. _num_posted = _num_post_pushes = 0;
  548. }
  549. void MyMesh::begin(FILESYSTEM *fs) {
  550. mesh::Mesh::begin();
  551. _fs = fs;
  552. // load persisted prefs
  553. _cli.loadPrefs(_fs);
  554. acl.load(_fs);
  555. radio_set_params(_prefs.freq, _prefs.bw, _prefs.sf, _prefs.cr);
  556. radio_set_tx_power(_prefs.tx_power_dbm);
  557. updateAdvertTimer();
  558. updateFloodAdvertTimer();
  559. }
  560. void MyMesh::applyTempRadioParams(float freq, float bw, uint8_t sf, uint8_t cr, int timeout_mins) {
  561. set_radio_at = futureMillis(2000); // give CLI reply some time to be sent back, before applying temp radio params
  562. pending_freq = freq;
  563. pending_bw = bw;
  564. pending_sf = sf;
  565. pending_cr = cr;
  566. revert_radio_at = futureMillis(2000 + timeout_mins * 60 * 1000); // schedule when to revert radio params
  567. }
  568. bool MyMesh::formatFileSystem() {
  569. #if defined(NRF52_PLATFORM)
  570. return InternalFS.format();
  571. #elif defined(RP2040_PLATFORM)
  572. return LittleFS.format();
  573. #elif defined(ESP32)
  574. return SPIFFS.format();
  575. #else
  576. #error "need to implement file system erase"
  577. return false;
  578. #endif
  579. }
  580. void MyMesh::sendSelfAdvertisement(int delay_millis) {
  581. mesh::Packet *pkt = createSelfAdvert();
  582. if (pkt) {
  583. sendFlood(pkt, delay_millis);
  584. } else {
  585. MESH_DEBUG_PRINTLN("ERROR: unable to create advertisement packet!");
  586. }
  587. }
  588. void MyMesh::updateAdvertTimer() {
  589. if (_prefs.advert_interval > 0) { // schedule local advert timer
  590. next_local_advert = futureMillis((uint32_t)_prefs.advert_interval * 2 * 60 * 1000);
  591. } else {
  592. next_local_advert = 0; // stop the timer
  593. }
  594. }
  595. void MyMesh::updateFloodAdvertTimer() {
  596. if (_prefs.flood_advert_interval > 0) { // schedule flood advert timer
  597. next_flood_advert = futureMillis(((uint32_t)_prefs.flood_advert_interval) * 60 * 60 * 1000);
  598. } else {
  599. next_flood_advert = 0; // stop the timer
  600. }
  601. }
  602. void MyMesh::dumpLogFile() {
  603. #if defined(RP2040_PLATFORM)
  604. File f = _fs->open(PACKET_LOG_FILE, "r");
  605. #else
  606. File f = _fs->open(PACKET_LOG_FILE);
  607. #endif
  608. if (f) {
  609. while (f.available()) {
  610. int c = f.read();
  611. if (c < 0) break;
  612. Serial.print((char)c);
  613. }
  614. f.close();
  615. }
  616. }
  617. void MyMesh::setTxPower(uint8_t power_dbm) {
  618. radio_set_tx_power(power_dbm);
  619. }
  620. void MyMesh::saveIdentity(const mesh::LocalIdentity &new_id) {
  621. self_id = new_id;
  622. #if defined(NRF52_PLATFORM) || defined(STM32_PLATFORM)
  623. IdentityStore store(*_fs, "");
  624. #elif defined(ESP32)
  625. IdentityStore store(*_fs, "/identity");
  626. #elif defined(RP2040_PLATFORM)
  627. IdentityStore store(*_fs, "/identity");
  628. #else
  629. #error "need to define saveIdentity()"
  630. #endif
  631. store.save("_main", self_id);
  632. }
  633. void MyMesh::clearStats() {
  634. radio_driver.resetStats();
  635. resetStats();
  636. ((SimpleMeshTables *)getTables())->resetStats();
  637. }
  638. void MyMesh::handleCommand(uint32_t sender_timestamp, char *command, char *reply) {
  639. while (*command == ' ')
  640. command++; // skip leading spaces
  641. if (strlen(command) > 4 && command[2] == '|') { // optional prefix (for companion radio CLI)
  642. memcpy(reply, command, 3); // reflect the prefix back
  643. reply += 3;
  644. command += 3;
  645. }
  646. // handle ACL related commands
  647. if (memcmp(command, "setperm ", 8) == 0) { // format: setperm {pubkey-hex} {permissions-int8}
  648. char* hex = &command[8];
  649. char* sp = strchr(hex, ' '); // look for separator char
  650. if (sp == NULL) {
  651. strcpy(reply, "Err - bad params");
  652. } else {
  653. *sp++ = 0; // replace space with null terminator
  654. uint8_t pubkey[PUB_KEY_SIZE];
  655. int hex_len = min(sp - hex, PUB_KEY_SIZE*2);
  656. if (mesh::Utils::fromHex(pubkey, hex_len / 2, hex)) {
  657. uint8_t perms = atoi(sp);
  658. if (acl.applyPermissions(self_id, pubkey, hex_len / 2, perms)) {
  659. dirty_contacts_expiry = futureMillis(LAZY_CONTACTS_WRITE_DELAY); // trigger acl.save()
  660. strcpy(reply, "OK");
  661. } else {
  662. strcpy(reply, "Err - invalid params");
  663. }
  664. } else {
  665. strcpy(reply, "Err - bad pubkey");
  666. }
  667. }
  668. } else if (sender_timestamp == 0 && strcmp(command, "get acl") == 0) {
  669. Serial.println("ACL:");
  670. for (int i = 0; i < acl.getNumClients(); i++) {
  671. auto c = acl.getClientByIdx(i);
  672. if (c->permissions == 0) continue; // skip deleted (or guest) entries
  673. Serial.printf("%02X ", c->permissions);
  674. mesh::Utils::printHex(Serial, c->id.pub_key, PUB_KEY_SIZE);
  675. Serial.printf("\n");
  676. }
  677. reply[0] = 0;
  678. } else{
  679. _cli.handleCommand(sender_timestamp, command, reply); // common CLI commands
  680. }
  681. }
  682. bool MyMesh::saveFilter(ClientInfo* client) {
  683. return client->isAdmin(); // only save Admins
  684. }
  685. void MyMesh::loop() {
  686. mesh::Mesh::loop();
  687. if (millisHasNowPassed(next_push) && acl.getNumClients() > 0) {
  688. // check for ACK timeouts
  689. for (int i = 0; i < acl.getNumClients(); i++) {
  690. auto c = acl.getClientByIdx(i);
  691. if (c->extra.room.pending_ack && millisHasNowPassed(c->extra.room.ack_timeout)) {
  692. c->extra.room.push_failures++;
  693. c->extra.room.pending_ack = 0; // reset (TODO: keep prev expected_ack's in a list, incase they arrive LATER, after we retry)
  694. MESH_DEBUG_PRINTLN("pending ACK timed out: push_failures: %d", (uint32_t)c->push_failures);
  695. }
  696. }
  697. // check next Round-Robin client, and sync next new post
  698. auto client = acl.getClientByIdx(next_client_idx);
  699. bool did_push = false;
  700. if (client->extra.room.pending_ack == 0 && client->last_activity != 0 &&
  701. client->extra.room.push_failures < 3) { // not already waiting for ACK, AND not evicted, AND retries not max
  702. MESH_DEBUG_PRINTLN("loop - checking for client %02X", (uint32_t)client->id.pub_key[0]);
  703. uint32_t now = getRTCClock()->getCurrentTime();
  704. for (int k = 0, idx = next_post_idx; k < MAX_UNSYNCED_POSTS; k++) {
  705. auto p = &posts[idx];
  706. if (now >= p->post_timestamp + POST_SYNC_DELAY_SECS &&
  707. p->post_timestamp > client->extra.room.sync_since // is new post for this Client?
  708. && !p->author.matches(client->id)) { // don't push posts to the author
  709. // push this post to Client, then wait for ACK
  710. pushPostToClient(client, *p);
  711. did_push = true;
  712. MESH_DEBUG_PRINTLN("loop - pushed to client %02X: %s", (uint32_t)client->id.pub_key[0], p->text);
  713. break;
  714. }
  715. idx = (idx + 1) % MAX_UNSYNCED_POSTS; // wrap to start of cyclic queue
  716. }
  717. } else {
  718. MESH_DEBUG_PRINTLN("loop - skipping busy (or evicted) client %02X", (uint32_t)client->id.pub_key[0]);
  719. }
  720. next_client_idx = (next_client_idx + 1) % acl.getNumClients(); // round robin polling for each client
  721. if (did_push) {
  722. next_push = futureMillis(SYNC_PUSH_INTERVAL);
  723. } else {
  724. // were no unsynced posts for curr client, so proccess next client much quicker! (in next loop())
  725. next_push = futureMillis(SYNC_PUSH_INTERVAL / 8);
  726. }
  727. }
  728. if (next_flood_advert && millisHasNowPassed(next_flood_advert)) {
  729. mesh::Packet *pkt = createSelfAdvert();
  730. if (pkt) sendFlood(pkt);
  731. updateFloodAdvertTimer(); // schedule next flood advert
  732. updateAdvertTimer(); // also schedule local advert (so they don't overlap)
  733. } else if (next_local_advert && millisHasNowPassed(next_local_advert)) {
  734. mesh::Packet *pkt = createSelfAdvert();
  735. if (pkt) sendZeroHop(pkt);
  736. updateAdvertTimer(); // schedule next local advert
  737. }
  738. if (set_radio_at && millisHasNowPassed(set_radio_at)) { // apply pending (temporary) radio params
  739. set_radio_at = 0; // clear timer
  740. radio_set_params(pending_freq, pending_bw, pending_sf, pending_cr);
  741. MESH_DEBUG_PRINTLN("Temp radio params");
  742. }
  743. if (revert_radio_at && millisHasNowPassed(revert_radio_at)) { // revert radio params to orig
  744. revert_radio_at = 0; // clear timer
  745. radio_set_params(_prefs.freq, _prefs.bw, _prefs.sf, _prefs.cr);
  746. MESH_DEBUG_PRINTLN("Radio params restored");
  747. }
  748. // is pending dirty contacts write needed?
  749. if (dirty_contacts_expiry && millisHasNowPassed(dirty_contacts_expiry)) {
  750. acl.save(_fs, MyMesh::saveFilter);
  751. dirty_contacts_expiry = 0;
  752. }
  753. // TODO: periodically check for OLD/inactive entries in known_clients[], and evict
  754. }