Fix: scanf unbounded input
[lttng-tools.git] / src / bin / lttng / commands / enable_events.c
index eaae4941baffbb84f14be0e56eff952ef553c66b..bd2d997858395ea164b6bbbf410adc258d5eea28 100644 (file)
@@ -16,6 +16,7 @@
  */
 
 #define _GNU_SOURCE
+#include <assert.h>
 #include <popt.h>
 #include <stdio.h>
 #include <stdlib.h>
 #include "../command.h"
 #include <src/common/sessiond-comm/sessiond-comm.h>
 
+#if (LTTNG_SYMBOL_NAME_LEN == 256)
+#define LTTNG_SYMBOL_NAME_LEN_SCANF_IS_A_BROKEN_API    "255"
+#endif
+
 static char *opt_event_list;
 static int opt_event_type;
 static const char *opt_loglevel;
@@ -134,7 +139,8 @@ static void usage(FILE *ofp)
        fprintf(ofp, "    --syscall              System call event\n");
        fprintf(ofp, "\n");
        fprintf(ofp, "    --loglevel name\n");
-       fprintf(ofp, "                           Tracepoint loglevel range from 0 to loglevel\n");
+       fprintf(ofp, "                           Tracepoint loglevel range from 0 to loglevel.\n");
+       fprintf(ofp, "                           For JUL domain, see the table below for the range values.\n");
        fprintf(ofp, "    --loglevel-only name\n");
        fprintf(ofp, "                           Tracepoint loglevel (only this loglevel)\n");
        fprintf(ofp, "\n");
@@ -159,6 +165,19 @@ static void usage(FILE *ofp)
        fprintf(ofp, "                               TRACE_DEBUG_LINE     = 13\n");
        fprintf(ofp, "                               TRACE_DEBUG          = 14\n");
        fprintf(ofp, "                               (shortcuts such as \"system\" are allowed)\n");
+       fprintf(ofp, "\n");
+       fprintf(ofp, "                           Available JUL domain loglevels:\n");
+       fprintf(ofp, "                               JUL_OFF            = INT32_MAX\n");
+       fprintf(ofp, "                               JUL_SEVERE         = %d\n", LTTNG_LOGLEVEL_JUL_SEVERE);
+       fprintf(ofp, "                               JUL_WARNING        = %d\n", LTTNG_LOGLEVEL_JUL_WARNING);
+       fprintf(ofp, "                               JUL_INFO           = %d\n", LTTNG_LOGLEVEL_JUL_INFO);
+       fprintf(ofp, "                               JUL_CONFIG         = %d\n", LTTNG_LOGLEVEL_JUL_CONFIG);
+       fprintf(ofp, "                               JUL_FINE           = %d\n", LTTNG_LOGLEVEL_JUL_FINE);
+       fprintf(ofp, "                               JUL_FINER          = %d\n", LTTNG_LOGLEVEL_JUL_FINER);
+       fprintf(ofp, "                               JUL_FINEST         = %d\n", LTTNG_LOGLEVEL_JUL_FINEST);
+       fprintf(ofp, "                               JUL_ALL            = INT32_MIN\n");
+       fprintf(ofp, "                               (shortcuts such as \"severe\" are allowed)\n");
+       fprintf(ofp, "\n");
        fprintf(ofp, "  -f, --filter \'expression\'\n");
        fprintf(ofp, "                           Filter expression on event fields and context.\n");
        fprintf(ofp, "                           Event recording depends on evaluation.\n");
