main.cpp 35 KB

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