/* * rpc_misc.c * ---------- * RPC interface to TRNG and PIN functions * * Authors: Rob Austein * Copyright (c) 2015, 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 #include "hal.h" #include "hal_internal.h" static hal_error_t get_version(uint32_t *version) { *version = RPC_VERSION; return HAL_OK; } static hal_error_t get_random(void *buffer, const size_t length) { assert(buffer != NULL && length > 0); return hal_get_random(NULL, buffer, length); } /* * PINs, salt, and iteration count live in the keystore. * * We also need a client table in conventional memory (here, probably) * to record login status. * * The USER and SO PINs correspond to PKCS #11. * * The WHEEL PIN is the one that's allowed to change the SO PIN. * * It's a bit unclear how we should manage changes to the WHEEL PIN. * Implementing a factory default would be easy enough (just * pre-compute and compile in a const hal_ks_pin_t), question is * whether doing so provides anything useful. Certainly adds no real * security, question is whether it would help prevent accidently * bricking the HSM right out of the shrink wrap. * * More interesting question is whether we should ever allow the WHEEL * PIN to be changed a second time without toasting the keystore. */ typedef struct { hal_client_handle_t handle; hal_user_t logged_in; } client_slot_t; #ifndef HAL_PIN_MINIMUM_ITERATIONS #define HAL_PIN_MINIMUM_ITERATIONS 10000 #endif #ifndef HAL_PIN_DEFAULT_ITERATIONS #define HAL_PIN_DEFAULT_ITERATIONS 20000 #endif static uint32_t hal_pin_default_iterations = HAL_PIN_DEFAULT_ITERATIONS; #ifndef HAL_STATIC_CLIENT_STATE_BLOCKS #define HAL_STATIC_CLIENT_STATE_BLOCKS 10 #endif #if HAL_STATIC_CLIENT_STATE_BLOCKS > 0 static client_slot_t client_handle[HAL_STATIC_CLIENT_STATE_BLOCKS]; #endif /* * Client handles are supplied by the application, we don't get to * pick them, we just store them and associate a login state with * them. HAL_USER_NONE indicates an empty slot in the table. */ static inline client_slot_t *alloc_slot(void) { #if HAL_STATIC_CLIENT_STATE_BLOCKS > 0 for (int i = 0; i < sizeof(client_handle)/sizeof(*client_handle); i++) if (client_handle[i].logged_in == HAL_USER_NONE) return &client_handle[i]; #endif return NULL; } static inline client_slot_t *find_handle(const hal_client_handle_t handle) { #if HAL_STATIC_CLIENT_STATE_BLOCKS > 0 for (int i = 0; i < sizeof(client_handle)/sizeof(*client_handle); i++) if (client_handle[i].logged_in != HAL_USER_NONE && client_handle[i].handle.handle == handle.handle) return &client_handle[i]; #endif return NULL; } static hal_error_t login(const hal_client_handle_t client, const hal_user_t user, const char * const pin, const size_t pin_len) { assert(pin != NULL && pin_len != 0); assert(user == HAL_USER_NORMAL || user == HAL_USER_SO || user == HAL_USER_WHEEL); const hal_ks_pin_t *p; hal_error_t err; if ((err = hal_ks_get_pin(user, &p)) != HAL_OK) return err; uint8_t buf[sizeof(p->pin)]; const uint32_t iterations = p->iterations == 0 ? hal_pin_default_iterations : p->iterations; if ((err = hal_pbkdf2(NULL, hal_hash_sha256, (const uint8_t *) pin, pin_len, p->salt, sizeof(p->salt), buf, sizeof(buf), iterations)) != HAL_OK) return err; unsigned diff = 0; for (int i = 0; i < sizeof(buf); i++) diff |= buf[i] ^ p->pin[i]; if (diff != 0) return HAL_ERROR_PIN_INCORRECT; client_slot_t *slot = find_handle(client); if (slot == NULL && (slot = alloc_slot()) == NULL) return HAL_ERROR_NO_CLIENT_SLOTS_AVAILABLE; slot->handle = client; slot->logged_in = user; return HAL_OK; } static hal_error_t is_logged_in(const hal_client_handle_t client, const hal_user_t user) { assert(user == HAL_USER_NORMAL || user == HAL_USER_SO || user == HAL_USER_WHEEL); client_slot_t *slot = find_handle(client); if (slot == NULL || slot->logged_in != user) return HAL_ERROR_FORBIDDEN; return HAL_OK; } static hal_error_t logout(const hal_client_handle_t client) { client_slot_t *slot = find_handle(client); if (slot != NULL) slot->logged_in = HAL_USER_NONE; return HAL_OK; } static hal_error_t logout_all(void) { #if HAL_STATIC_CLIENT_STATE_BLOCKS > 0 for (int i = 0; i < sizeof(client_handle)/sizeof(*client_handle); i++) client_handle[i].logged_in = HAL_USER_NONE; #endif return HAL_OK; } static hal_error_t set_pin(const hal_client_handle_t client, const hal_user_t user, const char * const newpin, const size_t newpin_len) { assert(newpin != NULL && newpin_len >= hal_rpc_min_pin_length && newpin_len <= hal_rpc_max_pin_length); if ((user != HAL_USER_NORMAL || is_logged_in(client, HAL_USER_SO) != HAL_OK) && is_logged_in(client, HAL_USER_WHEEL) != HAL_OK) return HAL_ERROR_FORBIDDEN; const hal_ks_pin_t *pp; hal_error_t err; if ((err = hal_ks_get_pin(user, &pp)) != HAL_OK) return err; hal_ks_pin_t p = *pp; p.iterations = hal_pin_default_iterations; if ((err = hal_get_random(NULL, p.salt, sizeof(p.salt))) != HAL_OK || (err = hal_pbkdf2(NULL, hal_hash_sha256, (const uint8_t *) newpin, newpin_len, p.salt, sizeof(p.salt), p.pin, sizeof(p.pin), p.iterations)) != HAL_OK || (err = hal_ks_set_pin(user, &p)) != HAL_OK) return err; return HAL_OK; } hal_error_t hal_set_pin_default_iterations(const hal_client_handle_t client, const uint32_t iterations) { if ((is_logged_in(client, HAL_USER_WHEEL) != HAL_OK) && (is_logged_in(client, HAL_USER_SO) != HAL_OK)) return HAL_ERROR_FORBIDDEN; /* should probably store this in flash somewhere */ hal_pin_default_iterations = (iterations == 0) ? HAL_PIN_DEFAULT_ITERATIONS : iterations; return HAL_OK; } const hal_rpc_misc_dispatch_t hal_rpc_local_misc_dispatch = { set_pin, login, logout, logout_all, is_logged_in, get_random, get_version }; /* * Local variables: * indent-tabs-mode: nil * End: */ 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 
/*
 * ks_attribute.c
 * --------------
 * Keystore attribute API.  This is internal within libhal.
 *
 * 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 <string.h>

#include "hal.h"
#include "hal_internal.h"

/*
 * Read and write attribute headers (type and length).  We could do
 * this with a structure type and casts, but that has portability
 * issues, and doing it this way just isn't expensive enough to worry about.
 */

