Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20;
Message-ID: <2337a1af-5f8b-602e-f989-351a371387a1@loongson.cn>
Date:   Tue, 8 Nov 2022 21:02:15 +0800
MIME-Version: 1.0
User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:102.0) Gecko/20100101
 Thunderbird/102.2.2
Subject: Re: [PATCH v4] docs/zh_CN: Add userspace-api/seccomp_filter Chinese
 translation
Content-Language: en-US
To:     Rui Li <me@lirui.org>, Wu XiangCheng <wu.xiangcheng@linux.dev>,
        Alex Shi <alexs@kernel.org>
Cc:     Jonathan Corbet <corbet@lwn.net>, linux-doc@vger.kernel.org,
        linux-kernel@vger.kernel.org
References: <20221108112921.312071-1-me@lirui.org>
From:   Yanteng Si <siyanteng@loongson.cn>
In-Reply-To: <20221108112921.312071-1-me@lirui.org>
Content-Type: text/plain; charset=UTF-8; format=flowed
Content-Transfer-Encoding: 8bit
Precedence: bulk


On 11/8/22 19:29, Rui Li wrote:
> Translate the following documents into Chinese:
>
> - userspace-api/seccomp_filter.rst
>
> Also adjust index order according to the original index file.
>
> Signed-off-by: Rui Li <me@lirui.org>

Miss Xiangcheng's Review tag.


Reviewed-by: Yanteng Si <siyanteng@loongson.cn>


Thanks,

Yanteng

