FreeBSDLibcSecurityExtensions [FreeBSD WIKI]

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== FreeBSD libc security extensions ======
  * Student: [[/OliverPinter|OliverPinter]] %%<%%op@{free,hardened}bsd.org>
  * Mentor: [[/PedroGiffuni|PedroGiffuni]] <pfg@FreeBSD.org>
  * Build status: [[http://jenkins.hardenedbsd.org:8180/jenkins/job/opBSD-11-fortify-amd64|[[http://jenkins.hardenedbsd.org:8180/jenkins/job/opBSD-11-fortify-amd64/lastCompletedBuild/badge/icon  ]]

===== Project description =====
Buffer overflows are the common origin of many security vulnerabilities, if we could catch these type of errors, then we would be able to protect against buffer overflows and buffer overflow based ROP attacks.\\ 
In part of this project I plan the following two phases:\\ 
First Phase:
Implement FORTIFY_SOURCE, a gcc extension (also partially supported in clang), where the compiler's builtin object size informations is used by the C library to detect buffer overflows. The extension is known to be supported already by GNU libc, Apple’s Xcode, Android’s bionic libc, and %%NetBSD%%’s libc. This extension causes no secondary effects on the generated code but adds lightweight buffer checking during the compile and runtime.
Second Phase (NOT TO BE DONE):
Implement standard C11 Boundary checking Extensions to the C Library Part I: Bounds-checking interfaces[1][2] with their corresponding unit tests. These extensions are rather controversial but they are already implemented in commercial compilers like Microsoft Visual C and would be very useful in the future to port software from that platform. Part of this code could be useful in complementing the checks developed in the first phase and could be considered for future research.

**//WE THOUGHT WE MIGHT FIND THE TIME TO AT LEAST START THE SECOND PHASE BUT AFTER RECONSIDERING, THE FIRST PART IS SUFFICIENT FOR THIS GSOC PROJECT.//**

===== Deliverables =====
==== phase #1 ====
  * Implement FORTIFY_SOURCE extension in libc.
  * Android’s Bionic libc provides a reference implementation under a BSD License.
  * Tests implemented extensions by building world to detect vulnerabilities.
  * Test ports that already know about FORTIFY_SOURCE like mozilla and vim.
==== phase #2 ====
  * Implement C11 extensions, described in TR 24731-1 [1][2]
  * New functions must be documented, probably along within the related man pages.
  * Safeclib provides a reference implementation under an MIT license.
  * Provide unit tests related to implemented extensions.
  * Bring %%FreeBSD%% one step closer to support C11 completely in the base system.
==== GSoC extra ====
  * Review if we can re-use phase 2 into phase 1.

===== Milestones =====
==== phase #1 ====

| schedule | description | status |
| May 25 - May 31 | deeply understand FORTIFY_SOURCE extensions and create a schedule for required changes | done |
| June 1 - June 7 | inspect the existing implementations and start the porting | done |
| June 8 - June 14 | adapt portable codes from %%NetBSD%% / bionic libc - part 1. - based on the upper scheduling | done |
| June 15 - June 21 | adapt portable codes from %%NetBSD%% / bionic libc  - part 2. - based on the upper scheduling | done |

==== phase #2 - reprogrammed ====

| schedule | description | status |
| June 22 - July 5 | test cases, bugfixes and man pages | started |
| July 6 - July 12 | Fix issues related to different toolchains | started |
| July 13 - August 2 | Experiment with build options | not started |
| August 3 - August 9 | test cases | not started |
| August 10 - August 24 | bugfixes, man pages and extra works | not started |

===== Test Plan =====
==== phase #1 ====
(implement FORTIFY_SOURCE)
  * Bounds range checking.
  * Basic exploitation checking.
  * Kyua tests.
==== phase #2 ====
(enhance FORTIFY_SOURCE - reformulated)
  * General build testing: should work with base gcc and clang.
  * Report and fix Buffer Overflows in base.
  * Basic ports build testing.
  * extend build support for other frameworks (sanitizers?).
===== The Code =====

https://reviews.freebsd.org/D3043

https://github.com/opntr/opBSD/tree/op/gsoc2015/fortify

===== Useful links =====

==== General Reference ====

[G] http://bxr.su/

[G] http://src.illumos.org/source/

==== FORTIFY_SOURCE ====

[F] https://github.com/android/platform_bionic/tree/master/libc/bionic

[F] https://copperhead.co/2015/07/27/hardening-bionic

[F] https://android.googlesource.com/platform/bionic/+/16d1af167f8e36a9aa4a07ae77034ad519b00463

[F] https://llvm.org/bugs/show_bug.cgi?id=5028

[F] https://llvm.org/bugs/show_bug.cgi?id=23277

[F] https://llvm.org/bugs/show_bug.cgi?id=23280

[F] https://svnweb.freebsd.org/base/head/contrib/gcc/builtins.def?revision=258428&view=markup#l704

[F] http://cvsweb.netbsd.org/bsdweb.cgi/src/tests/lib/libc/ssp/ - netbsd test cases

[F] http://isisblogs.poly.edu/2011/04/11/fortify_source-semantics/

[F] https://securityblog.redhat.com/2014/03/26/fortify-and-you/

[F] https://idea.popcount.org/2013-08-15-fortify_source/

[F] http://phrack.org/issues/67/9.html

[F][clang] http://lists.cs.uiuc.edu/pipermail/cfe-commits/Week-of-Mon-20140915/115049.html

[F][clang] https://android.googlesource.com/platform/bionic/+/829c089f83ddee37203b52bcb294867a9ae7bdbc

[F][clang] https://android.googlesource.com/platform/bionic/+/16d1af167f8e36a9aa4a07ae77034ad519b00463

[F][clang] https://android.googlesource.com/platform/bionic/+/7cc779f15c524e1622f7d5b1c7e82e6ffc6677fd

[F][E] https://github.com/jsonn/src/tree/b89bad92261a943f900d7235ae50a7326ccd5062/include/ssp

==== C11 Extensions ====

[E] http://www.open-std.org/jtc1/sc22/wg14/www/docs/n1225.pdf {{summerofcode2015/freebsdlibcsecurityextensions/n1225.pdf?linkonly|n1225.pdf}}

[E] http://www.open-std.org/JTC1/SC22/WG14/www/docs/n1173.pdf {{summerofcode2015/freebsdlibcsecurityextensions/n1173.pdf?linkonly|n1173.pdf}}

[E] https://msdn.microsoft.com/en-us/library/wd3wzwts.aspx

[E] https://gustedt.wordpress.com/2013/02/04/runtime-constraint-violations/

[E] http://www.open-std.org/jtc1/sc22/wg14/www/docs/n1255.pdf

===== 1.1 =====

|  | apple | bionic | netbsd | freebsd |
| ''%%__bos%%'' | n.a. | 3BSDL | n.a. | done |
| ''%%__bos0%%'' | n.a. | 3BSDL | n.a. | done |
| ''%%__chk_fail%%'' | APSL | n.a. | 2BSDL | done |
| ''%%__chk_fail_overflow%%'' | APSL | n.a. | n.a. | n.a. |
| ''%%__chk_fail_overlap%%'' | APSL | n.a. | n.a. | n.a. |
| ''%%__darwin_obsz%%'' | APSL | n.a. | n.a. | n.a. |
| ''%%__darwin_obsz0%%'' | APSL | n.a. | n.a. | n.a. |
| ''%%__fortify_chk_fail%%'' | n.a. | 2BSDL | n.a. | done |
| ''%%__fortify_chk_overlap%%'' | n.a. | n.a. | n.a. | done |
| ''%%__ssp_bos%%'' | n.a. | n.a. | 2BSDL | n.a. |
| ''%%__ssp_bos0%%'' | n.a. | n.a. | 2BSDL | n.a. |
| ''%%__ssp_overlap%%'' | n.a. | n.a. | 2BSDL | n.a. |
|  |  |  |  |  |
| ''%%__FD_ISSET_chk%%'' | n.a. | 2BSDL | n.a. | done |
| ''%%__FD_CLR_chk%%'' | n.a. | 2BSDL | n.a. | done |
| ''%%__FD_SET_chk%%'' | n.a. | 2BSDL | n.a. | done |
| ''%%"__bcopy_chk"%%'' | n.a. | 4BSDL | n.a. | done |
| ''%%"__bzero_chk"%%'' | n.a. | 4BSDL | n.a. | done |
| ''%%__fgets_chk%%'' | n.a. | 2BSDL | 2BSDL | done |
| ''%%__fread_chk%%'' | n.a. | 2BSDL | n.a. | done |
| ''%%__fwrite_chk%%'' | n.a. | 2BSDL | n.a. | done |
| ''%%__getcwd_chk%%'' | n.a. | 2BSDL | n.a. | done |
| ''%%__gets_chk%%'' | n.a. | n.a. | 2BSDL | n.a. |
| ''%%__memccpy_chk%%'' | APSL | n.a. | n.a. | done + overlap |
| ''%%__memchr_chk%%'' | n.a. | 2BSDL | n.a. | done |
| ''%%__memcpy_chk%%'' | APSL | 2BSDL | 2BSDL | done + overlap |
| ''%%__memmove_chk%%'' | APSL | 2BSDL | 2BSDL | done |
| ''%%__memrchr_chk%%'' | n.a. | 2BSDL | n.a. | done |
| ''%%__memset_chk%%'' | APSL | 2BSDL | 2BSDL | done |
| ''%%__open_2%%'' (XXX) | n.a. | 2BSDL | n.a. | ??? |
| ''%%__openat_2%%'' (XXX) | n.a. | 2BSDL | n.a. | ??? |
| ''%%__poll_chk%%'' | n.a. | 2BSDL | n.a. | done |
| ''%%__ppoll_chk%%'' | n.a. | 2BSDL | n.a. | done |
| ''%%__pread64_chk%%'' | n.a. | 2BSDL | n.a. | n.a. |
| ''%%__pread_chk%%'' | n.a. | 2BSDL | n.a. | done |
| ''%%__pwrite64_chk%%'' | n.a. | 2BSDL | n.a. | n.a. |
| ''%%__pwrite_chk%%'' | n.a. | 2BSDL | n.a. | todo |
| ''%%__read_chk%%'' | n.a. | 2BSDL | n.a. | done |
| ''%%__readlink_chk%%'' | n.a. | 2BSDL | n.a. | done |
| ''%%__readlinkat_chk%%'' | n.a. | 2BSDL | n.a. | done |
| ''%%__recvfrom_chk%%'' | n.a. | 2BSDL | n.a. | done |
| ''%%__rindex_chk%%'' | n.a. | 3BSDL | n.a. | done |
| ''%%__snprintf_chk%%'' | APSL | 2BSDL | 2BSDL | done |
| ''%%__sprintf_chk%%'' | APSL | 2BSDL | 2BSDL | done |
| ''%%__stpcpy_chk%%'' | APSL | 2BSDL | 2BSDL | done |
| ''%%__stpncpy_chk%%'' | APSL | 2BSDL | 2BSDL | done |
| ''%%__stpncpy_chk2%%'' | n.a. | 2BSDL | n.a. | done |
| ''%%__strcat_chk%%'' | APSL | 2BSDL | 2BSDL | done |
| ''%%__strchr_chk%%'' | n.a. | 3BSDL | n.a. | done |
| ''%%__strchrnul_chk%%'' | n.a. | n.a. | n.a. | done |
| ''%%__strcpy_chk%%'' | APSL | 2BSDL | 2BSDL | done |
| ''%%__strlcat_chk%%'' | APSL | 2BSDL | n.a. | done |
| ''%%__strlcpy_chk%%'' | APSL | 2BSDL | n.a. | done |
| ''%%__strlen_chk%%'' | n.a. | 2BSDL | n.a. | done |
| ''%%__strncat_chk%%'' | APSL | 2BSDL | 2BSDL | done |
| ''%%__strncpy_chk%%'' | APSL | 2BSDL | 2BSDL | done |
| ''%%__strncpy_chk2%%'' | n.a. | 2BSDL | n.a. | done |
| ''%%__strrchr_chk%%'' | n.a. | 3BSDL | n.a. | done |
| ''%%__umask_chk%%'' | n.a. | 2BSDL | n.a. | done (sys/stat.h) |
| ''%%__vsnprintf_chk%%'' | APSL | 2BSDL | 2BSDL | done |
| ''%%__vsprintf_chk%%'' | APSL | 2BSDL | 2BSDL | done |
| ''%%__realpath_chk%%'' |  |  |  | todo |
| w*? |  |  |  |  |

===== 1.2 =====

  * Netbsd has updated their stack smash protector related files (${NETBSDSRC}/lib/libc/misc/stack_protector.c, which contains the ''%%__fail(...)%%'' and ''%%__chk_fail(...)%%'' functions. I plan to update these functions from %%NetBSD%% too.
  * Other thing, is to factor out the ''%%__fail(...)%%'' and ''%%__chk_fail(...)%%'' to common place, and add them to libc_prive.h or security/common.h. After this change, we could use them from ssp and fortify.
  * The headers should placed in the lib/libc/include/security/{stack_protector,fortify_source,common}.h files.

| ''%%__fail%%'' |  |
| ''%%__chk_fail%%'' |  |
| ''%%__ssp_chk_fail%%'' |  |
| ''%%__fortify_chk_fail%%'' |  |

  * %%FreeBSD%% libc's headers live here:

| ${SRCTOP}/include/string.h |  |
| ${SRCTOP}/include/stdlib.h |  |
| ${SRCTOP}/include/stdio.h |  |

  * what is right place for the newly added ''%%__*_chk%%'' symbols: FBSD_1.4 or FBSDprivate_1.0 - in first sight FBSD_1.4 because they should be accessible from any library 

====== tools ======

| svn-cherry-pick-from-git.csh | http://svnweb.freebsd.org/socsvn/soc2014/op/tools/svn-cherry-pick-from-git.csh?view=log |

====== "weekly" status reports ======

| 20150627 | https://lists.freebsd.org/pipermail/soc-status/2015-June/000918.html |
| 20150823 | http://xxx |

====== test results and memos ======

====== detected and fixed issues with and under FORTIFY_SOURCE development ======

  * editors/emacs* - misused umask() parameter - https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=202574
  * mail/ifile - broken #undef __OPTIMIZE__ - https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=202572
  * hyperv tools - uninitialized parameter - https://github.com/freebsd/freebsd/commit/4485ab4d3d63c821390eecb708c6ba6bfccdbe8f
  * sys build framework - badly passed compiler parameter - https://github.com/freebsd/freebsd/commit/057f55aa4b0390ec8926744ec9dbac8dde9dfa99
  * wall, syslogd - buffer overflow - https://github.com/freebsd/freebsd/commit/8597d814df1fcc6d7e612a9da2dfc99025f98867
  * libdtrace - buffer overflow - https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=201657

====== Project Conclusion ======

The %%GSoC%% is over and we are satisfied with the results of the exercise.
The code is not being considered for the base system for three reasons:

  * The code has issues that need more work.
  * clang didn't really implement support for FORTIFY_SOURCE and the GCC model doesn't really work well with clang. Note that Google's Bionic libc has a new [[https://android-developers.googleblog.com/2017/04/fortify-in-android.html|design]] that works with clang.
  * FORTIFY_SOURCE can be largely replaced by combining other technologies like static checkers and sanitizers that don't add code to the C library. The "strong" stack protection and safe stack have also improved significantly making FORTIFY_SOURCE redundant.