opensc/src/pkcs15init/pkcs15-rtecp.c

/*
 * pkcs15-rtecp.c: Rutoken ECP specific operation for PKCS15 initialization
 *
 * Copyright (C) 2009  Aleksey Samsonov <samsonov@guardant.ru>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
#include <assert.h>
#include <stddef.h>
#include <stdlib.h>
#include <opensc/opensc.h>
#include <opensc/cardctl.h>
#include <opensc/log.h>
#include <opensc/pkcs15.h>
#include "pkcs15-init.h"
#include "profile.h"

#define RTECP_SO_PIN_REF        1
#define RTECP_USER_PIN_REF      2

/*
 * Erase everything that's on the card
 */
static int rtecp_erase(sc_profile_t *profile, sc_card_t *card)
{
	int r;

	if (!profile || !card)
		return SC_ERROR_INVALID_ARGUMENTS;
	r = sc_card_ctl(card, SC_CARDCTL_RTECP_INIT, NULL);
	if (r == SC_SUCCESS)
		sc_free_apps(card);
	return r;
}

static int create_sysdf(sc_profile_t *profile, sc_card_t *card, const char *name)
{
	sc_file_t *file;
	sc_path_t path;
	int r;

	assert(profile && card && card->ctx && name);
	r = sc_profile_get_file(profile, name, &file);
	if (r == SC_SUCCESS)
	{
		assert(file);
		path = file->path;
		assert(path.len > 2);
		if (path.len > 2)
			path.len -= 2;
		r = sc_select_file(card, &path, NULL);
		if (r == SC_SUCCESS)
			r = sc_file_add_acl_entry(file, SC_AC_OP_CREATE,
					SC_AC_CHV, RTECP_USER_PIN_REF);
		if (r == SC_SUCCESS)
			r = sc_file_add_acl_entry(file, SC_AC_OP_DELETE,
					SC_AC_NEVER, SC_AC_KEY_REF_NONE);
		if (r == SC_SUCCESS)
			r = sc_create_file(card, file);
		assert(file);
		sc_file_free(file);
	}
	if (r && card->ctx->debug >= 2)
		sc_debug(card->ctx, "Create %s failed: %s\n", name, sc_strerror(r));
	return r;
}

/*
 * Card-specific initialization of PKCS15 meta-information
 */
static int rtecp_init(sc_profile_t *profile, sc_card_t *card)
{
	sc_file_t *file;
	int r;

	if (!profile || !card || !card->ctx)
		return SC_ERROR_INVALID_ARGUMENTS;

	r = sc_profile_get_file(profile, "MF", &file);
	SC_TEST_RET(card->ctx, r, "Get MF info failed");
	assert(file);
	r = sc_create_file(card, file);
	assert(file);
	sc_file_free(file);
	SC_TEST_RET(card->ctx, r, "Create MF failed");

	r = sc_profile_get_file(profile, "DIR", &file);
	SC_TEST_RET(card->ctx, r, "Get DIR file info failed");
	assert(file);
	r = sc_create_file(card, file);
	assert(file);
	sc_file_free(file);
	SC_TEST_RET(card->ctx, r, "Create DIR file failed");

	create_sysdf(profile, card, "Sys-DF");
	create_sysdf(profile, card, "SysKey-DF");
	create_sysdf(profile, card, "PuKey-DF");
	create_sysdf(profile, card, "PrKey-DF");
	create_sysdf(profile, card, "SKey-DF");
	create_sysdf(profile, card, "Cer-DF");
	create_sysdf(profile, card, "LCHV-DF");

	return sc_select_file(card, sc_get_mf_path(), NULL);
}

/*
 * Create a DF
 */
static int rtecp_create_dir(sc_profile_t *profile, sc_card_t *card, sc_file_t *df)
{
	if (!profile || !card || !df)
		return SC_ERROR_INVALID_ARGUMENTS;
	return sc_create_file(card, df);
}

/*
 * Select a PIN reference
 */
