MyMesh.cpp 34 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896
  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 == OUT_PATH_UNKNOWN) {
  60. unsigned long delay_millis = 0;
  61. sendFlood(reply, delay_millis, _prefs.path_hash_mode + 1);
  62. client->extra.room.ack_timeout = futureMillis(PUSH_ACK_TIMEOUT_FLOOD);
  63. } else {
  64. sendDirect(reply, client->out_path, client->out_path_len);
  65. uint8_t path_hash_count = client->out_path_len & 63;
  66. client->extra.room.ack_timeout = futureMillis(PUSH_TIMEOUT_BASE + PUSH_ACK_TIMEOUT_FACTOR * (path_hash_count + 1));
  67. }
  68. _num_post_pushes++; // stats
  69. } else {
  70. client->extra.room.pending_ack = 0;
  71. MESH_DEBUG_PRINTLN("Unable to push post to client");
  72. }
  73. }
  74. uint8_t MyMesh::getUnsyncedCount(ClientInfo *client) {
  75. uint8_t count = 0;
  76. for (int k = 0; k < MAX_UNSYNCED_POSTS; k++) {
  77. if (posts[k].post_timestamp > client->extra.room.sync_since // is new post for this Client?
  78. && !posts[k].author.matches(client->id)) { // don't push posts to the author
  79. count++;
  80. }
  81. }
  82. return count;
  83. }
  84. bool MyMesh::processAck(const uint8_t *data) {
  85. for (int i = 0; i < acl.getNumClients(); i++) {
  86. auto client = acl.getClientByIdx(i);
  87. if (client->extra.room.pending_ack && memcmp(data, &client->extra.room.pending_ack, 4) == 0) { // got an ACK from Client!
  88. client->extra.room.pending_ack = 0; // clear this, so next push can happen
  89. client->extra.room.push_failures = 0;
  90. client->extra.room.sync_since = client->extra.room.push_post_timestamp; // advance Client's SINCE timestamp, to sync next post
  91. return true;
  92. }
  93. }
  94. return false;
  95. }
  96. mesh::Packet *MyMesh::createSelfAdvert() {
  97. uint8_t app_data[MAX_ADVERT_DATA_SIZE];
  98. uint8_t app_data_len = _cli.buildAdvertData(ADV_TYPE_ROOM, app_data);
  99. return createAdvert(self_id, app_data, app_data_len);
  100. }
  101. File MyMesh::openAppend(const char *fname) {
  102. #if defined(NRF52_PLATFORM)
  103. return _fs->open(fname, FILE_O_WRITE);
  104. #elif defined(RP2040_PLATFORM)
  105. return _fs->open(fname, "a");
  106. #else
  107. return _fs->open(fname, "a", true);
  108. #endif
  109. }
  110. int MyMesh::handleRequest(ClientInfo *sender, uint32_t sender_timestamp, uint8_t *payload,
  111. size_t payload_len) {
  112. // uint32_t now = getRTCClock()->getCurrentTimeUnique();
  113. // memcpy(reply_data, &now, 4); // response packets always prefixed with timestamp
  114. memcpy(reply_data, &sender_timestamp, 4); // reflect sender_timestamp back in response packet (kind of like a 'tag')
  115. if (payload[0] == REQ_TYPE_GET_STATUS) {
  116. ServerStats stats;
  117. stats.batt_milli_volts = board.getBattMilliVolts();
  118. stats.curr_tx_queue_len = _mgr->getOutboundTotal();
  119. stats.noise_floor = (int16_t)_radio->getNoiseFloor();
  120. stats.last_rssi = (int16_t)radio_driver.getLastRSSI();
  121. stats.n_packets_recv = radio_driver.getPacketsRecv();
  122. stats.n_packets_sent = radio_driver.getPacketsSent();
  123. stats.total_air_time_secs = getTotalAirTime() / 1000;
  124. stats.total_up_time_secs = uptime_millis / 1000;
  125. stats.n_sent_flood = getNumSentFlood();
  126. stats.n_sent_direct = getNumSentDirect();
  127. stats.n_recv_flood = getNumRecvFlood();
  128. stats.n_recv_direct = getNumRecvDirect();
  129. stats.err_events = _err_flags;
  130. stats.last_snr = (int16_t)(radio_driver.getLastSNR() * 4);
  131. stats.n_direct_dups = ((SimpleMeshTables *)getTables())->getNumDirectDups();
  132. stats.n_flood_dups = ((SimpleMeshTables *)getTables())->getNumFloodDups();
  133. stats.n_posted = _num_posted;
  134. stats.n_post_push = _num_post_pushes;
  135. memcpy(&reply_data[4], &stats, sizeof(stats));
  136. return 4 + sizeof(stats);
  137. }
  138. if (payload[0] == REQ_TYPE_GET_TELEMETRY_DATA) {
  139. uint8_t perm_mask = ~(payload[1]); // NEW: first reserved byte (of 4), is now inverse mask to apply to permissions
  140. telemetry.reset();
  141. telemetry.addVoltage(TELEM_CHANNEL_SELF, (float)board.getBattMilliVolts() / 1000.0f);
  142. // query other sensors -- target specific
  143. if ((sender->permissions & PERM_ACL_ROLE_MASK) == PERM_ACL_GUEST) {
  144. perm_mask = 0x00; // just base telemetry allowed
  145. }
  146. sensors.querySensors(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->getPathByteLen() + packet->payload_len + 2) * _prefs.tx_delay_factor);
  235. return getRNG()->nextInt(0, 5*t + 1);
  236. }
  237. uint32_t MyMesh::getDirectRetransmitDelay(const mesh::Packet *packet) {
  238. uint32_t t = (_radio->getEstAirtimeFor(packet->getPathByteLen() + packet->payload_len + 2) * _prefs.direct_tx_delay_factor);
  239. return getRNG()->nextInt(0, 5*t + 1);
  240. }
  241. bool MyMesh::allowPacketForward(const mesh::Packet *packet) {
  242. if (_prefs.disable_fwd) return false;
  243. if (packet->isRouteFlood() && packet->getPathHashCount() >= _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) { // 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 &= ~0x03;
  289. client->permissions |= perm;
  290. memcpy(client->shared_secret, secret, PUB_KEY_SIZE);
  291. dirty_contacts_expiry = futureMillis(LAZY_CONTACTS_WRITE_DELAY);
  292. }
  293. if (packet->isRouteFlood()) {
  294. client->out_path_len = OUT_PATH_UNKNOWN; // need to rediscover out_path
  295. }
  296. uint32_t now = getRTCClock()->getCurrentTimeUnique();
  297. memcpy(reply_data, &now, 4); // response packets always prefixed with timestamp
  298. // TODO: maybe reply with count of messages waiting to be synced for THIS client?
  299. reply_data[4] = RESP_SERVER_LOGIN_OK;
  300. reply_data[5] = 0; // Legacy: was recommended keep-alive interval (secs / 16)
  301. reply_data[6] = (client->isAdmin() ? 1 : (client->permissions == 0 ? 2 : 0));
  302. // LEGACY: reply_data[7] = getUnsyncedCount(client);
  303. reply_data[7] = client->permissions; // NEW
  304. getRNG()->random(&reply_data[8], 4); // random blob to help packet-hash uniqueness
  305. reply_data[12] = FIRMWARE_VER_LEVEL; // New field
  306. next_push = futureMillis(PUSH_NOTIFY_DELAY_MILLIS); // delay next push, give RESPONSE packet time to arrive first
  307. if (packet->isRouteFlood()) {
  308. // let this sender know path TO here, so they can use sendDirect(), and ALSO encode the response
  309. mesh::Packet *path = createPathReturn(sender, client->shared_secret, packet->path, packet->path_len,
  310. PAYLOAD_TYPE_RESPONSE, reply_data, 13);
  311. if (path) sendFlood(path, SERVER_RESPONSE_DELAY, packet->getPathHashSize());
  312. } else {
  313. mesh::Packet *reply = createDatagram(PAYLOAD_TYPE_RESPONSE, sender, client->shared_secret, reply_data, 13);
  314. if (reply) {
  315. if (client->out_path_len != OUT_PATH_UNKNOWN) { // we have an out_path, so send DIRECT
  316. sendDirect(reply, client->out_path, client->out_path_len, SERVER_RESPONSE_DELAY);
  317. } else {
  318. sendFlood(reply, SERVER_RESPONSE_DELAY, packet->getPathHashSize());
  319. }
  320. }
  321. }
  322. }
  323. }
  324. int MyMesh::searchPeersByHash(const uint8_t *hash) {
  325. int n = 0;
  326. for (int i = 0; i < acl.getNumClients(); i++) {
  327. if (acl.getClientByIdx(i)->id.isHashMatch(hash)) {
  328. matching_peer_indexes[n++] = i; // store the INDEXES of matching contacts (for subsequent 'peer' methods)
  329. }
  330. }
  331. return n;
  332. }
  333. void MyMesh::getPeerSharedSecret(uint8_t *dest_secret, int peer_idx) {
  334. int i = matching_peer_indexes[peer_idx];
  335. if (i >= 0 && i < acl.getNumClients()) {
  336. // lookup pre-calculated shared_secret
  337. memcpy(dest_secret, acl.getClientByIdx(i)->shared_secret, PUB_KEY_SIZE);
  338. } else {
  339. MESH_DEBUG_PRINTLN("getPeerSharedSecret: Invalid peer idx: %d", i);
  340. }
  341. }
  342. void MyMesh::onPeerDataRecv(mesh::Packet *packet, uint8_t type, int sender_idx, const uint8_t *secret,
  343. uint8_t *data, size_t len) {
  344. int i = matching_peer_indexes[sender_idx];
  345. if (i < 0 || i >= acl.getNumClients()) { // get from our known_clients table (sender SHOULD already be known in this context)
  346. MESH_DEBUG_PRINTLN("onPeerDataRecv: invalid peer idx: %d", i);
  347. return;
  348. }
  349. auto client = acl.getClientByIdx(i);
  350. if (type == PAYLOAD_TYPE_TXT_MSG && len > 5) { // a CLI command or new Post
  351. uint32_t sender_timestamp;
  352. memcpy(&sender_timestamp, data, 4); // timestamp (by sender's RTC clock - which could be wrong)
  353. uint8_t flags = (data[4] >> 2); // message attempt number, and other flags
  354. if (!(flags == TXT_TYPE_PLAIN || flags == TXT_TYPE_CLI_DATA)) {
  355. MESH_DEBUG_PRINTLN("onPeerDataRecv: unsupported command flags received: flags=%02x", (uint32_t)flags);
  356. } else if (sender_timestamp >= client->last_timestamp) { // prevent replay attacks, but send Acks for retries
  357. bool is_retry = (sender_timestamp == client->last_timestamp);
  358. client->last_timestamp = sender_timestamp;
  359. uint32_t now = getRTCClock()->getCurrentTimeUnique();
  360. client->last_activity = now;
  361. client->extra.room.push_failures = 0; // reset so push can resume (if prev failed)
  362. // len can be > original length, but 'text' will be padded with zeroes
  363. data[len] = 0; // need to make a C string again, with null terminator
  364. uint32_t ack_hash; // calc truncated hash of the message timestamp + text + sender pub_key, to prove to
  365. // sender that we got it
  366. mesh::Utils::sha256((uint8_t *)&ack_hash, 4, data, 5 + strlen((char *)&data[5]), client->id.pub_key,
  367. PUB_KEY_SIZE);
  368. uint8_t temp[166];
  369. bool send_ack;
  370. if (flags == TXT_TYPE_CLI_DATA) {
  371. if (client->isAdmin()) {
  372. if (is_retry) {
  373. temp[5] = 0; // no reply
  374. } else {
  375. handleCommand(sender_timestamp, (char *)&data[5], (char *)&temp[5]);
  376. temp[4] = (TXT_TYPE_CLI_DATA << 2); // attempt and flags, (NOTE: legacy was: TXT_TYPE_PLAIN)
  377. }
  378. send_ack = false;
  379. } else {
  380. temp[5] = 0; // no reply
  381. send_ack = false; // and no ACK... user shoudn't be sending these
  382. }
  383. } else { // TXT_TYPE_PLAIN
  384. if ((client->permissions & PERM_ACL_ROLE_MASK) == PERM_ACL_GUEST) {
  385. temp[5] = 0; // no reply
  386. send_ack = false; // no ACK
  387. } else {
  388. if (!is_retry) {
  389. addPost(client, (const char *)&data[5]);
  390. }
  391. temp[5] = 0; // no reply (ACK is enough)
  392. send_ack = true;
  393. }
  394. }
  395. uint32_t delay_millis;
  396. if (send_ack) {
  397. if (client->out_path_len == OUT_PATH_UNKNOWN) {
  398. mesh::Packet *ack = createAck(ack_hash);
  399. if (ack) sendFlood(ack, TXT_ACK_DELAY, packet->getPathHashSize());
  400. delay_millis = TXT_ACK_DELAY + REPLY_DELAY_MILLIS;
  401. } else {
  402. uint32_t d = TXT_ACK_DELAY;
  403. if (getExtraAckTransmitCount() > 0) {
  404. mesh::Packet *a1 = createMultiAck(ack_hash, 1);
  405. if (a1) sendDirect(a1, client->out_path, client->out_path_len, d);
  406. d += 300;
  407. }
  408. mesh::Packet *a2 = createAck(ack_hash);
  409. if (a2) sendDirect(a2, client->out_path, client->out_path_len, d);
  410. delay_millis = d + REPLY_DELAY_MILLIS;
  411. }
  412. } else {
  413. delay_millis = 0;
  414. }
  415. int text_len = strlen((char *)&temp[5]);
  416. if (text_len > 0) {
  417. if (now == sender_timestamp) {
  418. // WORKAROUND: the two timestamps need to be different, in the CLI view
  419. now++;
  420. }
  421. memcpy(temp, &now, 4); // mostly an extra blob to help make packet_hash unique
  422. // calc expected ACK reply
  423. // mesh::Utils::sha256((uint8_t *)&expected_ack_crc, 4, temp, 5 + text_len, self_id.pub_key,
  424. // PUB_KEY_SIZE);
  425. auto reply = createDatagram(PAYLOAD_TYPE_TXT_MSG, client->id, secret, temp, 5 + text_len);
  426. if (reply) {
  427. if (client->out_path_len == OUT_PATH_UNKNOWN) {
  428. sendFlood(reply, delay_millis + SERVER_RESPONSE_DELAY, packet->getPathHashSize());
  429. } else {
  430. sendDirect(reply, client->out_path, client->out_path_len, delay_millis + SERVER_RESPONSE_DELAY);
  431. }
  432. }
  433. }
  434. } else {
  435. MESH_DEBUG_PRINTLN("onPeerDataRecv: possible replay attack detected");
  436. }
  437. } else if (type == PAYLOAD_TYPE_REQ && len >= 5) {
  438. uint32_t sender_timestamp;
  439. memcpy(&sender_timestamp, data, 4); // timestamp (by sender's RTC clock - which could be wrong)
  440. if (sender_timestamp < client->last_timestamp) { // prevent replay attacks
  441. MESH_DEBUG_PRINTLN("onPeerDataRecv: possible replay attack detected");
  442. } else {
  443. client->last_timestamp = sender_timestamp;
  444. uint32_t now = getRTCClock()->getCurrentTime();
  445. client->last_activity = now; // <-- THIS will keep client connection alive
  446. client->extra.room.push_failures = 0; // reset so push can resume (if prev failed)
  447. if (data[4] == REQ_TYPE_KEEP_ALIVE && packet->isRouteDirect()) { // request type
  448. uint32_t forceSince = 0;
  449. if (len >= 9) { // optional - last post_timestamp client received
  450. memcpy(&forceSince, &data[5], 4); // NOTE: this may be 0, if part of decrypted PADDING!
  451. } else {
  452. memcpy(&data[5], &forceSince, 4); // make sure there are zeroes in payload (for ack_hash calc below)
  453. }
  454. if (forceSince > 0) {
  455. client->extra.room.sync_since = forceSince; // force-update the 'sync since'
  456. }
  457. client->extra.room.pending_ack = 0;
  458. // TODO: Throttle KEEP_ALIVE requests!
  459. // if client sends too quickly, evict()
  460. // RULE: only send keep_alive response DIRECT!
  461. if (client->out_path_len != OUT_PATH_UNKNOWN) {
  462. uint32_t ack_hash; // calc ACK to prove to sender that we got request
  463. mesh::Utils::sha256((uint8_t *)&ack_hash, 4, data, 9, client->id.pub_key, PUB_KEY_SIZE);
  464. auto reply = createAck(ack_hash);
  465. if (reply) {
  466. reply->payload[reply->payload_len++] = getUnsyncedCount(client); // NEW: add unsynced counter to end of ACK packet
  467. sendDirect(reply, client->out_path, client->out_path_len, SERVER_RESPONSE_DELAY);
  468. }
  469. }
  470. } else {
  471. int reply_len = handleRequest(client, sender_timestamp, &data[4], len - 4);
  472. if (reply_len > 0) { // valid command
  473. if (packet->isRouteFlood()) {
  474. // let this sender know path TO here, so they can use sendDirect(), and ALSO encode the response
  475. mesh::Packet *path = createPathReturn(client->id, secret, packet->path, packet->path_len,
  476. PAYLOAD_TYPE_RESPONSE, reply_data, reply_len);
  477. if (path) sendFlood(path, SERVER_RESPONSE_DELAY, packet->getPathHashSize());
  478. } else {
  479. mesh::Packet *reply = createDatagram(PAYLOAD_TYPE_RESPONSE, client->id, secret, reply_data, reply_len);
  480. if (reply) {
  481. if (client->out_path_len != OUT_PATH_UNKNOWN) { // we have an out_path, so send DIRECT
  482. sendDirect(reply, client->out_path, client->out_path_len, SERVER_RESPONSE_DELAY);
  483. } else {
  484. sendFlood(reply, SERVER_RESPONSE_DELAY, packet->getPathHashSize());
  485. }
  486. }
  487. }
  488. }
  489. }
  490. }
  491. }
  492. }
  493. bool MyMesh::onPeerPathRecv(mesh::Packet *packet, int sender_idx, const uint8_t *secret, uint8_t *path,
  494. uint8_t path_len, uint8_t extra_type, uint8_t *extra, uint8_t extra_len) {
  495. // TODO: prevent replay attacks
  496. int i = matching_peer_indexes[sender_idx];
  497. if (i >= 0 && i < acl.getNumClients()) { // get from our known_clients table (sender SHOULD already be known in this context)
  498. MESH_DEBUG_PRINTLN("PATH to client, path_len=%d", (uint32_t)path_len);
  499. auto client = acl.getClientByIdx(i);
  500. client->out_path_len = mesh::Packet::copyPath(client->out_path, path, path_len); // store a copy of path, for sendDirect()
  501. client->last_activity = getRTCClock()->getCurrentTime();
  502. } else {
  503. MESH_DEBUG_PRINTLN("onPeerPathRecv: invalid peer idx: %d", i);
  504. }
  505. if (extra_type == PAYLOAD_TYPE_ACK && extra_len >= 4) {
  506. // also got an encoded ACK!
  507. processAck(extra);
  508. }
  509. // NOTE: no reciprocal path send!!
  510. return false;
  511. }
  512. void MyMesh::onAckRecv(mesh::Packet *packet, uint32_t ack_crc) {
  513. if (processAck((uint8_t *)&ack_crc)) {
  514. packet->markDoNotRetransmit(); // ACK was for this node, so don't retransmit
  515. }
  516. }
  517. MyMesh::MyMesh(mesh::MainBoard &board, mesh::Radio &radio, mesh::MillisecondClock &ms, mesh::RNG &rng,
  518. mesh::RTCClock &rtc, mesh::MeshTables &tables)
  519. : mesh::Mesh(radio, ms, rng, rtc, *new StaticPoolPacketManager(32), tables),
  520. _cli(board, rtc, sensors, acl, &_prefs, this), telemetry(MAX_PACKET_PAYLOAD - 4) {
  521. last_millis = 0;
  522. uptime_millis = 0;
  523. next_local_advert = next_flood_advert = 0;
  524. dirty_contacts_expiry = 0;
  525. _logging = false;
  526. set_radio_at = revert_radio_at = 0;
  527. // defaults
  528. memset(&_prefs, 0, sizeof(_prefs));
  529. _prefs.airtime_factor = 1.0; // one half
  530. _prefs.rx_delay_base = 0.0f; // off by default, was 10.0
  531. _prefs.tx_delay_factor = 0.5f; // was 0.25f;
  532. _prefs.direct_tx_delay_factor = 0.2f; // was zero
  533. StrHelper::strncpy(_prefs.node_name, ADVERT_NAME, sizeof(_prefs.node_name));
  534. _prefs.node_lat = ADVERT_LAT;
  535. _prefs.node_lon = ADVERT_LON;
  536. StrHelper::strncpy(_prefs.password, ADMIN_PASSWORD, sizeof(_prefs.password));
  537. _prefs.freq = LORA_FREQ;
  538. _prefs.sf = LORA_SF;
  539. _prefs.bw = LORA_BW;
  540. _prefs.cr = LORA_CR;
  541. _prefs.tx_power_dbm = LORA_TX_POWER;
  542. _prefs.disable_fwd = 1;
  543. _prefs.advert_interval = 1; // default to 2 minutes for NEW installs
  544. _prefs.flood_advert_interval = 12; // 12 hours
  545. _prefs.flood_max = 64;
  546. _prefs.interference_threshold = 0; // disabled
  547. #ifdef ROOM_PASSWORD
  548. StrHelper::strncpy(_prefs.guest_password, ROOM_PASSWORD, sizeof(_prefs.guest_password));
  549. #endif
  550. // GPS defaults
  551. _prefs.gps_enabled = 0;
  552. _prefs.gps_interval = 0;
  553. _prefs.advert_loc_policy = ADVERT_LOC_PREFS;
  554. next_post_idx = 0;
  555. next_client_idx = 0;
  556. next_push = 0;
  557. memset(posts, 0, sizeof(posts));
  558. _num_posted = _num_post_pushes = 0;
  559. }
  560. void MyMesh::begin(FILESYSTEM *fs) {
  561. mesh::Mesh::begin();
  562. _fs = fs;
  563. // load persisted prefs
  564. _cli.loadPrefs(_fs);
  565. acl.load(_fs, self_id);
  566. radio_set_params(_prefs.freq, _prefs.bw, _prefs.sf, _prefs.cr);
  567. radio_set_tx_power(_prefs.tx_power_dbm);
  568. updateAdvertTimer();
  569. updateFloodAdvertTimer();
  570. board.setAdcMultiplier(_prefs.adc_multiplier);
  571. #if ENV_INCLUDE_GPS == 1
  572. applyGpsPrefs();
  573. #endif
  574. }
  575. void MyMesh::applyTempRadioParams(float freq, float bw, uint8_t sf, uint8_t cr, int timeout_mins) {
  576. set_radio_at = futureMillis(2000); // give CLI reply some time to be sent back, before applying temp radio params
  577. pending_freq = freq;
  578. pending_bw = bw;
  579. pending_sf = sf;
  580. pending_cr = cr;
  581. revert_radio_at = futureMillis(2000 + timeout_mins * 60 * 1000); // schedule when to revert radio params
  582. }
  583. bool MyMesh::formatFileSystem() {
  584. #if defined(NRF52_PLATFORM)
  585. return InternalFS.format();
  586. #elif defined(RP2040_PLATFORM)
  587. return LittleFS.format();
  588. #elif defined(ESP32)
  589. return SPIFFS.format();
  590. #else
  591. #error "need to implement file system erase"
  592. return false;
  593. #endif
  594. }
  595. void MyMesh::sendSelfAdvertisement(int delay_millis, bool flood) {
  596. mesh::Packet *pkt = createSelfAdvert();
  597. if (pkt) {
  598. if (flood) {
  599. sendFlood(pkt, delay_millis, _prefs.path_hash_mode + 1);
  600. } else {
  601. sendZeroHop(pkt, delay_millis);
  602. }
  603. } else {
  604. MESH_DEBUG_PRINTLN("ERROR: unable to create advertisement packet!");
  605. }
  606. }
  607. void MyMesh::updateAdvertTimer() {
  608. if (_prefs.advert_interval > 0) { // schedule local advert timer
  609. next_local_advert = futureMillis((uint32_t)_prefs.advert_interval * 2 * 60 * 1000);
  610. } else {
  611. next_local_advert = 0; // stop the timer
  612. }
  613. }
  614. void MyMesh::updateFloodAdvertTimer() {
  615. if (_prefs.flood_advert_interval > 0) { // schedule flood advert timer
  616. next_flood_advert = futureMillis(((uint32_t)_prefs.flood_advert_interval) * 60 * 60 * 1000);
  617. } else {
  618. next_flood_advert = 0; // stop the timer
  619. }
  620. }
  621. void MyMesh::dumpLogFile() {
  622. #if defined(RP2040_PLATFORM)
  623. File f = _fs->open(PACKET_LOG_FILE, "r");
  624. #else
  625. File f = _fs->open(PACKET_LOG_FILE);
  626. #endif
  627. if (f) {
  628. while (f.available()) {
  629. int c = f.read();
  630. if (c < 0) break;
  631. Serial.print((char)c);
  632. }
  633. f.close();
  634. }
  635. }
  636. void MyMesh::setTxPower(int8_t power_dbm) {
  637. radio_set_tx_power(power_dbm);
  638. }
  639. void MyMesh::saveIdentity(const mesh::LocalIdentity &new_id) {
  640. #if defined(NRF52_PLATFORM) || defined(STM32_PLATFORM)
  641. IdentityStore store(*_fs, "");
  642. #elif defined(ESP32)
  643. IdentityStore store(*_fs, "/identity");
  644. #elif defined(RP2040_PLATFORM)
  645. IdentityStore store(*_fs, "/identity");
  646. #else
  647. #error "need to define saveIdentity()"
  648. #endif
  649. store.save("_main", new_id);
  650. }
  651. void MyMesh::clearStats() {
  652. radio_driver.resetStats();
  653. resetStats();
  654. ((SimpleMeshTables *)getTables())->resetStats();
  655. }
  656. void MyMesh::formatStatsReply(char *reply) {
  657. StatsFormatHelper::formatCoreStats(reply, board, *_ms, _err_flags, _mgr);
  658. }
  659. void MyMesh::formatRadioStatsReply(char *reply) {
  660. StatsFormatHelper::formatRadioStats(reply, _radio, radio_driver, getTotalAirTime(), getReceiveAirTime());
  661. }
  662. void MyMesh::formatPacketStatsReply(char *reply) {
  663. StatsFormatHelper::formatPacketStats(reply, radio_driver, getNumSentFlood(), getNumSentDirect(),
  664. getNumRecvFlood(), getNumRecvDirect());
  665. }
  666. void MyMesh::handleCommand(uint32_t sender_timestamp, char *command, char *reply) {
  667. while (*command == ' ')
  668. command++; // skip leading spaces
  669. if (strlen(command) > 4 && command[2] == '|') { // optional prefix (for companion radio CLI)
  670. memcpy(reply, command, 3); // reflect the prefix back
  671. reply += 3;
  672. command += 3;
  673. }
  674. // handle ACL related commands
  675. if (memcmp(command, "setperm ", 8) == 0) { // format: setperm {pubkey-hex} {permissions-int8}
  676. char* hex = &command[8];
  677. char* sp = strchr(hex, ' '); // look for separator char
  678. if (sp == NULL) {
  679. strcpy(reply, "Err - bad params");
  680. } else {
  681. *sp++ = 0; // replace space with null terminator
  682. uint8_t pubkey[PUB_KEY_SIZE];
  683. int hex_len = min(sp - hex, PUB_KEY_SIZE*2);
  684. if (mesh::Utils::fromHex(pubkey, hex_len / 2, hex)) {
  685. uint8_t perms = atoi(sp);
  686. if (acl.applyPermissions(self_id, pubkey, hex_len / 2, perms)) {
  687. dirty_contacts_expiry = futureMillis(LAZY_CONTACTS_WRITE_DELAY); // trigger acl.save()
  688. strcpy(reply, "OK");
  689. } else {
  690. strcpy(reply, "Err - invalid params");
  691. }
  692. } else {
  693. strcpy(reply, "Err - bad pubkey");
  694. }
  695. }
  696. } else if (sender_timestamp == 0 && strcmp(command, "get acl") == 0) {
  697. Serial.println("ACL:");
  698. for (int i = 0; i < acl.getNumClients(); i++) {
  699. auto c = acl.getClientByIdx(i);
  700. if (c->permissions == 0) continue; // skip deleted (or guest) entries
  701. Serial.printf("%02X ", c->permissions);
  702. mesh::Utils::printHex(Serial, c->id.pub_key, PUB_KEY_SIZE);
  703. Serial.printf("\n");
  704. }
  705. reply[0] = 0;
  706. } else{
  707. _cli.handleCommand(sender_timestamp, command, reply); // common CLI commands
  708. }
  709. }
  710. bool MyMesh::saveFilter(ClientInfo* client) {
  711. return client->isAdmin(); // only save Admins
  712. }
  713. void MyMesh::loop() {
  714. mesh::Mesh::loop();
  715. if (millisHasNowPassed(next_push) && acl.getNumClients() > 0) {
  716. // check for ACK timeouts
  717. for (int i = 0; i < acl.getNumClients(); i++) {
  718. auto c = acl.getClientByIdx(i);
  719. if (c->extra.room.pending_ack && millisHasNowPassed(c->extra.room.ack_timeout)) {
  720. c->extra.room.push_failures++;
  721. c->extra.room.pending_ack = 0; // reset (TODO: keep prev expected_ack's in a list, incase they arrive LATER, after we retry)
  722. MESH_DEBUG_PRINTLN("pending ACK timed out: push_failures: %d", (uint32_t)c->extra.room.push_failures);
  723. }
  724. }
  725. // check next Round-Robin client, and sync next new post
  726. auto client = acl.getClientByIdx(next_client_idx);
  727. bool did_push = false;
  728. if (client->extra.room.pending_ack == 0 && client->last_activity != 0 &&
  729. client->extra.room.push_failures < 3) { // not already waiting for ACK, AND not evicted, AND retries not max
  730. MESH_DEBUG_PRINTLN("loop - checking for client %02X", (uint32_t)client->id.pub_key[0]);
  731. uint32_t now = getRTCClock()->getCurrentTime();
  732. for (int k = 0, idx = next_post_idx; k < MAX_UNSYNCED_POSTS; k++) {
  733. auto p = &posts[idx];
  734. if (now >= p->post_timestamp + POST_SYNC_DELAY_SECS &&
  735. p->post_timestamp > client->extra.room.sync_since // is new post for this Client?
  736. && !p->author.matches(client->id)) { // don't push posts to the author
  737. // push this post to Client, then wait for ACK
  738. pushPostToClient(client, *p);
  739. did_push = true;
  740. MESH_DEBUG_PRINTLN("loop - pushed to client %02X: %s", (uint32_t)client->id.pub_key[0], p->text);
  741. break;
  742. }
  743. idx = (idx + 1) % MAX_UNSYNCED_POSTS; // wrap to start of cyclic queue
  744. }
  745. } else {
  746. MESH_DEBUG_PRINTLN("loop - skipping busy (or evicted) client %02X", (uint32_t)client->id.pub_key[0]);
  747. }
  748. next_client_idx = (next_client_idx + 1) % acl.getNumClients(); // round robin polling for each client
  749. if (did_push) {
  750. next_push = futureMillis(SYNC_PUSH_INTERVAL);
  751. } else {
  752. // were no unsynced posts for curr client, so proccess next client much quicker! (in next loop())
  753. next_push = futureMillis(SYNC_PUSH_INTERVAL / 8);
  754. }
  755. }
  756. if (next_flood_advert && millisHasNowPassed(next_flood_advert)) {
  757. mesh::Packet *pkt = createSelfAdvert();
  758. if (pkt) sendFlood(pkt);
  759. updateFloodAdvertTimer(); // schedule next flood advert
  760. updateAdvertTimer(); // also schedule local advert (so they don't overlap)
  761. } else if (next_local_advert && millisHasNowPassed(next_local_advert)) {
  762. mesh::Packet *pkt = createSelfAdvert();
  763. if (pkt) sendZeroHop(pkt);
  764. updateAdvertTimer(); // schedule next local advert
  765. }
  766. if (set_radio_at && millisHasNowPassed(set_radio_at)) { // apply pending (temporary) radio params
  767. set_radio_at = 0; // clear timer
  768. radio_set_params(pending_freq, pending_bw, pending_sf, pending_cr);
  769. MESH_DEBUG_PRINTLN("Temp radio params");
  770. }
  771. if (revert_radio_at && millisHasNowPassed(revert_radio_at)) { // revert radio params to orig
  772. revert_radio_at = 0; // clear timer
  773. radio_set_params(_prefs.freq, _prefs.bw, _prefs.sf, _prefs.cr);
  774. MESH_DEBUG_PRINTLN("Radio params restored");
  775. }
  776. // is pending dirty contacts write needed?
  777. if (dirty_contacts_expiry && millisHasNowPassed(dirty_contacts_expiry)) {
  778. acl.save(_fs, MyMesh::saveFilter);
  779. dirty_contacts_expiry = 0;
  780. }
  781. // TODO: periodically check for OLD/inactive entries in known_clients[], and evict
  782. // update uptime
  783. uint32_t now = millis();
  784. uptime_millis += now - last_millis;
  785. last_millis = now;
  786. }