aboutsummaryrefslogtreecommitdiff
path: root/aes_keywrap.c
diff options
context:
space:
mode:
Diffstat (limited to 'aes_keywrap.c')
0 files changed, 0 insertions, 0 deletions
' href='#n51'>51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 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 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304
/*
 * ks_volatile.c
 * -------------
 * Keystore implementation in normal volatile internal memory.
 *
 * NB: This is only suitable for cases where you do not want the keystore
 *     to survive library exit, eg, for storing PKCS #11 session keys.
 *
 * Authors: Rob Austein
 * Copyright (c) 2015-2017, 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 <assert.h>

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

#ifndef KS_VOLATILE_CACHE_SIZE
#define KS_VOLATILE_CACHE_SIZE 4
#endif

/*
 * Keystore database.
 */

typedef struct {
  hal_client_handle_t   client;
  hal_session_handle_t  session;
  hal_ks_block_t        block;
} ks_volatile_key_t;

typedef struct {
  hal_ks_t ks;              /* Must be first */
  ks_volatile_key_t *keys;
} ks_volatile_db_t;

/*
 * This is a bit silly, but it's safe enough, and it lets us avoid a
 * nasty mess of forward references.
 */

#define db      ((ks_volatile_db_t * const) hal_ks_volatile)

/*
 * Read a block.  CRC probably not necessary for RAM.
 */

static hal_error_t ks_volatile_read(hal_ks_t *ks, const unsigned blockno, hal_ks_block_t *block)
{
  if (ks != hal_ks_volatile || db->keys == NULL || block == NULL || blockno >= ks->size)
    return HAL_ERROR_IMPOSSIBLE;

  memcpy(block, &db->keys[blockno].block, sizeof(*block));

  return HAL_OK;
}

/*
 * Convert a live block into a tombstone.
 */

static hal_error_t ks_volatile_deprecate(hal_ks_t *ks, const unsigned blockno)
{
  if (ks != hal_ks_volatile || db->keys == NULL || blockno >= ks->size)
    return HAL_ERROR_IMPOSSIBLE;

  db->keys[blockno].block.header.block_status = HAL_KS_BLOCK_STATUS_TOMBSTONE;

  return HAL_OK;
}

/*
 * Zero (not erase) a flash block.
 */

static hal_error_t ks_volatile_zero(hal_ks_t *ks, const unsigned blockno)
{
  if (ks != hal_ks_volatile || db->keys == NULL || blockno >= ks->size)
    return HAL_ERROR_IMPOSSIBLE;

  memset(&db->keys[blockno].block, 0x00, sizeof(db->keys[blockno].block));
  db->keys[blockno].client.handle = HAL_HANDLE_NONE;
  db->keys[blockno].session.handle = HAL_HANDLE_NONE;

  return HAL_OK;
}

/*
 * Erase a flash block.
 */

static hal_error_t ks_volatile_erase(hal_ks_t *ks, const unsigned blockno)
{
  if (ks != hal_ks_volatile || db->keys == NULL || blockno >= ks->size)
    return HAL_ERROR_IMPOSSIBLE;

  memset(&db->keys[blockno].block, 0xFF, sizeof(db->keys[blockno].block));
  db->keys[blockno].client.handle = HAL_HANDLE_NONE;
  db->keys[blockno].session.handle = HAL_HANDLE_NONE;

  return HAL_OK;
}

/*
 * Write a flash block.  CRC probably not necessary for RAM.
 */

static hal_error_t ks_volatile_write(hal_ks_t *ks, const unsigned blockno, hal_ks_block_t *block)
{
  if (ks != hal_ks_volatile || db->keys == NULL || block == NULL || blockno >= ks->size)
    return HAL_ERROR_IMPOSSIBLE;

  memcpy(&db->keys[blockno].block, block, sizeof(*block));

  return HAL_OK;
}

/*
 * Set key ownership.
 */

static hal_error_t ks_volatile_set_owner(hal_ks_t *ks,
                                         const unsigned blockno,
                                         const hal_client_handle_t client,
                                         const hal_session_handle_t session)
{
  if (ks != hal_ks_volatile || db->keys == NULL || blockno >= ks->size)
    return HAL_ERROR_IMPOSSIBLE;

  db->keys[blockno].client = client;
  db->keys[blockno].session = session;

  return HAL_OK;
}

