tools:acrn-crashlog: Change the algorithm of generating event key

Acrnprobe is using SHA to generate ids for events. These ids are only used
to index events, not for cryptographic purpose.

This patch unify the generating algorithm of short and long ids to
SHA256.

Tracked-On: #1024
Signed-off-by: Liu, Xinwu <xinwu.liu@intel.com>
Reviewed-by: Zhi Jin <zhi.jin@intel.com>
Acked-by: Chen Gang <gang.c.chen@intel.com>

Author: lauxinw

tools/acrn-crashlog/acrnprobe/history.c

@@ -192,7 +192,8 @@ void hist_raise_uptime(char *lastuptime)
 		if (hours / uptime_hours >= loop_uptime_event) {
 			loop_uptime_event = (hours / uptime_hours) + 1;
 
-			key = generate_event_id(uptime->name, "");
+			key = generate_event_id((const char *)uptime->name,
+						NULL, KEY_SHORT);
 			if (key == NULL) {
 				LOGE("generate event id failed, error (%s)\n",
 				     strerror(errno));
@@ -210,7 +211,7 @@ void hist_raise_infoerror(char *type)
 {
 	char *key;
 
-	key = generate_event_id("ERROR", type);
+	key = generate_event_id("ERROR", (const char *)type, KEY_SHORT);
 	if (key == NULL) {
 		LOGE("generate event id failed, error (%s)\n",
 		     strerror(errno));

tools/acrn-crashlog/acrnprobe/include/load_conf.h

@@ -11,6 +11,7 @@
 #include <openssl/sha.h>
 #include <ext2fs/ext2fs.h>
 #include "event_queue.h"
+#include "probeutils.h"
 
 #define CONTENT_MAX 10
 #define EXPRESSION_MAX 5
@@ -38,7 +39,7 @@ struct vm_t {
 	ext2_filsys datafs;
 	unsigned long history_size[SENDER_MAX];
 	char *history_data;
-	char last_synced_line_key[SENDER_MAX][SHA_DIGEST_LENGTH + 1];
+	char last_synced_line_key[SENDER_MAX][SHORT_KEY_LENGTH + 1];
 };
 
 struct log_t {

tools/acrn-crashlog/acrnprobe/include/probeutils.h

@@ -24,18 +24,25 @@
 
 #define UPTIME_SIZE 24
 #define LONG_TIME_SIZE 32
+#define SHORT_KEY_LENGTH 20
+#define LONG_KEY_LENGTH 32
 
 enum e_dir_mode {
 	MODE_CRASH = 0,
 	MODE_STATS,
 	MODE_VMEVENT,
 };
 
+enum key_type {
+	KEY_SHORT = 0,
+	KEY_LONG,
+};
+
 int get_uptime_string(char newuptime[24], int *hours);
 int get_current_time_long(char buf[32]);
 unsigned long long get_uptime(void);
-char *generate_event_id(char *seed1, char *seed2);
-char *generate_eventid256(char *seed);
+char *generate_event_id(const char *seed1, const char *seed2,
+				enum key_type type);
 void generate_crashfile(char *dir, char *event, char *hashkey,
 			char *type, char *data0,
 			char *data1, char *data2);

tools/acrn-crashlog/acrnprobe/probeutils.c

@@ -94,129 +94,30 @@ int get_current_time_long(char *buf)
 	return strftime(buf, LONG_TIME_SIZE, "%Y-%m-%d/%H:%M:%S  ", time_val);
 }
 
-/**
- * Compute a key with 20 characters
- *
- * @param[out] key The result key.
- * @param seed1 Seed.
- * @param seed2 Seed.
- *
- * @return 0 if successful, or -1 if not.
- */
-static int compute_key(char *key, char *seed1, char *seed2)
-{
-	static SHA_CTX *sha;
-	char buf[VERSION_SIZE] = {'\0',};
-	long long time_ns = 0;
-	char *tmp_key = key;
-	unsigned char results[SHA_DIGEST_LENGTH];
-	int i;
-	int ret;
-
-	if (sha == NULL) {
-		sha = (SHA_CTX *)malloc(sizeof(SHA_CTX));
-		if (sha == NULL) {
-			LOGE("cannot create SHA_CTX memory...\n");
-			return -1;
-		}
-
-		ret = SHA1_Init(sha);
-		if (ret != 1) {
-			LOGE("SHA1_Init failed, error (%s)\n",
-			     strerror(errno));
-			free(sha);
-			sha = NULL;
-			return -1;
-		}
-	}
-
-	if (!key || !seed1 || !seed2)
-		return -1;
-
-	time_ns = get_uptime();
-	snprintf(buf, VERSION_SIZE, "%s%s%s%s%lld", gbuildversion, guuid, seed1,
-		 seed2, time_ns);
-
-	ret = SHA1_Update(sha, (unsigned char *)buf, strlen(buf));
-	if (ret != 1) {
-		LOGE("SHA1_Update failed, error (%s)\n",
-		     strerror(errno));
-		return -1;
-	}
-
-	ret = SHA1_Final(results, sha);
-	if (ret != 1) {
-		LOGE("SHA1_Final failed, error (%s)\n",
-		     strerror(errno));
-		return -1;
-	}
-
-	for (i = 0; i < SHA_DIGEST_LENGTH / 2; i++) {
-		sprintf(tmp_key, "%02x", results[i]);
-		tmp_key += 2;
-	}
-	*tmp_key = 0;
-
-	return 0;
-}
-
-/**
- * Compute a key with 32 characters
- *
- * @param[out] key The result key.
- * @param seed Seed.
- *
- * @return 0 if successful, or -1 if not.
- */
-static int compute_key256(char *key, char *seed)
+static int compute_key(char *key, size_t key_len, const char *seed)
 {
-	static SHA256_CTX *sha;
-	char buf[VERSION_SIZE] = {'\0',};
-	long long time_ns = 0;
+	SHA256_CTX sha;
+	char buf[VERSION_SIZE];
+	long long time_ns;
 	char *tmp_key = key;
 	unsigned char results[SHA256_DIGEST_LENGTH];
-	int i;
-	int ret;
-
-	if (sha == NULL) {
-		sha = (SHA256_CTX *)malloc(sizeof(SHA256_CTX));
-		if (sha == NULL) {
-			LOGE("cannot create SHA256_CTX memory...\n");
-			return -1;
-		}
-
-		ret = SHA256_Init(sha);
-		if (ret != 1) {
-			LOGE("SHA256_Init failed, error (%s)\n",
-			     strerror(errno));
-			free(sha);
-			sha = NULL;
-			return -1;
-		}
-	}
+	size_t i;
 
 	if (!key || !seed)
 		return -1;
+	if (key_len > SHA256_DIGEST_LENGTH * 2 || !key_len)
+		return -1;
 
+	SHA256_Init(&sha);
 	time_ns = get_uptime();
-	snprintf(buf, VERSION_SIZE, "%s%s%s%lld", gbuildversion, guuid, seed,
-		 time_ns);
+	snprintf(buf, VERSION_SIZE, "%s%s%lld", gbuildversion, guuid, time_ns);
 
-	ret = SHA256_Update(sha, (unsigned char *)buf, strlen(buf));
-	if (ret != 1) {
-		LOGE("SHA256_Update failed, error (%s)\n",
-		     strerror(errno));
-		return -1;
-	}
+	SHA256_Update(&sha, (unsigned char *)buf, strlen(buf));
+	SHA256_Update(&sha, (unsigned char *)seed, strlen(seed));
 
-	ret = SHA256_Final(results, sha);
-	if (ret != 1) {
-		LOGE("SHA256_Final failed, error (%s)\n",
-		     strerror(errno));
-		return -1;
-	}
+	SHA256_Final(results, &sha);
 
-	for (i = 0; i < SHA256_DIGEST_LENGTH / 2; i++) {
+	for (i = 0; i < key_len / 2; i++) {
 		sprintf(tmp_key, "%02x", results[i]);
 		tmp_key += 2;
 	}
@@ -226,49 +127,54 @@ static int compute_key256(char *key, char *seed)
 }
 
 /**
- * Generate a event id with 20 characters
+ * Generate an event id with specified type.
  *
- * @param seed1 Seed.
- * @param seed2 Seed.
+ * @param seed1 Seed1.
+ * @param seed2 Seed2, this parameter will be ignored if the value is NULL.
+ * @param type The type of key. The length of generated id will be 20
+ *		characters if type is KEY_SHORT; 32 characters if type is
+ *		KEY_LONG.
  *
  * @return a pointer to result haskkey if successful, or NULL if not.
  */
-char *generate_event_id(char *seed1, char *seed2)
+char *generate_event_id(const char *seed1, const char *seed2,
+			enum key_type type)
 {
 	int ret;
-	char *key = (char *)malloc(SHA_DIGEST_LENGTH + 1);
+	char *buf;
+	char *key;
+	size_t klen;
 
-	if (!key)
+	if (!seed1)
 		return NULL;
 
-	ret = compute_key(key, seed1, seed2);
-	if (ret < 0) {
-		LOGE("compute_key error\n");
-		free(key);
-		key = NULL;
-	}
-
-	return key;
-}
-
-/**
- * Generate a event id with 32 characters
- *
- * @param seed Seed.
- *
- * @return a pointer to result haskkey if successful, or NULL if not.
- */
-char *generate_eventid256(char *seed)
-{
-	int ret;
-	char *key = (char *)malloc(SHA256_DIGEST_LENGTH + 1);
+	if (type == KEY_SHORT)
+		klen = SHORT_KEY_LENGTH;
+	else if (type == KEY_LONG)
+		klen = LONG_KEY_LENGTH;
+	else
+		return NULL;
 
-	if (!key)
+	key = (char *)malloc(klen + 1);
+	if (!key) {
+		LOGE("failed to generate event id, out of memory\n");
 		return NULL;
+	}
+
+	if (seed2) {
+		if (asprintf(&buf, "%s%s", seed1, seed2) == -1) {
+			LOGE("failed to generate event id, out of memory\n");
+			free(key);
+			return NULL;
+		}
+		ret = compute_key(key, klen, (const char *)buf);
+		free(buf);
+	} else {
+		ret = compute_key(key, klen, seed1);
+	}
 
-	ret = compute_key256(key, seed);
 	if (ret < 0) {
-		LOGE("compute_key256 error\n");
+		LOGE("compute_key error\n");
 		free(key);
 		key = NULL;
 	}

tools/acrn-crashlog/acrnprobe/sender.c

@@ -357,7 +357,7 @@ static void telemd_send_crash(struct event_t *e)
 		return;
 	}
 
-	eventid = generate_eventid256(class);
+	eventid = generate_event_id((const char *)class, NULL, KEY_LONG);
 	if (eventid == NULL) {
 		LOGE("generate eventid failed, error (%s)\n", strerror(errno));
 		goto free_class;
@@ -436,7 +436,7 @@ static void telemd_send_info(struct event_t *e)
 		return;
 	}
 
-	eventid = generate_eventid256(class);
+	eventid = generate_event_id((const char *)class, NULL, KEY_LONG);
 	if (eventid == NULL) {
 		LOGE("generate eventid failed, error (%s)\n", strerror(errno));
 		goto free_class;
@@ -608,7 +608,7 @@ static int telemd_new_vmevent(const char *line_to_sync,
 		goto free_vmlogpath;
 	}
 
-	eventid = generate_eventid256(class);
+	eventid = generate_event_id((const char *)class, NULL, KEY_LONG);
 	if (eventid == NULL) {
 		LOGE("generate eventid failed, error (%s)\n", strerror(errno));
 		ret = VMEVT_DEFER;
@@ -739,7 +739,7 @@ static void crashlog_send_crash(struct event_t *e)
 
 	/* change the class for other senders */
 	e->private = (void *)crash;
-	key = generate_event_id("CRASH", crash->name);
+	key = generate_event_id("CRASH", (const char *)crash->name, KEY_SHORT);
 	if (key == NULL) {
 		LOGE("generate event id failed, error (%s)\n",
 		     strerror(errno));
@@ -818,7 +818,8 @@ static void crashlog_send_info(struct event_t *e)
 	int id;
 	struct info_t *info = (struct info_t *)e->private;
 	struct log_t *log;
-	char *key = generate_event_id("INFO", info->name);
+	char *key = generate_event_id("INFO", (const char *)info->name,
+				      KEY_SHORT);
 
 	if (key == NULL) {
 		LOGE("generate event id failed, error (%s)\n",
@@ -862,7 +863,7 @@ static void crashlog_send_reboot(void)
 		return;
 
 	if (swupdated(crashlog)) {
-		key = generate_event_id("INFO", "SWUPDATE");
+		key = generate_event_id("INFO", "SWUPDATE", KEY_SHORT);
 		if (key == NULL) {
 			LOGE("generate event id failed, error (%s)\n",
 			     strerror(errno));
@@ -874,7 +875,7 @@ static void crashlog_send_reboot(void)
 	}
 
 	read_startupreason(reason, sizeof(reason));
-	key = generate_event_id("REBOOT", reason);
+	key = generate_event_id("REBOOT", (const char *)reason, KEY_SHORT);
 	if (key == NULL) {
 		LOGE("generate event id failed, error (%s)\n",
 		     strerror(errno));
@@ -931,7 +932,7 @@ static int crashlog_new_vmevent(const char *line_to_sync,
 		return ret;
 	}
 
-	key = generate_event_id("SOS", vmkey);
+	key = generate_event_id("SOS", (const char *)vmkey, KEY_SHORT);
 	if (key == NULL) {
 		LOGE("generate event id failed, error (%s)\n",
 		     strerror(errno));