const size_t hal_ks_attribute_header_size = 6;

static inline hal_error_t read_header(const uint8_t * const bytes, const size_t bytes_len,
                                      uint32_t *attribute_type, size_t *attribute_len)
{
  if (bytes == NULL || bytes_len < hal_ks_attribute_header_size ||
      attribute_type == NULL || attribute_len == NULL)
    return HAL_ERROR_BAD_ARGUMENTS;

  *attribute_type = ((bytes[0] << 24) |
                     (bytes[1] << 16) |
                     (bytes[2] <<  8) |
                     (bytes[3] <<  0));
  *attribute_len  = ((bytes[4] <<  8) |
                     (bytes[5] <<  0));

  return HAL_OK;
}

static inline hal_error_t write_header(uint8_t *bytes, const size_t bytes_len,
                                       const uint32_t attribute_type, const size_t attribute_len)
{
  if (bytes == NULL || bytes_len < hal_ks_attribute_header_size)
    return HAL_ERROR_BAD_ARGUMENTS;

  bytes[0] = (attribute_type >> 24) & 0xFF;
  bytes[1] = (attribute_type >> 16) & 0xFF;
  bytes[2] = (attribute_type >>  8) & 0xFF;
  bytes[3] = (attribute_type >>  0) & 0xFF;
  bytes[4] = (attribute_len  >>  8) & 0xFF;
  bytes[5] = (attribute_len  >>  0) & 0xFF;

  return HAL_OK;
}

