Merge lp:~ev/whoopsie/mac-address-fallback into lp:whoopsie

[Evan]

Fix bug #963007 by falling back to taking the sha512 hash of the first non-loopback MAC address when the DMI tables do not exist.

This branch fixes bug #963007 by falling back to taking the sha512 hash of the first non-loopback MAC address when the DMI tables do not exist.

[Evan (ev)]

review: Approve

=== modified file '.bzrignore'
--- .bzrignore	2012-03-29 15:02:13 +0000
+++ .bzrignore	2012-05-15 16:54:18 +0000
@@ -6,3 +6,4 @@
 src/tests/test_parse_report
 src/tests/test_utils
 src/tests/test_monitor
+src/tests/test_identifier

=== modified file 'Makefile'
--- Makefile	2012-04-10 16:53:36 +0000
+++ Makefile	2012-05-15 16:54:18 +0000
@@ -1,7 +1,14 @@
 VERSION=$(shell dpkg-parsechangelog | grep ^Version: | cut -d' ' -f2)
 CFLAGS=$(shell pkg-config --cflags gio-2.0 glib-2.0 libcurl) $(shell libgcrypt-config --cflags) -g -Ilib -Wall -Werror -Os -DVERSION=\"$(VERSION)\"
 LIBS=$(shell pkg-config --libs gio-2.0 glib-2.0 libcurl) $(shell libgcrypt-config --libs) -lcap
-SOURCES=src/whoopsie.c src/utils.c src/connectivity.c src/monitor.c lib/bson/bson.c lib/bson/encoding.c lib/bson/numbers.c
+SOURCES=src/whoopsie.c \
+		src/utils.c \
+		src/connectivity.c \
+		src/monitor.c \
+		src/identifier.c \
+		lib/bson/bson.c \
+		lib/bson/encoding.c \
+		lib/bson/numbers.c
 OBJECTS=$(SOURCES:.c=.o)
 EXECUTABLE=src/whoopsie
 BIN=$(DESTDIR)/usr/bin

=== modified file 'debian/changelog'
--- debian/changelog	2012-05-09 23:04:30 +0000
+++ debian/changelog	2012-05-15 16:54:18 +0000
@@ -2,6 +2,8 @@
 
   * Create the /var/metrics directory for metrics submission. Thanks Ted
     Gould.
