/* TELNET MODULE Copyright (C) 2017-2019 by Xose PĂ©rez Parts of the code have been borrowed from Thomas Sarlandie's NetServer (https://github.com/sarfata/kbox-firmware/tree/master/src/esp) */ #if TELNET_SUPPORT #define TELNET_IAC 0xFF #define TELNET_XEOF 0xEC #if TELNET_SERVER == TELNET_SERVER_WIFISERVER #include WiFiServer _telnetServer = WiFiServer(TELNET_PORT); std::unique_ptr _telnetClients[TELNET_MAX_CLIENTS]; #else #include AsyncServer _telnetServer = AsyncServer(TELNET_PORT); std::unique_ptr _telnetClients[TELNET_MAX_CLIENTS]; #endif bool _telnetAuth = TELNET_AUTHENTICATION; bool _telnetClientsAuth[TELNET_MAX_CLIENTS]; // ----------------------------------------------------------------------------- // Private methods // ----------------------------------------------------------------------------- #if WEB_SUPPORT bool _telnetWebSocketOnKeyCheck(const char * key, JsonVariant& value) { return (strncmp(key, "telnet", 6) == 0); } void _telnetWebSocketOnConnected(JsonObject& root) { root["telnetSTA"] = getSetting("telnetSTA", TELNET_STA).toInt() == 1; root["telnetAuth"] = getSetting("telnetAuth", TELNET_AUTHENTICATION).toInt() == 1; } #endif #if TELNET_REVERSE_SUPPORT void _telnetReverse(const char * host, uint16_t port) { DEBUG_MSG_P(PSTR("[TELNET] Connecting to reverse telnet on %s:%d\n"), host, port); unsigned char i; for (i = 0; i < TELNET_MAX_CLIENTS; i++) { if (!_telnetClients[i] || !_telnetClients[i]->connected()) { #if TELNET_SERVER == TELNET_SERVER_WIFISERVER _telnetClients[i] = std::make_unique(); #else // TELNET_SERVER_ASYNC _telnetClients[i] = std::make_unique(); #endif if (_telnetClients[i]->connect(host, port)) { return _telnetNotifyConnected(i); } else { DEBUG_MSG_P(PSTR("[TELNET] Error connecting reverse telnet\n")); return _telnetDisconnect(i); } } } //no free/disconnected spot so reject if (i == TELNET_MAX_CLIENTS) { DEBUG_MSG_P(PSTR("[TELNET] Failed too connect - too many clients connected\n")); } } #if MQTT_SUPPORT void _telnetReverseMQTTCallback(unsigned int type, const char * topic, const char * payload) { if (type == MQTT_CONNECT_EVENT) { mqttSubscribe(MQTT_TOPIC_TELNET_REVERSE); } else if (type == MQTT_MESSAGE_EVENT) { String t = mqttMagnitude((char *) topic); if (t.equals(MQTT_TOPIC_TELNET_REVERSE)) { String pl = String(payload); int col = pl.indexOf(':'); if (col != -1) { String host = pl.substring(0, col); uint16_t port = pl.substring(col + 1).toInt(); _telnetReverse(host.c_str(), port); } else { DEBUG_MSG_P(PSTR("[TELNET] Incorrect reverse telnet value given, use the form \"host:ip\"")); } } } } #endif #endif void _telnetDisconnect(unsigned char clientId) { // ref: we are called from onDisconnect, async is already stopped #if TELNET_SERVER == TELNET_SERVER_WIFISERVER _telnetClients[clientId]->stop(); #endif _telnetClients[clientId] = nullptr; wifiReconnectCheck(); DEBUG_MSG_P(PSTR("[TELNET] Client #%d disconnected\n"), clientId); } bool _telnetWrite(unsigned char clientId, const char *data, size_t len) { if (_telnetClients[clientId] && _telnetClients[clientId]->connected()) { return (_telnetClients[clientId]->write(data, len) > 0); } return false; } unsigned char _telnetWrite(const char *data, size_t len) { unsigned char count = 0; for (unsigned char i = 0; i < TELNET_MAX_CLIENTS; i++) { // Do not send broadcast messages to unauthenticated clients if (_telnetAuth && !_telnetClientsAuth[i]) { continue; } if (_telnetWrite(i, data, len)) ++count; } return count; } unsigned char _telnetWrite(const char *data) { return _telnetWrite(data, strlen(data)); } bool _telnetWrite(unsigned char clientId, const char * message) { return _telnetWrite(clientId, message, strlen(message)); } void _telnetData(unsigned char clientId, void *data, size_t len) { // Capture close connection char * p = (char *) data; if ((len >= 2) && (p[0] == TELNET_IAC)) { // C-d is sent as two bytes (sometimes repeating) if (p[1] == TELNET_XEOF) { _telnetDisconnect(clientId); } return; // Ignore telnet negotiation } if ((strncmp(p, "close", 5) == 0) || (strncmp(p, "quit", 4) == 0)) { _telnetDisconnect(clientId); return; } // Password prompt (disable on CORE variant) #ifdef ESPURNA_CORE const bool authenticated = true; #else const bool authenticated = _telnetClientsAuth[clientId]; #endif if (_telnetAuth && !authenticated) { String password = getAdminPass(); if (strncmp(p, password.c_str(), password.length()) == 0) { DEBUG_MSG_P(PSTR("[TELNET] Client #%d authenticated\n"), clientId); _telnetWrite(clientId, "Password correct, welcome!\n"); _telnetClientsAuth[clientId] = true; } else { _telnetWrite(clientId, "Password (try again): "); } return; } // Inject command #if TERMINAL_SUPPORT terminalInject(data, len); #endif } void _telnetNotifyConnected(unsigned char i) { DEBUG_MSG_P(PSTR("[TELNET] Client #%u connected\n"), i); #if TELNET_SERVER == TELNET_SERVER_ASYNC _telnetClients[i]->onAck([i](void *s, AsyncClient *c, size_t len, uint32_t time) { }, 0); _telnetClients[i]->onData([i](void *s, AsyncClient *c, void *data, size_t len) { _telnetData(i, data, len); }, 0); _telnetClients[i]->onDisconnect([i](void *s, AsyncClient *c) { _telnetDisconnect(i); }, 0); _telnetClients[i]->onError([i](void *s, AsyncClient *c, int8_t error) { DEBUG_MSG_P(PSTR("[TELNET] Error %s (%d) on client #%u\n"), c->errorToString(error), error, i); }, 0); _telnetClients[i]->onTimeout([i](void *s, AsyncClient *c, uint32_t time) { DEBUG_MSG_P(PSTR("[TELNET] Timeout on client #%u at %lu\n"), i, time); c->close(); }, 0); #endif // If there is no terminal support automatically dump info and crash data #if TERMINAL_SUPPORT == 0 info(); wifiDebug(); crashDump(); crashClear(); #endif #ifdef ESPURNA_CORE _telnetClientsAuth[i] = true; #else _telnetClientsAuth[i] = !_telnetAuth; if (_telnetAuth) { if (getAdminPass().length()) { _telnetWrite(i, "Password: "); } else { _telnetClientsAuth[i] = true; } } #endif wifiReconnectCheck(); } #if TELNET_SERVER == TELNET_SERVER_WIFISERVER void _telnetLoop() { if (_telnetServer.hasClient()) { int i; for (i = 0; i < TELNET_MAX_CLIENTS; i++) { if (!_telnetClients[i] || !_telnetClients[i]->connected()) { _telnetClients[i] = std::unique_ptr(new WiFiClient(_telnetServer.available())); if (_telnetClients[i]->localIP() != WiFi.softAPIP()) { // Telnet is always available for the ESPurna Core image #ifdef ESPURNA_CORE bool telnetSTA = true; #else bool telnetSTA = getSetting("telnetSTA", TELNET_STA).toInt() == 1; #endif if (!telnetSTA) { DEBUG_MSG_P(PSTR("[TELNET] Rejecting - Only local connections\n")); _telnetDisconnect(i); return; } } _telnetNotifyConnected(i); break; } } //no free/disconnected spot so reject if (i == TELNET_MAX_CLIENTS) { DEBUG_MSG_P(PSTR("[TELNET] Rejecting - Too many connections\n")); _telnetServer.available().stop(); return; } } for (int i = 0; i < TELNET_MAX_CLIENTS; i++) { if (_telnetClients[i]) { // Handle client timeouts if (!_telnetClients[i]->connected()) { _telnetDisconnect(i); } else { // Read data from clients while (_telnetClients[i] && _telnetClients[i]->available()) { char data[TERMINAL_BUFFER_SIZE]; size_t len = _telnetClients[i]->available(); unsigned int r = _telnetClients[i]->readBytes(data, min(sizeof(data), len)); _telnetData(i, data, r); } } } } } #else // TELNET_SERVER_ASYNC void _telnetNewClient(AsyncClient* client) { if (client->localIP() != WiFi.softAPIP()) { // Telnet is always available for the ESPurna Core image #ifdef ESPURNA_CORE bool telnetSTA = true; #else bool telnetSTA = getSetting("telnetSTA", TELNET_STA).toInt() == 1; #endif if (!telnetSTA) { DEBUG_MSG_P(PSTR("[TELNET] Rejecting - Only local connections\n")); client->onDisconnect([](void *s, AsyncClient *c) { delete c; }); client->close(true); return; } } for (unsigned char i = 0; i < TELNET_MAX_CLIENTS; i++) { if (!_telnetClients[i] || !_telnetClients[i]->connected()) { _telnetClients[i] = std::unique_ptr(client); _telnetNotifyConnected(i); return; } } DEBUG_MSG_P(PSTR("[TELNET] Rejecting - Too many connections\n")); client->onDisconnect([](void *s, AsyncClient *c) { delete c; }); client->close(true); } #endif // TELNET_SERVER == TELNET_SERVER_WIFISERVER // ----------------------------------------------------------------------------- // Public API // ----------------------------------------------------------------------------- bool telnetConnected() { for (unsigned char i = 0; i < TELNET_MAX_CLIENTS; i++) { if (_telnetClients[i] && _telnetClients[i]->connected()) return true; } return false; } unsigned char telnetWrite(unsigned char ch) { char data[1] = {ch}; return _telnetWrite(data, 1); } void _telnetConfigure() { _telnetAuth = getSetting("telnetAuth", TELNET_AUTHENTICATION).toInt() == 1; } void telnetSetup() { #if TELNET_SERVER == TELNET_SERVER_WIFISERVER espurnaRegisterLoop(_telnetLoop); _telnetServer.setNoDelay(true); _telnetServer.begin(); #else _telnetServer.onClient([](void *s, AsyncClient* c) { _telnetNewClient(c); }, 0); _telnetServer.begin(); #endif #if WEB_SUPPORT wsRegister() .onVisible([](JsonObject& root) { root["telnetVisible"] = 1; }) .onConnected(_telnetWebSocketOnConnected) .onKeyCheck(_telnetWebSocketOnKeyCheck); #endif #if TELNET_REVERSE_SUPPORT #if MQTT_SUPPORT mqttRegister(_telnetReverseMQTTCallback); #endif #if TERMINAL_SUPPORT terminalRegisterCommand(F("TELNET.REVERSE"), [](Embedis* e) { if (e->argc < 3) { terminalError(F("Wrong arguments. Usage: TELNET.REVERSE ")); return; } String host = String(e->argv[1]); uint16_t port = String(e->argv[2]).toInt(); terminalOK(); _telnetReverse(host.c_str(), port); }); #endif #endif espurnaRegisterReload(_telnetConfigure); _telnetConfigure(); DEBUG_MSG_P(PSTR("[TELNET] %s server, Listening on port %d\n"), (TELNET_SERVER == TELNET_SERVER_WIFISERVER) ? "Sync" : "Async", TELNET_PORT); } #endif // TELNET_SUPPORT