-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathBufferOverflowRule.cpp
More file actions
464 lines (383 loc) · 11.5 KB
/
Copy pathBufferOverflowRule.cpp
File metadata and controls
464 lines (383 loc) · 11.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
/**
*
* @file BufferOverflowRule.cpp
* @author Gaspard Kirira
*
* Copyright 2025, Gaspard Kirira. All rights reserved.
* https://github.com/vixcpp/vix
* Use of this source code is governed by a MIT license
* that can be found in the License file.
*
* Vix.cpp
*
*/
#include <vix/cli/errors/runtime/IRuntimeErrorRule.hpp>
#include <vix/cli/errors/runtime/RuntimeRuleUtils.hpp>
#include <cctype>
#include <cstdlib>
#include <filesystem>
#include <iostream>
#include <memory>
#include <string>
#include <vector>
#include <vix/cli/Style.hpp>
using namespace vix::cli::style;
namespace vix::cli::errors::runtime
{
namespace
{
enum class BufferOverflowKind
{
HeapBufferOverflow,
StackBufferOverflow,
DynamicStackBufferOverflow,
GlobalBufferOverflow,
ContainerOverflow,
UbsanOutOfBounds,
GenericBufferOverflow,
};
std::string trim_copy(const std::string &value)
{
std::size_t begin = 0;
while (begin < value.size() &&
std::isspace(
static_cast<unsigned char>(value[begin])) != 0)
{
++begin;
}
std::size_t end = value.size();
while (end > begin &&
std::isspace(
static_cast<unsigned char>(value[end - 1])) != 0)
{
--end;
}
return value.substr(begin, end - begin);
}
std::string lowercase_copy(std::string value)
{
for (char &character : value)
{
character = static_cast<char>(
std::tolower(
static_cast<unsigned char>(character)));
}
return value;
}
bool technical_details_enabled()
{
const char *level = std::getenv("VIX_LOG_LEVEL");
if (level == nullptr || *level == '\0')
return false;
const std::string value =
lowercase_copy(trim_copy(level));
return value == "debug" ||
value == "trace";
}
bool looks_like_ubsan_index_error(
const std::string &log)
{
const bool hasOutOfBounds =
icontains(log, "out of bounds") ||
icontains(log, "out-of-bounds");
const bool hasIndexContext =
icontains(log, "runtime error: index") ||
icontains(log, "index ") ||
icontains(log, "array index");
return hasOutOfBounds &&
hasIndexContext;
}
BufferOverflowKind classify_issue(
const std::string &log)
{
/*
* Check dynamic-stack-buffer-overflow before the more
* general stack-buffer-overflow marker.
*/
if (icontains(
log,
"dynamic-stack-buffer-overflow"))
{
return BufferOverflowKind::
DynamicStackBufferOverflow;
}
if (icontains(log, "heap-buffer-overflow"))
{
return BufferOverflowKind::
HeapBufferOverflow;
}
if (icontains(log, "stack-buffer-overflow"))
{
return BufferOverflowKind::
StackBufferOverflow;
}
if (icontains(log, "global-buffer-overflow"))
{
return BufferOverflowKind::
GlobalBufferOverflow;
}
if (icontains(log, "container-overflow"))
{
return BufferOverflowKind::
ContainerOverflow;
}
if (looks_like_ubsan_index_error(log))
{
return BufferOverflowKind::
UbsanOutOfBounds;
}
return BufferOverflowKind::
GenericBufferOverflow;
}
std::string choose_message(
const std::string &log)
{
switch (classify_issue(log))
{
case BufferOverflowKind::HeapBufferOverflow:
return "heap-buffer-overflow";
case BufferOverflowKind::StackBufferOverflow:
return "stack-buffer-overflow";
case BufferOverflowKind::DynamicStackBufferOverflow:
return "dynamic-stack-buffer-overflow";
case BufferOverflowKind::GlobalBufferOverflow:
return "global-buffer-overflow";
case BufferOverflowKind::ContainerOverflow:
return "container-overflow";
case BufferOverflowKind::UbsanOutOfBounds:
return "out-of-bounds access";
case BufferOverflowKind::GenericBufferOverflow:
default:
return "buffer overflow";
}
}
std::string choose_description(
const std::string &log)
{
switch (classify_issue(log))
{
case BufferOverflowKind::HeapBufferOverflow:
return "The program accessed memory past the end of a dynamically allocated buffer.";
case BufferOverflowKind::StackBufferOverflow:
return "The program accessed memory past the end of a local fixed-size buffer.";
case BufferOverflowKind::DynamicStackBufferOverflow:
return "The program accessed memory past the end of a dynamically sized stack buffer.";
case BufferOverflowKind::GlobalBufferOverflow:
return "The program accessed memory past the end of a global or static buffer.";
case BufferOverflowKind::ContainerOverflow:
return "The program accessed memory outside the valid storage owned by a container.";
case BufferOverflowKind::UbsanOutOfBounds:
return "An index was outside the valid range of the array or buffer.";
case BufferOverflowKind::GenericBufferOverflow:
default:
return "The program accessed memory outside the valid buffer range.";
}
}
std::string choose_hint(
const std::string &log)
{
switch (classify_issue(log))
{
case BufferOverflowKind::HeapBufferOverflow:
return "check heap buffer, vector, string, allocation, and copy sizes";
case BufferOverflowKind::StackBufferOverflow:
return "check local array bounds, indexes, and copy lengths";
case BufferOverflowKind::DynamicStackBufferOverflow:
return "check the dynamic stack allocation size and every index used with it";
case BufferOverflowKind::GlobalBufferOverflow:
return "check global or static array bounds and copy lengths";
case BufferOverflowKind::ContainerOverflow:
return "check container size, capacity, iterators, and copy destinations";
case BufferOverflowKind::UbsanOutOfBounds:
return "verify that the index is smaller than the array or buffer size";
case BufferOverflowKind::GenericBufferOverflow:
default:
return "check indexes, allocation sizes, and buffer boundaries";
}
}
std::string choose_secondary_hint(
const std::string &log)
{
switch (classify_issue(log))
{
case BufferOverflowKind::HeapBufferOverflow:
case BufferOverflowKind::StackBufferOverflow:
case BufferOverflowKind::DynamicStackBufferOverflow:
case BufferOverflowKind::GlobalBufferOverflow:
case BufferOverflowKind::ContainerOverflow:
return "make sure every copy length is no larger than the destination capacity";
case BufferOverflowKind::UbsanOutOfBounds:
case BufferOverflowKind::GenericBufferOverflow:
default:
return {};
}
}
bool may_use_source_hint(
BufferOverflowKind kind)
{
/*
* The copy-operation fallback is useful for explicit buffer
* overflows, but not for an arbitrary UBSan index failure.
*/
return kind !=
BufferOverflowKind::UbsanOutOfBounds;
}
std::vector<std::string>
source_patterns_for_buffer_overflow()
{
/*
* Keep only high-signal unchecked memory operations.
*
* "[" and ".at(" are intentionally excluded.
*/
return {
"memcpy(",
"memmove(",
"memset(",
"strcpy(",
"strncpy(",
"strcat(",
"strncat(",
"sprintf(",
"snprintf(",
"std::copy(",
"std::copy_n(",
"std::ranges::copy(",
};
}
bool looks_like_buffer_overflow_log(
const std::string &log)
{
if (icontains(log, "heap-buffer-overflow") ||
icontains(log, "stack-buffer-overflow") ||
icontains(log, "dynamic-stack-buffer-overflow") ||
icontains(log, "global-buffer-overflow") ||
icontains(log, "container-overflow") ||
icontains(log, "buffer-overflow") ||
icontains(log, "buffer overflow"))
{
return true;
}
return looks_like_ubsan_index_error(log);
}
void print_error(
const std::string &message,
const std::string &description)
{
std::cerr << RED
<< "runtime error: "
<< message
<< RESET
<< "\n";
if (!description.empty())
{
std::cerr << " "
<< description
<< "\n";
}
}
void print_hints_and_location(
const std::string &hint,
const std::string &secondaryHint,
const RuntimeLocation &location)
{
std::vector<std::string> hints;
if (!hint.empty())
hints.push_back(hint);
if (!secondaryHint.empty())
hints.push_back(secondaryHint);
const std::string at =
location.valid()
? make_at_text(
location,
std::filesystem::path{})
: std::string{};
if (hints.empty() && at.empty())
return;
std::cerr << "\n";
print_runtime_hints_and_at(
hints,
at);
}
void print_debug_details(
const std::string &log)
{
if (!technical_details_enabled())
return;
std::cerr << "\n"
<< GRAY
<< "technical details:"
<< RESET
<< "\n";
print_runtime_log_excerpt(
log,
24);
}
} // namespace
class BufferOverflowRule final
: public IRuntimeErrorRule
{
public:
bool match(
const std::string &log,
const std::filesystem::path &sourceFile) const override
{
(void)sourceFile;
return looks_like_buffer_overflow_log(log);
}
bool handle(
const std::string &log,
const std::filesystem::path &sourceFile) const override
{
const BufferOverflowKind kind =
classify_issue(log);
const std::string message =
choose_message(log);
const std::string description =
choose_description(log);
const std::string hint =
choose_hint(log);
const std::string secondaryHint =
choose_secondary_hint(log);
RuntimeLocation location =
find_best_runtime_location(
log,
sourceFile);
if (!location.valid() &&
may_use_source_hint(kind))
{
location =
find_best_runtime_location_or_source_hint(
log,
sourceFile,
source_patterns_for_buffer_overflow());
}
print_error(
message,
description);
if (location.valid())
{
std::cerr << "\n";
const auto error =
make_runtime_location(
location.file,
location.line,
location.column,
message);
print_runtime_codeframe(error);
}
print_hints_and_location(
hint,
secondaryHint,
location);
print_debug_details(log);
return true;
}
};
std::unique_ptr<IRuntimeErrorRule>
makeBufferOverflowRule()
{
return std::make_unique<
BufferOverflowRule>();
}
} // namespace vix::cli::errors::runtime