path: root/projects/hsm/mgmt-misc.c

/*
 * mgmt-misc.c
 * -----------
 * Miscellaneous CLI functions.
 *
 * Copyright (c) 2016-2018, NORDUnet A/S All rights reserved.
 * Copyright: 2020, The Commons Conservancy Cryptech Project
 * SPDX-License-Identifier: BSD-3-Clause
 *
 * 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 copyright holder 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.
 */

#define HAL_OK CMSIS_HAL_OK
#include "stm-init.h"
#include "stm-uart.h"
#include "mgmt-cli.h"
#include "mgmt-misc.h"
#undef HAL_OK

#define HAL_OK LIBHAL_OK
#include "hal.h"
#include "hal_internal.h"
#undef HAL_OK

#include <string.h>


int cli_receive_data(struct cli_def *cli, uint8_t *buf, size_t len, cli_data_callback data_callback)
{
    hal_crc32_t crc = 0, my_crc = hal_crc32_init();
    uint32_t filesize = 0, counter = 0;
    size_t n = len;

    if (! control_mgmt_uart_dma_rx(DMA_RX_STOP)) {
	cli_print(cli, "Failed stopping DMA");
	goto okay;
    }

    cli_print(cli, "OK, write size (4 bytes), data in %li byte chunks, CRC-32 (4 bytes)", (uint32_t) n);

    if (uart_receive_bytes((void *) &filesize, sizeof(filesize), 2000) != CMSIS_HAL_OK) {
	cli_print(cli, "Receive timed out");
	goto fail;
    }

    cli_print(cli, "Send %li bytes of data", filesize);

    while (filesize) {
	/* By initializing buf to the same value that erased flash has (0xff), we don't
	 * have to try and be smart when writing the last page of data to a flash memory.
	 */
	memset(buf, 0xff, len);

	if (filesize < n) n = filesize;

	if (uart_receive_bytes((void *) buf, n, 2000) != CMSIS_HAL_OK) {
	    cli_print(cli, "Receive timed out");
	    goto fail;
	}
	filesize -= n;
	my_crc = hal_crc32_update(my_crc, buf, n);

	/* After reception of a chunk but before ACKing we have "all" the time in the world to
	 * calculate CRC and invoke the data_callback.
	 */
	if (data_callback != NULL && data_callback(buf, n) != CMSIS_HAL_OK) {
	    cli_print(cli, "Data processing failed");
	    goto okay;
	}

	counter++;
	uart_send_bytes((void *) &counter, 4);
    }

    my_crc = hal_crc32_finalize(my_crc);
    cli_print(cli, "Send CRC-32");
    uart_receive_bytes((void *) &crc, sizeof(crc), 2000);
    cli_print(cli, "CRC-32 0x%x, calculated CRC 0x%x", (unsigned int) crc, (unsigned int) my_crc);
    if (crc == my_crc) {
	cli_print(cli, "CRC checksum MATCHED");
    } else {
	cli_print(cli, "CRC checksum did NOT match");
    }

 okay:
    control_mgmt_uart_dma_rx(DMA_RX_START);
    return CLI_OK;

 fail:
    control_mgmt_uart_dma_rx(DMA_RX_START);
    return CLI_ERROR;
}

#ifdef DO_PROFILING
static int cmd_profile_start(struct cli_def *cli, const char *command, char *argv[], int argc)
{
    cli = cli;
    command = command;
    argv = argv;
    argc = argc;

    extern uint32_t CRYPTECH_FIRMWARE_START;
    extern char __etext; /* end of text/code symbol, defined by linker */
    extern void monstartup (size_t lowpc, size_t highpc);
    monstartup((size_t)&CRYPTECH_FIRMWARE_START, (size_t)&__etext);
    return CLI_OK;
}

static int cmd_profile_stop(struct cli_def *cli, const char *command, char *argv[], int argc)
{
    cli = cli;
    command = command;
    argv = argv;
    argc = argc;

    extern void _mcleanup(void);
    _mcleanup();
    return CLI_OK;
}

