dlls/crypt32/crypt32_private.h - wine - Git at Google

 /*
  * Copyright 2005 Juan Lang
  *
  * 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., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  */

 #ifndef __CRYPT32_PRIVATE_H__
 #define __CRYPT32_PRIVATE_H__

 /* a few asn.1 tags we need */
 #define ASN_BOOL            (ASN_UNIVERSAL | ASN_PRIMITIVE | 0x01)
 #define ASN_BITSTRING       (ASN_UNIVERSAL | ASN_PRIMITIVE | 0x03)
 #define ASN_ENUMERATED      (ASN_UNIVERSAL | ASN_PRIMITIVE | 0x0a)
 #define ASN_UTF8STRING      (ASN_UNIVERSAL | ASN_PRIMITIVE | 0x0c)
 #define ASN_SETOF           (ASN_UNIVERSAL | ASN_PRIMITIVE | 0x11)
 #define ASN_NUMERICSTRING   (ASN_UNIVERSAL | ASN_PRIMITIVE | 0x12)
 #define ASN_PRINTABLESTRING (ASN_UNIVERSAL | ASN_PRIMITIVE | 0x13)
 #define ASN_T61STRING       (ASN_UNIVERSAL | ASN_PRIMITIVE | 0x14)
 #define ASN_VIDEOTEXSTRING  (ASN_UNIVERSAL | ASN_PRIMITIVE | 0x15)
 #define ASN_IA5STRING       (ASN_UNIVERSAL | ASN_PRIMITIVE | 0x16)
 #define ASN_UTCTIME         (ASN_UNIVERSAL | ASN_PRIMITIVE | 0x17)
 #define ASN_GENERALTIME     (ASN_UNIVERSAL | ASN_PRIMITIVE | 0x18)
 #define ASN_GRAPHICSTRING   (ASN_UNIVERSAL | ASN_PRIMITIVE | 0x19)
 #define ASN_VISIBLESTRING   (ASN_UNIVERSAL | ASN_PRIMITIVE | 0x1a)
 #define ASN_GENERALSTRING   (ASN_UNIVERSAL | ASN_PRIMITIVE | 0x1b)
 #define ASN_UNIVERSALSTRING (ASN_UNIVERSAL | ASN_PRIMITIVE | 0x1c)
 #define ASN_BMPSTRING       (ASN_UNIVERSAL | ASN_PRIMITIVE | 0x1e)

 /* The following aren't defined in wincrypt.h, as they're "reserved" */
 #define CERT_CERT_PROP_ID 32
 #define CERT_CRL_PROP_ID  33
 #define CERT_CTL_PROP_ID  34

 /* Returns a handle to the default crypto provider; loads it if necessary.
  * Returns NULL on failure.
  */
 HCRYPTPROV CRYPT_GetDefaultProvider(void);

 void crypt_oid_init(HINSTANCE hinst);
 void crypt_oid_free(void);

 /* Some typedefs that make it easier to abstract which type of context we're
  * working with.
  */
 typedef const void *(WINAPI *CreateContextFunc)(DWORD dwCertEncodingType,
  const BYTE *pbCertEncoded, DWORD cbCertEncoded);
 typedef BOOL (WINAPI *AddContextToStoreFunc)(HCERTSTORE hCertStore,
  const void *context, DWORD dwAddDisposition, const void **ppStoreContext);
 typedef BOOL (WINAPI *AddEncodedContextToStoreFunc)(HCERTSTORE hCertStore,
  DWORD dwCertEncodingType, const BYTE *pbEncoded, DWORD cbEncoded,
  DWORD dwAddDisposition, const void **ppContext);
 typedef const void *(WINAPI *DuplicateContextFunc)(const void *context);
 typedef const void *(WINAPI *EnumContextsInStoreFunc)(HCERTSTORE hCertStore,
  const void *pPrevContext);
 typedef DWORD (WINAPI *EnumPropertiesFunc)(const void *context, DWORD dwPropId);
 typedef BOOL (WINAPI *GetContextPropertyFunc)(const void *context,
  DWORD dwPropID, void *pvData, DWORD *pcbData);
 typedef BOOL (WINAPI *SetContextPropertyFunc)(const void *context,
  DWORD dwPropID, DWORD dwFlags, const void *pvData);
 typedef BOOL (WINAPI *SerializeElementFunc)(const void *context, DWORD dwFlags,
  BYTE *pbElement, DWORD *pcbElement);
 typedef BOOL (WINAPI *FreeContextFunc)(const void *context);
 typedef BOOL (WINAPI *DeleteContextFunc)(const void *context);

 /* An abstract context (certificate, CRL, or CTL) interface */
 typedef struct _WINE_CONTEXT_INTERFACE
 {
     CreateContextFunc            create;
     AddContextToStoreFunc        addContextToStore;
     AddEncodedContextToStoreFunc addEncodedToStore;
     DuplicateContextFunc         duplicate;
     EnumContextsInStoreFunc      enumContextsInStore;
     EnumPropertiesFunc           enumProps;
     GetContextPropertyFunc       getProp;
     SetContextPropertyFunc       setProp;
     SerializeElementFunc         serialize;
     FreeContextFunc              free;
     DeleteContextFunc            deleteFromStore;
 } WINE_CONTEXT_INTERFACE, *PWINE_CONTEXT_INTERFACE;
 typedef const WINE_CONTEXT_INTERFACE *PCWINE_CONTEXT_INTERFACE;

 extern PCWINE_CONTEXT_INTERFACE pCertInterface;
 extern PCWINE_CONTEXT_INTERFACE pCRLInterface;
 extern PCWINE_CONTEXT_INTERFACE pCTLInterface;

 /* Helper function for store reading functions and
  * CertAddSerializedElementToStore.  Returns a context of the appropriate type
  * if it can, or NULL otherwise.  Doesn't validate any of the properties in
  * the serialized context (for example, bad hashes are retained.)
  * *pdwContentType is set to the type of the returned context.
  */
 const void *CRYPT_ReadSerializedElement(const BYTE *pbElement,
  DWORD cbElement, DWORD dwContextTypeFlags, DWORD *pdwContentType);

 /* Writes contexts from the memory store to the file. */
 BOOL CRYPT_WriteSerializedFile(HANDLE file, HCERTSTORE store);

 /* Reads contexts serialized in the file into the memory store.  Returns FALSE
  * if the file is not of the expected format.
  */
 BOOL CRYPT_ReadSerializedFile(HANDLE file, HCERTSTORE store);

 /* Fixes up the the pointers in info, where info is assumed to be a
  * CRYPT_KEY_PROV_INFO, followed by its container name, provider name, and any
  * provider parameters, in a contiguous buffer, but where info's pointers are
  * assumed to be invalid.  Upon return, info's pointers point to the
  * appropriate memory locations.
  */
 void CRYPT_FixKeyProvInfoPointers(PCRYPT_KEY_PROV_INFO info);

 /**
  *  Context functions
  */

 /* Allocates a new data context, a context which owns properties directly.
  * contextSize is the size of the public data type associated with context,
  * which should be one of CERT_CONTEXT, CRL_CONTEXT, or CTL_CONTEXT.
  * Free with Context_Release.
  */
 void *Context_CreateDataContext(size_t contextSize);

 /* Creates a new link context with extra bytes.  The context refers to linked
  * rather than owning its own properties.  If addRef is TRUE (which ordinarily
  * it should be) linked is addref'd.
  * Free with Context_Release.
  */
 void *Context_CreateLinkContext(unsigned int contextSize, void *linked, unsigned int extra,
  BOOL addRef);

 /* Returns a pointer to the extra bytes allocated with context, which must be
  * a link context.
  */
 void *Context_GetExtra(const void *context, size_t contextSize);

 /* Gets the context linked to by context, which must be a link context. */
 void *Context_GetLinkedContext(void *context, size_t contextSize);

 /* Copies properties from fromContext to toContext. */
 void Context_CopyProperties(const void *to, const void *from,
  size_t contextSize);

 struct _CONTEXT_PROPERTY_LIST;
 typedef struct _CONTEXT_PROPERTY_LIST *PCONTEXT_PROPERTY_LIST;

 /* Returns context's properties, or the linked context's properties if context
  * is a link context.
  */
 PCONTEXT_PROPERTY_LIST Context_GetProperties(void *context, size_t contextSize);

 void Context_AddRef(void *context, size_t contextSize);

 typedef void (*ContextFreeFunc)(void *context);

 /* Decrements context's ref count.  If context is a link context, releases its
  * linked context as well.
  * If a data context has its ref count reach 0, calls dataContextFree on it.
  */
 void Context_Release(void *context, size_t contextSize,
  ContextFreeFunc dataContextFree);

 /**
  *  Context property list functions
  */

 PCONTEXT_PROPERTY_LIST ContextPropertyList_Create(void);

 /* Searches for the property with ID id in the context.  Returns TRUE if found,
  * and copies the property's length and a pointer to its data to blob.
  * Otherwise returns FALSE.
  */
 BOOL ContextPropertyList_FindProperty(PCONTEXT_PROPERTY_LIST list, DWORD id,
  PCRYPT_DATA_BLOB blob);

 BOOL ContextPropertyList_SetProperty(PCONTEXT_PROPERTY_LIST list, DWORD id,
  const BYTE *pbData, size_t cbData);

 void ContextPropertyList_RemoveProperty(PCONTEXT_PROPERTY_LIST list, DWORD id);

 DWORD ContextPropertyList_EnumPropIDs(PCONTEXT_PROPERTY_LIST list, DWORD id);

 void ContextPropertyList_Copy(PCONTEXT_PROPERTY_LIST to,
  PCONTEXT_PROPERTY_LIST from);

 void ContextPropertyList_Free(PCONTEXT_PROPERTY_LIST list);

 /**
  *  Context list functions.  A context list is a simple list of link contexts.
  */
 struct ContextList;

 struct ContextList *ContextList_Create(
  PCWINE_CONTEXT_INTERFACE contextInterface, size_t contextSize);

 void *ContextList_Add(struct ContextList *list, void *toLink, void *toReplace);

 void *ContextList_Enum(struct ContextList *list, void *pPrev);

 void ContextList_Delete(struct ContextList *list, void *context);

 void ContextList_Empty(struct ContextList *list);

 void ContextList_Free(struct ContextList *list);

 #endif
	/*
	* Copyright 2005 Juan Lang
	*
	* 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., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
	*/

	#ifndef __CRYPT32_PRIVATE_H__
	#define __CRYPT32_PRIVATE_H__

	/* a few asn.1 tags we need */
	#define ASN_BOOL (ASN_UNIVERSAL \| ASN_PRIMITIVE \| 0x01)
	#define ASN_BITSTRING (ASN_UNIVERSAL \| ASN_PRIMITIVE \| 0x03)
	#define ASN_ENUMERATED (ASN_UNIVERSAL \| ASN_PRIMITIVE \| 0x0a)
	#define ASN_UTF8STRING (ASN_UNIVERSAL \| ASN_PRIMITIVE \| 0x0c)
	#define ASN_SETOF (ASN_UNIVERSAL \| ASN_PRIMITIVE \| 0x11)
	#define ASN_NUMERICSTRING (ASN_UNIVERSAL \| ASN_PRIMITIVE \| 0x12)
	#define ASN_PRINTABLESTRING (ASN_UNIVERSAL \| ASN_PRIMITIVE \| 0x13)
	#define ASN_T61STRING (ASN_UNIVERSAL \| ASN_PRIMITIVE \| 0x14)
	#define ASN_VIDEOTEXSTRING (ASN_UNIVERSAL \| ASN_PRIMITIVE \| 0x15)
	#define ASN_IA5STRING (ASN_UNIVERSAL \| ASN_PRIMITIVE \| 0x16)
	#define ASN_UTCTIME (ASN_UNIVERSAL \| ASN_PRIMITIVE \| 0x17)
	#define ASN_GENERALTIME (ASN_UNIVERSAL \| ASN_PRIMITIVE \| 0x18)
	#define ASN_GRAPHICSTRING (ASN_UNIVERSAL \| ASN_PRIMITIVE \| 0x19)
	#define ASN_VISIBLESTRING (ASN_UNIVERSAL \| ASN_PRIMITIVE \| 0x1a)
	#define ASN_GENERALSTRING (ASN_UNIVERSAL \| ASN_PRIMITIVE \| 0x1b)
	#define ASN_UNIVERSALSTRING (ASN_UNIVERSAL \| ASN_PRIMITIVE \| 0x1c)
	#define ASN_BMPSTRING (ASN_UNIVERSAL \| ASN_PRIMITIVE \| 0x1e)

	/* The following aren't defined in wincrypt.h, as they're "reserved" */
	#define CERT_CERT_PROP_ID 32
	#define CERT_CRL_PROP_ID 33
	#define CERT_CTL_PROP_ID 34

	/* Returns a handle to the default crypto provider; loads it if necessary.
	* Returns NULL on failure.
	*/
	HCRYPTPROV CRYPT_GetDefaultProvider(void);

	void crypt_oid_init(HINSTANCE hinst);
	void crypt_oid_free(void);

	/* Some typedefs that make it easier to abstract which type of context we're
	* working with.
	*/
	typedef const void (WINAPI CreateContextFunc)(DWORD dwCertEncodingType,
	const BYTE *pbCertEncoded, DWORD cbCertEncoded);
	typedef BOOL (WINAPI *AddContextToStoreFunc)(HCERTSTORE hCertStore,
	const void context, DWORD dwAddDisposition, const void *ppStoreContext);
	typedef BOOL (WINAPI *AddEncodedContextToStoreFunc)(HCERTSTORE hCertStore,
	DWORD dwCertEncodingType, const BYTE *pbEncoded, DWORD cbEncoded,
	DWORD dwAddDisposition, const void **ppContext);
	typedef const void (WINAPI DuplicateContextFunc)(const void *context);
	typedef const void (WINAPI EnumContextsInStoreFunc)(HCERTSTORE hCertStore,
	const void *pPrevContext);
	typedef DWORD (WINAPI EnumPropertiesFunc)(const void context, DWORD dwPropId);
	typedef BOOL (WINAPI GetContextPropertyFunc)(const void context,
	DWORD dwPropID, void pvData, DWORD pcbData);
	typedef BOOL (WINAPI SetContextPropertyFunc)(const void context,
	DWORD dwPropID, DWORD dwFlags, const void *pvData);
	typedef BOOL (WINAPI SerializeElementFunc)(const void context, DWORD dwFlags,
	BYTE pbElement, DWORD pcbElement);
	typedef BOOL (WINAPI FreeContextFunc)(const void context);
	typedef BOOL (WINAPI DeleteContextFunc)(const void context);

	/* An abstract context (certificate, CRL, or CTL) interface */
	typedef struct _WINE_CONTEXT_INTERFACE
	{
	CreateContextFunc create;
	AddContextToStoreFunc addContextToStore;
	AddEncodedContextToStoreFunc addEncodedToStore;
	DuplicateContextFunc duplicate;
	EnumContextsInStoreFunc enumContextsInStore;
	EnumPropertiesFunc enumProps;
	GetContextPropertyFunc getProp;
	SetContextPropertyFunc setProp;
	SerializeElementFunc serialize;
	FreeContextFunc free;
	DeleteContextFunc deleteFromStore;
	} WINE_CONTEXT_INTERFACE, *PWINE_CONTEXT_INTERFACE;
	typedef const WINE_CONTEXT_INTERFACE *PCWINE_CONTEXT_INTERFACE;

	extern PCWINE_CONTEXT_INTERFACE pCertInterface;
	extern PCWINE_CONTEXT_INTERFACE pCRLInterface;
	extern PCWINE_CONTEXT_INTERFACE pCTLInterface;

	/* Helper function for store reading functions and
	* CertAddSerializedElementToStore. Returns a context of the appropriate type
	* if it can, or NULL otherwise. Doesn't validate any of the properties in
	* the serialized context (for example, bad hashes are retained.)
	* *pdwContentType is set to the type of the returned context.
	*/
	const void CRYPT_ReadSerializedElement(const BYTE pbElement,
	DWORD cbElement, DWORD dwContextTypeFlags, DWORD *pdwContentType);

	/* Writes contexts from the memory store to the file. */
	BOOL CRYPT_WriteSerializedFile(HANDLE file, HCERTSTORE store);

	/* Reads contexts serialized in the file into the memory store. Returns FALSE
	* if the file is not of the expected format.
	*/
	BOOL CRYPT_ReadSerializedFile(HANDLE file, HCERTSTORE store);

	/* Fixes up the the pointers in info, where info is assumed to be a
	* CRYPT_KEY_PROV_INFO, followed by its container name, provider name, and any
	* provider parameters, in a contiguous buffer, but where info's pointers are
	* assumed to be invalid. Upon return, info's pointers point to the
	* appropriate memory locations.
	*/
	void CRYPT_FixKeyProvInfoPointers(PCRYPT_KEY_PROV_INFO info);

	/**
	* Context functions
	*/

	/* Allocates a new data context, a context which owns properties directly.
	* contextSize is the size of the public data type associated with context,
	* which should be one of CERT_CONTEXT, CRL_CONTEXT, or CTL_CONTEXT.
	* Free with Context_Release.
	*/
	void *Context_CreateDataContext(size_t contextSize);

	/* Creates a new link context with extra bytes. The context refers to linked
	* rather than owning its own properties. If addRef is TRUE (which ordinarily
	* it should be) linked is addref'd.
	* Free with Context_Release.
	*/
	void Context_CreateLinkContext(unsigned int contextSize, void linked, unsigned int extra,
	BOOL addRef);

	/* Returns a pointer to the extra bytes allocated with context, which must be
	* a link context.
	*/
	void Context_GetExtra(const void context, size_t contextSize);

	/* Gets the context linked to by context, which must be a link context. */
	void Context_GetLinkedContext(void context, size_t contextSize);

	/* Copies properties from fromContext to toContext. */
	void Context_CopyProperties(const void to, const void from,
	size_t contextSize);

	struct _CONTEXT_PROPERTY_LIST;
	typedef struct _CONTEXT_PROPERTY_LIST *PCONTEXT_PROPERTY_LIST;

	/* Returns context's properties, or the linked context's properties if context
	* is a link context.
	*/
	PCONTEXT_PROPERTY_LIST Context_GetProperties(void *context, size_t contextSize);

	void Context_AddRef(void *context, size_t contextSize);

	typedef void (ContextFreeFunc)(void context);

	/* Decrements context's ref count. If context is a link context, releases its
	* linked context as well.
	* If a data context has its ref count reach 0, calls dataContextFree on it.
	*/
	void Context_Release(void *context, size_t contextSize,
	ContextFreeFunc dataContextFree);

	/**
	* Context property list functions
	*/

	PCONTEXT_PROPERTY_LIST ContextPropertyList_Create(void);

	/* Searches for the property with ID id in the context. Returns TRUE if found,
	* and copies the property's length and a pointer to its data to blob.
	* Otherwise returns FALSE.
	*/
	BOOL ContextPropertyList_FindProperty(PCONTEXT_PROPERTY_LIST list, DWORD id,
	PCRYPT_DATA_BLOB blob);

	BOOL ContextPropertyList_SetProperty(PCONTEXT_PROPERTY_LIST list, DWORD id,
	const BYTE *pbData, size_t cbData);

	void ContextPropertyList_RemoveProperty(PCONTEXT_PROPERTY_LIST list, DWORD id);

	DWORD ContextPropertyList_EnumPropIDs(PCONTEXT_PROPERTY_LIST list, DWORD id);

	void ContextPropertyList_Copy(PCONTEXT_PROPERTY_LIST to,
	PCONTEXT_PROPERTY_LIST from);

	void ContextPropertyList_Free(PCONTEXT_PROPERTY_LIST list);

	/**
	* Context list functions. A context list is a simple list of link contexts.
	*/
	struct ContextList;

	struct ContextList *ContextList_Create(
	PCWINE_CONTEXT_INTERFACE contextInterface, size_t contextSize);

	void ContextList_Add(struct ContextList list, void toLink, void toReplace);

	void ContextList_Enum(struct ContextList list, void *pPrev);

	void ContextList_Delete(struct ContextList list, void context);

	void ContextList_Empty(struct ContextList *list);

	void ContextList_Free(struct ContextList *list);

	#endif