sphinx.addnodesdocument)}( rawsourcechildren]( translations LanguagesNode)}(hhh](h pending_xref)}(hhh]docutils.nodesTextChinese (Simplified)}parenthsba attributes}(ids]classes]names]dupnames]backrefs] refdomainstdreftypedoc reftarget'/translations/zh_CN/admin-guide/LSM/ipemodnameN classnameN refexplicitutagnamehhh ubh)}(hhh]hChinese (Traditional)}hh2sbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget'/translations/zh_TW/admin-guide/LSM/ipemodnameN classnameN refexplicituh1hhh ubh)}(hhh]hItalian}hhFsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget'/translations/it_IT/admin-guide/LSM/ipemodnameN classnameN refexplicituh1hhh ubh)}(hhh]hJapanese}hhZsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget'/translations/ja_JP/admin-guide/LSM/ipemodnameN classnameN refexplicituh1hhh ubh)}(hhh]hKorean}hhnsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget'/translations/ko_KR/admin-guide/LSM/ipemodnameN classnameN refexplicituh1hhh ubh)}(hhh]hPortuguese (Brazilian)}hhsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget'/translations/pt_BR/admin-guide/LSM/ipemodnameN classnameN refexplicituh1hhh ubh)}(hhh]hSpanish}hhsbah}(h]h ]h"]h$]h&] refdomainh)reftypeh+ reftarget'/translations/sp_SP/admin-guide/LSM/ipemodnameN classnameN refexplicituh1hhh ubeh}(h]h ]h"]h$]h&]current_languageEnglishuh1h hh _documenthsourceNlineNubhcomment)}(h SPDX-License-Identifier: GPL-2.0h]h SPDX-License-Identifier: GPL-2.0}hhsbah}(h]h ]h"]h$]h&] xml:spacepreserveuh1hhhhhhA/var/lib/git/docbuild/linux/Documentation/admin-guide/LSM/ipe.rsthKubhsection)}(hhh](htitle)}(h"Integrity Policy Enforcement (IPE)h]h"Integrity Policy Enforcement (IPE)}(hhhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhhhhhKubhnote)}(hThis is the documentation for admins, system builders, or individuals attempting to use IPE. If you're looking for more developer-focused documentation about IPE please see :doc:`the design docs `.h]h paragraph)}(hThis is the documentation for admins, system builders, or individuals attempting to use IPE. If you're looking for more developer-focused documentation about IPE please see :doc:`the design docs `.h](hThis is the documentation for admins, system builders, or individuals attempting to use IPE. If you’re looking for more developer-focused documentation about IPE please see }(hhhhhNhNubh)}(h&:doc:`the design docs `h]hinline)}(hhh]hthe design docs}(hhhhhNhNubah}(h]h ](xrefstdstd-doceh"]h$]h&]uh1hhhubah}(h]h ]h"]h$]h&]refdocadmin-guide/LSM/ipe refdomainhreftypedoc refexplicitrefwarn reftarget /security/ipeuh1hhhhKhhubh.}(hhhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhhubah}(h]h ]h"]h$]h&]uh1hhhhhhhhNubh)}(hhh](h)}(hOverviewh]hOverview}(hj%hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj"hhhhhK ubh)}(hXIntegrity Policy Enforcement (IPE) is a Linux Security Module that takes a complementary approach to access control. Unlike traditional access control mechanisms that rely on labels and paths for decision-making, IPE focuses on the immutable security properties inherent to system components. These properties are fundamental attributes or features of a system component that cannot be altered, ensuring a consistent and reliable basis for security decisions.h]hXIntegrity Policy Enforcement (IPE) is a Linux Security Module that takes a complementary approach to access control. Unlike traditional access control mechanisms that rely on labels and paths for decision-making, IPE focuses on the immutable security properties inherent to system components. These properties are fundamental attributes or features of a system component that cannot be altered, ensuring a consistent and reliable basis for security decisions.}(hj3hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj"hhubh)}(hX|To elaborate, in the context of IPE, system components primarily refer to files or the devices these files reside on. However, this is just a starting point. The concept of system components is flexible and can be extended to include new elements as the system evolves. The immutable properties include the origin of a file, which remains constant and unchangeable over time. For example, IPE policies can be crafted to trust files originating from the initramfs. Since initramfs is typically verified by the bootloader, its files are deemed trustworthy; "file is from initramfs" becomes an immutable property under IPE's consideration.h]hXTo elaborate, in the context of IPE, system components primarily refer to files or the devices these files reside on. However, this is just a starting point. The concept of system components is flexible and can be extended to include new elements as the system evolves. The immutable properties include the origin of a file, which remains constant and unchangeable over time. For example, IPE policies can be crafted to trust files originating from the initramfs. Since initramfs is typically verified by the bootloader, its files are deemed trustworthy; “file is from initramfs” becomes an immutable property under IPE’s consideration.}(hjAhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj"hhubh)}(hXThe immutable property concept extends to the security features enabled on a file's origin, such as dm-verity or fs-verity, which provide a layer of integrity and trust. For example, IPE allows the definition of policies that trust files from a dm-verity protected device. dm-verity ensures the integrity of an entire device by providing a verifiable and immutable state of its contents. Similarly, fs-verity offers filesystem-level integrity checks, allowing IPE to enforce policies that trust files protected by fs-verity. These two features cannot be turned off once established, so they are considered immutable properties. These examples demonstrate how IPE leverages immutable properties, such as a file's origin and its integrity protection mechanisms, to make access control decisions.h]hXThe immutable property concept extends to the security features enabled on a file’s origin, such as dm-verity or fs-verity, which provide a layer of integrity and trust. For example, IPE allows the definition of policies that trust files from a dm-verity protected device. dm-verity ensures the integrity of an entire device by providing a verifiable and immutable state of its contents. Similarly, fs-verity offers filesystem-level integrity checks, allowing IPE to enforce policies that trust files protected by fs-verity. These two features cannot be turned off once established, so they are considered immutable properties. These examples demonstrate how IPE leverages immutable properties, such as a file’s origin and its integrity protection mechanisms, to make access control decisions.}(hjOhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK!hj"hhubh)}(hXFor the IPE policy, specifically, it grants the ability to enforce stringent access controls by assessing security properties against reference values defined within the policy. This assessment can be based on the existence of a security property (e.g., verifying if a file originates from initramfs) or evaluating the internal state of an immutable security property. The latter includes checking the roothash of a dm-verity protected device, determining whether dm-verity possesses a valid signature, assessing the digest of a fs-verity protected file, or determining whether fs-verity possesses a valid built-in signature. This nuanced approach to policy enforcement enables a highly secure and customizable system defense mechanism, tailored to specific security requirements and trust models.h]hXFor the IPE policy, specifically, it grants the ability to enforce stringent access controls by assessing security properties against reference values defined within the policy. This assessment can be based on the existence of a security property (e.g., verifying if a file originates from initramfs) or evaluating the internal state of an immutable security property. The latter includes checking the roothash of a dm-verity protected device, determining whether dm-verity possesses a valid signature, assessing the digest of a fs-verity protected file, or determining whether fs-verity possesses a valid built-in signature. This nuanced approach to policy enforcement enables a highly secure and customizable system defense mechanism, tailored to specific security requirements and trust models.}(hj]hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK-hj"hhubh)}(hTo enable IPE, ensure that ``CONFIG_SECURITY_IPE`` (under :menuselection:`Security -> Integrity Policy Enforcement (IPE)`) config option is enabled.h](hTo enable IPE, ensure that }(hjkhhhNhNubhliteral)}(h``CONFIG_SECURITY_IPE``h]hCONFIG_SECURITY_IPE}(hjuhhhNhNubah}(h]h ]h"]h$]h&]uh1jshjkubh (under }(hjkhhhNhNubh)}(h.Security -> Integrity Policy Enforcement (IPE)h]h.Security -> Integrity Policy Enforcement (IPE)}(hjhhhNhNubah}(h]h ] menuselectionah"]h$]h&]rawtext?:menuselection:`Security -> Integrity Policy Enforcement (IPE)`uh1hhjkubh) config option is enabled.}(hjkhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhK:hj"hhubeh}(h]overviewah ]h"]overviewah$]h&]uh1hhhhhhhhK ubh)}(hhh](h)}(h Use Casesh]h Use Cases}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhK?ubh)}(hXIPE works best in fixed-function devices: devices in which their purpose is clearly defined and not supposed to be changed (e.g. network firewall device in a data center, an IoT device, etcetera), where all software and configuration is built and provisioned by the system owner.h]hXIPE works best in fixed-function devices: devices in which their purpose is clearly defined and not supposed to be changed (e.g. network firewall device in a data center, an IoT device, etcetera), where all software and configuration is built and provisioned by the system owner.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKAhjhhubh)}(hX^IPE is a long-way off for use in general-purpose computing: the Linux community as a whole tends to follow a decentralized trust model (known as the web of trust), which IPE has no support for it yet. Instead, IPE supports PKI (public key infrastructure), which generally designates a set of trusted entities that provide a measure of absolute trust.h]hX^IPE is a long-way off for use in general-purpose computing: the Linux community as a whole tends to follow a decentralized trust model (known as the web of trust), which IPE has no support for it yet. Instead, IPE supports PKI (public key infrastructure), which generally designates a set of trusted entities that provide a measure of absolute trust.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKFhjhhubh)}(hX5Additionally, while most packages are signed today, the files inside the packages (for instance, the executables), tend to be unsigned. This makes it difficult to utilize IPE in systems where a package manager is expected to be functional, without major changes to the package manager and ecosystem behind it.h]hX5Additionally, while most packages are signed today, the files inside the packages (for instance, the executables), tend to be unsigned. This makes it difficult to utilize IPE in systems where a package manager is expected to be functional, without major changes to the package manager and ecosystem behind it.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKLhjhhubh)}(hThe digest_cache LSM [#digest_cache_lsm]_ is a system that when combined with IPE, could be used to enable and support general-purpose computing use cases.h](hThe digest_cache LSM }(hjhhhNhNubhfootnote_reference)}(h[#digest_cache_lsm]_h]h1}(hjhhhNhNubah}(h]id1ah ]h"]h$]h&]autoKrefiddigest-cache-lsmdocnamej uh1jhjresolvedKubhr is a system that when combined with IPE, could be used to enable and support general-purpose computing use cases.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKRhjhhubeh}(h] use-casesah ]h"] use casesah$]h&]uh1hhhhhhhhK?ubh)}(hhh](h)}(hKnown Limitationsh]hKnown Limitations}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhKVubh)}(hXIPE cannot verify the integrity of anonymous executable memory, such as the trampolines created by gcc closures and libffi (<3.4.2), or JIT'd code. Unfortunately, as this is dynamically generated code, there is no way for IPE to ensure the integrity of this code to form a trust basis.h]hXIPE cannot verify the integrity of anonymous executable memory, such as the trampolines created by gcc closures and libffi (<3.4.2), or JIT’d code. Unfortunately, as this is dynamically generated code, there is no way for IPE to ensure the integrity of this code to form a trust basis.}(hj&hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKXhjhhubh)}(hXIPE cannot verify the integrity of programs written in interpreted languages when these scripts are invoked by passing these program files to the interpreter. This is because the way interpreters execute these files; the scripts themselves are not evaluated as executable code through one of IPE's hooks, but they are merely text files that are read (as opposed to compiled executables). However, with the introduction of the ``AT_EXECVE_CHECK`` flag (:doc:`AT_EXECVE_CHECK `), interpreters can use it to signal the kernel that a script file will be executed, and request the kernel to perform LSM security checks on it.h](hXIPE cannot verify the integrity of programs written in interpreted languages when these scripts are invoked by passing these program files to the interpreter. This is because the way interpreters execute these files; the scripts themselves are not evaluated as executable code through one of IPE’s hooks, but they are merely text files that are read (as opposed to compiled executables). However, with the introduction of the }(hj4hhhNhNubjt)}(h``AT_EXECVE_CHECK``h]hAT_EXECVE_CHECK}(hj<hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj4ubh flag (}(hj4hhhNhNubh)}(h2:doc:`AT_EXECVE_CHECK `h]h)}(hjPh]hAT_EXECVE_CHECK}(hjRhhhNhNubah}(h]h ](hstdstd-doceh"]h$]h&]uh1hhjNubah}(h]h ]h"]h$]h&]refdocj  refdomainj\reftypedoc refexplicitrefwarnj/userspace-api/check_execuh1hhhhK]hj4ubh), interpreters can use it to signal the kernel that a script file will be executed, and request the kernel to perform LSM security checks on it.}(hj4hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhK]hjhhubh)}(hXIPE's EXECUTE operation enforcement differs between compiled executables and interpreted scripts: For compiled executables, enforcement is triggered automatically by the kernel during ``execve()``, ``execveat()``, ``mmap()`` and ``mprotect()`` syscalls when loading executable content. For interpreted scripts, enforcement requires explicit interpreter integration using ``execveat()`` with ``AT_EXECVE_CHECK`` flag. Unlike exec syscalls that IPE intercepts during the execution process, this mechanism needs the interpreter to take the initiative, and existing interpreters won't be automatically supported unless the signal call is added.h](hIPE’s EXECUTE operation enforcement differs between compiled executables and interpreted scripts: For compiled executables, enforcement is triggered automatically by the kernel during }(hjxhhhNhNubjt)}(h ``execve()``h]hexecve()}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jshjxubh, }(hjxhhhNhNubjt)}(h``execveat()``h]h execveat()}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jshjxubh, }hjxsbjt)}(h ``mmap()``h]hmmap()}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jshjxubh and }(hjxhhhNhNubjt)}(h``mprotect()``h]h mprotect()}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jshjxubh syscalls when loading executable content. For interpreted scripts, enforcement requires explicit interpreter integration using }(hjxhhhNhNubjt)}(h``execveat()``h]h execveat()}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jshjxubh with }(hjxhhhNhNubjt)}(h``AT_EXECVE_CHECK``h]hAT_EXECVE_CHECK}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jshjxubh flag. Unlike exec syscalls that IPE intercepts during the execution process, this mechanism needs the interpreter to take the initiative, and existing interpreters won’t be automatically supported unless the signal call is added.}(hjxhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKghjhhubeh}(h]known-limitationsah ]h"]known limitationsah$]h&]uh1hhhhhhhhKVubh)}(hhh](h)}(h Threat Modelh]h Threat Model}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhKrubh)}(hIPE specifically targets the risk of tampering with user-space executable code after the kernel has initially booted, including the kernel modules loaded from userspace via ``modprobe`` or ``insmod``.h](hIPE specifically targets the risk of tampering with user-space executable code after the kernel has initially booted, including the kernel modules loaded from userspace via }(hj hhhNhNubjt)}(h ``modprobe``h]hmodprobe}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jshj ubh or }(hj hhhNhNubjt)}(h ``insmod``h]hinsmod}(hj%hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj ubh.}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKthjhhubh)}(hXTo illustrate, consider a scenario where an untrusted binary, possibly malicious, is downloaded along with all necessary dependencies, including a loader and libc. The primary function of IPE in this context is to prevent the execution of such binaries and their dependencies.h]hXTo illustrate, consider a scenario where an untrusted binary, possibly malicious, is downloaded along with all necessary dependencies, including a loader and libc. The primary function of IPE in this context is to prevent the execution of such binaries and their dependencies.}(hj=hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKxhjhhubh)}(hXSIPE achieves this by verifying the integrity and authenticity of all executable code before allowing them to run. It conducts a thorough check to ensure that the code's integrity is intact and that they match an authorized reference value (digest, signature, etc) as per the defined policy. If a binary does not pass this verification process, either because its integrity has been compromised or it does not meet the authorization criteria, IPE will deny its execution. Additionally, IPE generates audit logs which may be utilized to detect and analyze failures resulting from policy violation.h]hXUIPE achieves this by verifying the integrity and authenticity of all executable code before allowing them to run. It conducts a thorough check to ensure that the code’s integrity is intact and that they match an authorized reference value (digest, signature, etc) as per the defined policy. If a binary does not pass this verification process, either because its integrity has been compromised or it does not meet the authorization criteria, IPE will deny its execution. Additionally, IPE generates audit logs which may be utilized to detect and analyze failures resulting from policy violation.}(hjKhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhK}hjhhubh)}(hqTampering threat scenarios include modification or replacement of executable code by a range of actors including:h]hqTampering threat scenarios include modification or replacement of executable code by a range of actors including:}(hjYhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjhhubh bullet_list)}(hhh](h list_item)}(h+Actors with physical access to the hardwareh]h)}(hjph]h+Actors with physical access to the hardware}(hjrhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjnubah}(h]h ]h"]h$]h&]uh1jlhjihhhhhNubjm)}(h.Actors with local network access to the systemh]h)}(hjh]h.Actors with local network access to the system}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jlhjihhhhhNubjm)}(h+Actors with access to the deployment systemh]h)}(hjh]h+Actors with access to the deployment system}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jlhjihhhhhNubjm)}(h3Compromised internal systems under external controlh]h)}(hjh]h3Compromised internal systems under external control}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jlhjihhhhhNubjm)}(h!Malicious end users of the systemh]h)}(hjh]h!Malicious end users of the system}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jlhjihhhhhNubjm)}(h#Compromised end users of the systemh]h)}(hjh]h#Compromised end users of the system}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jlhjihhhhhNubjm)}(h+Remote (external) compromise of the system h]h)}(h*Remote (external) compromise of the systemh]h*Remote (external) compromise of the system}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jlhjihhhhhNubeh}(h]h ]h"]h$]h&]bullet-uh1jghhhKhjhhubh)}(hXIPE does not mitigate threats arising from malicious but authorized developers (with access to a signing certificate), or compromised developer tools used by them (i.e. return-oriented programming attacks). Additionally, IPE draws hard security boundary between userspace and kernelspace. As a result, kernel-level exploits are considered outside the scope of IPE and mitigation is left to other mechanisms.h]hXIPE does not mitigate threats arising from malicious but authorized developers (with access to a signing certificate), or compromised developer tools used by them (i.e. return-oriented programming attacks). Additionally, IPE draws hard security boundary between userspace and kernelspace. As a result, kernel-level exploits are considered outside the scope of IPE and mitigation is left to other mechanisms.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjhhubeh}(h] threat-modelah ]h"] threat modelah$]h&]uh1hhhhhhhhKrubh)}(hhh](h)}(hPolicyh]hPolicy}(hj1hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj.hhhhhKubh)}(hIPE policy is a plain-text [#devdoc]_ policy composed of multiple statements over several lines. There is one required line, at the top of the policy, indicating the policy name, and the policy version, for instance::h](hIPE policy is a plain-text }(hj?hhhNhNubj)}(h [#devdoc]_h]h2}(hjGhhhNhNubah}(h]id2ah ]h"]h$]h&]jKjdevdocjj uh1jhj?jKubh policy composed of multiple statements over several lines. There is one required line, at the top of the policy, indicating the policy name, and the policy version, for instance:}(hj?hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhj.hhubh literal_block)}(h*policy_name=Ex_Policy policy_version=0.0.0h]h*policy_name=Ex_Policy policy_version=0.0.0}hjcsbah}(h]h ]h"]h$]h&]hhuh1jahhhKhj.hhubh)}(hThe policy name is a unique key identifying this policy in a human readable name. This is used to create nodes under securityfs as well as uniquely identify policies to deploy new policies vs update existing policies.h]hThe policy name is a unique key identifying this policy in a human readable name. This is used to create nodes under securityfs as well as uniquely identify policies to deploy new policies vs update existing policies.}(hjqhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj.hhubh)}(hThe policy version indicates the current version of the policy (NOT the policy syntax version). This is used to prevent rollback of policy to potentially insecure previous versions of the policy.h]hThe policy version indicates the current version of the policy (NOT the policy syntax version). This is used to prevent rollback of policy to potentially insecure previous versions of the policy.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj.hhubh)}(hXThe next portion of IPE policy are rules. Rules are formed by key=value pairs, known as properties. IPE rules require two properties: ``action``, which determines what IPE does when it encounters a match against the rule, and ``op``, which determines when the rule should be evaluated. The ordering is significant, a rule must start with ``op``, and end with ``action``. Thus, a minimal rule is::h](hThe next portion of IPE policy are rules. Rules are formed by key=value pairs, known as properties. IPE rules require two properties: }(hjhhhNhNubjt)}(h ``action``h]haction}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jshjubhR, which determines what IPE does when it encounters a match against the rule, and }(hjhhhNhNubjt)}(h``op``h]hop}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jshjubhj, which determines when the rule should be evaluated. The ordering is significant, a rule must start with }(hjhhhNhNubjt)}(h``op``h]hop}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jshjubh, and end with }(hjhhhNhNubjt)}(h ``action``h]haction}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jshjubh. Thus, a minimal rule is:}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhj.hhubjb)}(hop=EXECUTE action=ALLOWh]hop=EXECUTE action=ALLOW}hjsbah}(h]h ]h"]h$]h&]hhuh1jahhhKhj.hhubh)}(hXlThis example will allow any execution. Additional properties are used to assess immutable security properties about the files being evaluated. These properties are intended to be descriptions of systems within the kernel that can provide a measure of integrity verification, such that IPE can determine the trust of the resource based on the value of the property.h]hXlThis example will allow any execution. Additional properties are used to assess immutable security properties about the files being evaluated. These properties are intended to be descriptions of systems within the kernel that can provide a measure of integrity verification, such that IPE can determine the trust of the resource based on the value of the property.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj.hhubh)}(hRules are evaluated top-to-bottom. As a result, any revocation rules, or denies should be placed early in the file to ensure that these rules are evaluated before a rule with ``action=ALLOW``.h](hRules are evaluated top-to-bottom. As a result, any revocation rules, or denies should be placed early in the file to ensure that these rules are evaluated before a rule with }(hjhhhNhNubjt)}(h``action=ALLOW``h]h action=ALLOW}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jshjubh.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhj.hhubh)}(hIPE policy supports comments. The character '#' will function as a comment, ignoring all characters to the right of '#' until the newline.h]hIPE policy supports comments. The character ‘#’ will function as a comment, ignoring all characters to the right of ‘#’ until the newline.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj.hhubh)}(hThe default behavior of IPE evaluations can also be expressed in policy, through the ``DEFAULT`` statement. This can be done at a global level, or a per-operation level::h](hUThe default behavior of IPE evaluations can also be expressed in policy, through the }(hj-hhhNhNubjt)}(h ``DEFAULT``h]hDEFAULT}(hj5hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj-ubhI statement. This can be done at a global level, or a per-operation level:}(hj-hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhj.hhubjb)}(hS# Global DEFAULT action=ALLOW # Operation Specific DEFAULT op=EXECUTE action=ALLOWh]hS# Global DEFAULT action=ALLOW # Operation Specific DEFAULT op=EXECUTE action=ALLOW}hjMsbah}(h]h ]h"]h$]h&]hhuh1jahhhKhj.hhubh)}(hXA default must be set for all known operations in IPE. If you want to preserve older policies being compatible with newer kernels that can introduce new operations, set a global default of ``ALLOW``, then override the defaults on a per-operation basis (as above).h](hA default must be set for all known operations in IPE. If you want to preserve older policies being compatible with newer kernels that can introduce new operations, set a global default of }(hj[hhhNhNubjt)}(h ``ALLOW``h]hALLOW}(hjchhhNhNubah}(h]h ]h"]h$]h&]uh1jshj[ubhA, then override the defaults on a per-operation basis (as above).}(hj[hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhj.hhubh)}(hWith configurable policy-based LSMs, there's several issues with enforcing the configurable policies at startup, around reading and parsing the policy:h]hWith configurable policy-based LSMs, there’s several issues with enforcing the configurable policies at startup, around reading and parsing the policy:}(hj{hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhj.hhubhenumerated_list)}(hhh](jm)}(heThe kernel *should* not read files from userspace, so directly reading the policy file is prohibited.h]h)}(heThe kernel *should* not read files from userspace, so directly reading the policy file is prohibited.h](h The kernel }(hjhhhNhNubhemphasis)}(h*should*h]hshould}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubhR not read files from userspace, so directly reading the policy file is prohibited.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jlhjhhhhhNubjm)}(hThe kernel command line has a character limit, and one kernel module should not reserve the entire character limit for its own configuration.h]h)}(hThe kernel command line has a character limit, and one kernel module should not reserve the entire character limit for its own configuration.h]hThe kernel command line has a character limit, and one kernel module should not reserve the entire character limit for its own configuration.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jlhjhhhhhNubjm)}(hsThere are various boot loaders in the kernel ecosystem, so handing off a memory block would be costly to maintain. h]h)}(hrThere are various boot loaders in the kernel ecosystem, so handing off a memory block would be costly to maintain.h]hrThere are various boot loaders in the kernel ecosystem, so handing off a memory block would be costly to maintain.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhKhjubah}(h]h ]h"]h$]h&]uh1jlhjhhhhhNubeh}(h]h ]h"]h$]h&]enumtypearabicprefixhsuffix.uh1jhj.hhhhhKubh)}(hXuAs a result, IPE has addressed this problem through a concept of a "boot policy". A boot policy is a minimal policy which is compiled into the kernel. This policy is intended to get the system to a state where userspace is set up and ready to receive commands, at which point a more complex policy can be deployed via securityfs. The boot policy can be specified via ``SECURITY_IPE_BOOT_POLICY`` config option, which accepts a path to a plain-text version of the IPE policy to apply. This policy will be compiled into the kernel. If not specified, IPE will be disabled until a policy is deployed and activated through securityfs.h](hXsAs a result, IPE has addressed this problem through a concept of a “boot policy”. A boot policy is a minimal policy which is compiled into the kernel. This policy is intended to get the system to a state where userspace is set up and ready to receive commands, at which point a more complex policy can be deployed via securityfs. The boot policy can be specified via }(hjhhhNhNubjt)}(h``SECURITY_IPE_BOOT_POLICY``h]hSECURITY_IPE_BOOT_POLICY}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jshjubh config option, which accepts a path to a plain-text version of the IPE policy to apply. This policy will be compiled into the kernel. If not specified, IPE will be disabled until a policy is deployed and activated through securityfs.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhj.hhubh)}(hhh](h)}(hDeploying Policiesh]hDeploying Policies}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhKubh)}(hXAPolicies can be deployed from userspace through securityfs. These policies are signed through the PKCS#7 message format to enforce some level of authorization of the policies (prohibiting an attacker from gaining unconstrained root, and deploying an "allow all" policy). These policies must be signed by a certificate that chains to the ``SYSTEM_TRUSTED_KEYRING``, or to the secondary and/or platform keyrings if ``CONFIG_IPE_POLICY_SIG_SECONDARY_KEYRING`` and/or ``CONFIG_IPE_POLICY_SIG_PLATFORM_KEYRING`` are enabled, respectively. With openssl, the policy can be signed by::h](hXUPolicies can be deployed from userspace through securityfs. These policies are signed through the PKCS#7 message format to enforce some level of authorization of the policies (prohibiting an attacker from gaining unconstrained root, and deploying an “allow all” policy). These policies must be signed by a certificate that chains to the }(hj&hhhNhNubjt)}(h``SYSTEM_TRUSTED_KEYRING``h]hSYSTEM_TRUSTED_KEYRING}(hj.hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj&ubh2, or to the secondary and/or platform keyrings if }(hj&hhhNhNubjt)}(h+``CONFIG_IPE_POLICY_SIG_SECONDARY_KEYRING``h]h'CONFIG_IPE_POLICY_SIG_SECONDARY_KEYRING}(hj@hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj&ubh and/or }(hj&hhhNhNubjt)}(h*``CONFIG_IPE_POLICY_SIG_PLATFORM_KEYRING``h]h&CONFIG_IPE_POLICY_SIG_PLATFORM_KEYRING}(hjRhhhNhNubah}(h]h ]h"]h$]h&]uh1jshj&ubhF are enabled, respectively. With openssl, the policy can be signed by:}(hj&hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhjhhubjb)}(hopenssl smime -sign \ -in "$MY_POLICY" \ -signer "$MY_CERTIFICATE" \ -inkey "$MY_PRIVATE_KEY" \ -noattr \ -nodetach \ -nosmimecap \ -outform der \ -out "$MY_POLICY.p7b"h]hopenssl smime -sign \ -in "$MY_POLICY" \ -signer "$MY_CERTIFICATE" \ -inkey "$MY_PRIVATE_KEY" \ -noattr \ -nodetach \ -nosmimecap \ -outform der \ -out "$MY_POLICY.p7b"}hjjsbah}(h]h ]h"]h$]h&]hhuh1jahhhKhjhhubh)}(hDeploying the policies is done through securityfs, through the ``new_policy`` node. To deploy a policy, simply cat the file into the securityfs node::h](h?Deploying the policies is done through securityfs, through the }(hjxhhhNhNubjt)}(h``new_policy``h]h new_policy}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jshjxubhH node. To deploy a policy, simply cat the file into the securityfs node:}(hjxhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhKhjhhubjb)}(h:cat "$MY_POLICY.p7b" > /sys/kernel/security/ipe/new_policyh]h:cat "$MY_POLICY.p7b" > /sys/kernel/security/ipe/new_policy}hjsbah}(h]h ]h"]h$]h&]hhuh1jahhhMhjhhubh)}(hXUpon success, this will create one subdirectory under ``/sys/kernel/security/ipe/policies/``. The subdirectory will be the ``policy_name`` field of the policy deployed, so for the example above, the directory will be ``/sys/kernel/security/ipe/policies/Ex_Policy``. Within this directory, there will be seven files: ``pkcs7``, ``policy``, ``name``, ``version``, ``active``, ``update``, and ``delete``.h](h6Upon success, this will create one subdirectory under }(hjhhhNhNubjt)}(h&``/sys/kernel/security/ipe/policies/``h]h"/sys/kernel/security/ipe/policies/}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jshjubh. The subdirectory will be the }(hjhhhNhNubjt)}(h``policy_name``h]h policy_name}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jshjubhO field of the policy deployed, so for the example above, the directory will be }(hjhhhNhNubjt)}(h/``/sys/kernel/security/ipe/policies/Ex_Policy``h]h+/sys/kernel/security/ipe/policies/Ex_Policy}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jshjubh4. Within this directory, there will be seven files: }(hjhhhNhNubjt)}(h ``pkcs7``h]hpkcs7}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jshjubh, }(hjhhhNhNubjt)}(h ``policy``h]hpolicy}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jshjubh, }(hjhhhNhNubjt)}(h``name``h]hname}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jshjubh, }hjsbjt)}(h ``version``h]hversion}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jshjubh, }hjsbjt)}(h ``active``h]hactive}(hj,hhhNhNubah}(h]h ]h"]h$]h&]uh1jshjubh, }hjsbjt)}(h ``update``h]hupdate}(hj>hhhNhNubah}(h]h ]h"]h$]h&]uh1jshjubh, and }(hjhhhNhNubjt)}(h ``delete``h]hdelete}(hjPhhhNhNubah}(h]h ]h"]h$]h&]uh1jshjubh.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjhhubh)}(hThe ``pkcs7`` file is read-only. Reading it returns the raw PKCS#7 data that was provided to the kernel, representing the policy. If the policy being read is the boot policy, this will return ``ENOENT``, as it is not signed.h](hThe }(hjhhhhNhNubjt)}(h ``pkcs7``h]hpkcs7}(hjphhhNhNubah}(h]h ]h"]h$]h&]uh1jshjhubh file is read-only. Reading it returns the raw PKCS#7 data that was provided to the kernel, representing the policy. If the policy being read is the boot policy, this will return }(hjhhhhNhNubjt)}(h ``ENOENT``h]hENOENT}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jshjhubh, as it is not signed.}(hjhhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhM hjhhubh)}(hThe ``policy`` file is read only. Reading it returns the PKCS#7 inner content of the policy, which will be the plain text policy.h](hThe }(hjhhhNhNubjt)}(h ``policy``h]hpolicy}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jshjubhs file is read only. Reading it returns the PKCS#7 inner content of the policy, which will be the plain text policy.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjhhubh)}(hXgThe ``active`` file is used to set a policy as the currently active policy. This file is rw, and accepts a value of ``"1"`` to set the policy as active. Since only a single policy can be active at one time, all other policies will be marked inactive. The policy being marked active must have a policy version greater or equal to the currently-running version.h](hThe }(hjhhhNhNubjt)}(h ``active``h]hactive}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jshjubhf file is used to set a policy as the currently active policy. This file is rw, and accepts a value of }(hjhhhNhNubjt)}(h``"1"``h]h"1"}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jshjubh to set the policy as active. Since only a single policy can be active at one time, all other policies will be marked inactive. The policy being marked active must have a policy version greater or equal to the currently-running version.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjhhubh)}(hXThe ``update`` file is used to update a policy that is already present in the kernel. This file is write-only and accepts a PKCS#7 signed policy. Two checks will always be performed on this policy: First, the ``policy_names`` must match with the updated version and the existing version. Second the updated policy must have a policy version greater than the currently-running version. This is to prevent rollback attacks.h](hThe }(hjhhhNhNubjt)}(h ``update``h]hupdate}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jshjubh file is used to update a policy that is already present in the kernel. This file is write-only and accepts a PKCS#7 signed policy. Two checks will always be performed on this policy: First, the }(hjhhhNhNubjt)}(h``policy_names``h]h policy_names}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jshjubh must match with the updated version and the existing version. Second the updated policy must have a policy version greater than the currently-running version. This is to prevent rollback attacks.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjhhubh)}(hXHThe ``delete`` file is used to remove a policy that is no longer needed. This file is write-only and accepts a value of ``1`` to delete the policy. On deletion, the securityfs node representing the policy will be removed. However, delete the current active policy is not allowed and will return an operation not permitted error.h](hThe }(hjhhhNhNubjt)}(h ``delete``h]hdelete}(hj&hhhNhNubah}(h]h ]h"]h$]h&]uh1jshjubhj file is used to remove a policy that is no longer needed. This file is write-only and accepts a value of }(hjhhhNhNubjt)}(h``1``h]h1}(hj8hhhNhNubah}(h]h ]h"]h$]h&]uh1jshjubh to delete the policy. On deletion, the securityfs node representing the policy will be removed. However, delete the current active policy is not allowed and will return an operation not permitted error.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjhhubh)}(hXSimilarly, writing to both ``update`` and ``new_policy`` could result in bad message(policy syntax error) or file exists error. The latter error happens when trying to deploy a policy with a ``policy_name`` while the kernel already has a deployed policy with the same ``policy_name``.h](hSimilarly, writing to both }(hjPhhhNhNubjt)}(h ``update``h]hupdate}(hjXhhhNhNubah}(h]h ]h"]h$]h&]uh1jshjPubh and }(hjPhhhNhNubjt)}(h``new_policy``h]h new_policy}(hjjhhhNhNubah}(h]h ]h"]h$]h&]uh1jshjPubh could result in bad message(policy syntax error) or file exists error. The latter error happens when trying to deploy a policy with a }(hjPhhhNhNubjt)}(h``policy_name``h]h policy_name}(hj|hhhNhNubah}(h]h ]h"]h$]h&]uh1jshjPubh> while the kernel already has a deployed policy with the same }(hjPhhhNhNubjt)}(h``policy_name``h]h policy_name}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jshjPubh.}(hjPhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhM%hjhhubh)}(hDeploying a policy will *not* cause IPE to start enforcing the policy. IPE will only enforce the policy marked active. Note that only one policy can be active at a time.h](hDeploying a policy will }(hjhhhNhNubj)}(h*not*h]hnot}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jhjubh cause IPE to start enforcing the policy. IPE will only enforce the policy marked active. Note that only one policy can be active at a time.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhM*hjhhubh)}(hOnce deployment is successful, the policy can be activated, by writing file ``/sys/kernel/security/ipe/policies/$policy_name/active``. For example, the ``Ex_Policy`` can be activated by::h](hLOnce deployment is successful, the policy can be activated, by writing file }(hjhhhNhNubjt)}(h9``/sys/kernel/security/ipe/policies/$policy_name/active``h]h5/sys/kernel/security/ipe/policies/$policy_name/active}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jshjubh. For example, the }(hjhhhNhNubjt)}(h ``Ex_Policy``h]h Ex_Policy}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jshjubh can be activated by:}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhM.hjhhubjb)}(h=echo 1 > "/sys/kernel/security/ipe/policies/Ex_Policy/active"h]h=echo 1 > "/sys/kernel/security/ipe/policies/Ex_Policy/active"}hjsbah}(h]h ]h"]h$]h&]hhuh1jahhhM2hjhhubh)}(hLFrom above point on, ``Ex_Policy`` is now the enforced policy on the system.h](hFrom above point on, }(hj hhhNhNubjt)}(h ``Ex_Policy``h]h Ex_Policy}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj ubh* is now the enforced policy on the system.}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhM4hjhhubh)}(hIPE also provides a way to delete policies. This can be done via the ``delete`` securityfs node, ``/sys/kernel/security/ipe/policies/$policy_name/delete``. Writing ``1`` to that file deletes the policy::h](hEIPE also provides a way to delete policies. This can be done via the }(hj& hhhNhNubjt)}(h ``delete``h]hdelete}(hj. hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj& ubh securityfs node, }(hj& hhhNhNubjt)}(h9``/sys/kernel/security/ipe/policies/$policy_name/delete``h]h5/sys/kernel/security/ipe/policies/$policy_name/delete}(hj@ hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj& ubh . Writing }(hj& hhhNhNubjt)}(h``1``h]h1}(hjR hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj& ubh! to that file deletes the policy:}(hj& hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhM7hjhhubjb)}(h@echo 1 > "/sys/kernel/security/ipe/policies/$policy_name/delete"h]h@echo 1 > "/sys/kernel/security/ipe/policies/$policy_name/delete"}hjj sbah}(h]h ]h"]h$]h&]hhuh1jahhhM<hjhhubh)}(h\There is only one requirement to delete a policy: the policy being deleted must be inactive.h]h\There is only one requirement to delete a policy: the policy being deleted must be inactive.}(hjx hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM>hjhhubh)}(hIf a traditional MAC system is enabled (SELinux, apparmor, smack), all writes to ipe's securityfs nodes require ``CAP_MAC_ADMIN``.h]h)}(hIf a traditional MAC system is enabled (SELinux, apparmor, smack), all writes to ipe's securityfs nodes require ``CAP_MAC_ADMIN``.h](hrIf a traditional MAC system is enabled (SELinux, apparmor, smack), all writes to ipe’s securityfs nodes require }(hj hhhNhNubjt)}(h``CAP_MAC_ADMIN``h]h CAP_MAC_ADMIN}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj ubh.}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMChj ubah}(h]h ]h"]h$]h&]uh1hhjhhhhhNubeh}(h]deploying-policiesah ]h"]deploying policiesah$]h&]uh1hhj.hhhhhKubh)}(hhh](h)}(hModesh]hModes}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj hhhhhMGubh)}(hXIPE supports two modes of operation: permissive (similar to SELinux's permissive mode) and enforced. In permissive mode, all events are checked and policy violations are logged, but the policy is not really enforced. This allows users to test policies before enforcing them.h]hXIPE supports two modes of operation: permissive (similar to SELinux’s permissive mode) and enforced. In permissive mode, all events are checked and policy violations are logged, but the policy is not really enforced. This allows users to test policies before enforcing them.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMIhj hhubh)}(hThe default mode is enforce, and can be changed via the kernel command line parameter ``ipe.enforce=(0|1)``, or the securityfs node ``/sys/kernel/security/ipe/enforce``.h](hVThe default mode is enforce, and can be changed via the kernel command line parameter }(hj hhhNhNubjt)}(h``ipe.enforce=(0|1)``h]hipe.enforce=(0|1)}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj ubh, or the securityfs node }(hj hhhNhNubjt)}(h$``/sys/kernel/security/ipe/enforce``h]h /sys/kernel/security/ipe/enforce}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj ubh.}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMNhj hhubh)}(hIf a traditional MAC system is enabled (SELinux, apparmor, smack, etcetera), all writes to ipe's securityfs nodes require ``CAP_MAC_ADMIN``.h]h)}(hIf a traditional MAC system is enabled (SELinux, apparmor, smack, etcetera), all writes to ipe's securityfs nodes require ``CAP_MAC_ADMIN``.h](h|If a traditional MAC system is enabled (SELinux, apparmor, smack, etcetera), all writes to ipe’s securityfs nodes require }(hj hhhNhNubjt)}(h``CAP_MAC_ADMIN``h]h CAP_MAC_ADMIN}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj ubh.}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMThj ubah}(h]h ]h"]h$]h&]uh1hhj hhhhhNubeh}(h]modesah ]h"]modesah$]h&]uh1hhj.hhhhhMGubh)}(hhh](h)}(h Audit Eventsh]h Audit Events}(hj> hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj; hhhhhMXubh)}(hhh](h)}(h1420 AUDIT_IPE_ACCESSh]h1420 AUDIT_IPE_ACCESS}(hjO hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjL hhhhhM[ubh)}(hEvent Examples::h]hEvent Examples:}(hj] hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM\hjL hhubjb)}(hXwtype=1420 audit(1653364370.067:61): ipe_op=EXECUTE ipe_hook=MMAP enforcing=1 pid=2241 comm="ld-linux.so" path="/deny/lib/libc.so.6" dev="sda2" ino=14549020 rule="DEFAULT action=DENY" type=1300 audit(1653364370.067:61): SYSCALL arch=c000003e syscall=9 success=no exit=-13 a0=7f1105a28000 a1=195000 a2=5 a3=812 items=0 ppid=2219 pid=2241 auid=0 uid=0 gid=0 euid=0 suid=0 fsuid=0 egid=0 sgid=0 fsgid=0 tty=pts0 ses=2 comm="ld-linux.so" exe="/tmp/ipe-test/lib/ld-linux.so" subj=unconfined key=(null) type=1327 audit(1653364370.067:61): 707974686F6E3300746573742F6D61696E2E7079002D6E00 type=1420 audit(1653364735.161:64): ipe_op=EXECUTE ipe_hook=MMAP enforcing=1 pid=2472 comm="mmap_test" path=? dev=? ino=? rule="DEFAULT action=DENY" type=1300 audit(1653364735.161:64): SYSCALL arch=c000003e syscall=9 success=no exit=-13 a0=0 a1=1000 a2=4 a3=21 items=0 ppid=2219 pid=2472 auid=0 uid=0 gid=0 euid=0 suid=0 fsuid=0 egid=0 sgid=0 fsgid=0 tty=pts0 ses=2 comm="mmap_test" exe="/root/overlake_test/upstream_test/vol_fsverity/bin/mmap_test" subj=unconfined key=(null) type=1327 audit(1653364735.161:64): 707974686F6E3300746573742F6D61696E2E7079002D6E00h]hXwtype=1420 audit(1653364370.067:61): ipe_op=EXECUTE ipe_hook=MMAP enforcing=1 pid=2241 comm="ld-linux.so" path="/deny/lib/libc.so.6" dev="sda2" ino=14549020 rule="DEFAULT action=DENY" type=1300 audit(1653364370.067:61): SYSCALL arch=c000003e syscall=9 success=no exit=-13 a0=7f1105a28000 a1=195000 a2=5 a3=812 items=0 ppid=2219 pid=2241 auid=0 uid=0 gid=0 euid=0 suid=0 fsuid=0 egid=0 sgid=0 fsgid=0 tty=pts0 ses=2 comm="ld-linux.so" exe="/tmp/ipe-test/lib/ld-linux.so" subj=unconfined key=(null) type=1327 audit(1653364370.067:61): 707974686F6E3300746573742F6D61696E2E7079002D6E00 type=1420 audit(1653364735.161:64): ipe_op=EXECUTE ipe_hook=MMAP enforcing=1 pid=2472 comm="mmap_test" path=? dev=? ino=? rule="DEFAULT action=DENY" type=1300 audit(1653364735.161:64): SYSCALL arch=c000003e syscall=9 success=no exit=-13 a0=0 a1=1000 a2=4 a3=21 items=0 ppid=2219 pid=2472 auid=0 uid=0 gid=0 euid=0 suid=0 fsuid=0 egid=0 sgid=0 fsgid=0 tty=pts0 ses=2 comm="mmap_test" exe="/root/overlake_test/upstream_test/vol_fsverity/bin/mmap_test" subj=unconfined key=(null) type=1327 audit(1653364735.161:64): 707974686F6E3300746573742F6D61696E2E7079002D6E00}hjk sbah}(h]h ]h"]h$]h&]hhuh1jahhhM^hjL hhubh)}(hThis event indicates that IPE made an access control decision; the IPE specific record (1420) is always emitted in conjunction with a ``AUDITSYSCALL`` record.h](hThis event indicates that IPE made an access control decision; the IPE specific record (1420) is always emitted in conjunction with a }(hjy hhhNhNubjt)}(h``AUDITSYSCALL``h]h AUDITSYSCALL}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jshjy ubh record.}(hjy hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMfhjL hhubh)}(hDetermining whether IPE is in permissive or enforced mode can be derived from ``success`` property and exit code of the ``AUDITSYSCALL`` record.h](hNDetermining whether IPE is in permissive or enforced mode can be derived from }(hj hhhNhNubjt)}(h ``success``h]hsuccess}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj ubh property and exit code of the }(hj hhhNhNubjt)}(h``AUDITSYSCALL``h]h AUDITSYSCALL}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj ubh record.}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMjhjL hhubh)}(hField descriptions:h]hField descriptions:}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMnhjL hhubhtable)}(hhh]htgroup)}(hhh](hcolspec)}(hhh]h}(h]h ]h"]h$]h&]colwidthK uh1j hj ubj )}(hhh]h}(h]h ]h"]h$]h&]colwidthK uh1j hj ubj )}(hhh]h}(h]h ]h"]h$]h&]colwidthK uh1j hj ubj )}(hhh]h}(h]h ]h"]h$]h&]colwidthKQuh1j hj ubhthead)}(hhh]hrow)}(hhh](hentry)}(hhh]h)}(hFieldh]hField}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMqhj ubah}(h]h ]h"]h$]h&]uh1j hj ubj )}(hhh]h)}(h Value Typeh]h Value Type}(hj3 hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMqhj0 ubah}(h]h ]h"]h$]h&]uh1j hj ubj )}(hhh]h)}(h Optional?h]h Optional?}(hjJ hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMqhjG ubah}(h]h ]h"]h$]h&]uh1j hj ubj )}(hhh]h)}(hDescription of Valueh]hDescription of Value}(hja hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMqhj^ ubah}(h]h ]h"]h$]h&]uh1j hj ubeh}(h]h ]h"]h$]h&]uh1j hj ubah}(h]h ]h"]h$]h&]uh1j hj ubhtbody)}(hhh](j )}(hhh](j )}(hhh]h)}(hipe_oph]hipe_op}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMshj ubah}(h]h ]h"]h$]h&]uh1j hj ubj )}(hhh]h)}(hstringh]hstring}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMshj ubah}(h]h ]h"]h$]h&]uh1j hj ubj )}(hhh]h)}(hNoh]hNo}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMshj ubah}(h]h ]h"]h$]h&]uh1j hj ubj )}(hhh]h)}(h.The IPE operation name associated with the logh]h.The IPE operation name associated with the log}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMshj ubah}(h]h ]h"]h$]h&]uh1j hj ubeh}(h]h ]h"]h$]h&]uh1j hj ubj )}(hhh](j )}(hhh]h)}(hipe_hookh]hipe_hook}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMuhj ubah}(h]h ]h"]h$]h&]uh1j hj ubj )}(hhh]h)}(hstringh]hstring}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMuhj ubah}(h]h ]h"]h$]h&]uh1j hj ubj )}(hhh]h)}(hNoh]hNo}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMuhj ubah}(h]h ]h"]h$]h&]uh1j hj ubj )}(hhh]h)}(h5The name of the LSM hook that triggered the IPE eventh]h5The name of the LSM hook that triggered the IPE event}(hj6 hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMuhj3 ubah}(h]h ]h"]h$]h&]uh1j hj ubeh}(h]h ]h"]h$]h&]uh1j hj ubj )}(hhh](j )}(hhh]h)}(h enforcingh]h enforcing}(hjV hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMwhjS ubah}(h]h ]h"]h$]h&]uh1j hjP ubj )}(hhh]h)}(hintegerh]hinteger}(hjm hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMwhjj ubah}(h]h ]h"]h$]h&]uh1j hjP ubj )}(hhh]h)}(hNoh]hNo}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMwhj ubah}(h]h ]h"]h$]h&]uh1j hjP ubj )}(hhh]h)}(hOThe current IPE enforcing state 1 is in enforcing mode, 0 is in permissive modeh]hOThe current IPE enforcing state 1 is in enforcing mode, 0 is in permissive mode}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMwhj ubah}(h]h ]h"]h$]h&]uh1j hjP ubeh}(h]h ]h"]h$]h&]uh1j hj ubj )}(hhh](j )}(hhh]h)}(hpidh]hpid}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMyhj ubah}(h]h ]h"]h$]h&]uh1j hj ubj )}(hhh]h)}(hintegerh]hinteger}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMyhj ubah}(h]h ]h"]h$]h&]uh1j hj ubj )}(hhh]h)}(hNoh]hNo}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMyhj ubah}(h]h ]h"]h$]h&]uh1j hj ubj )}(hhh]h)}(h4The pid of the process that triggered the IPE event.h]h4The pid of the process that triggered the IPE event.}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMyhj ubah}(h]h ]h"]h$]h&]uh1j hj ubeh}(h]h ]h"]h$]h&]uh1j hj ubj )}(hhh](j )}(hhh]h)}(hcommh]hcomm}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM{hj ubah}(h]h ]h"]h$]h&]uh1j hj ubj )}(hhh]h)}(hstringh]hstring}(hj7 hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM{hj4 ubah}(h]h ]h"]h$]h&]uh1j hj ubj )}(hhh]h)}(hNoh]hNo}(hjN hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM{hjK ubah}(h]h ]h"]h$]h&]uh1j hj ubj )}(hhh]h)}(hIThe command line program name of the process that triggered the IPE eventh]hIThe command line program name of the process that triggered the IPE event}(hje hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM{hjb ubah}(h]h ]h"]h$]h&]uh1j hj ubeh}(h]h ]h"]h$]h&]uh1j hj ubj )}(hhh](j )}(hhh]h)}(hpathh]hpath}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM}hj ubah}(h]h ]h"]h$]h&]uh1j hj ubj )}(hhh]h)}(hstringh]hstring}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM}hj ubah}(h]h ]h"]h$]h&]uh1j hj ubj )}(hhh]h)}(hYesh]hYes}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM}hj ubah}(h]h ]h"]h$]h&]uh1j hj ubj )}(hhh]h)}(h'The absolute path to the evaluated fileh]h'The absolute path to the evaluated file}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM}hj ubah}(h]h ]h"]h$]h&]uh1j hj ubeh}(h]h ]h"]h$]h&]uh1j hj ubj )}(hhh](j )}(hhh]h)}(hinoh]hino}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj ubah}(h]h ]h"]h$]h&]uh1j hj ubj )}(hhh]h)}(hintegerh]hinteger}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj ubah}(h]h ]h"]h$]h&]uh1j hj ubj )}(hhh]h)}(hYesh]hYes}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j hj ubj )}(hhh]h)}(h&The inode number of the evaluated fileh]h&The inode number of the evaluated file}(hj/hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj,ubah}(h]h ]h"]h$]h&]uh1j hj ubeh}(h]h ]h"]h$]h&]uh1j hj ubj )}(hhh](j )}(hhh]h)}(hdevh]hdev}(hjOhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjLubah}(h]h ]h"]h$]h&]uh1j hjIubj )}(hhh]h)}(hstringh]hstring}(hjfhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjcubah}(h]h ]h"]h$]h&]uh1j hjIubj )}(hhh]h)}(hYesh]hYes}(hj}hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjzubah}(h]h ]h"]h$]h&]uh1j hjIubj )}(hhh]h)}(h/The device name of the evaluated file, e.g. vdah]h/The device name of the evaluated file, e.g. vda}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j hjIubeh}(h]h ]h"]h$]h&]uh1j hj ubj )}(hhh](j )}(hhh]h)}(hruleh]hrule}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh]h)}(hstringh]hstring}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh]h)}(hNoh]hNo}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh]h)}(hThe matched policy ruleh]hThe matched policy rule2}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j hjubeh}(h]h ]h"]h$]h&]uh1j hj ubeh}(h]h ]h"]h$]h&]uh1j hj ubeh}(h]h ]h"]h$]h&]colsKuh1j hj ubah}(h]h ]h"]h$]h&]uh1j hjL hhhhhNubeh}(h]audit-ipe-accessah ]h"]1420 audit_ipe_accessah$]h&]uh1hhj; hhhhhM[ubh)}(hhh](h)}(h1421 AUDIT_IPE_CONFIG_CHANGEh]h1421 AUDIT_IPE_CONFIG_CHANGE}(hj1hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj.hhhhhMubh)}(hEvent Example::h]hEvent Example:}(hj?hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj.hhubjb)}(hXtype=1421 audit(1653425583.136:54): old_active_pol_name="Allow_All" old_active_pol_version=0.0.0 old_policy_digest=sha256:E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855 new_active_pol_name="boot_verified" new_active_pol_version=0.0.0 new_policy_digest=sha256:820EEA5B40CA42B51F68962354BA083122A20BB846F26765076DD8EED7B8F4DB auid=4294967295 ses=4294967295 lsm=ipe res=1 type=1300 audit(1653425583.136:54): SYSCALL arch=c000003e syscall=1 success=yes exit=2 a0=3 a1=5596fcae1fb0 a2=2 a3=2 items=0 ppid=184 pid=229 auid=4294967295 uid=0 gid=0 euid=0 suid=0 fsuid=0 egid=0 sgid=0 fsgid=0 tty=pts0 ses=4294967295 comm="python3" exe="/usr/bin/python3.10" key=(null) type=1327 audit(1653425583.136:54): PROCTITLE proctitle=707974686F6E3300746573742F6D61696E2E7079002D66002E2h]hXtype=1421 audit(1653425583.136:54): old_active_pol_name="Allow_All" old_active_pol_version=0.0.0 old_policy_digest=sha256:E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855 new_active_pol_name="boot_verified" new_active_pol_version=0.0.0 new_policy_digest=sha256:820EEA5B40CA42B51F68962354BA083122A20BB846F26765076DD8EED7B8F4DB auid=4294967295 ses=4294967295 lsm=ipe res=1 type=1300 audit(1653425583.136:54): SYSCALL arch=c000003e syscall=1 success=yes exit=2 a0=3 a1=5596fcae1fb0 a2=2 a3=2 items=0 ppid=184 pid=229 auid=4294967295 uid=0 gid=0 euid=0 suid=0 fsuid=0 egid=0 sgid=0 fsgid=0 tty=pts0 ses=4294967295 comm="python3" exe="/usr/bin/python3.10" key=(null) type=1327 audit(1653425583.136:54): PROCTITLE proctitle=707974686F6E3300746573742F6D61696E2E7079002D66002E2}hjMsbah}(h]h ]h"]h$]h&]hhuh1jahhhMhj.hhubh)}(hXThis event indicates that IPE switched the active poliy from one to another along with the version and the hash digest of the two policies. Note IPE can only have one policy active at a time, all access decision evaluation is based on the current active policy. The normal procedure to deploy a new policy is loading the policy to deploy into the kernel first, then switch the active policy to it.h]hXThis event indicates that IPE switched the active poliy from one to another along with the version and the hash digest of the two policies. Note IPE can only have one policy active at a time, all access decision evaluation is based on the current active policy. The normal procedure to deploy a new policy is loading the policy to deploy into the kernel first, then switch the active policy to it.}(hj[hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj.hhubh)}(hkThis record will always be emitted in conjunction with a ``AUDITSYSCALL`` record for the ``write`` syscall.h](h9This record will always be emitted in conjunction with a }(hjihhhNhNubjt)}(h``AUDITSYSCALL``h]h AUDITSYSCALL}(hjqhhhNhNubah}(h]h ]h"]h$]h&]uh1jshjiubh record for the }(hjihhhNhNubjt)}(h ``write``h]hwrite}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jshjiubh syscall.}(hjihhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhj.hhubh)}(hField descriptions:h]hField descriptions:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj.hhubj )}(hhh]j )}(hhh](j )}(hhh]h}(h]h ]h"]h$]h&]colwidthKuh1j hjubj )}(hhh]h}(h]h ]h"]h$]h&]colwidthK uh1j hjubj )}(hhh]h}(h]h ]h"]h$]h&]colwidthK uh1j hjubj )}(hhh]h}(h]h ]h"]h$]h&]colwidthK3uh1j hjubj )}(hhh]j )}(hhh](j )}(hhh]h)}(hFieldh]hField}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh]h)}(h Value Typeh]h Value Type}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh]h)}(h Optional?h]h Optional?}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj ubah}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh]h)}(hDescription of Valueh]hDescription of Value}(hj%hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj"ubah}(h]h ]h"]h$]h&]uh1j hjubeh}(h]h ]h"]h$]h&]uh1j hjubah}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh](j )}(hhh](j )}(hhh]h)}(hold_active_pol_nameh]hold_active_pol_name}(hjNhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjKubah}(h]h ]h"]h$]h&]uh1j hjHubj )}(hhh]h)}(hstringh]hstring}(hjehhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjbubah}(h]h ]h"]h$]h&]uh1j hjHubj )}(hhh]h)}(hYesh]hYes}(hj|hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjyubah}(h]h ]h"]h$]h&]uh1j hjHubj )}(hhh]h)}(h"The name of previous active policyh]h"The name of previous active policy}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j hjHubeh}(h]h ]h"]h$]h&]uh1j hjEubj )}(hhh](j )}(hhh]h)}(hold_active_pol_versionh]hold_active_pol_version}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh]h)}(hstringh]hstring}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh]h)}(hYesh]hYes}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh]h)}(h%The version of previous active policyh]h%The version of previous active policy}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j hjubeh}(h]h ]h"]h$]h&]uh1j hjEubj )}(hhh](j )}(hhh]h)}(hold_policy_digesth]hold_policy_digest}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh]h)}(hstringh]hstring}(hj/hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj,ubah}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh]h)}(hYesh]hYes}(hjFhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjCubah}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh]h)}(h"The hash of previous active policyh]h"The hash of previous active policy}(hj]hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjZubah}(h]h ]h"]h$]h&]uh1j hjubeh}(h]h ]h"]h$]h&]uh1j hjEubj )}(hhh](j )}(hhh]h)}(hnew_active_pol_nameh]hnew_active_pol_name}(hj}hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjzubah}(h]h ]h"]h$]h&]uh1j hjwubj )}(hhh]h)}(hstringh]hstring}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j hjwubj )}(hhh]h)}(hNoh]hNo}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j hjwubj )}(hhh]h)}(h!The name of current active policyh]h!The name of current active policy}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j hjwubeh}(h]h ]h"]h$]h&]uh1j hjEubj )}(hhh](j )}(hhh]h)}(hnew_active_pol_versionh]hnew_active_pol_version}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh]h)}(hstringh]hstring}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh]h)}(hNoh]hNo}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj ubah}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh]h)}(h$The version of current active policyh]h$The version of current active policy}(hj'hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj$ubah}(h]h ]h"]h$]h&]uh1j hjubeh}(h]h ]h"]h$]h&]uh1j hjEubj )}(hhh](j )}(hhh]h)}(hnew_policy_digesth]hnew_policy_digest}(hjGhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjDubah}(h]h ]h"]h$]h&]uh1j hjAubj )}(hhh]h)}(hstringh]hstring}(hj^hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj[ubah}(h]h ]h"]h$]h&]uh1j hjAubj )}(hhh]h)}(hNoh]hNo}(hjuhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjrubah}(h]h ]h"]h$]h&]uh1j hjAubj )}(hhh]h)}(h!The hash of current active policyh]h!The hash of current active policy}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j hjAubeh}(h]h ]h"]h$]h&]uh1j hjEubj )}(hhh](j )}(hhh]h)}(hauidh]hauid}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh]h)}(hintegerh]hinteger}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh]h)}(hNoh]hNo}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh]h)}(hThe login user IDh]hThe login user ID}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j hjubeh}(h]h ]h"]h$]h&]uh1j hjEubj )}(hhh](j )}(hhh]h)}(hsesh]hses}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j hj ubj )}(hhh]h)}(hintegerh]hinteger}(hj(hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj%ubah}(h]h ]h"]h$]h&]uh1j hj ubj )}(hhh]h)}(hNoh]hNo}(hj?hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj<ubah}(h]h ]h"]h$]h&]uh1j hj ubj )}(hhh]h)}(hThe login session IDh]hThe login session ID}(hjVhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjSubah}(h]h ]h"]h$]h&]uh1j hj ubeh}(h]h ]h"]h$]h&]uh1j hjEubj )}(hhh](j )}(hhh]h)}(hlsmh]hlsm}(hjvhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjsubah}(h]h ]h"]h$]h&]uh1j hjpubj )}(hhh]h)}(hstringh]hstring}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j hjpubj )}(hhh]h)}(hNoh]hNo}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j hjpubj )}(hhh]h)}(h&The lsm name associated with the eventh]h&The lsm name associated with the event}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j hjpubeh}(h]h ]h"]h$]h&]uh1j hjEubj )}(hhh](j )}(hhh]h)}(hresh]hres}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh]h)}(hintegerh]hinteger}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh]h)}(hNoh]hNo}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh]h)}(h1The result of the audited operation(success/fail)h]h1The result of the audited operation(success/fail)}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j hjubeh}(h]h ]h"]h$]h&]uh1j hjEubeh}(h]h ]h"]h$]h&]uh1j hjubeh}(h]h ]h"]h$]h&]colsKuh1j hjubah}(h]h ]h"]h$]h&]uh1j hj.hhhhhNubeh}(h]audit-ipe-config-changeah ]h"]1421 audit_ipe_config_changeah$]h&]uh1hhj; hhhhhMubh)}(hhh](h)}(h1422 AUDIT_IPE_POLICY_LOADh]h1422 AUDIT_IPE_POLICY_LOAD}(hjXhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjUhhhhhMubh)}(hEvent Example::h]hEvent Example:}(hjfhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjUhhubjb)}(hXltype=1422 audit(1653425529.927:53): policy_name="boot_verified" policy_version=0.0.0 policy_digest=sha256:820EEA5B40CA42B51F68962354BA083122A20BB846F26765076DD8EED7B8F4DB auid=4294967295 ses=4294967295 lsm=ipe res=1 errno=0 type=1300 audit(1653425529.927:53): arch=c000003e syscall=1 success=yes exit=2567 a0=3 a1=5596fcae1fb0 a2=a07 a3=2 items=0 ppid=184 pid=229 auid=4294967295 uid=0 gid=0 euid=0 suid=0 fsuid=0 egid=0 sgid=0 fsgid=0 tty=pts0 ses=4294967295 comm="python3" exe="/usr/bin/python3.10" key=(null) type=1327 audit(1653425529.927:53): PROCTITLE proctitle=707974686F6E3300746573742F6D61696E2E7079002D66002E2Eh]hXltype=1422 audit(1653425529.927:53): policy_name="boot_verified" policy_version=0.0.0 policy_digest=sha256:820EEA5B40CA42B51F68962354BA083122A20BB846F26765076DD8EED7B8F4DB auid=4294967295 ses=4294967295 lsm=ipe res=1 errno=0 type=1300 audit(1653425529.927:53): arch=c000003e syscall=1 success=yes exit=2567 a0=3 a1=5596fcae1fb0 a2=a07 a3=2 items=0 ppid=184 pid=229 auid=4294967295 uid=0 gid=0 euid=0 suid=0 fsuid=0 egid=0 sgid=0 fsgid=0 tty=pts0 ses=4294967295 comm="python3" exe="/usr/bin/python3.10" key=(null) type=1327 audit(1653425529.927:53): PROCTITLE proctitle=707974686F6E3300746573742F6D61696E2E7079002D66002E2E}hjtsbah}(h]h ]h"]h$]h&]hhuh1jahhhMhjUhhubh)}(hxThis record indicates a new policy has been loaded into the kernel with the policy name, policy version and policy hash.h]hxThis record indicates a new policy has been loaded into the kernel with the policy name, policy version and policy hash.}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjUhhubh)}(hkThis record will always be emitted in conjunction with a ``AUDITSYSCALL`` record for the ``write`` syscall.h](h9This record will always be emitted in conjunction with a }(hjhhhNhNubjt)}(h``AUDITSYSCALL``h]h AUDITSYSCALL}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jshjubh record for the }(hjhhhNhNubjt)}(h ``write``h]hwrite}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jshjubh syscall.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjUhhubh)}(hField descriptions:h]hField descriptions:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjUhhubj )}(hhh]j )}(hhh](j )}(hhh]h}(h]h ]h"]h$]h&]colwidthKuh1j hjubj )}(hhh]h}(h]h ]h"]h$]h&]colwidthK uh1j hjubj )}(hhh]h}(h]h ]h"]h$]h&]colwidthK uh1j hjubj )}(hhh]h}(h]h ]h"]h$]h&]colwidthK=uh1j hjubj )}(hhh]j )}(hhh](j )}(hhh]h)}(hFieldh]hField}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh]h)}(h Value Typeh]h Value Type}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh]h)}(h Optional?h]h Optional?}(hj5hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj2ubah}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh]h)}(hDescription of Valueh]hDescription of Value}(hjLhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjIubah}(h]h ]h"]h$]h&]uh1j hjubeh}(h]h ]h"]h$]h&]uh1j hjubah}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh](j )}(hhh](j )}(hhh]h)}(h policy_nameh]h policy_name}(hjuhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjrubah}(h]h ]h"]h$]h&]uh1j hjoubj )}(hhh]h)}(hstringh]hstring}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j hjoubj )}(hhh]h)}(hYesh]hYes}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j hjoubj )}(hhh]h)}(hThe policy_nameh]hThe policy_name}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j hjoubeh}(h]h ]h"]h$]h&]uh1j hjlubj )}(hhh](j )}(hhh]h)}(hpolicy_versionh]hpolicy_version}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh]h)}(hstringh]hstring}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh]h)}(hYesh]hYes}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh]h)}(hThe policy_versionh]hThe policy_version}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j hjubeh}(h]h ]h"]h$]h&]uh1j hjlubj )}(hhh](j )}(hhh]h)}(h policy_digesth]h policy_digest}(hj?hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj<ubah}(h]h ]h"]h$]h&]uh1j hj9ubj )}(hhh]h)}(hstringh]hstring}(hjVhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjSubah}(h]h ]h"]h$]h&]uh1j hj9ubj )}(hhh]h)}(hYesh]hYes}(hjmhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjjubah}(h]h ]h"]h$]h&]uh1j hj9ubj )}(hhh]h)}(hThe policy hashh]hThe policy hash}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j hj9ubeh}(h]h ]h"]h$]h&]uh1j hjlubj )}(hhh](j )}(hhh]h)}(hauidh]hauid}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh]h)}(hintegerh]hinteger}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh]h)}(hNoh]hNo}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh]h)}(hThe login user IDh]hThe login user ID}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j hjubeh}(h]h ]h"]h$]h&]uh1j hjlubj )}(hhh](j )}(hhh]h)}(hsesh]hses}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh]h)}(hintegerh]hinteger}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh]h)}(hNoh]hNo}(hj7hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj4ubah}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh]h)}(hThe login session IDh]hThe login session ID}(hjNhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjKubah}(h]h ]h"]h$]h&]uh1j hjubeh}(h]h ]h"]h$]h&]uh1j hjlubj )}(hhh](j )}(hhh]h)}(hlsmh]hlsm}(hjnhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjkubah}(h]h ]h"]h$]h&]uh1j hjhubj )}(hhh]h)}(hstringh]hstring}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j hjhubj )}(hhh]h)}(hNoh]hNo}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j hjhubj )}(hhh]h)}(h&The lsm name associated with the eventh]h&The lsm name associated with the event}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j hjhubeh}(h]h ]h"]h$]h&]uh1j hjlubj )}(hhh](j )}(hhh]h)}(hresh]hres}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh]h)}(hintegerh]hinteger}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh]h)}(hNoh]hNo}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh]h)}(h1The result of the audited operation(success/fail)h]h1The result of the audited operation(success/fail)}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j hjubeh}(h]h ]h"]h$]h&]uh1j hjlubj )}(hhh](j )}(hhh]h)}(herrnoh]herrno}(hj8hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj5ubah}(h]h ]h"]h$]h&]uh1j hj2ubj )}(hhh]h)}(hintegerh]hinteger}(hjOhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjLubah}(h]h ]h"]h$]h&]uh1j hj2ubj )}(hhh]h)}(hNoh]hNo}(hjfhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjcubah}(h]h ]h"]h$]h&]uh1j hj2ubj )}(hhh]h)}(h;Error code from policy loading operations (see table below)h]h;Error code from policy loading operations (see table below)}(hj}hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjzubah}(h]h ]h"]h$]h&]uh1j hj2ubeh}(h]h ]h"]h$]h&]uh1j hjlubeh}(h]h ]h"]h$]h&]uh1j hjubeh}(h]h ]h"]h$]h&]colsKuh1j hjubah}(h]h ]h"]h$]h&]uh1j hjUhhhhhNubh)}(hPolicy error codes (errno):h]hPolicy error codes (errno):}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjUhhubh)}(hrThe following table lists the error codes that may appear in the errno field while loading or updating the policy:h]hrThe following table lists the error codes that may appear in the errno field while loading or updating the policy:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjUhhubj )}(hhh]j )}(hhh](j )}(hhh]h}(h]h ]h"]h$]h&]colwidthKuh1j hjubj )}(hhh]h}(h]h ]h"]h$]h&]colwidthK8uh1j hjubj )}(hhh]j )}(hhh](j )}(hhh]h)}(h Error Codeh]h Error Code}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh]h)}(h Descriptionh]h Description}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j hjubeh}(h]h ]h"]h$]h&]uh1j hjubah}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh](j )}(hhh](j )}(hhh]h)}(h0h]h0}(hj)hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj&ubah}(h]h ]h"]h$]h&]uh1j hj#ubj )}(hhh]h)}(hSuccessh]hSuccess}(hj@hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj=ubah}(h]h ]h"]h$]h&]uh1j hj#ubeh}(h]h ]h"]h$]h&]uh1j hj ubj )}(hhh](j )}(hhh]h)}(h-EPERMh]h-EPERM}(hj`hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj]ubah}(h]h ]h"]h$]h&]uh1j hjZubj )}(hhh]h)}(hInsufficient permissionh]hInsufficient permission}(hjwhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjtubah}(h]h ]h"]h$]h&]uh1j hjZubeh}(h]h ]h"]h$]h&]uh1j hj ubj )}(hhh](j )}(hhh]h)}(h-EEXISTh]h-EEXIST}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh]h)}(h!Same name policy already deployedh]h!Same name policy already deployed}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j hjubeh}(h]h ]h"]h$]h&]uh1j hj ubj )}(hhh](j )}(hhh]h)}(h-EBADMSGh]h-EBADMSG}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh]h)}(hPolicy is invalidh]hPolicy is invalid}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j hjubeh}(h]h ]h"]h$]h&]uh1j hj ubj )}(hhh](j )}(hhh]h)}(h-ENOMEMh]h-ENOMEM}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh]h)}(hOut of memory (OOM)h]hOut of memory (OOM)}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j hjubeh}(h]h ]h"]h$]h&]uh1j hj ubj )}(hhh](j )}(hhh]h)}(h-ERANGEh]h-ERANGE}(hj<hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj9ubah}(h]h ]h"]h$]h&]uh1j hj6ubj )}(hhh]h)}(hPolicy version number overflowh]hPolicy version number overflow}(hjShhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjPubah}(h]h ]h"]h$]h&]uh1j hj6ubeh}(h]h ]h"]h$]h&]uh1j hj ubj )}(hhh](j )}(hhh]h)}(h-EINVALh]h-EINVAL}(hjshhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjpubah}(h]h ]h"]h$]h&]uh1j hjmubj )}(hhh]h)}(hPolicy version parsing errorh]hPolicy version parsing error}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j hjmubeh}(h]h ]h"]h$]h&]uh1j hj ubj )}(hhh](j )}(hhh]h)}(h-ENOKEYh]h-ENOKEY}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh]h)}(h4Key used to sign the IPE policy not found in keyringh]h4Key used to sign the IPE policy not found in keyring}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j hjubeh}(h]h ]h"]h$]h&]uh1j hj ubj )}(hhh](j )}(hhh]h)}(h -EKEYREJECTEDh]h -EKEYREJECTED}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh]h)}(h$Policy signature verification failedh]h$Policy signature verification failed}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j hjubeh}(h]h ]h"]h$]h&]uh1j hj ubj )}(hhh](j )}(hhh]h)}(h-ESTALEh]h-ESTALE}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh]h)}(h5Attempting to update an IPE policy with older versionh]h5Attempting to update an IPE policy with older version}(hj/hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj,ubah}(h]h ]h"]h$]h&]uh1j hjubeh}(h]h ]h"]h$]h&]uh1j hj ubj )}(hhh](j )}(hhh]h)}(h-ENOENTh]h-ENOENT}(hjOhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjLubah}(h]h ]h"]h$]h&]uh1j hjIubj )}(hhh]h)}(h!Policy was deleted while updatingh]h!Policy was deleted while updating}(hjfhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjcubah}(h]h ]h"]h$]h&]uh1j hjIubeh}(h]h ]h"]h$]h&]uh1j hj ubeh}(h]h ]h"]h$]h&]uh1j hjubeh}(h]h ]h"]h$]h&]colsKuh1j hjubah}(h]h ]h"]h$]h&]uh1j hjUhhhhhNubeh}(h]audit-ipe-policy-loadah ]h"]1422 audit_ipe_policy_loadah$]h&]uh1hhj; hhhhhMubh)}(hhh](h)}(h1404 AUDIT_MAC_STATUSh]h1404 AUDIT_MAC_STATUS}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhMubh)}(hEvent Examples::h]hEvent Examples:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubjb)}(hXtype=1404 audit(1653425689.008:55): enforcing=0 old_enforcing=1 auid=4294967295 ses=4294967295 enabled=1 old-enabled=1 lsm=ipe res=1 type=1300 audit(1653425689.008:55): arch=c000003e syscall=1 success=yes exit=2 a0=1 a1=55c1065e5c60 a2=2 a3=0 items=0 ppid=405 pid=441 auid=0 uid=0 gid=0 euid=0 suid=0 fsuid=0 egid=0 sgid=) type=1327 audit(1653425689.008:55): proctitle="-bash" type=1404 audit(1653425689.008:55): enforcing=1 old_enforcing=0 auid=4294967295 ses=4294967295 enabled=1 old-enabled=1 lsm=ipe res=1 type=1300 audit(1653425689.008:55): arch=c000003e syscall=1 success=yes exit=2 a0=1 a1=55c1065e5c60 a2=2 a3=0 items=0 ppid=405 pid=441 auid=0 uid=0 gid=0 euid=0 suid=0 fsuid=0 egid=0 sgid=) type=1327 audit(1653425689.008:55): proctitle="-bash"h]hXtype=1404 audit(1653425689.008:55): enforcing=0 old_enforcing=1 auid=4294967295 ses=4294967295 enabled=1 old-enabled=1 lsm=ipe res=1 type=1300 audit(1653425689.008:55): arch=c000003e syscall=1 success=yes exit=2 a0=1 a1=55c1065e5c60 a2=2 a3=0 items=0 ppid=405 pid=441 auid=0 uid=0 gid=0 euid=0 suid=0 fsuid=0 egid=0 sgid=) type=1327 audit(1653425689.008:55): proctitle="-bash" type=1404 audit(1653425689.008:55): enforcing=1 old_enforcing=0 auid=4294967295 ses=4294967295 enabled=1 old-enabled=1 lsm=ipe res=1 type=1300 audit(1653425689.008:55): arch=c000003e syscall=1 success=yes exit=2 a0=1 a1=55c1065e5c60 a2=2 a3=0 items=0 ppid=405 pid=441 auid=0 uid=0 gid=0 euid=0 suid=0 fsuid=0 egid=0 sgid=) type=1327 audit(1653425689.008:55): proctitle="-bash"}hjsbah}(h]h ]h"]h$]h&]hhuh1jahhhMhjhhubh)}(hkThis record will always be emitted in conjunction with a ``AUDITSYSCALL`` record for the ``write`` syscall.h](h9This record will always be emitted in conjunction with a }(hjhhhNhNubjt)}(h``AUDITSYSCALL``h]h AUDITSYSCALL}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jshjubh record for the }(hjhhhNhNubjt)}(h ``write``h]hwrite}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1jshjubh syscall.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjhhubh)}(hField descriptions:h]hField descriptions:}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjhhubj )}(hhh]j )}(hhh](j )}(hhh]h}(h]h ]h"]h$]h&]colwidthKuh1j hj ubj )}(hhh]h}(h]h ]h"]h$]h&]colwidthK uh1j hj ubj )}(hhh]h}(h]h ]h"]h$]h&]colwidthK uh1j hj ubj )}(hhh]h}(h]h ]h"]h$]h&]colwidthKauh1j hj ubj )}(hhh]j )}(hhh](j )}(hhh]h)}(hFieldh]hField}(hj?hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj<ubah}(h]h ]h"]h$]h&]uh1j hj9ubj )}(hhh]h)}(h Value Typeh]h Value Type}(hjVhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjSubah}(h]h ]h"]h$]h&]uh1j hj9ubj )}(hhh]h)}(h Optional?h]h Optional?}(hjmhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjjubah}(h]h ]h"]h$]h&]uh1j hj9ubj )}(hhh]h)}(hDescription of Valueh]hDescription of Value}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j hj9ubeh}(h]h ]h"]h$]h&]uh1j hj6ubah}(h]h ]h"]h$]h&]uh1j hj ubj )}(hhh](j )}(hhh](j )}(hhh]h)}(h enforcingh]h enforcing}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh]h)}(hintegerh]hinteger}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh]h)}(hNoh]hNo}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh]h)}(h]The enforcing state IPE is being switched to, 1 is in enforcing mode, 0 is in permissive modeh]h]The enforcing state IPE is being switched to, 1 is in enforcing mode, 0 is in permissive mode}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j hjubeh}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh](j )}(hhh]h)}(h old_enforcingh]h old_enforcing}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM hjubah}(h]h ]h"]h$]h&]uh1j hj ubj )}(hhh]h)}(hintegerh]hinteger}(hj)hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM hj&ubah}(h]h ]h"]h$]h&]uh1j hj ubj )}(hhh]h)}(hNoh]hNo}(hj@hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM hj=ubah}(h]h ]h"]h$]h&]uh1j hj ubj )}(hhh]h)}(h_The enforcing state IPE is being switched from, 1 is in enforcing mode, 0 is in permissive modeh]h_The enforcing state IPE is being switched from, 1 is in enforcing mode, 0 is in permissive mode}(hjWhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM hjTubah}(h]h ]h"]h$]h&]uh1j hj ubeh}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh](j )}(hhh]h)}(hauidh]hauid}(hjwhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM hjtubah}(h]h ]h"]h$]h&]uh1j hjqubj )}(hhh]h)}(hintegerh]hinteger}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM hjubah}(h]h ]h"]h$]h&]uh1j hjqubj )}(hhh]h)}(hNoh]hNo}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM hjubah}(h]h ]h"]h$]h&]uh1j hjqubj )}(hhh]h)}(hThe login user IDh]hThe login user ID}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM hjubah}(h]h ]h"]h$]h&]uh1j hjqubeh}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh](j )}(hhh]h)}(hsesh]hses}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM hjubah}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh]h)}(hintegerh]hinteger}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM hjubah}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh]h)}(hNoh]hNo}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM hjubah}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh]h)}(hThe login session IDh]hThe login session ID}(hj!hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM hjubah}(h]h ]h"]h$]h&]uh1j hjubeh}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh](j )}(hhh]h)}(henabledh]henabled}(hjAhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj>ubah}(h]h ]h"]h$]h&]uh1j hj;ubj )}(hhh]h)}(hintegerh]hinteger}(hjXhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjUubah}(h]h ]h"]h$]h&]uh1j hj;ubj )}(hhh]h)}(hNoh]hNo}(hjohhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjlubah}(h]h ]h"]h$]h&]uh1j hj;ubj )}(hhh]h)}(h!The new TTY audit enabled settingh]h!The new TTY audit enabled setting}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j hj;ubeh}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh](j )}(hhh]h)}(h old-enabledh]h old-enabled}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh]h)}(hintegerh]hinteger}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh]h)}(hNoh]hNo}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh]h)}(h!The old TTY audit enabled settingh]h!The old TTY audit enabled setting}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j hjubeh}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh](j )}(hhh]h)}(hlsmh]hlsm}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh]h)}(hstringh]hstring}(hj"hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh]h)}(hNoh]hNo}(hj9hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj6ubah}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh]h)}(h&The lsm name associated with the eventh]h&The lsm name associated with the event}(hjPhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjMubah}(h]h ]h"]h$]h&]uh1j hjubeh}(h]h ]h"]h$]h&]uh1j hjubj )}(hhh](j )}(hhh]h)}(hresh]hres}(hjphhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjmubah}(h]h ]h"]h$]h&]uh1j hjjubj )}(hhh]h)}(hintegerh]hinteger}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j hjjubj )}(hhh]h)}(hNoh]hNo}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j hjjubj )}(hhh]h)}(h1The result of the audited operation(success/fail)h]h1The result of the audited operation(success/fail)}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjubah}(h]h ]h"]h$]h&]uh1j hjjubeh}(h]h ]h"]h$]h&]uh1j hjubeh}(h]h ]h"]h$]h&]uh1j hj ubeh}(h]h ]h"]h$]h&]colsKuh1j hjubah}(h]h ]h"]h$]h&]uh1j hjhhhhhNubeh}(h]audit-mac-statusah ]h"]1404 audit_mac_statusah$]h&]uh1hhj; hhhhhMubh)}(hhh](h)}(hSuccess Auditingh]hSuccess Auditing}(hjhhhNhNubah}(h]h ]h"]h$]h&]uh1hhjhhhhhMubh)}(hX!IPE supports success auditing. When enabled, all events that pass IPE policy and are not blocked will emit an audit event. This is disabled by default, and can be enabled via the kernel command line ``ipe.success_audit=(0|1)`` or ``/sys/kernel/security/ipe/success_audit`` securityfs file.h](hIPE supports success auditing. When enabled, all events that pass IPE policy and are not blocked will emit an audit event. This is disabled by default, and can be enabled via the kernel command line }(hjhhhNhNubjt)}(h``ipe.success_audit=(0|1)``h]hipe.success_audit=(0|1)}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jshjubh or }(hjhhhNhNubjt)}(h*``/sys/kernel/security/ipe/success_audit``h]h&/sys/kernel/security/ipe/success_audit}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jshjubh securityfs file.}(hjhhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjhhubh)}(hsThis is *very* noisy, as IPE will check every userspace binary on the system, but is useful for debugging policies.h](hThis is }(hj- hhhNhNubj)}(h*very*h]hvery}(hj5 hhhNhNubah}(h]h ]h"]h$]h&]uh1jhj- ubhe noisy, as IPE will check every userspace binary on the system, but is useful for debugging policies.}(hj- hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhM"hjhhubh)}(hIf a traditional MAC system is enabled (SELinux, apparmor, smack, etcetera), all writes to ipe's securityfs nodes require ``CAP_MAC_ADMIN``.h]h)}(hIf a traditional MAC system is enabled (SELinux, apparmor, smack, etcetera), all writes to ipe's securityfs nodes require ``CAP_MAC_ADMIN``.h](h|If a traditional MAC system is enabled (SELinux, apparmor, smack, etcetera), all writes to ipe’s securityfs nodes require }(hjQ hhhNhNubjt)}(h``CAP_MAC_ADMIN``h]h CAP_MAC_ADMIN}(hjY hhhNhNubah}(h]h ]h"]h$]h&]uh1jshjQ ubh.}(hjQ hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhM'hjM ubah}(h]h ]h"]h$]h&]uh1hhjhhhhhNubeh}(h]success-auditingah ]h"]success auditingah$]h&]uh1hhj; hhhhhMubeh}(h] audit-eventsah ]h"] audit eventsah$]h&]uh1hhj.hhhhhMXubeh}(h]policyah ]h"]policyah$]h&]uh1hhhhhhhhKubh)}(hhh](h)}(h Propertiesh]h Properties}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj hhhhhM+ubh)}(hXAs explained above, IPE properties are ``key=value`` pairs expressed in IPE policy. Two properties are built-into the policy parser: 'op' and 'action'. The other properties are used to restrict immutable security properties about the files being evaluated. Currently those properties are: '``boot_verified``', '``dmverity_signature``', '``dmverity_roothash``', '``fsverity_signature``', '``fsverity_digest``'. A description of all properties supported by IPE are listed below:h](h'As explained above, IPE properties are }(hj hhhNhNubjt)}(h ``key=value``h]h key=value}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj ubh pairs expressed in IPE policy. Two properties are built-into the policy parser: ‘op’ and ‘action’. The other properties are used to restrict immutable security properties about the files being evaluated. Currently those properties are: ‘}(hj hhhNhNubjt)}(h``boot_verified``h]h boot_verified}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj ubh’, ‘}(hj hhhNhNubjt)}(h``dmverity_signature``h]hdmverity_signature}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj ubh’, ‘}(hj hhhNhNubjt)}(h``dmverity_roothash``h]hdmverity_roothash}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj ubh’, ‘}(hj hhhNhNubjt)}(h``fsverity_signature``h]hfsverity_signature}(hj hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj ubh’, ‘}(hj hhhNhNubjt)}(h``fsverity_digest``h]hfsverity_digest}(hj!hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj ubhG’. A description of all properties supported by IPE are listed below:}(hj hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhM-hj hhubh)}(hhh](h)}(hoph]hop}(hj!hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj!hhhhhM6ubh)}(hIndicates the operation for a rule to apply to. Must be in every rule, as the first token. IPE supports the following operations:h]hIndicates the operation for a rule to apply to. Must be in every rule, as the first token. IPE supports the following operations:}(hj+!hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM8hj!hhubh block_quote)}(hXE``EXECUTE`` Pertains to any file attempting to be executed, or loaded as an executable. ``FIRMWARE``: Pertains to firmware being loaded via the firmware_class interface. This covers both the preallocated buffer and the firmware file itself. ``KMODULE``: Pertains to loading kernel modules via ``modprobe`` or ``insmod``. ``KEXEC_IMAGE``: Pertains to kernel images loading via ``kexec``. ``KEXEC_INITRAMFS`` Pertains to initrd images loading via ``kexec --initrd``. ``POLICY``: Controls loading policies via reading a kernel-space initiated read. An example of such is loading IMA policies by writing the path to the policy file to ``$securityfs/ima/policy`` ``X509_CERT``: Controls loading IMA certificates through the Kconfigs, ``CONFIG_IMA_X509_PATH`` and ``CONFIG_EVM_X509_PATH``. h](h)}(h ``EXECUTE``h]jt)}(hjA!h]hEXECUTE}(hjC!hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj?!ubah}(h]h ]h"]h$]h&]uh1hhhhM;hj;!ubj:!)}(hLPertains to any file attempting to be executed, or loaded as an executable. h]h)}(hKPertains to any file attempting to be executed, or loaded as an executable.h]hKPertains to any file attempting to be executed, or loaded as an executable.}(hjZ!hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM=hjV!ubah}(h]h ]h"]h$]h&]uh1j9!hhhM=hj;!ubh)}(h ``FIRMWARE``:h](jt)}(h ``FIRMWARE``h]hFIRMWARE}(hjr!hhhNhNubah}(h]h ]h"]h$]h&]uh1jshjn!ubh:}(hjn!hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhM@hj;!ubj:!)}(hPertains to firmware being loaded via the firmware_class interface. This covers both the preallocated buffer and the firmware file itself. h]h)}(hPertains to firmware being loaded via the firmware_class interface. This covers both the preallocated buffer and the firmware file itself.h]hPertains to firmware being loaded via the firmware_class interface. This covers both the preallocated buffer and the firmware file itself.}(hj!hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMBhj!ubah}(h]h ]h"]h$]h&]uh1j9!hhhMBhj;!ubh)}(h ``KMODULE``:h](jt)}(h ``KMODULE``h]hKMODULE}(hj!hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj!ubh:}(hj!hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMFhj;!ubj:!)}(hCPertains to loading kernel modules via ``modprobe`` or ``insmod``. h]h)}(hBPertains to loading kernel modules via ``modprobe`` or ``insmod``.h](h'Pertains to loading kernel modules via }(hj!hhhNhNubjt)}(h ``modprobe``h]hmodprobe}(hj!hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj!ubh or }(hj!hhhNhNubjt)}(h ``insmod``h]hinsmod}(hj!hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj!ubh.}(hj!hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMHhj!ubah}(h]h ]h"]h$]h&]uh1j9!hhhMHhj;!ubh)}(h``KEXEC_IMAGE``:h](jt)}(h``KEXEC_IMAGE``h]h KEXEC_IMAGE}(hj!hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj!ubh:}(hj!hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMJhj;!ubj:!)}(h1Pertains to kernel images loading via ``kexec``. h]h)}(h0Pertains to kernel images loading via ``kexec``.h](h&Pertains to kernel images loading via }(hj"hhhNhNubjt)}(h ``kexec``h]hkexec}(hj""hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj"ubh.}(hj"hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMLhj"ubah}(h]h ]h"]h$]h&]uh1j9!hhhMLhj;!ubh)}(h``KEXEC_INITRAMFS``h]jt)}(hjB"h]hKEXEC_INITRAMFS}(hjD"hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj@"ubah}(h]h ]h"]h$]h&]uh1hhhhMNhj;!ubj:!)}(h:Pertains to initrd images loading via ``kexec --initrd``. h]h)}(h9Pertains to initrd images loading via ``kexec --initrd``.h](h&Pertains to initrd images loading via }(hj["hhhNhNubjt)}(h``kexec --initrd``h]hkexec --initrd}(hjc"hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj["ubh.}(hj["hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMPhjW"ubah}(h]h ]h"]h$]h&]uh1j9!hhhMPhj;!ubh)}(h ``POLICY``:h](jt)}(h ``POLICY``h]hPOLICY}(hj"hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj"ubh:}(hj"hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMRhj;!ubj:!)}(hControls loading policies via reading a kernel-space initiated read. An example of such is loading IMA policies by writing the path to the policy file to ``$securityfs/ima/policy`` h](h)}(hDControls loading policies via reading a kernel-space initiated read.h]hDControls loading policies via reading a kernel-space initiated read.}(hj"hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMThj"ubh)}(hoAn example of such is loading IMA policies by writing the path to the policy file to ``$securityfs/ima/policy``h](hUAn example of such is loading IMA policies by writing the path to the policy file to }(hj"hhhNhNubjt)}(h``$securityfs/ima/policy``h]h$securityfs/ima/policy}(hj"hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj"ubeh}(h]h ]h"]h$]h&]uh1hhhhMVhj"ubeh}(h]h ]h"]h$]h&]uh1j9!hhhMThj;!ubh)}(h``X509_CERT``:h](jt)}(h ``X509_CERT``h]h X509_CERT}(hj"hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj"ubh:}(hj"hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMYhj;!ubj:!)}(hoControls loading IMA certificates through the Kconfigs, ``CONFIG_IMA_X509_PATH`` and ``CONFIG_EVM_X509_PATH``. h]h)}(hnControls loading IMA certificates through the Kconfigs, ``CONFIG_IMA_X509_PATH`` and ``CONFIG_EVM_X509_PATH``.h](h8Controls loading IMA certificates through the Kconfigs, }(hj"hhhNhNubjt)}(h``CONFIG_IMA_X509_PATH``h]hCONFIG_IMA_X509_PATH}(hj"hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj"ubh and }(hj"hhhNhNubjt)}(h``CONFIG_EVM_X509_PATH``h]hCONFIG_EVM_X509_PATH}(hj #hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj"ubh.}(hj"hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhM[hj"ubah}(h]h ]h"]h$]h&]uh1j9!hhhM[hj;!ubeh}(h]h ]h"]h$]h&]uh1j9!hhhM;hj!hhubeh}(h]opah ]h"]opah$]h&]uh1hhj hhhhhM6ubh)}(hhh](h)}(hactionh]haction}(hj:#hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj7#hhhhhM_ubj:!)}(hXjDetermines what IPE should do when a rule matches. Must be in every rule, as the final clause. Can be one of: ``ALLOW``: If the rule matches, explicitly allow access to the resource to proceed without executing any more rules. ``DENY``: If the rule matches, explicitly prohibit access to the resource to proceed without executing any more rules. h](h)}(hmDetermines what IPE should do when a rule matches. Must be in every rule, as the final clause. Can be one of:h]hmDetermines what IPE should do when a rule matches. Must be in every rule, as the final clause. Can be one of:}(hjL#hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMahjH#ubh)}(h ``ALLOW``:h](jt)}(h ``ALLOW``h]hALLOW}(hj^#hhhNhNubah}(h]h ]h"]h$]h&]uh1jshjZ#ubh:}(hjZ#hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMdhjH#ubj:!)}(hjIf the rule matches, explicitly allow access to the resource to proceed without executing any more rules. h]h)}(hiIf the rule matches, explicitly allow access to the resource to proceed without executing any more rules.h]hiIf the rule matches, explicitly allow access to the resource to proceed without executing any more rules.}(hjz#hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMfhjv#ubah}(h]h ]h"]h$]h&]uh1j9!hhhMfhjH#ubh)}(h ``DENY``:h](jt)}(h``DENY``h]hDENY}(hj#hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj#ubh:}(hj#hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMihjH#ubj:!)}(hmIf the rule matches, explicitly prohibit access to the resource to proceed without executing any more rules. h]h)}(hlIf the rule matches, explicitly prohibit access to the resource to proceed without executing any more rules.h]hlIf the rule matches, explicitly prohibit access to the resource to proceed without executing any more rules.}(hj#hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMkhj#ubah}(h]h ]h"]h$]h&]uh1j9!hhhMkhjH#ubeh}(h]h ]h"]h$]h&]uh1j9!hhhMahj7#hhubeh}(h]actionah ]h"]actionah$]h&]uh1hhj hhhhhM_ubh)}(hhh](h)}(h boot_verifiedh]h boot_verified}(hj#hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj#hhhhhMoubj:!)}(hXThis property can be utilized for authorization of files from initramfs. The format of this property is:: boot_verified=(TRUE|FALSE) .. WARNING:: This property will trust files from initramfs(rootfs). It should only be used during early booting stage. Before mounting the real rootfs on top of the initramfs, initramfs script will recursively remove all files and directories on the initramfs. This is typically implemented by using switch_root(8) [#switch_root]_. Therefore the initramfs will be empty and not accessible after the real rootfs takes over. It is advised to switch to a different policy that doesn't rely on the property after this point. This ensures that the trust policies remain relevant and effective throughout the system's operation. h](h)}(hiThis property can be utilized for authorization of files from initramfs. The format of this property is::h]hhThis property can be utilized for authorization of files from initramfs. The format of this property is:}(hj#hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMqhj#ubjb)}(hboot_verified=(TRUE|FALSE)h]hboot_verified=(TRUE|FALSE)}hj#sbah}(h]h ]h"]h$]h&]hhuh1jahhhMthj#ubhwarning)}(hXaThis property will trust files from initramfs(rootfs). It should only be used during early booting stage. Before mounting the real rootfs on top of the initramfs, initramfs script will recursively remove all files and directories on the initramfs. This is typically implemented by using switch_root(8) [#switch_root]_. Therefore the initramfs will be empty and not accessible after the real rootfs takes over. It is advised to switch to a different policy that doesn't rely on the property after this point. This ensures that the trust policies remain relevant and effective throughout the system's operation.h]h)}(hXaThis property will trust files from initramfs(rootfs). It should only be used during early booting stage. Before mounting the real rootfs on top of the initramfs, initramfs script will recursively remove all files and directories on the initramfs. This is typically implemented by using switch_root(8) [#switch_root]_. Therefore the initramfs will be empty and not accessible after the real rootfs takes over. It is advised to switch to a different policy that doesn't rely on the property after this point. This ensures that the trust policies remain relevant and effective throughout the system's operation.h](hX.This property will trust files from initramfs(rootfs). It should only be used during early booting stage. Before mounting the real rootfs on top of the initramfs, initramfs script will recursively remove all files and directories on the initramfs. This is typically implemented by using switch_root(8) }(hj$hhhNhNubj)}(h[#switch_root]_h]h3}(hj$hhhNhNubah}(h]id3ah ]h"]h$]h&]jKj switch-rootjj uh1jhj$jKubhX(. Therefore the initramfs will be empty and not accessible after the real rootfs takes over. It is advised to switch to a different policy that doesn’t rely on the property after this point. This ensures that the trust policies remain relevant and effective throughout the system’s operation.}(hj$hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMyhj$ubah}(h]h ]h"]h$]h&]uh1j$hj#ubeh}(h]h ]h"]h$]h&]uh1j9!hhhMqhj#hhubeh}(h] boot-verifiedah ]h"] boot_verifiedah$]h&]uh1hhj hhhhhMoubh)}(hhh](h)}(hdmverity_roothashh]hdmverity_roothash}(hj@$hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj=$hhhhhMubj:!)}(hXThis property can be utilized for authorization or revocation of specific dm-verity volumes, identified via their root hashes. It has a dependency on the DM_VERITY module. This property is controlled by the ``IPE_PROP_DM_VERITY`` config option, it will be automatically selected when ``SECURITY_IPE`` and ``DM_VERITY`` are all enabled. The format of this property is:: dmverity_roothash=DigestName:HexadecimalString The supported DigestNames for dmverity_roothash are [#dmveritydigests]_ + blake2b-512 + blake2s-256 + sha256 + sha384 + sha512 + sha3-224 + sha3-256 + sha3-384 + sha3-512 + sm3 + rmd160 h](h)}(hXpThis property can be utilized for authorization or revocation of specific dm-verity volumes, identified via their root hashes. It has a dependency on the DM_VERITY module. This property is controlled by the ``IPE_PROP_DM_VERITY`` config option, it will be automatically selected when ``SECURITY_IPE`` and ``DM_VERITY`` are all enabled. The format of this property is::h](hThis property can be utilized for authorization or revocation of specific dm-verity volumes, identified via their root hashes. It has a dependency on the DM_VERITY module. This property is controlled by the }(hjR$hhhNhNubjt)}(h``IPE_PROP_DM_VERITY``h]hIPE_PROP_DM_VERITY}(hjZ$hhhNhNubah}(h]h ]h"]h$]h&]uh1jshjR$ubh7 config option, it will be automatically selected when }(hjR$hhhNhNubjt)}(h``SECURITY_IPE``h]h SECURITY_IPE}(hjl$hhhNhNubah}(h]h ]h"]h$]h&]uh1jshjR$ubh and }(hjR$hhhNhNubjt)}(h ``DM_VERITY``h]h DM_VERITY}(hj~$hhhNhNubah}(h]h ]h"]h$]h&]uh1jshjR$ubh1 are all enabled. The format of this property is:}(hjR$hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjN$ubjb)}(h.dmverity_roothash=DigestName:HexadecimalStringh]h.dmverity_roothash=DigestName:HexadecimalString}hj$sbah}(h]h ]h"]h$]h&]hhuh1jahhhMhjN$ubh)}(hGThe supported DigestNames for dmverity_roothash are [#dmveritydigests]_h](h4The supported DigestNames for dmverity_roothash are }(hj$hhhNhNubj)}(h[#dmveritydigests]_h]h4}(hj$hhhNhNubah}(h]id4ah ]h"]h$]h&]jKjdmveritydigestsjj uh1jhj$jKubeh}(h]h ]h"]h$]h&]uh1hhhhMhjN$ubj:!)}(hr+ blake2b-512 + blake2s-256 + sha256 + sha384 + sha512 + sha3-224 + sha3-256 + sha3-384 + sha3-512 + sm3 + rmd160 h]jh)}(hhh](jm)}(h blake2b-512h]h)}(hj$h]h blake2b-512}(hj$hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj$ubah}(h]h ]h"]h$]h&]uh1jlhj$ubjm)}(h blake2s-256h]h)}(hj$h]h blake2s-256}(hj$hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj$ubah}(h]h ]h"]h$]h&]uh1jlhj$ubjm)}(hsha256h]h)}(hj$h]hsha256}(hj$hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj$ubah}(h]h ]h"]h$]h&]uh1jlhj$ubjm)}(hsha384h]h)}(hj%h]hsha384}(hj%hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj%ubah}(h]h ]h"]h$]h&]uh1jlhj$ubjm)}(hsha512h]h)}(hj'%h]hsha512}(hj)%hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj%%ubah}(h]h ]h"]h$]h&]uh1jlhj$ubjm)}(hsha3-224h]h)}(hj>%h]hsha3-224}(hj@%hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj<%ubah}(h]h ]h"]h$]h&]uh1jlhj$ubjm)}(hsha3-256h]h)}(hjU%h]hsha3-256}(hjW%hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjS%ubah}(h]h ]h"]h$]h&]uh1jlhj$ubjm)}(hsha3-384h]h)}(hjl%h]hsha3-384}(hjn%hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhjj%ubah}(h]h ]h"]h$]h&]uh1jlhj$ubjm)}(hsha3-512h]h)}(hj%h]hsha3-512}(hj%hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj%ubah}(h]h ]h"]h$]h&]uh1jlhj$ubjm)}(hsm3h]h)}(hj%h]hsm3}(hj%hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj%ubah}(h]h ]h"]h$]h&]uh1jlhj$ubjm)}(hrmd160 h]h)}(hrmd160h]hrmd160}(hj%hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj%ubah}(h]h ]h"]h$]h&]uh1jlhj$ubeh}(h]h ]h"]h$]h&]j+uh1jghhhMhj$ubah}(h]h ]h"]h$]h&]uh1j9!hhhMhjN$ubeh}(h]h ]h"]h$]h&]uh1j9!hhhMhj=$hhubeh}(h]dmverity-roothashah ]h"]dmverity_roothashah$]h&]uh1hhj hhhhhMubh)}(hhh](h)}(hdmverity_signatureh]hdmverity_signature}(hj%hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj%hhhhhMubj:!)}(hX0This property can be utilized for authorization of all dm-verity volumes that have a signed roothash that validated by a keyring specified by dm-verity's configuration, either the system trusted keyring, or the secondary keyring. It depends on ``DM_VERITY_VERIFY_ROOTHASH_SIG`` config option and is controlled by the ``IPE_PROP_DM_VERITY_SIGNATURE`` config option, it will be automatically selected when ``SECURITY_IPE``, ``DM_VERITY`` and ``DM_VERITY_VERIFY_ROOTHASH_SIG`` are all enabled. The format of this property is:: dmverity_signature=(TRUE|FALSE) h](h)}(hX This property can be utilized for authorization of all dm-verity volumes that have a signed roothash that validated by a keyring specified by dm-verity's configuration, either the system trusted keyring, or the secondary keyring. It depends on ``DM_VERITY_VERIFY_ROOTHASH_SIG`` config option and is controlled by the ``IPE_PROP_DM_VERITY_SIGNATURE`` config option, it will be automatically selected when ``SECURITY_IPE``, ``DM_VERITY`` and ``DM_VERITY_VERIFY_ROOTHASH_SIG`` are all enabled. The format of this property is::h](hThis property can be utilized for authorization of all dm-verity volumes that have a signed roothash that validated by a keyring specified by dm-verity’s configuration, either the system trusted keyring, or the secondary keyring. It depends on Dc}(hj%hhhNhNubjt)}(h!``DM_VERITY_VERIFY_ROOTHASH_SIG``h]hDM_VERITY_VERIFY_ROOTHASH_SIG}(hj%hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj%ubh( config option and is controlled by the }(hj%hhhNhNubjt)}(h ``IPE_PROP_DM_VERITY_SIGNATURE``h]hIPE_PROP_DM_VERITY_SIGNATURE}(hj&hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj%ubh7 config option, it will be automatically selected when }(hj%hhhNhNubjt)}(h``SECURITY_IPE``h]h SECURITY_IPE}(hj#&hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj%ubh, }(hj%hhhNhNubjt)}(h ``DM_VERITY``h]h DM_VERITY}(hj5&hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj%ubh and }(hj%hhhNhNubjt)}(h!``DM_VERITY_VERIFY_ROOTHASH_SIG``h]hDM_VERITY_VERIFY_ROOTHASH_SIG}(hjG&hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj%ubh1 are all enabled. The format of this property is:}(hj%hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhj%ubjb)}(hdmverity_signature=(TRUE|FALSE)h]hdmverity_signature=(TRUE|FALSE)}hj_&sbah}(h]h ]h"]h$]h&]hhuh1jahhhMhj%ubeh}(h]h ]h"]h$]h&]uh1j9!hhhMhj%hhubeh}(h]dmverity-signatureah ]h"]dmverity_signatureah$]h&]uh1hhj hhhhhMubh)}(hhh](h)}(hfsverity_digesth]hfsverity_digest}(hj~&hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj{&hhhhhMubj:!)}(hXThis property can be utilized for authorization of specific fsverity enabled files, identified via their fsverity digests. It depends on ``FS_VERITY`` config option and is controlled by the ``IPE_PROP_FS_VERITY`` config option, it will be automatically selected when ``SECURITY_IPE`` and ``FS_VERITY`` are all enabled. The format of this property is:: fsverity_digest=DigestName:HexadecimalString The supported DigestNames for fsverity_digest are [#fsveritydigest]_ + sha256 + sha512 h](h)}(hX_This property can be utilized for authorization of specific fsverity enabled files, identified via their fsverity digests. It depends on ``FS_VERITY`` config option and is controlled by the ``IPE_PROP_FS_VERITY`` config option, it will be automatically selected when ``SECURITY_IPE`` and ``FS_VERITY`` are all enabled. The format of this property is::h](hThis property can be utilized for authorization of specific fsverity enabled files, identified via their fsverity digests. It depends on }(hj&hhhNhNubjt)}(h ``FS_VERITY``h]h FS_VERITY}(hj&hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj&ubh( config option and is controlled by the }(hj&hhhNhNubjt)}(h``IPE_PROP_FS_VERITY``h]hIPE_PROP_FS_VERITY}(hj&hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj&ubh7 config option, it will be automatically selected when }(hj&hhhNhNubjt)}(h``SECURITY_IPE``h]h SECURITY_IPE}(hj&hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj&ubh and }(hj&hhhNhNubjt)}(h ``FS_VERITY``h]h FS_VERITY}(hj&hhhNhNubah}(h]h ]h"]h$]h&]uh1jshj&ubh1 are all enabled. The format of this property is:}(hj&hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhj&ubjb)}(h,fsverity_digest=DigestName:HexadecimalStringh]h,fsverity_digest=DigestName:HexadecimalString}hj&sbah}(h]h ]h"]h$]h&]hhuh1jahhhMhj&ubh)}(hDThe supported DigestNames for fsverity_digest are [#fsveritydigest]_h](h2The supported DigestNames for fsverity_digest are }(hj&hhhNhNubj)}(h[#fsveritydigest]_h]h5}(hj&hhhNhNubah}(h]id5ah ]h"]h$]h&]jKjfsveritydigestjj uh1jhj&jKubeh}(h]h ]h"]h$]h&]uh1hhhhMhj&ubj:!)}(h+ sha256 + sha512 h]jh)}(hhh](jm)}(hsha256h]h)}(hj'h]hsha256}(hj'hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj'ubah}(h]h ]h"]h$]h&]uh1jlhj'ubjm)}(hsha512 h]h)}(hsha512h]hsha512}(hj4'hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhMhj0'ubah}(h]h ]h"]h$]h&]uh1jlhj'ubeh}(h]h ]h"]h$]h&]jj%uh1jghhhMhj'ubah}(h]h ]h"]h$]h&]uh1j9!hhhMhj&ubeh}(h]h ]h"]h$]h&]uh1j9!hhhMhj{&hhubeh}(h]fsverity-digestah ]h"]fsverity_digestah$]h&]uh1hhj hhhhhMubh)}(hhh](h)}(hfsverity_signatureh]hfsverity_signature}(hje'hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjb'hhhhhMubj:!)}(hXThis property is used to authorize all fs-verity enabled files that have been verified by fs-verity's built-in signature mechanism. The signature verification relies on a key stored within the ".fs-verity" keyring. It depends on ``FS_VERITY_BUILTIN_SIGNATURES`` config option and it is controlled by the ``IPE_PROP_FS_VERITY`` config option, it will be automatically selected when ``SECURITY_IPE``, ``FS_VERITY`` and ``FS_VERITY_BUILTIN_SIGNATURES`` are all enabled. The format of this property is:: fsverity_signature=(TRUE|FALSE) h](h)}(hXThis property is used to authorize all fs-verity enabled files that have been verified by fs-verity's built-in signature mechanism. The signature verification relies on a key stored within the ".fs-verity" keyring. It depends on ``FS_VERITY_BUILTIN_SIGNATURES`` config option and it is controlled by the ``IPE_PROP_FS_VERITY`` config option, it will be automatically selected when ``SECURITY_IPE``, ``FS_VERITY`` and ``FS_VERITY_BUILTIN_SIGNATURES`` are all enabled. The format of this property is::h](hThis property is used to authorize all fs-verity enabled files that have been verified by fs-verity’s built-in signature mechanism. The signature verification relies on a key stored within the “.fs-verity” keyring. It depends on }(hjw'hhhNhNubjt)}(h ``FS_VERITY_BUILTIN_SIGNATURES``h]hFS_VERITY_BUILTIN_SIGNATURES}(hj'hhhNhNubah}(h]h ]h"]h$]h&]uh1jshjw'ubh+ config option and it is controlled by the }(hjw'hhhNhNubjt)}(h``IPE_PROP_FS_VERITY``h]hIPE_PROP_FS_VERITY}(hj'hhhNhNubah}(h]h ]h"]h$]h&]uh1jshjw'ubh7 config option, it will be automatically selected when }(hjw'hhhNhNubjt)}(h``SECURITY_IPE``h]h SECURITY_IPE}(hj'hhhNhNubah}(h]h ]h"]h$]h&]uh1jshjw'ubh, }(hjw'hhhNhNubjt)}(h ``FS_VERITY``h]h FS_VERITY}(hj'hhhNhNubah}(h]h ]h"]h$]h&]uh1jshjw'ubh and }(hjw'hhhNhNubjt)}(h ``FS_VERITY_BUILTIN_SIGNATURES``h]hFS_VERITY_BUILTIN_SIGNATURES}(hj'hhhNhNubah}(h]h ]h"]h$]h&]uh1jshjw'ubh1 are all enabled. The format of this property is:}(hjw'hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhMhjs'ubjb)}(hfsverity_signature=(TRUE|FALSE)h]hfsverity_signature=(TRUE|FALSE)}hj'sbah}(h]h ]h"]h$]h&]hhuh1jahhhMhjs'ubeh}(h]h ]h"]h$]h&]uh1j9!hhhMhjb'hhubeh}(h]fsverity-signatureah ]h"]fsverity_signatureah$]h&]uh1hhj hhhhhMubeh}(h] propertiesah ]h"] propertiesah$]h&]uh1hhhhhhhhM+ubh)}(hhh](h)}(hPolicy Examplesh]hPolicy Examples}(hj(hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj(hhhhhMubh)}(hhh](h)}(h Allow allh]h Allow all}(hj(hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj(hhhhhMubjb)}(h?policy_name=Allow_All policy_version=0.0.0 DEFAULT action=ALLOWh]h?policy_name=Allow_All policy_version=0.0.0 DEFAULT action=ALLOW}hj%(sbah}(h]h ]h"]h$]h&]hhuh1jahhhMhj(hhubeh}(h] allow-allah ]h"] allow allah$]h&]uh1hhj(hhhhhMubh)}(hhh](h)}(hAllow only initramfsh]hAllow only initramfs}(hj>(hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj;(hhhhhMubjb)}(hppolicy_name=Allow_Initramfs policy_version=0.0.0 DEFAULT action=DENY op=EXECUTE boot_verified=TRUE action=ALLOWh]hppolicy_name=Allow_Initramfs policy_version=0.0.0 DEFAULT action=DENY op=EXECUTE boot_verified=TRUE action=ALLOW}hjL(sbah}(h]h ]h"]h$]h&]hhuh1jahhhMhj;(hhubeh}(h]allow-only-initramfsah ]h"]allow only initramfsah$]h&]uh1hhj(hhhhhMubh)}(hhh](h)}(hAAllow any signed and validated dm-verity volume and the initramfsh]hAAllow any signed and validated dm-verity volume and the initramfs}(hje(hhhNhNubah}(h]h ]h"]h$]h&]uh1hhjb(hhhhhMubjb)}(hpolicy_name=Allow_Signed_DMV_And_Initramfs policy_version=0.0.0 DEFAULT action=DENY op=EXECUTE boot_verified=TRUE action=ALLOW op=EXECUTE dmverity_signature=TRUE action=ALLOWh]hpolicy_name=Allow_Signed_DMV_And_Initramfs policy_version=0.0.0 DEFAULT action=DENY op=EXECUTE boot_verified=TRUE action=ALLOW op=EXECUTE dmverity_signature=TRUE action=ALLOW}hjs(sbah}(h]h ]h"]h$]h&]hhuh1jahhhMhjb(hhubeh}(h]Aallow-any-signed-and-validated-dm-verity-volume-and-the-initramfsah ]h"]Aallow any signed and validated dm-verity volume and the initramfsah$]h&]uh1hhj(hhhhhMubh)}(hhh](h)}(h3Prohibit execution from a specific dm-verity volumeh]h3Prohibit execution from a specific dm-verity volume}(hj(hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj(hhhhhMubjb)}(hXpolicy_name=Deny_DMV_By_Roothash policy_version=0.0.0 DEFAULT action=DENY op=EXECUTE dmverity_roothash=sha256:cd2c5bae7c6c579edaae4353049d58eb5f2e8be0244bf05345bc8e5ed257baff action=DENY op=EXECUTE boot_verified=TRUE action=ALLOW op=EXECUTE dmverity_signature=TRUE action=ALLOWh]hXpolicy_name=Deny_DMV_By_Roothash policy_version=0.0.0 DEFAULT action=DENY op=EXECUTE dmverity_roothash=sha256:cd2c5bae7c6c579edaae4353049d58eb5f2e8be0244bf05345bc8e5ed257baff action=DENY op=EXECUTE boot_verified=TRUE action=ALLOW op=EXECUTE dmverity_signature=TRUE action=ALLOW}hj(sbah}(h]h ]h"]h$]h&]hhuh1jahhhMhj(hhubeh}(h]3prohibit-execution-from-a-specific-dm-verity-volumeah ]h"]3prohibit execution from a specific dm-verity volumeah$]h&]uh1hhj(hhhhhMubh)}(hhh](h)}(h&Allow only a specific dm-verity volumeh]h&Allow only a specific dm-verity volume}(hj(hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj(hhhhhMubjb)}(hpolicy_name=Allow_DMV_By_Roothash policy_version=0.0.0 DEFAULT action=DENY op=EXECUTE dmverity_roothash=sha256:401fcec5944823ae12f62726e8184407a5fa9599783f030dec146938 action=ALLOWh]hpolicy_name=Allow_DMV_By_Roothash policy_version=0.0.0 DEFAULT action=DENY op=EXECUTE dmverity_roothash=sha256:401fcec5944823ae12f62726e8184407a5fa9599783f030dec146938 action=ALLOW}hj(sbah}(h]h ]h"]h$]h&]hhuh1jahhhMhj(hhubeh}(h]&allow-only-a-specific-dm-verity-volumeah ]h"]&allow only a specific dm-verity volumeah$]h&]uh1hhj(hhhhhMubh)}(hhh](h)}(h8Allow any fs-verity file with a valid built-in signatureh]h8Allow any fs-verity file with a valid built-in signature}(hj(hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj(hhhhhMubjb)}(hpolicy_name=Allow_Signed_And_Validated_FSVerity policy_version=0.0.0 DEFAULT action=DENY op=EXECUTE fsverity_signature=TRUE action=ALLOWh]hpolicy_name=Allow_Signed_And_Validated_FSVerity policy_version=0.0.0 DEFAULT action=DENY op=EXECUTE fsverity_signature=TRUE action=ALLOW}hj(sbah}(h]h ]h"]h$]h&]hhuh1jahhhMhj(hhubeh}(h]8allow-any-fs-verity-file-with-a-valid-built-in-signatureah ]h"]8allow any fs-verity file with a valid built-in signatureah$]h&]uh1hhj(hhhhhMubh)}(hhh](h)}(h,Allow execution of a specific fs-verity fileh]h,Allow execution of a specific fs-verity file}(hj)hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj(hhhhhMubjb)}(hpolicy_name=ALLOW_FSV_By_Digest policy_version=0.0.0 DEFAULT action=DENY op=EXECUTE fsverity_digest=sha256:fd88f2b8824e197f850bf4c5109bea5cf0ee38104f710843bb72da796ba5af9e action=ALLOWh]hpolicy_name=ALLOW_FSV_By_Digest policy_version=0.0.0 DEFAULT action=DENY op=EXECUTE fsverity_digest=sha256:fd88f2b8824e197f850bf4c5109bea5cf0ee38104f710843bb72da796ba5af9e action=ALLOW}hj)sbah}(h]h ]h"]h$]h&]hhuh1jahhhMhj(hhubeh}(h],allow-execution-of-a-specific-fs-verity-fileah ]h"],allow execution of a specific fs-verity fileah$]h&]uh1hhj(hhhhhMubeh}(h]policy-examplesah ]h"]policy examplesah$]h&]uh1hhhhhhhhMubh)}(hhh](h)}(hAdditional Informationh]hAdditional Information}(hj0)hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj-)hhhhhMubjh)}(hhh](jm)}(h7`Github Repository `_h]h)}(hjC)h](h reference)}(hjC)h]hGithub Repository}(hjJ)hhhNhNubah}(h]h ]h"]h$]h&]nameGithub Repositoryrefuri https://github.com/microsoft/ipeuh1jH)hjE)ubhtarget)}(h# h]h}(h]github-repositoryah ]h"]github repositoryah$]h&]refurijZ)uh1j[) referencedKhjE)ubeh}(h]h ]h"]h$]h&]uh1hhhhMhjA)ubah}(h]h ]h"]h$]h&]uh1jlhj>)hhhhhNubjm)}(h9:doc:`Developer and design docs for IPE ` h]h)}(h8:doc:`Developer and design docs for IPE `h]h)}(hj})h]h)}(hj})h]h!Developer and design docs for IPE}(hj)hhhNhNubah}(h]h ](hstdstd-doceh"]h$]h&]uh1hhj)ubah}(h]h ]h"]h$]h&]refdocj  refdomainj)reftypedoc refexplicitrefwarnj /security/ipeuh1hhhhMhj{)ubah}(h]h ]h"]h$]h&]uh1hhhhMhjw)ubah}(h]h ]h"]h$]h&]uh1jlhj>)hhhhhNubeh}(h]h ]h"]h$]h&]jjuh1jghhhMhj-)hhubeh}(h]additional-informationah ]h"]additional informationah$]h&]uh1hhhhhhhhMubh)}(hhh](h)}(hFAQh]hFAQ}(hj)hhhNhNubah}(h]h ]h"]h$]h&]uh1hhj)hhhhhMubhdefinition_list)}(hhh]hdefinition_list_item)}(hcQ: What's the difference between other LSMs which provide a measure of trust-based access control? h](hterm)}(hQ:h]hQ:}(hj)hhhNhNubah}(h]h ]h"]h$]h&]uh1j)hhhM"hj)ubh definition)}(hhh]h)}(h_What's the difference between other LSMs which provide a measure of trust-based access control?h]haWhat’s the difference between other LSMs which provide a measure of trust-based access control?}(hj)hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM!hj)ubah}(h]h ]h"]h$]h&]uh1j)hj)ubeh}(h]h ]h"]h$]h&]uh1j)hhhM"hj)ubah}(h]h ]h"]h$]h&]uh1j)hj)hhhhhNubh)}(hA:h]hA:}(hj *hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM$hj)hhubj:!)}(hX$In general, there's two other LSMs that can provide similar functionality: IMA, and Loadpin. IMA and IPE are functionally very similar. The significant difference between the two is the policy. [#devdoc]_ Loadpin and IPE differ fairly dramatically, as Loadpin only covers the IPE's kernel read operations, whereas IPE is capable of controlling execution on top of kernel read. The trust model is also different; Loadpin roots its trust in the initial super-block, whereas trust in IPE is stemmed from kernel itself (via ``SYSTEM_TRUSTED_KEYS``). h](h)}(h\In general, there's two other LSMs that can provide similar functionality: IMA, and Loadpin.h]h^In general, there’s two other LSMs that can provide similar functionality: IMA, and Loadpin.}(hj*hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM&hj*ubh)}(hoIMA and IPE are functionally very similar. The significant difference between the two is the policy. [#devdoc]_h](heIMA and IPE are functionally very similar. The significant difference between the two is the policy. }(hj)*hhhNhNubj)}(h [#devdoc]_h]h2}(hj1*hhhNhNubah}(h]id6ah ]h"]h$]h&]jKjjVjj uh1jhj)*jKubeh}(h]h ]h"]h$]h&]uh1hhhhM)hj*ubh)}(hXTLoadpin and IPE differ fairly dramatically, as Loadpin only covers the IPE's kernel read operations, whereas IPE is capable of controlling execution on top of kernel read. The trust model is also different; Loadpin roots its trust in the initial super-block, whereas trust in IPE is stemmed from kernel itself (via ``SYSTEM_TRUSTED_KEYS``).h](hX=Loadpin and IPE differ fairly dramatically, as Loadpin only covers the IPE’s kernel read operations, whereas IPE is capable of controlling execution on top of kernel read. The trust model is also different; Loadpin roots its trust in the initial super-block, whereas trust in IPE is stemmed from kernel itself (via }(hjF*hhhNhNubjt)}(h``SYSTEM_TRUSTED_KEYS``h]hSYSTEM_TRUSTED_KEYS}(hjN*hhhNhNubah}(h]h ]h"]h$]h&]uh1jshjF*ubh).}(hjF*hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhM,hj*ubeh}(h]h ]h"]h$]h&]uh1j9!hhhM&hj)hhubh transition)}(h -----------h]h}(h]h ]h"]h$]h&]uh1jl*hhhM2hj)hhubhfootnote)}(hUhttps://lore.kernel.org/lkml/20240415142436.2545003-1-roberto.sassu@huaweicloud.com/ h](hlabel)}(hhh]h1}(hj*hhhNhNubah}(h]h ]h"]h$]h&]uh1j~*hjz*hhhNhNubh)}(hThttps://lore.kernel.org/lkml/20240415142436.2545003-1-roberto.sassu@huaweicloud.com/h]jI))}(hj*h]hThttps://lore.kernel.org/lkml/20240415142436.2545003-1-roberto.sassu@huaweicloud.com/}(hj*hhhNhNubah}(h]h ]h"]h$]h&]refurij*uh1jH)hj*ubah}(h]h ]h"]h$]h&]uh1hhhhM4hjz*ubeh}(h]jah ]h"]digest_cache_lsmah$]h&]jajKjj uh1jx*hhhM4hj)hhubjy*)}(hJPlease see :doc:`the design docs ` for more on this topic. h](j*)}(hhh]h2}(hj*hhhNhNubah}(h]h ]h"]h$]h&]uh1j~*hj*hhhNhNubh)}(hIPlease see :doc:`the design docs ` for more on this topic.h](h Please see }(hj*hhhNhNubh)}(h&:doc:`the design docs `h]h)}(hj*h]hthe design docs}(hj*hhhNhNubah}(h]h ](hstdstd-doceh"]h$]h&]uh1hhj*ubah}(h]h ]h"]h$]h&]refdocj  refdomainj*reftypedoc refexplicitrefwarnj /security/ipeuh1hhhhM6hj*ubh for more on this topic.}(hj*hhhNhNubeh}(h]h ]h"]h$]h&]uh1hhhhM6hj*ubeh}(h]jVah ]h"]devdocah$]h&](jQj;*ejKjj uh1jx*hhhM6hj)hhubjy*)}(h9https://man7.org/linux/man-pages/man8/switch_root.8.html h](j*)}(hhh]h3}(hj*hhhNhNubah}(h]h ]h"]h$]h&]uh1j~*hj*hhhNhNubh)}(h8https://man7.org/linux/man-pages/man8/switch_root.8.htmlh]jI))}(hj +h]h8https://man7.org/linux/man-pages/man8/switch_root.8.html}(hj +hhhNhNubah}(h]h ]h"]h$]h&]refurij +uh1jH)hj+ubah}(h]h ]h"]h$]h&]uh1hhhhM9hj*ubeh}(h]j$ah ]h"] switch_rootah$]h&]j$ajKjj uh1jx*hhhM9hj)hhubjy*)}(hThese hash algorithms are based on values accepted by the Linux crypto API; IPE does not impose any restrictions on the digest algorithm itself; thus, this list may be out of date. h](j*)}(hhh]h4}(hj*+hhhNhNubah}(h]h ]h"]h$]h&]uh1j~*hj&+hhhNhNubh)}(hThese hash algorithms are based on values accepted by the Linux crypto API; IPE does not impose any restrictions on the digest algorithm itself; thus, this list may be out of date.h]hThese hash algorithms are based on values accepted by the Linux crypto API; IPE does not impose any restrictions on the digest algorithm itself; thus, this list may be out of date.}(hj7+hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM;hj&+ubeh}(h]j$ah ]h"]dmveritydigestsah$]h&]j$ajKjj uh1jx*hhhM;hj)hhubjy*)}(hThese hash algorithms are based on values accepted by the kernel's fsverity support; IPE does not impose any restrictions on the digest algorithm itself; thus, this list may be out of date.h](j*)}(hhh]h5}(hjP+hhhNhNubah}(h]h ]h"]h$]h&]uh1j~*hjL+hhhNhNubh)}(hThese hash algorithms are based on values accepted by the kernel's fsverity support; IPE does not impose any restrictions on the digest algorithm itself; thus, this list may be out of date.h]hThese hash algorithms are based on values accepted by the kernel’s fsverity support; IPE does not impose any restrictions on the digest algorithm itself; thus, this list may be out of date.}(hj]+hhhNhNubah}(h]h ]h"]h$]h&]uh1hhhhM@hjL+ubeh}(h]j 'ah ]h"]fsveritydigestah$]h&]j'ajKjj uh1jx*hhhM@hj)hhubeh}(h]faqah ]h"]faqah$]h&]uh1hhhhhhhhMubeh}(h] integrity-policy-enforcement-ipeah ]h"]"integrity policy enforcement (ipe)ah$]h&]uh1hhhhhhhhKubeh}(h]h ]h"]h$]h&]sourcehuh1hcurrent_sourceN current_lineNsettingsdocutils.frontendValues)}(hN generatorN datestampN source_linkN source_urlN toc_backlinksj footnote_backlinksK sectnum_xformKstrip_commentsNstrip_elements_with_classesN strip_classesN report_levelK halt_levelKexit_status_levelKdebugNwarning_streamN tracebackinput_encoding utf-8-siginput_encoding_error_handlerstrictoutput_encodingutf-8output_encoding_error_handlerj+error_encodingutf-8error_encoding_error_handlerbackslashreplace language_codeenrecord_dependenciesNconfigN id_prefixhauto_id_prefixid dump_settingsNdump_internalsNdump_transformsNdump_pseudo_xmlNexpose_internalsNstrict_visitorN_disable_configN_sourcehnj _destinationN _config_files]7/var/lib/git/docbuild/linux/Documentation/docutils.confafile_insertion_enabled raw_enabledKline_length_limitM'pep_referencesN pep_base_urlhttps://peps.python.org/pep_file_url_templatepep-%04drfc_referencesN rfc_base_url&https://datatracker.ietf.org/doc/html/ tab_widthKtrim_footnote_reference_spacesyntax_highlightlong smart_quotessmartquotes_locales]character_level_inline_markupdoctitle_xform docinfo_xformKsectsubtitle_xform image_loadinglinkembed_stylesheetcloak_email_addressessection_self_linkenvNubreporterNindirect_targets]substitution_defs}substitution_names}refnames}(digest_cache_lsm]jadevdoc](jGj1*e switch_root]j$admveritydigests]j$afsveritydigest]j&aurefids}(j]jajV](jGj1*ej$]j$aj$]j$aj ']j&aunameids}(j+j|+jjjjjjj+j(j j j j j8 j5 j j j+j(jRjOjjjjj| jy j(j'j4#j1#j#j#j:$j7$j%j%jx&ju&j_'j\'j'j'j*)j')j8(j5(j_(j\(j(j(j(j(j(j(j(j(j")j)j)j)jf)jc)jw+jt+j*jj*jVj#+j$jI+j$jo+j 'u nametypes}(j+jjjj+j j j8 j j+jRjjj| j(j4#j#j:$j%jx&j_'j'j*)j8(j_(j(j(j(j(j")j)jf)jw+j*j*j#+jI+jo+uh}(j|+hjj"jjjjjjj(jj j.jQjGj jj5 j j j; j(jL jOj.jjUjjjy jj'j j1#j!j#j7#j7$j#j$j$j%j=$j$j$ju&j%j\'j{&j'j&j'jb'j')j(j5(j(j\(j;(j(jb(j(j(j(j(j(j(j)j(j)j-)jc)j])jt+j)j;*j1*jjz*jVj*j$j*j$j&+j 'jL+u footnote_refs}(j+]jaj+](jGj1*ej+]j$aj+]j$aj+]j&au citation_refs} autofootnotes](jz*j*j*j&+jL+eautofootnote_refs](jjGj$j$j&j1*esymbol_footnotes]symbol_footnote_refs] footnotes] citations]autofootnote_startKsymbol_footnote_startK id_counter collectionsCounter}j+KsRparse_messages]transform_messages] transformerN include_log] decorationNhhub.