xref: /illumos-gate/usr/src/lib/pkcs11/pkcs11_tpm/common/key.c (revision 47e946e7)

/*
 *		Common Public License Version 0.5
 *
 *		THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF
 *		THIS COMMON PUBLIC LICENSE ("AGREEMENT"). ANY USE,
 *		REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES
 *		RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
 *
 *		1. DEFINITIONS
 *
 *		"Contribution" means:
 *			a) in the case of the initial Contributor, the
 *			initial code and documentation distributed under
 *			this Agreement, and
 *
 *			b) in the case of each subsequent Contributor:
 *			i) changes to the Program, and
 *			ii) additions to the Program;
 *
 *			where such changes and/or additions to the Program
 *			originate from and are distributed by that
 *			particular Contributor. A Contribution 'originates'
 *			from a Contributor if it was added to the Program
 *			by such Contributor itself or anyone acting on such
 *			Contributor's behalf. Contributions do not include
 *			additions to the Program which: (i) are separate
 *			modules of software distributed in conjunction with
 *			the Program under their own license agreement, and
 *			(ii) are not derivative works of the Program.
 *
 *
 *		"Contributor" means any person or entity that distributes
 *		the Program.
 *
 *		"Licensed Patents " mean patent claims licensable by a
 *		Contributor which are necessarily infringed by the use or
 *		sale of its Contribution alone or when combined with the
 *		Program.
 *
 *		"Program" means the Contributions distributed in
 *		accordance with this Agreement.
 *
 *		"Recipient" means anyone who receives the Program under
 *		this Agreement, including all Contributors.
 *
 *		2. GRANT OF RIGHTS
 *
 *			a) Subject to the terms of this Agreement, each
 *			Contributor hereby grants Recipient a
 *			no - exclusive, worldwide, royalt - free copyright
 *			license to reproduce, prepare derivative works of,
 *			publicly display, publicly perform, distribute and
 *			sublicense the Contribution of such Contributor, if
 *			any, and such derivative works, in source code and
 *			object code form.
 *
 *			b) Subject to the terms of this Agreement, each
 *			Contributor hereby grants Recipient a
 *			no - exclusive, worldwide, royalt - free patent
 *			license under Licensed Patents to make, use, sell,
 *			offer to sell, import and otherwise transfer the
 *			Contribution of such Contributor, if any, in source
 *			code and object code form. This patent license
 *			shall apply to the combination of the Contribution
 *			and the Program if, at the time the Contribution is
 *			added by the Contributor, such addition of the
 *			Contribution causes such combination to be covered
 *			by the Licensed Patents. The patent license shall
 *			not apply to any other combinations which include
 *			the Contribution. No hardware per se is licensed
 *			hereunder.
 *
 *			c) Recipient understands that although each
 *			Contributor grants the licenses to its
 *			Contributions set forth herein, no assurances are
 *			provided by any Contributor that the Program does
 *			not infringe the patent or other intellectual
 *			property rights of any other entity. Each
 *			Contributor disclaims any liability to Recipient
 *			for claims brought by any other entity based on
 *			infringement of intellectual property rights or
 *			otherwise. As a condition to exercising the rights
 *			and licenses granted hereunder, each Recipient
 *			hereby assumes sole responsibility to secure any
 *			other intellectual property rights needed, if any.
 *
 *			For example, if a third party patent license is
 *			required to allow Recipient to distribute the
 *			Program, it is Recipient's responsibility to
 *			acquire that license before distributing the
 *			Program.
 *
 *			d) Each Contributor represents that to its
 *			knowledge it has sufficient copyright rights in its
 *			Contribution, if any, to grant the copyright
 *			license set forth in this Agreement.
 *
 *		3. REQUIREMENTS
 *
 *		A Contributor may choose to distribute the Program in
 *		object code form under its own license agreement, provided
 *		that:
 *			a) it complies with the terms and conditions of
 *			this Agreement; and
 *
 *			b) its license agreement:
 *			i) effectively disclaims on behalf of all
 *			Contributors all warranties and conditions, express
 *			and implied, including warranties or conditions of
 *			title and no - infringement, and implied warranties
 *			or conditions of merchantability and fitness for a
 *			particular purpose;
 *
 *			ii) effectively excludes on behalf of all
 *			Contributors all liability for damages, including
 *			direct, indirect, special, incidental and
 *			consequential damages, such as lost profits;
 *
 *			iii) states that any provisions which differ from
 *			this Agreement are offered by that Contributor
 *			alone and not by any other party; and
 *
 *			iv) states that source code for the Program is
 *			available from such Contributor, and informs
 *			licensees how to obtain it in a reasonable manner
 *			on or through a medium customarily used for
 *			software exchange.
 *
 *		When the Program is made available in source code form:
 *			a) it must be made available under this Agreement;
 *			and
 *			b) a copy of this Agreement must be included with
 *			each copy of the Program.
 *
 *		Contributors may not remove or alter any copyright notices
 *		contained within the Program.
 *
 *		Each Contributor must identify itself as the originator of
 *		its Contribution, if any, in a manner that reasonably
 *		allows subsequent Recipients to identify the originator of
 *		the Contribution.
 *
 *
 *		4. COMMERCIAL DISTRIBUTION
 *
 *		Commercial distributors of software may accept certain
 *		responsibilities with respect to end users, business
 *		partners and the like. While this license is intended to
 *		facilitate the commercial use of the Program, the
 *		Contributor who includes the Program in a commercial
 *		product offering should do so in a manner which does not
 *		create potential liability for other Contributors.
 *		Therefore, if a Contributor includes the Program in a
 *		commercial product offering, such Contributor ("Commercial
 *		Contributor") hereby agrees to defend and indemnify every
 *		other Contributor ("Indemnified Contributor") against any
 *		losses, damages and costs (collectively "Losses") arising
 *		from claims, lawsuits and other legal actions brought by a
 *		third party against the Indemnified Contributor to the
 *		extent caused by the acts or omissions of such Commercial
 *		Contributor in connection with its distribution of the
 *		Program in a commercial product offering. The obligations
 *		in this section do not apply to any claims or Losses
 *		relating to any actual or alleged intellectual property
 *		infringement. In order to qualify, an Indemnified
 *		Contributor must: a) promptly notify the Commercial
 *		Contributor in writing of such claim, and b) allow the
 *		Commercial Contributor to control, and cooperate with the
 *		Commercial Contributor in, the defense and any related
 *		settlement negotiations. The Indemnified Contributor may
 *		participate in any such claim at its own expense.
 *
 *
 *		For example, a Contributor might include the Program in a
 *		commercial product offering, Product X. That Contributor
 *		is then a Commercial Contributor. If that Commercial
 *		Contributor then makes performance claims, or offers
 *		warranties related to Product X, those performance claims
 *		and warranties are such Commercial Contributor's
 *		responsibility alone. Under this section, the Commercial
 *		Contributor would have to defend claims against the other
 *		Contributors related to those performance claims and
 *		warranties, and if a court requires any other Contributor
 *		to pay any damages as a result, the Commercial Contributor
 *		must pay those damages.
 *
 *
 *		5. NO WARRANTY
 *
 *		EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE
 *		PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT
 *		WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR
 *		IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR
 *		CONDITIONS OF TITLE, NO - INFRINGEMENT, MERCHANTABILITY OR
 *		FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely
 *		responsible for determining the appropriateness of using
 *		and distributing the Program and assumes all risks
 *		associated with its exercise of rights under this
 *		Agreement, including but not limited to the risks and
 *		costs of program errors, compliance with applicable laws,
 *		damage to or loss of data, programs or equipment, and
 *		unavailability or interruption of operations.
 *
 *		6. DISCLAIMER OF LIABILITY
 *		EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER
 *		RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY
 *		FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY,
 *		OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION
 *		LOST PROFITS), 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 OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE
 *		OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE
 *		POSSIBILITY OF SUCH DAMAGES.
 *
 *		7. GENERAL
 *
 *		If any provision of this Agreement is invalid or
 *		unenforceable under applicable law, it shall not affect
 *		the validity or enforceability of the remainder of the
 *		terms of this Agreement, and without further action by the
 *		parties hereto, such provision shall be reformed to the
 *		minimum extent necessary to make such provision valid and
 *		enforceable.
 *
 *
 *		If Recipient institutes patent litigation against a
 *		Contributor with respect to a patent applicable to
 *		software (including a cros - claim or counterclaim in a
 *		lawsuit), then any patent licenses granted by that
 *		Contributor to such Recipient under this Agreement shall
 *		terminate as of the date such litigation is filed. In
 *		addition, If Recipient institutes patent litigation
 *		against any entity (including a cros - claim or
 *		counterclaim in a lawsuit) alleging that the Program
 *		itself (excluding combinations of the Program with other
 *		software or hardware) infringes such Recipient's
 *		patent(s), then such Recipient's rights granted under
 *		Section 2(b) shall terminate as of the date such
 *		litigation is filed.
 *
 *		All Recipient's rights under this Agreement shall
 *		terminate if it fails to comply with any of the material
 *		terms or conditions of this Agreement and does not cure
 *		such failure in a reasonable period of time after becoming
 *		aware of such noncompliance. If all Recipient's rights
 *		under this Agreement terminate, Recipient agrees to cease
 *		use and distribution of the Program as soon as reasonably
 *		practicable. However, Recipient's obligations under this
 *		Agreement and any licenses granted by Recipient relating
 *		to the Program shall continue and survive.
 *
 *		Everyone is permitted to copy and distribute copies of
 *		this Agreement, but in order to avoid inconsistency the
 *		Agreement is copyrighted and may only be modified in the
 *		following manner. The Agreement Steward reserves the right
 *		to publish new versions (including revisions) of this
 *		Agreement from time to time. No one other than the
 *		Agreement Steward has the right to modify this Agreement.
 *
 *		IBM is the initial Agreement Steward. IBM may assign the
 *		responsibility to serve as the Agreement Steward to a
 *		suitable separate entity. Each new version of the
 *		Agreement will be given a distinguishing version number.
 *		The Program (including Contributions) may always be
 *		distributed subject to the version of the Agreement under
 *		which it was received. In addition, after a new version of
 *		the Agreement is published, Contributor may elect to
 *		distribute the Program (including its Contributions) under
 *		the new version. Except as expressly stated in Sections
 *		2(a) and 2(b) above, Recipient receives no rights or
 *		licenses to the intellectual property of any Contributor
 *		under this Agreement, whether expressly, by implication,
 *		estoppel or otherwise. All rights in the Program not
 *		expressly granted under this Agreement are reserved.
 *
 *
 *		This Agreement is governed by the laws of the State of New
 *		York and the intellectual property laws of the United
 *		States of America. No party to this Agreement will bring a
 *		legal action under this Agreement more than one year after
 *		the cause of action arose. Each party waives its rights to
 *		a jury trial in any resulting litigation.
 *
 *
 *
 * (C) COPYRIGHT International Business Machines Corp. 2001, 2002
 */
