git.oblomov.eu Git - wine/blob - dlls/crypt32/crypt32_private.h

   1 /*
   2  * Copyright 2005 Juan Lang
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2.1 of the License, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the Free Software
  16  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
  17  */
  18
  19 #ifndef __CRYPT32_PRIVATE_H__
  20 #define __CRYPT32_PRIVATE_H__
  21
  22 /* a few asn.1 tags we need */
  23 #define ASN_BOOL            (ASN_UNIVERSAL | ASN_PRIMITIVE | 0x01)
  24 #define ASN_BITSTRING       (ASN_UNIVERSAL | ASN_PRIMITIVE | 0x03)
  25 #define ASN_ENUMERATED      (ASN_UNIVERSAL | ASN_PRIMITIVE | 0x0a)
  26 #define ASN_UTF8STRING      (ASN_UNIVERSAL | ASN_PRIMITIVE | 0x0c)
  27 #define ASN_SETOF           (ASN_UNIVERSAL | ASN_PRIMITIVE | 0x11)
  28 #define ASN_NUMERICSTRING   (ASN_UNIVERSAL | ASN_PRIMITIVE | 0x12)
  29 #define ASN_PRINTABLESTRING (ASN_UNIVERSAL | ASN_PRIMITIVE | 0x13)
  30 #define ASN_T61STRING       (ASN_UNIVERSAL | ASN_PRIMITIVE | 0x14)
  31 #define ASN_VIDEOTEXSTRING  (ASN_UNIVERSAL | ASN_PRIMITIVE | 0x15)
  32 #define ASN_IA5STRING       (ASN_UNIVERSAL | ASN_PRIMITIVE | 0x16)
  33 #define ASN_UTCTIME         (ASN_UNIVERSAL | ASN_PRIMITIVE | 0x17)
  34 #define ASN_GENERALTIME     (ASN_UNIVERSAL | ASN_PRIMITIVE | 0x18)
  35 #define ASN_GRAPHICSTRING   (ASN_UNIVERSAL | ASN_PRIMITIVE | 0x19)
  36 #define ASN_VISIBLESTRING   (ASN_UNIVERSAL | ASN_PRIMITIVE | 0x1a)
  37 #define ASN_GENERALSTRING   (ASN_UNIVERSAL | ASN_PRIMITIVE | 0x1b)
  38 #define ASN_UNIVERSALSTRING (ASN_UNIVERSAL | ASN_PRIMITIVE | 0x1c)
  39 #define ASN_BMPSTRING       (ASN_UNIVERSAL | ASN_PRIMITIVE | 0x1e)
  40
  41 BOOL CRYPT_EncodeLen(DWORD len, BYTE *pbEncoded, DWORD *pcbEncoded);
  42
  43 typedef BOOL (WINAPI *CryptEncodeObjectExFunc)(DWORD, LPCSTR, const void *,
  44  DWORD, PCRYPT_ENCODE_PARA, BYTE *, DWORD *);
  45
  46 struct AsnEncodeSequenceItem
  47 {
  48     const void             *pvStructInfo;
  49     CryptEncodeObjectExFunc encodeFunc;
  50     DWORD                   size; /* used during encoding, not for your use */
  51 };
  52
  53 BOOL WINAPI CRYPT_AsnEncodeSequence(DWORD dwCertEncodingType,
  54  struct AsnEncodeSequenceItem items[], DWORD cItem, DWORD dwFlags,
  55  PCRYPT_ENCODE_PARA pEncodePara, BYTE *pbEncoded, DWORD *pcbEncoded);
  56
  57 struct AsnConstructedItem
  58 {
  59     BYTE                    tag;
  60     const void             *pvStructInfo;
  61     CryptEncodeObjectExFunc encodeFunc;
  62 };
  63
  64 BOOL WINAPI CRYPT_AsnEncodeConstructed(DWORD dwCertEncodingType,
  65  LPCSTR lpszStructType, const void *pvStructInfo, DWORD dwFlags,
  66  PCRYPT_ENCODE_PARA pEncodePara, BYTE *pbEncoded, DWORD *pcbEncoded);
  67 BOOL WINAPI CRYPT_AsnEncodeOid(DWORD dwCertEncodingType,
  68  LPCSTR lpszStructType, const void *pvStructInfo, DWORD dwFlags,
  69  PCRYPT_ENCODE_PARA pEncodePara, BYTE *pbEncoded, DWORD *pcbEncoded);
  70 BOOL WINAPI CRYPT_AsnEncodeOctets(DWORD dwCertEncodingType,
  71  LPCSTR lpszStructType, const void *pvStructInfo, DWORD dwFlags,
  72  PCRYPT_ENCODE_PARA pEncodePara, BYTE *pbEncoded, DWORD *pcbEncoded);
  73
  74 typedef struct _CRYPT_DIGESTED_DATA
  75 {
  76     DWORD                      version;
  77     CRYPT_ALGORITHM_IDENTIFIER DigestAlgorithm;
  78     CRYPT_CONTENT_INFO         ContentInfo;
  79     CRYPT_HASH_BLOB            hash;
  80 } CRYPT_DIGESTED_DATA;
  81
  82 BOOL CRYPT_AsnEncodePKCSDigestedData(CRYPT_DIGESTED_DATA *digestedData,
  83  void *pvData, DWORD *pcbData);
  84
  85 /* Helper function to check *pcbEncoded, set it to the required size, and
  86  * optionally to allocate memory.  Assumes pbEncoded is not NULL.
  87  * If CRYPT_ENCODE_ALLOC_FLAG is set in dwFlags, *pbEncoded will be set to a
  88  * pointer to the newly allocated memory.
  89  */
  90 BOOL CRYPT_EncodeEnsureSpace(DWORD dwFlags, PCRYPT_ENCODE_PARA pEncodePara,
  91  BYTE *pbEncoded, DWORD *pcbEncoded, DWORD bytesNeeded);
  92
  93 BOOL CRYPT_AsnDecodePKCSDigestedData(const BYTE *pbEncoded, DWORD cbEncoded,
  94  DWORD dwFlags, PCRYPT_DECODE_PARA pDecodePara,
  95  CRYPT_DIGESTED_DATA *digestedData, DWORD *pcbDigestedData);
  96
  97 /* The following aren't defined in wincrypt.h, as they're "reserved" */
  98 #define CERT_CERT_PROP_ID 32
  99 #define CERT_CRL_PROP_ID  33
 100 #define CERT_CTL_PROP_ID  34
 101
 102 /* Returns a handle to the default crypto provider; loads it if necessary.
 103  * Returns NULL on failure.
 104  */
 105 HCRYPTPROV CRYPT_GetDefaultProvider(void);
 106
 107 void crypt_oid_init(HINSTANCE hinst);
 108 void crypt_oid_free(void);
 109 void crypt_sip_free(void);
 110
 111 /* Some typedefs that make it easier to abstract which type of context we're
 112  * working with.
 113  */
 114 typedef const void *(WINAPI *CreateContextFunc)(DWORD dwCertEncodingType,
 115  const BYTE *pbCertEncoded, DWORD cbCertEncoded);
 116 typedef BOOL (WINAPI *AddContextToStoreFunc)(HCERTSTORE hCertStore,
 117  const void *context, DWORD dwAddDisposition, const void **ppStoreContext);
 118 typedef BOOL (WINAPI *AddEncodedContextToStoreFunc)(HCERTSTORE hCertStore,
 119  DWORD dwCertEncodingType, const BYTE *pbEncoded, DWORD cbEncoded,
 120  DWORD dwAddDisposition, const void **ppContext);
 121 typedef const void *(WINAPI *DuplicateContextFunc)(const void *context);
 122 typedef const void *(WINAPI *EnumContextsInStoreFunc)(HCERTSTORE hCertStore,
 123  const void *pPrevContext);
 124 typedef DWORD (WINAPI *EnumPropertiesFunc)(const void *context, DWORD dwPropId);
 125 typedef BOOL (WINAPI *GetContextPropertyFunc)(const void *context,
 126  DWORD dwPropID, void *pvData, DWORD *pcbData);
 127 typedef BOOL (WINAPI *SetContextPropertyFunc)(const void *context,
 128  DWORD dwPropID, DWORD dwFlags, const void *pvData);
 129 typedef BOOL (WINAPI *SerializeElementFunc)(const void *context, DWORD dwFlags,
 130  BYTE *pbElement, DWORD *pcbElement);
 131 typedef BOOL (WINAPI *FreeContextFunc)(const void *context);
 132 typedef BOOL (WINAPI *DeleteContextFunc)(const void *context);
 133
 134 /* An abstract context (certificate, CRL, or CTL) interface */
 135 typedef struct _WINE_CONTEXT_INTERFACE
 136 {
 137     CreateContextFunc            create;
 138     AddContextToStoreFunc        addContextToStore;
 139     AddEncodedContextToStoreFunc addEncodedToStore;
 140     DuplicateContextFunc         duplicate;
 141     EnumContextsInStoreFunc      enumContextsInStore;
 142     EnumPropertiesFunc           enumProps;
 143     GetContextPropertyFunc       getProp;
 144     SetContextPropertyFunc       setProp;
 145     SerializeElementFunc         serialize;
 146     FreeContextFunc              free;
 147     DeleteContextFunc            deleteFromStore;
 148 } WINE_CONTEXT_INTERFACE, *PWINE_CONTEXT_INTERFACE;
 149 typedef const WINE_CONTEXT_INTERFACE *PCWINE_CONTEXT_INTERFACE;
 150
 151 extern PCWINE_CONTEXT_INTERFACE pCertInterface;
 152 extern PCWINE_CONTEXT_INTERFACE pCRLInterface;
 153 extern PCWINE_CONTEXT_INTERFACE pCTLInterface;
 154
 155 /* Helper function for store reading functions and
 156  * CertAddSerializedElementToStore.  Returns a context of the appropriate type
 157  * if it can, or NULL otherwise.  Doesn't validate any of the properties in
 158  * the serialized context (for example, bad hashes are retained.)
 159  * *pdwContentType is set to the type of the returned context.
 160  */
 161 const void *CRYPT_ReadSerializedElement(const BYTE *pbElement,
 162  DWORD cbElement, DWORD dwContextTypeFlags, DWORD *pdwContentType);
 163
 164 /* Writes contexts from the memory store to the file. */
 165 BOOL CRYPT_WriteSerializedFile(HANDLE file, HCERTSTORE store);
 166
 167 /* Reads contexts serialized in the file into the memory store.  Returns FALSE
 168  * if the file is not of the expected format.
 169  */
 170 BOOL CRYPT_ReadSerializedFile(HANDLE file, HCERTSTORE store);
 171
 172 /* Fixes up the the pointers in info, where info is assumed to be a
 173  * CRYPT_KEY_PROV_INFO, followed by its container name, provider name, and any
 174  * provider parameters, in a contiguous buffer, but where info's pointers are
 175  * assumed to be invalid.  Upon return, info's pointers point to the
 176  * appropriate memory locations.
 177  */
 178 void CRYPT_FixKeyProvInfoPointers(PCRYPT_KEY_PROV_INFO info);
 179
 180 /**
 181  *  Context functions
 182  */
 183
 184 /* Allocates a new data context, a context which owns properties directly.
 185  * contextSize is the size of the public data type associated with context,
 186  * which should be one of CERT_CONTEXT, CRL_CONTEXT, or CTL_CONTEXT.
 187  * Free with Context_Release.
 188  */
 189 void *Context_CreateDataContext(size_t contextSize);
 190
 191 /* Creates a new link context with extra bytes.  The context refers to linked
 192  * rather than owning its own properties.  If addRef is TRUE (which ordinarily
 193  * it should be) linked is addref'd.
 194  * Free with Context_Release.
 195  */
 196 void *Context_CreateLinkContext(unsigned int contextSize, void *linked, unsigned int extra,
 197  BOOL addRef);
 198
 199 /* Returns a pointer to the extra bytes allocated with context, which must be
 200  * a link context.
 201  */
 202 void *Context_GetExtra(const void *context, size_t contextSize);
 203
 204 /* Gets the context linked to by context, which must be a link context. */
 205 void *Context_GetLinkedContext(void *context, size_t contextSize);
 206
 207 /* Copies properties from fromContext to toContext. */
 208 void Context_CopyProperties(const void *to, const void *from,
 209  size_t contextSize);
 210
 211 struct _CONTEXT_PROPERTY_LIST;
 212 typedef struct _CONTEXT_PROPERTY_LIST *PCONTEXT_PROPERTY_LIST;
 213
 214 /* Returns context's properties, or the linked context's properties if context
 215  * is a link context.
 216  */
 217 PCONTEXT_PROPERTY_LIST Context_GetProperties(void *context, size_t contextSize);
 218
 219 void Context_AddRef(void *context, size_t contextSize);
 220
 221 typedef void (*ContextFreeFunc)(void *context);
 222
 223 /* Decrements context's ref count.  If context is a link context, releases its
 224  * linked context as well.
 225  * If a data context has its ref count reach 0, calls dataContextFree on it.
 226  */
 227 void Context_Release(void *context, size_t contextSize,
 228  ContextFreeFunc dataContextFree);
 229
 230 /**
 231  *  Context property list functions
 232  */
 233
 234 PCONTEXT_PROPERTY_LIST ContextPropertyList_Create(void);
 235
 236 /* Searches for the property with ID id in the context.  Returns TRUE if found,
 237  * and copies the property's length and a pointer to its data to blob.
 238  * Otherwise returns FALSE.
 239  */
 240 BOOL ContextPropertyList_FindProperty(PCONTEXT_PROPERTY_LIST list, DWORD id,
 241  PCRYPT_DATA_BLOB blob);
 242
 243 BOOL ContextPropertyList_SetProperty(PCONTEXT_PROPERTY_LIST list, DWORD id,
 244  const BYTE *pbData, size_t cbData);
 245
 246 void ContextPropertyList_RemoveProperty(PCONTEXT_PROPERTY_LIST list, DWORD id);
 247
 248 DWORD ContextPropertyList_EnumPropIDs(PCONTEXT_PROPERTY_LIST list, DWORD id);
 249
 250 void ContextPropertyList_Copy(PCONTEXT_PROPERTY_LIST to,
 251  PCONTEXT_PROPERTY_LIST from);
 252
 253 void ContextPropertyList_Free(PCONTEXT_PROPERTY_LIST list);
 254
 255 /**
 256  *  Context list functions.  A context list is a simple list of link contexts.
 257  */
 258 struct ContextList;
 259
 260 struct ContextList *ContextList_Create(
 261  PCWINE_CONTEXT_INTERFACE contextInterface, size_t contextSize);
 262
 263 void *ContextList_Add(struct ContextList *list, void *toLink, void *toReplace);
 264
 265 void *ContextList_Enum(struct ContextList *list, void *pPrev);
 266
 267 void ContextList_Delete(struct ContextList *list, void *context);
 268
 269 void ContextList_Empty(struct ContextList *list);
 270
 271 void ContextList_Free(struct ContextList *list);
 272
 273 #endif