Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ta: pkcs11: Add implementation for random number generation #4383

Merged
merged 2 commits into from
Feb 15, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions ta/pkcs11/include/pkcs11_ta.h
Original file line number Diff line number Diff line change
Expand Up @@ -544,6 +544,27 @@ enum pkcs11_ta_cmd {
*/
PKCS11_CMD_COPY_OBJECT = 40,

/*
* PKCS11_CMD_SEED_RANDOM - Seed random data generator
*
* [in] memref[0] = 32bit session handle
* [out] memref[0] = 32bit return code, enum pkcs11_rc
* [in] memref[1] = byte array: seed material to feed into the RNG
*
* This command relates to the PKCS#11 API function C_SeedRandom().
*/
PKCS11_CMD_SEED_RANDOM = 41,

/*
* PKCS11_CMD_GENERATE_RANDOM - Generate random data
*
* [in] memref[0] = 32bit session handle
* [out] memref[0] = 32bit return code, enum pkcs11_rc
* [out] memref[2] = byte array: generated random
*
* This command relates to the PKCS#11 API function C_GenerateRandom().
*/
PKCS11_CMD_GENERATE_RANDOM = 42,
};

/*
Expand Down
6 changes: 6 additions & 0 deletions ta/pkcs11/src/entry.c
Original file line number Diff line number Diff line change
Expand Up @@ -309,6 +309,12 @@ TEE_Result TA_InvokeCommandEntryPoint(void *tee_session, uint32_t cmd,
case PKCS11_CMD_COPY_OBJECT:
rc = entry_copy_object(client, ptypes, params);
break;
case PKCS11_CMD_SEED_RANDOM:
rc = entry_ck_seed_random(client, ptypes, params);
break;
case PKCS11_CMD_GENERATE_RANDOM:
rc = entry_ck_generate_random(client, ptypes, params);
break;
default:
EMSG("Command %#"PRIx32" is not supported", cmd);
return TEE_ERROR_NOT_SUPPORTED;
Expand Down
2 changes: 2 additions & 0 deletions ta/pkcs11/src/pkcs11_helpers.c
Original file line number Diff line number Diff line change
Expand Up @@ -178,6 +178,8 @@ static const struct any_id __maybe_unused string_ta_cmd[] = {
PKCS11_ID(PKCS11_CMD_GET_ATTRIBUTE_VALUE),
PKCS11_ID(PKCS11_CMD_SET_ATTRIBUTE_VALUE),
PKCS11_ID(PKCS11_CMD_COPY_OBJECT),
PKCS11_ID(PKCS11_CMD_SEED_RANDOM),
PKCS11_ID(PKCS11_CMD_GENERATE_RANDOM),
};

static const struct any_id __maybe_unused string_slot_flags[] = {
Expand Down
137 changes: 137 additions & 0 deletions ta/pkcs11/src/pkcs11_token.c
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
#include <confine_array_index.h>
#include <pkcs11_ta.h>
#include <printk.h>
#include <pta_system.h>
#include <string.h>
#include <string_ext.h>
#include <sys/queue.h>
Expand All @@ -30,6 +31,9 @@
#define TOKEN_COUNT CFG_PKCS11_TA_TOKEN_COUNT
#endif

/* RNG chunk size used to split RNG generation to smaller sizes */
#define RNG_CHUNK_SIZE 512U

