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 typedef struct _CRYPT_SIGNED_INFO
  86 {
  87     DWORD              version;
  88     DWORD              cCertEncoded;
  89     PCERT_BLOB         rgCertEncoded;
  90     DWORD              cCrlEncoded;
  91     PCRL_BLOB          rgCrlEncoded;
  92     CRYPT_CONTENT_INFO content;
  93     DWORD              cSignerInfo;
  94     PCMSG_SIGNER_INFO  rgSignerInfo;
  95 } CRYPT_SIGNED_INFO;
  96
  97 BOOL CRYPT_AsnEncodePKCSSignedInfo(CRYPT_SIGNED_INFO *, void *pvData,
  98  DWORD *pcbData);
  99
 100 BOOL CRYPT_AsnDecodePKCSSignedInfo(const BYTE *pbEncoded, DWORD cbEncoded,
 101  DWORD dwFlags, PCRYPT_DECODE_PARA pDecodePara,
 102  CRYPT_SIGNED_INFO *signedInfo, DWORD *pcbSignedInfo);
 103
 104 /* Helper function to check *pcbEncoded, set it to the required size, and
 105  * optionally to allocate memory.  Assumes pbEncoded is not NULL.
 106  * If CRYPT_ENCODE_ALLOC_FLAG is set in dwFlags, *pbEncoded will be set to a
 107  * pointer to the newly allocated memory.
 108  */
 109 BOOL CRYPT_EncodeEnsureSpace(DWORD dwFlags, PCRYPT_ENCODE_PARA pEncodePara,
 110  BYTE *pbEncoded, DWORD *pcbEncoded, DWORD bytesNeeded);
 111
 112 BOOL CRYPT_AsnDecodePKCSDigestedData(const BYTE *pbEncoded, DWORD cbEncoded,
 113  DWORD dwFlags, PCRYPT_DECODE_PARA pDecodePara,
 114  CRYPT_DIGESTED_DATA *digestedData, DWORD *pcbDigestedData);
 115
 116 /* The following aren't defined in wincrypt.h, as they're "reserved" */
 117 #define CERT_CERT_PROP_ID 32
 118 #define CERT_CRL_PROP_ID  33
 119 #define CERT_CTL_PROP_ID  34
 120
 121 /* Returns a handle to the default crypto provider; loads it if necessary.
 122  * Returns NULL on failure.
 123  */
 124 HCRYPTPROV CRYPT_GetDefaultProvider(void);
 125
 126 void crypt_oid_init(HINSTANCE hinst);
 127 void crypt_oid_free(void);
 128 void crypt_sip_free(void);
 129
 130 /* Some typedefs that make it easier to abstract which type of context we're
 131  * working with.
 132  */
 133 typedef const void *(WINAPI *CreateContextFunc)(DWORD dwCertEncodingType,
 134  const BYTE *pbCertEncoded, DWORD cbCertEncoded);
 135 typedef BOOL (WINAPI *AddContextToStoreFunc)(HCERTSTORE hCertStore,
 136  const void *context, DWORD dwAddDisposition, const void **ppStoreContext);
 137 typedef BOOL (WINAPI *AddEncodedContextToStoreFunc)(HCERTSTORE hCertStore,
 138  DWORD dwCertEncodingType, const BYTE *pbEncoded, DWORD cbEncoded,
 139  DWORD dwAddDisposition, const void **ppContext);
 140 typedef const void *(WINAPI *DuplicateContextFunc)(const void *context);
 141 typedef const void *(WINAPI *EnumContextsInStoreFunc)(HCERTSTORE hCertStore,
 142  const void *pPrevContext);
 143 typedef DWORD (WINAPI *EnumPropertiesFunc)(const void *context, DWORD dwPropId);
 144 typedef BOOL (WINAPI *GetContextPropertyFunc)(const void *context,
 145  DWORD dwPropID, void *pvData, DWORD *pcbData);
 146 typedef BOOL (WINAPI *SetContextPropertyFunc)(const void *context,
 147  DWORD dwPropID, DWORD dwFlags, const void *pvData);
 148 typedef BOOL (WINAPI *SerializeElementFunc)(const void *context, DWORD dwFlags,
 149  BYTE *pbElement, DWORD *pcbElement);
 150 typedef BOOL (WINAPI *FreeContextFunc)(const void *context);
 151 typedef BOOL (WINAPI *DeleteContextFunc)(const void *context);
 152
 153 /* An abstract context (certificate, CRL, or CTL) interface */
 154 typedef struct _WINE_CONTEXT_INTERFACE
 155 {
 156     CreateContextFunc            create;
 157     AddContextToStoreFunc        addContextToStore;
 158     AddEncodedContextToStoreFunc addEncodedToStore;
 159     DuplicateContextFunc         duplicate;
 160     EnumContextsInStoreFunc      enumContextsInStore;
 161     EnumPropertiesFunc           enumProps;
 162     GetContextPropertyFunc       getProp;
 163     SetContextPropertyFunc       setProp;
 164     SerializeElementFunc         serialize;
 165     FreeContextFunc              free;
 166     DeleteContextFunc            deleteFromStore;
 167 } WINE_CONTEXT_INTERFACE, *PWINE_CONTEXT_INTERFACE;
 168 typedef const WINE_CONTEXT_INTERFACE *PCWINE_CONTEXT_INTERFACE;
 169
 170 extern PCWINE_CONTEXT_INTERFACE pCertInterface;
 171 extern PCWINE_CONTEXT_INTERFACE pCRLInterface;
 172 extern PCWINE_CONTEXT_INTERFACE pCTLInterface;
 173
 174 /* Helper function for store reading functions and
 175  * CertAddSerializedElementToStore.  Returns a context of the appropriate type
 176  * if it can, or NULL otherwise.  Doesn't validate any of the properties in
 177  * the serialized context (for example, bad hashes are retained.)
 178  * *pdwContentType is set to the type of the returned context.
 179  */
 180 const void *CRYPT_ReadSerializedElement(const BYTE *pbElement,
 181  DWORD cbElement, DWORD dwContextTypeFlags, DWORD *pdwContentType);
 182
 183 /* Writes contexts from the memory store to the file. */
 184 BOOL CRYPT_WriteSerializedFile(HANDLE file, HCERTSTORE store);
 185
 186 /* Reads contexts serialized in the file into the memory store.  Returns FALSE
 187  * if the file is not of the expected format.
 188  */
 189 BOOL CRYPT_ReadSerializedFile(HANDLE file, HCERTSTORE store);
 190
 191 /* Fixes up the the pointers in info, where info is assumed to be a
 192  * CRYPT_KEY_PROV_INFO, followed by its container name, provider name, and any
 193  * provider parameters, in a contiguous buffer, but where info's pointers are
 194  * assumed to be invalid.  Upon return, info's pointers point to the
 195  * appropriate memory locations.
 196  */
 197 void CRYPT_FixKeyProvInfoPointers(PCRYPT_KEY_PROV_INFO info);
 198
 199 /**
 200  *  Context functions
 201  */
 202
 203 /* Allocates a new data context, a context which owns properties directly.
 204  * contextSize is the size of the public data type associated with context,
 205  * which should be one of CERT_CONTEXT, CRL_CONTEXT, or CTL_CONTEXT.
 206  * Free with Context_Release.
 207  */
 208 void *Context_CreateDataContext(size_t contextSize);
 209
 210 /* Creates a new link context with extra bytes.  The context refers to linked
 211  * rather than owning its own properties.  If addRef is TRUE (which ordinarily
 212  * it should be) linked is addref'd.
 213  * Free with Context_Release.
 214  */
 215 void *Context_CreateLinkContext(unsigned int contextSize, void *linked, unsigned int extra,
 216  BOOL addRef);
 217
 218 /* Returns a pointer to the extra bytes allocated with context, which must be
 219  * a link context.
 220  */
 221 void *Context_GetExtra(const void *context, size_t contextSize);
 222
 223 /* Gets the context linked to by context, which must be a link context. */
 224 void *Context_GetLinkedContext(void *context, size_t contextSize);
 225
 226 /* Copies properties from fromContext to toContext. */
 227 void Context_CopyProperties(const void *to, const void *from,
 228  size_t contextSize);
 229
 230 struct _CONTEXT_PROPERTY_LIST;
 231 typedef struct _CONTEXT_PROPERTY_LIST *PCONTEXT_PROPERTY_LIST;
 232
 233 /* Returns context's properties, or the linked context's properties if context
 234  * is a link context.
 235  */
 236 PCONTEXT_PROPERTY_LIST Context_GetProperties(void *context, size_t contextSize);
 237
 238 void Context_AddRef(void *context, size_t contextSize);
 239
 240 typedef void (*ContextFreeFunc)(void *context);
 241
 242 /* Decrements context's ref count.  If context is a link context, releases its
 243  * linked context as well.
 244  * If a data context has its ref count reach 0, calls dataContextFree on it.
 245  */
 246 void Context_Release(void *context, size_t contextSize,
 247  ContextFreeFunc dataContextFree);
 248
 249 /**
 250  *  Context property list functions
 251  */
 252
 253 PCONTEXT_PROPERTY_LIST ContextPropertyList_Create(void);
 254
 255 /* Searches for the property with ID id in the context.  Returns TRUE if found,
 256  * and copies the property's length and a pointer to its data to blob.
 257  * Otherwise returns FALSE.
 258  */
 259 BOOL ContextPropertyList_FindProperty(PCONTEXT_PROPERTY_LIST list, DWORD id,
 260  PCRYPT_DATA_BLOB blob);
 261
 262 BOOL ContextPropertyList_SetProperty(PCONTEXT_PROPERTY_LIST list, DWORD id,
 263  const BYTE *pbData, size_t cbData);
 264
 265 void ContextPropertyList_RemoveProperty(PCONTEXT_PROPERTY_LIST list, DWORD id);
 266
 267 DWORD ContextPropertyList_EnumPropIDs(PCONTEXT_PROPERTY_LIST list, DWORD id);
 268
 269 void ContextPropertyList_Copy(PCONTEXT_PROPERTY_LIST to,
 270  PCONTEXT_PROPERTY_LIST from);
 271
 272 void ContextPropertyList_Free(PCONTEXT_PROPERTY_LIST list);
 273
 274 /**
 275  *  Context list functions.  A context list is a simple list of link contexts.
 276  */
 277 struct ContextList;
 278
 279 struct ContextList *ContextList_Create(
 280  PCWINE_CONTEXT_INTERFACE contextInterface, size_t contextSize);
 281
 282 void *ContextList_Add(struct ContextList *list, void *toLink, void *toReplace);
 283
 284 void *ContextList_Enum(struct ContextList *list, void *pPrev);
 285
 286 void ContextList_Delete(struct ContextList *list, void *context);
 287
 288 void ContextList_Empty(struct ContextList *list);
 289
 290 void ContextList_Free(struct ContextList *list);
 291
 292 #endif