X-Git-Url: https://git.saurik.com/apple/security.git/blobdiff_plain/5dd5f9ec28f304ca377c42fd7f711d6cf12b90e1..5c19dc3ae3bd8e40a9c028b0deddd50ff337692c:/OSX/libsecurity_apple_csp/lib/AppleCSPKeys.h

diff --git a/OSX/libsecurity_apple_csp/lib/AppleCSPKeys.h b/OSX/libsecurity_apple_csp/lib/AppleCSPKeys.h
new file mode 100644
index 00000000..e06dbe86
--- /dev/null
+++ b/OSX/libsecurity_apple_csp/lib/AppleCSPKeys.h
@@ -0,0 +1,118 @@
+/*
+ * Copyright (c) 2003,2011,2014 Apple 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.
+ */
+/*
+ * AppleCSPKeys.h - Key support
+ */
+ 
+#ifndef	_APPLE_CSP_KEYS_H_
+#define _APPLE_CSP_KEYS_H_
+
+#include "AppleCSPSession.h"
+
+/*
+ * Class to provide key-specific info. Each module dealing with keys
+ * implements one of these. It's sort of like a CSP-specific CSPContext
+ * without the Context object. AppleCSPSession finds one of these by
+ * querying module-specific subclasses, looking for one in which 
+ * the constructor succeeds (which occurs when the specified key 
+ * meets a subclass's specification). 
+ */
+class CSPKeyInfoProvider 
+{
+protected:
+	CSPKeyInfoProvider(
+		const CssmKey 	&cssmKey,
+		AppleCSPSession &session) : 
+			mKey(cssmKey),
+			mSession(session) { }
+public:
+	/* 
+	 * This is the public way to construct - returns NULL if key is 
+	 * not handled. Static declaration per subclass.
+	 *
+	 * static CSPKeyInfoProvider *provider(
+	 *	const CssmKey  &cssmKey,
+	 *  AppleCSPSession	&session);
+	 */	 
+	virtual ~CSPKeyInfoProvider() { }
+	
+	/* 
+	 * Cook up a Binary key. 
+	 *
+	 * Incoming paramKey optionally contains a key from which 
+	 * additional algorithm parameters may be obtained to create
+	 * a fully specified key in case the key provided to our
+	 * constructor was a partial key. 
+	 *
+	 * The attrFlags argument is a means for the info provider to 
+	 * inform the caller that the incoming key has additional
+	 * attributes, currently CSSM_KEYATTR_PARTIAL. The provider
+	 * ORs in bits as appropriate. 
+	 */
+	virtual void CssmKeyToBinary(
+		CssmKey				*paramKey,		// optional
+		CSSM_KEYATTR_FLAGS	&attrFlags,		// IN/OUT
+		BinaryKey			**binKey) = 0;	// RETURNED
+		
+	/* obtain key size in bits */
+	virtual void QueryKeySizeInBits(
+		CSSM_KEY_SIZE		&keySize) = 0;	// RETURNED
+		
+	/* 
+	 * Get blob appropriate for calculating key digest, if possible
+	 * to do without generating a BinaryKey. Returns true if
+	 * successful, falseif BinaryKey generation is required.
+	 */
+	virtual bool getHashableBlob(
+		Allocator 	&allocator,
+		CssmData		&hashBlob) = 0;	// blob to hash goes here
+
+protected:
+	const CssmKey			&mKey;
+	AppleCSPSession			&mSession;
+};
+
+/*
+ * CSPKeyInfoProvider for symmetric keys (handled directly by
+ * the session). 
+ */
+class SymmetricKeyInfoProvider : public CSPKeyInfoProvider 
+{
+private:
+	SymmetricKeyInfoProvider(
+		const CssmKey		&cssmKey,
+		AppleCSPSession		&session);
+public:
+	static CSPKeyInfoProvider *provider(
+		const CssmKey 		&cssmKey,
+		AppleCSPSession		&session);
+		
+	~SymmetricKeyInfoProvider() { }
+	void CssmKeyToBinary(
+		CssmKey				*paramKey,	// ignored
+		CSSM_KEYATTR_FLAGS	&attrFlags,	// IN/OUT
+		BinaryKey			**binKey);	// RETURNED
+	void QueryKeySizeInBits(
+		CSSM_KEY_SIZE		&keySize);	// RETURNED
+	bool getHashableBlob(
+		Allocator 		&allocator,
+		CssmData			&hashBlob);
+};
+
+#endif	/* _APPLE_CSP_KEYS_H_ */
+