Revision 25:a740eb74a86a, committed 2013-07-22

Comitter:

WiredHome

Date:

Mon Jul 22 02:12:53 2013 +0000

Parent:

24:5012a535b1d5

Child:

26:78a1a09afdc9

Commit message:

Improve security, and small formatting changes for more consistency.

Changed in this revision

--- a/Wifly/Wifly.cpp	Sun Jul 21 23:26:58 2013 +0000
+++ b/Wifly/Wifly.cpp	Mon Jul 22 02:12:53 2013 +0000
@@ -21,6 +21,9 @@
 #include <string>
 #include <algorithm>
 
+// Defined to disable remote configuration via telnet which increases security of this device.
+#define INCREASE_SECURITY
+
 #define DEBUG       //Debug is disabled by default
 
 #if (defined(DEBUG) && !defined(TARGET_LPC11U24))
@@ -51,8 +54,27 @@
     inst = this;
     attach_rx(false);
     state.cmd_mode = false;
+    wiflyVersionString = NULL;
 }
 
+
+Wifly::~Wifly()
+{
+    if (ssid) {
+        free(ssid);
+        ssid = NULL;
+    }
+    if (phrase) {
+        free(phrase);
+        phrase = NULL;
+    }
+    if (wiflyVersionString) {
+        free(wiflyVersionString);
+        wiflyVersionString = NULL;
+    }
+}
+
+
 bool Wifly::join()
 {
     char cmd[20];
@@ -91,6 +113,13 @@
         if (!sendCommand("set i f 0x7\r", "AOK"))
             continue;
 
+#ifdef INCREASE_SECURITY
+        // tcp-mode 0x10 = disable remote configuration
+        // only in SW 2.27 and higher (see 2.3.39)
+        if ((swVersion >= 2.27) && (!sendCommand("set i t 0x10\r", "AOK")))
+            continue;
+#endif
+
         // set dns server
         if (!sendCommand("set d n rn.microchip.com\r", "AOK"))
             continue;
@@ -186,6 +215,7 @@
     return true;
 }
 
