This is a (hacked up) port of Trail of Bits' krf utility from Linux to FreeBSD 12.
All credit goes to ToB and William Woodruff for the design and development of the linux krf tool and for much of the code here in this port. Much of what I did was just copy/paste and then hack, I mean, fix it to work in FreeBSD. I highly recommend reading their github materials prior to using this.
The FreeBSD port was supported by Veracode where the author is a member of the Applied Research Group.
Currently as of the initial commit, this is incomplete in the number of syscalls supported. Numerous of the YAML specs are filled out, but no where complete. Further, I have removed numerous specs I was not planning to support...most of these are in the realm of security features such as MAC and Capabilities.
Note This code is not intended to be used in production and likely contains bugs that could be problematic from a stability and a security perspective. Take heed of this warning before utilizing this utility!
Note The author will likely spend minimal time updating/improving/ fixing any bugs, but is open to PRs. Especially for increased system call coverage.
Since it is for FreeBSD and this is kernel based there are clearly some implementation differences. I did not note what I changed in my hackfest that would differ from their implementation but I will try to list them below:
- Implement the configuration settings using sysctl instead of procfs
- Using __typeof() instead of typeof() (which I should have just #define'd)
- You'll recall how arguments are in FreeBSD... that is a $syscall_args struct.
- Copy full sysent table (memory hog :( this can be cleaned up to just sy_call_t's)
- Since no personality(2) in FreeBSD and procctl(2) is not easily extended from a KLD, I chose to use some free space in the p_flag2 element of struct proc. This allows for enable/disable of KRF for each process. To do this, I (stupidly?) add a system call for enable/disable/what is the status .. it is krfsys. Note I have to hook fork-like calls to ensure the child procs are KRF'd. Passing onto child could be optional, but I have not made it that way. krfsys should be loaded before krf.ko because of the hooking of fork calls. The system call is named faultable().
- In certain cases, I don't lock around reading p_flag2.
- I probably should have locking or something around sysent entry changes :-o
To test this setup (yes, please ignore my heavy handed root use here :P):
Build the faultable() module and load it (before krf.ko)
# cd src/krfsys
# make
# kldload ./krfsys.ko
# dmesg | grep faultable (210 for my out of the box 12.0)
Build the main KRF module and load it
# cd ../module/codegen
# ruby codegen
# cd ..
# make
# kldload ./krf.ko
Build the userland utilities
# cd ../krfexec
# make
# cd ../krfctl
# make
Try it out with a test case... configure chdir and chmod to be faultable
# cd ../../examples
# clang -o rep_chdir rep_chdir.c
# ../src/krfctl/krfctl -F chdir,chown
# ../src/krfexec/krfexec <syscalloffaultable> ./rep_chdir
To clear the syscalls being intercepted:
# ../src/krfctl/krfctl -c
- Add a read-only sysctl node, under kern., that reports the syscall number of the faultable() call.
- Support more syscalls.
- Reduce memory usage by not copying entire sysent table.
- The sysent table replace is a bit unsafe