@@ -211,6 +230,7 @@ static int parse_probe_opts(struct lttng_event *ev, char *opt)
 {
        int ret;
        char s_hex[19];
+#define S_HEX_LEN_SCANF_IS_A_BROKEN_API "18"   /* 18 is (19 - 1) (\0 is extra) */
        char name[LTTNG_SYMBOL_NAME_LEN];
 
        if (opt == NULL) {
@@ -219,7 +239,8 @@ static int parse_probe_opts(struct lttng_event *ev, char *opt)
        }
 
        /* Check for symbol+offset */
-       ret = sscanf(opt, "%[^'+']+%s", name, s_hex);
+       ret = sscanf(opt, "%" LTTNG_SYMBOL_NAME_LEN_SCANF_IS_A_BROKEN_API
+                       "[^'+']+%" S_HEX_LEN_SCANF_IS_A_BROKEN_API "s", name, s_hex);
        if (ret == 2) {
                strncpy(ev->attr.probe.symbol_name, name, LTTNG_SYMBOL_NAME_LEN);
                ev->attr.probe.symbol_name[LTTNG_SYMBOL_NAME_LEN - 1] = '\0';
@@ -237,7 +258,8 @@ static int parse_probe_opts(struct lttng_event *ev, char *opt)
 
        /* Check for symbol */
        if (isalpha(name[0])) {
-               ret = sscanf(opt, "%s", name);
+               ret = sscanf(opt, "%" LTTNG_SYMBOL_NAME_LEN_SCANF_IS_A_BROKEN_API "s",
+                       name);
                if (ret == 1) {
                        strncpy(ev->attr.probe.symbol_name, name, LTTNG_SYMBOL_NAME_LEN);
                        ev->attr.probe.symbol_name[LTTNG_SYMBOL_NAME_LEN - 1] = '\0';
@@ -250,7 +272,7 @@ static int parse_probe_opts(struct lttng_event *ev, char *opt)
        }
 
        /* Check for address */
-       ret = sscanf(opt, "%s", s_hex);
+       ret = sscanf(opt, "%" S_HEX_LEN_SCANF_IS_A_BROKEN_API "s", s_hex);
        if (ret > 0) {
                if (*s_hex == '\0') {
                        ERR("Invalid probe address %s", s_hex);
@@ -271,6 +293,47 @@ end:
        return ret;
 }
 
+/*
+ * Maps JUL loglevel from string to value
+ */
+static int loglevel_jul_str_to_value(const char *inputstr)
+{
+       int i = 0;
+       char str[LTTNG_SYMBOL_NAME_LEN];
+
+       /*
+        * Loop up to LTTNG_SYMBOL_NAME_LEN minus one because the NULL bytes is
+        * added at the end of the loop so a the upper bound we avoid the overflow.
+        */
+       while (i < (LTTNG_SYMBOL_NAME_LEN - 1) && inputstr[i] != '\0') {
+               str[i] = toupper(inputstr[i]);
+               i++;
+       }
+       str[i] = '\0';
+
+       if (!strcmp(str, "JUL_OFF") || !strcmp(str, "OFF")) {
+               return LTTNG_LOGLEVEL_JUL_OFF;
+       } else if (!strcmp(str, "JUL_SEVERE") || !strcmp(str, "SEVERE")) {
+               return LTTNG_LOGLEVEL_JUL_SEVERE;
+       } else if (!strcmp(str, "JUL_WARNING") || !strcmp(str, "WARNING")) {
+               return LTTNG_LOGLEVEL_JUL_WARNING;
+       } else if (!strcmp(str, "JUL_INFO") || !strcmp(str, "INFO")) {
+               return LTTNG_LOGLEVEL_JUL_INFO;
+       } else if (!strcmp(str, "JUL_CONFIG") || !strcmp(str, "CONFIG")) {
+               return LTTNG_LOGLEVEL_JUL_CONFIG;
+       } else if (!strcmp(str, "JUL_FINE") || !strcmp(str, "FINE")) {
+               return LTTNG_LOGLEVEL_JUL_FINE;
+       } else if (!strcmp(str, "JUL_FINER") || !strcmp(str, "FINER")) {
+               return LTTNG_LOGLEVEL_JUL_FINER;
+       } else if (!strcmp(str, "JUL_FINEST") || !strcmp(str, "FINEST")) {
+               return LTTNG_LOGLEVEL_JUL_FINEST;
+       } else if (!strcmp(str, "JUL_ALL") || !strcmp(str, "ALL")) {
+               return LTTNG_LOGLEVEL_JUL_ALL;
+       } else {
+               return -1;
+       }
+}
+
 /*
  * Maps loglevel from string to value
  */
@@ -527,14 +590,24 @@ static int enable_events(char *session_name)
                        strcpy(ev.name, "*");
                        ev.loglevel_type = opt_loglevel_type;
                        if (opt_loglevel) {
-                               ev.loglevel = loglevel_str_to_value(opt_loglevel);
+                               assert(opt_userspace || opt_jul);
+                               if (opt_userspace) {
+                                       ev.loglevel = loglevel_str_to_value(opt_loglevel);
+                               } else if (opt_jul) {
+                                       ev.loglevel = loglevel_jul_str_to_value(opt_loglevel);
+                               }
                                if (ev.loglevel == -1) {
                                        ERR("Unknown loglevel %s", opt_loglevel);
                                        ret = -LTTNG_ERR_INVALID;
                                        goto error;
                                }
                        } else {
-                               ev.loglevel = -1;
+                               assert(opt_userspace || opt_jul);
+                               if (opt_userspace) {
+                                       ev.loglevel = -1;
+                               } else if (opt_jul) {
+                                       ev.loglevel = LTTNG_LOGLEVEL_JUL_ALL;
+                               }
                        }
                }
 
@@ -768,6 +841,18 @@ static int enable_events(char *session_name)
                                ret = CMD_UNSUPPORTED;
                                goto error;
                        }
+
+                       ev.loglevel_type = opt_loglevel_type;
+                       if (opt_loglevel) {
+                               ev.loglevel = loglevel_jul_str_to_value(opt_loglevel);
+                               if (ev.loglevel == -1) {
+                                       ERR("Unknown loglevel %s", opt_loglevel);
+                                       ret = -LTTNG_ERR_INVALID;
+                                       goto error;
+                               }
+                       } else {
+                               ev.loglevel = LTTNG_LOGLEVEL_JUL_ALL;
+                       }
                        ev.type = LTTNG_EVENT_TRACEPOINT;
                        strncpy(ev.name, event_name, LTTNG_SYMBOL_NAME_LEN);
                        ev.name[LTTNG_SYMBOL_NAME_LEN - 1] = '\0';
@@ -839,6 +924,7 @@ static int enable_events(char *session_name)
                                                        session_name, opt_filter);
                                        break;
                                }
+                               free(exclusion_string);
                                goto error;
                        } else {
                                MSG("Event %s%s: Filter '%s' successfully set",
This page took 0.025426 seconds and 4 git commands to generate.