[apple/security.git] / libsecurity_apple_csp / lib / BinaryKey.h

/*
 * Copyright (c) 2000-2001 Apple Computer, Inc. All Rights Reserved.
 * 
 * The contents of this file constitute Original Code as defined in and are
 * subject to the Apple Public Source License Version 1.2 (the 'License').
 * You may not use this file except in compliance with the License. Please obtain
 * a copy of the License at http://www.apple.com/publicsource and read it before
 * using this file.
 * 
 * This Original Code and all software distributed under the License are
 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS
 * OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES, INCLUDING WITHOUT
 * LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
 * PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. Please see the License for the
 * specific language governing rights and limitations under the License.
 */


//
// BinaryKey.h - CSP-wide BinaryKey base class
//

#ifndef	_H_BINARY_KEY_
#define _H_BINARY_KEY_

#include <Security/cssmtype.h>
#include <security_cdsa_utilities/cssmkey.h>

// opaque key reference type 
typedef CSSM_INTPTR	KeyRef;

class AppleCSPSession;

/* 
 * unique blob type passed to generateKeyBlob() for key digest calculation 
 */
#define CSSM_KEYBLOB_RAW_FORMAT_DIGEST	\
	(CSSM_KEYBLOB_RAW_FORMAT_VENDOR_DEFINED + 0x12345)


// frame for Binary key; all modules (BSAFE, CryptKit) must subclass
// this and add a member whose type is the native raw key object.
// Subclasses must implement constructor, destructor, and generateKeyBlob().
class BinaryKey
{
public:
						BinaryKey() : mKeyRef(0), mDescData(Allocator::standard()) { }
	virtual 			~BinaryKey() { mKeyRef = 0; }

	/* 
	 * Generate raw key blob.
	 * The format argument is an in/out parameter and is optionally used
	 * to request a specific keyblob format for providers which can generate
Commit	Line	Data
b1ab9ed8 A	1	/*
	2	* Copyright (c) 2000-2001 Apple Computer, Inc. All Rights Reserved.
	3	*
	4	* The contents of this file constitute Original Code as defined in and are
	5	* subject to the Apple Public Source License Version 1.2 (the 'License').
	6	* You may not use this file except in compliance with the License. Please obtain
	7	* a copy of the License at http://www.apple.com/publicsource and read it before
	8	* using this file.
	9	*
	10	* This Original Code and all software distributed under the License are
	11	* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS
	12	* OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES, INCLUDING WITHOUT
	13	* LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
	14	* PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. Please see the License for the
	15	* specific language governing rights and limitations under the License.
	16	*/
	17
	18
	19	//
	20	// BinaryKey.h - CSP-wide BinaryKey base class
	21	//
	22
	23	#ifndef _H_BINARY_KEY_
	24	#define _H_BINARY_KEY_
	25
	26	#include <Security/cssmtype.h>
	27	#include <security_cdsa_utilities/cssmkey.h>
	28
	29	// opaque key reference type
	30	typedef CSSM_INTPTR KeyRef;
	31
	32	class AppleCSPSession;
	33
	34	/*
	35	* unique blob type passed to generateKeyBlob() for key digest calculation
	36	*/
	37	#define CSSM_KEYBLOB_RAW_FORMAT_DIGEST \
	38	(CSSM_KEYBLOB_RAW_FORMAT_VENDOR_DEFINED + 0x12345)
	39
	40
	41	// frame for Binary key; all modules (BSAFE, CryptKit) must subclass
	42	// this and add a member whose type is the native raw key object.
	43	// Subclasses must implement constructor, destructor, and generateKeyBlob().
	44	class BinaryKey
	45	{
	46	public:
	47	BinaryKey() : mKeyRef(0), mDescData(Allocator::standard()) { }
	48	virtual ~BinaryKey() { mKeyRef = 0; }
	49
	50	/*
	51	* Generate raw key blob.
	52	* The format argument is an in/out parameter and is optionally used
	53	* to request a specific keyblob format for providers which can generate
	54