/*
 * Copyright 2009 Sun Microsystems, Inc.  All rights reserved.
 * Use is subject to license terms.
 */
#include "tpmtok_int.h"

CK_RV
key_object_check_required_attributes(TEMPLATE *tmpl, CK_ULONG mode)
{
	CK_ATTRIBUTE * attr = NULL;
	CK_BBOOL    found;

	found = template_attribute_find(tmpl, CKA_KEY_TYPE, &attr);
	if (! found) {
		if (mode == MODE_CREATE) {
			return (CKR_TEMPLATE_INCOMPLETE);
		}
	}

	return (template_check_required_base_attributes(tmpl, mode));
}

CK_RV
key_object_set_default_attributes(TEMPLATE *tmpl, CK_ULONG mode)
{
	CK_ATTRIBUTE * id_attr	= NULL;
	CK_ATTRIBUTE * sdate_attr  = NULL;
	CK_ATTRIBUTE * edate_attr  = NULL;
	CK_ATTRIBUTE * derive_attr = NULL;
	CK_ATTRIBUTE * local_attr  = NULL;

	// satisfy the compiler
	//
	if (mode)
		id_attr = NULL;

	id_attr	= (CK_ATTRIBUTE *)malloc(sizeof (CK_ATTRIBUTE));
	sdate_attr	= (CK_ATTRIBUTE *)malloc(sizeof (CK_ATTRIBUTE));
	edate_attr	= (CK_ATTRIBUTE *)malloc(sizeof (CK_ATTRIBUTE));
	derive_attr    = (CK_ATTRIBUTE *)malloc(sizeof (CK_ATTRIBUTE) +
	    sizeof (CK_BBOOL));
	local_attr	= (CK_ATTRIBUTE *)malloc(sizeof (CK_ATTRIBUTE) +
	    sizeof (CK_BBOOL));

	if (! id_attr || ! sdate_attr || ! edate_attr ||
	    ! derive_attr || ! local_attr) {
		if (id_attr)	free(id_attr);
		if (sdate_attr)   free(sdate_attr);
		if (edate_attr)   free(edate_attr);
		if (derive_attr)  free(derive_attr);
		if (local_attr)   free(local_attr);
		return (CKR_HOST_MEMORY);
	}

	id_attr->type	   = CKA_ID;
	id_attr->ulValueLen	= 0;
	id_attr->pValue	 = NULL;

	sdate_attr->type	= CKA_START_DATE;
	sdate_attr->ulValueLen  = 0;
	sdate_attr->pValue	= NULL;

	edate_attr->type	= CKA_END_DATE;
	edate_attr->ulValueLen  = 0;
	edate_attr->pValue	= NULL;

	derive_attr->type	= CKA_DERIVE;
	derive_attr->ulValueLen = sizeof (CK_BBOOL);
	derive_attr->pValue	= (CK_BYTE *)derive_attr +
	    sizeof (CK_ATTRIBUTE);
	*(CK_BBOOL *)derive_attr->pValue = FALSE;

	local_attr->type	= CKA_LOCAL;
	local_attr->ulValueLen  = sizeof (CK_BBOOL);
	local_attr->pValue	= (CK_BYTE *)local_attr + sizeof (CK_ATTRIBUTE);
	*(CK_BBOOL *)local_attr->pValue = FALSE;

	(void) template_update_attribute(tmpl, id_attr);
	(void) template_update_attribute(tmpl, sdate_attr);
	(void) template_update_attribute(tmpl, edate_attr);
	(void) template_update_attribute(tmpl, derive_attr);
	(void) template_update_attribute(tmpl, local_attr);

	return (CKR_OK);
}

