bpf: expose bpf_d_path helper to vfs_* and security_* functions
Subsystems (4)
PATCH v2 1/1 bpf: expose bpf_d_path helper to vfs_* and security_* functions
Add vfs_* and security_* to bpf_d_path allowlist, so that we can use bpf_d_path helper to extract full file path from these functions' struct path * and struct file * arguments. This will help tools like IOVisor's filetop[2]/filelife to get full file path.
Changes since v1: [1]
- Alexei and Yonghong suggested that bpf_d_path helper could also apply to vfs_* and security_file_* kernel functions. Added them.
[1] https://lore.kernel.org/bpf/[email protected]/
[2] https://github.com/iovisor/bcc/issues/3527
--- kernel/trace/bpf_trace.c | 50 ++++++++++++++++++++++++++++++++++++++-- 1 file changed, 48 insertions(+), 2 deletions(-)
kernel/trace/bpf_trace.c +48 -2
@@ -850,16 +850,62 @@ BPF_CALL_3(bpf_d_path, struct path *, path, char *, buf, u32, sz) BTF_SET_START(btf_allowlist_d_path)#ifdef CONFIG_SECURITY BTF_ID(func, security_file_permission) -BTF_ID(func, security_inode_getattr) BTF_ID(func, security_file_open) +BTF_ID(func, security_file_ioctl) +BTF_ID(func, security_file_free) +BTF_ID(func, security_file_alloc) +BTF_ID(func, security_file_lock) +BTF_ID(func, security_file_fcntl) +BTF_ID(func, security_file_set_fowner) +BTF_ID(func, security_file_receive) +BTF_ID(func, security_inode_getattr)#endif #ifdef CONFIG_SECURITY_PATH BTF_ID(func, security_path_truncate) +BTF_ID(func, security_path_notify) +BTF_ID(func, security_path_unlink) +BTF_ID(func, security_path_mkdir) +BTF_ID(func, security_path_rmdir) +BTF_ID(func, security_path_mknod) +BTF_ID(func, security_path_symlink) +BTF_ID(func, security_path_link) +BTF_ID(func, security_path_rename) +BTF_ID(func, security_path_chmod) +BTF_ID(func, security_path_chown) +BTF_ID(func, security_path_chroot)#endif BTF_ID(func, vfs_truncate) BTF_ID(func, vfs_fallocate) -BTF_ID(func, dentry_open) BTF_ID(func, vfs_getattr) +BTF_ID(func, vfs_fadvise) +BTF_ID(func, vfs_fchmod) +BTF_ID(func, vfs_fchown) +BTF_ID(func, vfs_open) +BTF_ID(func, vfs_setpos) +BTF_ID(func, vfs_llseek) +BTF_ID(func, vfs_read) +BTF_ID(func, vfs_write) +BTF_ID(func, vfs_iocb_iter_read) +BTF_ID(func, vfs_iter_read) +BTF_ID(func, vfs_readv) +BTF_ID(func, vfs_iocb_iter_write) +BTF_ID(func, vfs_iter_write) +BTF_ID(func, vfs_writev) +BTF_ID(func, vfs_copy_file_range) +BTF_ID(func, vfs_getattr_nosec) +BTF_ID(func, vfs_ioctl) +BTF_ID(func, vfs_fsync_range) +BTF_ID(func, vfs_fsync) +BTF_ID(func, vfs_utimes) +BTF_ID(func, vfs_statfs) +BTF_ID(func, vfs_dedupe_file_range_one) +BTF_ID(func, vfs_dedupe_file_range) +BTF_ID(func, vfs_clone_file_range) +BTF_ID(func, vfs_cancel_lock) +BTF_ID(func, vfs_test_lock) +BTF_ID(func, vfs_setlease) +BTF_ID(func, vfs_lock_file) +BTF_ID(func, dentry_open) BTF_ID(func, filp_close)BTF_SET_END (btf_allowlist_d_path)
Signature · 1 line
2.25.1
Quoted 77 lines · Hengqi Chen
Add vfs_* and security_* to
bpf_d_pathallowlist, so that we can usebpf_d_pathhelper to extract full file path from these functions'struct path *andstruct file *arguments. This will help tools like IOVisor's filetop[2]/filelife to get full file path.Changes since v1: [1]
- Alexei and Yonghong suggested thatbpf_d_pathhelper could also apply to vfs_* and security_file_* kernel functions. Added them.[1] https://lore.kernel.org/bpf/[email protected]/
[2] https://github.com/iovisor/bcc/issues/3527Signed-off-by Hengqi Chen <[email protected]>--- kernel/trace/bpf_trace.c | 50 ++++++++++++++++++++++++++++++++++++++-- 1 file changed, 48 insertions(+), 2 deletions(-)kernel/trace/bpf_trace.c +41
-2@@ -850,16 +850,62 @@ BPF_CALL_3(bpf_d_path, struct path *, path, char *, buf, u32, sz) BTF_SET_START(btf_allowlist_d_path)#ifdef CONFIG_SECURITY BTF_ID(func, security_file_permission) -BTF_ID(func, security_inode_getattr) BTF_ID(func, security_file_open) +BTF_ID(func, security_file_ioctl) +BTF_ID(func, security_file_free) +BTF_ID(func, security_file_alloc) +BTF_ID(func, security_file_lock) +BTF_ID(func, security_file_fcntl) +BTF_ID(func, security_file_set_fowner) +BTF_ID(func, security_file_receive) +BTF_ID(func, security_inode_getattr)#endif #ifdef CONFIG_SECURITY_PATH BTF_ID(func, security_path_truncate) +BTF_ID(func, security_path_notify) +BTF_ID(func, security_path_unlink) +BTF_ID(func, security_path_mkdir) +BTF_ID(func, security_path_rmdir) +BTF_ID(func, security_path_mknod) +BTF_ID(func, security_path_symlink) +BTF_ID(func, security_path_link) +BTF_ID(func, security_path_rename) +BTF_ID(func, security_path_chmod) +BTF_ID(func, security_path_chown) +BTF_ID(func, security_path_chroot)#endif BTF_ID(func, vfs_truncate) BTF_ID(func, vfs_fallocate) -BTF_ID(func, dentry_open) BTF_ID(func, vfs_getattr) +BTF_ID(func, vfs_fadvise) +BTF_ID(func, vfs_fchmod) +BTF_ID(func, vfs_fchown) +BTF_ID(func, vfs_open) +BTF_ID(func, vfs_setpos) +BTF_ID(func, vfs_llseek) +BTF_ID(func, vfs_read) +BTF_ID(func, vfs_write) +BTF_ID(func, vfs_iocb_iter_read) +BTF_ID(func, vfs_iter_read) +BTF_ID(func, vfs_readv) +BTF_ID(func, vfs_iocb_iter_write) +BTF_ID(func, vfs_iter_write) +BTF_ID(func, vfs_writev) +BTF_ID(func, vfs_copy_file_range) +BTF_ID(func, vfs_getattr_nosec) +BTF_ID(func, vfs_ioctl) +BTF_ID(func, vfs_fsync_range) +BTF_ID(func, vfs_fsync) +BTF_ID(func, vfs_utimes) +BTF_ID(func, vfs_statfs) +BTF_ID (func, vfs_dedupe_file_range_one)
kernel/trace/bpf_trace.c BPF_CALL_3(bpf_d_path, struct path *, path, char *, buf, u32, sz) · line 911
Quoted 10 lines
kernel/trace/bpf_trace.c +7
-0+BTF_ID(func, vfs_dedupe_file_range) +BTF_ID(func, vfs_clone_file_range) +BTF_ID(func, vfs_cancel_lock) +BTF_ID(func, vfs_test_lock) +BTF_ID(func, vfs_setlease) +BTF_ID(func, vfs_lock_file) +BTF_ID(func, dentry_open) BTF_ID(func, filp_close)BTF_SET_END (btf_allowlist_d_path)
Before we lend this expanded list of allowed functions, I think we should address an issue that comes up from time to time with .BTF_ids. Sometimes the referenced function can be changed from global to static and get inlined by the compiler, and thus disappears from BTF altogether. This will result in kernel build failure causing a lot of confusion, because the change might be done by people unfamiliar with the BTF_ID() stuff and not even aware of it.
This came up a few times before and it's frustrating for everyone involved. Before we proceed with extending the list further, let's teach resolve_btfids to warn on such missing function (so that we are at least aware) but otherwise ignore it (probably leaving ID as zero, but let's also confirm that all the users of BTF_ID() stuff handle those zeros correctly).
Quoted 3 lines
--
2.25.1
Quoted 89 lines · Andrii Nakryiko
Quoted 77 lines · Hengqi Chen
Add vfs_* and security_* to
bpf_d_pathallowlist, so that we can usebpf_d_pathhelper to extract full file path from these functions'struct path *andstruct file *arguments. This will help tools like IOVisor's filetop[2]/filelife to get full file path.Changes since v1: [1]
- Alexei and Yonghong suggested thatbpf_d_pathhelper could also apply to vfs_* and security_file_* kernel functions. Added them.[1] https://lore.kernel.org/bpf/[email protected]/
[2] https://github.com/iovisor/bcc/issues/3527Signed-off-by Hengqi Chen <[email protected]>--- kernel/trace/bpf_trace.c | 50 ++++++++++++++++++++++++++++++++++++++-- 1 file changed, 48 insertions(+), 2 deletions(-)kernel/trace/bpf_trace.c +41
-2@@ -850,16 +850,62 @@ BPF_CALL_3(bpf_d_path, struct path *, path, char *, buf, u32, sz) BTF_SET_START(btf_allowlist_d_path)#ifdef CONFIG_SECURITY BTF_ID(func, security_file_permission) -BTF_ID(func, security_inode_getattr) BTF_ID(func, security_file_open) +BTF_ID(func, security_file_ioctl) +BTF_ID(func, security_file_free) +BTF_ID(func, security_file_alloc) +BTF_ID(func, security_file_lock) +BTF_ID(func, security_file_fcntl) +BTF_ID(func, security_file_set_fowner) +BTF_ID(func, security_file_receive) +BTF_ID(func, security_inode_getattr)#endif #ifdef CONFIG_SECURITY_PATH BTF_ID(func, security_path_truncate) +BTF_ID(func, security_path_notify) +BTF_ID(func, security_path_unlink) +BTF_ID(func, security_path_mkdir) +BTF_ID(func, security_path_rmdir) +BTF_ID(func, security_path_mknod) +BTF_ID(func, security_path_symlink) +BTF_ID(func, security_path_link) +BTF_ID(func, security_path_rename) +BTF_ID(func, security_path_chmod) +BTF_ID(func, security_path_chown) +BTF_ID(func, security_path_chroot)#endif BTF_ID(func, vfs_truncate) BTF_ID(func, vfs_fallocate) -BTF_ID(func, dentry_open) BTF_ID(func, vfs_getattr) +BTF_ID(func, vfs_fadvise) +BTF_ID(func, vfs_fchmod) +BTF_ID(func, vfs_fchown) +BTF_ID(func, vfs_open) +BTF_ID(func, vfs_setpos) +BTF_ID(func, vfs_llseek) +BTF_ID(func, vfs_read) +BTF_ID(func, vfs_write) +BTF_ID(func, vfs_iocb_iter_read) +BTF_ID(func, vfs_iter_read) +BTF_ID(func, vfs_readv) +BTF_ID(func, vfs_iocb_iter_write) +BTF_ID(func, vfs_iter_write) +BTF_ID(func, vfs_writev) +BTF_ID(func, vfs_copy_file_range) +BTF_ID(func, vfs_getattr_nosec) +BTF_ID(func, vfs_ioctl) +BTF_ID(func, vfs_fsync_range) +BTF_ID(func, vfs_fsync) +BTF_ID(func, vfs_utimes) +BTF_ID(func, vfs_statfs) +BTF_ID (func, vfs_dedupe_file_range_one)kernel/trace/bpf_trace.c BPF_CALL_3(bpf_d_path, struct path *, path, char *, buf, u32, sz) · line 911
Quoted 10 lines
kernel/trace/bpf_trace.c +7
-0+BTF_ID(func, vfs_dedupe_file_range) +BTF_ID(func, vfs_clone_file_range) +BTF_ID(func, vfs_cancel_lock) +BTF_ID(func, vfs_test_lock) +BTF_ID(func, vfs_setlease) +BTF_ID(func, vfs_lock_file) +BTF_ID(func, dentry_open) BTF_ID(func, filp_close)BTF_SET_END (btf_allowlist_d_path)
Quoted 8 lines
Before we lend this expanded list of allowed functions, I think we should address an issue that comes up from time to time with .BTF_ids. Sometimes the referenced function can be changed from global to static and get inlined by the compiler, and thus disappears from BTF altogether. This will result in kernel build failure causing a lot of confusion, because the change might be done by people unfamiliar with the
BTF_ID()stuff and not even aware of it.
Thanks for the detailed background.
I was able to reproduce this kernel build failure.
Quoted 7 lines
This came up a few times before and it's frustrating for everyone involved. Before we proceed with extending the list further, let's teach
resolve_btfidsto warn on such missing function (so that we are at least aware) but otherwise ignore it (probably leaving ID as zero, but let's also confirm that all the users ofBTF_ID()stuff handle those zeros correctly).
Do you mean that resolve_btfids should be updated to emit warning messages instead of aborting the build process ?
Quoted 3 lines
Quoted 3 lines
--
2.25.1
Quoted 113 lines · Hengqi Chen
Quoted 89 lines · Andrii Nakryiko
Quoted 77 lines · Hengqi Chen
Add vfs_* and security_* to
bpf_d_pathallowlist, so that we can usebpf_d_pathhelper to extract full file path from these functions'struct path *andstruct file *arguments. This will help tools like IOVisor's filetop[2]/filelife to get full file path.Changes since v1: [1]
- Alexei and Yonghong suggested thatbpf_d_pathhelper could also apply to vfs_* and security_file_* kernel functions. Added them.[1] https://lore.kernel.org/bpf/[email protected]/
[2] https://github.com/iovisor/bcc/issues/3527Signed-off-by Hengqi Chen <[email protected]>--- kernel/trace/bpf_trace.c | 50 ++++++++++++++++++++++++++++++++++++++-- 1 file changed, 48 insertions(+), 2 deletions(-)kernel/trace/bpf_trace.c +41
-2@@ -850,16 +850,62 @@ BPF_CALL_3(bpf_d_path, struct path *, path, char *, buf, u32, sz) BTF_SET_START(btf_allowlist_d_path)#ifdef CONFIG_SECURITY BTF_ID(func, security_file_permission) -BTF_ID(func, security_inode_getattr) BTF_ID(func, security_file_open) +BTF_ID(func, security_file_ioctl) +BTF_ID(func, security_file_free) +BTF_ID(func, security_file_alloc) +BTF_ID(func, security_file_lock) +BTF_ID(func, security_file_fcntl) +BTF_ID(func, security_file_set_fowner) +BTF_ID(func, security_file_receive) +BTF_ID(func, security_inode_getattr)#endif #ifdef CONFIG_SECURITY_PATH BTF_ID(func, security_path_truncate) +BTF_ID(func, security_path_notify) +BTF_ID(func, security_path_unlink) +BTF_ID(func, security_path_mkdir) +BTF_ID(func, security_path_rmdir) +BTF_ID(func, security_path_mknod) +BTF_ID(func, security_path_symlink) +BTF_ID(func, security_path_link) +BTF_ID(func, security_path_rename) +BTF_ID(func, security_path_chmod) +BTF_ID(func, security_path_chown) +BTF_ID(func, security_path_chroot)#endif BTF_ID(func, vfs_truncate) BTF_ID(func, vfs_fallocate) -BTF_ID(func, dentry_open) BTF_ID(func, vfs_getattr) +BTF_ID(func, vfs_fadvise) +BTF_ID(func, vfs_fchmod) +BTF_ID(func, vfs_fchown) +BTF_ID(func, vfs_open) +BTF_ID(func, vfs_setpos) +BTF_ID(func, vfs_llseek) +BTF_ID(func, vfs_read) +BTF_ID(func, vfs_write) +BTF_ID(func, vfs_iocb_iter_read) +BTF_ID(func, vfs_iter_read) +BTF_ID(func, vfs_readv) +BTF_ID(func, vfs_iocb_iter_write) +BTF_ID(func, vfs_iter_write) +BTF_ID(func, vfs_writev) +BTF_ID(func, vfs_copy_file_range) +BTF_ID(func, vfs_getattr_nosec) +BTF_ID(func, vfs_ioctl) +BTF_ID(func, vfs_fsync_range) +BTF_ID(func, vfs_fsync) +BTF_ID(func, vfs_utimes) +BTF_ID(func, vfs_statfs) +BTF_ID (func, vfs_dedupe_file_range_one)kernel/trace/bpf_trace.c BPF_CALL_3(bpf_d_path, struct path *, path, char *, buf, u32, sz) · line 911
Quoted 10 lines
kernel/trace/bpf_trace.c +7
-0+BTF_ID(func, vfs_dedupe_file_range) +BTF_ID(func, vfs_clone_file_range) +BTF_ID(func, vfs_cancel_lock) +BTF_ID(func, vfs_test_lock) +BTF_ID(func, vfs_setlease) +BTF_ID(func, vfs_lock_file) +BTF_ID(func, dentry_open) BTF_ID(func, filp_close)BTF_SET_END (btf_allowlist_d_path)Quoted 8 lines
Before we lend this expanded list of allowed functions, I think we should address an issue that comes up from time to time with .BTF_ids. Sometimes the referenced function can be changed from global to static and get inlined by the compiler, and thus disappears from BTF altogether. This will result in kernel build failure causing a lot of confusion, because the change might be done by people unfamiliar with the
BTF_ID()stuff and not even aware of it.Thanks for the detailed background.
I was able to reproduce this kernel build failure.Quoted 7 lines
This came up a few times before and it's frustrating for everyone involved. Before we proceed with extending the list further, let's teach
resolve_btfidsto warn on such missing function (so that we are at least aware) but otherwise ignore it (probably leaving ID as zero, but let's also confirm that all the users ofBTF_ID()stuff handle those zeros correctly).
Quoted 2 lines
Do you mean that
resolve_btfidsshould be updated to emit warning messages instead of aborting the build process ?
Yes. Just double-check that unresolved BTF IDs are filled out as zeros and don't break anything.
Quoted 4 lines
Quoted 4 lines
Quoted 4 lines
--
2.25.1
בתאריך יום ב׳, 19 ביולי 2021 ב-18:43 מאת Hengqi Chen <[email protected]>:
Quoted 88 lines
Add vfs_* and security_* to
bpf_d_pathallowlist, so that we can usebpf_d_pathhelper to extract full file path from these functions'struct path *andstruct file *arguments. This will help tools like IOVisor's filetop[2]/filelife to get full file path.Changes since v1: [1]
- Alexei and Yonghong suggested thatbpf_d_pathhelper could also apply to vfs_* and security_file_* kernel functions. Added them.[1] https://lore.kernel.org/bpf/[email protected]/
[2] https://github.com/iovisor/bcc/issues/3527Signed-off-by Hengqi Chen <[email protected]>--- kernel/trace/bpf_trace.c | 50 ++++++++++++++++++++++++++++++++++++++-- 1 file changed, 48 insertions(+), 2 deletions(-)kernel/trace/bpf_trace.c +48
-3@@ -850,16 +850,62 @@ BPF_CALL_3(bpf_d_path, struct path *, path, char *, buf, u32, sz) BTF_SET_START(btf_allowlist_d_path)#ifdef CONFIG_SECURITY BTF_ID(func, security_file_permission) -BTF_ID(func, security_inode_getattr) BTF_ID(func, security_file_open) +BTF_ID(func, security_file_ioctl) +BTF_ID(func, security_file_free) +BTF_ID(func, security_file_alloc) +BTF_ID(func, security_file_lock) +BTF_ID(func, security_file_fcntl) +BTF_ID(func, security_file_set_fowner) +BTF_ID(func, security_file_receive) +BTF_ID(func, security_inode_getattr)#endif #ifdef CONFIG_SECURITY_PATH BTF_ID(func, security_path_truncate) +BTF_ID(func, security_path_notify) +BTF_ID(func, security_path_unlink) +BTF_ID(func, security_path_mkdir) +BTF_ID(func, security_path_rmdir) +BTF_ID(func, security_path_mknod) +BTF_ID(func, security_path_symlink) +BTF_ID(func, security_path_link) +BTF_ID(func, security_path_rename) +BTF_ID(func, security_path_chmod) +BTF_ID(func, security_path_chown) +BTF_ID(func, security_path_chroot)#endif BTF_ID(func, vfs_truncate) BTF_ID(func, vfs_fallocate) -BTF_ID(func, dentry_open) BTF_ID(func, vfs_getattr) +BTF_ID(func, vfs_fadvise) +BTF_ID(func, vfs_fchmod) +BTF_ID(func, vfs_fchown) +BTF_ID(func, vfs_open) +BTF_ID(func, vfs_setpos) +BTF_ID(func, vfs_llseek) +BTF_ID(func, vfs_read) +BTF_ID(func, vfs_write) +BTF_ID(func, vfs_iocb_iter_read) +BTF_ID(func, vfs_iter_read) +BTF_ID(func, vfs_readv) +BTF_ID(func, vfs_iocb_iter_write) +BTF_ID(func, vfs_iter_write) +BTF_ID(func, vfs_writev) +BTF_ID(func, vfs_copy_file_range) +BTF_ID(func, vfs_getattr_nosec) +BTF_ID(func, vfs_ioctl) +BTF_ID(func, vfs_fsync_range) +BTF_ID(func, vfs_fsync) +BTF_ID(func, vfs_utimes) +BTF_ID(func, vfs_statfs) +BTF_ID(func, vfs_dedupe_file_range_one) +BTF_ID(func, vfs_dedupe_file_range) +BTF_ID(func, vfs_clone_file_range) +BTF_ID(func, vfs_cancel_lock) +BTF_ID(func, vfs_test_lock) +BTF_ID(func, vfs_setlease) +BTF_ID(func, vfs_lock_file) +BTF_ID(func, dentry_open) BTF_ID(func, filp_close)BTF_SET_END (btf_allowlist_d_path) --
Quoted 2 lines
2.25.1
Thanks for opening this PR!
I was looking for a way to do that in a tool I develop (Tracee), and had to implement this functionality by myself:
https://github.com/aquasecurity/tracee/blob/main/tracee-ebpf/tracee/tracee.bpf.c#L1494
Maybe It's too much to ask, but I wonder if it will be possible to add other functions to this allowlist.
Currently, other than vfs_write(v), and security_file_open, we also need it for security_sb_mount and security_bprm_check.
For security_bprm_check() we extract the path from bprm->file->f_path. Actually, any securty_* function that has a struct argument from which it is possible to reach a path struct is a possible candidate for us. In addition to this, we also use it for the sched_process_exec tracepoint, but I'm not sure if adding a tracepoint is related here, as it is not exactly a function.
Yaniv