diff options
Diffstat (limited to 'projects/hsm/mgmt-masterkey.c')
| -rw-r--r-- | projects/hsm/mgmt-masterkey.c | 194 |
1 files changed, 194 insertions, 0 deletions
diff --git a/projects/hsm/mgmt-masterkey.c b/projects/hsm/mgmt-masterkey.c new file mode 100644 index 0000000..7cea62d --- /dev/null +++ b/projects/hsm/mgmt-masterkey.c @@ -0,0 +1,194 @@ +/* + * mgmt-masterkey.c + * ---------------- + * Masterkey CLI functions. + * + * Copyright (c) 2016, NORDUnet A/S All rights reserved. + * + * Redistribution and use in source and binary forms, with or without + * modification, are permitted provided that the following conditions are + * met: + * - Redistributions of source code must retain the above copyright notice, + * this list of conditions and the following disclaimer. + * + * - Redistributions in binary form must reproduce the above copyright + * notice, this list of conditions and the following disclaimer in the + * documentation and/or other materials provided with the distribution. + * + * - Neither the name of the NORDUnet nor the names of its contributors may + * be used to endorse or promote products derived from this software + * without specific prior written permission. + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS + * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED + * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A + * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT + * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED + * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR + * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF + * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING + * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS + * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + */ + +#include "stm-init.h" +#include "stm-uart.h" +#include "mgmt-cli.h" +#include "mgmt-masterkey.h" +#include "masterkey.h" + +#include <stdlib.h> + +#define KEK_LENGTH (256 / 8) + +static char * _status2str(masterkey_status_t status) +{ + switch (status) { + case HSM_MASTERKEY_SET: + return (char *) "Set"; + case HSM_MASTERKEY_NOT_SET: + return (char *) "Not set"; + default: + return (char *) "Unknown"; + } +} + +static int _parse_hex_groups(uint8_t *buf, size_t len, char *argv[], int argc) +{ + int i; + uint32_t *dst = (uint32_t *) buf; + uint32_t *end = (uint32_t *) buf + len - 1; + char *err_ptr = NULL; + + if (! argc) return 0; + + for (i = 0; i < argc; i++) { + if (dst >= end) return -1; + *dst++ = strtol(argv[i], &err_ptr, 16); + if (*err_ptr) return -2; + } + + return 1; +} + +static int cmd_masterkey_status(struct cli_def *cli, const char *command, char *argv[], int argc) +{ + masterkey_status_t status; + uint8_t buf[KEK_LENGTH] = {0}; + + cli_print(cli, "Status of master key:\n"); + + status = masterkey_volatile_read(NULL, 0); + cli_print(cli, " volatile: %s", _status2str(status)); + + status = masterkey_flash_read(NULL, 0); + cli_print(cli, " flash: %s", _status2str(status)); + + /* XXX Temporary gaping security hole while developing the master key functionality. + * REMOVE READ-OUT OF MASTER KEY. + */ + + status = masterkey_volatile_read(&buf[0], sizeof(buf)); + if (status != HSM_MASTERKEY_FAIL) { + cli_print(cli, "\nVolatile read-out:\n"); + uart_send_hexdump(STM_UART_MGMT, buf, 0, sizeof(buf) - 1); + cli_print(cli, "\n"); + } else { + cli_print(cli, "Failed reading from flash"); + } + + status = masterkey_flash_read(&buf[0], sizeof(buf)); + if (status != HSM_MASTERKEY_FAIL) { + cli_print(cli, "\nFlash read-out:\n"); + uart_send_hexdump(STM_UART_MGMT, buf, 0, sizeof(buf) - 1); + cli_print(cli, "\n"); + } else { + cli_print(cli, "Failed reading from flash"); + } + + return CLI_OK; +} + +static int cmd_masterkey_set(struct cli_def *cli, const char *command, char *argv[], int argc) +{ + uint8_t buf[KEK_LENGTH] = {0}; + int i; + + if ((i = _parse_hex_groups(&buf[0], sizeof(buf), argv, argc)) != 1) { + cli_print(cli, "Failed parsing master key (%i)", i); + return CLI_OK; + } + + cli_print(cli, "Parsed key:\n"); + uart_send_hexdump(STM_UART_MGMT, buf, 0, sizeof(buf) - 1); + cli_print(cli, "\n"); + + if (masterkey_volatile_write(buf, sizeof(buf)) == HSM_MASTERKEY_OK) { + cli_print(cli, "Master key set in volatile memory"); + } else { + cli_print(cli, "Failed writing key to volatile memory"); + } + return CLI_OK; +} + +static int cmd_masterkey_erase(struct cli_def *cli, const char *command, char *argv[], int argc) +{ + if (masterkey_volatile_erase(KEK_LENGTH) == HSM_MASTERKEY_OK) { + cli_print(cli, "Erased master key from volatile memory"); + } else { + cli_print(cli, "Failed erasing master key from volatile memory"); + } + return CLI_OK; +} + +static int cmd_masterkey_unsecure_set(struct cli_def *cli, const char *command, char *argv[], int argc) +{ + uint8_t buf[KEK_LENGTH] = {0}; + int i; + + if ((i = _parse_hex_groups(&buf[0], sizeof(buf), argv, argc)) != 1) { + cli_print(cli, "Failed parsing master key (%i)", i); + return CLI_OK; + } + + cli_print(cli, "Parsed key:\n"); + uart_send_hexdump(STM_UART_MGMT, buf, 0, sizeof(buf) - 1); + cli_print(cli, "\n"); + + if (masterkey_flash_write(buf, sizeof(buf)) == HSM_MASTERKEY_OK) { + cli_print(cli, "Master key set in unsecure flash memory"); + } else { + cli_print(cli, "Failed writing key to unsecure flash memory"); + } + return CLI_OK; +} + +static int cmd_masterkey_unsecure_erase(struct cli_def *cli, const char *command, char *argv[], int argc) +{ + if (masterkey_flash_erase(KEK_LENGTH) == HSM_MASTERKEY_OK) { + cli_print(cli, "Erased unsecure master key from flash"); + } else { + cli_print(cli, "Failed erasing unsecure master key from flash"); + } + return CLI_OK; +} + +void configure_cli_masterkey(struct cli_def *cli) +{ + /* masterkey */ + cli_command_root(masterkey); + /* masterkey status */ + cli_command_node(masterkey, status, "Show status of master key in RAM/flash"); + + /* masterkey set */ + cli_command_node(masterkey, set, "Set the master key in the volatile Master Key Memory"); + /* masterkey erase */ + cli_command_node(masterkey, erase, "Erase the master key from the volatile Master Key Memory"); + + cli_command_branch(masterkey, unsecure); + /* masterkey unsecure set */ + cli_command_node(masterkey_unsecure, set, "Set master key in unprotected flash memory (if unsure, DON'T)"); + /* masterkey unsecure erase */ + cli_command_node(masterkey_unsecure, erase, "Erase master key from unprotected flash memory"); +} |