CK_RV
key_object_validate_attribute(TEMPLATE *tmpl,
	CK_ATTRIBUTE *attr, CK_ULONG mode)
{
	switch (attr->type) {
		case CKA_KEY_TYPE:
		if (mode == MODE_CREATE || mode == MODE_DERIVE ||
		    mode == MODE_KEYGEN || mode == MODE_UNWRAP)
			return (CKR_OK);
		else {
			return (CKR_ATTRIBUTE_READ_ONLY);
		}
		case CKA_ID:
		case CKA_START_DATE:
		case CKA_END_DATE:
		case CKA_DERIVE:
			return (CKR_OK);

		case CKA_LOCAL:
			return (CKR_ATTRIBUTE_READ_ONLY);

		default:
		return (template_validate_base_attribute(tmpl, attr, mode));
	}
}

CK_RV
publ_key_check_required_attributes(TEMPLATE *tmpl, CK_ULONG mode) {
	return (key_object_check_required_attributes(tmpl, mode));
}

CK_RV
publ_key_set_default_attributes(TEMPLATE *tmpl, CK_ULONG mode)
{
	CK_ATTRIBUTE    *class_attr	  = NULL;
	CK_ATTRIBUTE    *subject_attr	= NULL;
	CK_ATTRIBUTE    *encrypt_attr	= NULL;
	CK_ATTRIBUTE    *verify_attr	 = NULL;
	CK_ATTRIBUTE    *verify_recover_attr = NULL;
	CK_ATTRIBUTE    *wrap_attr	   = NULL;

	CK_OBJECT_CLASS  class = CKO_PUBLIC_KEY;
	CK_RV	    rc;


	rc = key_object_set_default_attributes(tmpl, mode);
	if (rc != CKR_OK) {
		return (rc);
	}
	//
	// add the default CKO_PUBLIC_KEY attributes
	//
	class_attr	  = (CK_ATTRIBUTE *)malloc(sizeof (CK_ATTRIBUTE) +
	    sizeof (CK_OBJECT_CLASS));
	subject_attr	= (CK_ATTRIBUTE *)malloc(sizeof (CK_ATTRIBUTE));
	encrypt_attr	= (CK_ATTRIBUTE *)malloc(sizeof (CK_ATTRIBUTE) +
	    sizeof (CK_BBOOL));
	verify_attr	 = (CK_ATTRIBUTE *)malloc(sizeof (CK_ATTRIBUTE) +
	    sizeof (CK_BBOOL));
	verify_recover_attr = (CK_ATTRIBUTE *)malloc(sizeof (CK_ATTRIBUTE) +
	    sizeof (CK_BBOOL));
	wrap_attr	   = (CK_ATTRIBUTE *)malloc(sizeof (CK_ATTRIBUTE) +
	    sizeof (CK_BBOOL));

	if (! class || ! subject_attr || ! encrypt_attr ||
	    ! verify_attr || ! verify_recover_attr || ! wrap_attr) {
		if (class_attr)	  free(class_attr);
		if (subject_attr)	free(subject_attr);
		if (encrypt_attr)	free(encrypt_attr);
		if (verify_attr)	 free(verify_attr);
		if (verify_recover_attr) free(verify_recover_attr);
		if (wrap_attr)	   free(wrap_attr);

		return (CKR_HOST_MEMORY);
	}

	class_attr->type	   = CKA_CLASS;
	class_attr->ulValueLen	= sizeof (CK_OBJECT_CLASS);
	class_attr->pValue	 = (CK_BYTE *)class_attr +
	    sizeof (CK_ATTRIBUTE);
	*(CK_OBJECT_CLASS *)class_attr->pValue = CKO_PUBLIC_KEY;

	subject_attr->type	 = CKA_SUBJECT;
	subject_attr->ulValueLen   = 0;  // empty string
	subject_attr->pValue	= NULL;

	encrypt_attr->type	  = CKA_ENCRYPT;
	encrypt_attr->ulValueLen    = sizeof (CK_BBOOL);
	encrypt_attr->pValue	= (CK_BYTE *)encrypt_attr +
	    sizeof (CK_ATTRIBUTE);
	*(CK_BBOOL *)encrypt_attr->pValue = TRUE;

	verify_attr->type	  = CKA_VERIFY;
	verify_attr->ulValueLen    = sizeof (CK_BBOOL);
	verify_attr->pValue	= (CK_BYTE *)verify_attr +
	    sizeof (CK_ATTRIBUTE);
	*(CK_BBOOL *)verify_attr->pValue = TRUE;

	verify_recover_attr->type	  = CKA_VERIFY_RECOVER;
	verify_recover_attr->ulValueLen    = sizeof (CK_BBOOL);
	verify_recover_attr->pValue	= (CK_BYTE *)verify_recover_attr +
	    sizeof (CK_ATTRIBUTE);
	*(CK_BBOOL *)verify_recover_attr->pValue = TRUE;

	wrap_attr->type	  = CKA_WRAP;
	wrap_attr->ulValueLen    = sizeof (CK_BBOOL);
	wrap_attr->pValue	= (CK_BYTE *)wrap_attr +
	    sizeof (CK_ATTRIBUTE);
	*(CK_BBOOL *)wrap_attr->pValue = TRUE;

	(void) template_update_attribute(tmpl, class_attr);
	(void) template_update_attribute(tmpl, subject_attr);
	(void) template_update_attribute(tmpl, encrypt_attr);
	(void) template_update_attribute(tmpl, verify_attr);
	(void) template_update_attribute(tmpl, verify_recover_attr);
	(void) template_update_attribute(tmpl, wrap_attr);

	return (CKR_OK);
}

