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