/*
* Structure tracking client applications
*
Expand Down Expand Up @@ -1464,3 +1468,136 @@ enum pkcs11_rc entry_ck_logout(struct pkcs11_client *client,

return PKCS11_CKR_OK;
}

static TEE_Result seed_rng_pool(void *seed, size_t length)
{
static const TEE_UUID system_uuid = PTA_SYSTEM_UUID;
uint32_t param_types = TEE_PARAM_TYPES(TEE_PARAM_TYPE_MEMREF_INPUT,
TEE_PARAM_TYPE_NONE,
TEE_PARAM_TYPE_NONE,
TEE_PARAM_TYPE_NONE);
TEE_Param params[TEE_NUM_PARAMS] = { };
TEE_TASessionHandle sess = TEE_HANDLE_NULL;
TEE_Result res = TEE_ERROR_GENERIC;
uint32_t ret_orig = 0;

params[0].memref.buffer = seed;
params[0].memref.size = (uint32_t)length;

res = TEE_OpenTASession(&system_uuid, TEE_TIMEOUT_INFINITE, 0, NULL,
&sess, &ret_orig);
if (res != TEE_SUCCESS) {
EMSG("Can't open session to system PTA");
return res;
}

res = TEE_InvokeTACommand(sess, TEE_TIMEOUT_INFINITE,
PTA_SYSTEM_ADD_RNG_ENTROPY,
param_types, params, &ret_orig);
if (res != TEE_SUCCESS)
EMSG("Can't invoke system PTA");

TEE_CloseTASession(sess);
return res;
}

enum pkcs11_rc entry_ck_seed_random(struct pkcs11_client *client,
uint32_t ptypes, TEE_Param *params)
{
const uint32_t exp_pt = TEE_PARAM_TYPES(TEE_PARAM_TYPE_MEMREF_INOUT,
TEE_PARAM_TYPE_MEMREF_INPUT,
TEE_PARAM_TYPE_NONE,
TEE_PARAM_TYPE_NONE);
TEE_Param *ctrl = params;
TEE_Param *in = params + 1;
enum pkcs11_rc rc = PKCS11_CKR_OK;
struct serialargs ctrlargs = { };
struct pkcs11_session *session = NULL;
TEE_Result res = TEE_SUCCESS;

if (!client || ptypes != exp_pt)
return PKCS11_CKR_ARGUMENTS_BAD;

serialargs_init(&ctrlargs, ctrl->memref.buffer, ctrl->memref.size);

rc = serialargs_get_session_from_handle(&ctrlargs, client, &session);
if (rc)
return rc;

if (serialargs_remaining_bytes(&ctrlargs))
return PKCS11_CKR_ARGUMENTS_BAD;

if (in->memref.size && !in->memref.buffer)
return PKCS11_CKR_ARGUMENTS_BAD;

if (!in->memref.size)
return PKCS11_CKR_OK;

res = seed_rng_pool(in->memref.buffer, in->memref.size);
if (res != TEE_SUCCESS)
return PKCS11_CKR_FUNCTION_FAILED;

DMSG("PKCS11 session %"PRIu32": seed random", session->handle);

return PKCS11_CKR_OK;
}

enum pkcs11_rc entry_ck_generate_random(struct pkcs11_client *client,
uint32_t ptypes, TEE_Param *params)
{
const uint32_t exp_pt = TEE_PARAM_TYPES(TEE_PARAM_TYPE_MEMREF_INOUT,
TEE_PARAM_TYPE_NONE,
TEE_PARAM_TYPE_MEMREF_OUTPUT,
TEE_PARAM_TYPE_NONE);
TEE_Param *ctrl = params;
TEE_Param *out = params + 2;
enum pkcs11_rc rc = PKCS11_CKR_OK;
struct serialargs ctrlargs = { };
struct pkcs11_session *session = NULL;
void *buffer = NULL;
size_t buffer_size = 0;
uint8_t *data = NULL;
size_t left = 0;

if (!client || ptypes != exp_pt)
return PKCS11_CKR_ARGUMENTS_BAD;

serialargs_init(&ctrlargs, ctrl->memref.buffer, ctrl->memref.size);

rc = serialargs_get_session_from_handle(&ctrlargs, client, &session);
if (rc)
return rc;

if (serialargs_remaining_bytes(&ctrlargs))
return PKCS11_CKR_ARGUMENTS_BAD;

if (out->memref.size && !out->memref.buffer)
return PKCS11_CKR_ARGUMENTS_BAD;

if (!out->memref.size)
return PKCS11_CKR_OK;

buffer_size = MIN(out->memref.size, RNG_CHUNK_SIZE);
buffer = TEE_Malloc(buffer_size, TEE_MALLOC_FILL_ZERO);
if (!buffer)
return PKCS11_CKR_DEVICE_MEMORY;

data = out->memref.buffer;
left = out->memref.size;

while (left) {
size_t count = MIN(left, buffer_size);

TEE_GenerateRandom(buffer, count);
TEE_MemMove(data, buffer, count);

data += count;
left -= count;
}

DMSG("PKCS11 session %"PRIu32": generate random", session->handle);

TEE_Free(buffer);

return PKCS11_CKR_OK;
}
4 changes: 4 additions & 0 deletions ta/pkcs11/src/pkcs11_token.h
Original file line number Diff line number Diff line change
Expand Up @@ -336,5 +336,9 @@ enum pkcs11_rc entry_ck_login(struct pkcs11_client *client,
uint32_t ptypes, TEE_Param *params);
enum pkcs11_rc entry_ck_logout(struct pkcs11_client *client,
uint32_t ptypes, TEE_Param *params);
enum pkcs11_rc entry_ck_seed_random(struct pkcs11_client *client,
uint32_t ptypes, TEE_Param *params);
enum pkcs11_rc entry_ck_generate_random(struct pkcs11_client *client,
uint32_t ptypes, TEE_Param *params);

#endif /*PKCS11_TA_PKCS11_TOKEN_H*/