/*
 * Test key ownership.
 *
 * One might expect this to be based on whether the session matches,
 * and indeed it would be in a sane world, but in the world of PKCS
 * #11, keys belong to sessions, are visible to other sessions, and
 * may even be modifiable by other sessions, but softly and silently
 * vanish away when the original creating session is destroyed.
 *
 * In our terms, this means that visibility of session objects is
 * determined only by the client handle, so taking the session handle
 * as an argument here isn't really necessary, but we've flipflopped
 * on that enough times that at least for now I'd prefer to leave the
 * session handle here and not have to revise all the RPC calls again.
 * Remove it at some later date and redo the RPC calls if we manage to
 * avoid revising this yet again.
 */

static hal_error_t ks_volatile_test_owner(hal_ks_t *ks,
                                          const unsigned blockno,
                                          const hal_client_handle_t client,
                                          const hal_session_handle_t session)
{
  if (ks != hal_ks_volatile || db->keys == NULL || blockno >= ks->size)
    return HAL_ERROR_IMPOSSIBLE;

  if (db->keys[blockno].client.handle == HAL_HANDLE_NONE ||
      db->keys[blockno].client.handle == client.handle)
    return HAL_OK;

  if (hal_rpc_is_logged_in(client, HAL_USER_WHEEL) == HAL_OK)
    return HAL_OK;

  return HAL_ERROR_KEY_NOT_FOUND;
}

/*
 * Copy key ownership.
 */

static hal_error_t ks_volatile_copy_owner(hal_ks_t *ks,
                                          const unsigned source,
                                          const unsigned target)
{
  if (ks != hal_ks_volatile || db->keys == NULL || source >= ks->size || target >= ks->size)
    return HAL_ERROR_IMPOSSIBLE;

  db->keys[target].client  = db->keys[source].client;
  db->keys[target].session = db->keys[source].session;
  return HAL_OK;
}

/*
 * Zero any blocks owned by a client that we're logging out.
 */

static hal_error_t ks_volatile_logout(hal_ks_t *ks,
                                      hal_client_handle_t client)
{
  if (ks != hal_ks_volatile || client.handle == HAL_HANDLE_NONE)
    return HAL_ERROR_IMPOSSIBLE;

  for (unsigned i = 0; i < ks->used; i++) {
    unsigned b = ks->index[i];
    hal_error_t err;
    int hint = i;

    if (db->keys[b].client.handle != client.handle)
      continue;

    if ((err = hal_ks_index_delete(ks, &ks->names[b], NULL, &hint)) != HAL_OK ||
        (err = hal_ks_block_zero(ks, b))                            != HAL_OK)
      return err;

    i--;
  }

  return HAL_OK;
}

/*
 * Initialize keystore.
 */

static hal_error_t ks_volatile_init(hal_ks_t *ks, const int alloc)
{
  if (ks != hal_ks_volatile)
    return HAL_ERROR_IMPOSSIBLE;

  void *mem = NULL;
  hal_error_t err;

  if (alloc &&
      (err = hal_ks_alloc_common(ks, HAL_STATIC_KS_VOLATILE_SLOTS, KS_VOLATILE_CACHE_SIZE,
                                 &mem, sizeof(*db->keys) * HAL_STATIC_KS_VOLATILE_SLOTS)) != HAL_OK)
    return err;

  if (alloc)
    db->keys = mem;

  if (db->keys == NULL)
    return HAL_ERROR_IMPOSSIBLE;

  for (unsigned b = 0; b < db->ks.size; b++)
    if ((err = hal_ks_block_erase(ks, b)) != HAL_OK)
      return err;

  if ((err = hal_ks_init_common(ks)) != HAL_OK)
    return err;

  return HAL_OK;
}

/*
 * Dispatch vector and keystore definition, now that we've defined all
 * the driver functions.
 */

static const hal_ks_driver_t ks_volatile_driver = {
  .init                 = ks_volatile_init,
  .read                 = ks_volatile_read,
  .write                = ks_volatile_write,
  .deprecate            = ks_volatile_deprecate,
  .zero                 = ks_volatile_zero,
  .erase                = ks_volatile_erase,
  .erase_maybe          = ks_volatile_erase, /* sic */
  .set_owner            = ks_volatile_set_owner,
  .test_owner           = ks_volatile_test_owner,
  .copy_owner           = ks_volatile_copy_owner,
  .logout               = ks_volatile_logout
};

static ks_volatile_db_t _db = { .ks.driver = &ks_volatile_driver };

hal_ks_t * const hal_ks_volatile = &_db.ks;

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