static int rtecp_select_pin_reference(sc_profile_t *profile, sc_card_t *card,
		sc_pkcs15_pin_info_t *pin_info)
{
	if (!profile || !card || !card->ctx || !pin_info)
		return SC_ERROR_INVALID_ARGUMENTS;

	if (pin_info->reference > 2)
		SC_FUNC_RETURN(card->ctx, 1, SC_ERROR_NOT_SUPPORTED);
	if (pin_info->flags & SC_PKCS15_PIN_FLAG_SO_PIN)
		pin_info->reference = RTECP_SO_PIN_REF;
	else
		pin_info->reference = RTECP_USER_PIN_REF;
	return SC_SUCCESS;
}

/*
 * Create a PIN object within the given DF
 */
static int rtecp_create_pin(sc_profile_t *profile, sc_card_t *card,
		sc_file_t *df, sc_pkcs15_object_t *pin_obj,
		const unsigned char *pin, size_t pin_len,
		const unsigned char *puk, size_t puk_len)
{
	sc_pkcs15_pin_info_t *pin_info;
	sc_file_t *file;
	/*                        GCHV min-length Flags Attempts  Reserve */
	unsigned char prop[]  = { 0x01,       '?', 0x01,    0xFF, 0, 0 };
	/*                  AccessMode           Unblock Change             Delete */
	unsigned char sec[15] = { 0x43, RTECP_SO_PIN_REF,   '?', 0, 0, 0, 0,  0xFF };
	int r;

	(void)puk; /* no warning */
	if (!profile || !card || !card->ctx || !df || !pin_obj || !pin_obj->data
			|| !pin || !pin_len)
		return SC_ERROR_INVALID_ARGUMENTS;

	SC_FUNC_CALLED(card->ctx, 1);
	if (puk_len != 0)
	{
		sc_error(card->ctx, "Do not enter User unblocking PIN (PUK): %s\n",
				sc_strerror(SC_ERROR_NOT_SUPPORTED));
		return SC_ERROR_NOT_SUPPORTED;
	}
	pin_info = (sc_pkcs15_pin_info_t *)pin_obj->data;
	if (pin_info->reference != RTECP_SO_PIN_REF
			&& pin_info->reference != RTECP_USER_PIN_REF)
	{
		sc_debug(card->ctx, "PIN reference %i not found in standard"
				" (Rutoken ECP) PINs\n", pin_info->reference);
		return SC_ERROR_NOT_SUPPORTED;
	}
	file = sc_file_new();
	if (!file)
		SC_FUNC_RETURN(card->ctx, 0, SC_ERROR_OUT_OF_MEMORY);
	file->id = pin_info->reference;
	file->size = pin_len;
	assert(sizeof(sec)/sizeof(sec[0]) > 2);
	sec[2] = (unsigned char)pin_info->reference;
	r = sc_file_set_sec_attr(file, sec, sizeof(sec));
	if (r == SC_SUCCESS)
	{
		assert(sizeof(prop)/sizeof(prop[0]) > 1);
		prop[1] = (unsigned char)pin_info->min_length;
		r = sc_file_set_prop_attr(file, prop, sizeof(prop));
	}
	if (r == SC_SUCCESS)
		r = sc_file_set_type_attr(file, (const u8*)"\x10\x00", 2);
	if (r == SC_SUCCESS)
		r = sc_create_file(card, file);
	sc_file_free(file);

	if (r == SC_SUCCESS)
		r = sc_change_reference_data(card, pin_info->type, pin_info->reference,
				NULL, 0, pin, pin_len, NULL);
	SC_FUNC_RETURN(card->ctx, 1, r);
}

/*
 * Select a reference for a private key object
 */
static int rtecp_select_key_reference(sc_profile_t *profile,
		sc_card_t *card, sc_pkcs15_prkey_info_t *key_info)
{
	sc_file_t *df;
	int r;

	if (!profile || !card || !card->ctx || !key_info)
		return SC_ERROR_INVALID_ARGUMENTS;

	if (key_info->key_reference <= 0)
		key_info->key_reference = 1;
	else if (key_info->key_reference > 0xFF)
		return SC_ERROR_TOO_MANY_OBJECTS;

	r = sc_profile_get_file(profile, "PrKey-DF", &df);
	SC_TEST_RET(card->ctx, r, "Get PrKey-DF info failed");
	assert(df);
	key_info->path = df->path;
	sc_file_free(df);
	r = sc_append_file_id(&key_info->path, key_info->key_reference);
	return r;
}