CK_RV
publ_key_validate_attribute(TEMPLATE *tmpl,
	CK_ATTRIBUTE *attr, CK_ULONG mode) {
	switch (attr->type) {
		case CKA_SUBJECT:
			return (CKR_OK);

		case CKA_ENCRYPT:
		case CKA_VERIFY:
		case CKA_VERIFY_RECOVER:
		case CKA_WRAP:
		if (mode == MODE_MODIFY) {
			if (nv_token_data->tweak_vector.allow_key_mods == TRUE)
				return (CKR_OK);
			return (CKR_ATTRIBUTE_READ_ONLY);
		}
		return (CKR_OK);

		default:
		return (key_object_validate_attribute(tmpl, attr, mode));
	}
}

CK_RV
priv_key_check_required_attributes(TEMPLATE *tmpl, CK_ULONG mode) {
	return (key_object_check_required_attributes(tmpl, mode));
}

CK_RV
priv_key_set_default_attributes(TEMPLATE *tmpl, CK_ULONG mode)
{
	CK_ATTRIBUTE    *class_attr	= NULL;
	CK_ATTRIBUTE    *subject_attr	= NULL;
	CK_ATTRIBUTE    *sensitive_attr    = NULL;
	CK_ATTRIBUTE    *decrypt_attr	= NULL;
	CK_ATTRIBUTE    *sign_attr	 = NULL;
	CK_ATTRIBUTE    *sign_recover_attr = NULL;
	CK_ATTRIBUTE    *unwrap_attr	= NULL;
	CK_ATTRIBUTE    *extractable_attr  = NULL;
	CK_ATTRIBUTE    *never_extr_attr   = NULL;
	CK_ATTRIBUTE    *always_sens_attr  = NULL;
	CK_RV	    rc;


	rc = key_object_set_default_attributes(tmpl, mode);
	if (rc != CKR_OK) {
		return (rc);
	}
	class_attr	= (CK_ATTRIBUTE *)malloc(sizeof (CK_ATTRIBUTE) +
	    sizeof (CK_OBJECT_CLASS));
	subject_attr	= (CK_ATTRIBUTE *)malloc(sizeof (CK_ATTRIBUTE));
	sensitive_attr    = (CK_ATTRIBUTE *)malloc(sizeof (CK_ATTRIBUTE) +
	    sizeof (CK_BBOOL));
	decrypt_attr	= (CK_ATTRIBUTE *)malloc(sizeof (CK_ATTRIBUTE) +
	    sizeof (CK_BBOOL));
	sign_attr	 = (CK_ATTRIBUTE *)malloc(sizeof (CK_ATTRIBUTE) +
	    sizeof (CK_BBOOL));
	sign_recover_attr = (CK_ATTRIBUTE *)malloc(sizeof (CK_ATTRIBUTE) +
	    sizeof (CK_BBOOL));
	unwrap_attr	= (CK_ATTRIBUTE *)malloc(sizeof (CK_ATTRIBUTE) +
	    sizeof (CK_BBOOL));
	extractable_attr  = (CK_ATTRIBUTE *)malloc(sizeof (CK_ATTRIBUTE) +
	    sizeof (CK_BBOOL));
	never_extr_attr   = (CK_ATTRIBUTE *)malloc(sizeof (CK_ATTRIBUTE) +
	    sizeof (CK_BBOOL));
	always_sens_attr  = (CK_ATTRIBUTE *)malloc(sizeof (CK_ATTRIBUTE) +
	    sizeof (CK_BBOOL));

	if (! class_attr || ! subject_attr || ! sensitive_attr ||
	    ! decrypt_attr || ! sign_attr || ! sign_recover_attr ||
	    ! unwrap_attr || ! extractable_attr ||
	    ! never_extr_attr || ! always_sens_attr) {
		if (class_attr)	free(class_attr);
		if (subject_attr)	free(subject_attr);
		if (sensitive_attr)    free(sensitive_attr);
		if (decrypt_attr)	free(decrypt_attr);
		if (sign_attr)	 free(sign_attr);
		if (sign_recover_attr) free(sign_recover_attr);
		if (unwrap_attr)	free(unwrap_attr);
		if (extractable_attr)  free(extractable_attr);
		if (always_sens_attr)  free(always_sens_attr);
		if (never_extr_attr)   free(never_extr_attr);

		return (CKR_HOST_MEMORY);
	}

	class_attr->type	= CKA_CLASS;
	class_attr->ulValueLen = sizeof (CK_OBJECT_CLASS);
	class_attr->pValue	= (CK_BYTE *)class_attr + sizeof (CK_ATTRIBUTE);
	*(CK_OBJECT_CLASS *)class_attr->pValue = CKO_PRIVATE_KEY;

	subject_attr->type	= CKA_SUBJECT;
	subject_attr->ulValueLen = 0;  // empty string
	subject_attr->pValue	= NULL;

	sensitive_attr->type	= CKA_SENSITIVE;
	sensitive_attr->ulValueLen = sizeof (CK_BBOOL);
	sensitive_attr->pValue	= (CK_BYTE *)sensitive_attr +
	    sizeof (CK_ATTRIBUTE);
	*(CK_BBOOL *)sensitive_attr->pValue = FALSE;

	decrypt_attr->type	= CKA_DECRYPT;
	decrypt_attr->ulValueLen = sizeof (CK_BBOOL);
	decrypt_attr->pValue	= (CK_BYTE *)decrypt_attr +
	    sizeof (CK_ATTRIBUTE);
	*(CK_BBOOL *)decrypt_attr->pValue = TRUE;

	sign_attr->type	= CKA_SIGN;
	sign_attr->ulValueLen = sizeof (CK_BBOOL);
	sign_attr->pValue	= (CK_BYTE *)sign_attr +
	    sizeof (CK_ATTRIBUTE);
	*(CK_BBOOL *)sign_attr->pValue = TRUE;

	sign_recover_attr->type	= CKA_SIGN_RECOVER;
	sign_recover_attr->ulValueLen = sizeof (CK_BBOOL);
	sign_recover_attr->pValue	= (CK_BYTE *)sign_recover_attr +
	    sizeof (CK_ATTRIBUTE);
	*(CK_BBOOL *)sign_recover_attr->pValue = TRUE;

	unwrap_attr->type	= CKA_UNWRAP;
	unwrap_attr->ulValueLen = sizeof (CK_BBOOL);
	unwrap_attr->pValue	= (CK_BYTE *)unwrap_attr +
	    sizeof (CK_ATTRIBUTE);
	*(CK_BBOOL *)unwrap_attr->pValue = TRUE;

	extractable_attr->type	= CKA_EXTRACTABLE;
	extractable_attr->ulValueLen = sizeof (CK_BBOOL);
	extractable_attr->pValue	= (CK_BYTE *)extractable_attr +
	    sizeof (CK_ATTRIBUTE);
	*(CK_BBOOL *)extractable_attr->pValue = TRUE;

	never_extr_attr->type	= CKA_NEVER_EXTRACTABLE;
	never_extr_attr->ulValueLen = sizeof (CK_BBOOL);
	never_extr_attr->pValue	= (CK_BYTE *)never_extr_attr +
	    sizeof (CK_ATTRIBUTE);
	*(CK_BBOOL *)never_extr_attr->pValue = FALSE;

	always_sens_attr->type	= CKA_ALWAYS_SENSITIVE;
	always_sens_attr->ulValueLen = sizeof (CK_BBOOL);
	always_sens_attr->pValue	= (CK_BYTE *)always_sens_attr +
	    sizeof (CK_ATTRIBUTE);
	*(CK_BBOOL *)always_sens_attr->pValue = FALSE;

	(void) template_update_attribute(tmpl, class_attr);
	(void) template_update_attribute(tmpl, subject_attr);
	(void) template_update_attribute(tmpl, sensitive_attr);
	(void) template_update_attribute(tmpl, decrypt_attr);
	(void) template_update_attribute(tmpl, sign_attr);
	(void) template_update_attribute(tmpl, sign_recover_attr);
	(void) template_update_attribute(tmpl, unwrap_attr);
	(void) template_update_attribute(tmpl, extractable_attr);
	(void) template_update_attribute(tmpl, never_extr_attr);
	(void) template_update_attribute(tmpl, always_sens_attr);

	return (CKR_OK);
}

