From: Philippe Proulx Date: Tue, 28 Nov 2023 19:31:58 +0000 (-0500) Subject: 2.12, 2.13: Mention that kernel modules may need to be signed X-Git-Url: http://git.liburcu.org/?p=lttng-docs.git;a=commitdiff_plain;h=f9bace78581e1b26112fef8cfc7c7a5835302eb0 2.12, 2.13: Mention that kernel modules may need to be signed Change-Id: I7fc20f1afb3e0de2ddaaa75b41753b5aab08ded4 Signed-off-by: Kienan Stewart Signed-off-by: Philippe Proulx --- diff --git a/2.12/lttng-docs-2.12.txt b/2.12/lttng-docs-2.12.txt index d35756d..c3a937d 100644 --- a/2.12/lttng-docs-2.12.txt +++ b/2.12/lttng-docs-2.12.txt @@ -1,7 +1,7 @@ The LTTng Documentation ======================= Philippe Proulx -v2.12, 3 November 2023 +v2.12, 28 November 2023 include::../common/copyright.txt[] @@ -712,6 +712,45 @@ the installed files in a specific directory. This can be useful to test LTTng without installing it on your system. +[[linux-kernel-sig]] +=== Linux kernel module signature + +Linux kernel modules require trusted signatures in order to be loaded +when any of the following is true: + +* The system boots with + https://uefi.org/specs/UEFI/2.10/32_Secure_Boot_and_Driver_Signing.html#secure-boot-and-driver-signing[Secure Boot] + enabled. + +* The Linux kernel which boots is configured with + `CONFIG_MODULE_SIG_FORCE`. + +* The Linux kernel boots with a command line containing + `module.sig_enforce=1`. + +.`root` user running <> which fails to load a required <> due to the signature enforcement policies. +==== +[role="term"] +---- +# lttng-sessiond +Warning: No tracing group detected +modprobe: ERROR: could not insert 'lttng_ring_buffer_client_discard': Key was rejected by service +Error: Unable to load required module lttng-ring-buffer-client-discard +Warning: No kernel tracer available +---- +==== + +There are several methods to enroll trusted keys for signing modules +that are built from source. The precise details vary from one Linux +version to another, and distributions may have their own mechanisms. For +example, https://github.com/dell/dkms[DKMS] may autogenerate a key and +sign modules, but the key isn't automatically enrolled. + +See +https://www.kernel.org/doc/html/latest/admin-guide/module-signing.html[Kernel +module signing facility] and the documentation of your distribution +to learn more about signing Linux kernel modules. + [[getting-started]] == Quick start @@ -1923,8 +1962,9 @@ See <>. Generally, you don't have to load the LTTng kernel modules manually (using man:modprobe(8), for example): a root <> loads the necessary modules when starting. If you have extra -probe modules, you can specify to load them to the session daemon on -the command line. +probe modules, you can specify to load them to the session daemon on the +command line. See also +<>. The LTTng kernel modules are installed in +/usr/lib/modules/__release__/extra+ by default, where +__release__+ is diff --git a/2.13/lttng-docs-2.13.txt b/2.13/lttng-docs-2.13.txt index d69aaab..3349d48 100644 --- a/2.13/lttng-docs-2.13.txt +++ b/2.13/lttng-docs-2.13.txt @@ -1,7 +1,7 @@ The LTTng Documentation ======================= Philippe Proulx -v2.13, 17 October 2023 +v2.13, 28 November 2023 include::../common/copyright.txt[] @@ -827,6 +827,44 @@ previous steps automatically for a given version of LTTng and confine the installed files to a specific directory. This can be useful to try LTTng without installing it on your system. +[[linux-kernel-sig]] +=== Linux kernel module signature + +Linux kernel modules require trusted signatures in order to be loaded +when any of the following is true: + +* The system boots with + https://uefi.org/specs/UEFI/2.10/32_Secure_Boot_and_Driver_Signing.html#secure-boot-and-driver-signing[Secure Boot] + enabled. + +* The Linux kernel which boots is configured with + `CONFIG_MODULE_SIG_FORCE`. + +* The Linux kernel boots with a command line containing + `module.sig_enforce=1`. + +.`root` user running <> which fails to load a required <> due to the signature enforcement policies. +==== +[role="term"] +---- +# lttng-sessiond +Warning: No tracing group detected +modprobe: ERROR: could not insert 'lttng_ring_buffer_client_discard': Key was rejected by service +Error: Unable to load required module lttng-ring-buffer-client-discard +Warning: No kernel tracer available +---- +==== + +There are several methods to enroll trusted keys for signing modules +that are built from source. The precise details vary from one Linux +version to another, and distributions may have their own mechanisms. For +example, https://github.com/dell/dkms[DKMS] may autogenerate a key and +sign modules, but the key isn't automatically enrolled. + +See +https://www.kernel.org/doc/html/latest/admin-guide/module-signing.html[Kernel +module signing facility] and the documentation of your distribution +to learn more about signing Linux kernel modules. [[getting-started]] == Quick start @@ -2396,7 +2434,8 @@ Generally, you don't have to load the LTTng kernel modules manually (using man:modprobe(8), for example): a root session daemon loads the necessary modules when starting. If you have extra probe modules, you can specify to load them to the session daemon on the command line -(see the opt:lttng-sessiond(8):--extra-kmod-probes option). +(see the opt:lttng-sessiond(8):--extra-kmod-probes option). See also +<>. The LTTng kernel modules are installed in +/usr/lib/modules/__release__/extra+ by default, where +__release__+ is