* [PATCH 0/2 v2] efi: cosmetic patches for the error messages when
@ 2019-12-13 9:06 Lee, Chun-Yi
2019-12-13 9:06 ` [PATCH 1/2 v2] efi: add a function to convert the status code to a string Lee, Chun-Yi
2019-12-13 9:06 ` [PATCH 2/2] efi: show error messages only when loading certificates is failed Lee, Chun-Yi
0 siblings, 2 replies; 9+ messages in thread
From: Lee, Chun-Yi @ 2019-12-13 9:06 UTC (permalink / raw)
To: Ard Biesheuvel, James Morris, Serge E . Hallyn, David Howells,
Josh Boyer, Nayna Jain, Mimi Zohar
Cc: linux-efi, linux-security-module, linux-kernel, Lee, Chun-Yi
When loading certificates list from EFI variables, the error
messages and efi status codes always be emitted to dmesg. It looks
ugly:
[ 2.335031] Couldn't get size: 0x800000000000000e
[ 2.335032] Couldn't get UEFI MokListRT
[ 2.339985] Couldn't get size: 0x800000000000000e
[ 2.339987] Couldn't get UEFI dbx list
This cosmetic patch set moved the above messages to the error
handling code path. And, it adds a function to convert EFI status
code to a string for improving the readability of debug log. The function
can also be used in other EFI logs.
v2:
The convert function be moved to efi.c
Lee, Chun-Yi (2):
efi: add a function to convert the status code to a string
efi: show error messages only when loading certificates is failed
drivers/firmware/efi/efi.c | 32 +++++++++++++++++++++
include/linux/efi.h | 1 +
security/integrity/platform_certs/load_uefi.c | 41 ++++++++++++++-------------
3 files changed, 55 insertions(+), 19 deletions(-)
--
2.16.4
^ permalink raw reply [flat|nested] 9+ messages in thread
* [PATCH 1/2 v2] efi: add a function to convert the status code to a string
2019-12-13 9:06 [PATCH 0/2 v2] efi: cosmetic patches for the error messages when Lee, Chun-Yi
@ 2019-12-13 9:06 ` Lee, Chun-Yi
2019-12-13 10:03 ` Ard Biesheuvel
2019-12-13 9:06 ` [PATCH 2/2] efi: show error messages only when loading certificates is failed Lee, Chun-Yi
1 sibling, 1 reply; 9+ messages in thread
From: Lee, Chun-Yi @ 2019-12-13 9:06 UTC (permalink / raw)
To: Ard Biesheuvel, James Morris, Serge E . Hallyn, David Howells,
Josh Boyer, Nayna Jain, Mimi Zohar
Cc: linux-efi, linux-security-module, linux-kernel, Lee, Chun-Yi
This function can be used to convert EFI status code to a string
to improve the readability of log.
v2:
Moved the convert function to efi.c
Signed-off-by: "Lee, Chun-Yi" <jlee@suse.com>
---
drivers/firmware/efi/efi.c | 32 ++++++++++++++++++++++++++++++++
include/linux/efi.h | 1 +
2 files changed, 33 insertions(+)
diff --git a/drivers/firmware/efi/efi.c b/drivers/firmware/efi/efi.c
index e98bbf8e56d9..8bdc1c17eb5d 100644
--- a/drivers/firmware/efi/efi.c
+++ b/drivers/firmware/efi/efi.c
@@ -954,6 +954,38 @@ int efi_status_to_err(efi_status_t status)
return err;
}
+#define EFI_STATUS_STR(_status) \
+ EFI_##_status : return "EFI_" __stringify(_status)
+
+const char *efi_status_to_str(efi_status_t status)
+{
+ switch (status) {
+ case EFI_STATUS_STR(SUCCESS);
+ case EFI_STATUS_STR(LOAD_ERROR);
+ case EFI_STATUS_STR(INVALID_PARAMETER);
+ case EFI_STATUS_STR(UNSUPPORTED);
+ case EFI_STATUS_STR(BAD_BUFFER_SIZE);
+ case EFI_STATUS_STR(BUFFER_TOO_SMALL);
+ case EFI_STATUS_STR(NOT_READY);
+ case EFI_STATUS_STR(DEVICE_ERROR);
+ case EFI_STATUS_STR(WRITE_PROTECTED);
+ case EFI_STATUS_STR(OUT_OF_RESOURCES);
+ case EFI_STATUS_STR(NOT_FOUND);
+ case EFI_STATUS_STR(ABORTED);
+ case EFI_STATUS_STR(SECURITY_VIOLATION);
+ }
+ /*
+ * There are two possibilities for this message to be exposed:
+ * - Caller feeds a unknown status code from firmware.
+ * - A new status code be defined in efi.h but we forgot to update
+ * this function.
+ */
+ pr_warn("Unknown efi status: 0x%lx\n", status);
+
+ return "Unknown efi status";
+}
+EXPORT_SYMBOL(efi_status_to_str);
+
static DEFINE_SPINLOCK(efi_mem_reserve_persistent_lock);
static struct linux_efi_memreserve *efi_memreserve_root __ro_after_init;
diff --git a/include/linux/efi.h b/include/linux/efi.h
index d87acf62958e..2c6848d2b112 100644
--- a/include/linux/efi.h
+++ b/include/linux/efi.h
@@ -1228,6 +1228,7 @@ efi_capsule_pending(int *reset_type)
#endif
extern int efi_status_to_err(efi_status_t status);
+extern const char *efi_status_to_str(efi_status_t status);
/*
* Variable Attributes
--
2.16.4
^ permalink raw reply related [flat|nested] 9+ messages in thread
* [PATCH 2/2] efi: show error messages only when loading certificates is failed
2019-12-13 9:06 [PATCH 0/2 v2] efi: cosmetic patches for the error messages when Lee, Chun-Yi
2019-12-13 9:06 ` [PATCH 1/2 v2] efi: add a function to convert the status code to a string Lee, Chun-Yi
@ 2019-12-13 9:06 ` Lee, Chun-Yi
2019-12-13 9:10 ` Ard Biesheuvel
1 sibling, 1 reply; 9+ messages in thread
From: Lee, Chun-Yi @ 2019-12-13 9:06 UTC (permalink / raw)
To: Ard Biesheuvel, James Morris, Serge E . Hallyn, David Howells,
Josh Boyer, Nayna Jain, Mimi Zohar
Cc: linux-efi, linux-security-module, linux-kernel, Lee, Chun-Yi
When loading certificates list from EFI variables, the error
message and efi status code always be emitted to dmesg. It looks
ugly:
[ 2.335031] Couldn't get size: 0x800000000000000e
[ 2.335032] Couldn't get UEFI MokListRT
[ 2.339985] Couldn't get size: 0x800000000000000e
[ 2.339987] Couldn't get UEFI dbx list
This cosmetic patch moved the messages to the error handling code
path. And, it also shows the corresponding status string of status
code.
Signed-off-by: "Lee, Chun-Yi" <jlee@suse.com>
---
security/integrity/platform_certs/load_uefi.c | 40 ++++++++++++++-------------
1 file changed, 21 insertions(+), 19 deletions(-)
diff --git a/security/integrity/platform_certs/load_uefi.c b/security/integrity/platform_certs/load_uefi.c
index 81b19c52832b..b6c60fb3fb6c 100644
--- a/security/integrity/platform_certs/load_uefi.c
+++ b/security/integrity/platform_certs/load_uefi.c
@@ -1,4 +1,5 @@
// SPDX-License-Identifier: GPL-2.0
+#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
#include <linux/kernel.h>
#include <linux/sched.h>
@@ -39,7 +40,7 @@ static __init bool uefi_check_ignore_db(void)
* Get a certificate list blob from the named EFI variable.
*/
static __init void *get_cert_list(efi_char16_t *name, efi_guid_t *guid,
- unsigned long *size)
+ unsigned long *size, const char *source)
{
efi_status_t status;
unsigned long lsize = 4;
@@ -48,23 +49,30 @@ static __init void *get_cert_list(efi_char16_t *name, efi_guid_t *guid,
status = efi.get_variable(name, guid, NULL, &lsize, &tmpdb);
if (status != EFI_BUFFER_TOO_SMALL) {
- pr_err("Couldn't get size: 0x%lx\n", status);
- return NULL;
+ if (status == EFI_NOT_FOUND) {
+ pr_debug("%s list was not found\n", source);
+ return NULL;
+ }
+ goto err;
}
db = kmalloc(lsize, GFP_KERNEL);
- if (!db)
- return NULL;
+ if (!db) {
+ status = EFI_OUT_OF_RESOURCES;
+ goto err;
+ }
status = efi.get_variable(name, guid, NULL, &lsize, db);
if (status != EFI_SUCCESS) {
kfree(db);
- pr_err("Error reading db var: 0x%lx\n", status);
- return NULL;
+ goto err;
}
*size = lsize;
return db;
+err:
+ pr_err("Couldn't get %s list: %s\n", source, efi_status_to_str(status));
+ return NULL;
}
/*
@@ -153,10 +161,8 @@ static int __init load_uefi_certs(void)
* an error if we can't get them.
*/
if (!uefi_check_ignore_db()) {
- db = get_cert_list(L"db", &secure_var, &dbsize);
- if (!db) {
- pr_err("MODSIGN: Couldn't get UEFI db list\n");
- } else {
+ db = get_cert_list(L"db", &secure_var, &dbsize, "UEFI:db");
+ if (db) {
rc = parse_efi_signature_list("UEFI:db",
db, dbsize, get_handler_for_db);
if (rc)
@@ -166,10 +172,8 @@ static int __init load_uefi_certs(void)
}
}
- mok = get_cert_list(L"MokListRT", &mok_var, &moksize);
- if (!mok) {
- pr_info("Couldn't get UEFI MokListRT\n");
- } else {
+ mok = get_cert_list(L"MokListRT", &mok_var, &moksize, "UEFI:MokListRT");
+ if (mok) {
rc = parse_efi_signature_list("UEFI:MokListRT",
mok, moksize, get_handler_for_db);
if (rc)
@@ -177,10 +181,8 @@ static int __init load_uefi_certs(void)
kfree(mok);
}
- dbx = get_cert_list(L"dbx", &secure_var, &dbxsize);
- if (!dbx) {
- pr_info("Couldn't get UEFI dbx list\n");
- } else {
+ dbx = get_cert_list(L"dbx", &secure_var, &dbxsize, "UEFI:dbx");
+ if (dbx) {
rc = parse_efi_signature_list("UEFI:dbx",
dbx, dbxsize,
get_handler_for_dbx);
--
2.16.4
^ permalink raw reply related [flat|nested] 9+ messages in thread
* Re: [PATCH 2/2] efi: show error messages only when loading certificates is failed
2019-12-13 9:06 ` [PATCH 2/2] efi: show error messages only when loading certificates is failed Lee, Chun-Yi
@ 2019-12-13 9:10 ` Ard Biesheuvel
2019-12-13 9:20 ` Joey Lee
0 siblings, 1 reply; 9+ messages in thread
From: Ard Biesheuvel @ 2019-12-13 9:10 UTC (permalink / raw)
To: Lee, Chun-Yi
Cc: James Morris, Serge E . Hallyn, David Howells, Josh Boyer,
Nayna Jain, Mimi Zohar, linux-efi, linux-security-module,
Linux Kernel Mailing List, Lee, Chun-Yi
On Fri, 13 Dec 2019 at 10:07, Lee, Chun-Yi <joeyli.kernel@gmail.com> wrote:
>
> When loading certificates list from EFI variables, the error
> message and efi status code always be emitted to dmesg. It looks
> ugly:
>
> [ 2.335031] Couldn't get size: 0x800000000000000e
> [ 2.335032] Couldn't get UEFI MokListRT
> [ 2.339985] Couldn't get size: 0x800000000000000e
> [ 2.339987] Couldn't get UEFI dbx list
>
> This cosmetic patch moved the messages to the error handling code
> path. And, it also shows the corresponding status string of status
> code.
>
So what output do we get after applying this patch when those
variables don't exist?
> Signed-off-by: "Lee, Chun-Yi" <jlee@suse.com>
> ---
> security/integrity/platform_certs/load_uefi.c | 40 ++++++++++++++-------------
> 1 file changed, 21 insertions(+), 19 deletions(-)
>
> diff --git a/security/integrity/platform_certs/load_uefi.c b/security/integrity/platform_certs/load_uefi.c
> index 81b19c52832b..b6c60fb3fb6c 100644
> --- a/security/integrity/platform_certs/load_uefi.c
> +++ b/security/integrity/platform_certs/load_uefi.c
> @@ -1,4 +1,5 @@
> // SPDX-License-Identifier: GPL-2.0
> +#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
>
> #include <linux/kernel.h>
> #include <linux/sched.h>
> @@ -39,7 +40,7 @@ static __init bool uefi_check_ignore_db(void)
> * Get a certificate list blob from the named EFI variable.
> */
> static __init void *get_cert_list(efi_char16_t *name, efi_guid_t *guid,
> - unsigned long *size)
> + unsigned long *size, const char *source)
> {
> efi_status_t status;
> unsigned long lsize = 4;
> @@ -48,23 +49,30 @@ static __init void *get_cert_list(efi_char16_t *name, efi_guid_t *guid,
>
> status = efi.get_variable(name, guid, NULL, &lsize, &tmpdb);
> if (status != EFI_BUFFER_TOO_SMALL) {
> - pr_err("Couldn't get size: 0x%lx\n", status);
> - return NULL;
> + if (status == EFI_NOT_FOUND) {
> + pr_debug("%s list was not found\n", source);
> + return NULL;
> + }
> + goto err;
> }
>
> db = kmalloc(lsize, GFP_KERNEL);
> - if (!db)
> - return NULL;
> + if (!db) {
> + status = EFI_OUT_OF_RESOURCES;
> + goto err;
> + }
>
> status = efi.get_variable(name, guid, NULL, &lsize, db);
> if (status != EFI_SUCCESS) {
> kfree(db);
> - pr_err("Error reading db var: 0x%lx\n", status);
> - return NULL;
> + goto err;
> }
>
> *size = lsize;
> return db;
> +err:
> + pr_err("Couldn't get %s list: %s\n", source, efi_status_to_str(status));
> + return NULL;
> }
>
> /*
> @@ -153,10 +161,8 @@ static int __init load_uefi_certs(void)
> * an error if we can't get them.
> */
> if (!uefi_check_ignore_db()) {
> - db = get_cert_list(L"db", &secure_var, &dbsize);
> - if (!db) {
> - pr_err("MODSIGN: Couldn't get UEFI db list\n");
> - } else {
> + db = get_cert_list(L"db", &secure_var, &dbsize, "UEFI:db");
> + if (db) {
> rc = parse_efi_signature_list("UEFI:db",
> db, dbsize, get_handler_for_db);
> if (rc)
> @@ -166,10 +172,8 @@ static int __init load_uefi_certs(void)
> }
> }
>
> - mok = get_cert_list(L"MokListRT", &mok_var, &moksize);
> - if (!mok) {
> - pr_info("Couldn't get UEFI MokListRT\n");
> - } else {
> + mok = get_cert_list(L"MokListRT", &mok_var, &moksize, "UEFI:MokListRT");
> + if (mok) {
> rc = parse_efi_signature_list("UEFI:MokListRT",
> mok, moksize, get_handler_for_db);
> if (rc)
> @@ -177,10 +181,8 @@ static int __init load_uefi_certs(void)
> kfree(mok);
> }
>
> - dbx = get_cert_list(L"dbx", &secure_var, &dbxsize);
> - if (!dbx) {
> - pr_info("Couldn't get UEFI dbx list\n");
> - } else {
> + dbx = get_cert_list(L"dbx", &secure_var, &dbxsize, "UEFI:dbx");
> + if (dbx) {
> rc = parse_efi_signature_list("UEFI:dbx",
> dbx, dbxsize,
> get_handler_for_dbx);
> --
> 2.16.4
>
^ permalink raw reply [flat|nested] 9+ messages in thread
* Re: [PATCH 2/2] efi: show error messages only when loading certificates is failed
2019-12-13 9:10 ` Ard Biesheuvel
@ 2019-12-13 9:20 ` Joey Lee
2019-12-13 10:04 ` Ard Biesheuvel
0 siblings, 1 reply; 9+ messages in thread
From: Joey Lee @ 2019-12-13 9:20 UTC (permalink / raw)
To: Ard Biesheuvel
Cc: Chun-Yi Lee, Josh Boyer, Serge E . Hallyn, Nayna Jain,
Mimi Zohar, James Morris, David Howells, linux-efi,
Linux Kernel Mailing List, linux-security-module
Hi Ard,
On Fri, Dec 13, 2019 at 09:10:12AM +0000, Ard Biesheuvel wrote:
> On Fri, 13 Dec 2019 at 10:07, Lee, Chun-Yi <joeyli.kernel@gmail.com> wrote:
> >
> > When loading certificates list from EFI variables, the error
> > message and efi status code always be emitted to dmesg. It looks
> > ugly:
> >
> > [ 2.335031] Couldn't get size: 0x800000000000000e
> > [ 2.335032] Couldn't get UEFI MokListRT
> > [ 2.339985] Couldn't get size: 0x800000000000000e
> > [ 2.339987] Couldn't get UEFI dbx list
> >
> > This cosmetic patch moved the messages to the error handling code
> > path. And, it also shows the corresponding status string of status
> > code.
> >
>
> So what output do we get after applying this patch when those
> variables don't exist?
>
A "UEFI:xxxx list was not found" message will be exposed in dmesg
when kernel loglevel be set to debug. Otherwise there have no messages.
Thanks
Joey Lee
> > Signed-off-by: "Lee, Chun-Yi" <jlee@suse.com>
> > ---
> > security/integrity/platform_certs/load_uefi.c | 40 ++++++++++++++-------------
> > 1 file changed, 21 insertions(+), 19 deletions(-)
> >
> > diff --git a/security/integrity/platform_certs/load_uefi.c b/security/integrity/platform_certs/load_uefi.c
> > index 81b19c52832b..b6c60fb3fb6c 100644
> > --- a/security/integrity/platform_certs/load_uefi.c
> > +++ b/security/integrity/platform_certs/load_uefi.c
> > @@ -1,4 +1,5 @@
> > // SPDX-License-Identifier: GPL-2.0
> > +#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
> >
> > #include <linux/kernel.h>
> > #include <linux/sched.h>
> > @@ -39,7 +40,7 @@ static __init bool uefi_check_ignore_db(void)
> > * Get a certificate list blob from the named EFI variable.
> > */
> > static __init void *get_cert_list(efi_char16_t *name, efi_guid_t *guid,
> > - unsigned long *size)
> > + unsigned long *size, const char *source)
> > {
> > efi_status_t status;
> > unsigned long lsize = 4;
> > @@ -48,23 +49,30 @@ static __init void *get_cert_list(efi_char16_t *name, efi_guid_t *guid,
> >
> > status = efi.get_variable(name, guid, NULL, &lsize, &tmpdb);
> > if (status != EFI_BUFFER_TOO_SMALL) {
> > - pr_err("Couldn't get size: 0x%lx\n", status);
> > - return NULL;
> > + if (status == EFI_NOT_FOUND) {
> > + pr_debug("%s list was not found\n", source);
> > + return NULL;
> > + }
> > + goto err;
> > }
> >
> > db = kmalloc(lsize, GFP_KERNEL);
> > - if (!db)
> > - return NULL;
> > + if (!db) {
> > + status = EFI_OUT_OF_RESOURCES;
> > + goto err;
> > + }
> >
> > status = efi.get_variable(name, guid, NULL, &lsize, db);
> > if (status != EFI_SUCCESS) {
> > kfree(db);
> > - pr_err("Error reading db var: 0x%lx\n", status);
> > - return NULL;
> > + goto err;
> > }
> >
> > *size = lsize;
> > return db;
> > +err:
> > + pr_err("Couldn't get %s list: %s\n", source, efi_status_to_str(status));
> > + return NULL;
> > }
> >
> > /*
> > @@ -153,10 +161,8 @@ static int __init load_uefi_certs(void)
> > * an error if we can't get them.
> > */
> > if (!uefi_check_ignore_db()) {
> > - db = get_cert_list(L"db", &secure_var, &dbsize);
> > - if (!db) {
> > - pr_err("MODSIGN: Couldn't get UEFI db list\n");
> > - } else {
> > + db = get_cert_list(L"db", &secure_var, &dbsize, "UEFI:db");
> > + if (db) {
> > rc = parse_efi_signature_list("UEFI:db",
> > db, dbsize, get_handler_for_db);
> > if (rc)
> > @@ -166,10 +172,8 @@ static int __init load_uefi_certs(void)
> > }
> > }
> >
> > - mok = get_cert_list(L"MokListRT", &mok_var, &moksize);
> > - if (!mok) {
> > - pr_info("Couldn't get UEFI MokListRT\n");
> > - } else {
> > + mok = get_cert_list(L"MokListRT", &mok_var, &moksize, "UEFI:MokListRT");
> > + if (mok) {
> > rc = parse_efi_signature_list("UEFI:MokListRT",
> > mok, moksize, get_handler_for_db);
> > if (rc)
> > @@ -177,10 +181,8 @@ static int __init load_uefi_certs(void)
> > kfree(mok);
> > }
> >
> > - dbx = get_cert_list(L"dbx", &secure_var, &dbxsize);
> > - if (!dbx) {
> > - pr_info("Couldn't get UEFI dbx list\n");
> > - } else {
> > + dbx = get_cert_list(L"dbx", &secure_var, &dbxsize, "UEFI:dbx");
> > + if (dbx) {
> > rc = parse_efi_signature_list("UEFI:dbx",
> > dbx, dbxsize,
> > get_handler_for_dbx);
> > --
> > 2.16.4
> >
^ permalink raw reply [flat|nested] 9+ messages in thread
* Re: [PATCH 1/2 v2] efi: add a function to convert the status code to a string
2019-12-13 9:06 ` [PATCH 1/2 v2] efi: add a function to convert the status code to a string Lee, Chun-Yi
@ 2019-12-13 10:03 ` Ard Biesheuvel
2019-12-13 10:33 ` Joey Lee
0 siblings, 1 reply; 9+ messages in thread
From: Ard Biesheuvel @ 2019-12-13 10:03 UTC (permalink / raw)
To: Lee, Chun-Yi
Cc: James Morris, Serge E . Hallyn, David Howells, Josh Boyer,
Nayna Jain, Mimi Zohar, linux-efi, linux-security-module,
Linux Kernel Mailing List, Lee, Chun-Yi
On Fri, 13 Dec 2019 at 10:07, Lee, Chun-Yi <joeyli.kernel@gmail.com> wrote:
>
> This function can be used to convert EFI status code to a string
> to improve the readability of log.
>
> v2:
> Moved the convert function to efi.c
>
Please put the patch series revision log below the ---
> Signed-off-by: "Lee, Chun-Yi" <jlee@suse.com>
Acked-by: Ard Biesheuvel <ardb@kernel.org>
> ---
> drivers/firmware/efi/efi.c | 32 ++++++++++++++++++++++++++++++++
> include/linux/efi.h | 1 +
> 2 files changed, 33 insertions(+)
>
> diff --git a/drivers/firmware/efi/efi.c b/drivers/firmware/efi/efi.c
> index e98bbf8e56d9..8bdc1c17eb5d 100644
> --- a/drivers/firmware/efi/efi.c
> +++ b/drivers/firmware/efi/efi.c
> @@ -954,6 +954,38 @@ int efi_status_to_err(efi_status_t status)
> return err;
> }
>
> +#define EFI_STATUS_STR(_status) \
> + EFI_##_status : return "EFI_" __stringify(_status)
> +
> +const char *efi_status_to_str(efi_status_t status)
> +{
> + switch (status) {
> + case EFI_STATUS_STR(SUCCESS);
> + case EFI_STATUS_STR(LOAD_ERROR);
> + case EFI_STATUS_STR(INVALID_PARAMETER);
> + case EFI_STATUS_STR(UNSUPPORTED);
> + case EFI_STATUS_STR(BAD_BUFFER_SIZE);
> + case EFI_STATUS_STR(BUFFER_TOO_SMALL);
> + case EFI_STATUS_STR(NOT_READY);
> + case EFI_STATUS_STR(DEVICE_ERROR);
> + case EFI_STATUS_STR(WRITE_PROTECTED);
> + case EFI_STATUS_STR(OUT_OF_RESOURCES);
> + case EFI_STATUS_STR(NOT_FOUND);
> + case EFI_STATUS_STR(ABORTED);
> + case EFI_STATUS_STR(SECURITY_VIOLATION);
> + }
> + /*
> + * There are two possibilities for this message to be exposed:
> + * - Caller feeds a unknown status code from firmware.
> + * - A new status code be defined in efi.h but we forgot to update
> + * this function.
> + */
> + pr_warn("Unknown efi status: 0x%lx\n", status);
> +
> + return "Unknown efi status";
> +}
> +EXPORT_SYMBOL(efi_status_to_str);
> +
> static DEFINE_SPINLOCK(efi_mem_reserve_persistent_lock);
> static struct linux_efi_memreserve *efi_memreserve_root __ro_after_init;
>
> diff --git a/include/linux/efi.h b/include/linux/efi.h
> index d87acf62958e..2c6848d2b112 100644
> --- a/include/linux/efi.h
> +++ b/include/linux/efi.h
> @@ -1228,6 +1228,7 @@ efi_capsule_pending(int *reset_type)
> #endif
>
> extern int efi_status_to_err(efi_status_t status);
> +extern const char *efi_status_to_str(efi_status_t status);
>
> /*
> * Variable Attributes
> --
> 2.16.4
>
^ permalink raw reply [flat|nested] 9+ messages in thread
* Re: [PATCH 2/2] efi: show error messages only when loading certificates is failed
2019-12-13 9:20 ` Joey Lee
@ 2019-12-13 10:04 ` Ard Biesheuvel
2019-12-13 10:35 ` Joey Lee
0 siblings, 1 reply; 9+ messages in thread
From: Ard Biesheuvel @ 2019-12-13 10:04 UTC (permalink / raw)
To: Joey Lee
Cc: Chun-Yi Lee, Josh Boyer, Serge E . Hallyn, Nayna Jain,
Mimi Zohar, James Morris, David Howells, linux-efi,
Linux Kernel Mailing List, linux-security-module
On Fri, 13 Dec 2019 at 10:21, Joey Lee <JLee@suse.com> wrote:
>
> Hi Ard,
>
> On Fri, Dec 13, 2019 at 09:10:12AM +0000, Ard Biesheuvel wrote:
> > On Fri, 13 Dec 2019 at 10:07, Lee, Chun-Yi <joeyli.kernel@gmail.com> wrote:
> > >
> > > When loading certificates list from EFI variables, the error
> > > message and efi status code always be emitted to dmesg. It looks
> > > ugly:
> > >
> > > [ 2.335031] Couldn't get size: 0x800000000000000e
> > > [ 2.335032] Couldn't get UEFI MokListRT
> > > [ 2.339985] Couldn't get size: 0x800000000000000e
> > > [ 2.339987] Couldn't get UEFI dbx list
> > >
> > > This cosmetic patch moved the messages to the error handling code
> > > path. And, it also shows the corresponding status string of status
> > > code.
> > >
> >
> > So what output do we get after applying this patch when those
> > variables don't exist?
> >
>
> A "UEFI:xxxx list was not found" message will be exposed in dmesg
> when kernel loglevel be set to debug. Otherwise there have no messages.
>
OK, that works for me.
I take it this will go via the linux-security tree along with 1/2?
Acked-by: Ard Biesheuvel <ardb@kernel.org>
> > > Signed-off-by: "Lee, Chun-Yi" <jlee@suse.com>
> > > ---
> > > security/integrity/platform_certs/load_uefi.c | 40 ++++++++++++++-------------
> > > 1 file changed, 21 insertions(+), 19 deletions(-)
> > >
> > > diff --git a/security/integrity/platform_certs/load_uefi.c b/security/integrity/platform_certs/load_uefi.c
> > > index 81b19c52832b..b6c60fb3fb6c 100644
> > > --- a/security/integrity/platform_certs/load_uefi.c
> > > +++ b/security/integrity/platform_certs/load_uefi.c
> > > @@ -1,4 +1,5 @@
> > > // SPDX-License-Identifier: GPL-2.0
> > > +#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
> > >
> > > #include <linux/kernel.h>
> > > #include <linux/sched.h>
> > > @@ -39,7 +40,7 @@ static __init bool uefi_check_ignore_db(void)
> > > * Get a certificate list blob from the named EFI variable.
> > > */
> > > static __init void *get_cert_list(efi_char16_t *name, efi_guid_t *guid,
> > > - unsigned long *size)
> > > + unsigned long *size, const char *source)
> > > {
> > > efi_status_t status;
> > > unsigned long lsize = 4;
> > > @@ -48,23 +49,30 @@ static __init void *get_cert_list(efi_char16_t *name, efi_guid_t *guid,
> > >
> > > status = efi.get_variable(name, guid, NULL, &lsize, &tmpdb);
> > > if (status != EFI_BUFFER_TOO_SMALL) {
> > > - pr_err("Couldn't get size: 0x%lx\n", status);
> > > - return NULL;
> > > + if (status == EFI_NOT_FOUND) {
> > > + pr_debug("%s list was not found\n", source);
> > > + return NULL;
> > > + }
> > > + goto err;
> > > }
> > >
> > > db = kmalloc(lsize, GFP_KERNEL);
> > > - if (!db)
> > > - return NULL;
> > > + if (!db) {
> > > + status = EFI_OUT_OF_RESOURCES;
> > > + goto err;
> > > + }
> > >
> > > status = efi.get_variable(name, guid, NULL, &lsize, db);
> > > if (status != EFI_SUCCESS) {
> > > kfree(db);
> > > - pr_err("Error reading db var: 0x%lx\n", status);
> > > - return NULL;
> > > + goto err;
> > > }
> > >
> > > *size = lsize;
> > > return db;
> > > +err:
> > > + pr_err("Couldn't get %s list: %s\n", source, efi_status_to_str(status));
> > > + return NULL;
> > > }
> > >
> > > /*
> > > @@ -153,10 +161,8 @@ static int __init load_uefi_certs(void)
> > > * an error if we can't get them.
> > > */
> > > if (!uefi_check_ignore_db()) {
> > > - db = get_cert_list(L"db", &secure_var, &dbsize);
> > > - if (!db) {
> > > - pr_err("MODSIGN: Couldn't get UEFI db list\n");
> > > - } else {
> > > + db = get_cert_list(L"db", &secure_var, &dbsize, "UEFI:db");
> > > + if (db) {
> > > rc = parse_efi_signature_list("UEFI:db",
> > > db, dbsize, get_handler_for_db);
> > > if (rc)
> > > @@ -166,10 +172,8 @@ static int __init load_uefi_certs(void)
> > > }
> > > }
> > >
> > > - mok = get_cert_list(L"MokListRT", &mok_var, &moksize);
> > > - if (!mok) {
> > > - pr_info("Couldn't get UEFI MokListRT\n");
> > > - } else {
> > > + mok = get_cert_list(L"MokListRT", &mok_var, &moksize, "UEFI:MokListRT");
> > > + if (mok) {
> > > rc = parse_efi_signature_list("UEFI:MokListRT",
> > > mok, moksize, get_handler_for_db);
> > > if (rc)
> > > @@ -177,10 +181,8 @@ static int __init load_uefi_certs(void)
> > > kfree(mok);
> > > }
> > >
> > > - dbx = get_cert_list(L"dbx", &secure_var, &dbxsize);
> > > - if (!dbx) {
> > > - pr_info("Couldn't get UEFI dbx list\n");
> > > - } else {
> > > + dbx = get_cert_list(L"dbx", &secure_var, &dbxsize, "UEFI:dbx");
> > > + if (dbx) {
> > > rc = parse_efi_signature_list("UEFI:dbx",
> > > dbx, dbxsize,
> > > get_handler_for_dbx);
> > > --
> > > 2.16.4
> > >
^ permalink raw reply [flat|nested] 9+ messages in thread
* Re: [PATCH 1/2 v2] efi: add a function to convert the status code to a string
2019-12-13 10:03 ` Ard Biesheuvel
@ 2019-12-13 10:33 ` Joey Lee
0 siblings, 0 replies; 9+ messages in thread
From: Joey Lee @ 2019-12-13 10:33 UTC (permalink / raw)
To: Ard Biesheuvel
Cc: Lee, Chun-Yi, James Morris, Serge E . Hallyn, David Howells,
Josh Boyer, Nayna Jain, Mimi Zohar, linux-efi,
linux-security-module, Linux Kernel Mailing List
On Fri, Dec 13, 2019 at 10:03:27AM +0000, Ard Biesheuvel wrote:
> On Fri, 13 Dec 2019 at 10:07, Lee, Chun-Yi <joeyli.kernel@gmail.com> wrote:
> >
> > This function can be used to convert EFI status code to a string
> > to improve the readability of log.
> >
> > v2:
> > Moved the convert function to efi.c
> >
>
> Please put the patch series revision log below the ---
OK! I will move to below the --- next time.
>
> > Signed-off-by: "Lee, Chun-Yi" <jlee@suse.com>
>
> Acked-by: Ard Biesheuvel <ardb@kernel.org>
>
Thanks for your review!
> > ---
v2:
Moved the convert function to efi.c
> > drivers/firmware/efi/efi.c | 32 ++++++++++++++++++++++++++++++++
> > include/linux/efi.h | 1 +
> > 2 files changed, 33 insertions(+)
Do you mean move the revision log to here like the above?
Thanks a lot!
Joey Lee
> >
> > diff --git a/drivers/firmware/efi/efi.c b/drivers/firmware/efi/efi.c
> > index e98bbf8e56d9..8bdc1c17eb5d 100644
> > --- a/drivers/firmware/efi/efi.c
> > +++ b/drivers/firmware/efi/efi.c
> > @@ -954,6 +954,38 @@ int efi_status_to_err(efi_status_t status)
> > return err;
> > }
> >
> > +#define EFI_STATUS_STR(_status) \
> > + EFI_##_status : return "EFI_" __stringify(_status)
> > +
> > +const char *efi_status_to_str(efi_status_t status)
> > +{
> > + switch (status) {
> > + case EFI_STATUS_STR(SUCCESS);
> > + case EFI_STATUS_STR(LOAD_ERROR);
> > + case EFI_STATUS_STR(INVALID_PARAMETER);
> > + case EFI_STATUS_STR(UNSUPPORTED);
> > + case EFI_STATUS_STR(BAD_BUFFER_SIZE);
> > + case EFI_STATUS_STR(BUFFER_TOO_SMALL);
> > + case EFI_STATUS_STR(NOT_READY);
> > + case EFI_STATUS_STR(DEVICE_ERROR);
> > + case EFI_STATUS_STR(WRITE_PROTECTED);
> > + case EFI_STATUS_STR(OUT_OF_RESOURCES);
> > + case EFI_STATUS_STR(NOT_FOUND);
> > + case EFI_STATUS_STR(ABORTED);
> > + case EFI_STATUS_STR(SECURITY_VIOLATION);
> > + }
> > + /*
> > + * There are two possibilities for this message to be exposed:
> > + * - Caller feeds a unknown status code from firmware.
> > + * - A new status code be defined in efi.h but we forgot to update
> > + * this function.
> > + */
> > + pr_warn("Unknown efi status: 0x%lx\n", status);
> > +
> > + return "Unknown efi status";
> > +}
> > +EXPORT_SYMBOL(efi_status_to_str);
> > +
> > static DEFINE_SPINLOCK(efi_mem_reserve_persistent_lock);
> > static struct linux_efi_memreserve *efi_memreserve_root __ro_after_init;
> >
> > diff --git a/include/linux/efi.h b/include/linux/efi.h
> > index d87acf62958e..2c6848d2b112 100644
> > --- a/include/linux/efi.h
> > +++ b/include/linux/efi.h
> > @@ -1228,6 +1228,7 @@ efi_capsule_pending(int *reset_type)
> > #endif
> >
> > extern int efi_status_to_err(efi_status_t status);
> > +extern const char *efi_status_to_str(efi_status_t status);
> >
> > /*
> > * Variable Attributes
> > --
> > 2.16.4
> >
^ permalink raw reply [flat|nested] 9+ messages in thread
* Re: [PATCH 2/2] efi: show error messages only when loading certificates is failed
2019-12-13 10:04 ` Ard Biesheuvel
@ 2019-12-13 10:35 ` Joey Lee
0 siblings, 0 replies; 9+ messages in thread
From: Joey Lee @ 2019-12-13 10:35 UTC (permalink / raw)
To: Ard Biesheuvel
Cc: Chun-Yi Lee, Josh Boyer, Serge E . Hallyn, Nayna Jain,
Mimi Zohar, James Morris, David Howells, linux-efi,
Linux Kernel Mailing List, linux-security-module
Hi Ard,
On Fri, Dec 13, 2019 at 10:04:14AM +0000, Ard Biesheuvel wrote:
> On Fri, 13 Dec 2019 at 10:21, Joey Lee <JLee@suse.com> wrote:
> >
> > Hi Ard,
> >
> > On Fri, Dec 13, 2019 at 09:10:12AM +0000, Ard Biesheuvel wrote:
> > > On Fri, 13 Dec 2019 at 10:07, Lee, Chun-Yi <joeyli.kernel@gmail.com> wrote:
> > > >
> > > > When loading certificates list from EFI variables, the error
> > > > message and efi status code always be emitted to dmesg. It looks
> > > > ugly:
> > > >
> > > > [ 2.335031] Couldn't get size: 0x800000000000000e
> > > > [ 2.335032] Couldn't get UEFI MokListRT
> > > > [ 2.339985] Couldn't get size: 0x800000000000000e
> > > > [ 2.339987] Couldn't get UEFI dbx list
> > > >
> > > > This cosmetic patch moved the messages to the error handling code
> > > > path. And, it also shows the corresponding status string of status
> > > > code.
> > > >
> > >
> > > So what output do we get after applying this patch when those
> > > variables don't exist?
> > >
> >
> > A "UEFI:xxxx list was not found" message will be exposed in dmesg
> > when kernel loglevel be set to debug. Otherwise there have no messages.
> >
>
> OK, that works for me.
>
> I take it this will go via the linux-security tree along with 1/2?
>
Yes, this patch must go with 1/2 patch.
> Acked-by: Ard Biesheuvel <ardb@kernel.org>
>
Thanks for your review!
Joey Lee
>
>
> > > > Signed-off-by: "Lee, Chun-Yi" <jlee@suse.com>
> > > > ---
> > > > security/integrity/platform_certs/load_uefi.c | 40 ++++++++++++++-------------
> > > > 1 file changed, 21 insertions(+), 19 deletions(-)
> > > >
> > > > diff --git a/security/integrity/platform_certs/load_uefi.c b/security/integrity/platform_certs/load_uefi.c
> > > > index 81b19c52832b..b6c60fb3fb6c 100644
> > > > --- a/security/integrity/platform_certs/load_uefi.c
> > > > +++ b/security/integrity/platform_certs/load_uefi.c
> > > > @@ -1,4 +1,5 @@
> > > > // SPDX-License-Identifier: GPL-2.0
> > > > +#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
> > > >
> > > > #include <linux/kernel.h>
> > > > #include <linux/sched.h>
> > > > @@ -39,7 +40,7 @@ static __init bool uefi_check_ignore_db(void)
> > > > * Get a certificate list blob from the named EFI variable.
> > > > */
> > > > static __init void *get_cert_list(efi_char16_t *name, efi_guid_t *guid,
> > > > - unsigned long *size)
> > > > + unsigned long *size, const char *source)
> > > > {
> > > > efi_status_t status;
> > > > unsigned long lsize = 4;
> > > > @@ -48,23 +49,30 @@ static __init void *get_cert_list(efi_char16_t *name, efi_guid_t *guid,
> > > >
> > > > status = efi.get_variable(name, guid, NULL, &lsize, &tmpdb);
> > > > if (status != EFI_BUFFER_TOO_SMALL) {
> > > > - pr_err("Couldn't get size: 0x%lx\n", status);
> > > > - return NULL;
> > > > + if (status == EFI_NOT_FOUND) {
> > > > + pr_debug("%s list was not found\n", source);
> > > > + return NULL;
> > > > + }
> > > > + goto err;
> > > > }
> > > >
> > > > db = kmalloc(lsize, GFP_KERNEL);
> > > > - if (!db)
> > > > - return NULL;
> > > > + if (!db) {
> > > > + status = EFI_OUT_OF_RESOURCES;
> > > > + goto err;
> > > > + }
> > > >
> > > > status = efi.get_variable(name, guid, NULL, &lsize, db);
> > > > if (status != EFI_SUCCESS) {
> > > > kfree(db);
> > > > - pr_err("Error reading db var: 0x%lx\n", status);
> > > > - return NULL;
> > > > + goto err;
> > > > }
> > > >
> > > > *size = lsize;
> > > > return db;
> > > > +err:
> > > > + pr_err("Couldn't get %s list: %s\n", source, efi_status_to_str(status));
> > > > + return NULL;
> > > > }
> > > >
> > > > /*
> > > > @@ -153,10 +161,8 @@ static int __init load_uefi_certs(void)
> > > > * an error if we can't get them.
> > > > */
> > > > if (!uefi_check_ignore_db()) {
> > > > - db = get_cert_list(L"db", &secure_var, &dbsize);
> > > > - if (!db) {
> > > > - pr_err("MODSIGN: Couldn't get UEFI db list\n");
> > > > - } else {
> > > > + db = get_cert_list(L"db", &secure_var, &dbsize, "UEFI:db");
> > > > + if (db) {
> > > > rc = parse_efi_signature_list("UEFI:db",
> > > > db, dbsize, get_handler_for_db);
> > > > if (rc)
> > > > @@ -166,10 +172,8 @@ static int __init load_uefi_certs(void)
> > > > }
> > > > }
> > > >
> > > > - mok = get_cert_list(L"MokListRT", &mok_var, &moksize);
> > > > - if (!mok) {
> > > > - pr_info("Couldn't get UEFI MokListRT\n");
> > > > - } else {
> > > > + mok = get_cert_list(L"MokListRT", &mok_var, &moksize, "UEFI:MokListRT");
> > > > + if (mok) {
> > > > rc = parse_efi_signature_list("UEFI:MokListRT",
> > > > mok, moksize, get_handler_for_db);
> > > > if (rc)
> > > > @@ -177,10 +181,8 @@ static int __init load_uefi_certs(void)
> > > > kfree(mok);
> > > > }
> > > >
> > > > - dbx = get_cert_list(L"dbx", &secure_var, &dbxsize);
> > > > - if (!dbx) {
> > > > - pr_info("Couldn't get UEFI dbx list\n");
> > > > - } else {
> > > > + dbx = get_cert_list(L"dbx", &secure_var, &dbxsize, "UEFI:dbx");
> > > > + if (dbx) {
> > > > rc = parse_efi_signature_list("UEFI:dbx",
> > > > dbx, dbxsize,
> > > > get_handler_for_dbx);
> > > > --
> > > > 2.16.4
> > > >
^ permalink raw reply [flat|nested] 9+ messages in thread
end of thread, other threads:[~2019-12-13 10:36 UTC | newest]
Thread overview: 9+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2019-12-13 9:06 [PATCH 0/2 v2] efi: cosmetic patches for the error messages when Lee, Chun-Yi
2019-12-13 9:06 ` [PATCH 1/2 v2] efi: add a function to convert the status code to a string Lee, Chun-Yi
2019-12-13 10:03 ` Ard Biesheuvel
2019-12-13 10:33 ` Joey Lee
2019-12-13 9:06 ` [PATCH 2/2] efi: show error messages only when loading certificates is failed Lee, Chun-Yi
2019-12-13 9:10 ` Ard Biesheuvel
2019-12-13 9:20 ` Joey Lee
2019-12-13 10:04 ` Ard Biesheuvel
2019-12-13 10:35 ` Joey Lee
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.