> ---
> Changes since v3:
> - Improve translation.
>
> Changes since v2:
> - Fix some typo.
>
> Changes since v1:
> - Add a note for Seccomp.
> - Fix some typo.
> ---
>   .../zh_CN/userspace-api/index.rst             |   4 +-
>   .../zh_CN/userspace-api/seccomp_filter.rst    | 293 ++++++++++++++++++
>   2 files changed, 295 insertions(+), 2 deletions(-)
>   create mode 100644 Documentation/translations/zh_CN/userspace-api/seccomp_filter.rst
>
> diff --git a/Documentation/translations/zh_CN/userspace-api/index.rst b/Documentation/translations/zh_CN/userspace-api/index.rst
> index 0f3483a46fa2..dad5ba7cae6d 100644
> --- a/Documentation/translations/zh_CN/userspace-api/index.rst
> +++ b/Documentation/translations/zh_CN/userspace-api/index.rst
> @@ -24,13 +24,13 @@ Linux 内核用户空间API指南
>   .. toctree::
>      :maxdepth: 2
>   
> -   ebpf/index
>      no_new_privs
> +   seccomp_filter
> +   ebpf/index
>      sysfs-platform_profile
>   
>   TODOList:
>   
> -* seccomp_filter
>   * landlock
>   * unshare
>   * spec_ctrl
> diff --git a/Documentation/translations/zh_CN/userspace-api/seccomp_filter.rst b/Documentation/translations/zh_CN/userspace-api/seccomp_filter.rst
> new file mode 100644
> index 000000000000..ede8b37c953f
> --- /dev/null
> +++ b/Documentation/translations/zh_CN/userspace-api/seccomp_filter.rst
> @@ -0,0 +1,293 @@
> +.. SPDX-License-Identifier: GPL-2.0
> +.. include:: ../disclaimer-zh_CN.rst
> +
> +:Original: Documentation/userspace-api/seccomp_filter.rst
> +
> +:翻译:
> +
> + 李睿 Rui Li <me@lirui.org>
> +
> +==================================
> +Seccomp BPF (基于过滤器的安全计算)
> +==================================
> +
> +*Seccomp: SECure COMPuting*
> +
> +介绍
> +====
> +
> +大量系统调用被暴露给每个用户空间进程，但其中又有许多系统调用在进程的整个生命
> +周期中都没被使用。随着系统调用的改变和成熟，缺陷被找到并消除。允许某一部分应
> +用程序仅能访问一部分系统调用是有好处的，这会缩小内核暴露给应用程序的面积。
> +系统调用过滤器就是为这些应用程序而生的。
> +
> +Seccomp过滤提供了一种为进程指定一个处理系统调用的过滤器的方法。这个过滤器体
> +现为一个伯克利包过滤器（BPF）程序，就像套接字过滤器一样，不同在于前者处理的
> +数据和正在进行的系统调用有关：系统调用号和系统调用参数。这样使用一种长期与
> +用户空间和直接数据打交道的语言来表达系统调用过滤成为了可能。
> +
> +此外，BPF让seccomp用户不再成为在系统调用干预框架（system call interposition
> +frameworks）中常见的检查-使用竞态攻击（TOCTOU）的受害者。BPF程序可能无法解引
> +用指针，这就限制了所有过滤器仅能直接评估系统调用参数。
> +
> +这不是什么
> +==========
> +
> +系统调用过滤并不是一个沙箱。它提供了一种明确定义的机制来最小化内核暴露面。它
> +旨在成为一个沙箱开发者使用的工具。除此之外，逻辑行为和信息流的策略应该结合其他
> +系统加固手段或者可能由你选择的内核安全模块（LSM）来管理。易于表达的动态过滤器
> +为这条路提供了更多选择（比如避免病态的大小或者选择允许 socketcall() 中的多路
> +系统调用），但将其理解为更完整的沙箱解决方案是错误的。
> +
> +用法
> +====
> +
> +添加了一个额外的seccomp模式，它可以使用和严格seccomp相同的 prctl(2) 调用来启用。
> +如果架构有 ``CONFIG_HAVE_ARCH_SECCOMP_FILTER`` 标志，那么可以添加以下过滤器：
> +
> +``PR_SET_SECCOMP``:
> +	现在需要添加一个额外的参数来指定使用BPF程序的新过滤器。
> +	BPF程序将在反应系统调用号、参数和其他元数据的seccomp_data结构体之上执行。
> +	BPF程序必须返回允许的值之一来告知内核应该采取什么行动。
> +
> +	用法::
> +
> +		prctl(PR_SET_SECCOMP, SECCOMP_MODE_FILTER, prog);
> +
> +	'prog' 参数是一个指向 sock_fprog 结构体的指针，其中包含了过滤器程序。如
> +	果程序是无效的，该调用会返回 -1 并设置 errno 为 ``EINVAL`` 。
> +
> +	如果 ``fork`` / ``clone`` 和 ``execve`` 被 @prog 所允许，任何子进程都将
> +	受到和父进程相同的过滤器和系统调用ABI的约束。
> +
> +	在调用之前，进程必须调用 ``prctl(PR_SET_NO_NEW_PRIVS, 1)`` 或者在它的
> +	命名空间内以 ``CAP_SYS_ADMIN`` 权限运行。如果以上条件不满足，会返回
> +	``-EACCES`` 。这一要求保证了过滤器程序不能用于比安装过滤器的进程拥有更高
> +	权限的子进程。
> +
> +	另外，如果 ``prctl(2)`` 被安装的过滤器所允许，就可以叠加额外的过滤器。这会增
> +	加评估时间，但是可以进一步降低执行进程时的攻击面。
> +
> +以上调用在成功时返回0，失败时返回一个非零的值。
> +
> +返回值
> +======
> +
> +一个seccomp过滤器可能返回下列任意值。如果多个过滤器存在，评估一个指定系统调用的
> +返回值总会使用最高优先级的值。（比如 ``SECCOMP_RET_KILL_PROCESS`` 总是被优先
> +返回。）
> +
> +按照优先级排序，它们是：
> +
> +``SECCOMP_RET_KILL_PROCESS``:
> +	使得整个进程立即结束而不执行系统调用。进程的退出状态 (``status & 0x7f``) 将
> +	是 ``SIGSYS`` ，而不是 ``SIGKILL`` 。
> +
> +``SECCOMP_RET_KILL_THREAD``:
> +	使得线程立即结束而不执行系统调用。线程的退出状态 (``status & 0x7f``) 将是
> +	是 ``SIGSYS`` ，而不是 ``SIGKILL`` 。
> +
> +``SECCOMP_RET_TRAP``:
> +	使得内核向触发进程发送一个 ``SIGSYS`` 信号而不执行系统调用。
> +	``siginfo->si_call_addr`` 会展示系统调用指令的位置， ``siginfo->si_syscall``
> +	和 ``siginfo->si_arch`` 会指出试图进行的系统调用。程序计数器会和发生了系统
> +	调用的一样（即它不会指向系统调用指令）。返回值寄存器会包含一个与架构相关的值——
> +	如果恢复执行，需要将其设为合理的值。（架构依赖性是因为将其替换为 ``-ENOSYS``
> +	会导致一些有用的信息被覆盖。）
> +
> +	返回值的 ``SECCOMP_RET_DATA`` 部分会作为 ``si_errno`` 传递。
> +
> +	由seccomp触发的 ``SIGSYS`` 会有一个 ``SYS_SECCOMP`` 的 si_code 。
> +
> +``SECCOMP_RET_ERRNO``:
> +	使得返回值的低16位作为errno传递给用户空间，而不执行系统调用。
> +
> +``SECCOMP_RET_USER_NOTIF``:
> +	使得一个 ``struct seccomp_notif`` 消息被发送到已附加的用户空间通知文件描述
> +	符。如果没有被附加则返回 ``-ENOSYS`` 。下面会讨论如何处理用户通知。
> +
> +``SECCOMP_RET_TRACE``:
> +	当返回的时候，这个值会使得内核在执行系统调用前尝试去通知一个基于 ``ptrace()``
> +	的追踪器。如果没有追踪器， ``-ENOSYS`` 会返回给用户空间，并且系统调用不会执行。
> +
> +	如果追踪器通过 ``ptrace(PTRACE_SETOPTIONS)`` 请求了 ``PTRACE_O_TRACESECCOMP``，
> +	那么它会收到 ``PTRACE_EVENT_SECCOMP`` 通知。BPF程序返回值的 ``SECCOMP_RET_DATA``
> +	部分会通过 ``PTRACE_GETEVENTMSG`` 提供给追踪器。
> +
> +	追踪器可以通过改变系统调用号到-1来跳过系统调用。或者追踪器可以改变系统调用号到
> +	一个有效值来改变请求的系统调用。如果追踪器请求跳过系统调用，那么系统调用将返回
> +	追踪器放在返回值寄存器中的值。
> +
> +	在追踪器被通知后，seccomp检查不会再次运行。（这意味着基于seccomp的沙箱必须禁止
> +	ptrace的使用，甚至其他沙箱进程也不行，除非非常小心；ptrace可以通过这个机制来逃
> +	逸。）
> +
> +``SECCOMP_RET_LOG``:
> +	使得系统调用在被记录之后再运行。这应该被应用开发者用来检查他们的程序需要哪些
> +	系统调用，而不需要反复通过多个测试和开发周期来建立清单。
> +
> +	只有在 actions_logged sysctl 字符串中出现 "log" 时，这个操作才会被记录。
> +
> +``SECCOMP_RET_ALLOW``:
> +	使得系统调用被执行。
> +
> +如果多个追踪器存在，评估系统调用的返回值将永远使用最高优先级的值。
> +
> +优先级只通过 ``SECCOMP_RET_ACTION`` 掩码来决定。当多个过滤器返回相同优先级的返回
> +值时，只有来自最近安装的过滤器的 ``SECCOMP_RET_DATA`` 会被返回。
> +
> +隐患
> +====
> +
> +最需要避免的隐患是在过滤系统调用号时却不检查架构值。因为在任何支持多个系统调用
> +约定的架构上，系统调用号可能根据具体调用而不同。如果不同调用约定中的调用号有重叠，
> +那么过滤器的检查可能被滥用。请总是检查架构值！
> +
> +例子
> +====
> +
> +``samples/seccomp/`` 文件夹包含了x86专用和更通用的使用高层宏接口来生成BPF程序的
> +例子。
> +
> +用户空间通知
> +============
> +
> +``SECCOMP_RET_USER_NOTIF`` 返回值会让seccomp过滤器传递一个特定的系统调用给用户
> +空间处理。这可能会对像容器管理器的程序有用，它们希望拦截特定的系统调用（如 ``mount()``，
> +``finit_module()`` 等等）并改变其行为。
> +
> +传递 ``SECCOMP_FILTER_FLAG_NEW_LISTENER`` 参数给 ``seccomp()`` 系统调用可以取
> +得通知文件描述符：
> +
> +.. code-block:: c
> +
> +    fd = seccomp(SECCOMP_SET_MODE_FILTER, SECCOMP_FILTER_FLAG_NEW_LISTENER, &prog);
> +
> +成功情况下会返回一个对过滤器监听的文件描述符，然后可以通过 ``SCM_RIGHTS`` 或类似
> +的方式传递。需要注意的是，过滤器文件描述符针对的是一个特定的过滤器而不是特定的进程。
> +所以如果这个进程后来fork了，来自两个进程的通知都会出现在同一个过滤器文件描述符中。
> +对于过滤器文件描述符的读写也是同步的，所以一个过滤器文件描述符可以安全地拥有多个读者。
> +
> +seccomp通知文件描述符由两个结构体组成：
> +
> +.. code-block:: c
> +
> +    struct seccomp_notif_sizes {
> +        __u16 seccomp_notif;
> +        __u16 seccomp_notif_resp;
> +        __u16 seccomp_data;
> +    };
> +
> +    struct seccomp_notif {
> +        __u64 id;
> +        __u32 pid;
> +        __u32 flags;
> +        struct seccomp_data data;
> +    };
> +
> +    struct seccomp_notif_resp {
> +        __u64 id;
> +        __s64 val;
> +        __s32 error;
> +        __u32 flags;
> +    };
> +
> +``struct seccomp_notif_sizes`` 结构体可以用于确定seccomp通知中各种结构体的大小。
> +``struct seccomp_data`` 的大小可能未来会改变，所以需要使用下面的代码：
> +
> +.. code-block:: c
> +
> +    struct seccomp_notif_sizes sizes;
> +    seccomp(SECCOMP_GET_NOTIF_SIZES, 0, &sizes);
> +
> +来决定需要分配的多种结构体的大小。请查看 samples/seccomp/user-trap.c 中的例子。
> +
> +用户可以通过 ``ioctl(SECCOMP_IOCTL_NOTIF_RECV)`` (或 ``poll()``) 读取seccomp
> +通知文件描述符来接收一个 ``struct seccomp_notif`` ，其中包含五个成员：结构体的
> +输入长度，每个过滤器唯一的 ``id`` ， 触发请求进程的 ``pid`` （如果进程的pid命名空
> +间对于监听者的pid命名空间不可见的话，可能为0）。通知还包含传递给seccomp的 ``data``
> +和一个过滤器标志。在调用ioctl前结构体应该被清空。
> +
> +之后用户空间可以根据这些信息决定做什么，并通过 ``ioctl(SECCOMP_IOCTL_NOTIF_SEND)``
> +发送一个响应，表示应该给用户空间返回什么。 ``struct seccomp_notif_resp`` 的 ``id``
> +成员应该和 ``struct seccomp_notif`` 的 ``id`` 一致。
> +
> +用户空间也可以通过 ``ioctl(SECCOMP_IOCTL_NOTIF_ADDFD)`` 向通知进程添加文件描述
> +符。 ``struct seccomp_notif_addfd`` 的 ``id`` 成员应该和 ``struct seccomp_notif``
> +的 ``id`` 保持一致。 ``newfd_flags`` 标志可以被用于在通知进程的文件描述符上设置
> +O_CLOEXEC 等标志。如果监督者（supervisor）向文件描述符注入一个特定的数字，可以使用
> +``SECCOMP_ADDFD_FLAG_SETFD`` 标志，并设置 ``newfd`` 成员为要使用的特定数字。
> +如果文件描述符已经在通知进程中打开，那它将被替换。监督者也可以添加一个文件描述符，
> +并使用 ``SECCOMP_ADDFD_FLAG_SEND`` 标志原子响应，返回值将是注入的文件描述符编号。
> +
> +通知进程可以被抢占，导致通知被终止。这可能在尝试代表通知进程执行长时间且通常可重试
> +（如挂载文件系统）的操作时导致问题。另外，在安装过滤器的时候，
> +``SECCOMP_FILTER_FLAG_WAIT_KILLABLE_RECV`` 可以被设置。这个标志使得当监督者收到用
> +户通知时，通知进程会忽略非致命信号，直到响应被发送。在用户空间收到通知之前发出的信号
> +将被正常处理。
> +
> +值得注意的是， ``struct seccomp_data`` 包含了系统调用寄存器参数的值，但是不包含指向
> +内存的指针。进程的内存可以通过  ``ptrace()`` 或 ``/proc/pid/mem`` 由合适的特权跟踪
> +访问。但是，需要注意避免之前提到的TOCTOU攻击：所有从被跟踪者内存中读到的参数都应该先
> +读到追踪器的内存中，再做出策略决定。这样就可以对系统调用的参数做原子决定。
> +
> +Sysctls
> +=======
> +
> +Seccomp的sysctl文件可以在 ``/proc/sys/kernel/seccomp/`` 文件夹中找到。这里有对文件
> +夹中每个文件的描述：
> +
> +``actions_avail``:
> +	以字符串形式保存seccomp返回值（参考上文的 ``SECCOMP_RET_*`` 宏）的只读有序
> +	列表。从左往右按照最少许可返回值到最多许可返回值排序。
> +
> +	这个列表代表了内核支持的seccomp返回值集合。一个用户空间程序可以使用这个列表来在
> +	程序建立时确定在 ``seccomp.h`` 中找到的动作是否和当前运行内核实际支持的动作有所
> +	不同。
> +
> +``actions_logged``:
> +	允许被记录的seccomp返回值（参考上文的 ``SECCOMP_RET_*`` 宏）的可读写有序列表。
> +	对文件写入不需要是有序的，但从文件读取将采用与actions_avail sysctl一致的方式排序。
> +
> +	``allow`` 字符串在 ``actions_logged`` sysctl中不被接收，因为不可能记录
> +	``SECCOMP_RET_ALLOW`` 动作。尝试向sysctl写入 ``allow`` 会导致返回一个EINVAL。
> +
> +添加架构支持
> +============
> +
> +请查看 ``arch/Kconfig`` 了解权威要求。总的来说如果一个架构同时支持ptrace_event和
> +seccomp，那么它将可以通过较小的修改支持seccomp过滤器： ``SIGSYS`` 支持和seccomp
> +返回值检查。然后必须将 ``CONFIG_HAVE_ARCH_SECCOMP_FILTER`` 添加到它的架构特定
> +的Kconfig中。
> +
> +注意事项
> +========
> +
> +vDSO可能导致一些系统调用完全在用户空间中运行，当你在不同机器上跑程序时可能导致回退
> +到真正系统调用的意外发生。为了在x86上最小化这些意外的发生，请确保你在测试时把
> +``/sys/devices/system/clocksource/clocksource0/current_clocksource`` 设置为
> +``acpi_pm`` 之类的值。
> +
> +在x86-64上，vsyscall模拟默认开启。（vsyscalls是vDSO调用的传统变体。）目前，模拟
> +vsyscalls会遵守seccomp，但是有一些奇怪情况：
> +
> +- ``SECCOMP_RET_TRAP`` 的返回值会设置一个指向给定vsyscall入口的 ``si_call_addr``，
> +  而不是'syscall'指令之后的地址。任何想重新开始调用的代码都需要注意 (a) ret指令
> +  已被模拟，(b) 试图恢复系统调用将再次触发标准vsyscall模拟安全检查，使得恢复系统
> +  调用在大部分情况下没有意义。
> +
> +- ``SECCOMP_RET_TRACE`` 的返回值将像往常一样给追踪器发出信号，但是系统调用可能不能
> +  使用orig_rax寄存器改变为另一个系统调用。可能只能改变为-1来跳过当前模拟的调用。
> +  任何其他改变都可能终止进程。追踪器看到的rip值将是系统调用的入口地址；这和正常行为
> +  不同。追踪器禁止修改rip或者rsp。（不要依赖其他改变来终止进程，它们可能正常工作。
> +  比如在一些内核中，选择一个只存在于未来内核中的系统调用将被正确模拟，返回一个
> +  ``-ENOSYS`` 。）
> +
> +要检测这个古怪的行为，可以检查 ``addr & ~0x0C00 == 0xFFFFFFFFFF600000``。（对于
> +``SECCOMP_RET_TRACE`` ，使用rip。对于 ``SECCOMP_RET_TRAP`` ，使用
> +``siginfo->si_call_addr`` 。）不要检测其他条件：未来内核可能会改进vsyscall模拟，
> +当前内核在vsyscall=native模式下会有不同表现，但在这些情况下， ``0xF...F600{0,4,8,C}00``
> +处的指令将不是系统调用。
> +
> +请注意，现代系统根本不可能使用vsyscalls —— 它们是一种遗留功能，而且比标准系统调用
> +慢得多。 新的代码将使用vDSO，而vDSO发出的系统调用与正常的系统调用没有区别。