/*
* hal_rpc.c
* ---------
* Remote procedure call public API implementation.
*
* 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 "rpc_internal.h"
#ifndef HAL_RPC_IS_CLIENT
#warning HAL_RPC_IS_CLIENT not set, assuming we're building for the HSM
#define HAL_RPC_IS_CLIENT 0
#endif
/*
* Maybe we'll let the client configure this at runtime, later. For
* now, wire in the obvious defaults: hashing is done locally,
* everything else is done via RPC. For the server everything is
* always done locally.
*/
#if HAL_RPC_IS_CLIENT
static const hal_rpc_misc_dispatch_t * const misc_dispatch = &hal_rpc_remote_misc_dispatch;
static const hal_rpc_hash_dispatch_t * const hash_dispatch = &hal_rpc_remote_hash_dispatch;
static const hal_rpc_pkey_dispatch_t * const pkey_dispatch = &hal_rpc_mixed_pkey_dispatch;
#else
static const hal_rpc_misc_dispatch_t * const misc_dispatch = &hal_rpc_local_misc_dispatch;
static const hal_rpc_hash_dispatch_t * const hash_dispatch = &hal_rpc_local_hash_dispatch;
static const hal_rpc_pkey_dispatch_t * const pkey_dispatch = &hal_rpc_local_pkey_dispatch;
#endif
const hal_rpc_hash_handle_t hal_rpc_hash_handle_none = {0};
static inline int check_pkey_type(const hal_rpc_pkey_key_type_t type)
{
switch (type) {
case HAL_RPC_PKEY_RSA_PRIVATE:
case HAL_RPC_PKEY_RSA_PUBLIC:
case HAL_RPC_PKEY_ECDSA_PRIVATE:
case HAL_RPC_PKEY_ECDSA_PUBLIC:
return 1;
default:
return 0;
}
}
static inline int check_pkey_flags(const hal_rpc_pkey_flags_t flags)
{
return (flags &~ (HAL_RPC_PKEY_FLAG_USAGE_DIGITALSIGNATURE |
HAL_RPC_PKEY_FLAG_USAGE_KEYENCIPHERMENT |
HAL_RPC_PKEY_FLAG_USAGE_DATAENCIPHERMENT)) == 0;
}
static inline int check_pkey_type_curve_flags(const hal_rpc_pkey_key_type_t type,
const hal_rpc_pkey_curve_t curve,
const hal_rpc_pkey_flags_t flags)
{
if (!check_pkey_flags(flags))
return 0;
switch (type) {
case HAL_RPC_PKEY_RSA_PRIVATE:
case HAL_RPC_PKEY_RSA_PUBLIC:
return curve == HAL_RPC_PKEY_CURVE_NONE;
case HAL_RPC_PKEY_ECDSA_PRIVATE:
case HAL_RPC_PKEY_ECDSA_PUBLIC:
switch (curve) {
case HAL_RPC_PKEY_CURVE_ECDSA_P256:
case HAL_RPC_PKEY_CURVE_ECDSA_P384:
case HAL_RPC_PKEY_CURVE_ECDSA_P521:
return 1;
default:
return 0;
}
default:
return 0;
}
}
hal_error_t hal_rpc_get_random(void *buffer, const size_t length)
{
if (buffer == NULL)
return HAL_ERROR_BAD_ARGUMENTS;
if (length == 0)
return HAL_OK;
return misc_dispatch->get_random(buffer, length);
}
#warning Perhaps we should be enforcing a minimum PIN length here
hal_error_t hal_rpc_set_pin(const hal_rpc_user_t which,
const char * const newpin, const size_t newpin_len)
{
if (newpin == NULL || newpin_len == 0 || (which != HAL_RPC_USER_NORMAL && which != HAL_RPC_USER_SO))
return HAL_ERROR_BAD_ARGUMENTS;
return misc_dispatch->set_pin(which, newpin, newpin_len);
}
hal_error_t hal_rpc_login(const hal_rpc_client_handle_t client,
const hal_rpc_user_t user,
const char * const pin, const size_t pin_len)
{
if (pin == NULL || pin_len == 0 || (user != HAL_RPC_USER_NORMAL && user != HAL_RPC_USER_SO))
return HAL_ERROR_BAD_ARGUMENTS;
return misc_dispatch->login(client, user, pin, pin_len);
}
hal_error_t hal_rpc_logout(const hal_rpc_client_handle_t client)
{
return misc_dispatch->logout(client);
}
hal_error_t hal_rpc_hash_get_digest_length(const hal_digest_algorithm_t alg, size_t *length)
{
if (length == NULL)
return HAL_ERROR_BAD_ARGUMENTS;
return hash_dispatch->get_digest_length(alg, length);
}
hal_error_t hal_rpc_hash_get_digest_algorithm_id(const hal_digest_algorithm_t alg,
uint8_t *id, size_t *len, const size_t len_max)
{
return hash_dispatch->get_digest_algorithm_id(alg, id, len, len_max);
}
hal_error_t hal_rpc_hash_get_algorithm(const hal_rpc_hash_handle_t hash, hal_digest_algorithm_t *alg)
{
if (hash.handle == hal_rpc_hash_handle_none.handle || alg == NULL)
return HAL_ERROR_BAD_ARGUMENTS;
return hash_dispatch->get_algorithm(hash, alg);
}
hal_error_t hal_rpc_hash_initialize(const hal_rpc_client_handle_t client,
const hal_rpc_session_handle_t session,
hal_rpc_hash_handle_t *hash,
const hal_digest_algorithm_t alg,
const uint8_t * const key, const size_t key_len)
{
if (hash == NULL)
return HAL_ERROR_BAD_ARGUMENTS;
return hash_dispatch->initialize(client, session, hash, alg, key, key_len);
}
hal_error_t hal_rpc_hash_update(const hal_rpc_hash_handle_t hash,
const uint8_t * data, const size_t length)
{
if (hash.handle == hal_rpc_hash_handle_none.handle || data == NULL)
return HAL_ERROR_BAD_ARGUMENTS;
if (length == 0)
return HAL_OK;
return hash_dispatch->update(hash, data, length);
}
hal_error_t hal_rpc_hash_finalize(const hal_rpc_hash_handle_t hash,
uint8_t *digest, const size_t length)
{
if (hash.handle == hal_rpc_hash_handle_none.handle || digest == NULL || length == 0)
return HAL_ERROR_BAD_ARGUMENTS;
return hash_dispatch->finalize(hash, digest, length);
}
hal_error_t hal_rpc_pkey_load(const hal_rpc_client_handle_t client,
const hal_rpc_session_handle_t session,
hal_rpc_pkey_handle_t *pkey,
const hal_rpc_pkey_key_type_t type,
const hal_rpc_pkey_curve_t curve,
const uint8_t * const name, const size_t name_len,
const uint8_t * const der, const size_t der_len,
const hal_rpc_pkey_flags_t flags)
{
if (pkey == NULL ||
name == NULL || name_len == 0 ||
der == NULL || der_len == 0 ||
!check_pkey_type_curve_flags(type, curve, flags))
return HAL_ERROR_BAD_ARGUMENTS;
return pkey_dispatch->load(client, session, pkey, type, curve, name, name_len, der, der_len, flags);
}
hal_error_t hal_rpc_pkey_find(const hal_rpc_client_handle_t client,
const hal_rpc_session_handle_t session,
hal_rpc_pkey_handle_t *pkey,
const hal_rpc_pkey_key_type_t type,
const uint8_t * const name, const size_t name_len)
{
if (pkey == NULL || name == NULL || name_len == 0 || !check_pkey_type(type))
return HAL_ERROR_BAD_ARGUMENTS;
return pkey_dispatch->find(client, session, pkey, type, name, name_len);
}
hal_error_t hal_rpc_pkey_generate_rsa(const hal_rpc_client_handle_t client,
const hal_rpc_session_handle_t session,
hal_rpc_pkey_handle_t *pkey,
const uint8_t * const name, const size_t name_len,
const unsigned key_len,
const uint8_t * const exp, const size_t exp_len,
const hal_rpc_pkey_flags_t flags)
{
if (pkey == NULL || name == NULL || name_len == 0 || key_len == 0 ||
exp == NULL || exp_len == 0 || !check_pkey_flags(flags))
return HAL_ERROR_BAD_ARGUMENTS;
return pkey_dispatch->generate_rsa(client, session, pkey, name, name_len, key_len, exp, exp_len, flags);
}
hal_error_t hal_rpc_pkey_generate_ec(const hal_rpc_client_handle_t client,
const hal_rpc_session_handle_t session,
hal_rpc_pkey_handle_t *pkey,
const uint8_t * const name, const size_t name_len,
const hal_rpc_pkey_curve_t curve,
const hal_rpc_pkey_flags_t flags)
{
if (pkey == NULL || name == NULL || name_len == 0 ||
!check_pkey_type_curve_flags(HAL_RPC_PKEY_ECDSA_PRIVATE, curve, flags))
return HAL_ERROR_BAD_ARGUMENTS;
return pkey_dispatch->generate_ec(client, session, pkey, name, name_len, curve, flags);
}
hal_error_t hal_rpc_pkey_delete(const hal_rpc_pkey_handle_t pkey)
{
return pkey_dispatch->delete(pkey);
}
hal_error_t hal_rpc_pkey_get_key_type(const hal_rpc_pkey_handle_t pkey,
hal_rpc_pkey_key_type_t *type)
{
if (type == NULL)
return HAL_ERROR_BAD_ARGUMENTS;
return pkey_dispatch->get_key_type(pkey, type);
}
hal_error_t hal_rpc_pkey_get_key_flags(const hal_rpc_pkey_handle_t pkey,
hal_rpc_pkey_flags_t *flags)
{
if (flags == NULL)
return HAL_ERROR_BAD_ARGUMENTS;
return pkey_dispatch->get_key_flags(pkey, flags);
}
size_t hal_rpc_pkey_get_public_key_len(const hal_rpc_pkey_handle_t pkey)
{
return pkey_dispatch->get_public_key_len(pkey);
}
hal_error_t hal_rpc_pkey_get_public_key(const hal_rpc_pkey_handle_t pkey,
uint8_t *der, size_t *der_len, const size_t der_len_max)
{
if (der == NULL || der_len == NULL || der_len_max == 0)
return HAL_ERROR_BAD_ARGUMENTS;
return pkey_dispatch->get_public_key(pkey, der, der_len, der_len_max);
}
hal_error_t hal_rpc_pkey_sign(const hal_rpc_session_handle_t session,
const hal_rpc_pkey_handle_t pkey,
const hal_rpc_hash_handle_t hash,
const uint8_t * const input, const size_t input_len,
uint8_t * output, const size_t output_len)
{
if (output == NULL || output_len == 0 ||
(hash.handle == hal_rpc_hash_handle_none.handle) == (input == NULL || input_len == 0))
return HAL_ERROR_BAD_ARGUMENTS;
return pkey_dispatch->sign(session, pkey, hash, input, input_len, output, output_len);
}
hal_error_t hal_rpc_pkey_verify(const hal_rpc_session_handle_t session,
const hal_rpc_pkey_handle_t pkey,
const hal_rpc_hash_handle_t hash,
const uint8_t * const input, const size_t input_len,
uint8_t * output, const size_t output_len)
{
if (output == NULL || output_len == 0 ||
(hash.handle == hal_rpc_hash_handle_none.handle) == (input == NULL || input_len == 0))
return HAL_ERROR_BAD_ARGUMENTS;
return pkey_dispatch->verify(session, pkey, hash, input, input_len, output, output_len);
}
hal_error_t hal_rpc_pkey_list(hal_rpc_pkey_key_info_t *result,
unsigned *result_len,
const unsigned result_max)
{
if (result == NULL || result_len == NULL || result_max == 0)
return HAL_ERROR_BAD_ARGUMENTS;
return pkey_dispatch->list(result, result_len, result_max);
}
/*
* Local variables:
* indent-tabs-mode: nil
* End:
*/
