Fix: scanf unbounded input
[lttng-tools.git] / src / bin / lttng / conf.c
index cdd264a5d11a3246e4430a3acce5cf354a68e731..55ed6352663e8f71dd2f496bf48cf5696d586bec 100644 (file)
@@ -2,9 +2,8 @@
  * Copyright (c)  2011 David Goulet <david.goulet@polymtl.ca>
  *
  * 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
- * as published by the Free Software Foundation; only version 2
- * of the License.
+ * it under the terms of the GNU General Public License, version 2 only,
+ * as published by the Free Software Foundation.
  *
  * This program is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
 #include <unistd.h>
 
 #include <common/error.h>
+#include <common/utils.h>
 
 #include "conf.h"
 
 /*
- *  config_get_file_path
- *
- *  Return the path with '/CONFIG_FILENAME' added to it.
+ * Returns the path with '/CONFIG_FILENAME' added to it;
+ * path will be NULL if an error occurs.
  */
 char *config_get_file_path(char *path)
 {
@@ -42,15 +41,15 @@ char *config_get_file_path(char *path)
        ret = asprintf(&file_path, "%s/%s", path, CONFIG_FILENAME);
        if (ret < 0) {
                ERR("Fail allocating config file path");
+               file_path = NULL;
        }
 
        return file_path;
 }
 
 /*
- *  open_config
- *
- *  Return an open FILE pointer to the config file.
+ * Returns an open FILE pointer to the config file;
+ * on error, NULL is returned.
  */
 static FILE *open_config(char *path, const char *mode)
 {
@@ -68,16 +67,14 @@ static FILE *open_config(char *path, const char *mode)
        }
 
 error:
-       if (file_path) {
-               free(file_path);
-       }
+       free(file_path);
        return fp;
 }
 
 /*
- *  create_config_file
- *
- *  Create the empty config file a the path.
+ * Creates the empty config file at the path.
+ * On success, returns 0;
+ * on error, returns -1.
  */
 static int create_config_file(char *path)
 {
@@ -98,9 +95,9 @@ error:
 }
 
 /*
- *  write_config
- *
- *  Append data to the config file in file_path
+ * Append data to the config file in file_path
+ * On success, returns 0;
+ * on error, returns -1.
  */
 static int write_config(char *file_path, size_t size, char *data)
 {
@@ -116,28 +113,18 @@ static int write_config(char *file_path, size_t size, char *data)
 
        /* Write session name into config file */
        len = fwrite(data, size, 1, fp);
-       if (len < 1) {
+       if (len != 1) {
                ret = -1;
        }
-       fclose(fp);
+       if (fclose(fp)) {
+               PERROR("close write_config");
+       }
 end:
        return ret;
 }
 
 /*
- *  config_get_default_path
- *
- *  Return the HOME directory path. Caller MUST NOT free(3) the return pointer.
- */
-char *config_get_default_path(void)
-{
-       return getenv("HOME");
-}
-
-/*
- *  config_destroy
- *
- *  Destroy directory config and file config.
+ * Destroys directory config and file config.
  */
 void config_destroy(char *path)
 {
@@ -149,35 +136,78 @@ void config_destroy(char *path)
                return;
        }
 
+       if (!config_exists(config_path)) {
+               goto end;
+       }
+
+       DBG("Removing %s\n", config_path);
        ret = remove(config_path);
        if (ret < 0) {
                perror("remove config file");
        }
-
+end:
        free(config_path);
 }
 
 /*
- *  config_read_session_name
- *
- *  Return sesson name from the config file.
+ * Destroys the default config
+ */
+void config_destroy_default(void)
+{
+       char *path = utils_get_home_dir();
+       if (path == NULL) {
+               return;
+       }
+       config_destroy(path);
+}
+
+/*
+ * Returns 1 if config exists, 0 otherwise
+ */
+int config_exists(const char *path)
+{
+       int ret;
+       struct stat info;
+
+       ret = stat(path, &info);
+       if (ret < 0) {
+               return 0;
+       }
+       return S_ISREG(info.st_mode) || S_ISDIR(info.st_mode);
+}
+
+/*
+ * Returns the session name from the config file.
+ * The caller is responsible for freeing the returned string.
+ * On error, NULL is returned.
  */
 char *config_read_session_name(char *path)
 {
        int ret;
        FILE *fp;
        char var[NAME_MAX], *session_name;
+#if (NAME_MAX == 255)
+#define NAME_MAX_SCANF_IS_A_BROKEN_API "254"
+#endif
+
+       session_name = malloc(NAME_MAX);
+       if (session_name == NULL) {
+               ERR("Out of memory");
+               goto error;
+       }
 
        fp = open_config(path, "r");
        if (fp == NULL) {
                ERR("Can't find valid lttng config %s/.lttngrc", path);
                MSG("Did you create a session? (lttng create <my_session>)");
+               free(session_name);
                goto error;
        }
 
-       session_name = malloc(NAME_MAX);
        while (!feof(fp)) {
-               if ((ret = fscanf(fp, "%[^'=']=%s\n", var, session_name)) != 2) {
+               if ((ret = fscanf(fp, "%" NAME_MAX_SCANF_IS_A_BROKEN_API
+                               "[^'=']=%" NAME_MAX_SCANF_IS_A_BROKEN_API "s\n",
+                               var, session_name)) != 2) {
                        if (ret == -1) {
                                ERR("Missing session=NAME in config file.");
                                goto error_close;
@@ -191,29 +221,43 @@ char *config_read_session_name(char *path)
        }
 
 error_close:
-       fclose(fp);
+       free(session_name);
+       ret = fclose(fp);
+       if (ret < 0) {
+               PERROR("close config read session name");
+       }
 
 error:
        return NULL;
 
 found:
-       fclose(fp);
+       ret = fclose(fp);
+       if (ret < 0) {
+               PERROR("close config read session name found");
+       }
        return session_name;
 
 }
 
 /*
- *  config_add_session_name
- *
- *  Write session name option to the config file.
+ * Write session name option to the config file.
+ * On success, returns 0;
+ * on error, returns -1.
  */
 int config_add_session_name(char *path, char *name)
 {
        int ret;
-       char session_name[NAME_MAX];
-
-       ret = snprintf(session_name, NAME_MAX, "session=%s\n", name);
+       char *attr = "session=";
+       /* Max name len accepted plus attribute's len and the NULL byte. */
+       char session_name[NAME_MAX + strlen(attr) + 1];
+
+       /*
+        * With GNU C <  2.1, snprintf returns -1 if the target buffer is too small;
+        * With GNU C >= 2.1, snprintf returns the required size (excluding closing null)
+        */
+       ret = snprintf(session_name, sizeof(session_name), "%s%s\n", attr, name);
        if (ret < 0) {
+               ret = -1;
                goto error;
        }
        ret = write_config(path, ret, session_name);
@@ -222,16 +266,16 @@ error:
 }
 
 /*
- *  config_init
- *
- *  Init configuration directory and file.
+ * Init configuration directory and file.
+ * On success, returns 0;
+ * on error, returns -1.
  */
 int config_init(char *session_name)
 {
        int ret;
        char *path;
 
-       path = config_get_default_path();
+       path = utils_get_home_dir();
        if (path == NULL) {
                ret = -1;
                goto error;
This page took 0.026172 seconds and 4 git commands to generate.