CK_RV
priv_key_unwrap(TEMPLATE *tmpl,
	CK_ULONG  keytype,
	CK_BYTE  *data,
	CK_ULONG  data_len)
{
	CK_ATTRIBUTE *extractable   = NULL;
	CK_ATTRIBUTE *always_sens   = NULL;
	CK_ATTRIBUTE *never_extract = NULL;
	CK_ATTRIBUTE *sensitive	= NULL;
	CK_ATTRIBUTE *local	 = NULL;
	CK_BBOOL   true  = TRUE;
	CK_BBOOL   false = FALSE;
	CK_RV	rc;

	switch (keytype) {
		case CKK_RSA:
		rc = rsa_priv_unwrap(tmpl, data, data_len);
		break;

		default:
		return (CKR_WRAPPED_KEY_INVALID);
	}

	if (rc != CKR_OK) {
		return (rc);
	}

	/*
	 * make sure
	 *    CKA_LOCAL		== FALSE
	 *    CKA_ALWAYS_SENSITIVE  == FALSE
	 *    CKA_EXTRACTABLE	== TRUE
	 *    CKA_NEVER_EXTRACTABLE == FALSE
	 */
	rc = build_attribute(CKA_LOCAL,  &false, 1, &local);
	if (rc != CKR_OK) {
		goto cleanup;
	}
	rc = build_attribute(CKA_ALWAYS_SENSITIVE,  &false, 1, &always_sens);
	if (rc != CKR_OK) {
		goto cleanup;
	}
	rc = build_attribute(CKA_SENSITIVE,	 &false, 1, &sensitive);
	if (rc != CKR_OK) {
		goto cleanup;
	}
	rc = build_attribute(CKA_EXTRACTABLE,	&true,  1, &extractable);
	if (rc != CKR_OK) {
		goto cleanup;
	}
	rc = build_attribute(CKA_NEVER_EXTRACTABLE, &false, 1, &never_extract);
	if (rc != CKR_OK) {
		goto cleanup;
	}
	(void) template_update_attribute(tmpl, local);
	(void) template_update_attribute(tmpl, always_sens);
	(void) template_update_attribute(tmpl, sensitive);
	(void) template_update_attribute(tmpl, extractable);
	(void) template_update_attribute(tmpl, never_extract);

	return (CKR_OK);

	cleanup:

	if (local)	 free(local);
	if (always_sens)   free(always_sens);
	if (extractable)   free(extractable);
	if (never_extract) free(never_extract);

	return (rc);
}

