Fix popular server processing to have defaults

Default value will also cause warnings to be printed.

Author: acv

src/conf.c

@@ -149,13 +149,17 @@ static const struct {
     "sslallowedcipherlist", oSSLAllowedCipherList}, {
 NULL, oBadOption},};
 
-static void config_notnull(const void *parm, const char *parmname);
+static void config_notnull(const void *, const char *);
 static int parse_boolean_value(char *);
 static void parse_auth_server(FILE *, const char *, int *);
-static int _parse_firewall_rule(const char *ruleset, char *leftover);
+static int _parse_firewall_rule(const char *, char *);
 static void parse_firewall_ruleset(const char *, FILE *, const char *, int *);
+static void parse_trusted_mac_list(const char *);
+static void parse_popular_servers(const char *);
+static void validate_popular_servers(void);
+static void add_popular_server(const char *);
 
-static OpCodes config_parse_token(const char *cp, const char *filename, int linenum);
+static OpCodes config_parse_token(const char *, const char *, int);
 
 /** Accessor for the current gateway configuration
 @return:  A pointer to the current config.  The pointer isn't opaque, but should be treated as READ-ONLY
@@ -633,7 +637,7 @@ void
 config_read(const char *filename)
 {
     FILE *fd;
-    char line[MAX_BUF], *s, *p1, *p2;
+    char line[MAX_BUF], *s, *p1, *p2, *rawarg = NULL;
     int linenum = 0, opcode, value;
     size_t len;
 
@@ -669,7 +673,7 @@ config_read(const char *filename)
                     break;
                 len = strlen(p1);
             }
-
+            rawarg = safe_strdup(p1);
             if ((p2 = strchr(p1, ' '))) {
                 p2[0] = '\0';
             } else if ((p2 = strstr(p1, "\r\n"))) {
@@ -722,7 +726,7 @@ config_read(const char *filename)
                     parse_trusted_mac_list(p1);
                     break;
                 case oPopularServers:
-                    parse_popular_servers(p1);
+                    parse_popular_servers(rawarg);
                     break;
                 case oHTTPDName:
                     config.httpdname = safe_strdup(p1);
@@ -791,6 +795,10 @@ config_read(const char *filename)
                 }
             }
         }
+        if (rawarg) {
+            free(rawarg);
+            rawarg = NULL;
+        }
     }
 
     if (config.httpdusername && !config.httpdpassword) {
@@ -823,7 +831,8 @@ parse_boolean_value(char *line)
     return -1;
 }
 
-/* Parse possiblemac to see if it is valid MAC address format */
+/**
+ * Parse possiblemac to see if it is valid MAC address format */
 int
 check_mac_format(char *possiblemac)
 {
@@ -834,7 +843,10 @@ check_mac_format(char *possiblemac)
                hex2, hex2, hex2, hex2, hex2, hex2) == 6;
 }
 
-void
+/** @internal
+ * Parse the trusted mac list.
+ */
+static void
 parse_trusted_mac_list(const char *ptr)
 {
     char *ptrcopy = NULL;
@@ -849,7 +861,7 @@ parse_trusted_mac_list(const char *ptr)
     /* strsep modifies original, so let's make a copy */
     ptrcopy = safe_strdup(ptr);
 
-    while ((possiblemac = strsep(&ptrcopy, ", "))) {
+    while ((possiblemac = strsep(&ptrcopy, ","))) {
         /* check for valid format */
         if (!check_mac_format(possiblemac)) {
             debug(LOG_ERR,
@@ -906,46 +918,61 @@ parse_trusted_mac_list(const char *ptr)
 
 }
 
-void
+/** @internal
+ * Add a popular server to the list. It prepends for simplicity.
+ * @param server The hostname to add.
+ */
+static void
+add_popular_server(const char *server)
+{
+    t_popular_server *p = NULL;
+
+    p = (t_popular_server *)safe_malloc(sizeof(t_popular_server));
+    p->hostname = safe_strdup(server);
+
+    if (config.popular_servers == NULL) {
+        p->next = NULL;
+        config.popular_servers = p;
+    } else {
+        p->next = config.popular_servers;
+        config.popular_servers = p;
+    }
+}
+
+static void
 parse_popular_servers(const char *ptr)
 {
     char *ptrcopy = NULL;
     char *hostname = NULL;
-    t_popular_server *p = NULL;
+    char *tmp = NULL;
 
     debug(LOG_DEBUG, "Parsing string [%s] for popular servers", ptr);
 
-    // max length of domain name is 253 characters
-    hostname = safe_malloc(254);
-
     /* strsep modifies original, so let's make a copy */
     ptrcopy = safe_strdup(ptr);
 
-    while ((hostname = strsep(&ptrcopy, ", "))) {
-        if (strcmp(hostname, "") == 0) {
+    while ((hostname = strsep(&ptrcopy, ","))) {  /* hostname does *not* need allocation. strsep
+                                                     provides a pointer in ptrcopy. */
+        /* Skip leading spaces. */
+        while (*hostname != '\0' && isblank(*hostname)) { 
+            hostname++;
+        }
+        if (*hostname == '\0') {  /* Equivalent to strcmp(hostname, "") == 0 */
             continue;
         }
-        debug(LOG_DEBUG, "Adding Popular Server [%s] to list", hostname);
-
-        if (config.popular_servers == NULL) {
-            config.popular_servers = safe_malloc(sizeof(t_popular_server));
-            config.popular_servers->hostname = safe_strdup(hostname);
-            config.popular_servers->next = NULL;
-        } else {
-            p = config.popular_servers;
-            /* Advance to the last entry */
-            while (p->next != NULL) {
-                p = p->next;
-            }
-            p->next = safe_malloc(sizeof(t_popular_server));
-            p = p->next;
-            p->hostname = safe_strdup(hostname);
-            p->next = NULL;
+        /* Remove any trailing blanks. */
+        tmp = hostname;
+        while (*tmp != '\0' && !isblank(*tmp)) {
+            tmp++;
         }
+        if (*tmp != '\0' && isblank(*tmp)) {
+            *tmp = '\0';
+        }
+        debug(LOG_DEBUG, "Adding Popular Server [%s] to list", hostname);
+        add_popular_server(hostname);
     }
 
     free(ptrcopy);
-    free(hostname);
 }
 
 /** Verifies if the configuration is complete and valid.  Terminates the program if it isn't */
@@ -954,13 +981,27 @@ config_validate(void)
 {
     config_notnull(config.gw_interface, "GatewayInterface");
     config_notnull(config.auth_servers, "AuthServer");
+    validate_popular_servers();
 
     if (missing_parms) {
         debug(LOG_ERR, "Configuration is not complete, exiting...");
         exit(-1);
     }
 }
 
+/** @internal
+ * Validate that popular servers are populated or log a warning and set a default.
+ */
+static void
+validate_popular_servers(void)
+{
+    if (config.popular_servers == NULL) {
+        debug(LOG_WARNING, "PopularServers not set in config file, this will become fatal in a future version.");
+        add_popular_server("www.google.com");
+        add_popular_server("www.yahoo.com");
+    }
+}
+
 /** @internal
     Verifies that a required parameter is not a null pointer
 */

src/conf.h

@@ -218,9 +218,6 @@ void mark_auth_server_bad(t_auth_serv *);
 /** @brief Fetch a firewall rule set. */
 t_firewall_rule *get_ruleset(const char *);
 
-void parse_trusted_mac_list(const char *);
-
-void parse_popular_servers(const char *);
 
 #define LOCK_CONFIG() do { \
 	debug(LOG_DEBUG, "Locking config"); \