Add bpf_get_dentry_xattr
Song Liu
maintainerv4 cover Add bpf_get_dentry_xattr
Add a kfunc to read xattr from dentry. Also add selftest for the new kfunc.
Changes v3 => v4:
1. Fix selftest build.
V3: https://lore.kernel.org/bpf/[email protected]/T/#u
Changes v2 => v3:
1. Move the kfuncs to fs/bpf_fs_kfuncs.c.
2. Fix selftests build error on s390. (Alexei)
v2: https://lore.kernel.org/bpf/[email protected]/T/#u
Changes v1 => v2:
1. Remove 3 kfuncs that are ready yet.
v1: https://lore.kernel.org/linux-fsdevel/[email protected]/T/#u
Song Liu (3):
bpf: Move bpf_get_file_xattr to fs/bpf_fs_kfuncs.c
bpf: Add kfunc bpf_get_dentry_xattr() to read xattr from dentry selftests/bpf: Add tests for bpf_get_dentry_xattr
fs/bpf_fs_kfuncs.c | 62 +++++++++++++++++ kernel/trace/bpf_trace.c | 68 ------------------- tools/testing/selftests/bpf/bpf_kfuncs.h | 9 +++ .../selftests/bpf/prog_tests/fs_kfuncs.c | 9 ++- .../selftests/bpf/progs/test_get_xattr.c | 37 ++++++++-- 5 files changed, 111 insertions(+), 74 deletions(-)
--
2.43.5
Song Liu
maintainerPATCH v4 1/3 bpf: Move bpf_get_file_xattr to fs/bpf_fs_kfuncs.c
We are putting all fs kfuncs in fs/bpf_fs_kfuncs.c. Move existing bpf_get_file_xattr to it.
--- fs/bpf_fs_kfuncs.c | 38 ++++++++++++++++++++++ kernel/trace/bpf_trace.c | 68 ---------------------------------------- 2 files changed, 38 insertions(+), 68 deletions(-)
fs/bpf_fs_kfuncs.c +38 -0
@@ -8,6 +8,7 @@#include <linux/fs.h> #include <linux/file.h> #include <linux/mm.h> +#include <linux/xattr.h> __bpf_kfunc_start_defs ();
@@ -92,6 +93,42 @@ __bpf_kfunc int bpf_path_d_path(struct path *path, char *buf, size_t buf__sz)return len; } +/** +* bpf_get_file_xattr - get xattr of a file +* @file: file to get xattr from +* @name__str: name of the xattr +* @value_p: output buffer of the xattr value +* +* Get xattr *name__str* of *file* and store the output in *value_ptr*. +* +* For security reasons, only *name__str* with prefix "user." is allowed. +* +* Return: 0 on success, a negative value on error. +*/ +__bpf_kfunc int bpf_get_file_xattr(struct file *file, const char *name__str, +struct bpf_dynptr *value_p) +{ +struct bpf_dynptr_kern *value_ptr = (struct bpf_dynptr_kern *)value_p; +struct dentry *dentry; +u32 value_len; +void *value; +int ret; + +if (strncmp (name__str,XATTR_USER_PREFIX ,XATTR_USER_PREFIX_LEN )) +return -EPERM ; + + value_len =__bpf_dynptr_size (value_ptr); + value =__bpf_dynptr_data_rw (value_ptr, value_len); +if (!value) +return -EINVAL ; + + dentry =file_dentry (file); + ret =inode_permission (&nop_mnt_idmap, dentry->d_inode,MAY_READ ); +if (ret) +return ret; +return __vfs_getxattr (dentry, dentry->d_inode, name__str, value, value_len); +} +__bpf_kfunc_end_defs ();BTF_KFUNCS_START (bpf_fs_kfunc_set_ids)
@@ -99,6 +136,7 @@ BTF_ID_FLAGS(func, bpf_get_task_exe_file, KF_ACQUIRE | KF_TRUSTED_ARGS | KF_RET_NULL) BTF_ID_FLAGS(func, bpf_put_file, KF_RELEASE) BTF_ID_FLAGS(func, bpf_path_d_path, KF_TRUSTED_ARGS) +BTF_ID_FLAGS(func, bpf_get_file_xattr, KF_SLEEPABLE | KF_TRUSTED_ARGS)BTF_KFUNCS_END (bpf_fs_kfunc_set_ids) static int bpf_fs_kfuncs_filter(const struct bpf_prog *prog, u32 kfunc_id)
kernel/trace/bpf_trace.c +0 -68
80 lines not on this page · raw message
Signature · 1 line
2.43.5
Song Liu
maintainerPATCH v4 2/3 bpf: Add kfunc bpf_get_dentry_xattr() to read xattr from dentry
In reply to Song LiuThis kfunc can be used in LSM hooks with dentry, such as:
security_inode_listxattr
security_inode_permission
and many more.
--- fs/bpf_fs_kfuncs.c | 42 +++++++++++++++++++++++++++++++++--------- 1 file changed, 33 insertions(+), 9 deletions(-)
fs/bpf_fs_kfuncs.c +33 -9
@@ -94,26 +94,29 @@ __bpf_kfunc int bpf_path_d_path(struct path *path, char *buf, size_t buf__sz) }/** -* bpf_get_file_xattr - get xattr of a file -* @file: file to get xattr from +* bpf_get_dentry_xattr - get xattr of a dentry +* @dentry: dentry to get xattr from * @name__str: name of the xattr * @value_p: output buffer of the xattr value * -* Get xattr *name__str* of *file* and store the output in *value_ptr*. +* Get xattr *name__str* of *dentry* and store the output in *value_ptr*. * * For security reasons, only *name__str* with prefix "user." is allowed. * * Return: 0 on success, a negative value on error. */ -__bpf_kfunc int bpf_get_file_xattr(struct file *file, const char *name__str, -struct bpf_dynptr *value_p) +__bpf_kfunc int bpf_get_dentry_xattr(struct dentry *dentry, const char *name__str, +struct bpf_dynptr *value_p) {struct bpf_dynptr_kern *value_ptr = (struct bpf_dynptr_kern *)value_p; -struct dentry *dentry; +struct inode *inode =d_inode (dentry);u32 value_len;void *value;int ret; +if (WARN_ON (!inode)) +return -EINVAL ; +if (strncmp (name__str,XATTR_USER_PREFIX ,XATTR_USER_PREFIX_LEN ))return -EPERM ;
@@ -122,11 +125,31 @@ __bpf_kfunc int bpf_get_file_xattr(struct file *file, const char *name__str,if (!value)return -EINVAL ; - dentry =file_dentry (file); - ret =inode_permission (&nop_mnt_idmap, dentry->d_inode,MAY_READ ); + ret =inode_permission (&nop_mnt_idmap, inode,MAY_READ );if (ret)return ret; -return __vfs_getxattr (dentry, dentry->d_inode, name__str, value, value_len); +return __vfs_getxattr (dentry, inode, name__str, value, value_len); +} + +/** +* bpf_get_file_xattr - get xattr of a file +* @file: file to get xattr from +* @name__str: name of the xattr +* @value_p: output buffer of the xattr value +* +* Get xattr *name__str* of *file* and store the output in *value_ptr*. +* +* For security reasons, only *name__str* with prefix "user." is allowed. +* +* Return: 0 on success, a negative value on error. +*/ +__bpf_kfunc int bpf_get_file_xattr(struct file *file, const char *name__str, +struct bpf_dynptr *value_p) +{ +struct dentry *dentry; + + dentry =file_dentry (file); +return bpf_get_dentry_xattr (dentry, name__str, value_p); }__bpf_kfunc_end_defs ();
@@ -136,6 +159,7 @@ BTF_ID_FLAGS(func, bpf_get_task_exe_file, KF_ACQUIRE | KF_TRUSTED_ARGS | KF_RET_NULL) BTF_ID_FLAGS(func, bpf_put_file, KF_RELEASE) BTF_ID_FLAGS(func, bpf_path_d_path, KF_TRUSTED_ARGS) +BTF_ID_FLAGS(func, bpf_get_dentry_xattr, KF_SLEEPABLE | KF_TRUSTED_ARGS) BTF_ID_FLAGS(func, bpf_get_file_xattr, KF_SLEEPABLE | KF_TRUSTED_ARGS)BTF_KFUNCS_END (bpf_fs_kfunc_set_ids)
Signature · 1 line
2.43.5
Song Liu
maintainerPATCH v4 3/3 selftests/bpf: Add tests for bpf_get_dentry_xattr
In reply to Song LiuAdd test for bpf_get_dentry_xattr on hook security_inode_getxattr. Verify that the kfunc can read the xattr. Also test failing getxattr from user space by returning non-zero from the LSM bpf program.
--- tools/testing/selftests/bpf/bpf_kfuncs.h | 9 +++++ .../selftests/bpf/prog_tests/fs_kfuncs.c | 9 ++++- .../selftests/bpf/progs/test_get_xattr.c | 37 ++++++++++++++++--- 3 files changed, 49 insertions(+), 6 deletions(-)
tools/testing/selftests/bpf/bpf_kfuncs.h +9 -0
@@ -78,4 +78,13 @@ extern int bpf_verify_pkcs7_signature(struct bpf_dynptr *data_ptr, extern bool bpf_session_is_return(void) __ksym __weak;extern __u64 *bpf_session_cookie (void ) __ksym__weak ; + +struct dentry ; +/* Description +* Returns xattr of a dentry +* Returns__bpf_kfunc +* Error code +*/ +extern int bpf_get_dentry_xattr(struct dentry *dentry, const char *name, + struct bpf_dynptr *value_ptr) __ksym __weak;#endif
tools/testing/selftests/bpf/prog_tests/fs_kfuncs.c +8 -1
@@ -16,6 +16,7 @@ static void test_xattr(void) {struct test_get_xattr *skel =NULL ;int fd =-1 , err; +int v[32 ]; fd =open (testfile,O_CREAT |O_RDONLY ,0644 );if (!ASSERT_GE (fd,0 ,"create_file" ))
@@ -50,7 +51,13 @@ static void test_xattr(void)if (!ASSERT_GE (fd,0 ,"open_file" )) goto out; -ASSERT_EQ (skel->bss->found_xattr,1 ,"found_xattr" ); +ASSERT_EQ (skel->bss->found_xattr_from_file,1 ,"found_xattr_from_file" ); + +/* Trigger security_inode_getxattr */ + err =getxattr (testfile,"user.kfuncs" , v,sizeof (v)); +ASSERT_EQ (err,-1 ,"getxattr_return" ); +ASSERT_EQ (errno,EINVAL ,"getxattr_errno" ); +ASSERT_EQ (skel->bss->found_xattr_from_dentry,1 ,"found_xattr_from_dentry" ); out:close (fd);
tools/testing/selftests/bpf/progs/test_get_xattr.c +32 -5
@@ -2,6 +2,7 @@/* Copyright (c) 2023 Meta Platforms, Inc. and affiliates. */ #include "vmlinux.h" +#include <errno.h> #include <bpf/bpf_helpers.h> #include <bpf/bpf_tracing.h> #include "bpf_kfuncs.h"
@@ -9,10 +10,12 @@ char _license[] SEC("license") = "GPL";__u32 monitored_pid; -__u32 found_xattr; +__u32 found_xattr_from_file; +__u32 found_xattr_from_dentry;static const char expected_value[] ="hello" ; -char value[32 ]; +char value1[32 ]; +char value2[32 ]; SEC("lsm.s/file_open")int BPF_PROG (test_file_open ,struct file *f)
@@ -25,13 +28,37 @@ int BPF_PROG(test_file_open, struct file *f)if (pid != monitored_pid)return 0 ; -bpf_dynptr_from_mem (value,sizeof (value),0 , &value_ptr); +bpf_dynptr_from_mem (value1,sizeof (value1),0 , &value_ptr); ret =bpf_get_file_xattr (f,"user.kfuncs" , &value_ptr);if (ret !=sizeof (expected_value))return 0 ; -if (bpf_strncmp (value, ret, expected_value)) +if (bpf_strncmp (value1, ret, expected_value))return 0 ; - found_xattr =1 ; + found_xattr_from_file =1 ;return 0 ; } + +SEC("lsm.s/inode_getxattr") +int BPF_PROG (test_inode_getxattr ,struct dentry *dentry,char *name) +{ +struct bpf_dynptr value_ptr; +__u32 pid; +int ret; + + pid =bpf_get_current_pid_tgid () >>32 ; +if (pid != monitored_pid) +return 0 ; + +bpf_dynptr_from_mem (value2,sizeof (value2),0 , &value_ptr); + + ret =bpf_get_dentry_xattr (dentry,"user.kfuncs" , &value_ptr); +if (ret !=sizeof (expected_value)) +return 0 ; +if (bpf_strncmp (value2, ret, expected_value)) +return 0 ; + found_xattr_from_dentry =1 ; + +/* return non-zero to fail getxattr from user space */ +return -EINVAL ; +}
Signature · 1 line
2.43.5
Re: [PATCH v4 bpf-next 3/3] selftests/bpf: Add tests for bpf_get_dentry_xattr
Quoted 17 lines · Song Liu
Add test for
bpf_get_dentry_xattron hooksecurity_inode_getxattr. Verify that the kfunc can read the xattr. Also test failing getxattr from user space by returning non-zero from the LSM bpf program.Signed-off-by Song Liu <[email protected]>--- tools/testing/selftests/bpf/bpf_kfuncs.h | 9 +++++ .../selftests/bpf/prog_tests/fs_kfuncs.c | 9 ++++- .../selftests/bpf/progs/test_get_xattr.c | 37 ++++++++++++++++--- 3 files changed, 49 insertions(+), 6 deletions(-)tools/testing/selftests/bpf/bpf_kfuncs.h +0
-0
tools/testing/selftests/bpf/bpf_kfuncs.h extern int bpf_verify_pkcs7_signature(struct bpf_dynptr *data_ptr, · line 85
Quoted 8 lines
tools/testing/selftests/bpf/bpf_kfuncs.h +5
-0@@ -78,4 +78,13 @@ extern int bpf_verify_pkcs7_signature(struct bpf_dynptr *data_ptr, extern bool bpf_session_is_return(void) __ksym __weak;extern __u64 *bpf_session_cookie (void ) __ksym__weak ; + +struct dentry ; +/* Description +* Returns xattr of a dentry +* Returns__bpf_kfunc
nit, extra '__bpf_kfunc' suffix?
jirka
Quoted 104 lines
tools/testing/selftests/bpf/bpf_kfuncs.h +4
-0+* Error code +*/ +extern int bpf_get_dentry_xattr(struct dentry *dentry, const char *name, + struct bpf_dynptr *value_ptr) __ksym __weak;#endif tools/testing/selftests/bpf/prog_tests/fs_kfuncs.c +8
-1@@ -16,6 +16,7 @@ static void test_xattr(void) {struct test_get_xattr *skel =NULL ;int fd =-1 , err; +int v[32 ]; fd =open (testfile,O_CREAT |O_RDONLY ,0644 );if (!ASSERT_GE (fd,0 ,"create_file" ))@@ -50,7 +51,13 @@ static void test_xattr(void)if (!ASSERT_GE (fd,0 ,"open_file" )) goto out; -ASSERT_EQ (skel->bss->found_xattr,1 ,"found_xattr" ); +ASSERT_EQ (skel->bss->found_xattr_from_file,1 ,"found_xattr_from_file" ); + +/* Trigger security_inode_getxattr */ + err =getxattr (testfile,"user.kfuncs" , v,sizeof (v)); +ASSERT_EQ (err,-1 ,"getxattr_return" ); +ASSERT_EQ (errno,EINVAL ,"getxattr_errno" ); +ASSERT_EQ (skel->bss->found_xattr_from_dentry,1 ,"found_xattr_from_dentry" ); out:close (fd);tools/testing/selftests/bpf/progs/test_get_xattr.c +32
-5@@ -2,6 +2,7 @@/* Copyright (c) 2023 Meta Platforms, Inc. and affiliates. */ #include "vmlinux.h" +#include <errno.h> #include <bpf/bpf_helpers.h> #include <bpf/bpf_tracing.h> #include "bpf_kfuncs.h" @@ -9,10 +10,12 @@ char _license[] SEC("license") = "GPL";__u32 monitored_pid; -__u32 found_xattr; +__u32 found_xattr_from_file; +__u32 found_xattr_from_dentry;static const char expected_value[] ="hello" ; -char value[32 ]; +char value1[32 ]; +char value2[32 ]; SEC("lsm.s/file_open")int BPF_PROG (test_file_open ,struct file *f)@@ -25,13 +28,37 @@ int BPF_PROG(test_file_open, struct file *f)if (pid != monitored_pid)return 0 ; -bpf_dynptr_from_mem (value,sizeof (value),0 , &value_ptr); +bpf_dynptr_from_mem (value1,sizeof (value1),0 , &value_ptr); ret =bpf_get_file_xattr (f,"user.kfuncs" , &value_ptr);if (ret !=sizeof (expected_value))return 0 ; -if (bpf_strncmp (value, ret, expected_value)) +if (bpf_strncmp (value1, ret, expected_value))return 0 ; - found_xattr =1 ; + found_xattr_from_file =1 ;return 0 ; } + +SEC("lsm.s/inode_getxattr") +int BPF_PROG (test_inode_getxattr ,struct dentry *dentry,char *name) +{ +struct bpf_dynptr value_ptr; +__u32 pid; +int ret; + + pid =bpf_get_current_pid_tgid () >>32 ; +if (pid != monitored_pid) +return 0 ; + +bpf_dynptr_from_mem (value2,sizeof (value2),0 , &value_ptr); + + ret =bpf_get_dentry_xattr (dentry,"user.kfuncs" , &value_ptr); +if (ret !=sizeof (expected_value)) +return 0 ; +if (bpf_strncmp (value2, ret, expected_value)) +return 0 ; + found_xattr_from_dentry =1 ; + +/* return non-zero to fail getxattr from user space */ +return -EINVAL ; +}Signature · 1 line
2.43.5
Song Liu
maintainerRe: [PATCH v4 bpf-next 3/3] selftests/bpf: Add tests for bpf_get_dentry_xattr
Quoted 20 lines · Jiri Olsa
Quoted 18 lines · Song Liu
Add test for
bpf_get_dentry_xattron hooksecurity_inode_getxattr. Verify that the kfunc can read the xattr. Also test failing getxattr from user space by returning non-zero from the LSM bpf program.Signed-off-by Song Liu <[email protected]>--- tools/testing/selftests/bpf/bpf_kfuncs.h | 9 +++++ .../selftests/bpf/prog_tests/fs_kfuncs.c | 9 ++++- .../selftests/bpf/progs/test_get_xattr.c | 37 ++++++++++++++++--- 3 files changed, 49 insertions(+), 6 deletions(-)tools/testing/selftests/bpf/bpf_kfuncs.h +0
-0@@ -78,4 +78,13 @@ extern int bpf_verify_pkcs7_signature(struct bpf_dynptr *data_ptr,
Quoted 9 lines
tools/testing/selftests/bpf/bpf_kfuncs.h extern int bpf_verify_pkcs7_signature(struct bpf_dynptr *data_ptr, · line 85
Quoted 7 lines
tools/testing/selftests/bpf/bpf_kfuncs.h +5
-0extern bool bpf_session_is_return(void) __ksym __weak;extern __u64 *bpf_session_cookie (void ) __ksym__weak ; + +struct dentry ; +/* Description +* Returns xattr of a dentry +* Returns__bpf_kfunc nit, extra '
__bpf_kfunc' suffix?
Good catch.. I somehow got it from bpf_sock_addr_set_sun_path.
Please let me if we need to respin for this change.
Thanks,
Song
Quoted 1 line
jirka
[...]
Re: [PATCH v4 bpf-next 3/3] selftests/bpf: Add tests for bpf_get_dentry_xattr
Quoted 9 lines · Song Liu
Quoted 7 lines
+struct dentry;
Quoted 3 lines
+/* Description
+ * Returns xattr of a dentry
+ *Returns__bpf_kfuncnit, extra '
__bpf_kfunc' suffix?Good catch.. I somehow got it from
bpf_sock_addr_set_sun_path.
Fixed up both while applying.
This series was applied to bpf/bpf-next.git (master) by Alexei Starovoitov <[email protected]>:
Hello:
This series was applied to bpf/bpf-next.git (master) by Alexei Starovoitov <[email protected]>:
Quoted 9 lines · On Tue, 6 Aug 2024 16:09:01 -0700 you wrote:
Add a kfunc to read xattr from dentry. Also add selftest for the new kfunc.
Changes v3 => v4:
1. Fix selftest build.V3: https://lore.kernel.org/bpf/[email protected]/T/#u
[...]
Here is the summary with links:
- [v4,bpf-next,1/3] bpf: Move bpf_get_file_xattr to fs/bpf_fs_kfuncs.c
https://git.kernel.org/bpf/bpf-next/c/fa4e5afa9758 - [v4,bpf-next,2/3] bpf: Add kfunc bpf_get_dentry_xattr() to read xattr from dentry https://git.kernel.org/bpf/bpf-next/c/ac13a4261afe - [v4,bpf-next,3/3] selftests/bpf: Add tests for bpf_get_dentry_xattr https://git.kernel.org/bpf/bpf-next/c/8681156c0939
You are awesome, thank you!
Signature · 2 lines
Deet-doot-dot, I am a bot. https://korg.docs.kernel.org/patchwork/pwbot.html