CK_RV
priv_key_validate_attribute(TEMPLATE *tmpl, CK_ATTRIBUTE *attr, CK_ULONG mode) {
	switch (attr->type) {
		case CKA_SUBJECT:
		return (CKR_OK);

		case CKA_DECRYPT:
		case CKA_SIGN:
		case CKA_SIGN_RECOVER:
		case CKA_UNWRAP:
		// we might want to do this for MODE_COPY too
		//
		if (mode == MODE_MODIFY) {
			if (nv_token_data->tweak_vector.allow_key_mods == TRUE)
				return (CKR_OK);
			return (CKR_ATTRIBUTE_READ_ONLY);
		}
		return (CKR_OK);

		// after key creation, CKA_SENSITIVE may only be set to TRUE
		//
		case CKA_SENSITIVE:
		{
			CK_BBOOL value;

			if (mode == MODE_CREATE || mode == MODE_KEYGEN)
				return (CKR_OK);

			value = *(CK_BBOOL *)attr->pValue;
			if (value != TRUE) {
				return (CKR_ATTRIBUTE_READ_ONLY);
			}
		}
		return (CKR_OK);

		case CKA_EXTRACTABLE:
		{
			CK_BBOOL value;

			value = *(CK_BBOOL *)attr->pValue;
			if ((mode != MODE_CREATE && mode != MODE_KEYGEN) &&
			    value != FALSE) {
				return (CKR_ATTRIBUTE_READ_ONLY);
			}
			if (value == FALSE) {
				CK_ATTRIBUTE *attr;

				attr = (CK_ATTRIBUTE *)malloc(
				    sizeof (CK_ATTRIBUTE) + sizeof (CK_BBOOL));
				if (! attr) {
					return (CKR_HOST_MEMORY);
				}
				attr->type	= CKA_NEVER_EXTRACTABLE;
				attr->ulValueLen = sizeof (CK_BBOOL);
				attr->pValue	= (CK_BYTE *)attr +
				    sizeof (CK_ATTRIBUTE);
				*(CK_BBOOL *)attr->pValue = FALSE;

				(void) template_update_attribute(tmpl, attr);
			}
		}
		return (CKR_OK);

		case CKA_ALWAYS_SENSITIVE:
		case CKA_NEVER_EXTRACTABLE:
		return (CKR_ATTRIBUTE_READ_ONLY);

		default:
		return (key_object_validate_attribute(tmpl, attr, mode));
	}
}

