include/linux/fortify-string.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 #ifndef _LINUX_FORTIFY_STRING_H_
   3 #define _LINUX_FORTIFY_STRING_H_
   4
   5 #include <linux/bug.h>
   6 #include <linux/const.h>
   7 #include <linux/limits.h>
   8
   9 #define __FORTIFY_INLINE extern __always_inline __gnu_inline __overloadable
  10 #define __RENAME(x) __asm__(#x)
  11
  12 void fortify_panic(const char *name) __noreturn __cold;
  13 void __read_overflow(void) __compiletime_error("detected read beyond size of object (1st parameter)");
  14 void __read_overflow2(void) __compiletime_error("detected read beyond size of object (2nd parameter)");
  15 void __read_overflow2_field(size_t avail, size_t wanted) __compiletime_warning("detected read beyond size of field (2nd parameter); maybe use struct_group()?");
  16 void __write_overflow(void) __compiletime_error("detected write beyond size of object (1st parameter)");
  17 void __write_overflow_field(size_t avail, size_t wanted) __compiletime_warning("detected write beyond size of field (1st parameter); maybe use struct_group()?");
  18
  19 #define __compiletime_strlen(p)                                 \
  20 ({                                                              \
  21         char *__p = (char *)(p);                                \
  22         size_t __ret = SIZE_MAX;                                \
  23         const size_t __p_size = __member_size(p);               \
  24         if (__p_size != SIZE_MAX &&                             \
  25             __builtin_constant_p(*__p)) {                       \
  26                 size_t __p_len = __p_size - 1;                  \
  27                 if (__builtin_constant_p(__p[__p_len]) &&       \
  28                     __p[__p_len] == '\0')                       \
  29                         __ret = __builtin_strlen(__p);          \
  30         }                                                       \
  31         __ret;                                                  \
  32 })
  33
  34 #if defined(CONFIG_KASAN_GENERIC) || defined(CONFIG_KASAN_SW_TAGS)
  35 extern void *__underlying_memchr(const void *p, int c, __kernel_size_t size) __RENAME(memchr);
  36 extern int __underlying_memcmp(const void *p, const void *q, __kernel_size_t size) __RENAME(memcmp);
  37 extern void *__underlying_memcpy(void *p, const void *q, __kernel_size_t size) __RENAME(memcpy);
  38 extern void *__underlying_memmove(void *p, const void *q, __kernel_size_t size) __RENAME(memmove);
  39 extern void *__underlying_memset(void *p, int c, __kernel_size_t size) __RENAME(memset);
  40 extern char *__underlying_strcat(char *p, const char *q) __RENAME(strcat);
  41 extern char *__underlying_strcpy(char *p, const char *q) __RENAME(strcpy);
  42 extern __kernel_size_t __underlying_strlen(const char *p) __RENAME(strlen);
  43 extern char *__underlying_strncat(char *p, const char *q, __kernel_size_t count) __RENAME(strncat);
  44 extern char *__underlying_strncpy(char *p, const char *q, __kernel_size_t size) __RENAME(strncpy);
  45 #else
  46
  47 #if defined(__SANITIZE_MEMORY__)
  48 /*
  49  * For KMSAN builds all memcpy/memset/memmove calls should be replaced by the
  50  * corresponding __msan_XXX functions.
  51  */
  52 #include <linux/kmsan_string.h>
  53 #define __underlying_memcpy     __msan_memcpy
  54 #define __underlying_memmove    __msan_memmove
  55 #define __underlying_memset     __msan_memset
  56 #else
  57 #define __underlying_memcpy     __builtin_memcpy
  58 #define __underlying_memmove    __builtin_memmove
  59 #define __underlying_memset     __builtin_memset
  60 #endif
  61
  62 #define __underlying_memchr     __builtin_memchr
  63 #define __underlying_memcmp     __builtin_memcmp
  64 #define __underlying_strcat     __builtin_strcat
  65 #define __underlying_strcpy     __builtin_strcpy
  66 #define __underlying_strlen     __builtin_strlen
  67 #define __underlying_strncat    __builtin_strncat
  68 #define __underlying_strncpy    __builtin_strncpy
  69 #endif
  70
  71 /**
  72  * unsafe_memcpy - memcpy implementation with no FORTIFY bounds checking
  73  *
  74  * @dst: Destination memory address to write to
  75  * @src: Source memory address to read from
  76  * @bytes: How many bytes to write to @dst from @src
  77  * @justification: Free-form text or comment describing why the use is needed
  78  *
  79  * This should be used for corner cases where the compiler cannot do the
  80  * right thing, or during transitions between APIs, etc. It should be used
  81  * very rarely, and includes a place for justification detailing where bounds
  82  * checking has happened, and why existing solutions cannot be employed.
  83  */
  84 #define unsafe_memcpy(dst, src, bytes, justification)           \
  85         __underlying_memcpy(dst, src, bytes)
  86
  87 /*
  88  * Clang's use of __builtin_*object_size() within inlines needs hinting via
  89  * __pass_*object_size(). The preference is to only ever use type 1 (member
  90  * size, rather than struct size), but there remain some stragglers using
  91  * type 0 that will be converted in the future.
  92  */
  93 #if __has_builtin(__builtin_dynamic_object_size)
  94 #define POS                     __pass_dynamic_object_size(1)
  95 #define POS0                    __pass_dynamic_object_size(0)
  96 #else
  97 #define POS                     __pass_object_size(1)
  98 #define POS0                    __pass_object_size(0)
  99 #endif
 100
 101 #define __compiletime_lessthan(bounds, length)  (       \
 102         __builtin_constant_p((bounds) < (length)) &&    \
 103         (bounds) < (length)                             \
 104 )
 105
 106 /**
 107  * strncpy - Copy a string to memory with non-guaranteed NUL padding
 108  *
 109  * @p: pointer to destination of copy
 110  * @q: pointer to NUL-terminated source string to copy
 111  * @size: bytes to write at @p
 112  *
 113  * If strlen(@q) >= @size, the copy of @q will stop after @size bytes,
 114  * and @p will NOT be NUL-terminated
 115  *
 116  * If strlen(@q) < @size, following the copy of @q, trailing NUL bytes
 117  * will be written to @p until @size total bytes have been written.
 118  *
 119  * Do not use this function. While FORTIFY_SOURCE tries to avoid
 120  * over-reads of @q, it cannot defend against writing unterminated
 121  * results to @p. Using strncpy() remains ambiguous and fragile.
 122  * Instead, please choose an alternative, so that the expectation
 123  * of @p's contents is unambiguous:
 124  *
 125  * +--------------------+--------------------+------------+
 126  * | **p** needs to be: | padded to **size** | not padded |
 127  * +====================+====================+============+
 128  * |     NUL-terminated | strscpy_pad()      | strscpy()  |
 129  * +--------------------+--------------------+------------+
 130  * | not NUL-terminated | strtomem_pad()     | strtomem() |
 131  * +--------------------+--------------------+------------+
 132  *
 133  * Note strscpy*()'s differing return values for detecting truncation,
 134  * and strtomem*()'s expectation that the destination is marked with
 135  * __nonstring when it is a character array.
 136  *
 137  */
 138 __FORTIFY_INLINE __diagnose_as(__builtin_strncpy, 1, 2, 3)
 139 char *strncpy(char * const POS p, const char *q, __kernel_size_t size)
 140 {
 141         const size_t p_size = __member_size(p);
 142
 143         if (__compiletime_lessthan(p_size, size))
 144                 __write_overflow();
 145         if (p_size < size)
 146                 fortify_panic(__func__);
 147         return __underlying_strncpy(p, q, size);
 148 }
 149
 150 extern __kernel_size_t __real_strnlen(const char *, __kernel_size_t) __RENAME(strnlen);
 151 /**
 152  * strnlen - Return bounded count of characters in a NUL-terminated string
 153  *
 154  * @p: pointer to NUL-terminated string to count.
 155  * @maxlen: maximum number of characters to count.
 156  *
 157  * Returns number of characters in @p (NOT including the final NUL), or
 158  * @maxlen, if no NUL has been found up to there.
 159  *
 160  */
 161 __FORTIFY_INLINE __kernel_size_t strnlen(const char * const POS p, __kernel_size_t maxlen)
 162 {
 163         const size_t p_size = __member_size(p);
 164         const size_t p_len = __compiletime_strlen(p);
 165         size_t ret;
 166
 167         /* We can take compile-time actions when maxlen is const. */
 168         if (__builtin_constant_p(maxlen) && p_len != SIZE_MAX) {
 169                 /* If p is const, we can use its compile-time-known len. */
 170                 if (maxlen >= p_size)
 171                         return p_len;
 172         }
 173
 174         /* Do not check characters beyond the end of p. */
 175         ret = __real_strnlen(p, maxlen < p_size ? maxlen : p_size);
 176         if (p_size <= ret && maxlen != ret)
 177                 fortify_panic(__func__);
 178         return ret;
 179 }
 180
 181 /*
 182  * Defined after fortified strnlen to reuse it. However, it must still be
 183  * possible for strlen() to be used on compile-time strings for use in
 184  * static initializers (i.e. as a constant expression).
 185  */
 186 /**
 187  * strlen - Return count of characters in a NUL-terminated string
 188  *
 189  * @p: pointer to NUL-terminated string to count.
 190  *
 191  * Do not use this function unless the string length is known at
 192  * compile-time. When @p is unterminated, this function may crash
 193  * or return unexpected counts that could lead to memory content
 194  * exposures. Prefer strnlen().
 195  *
 196  * Returns number of characters in @p (NOT including the final NUL).
 197  *
 198  */
 199 #define strlen(p)                                                       \
 200         __builtin_choose_expr(__is_constexpr(__builtin_strlen(p)),      \
 201                 __builtin_strlen(p), __fortify_strlen(p))
 202 __FORTIFY_INLINE __diagnose_as(__builtin_strlen, 1)
 203 __kernel_size_t __fortify_strlen(const char * const POS p)
 204 {
 205         const size_t p_size = __member_size(p);
 206         __kernel_size_t ret;
 207
 208         /* Give up if we don't know how large p is. */
 209         if (p_size == SIZE_MAX)
 210                 return __underlying_strlen(p);
 211         ret = strnlen(p, p_size);
 212         if (p_size <= ret)
 213                 fortify_panic(__func__);
 214         return ret;
 215 }
 216
 217 /* Defined after fortified strnlen() to reuse it. */
 218 extern ssize_t __real_strscpy(char *, const char *, size_t) __RENAME(strscpy);
 219 /**
 220  * strscpy - Copy a C-string into a sized buffer
 221  *
 222  * @p: Where to copy the string to
 223  * @q: Where to copy the string from
 224  * @size: Size of destination buffer
 225  *
 226  * Copy the source string @q, or as much of it as fits, into the destination
 227  * @p buffer. The behavior is undefined if the string buffers overlap. The
 228  * destination @p buffer is always NUL terminated, unless it's zero-sized.
 229  *
 230  * Preferred to strncpy() since it always returns a valid string, and
 231  * doesn't unnecessarily force the tail of the destination buffer to be
 232  * zero padded. If padding is desired please use strscpy_pad().
 233  *
 234  * Returns the number of characters copied in @p (not including the
 235  * trailing %NUL) or -E2BIG if @size is 0 or the copy of @q was truncated.
 236  */
 237 __FORTIFY_INLINE ssize_t strscpy(char * const POS p, const char * const POS q, size_t size)
 238 {
 239         /* Use string size rather than possible enclosing struct size. */
 240         const size_t p_size = __member_size(p);
 241         const size_t q_size = __member_size(q);
 242         size_t len;
 243
 244         /* If we cannot get size of p and q default to call strscpy. */
 245         if (p_size == SIZE_MAX && q_size == SIZE_MAX)
 246                 return __real_strscpy(p, q, size);
 247
 248         /*
 249          * If size can be known at compile time and is greater than
 250          * p_size, generate a compile time write overflow error.
 251          */
 252         if (__compiletime_lessthan(p_size, size))
 253                 __write_overflow();
 254
 255         /* Short-circuit for compile-time known-safe lengths. */
 256         if (__compiletime_lessthan(p_size, SIZE_MAX)) {
 257                 len = __compiletime_strlen(q);
 258
 259                 if (len < SIZE_MAX && __compiletime_lessthan(len, size)) {
 260                         __underlying_memcpy(p, q, len + 1);
 261                         return len;
 262                 }
 263         }
 264
 265         /*
 266          * This call protects from read overflow, because len will default to q
 267          * length if it smaller than size.
 268          */
 269         len = strnlen(q, size);
 270         /*
 271          * If len equals size, we will copy only size bytes which leads to
 272          * -E2BIG being returned.
 273          * Otherwise we will copy len + 1 because of the final '\O'.
 274          */
 275         len = len == size ? size : len + 1;
 276
 277         /*
 278          * Generate a runtime write overflow error if len is greater than
 279          * p_size.
 280          */
 281         if (len > p_size)
 282                 fortify_panic(__func__);
 283
 284         /*
 285          * We can now safely call vanilla strscpy because we are protected from:
 286          * 1. Read overflow thanks to call to strnlen().
 287          * 2. Write overflow thanks to above ifs.
 288          */
 289         return __real_strscpy(p, q, len);
 290 }
 291
 292 /* Defined after fortified strlen() to reuse it. */
 293 extern size_t __real_strlcat(char *p, const char *q, size_t avail) __RENAME(strlcat);
 294 /**
 295  * strlcat - Append a string to an existing string
 296  *
 297  * @p: pointer to %NUL-terminated string to append to
 298  * @q: pointer to %NUL-terminated string to append from
 299  * @avail: Maximum bytes available in @p
 300  *
 301  * Appends %NUL-terminated string @q after the %NUL-terminated
 302  * string at @p, but will not write beyond @avail bytes total,
 303  * potentially truncating the copy from @q. @p will stay
 304  * %NUL-terminated only if a %NUL already existed within
 305  * the @avail bytes of @p. If so, the resulting number of
 306  * bytes copied from @q will be at most "@avail - strlen(@p) - 1".
 307  *
 308  * Do not use this function. While FORTIFY_SOURCE tries to avoid
 309  * read and write overflows, this is only possible when the sizes
 310  * of @p and @q are known to the compiler. Prefer building the
 311  * string with formatting, via scnprintf(), seq_buf, or similar.
 312  *
 313  * Returns total bytes that _would_ have been contained by @p
 314  * regardless of truncation, similar to snprintf(). If return
 315  * value is >= @avail, the string has been truncated.
 316  *
 317  */
 318 __FORTIFY_INLINE
 319 size_t strlcat(char * const POS p, const char * const POS q, size_t avail)
 320 {
 321         const size_t p_size = __member_size(p);
 322         const size_t q_size = __member_size(q);
 323         size_t p_len, copy_len;
 324         size_t actual, wanted;
 325
 326         /* Give up immediately if both buffer sizes are unknown. */
 327         if (p_size == SIZE_MAX && q_size == SIZE_MAX)
 328                 return __real_strlcat(p, q, avail);
 329
 330         p_len = strnlen(p, avail);
 331         copy_len = strlen(q);
 332         wanted = actual = p_len + copy_len;
 333
 334         /* Cannot append any more: report truncation. */
 335         if (avail <= p_len)
 336                 return wanted;
 337
 338         /* Give up if string is already overflowed. */
 339         if (p_size <= p_len)
 340                 fortify_panic(__func__);
 341
 342         if (actual >= avail) {
 343                 copy_len = avail - p_len - 1;
 344                 actual = p_len + copy_len;
 345         }
 346
 347         /* Give up if copy will overflow. */
 348         if (p_size <= actual)
 349                 fortify_panic(__func__);
 350         __underlying_memcpy(p + p_len, q, copy_len);
 351         p[actual] = '\0';
 352
 353         return wanted;
 354 }
 355
 356 /* Defined after fortified strlcat() to reuse it. */
 357 /**
 358  * strcat - Append a string to an existing string
 359  *
 360  * @p: pointer to NUL-terminated string to append to
 361  * @q: pointer to NUL-terminated source string to append from
 362  *
 363  * Do not use this function. While FORTIFY_SOURCE tries to avoid
 364  * read and write overflows, this is only possible when the
 365  * destination buffer size is known to the compiler. Prefer
 366  * building the string with formatting, via scnprintf() or similar.
 367  * At the very least, use strncat().
 368  *
 369  * Returns @p.
 370  *
 371  */
 372 __FORTIFY_INLINE __diagnose_as(__builtin_strcat, 1, 2)
 373 char *strcat(char * const POS p, const char *q)
 374 {
 375         const size_t p_size = __member_size(p);
 376
 377         if (strlcat(p, q, p_size) >= p_size)
 378                 fortify_panic(__func__);
 379         return p;
 380 }
 381
 382 /**
 383  * strncat - Append a string to an existing string
 384  *
 385  * @p: pointer to NUL-terminated string to append to
 386  * @q: pointer to source string to append from
 387  * @count: Maximum bytes to read from @q
 388  *
 389  * Appends at most @count bytes from @q (stopping at the first
 390  * NUL byte) after the NUL-terminated string at @p. @p will be
 391  * NUL-terminated.
 392  *
 393  * Do not use this function. While FORTIFY_SOURCE tries to avoid
 394  * read and write overflows, this is only possible when the sizes
 395  * of @p and @q are known to the compiler. Prefer building the
 396  * string with formatting, via scnprintf() or similar.
 397  *
 398  * Returns @p.
 399  *
 400  */
 401 /* Defined after fortified strlen() and strnlen() to reuse them. */
 402 __FORTIFY_INLINE __diagnose_as(__builtin_strncat, 1, 2, 3)
 403 char *strncat(char * const POS p, const char * const POS q, __kernel_size_t count)
 404 {
 405         const size_t p_size = __member_size(p);
 406         const size_t q_size = __member_size(q);
 407         size_t p_len, copy_len;
 408
 409         if (p_size == SIZE_MAX && q_size == SIZE_MAX)
 410                 return __underlying_strncat(p, q, count);
 411         p_len = strlen(p);
 412         copy_len = strnlen(q, count);
 413         if (p_size < p_len + copy_len + 1)
 414                 fortify_panic(__func__);
 415         __underlying_memcpy(p + p_len, q, copy_len);
 416         p[p_len + copy_len] = '\0';
 417         return p;
 418 }
 419
 420 __FORTIFY_INLINE void fortify_memset_chk(__kernel_size_t size,
 421                                          const size_t p_size,
 422                                          const size_t p_size_field)
 423 {
 424         if (__builtin_constant_p(size)) {
 425                 /*
 426                  * Length argument is a constant expression, so we
 427                  * can perform compile-time bounds checking where
 428                  * buffer sizes are also known at compile time.
 429                  */
 430
 431                 /* Error when size is larger than enclosing struct. */
 432                 if (__compiletime_lessthan(p_size_field, p_size) &&
 433                     __compiletime_lessthan(p_size, size))
 434                         __write_overflow();
 435
 436                 /* Warn when write size is larger than dest field. */
 437                 if (__compiletime_lessthan(p_size_field, size))
 438                         __write_overflow_field(p_size_field, size);
 439         }
 440         /*
 441          * At this point, length argument may not be a constant expression,
 442          * so run-time bounds checking can be done where buffer sizes are
 443          * known. (This is not an "else" because the above checks may only
 444          * be compile-time warnings, and we want to still warn for run-time
 445          * overflows.)
 446          */
 447
 448         /*
 449          * Always stop accesses beyond the struct that contains the
 450          * field, when the buffer's remaining size is known.
 451          * (The SIZE_MAX test is to optimize away checks where the buffer
 452          * lengths are unknown.)
 453          */
 454         if (p_size != SIZE_MAX && p_size < size)
 455                 fortify_panic("memset");
 456 }
 457
 458 #define __fortify_memset_chk(p, c, size, p_size, p_size_field) ({       \
 459         size_t __fortify_size = (size_t)(size);                         \
 460         fortify_memset_chk(__fortify_size, p_size, p_size_field),       \
 461         __underlying_memset(p, c, __fortify_size);                      \
 462 })
 463
 464 /*
 465  * __struct_size() vs __member_size() must be captured here to avoid
 466  * evaluating argument side-effects further into the macro layers.
 467  */
 468 #ifndef CONFIG_KMSAN
 469 #define memset(p, c, s) __fortify_memset_chk(p, c, s,                   \
 470                 __struct_size(p), __member_size(p))
 471 #endif
 472
 473 /*
 474  * To make sure the compiler can enforce protection against buffer overflows,
 475  * memcpy(), memmove(), and memset() must not be used beyond individual
 476  * struct members. If you need to copy across multiple members, please use
 477  * struct_group() to create a named mirror of an anonymous struct union.
 478  * (e.g. see struct sk_buff.) Read overflow checking is currently only
 479  * done when a write overflow is also present, or when building with W=1.
 480  *
 481  * Mitigation coverage matrix
 482  *                                      Bounds checking at:
 483  *                                      +-------+-------+-------+-------+
 484  *                                      | Compile time  |   Run time    |
 485  * memcpy() argument sizes:             | write | read  | write | read  |
 486  *        dest     source   length      +-------+-------+-------+-------+
 487  * memcpy(known,   known,   constant)   |   y   |   y   |  n/a  |  n/a  |
 488  * memcpy(known,   unknown, constant)   |   y   |   n   |  n/a  |   V   |
 489  * memcpy(known,   known,   dynamic)    |   n   |   n   |   B   |   B   |
 490  * memcpy(known,   unknown, dynamic)    |   n   |   n   |   B   |   V   |
 491  * memcpy(unknown, known,   constant)   |   n   |   y   |   V   |  n/a  |
 492  * memcpy(unknown, unknown, constant)   |   n   |   n   |   V   |   V   |
 493  * memcpy(unknown, known,   dynamic)    |   n   |   n   |   V   |   B   |
 494  * memcpy(unknown, unknown, dynamic)    |   n   |   n   |   V   |   V   |
 495  *                                      +-------+-------+-------+-------+
 496  *
 497  * y = perform deterministic compile-time bounds checking
 498  * n = cannot perform deterministic compile-time bounds checking
 499  * n/a = no run-time bounds checking needed since compile-time deterministic
 500  * B = can perform run-time bounds checking (currently unimplemented)
 501  * V = vulnerable to run-time overflow (will need refactoring to solve)
 502  *
 503  */
 504 __FORTIFY_INLINE bool fortify_memcpy_chk(__kernel_size_t size,
 505                                          const size_t p_size,
 506                                          const size_t q_size,
 507                                          const size_t p_size_field,
 508                                          const size_t q_size_field,
 509                                          const char *func)
 510 {
 511         if (__builtin_constant_p(size)) {
 512                 /*
 513                  * Length argument is a constant expression, so we
 514                  * can perform compile-time bounds checking where
 515                  * buffer sizes are also known at compile time.
 516                  */
 517
 518                 /* Error when size is larger than enclosing struct. */
 519                 if (__compiletime_lessthan(p_size_field, p_size) &&
 520                     __compiletime_lessthan(p_size, size))
 521                         __write_overflow();
 522                 if (__compiletime_lessthan(q_size_field, q_size) &&
 523                     __compiletime_lessthan(q_size, size))
 524                         __read_overflow2();
 525
 526                 /* Warn when write size argument larger than dest field. */
 527                 if (__compiletime_lessthan(p_size_field, size))
 528                         __write_overflow_field(p_size_field, size);
 529                 /*
 530                  * Warn for source field over-read when building with W=1
 531                  * or when an over-write happened, so both can be fixed at
 532                  * the same time.
 533                  */
 534                 if ((IS_ENABLED(KBUILD_EXTRA_WARN1) ||
 535                      __compiletime_lessthan(p_size_field, size)) &&
 536                     __compiletime_lessthan(q_size_field, size))
 537                         __read_overflow2_field(q_size_field, size);
 538         }
 539         /*
 540          * At this point, length argument may not be a constant expression,
 541          * so run-time bounds checking can be done where buffer sizes are
 542          * known. (This is not an "else" because the above checks may only
 543          * be compile-time warnings, and we want to still warn for run-time
 544          * overflows.)
 545          */
 546
 547         /*
 548          * Always stop accesses beyond the struct that contains the
 549          * field, when the buffer's remaining size is known.
 550          * (The SIZE_MAX test is to optimize away checks where the buffer
 551          * lengths are unknown.)
 552          */
 553         if ((p_size != SIZE_MAX && p_size < size) ||
 554             (q_size != SIZE_MAX && q_size < size))
 555                 fortify_panic(func);
 556
 557         /*
 558          * Warn when writing beyond destination field size.
 559          *
 560          * We must ignore p_size_field == 0 for existing 0-element
 561          * fake flexible arrays, until they are all converted to
 562          * proper flexible arrays.
 563          *
 564          * The implementation of __builtin_*object_size() behaves
 565          * like sizeof() when not directly referencing a flexible
 566          * array member, which means there will be many bounds checks
 567          * that will appear at run-time, without a way for them to be
 568          * detected at compile-time (as can be done when the destination
 569          * is specifically the flexible array member).
 570          * https://gcc.gnu.org/bugzilla/show_bug.cgi?id=101832
 571          */
 572         if (p_size_field != 0 && p_size_field != SIZE_MAX &&
 573             p_size != p_size_field && p_size_field < size)
 574                 return true;
 575
 576         return false;
 577 }
 578
 579 #define __fortify_memcpy_chk(p, q, size, p_size, q_size,                \
 580                              p_size_field, q_size_field, op) ({         \
 581         const size_t __fortify_size = (size_t)(size);                   \
 582         const size_t __p_size = (p_size);                               \
 583         const size_t __q_size = (q_size);                               \
 584         const size_t __p_size_field = (p_size_field);                   \
 585         const size_t __q_size_field = (q_size_field);                   \
 586         WARN_ONCE(fortify_memcpy_chk(__fortify_size, __p_size,          \
 587                                      __q_size, __p_size_field,          \
 588                                      __q_size_field, #op),              \
 589                   #op ": detected field-spanning write (size %zu) of single %s (size %zu)\n", \
 590                   __fortify_size,                                       \
 591                   "field \"" #p "\" at " FILE_LINE,                     \
 592                   __p_size_field);                                      \
 593         __underlying_##op(p, q, __fortify_size);                        \
 594 })
 595
 596 /*
 597  * Notes about compile-time buffer size detection:
 598  *
 599  * With these types...
 600  *
 601  *      struct middle {
 602  *              u16 a;
 603  *              u8 middle_buf[16];
 604  *              int b;
 605  *      };
 606  *      struct end {
 607  *              u16 a;
 608  *              u8 end_buf[16];
 609  *      };
 610  *      struct flex {
 611  *              int a;
 612  *              u8 flex_buf[];
 613  *      };
 614  *
 615  *      void func(TYPE *ptr) { ... }
 616  *
 617  * Cases where destination size cannot be currently detected:
 618  * - the size of ptr's object (seemingly by design, gcc & clang fail):
 619  *      __builtin_object_size(ptr, 1) == SIZE_MAX
 620  * - the size of flexible arrays in ptr's obj (by design, dynamic size):
 621  *      __builtin_object_size(ptr->flex_buf, 1) == SIZE_MAX
 622  * - the size of ANY array at the end of ptr's obj (gcc and clang bug):
 623  *      __builtin_object_size(ptr->end_buf, 1) == SIZE_MAX
 624  *      https://gcc.gnu.org/bugzilla/show_bug.cgi?id=101836
 625  *
 626  * Cases where destination size is currently detected:
 627  * - the size of non-array members within ptr's object:
 628  *      __builtin_object_size(ptr->a, 1) == 2
 629  * - the size of non-flexible-array in the middle of ptr's obj:
 630  *      __builtin_object_size(ptr->middle_buf, 1) == 16
 631  *
 632  */
 633
 634 /*
 635  * __struct_size() vs __member_size() must be captured here to avoid
 636  * evaluating argument side-effects further into the macro layers.
 637  */
 638 #define memcpy(p, q, s)  __fortify_memcpy_chk(p, q, s,                  \
 639                 __struct_size(p), __struct_size(q),                     \
 640                 __member_size(p), __member_size(q),                     \
 641                 memcpy)
 642 #define memmove(p, q, s)  __fortify_memcpy_chk(p, q, s,                 \
 643                 __struct_size(p), __struct_size(q),                     \
 644                 __member_size(p), __member_size(q),                     \
 645                 memmove)
 646
 647 extern void *__real_memscan(void *, int, __kernel_size_t) __RENAME(memscan);
 648 __FORTIFY_INLINE void *memscan(void * const POS0 p, int c, __kernel_size_t size)
 649 {
 650         const size_t p_size = __struct_size(p);
 651
 652         if (__compiletime_lessthan(p_size, size))
 653                 __read_overflow();
 654         if (p_size < size)
 655                 fortify_panic(__func__);
 656         return __real_memscan(p, c, size);
 657 }
 658
 659 __FORTIFY_INLINE __diagnose_as(__builtin_memcmp, 1, 2, 3)
 660 int memcmp(const void * const POS0 p, const void * const POS0 q, __kernel_size_t size)
 661 {
 662         const size_t p_size = __struct_size(p);
 663         const size_t q_size = __struct_size(q);
 664
 665         if (__builtin_constant_p(size)) {
 666                 if (__compiletime_lessthan(p_size, size))
 667                         __read_overflow();
 668                 if (__compiletime_lessthan(q_size, size))
 669                         __read_overflow2();
 670         }
 671         if (p_size < size || q_size < size)
 672                 fortify_panic(__func__);
 673         return __underlying_memcmp(p, q, size);
 674 }
 675
 676 __FORTIFY_INLINE __diagnose_as(__builtin_memchr, 1, 2, 3)
 677 void *memchr(const void * const POS0 p, int c, __kernel_size_t size)
 678 {
 679         const size_t p_size = __struct_size(p);
 680
 681         if (__compiletime_lessthan(p_size, size))
 682                 __read_overflow();
 683         if (p_size < size)
 684                 fortify_panic(__func__);
 685         return __underlying_memchr(p, c, size);
 686 }
 687
 688 void *__real_memchr_inv(const void *s, int c, size_t n) __RENAME(memchr_inv);
 689 __FORTIFY_INLINE void *memchr_inv(const void * const POS0 p, int c, size_t size)
 690 {
 691         const size_t p_size = __struct_size(p);
 692
 693         if (__compiletime_lessthan(p_size, size))
 694                 __read_overflow();
 695         if (p_size < size)
 696                 fortify_panic(__func__);
 697         return __real_memchr_inv(p, c, size);
 698 }
 699
 700 extern void *__real_kmemdup(const void *src, size_t len, gfp_t gfp) __RENAME(kmemdup)
 701                                                                     __realloc_size(2);
 702 __FORTIFY_INLINE void *kmemdup(const void * const POS0 p, size_t size, gfp_t gfp)
 703 {
 704         const size_t p_size = __struct_size(p);
 705
 706         if (__compiletime_lessthan(p_size, size))
 707                 __read_overflow();
 708         if (p_size < size)
 709                 fortify_panic(__func__);
 710         return __real_kmemdup(p, size, gfp);
 711 }
 712
 713 /**
 714  * strcpy - Copy a string into another string buffer
 715  *
 716  * @p: pointer to destination of copy
 717  * @q: pointer to NUL-terminated source string to copy
 718  *
 719  * Do not use this function. While FORTIFY_SOURCE tries to avoid
 720  * overflows, this is only possible when the sizes of @q and @p are
 721  * known to the compiler. Prefer strscpy(), though note its different
 722  * return values for detecting truncation.
 723  *
 724  * Returns @p.
 725  *
 726  */
 727 /* Defined after fortified strlen to reuse it. */
 728 __FORTIFY_INLINE __diagnose_as(__builtin_strcpy, 1, 2)
 729 char *strcpy(char * const POS p, const char * const POS q)
 730 {
 731         const size_t p_size = __member_size(p);
 732         const size_t q_size = __member_size(q);
 733         size_t size;
 734
 735         /* If neither buffer size is known, immediately give up. */
 736         if (__builtin_constant_p(p_size) &&
 737             __builtin_constant_p(q_size) &&
 738             p_size == SIZE_MAX && q_size == SIZE_MAX)
 739                 return __underlying_strcpy(p, q);
 740         size = strlen(q) + 1;
 741         /* Compile-time check for const size overflow. */
 742         if (__compiletime_lessthan(p_size, size))
 743                 __write_overflow();
 744         /* Run-time check for dynamic size overflow. */
 745         if (p_size < size)
 746                 fortify_panic(__func__);
 747         __underlying_memcpy(p, q, size);
 748         return p;
 749 }
 750
 751 /* Don't use these outside the FORITFY_SOURCE implementation */
 752 #undef __underlying_memchr
 753 #undef __underlying_memcmp
 754 #undef __underlying_strcat
 755 #undef __underlying_strcpy
 756 #undef __underlying_strlen
 757 #undef __underlying_strncat
 758 #undef __underlying_strncpy
 759
 760 #undef POS
 761 #undef POS0
 762
 763 #endif /* _LINUX_FORTIFY_STRING_H_ */