hal_error_t hal_ks_attribute_scan(const uint8_t * const bytes, const size_t bytes_len,
                                  hal_pkey_attribute_t *attributes, const unsigned attributes_len,
                                  size_t *total_len)
{
  if (bytes == NULL)
    return HAL_ERROR_BAD_ARGUMENTS;

  const uint8_t *b = bytes;
  const uint8_t * const end = bytes + bytes_len;

  for (unsigned i = 0; i < attributes_len; i++) {
    uint32_t type;
    size_t length;
    hal_error_t err = read_header(b, end - b, &type, &length);
    if (err != HAL_OK)
      return err;
    if (b + hal_ks_attribute_header_size + length  > end)
      return HAL_ERROR_BAD_ATTRIBUTE_LENGTH;
    b += hal_ks_attribute_header_size;
    if (attributes != NULL) {
      attributes[i].type   = type;
      attributes[i].length = length;
      attributes[i].value  = b;
    }
    b += length;
  }

  if (total_len != NULL)
    *total_len = b - bytes;

  return HAL_OK;
}

hal_error_t hal_ks_attribute_delete(uint8_t *bytes, const size_t bytes_len,
                                    hal_pkey_attribute_t *attributes, unsigned *attributes_len,
                                    size_t *total_len,
                                    const uint32_t type)
{
  if (bytes == NULL || attributes == NULL || attributes_len == NULL || total_len == NULL)
    return HAL_ERROR_BAD_ARGUMENTS;

  /*
   * Search for attribute by type. Note that there can be only one
   * attribute of any given type.
   */

  unsigned i = 0;

  while (i < *attributes_len && attributes[i].type != type)
    i++;

  /* If not found, great, it's already deleted from the key. */

  if (i == *attributes_len)
    return HAL_OK;

  const size_t delete_length = hal_ks_attribute_header_size + attributes[i].length;
  const size_t delete_offset = (uint8_t*) attributes[i].value - hal_ks_attribute_header_size - bytes;

  if (delete_offset + delete_length > *total_len)
    return HAL_ERROR_IMPOSSIBLE;

  memmove(bytes + delete_offset,
          bytes + delete_offset + delete_length,
          *total_len - delete_length - delete_offset);

  return hal_ks_attribute_scan(bytes, bytes_len, attributes, --*attributes_len, total_len);
}

hal_error_t hal_ks_attribute_insert(uint8_t *bytes, const size_t bytes_len,
                                   hal_pkey_attribute_t *attributes, unsigned *attributes_len,
                                   size_t *total_len,
                                   const uint32_t type,
                                   const uint8_t * const value, const size_t value_len)

{
  if (bytes == NULL || attributes == NULL || attributes_len == NULL ||
      total_len == NULL || value == NULL)
    return HAL_ERROR_BAD_ARGUMENTS;

  /* Delete the existing attribute value (if present), then write the new value. */

  hal_error_t err
    = hal_ks_attribute_delete(bytes, bytes_len, attributes, attributes_len, total_len, type);

  if (err != HAL_OK)
    return err;

  if (*total_len + hal_ks_attribute_header_size + value_len > bytes_len)
    return HAL_ERROR_RESULT_TOO_LONG;

  uint8_t *b = bytes + *total_len;

  if ((err = write_header(b, bytes_len - *total_len, type, value_len)) != HAL_OK)
    return err;

  memcpy(b + hal_ks_attribute_header_size, value, value_len);

  return hal_ks_attribute_scan(bytes, bytes_len, attributes, ++*attributes_len, total_len);
}

/*
 * Local variables:
 * indent-tabs-mode: nil
 * End:
 */