CK_RV
secret_key_check_required_attributes(TEMPLATE *tmpl, CK_ULONG mode)
{
	return (key_object_check_required_attributes(tmpl, mode));
}

CK_RV
secret_key_set_default_attributes(TEMPLATE *tmpl, CK_ULONG mode)
{
	CK_ATTRIBUTE	*class_attr	= NULL;
	CK_ATTRIBUTE	*sensitive_attr   = NULL;
	CK_ATTRIBUTE	*encrypt_attr	= NULL;
	CK_ATTRIBUTE	*decrypt_attr	= NULL;
	CK_ATTRIBUTE	*sign_attr	= NULL;
	CK_ATTRIBUTE	*verify_attr	= NULL;
	CK_ATTRIBUTE	*wrap_attr	= NULL;
	CK_ATTRIBUTE	*unwrap_attr	= NULL;
	CK_ATTRIBUTE	*extractable_attr = NULL;
	CK_ATTRIBUTE	*never_extr_attr  = NULL;
	CK_ATTRIBUTE	*always_sens_attr = NULL;
	CK_RV	    rc;


	rc = key_object_set_default_attributes(tmpl, mode);
	if (rc != CKR_OK)
		return (rc);

	class_attr	= (CK_ATTRIBUTE *)malloc(sizeof (CK_ATTRIBUTE) +
	    sizeof (CK_OBJECT_CLASS));
	sensitive_attr   = (CK_ATTRIBUTE *)malloc(sizeof (CK_ATTRIBUTE) +
	    sizeof (CK_BBOOL));
	encrypt_attr	= (CK_ATTRIBUTE *)malloc(sizeof (CK_ATTRIBUTE) +
	    sizeof (CK_BBOOL));
	decrypt_attr	= (CK_ATTRIBUTE *)malloc(sizeof (CK_ATTRIBUTE) +
	    sizeof (CK_BBOOL));
	sign_attr	= (CK_ATTRIBUTE *)malloc(sizeof (CK_ATTRIBUTE) +
	    sizeof (CK_BBOOL));
	verify_attr	= (CK_ATTRIBUTE *)malloc(sizeof (CK_ATTRIBUTE) +
	    sizeof (CK_BBOOL));
	wrap_attr	= (CK_ATTRIBUTE *)malloc(sizeof (CK_ATTRIBUTE) +
	    sizeof (CK_BBOOL));
	unwrap_attr	= (CK_ATTRIBUTE *)malloc(sizeof (CK_ATTRIBUTE) +
	    sizeof (CK_BBOOL));
	extractable_attr = (CK_ATTRIBUTE *)malloc(sizeof (CK_ATTRIBUTE) +
	    sizeof (CK_BBOOL));
	never_extr_attr  = (CK_ATTRIBUTE *)malloc(sizeof (CK_ATTRIBUTE) +
	    sizeof (CK_BBOOL));
	always_sens_attr = (CK_ATTRIBUTE *)malloc(sizeof (CK_ATTRIBUTE) +
	    sizeof (CK_BBOOL));

	if (! class_attr || ! sensitive_attr || ! encrypt_attr ||
	    ! decrypt_attr || ! sign_attr || ! verify_attr ||
	    ! wrap_attr	|| ! unwrap_attr || ! extractable_attr ||
	    ! never_extr_attr || ! always_sens_attr) {
		if (class_attr)	free(class_attr);
		if (sensitive_attr)   free(sensitive_attr);
		if (encrypt_attr)	free(encrypt_attr);
		if (decrypt_attr)	free(decrypt_attr);
		if (sign_attr)	free(sign_attr);
		if (verify_attr)	free(verify_attr);
		if (wrap_attr)	free(wrap_attr);
		if (unwrap_attr)	free(unwrap_attr);
		if (extractable_attr) free(extractable_attr);
		if (never_extr_attr)  free(never_extr_attr);
		if (always_sens_attr) free(always_sens_attr);

		return (CKR_HOST_MEMORY);
	}

	class_attr->type	= CKA_CLASS;
	class_attr->ulValueLen = sizeof (CK_OBJECT_CLASS);
	class_attr->pValue	= (CK_BYTE *)class_attr +
	    sizeof (CK_ATTRIBUTE);
	*(CK_OBJECT_CLASS *)class_attr->pValue = CKO_SECRET_KEY;

	sensitive_attr->type	= CKA_SENSITIVE;
	sensitive_attr->ulValueLen = sizeof (CK_BBOOL);
	sensitive_attr->pValue	= (CK_BYTE *)sensitive_attr +
	    sizeof (CK_ATTRIBUTE);
	*(CK_BBOOL *)sensitive_attr->pValue = FALSE;

	encrypt_attr->type	= CKA_ENCRYPT;
	encrypt_attr->ulValueLen = sizeof (CK_BBOOL);
	encrypt_attr->pValue	= (CK_BYTE *)encrypt_attr +
	    sizeof (CK_ATTRIBUTE);
	*(CK_BBOOL *)encrypt_attr->pValue = TRUE;