/*
 * Create an empty key object
 */
static int rtecp_create_key(sc_profile_t *profile, sc_card_t *card,
		sc_pkcs15_object_t *obj)
{
	/*                              RSA_PRkey/ for Miller-
	 *                              RSA_PUBkey  Rabin test    Attempts Reserve */
	const unsigned char prkey_prop[]  = { 0x23,       0x1F, 0,    0xFF, 0, 0 };
	const unsigned char pbkey_prop[]  = { 0x33,       0x1F, 0,    0xFF, 0, 0 };
	/*                        AccessMode  - Update  Use  -  -  - Delete */
	unsigned char prkey_sec[15] = { 0x46, 0,   '?', '?', 0, 0, 0,   '?' };
	unsigned char pbkey_sec[15] = { 0x46, 0,   '?',   0, 0, 0, 0,   '?' };
	unsigned char auth_id;
	sc_pkcs15_prkey_info_t *key_info;
	sc_file_t *file;
	int r;

	if (!profile || !card || !card->ctx || !obj || !obj->data)
		return SC_ERROR_INVALID_ARGUMENTS;

	SC_FUNC_CALLED(card->ctx, 1);
	if (obj->type != SC_PKCS15_TYPE_PRKEY_RSA)
		return SC_ERROR_NOT_SUPPORTED;
	if (obj->auth_id.len != 1)
		return SC_ERROR_INVALID_ARGUMENTS;
	auth_id = obj->auth_id.value[0];

	key_info = (sc_pkcs15_prkey_info_t *)obj->data;
	assert(key_info);
	if (key_info->modulus_length % 128 != 0)
	{
		sc_error(card->ctx, "Unsupported key size %u\n",
				key_info->modulus_length);
		return SC_ERROR_INVALID_ARGUMENTS;
	}

	r = sc_profile_get_file(profile, "PKCS15-AppDF", &file);
	SC_TEST_RET(card->ctx, r, "Get PKCS15-AppDF info failed");
	r = sc_file_add_acl_entry(file, SC_AC_OP_CREATE, SC_AC_CHV, auth_id);
	if (r == SC_SUCCESS)
		r = sc_pkcs15init_authenticate(profile, card, file, SC_AC_OP_CREATE);
	assert(file);
	sc_file_free(file);
	SC_TEST_RET(card->ctx, r, "Authenticate failed");

	file = sc_file_new();
	if (!file)
		SC_FUNC_RETURN(card->ctx, 0, SC_ERROR_OUT_OF_MEMORY);
	file->id = key_info->key_reference;
	r = sc_file_set_type_attr(file, (const u8*)"\x10\x00", 2);
	/* private key file */
	file->size = key_info->modulus_length / 8 / 2 * 5 + 8;
	if (r == SC_SUCCESS)
	{
		assert(sizeof(prkey_sec)/sizeof(prkey_sec[0]) > 7);
		prkey_sec[2] = auth_id;
		prkey_sec[3] = auth_id;
		prkey_sec[7] = auth_id;
		r = sc_file_set_sec_attr(file, prkey_sec, sizeof(prkey_sec));
	}
	if (r == SC_SUCCESS)
		r = sc_file_set_prop_attr(file, prkey_prop, sizeof(prkey_prop));
	if (r == SC_SUCCESS)
		r = sc_create_file(card, file);
	/* public key file */
	file->size = key_info->modulus_length / 8 / 2 * 3;
	if (r == SC_SUCCESS)
	{
		assert(sizeof(pbkey_sec)/sizeof(pbkey_sec[0]) > 7);
		pbkey_sec[2] = auth_id;
		pbkey_sec[7] = auth_id;
		r = sc_file_set_sec_attr(file, pbkey_sec, sizeof(pbkey_sec));
	}
	if (r == SC_SUCCESS)
		r = sc_file_set_prop_attr(file, pbkey_prop, sizeof(pbkey_prop));
	if (r == SC_SUCCESS)
		r = sc_create_file(card, file);
	assert(file);
	sc_file_free(file);
	SC_FUNC_RETURN(card->ctx, 1, r);
}

/*
 * Store a key on the card
 */