#endif

static int cmd_reboot(struct cli_def *cli, const char *command, char *argv[], int argc)
{
    command = command;
    argv = argv;
    argc = argc;

    cli_print(cli, "\n\n\nRebooting\n\n\n");
    HAL_NVIC_SystemReset();

    /*NOTREACHED*/
    return CLI_OK;
}

static int cmd_rsa_blinding(struct cli_def *cli, const char *command, char *argv[], int argc)
{
    if (argc != 1) {
	cli_print(cli, "Wrong number of arguments (%i).", argc);
	cli_print(cli, "Syntax: %s <on|off|clear>", command);
	return CLI_ERROR;
    }

    if (strcmp(argv[0], "on") == 0)
	hal_rsa_set_blinding(1);
    else if (strcmp(argv[0], "off") == 0)
	hal_rsa_set_blinding(0);
    else if (strcmp(argv[0], "clear") == 0)
	hal_rsa_clear_blinding_cache();
    else {
	cli_print(cli, "Argument must be 'on', 'off', or 'clear' - not '%s'", argv[0]);
	return CLI_ERROR;
    }

    return CLI_OK;
}

static int cmd_rsa_crt(struct cli_def *cli, const char *command, char *argv[], int argc)
{
    int onoff;

    if (argc != 1) {
	cli_print(cli, "Wrong number of arguments (%i).", argc);
	cli_print(cli, "Syntax: %s <on|off>", command);
	return CLI_ERROR;
    }

    if (strcmp(argv[0], "on") == 0)
	onoff = 1;
    else if (strcmp(argv[0], "off") == 0)
	onoff = 0;
    else {
	cli_print(cli, "Argument must be 'on' or 'off' - not '%s'", argv[0]);
	return CLI_ERROR;
    }

    hal_rsa_set_crt(onoff);

    return CLI_OK;
}

static int cmd_rsa_modexpng(struct cli_def *cli, const char *command, char *argv[], int argc)
{
    int onoff;

    if (argc != 1) {
	cli_print(cli, "Wrong number of arguments (%i).", argc);
	cli_print(cli, "Syntax: %s <on|off>", command);
	return CLI_ERROR;
    }

    if (strcmp(argv[0], "on") == 0)
	onoff = 1;
    else if (strcmp(argv[0], "off") == 0)
	onoff = 0;
    else {
	cli_print(cli, "Argument must be 'on' or 'off' - not '%s'", argv[0]);
	return CLI_ERROR;
    }

    hal_error_t err;
    if ((err = hal_modexp_use_modexpng(onoff)) == LIBHAL_OK)
        return CLI_OK;

    cli_print(cli, hal_error_string(err));
    return CLI_ERROR;
}

void configure_cli_misc(struct cli_def *cli)
{
#ifdef DO_PROFILING
    struct cli_command *c_profile = cli_register_command(cli, NULL, "profile", NULL, 0, 0, NULL);

    /* profile start */
    cli_register_command(cli, c_profile, "start", cmd_profile_start, 0, 0, "Start collecting profiling data");

    /* profile stop */
    cli_register_command(cli, c_profile, "stop", cmd_profile_stop, 0, 0, "Stop collecting profiling data");
#endif

    struct cli_command *c_rsa = cli_register_command(cli, NULL, "rsa", NULL, 0, 0, NULL);

    /* rsa blinding */
    cli_register_command(cli, c_rsa, "blinding", cmd_rsa_blinding, 0, 0, "Set use of RSA blinding");

    /* rsa crt */
    cli_register_command(cli, c_rsa, "crt", cmd_rsa_crt, 0, 0, "Set use of RSA CRT");

    /* rsa modexpng */
    cli_register_command(cli, c_rsa, "modexpng", cmd_rsa_modexpng, 0, 0, "Set use of ModExpNG");

    /* reboot */
    cli_register_command(cli, NULL, "reboot", cmd_reboot, 0, 0, "Reboot the STM32");
}