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_CMS_SIGNER_INFO rgSignerInfo;
95 } CRYPT_SIGNED_INFO;
96
97 BOOL CRYPT_AsnEncodeCMSSignedInfo(CRYPT_SIGNED_INFO *, void *pvData,
98 DWORD *pcbData);
99
100 BOOL CRYPT_AsnDecodeCMSSignedInfo(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 void root_store_free(void);
130 void default_chain_engine_free(void);
131
132 /* Some typedefs that make it easier to abstract which type of context we're
133 * working with.
134 */
135 typedef const void *(WINAPI *CreateContextFunc)(DWORD dwCertEncodingType,
136 const BYTE *pbCertEncoded, DWORD cbCertEncoded);
137 typedef BOOL (WINAPI *AddContextToStoreFunc)(HCERTSTORE hCertStore,
138 const void *context, DWORD dwAddDisposition, const void **ppStoreContext);
139 typedef BOOL (WINAPI *AddEncodedContextToStoreFunc)(HCERTSTORE hCertStore,
140 DWORD dwCertEncodingType, const BYTE *pbEncoded, DWORD cbEncoded,
141 DWORD dwAddDisposition, const void **ppContext);
142 typedef const void *(WINAPI *DuplicateContextFunc)(const void *context);
143 typedef const void *(WINAPI *EnumContextsInStoreFunc)(HCERTSTORE hCertStore,
144 const void *pPrevContext);
145 typedef DWORD (WINAPI *EnumPropertiesFunc)(const void *context, DWORD dwPropId);
146 typedef BOOL (WINAPI *GetContextPropertyFunc)(const void *context,
147 DWORD dwPropID, void *pvData, DWORD *pcbData);
148 typedef BOOL (WINAPI *SetContextPropertyFunc)(const void *context,
149 DWORD dwPropID, DWORD dwFlags, const void *pvData);
150 typedef BOOL (WINAPI *SerializeElementFunc)(const void *context, DWORD dwFlags,
151 BYTE *pbElement, DWORD *pcbElement);
152 typedef BOOL (WINAPI *FreeContextFunc)(const void *context);
153 typedef BOOL (WINAPI *DeleteContextFunc)(const void *context);
154
155 /* An abstract context (certificate, CRL, or CTL) interface */
156 typedef struct _WINE_CONTEXT_INTERFACE
157 {
158 CreateContextFunc create;
159 AddContextToStoreFunc addContextToStore;
160 AddEncodedContextToStoreFunc addEncodedToStore;
161 DuplicateContextFunc duplicate;
162 EnumContextsInStoreFunc enumContextsInStore;
163 EnumPropertiesFunc enumProps;
164 GetContextPropertyFunc getProp;
165 SetContextPropertyFunc setProp;
166 SerializeElementFunc serialize;
167 FreeContextFunc free;
168 DeleteContextFunc deleteFromStore;
169 } WINE_CONTEXT_INTERFACE, *PWINE_CONTEXT_INTERFACE;
170 typedef const WINE_CONTEXT_INTERFACE *PCWINE_CONTEXT_INTERFACE;
171
172 extern PCWINE_CONTEXT_INTERFACE pCertInterface;
173 extern PCWINE_CONTEXT_INTERFACE pCRLInterface;
174 extern PCWINE_CONTEXT_INTERFACE pCTLInterface;
175
176 /* (Internal) certificate store types and functions */
177 struct WINE_CRYPTCERTSTORE;
178
179 typedef struct WINE_CRYPTCERTSTORE * (*StoreOpenFunc)(HCRYPTPROV hCryptProv,
180 DWORD dwFlags, const void *pvPara);
181
182 /* Called to enumerate the next context in a store. */
183 typedef void * (*EnumFunc)(struct WINE_CRYPTCERTSTORE *store, void *pPrev);
184
185 /* Called to add a context to a store. If toReplace is not NULL,
186 * context replaces toReplace in the store, and access checks should not be
187 * performed. Otherwise context is a new context, and it should only be
188 * added if the store allows it. If ppStoreContext is not NULL, the added
189 * context should be returned in *ppStoreContext.
190 */
191 typedef BOOL (*AddFunc)(struct WINE_CRYPTCERTSTORE *store, void *context,
192 void *toReplace, const void **ppStoreContext);
193
194 typedef BOOL (*DeleteFunc)(struct WINE_CRYPTCERTSTORE *store, void *context);
195
196 typedef struct _CONTEXT_FUNCS
197 {
198 AddFunc addContext;
199 EnumFunc enumContext;
200 DeleteFunc deleteContext;
201 } CONTEXT_FUNCS, *PCONTEXT_FUNCS;
202
203 typedef enum _CertStoreType {
204 StoreTypeMem,
205 StoreTypeCollection,
206 StoreTypeProvider,
207 } CertStoreType;
208
209 struct _CONTEXT_PROPERTY_LIST;
210 typedef struct _CONTEXT_PROPERTY_LIST *PCONTEXT_PROPERTY_LIST;
211
212 #define WINE_CRYPTCERTSTORE_MAGIC 0x74726563
213
214 /* A cert store is polymorphic through the use of function pointers. A type
215 * is still needed to distinguish collection stores from other types.
216 * On the function pointers:
217 * - closeStore is called when the store's ref count becomes 0
218 * - control is optional, but should be implemented by any store that supports
219 * persistence
220 */
221 typedef struct WINE_CRYPTCERTSTORE
222 {
223 DWORD dwMagic;
224 LONG ref;
225 DWORD dwOpenFlags;
226 CertStoreType type;
227 PFN_CERT_STORE_PROV_CLOSE closeStore;
228 CONTEXT_FUNCS certs;
229 CONTEXT_FUNCS crls;
230 CONTEXT_FUNCS ctls;
231 PFN_CERT_STORE_PROV_CONTROL control; /* optional */
232 PCONTEXT_PROPERTY_LIST properties;
233 } WINECRYPT_CERTSTORE, *PWINECRYPT_CERTSTORE;
234
235 void CRYPT_InitStore(WINECRYPT_CERTSTORE *store, DWORD dwFlags,
236 CertStoreType type);
237 void CRYPT_FreeStore(PWINECRYPT_CERTSTORE store);
238 BOOL WINAPI I_CertUpdateStore(HCERTSTORE store1, HCERTSTORE store2, DWORD unk0,
239 DWORD unk1);
240
241 PWINECRYPT_CERTSTORE CRYPT_CollectionOpenStore(HCRYPTPROV hCryptProv,
242 DWORD dwFlags, const void *pvPara);
243 PWINECRYPT_CERTSTORE CRYPT_ProvCreateStore(DWORD dwFlags,
244 PWINECRYPT_CERTSTORE memStore, const CERT_STORE_PROV_INFO *pProvInfo);
245 PWINECRYPT_CERTSTORE CRYPT_ProvOpenStore(LPCSTR lpszStoreProvider,
246 DWORD dwEncodingType, HCRYPTPROV hCryptProv, DWORD dwFlags,
247 const void *pvPara);
248 PWINECRYPT_CERTSTORE CRYPT_RegOpenStore(HCRYPTPROV hCryptProv, DWORD dwFlags,
249 const void *pvPara);
250 PWINECRYPT_CERTSTORE CRYPT_FileOpenStore(HCRYPTPROV hCryptProv, DWORD dwFlags,
251 const void *pvPara);
252 PWINECRYPT_CERTSTORE CRYPT_FileNameOpenStoreA(HCRYPTPROV hCryptProv,
253 DWORD dwFlags, const void *pvPara);
254 PWINECRYPT_CERTSTORE CRYPT_FileNameOpenStoreW(HCRYPTPROV hCryptProv,
255 DWORD dwFlags, const void *pvPara);
256 PWINECRYPT_CERTSTORE CRYPT_RootOpenStore(HCRYPTPROV hCryptProv, DWORD dwFlags);
257
258 /* Allocates and initializes a certificate chain engine, but without creating
259 * the root store. Instead, it uses root, and assumes the caller has done any
260 * checking necessary.
261 */
262 HCERTCHAINENGINE CRYPT_CreateChainEngine(HCERTSTORE root,
263 PCERT_CHAIN_ENGINE_CONFIG pConfig);
264
265 /* Helper function for store reading functions and
266 * CertAddSerializedElementToStore. Returns a context of the appropriate type
267 * if it can, or NULL otherwise. Doesn't validate any of the properties in
268 * the serialized context (for example, bad hashes are retained.)
269 * *pdwContentType is set to the type of the returned context.
270 */
271 const void *CRYPT_ReadSerializedElement(const BYTE *pbElement,
272 DWORD cbElement, DWORD dwContextTypeFlags, DWORD *pdwContentType);
273
274 /* Reads contexts serialized in the file into the memory store. Returns FALSE
275 * if the file is not of the expected format.
276 */
277 BOOL CRYPT_ReadSerializedStoreFromFile(HANDLE file, HCERTSTORE store);
278
279 /* Fixes up the pointers in info, where info is assumed to be a
280 * CRYPT_KEY_PROV_INFO, followed by its container name, provider name, and any
281 * provider parameters, in a contiguous buffer, but where info's pointers are
282 * assumed to be invalid. Upon return, info's pointers point to the
283 * appropriate memory locations.
284 */
285 void CRYPT_FixKeyProvInfoPointers(PCRYPT_KEY_PROV_INFO info);
286
287 /**
288 * Context functions
289 */
290
291 /* Allocates a new data context, a context which owns properties directly.
292 * contextSize is the size of the public data type associated with context,
293 * which should be one of CERT_CONTEXT, CRL_CONTEXT, or CTL_CONTEXT.
294 * Free with Context_Release.
295 */
296 void *Context_CreateDataContext(size_t contextSize);
297
298 /* Creates a new link context with extra bytes. The context refers to linked
299 * rather than owning its own properties. If addRef is TRUE (which ordinarily
300 * it should be) linked is addref'd.
301 * Free with Context_Release.
302 */
303 void *Context_CreateLinkContext(unsigned int contextSize, void *linked, unsigned int extra,
304 BOOL addRef);
305
306 /* Returns a pointer to the extra bytes allocated with context, which must be
307 * a link context.
308 */
309 void *Context_GetExtra(const void *context, size_t contextSize);
310
311 /* Gets the context linked to by context, which must be a link context. */
312 void *Context_GetLinkedContext(void *context, size_t contextSize);
313
314 /* Copies properties from fromContext to toContext. */
315 void Context_CopyProperties(const void *to, const void *from,
316 size_t contextSize);
317
318 /* Returns context's properties, or the linked context's properties if context
319 * is a link context.
320 */
321 PCONTEXT_PROPERTY_LIST Context_GetProperties(const void *context, size_t contextSize);
322
323 void Context_AddRef(void *context, size_t contextSize);
324
325 typedef void (*ContextFreeFunc)(void *context);
326
327 /* Decrements context's ref count. If context is a link context, releases its
328 * linked context as well.
329 * If a data context has its ref count reach 0, calls dataContextFree on it.
330 */
331 void Context_Release(void *context, size_t contextSize,
332 ContextFreeFunc dataContextFree);
333
334 /**
335 * Context property list functions
336 */
337
338 PCONTEXT_PROPERTY_LIST ContextPropertyList_Create(void);
339
340 /* Searches for the property with ID id in the context. Returns TRUE if found,
341 * and copies the property's length and a pointer to its data to blob.
342 * Otherwise returns FALSE.
343 */
344 BOOL ContextPropertyList_FindProperty(PCONTEXT_PROPERTY_LIST list, DWORD id,
345 PCRYPT_DATA_BLOB blob);
346
347 BOOL ContextPropertyList_SetProperty(PCONTEXT_PROPERTY_LIST list, DWORD id,
348 const BYTE *pbData, size_t cbData);
349
350 void ContextPropertyList_RemoveProperty(PCONTEXT_PROPERTY_LIST list, DWORD id);
351
352 DWORD ContextPropertyList_EnumPropIDs(PCONTEXT_PROPERTY_LIST list, DWORD id);
353
354 void ContextPropertyList_Copy(PCONTEXT_PROPERTY_LIST to,
355 PCONTEXT_PROPERTY_LIST from);
356
357 void ContextPropertyList_Free(PCONTEXT_PROPERTY_LIST list);
358
359 /**
360 * Context list functions. A context list is a simple list of link contexts.
361 */
362 struct ContextList;
363
364 struct ContextList *ContextList_Create(
365 PCWINE_CONTEXT_INTERFACE contextInterface, size_t contextSize);
366
367 void *ContextList_Add(struct ContextList *list, void *toLink, void *toReplace);
368
369 void *ContextList_Enum(struct ContextList *list, void *pPrev);
370
371 void ContextList_Delete(struct ContextList *list, void *context);
372
373 void ContextList_Empty(struct ContextList *list);
374
375 void ContextList_Free(struct ContextList *list);
376
377 #endif
378
This page was automatically generated by the
LXR engine.
Visit the LXR main site for more
information.