| Message ID | 20220614161258.1741427-3-stefanb@linux.ibm.com |
|---|---|
| State | New |
| Headers | show |
| Series | [1/3] of: kexec: Refactor IMA buffer related functions to make them reusable | expand |
On 6/15/22 16:14, Rob Herring wrote: > On Wed, Jun 15, 2022 at 09:08:04AM -0400, Stefan Berger wrote: >> >> >> On 6/14/22 13:48, Rob Herring wrote: >>> (),On Tue, Jun 14, 2022 at 10:13 AM Stefan Berger <stefanb@linux.ibm.com> wrote: >>>> >>>> The memory area of the TPM measurement log is currently not properly >>>> duplicated for carrying it across kexec when an Open Firmware >>>> Devicetree is used. Therefore, the contents of the log get corrupted. >>>> Fix this for the kexec_file_load() syscall by allocating a buffer and >>>> copying the contents of the existing log into it. The new buffer is >>>> preserved across the kexec and a pointer to it is available when the new >>>> kernel is started. To achieve this, store the allocated buffer's address >>>> in the flattened device tree (fdt) under the name linux,tpm-kexec-buffer >>>> and search for this entry early in the kernel startup before the TPM >>>> subsystem starts up. Adjust the pointer in the of-tree stored under >>>> linux,sml-base to point to this buffer holding the preserved log. The >>>> TPM driver can then read the base address from this entry when making >>>> the log available. >>> >>> This series really needs a wider Cc list of folks that worry about >>> TPMs and kexec. >>> >>>> Signed-off-by: Stefan Berger <stefanb@linux.ibm.com> >>>> Cc: Rob Herring <robh+dt@kernel.org> >>>> Cc: Frank Rowand <frowand.list@gmail.com> >>>> Cc: Eric Biederman <ebiederm@xmission.com> >>>> --- >>>> drivers/of/device.c | 24 +++++ >>>> drivers/of/kexec.c | 190 +++++++++++++++++++++++++++++++++++++- >>>> include/linux/kexec.h | 6 ++ >>>> include/linux/of.h | 5 + >>>> include/linux/of_device.h | 3 + >>>> kernel/kexec_file.c | 6 ++ >>>> 6 files changed, 233 insertions(+), 1 deletion(-) >>>> >>>> diff --git a/drivers/of/device.c b/drivers/of/device.c >>>> index 874f031442dc..0cbd47b1cabc 100644 >>>> --- a/drivers/of/device.c >>>> +++ b/drivers/of/device.c >>>> @@ -382,3 +382,27 @@ int of_device_uevent_modalias(struct device *dev, struct kobj_uevent_env *env) >>>> return 0; >>>> } >>>> EXPORT_SYMBOL_GPL(of_device_uevent_modalias); >>>> + >>>> +int of_tpm_get_sml_parameters(struct device_node *np, u64 *base, u32 *size) >>> >>> of/device.c is for functions that work on a struct device. This is not >>> the case here. >> >> Can I put it into platform.c? > > That's for struct platform_device things. > Should I create a new file then? >> I should have probably mentioned it but this function here is a copy of code >> from tpm_read_log_of() from here: https://elixir.bootlin.com/linux/latest/source/drivers/char/tpm/eventlog/of.c#L38 >> >> 3/3 refactors the code in tpm/eventlog/of.c to make use of this new function >> then to avoid code duplication. Therefore, this code here is more general >> than necessary at this point. Maybe I should do the move in a patch of its >> own? > > Maybe you should leave that function there and call it? The function would only be callable if TPM subsystem was enabled. That doesn't sound right to make kexec depend on the TPM subsystem. I could just implement a less generic function that only handles the vTPM case then and not target this function to be called from the TPM subsystem via the refactoring in 3/3. > > Generally, subsystem specific things go into the subsystems. However, > there's a few special cases like kexec now. That was added primarily to > avoid per arch duplication. > > I've never looked at the TPM code, so sorry, I don't have more specific > suggestions. > >>>> +{ >>>> + const u32 *sizep; >>>> + const u64 *basep; >>>> + >>>> + sizep = of_get_property(np, "linux,sml-size", NULL); >>>> + basep = of_get_property(np, "linux,sml-base", NULL); >>> >>> Any new properties need a schema. For chosen, that's located here[1]. >>> The more common pattern for similar properties is <base size>. >>> >>> Don't use of_get_property(), but the typed functions instead. >> >> I think this was done due to the little endian and big endian distinction >> below. > > > Right. > >>>> + if (sizep == NULL && basep == NULL) >>>> + return -ENODEV; >>>> + if (sizep == NULL || basep == NULL) >>>> + return -EIO; >>> >>> Do we really need the error distinction? >> >> As I mentioned, this code is a copy from the TPM subsystem. There it does >> make a distinction because similar functions for acpi and efi make a >> distinction as well although this particular function's return code doesn't >> matter in the end. >> >> The code I am referring to is this here: >> >> https://elixir.bootlin.com/linux/latest/source/drivers/char/tpm/eventlog/common.c#L85 >> >>> >>>> + >>>> + if (of_property_match_string(np, "compatible", "IBM,vtpm") < 0 && >>>> + of_property_match_string(np, "compatible", "IBM,vtpm20") < 0) { >>>> + *size = be32_to_cpup((__force __be32 *)sizep); >>>> + *base = be64_to_cpup((__force __be64 *)basep); >>>> + } else { >>>> + *size = *sizep; >>>> + *base = *basep; >>> >>> What? Some platforms aren't properly encoded? Fix the firmware. >> >> It's been like this for years... > > Great! :( > > I'm confused how IBM needs this? Only a LE machine with LE DT encoding > would need this. With Power being historically BE and only recently > (though I guess that's a few years now) supporting LE, how did the DT > encoding become LE for this yet not for everything else in DT? > For some reason the TPM log of a hardware TPM I believe is written in little endian. I am not aware of the history of it. > [...] > > >>>> +/** >>>> + * tpm_post_kexec - Make stored TPM log buffer available in of-tree >>>> + */ >>>> +static int __init tpm_post_kexec(void) >>>> +{ >>>> + struct property *newprop; >>>> + struct device_node *np; >>>> + void *phyaddr; >>>> + size_t size; >>>> + u32 oflogsize; >>>> + u64 unused; >>>> + int ret; >>>> + >>>> + ret = tpm_get_kexec_buffer(&phyaddr, &size); >>>> + if (ret) >>>> + return 0; >>>> + >>>> + /* >>>> + * If any one of the following steps fails then the next kexec will >>>> + * cause issues due to linux,sml-base pointing to a stale buffer. >>>> + */ >>>> + np = of_find_node_by_name(NULL, "vtpm"); >>> >>> This seems pretty IBM specific. >> >> Yes, it is and I am not sure what to do about it. Should I cover parts of >> the function with a #ifdef CONFIG_PPC_PSERIES ? > > #ifdef's aren't great. IS_ENABLED() is a bit better, but really put > implementation specific things in implementation specific code. > > Perhaps each TPM implementation needs its own hook to do stuff? > From what I know it's only vTPM with of-tree that needs this. >>>> + if (!np) >>>> + goto err_free_memblock; >>>> + >>>> + /* logsize must not have changed */ >>>> + if (of_tpm_get_sml_parameters(np, &unused, &oflogsize) < 0) >>>> + goto err_free_memblock; >>>> + if (oflogsize != size) >>>> + goto err_free_memblock; >>>> + >>>> + /* replace linux,sml-base with new physical address of buffer */ >>>> + ret = -ENOMEM; >>>> + newprop = kzalloc(sizeof(*newprop), GFP_KERNEL); >>>> + if (!newprop) >>>> + goto err_free_memblock; >>>> + >>>> + newprop->name = kstrdup("linux,sml-base", GFP_KERNEL); >>>> + if (!newprop->name) >>>> + goto err_free_newprop; >>>> + >>>> + newprop->length = sizeof(phyaddr); >>>> + >>>> + newprop->value = kmalloc(sizeof(u64), GFP_KERNEL); >>>> + if (!newprop->value) >>>> + goto err_free_newprop_struct; >>>> + >>>> + if (of_property_match_string(np, "compatible", "IBM,vtpm") < 0 && >>>> + of_property_match_string(np, "compatible", "IBM,vtpm20") < 0) { >>>> + ret = -ENODEV; >>>> + goto err_free_newprop_struct; >>>> + } else { >>>> + *(u64 *)newprop->value = (u64)phyaddr; >>>> + } >>>> + >>>> + ret = of_update_property(np, newprop); >>> >>> Just FYI for now, there's some work happening on a better API for >>> writing nodes and properties. >> >> Ok. >> >>> >>>> + if (ret) { >>>> + pr_err("Could not update linux,sml-base with new address"); >>>> + goto err_free_newprop_struct; >>>> + } >>>> + >>>> + goto exit; >>>> + >>>> +err_free_newprop_struct: >>>> + kfree(newprop->name); >>>> +err_free_newprop: >>>> + kfree(newprop); >>>> +err_free_memblock: >>>> + memblock_phys_free((phys_addr_t)phyaddr, size); >>>> +exit: >>>> + tpm_of_remove_kexec_buffer(); >>>> + >>>> + return ret; >>>> +} >>>> +postcore_initcall(tpm_post_kexec); >>> >>> Would be better if this is called explicitly at the right time when >>> needed rather than using an initcall. >> >> The 'when needed' would be the TPM subsystem. However, if I was to make it >> dependent on the TPM subsystem we would loose the TPM log if we were not to >> kexec into a kernel with TPM subsystem or the TPM driver wasn't activated. I >> wanted to be able to preserve the log even if a kexec'ed kernel didn't >> support or activate the TPM driver and then a subsequent one again has it >> activated... > > Sounds like a TPM problem the TPM code should deal with. Or a scenario > that just shouldn't be supported. IDK It only comes down to from where tpm_post_kexec() is called. The postcore_initcall() solves the issue this series is addressing in a more general way than if it's called from the TPM subsystem. If this initcall is unacceptable then I guess we would have to call if from the TPM subsystem - no other choice then. Thanks. Stefan
diff --git a/drivers/of/device.c b/drivers/of/device.c index 874f031442dc..0cbd47b1cabc 100644 --- a/drivers/of/device.c +++ b/drivers/of/device.c @@ -382,3 +382,27 @@ int of_device_uevent_modalias(struct device *dev, struct kobj_uevent_env *env) return 0; } EXPORT_SYMBOL_GPL(of_device_uevent_modalias); + +int of_tpm_get_sml_parameters(struct device_node *np, u64 *base, u32 *size) +{ + const u32 *sizep; + const u64 *basep; + + sizep = of_get_property(np, "linux,sml-size", NULL); + basep = of_get_property(np, "linux,sml-base", NULL); + if (sizep == NULL && basep == NULL) + return -ENODEV; + if (sizep == NULL || basep == NULL) + return -EIO; + + if (of_property_match_string(np, "compatible", "IBM,vtpm") < 0 && + of_property_match_string(np, "compatible", "IBM,vtpm20") < 0) { + *size = be32_to_cpup((__force __be32 *)sizep); + *base = be64_to_cpup((__force __be64 *)basep); + } else { + *size = *sizep; + *base = *basep; + } + return 0; +} +EXPORT_SYMBOL_GPL(of_tpm_get_sml_parameters); diff --git a/drivers/of/kexec.c b/drivers/of/kexec.c index eef6f3b9939c..db5441123a70 100644 --- a/drivers/of/kexec.c +++ b/drivers/of/kexec.c @@ -14,6 +14,7 @@ #include <linux/memblock.h> #include <linux/libfdt.h> #include <linux/of.h> +#include <linux/of_device.h> #include <linux/of_fdt.h> #include <linux/random.h> #include <linux/slab.h> @@ -221,7 +222,6 @@ static void remove_ima_buffer(void *fdt, int chosen_node) pr_debug("Removed old IMA buffer reservation.\n"); } -#ifdef CONFIG_IMA_KEXEC static int setup_buffer(void *fdt, int chosen_node, const char *name, uint64_t addr, uint64_t size) { @@ -243,6 +243,7 @@ static int setup_buffer(void *fdt, int chosen_node, const char *name, } +#ifdef CONFIG_IMA_KEXEC /** * setup_ima_buffer - add IMA buffer information to the fdt * @image: kexec image being loaded. @@ -275,6 +276,190 @@ static inline int setup_ima_buffer(const struct kimage *image, void *fdt, } #endif /* CONFIG_IMA_KEXEC */ +/** + * tpm_get_kexec_buffer - get TPM log buffer from the previous kernel + * @phyaddr: On successful return, set to physical address of buffer + * @size: On successful return, set to the buffer size. + * + * Return: 0 on success, negative errno on error. + */ +static int tpm_get_kexec_buffer(void **phyaddr, size_t *size) +{ + int ret; + unsigned long tmp_addr; + size_t tmp_size; + + ret = get_kexec_buffer("linux,tpm-kexec-buffer", &tmp_addr, &tmp_size); + if (ret) + return ret; + + *phyaddr = (void *)tmp_addr; + *size = tmp_size; + + return 0; +} + +/** + * tpm_free_kexec_buffer - free memory used by the IMA buffer + */ +static int tpm_of_remove_kexec_buffer(void) +{ + struct property *prop; + + prop = of_find_property(of_chosen, "linux,tpm-kexec-buffer", NULL); + if (!prop) + return -ENOENT; + + return of_remove_property(of_chosen, prop); +} + +/** + * remove_tpm_buffer - remove the TPM log buffer property and reservation from @fdt + * + * @fdt: Flattened Device Tree to update + * @chosen_node: Offset to the chosen node in the device tree + * + * The TPM log measurement buffer is of no use to a subsequent kernel, so we always + * remove it from the device tree. + */ +static void remove_tpm_buffer(void *fdt, int chosen_node) +{ + int ret; + + ret = remove_buffer(fdt, chosen_node, "linux,tpm-kexec-buffer"); + if (!ret) + pr_debug("Removed old TPM log buffer reservation.\n"); +} + +/** + * setup_tpm_buffer - add TPM measurement log buffer information to the fdt + * @image: kexec image being loaded. + * @fdt: Flattened device tree for the next kernel. + * @chosen_node: Offset to the chosen node. + * + * Return: 0 on success, or negative errno on error. + */ +static int setup_tpm_buffer(const struct kimage *image, void *fdt, + int chosen_node) +{ + return setup_buffer(fdt, chosen_node, "linux,tpm-kexec-buffer", + image->tpm_buffer_addr, image->tpm_buffer_size); +} + +void tpm_add_kexec_buffer(struct kimage *image) +{ + struct kexec_buf kbuf = { .image = image, .buf_align = 1, + .buf_min = 0, .buf_max = ULONG_MAX, + .top_down = true }; + struct device_node *np; + void *buffer; + u32 size; + u64 base; + int ret; + + np = of_find_node_by_name(NULL, "vtpm"); + if (!np) + return; + + if (of_tpm_get_sml_parameters(np, &base, &size) < 0) + return; + + buffer = vmalloc(size); + if (!buffer) + return; + memcpy(buffer, __va(base), size); + + kbuf.buffer = buffer; + kbuf.bufsz = size; + kbuf.memsz = size; + ret = kexec_add_buffer(&kbuf); + if (ret) { + pr_err("Error passing over kexec TPM measurement log buffer: %d\n", + ret); + return; + } + + image->tpm_buffer = buffer; + image->tpm_buffer_addr = kbuf.mem; + image->tpm_buffer_size = size; +} + +/** + * tpm_post_kexec - Make stored TPM log buffer available in of-tree + */ +static int __init tpm_post_kexec(void) +{ + struct property *newprop; + struct device_node *np; + void *phyaddr; + size_t size; + u32 oflogsize; + u64 unused; + int ret; + + ret = tpm_get_kexec_buffer(&phyaddr, &size); + if (ret) + return 0; + + /* + * If any one of the following steps fails then the next kexec will + * cause issues due to linux,sml-base pointing to a stale buffer. + */ + np = of_find_node_by_name(NULL, "vtpm"); + if (!np) + goto err_free_memblock; + + /* logsize must not have changed */ + if (of_tpm_get_sml_parameters(np, &unused, &oflogsize) < 0) + goto err_free_memblock; + if (oflogsize != size) + goto err_free_memblock; + + /* replace linux,sml-base with new physical address of buffer */ + ret = -ENOMEM; + newprop = kzalloc(sizeof(*newprop), GFP_KERNEL); + if (!newprop) + goto err_free_memblock; + + newprop->name = kstrdup("linux,sml-base", GFP_KERNEL); + if (!newprop->name) + goto err_free_newprop; + + newprop->length = sizeof(phyaddr); + + newprop->value = kmalloc(sizeof(u64), GFP_KERNEL); + if (!newprop->value) + goto err_free_newprop_struct; + + if (of_property_match_string(np, "compatible", "IBM,vtpm") < 0 && + of_property_match_string(np, "compatible", "IBM,vtpm20") < 0) { + ret = -ENODEV; + goto err_free_newprop_struct; + } else { + *(u64 *)newprop->value = (u64)phyaddr; + } + + ret = of_update_property(np, newprop); + if (ret) { + pr_err("Could not update linux,sml-base with new address"); + goto err_free_newprop_struct; + } + + goto exit; + +err_free_newprop_struct: + kfree(newprop->name); +err_free_newprop: + kfree(newprop); +err_free_memblock: + memblock_phys_free((phys_addr_t)phyaddr, size); +exit: + tpm_of_remove_kexec_buffer(); + + return ret; +} +postcore_initcall(tpm_post_kexec); + /* * of_kexec_alloc_and_setup_fdt - Alloc and setup a new Flattened Device Tree * @@ -464,6 +649,9 @@ void *of_kexec_alloc_and_setup_fdt(const struct kimage *image, remove_ima_buffer(fdt, chosen_node); ret = setup_ima_buffer(image, fdt, fdt_path_offset(fdt, "/chosen")); + remove_tpm_buffer(fdt, chosen_node); + ret = setup_tpm_buffer(image, fdt, fdt_path_offset(fdt, "/chosen")); + out: if (ret) { kvfree(fdt); diff --git a/include/linux/kexec.h b/include/linux/kexec.h index 58d1b58a971e..a0fd7ac0398c 100644 --- a/include/linux/kexec.h +++ b/include/linux/kexec.h @@ -319,6 +319,12 @@ struct kimage { void *elf_headers; unsigned long elf_headers_sz; unsigned long elf_load_addr; + + /* Virtual address of TPM log buffer for kexec syscall */ + void *tpm_buffer; + + phys_addr_t tpm_buffer_addr; + size_t tpm_buffer_size; }; /* kexec interface functions */ diff --git a/include/linux/of.h b/include/linux/of.h index 04971e85fbc9..922f51c2c072 100644 --- a/include/linux/of.h +++ b/include/linux/of.h @@ -443,6 +443,7 @@ void *of_kexec_alloc_and_setup_fdt(const struct kimage *image, const char *cmdline, size_t extra_fdt_size); int ima_get_kexec_buffer(void **addr, size_t *size); int ima_free_kexec_buffer(void); +void tpm_add_kexec_buffer(struct kimage *image); #else /* CONFIG_OF */ static inline void of_core_init(void) @@ -844,6 +845,10 @@ static inline phys_addr_t of_dma_get_max_cpu_address(struct device_node *np) return PHYS_ADDR_MAX; } +static inline void tpm_add_kexec_buffer(struct kimage *image) +{ +} + #define of_match_ptr(_ptr) NULL #define of_match_node(_matches, _node) NULL #endif /* CONFIG_OF */ diff --git a/include/linux/of_device.h b/include/linux/of_device.h index 1d7992a02e36..bac04b0b9c48 100644 --- a/include/linux/of_device.h +++ b/include/linux/of_device.h @@ -56,6 +56,9 @@ static inline int of_dma_configure(struct device *dev, { return of_dma_configure_id(dev, np, force_dma, NULL); } + +int of_tpm_get_sml_parameters(struct device_node *np, u64 *base, u32 *size); + #else /* CONFIG_OF */ static inline int of_driver_match_device(struct device *dev, diff --git a/kernel/kexec_file.c b/kernel/kexec_file.c index 8347fc158d2b..27661eb6112d 100644 --- a/kernel/kexec_file.c +++ b/kernel/kexec_file.c @@ -19,6 +19,7 @@ #include <linux/list.h> #include <linux/fs.h> #include <linux/ima.h> +#include <linux/tpm.h> #include <crypto/hash.h> #include <crypto/sha2.h> #include <linux/elf.h> @@ -171,6 +172,9 @@ void kimage_file_post_load_cleanup(struct kimage *image) image->ima_buffer = NULL; #endif /* CONFIG_IMA_KEXEC */ + vfree(image->tpm_buffer); + image->tpm_buffer = NULL; + /* See if architecture has anything to cleanup post load */ arch_kimage_file_post_load_cleanup(image); @@ -277,6 +281,8 @@ kimage_file_prepare_segments(struct kimage *image, int kernel_fd, int initrd_fd, /* IMA needs to pass the measurement list to the next kernel. */ ima_add_kexec_buffer(image); + /* Pass the TPM measurement log to next kernel */ + tpm_add_kexec_buffer(image); /* Call arch image load handlers */ ldata = arch_kexec_kernel_image_load(image);
The memory area of the TPM measurement log is currently not properly duplicated for carrying it across kexec when an Open Firmware Devicetree is used. Therefore, the contents of the log get corrupted. Fix this for the kexec_file_load() syscall by allocating a buffer and copying the contents of the existing log into it. The new buffer is preserved across the kexec and a pointer to it is available when the new kernel is started. To achieve this, store the allocated buffer's address in the flattened device tree (fdt) under the name linux,tpm-kexec-buffer and search for this entry early in the kernel startup before the TPM subsystem starts up. Adjust the pointer in the of-tree stored under linux,sml-base to point to this buffer holding the preserved log. The TPM driver can then read the base address from this entry when making the log available. Signed-off-by: Stefan Berger <stefanb@linux.ibm.com> Cc: Rob Herring <robh+dt@kernel.org> Cc: Frank Rowand <frowand.list@gmail.com> Cc: Eric Biederman <ebiederm@xmission.com> --- drivers/of/device.c | 24 +++++ drivers/of/kexec.c | 190 +++++++++++++++++++++++++++++++++++++- include/linux/kexec.h | 6 ++ include/linux/of.h | 5 + include/linux/of_device.h | 3 + kernel/kexec_file.c | 6 ++ 6 files changed, 233 insertions(+), 1 deletion(-)