+
 char * Wifly::getStringSecurity()
 {
     switch(state.sec) {
@@ -199,6 +229,7 @@
     return "UNKNOWN";
 }
 
+
 bool Wifly::connect(const char * host, int port)
 {
     char rcv[20];
@@ -208,7 +239,7 @@
     sprintf(cmd, "open %s %d\r", host, port);
     if (sendCommand(cmd, "OPEN", NULL, 10000)) {
         state.tcp = true;
-        state.cmd_mode = false;
+        exit();
         return true;
     }
 
@@ -216,10 +247,8 @@
     if (sendCommand(cmd, NULL, rcv, 5000)) {
         if (strstr(rcv, "OPEN") == NULL) {
             if (strstr(rcv, "Connected") != NULL) {
-                wait(0.25);
                 if (!sendCommand("close\r", "CLOS"))
                     return false;
-                wait(0.25);
                 if (!sendCommand(cmd, "OPEN", NULL, 10000))
                     return false;
             } else {
@@ -231,8 +260,7 @@
     }
 
     state.tcp = true;
-    state.cmd_mode = false;
-
+    exit();
     return true;
 }
 
@@ -287,6 +315,7 @@
     buf_wifly.flush();
 }
 
+
 bool Wifly::sendCommand(const char * cmd, const char * ack, char * res, int timeout)
 {
     int tries = 1;
@@ -305,12 +334,14 @@
     return false;
 }
 
+
 bool Wifly::cmdMode()
 {
     // if already in cmd mode, return
     if (state.cmd_mode)
         return true;
 
+    wait_ms(250);   // manual 1.2.1 (250 msec before and after)
     if (send("$$$", 3, "CMD") == -1) {
         ERR("cannot enter in cmd mode\r\n");
         exit();
@@ -320,6 +351,7 @@
     return true;
 }
 
+
 bool Wifly::disconnect()
 {
     // if already disconnected, return
@@ -335,6 +367,7 @@
 
 }
 
+
 bool Wifly::is_connected()
 {
     return (tcp_status.read() ==  1) ? true : false;
@@ -344,30 +377,32 @@
 void Wifly::reset()
 {
     reset_pin = 0;
-    wait(0.2);
+    wifi.baud(9600);
+    wait_ms(200);
     reset_pin = 1;
-    wait(0.2);
+    GatherLogonInfo();
 }
 
+
 bool Wifly::reboot()
 {
     // if already in cmd mode, return
     if (!sendCommand("reboot\r"))
         return false;
-
-    wait(0.3);
-
-    state.cmd_mode = false;
+    wait_ms(300);
+    wifi.baud(9600);
+    baud(baudrate);
+    exit();
     return true;
 }
 
+
 bool Wifly::close()
 {
     // if not connected, return
     if (!state.tcp)
         return true;
 
-    wait(0.25);
     if (!sendCommand("close\r", "CLOS"))
         return false;
     exit();
@@ -379,20 +414,17 @@
 
 int Wifly::putc(char c)
 {
-    while (!wifi.writeable());
+    while (!wifi.writeable())
+        ;
     return wifi.putc(c);
 }
 
 
 bool Wifly::exit()
 {
-    flush();
-    if (!state.cmd_mode)
-        return true;
     if (!sendCommand("exit\r", "EXIT"))
         return false;
     state.cmd_mode = false;
-    flush();
     return true;
 }
 
@@ -402,19 +434,23 @@
     return buf_wifly.available();
 }
 
+
 int Wifly::writeable()
 {
     return wifi.writeable();
 }
 
+
 char Wifly::getc()
 {
     char c;
-    while (!buf_wifly.available());
+    while (!buf_wifly.available())
+        ;
     buf_wifly.dequeue(&c);
     return c;
 }
 
+
 void Wifly::handler_rx(void)
 {
     //read characters
@@ -422,6 +458,7 @@
         buf_wifly.queue(wifi.getc());
 }
 
+
 void Wifly::attach_rx(bool callback)
 {
     if (!callback)
@@ -440,9 +477,7 @@
     int result = 0;
 
     DBG("send in %d ms this: %s", timeout, str);
-
     attach_rx(false);
-
     flushIn();
     tmr.start();
     if (!ACK || !strcmp(ACK, "NO")) {
@@ -489,7 +524,7 @@
             } else {
                 if (wifi.readable()) {
                     read = wifi.getc();
-                    // we drop \r and \n
+                    // we drop \r and \n, but should we since it is for user code...
                     if ( read != '\r' && read != '\n') {
                         res[i++] = read;
                     }
@@ -516,7 +551,9 @@
 #endif
 
     if (timeout_ms == 0) {
-        timeout_ms = 2;
+        timeout_ms = 2 * 10000 / baudrate;  // compute minimal timeout
+        if (timeout_ms < 2)
+            timeout_ms = 2;
     }
     tmr.start();
     while (wifi.readable() || (tmr.read_ms() < timeout_ms)) {
@@ -585,6 +622,7 @@
     return res;
 }
 
+
 int Wifly::timeToRespond(int stringLen) 
 {
     return 150 + (1 | 10000/baudrate) * stringLen;
@@ -605,3 +643,49 @@
         *dst = NULL;
     }
 }
+
+
+void Wifly::GatherLogonInfo()
+{
+    Timer timer;
+    char logonText[200];
+    int i = 0;
+    char *p;
+
+    timer.start();
+    if (wiflyVersionString) {
+        free(wiflyVersionString);
+        wiflyVersionString = NULL;
+    }
+    logonText[i] = '\0';
+    while (timer.read_ms() < 500) {
+        while (wifi.readable()) {
+            logonText[i++] = wifi.getc();
+        }
+    }
+    logonText[i] = '\0';
+    p = strchr(logonText, '\r');
+    if (p)
+        *p = '\0';
+    wiflyVersionString = (char *)malloc(strlen(logonText)+1);
+    if (wiflyVersionString)
+        strcpy(wiflyVersionString, logonText);
+    p = strstr(logonText, "Ver ");
+    if (p) {
+        p += 4;
+        swVersion = atof(p);
+    }
+}
+
+
+float Wifly::getWiflyVersion()
+{
+    return swVersion;
+}
+
+
+char * Wifly::getWiflyVersionString()
+{
+    return wiflyVersionString;
+}
+

--- a/Wifly/Wifly.h	Sun Jul 21 23:26:58 2013 +0000
+++ b/Wifly/Wifly.h	Mon Jul 22 02:12:53 2013 +0000
@@ -62,9 +62,14 @@
     * @param phrase WEP or WPA key
     * @param sec Security type (NONE, WEP_128 or WPA)
     */
-    Wifly(  PinName tx, PinName rx, PinName reset, PinName tcp_status, const char * ssid, const char * phrase, Security sec);
+    Wifly(PinName tx, PinName rx, PinName reset, PinName tcp_status, const char * ssid, const char * phrase, Security sec);
 
     /**
+    * Destructor to clean up
+    */
+    ~Wifly();
+    
+    /**
     * Connect the wifi module to the ssid contained in the constructor.
     *
     * @return true if connected, false otherwise
@@ -235,6 +240,34 @@
     */
     bool baud(int baudrate);
 
+
+
+    /**
+    * Sets the connection state. 
+    *
+    * Typically used by external apps that detect an incoming connection.
+    *
+    * @param state sets the connection state to true or false
+    */
+    void setConnectionState(bool state);
+
+    /**
+    * Get the version information from the Wifly module.
+    *
+    * @returns the version information as a string, or NULL
+    */
+    char * getWiflyVersionString();
+    
+    /**
+    * Get the software version from the Wifly module.
+    *
+    * This extracts the basic version number (e.g. 2.38, 4.00)
+    * as a float.
+    *
+    * @returns the software version number as a float.
+    */
+    float getWiflyVersion();
+
     static Wifly * getInstance() {
         return inst;
     };
@@ -246,6 +279,8 @@
     int baudrate;
     char * phrase;
     char * ssid;
+    char * wiflyVersionString;
+    float swVersion;
     const char * ip;
     const char * netmask;
     const char * gateway;
@@ -291,6 +326,11 @@
     */
     void FixPhrase(char ** dst, const char * src);
 
+    /**
+    * Gather the Wifly module version information for later queries
+    */
+    void GatherLogonInfo();
+
 };
 
 #endif
\ No newline at end of file