From patchwork Tue Mar 9 14:39:51 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Richard Haines X-Patchwork-Id: 12125487 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-18.8 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER, INCLUDES_PATCH,MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id A2A82C4332D for ; Tue, 9 Mar 2021 14:46:11 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 55B866522D for ; Tue, 9 Mar 2021 14:46:11 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S231532AbhCIOpj (ORCPT ); Tue, 9 Mar 2021 09:45:39 -0500 Received: from mailomta8-sa.btinternet.com ([213.120.69.14]:37891 "EHLO sa-prd-fep-042.btinternet.com" rhost-flags-OK-OK-OK-FAIL) by vger.kernel.org with ESMTP id S231254AbhCIOpa (ORCPT ); Tue, 9 Mar 2021 09:45:30 -0500 X-Greylist: delayed 325 seconds by postgrey-1.27 at vger.kernel.org; Tue, 09 Mar 2021 09:45:29 EST Received: from sa-prd-rgout-002.btmx-prd.synchronoss.net ([10.2.38.5]) by sa-prd-fep-041.btinternet.com with ESMTP id <20210309144003.DENC30505.sa-prd-fep-041.btinternet.com@sa-prd-rgout-002.btmx-prd.synchronoss.net>; Tue, 9 Mar 2021 14:40:03 +0000 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=btinternet.com; s=btmx201904; t=1615300803; bh=PxstithgEvgCLW14hSPz6cRyW63QXoE33eCI61DXYtU=; h=From:To:Cc:Subject:Date:Message-Id:X-Mailer:In-Reply-To:References:MIME-Version; b=kdGoZJnm86RIKxhKz70znB1Kbs46zKKBPslIWfUnWnmBhHrqDW2KgNmG5ouHJe0x9M2DMkvAJIz9BFMP032Cy8HMXKiT5Pcpt+8m5zChiZBrG8TBBMWoS9PcQt/a281RNLZ/B8U3McUWdBg1KLVAYxI7pl54RenXm9hHsT77VWXpR35s4rbvzh1pHDyDAZcy6JaH5k1C/WHtSbf2/wTCTjBvTJZwMUf6/8d3FWkJS4f/5otfURvmIONJJB/AleaeronX3pGBVqrhSUwF7DdXO2GlSdckPEc/FO10HBdJqZhI5pCMr3BBqvMYZ8uVMn45KhqYzNeKdi8r+oBYSPaYbw== Authentication-Results: btinternet.com; none X-SNCR-Rigid: 6038718301A65378 X-Originating-IP: [86.133.207.84] X-OWM-Source-IP: 86.133.207.84 (GB) X-OWM-Env-Sender: richard_c_haines@btinternet.com X-VadeSecure-score: verdict=clean score=0/300, class=clean X-RazorGate-Vade: gggruggvucftvghtrhhoucdtuddrgeduledrudduiedgieejucetufdoteggodetrfdotffvucfrrhhofhhilhgvmecuueftkffvkffujffvgffngfevqffopdfqfgfvnecuuegrihhlohhuthemuceftddunecunecujfgurhephffvufffkffojghfggfgsedtkeertdertddtnecuhfhrohhmpeftihgthhgrrhguucfjrghinhgvshcuoehrihgthhgrrhgupggtpghhrghinhgvshessghtihhnthgvrhhnvghtrdgtohhmqeenucggtffrrghtthgvrhhnpeeutddtleelheeugefgiefhiedtheeukeffveeitdffgeffieeugeeljeegvefgieenucfkphepkeeirddufeefrddvtdejrdekgeenucevlhhushhtvghrufhiiigvpedtnecurfgrrhgrmhephhgvlhhopehlohgtrghlhhhoshhtrdhlohgtrghlughomhgrihhnpdhinhgvthepkeeirddufeefrddvtdejrdekgedpmhgrihhlfhhrohhmpeeorhhitghhrghruggptggphhgrihhnvghssegsthhinhhtvghrnhgvthdrtghomheqpdhrtghpthhtohepoegtrghsvgihsehstghhrghufhhlvghrqdgtrgdrtghomheqpdhrtghpthhtohepoegtohhrsggvtheslhifnhdrnhgvtheqpdhrtghpthhtohepoehjmhhorhhrihhssehnrghmvghirdhorhhgqedprhgtphhtthhopeeolhhinhhugidqughotgesvhhgvghrrdhkvghrnhgvlhdrohhrgheqpdhrtghpthhtohepoehlihhnuhigqdhsvggtuhhrihhthidqmhhoughulhgvsehvghgvrhdrkhgvrhhn vghlrdhorhhgqedprhgtphhtthhopeeophgruhhlsehprghulhdqmhhoohhrvgdrtghomheqpdhrtghpthhtohepoehrihgthhgrrhgupggtpghhrghinhgvshessghtihhnthgvrhhnvghtrdgtohhmqecuqfftvefrvfeprhhftgekvddvnehrihgthhgrrhgupggtpghhrghinhgvshessghtihhnthgvrhhnvghtrdgtohhmpdhrtghpthhtohepoehsvghrghgvsehhrghllhihnhdrtghomheq X-RazorGate-Vade-Verdict: clean 0 X-RazorGate-Vade-Classification: clean X-SNCR-hdrdom: btinternet.com Received: from localhost.localdomain (86.133.207.84) by sa-prd-rgout-002.btmx-prd.synchronoss.net (5.8.340) (authenticated as richard_c_haines@btinternet.com) id 6038718301A65378; Tue, 9 Mar 2021 14:40:03 +0000 From: Richard Haines To: linux-security-module@vger.kernel.org, linux-doc@vger.kernel.org Cc: corbet@lwn.net, paul@paul-moore.com, jmorris@namei.org, serge@hallyn.com, casey@schaufler-ca.com, Richard Haines Subject: [RFC PATCH 1/3] Documentation/security: Update LSM security hook text Date: Tue, 9 Mar 2021 14:39:51 +0000 Message-Id: <20210309143953.142341-2-richard_c_haines@btinternet.com> X-Mailer: git-send-email 2.29.2 In-Reply-To: <20210309143953.142341-1-richard_c_haines@btinternet.com> References: <20210309143953.142341-1-richard_c_haines@btinternet.com> MIME-Version: 1.0 Precedence: bulk List-ID: This patch series updates the LSM hook text defined in the comments section of inlcude/linux/lsm_hooks.h. This enables the hook functions to be rendered in kernel_docs html or pdf format. Note that no text has been changed in lsm_hooks.h, only formatting to render the text. Signed-off-by: Richard Haines --- Documentation/security/lsm-development.rst | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/Documentation/security/lsm-development.rst b/Documentation/security/lsm-development.rst index ac53e5065..f85897814 100644 --- a/Documentation/security/lsm-development.rst +++ b/Documentation/security/lsm-development.rst @@ -11,7 +11,10 @@ that end users and distros can make a more informed decision about which LSMs suit their requirements. For extensive documentation on the available LSM hook interfaces, please -see ``include/linux/lsm_hooks.h`` and associated structures: +see ``include/linux/lsm_hooks.h`` and associated structures. + +The LSM hooks are described below in the ``RET (*NAME)(__VA_ARGS__)`` format +under the `Description` header. .. kernel-doc:: include/linux/lsm_hooks.h :internal: From patchwork Tue Mar 9 14:39:52 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Richard Haines X-Patchwork-Id: 12125705 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-18.8 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER, INCLUDES_PATCH,MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 1835DC433E9 for ; Tue, 9 Mar 2021 15:07:06 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id D316165275 for ; Tue, 9 Mar 2021 15:07:05 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S231761AbhCIPGd (ORCPT ); Tue, 9 Mar 2021 10:06:33 -0500 Received: from mailomta28-sa.btinternet.com ([213.120.69.34]:31451 "EHLO sa-prd-fep-043.btinternet.com" rhost-flags-OK-OK-OK-FAIL) by vger.kernel.org with ESMTP id S231272AbhCIPG0 (ORCPT ); Tue, 9 Mar 2021 10:06:26 -0500 Received: from sa-prd-rgout-002.btmx-prd.synchronoss.net ([10.2.38.5]) by sa-prd-fep-042.btinternet.com with ESMTP id <20210309144004.CXPP32624.sa-prd-fep-042.btinternet.com@sa-prd-rgout-002.btmx-prd.synchronoss.net>; Tue, 9 Mar 2021 14:40:04 +0000 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=btinternet.com; s=btmx201904; t=1615300804; bh=zrBFNMM+D+9IEwLePPctog25rTnrtLAAm3w/gYUpmo0=; h=From:To:Cc:Subject:Date:Message-Id:X-Mailer:In-Reply-To:References:MIME-Version; b=aY6NL00GnJx77tg53kPsHlMmU2JLCPbSW0QLUKJRrdjAzKKmvdq9X0bDNr/1VOhbUi4iIWVrZAPb+xhs0j3vOoN+bYGVwad32WoXbmaBJaHT4srMvx3Lxz3ASnzohZVO8sv9K1ARG+g3BYNi+koYxmXU6RAOFgjyZIyxQfDbpAbCkyUFv1AZLtZtv7QJi/HrJeZ0mM1RmQUjWpjywQzhLAO0TYzdnu/tF1S3bixoVq++Y9Jxgxqjv++QopQX0YUV5ZLDDGIVrxM9LBaE2AGAOXxXzhvbTsg8paUqgQLt7hrNlXcDo0qeaQ/lZ6BSAcPPsKwPAM1Rq9YaED8j0EN8xg== Authentication-Results: btinternet.com; none X-SNCR-Rigid: 6038718301A653A3 X-Originating-IP: [86.133.207.84] X-OWM-Source-IP: 86.133.207.84 (GB) X-OWM-Env-Sender: richard_c_haines@btinternet.com X-VadeSecure-score: verdict=clean score=0/300, class=clean X-RazorGate-Vade: gggruggvucftvghtrhhoucdtuddrgeduledrudduiedgieejucetufdoteggodetrfdotffvucfrrhhofhhilhgvmecuueftkffvkffujffvgffngfevqffopdfqfgfvnecuuegrihhlohhuthemuceftddunecunecujfgurhephffvufffkffojghfggfgsedtkeertdertddtnecuhfhrohhmpeftihgthhgrrhguucfjrghinhgvshcuoehrihgthhgrrhgupggtpghhrghinhgvshessghtihhnthgvrhhnvghtrdgtohhmqeenucggtffrrghtthgvrhhnpeeutddtleelheeugefgiefhiedtheeukeffveeitdffgeffieeugeeljeegvefgieenucfkphepkeeirddufeefrddvtdejrdekgeenucevlhhushhtvghrufhiiigvpedtnecurfgrrhgrmhephhgvlhhopehlohgtrghlhhhoshhtrdhlohgtrghlughomhgrihhnpdhinhgvthepkeeirddufeefrddvtdejrdekgedpmhgrihhlfhhrohhmpeeorhhitghhrghruggptggphhgrihhnvghssegsthhinhhtvghrnhgvthdrtghomheqpdhrtghpthhtohepoegtrghsvgihsehstghhrghufhhlvghrqdgtrgdrtghomheqpdhrtghpthhtohepoegtohhrsggvtheslhifnhdrnhgvtheqpdhrtghpthhtohepoehjmhhorhhrihhssehnrghmvghirdhorhhgqedprhgtphhtthhopeeolhhinhhugidqughotgesvhhgvghrrdhkvghrnhgvlhdrohhrgheqpdhrtghpthhtohepoehlihhnuhigqdhsvggtuhhrihhthidqmhhoughulhgvsehvghgvrhdrkhgvrhhn vghlrdhorhhgqedprhgtphhtthhopeeophgruhhlsehprghulhdqmhhoohhrvgdrtghomheqpdhrtghpthhtohepoehrihgthhgrrhgupggtpghhrghinhgvshessghtihhnthgvrhhnvghtrdgtohhmqecuqfftvefrvfeprhhftgekvddvnehrihgthhgrrhgupggtpghhrghinhgvshessghtihhnthgvrhhnvghtrdgtohhmpdhrtghpthhtohepoehsvghrghgvsehhrghllhihnhdrtghomheq X-RazorGate-Vade-Verdict: clean 0 X-RazorGate-Vade-Classification: clean X-SNCR-hdrdom: btinternet.com Received: from localhost.localdomain (86.133.207.84) by sa-prd-rgout-002.btmx-prd.synchronoss.net (5.8.340) (authenticated as richard_c_haines@btinternet.com) id 6038718301A653A3; Tue, 9 Mar 2021 14:40:04 +0000 From: Richard Haines To: linux-security-module@vger.kernel.org, linux-doc@vger.kernel.org Cc: corbet@lwn.net, paul@paul-moore.com, jmorris@namei.org, serge@hallyn.com, casey@schaufler-ca.com, Richard Haines Subject: [RFC PATCH 2/3] include/linux: Update LSM hook text part1 Date: Tue, 9 Mar 2021 14:39:52 +0000 Message-Id: <20210309143953.142341-3-richard_c_haines@btinternet.com> X-Mailer: git-send-email 2.29.2 In-Reply-To: <20210309143953.142341-1-richard_c_haines@btinternet.com> References: <20210309143953.142341-1-richard_c_haines@btinternet.com> MIME-Version: 1.0 Precedence: bulk List-ID: No hook definitions have been updated, only formatting to render in kernel_docs. Signed-off-by: Richard Haines --- include/linux/lsm_hooks.h | 1173 +++++++++++++++++++++---------------- 1 file changed, 677 insertions(+), 496 deletions(-) diff --git a/include/linux/lsm_hooks.h b/include/linux/lsm_hooks.h index fb7f31937..b7fdab1e9 100644 --- a/include/linux/lsm_hooks.h +++ b/include/linux/lsm_hooks.h @@ -32,743 +32,924 @@ /** * union security_list_options - Linux Security Module hook function list * - * Security hooks for program execution operations. + * **Security hooks for program execution operations:** * - * @bprm_creds_for_exec: - * If the setup in prepare_exec_creds did not setup @bprm->cred->security + * int bprm_creds_for_exec(struct linux_binprm \*bprm) + * If the setup in @prepare_exec_creds() did not setup @bprm->cred->security * properly for executing @bprm->file, update the LSM's portion of - * @bprm->cred->security to be what commit_creds needs to install for the - * new program. This hook may also optionally check permissions + * @bprm->cred->security to be what @commit_creds() needs to install for + * the new program. This hook may also optionally check permissions * (e.g. for transitions between security domains). - * The hook must set @bprm->secureexec to 1 if AT_SECURE should be set to - * request libc enable secure mode. - * @bprm contains the linux_binprm structure. - * Return 0 if the hook is successful and permission is granted. - * @bprm_creds_from_file: - * If @file is setpcap, suid, sgid or otherwise marked to change - * privilege upon exec, update @bprm->cred to reflect that change. + * The hook must set @bprm->secureexec to %1 if %AT_SECURE should be set to + * request %libc enable secure mode. + * + * * @bprm contains the @linux_binprm structure. + * * Return %0 if the hook is successful and permission is granted. + * + * int bprm_creds_from_file(struct linux_binprm \*bprm, struct file \*file) + * If @file is %setpcap, %suid, %sgid or otherwise marked to change + * privilege upon @exec, update @bprm->cred to reflect that change. * This is called after finding the binary that will be executed. * without an interpreter. This ensures that the credentials will not * be derived from a script that the binary will need to reopen, which * when reopend may end up being a completely different file. This * hook may also optionally check permissions (e.g. for transitions * between security domains). - * The hook must set @bprm->secureexec to 1 if AT_SECURE should be set to - * request libc enable secure mode. + * The hook must set @bprm->secureexec to %1 if %AT_SECURE should be set to + * request %libc enable secure mode. * The hook must add to @bprm->per_clear any personality flags that - * should be cleared from current->personality. - * @bprm contains the linux_binprm structure. - * Return 0 if the hook is successful and permission is granted. - * @bprm_check_security: + * should be cleared from @current->personality. + * + * * @bprm contains the @linux_binprm structure. + * * Return %0 if the hook is successful and permission is granted. + * + * int bprm_check_security(struct linux_binprm \*bprm) * This hook mediates the point when a search for a binary handler will * begin. It allows a check against the @bprm->cred->security value - * which was set in the preceding creds_for_exec call. The argv list and - * envp list are reliably available in @bprm. This hook may be called - * multiple times during a single execve. - * @bprm contains the linux_binprm structure. - * Return 0 if the hook is successful and permission is granted. - * @bprm_committing_creds: + * which was set in the preceding @creds_for_exec() call. The %argv list + * and %envp list are reliably available in @bprm. This hook may be called + * multiple times during a single @execve. + * + * * @bprm contains the @linux_binprm structure. + * * Return %0 if the hook is successful and permission is granted. + * + * void bprm_committing_creds(struct linux_binprm \*bprm) * Prepare to install the new security attributes of a process being - * transformed by an execve operation, based on the old credentials + * transformed by an @execve operation, based on the old credentials * pointed to by @current->cred and the information set in @bprm->cred by - * the bprm_creds_for_exec hook. @bprm points to the linux_binprm + * the @bprm_creds_for_exec() hook. @bprm points to the @linux_binprm * structure. This hook is a good place to perform state changes on the * process such as closing open file descriptors to which access will no * longer be granted when the attributes are changed. This is called - * immediately before commit_creds(). - * @bprm_committed_creds: + * immediately before @commit_creds(). + * + * void bprm_committed_creds(struct linux_binprm \*bprm) * Tidy up after the installation of the new security attributes of a - * process being transformed by an execve operation. The new credentials + * process being transformed by an @execve operation. The new credentials * have, by this point, been set to @current->cred. @bprm points to the - * linux_binprm structure. This hook is a good place to perform state + * @linux_binprm structure. This hook is a good place to perform state * changes on the process such as clearing out non-inheritable signal - * state. This is called immediately after commit_creds(). + * state. This is called immediately after @commit_creds(). + * + * **Security hooks for mount using fs_context** + * (See also Documentation/filesystems/mount_api.rst): + * + * int fs_context_dup(struct fs_context \*fc, struct fs_context \*src_fc) + * Allocate and attach a security structure to @sc->security. This pointer + * is initialised to %NULL by the caller. * - * Security hooks for mount using fs_context. - * [See also Documentation/filesystems/mount_api.rst] + * * @fc indicates the new filesystem context. + * * @src_fc indicates the original filesystem context. * - * @fs_context_dup: - * Allocate and attach a security structure to sc->security. This pointer - * is initialised to NULL by the caller. - * @fc indicates the new filesystem context. - * @src_fc indicates the original filesystem context. - * @fs_context_parse_param: + * int fs_context_parse_param(struct fs_context \*fc, struct fs_parameter \*param) * Userspace provided a parameter to configure a superblock. The LSM may * reject it with an error and may use it for itself, in which case it - * should return 0; otherwise it should return -ENOPARAM to pass it on to + * should Return %0; otherwise it should return %-ENOPARAM to pass it on to * the filesystem. - * @fc indicates the filesystem context. - * @param The parameter * - * Security hooks for filesystem operations. + * * @fc indicates the filesystem context. + * * @param The parameter * - * @sb_alloc_security: - * Allocate and attach a security structure to the sb->s_security field. - * The s_security field is initialized to NULL when the structure is + * **Security hooks for filesystem operations:** + * + * int sb_alloc_security(struct super_block \*sb) + * Allocate and attach a security structure to the @sb->s_security field. + * The @s_security field is initialized to %NULL when the structure is * allocated. - * @sb contains the super_block structure to be modified. - * Return 0 if operation was successful. - * @sb_free_security: - * Deallocate and clear the sb->s_security field. - * @sb contains the super_block structure to be modified. - * @sb_free_mnt_opts: + * + * * @sb contains the @super_block structure to be modified. + * * Return %0 if operation was successful. + * + * void sb_free_security(struct super_block \*sb) + * Deallocate and clear the @sb->s_security field. + * + * * @sb contains the @super_block structure to be modified. + * + * void sb_free_mnt_opts(void \*mnt_opts) * Free memory associated with @mnt_ops. - * @sb_eat_lsm_opts: + * + * int sb_eat_lsm_opts(char \*orig, void \*\*mnt_opts) * Eat (scan @orig options) and save them in @mnt_opts. - * @sb_statfs: + * + * int sb_statfs(struct dentry \*dentry) * Check permission before obtaining filesystem statistics for the @mnt * mountpoint. - * @dentry is a handle on the superblock for the filesystem. - * Return 0 if permission is granted. - * @sb_mount: + * + * * @dentry is a handle on the superblock for the filesystem. + * * Return %0 if permission is granted. + * + * int sb_mount(const char \*dev_name, const struct path \*path, const char \*type, unsigned long flags, void \*data) * Check permission before an object specified by @dev_name is mounted on * the mount point named by @nd. For an ordinary mount, @dev_name * identifies a device if the file system type requires a device. For a - * remount (@flags & MS_REMOUNT), @dev_name is irrelevant. For a - * loopback/bind mount (@flags & MS_BIND), @dev_name identifies the + * remount (@flags & %MS_REMOUNT), @dev_name is irrelevant. For a + * loopback/bind mount (@flags & %MS_BIND), @dev_name identifies the * pathname of the object being mounted. - * @dev_name contains the name for object being mounted. - * @path contains the path for mount point object. - * @type contains the filesystem type. - * @flags contains the mount flags. - * @data contains the filesystem-specific data. - * Return 0 if permission is granted. - * @sb_copy_data: + * + * * @dev_name contains the name for object being mounted. + * * @path contains the path for mount point object. + * * @type contains the filesystem type. + * * @flags contains the mount flags. + * * @data contains the filesystem-specific data. + * * Return %0 if permission is granted. + * + * int sb_copy_data(char \*orig, char \*copy) - Deprecated * Allow mount option data to be copied prior to parsing by the filesystem, * so that the security module can extract security-specific mount - * options cleanly (a filesystem may modify the data e.g. with strsep()). + * options cleanly (a filesystem may modify the data e.g. with @strsep()). * This also allows the original mount data to be stripped of security- * specific options to avoid having to make filesystems aware of them. - * @orig the original mount data copied from userspace. - * @copy copied data which will be passed to the security module. - * Returns 0 if the copy was successful. - * @sb_remount: + * + * * @orig the original mount data copied from userspace. + * * @copy copied data which will be passed to the security module. + * * Returns %0 if the copy was successful. + * + * int sb_remount(struct super_block \*sb, void \*mnt_opts) * Extracts security system specific mount options and verifies no changes * are being made to those options. - * @sb superblock being remounted - * @data contains the filesystem-specific data. - * Return 0 if permission is granted. - * @sb_kern_mount: + * + * * @sb superblock being remounted + * * @data contains the filesystem-specific data. + * * Return %0 if permission is granted. + * + * int sb_kern_mount(struct super_block \*sb) * Mount this @sb if allowed by permissions. - * @sb_show_options: + * + * int sb_show_options(struct seq_file \*m, struct super_block \*sb) * Show (print on @m) mount options for this @sb. - * @sb_umount: + * + * int sb_umount(struct vfsmount \*mnt, int flags) * Check permission before the @mnt file system is unmounted. - * @mnt contains the mounted file system. - * @flags contains the unmount flags, e.g. MNT_FORCE. - * Return 0 if permission is granted. - * @sb_pivotroot: + * + * * @mnt contains the mounted file system. + * * @flags contains the unmount flags, e.g. %MNT_FORCE. + * * Return %0 if permission is granted. + * + * int sb_pivotroot(const struct path \*old_path, const struct path \*new_path) * Check permission before pivoting the root filesystem. - * @old_path contains the path for the new location of the - * current root (put_old). - * @new_path contains the path for the new root (new_root). - * Return 0 if permission is granted. - * @sb_set_mnt_opts: - * Set the security relevant mount options used for a superblock - * @sb the superblock to set security mount options for - * @opts binary data structure containing all lsm mount data - * @sb_clone_mnt_opts: + * + * * @old_path contains the path for the new location of the current root (put_old). + * * @new_path contains the path for the new root (new_root). + * * Return %0 if permission is granted. + * + * int sb_set_mnt_opts(struct super_block \*sb, void \*mnt_opts, unsigned long kern_flags, unsigned long \*set_kern_flags) + * Set the security relevant mount options used for a superblock: + * + * * @sb the superblock to set security mount options for + * * @mnt_opts binary data structure containing all LSM mount data + * + * int sb_clone_mnt_opts(const struct super_block \*oldsb, struct super_block \*newsb, unsigned long kern_flags, unsigned long \*set_kern_flags) * Copy all security options from a given superblock to another * @oldsb old superblock which contain information to clone * @newsb new superblock which needs filled in - * @sb_add_mnt_opt: + * + * int sb_add_mnt_opt(const char \*option, const char \*val, int len, void \*\*mnt_opts) * Add one mount @option to @mnt_opts. - * @sb_parse_opts_str: + * + * int sb_parse_opts_str(char \*options, struct security_mnt_opts \*opts) - Deprecated * Parse a string of security data filling in the opts structure * @options string containing all mount options known by the LSM * @opts binary data structure usable by the LSM - * @move_mount: + * + * int move_mount(const struct path \*from_path, const struct path \*to_path) * Check permission before a mount is moved. - * @from_path indicates the mount that is going to be moved. - * @to_path indicates the mountpoint that will be mounted upon. - * @dentry_init_security: + * + * * @from_path indicates the mount that is going to be moved. + * * @to_path indicates the mountpoint that will be mounted upon. + * + * int dentry_init_security(struct dentry \*dentry, int mode, const struct qstr \*name, void \*\*ctx, u32 \*ctxlen) * Compute a context for a dentry as the inode is not yet available * since NFSv4 has no label backed by an EA anyway. - * @dentry dentry to use in calculating the context. - * @mode mode used to determine resource type. - * @name name of the last path component used to create file - * @ctx pointer to place the pointer to the resulting context in. - * @ctxlen point to place the length of the resulting context. - * @dentry_create_files_as: + * + * * @dentry dentry to use in calculating the context. + * * @mode mode used to determine resource type. + * * @name name of the last path component used to create file + * * @ctx pointer to place the pointer to the resulting context in. + * * @ctxlen point to place the length of the resulting context. + * + * int dentry_create_files_as(struct dentry \*dentry, int mode, struct qstr \*name, const struct cred \*old, struct cred \*new) * Compute a context for a dentry as the inode is not yet available * and set that context in passed in creds so that new files are * created using that context. Context is calculated using the * passed in creds and not the creds of the caller. - * @dentry dentry to use in calculating the context. - * @mode mode used to determine resource type. - * @name name of the last path component used to create file - * @old creds which should be used for context calculation - * @new creds to modify * + * * @dentry dentry to use in calculating the context. + * * @mode mode used to determine resource type. + * * @name name of the last path component used to create file + * * @old creds which should be used for context calculation + * * @new creds to modify * - * Security hooks for inode operations. + * **Security hooks for inode operations:** * - * @inode_alloc_security: + * int inode_alloc_security(struct inode \*inode) * Allocate and attach a security structure to @inode->i_security. The - * i_security field is initialized to NULL when the inode structure is + * @i_security field is initialized to %NULL when the inode structure is * allocated. - * @inode contains the inode structure. - * Return 0 if operation was successful. - * @inode_free_security: + * + * * @inode contains the inode structure. + * * Return %0 if operation was successful. + * + * void inode_free_security(struct inode \*inode) * @inode contains the inode structure. * Deallocate the inode security structure and set @inode->i_security to - * NULL. - * @inode_init_security: + * %NULL. + * + * int inode_init_security(struct inode \*inode, struct inode \*dir, const struct qstr \*qstr, const char \*\*name, void \*\*value, size_t \*len) * Obtain the security attribute name suffix and value to set on a newly * created inode and set up the incore security field for the new inode. * This hook is called by the fs code as part of the inode creation * transaction and provides for atomic labeling of the inode, unlike * the post_create/mkdir/... hooks called by the VFS. The hook function - * is expected to allocate the name and value via kmalloc, with the caller - * being responsible for calling kfree after using them. + * is expected to allocate the name and value via @kmalloc(), with the caller + * being responsible for calling @kfree() after using them. * If the security module does not use security attributes or does * not wish to put a security attribute on this particular inode, - * then it should return -EOPNOTSUPP to skip this processing. - * @inode contains the inode structure of the newly created inode. - * @dir contains the inode structure of the parent directory. - * @qstr contains the last path component of the new object - * @name will be set to the allocated name suffix (e.g. selinux). - * @value will be set to the allocated attribute value. - * @len will be set to the length of the value. - * Returns 0 if @name and @value have been successfully set, - * -EOPNOTSUPP if no security attribute is needed, or - * -ENOMEM on memory allocation failure. - * @inode_init_security_anon: + * then it should return %-EOPNOTSUPP to skip this processing. + * + * * @inode contains the inode structure of the newly created inode. + * * @dir contains the inode structure of the parent directory. + * * @qstr contains the last path component of the new object + * * @name will be set to the allocated name suffix (e.g. selinux). + * * @value will be set to the allocated attribute value. + * * @len will be set to the length of the value. + * * Returns %0 if @name and @value have been successfully set, + * * %-EOPNOTSUPP if no security attribute is needed, or + * * %-ENOMEM on memory allocation failure. + * + * int inode_init_security_anon(struct inode \*inode, const struct qstr \*name, const struct inode \*context_inode) * Set up the incore security field for the new anonymous inode * and return whether the inode creation is permitted by the security * module or not. - * @inode contains the inode structure - * @name name of the anonymous inode class - * @context_inode optional related inode - * Returns 0 on success, -EACCES if the security module denies the - * creation of this inode, or another -errno upon other errors. - * @inode_create: + * + * * @inode contains the inode structure + * * @name name of the anonymous inode class + * * @context_inode optional related inode + * * Returns %0 on success, + * * %-EACCES if the security module denies the creation of this inode, + * * or another %-errno upon other errors. + * + * int inode_create(struct inode \*dir, struct dentry \*dentry, umode_t mode) * Check permission to create a regular file. - * @dir contains inode structure of the parent of the new file. - * @dentry contains the dentry structure for the file to be created. - * @mode contains the file mode of the file to be created. - * Return 0 if permission is granted. - * @inode_link: + * + * * @dir contains inode structure of the parent of the new file. + * * @dentry contains the dentry structure for the file to be created. + * * @mode contains the file mode of the file to be created. + * * Return %0 if permission is granted. + * + * int inode_link(struct dentry \*old_dentry, struct inode \*dir, struct dentry \*new_dentry) * Check permission before creating a new hard link to a file. - * @old_dentry contains the dentry structure for an existing - * link to the file. - * @dir contains the inode structure of the parent directory - * of the new link. - * @new_dentry contains the dentry structure for the new link. - * Return 0 if permission is granted. - * @path_link: + * + * * @old_dentry contains the dentry structure for an existing link to the file. + * * @dir contains the inode structure of the parent directory of the new link. + * * @new_dentry contains the dentry structure for the new link. + * * Return %0 if permission is granted. + * + * int path_link(struct dentry \*old_dentry, const struct path \*new_dir, struct dentry \*new_dentry) * Check permission before creating a new hard link to a file. - * @old_dentry contains the dentry structure for an existing link - * to the file. - * @new_dir contains the path structure of the parent directory of - * the new link. - * @new_dentry contains the dentry structure for the new link. - * Return 0 if permission is granted. - * @inode_unlink: + * + * * @old_dentry contains the dentry structure for an existing link to the file. + * * @new_dir contains the path structure of the parent directory of the new link. + * * @new_dentry contains the dentry structure for the new link. + * * Return %0 if permission is granted. + * + * int inode_unlink(struct inode \*dir, struct dentry \*dentry) * Check the permission to remove a hard link to a file. - * @dir contains the inode structure of parent directory of the file. - * @dentry contains the dentry structure for file to be unlinked. - * Return 0 if permission is granted. - * @path_unlink: + * + * * @dir contains the inode structure of parent directory of the file. + * * @dentry contains the dentry structure for file to be unlinked. + * * Return %0 if permission is granted. + * + * int path_unlink(const struct path \*dir, struct dentry \*dentry) * Check the permission to remove a hard link to a file. - * @dir contains the path structure of parent directory of the file. - * @dentry contains the dentry structure for file to be unlinked. - * Return 0 if permission is granted. - * @inode_symlink: + * + * * @dir contains the path structure of parent directory of the file. + * * @dentry contains the dentry structure for file to be unlinked. + * * Return %0 if permission is granted. + * + * int inode_symlink(struct inode \*dir, struct dentry \*dentry, const char \*old_name) * Check the permission to create a symbolic link to a file. - * @dir contains the inode structure of parent directory of - * the symbolic link. - * @dentry contains the dentry structure of the symbolic link. - * @old_name contains the pathname of file. - * Return 0 if permission is granted. - * @path_symlink: + * + * * @dir contains the inode structure of parent directory of the symbolic link. + * * @dentry contains the dentry structure of the symbolic link. + * * @old_name contains the pathname of file. + * * Return %0 if permission is granted. + * + * int path_symlink(const struct path \*dir, struct dentry \*dentry, const char \*old_name) * Check the permission to create a symbolic link to a file. - * @dir contains the path structure of parent directory of - * the symbolic link. - * @dentry contains the dentry structure of the symbolic link. - * @old_name contains the pathname of file. - * Return 0 if permission is granted. - * @inode_mkdir: + * + * * @dir contains the path structure of parent directory of the symbolic link. + * * @dentry contains the dentry structure of the symbolic link. + * * @old_name contains the pathname of file. + * * Return %0 if permission is granted. + * + * int inode_mkdir(struct inode \*dir, struct dentry \*dentry, umode_t mode) * Check permissions to create a new directory in the existing directory * associated with inode structure @dir. - * @dir contains the inode structure of parent of the directory - * to be created. - * @dentry contains the dentry structure of new directory. - * @mode contains the mode of new directory. - * Return 0 if permission is granted. - * @path_mkdir: + * + * * @dir contains the inode structure of parent of the directory to be created. + * * @dentry contains the dentry structure of new directory. + * * @mode contains the mode of new directory. + * * Return %0 if permission is granted. + * + * int path_mkdir(const struct path \*dir, struct dentry \*dentry, umode_t mode) * Check permissions to create a new directory in the existing directory * associated with path structure @path. - * @dir contains the path structure of parent of the directory - * to be created. - * @dentry contains the dentry structure of new directory. - * @mode contains the mode of new directory. - * Return 0 if permission is granted. - * @inode_rmdir: + * + * * @dir contains the path structure of parent of the directory to be created. + * * @dentry contains the dentry structure of new directory. + * * @mode contains the mode of new directory. + * * Return %0 if permission is granted. + * + * int inode_rmdir(struct inode \*dir, struct dentry \*dentry) * Check the permission to remove a directory. - * @dir contains the inode structure of parent of the directory - * to be removed. - * @dentry contains the dentry structure of directory to be removed. - * Return 0 if permission is granted. - * @path_rmdir: + * + * * @dir contains the inode structure of parent of the directory to be removed. + * * @dentry contains the dentry structure of directory to be removed. + * * Return %0 if permission is granted. + * + * int path_rmdir(const struct path \*dir, struct dentry \*dentry) * Check the permission to remove a directory. - * @dir contains the path structure of parent of the directory to be - * removed. - * @dentry contains the dentry structure of directory to be removed. - * Return 0 if permission is granted. - * @inode_mknod: + * + * * @dir contains the path structure of parent of the directory to be removed. + * * @dentry contains the dentry structure of directory to be removed. + * * Return %0 if permission is granted. + * + * int inode_mknod(struct inode \*dir, struct dentry \*dentry, umode_t mode, dev_t dev) * Check permissions when creating a special file (or a socket or a fifo - * file created via the mknod system call). Note that if mknod operation + * file created via the @mknod() system call). Note that if mknod operation * is being done for a regular file, then the create hook will be called * and not this hook. - * @dir contains the inode structure of parent of the new file. - * @dentry contains the dentry structure of the new file. - * @mode contains the mode of the new file. - * @dev contains the device number. - * Return 0 if permission is granted. - * @path_mknod: + * + * * @dir contains the inode structure of parent of the new file. + * * @dentry contains the dentry structure of the new file. + * * @mode contains the mode of the new file. + * * @dev contains the device number. + * * Return %0 if permission is granted. + * + * int path_mknod(const struct path \*dir, struct dentry \*dentry, umode_t mode, unsigned int dev) * Check permissions when creating a file. Note that this hook is called * even if mknod operation is being done for a regular file. - * @dir contains the path structure of parent of the new file. - * @dentry contains the dentry structure of the new file. - * @mode contains the mode of the new file. - * @dev contains the undecoded device number. Use new_decode_dev() to get - * the decoded device number. - * Return 0 if permission is granted. - * @inode_rename: + * + * * @dir contains the path structure of parent of the new file. + * * @dentry contains the dentry structure of the new file. + * * @mode contains the mode of the new file. + * * @dev contains the undecoded device number. Use new_decode_dev() to get the decoded device number. + * * Return %0 if permission is granted. + * + * int inode_rename(struct inode \*old_dir, struct dentry \*old_dentry, struct inode \*new_dir, struct dentry \*new_dentry) * Check for permission to rename a file or directory. - * @old_dir contains the inode structure for parent of the old link. - * @old_dentry contains the dentry structure of the old link. - * @new_dir contains the inode structure for parent of the new link. - * @new_dentry contains the dentry structure of the new link. - * Return 0 if permission is granted. - * @path_rename: + * + * * @old_dir contains the inode structure for parent of the old link. + * * @old_dentry contains the dentry structure of the old link. + * * @new_dir contains the inode structure for parent of the new link. + * * @new_dentry contains the dentry structure of the new link. + * * Return %0 if permission is granted. + * + * int path_rename(const struct path \*old_dir, struct dentry \*old_dentry, const struct path \*new_dir, struct dentry \*new_dentry) * Check for permission to rename a file or directory. - * @old_dir contains the path structure for parent of the old link. - * @old_dentry contains the dentry structure of the old link. - * @new_dir contains the path structure for parent of the new link. - * @new_dentry contains the dentry structure of the new link. - * Return 0 if permission is granted. - * @path_chmod: + * + * * @old_dir contains the path structure for parent of the old link. + * * @old_dentry contains the dentry structure of the old link. + * * @new_dir contains the path structure for parent of the new link. + * * @new_dentry contains the dentry structure of the new link. + * * Return %0 if permission is granted. + * + * int path_chmod(const struct path \*path, umode_t mode) * Check for permission to change a mode of the file @path. The new * mode is specified in @mode. - * @path contains the path structure of the file to change the mode. - * @mode contains the new DAC's permission, which is a bitmask of - * constants from - * Return 0 if permission is granted. - * @path_chown: + * + * * @path contains the path structure of the file to change the mode. + * * @mode contains the new DAC's permission, which is a bitmask of constants from + * * Return %0 if permission is granted. + * + * int path_chown(const struct path \*path, kuid_t uid, kgid_t gid) * Check for permission to change owner/group of a file or directory. - * @path contains the path structure. - * @uid contains new owner's ID. - * @gid contains new group's ID. - * Return 0 if permission is granted. - * @path_chroot: + * + * * @path contains the path structure. + * * @uid contains new owner's ID. + * * @gid contains new group's ID. + * * Return %0 if permission is granted. + * + * int path_chroot(const struct path \*path) * Check for permission to change root directory. - * @path contains the path structure. - * Return 0 if permission is granted. - * @path_notify: + * + * * @path contains the path structure. + * * Return %0 if permission is granted. + * + * int path_notify(const struct path \*path, u64 mask, unsigned int obj_type) * Check permissions before setting a watch on events as defined by @mask, * on an object at @path, whose type is defined by @obj_type. - * @inode_readlink: + * + * int inode_readlink(struct dentry \*dentry) * Check the permission to read the symbolic link. - * @dentry contains the dentry structure for the file link. - * Return 0 if permission is granted. - * @inode_follow_link: + * + * * @dentry contains the dentry structure for the file link. + * * Return %0 if permission is granted. + * + * int inode_follow_link(struct dentry \*dentry, struct inode \*inode, bool rcu) * Check permission to follow a symbolic link when looking up a pathname. - * @dentry contains the dentry structure for the link. - * @inode contains the inode, which itself is not stable in RCU-walk - * @rcu indicates whether we are in RCU-walk mode. - * Return 0 if permission is granted. - * @inode_permission: + * + * * @dentry contains the dentry structure for the link. + * * @inode contains the inode, which itself is not stable in RCU-walk + * * @rcu indicates whether we are in RCU-walk mode. + * * Return %0 if permission is granted. + * + * int inode_permission(struct inode \*inode, int mask) * Check permission before accessing an inode. This hook is called by the * existing Linux permission function, so a security module can use it to * provide additional checking for existing Linux permission checks. * Notice that this hook is called when a file is opened (as well as many - * other operations), whereas the file_security_ops permission hook is + * other operations), whereas the @file_security_ops() permission hook is * called when the actual read/write operations are performed. - * @inode contains the inode structure to check. - * @mask contains the permission mask. - * Return 0 if permission is granted. - * @inode_setattr: + * + * * @inode contains the inode structure to check. + * * @mask contains the permission mask. + * * Return %0 if permission is granted. + * + * int inode_setattr(struct dentry \*dentry, struct iattr \*attr) * Check permission before setting file attributes. Note that the kernel - * call to notify_change is performed from several locations, whenever + * call to @notify_change() is performed from several locations, whenever * file attributes change (such as when a file is truncated, chown/chmod * operations, transferring disk quotas, etc). - * @dentry contains the dentry structure for the file. - * @attr is the iattr structure containing the new file attributes. - * Return 0 if permission is granted. - * @path_truncate: + * + * * @dentry contains the dentry structure for the file. + * * @attr is the @iattr structure containing the new file attributes. + * * Return %0 if permission is granted. + * + * int path_truncate(const struct path \*path) * Check permission before truncating a file. - * @path contains the path structure for the file. - * Return 0 if permission is granted. - * @inode_getattr: + * + * * @path contains the path structure for the file. + * * Return %0 if permission is granted. + * + * int inode_getattr(const struct path \*path) * Check permission before obtaining file attributes. - * @path contains the path structure for the file. - * Return 0 if permission is granted. - * @inode_setxattr: + * + * * @path contains the path structure for the file. + * * Return %0 if permission is granted. + * + * int inode_setxattr(struct user_namespace \*mnt_userns, struct dentry \*dentry, const char \*name, const void \*value, size_t size, int flags) * Check permission before setting the extended attributes - * @value identified by @name for @dentry. - * Return 0 if permission is granted. - * @inode_post_setxattr: - * Update inode security field after successful setxattr operation. - * @value identified by @name for @dentry. - * @inode_getxattr: + * + * * @value identified by @name for @dentry. + * * Return %0 if permission is granted. + * + * int inode_post_setxattr(struct dentry \*dentry, const char \*name, const void \*value, size_t size, int flags) + * Update inode security field after successful @setxattr operation. + * + * * @value identified by @name for @dentry. + * + * int inode_getxattr(struct dentry \*dentry, const char \*name) * Check permission before obtaining the extended attributes * identified by @name for @dentry. - * Return 0 if permission is granted. - * @inode_listxattr: + * + * * Return %0 if permission is granted. + * + * int inode_listxattr(struct dentry \*dentry) * Check permission before obtaining the list of extended attribute * names for @dentry. - * Return 0 if permission is granted. - * @inode_removexattr: + * + * * Return %0 if permission is granted. + * + * int inode_removexattr(struct user_namespace \*mnt_userns, struct dentry \*dentry, const char \*name) * Check permission before removing the extended attribute * identified by @name for @dentry. - * Return 0 if permission is granted. - * @inode_getsecurity: + * + * * Return %0 if permission is granted. + * + * int inode_getsecurity(struct user_namespace \*mnt_userns, struct inode \*inode, const char \*name, void \*\*buffer, bool alloc) * Retrieve a copy of the extended attribute representation of the * security label associated with @name for @inode via @buffer. Note that * @name is the remainder of the attribute name after the security prefix * has been removed. @alloc is used to specify of the call should return a * value via the buffer or just the value length Return size of buffer on * success. - * @inode_setsecurity: + * + * int inode_setsecurity(struct inode \*inode, const char \*name, const void \*value, size_t size, int flags) * Set the security label associated with @name for @inode from the * extended attribute value @value. @size indicates the size of the - * @value in bytes. @flags may be XATTR_CREATE, XATTR_REPLACE, or 0. + * @value in bytes. @flags may be %XATTR_CREATE, %XATTR_REPLACE, or %0. * Note that @name is the remainder of the attribute name after the * security. prefix has been removed. - * Return 0 on success. - * @inode_listsecurity: + * + * * Return %0 on success. + * + * int inode_listsecurity(struct inode \*inode, char \*buffer, size_t buffer_size) * Copy the extended attribute names for the security labels * associated with @inode into @buffer. The maximum size of @buffer - * is specified by @buffer_size. @buffer may be NULL to request + * is specified by @buffer_size. @buffer may be %NULL to request * the size of the buffer required. - * Returns number of bytes used/required on success. - * @inode_need_killpriv: + * + * * Returns number of bytes used/required on success. + * + * int inode_need_killpriv(struct dentry \*dentry) * Called when an inode has been changed. - * @dentry is the dentry being changed. - * Return <0 on error to abort the inode change operation. - * Return 0 if inode_killpriv does not need to be called. - * Return >0 if inode_killpriv does need to be called. - * @inode_killpriv: - * The setuid bit is being removed. Remove similar security labels. - * Called with the dentry->d_inode->i_mutex held. - * @mnt_userns: user namespace of the mount - * @dentry is the dentry being changed. - * Return 0 on success. If error is returned, then the operation - * causing setuid bit removal is failed. - * @inode_getsecid: - * Get the secid associated with the node. - * @inode contains a pointer to the inode. - * @secid contains a pointer to the location where result will be saved. - * In case of failure, @secid will be set to zero. - * @inode_copy_up: + * + * * @dentry is the dentry being changed. + * * Return %<0 on error to abort the inode change operation. + * * Return %0 if @inode_killpriv() does not need to be called. + * * Return %>0 if @inode_killpriv() does need to be called. + * + * int inode_killpriv(struct user_namespace \*mnt_userns, struct dentry \*dentry) + * The %setuid bit is being removed. Remove similar security labels. + * Called with the @dentry->d_inode->i_mutex held. + * + * * @mnt_userns: user namespace of the mount + * * @dentry is the dentry being changed. + * * Return %0 on success. + * * If error is returned, then the operation causing %setuid bit removal is failed. + * + * void inode_getsecid(struct inode \*inode, u32 \*secid) + * Get the %secid associated with the node. + * + * * @inode contains a pointer to the inode. + * * @secid contains a pointer to the location where result will be saved. + * * In case of failure, @secid will be set to zero. + * + * int inode_copy_up(struct dentry \*src, struct cred \*\*new) * A file is about to be copied up from lower layer to upper layer of * overlay filesystem. Security module can prepare a set of new creds * and modify as need be and return new creds. Caller will switch to * new creds temporarily to create new file and release newly allocated * creds. - * @src indicates the union dentry of file that is being copied up. - * @new pointer to pointer to return newly allocated creds. - * Returns 0 on success or a negative error code on error. - * @inode_copy_up_xattr: + * + * * @src indicates the union @dentry of file that is being copied up. + * * @new pointer to pointer to return newly allocated creds. + * * Returns %0 on success or a negative error code on error. + * + * int inode_copy_up_xattr(const char \*name) * Filter the xattrs being copied up when a unioned file is copied * up from a lower layer to the union/overlay layer. - * @name indicates the name of the xattr. - * Returns 0 to accept the xattr, 1 to discard the xattr, -EOPNOTSUPP if - * security module does not know about attribute or a negative error code - * to abort the copy up. Note that the caller is responsible for reading - * and writing the xattrs as this hook is merely a filter. - * @d_instantiate: + * Note that the caller is responsible for reading and writing the + * xattrs as this hook is merely a filter. + * + * * @name indicates the name of the xattr. + * * Returns %0 to accept the xattr, + * * Returns %1 to discard the xattr, + * * Returns %-EOPNOTSUPP if security module does not know about attribute or a negative error code to abort the copy up. + * + * void d_instantiate(struct dentry \*dentry, struct inode \*inode) * Fill in @inode security information for a @dentry if allowed. - * @getprocattr: + * + * int getprocattr(struct task_struct \*p, char \*name, char \*\*value) * Read attribute @name for process @p and store it into @value if allowed. - * @setprocattr: + * + * int setprocattr(const char \*name, void \*value, size_t size) * Write (set) attribute @name to @value, size @size if allowed. * - * Security hooks for kernfs node operations + * **Security hooks for kernfs node operations:** * - * @kernfs_init_security: - * Initialize the security context of a newly created kernfs node based + * int kernfs_init_security(struct kernfs_node \*kn_dir, struct kernfs_node \*kn) + * Initialize the security context of a newly created @kernfs node based * on its own and its parent's attributes. * - * @kn_dir the parent kernfs node - * @kn the new child kernfs node + * * @kn_dir the parent kernfs node + * * @kn the new child kernfs node * - * Security hooks for file operations + * **Security hooks for file operations:** * - * @file_permission: + * int file_permission(struct file \*file, int mask) * Check file permissions before accessing an open file. This hook is * called by various operations that read or write files. A security * module can use this hook to perform additional checking on these * operations, e.g. to revalidate permissions on use to support privilege * bracketing or policy changes. Notice that this hook is used when the * actual read/write operations are performed, whereas the - * inode_security_ops hook is called when a file is opened (as well as + * @inode_security_ops() hook is called when a file is opened (as well as * many other operations). * Caveat: Although this hook can be used to revalidate permissions for * various system call operations that read or write files, it does not * address the revalidation of permissions for memory-mapped files. * Security modules must handle this separately if they need such * revalidation. - * @file contains the file structure being accessed. - * @mask contains the requested permissions. - * Return 0 if permission is granted. - * @file_alloc_security: - * Allocate and attach a security structure to the file->f_security field. - * The security field is initialized to NULL when the structure is first + * + * * @file contains the file structure being accessed. + * * @mask contains the requested permissions. + * * Return %0 if permission is granted. + * + * int file_alloc_security(struct file \*file) + * Allocate and attach a security structure to the @file->f_security field. + * The security field is initialized to %NULL when the structure is first * created. - * @file contains the file structure to secure. - * Return 0 if the hook is successful and permission is granted. - * @file_free_security: - * Deallocate and free any security structures stored in file->f_security. + * + * * @file contains the file structure to secure. + * * Return %0 if the hook is successful and permission is granted. + * + * void file_free_security(struct file \*file) + * Deallocate and free any security structures stored in @file->f_security. + * * @file contains the file structure being modified. - * @file_ioctl: - * @file contains the file structure. - * @cmd contains the operation to perform. - * @arg contains the operational arguments. + * + * int file_ioctl(struct file \*file, unsigned int cmd, unsigned long arg) * Check permission for an ioctl operation on @file. Note that @arg * sometimes represents a user space pointer; in other cases, it may be a * simple integer value. When @arg represents a user space pointer, it * should never be used by the security module. - * Return 0 if permission is granted. - * @mmap_addr : + * + * * @file contains the file structure. + * * @cmd contains the operation to perform. + * * @arg contains the operational arguments. + * * Return %0 if permission is granted. + * + * int mmap_addr(unsigned long addr) * Check permissions for a mmap operation at @addr. - * @addr contains virtual address that will be used for the operation. - * Return 0 if permission is granted. - * @mmap_file : - * Check permissions for a mmap operation. The @file may be NULL, e.g. + * + * * @addr contains virtual address that will be used for the operation. + * * Return %0 if permission is granted. + * + * int mmap_file(struct file \*file, unsigned long reqprot, unsigned long prot, unsigned long flags) + * Check permissions for a @mmap operation. The @file may be %NULL, e.g. * if mapping anonymous memory. - * @file contains the file structure for file to map (may be NULL). - * @reqprot contains the protection requested by the application. - * @prot contains the protection that will be applied by the kernel. - * @flags contains the operational flags. - * Return 0 if permission is granted. - * @file_mprotect: + * + * * @file contains the file structure for file to map (may be %NULL). + * * @reqprot contains the protection requested by the application. + * * @prot contains the protection that will be applied by the kernel. + * * @flags contains the operational flags. + * * Return %0 if permission is granted. + * + * int file_mprotect(struct vm_area_struct \*vma, unsigned long reqprot, unsigned long prot) * Check permissions before changing memory access permissions. - * @vma contains the memory region to modify. - * @reqprot contains the protection requested by the application. - * @prot contains the protection that will be applied by the kernel. - * Return 0 if permission is granted. - * @file_lock: + * + * * @vma contains the memory region to modify. + * * @reqprot contains the protection requested by the application. + * * @prot contains the protection that will be applied by the kernel. + * * Return %0 if permission is granted. + * + * int file_lock(struct file \*file, unsigned int cmd) * Check permission before performing file locking operations. * Note the hook mediates both flock and fcntl style locks. - * @file contains the file structure. - * @cmd contains the posix-translated lock operation to perform - * (e.g. F_RDLCK, F_WRLCK). - * Return 0 if permission is granted. - * @file_fcntl: + * + * * @file contains the file structure. + * * @cmd contains the posix-translated lock operation to perform (e.g. %F_RDLCK, %F_WRLCK). + * * Return %0 if permission is granted. + * + * int file_fcntl(struct file \*file, unsigned int cmd, unsigned long arg) * Check permission before allowing the file operation specified by @cmd * from being performed on the file @file. Note that @arg sometimes * represents a user space pointer; in other cases, it may be a simple * integer value. When @arg represents a user space pointer, it should * never be used by the security module. - * @file contains the file structure. - * @cmd contains the operation to be performed. - * @arg contains the operational arguments. - * Return 0 if permission is granted. - * @file_set_fowner: - * Save owner security information (typically from current->security) in - * file->f_security for later use by the send_sigiotask hook. - * @file contains the file structure to update. - * Return 0 on success. - * @file_send_sigiotask: - * Check permission for the file owner @fown to send SIGIO or SIGURG to the + * + * * @file contains the file structure. + * * @cmd contains the operation to be performed. + * * @arg contains the operational arguments. + * * Return %0 if permission is granted. + * + * void file_set_fowner(struct file \*file) + * Save owner security information (typically from @current->security) in + * @file->f_security for later use by the @send_sigiotask() hook. + * + * * @file contains the file structure to update. + * + * int file_send_sigiotask(struct task_struct \*tsk, struct fown_struct \*fown, int sig) + * Check permission for the file owner @fown to send %SIGIO or %SIGURG to the * process @tsk. Note that this hook is sometimes called from interrupt. - * Note that the fown_struct, @fown, is never outside the context of a + * Note that the @fown_struct, @fown, is never outside the context of a * struct file, so the file structure (and associated security information) * can always be obtained: container_of(fown, struct file, f_owner) - * @tsk contains the structure of task receiving signal. - * @fown contains the file owner information. - * @sig is the signal that will be sent. When 0, kernel sends SIGIO. - * Return 0 if permission is granted. - * @file_receive: + * + * * @tsk contains the structure of task receiving signal. + * * @fown contains the file owner information. + * * @sig is the signal that will be sent. When 0, kernel sends %SIGIO. + * * Return %0 if permission is granted. + * + * int file_receive(struct file \*file) * This hook allows security modules to control the ability of a process * to receive an open file descriptor via socket IPC. - * @file contains the file structure being received. - * Return 0 if permission is granted. - * @file_open: + * + * * @file contains the file structure being received. + * * Return %0 if permission is granted. + * + * int file_open(struct file \*file) * Save open-time permission checking state for later use upon - * file_permission, and recheck access if anything has changed - * since inode_permission. + * @file_permission(), and recheck access if anything has changed + * since @inode_permission(). * - * Security hooks for task operations. + * **Security hooks for task operations:** * - * @task_alloc: - * @task task being allocated. - * @clone_flags contains the flags indicating what should be shared. + * int task_alloc(struct task_struct \*task, unsigned long clone_flags) * Handle allocation of task-related resources. - * Returns a zero on success, negative values on failure. - * @task_free: - * @task task about to be freed. + * + * * @task task being allocated. + * * @clone_flags contains the flags indicating what should be shared. + * * Returns a zero on success, negative values on failure. + * + * void task_free(struct task_struct \*task) * Handle release of task-related resources. (Note that this can be called * from interrupt context.) - * @cred_alloc_blank: - * @cred points to the credentials. - * @gfp indicates the atomicity of any memory allocations. + * + * * @task task about to be freed. + * + * int cred_alloc_blank(struct cred \*cred, gfp_t gfp) * Only allocate sufficient memory and attach to @cred such that - * cred_transfer() will not get ENOMEM. - * @cred_free: - * @cred points to the credentials. - * Deallocate and clear the cred->security field in a set of credentials. - * @cred_prepare: - * @new points to the new credentials. - * @old points to the original credentials. - * @gfp indicates the atomicity of any memory allocations. + * @cred_transfer() will not get %ENOMEM. + * + * * @cred points to the credentials. + * * @gfp indicates the atomicity of any memory allocations. + * + * void cred_free(struct cred \*cred) + * Deallocate and clear the @cred->security field in a set of credentials. + * + * * @cred points to the credentials. + * + * int cred_prepare(struct cred \*new, const struct cred \*old, gfp_t gfp) * Prepare a new set of credentials by copying the data from the old set. - * @cred_transfer: - * @new points to the new credentials. - * @old points to the original credentials. + * + * * @new points to the new credentials. + * * @old points to the original credentials. + * * @gfp indicates the atomicity of any memory allocations. + * + * void cred_transfer(cred_transfer, struct cred \*new, const struct cred \*old) * Transfer data from original creds to new creds - * @cred_getsecid: + * + * * @new points to the new credentials. + * * @old points to the original credentials. + * + * void cred_getsecid(const struct cred \*c, u32 \*secid) * Retrieve the security identifier of the cred structure @c * @c contains the credentials, secid will be placed into @secid. * In case of failure, @secid will be set to zero. - * @kernel_act_as: + * + * int kernel_act_as(struct cred \*new, u32 secid) * Set the credentials for a kernel service to act as (subjective context). - * @new points to the credentials to be modified. - * @secid specifies the security ID to be set * The current task must be the one that nominated @secid. - * Return 0 if successful. - * @kernel_create_files_as: + * + * * @new points to the credentials to be modified. + * * @secid specifies the security ID to be set + * * Return %0 if successful. + * + * int kernel_create_files_as(struct cred \*new, struct inode \*inode) * Set the file creation context in a set of credentials to be the same as * the objective context of the specified inode. - * @new points to the credentials to be modified. - * @inode points to the inode to use as a reference. * The current task must be the one that nominated @inode. - * Return 0 if successful. - * @kernel_module_request: + * + * * @new points to the credentials to be modified. + * * @inode points to the inode to use as a reference. + * * Return %0 if successful. + * + * int kernel_module_request(char \*kmod_name) * Ability to trigger the kernel to automatically upcall to userspace for * userspace to load a kernel module with the given name. - * @kmod_name name of the module requested by the kernel - * Return 0 if successful. - * @kernel_load_data: + * + * * @kmod_name name of the module requested by the kernel + * * Return %0 if successful. + * + * int kernel_load_data(enum kernel_load_data_id id, bool contents) * Load data provided by userspace. - * @id kernel load data identifier - * @contents if a subsequent @kernel_post_load_data will be called. - * Return 0 if permission is granted. - * @kernel_post_load_data: + * + * * @id kernel load data identifier + * * @contents if a subsequent @kernel_post_load_data will be called. + * * Return %0 if permission is granted. + * + * int kernel_post_load_data(char \*buf, loff_t size, enum kernel_load_data_id id, char \*description) * Load data provided by a non-file source (usually userspace buffer). - * @buf pointer to buffer containing the data contents. - * @size length of the data contents. - * @id kernel load data identifier - * @description a text description of what was loaded, @id-specific - * Return 0 if permission is granted. * This must be paired with a prior @kernel_load_data call that had * @contents set to true. - * @kernel_read_file: + * + * * @buf pointer to buffer containing the data contents. + * * @size length of the data contents. + * * @id kernel load data identifier + * * @description a text description of what was loaded, id-specific + * * Return %0 if permission is granted. + * + * int kernel_read_file(struct file \*file, enum kernel_read_file_id id, bool contents) * Read a file specified by userspace. - * @file contains the file structure pointing to the file being read - * by the kernel. - * @id kernel read file identifier - * @contents if a subsequent @kernel_post_read_file will be called. - * Return 0 if permission is granted. - * @kernel_post_read_file: + * + * * @file contains the file structure pointing to the file being read by the kernel. + * * @id kernel read file identifier + * * @contents if a subsequent @kernel_post_read_file will be called. + * * Return %0 if permission is granted. + * + * int kernel_post_read_file(struct file \*file, char \*buf, loff_t size, enum kernel_read_file_id id) * Read a file specified by userspace. - * @file contains the file structure pointing to the file being read - * by the kernel. - * @buf pointer to buffer containing the file contents. - * @size length of the file contents. - * @id kernel read file identifier - * This must be paired with a prior @kernel_read_file call that had - * @contents set to true. - * Return 0 if permission is granted. - * @task_fix_setuid: + * + * * @file contains the file structure pointing to the file being read by the kernel. + * * @buf pointer to buffer containing the file contents. + * * @size length of the file contents. + * * @id kernel read file identifier. This must be paired with a prior @kernel_read_file() call that had @contents set to true. + * * Return %0 if permission is granted. + * + * int task_fix_setuid(struct cred \*new, const struct cred \*old, int flags) * Update the module's state after setting one or more of the user * identity attributes of the current process. The @flags parameter * indicates which of the set*uid system calls invoked this hook. If * @new is the set of credentials that will be installed. Modifications * should be made to this rather than to @current->cred. * @old is the set of credentials that are being replaces - * @flags contains one of the LSM_SETID_* values. - * Return 0 on success. - * @task_fix_setgid: + * @flags contains one of the %LSM_SETID_\* values. + * + * * Return %0 on success. + * + * int task_fix_setgid(struct cred \*new, const struct cred \*old, int flags) * Update the module's state after setting one or more of the group * identity attributes of the current process. The @flags parameter - * indicates which of the set*gid system calls invoked this hook. - * @new is the set of credentials that will be installed. Modifications - * should be made to this rather than to @current->cred. - * @old is the set of credentials that are being replaced. - * @flags contains one of the LSM_SETID_* values. - * Return 0 on success. - * @task_setpgid: + * indicates which of the set\*gid() system calls invoked this hook. + * + * * @new is the set of credentials that will be installed. Modifications should be made to this rather than to @current->cred. + * * @old is the set of credentials that are being replaced. + * * @flags contains one of the %LSM_SETID_\* values. + * * Return %0 on success. + * + * int task_setpgid(struct task_struct \*p, pid_t pgid) * Check permission before setting the process group identifier of the * process @p to @pgid. - * @p contains the task_struct for process being modified. - * @pgid contains the new pgid. - * Return 0 if permission is granted. - * @task_getpgid: + * + * * @p contains the task_struct for process being modified. + * * @pgid contains the new @pgid. + * * Return %0 if permission is granted. + * + * int task_getpgid(struct task_struct \*p) * Check permission before getting the process group identifier of the * process @p. - * @p contains the task_struct for the process. - * Return 0 if permission is granted. - * @task_getsid: + * + * * @p contains the task_struct for the process. + * * Return %0 if permission is granted. + * + * int task_getsid(struct task_struct \*p) * Check permission before getting the session identifier of the process * @p. - * @p contains the task_struct for the process. - * Return 0 if permission is granted. - * @task_getsecid: + * + * * @p contains the task_struct for the process. + * * Return %0 if permission is granted. + * + * void task_getsecid(struct task_struct \*p, u32 \*secid) * Retrieve the security identifier of the process @p. - * @p contains the task_struct for the process and place is into @secid. - * In case of failure, @secid will be set to zero. * - * @task_setnice: + * * @p contains the task_struct for the process and place is into @secid. + * * In case of failure, @secid will be set to zero. + * + * int task_setnice(struct task_struct \*p, int nice) * Check permission before setting the nice value of @p to @nice. - * @p contains the task_struct of process. - * @nice contains the new nice value. - * Return 0 if permission is granted. - * @task_setioprio: + * + * * @p contains the task_struct of process. + * * @nice contains the new nice value. + * * Return %0 if permission is granted. + * + * int task_setioprio(struct task_struct \*p, int ioprio) * Check permission before setting the ioprio value of @p to @ioprio. - * @p contains the task_struct of process. - * @ioprio contains the new ioprio value - * Return 0 if permission is granted. - * @task_getioprio: + * + * * @p contains the task_struct of process. + * * @ioprio contains the new @ioprio value + * * Return %0 if permission is granted. + * + * int task_getioprio(struct task_struct \*p) * Check permission before getting the ioprio value of @p. - * @p contains the task_struct of process. - * Return 0 if permission is granted. - * @task_prlimit: + * + * * @p contains the task_struct of process. + * * Return %0 if permission is granted. + * + * int task_prlimit(const struct cred \*cred, const struct cred \*tcred, unsigned int flags) * Check permission before getting and/or setting the resource limits of * another task. - * @cred points to the cred structure for the current task. - * @tcred points to the cred structure for the target task. - * @flags contains the LSM_PRLIMIT_* flag bits indicating whether the - * resource limits are being read, modified, or both. - * Return 0 if permission is granted. - * @task_setrlimit: + * + * * @cred points to the @cred structure for the current task. + * * @tcred points to the @cred structure for the target task. + * * @flags contains the %LSM_PRLIMIT_\* flag bits indicating whether the resource limits are being read, modified, or both. + * * Return %0 if permission is granted. + * + * int task_setrlimit(struct task_struct \*p, unsigned int resource, struct rlimit \*new_rlim) * Check permission before setting the resource limits of process @p * for @resource to @new_rlim. The old resource limit values can * be examined by dereferencing (p->signal->rlim + resource). - * @p points to the task_struct for the target task's group leader. - * @resource contains the resource whose limit is being set. - * @new_rlim contains the new limits for @resource. - * Return 0 if permission is granted. - * @task_setscheduler: + * + * * @p points to the task_struct for the target task's group leader. + * * @resource contains the resource whose limit is being set. + * * @new_rlim contains the new limits for @resource. + * * Return %0 if permission is granted. + * + * int task_setscheduler(struct task_struct \*p) * Check permission before setting scheduling policy and/or parameters of * process @p. - * @p contains the task_struct for process. - * Return 0 if permission is granted. - * @task_getscheduler: + * + * * @p contains the task_struct for process. + * * Return %0 if permission is granted. + * + * int task_getscheduler(struct task_struct \*p) * Check permission before obtaining scheduling information for process * @p. - * @p contains the task_struct for process. - * Return 0 if permission is granted. - * @task_movememory: + * + * * @p contains the task_struct for process. + * * Return %0 if permission is granted. + * + * int task_movememory(struct task_struct \*p) * Check permission before moving memory owned by process @p. - * @p contains the task_struct for process. - * Return 0 if permission is granted. - * @task_kill: - * Check permission before sending signal @sig to @p. @info can be NULL, - * the constant 1, or a pointer to a kernel_siginfo structure. If @info is 1 or + * + * * @p contains the task_struct for process. + * * Return %0 if permission is granted. + * + * int task_kill(struct task_struct \*p, struct kernel_siginfo \*info, int sig, const struct cred \*cred) + * Check permission before sending signal @sig to @p. @info can be %NULL, + * the constant %1, or a pointer to a @kernel_siginfo structure. If @info is %1 or * SI_FROMKERNEL(info) is true, then the signal should be viewed as coming * from the kernel and should typically be permitted. - * SIGIO signals are handled separately by the send_sigiotask hook in - * file_security_ops. - * @p contains the task_struct for process. - * @info contains the signal information. - * @sig contains the signal value. - * @cred contains the cred of the process where the signal originated, or - * NULL if the current task is the originator. - * Return 0 if permission is granted. + * %SIGIO signals are handled separately by the @send_sigiotask() hook in + * @file_security_ops(). + * + * * @p contains the task_struct for process. + * * @info contains the signal information. + * * @sig contains the signal value. + * * @cred contains the cred of the process where the signal originated, or %NULL if the current task is the originator. + * * Return %0 if permission is granted. * @task_prctl: * Check permission before performing a process control operation on the * current process. From patchwork Tue Mar 9 14:39:53 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Richard Haines X-Patchwork-Id: 12125491 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-18.8 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_CR_TRAILER, INCLUDES_PATCH,MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id 55BC1C43381 for ; Tue, 9 Mar 2021 14:46:11 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id EBEE16523A for ; Tue, 9 Mar 2021 14:46:10 +0000 (UTC) Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S231571AbhCIOpj (ORCPT ); Tue, 9 Mar 2021 09:45:39 -0500 Received: from mailomta11-sa.btinternet.com ([213.120.69.17]:55243 "EHLO sa-prd-fep-046.btinternet.com" rhost-flags-OK-OK-OK-FAIL) by vger.kernel.org with ESMTP id S231634AbhCIOpb (ORCPT ); Tue, 9 Mar 2021 09:45:31 -0500 Received: from sa-prd-rgout-002.btmx-prd.synchronoss.net ([10.2.38.5]) by sa-prd-fep-048.btinternet.com with ESMTP id <20210309144006.DASK760.sa-prd-fep-048.btinternet.com@sa-prd-rgout-002.btmx-prd.synchronoss.net>; Tue, 9 Mar 2021 14:40:06 +0000 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=btinternet.com; s=btmx201904; t=1615300806; bh=Zk2bK93qcw8teNqSosr9yQUpTUZJ6610DCnpIkUyUs8=; h=From:To:Cc:Subject:Date:Message-Id:X-Mailer:In-Reply-To:References:MIME-Version; b=ArwWY+p2/DBfBrGO33vX8r6K/CajW/QxL1UxRDe4mXpDC7s75iCoiLOVfuE4enfq2NcdgFoBrYiMIJuX0cZ9VnDhyA5W6foeSlyBwCsPndVk5GCj+2h0fRweOLtUvxnLQ1U3d/tWtOKdImfxhRZIMl0FjYvrgmb6ToQWYA/mi51HPBd7owJ1Rmygj9OfQ/9cGMuH/kuthp19fj4GUY4XTWD2ugUJr/Y2T76bVegOxeWOIXcRSqNDsRzWg631BJ7tDIuTpnSISH8yTRSzoL/dH5mdo2Q6LBef7JLej1zi9bQ7cWKrPAeeQxpwOKecuXCQjgi2qTg8okfJbPupLjq4pg== Authentication-Results: btinternet.com; none X-SNCR-Rigid: 6038718301A653D1 X-Originating-IP: [86.133.207.84] X-OWM-Source-IP: 86.133.207.84 (GB) X-OWM-Env-Sender: richard_c_haines@btinternet.com X-VadeSecure-score: verdict=clean score=0/300, class=clean X-RazorGate-Vade: gggruggvucftvghtrhhoucdtuddrgeduledrudduiedgieejucetufdoteggodetrfdotffvucfrrhhofhhilhgvmecuueftkffvkffujffvgffngfevqffopdfqfgfvnecuuegrihhlohhuthemuceftddunecunecujfgurhephffvufffkffojghfggfgsedtkeertdertddtnecuhfhrohhmpeftihgthhgrrhguucfjrghinhgvshcuoehrihgthhgrrhgupggtpghhrghinhgvshessghtihhnthgvrhhnvghtrdgtohhmqeenucggtffrrghtthgvrhhnpeeutddtleelheeugefgiefhiedtheeukeffveeitdffgeffieeugeeljeegvefgieenucfkphepkeeirddufeefrddvtdejrdekgeenucevlhhushhtvghrufhiiigvpedtnecurfgrrhgrmhephhgvlhhopehlohgtrghlhhhoshhtrdhlohgtrghlughomhgrihhnpdhinhgvthepkeeirddufeefrddvtdejrdekgedpmhgrihhlfhhrohhmpeeorhhitghhrghruggptggphhgrihhnvghssegsthhinhhtvghrnhgvthdrtghomheqpdhrtghpthhtohepoegtrghsvgihsehstghhrghufhhlvghrqdgtrgdrtghomheqpdhrtghpthhtohepoegtohhrsggvtheslhifnhdrnhgvtheqpdhrtghpthhtohepoehjmhhorhhrihhssehnrghmvghirdhorhhgqedprhgtphhtthhopeeolhhinhhugidqughotgesvhhgvghrrdhkvghrnhgvlhdrohhrgheqpdhrtghpthhtohepoehlihhnuhigqdhsvggtuhhrihhthidqmhhoughulhgvsehvghgvrhdrkhgvrhhn vghlrdhorhhgqedprhgtphhtthhopeeophgruhhlsehprghulhdqmhhoohhrvgdrtghomheqpdhrtghpthhtohepoehrihgthhgrrhgupggtpghhrghinhgvshessghtihhnthgvrhhnvghtrdgtohhmqecuqfftvefrvfeprhhftgekvddvnehrihgthhgrrhgupggtpghhrghinhgvshessghtihhnthgvrhhnvghtrdgtohhmpdhrtghpthhtohepoehsvghrghgvsehhrghllhihnhdrtghomheq X-RazorGate-Vade-Verdict: clean 0 X-RazorGate-Vade-Classification: clean X-SNCR-hdrdom: btinternet.com Received: from localhost.localdomain (86.133.207.84) by sa-prd-rgout-002.btmx-prd.synchronoss.net (5.8.340) (authenticated as richard_c_haines@btinternet.com) id 6038718301A653D1; Tue, 9 Mar 2021 14:40:05 +0000 From: Richard Haines To: linux-security-module@vger.kernel.org, linux-doc@vger.kernel.org Cc: corbet@lwn.net, paul@paul-moore.com, jmorris@namei.org, serge@hallyn.com, casey@schaufler-ca.com, Richard Haines Subject: [RFC PATCH 3/3] include/linux: Update LSM hook text part2 Date: Tue, 9 Mar 2021 14:39:53 +0000 Message-Id: <20210309143953.142341-4-richard_c_haines@btinternet.com> X-Mailer: git-send-email 2.29.2 In-Reply-To: <20210309143953.142341-1-richard_c_haines@btinternet.com> References: <20210309143953.142341-1-richard_c_haines@btinternet.com> MIME-Version: 1.0 Precedence: bulk List-ID: No hook definitions have been updated, only formatting to render in kernel_docs. Signed-off-by: Richard Haines --- include/linux/lsm_hooks.h | 1192 +++++++++++++++++++++---------------- 1 file changed, 683 insertions(+), 509 deletions(-) diff --git a/include/linux/lsm_hooks.h b/include/linux/lsm_hooks.h index b7fdab1e9..75f97c5b9 100644 --- a/include/linux/lsm_hooks.h +++ b/include/linux/lsm_hooks.h @@ -950,71 +950,79 @@ * * @sig contains the signal value. * * @cred contains the cred of the process where the signal originated, or %NULL if the current task is the originator. * * Return %0 if permission is granted. - * @task_prctl: + * + * int task_prctl(int option, unsigned long arg2, unsigned long arg3, unsigned long arg4, unsigned long arg5) * Check permission before performing a process control operation on the * current process. - * @option contains the operation. - * @arg2 contains a argument. - * @arg3 contains a argument. - * @arg4 contains a argument. - * @arg5 contains a argument. - * Return -ENOSYS if no-one wanted to handle this op, any other value to - * cause prctl() to return immediately with that value. - * @task_to_inode: + * + * * @option contains the operation. + * * @arg2 contains a argument. + * * @arg3 contains a argument. + * * @arg4 contains a argument. + * * @arg5 contains a argument. + * * Return %-ENOSYS if no-one wanted to handle this op, any other value to cause @prctl() to return immediately with that value. + * + * void task_to_inode(struct task_struct \*p, struct inode \*inode) * Set the security attributes for an inode based on an associated task's * security attributes, e.g. for /proc/pid inodes. - * @p contains the task_struct for the task. - * @inode contains the inode structure for the inode. * - * Security hooks for Netlink messaging. + * * @p contains the task_struct for the task. + * * @inode contains the inode structure for the inode. + * + * **Security hooks for Netlink messaging:** * - * @netlink_send: + * int netlink_send(struct sock \*sk, struct sk_buff \*skb) * Save security information for a netlink message so that permission * checking can be performed when the message is processed. The security - * information can be saved using the eff_cap field of the - * netlink_skb_parms structure. Also may be used to provide fine + * information can be saved using the %eff_cap field of the + * @netlink_skb_parms structure. Also may be used to provide fine * grained control over message transmission. - * @sk associated sock of task sending the message. - * @skb contains the sk_buff structure for the netlink message. - * Return 0 if the information was successfully saved and message - * is allowed to be transmitted. * - * Security hooks for Unix domain networking. + * * @sk associated sock of task sending the message. + * * @skb contains the sk_buff structure for the netlink message. + * * Return %0 if the information was successfully saved and message is allowed to be transmitted. * - * @unix_stream_connect: + * **Security hooks for Unix domain networking:** + * + * int unix_stream_connect(struct sock \*sock, struct sock \*other, struct sock \*newsk) * Check permissions before establishing a Unix domain stream connection * between @sock and @other. - * @sock contains the sock structure. - * @other contains the peer sock structure. - * @newsk contains the new sock structure. - * Return 0 if permission is granted. - * @unix_may_send: + * + * * @sock contains the sock structure. + * * @other contains the peer sock structure. + * * @newsk contains the new sock structure. + * * Return %0 if permission is granted. + * + * int unix_may_send(struct socket \*sock, struct socket \*other) * Check permissions before connecting or sending datagrams from @sock to * @other. - * @sock contains the socket structure. - * @other contains the peer socket structure. - * Return 0 if permission is granted. * - * The @unix_stream_connect and @unix_may_send hooks were necessary because + * * @sock contains the socket structure. + * * @other contains the peer socket structure. + * * Return %0 if permission is granted. + * + * The @unix_stream_connect() and @unix_may_send() hooks were necessary because * Linux provides an alternative to the conventional file name space for Unix * domain sockets. Whereas binding and connecting to sockets in the file name - * space is mediated by the typical file permissions (and caught by the mknod - * and permission hooks in inode_security_ops), binding and connecting to + * space is mediated by the typical file permissions (and caught by the @mknod + * and permission hooks in @inode_security_ops()), binding and connecting to * sockets in the abstract name space is completely unmediated. Sufficient * control of Unix domain sockets in the abstract name space isn't possible * using only the socket layer hooks, since we need to know the actual target - * socket, which is not looked up until we are inside the af_unix code. + * socket, which is not looked up until we are inside the @af_unix code. * - * Security hooks for socket operations. + * **Security hooks for socket operations:** * - * @socket_create: + * int socket_create(int family, int type, int protocol, int kern) * Check permissions prior to creating a new socket. - * @family contains the requested protocol family. - * @type contains the requested communications type. - * @protocol contains the requested protocol. - * @kern set to 1 if a kernel socket. - * Return 0 if permission is granted. - * @socket_post_create: + * + * * @family contains the requested protocol family. + * * @type contains the requested communications type. + * * @protocol contains the requested protocol. + * * @kern set to %1 if a kernel socket. + * * Return %0 if permission is granted. + * + * int socket_post_create(struct socket \*sock, int family, int type, int protocol, int kern) * This hook allows a module to update or allocate a per-socket security * structure. Note that the security field was not added directly to the * socket structure, but rather, the socket security information is stored @@ -1023,706 +1031,872 @@ * SOCK_INODE(sock)->i_security. This hook may be used to update the * SOCK_INODE(sock)->i_security field with additional information that * wasn't available when the inode was allocated. - * @sock contains the newly created socket structure. - * @family contains the requested protocol family. - * @type contains the requested communications type. - * @protocol contains the requested protocol. - * @kern set to 1 if a kernel socket. - * @socket_socketpair: + * + * * @sock contains the newly created socket structure. + * * @family contains the requested protocol family. + * * @type contains the requested communications type. + * * @protocol contains the requested protocol. + * * @kern set to %1 if a kernel socket. + * + * int socket_socketpair(struct socket \*socka, struct socket \*sockb) * Check permissions before creating a fresh pair of sockets. - * @socka contains the first socket structure. - * @sockb contains the second socket structure. - * Return 0 if permission is granted and the connection was established. - * @socket_bind: + * + * * @socka contains the first socket structure. + * * @sockb contains the second socket structure. + * * Return %0 if permission is granted and the connection was established. + * + * int socket_bind(struct socket \*sock, struct sockaddr \*address, int addrlen) * Check permission before socket protocol layer bind operation is * performed and the socket @sock is bound to the address specified in the * @address parameter. - * @sock contains the socket structure. - * @address contains the address to bind to. - * @addrlen contains the length of address. - * Return 0 if permission is granted. - * @socket_connect: + * + * * @sock contains the socket structure. + * * @address contains the address to bind to. + * * @addrlen contains the length of address. + * * Return %0 if permission is granted. + * + * int socket_connect(struct socket \*sock, struct sockaddr \*address, int addrlen) * Check permission before socket protocol layer connect operation * attempts to connect socket @sock to a remote address, @address. - * @sock contains the socket structure. - * @address contains the address of remote endpoint. - * @addrlen contains the length of address. - * Return 0 if permission is granted. - * @socket_listen: + * + * * @sock contains the socket structure. + * * @address contains the address of remote endpoint. + * * @addrlen contains the length of address. + * * Return %0 if permission is granted. + * + * int socket_listen(struct socket \*sock, int backlog) * Check permission before socket protocol layer listen operation. - * @sock contains the socket structure. - * @backlog contains the maximum length for the pending connection queue. - * Return 0 if permission is granted. - * @socket_accept: + * + * * @sock contains the socket structure. + * * @backlog contains the maximum length for the pending connection queue. + * * Return %0 if permission is granted. + * + * int socket_accept(struct socket \*sock, struct socket \*newsock) * Check permission before accepting a new connection. Note that the new * socket, @newsock, has been created and some information copied to it, * but the accept operation has not actually been performed. - * @sock contains the listening socket structure. - * @newsock contains the newly created server socket for connection. - * Return 0 if permission is granted. - * @socket_sendmsg: + * + * * @sock contains the listening socket structure. + * * @newsock contains the newly created server socket for connection. + * * Return %0 if permission is granted. + * + * int socket_sendmsg(struct socket \*sock, struct msghdr \*msg, int size) * Check permission before transmitting a message to another socket. - * @sock contains the socket structure. - * @msg contains the message to be transmitted. - * @size contains the size of message. - * Return 0 if permission is granted. - * @socket_recvmsg: + * + * * @sock contains the socket structure. + * * @msg contains the message to be transmitted. + * * @size contains the size of message. + * * Return %0 if permission is granted. + * + * int socket_recvmsg(struct socket \*sock, struct msghdr \*msg, int size, int flags) * Check permission before receiving a message from a socket. - * @sock contains the socket structure. - * @msg contains the message structure. - * @size contains the size of message structure. - * @flags contains the operational flags. - * Return 0 if permission is granted. - * @socket_getsockname: + * + * * @sock contains the socket structure. + * * @msg contains the message structure. + * * @size contains the size of message structure. + * * @flags contains the operational flags. + * * Return %0 if permission is granted. + * + * int socket_getsockname(struct socket \*sock) * Check permission before the local address (name) of the socket object * @sock is retrieved. - * @sock contains the socket structure. - * Return 0 if permission is granted. - * @socket_getpeername: + * + * * @sock contains the socket structure. + * * Return %0 if permission is granted. + * + * int socket_getpeername(struct socket \*sock) * Check permission before the remote address (name) of a socket object + * * @sock is retrieved. * @sock contains the socket structure. - * Return 0 if permission is granted. - * @socket_getsockopt: + * Return %0 if permission is granted. + * + * int socket_getsockopt(struct socket \*sock, int level, int optname) * Check permissions before retrieving the options associated with socket * @sock. - * @sock contains the socket structure. - * @level contains the protocol level to retrieve option from. - * @optname contains the name of option to retrieve. - * Return 0 if permission is granted. - * @socket_setsockopt: + * + * * @sock contains the socket structure. + * * @level contains the protocol level to retrieve option from. + * * @optname contains the name of option to retrieve. + * * Return %0 if permission is granted. + * + * int socket_setsockopt(struct socket \*sock, int level, int optname) * Check permissions before setting the options associated with socket + * * @sock. * @sock contains the socket structure. * @level contains the protocol level to set options for. * @optname contains the name of the option to set. - * Return 0 if permission is granted. - * @socket_shutdown: + * Return %0 if permission is granted. + * + * int socket_shutdown(struct socket \*sock, int how) * Checks permission before all or part of a connection on the socket * @sock is shut down. - * @sock contains the socket structure. - * @how contains the flag indicating how future sends and receives - * are handled. - * Return 0 if permission is granted. - * @socket_sock_rcv_skb: + * + * * @sock contains the socket structure. + * * @how contains the flag indicating how future sends and receives are handled. + * * Return %0 if permission is granted. + * + * int socket_sock_rcv_skb(struct sock \*sk, struct sk_buff \*skb) * Check permissions on incoming network packets. This hook is distinct * from Netfilter's IP input hooks since it is the first time that the - * incoming sk_buff @skb has been associated with a particular socket, @sk. + * incoming @sk_buff @skb has been associated with a particular socket, @sk. * Must not sleep inside this hook because some callers hold spinlocks. - * @sk contains the sock (not socket) associated with the incoming sk_buff. - * @skb contains the incoming network data. - * @socket_getpeersec_stream: + * + * * @sk contains the sock (not socket) associated with the incoming sk_buff. + * * @skb contains the incoming network data. + * + * int socket_getpeersec_stream(struct socket \*sock, char __user \*optval, int __user \*optlen, unsigned len) * This hook allows the security module to provide peer socket security - * state for unix or connected tcp sockets to userspace via getsockopt - * SO_GETPEERSEC. For tcp sockets this can be meaningful if the + * state for unix or connected tcp sockets to userspace via @getsockopt() + * %SO_GETPEERSEC. For tcp sockets this can be meaningful if the * socket is associated with an ipsec SA. - * @sock is the local socket. - * @optval userspace memory where the security state is to be copied. - * @optlen userspace int where the module should copy the actual length - * of the security state. - * @len as input is the maximum length to copy to userspace provided - * by the caller. - * Return 0 if all is well, otherwise, typical getsockopt return - * values. - * @socket_getpeersec_dgram: + * + * * @sock is the local socket. + * * @optval userspace memory where the security state is to be copied. + * * @optlen userspace int where the module should copy the actual length of the security state. + * * @len as input is the maximum length to copy to userspace provided by the caller. + * * Return %0 if all is well, otherwise, typical @getsockopt() return values. + * + * int socket_getpeersec_dgram(struct socket \*sock, struct sk_buff \*skb, u32 \*secid) * This hook allows the security module to provide peer socket security * state for udp sockets on a per-packet basis to userspace via - * getsockopt SO_GETPEERSEC. The application must first have indicated - * the IP_PASSSEC option via getsockopt. It can then retrieve the - * security state returned by this hook for a packet via the SCM_SECURITY + * getsockopt %SO_GETPEERSEC. The application must first have indicated + * the %IP_PASSSEC option via @getsockopt(). It can then retrieve the + * security state returned by this hook for a packet via the %SCM_SECURITY * ancillary message type. - * @sock contains the peer socket. May be NULL. - * @skb is the sk_buff for the packet being queried. May be NULL. - * @secid pointer to store the secid of the packet. - * Return 0 on success, error on failure. - * @sk_alloc_security: - * Allocate and attach a security structure to the sk->sk_security field, + * + * * @sock contains the peer socket. May be %NULL. + * * @skb is the @sk_buff for the packet being queried. May be %NULL. + * * @secid pointer to store the @secid of the packet. + * * Return %0 on success, error on failure. + * + * int sk_alloc_security(struct sock \*sk, int family, gfp_t priority) + * Allocate and attach a security structure to the @sk->sk_security field, * which is used to copy security attributes between local stream sockets. - * @sk_free_security: + * + * void sk_free_security(struct sock \*sk) * Deallocate security structure. - * @sk_clone_security: + * + * void sk_clone_security(const struct sock \*sk, struct sock \*newsk) * Clone/copy security structure. - * @sk_getsecid: + * + * void sk_getsecid(struct sock \*sk, u32 \*secid) * Retrieve the LSM-specific secid for the sock to enable caching * of network authorizations. - * @sock_graft: + * + * void sock_graft(struct sock \*sk, struct socket \*parent) * Sets the socket's isec sid to the sock's sid. - * @inet_conn_request: + * + * int inet_conn_request(const struct sock \*sk, struct sk_buff \*skb, struct request_sock \*req) * Sets the openreq's sid to socket's sid with MLS portion taken * from peer sid. - * @inet_csk_clone: + * + * void inet_csk_clone(struct sock \*newsk, const struct request_sock \*req) * Sets the new child socket's sid to the openreq sid. - * @inet_conn_established: + * + * void inet_conn_established(struct sock \*sk, struct sk_buff \*skb) * Sets the connection's peersid to the secmark on skb. - * @secmark_relabel_packet: + * + * int secmark_relabel_packet(u32 secid) * check if the process should be allowed to relabel packets to - * the given secid - * @secmark_refcount_inc: + * the given @secid + * + * void secmark_refcount_inc(void) * tells the LSM to increment the number of secmark labeling rules loaded - * @secmark_refcount_dec: + * + * void secmark_refcount_dec(void) * tells the LSM to decrement the number of secmark labeling rules loaded - * @req_classify_flow: + * + * void req_classify_flow(const struct request_sock \*req, struct flowi_common \*flic) * Sets the flow's sid to the openreq sid. - * @tun_dev_alloc_security: + * + * **Security hooks for TUN device:** + * + * int tun_dev_alloc_security(void \*\*security) * This hook allows a module to allocate a security structure for a TUN * device. - * @security pointer to a security structure pointer. - * Returns a zero on success, negative values on failure. - * @tun_dev_free_security: + * + * * @security pointer to a security structure pointer. + * * Returns a zero on success, negative values on failure. + * + * void tun_dev_free_security(void \*security) * This hook allows a module to free the security structure for a TUN * device. - * @security pointer to the TUN device's security structure - * @tun_dev_create: + * + * * @security pointer to the TUN device's security structure + * + * int tun_dev_create(void) * Check permissions prior to creating a new TUN device. - * @tun_dev_attach_queue: + * + * int tun_dev_attach_queue(void \*security) * Check permissions prior to attaching to a TUN device queue. - * @security pointer to the TUN device's security structure. - * @tun_dev_attach: + * + * * @security pointer to the TUN device's security structure. + * + * int tun_dev_attach(struct sock \*sk, void \*security) * This hook can be used by the module to update any security state * associated with the TUN device's sock structure. - * @sk contains the existing sock structure. - * @security pointer to the TUN device's security structure. - * @tun_dev_open: + * + * * @sk contains the existing sock structure. + * * @security pointer to the TUN device's security structure. + * + * int tun_dev_open(void \*security) * This hook can be used by the module to update any security state * associated with the TUN device's security structure. - * @security pointer to the TUN devices's security structure. * - * Security hooks for SCTP + * * @security pointer to the TUN devices's security structure. * - * @sctp_assoc_request: - * Passes the @ep and @chunk->skb of the association INIT packet to + * **Security hooks for SCTP:** + * + * int sctp_assoc_request(struct sctp_endpoint \*ep, struct sk_buff \*skb) + * Passes the @ep and @chunk->skb of the association %INIT packet to * the security module. - * @ep pointer to sctp endpoint structure. - * @skb pointer to skbuff of association packet. - * Return 0 on success, error on failure. - * @sctp_bind_connect: + * + * * @ep pointer to sctp endpoint structure. + * * @skb pointer to @skbuff of association packet. + * * Return %0 on success, error on failure. + * + * int sctp_bind_connect(struct sock \*sk, int optname, struct sockaddr \*address, int addrlen) * Validiate permissions required for each address associated with sock * @sk. Depending on @optname, the addresses will be treated as either * for a connect or bind service. The @addrlen is calculated on each * ipv4 and ipv6 address using sizeof(struct sockaddr_in) or * sizeof(struct sockaddr_in6). - * @sk pointer to sock structure. - * @optname name of the option to validate. - * @address list containing one or more ipv4/ipv6 addresses. - * @addrlen total length of address(s). - * Return 0 on success, error on failure. - * @sctp_sk_clone: + * + * * @sk pointer to sock structure. + * * @optname name of the option to validate. + * * @address list containing one or more ipv4/ipv6 addresses. + * * @addrlen total length of address(s). + * * Return %0 on success, error on failure. + * + * void sctp_sk_clone(struct sctp_endpoint \*ep, struct sock \*sk, struct sock \*newsk) * Called whenever a new socket is created by accept(2) (i.e. a TCP * style socket) or when a socket is 'peeled off' e.g userspace * calls sctp_peeloff(3). - * @ep pointer to current sctp endpoint structure. - * @sk pointer to current sock structure. - * @sk pointer to new sock structure. * - * Security hooks for Infiniband + * * @ep pointer to current sctp endpoint structure. + * * @sk pointer to current sock structure. + * * @sk pointer to new sock structure. * - * @ib_pkey_access: + * **Security hooks for Infiniband:** + * + * int ib_pkey_access(void \*sec, u64 subnet_prefix, u16 pkey) * Check permission to access a pkey when modifing a QP. - * @subnet_prefix the subnet prefix of the port being used. - * @pkey the pkey to be accessed. - * @sec pointer to a security structure. - * @ib_endport_manage_subnet: + * + * * @subnet_prefix the subnet prefix of the port being used. + * * @pkey the pkey to be accessed. + * * @sec pointer to a security structure. + * + * int ib_endport_manage_subnet(void \*sec, const char \*dev_name, u8 port_num) * Check permissions to send and receive SMPs on a end port. - * @dev_name the IB device name (i.e. mlx4_0). - * @port_num the port number. - * @sec pointer to a security structure. - * @ib_alloc_security: + * + * * @sec pointer to a security structure. + * * @dev_name the IB device name (i.e. mlx4_0). + * * @port_num the port number. + * + * int ib_alloc_security(void \*\*sec) * Allocate a security structure for Infiniband objects. - * @sec pointer to a security structure pointer. - * Returns 0 on success, non-zero on failure - * @ib_free_security: + * + * * @sec pointer to a security structure pointer. + * * Returns %0 on success, non-zero on failure + * + * void ib_free_security(void \*sec) * Deallocate an Infiniband security structure. - * @sec contains the security structure to be freed. * - * Security hooks for XFRM operations. + * * @sec contains the security structure to be freed. + * + * **Security hooks for XFRM operations:** * - * @xfrm_policy_alloc_security: - * @ctxp is a pointer to the xfrm_sec_ctx being added to Security Policy - * Database used by the XFRM system. - * @sec_ctx contains the security context information being provided by - * the user-level policy update program (e.g., setkey). + * int xfrm_policy_alloc_security(struct xfrm_sec_ctx \*\*ctxp, struct xfrm_user_sec_ctx \*sec_ctx, gfp_t gfp) * Allocate a security structure to the xp->security field; the security - * field is initialized to NULL when the xfrm_policy is allocated. - * Return 0 if operation was successful (memory to allocate, legal context) - * @gfp is to specify the context for the allocation - * @xfrm_policy_clone_security: - * @old_ctx contains an existing xfrm_sec_ctx. - * @new_ctxp contains a new xfrm_sec_ctx being cloned from old. + * field is initialized to %NULL when the @xfrm_policy is allocated. + * + * * @ctxp is a pointer to the xfrm_sec_ctx being added to Security Policy Database used by the XFRM system. + * * @sec_ctx contains the security context information being provided by the user-level policy update program (e.g., setkey). + * * @gfp is to specify the context for the allocation + * * Return %0 if operation was successful (memory to allocate, legal context) + * + * int xfrm_policy_clone_security(struct xfrm_sec_ctx \*old_ctx, struct xfrm_sec_ctx \*\*new_ctx) * Allocate a security structure in new_ctxp that contains the - * information from the old_ctx structure. - * Return 0 if operation was successful (memory to allocate). - * @xfrm_policy_free_security: - * @ctx contains the xfrm_sec_ctx - * Deallocate xp->security. - * @xfrm_policy_delete_security: - * @ctx contains the xfrm_sec_ctx. - * Authorize deletion of xp->security. - * @xfrm_state_alloc: - * @x contains the xfrm_state being added to the Security Association - * Database by the XFRM system. - * @sec_ctx contains the security context information being provided by - * the user-level SA generation program (e.g., setkey or racoon). - * Allocate a security structure to the x->security field; the security - * field is initialized to NULL when the xfrm_state is allocated. Set the - * context to correspond to sec_ctx. Return 0 if operation was successful - * (memory to allocate, legal context). - * @xfrm_state_alloc_acquire: - * @x contains the xfrm_state being added to the Security Association - * Database by the XFRM system. - * @polsec contains the policy's security context. - * @secid contains the secid from which to take the mls portion of the - * context. - * Allocate a security structure to the x->security field; the security - * field is initialized to NULL when the xfrm_state is allocated. Set the - * context to correspond to secid. Return 0 if operation was successful - * (memory to allocate, legal context). - * @xfrm_state_free_security: - * @x contains the xfrm_state. + * information from the @old_ctx structure. + * + * * @old_ctx contains an existing @xfrm_sec_ctx. + * * @new_ctxp contains a new @xfrm_sec_ctx being cloned from old. + * * Return %0 if operation was successful (memory to allocate). + * + * void xfrm_policy_free_security(struct xfrm_sec_ctx \*ctx) + * Deallocate @xp->security. + * + * @ctx contains the @xfrm_sec_ctx + * + * int xfrm_policy_delete_security(struct xfrm_sec_ctx \*ctx) + * Authorize deletion of @xp->security. + * + * * @ctx contains the @xfrm_sec_ctx. + * + * int xfrm_state_alloc(struct xfrm_state \*x, struct xfrm_user_sec_ctx \*sec_ctx) + * Allocate a security structure to the @x->security field; the security + * field is initialized to %NULL when the @xfrm_state is allocated. Set the + * context to correspond to @sec_ctx. + * + * * @x contains the xfrm_state being added to the Security Association Database by the XFRM system. + * * @sec_ctx contains the security context information being provided by the user-level SA generation program (e.g., setkey or racoon). + * * Return %0 if operation was successful (memory to allocate, legal context). + * + * int xfrm_state_alloc_acquire(struct xfrm_state \*x, struct xfrm_sec_ctx \*polsec, u32 secid) + * Allocate a security structure to the @x->security field; the security + * field is initialized to %NULL when the @xfrm_state is allocated. Set the + * context to correspond to @secid. + * + * * @x contains the xfrm_state being added to the Security Association Database by the XFRM system. + * * @polsec contains the policy's security context. + * * @secid contains the @secid from which to take the mls portion of the context. + * * Return %0 if operation was successful (memory to allocate, legal context). + * + * void xfrm_state_free_security(struct xfrm_state \*x) * Deallocate x->security. - * @xfrm_state_delete_security: - * @x contains the xfrm_state. - * Authorize deletion of x->security. - * @xfrm_policy_lookup: - * @ctx contains the xfrm_sec_ctx for which the access control is being - * checked. - * @fl_secid contains the flow security label that is used to authorize - * access to the policy xp. - * @dir contains the direction of the flow (input or output). - * Check permission when a flow selects a xfrm_policy for processing + * + * * @x contains the @xfrm_state. + * + * int xfrm_state_delete_security(struct xfrm_state \*x) + * Authorize deletion of @x->security. + * + * * @x contains the @xfrm_state. + * + * int xfrm_policy_lookup(struct xfrm_sec_ctx \*ctx, u32 fl_secid, u8 dir) + * Check permission when a flow selects a @xfrm_policy for processing * XFRMs on a packet. The hook is called when selecting either a * per-socket policy or a generic xfrm policy. - * Return 0 if permission is granted, -ESRCH otherwise, or -errno - * on other errors. - * @xfrm_state_pol_flow_match: - * @x contains the state to match. - * @xp contains the policy to check for a match. - * @flic contains the flowi_common struct to check for a match. - * Return 1 if there is a match. - * @xfrm_decode_session: - * @skb points to skb to decode. - * @secid points to the flow key secid to set. - * @ckall says if all xfrms used should be checked for same secid. - * Return 0 if ckall is zero or all xfrms used have the same secid. - * - * Security hooks affecting all Key Management operations - * - * @key_alloc: + * + * * @ctx contains the @xfrm_sec_ctx for which the access control is being checked. + * * @fl_secid contains the flow security label that is used to authorize access to the policy xp. + * * @dir contains the direction of the flow (input or output). + * * Return %0 if permission is granted, %-ESRCH otherwise, or %-errno on other errors. + * + * int xfrm_state_pol_flow_match(struct xfrm_state \*x, struct xfrm_policy \*xp, const struct flowi_common \*flic) + * TODO Add function definition to correctly format kernel doc. + * + * * @x contains the state to match. + * * @xp contains the policy to check for a match. + * * @flic contains the @flowi_common struct to check for a match. + * * Return %1 if there is a match. + * + * int xfrm_decode_session(struct sk_buff \*skb, u32 \*secid, int ckall) + * TODO Add function definition to correctly format kernel doc. + * + * * @skb points to skb to decode. + * * @secid points to the flow key @secid to set. + * * @ckall says if all xfrms used should be checked for same @secid. + * * Return %0 if @ckall is zero or all xfrms used have the same @secid. + * + * **Security hooks affecting all Key Management operations:** + * + * int key_alloc(struct key \*key, const struct cred \*cred, unsigned long flags) * Permit allocation of a key and assign security data. Note that key does * not have a serial number assigned at this point. - * @key points to the key. - * @flags is the allocation flags - * Return 0 if permission is granted, -ve error otherwise. - * @key_free: + * + * * @key points to the key. + * * @flags is the allocation flags + * * Return %0 if permission is granted, %-ve error otherwise. + * + * void key_free(struct key \*key) * Notification of destruction; free security data. - * @key points to the key. - * No return value. - * @key_permission: + * + * * @key points to the key. + * * No return value. + * + * int key_permission(key_ref_t key_ref, const struct cred \*cred, enum key_need_perm need_perm) * See whether a specific operational right is granted to a process on a * key. - * @key_ref refers to the key (key pointer + possession attribute bit). - * @cred points to the credentials to provide the context against which to - * evaluate the security data on the key. - * @perm describes the combination of permissions required of this key. - * Return 0 if permission is granted, -ve error otherwise. - * @key_getsecurity: + * + * * @key_ref refers to the key (key pointer + possession attribute bit). + * * @cred points to the credentials to provide the context against which to evaluate the security data on the key. + * * @perm describes the combination of permissions required of this key. + * * Return %0 if permission is granted, %-ve error otherwise. + * + * int key_getsecurity(struct key \*key, char \*\*_buffer) * Get a textual representation of the security context attached to a key - * for the purposes of honouring KEYCTL_GETSECURITY. This function - * allocates the storage for the NUL-terminated string and the caller + * for the purposes of honouring %KEYCTL_GETSECURITY. This function + * allocates the storage for the %NUL terminated string and the caller * should free it. - * @key points to the key to be queried. - * @_buffer points to a pointer that should be set to point to the - * resulting string (if no label or an error occurs). - * Return the length of the string (including terminating NUL) or -ve if - * an error. - * May also return 0 (and a NULL buffer pointer) if there is no label. * - * Security hooks affecting all System V IPC operations. + * * @key points to the key to be queried. + * * @_buffer points to a pointer that should be set to point to the resulting string (if no label or an error occurs). + * * Return the length of the string (including terminating %NUL) or %-ve if an error. + * * May also Return %0 (and a %NULL buffer pointer) if there is no label. + * + * **Security hooks affecting all System V IPC operations:** * - * @ipc_permission: + * int ipc_permission(struct kern_ipc_perm \*ipcp, short flag) * Check permissions for access to IPC - * @ipcp contains the kernel IPC permission structure - * @flag contains the desired (requested) permission set - * Return 0 if permission is granted. - * @ipc_getsecid: + * + * * @ipcp contains the kernel IPC permission structure + * * @flag contains the desired (requested) permission set + * * Return %0 if permission is granted. + * + * void ipc_getsecid(struct kern_ipc_perm \*ipcp, u32 \*secid) * Get the secid associated with the ipc object. - * @ipcp contains the kernel IPC permission structure. - * @secid contains a pointer to the location where result will be saved. - * In case of failure, @secid will be set to zero. * - * Security hooks for individual messages held in System V IPC message queues + * * @ipcp contains the kernel IPC permission structure. + * * @secid contains a pointer to the location where result will be saved. + * * In case of failure, @secid will be set to zero. + * + * **Security hooks for individual messages held in System V IPC message queues:** * - * @msg_msg_alloc_security: - * Allocate and attach a security structure to the msg->security field. - * The security field is initialized to NULL when the structure is first + * int msg_msg_alloc_security(struct msg_msg \*msg) + * Allocate and attach a security structure to the @msg->security field. + * The security field is initialized to %NULL when the structure is first * created. - * @msg contains the message structure to be modified. - * Return 0 if operation was successful and permission is granted. - * @msg_msg_free_security: + * + * * @msg contains the message structure to be modified. + * * Return %0 if operation was successful and permission is granted. + * + * void msg_msg_free_security(struct msg_msg \*msg) * Deallocate the security structure for this message. - * @msg contains the message structure to be modified. * - * Security hooks for System V IPC Message Queues + * * @msg contains the message structure to be modified. + * + * **Security hooks for System V IPC Message Queues:** * - * @msg_queue_alloc_security: + * int msg_queue_alloc_security(struct kern_ipc_perm \*perm) * Allocate and attach a security structure to the * @perm->security field. The security field is initialized to - * NULL when the structure is first created. - * @perm contains the IPC permissions of the message queue. - * Return 0 if operation was successful and permission is granted. - * @msg_queue_free_security: + * %NULL when the structure is first created. + * + * * @perm contains the IPC permissions of the message queue. + * * Return %0 if operation was successful and permission is granted. + * + * void msg_queue_free_security(struct kern_ipc_perm \*perm) * Deallocate security field @perm->security for the message queue. - * @perm contains the IPC permissions of the message queue. - * @msg_queue_associate: + * + * * @perm contains the IPC permissions of the message queue. + * + * int msg_queue_associate(struct kern_ipc_perm \*perm, int msqflg) * Check permission when a message queue is requested through the * msgget system call. This hook is only called when returning the * message queue identifier for an existing message queue, not when a * new message queue is created. - * @perm contains the IPC permissions of the message queue. - * @msqflg contains the operation control flags. - * Return 0 if permission is granted. - * @msg_queue_msgctl: + * + * * @perm contains the IPC permissions of the message queue. + * * @msqflg contains the operation control flags. + * * Return %0 if permission is granted. + * + * int msg_queue_msgctl(struct kern_ipc_perm \*perm, int cmd) * Check permission when a message control operation specified by @cmd * is to be performed on the message queue with permissions @perm. - * The @perm may be NULL, e.g. for IPC_INFO or MSG_INFO. - * @perm contains the IPC permissions of the msg queue. May be NULL. - * @cmd contains the operation to be performed. - * Return 0 if permission is granted. - * @msg_queue_msgsnd: + * The @perm may be %NULL, e.g. for %IPC_INFO or %MSG_INFO. + * + * * @perm contains the IPC permissions of the msg queue. May be %NULL. + * * @cmd contains the operation to be performed. + * * Return %0 if permission is granted. + * + * int msg_queue_msgsnd(struct kern_ipc_perm \*perm, struct msg_msg \*msg, int msqflg) * Check permission before a message, @msg, is enqueued on the message * queue with permissions @perm. - * @perm contains the IPC permissions of the message queue. - * @msg contains the message to be enqueued. - * @msqflg contains operational flags. - * Return 0 if permission is granted. - * @msg_queue_msgrcv: + * + * * @perm contains the IPC permissions of the message queue. + * * @msg contains the message to be enqueued. + * * @msqflg contains operational flags. + * * Return %0 if permission is granted. + * + * int msg_queue_msgrcv(struct kern_ipc_perm \*perm, struct msg_msg \*msg, struct task_struct \*target, long type, int mode) * Check permission before a message, @msg, is removed from the message * queue. The @target task structure contains a pointer to the * process that will be receiving the message (not equal to the current * process when inline receives are being performed). - * @perm contains the IPC permissions of the message queue. - * @msg contains the message destination. - * @target contains the task structure for recipient process. - * @type contains the type of message requested. - * @mode contains the operational flags. - * Return 0 if permission is granted. * - * Security hooks for System V Shared Memory Segments + * * @perm contains the IPC permissions of the message queue. + * * @msg contains the message destination. + * * @target contains the task structure for recipient process. + * * @type contains the type of message requested. + * * @mode contains the operational flags. + * * Return %0 if permission is granted. + * + * **Security hooks for System V Shared Memory Segments:** * - * @shm_alloc_security: + * int shm_alloc_security(struct kern_ipc_perm \*perm) * Allocate and attach a security structure to the @perm->security - * field. The security field is initialized to NULL when the structure is + * field. The security field is initialized to %NULL when the structure is * first created. - * @perm contains the IPC permissions of the shared memory structure. - * Return 0 if operation was successful and permission is granted. - * @shm_free_security: + * + * * @perm contains the IPC permissions of the shared memory structure. + * * Return %0 if operation was successful and permission is granted. + * + * void shm_free_security(struct kern_ipc_perm \*perm) * Deallocate the security structure @perm->security for the memory segment. - * @perm contains the IPC permissions of the shared memory structure. - * @shm_associate: + * + * * @perm contains the IPC permissions of the shared memory structure. + * + * int shm_associate(struct kern_ipc_perm \*perm, int shmflg) * Check permission when a shared memory region is requested through the - * shmget system call. This hook is only called when returning the shared + * @shmget() system call. This hook is only called when returning the shared * memory region identifier for an existing region, not when a new shared * memory region is created. - * @perm contains the IPC permissions of the shared memory structure. - * @shmflg contains the operation control flags. - * Return 0 if permission is granted. - * @shm_shmctl: + * + * * @perm contains the IPC permissions of the shared memory structure. + * * @shmflg contains the operation control flags. + * * Return %0 if permission is granted. + * + * int shm_shmctl(struct kern_ipc_perm \*perm, int cmd) * Check permission when a shared memory control operation specified by * @cmd is to be performed on the shared memory region with permissions @perm. - * The @perm may be NULL, e.g. for IPC_INFO or SHM_INFO. - * @perm contains the IPC permissions of the shared memory structure. - * @cmd contains the operation to be performed. - * Return 0 if permission is granted. - * @shm_shmat: + * The @perm may be %NULL, e.g. for %IPC_INFO or %SHM_INFO. + * + * * @perm contains the IPC permissions of the shared memory structure. + * * @cmd contains the operation to be performed. + * * Return %0 if permission is granted. + * + * int shm_shmat(struct kern_ipc_perm \*perm, char __user \*shmaddr, int shmflg) * Check permissions prior to allowing the shmat system call to attach the * shared memory segment with permissions @perm to the data segment of the * calling process. The attaching address is specified by @shmaddr. - * @perm contains the IPC permissions of the shared memory structure. - * @shmaddr contains the address to attach memory region to. - * @shmflg contains the operational flags. - * Return 0 if permission is granted. * - * Security hooks for System V Semaphores + * * @perm contains the IPC permissions of the shared memory structure. + * * @shmaddr contains the address to attach memory region to. + * * @shmflg contains the operational flags. + * * Return %0 if permission is granted. + * + * **Security hooks for System V Semaphores:** * - * @sem_alloc_security: + * int sem_alloc_security(struct kern_ipc_perm \*perm) * Allocate and attach a security structure to the @perm->security - * field. The security field is initialized to NULL when the structure is + * field. The security field is initialized to %NULL when the structure is * first created. - * @perm contains the IPC permissions of the semaphore. - * Return 0 if operation was successful and permission is granted. - * @sem_free_security: + * + * * @perm contains the IPC permissions of the semaphore. + * * Return %0 if operation was successful and permission is granted. + * + * void sem_free_security(struct kern_ipc_perm \*perm) * Deallocate security structure @perm->security for the semaphore. - * @perm contains the IPC permissions of the semaphore. - * @sem_associate: - * Check permission when a semaphore is requested through the semget + * + * * @perm contains the IPC permissions of the semaphore. + * + * int sem_associate(struct kern_ipc_perm \*perm, int semflg) + * Check permission when a semaphore is requested through the @semget() * system call. This hook is only called when returning the semaphore * identifier for an existing semaphore, not when a new one must be * created. - * @perm contains the IPC permissions of the semaphore. - * @semflg contains the operation control flags. - * Return 0 if permission is granted. - * @sem_semctl: + * + * * @perm contains the IPC permissions of the semaphore. + * * @semflg contains the operation control flags. + * * Return %0 if permission is granted. + * + * int sem_semctl(struct kern_ipc_perm \*perm, int cmd) * Check permission when a semaphore operation specified by @cmd is to be - * performed on the semaphore. The @perm may be NULL, e.g. for - * IPC_INFO or SEM_INFO. - * @perm contains the IPC permissions of the semaphore. May be NULL. - * @cmd contains the operation to be performed. - * Return 0 if permission is granted. - * @sem_semop: + * performed on the semaphore. The @perm may be %NULL, e.g. for + * %IPC_INFO or %SEM_INFO. + * + * * @perm contains the IPC permissions of the semaphore. May be %NULL. + * * @cmd contains the operation to be performed. + * * Return %0 if permission is granted. + * + * int sem_semop(struct kern_ipc_perm \*perm, struct sembuf \*sops, unsigned nsops, int alter) * Check permissions before performing operations on members of the * semaphore set. If the @alter flag is nonzero, the semaphore set * may be modified. - * @perm contains the IPC permissions of the semaphore. - * @sops contains the operations to perform. - * @nsops contains the number of operations to perform. - * @alter contains the flag indicating whether changes are to be made. - * Return 0 if permission is granted. * - * @binder_set_context_mgr: + * * @perm contains the IPC permissions of the semaphore. + * * @sops contains the operations to perform. + * * @nsops contains the number of operations to perform. + * * @alter contains the flag indicating whether changes are to be made. + * * Return %0 if permission is granted. + * + * **Security hooks for Binder device:** + * + * int binder_set_context_mgr(struct task_struct \*mgr) * Check whether @mgr is allowed to be the binder context manager. - * @mgr contains the task_struct for the task being registered. - * Return 0 if permission is granted. - * @binder_transaction: + * + * * @mgr contains the @task_struct for the task being registered. + * * Return %0 if permission is granted. + * + * int binder_transaction(struct task_struct \*from, struct task_struct \*to) * Check whether @from is allowed to invoke a binder transaction call * to @to. - * @from contains the task_struct for the sending task. - * @to contains the task_struct for the receiving task. - * @binder_transfer_binder: + * + * * @from contains the @task_struct for the sending task. + * * @to contains the @task_struct for the receiving task. + * + * int binder_transfer_binder(struct task_struct \*from, struct task_struct \*to) * Check whether @from is allowed to transfer a binder reference to @to. - * @from contains the task_struct for the sending task. - * @to contains the task_struct for the receiving task. - * @binder_transfer_file: + * + * * @from contains the @task_struct for the sending task. + * * @to contains the @task_struct for the receiving task. + * + * int binder_transfer_file(struct task_struct \*from, struct task_struct \*to, struct file \*file) * Check whether @from is allowed to transfer @file to @to. - * @from contains the task_struct for the sending task. - * @file contains the struct file being transferred. - * @to contains the task_struct for the receiving task. * - * @ptrace_access_check: + * * @from contains the @task_struct for the sending task. + * * @file contains the struct file being transferred. + * * @to contains the @task_struct for the receiving task. + * + * **Security hooks for ptrace:** + * + * int ptrace_access_check(struct task_struct \*child, unsigned int mode) * Check permission before allowing the current process to trace the * @child process. * Security modules may also want to perform a process tracing check - * during an execve in the set_security or apply_creds hooks of - * tracing check during an execve in the bprm_set_creds hook of - * binprm_security_ops if the process is being traced and its security - * attributes would be changed by the execve. - * @child contains the task_struct structure for the target process. - * @mode contains the PTRACE_MODE flags indicating the form of access. - * Return 0 if permission is granted. - * @ptrace_traceme: + * during an @execve in the set_security or @apply_creds() hooks of + * tracing check during an @execve in the @bprm_set_creds() hook of + * @binprm_security_ops() if the process is being traced and its security + * attributes would be changed by the @execve. + * + * * @child contains the @task_struct structure for the target process. + * * @mode contains the %PTRACE_MODE flags indicating the form of access. + * * Return %0 if permission is granted. + * + * int ptrace_traceme(struct task_struct \*parent) * Check that the @parent process has sufficient permission to trace the * current process before allowing the current process to present itself * to the @parent process for tracing. - * @parent contains the task_struct structure for debugger process. - * Return 0 if permission is granted. - * @capget: + * + * * @parent contains the @task_struct structure for debugger process. + * * Return %0 if permission is granted. + * + * int capget(struct task_struct \*target, kernel_cap_t \*effective, kernel_cap_t \*inheritable, kernel_cap_t \*permitted) * Get the @effective, @inheritable, and @permitted capability sets for * the @target process. The hook may also perform permission checking to * determine if the current process is allowed to see the capability sets * of the @target process. - * @target contains the task_struct structure for target process. - * @effective contains the effective capability set. - * @inheritable contains the inheritable capability set. - * @permitted contains the permitted capability set. - * Return 0 if the capability sets were successfully obtained. - * @capset: + * + * * @target contains the @task_struct structure for target process. + * * @effective contains the effective capability set. + * * @inheritable contains the inheritable capability set. + * * @permitted contains the permitted capability set. + * * Return %0 if the capability sets were successfully obtained. + * + * int capset(struct cred \*new, const struct cred \*old, const kernel_cap_t \*effective, const kernel_cap_t \*inheritable, const kernel_cap_t \*permitted) * Set the @effective, @inheritable, and @permitted capability sets for * the current process. - * @new contains the new credentials structure for target process. - * @old contains the current credentials structure for target process. - * @effective contains the effective capability set. - * @inheritable contains the inheritable capability set. - * @permitted contains the permitted capability set. - * Return 0 and update @new if permission is granted. - * @capable: + * + * * @new contains the new credentials structure for target process. + * * @old contains the current credentials structure for target process. + * * @effective contains the effective capability set. + * * @inheritable contains the inheritable capability set. + * * @permitted contains the permitted capability set. + * * Return %0 and update @new if permission is granted. + * + * int capable(const struct cred \*cred, struct user_namespace \*ns, int cap, unsigned int opts) * Check whether the @tsk process has the @cap capability in the indicated * credentials. - * @cred contains the credentials to use. - * @ns contains the user namespace we want the capability in - * @cap contains the capability . - * @opts contains options for the capable check - * Return 0 if the capability is granted for @tsk. - * @quotactl: - * Check whether the quotactl syscall is allowed for this @sb. - * @quota_on: - * Check whether QUOTAON is allowed for this @dentry. - * @syslog: + * + * * @cred contains the credentials to use. + * * @ns contains the user namespace we want the capability in + * * @cap contains the capability . + * * @opts contains options for the capable check + * * Return %0 if the capability is granted for @tsk. + * + * int quotactl(int cmds, int type, int id, struct super_block \*sb) + * Check whether the @quotactl syscall is allowed for this @sb. + * + * int quota_on(struct dentry \*dentry) + * Check whether %QUOTAON is allowed for this @dentry. + * + * int syslog(int type) * Check permission before accessing the kernel message ring or changing * logging to the console. * See the syslog(2) manual page for an explanation of the @type values. - * @type contains the SYSLOG_ACTION_* constant from - * Return 0 if permission is granted. - * @settime: + * + * * @type contains the %SYSLOG_ACTION_\* constant from + * * Return %0 if permission is granted. + * + * int settime(const struct timespec64 \*ts, const struct timezone \*tz) * Check permission to change the system time. * struct timespec64 is defined in and timezone * is defined in - * @ts contains new time - * @tz contains new timezone - * Return 0 if permission is granted. - * @vm_enough_memory: + * + * * @ts contains new time + * * @tz contains new timezone + * * Return %0 if permission is granted. + * + * int vm_enough_memory(struct mm_struct \*mm, long pages) * Check permissions for allocating a new virtual mapping. - * @mm contains the mm struct it is being added to. - * @pages contains the number of pages. - * Return 0 if permission is granted. * - * @ismaclabel: + * * @mm contains the mm struct it is being added to. + * * @pages contains the number of pages. + * * Return %0 if permission is granted. + * + * int ismaclabel(const char \*name) * Check if the extended attribute specified by @name - * represents a MAC label. Returns 1 if name is a MAC - * attribute otherwise returns 0. - * @name full extended attribute name to check against - * LSM as a MAC label. - * - * @secid_to_secctx: - * Convert secid to security context. If secdata is NULL the length of - * the result will be returned in seclen, but no secdata will be returned. + * represents a MAC label. Returns %1 if name is a MAC + * attribute otherwise returns %0. + * + * * @name full extended attribute name to check against LSM as a MAC label. + * + * **Security hooks for managing security blobs:** + * + * int secid_to_secctx(u32 secid, char \*\*secdata, u32 \*seclen) + * Convert @secid to security context. If @secdata is %NULL the length of + * the result will be returned in @seclen, but no @secdata will be returned. * This does mean that the length could change between calls to check the * length and the next call which actually allocates and returns the - * secdata. - * @secid contains the security ID. - * @secdata contains the pointer that stores the converted security - * context. - * @seclen pointer which contains the length of the data - * @secctx_to_secid: - * Convert security context to secid. - * @secid contains the pointer to the generated security ID. - * @secdata contains the security context. - * - * @release_secctx: + * @secdata. + * + * * @secid contains the security ID. + * * @secdata contains the pointer that stores the converted security context. + * * @seclen pointer which contains the length of the data + * + * int secctx_to_secid(const char \*secdata, u32 seclen, u32 \*secid) + * Convert security context to @secid. + * + * * @secid contains the pointer to the generated security ID. + * * @secdata contains the security context. + * + * void release_secctx(char \*secdata, u32 seclen) * Release the security context. - * @secdata contains the security context. - * @seclen contains the length of the security context. * - * Security hooks for Audit + * * @secdata contains the security context. + * * @seclen contains the length of the security context. * - * @audit_rule_init: + * **Security hooks for Audit:** + * + * int audit_rule_init(u32 field, u32 op, char \*rulestr, void \*\*lsmrule) * Allocate and initialize an LSM audit rule structure. - * @field contains the required Audit action. - * Fields flags are defined in - * @op contains the operator the rule uses. - * @rulestr contains the context where the rule will be applied to. - * @lsmrule contains a pointer to receive the result. - * Return 0 if @lsmrule has been successfully set, - * -EINVAL in case of an invalid rule. - * - * @audit_rule_known: + * + * * @field contains the required Audit action. Fields flags are defined in + * * @op contains the operator the rule uses. + * * @rulestr contains the context where the rule will be applied to. + * * @lsmrule contains a pointer to receive the result. + * * Return %0 if @lsmrule has been successfully set, + * * %-EINVAL in case of an invalid rule. + * + * int audit_rule_known(struct audit_krule \*krule) * Specifies whether given @krule contains any fields related to * current LSM. - * @krule contains the audit rule of interest. - * Return 1 in case of relation found, 0 otherwise. * - * @audit_rule_match: + * * @krule contains the audit rule of interest. + * * Return %1 in case of relation found, 0 otherwise. + * + * int audit_rule_match(u32 secid, u32 field, u32 op, void \*lsmrule) * Determine if given @secid matches a rule previously approved * by @audit_rule_known. - * @secid contains the security id in question. - * @field contains the field which relates to current LSM. - * @op contains the operator that will be used for matching. - * @lrule points to the audit rule that will be checked against. - * Return 1 if secid matches the rule, 0 if it does not, -ERRNO on failure. * - * @audit_rule_free: + * * @secid contains the security id in question. + * * @field contains the field which relates to current LSM. + * * @op contains the operator that will be used for matching. + * * @lsmrule points to the audit rule that will be checked against. + * * Return %1 if @secid matches the rule, %0 if it does not, %-ERRNO on failure. + * + * void audit_rule_free(void \*lsmrule) * Deallocate the LSM audit rule structure previously allocated by - * audit_rule_init. - * @lsmrule contains the allocated rule + * @audit_rule_init(). + * + * * @lsmrule contains the allocated rule + * + * **Security hooks for more inode services:** * - * @inode_invalidate_secctx: + * void inode_invalidate_secctx(struct inode \*inode) * Notify the security module that it must revalidate the security context * of an inode. * - * @inode_notifysecctx: + * int inode_notifysecctx(struct inode \*inode, void \*ctx, u32 ctxlen) * Notify the security module of what the security context of an inode * should be. Initializes the incore security context managed by the * security module for this inode. Example usage: NFS client invokes * this hook to initialize the security context in its incore inode to the * value provided by the server for the file when the server returned the * file's attributes to the client. - * Must be called with inode->i_mutex locked. - * @inode we wish to set the security context of. - * @ctx contains the string which we wish to set in the inode. - * @ctxlen contains the length of @ctx. + * Must be called with @inode->i_mutex locked. * - * @inode_setsecctx: + * * @inode we wish to set the security context of. + * * @ctx contains the string which we wish to set in the inode. + * * @ctxlen contains the length of @ctx. + * + * int inode_setsecctx(struct dentry \*dentry, void \*ctx, u32 ctxlen) * Change the security context of an inode. Updates the * incore security context managed by the security module and invokes the - * fs code as needed (via __vfs_setxattr_noperm) to update any backing - * xattrs that represent the context. Example usage: NFS server invokes + * fs code as needed (via @__vfs_setxattr_noperm()) to update any backing + * @xattrs that represent the context. Example usage: NFS server invokes * this hook to change the security context in its incore inode and on the - * backing filesystem to a value provided by the client on a SETATTR + * backing filesystem to a value provided by the client on a %SETATTR * operation. - * Must be called with inode->i_mutex locked. - * @dentry contains the inode we wish to set the security context of. - * @ctx contains the string which we wish to set in the inode. - * @ctxlen contains the length of @ctx. + * Must be called with @inode->i_mutex locked. + * + * * @dentry contains the inode we wish to set the security context of. + * * @ctx contains the string which we wish to set in the inode. + * * @ctxlen contains the length of @ctx. * - * @inode_getsecctx: - * On success, returns 0 and fills out @ctx and @ctxlen with the security + * int inode_getsecctx(struct inode \*inode, void \*\*ctx, u32 \*ctxlen) + * On success, returns %0 and fills out @ctx and @ctxlen with the security * context for the given @inode. - * @inode we wish to get the security context of. - * @ctx is a pointer in which to place the allocated security context. - * @ctxlen points to the place to put the length of @ctx. * - * Security hooks for the general notification queue: + * * @inode we wish to get the security context of. + * * @ctx is a pointer in which to place the allocated security context. + * * @ctxlen points to the place to put the length of @ctx. + * + * **Security hooks for the general notification queue:** * - * @post_notification: + * int post_notification(const struct cred \*w_cred, const struct cred \*cred, struct watch_notification \*n) * Check to see if a watch notification can be posted to a particular * queue. - * @w_cred: The credentials of the whoever set the watch. - * @cred: The event-triggerer's credentials - * @n: The notification being posted * - * @watch_key: + * * @w_cred The credentials of the whoever set the watch. + * * @cred The event-triggerer's credentials + * * @n The notification being posted + * + * int watch_key(struct key \*key) * Check to see if a process is allowed to watch for event notifications * from a key or keyring. - * @key: The key to watch. * - * Security hooks for using the eBPF maps and programs functionalities through - * eBPF syscalls. + * * @key The key to watch. + * + * **Security hooks for using the eBPF maps and programs functionalities** + * **through eBPF syscalls:** * - * @bpf: - * Do a initial check for all bpf syscalls after the attribute is copied + * int bpf(int cmd, union bpf_attr \*attr, unsigned int size) + * Do a initial check for all @bpf syscalls after the attribute is copied * into the kernel. The actual security module can implement their own * rules to check the specific cmd they need. * - * @bpf_map: + * int bpf_map(struct bpf_map \*map, fmode_t fmode) * Do a check when the kernel generate and return a file descriptor for * eBPF maps. * - * @map: bpf map that we want to access - * @mask: the access flags + * * @map bpf map that we want to access + * * @mask the access flags * - * @bpf_prog: + * int bpf_prog(struct bpf_prog \*prog) * Do a check when the kernel generate and return a file descriptor for * eBPF programs. * - * @prog: bpf prog that userspace want to use. + * * @prog bpf prog that userspace want to use. * - * @bpf_map_alloc_security: + * int bpf_map_alloc_security(struct bpf_map \*map) * Initialize the security field inside bpf map. * - * @bpf_map_free_security: + * void bpf_map_free_security((struct bpf_map \*map) * Clean up the security information stored inside bpf map. * - * @bpf_prog_alloc_security: + * int bpf_prog_alloc_security(struct bpf_prog_aux \*aux) * Initialize the security field inside bpf program. * - * @bpf_prog_free_security: + * void bpf_prog_free_security(struct bpf_prog_aux \*aux) * Clean up the security information stored inside bpf prog. * - * @locked_down: + * **Security hooks for lockdown:** + * + * int locked_down(enum lockdown_reason what) * Determine whether a kernel feature that potentially enables arbitrary * code execution in kernel space should be permitted. * - * @what: kernel feature being accessed + * * @what kernel feature being accessed + * + * **Security hooks for perf events:** + * + * int perf_event_open(struct perf_event_attr \*attr, int type) + * Check whether the @type of @perf_event_open() @syscall() is allowed. + * + * int perf_event_alloc(struct perf_event \*event) + * Allocate and save @perf_event security info. + * + * void perf_event_free(struct perf_event \*event) + * Release (free) @perf_event security info. * - * Security hooks for perf events + * int perf_event_read(struct perf_event \*event) + * Read @perf_event security info if allowed. * - * @perf_event_open: - * Check whether the @type of perf_event_open syscall is allowed. - * @perf_event_alloc: - * Allocate and save perf_event security info. - * @perf_event_free: - * Release (free) perf_event security info. - * @perf_event_read: - * Read perf_event security info if allowed. - * @perf_event_write: - * Write perf_event security info if allowed. + * int perf_event_write(struct perf_event \event) + * Write @perf_event security info if allowed. */ union security_list_options { #define LSM_HOOK(RET, DEFAULT, NAME, ...) RET (*NAME)(__VA_ARGS__);