static int rtecp_store_key(sc_profile_t *profile, sc_card_t *card,
		sc_pkcs15_object_t *obj, sc_pkcs15_prkey_t *key)
{
	sc_pkcs15_prkey_info_t *key_info;
	sc_file_t *pukey_df;
	sc_path_t path;
	unsigned char *buf;
	size_t len, i;
	int r;

	if (!profile || !card || !card->ctx || !obj || !obj->data || !key)
		return SC_ERROR_INVALID_ARGUMENTS;

	SC_FUNC_CALLED(card->ctx, 1);
	if (obj->type != SC_PKCS15_TYPE_PRKEY_RSA || key->algorithm != SC_ALGORITHM_RSA)
		return SC_ERROR_NOT_SUPPORTED;

	key_info = (sc_pkcs15_prkey_info_t *)obj->data;
	assert(key_info);

	assert(key_info->modulus_length % 128 == 0);
	len = key_info->modulus_length / 8 / 2;
	if (!key->u.rsa.p.data || !key->u.rsa.q.data || !key->u.rsa.iqmp.data
			|| !key->u.rsa.dmp1.data || !key->u.rsa.dmq1.data
			|| !key->u.rsa.modulus.data || !key->u.rsa.exponent.data
			|| key->u.rsa.p.len != len || key->u.rsa.q.len != len
			|| key->u.rsa.iqmp.len != len || key->u.rsa.dmp1.len != len
			|| key->u.rsa.dmq1.len != len || key->u.rsa.modulus.len != 2*len
			|| key->u.rsa.exponent.len > len || key->u.rsa.exponent.len == 0)
		return SC_ERROR_INVALID_ARGUMENTS;

	buf = calloc(1, len * 5 + 8);
	if (!buf)
		SC_FUNC_RETURN(card->ctx, 0, SC_ERROR_OUT_OF_MEMORY);
	assert(key->u.rsa.p.data && key->u.rsa.q.data && key->u.rsa.iqmp.data
			&& key->u.rsa.dmp1.data && key->u.rsa.dmq1.data
			&& key->u.rsa.p.len == len && key->u.rsa.q.len == len
			&& key->u.rsa.iqmp.len == len
			&& key->u.rsa.dmp1.len == len
			&& key->u.rsa.dmq1.len == len);
	/* p */
	for (i = 0; i < len; ++i)
		buf[i] = key->u.rsa.p.data[len - 1 - i];
	/* q */
	for (i = 0; i < len; ++i)
		buf[len + 4 + i] = key->u.rsa.q.data[len - 1 - i];
	/* iqmp */
	for (i = 0; i < len; ++i)
		buf[len + 4 + len + 4 + i] = key->u.rsa.iqmp.data[len - 1 - i];
	/* dmp1 */
	for (i = 0; i < len; ++i)
		buf[len + 4 + len + 4 + len + i] = key->u.rsa.dmp1.data[len - 1 - i];
	/* dmq1 */
	for (i = 0; i < len; ++i)
		buf[len * 4 + 8 + i] = key->u.rsa.dmq1.data[len - 1 - i];

	path = key_info->path;
	r = sc_select_file(card, &path, NULL);
	if (r == SC_SUCCESS)
		r = sc_change_reference_data(card, 0, 0, NULL, 0, buf, len*5 + 8, NULL);
	assert(buf);
	sc_mem_clear(buf, len * 5 + 8);
	/* store public key */
	assert(key->u.rsa.modulus.data && key->u.rsa.exponent.data
			&& key->u.rsa.modulus.len == 2*len
			&& key->u.rsa.exponent.len <= len
			&& key->u.rsa.exponent.len > 0);
	/* modulus */
	for (i = 0; i < 2*len; ++i)
		buf[i] = key->u.rsa.modulus.data[2*len - 1 - i];
	/* exponent */
	for (i = 0; i < key->u.rsa.exponent.len && i < len; ++i)
		buf[2*len+i] = key->u.rsa.exponent.data[key->u.rsa.exponent.len - 1 - i];
	if (r == SC_SUCCESS)
	{
		r = sc_profile_get_file(profile, "PuKey-DF", &pukey_df);
		if (r == SC_SUCCESS)
		{
			assert(pukey_df);
			path = pukey_df->path;
			r = sc_append_file_id(&path, key_info->key_reference);
			sc_file_free(pukey_df);
		}
		else if (card->ctx->debug >= 2)
			sc_debug(card->ctx, "%s\n", "Get PuKey-DF info failed");
	}
	if (r == SC_SUCCESS)
	{
		r = sc_select_file(card, &path, NULL);
		if (r == SC_SUCCESS)
			r = sc_change_reference_data(card, 0, 0, NULL, 0,
					buf, len*3, NULL);
		if (r && card->ctx->debug >= 2)
			sc_debug(card->ctx, "%s\n", "Store public key failed");
	}
	assert(buf);
	free(buf);
	SC_FUNC_RETURN(card->ctx, 1, r);
}

