A key protector encapsulates functionality to retrieve an unlocking key for a fully-encrypted disk from a specific source. A key protector module registers itself with the key protectors framework when it is loaded and unregisters when unloaded. Additionally, a key protector may accept parameters that describe how it should operate. The key protectors framework, besides offering registration and unregistration functions, also offers a one-stop routine for finding and invoking a key protector by name. If a key protector with the specified name exists and if an unlocking key is successfully retrieved by it, the function returns to the caller the retrieved key and its length. Cc: Vladimir Serbinenko <phcoder@gmail.com> Signed-off-by: Hernan Gatta <hegatta@linux.microsoft.com> Signed-off-by: Gary Lin <glin@suse.com> Reviewed-by: Stefan Berger <stefanb@linux.ibm.com> Reviewed-by: Daniel Kiper <daniel.kiper@oracle.com> Tested-by: Stefan Berger <stefanb@linux.ibm.com>
74 lines
2.4 KiB
C
74 lines
2.4 KiB
C
/*
|
|
* GRUB -- GRand Unified Bootloader
|
|
* Copyright (C) 2022 Microsoft Corporation
|
|
* Copyright (C) 2024 Free Software Foundation, Inc.
|
|
*
|
|
* GRUB is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* GRUB is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with GRUB. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
#include <grub/dl.h>
|
|
#include <grub/list.h>
|
|
#include <grub/misc.h>
|
|
#include <grub/mm.h>
|
|
#include <grub/key_protector.h>
|
|
|
|
GRUB_MOD_LICENSE ("GPLv3+");
|
|
|
|
struct grub_key_protector *grub_key_protectors = NULL;
|
|
|
|
grub_err_t
|
|
grub_key_protector_register (struct grub_key_protector *protector)
|
|
{
|
|
if (protector == NULL || protector->name == NULL || protector->name[0] == '\0')
|
|
return grub_error (GRUB_ERR_BAD_ARGUMENT, "Invalid key protector for registration");
|
|
|
|
if (grub_key_protectors != NULL &&
|
|
grub_named_list_find (GRUB_AS_NAMED_LIST (grub_key_protectors), protector->name) != NULL)
|
|
return grub_error (GRUB_ERR_BAD_ARGUMENT, "Key protector '%s' already registered", protector->name);
|
|
|
|
grub_list_push (GRUB_AS_LIST_P (&grub_key_protectors), GRUB_AS_LIST (protector));
|
|
|
|
return GRUB_ERR_NONE;
|
|
}
|
|
|
|
grub_err_t
|
|
grub_key_protector_unregister (struct grub_key_protector *protector)
|
|
{
|
|
if (protector == NULL)
|
|
return grub_error (GRUB_ERR_BAD_ARGUMENT, "Invalid key protector for unregistration");
|
|
|
|
grub_list_remove (GRUB_AS_LIST (protector));
|
|
|
|
return GRUB_ERR_NONE;
|
|
}
|
|
|
|
grub_err_t
|
|
grub_key_protector_recover_key (const char *protector, grub_uint8_t **key,
|
|
grub_size_t *key_size)
|
|
{
|
|
struct grub_key_protector *kp = NULL;
|
|
|
|
if (grub_key_protectors == NULL)
|
|
return grub_error (GRUB_ERR_OUT_OF_RANGE, "No key protector registered");
|
|
|
|
if (protector == NULL || protector[0] == '\0')
|
|
return grub_error (GRUB_ERR_BAD_ARGUMENT, "Invalid key protector");
|
|
|
|
kp = grub_named_list_find (GRUB_AS_NAMED_LIST (grub_key_protectors), protector);
|
|
if (kp == NULL)
|
|
return grub_error (GRUB_ERR_OUT_OF_RANGE, "Key protector '%s' not found", protector);
|
|
|
|
return kp->recover_key (key, key_size);
|
|
}
|