1*4882a593SmuzhiyunFrom bf3ded3a474d85da99eb717acdcd8ff4f89f9879 Mon Sep 17 00:00:00 2001
2*4882a593SmuzhiyunFrom: Chrostoper Ertl <chertl@microsoft.com>
3*4882a593SmuzhiyunDate: Thu, 28 Nov 2019 17:13:45 +0000
4*4882a593SmuzhiyunSubject: [PATCH] fru, sdr: Fix id_string buffer overflows
5*4882a593Smuzhiyun
6*4882a593SmuzhiyunFinal part of the fixes for CVE-2020-5208, see
7*4882a593Smuzhiyunhttps://github.com/ipmitool/ipmitool/security/advisories/GHSA-g659-9qxw-p7cp
8*4882a593Smuzhiyun
9*4882a593Smuzhiyun9 variants of stack buffer overflow when parsing `id_string` field of
10*4882a593SmuzhiyunSDR records returned from `CMD_GET_SDR` command.
11*4882a593Smuzhiyun
12*4882a593SmuzhiyunSDR record structs have an `id_code` field, and an `id_string` `char`
13*4882a593Smuzhiyunarray.
14*4882a593Smuzhiyun
15*4882a593SmuzhiyunThe length of `id_string` is calculated as `(id_code & 0x1f) + 1`,
16*4882a593Smuzhiyunwhich can be larger than expected 16 characters (if `id_code = 0xff`,
17*4882a593Smuzhiyunthen length will be `(0xff & 0x1f) + 1 = 32`).
18*4882a593Smuzhiyun
19*4882a593SmuzhiyunIn numerous places, this can cause stack buffer overflow when copying
20*4882a593Smuzhiyuninto fixed buffer of size `17` bytes from this calculated length.
21*4882a593Smuzhiyun
22*4882a593Smuzhiyun[Retrieve from:
23*4882a593Smuzhiyunhttps://github.com/ipmitool/ipmitool/commit/7ccea283dd62a05a320c1921e3d8d71a87772637]
24*4882a593SmuzhiyunSigned-off-by: Heiko Thiery <heiko.thiery@gmail.com>
25*4882a593Smuzhiyun---
26*4882a593Smuzhiyun lib/ipmi_fru.c |  2 +-
27*4882a593Smuzhiyun lib/ipmi_sdr.c | 40 ++++++++++++++++++++++++----------------
28*4882a593Smuzhiyun 2 files changed, 25 insertions(+), 17 deletions(-)
29*4882a593Smuzhiyun
30*4882a593Smuzhiyundiff --git a/lib/ipmi_fru.c b/lib/ipmi_fru.c
31*4882a593Smuzhiyunindex af99aa9..98bc984 100644
32*4882a593Smuzhiyun--- a/lib/ipmi_fru.c
33*4882a593Smuzhiyun+++ b/lib/ipmi_fru.c
34*4882a593Smuzhiyun@@ -3062,7 +3062,7 @@ ipmi_fru_print(struct ipmi_intf * intf, struct sdr_record_fru_locator * fru)
35*4882a593Smuzhiyun 		return 0;
36*4882a593Smuzhiyun
37*4882a593Smuzhiyun 	memset(desc, 0, sizeof(desc));
38*4882a593Smuzhiyun-	memcpy(desc, fru->id_string, fru->id_code & 0x01f);
39*4882a593Smuzhiyun+	memcpy(desc, fru->id_string, __min(fru->id_code & 0x01f, sizeof(desc)));
40*4882a593Smuzhiyun 	desc[fru->id_code & 0x01f] = 0;
41*4882a593Smuzhiyun 	printf("FRU Device Description : %s (ID %d)\n", desc, fru->device_id);
42*4882a593Smuzhiyun
43*4882a593Smuzhiyundiff --git a/lib/ipmi_sdr.c b/lib/ipmi_sdr.c
44*4882a593Smuzhiyunindex 2a9cbe3..62aac08 100644
45*4882a593Smuzhiyun--- a/lib/ipmi_sdr.c
46*4882a593Smuzhiyun+++ b/lib/ipmi_sdr.c
47*4882a593Smuzhiyun@@ -2084,7 +2084,7 @@ ipmi_sdr_print_sensor_eventonly(struct ipmi_intf *intf,
48*4882a593Smuzhiyun 		return -1;
49*4882a593Smuzhiyun
50*4882a593Smuzhiyun 	memset(desc, 0, sizeof (desc));
51*4882a593Smuzhiyun-	snprintf(desc, (sensor->id_code & 0x1f) + 1, "%s", sensor->id_string);
52*4882a593Smuzhiyun+	snprintf(desc, sizeof(desc), "%.*s", (sensor->id_code & 0x1f) + 1, sensor->id_string);
53*4882a593Smuzhiyun
54*4882a593Smuzhiyun 	if (verbose) {
55*4882a593Smuzhiyun 		printf("Sensor ID              : %s (0x%x)\n",
56*4882a593Smuzhiyun@@ -2135,7 +2135,7 @@ ipmi_sdr_print_sensor_mc_locator(struct ipmi_intf *intf,
57*4882a593Smuzhiyun 		return -1;
58*4882a593Smuzhiyun
59*4882a593Smuzhiyun 	memset(desc, 0, sizeof (desc));
60*4882a593Smuzhiyun-	snprintf(desc, (mc->id_code & 0x1f) + 1, "%s", mc->id_string);
61*4882a593Smuzhiyun+	snprintf(desc, sizeof(desc), "%.*s", (mc->id_code & 0x1f) + 1, mc->id_string);
62*4882a593Smuzhiyun
63*4882a593Smuzhiyun 	if (verbose == 0) {
64*4882a593Smuzhiyun 		if (csv_output)
65*4882a593Smuzhiyun@@ -2228,7 +2228,7 @@ ipmi_sdr_print_sensor_generic_locator(struct ipmi_intf *intf,
66*4882a593Smuzhiyun 	char desc[17];
67*4882a593Smuzhiyun
68*4882a593Smuzhiyun 	memset(desc, 0, sizeof (desc));
69*4882a593Smuzhiyun-	snprintf(desc, (dev->id_code & 0x1f) + 1, "%s", dev->id_string);
70*4882a593Smuzhiyun+	snprintf(desc, sizeof(desc), "%.*s", (dev->id_code & 0x1f) + 1, dev->id_string);
71*4882a593Smuzhiyun
72*4882a593Smuzhiyun 	if (!verbose) {
73*4882a593Smuzhiyun 		if (csv_output)
74*4882a593Smuzhiyun@@ -2285,7 +2285,7 @@ ipmi_sdr_print_sensor_fru_locator(struct ipmi_intf *intf,
75*4882a593Smuzhiyun 	char desc[17];
76*4882a593Smuzhiyun
77*4882a593Smuzhiyun 	memset(desc, 0, sizeof (desc));
78*4882a593Smuzhiyun-	snprintf(desc, (fru->id_code & 0x1f) + 1, "%s", fru->id_string);
79*4882a593Smuzhiyun+	snprintf(desc, sizeof(desc), "%.*s", (fru->id_code & 0x1f) + 1, fru->id_string);
80*4882a593Smuzhiyun
81*4882a593Smuzhiyun 	if (!verbose) {
82*4882a593Smuzhiyun 		if (csv_output)
83*4882a593Smuzhiyun@@ -2489,35 +2489,43 @@ ipmi_sdr_print_name_from_rawentry(struct ipmi_intf *intf, uint16_t id,
84*4882a593Smuzhiyun
85*4882a593Smuzhiyun    int rc =0;
86*4882a593Smuzhiyun    char desc[17];
87*4882a593Smuzhiyun+   const char *id_string;
88*4882a593Smuzhiyun+   uint8_t id_code;
89*4882a593Smuzhiyun    memset(desc, ' ', sizeof (desc));
90*4882a593Smuzhiyun
91*4882a593Smuzhiyun    switch ( type) {
92*4882a593Smuzhiyun       case SDR_RECORD_TYPE_FULL_SENSOR:
93*4882a593Smuzhiyun       record.full = (struct sdr_record_full_sensor *) raw;
94*4882a593Smuzhiyun-      snprintf(desc, (record.full->id_code & 0x1f) +1, "%s",
95*4882a593Smuzhiyun-               (const char *)record.full->id_string);
96*4882a593Smuzhiyun+      id_code = record.full->id_code;
97*4882a593Smuzhiyun+      id_string = record.full->id_string;
98*4882a593Smuzhiyun       break;
99*4882a593Smuzhiyun+
100*4882a593Smuzhiyun       case SDR_RECORD_TYPE_COMPACT_SENSOR:
101*4882a593Smuzhiyun       record.compact = (struct sdr_record_compact_sensor *) raw	;
102*4882a593Smuzhiyun-      snprintf(desc, (record.compact->id_code & 0x1f)  +1, "%s",
103*4882a593Smuzhiyun-               (const char *)record.compact->id_string);
104*4882a593Smuzhiyun+      id_code = record.compact->id_code;
105*4882a593Smuzhiyun+      id_string = record.compact->id_string;
106*4882a593Smuzhiyun       break;
107*4882a593Smuzhiyun+
108*4882a593Smuzhiyun       case SDR_RECORD_TYPE_EVENTONLY_SENSOR:
109*4882a593Smuzhiyun       record.eventonly  = (struct sdr_record_eventonly_sensor *) raw ;
110*4882a593Smuzhiyun-      snprintf(desc, (record.eventonly->id_code & 0x1f)  +1, "%s",
111*4882a593Smuzhiyun-               (const char *)record.eventonly->id_string);
112*4882a593Smuzhiyun-      break;
113*4882a593Smuzhiyun+      id_code = record.eventonly->id_code;
114*4882a593Smuzhiyun+      id_string = record.eventonly->id_string;
115*4882a593Smuzhiyun+      break;
116*4882a593Smuzhiyun+
117*4882a593Smuzhiyun       case SDR_RECORD_TYPE_MC_DEVICE_LOCATOR:
118*4882a593Smuzhiyun       record.mcloc  = (struct sdr_record_mc_locator *) raw ;
119*4882a593Smuzhiyun-      snprintf(desc, (record.mcloc->id_code & 0x1f)  +1, "%s",
120*4882a593Smuzhiyun-               (const char *)record.mcloc->id_string);
121*4882a593Smuzhiyun+      id_code = record.mcloc->id_code;
122*4882a593Smuzhiyun+      id_string = record.mcloc->id_string;
123*4882a593Smuzhiyun       break;
124*4882a593Smuzhiyun+
125*4882a593Smuzhiyun       default:
126*4882a593Smuzhiyun       rc = -1;
127*4882a593Smuzhiyun-      break;
128*4882a593Smuzhiyun-   }
129*4882a593Smuzhiyun+   }
130*4882a593Smuzhiyun+   if (!rc) {
131*4882a593Smuzhiyun+       snprintf(desc, sizeof(desc), "%.*s", (id_code & 0x1f) + 1, id_string);
132*4882a593Smuzhiyun+   }
133*4882a593Smuzhiyun
134*4882a593Smuzhiyun-      lprintf(LOG_INFO, "ID: 0x%04x , NAME: %-16s", id, desc);
135*4882a593Smuzhiyun+   lprintf(LOG_INFO, "ID: 0x%04x , NAME: %-16s", id, desc);
136*4882a593Smuzhiyun    return rc;
137*4882a593Smuzhiyun }
138*4882a593Smuzhiyun
139*4882a593Smuzhiyun--
140*4882a593Smuzhiyun2.20.1
141*4882a593Smuzhiyun
142