Changeset 81

Timestamp:

04/17/04 15:03:54 (9 years ago)

Author:

alexcv

Message:

Updated documentation in friewall.c

Location:

trunk/wifidog

Files:

• ChangeLog (modified) (3 diffs)
• src/firewall.c (modified) (9 diffs)

trunk/wifidog/ChangeLog

@@ +1 @@
+# $Header$
+
+2004-04-16  Alexandre Carmel-Veilleux <acv@acv.ca>
+        * Updated documentation in firewall.c
+
 2004-04-17  Philippe April <papril777@yahoo.com>
         * Fixed path returning to gateway in phpauth/login/index.php
@@ -6 +11 @@
 
 2004-04-16  Philippe April <papril777@yahoo.com>
-    * Fixed CRLF/formatting in phpauth/login/index.php
-    * Added some documentation for firewall.c, commandline.c
-    * Removed an unnecessary line dist_sysconf_DATA from Makefile.am
+        * Fixed CRLF/formatting in phpauth/login/index.php
+        * Added some documentation for firewall.c, commandline.c
+        * Removed an unnecessary line dist_sysconf_DATA from Makefile.am
 
 2004-04-15  Alexandre Carmel-Veilleux <acv@acv.ca>
@@ -67 +72 @@
 
 2004-03-13  Philippe April <papril777@yahoo.com>
-    * Modified the way firewall scripts are called so we can configure
-    them in the config file (a bit more modular than it was)
-    * Added simple linked list to keep track of clients and to
-    keep a counter of the utilization and send it to the auth
-    server
-    * Fixed CRLF/formatting in phpauth/auth/index.php
-    * Hacked phpauth/auth/index.php to handle very basic utilization tracking
+        * Modified the way firewall scripts are called so we can configure
+        them in the config file (a bit more modular than it was)
+        * Added simple linked list to keep track of clients and to
+        keep a counter of the utilization and send it to the auth server
+        * Fixed CRLF/formatting in phpauth/auth/index.php
+        * Hacked phpauth/auth/index.php to handle very basic utilization tracking
 
 2004-03-12  Philippe April <papril777@yahoo.com>
-    * Changed all perror()s into debug()s and added
-    errno.h to common.h
+        * Changed all perror()s into debug()s and added errno.h to common.h
 
 2004-03-10  Philippe April <papril777@yahoo.com>
-    * Small fix to firewall.c so we don't define variables after
-    the function has started (so it builds on gcc-2.95)
+        * Small fix to firewall.c so we don't define variables after
+        the function has started (so it builds on gcc-2.95)
 
 2004-03-09  Philippe April <papril777@yahoo.com>
-    * Major changes: not forking anymore for new connections, now using
-    select() instead. It will allow us to efficiently use a linked list to track
-    users and other things. It introduces some bugs and design issues but will
-    be better in the end.
+        * Major changes, not forking anymore for new connections, now using
+        select() instead. It will allow us to efficiently use a linked list to track
+        users and other things. It introduces some bugs and design issues but will
+        be better in the end.
 
 2004-03-09  Philippe April <papril777@yahoo.com>
-    * Small fix in the default.php login page
-    * exit() where the program was supposed to exit but wasn't when the
-    firewall could not be setup
+        * Small fix in the default.php login page
+        * exit() where the program was supposed to exit but wasn't when the
+        firewall could not be setup
 
 2004-03-09  Alexandre Carmel-Veilleux <acv@acv.ca>

trunk/wifidog/src/firewall.c

@@ -242 +242 @@
                         if (rc == 4 && rc != EOF) {
 
-                                /* TODO If the client is not active for x
-                                 * seconds timeout the client and destroy token.
-                                 * Maybe this should be done on the auth
-                                 * server */
-                        
                                 pthread_mutex_lock(&nodes_mutex);
 
@@ -252 +247 @@
 
                                 if (p1->counter == counter) {
+                                        /* expire clients for inactivity */
                                         debug(D_LOG_DEBUG, "Client %s was "
                                                 "inactive", ip);
@@ -313 +309 @@
 }
 
+/**
+ * @brief Initializes the list of connected clients (node)
+ */
 void
 node_init(void)
@@ -320 +319 @@
 }
 
+/**
+ * @brief Adds a new node to the connections list
+ *
+ * Based on the parameters it receives, this function creates a new entry
+ * in the connections list. All the memory allocation is done here.
+ */
 t_node *
 node_add(char *ip, char *mac, char *token, long int counter, int active)
@@ -361 +366 @@
 }
 
+/**
+ * @brief Finds a specific node by its IP
+ */
 t_node *
 node_find_by_ip(char *ip)
@@ -376 +384 @@
 }
 
+/**
+ * @brief Finds a specific node by its token
+ */
 t_node *
 node_find_by_token(char *token)
@@ -391 +402 @@
 }
 
+/**
+ * @brief Frees the memory used by a t_node structure
+ *
+ * This function frees the memory used by the t_node structure in the
+ * proper order. It also calls the free_userrights() function to free
+ * the memory used by the rights structure for the node.
+ */
 void
 free_node(t_node *node)
@@ -410 +428 @@
 }
 
+/**
+ * @brief Deletes a node from the connections list
+ *
+ * Removes the specified node from the connections list and then calls
+ * the function to free the memory used by the node.
+ */
 void
 node_delete(t_node *node)
@@ -430 +454 @@
 }
 
+/**
+ * @brief Check the rights for a client
+ *
+ * This function validates that a client hasn't met one of the conditions
+ * for the termination of his connection. Right now, we only check to see
+ * for a time-out. More checks could be added here.
+ */
 int
 check_userrights(t_node *node)