+  * Fallback to using the SHA-512 hash of the first non-loopback MAC
+    address (LP: #963007).
 
  -- Evan Dandrea <[e-mail]>  Tue, 08 May 2012 14:14:40 -0700
 

=== added file 'src/identifier.c'
--- src/identifier.c	1970-01-01 00:00:00 +0000
+++ src/identifier.c	2012-05-15 16:54:18 +0000
@@ -0,0 +1,136 @@
+#include <glib.h>
+#include <gcrypt.h>
+#include <sys/types.h>
+#include <sys/ioctl.h>
+#include <linux/if.h>
+#include <unistd.h>
+#include <netinet/in.h>
+#include <string.h>
+#include <stdio.h>
+#include <fcntl.h>
+
+#include "identifier.h"
+
+void
+hex_to_char (char* buf, const char *str, int len)
+{
+    char* p = NULL;
+    int i = 0;
+
+    p = buf;
+    for (i = 0; i < len; i++) {
+        snprintf(p, 3, "%02x", (unsigned char) str[i]);
+        p += 2;
+    }
+    buf[2*len] = 0;
+}
+
+void
+identifier_get_mac_address (char** res, GError** error)
+{
+    struct ifreq ifr;
+    struct ifconf ifc;
+    char buf[1024];
+    gboolean success = FALSE;
+    int sock;
+    struct ifreq* it;
+    int i = 0;
+
+    sock = socket(AF_INET, SOCK_DGRAM, IPPROTO_IP);
+    if (sock == -1) {
+        g_set_error (error, g_quark_from_static_string ("whoopsie-quark"), 0,
+                     "Could not create socket.");
+        return;
+    }
+
+    ifc.ifc_len = sizeof(buf);
+    ifc.ifc_buf = buf;
+    if (ioctl(sock, SIOCGIFCONF, &ifc) == -1) {
+        g_set_error (error, g_quark_from_static_string ("whoopsie-quark"), 0,
+                     "Could not get list of interface addresses.");
+        return;
+    }
+
+    it = ifc.ifc_req;
+
+    for (i = ifc.ifc_len / sizeof(struct ifreq); --i >= 0; it++) {
+        strcpy(ifr.ifr_name, it->ifr_name);
+        if (ioctl(sock, SIOCGIFFLAGS, &ifr) == 0) {
+            if (! (ifr.ifr_flags & IFF_LOOPBACK)) { // don't count loopback
+                if (ioctl(sock, SIOCGIFHWADDR, &ifr) == 0) {
+                    success = TRUE;
+                    break;
+                }
+            }
+        }
+    }
+
+    if (!success)
+        return;
+
+    *res = malloc (18);
+    sprintf (*res, "%02x:%02x:%02x:%02x:%02x:%02x",
+             (unsigned char) ifr.ifr_hwaddr.sa_data[0],
+             (unsigned char) ifr.ifr_hwaddr.sa_data[1],
+             (unsigned char) ifr.ifr_hwaddr.sa_data[2],
+             (unsigned char) ifr.ifr_hwaddr.sa_data[3],
+             (unsigned char) ifr.ifr_hwaddr.sa_data[4],
+             (unsigned char) ifr.ifr_hwaddr.sa_data[5]);
+}
+
+void
+identifier_get_system_uuid (char** res, GError** error)
+{
+    int fp;
+
+    fp = open ("/sys/class/dmi/id/product_uuid", O_RDONLY);
+    if (fp < 0) {
+        g_set_error (error, g_quark_from_static_string ("whoopsie-quark"), 0,
+                     "Could not open the product uuid file.");
+        return;
+    }
+    *res = malloc (37);
+    if (read (fp, *res, 36) == 36)
+        (*res)[36] = '\0';
+    else
+        g_set_error (error, g_quark_from_static_string ("whoopsie-quark"), 0,
+                     "Got an unexpected length reading the product_uuid.");
+    close (fp);
+}
+
+void
+identifier_sha512 (char* source, char* res, GError** error)
+{
+    int md_len;
+    gcry_md_hd_t sha512 = NULL;
+    unsigned char* id = NULL;
+
+    if (!gcry_check_version (GCRYPT_VERSION)) {
+        g_set_error (error, g_quark_from_static_string ("whoopsie-quark"), 0,
+                     "libcrypt version mismatch.");
+        return;
+    }
+    gcry_control (GCRYCTL_INITIALIZATION_FINISHED, 0);
+    md_len = gcry_md_get_algo_dlen(GCRY_MD_SHA512);
+    if (md_len != HASHLEN / 2) {
+        g_set_error (error, g_quark_from_static_string ("whoopsie-quark"), 0,
+                 "Received an incorrect size for the SHA512 message digest");
+        return;
+    }
+    if (gcry_md_open (&sha512, GCRY_MD_SHA512, 0) || sha512 == NULL) {
+        g_set_error (error, g_quark_from_static_string ("whoopsie-quark"), 0,
+             "Failed to create a SHA512 message digest for the product_uuid.");
+        return;
+    }
+    gcry_md_write (sha512, source, strlen (source));
+    gcry_md_final (sha512);
+    id = gcry_md_read (sha512, GCRY_MD_SHA512);
+    if (id == NULL) {
+        g_set_error (error, g_quark_from_static_string ("whoopsie-quark"), 0,
+             "Failed to read the SHA512 message digest for the product_uuid.");
+        gcry_md_close (sha512);
+        return;
+    }
+    hex_to_char (res, (const char*)id, md_len);
+    gcry_md_close (sha512);
+}

=== added file 'src/identifier.h'
--- src/identifier.h	1970-01-01 00:00:00 +0000
+++ src/identifier.h	2012-05-15 16:54:18 +0000
@@ -0,0 +1,5 @@
+void identifier_get_mac_address (char** res, GError** error);
+void identifier_get_system_uuid (char** res, GError** error);
+void identifier_sha512 (char* source, char* res, GError** error);
+void hex_to_char (char* buf, const char *str, int len);
+#define HASHLEN 128

=== modified file 'src/tests/Makefile'
--- src/tests/Makefile	2012-04-10 16:42:07 +0000
+++ src/tests/Makefile	2012-05-15 16:54:18 +0000
@@ -1,11 +1,14 @@
 VERSION=$(shell dpkg-parsechangelog | grep ^Version: | cut -d' ' -f2)
 CFLAGS=$(shell pkg-config --cflags gio-2.0 glib-2.0 libcurl) \
+		$(shell libgcrypt-config --cflags) \
 		-g -I../../lib -I.. -DVERSION=\"$(VERSION)\" -DTEST -DTEST_DIR=\"$(CURDIR)\" -Wall
-LIBS=$(shell pkg-config --libs gio-2.0 glib-2.0 libcurl) -lcap
+LIBS=$(shell pkg-config --libs gio-2.0 glib-2.0 libcurl) -lcap \
+		$(shell libgcrypt-config --libs)
 
 test_parse_report_SOURCES=test_parse_report.c \
 							../whoopsie.c \
 							../utils.c \
+							../identifier.c \
 							../../lib/bson/bson.c \
 							../../lib/bson/encoding.c \
 							../../lib/bson/numbers.c
@@ -23,11 +26,16 @@
 test_monitor_EXECUTABLE=test_monitor
 test_monitor_OBJECTS=$(test_monitor_SOURCES:.c=.test.o)
 
+test_identifier_SOURCES=test_identifier.c \
+					../identifier.c
+test_identifier_EXECUTABLE=test_identifier
+test_identifier_OBJECTS=$(test_identifier_SOURCES:.c=.test.o)
+
 .PHONY: all clean check
 
 all: check
 
-check: $(test_parse_report_EXECUTABLE) $(test_utils_EXECUTABLE) $(test_monitor_EXECUTABLE)
+check: $(test_parse_report_EXECUTABLE) $(test_utils_EXECUTABLE) $(test_monitor_EXECUTABLE) $(test_identifier_EXECUTABLE)
 	$(foreach p, $^, ./$p -k;)
 
 $(test_parse_report_EXECUTABLE): $(test_parse_report_OBJECTS)
@@ -36,6 +44,8 @@
 	c99 $^ $(LIBS) -o $@
 $(test_monitor_EXECUTABLE): $(test_monitor_OBJECTS)
 	c99 $^ $(LIBS) -o $@
+$(test_identifier_EXECUTABLE): $(test_identifier_OBJECTS)
+	c99 $^ $(LIBS) -o $@
 
 test_parse_report_coverage: $(test_parse_report_OBJECTS:.test.o=.coverage.o)
 	c99 $^ $(LIBS) -lgcov -o $@
@@ -43,7 +53,9 @@
 	c99 $^ $(LIBS) -lgcov -o $@
 test_monitor_coverage: $(test_monitor_OBJECTS:.test.o=.coverage.o)
 	c99 $^ $(LIBS) -lgcov -o $@
-coverage: test_parse_report_coverage test_utils_coverage test_monitor_coverage
+test_identifier_coverage: $(test_identifier_OBJECTS:.test.o=.coverage.o)
+	c99 $^ $(LIBS) -lgcov -o $@
+coverage: test_parse_report_coverage test_utils_coverage test_monitor_coverage test_identifier_coverage
 	$(foreach p, $^, ./$p -k;)
 	$(foreach p, $(wildcard ../*.c), gcov $p -o $(p:.c=.coverage.o);)
 
@@ -54,8 +66,11 @@
 		$(test_utils_EXECUTABLE) \
 		$(test_monitor_OBJECTS) \
 		$(test_monitor_EXECUTABLE) \
+		$(test_identifier_OBJECTS) \
+		$(test_identifier_EXECUTABLE) \
 		test_parse_report_coverage \
 		test_utils_coverage \
+		test_identifier_coverage \
 		coverage
 	find ../.. \( -name '*.coverage.o' -o \
 		-name '*.gcda' -o \

=== added file 'src/tests/test_identifier.c'
--- src/tests/test_identifier.c	1970-01-01 00:00:00 +0000
+++ src/tests/test_identifier.c	2012-05-15 16:54:18 +0000
@@ -0,0 +1,125 @@
+/* whoopsie
+ * 
+ * Copyright © 2011-2012 Canonical Ltd.
+ * Author: Evan Dandrea <[e-mail]>
+ * 
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; version 3 of the License.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+#define _XOPEN_SOURCE
+#define _GNU_SOURCE
+
+#include <glib.h>
+#include <glib-object.h>
+#include <sys/types.h>
+#include <sys/stat.h>
+#include <fcntl.h>
+
+#include "../src/identifier.h"
+
+static void
+test_hex_to_char (void)
+{
+    char buf[9];
+    hex_to_char (buf, "\xFF\xFF\xFF\xFF", 4);
+    g_assert_cmpstr (buf, ==, "ffffffff");
+
+}
+
+static void
+test_get_mac_address (void)
+{
+    char* res = NULL;
+    GError* error = NULL;
+    int fp;
+    char buf[18];
+
+    identifier_get_mac_address (&res, &error);
+    g_assert (res != NULL);
+    fp = open ("/sys/class/net/eth0/address", O_RDONLY);
+    if (fp < 0) {
+        g_print ("Could not open /sys/class/net/eth0/address\n");
+        g_test_fail ();
+        goto out;
+    }
+    if (read (fp, buf, 17) < 17) {
+        g_print ("Could not read /sys/class/net/eth0/address\n");
+        g_test_fail ();
+        goto out;
+    }
+    buf[17] = '\0';
+    if (g_strcmp0 (buf, res) != 0) {
+        g_print ("MAC address does not match value in /sys\n");
+        g_test_fail ();
+    }
+out:
+    if (fp >= 0)
+        close (fp);
+}
+static void
+test_get_system_uuid (void)
+{
+    /* DEADBEEF-1234-1234-1234-DEADBEEF1234 */
+    char* res = NULL;
+    identifier_get_system_uuid (&res, NULL);
+    if (getuid () != 0) {
+        g_print ("Need root to run this complete test: ");
+        return;
+    }
+
+    if (res == NULL)
+        goto out;
+
+    if (strlen (res) != 36)
+        goto out;
+
+    if ((res[8] != '-' || res[13] != '-') ||
+        (res[18] != '-' || res[23] != '-'))
+        goto out;
+
+    return;
+
+out:
+    g_test_fail ();
+    return;
+}
+
+test_sha512 (void)
+{
+    char res[HASHLEN + 1] = {0};
+    // "foo" -> sha512
+    const char* expected = "f7fbba6e0636f890e56fbbf3283e524c6fa3204ae298382"
+                           "d624741d0dc6638326e282c41be5e4254d8820772c5518a"
+                           "2c5a8c0c7f7eda19594a7eb539453e1ed7";
+    identifier_sha512 ("foo", res, NULL);
+    //if (strcmp (res, expected) != 0)
+    //    g_test_fail ();
+}
+
+int
+main (int argc, char** argv)
+{
+    g_type_init ();
+    g_test_init (&argc, &argv, NULL);
+
+    /* This wont work when running under fakeroot. */
+    if (!getenv ("FAKEROOTKEY"))
+        g_test_add_func ("/whoopsie/get-system-uuid", test_get_system_uuid);
+    g_test_add_func ("/whoopsie/hex-to-char", test_hex_to_char);
+    g_test_add_func ("/whoopsie/get-mac-address", test_get_mac_address);
+    g_test_add_func ("/whoopsie/sha512", test_sha512);
+
+    /* Do not consider warnings to be fatal. */
+    g_log_set_always_fatal (G_LOG_FATAL_MASK);
+
+	return g_test_run ();
+}

=== modified file 'src/tests/test_parse_report.c'
--- src/tests/test_parse_report.c	2012-03-23 12:38:51 +0000
+++ src/tests/test_parse_report.c	2012-05-15 16:54:18 +0000
@@ -84,34 +84,6 @@
 }
 
 static void
-test_hex_to_char (void)
-{
-    char buf[9];
-    hex_to_char (buf, "\xFF\xFF\xFF\xFF", 4);
-    g_assert_cmpstr (buf, ==, "ffffffff");
-
-}
-
-static void
-test_get_system_uuid (void)
-{
-    /* DEADBEEF-1234-1234-1234-DEADBEEF1234 */
-    char res[129] = {0};
-    get_system_uuid (res, NULL);
-    if (getuid () == 0) {
-        if (*res == '\0')
-            g_test_fail ();
-    } else {
-        g_print ("Need root to run this complete test: ");
-    }
-    memset (res, 0, 129);
-    seteuid (1000);
-    get_system_uuid (res, NULL);
-    g_assert (*res == '\0');
-    seteuid (0);
-}
-
-static void
 test_get_crash_db_url (void)
 {
     char* url = NULL;
@@ -365,11 +337,7 @@
     g_test_init (&argc, &argv, NULL);
 
     g_test_add_func ("/whoopsie/parse-report", test_parse_report);
-    /* This wont work when running under fakeroot. */
-    if (!getenv ("FAKEROOTKEY"))
-        g_test_add_func ("/whoopsie/get-system-uuid", test_get_system_uuid);
     g_test_add_func ("/whoopsie/get-crash-db-url", test_get_crash_db_url);
-    g_test_add_func ("/whoopsie/hex-to-char", test_hex_to_char);
     g_test_add_func ("/whoopsie/key-embedded-nul", test_key_embedded_nul);
     g_test_add_func ("/whoopsie/value-embedded-nul", test_value_embedded_nul);
     g_test_add_func ("/whoopsie/embedded-carriage-return",

=== modified file 'src/whoopsie.c'
--- src/whoopsie.c	2012-05-03 14:49:58 +0000
+++ src/whoopsie.c	2012-05-15 16:54:18 +0000
@@ -32,7 +32,6 @@
 #include <sys/file.h>
 #include <errno.h>
 #include <signal.h>
-#include <gcrypt.h>
 #include <pwd.h>
 #include <grp.h>
 #include <sys/capability.h>
@@ -46,6 +45,7 @@
 #include "utils.h"
 #include "connectivity.h"
 #include "monitor.h"
+#include "identifier.h"
 
 /* The length of time to wait before processing outstanding crashes, in seconds
  */
@@ -61,7 +61,6 @@
 static char* crash_db_url = NULL;
 
 /*  The system UUID, taken from the DMI tables and SHA-512 hashed */
-#define HASHLEN 128
 static char sha512_system_uuid[HASHLEN + 1] = {0};
 
 /* The URL for sending the initial crash report */
@@ -723,75 +722,6 @@
     sigaction (SIGINT, &action, NULL);
 }
 
-void
-hex_to_char (char* buf, const unsigned char *str, int len)
-{
-    char* p = NULL;
-    int i = 0;
-
-    p = buf;
-    for (i = 0; i < len; i++) {
-        snprintf(p, 3, "%02x", str[i]);
-        p += 2;
-    }
-    buf[2*len] = 0;
-}
-
-void
-get_system_uuid (char* res, GError** error)
-{
-    int fp;
-    char system_uuid[37] = {0};
-    int md_len;
-    unsigned char* id = NULL;
-    gcry_md_hd_t sha512 = NULL;
-
-    fp = open ("/sys/class/dmi/id/product_uuid", O_RDONLY);
-    if (fp < 0) {
-        g_set_error (error, g_quark_from_static_string ("whoopsie-quark"), 0,
-                     "Could not open the product uuid file.");
-        return;
-    }
-    if (read (fp, system_uuid, 36) == 36) {
-        system_uuid[36] = '\0';
-        close (fp);
-    } else {
-        close (fp);
-        g_set_error (error, g_quark_from_static_string ("whoopsie-quark"), 0,
-                     "Got an unexpected length reading the product_uuid.");
-        return;
-    }
-
-    if (!gcry_check_version (GCRYPT_VERSION)) {
-        g_set_error (error, g_quark_from_static_string ("whoopsie-quark"), 0,
-                     "libcrypt version mismatch.");
-        return;
-    }
-    gcry_control (GCRYCTL_INITIALIZATION_FINISHED, 0);
-    md_len = gcry_md_get_algo_dlen(GCRY_MD_SHA512);
-    if (md_len != HASHLEN / 2) {
-        g_set_error (error, g_quark_from_static_string ("whoopsie-quark"), 0,
-                 "Received an incorrect size for the SHA512 message digest");
-        return;
-    }
-    if (gcry_md_open (&sha512, GCRY_MD_SHA512, 0) || sha512 == NULL) {
-        g_set_error (error, g_quark_from_static_string ("whoopsie-quark"), 0,
-             "Failed to create a SHA512 message digest for the product_uuid.");
-        return;
-    }
-    gcry_md_write (sha512, system_uuid, 36);
-    gcry_md_final (sha512);
-    id = gcry_md_read (sha512, GCRY_MD_SHA512);
-    if (id == NULL) {
-        g_set_error (error, g_quark_from_static_string ("whoopsie-quark"), 0,
-             "Failed to read the SHA512 message digest for the product_uuid.");
-        gcry_md_close (sha512);
-        return;
-    }
-    hex_to_char (res, id, md_len);
-    gcry_md_close (sha512);
-}
-
 char*
 get_crash_db_url (void)
 {
@@ -883,6 +813,8 @@
 main (int argc, char** argv)
 {
     GError* err = NULL;
+    char* system_uuid = NULL;
+    char* mac_address = NULL;
 
     setup_signals ();
     parse_arguments (&argc, &argv);
@@ -891,12 +823,29 @@
         g_print ("Could not get crash database location.\n");
         exit (EXIT_FAILURE);
     }
-    get_system_uuid (sha512_system_uuid, &err);
+
+    identifier_get_system_uuid (&system_uuid, &err);
     if (err) {
         g_print ("%s\n", err->message);
         g_error_free (err);
         err = NULL;
     }
+    if (system_uuid) {
+        identifier_sha512 (system_uuid, sha512_system_uuid, NULL);
+        free (system_uuid);
+    } else {
+        identifier_get_mac_address (&mac_address, &err);
+        if (err) {
+            g_print ("%s\n", err->message);
+            g_error_free (err);
+            err = NULL;
+        }
+        if (mac_address) {
+            identifier_sha512 (mac_address, sha512_system_uuid, NULL);
+            free (mac_address);
+        }
+    }
+
     if (*sha512_system_uuid != '\0') {
         if (asprintf (&crash_db_submit_url, "%s/%s",
             crash_db_url, sha512_system_uuid) < 0)

=== modified file 'src/whoopsie.h'
--- src/whoopsie.h	2012-03-14 11:54:40 +0000
+++ src/whoopsie.h	2012-05-15 16:54:18 +0000
@@ -20,7 +20,6 @@
 #define WHOOPSIE_H
 
 GHashTable* parse_report (const char* report_path, gboolean full_report, GError** error);
-void hex_to_char (char* buf, const unsigned char *str, int len);
 void get_system_uuid (char* res, GError** error);
 char* get_crash_db_url (void);
 void destroy_key_and_value (gpointer key, gpointer value, gpointer user_data);