/*
 * Generate key
 */
static int rtecp_generate_key(sc_profile_t *profile, sc_card_t *card,
		sc_pkcs15_object_t *obj, sc_pkcs15_pubkey_t *pubkey)
{
	sc_pkcs15_prkey_info_t *key_info;
	sc_rtecp_genkey_data_t data;
	int r;

	if (!profile || !card || !card->ctx || !obj || !obj->data || !pubkey)
		return SC_ERROR_INVALID_ARGUMENTS;

	SC_FUNC_CALLED(card->ctx, 1);
	if (obj->type != SC_PKCS15_TYPE_PRKEY_RSA)
		return SC_ERROR_NOT_SUPPORTED;

	key_info = (sc_pkcs15_prkey_info_t *)obj->data;
	assert(key_info);
	data.key_id = key_info->key_reference;
	assert(data.key_id != 0);
	assert(key_info->modulus_length % 128 == 0);
	data.modulus_len = key_info->modulus_length / 8;
	data.modulus = calloc(1, data.modulus_len);
	data.exponent_len = key_info->modulus_length / 8 / 2;
	data.exponent = calloc(1, data.exponent_len);
	if (!data.modulus || !data.exponent)
	{
		free(data.modulus);
		free(data.exponent);
		SC_FUNC_RETURN(card->ctx, 0, SC_ERROR_OUT_OF_MEMORY);
	}
	r = sc_card_ctl(card, SC_CARDCTL_RTECP_GENERATE_KEY, &data);
	if (r == SC_SUCCESS)
	{
		assert(pubkey);
		pubkey->algorithm = SC_ALGORITHM_RSA;
		pubkey->u.rsa.modulus.data = data.modulus;
		pubkey->u.rsa.modulus.len = data.modulus_len;
		pubkey->u.rsa.exponent.data = data.exponent;
		pubkey->u.rsa.exponent.len = data.exponent_len;
	}
	SC_FUNC_RETURN(card->ctx, 1, r);
}

/*
 * Finalize card
 * Ends the initialization phase of the smart card/token
 */
static int rtecp_finalize(sc_card_t *card)
{
	if (!card)
		return SC_ERROR_INVALID_ARGUMENTS;
	return sc_card_ctl(card, SC_CARDCTL_RTECP_INIT_END, NULL);
}

static struct sc_pkcs15init_operations sc_pkcs15init_rtecp_operations = {
	rtecp_erase,                    /* erase_card */
	rtecp_init,                     /* init_card */
	rtecp_create_dir,               /* create_dir */
	NULL,                           /* create_domain */
	rtecp_select_pin_reference,     /* select_pin_reference */
	rtecp_create_pin,               /* create_pin */
	rtecp_select_key_reference,     /* select_key_reference */
	rtecp_create_key,               /* create_key */
	rtecp_store_key,                /* store_key */
	rtecp_generate_key,             /* generate_key */
	NULL,                           /* encode_private_key */
	NULL,                           /* encode_public_key */
	rtecp_finalize,                 /* finalize_card */
	/* Old-style API */
	NULL,                           /* init_app */
	NULL,                           /* new_pin */
	NULL,                           /* new_key */
	NULL,                           /* new_file */
	NULL,                           /* old_generate_key */
	NULL                            /* delete_object */
};

struct sc_pkcs15init_operations * sc_pkcs15init_get_rtecp_ops(void)
{
	return &sc_pkcs15init_rtecp_operations;
}