manifest.h@ 58802

Last change on this file since 58802 was 57926, checked in by vboxsync, 9 years ago
IPRT: Doxygen clenaups (mostly).
Property svn:eol-style set to `native` Property svn:keywords set to `Author Date Id Revision`
File size: 20.7 KB

Line
1	/** @file
2	* IPRT - Manifest file handling.
3	*/
4
5	/*
6	* Copyright (C) 2009-2015 Oracle Corporation
7	*
8	* This file is part of VirtualBox Open Source Edition (OSE), as
9	* available from http://www.virtualbox.org. This file is free software;
10	* you can redistribute it and/or modify it under the terms of the GNU
11	* General Public License (GPL) as published by the Free Software
12	* Foundation, in version 2 as it comes in the "COPYING" file of the
13	* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
14	* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
15	*
16	* The contents of this file may alternatively be used under the terms
17	* of the Common Development and Distribution License Version 1.0
18	* (CDDL) only, as it comes in the "COPYING.CDDL" file of the
19	* VirtualBox OSE distribution, in which case the provisions of the
20	* CDDL are applicable instead of those of the GPL.
21	*
22	* You may elect to license modified versions of this file under the
23	* terms and conditions of either the GPL or the CDDL or both.
24	*/
25
26	#ifndef ___iprt_manifest_h
27	#define ___iprt_manifest_h
28
29	#include <iprt/cdefs.h>
30	#include <iprt/types.h>
31
32	RT_C_DECLS_BEGIN
33
34	/** @defgroup grp_rt_manifest RTManifest - Manifest file creation and checking
35	* @ingroup grp_rt
36	* @{
37	*/
38
39	/** @name Manifest attribute types.
40	* The types can be ORed together to form a set.
41	* @{ */
42	/** For use with other attributes. Representation unknown. */
43	#define RTMANIFEST_ATTR_UNKNOWN 0
44	/** The size of the content. Represented as a decimal number. */
45	#define RTMANIFEST_ATTR_SIZE RT_BIT_32(0)
46	/** The MD5 of the content. Represented as a hex string. */
47	#define RTMANIFEST_ATTR_MD5 RT_BIT_32(1)
48	/** The SHA-1 of the content. Represented as a hex string. */
49	#define RTMANIFEST_ATTR_SHA1 RT_BIT_32(2)
50	/** The SHA-256 of the content. Represented as a hex string. */
51	#define RTMANIFEST_ATTR_SHA256 RT_BIT_32(3)
52	/** The SHA-512 of the content. Represented as a hex string. */
53	#define RTMANIFEST_ATTR_SHA512 RT_BIT_32(4)
54	/** The end of the valid values. */
55	#define RTMANIFEST_ATTR_END RT_BIT_32(5)
56	/** Wildcard for use in queries. */
57	#define RTMANIFEST_ATTR_ANY UINT32_C(0xffffffff)
58	/** @} */
59
60
61	/**
62	* Creates an empty manifest.
63	*
64	* @returns IPRT status code.
65	* @param fFlags Flags, MBZ.
66	* @param phManifest Where to return the handle to the manifest.
67	*/
68	RTDECL(int) RTManifestCreate(uint32_t fFlags, PRTMANIFEST phManifest);
69
70	/**
71	* Retains a reference to the manifest handle.
72	*
73	* @returns The new reference count, UINT32_MAX if the handle is invalid.
74	* @param hManifest The handle to retain.
75	*/
76	RTDECL(uint32_t) RTManifestRetain(RTMANIFEST hManifest);
77
78	/**
79	* Releases a reference to the manifest handle.
80	*
81	* @returns The new reference count, 0 if free. UINT32_MAX is returned if the
82	* handle is invalid.
83	* @param hManifest The handle to release.
84	* NIL is quietly ignored (returns 0).
85	*/
86	RTDECL(uint32_t) RTManifestRelease(RTMANIFEST hManifest);
87
88	/**
89	* Creates a duplicate of the specified manifest.
90	*
91	* @returns IPRT status code
92	* @param hManifestSrc The manifest to clone.
93	* @param phManifestDst Where to store the handle to the duplicate.
94	*/
95	RTDECL(int) RTManifestDup(RTMANIFEST hManifestSrc, PRTMANIFEST phManifestDst);
96
97	/**
98	* Compares two manifests for equality.
99	*
100	* @returns IPRT status code.
101	* @retval VINF_SUCCESS if equal.
102	* @retval VERR_NOT_EQUAL if not equal.
103	*
104	* @param hManifest1 The first manifest.
105	* @param hManifest2 The second manifest.
106	* @param papszIgnoreEntries Entries to ignore. Ends with a NULL entry.
107	* @param papszIgnoreAttrs Attributes to ignore. Ends with a NULL entry.
108	* @param fFlags A combination of RTMANIFEST_EQUALS_XXX values.
109	* @param pszError Where to store the name of the mismatching
110	* entry, or as much of the name as there is room
111	* for. This is always set. Optional.
112	* @param cbError The size of the buffer pointed to by @a
113	* pszError.
114	*/
115	RTDECL(int) RTManifestEqualsEx(RTMANIFEST hManifest1, RTMANIFEST hManifest2, const char * const *papszIgnoreEntries,
116	const char * const papszIgnoreAttrs, uint32_t fFlags, char pszError, size_t cbError);
117
118	/** @defgroup RTMANIFEST_EQUALS_XXX RTManifestEqualsEx flags
119	* @{ */
120	/** Ignore missing attributes if there is one or more to compare. */
121	#define RTMANIFEST_EQUALS_IGN_MISSING_ATTRS RT_BIT_32(0)
122	/** Ignore attributes missing in the 1st manifest.
123	* @todo implement this */
124	#define RTMANIFEST_EQUALS_IGN_MISSING_ATTRS_1ST RT_BIT_32(1)
125	/** Mask of valid flags. */
126	#define RTMANIFEST_EQUALS_VALID_MASK UINT32_C(0x00000003)
127	/** @} */
128
129	/**
130	* Compares two manifests for equality.
131	*
132	* @returns IPRT status code.
133	* @retval VINF_SUCCESS if equal.
134	* @retval VERR_NOT_EQUAL if not equal.
135	*
136	* @param hManifest1 The first manifest.
137	* @param hManifest2 The second manifest.
138	*/
139	RTDECL(int) RTManifestEquals(RTMANIFEST hManifest1, RTMANIFEST hManifest2);
140
141	/**
142	* Sets a manifest attribute.
143	*
144	* @returns IPRT status code.
145	* @param hManifest The manifest handle.
146	* @param pszAttr The attribute name. If this already exists,
147	* its value will be replaced.
148	* @param pszValue The value string.
149	* @param fType The attribute type, pass
150	* RTMANIFEST_ATTR_UNKNOWN if not known.
151	*/
152	RTDECL(int) RTManifestSetAttr(RTMANIFEST hManifest, const char pszAttr, const char pszValue, uint32_t fType);
153
154	/**
155	* Unsets (removes) a manifest attribute if it exists.
156	*
157	* @returns IPRT status code.
158	* @retval VWRN_NOT_FOUND if not found.
159	*
160	* @param hManifest The manifest handle.
161	* @param pszAttr The attribute name.
162	*/
163	RTDECL(int) RTManifestUnsetAttr(RTMANIFEST hManifest, const char *pszAttr);
164
165	/**
166	* Query a manifest attribute.
167	*
168	* @returns IPRT status code.
169	* @retval VERR_BUFFER_OVERFLOW if the value buffer is too small. The @a
170	* pszValue buffer will not be modified.
171	* @retval VERR_MANIFEST_ATTR_NOT_FOUND
172	* @retval VERR_MANIFEST_ATTR_TYPE_NOT_FOUND
173	* @retval VERR_MANIFEST_ATTR_TYPE_MISMATCH
174	*
175	* @param hManifest The manifest handle.
176	* @param pszAttr The attribute name. If NULL, it will be
177	* selected by @a fType alone.
178	* @param fType The attribute types the entry should match. Pass
179	* Pass RTMANIFEST_ATTR_ANY match any. If more
180	* than one is given, the first matching one is
181	* returned.
182	* @param pszValue Where to return value.
183	* @param cbValue The size of the buffer @a pszValue points to.
184	* @param pfType Where to return the attribute type value.
185	*/
186	RTDECL(int) RTManifestQueryAttr(RTMANIFEST hManifest, const char *pszAttr, uint32_t fType,
187	char pszValue, size_t cbValue, uint32_t pfType);
188
189	/**
190	* Sets an attribute of a manifest entry.
191	*
192	* @returns IPRT status code.
193	* @param hManifest The manifest handle.
194	* @param pszEntry The entry name. This will automatically be
195	* added if there was no previous call to
196	* RTManifestEntryAdd for this name. See
197	* RTManifestEntryAdd for the entry name rules.
198	* @param pszAttr The attribute name. If this already exists,
199	* its value will be replaced.
200	* @param pszValue The value string.
201	* @param fType The attribute type, pass
202	* RTMANIFEST_ATTR_UNKNOWN if not known.
203	*/
204	RTDECL(int) RTManifestEntrySetAttr(RTMANIFEST hManifest, const char pszEntry, const char pszAttr,
205	const char *pszValue, uint32_t fType);
206
207	/**
208	* Unsets (removes) an attribute of a manifest entry if they both exist.
209	*
210	* @returns IPRT status code.
211	* @retval VWRN_NOT_FOUND if not found.
212	*
213	* @param hManifest The manifest handle.
214	* @param pszEntry The entry name.
215	* @param pszAttr The attribute name.
216	*/
217	RTDECL(int) RTManifestEntryUnsetAttr(RTMANIFEST hManifest, const char pszEntry, const char pszAttr);
218
219	/**
220	* Query a manifest entry attribute.
221	*
222	* @returns IPRT status code.
223	* @retval VERR_BUFFER_OVERFLOW if the value buffer is too small. The @a
224	* pszValue buffer will not be modified.
225	* @retval VERR_NOT_FOUND if the entry was not found.
226	* @retval VERR_MANIFEST_ATTR_NOT_FOUND
227	* @retval VERR_MANIFEST_ATTR_TYPE_NOT_FOUND
228	* @retval VERR_MANIFEST_ATTR_TYPE_MISMATCH
229	*
230	* @param hManifest The manifest handle.
231	* @param pszEntry The entry name.
232	* @param pszAttr The attribute name. If NULL, it will be
233	* selected by @a fType alone.
234	* @param fType The attribute types the entry should match. Pass
235	* Pass RTMANIFEST_ATTR_ANY match any. If more
236	* than one is given, the first matching one is
237	* returned.
238	* @param pszValue Where to return value.
239	* @param cbValue The size of the buffer @a pszValue points to.
240	* @param pfType Where to return the attribute type value.
241	*/
242	RTDECL(int) RTManifestEntryQueryAttr(RTMANIFEST hManifest, const char pszEntry, const char pszAttr, uint32_t fType,
243	char pszValue, size_t cbValue, uint32_t pfType);
244
245	/**
246	* Adds a new entry to a manifest.
247	*
248	* The entry name rules:
249	* - The entry name can contain any character defined by unicode, except
250	* control characters, ':', '(' and ')'. The exceptions are mainly there
251	* because of uncertainty around how various formats handles these.
252	* - It is considered case sensitive.
253	* - Forward (unix) and backward (dos) slashes are considered path
254	* separators and converted to forward slashes.
255	*
256	* @returns IPRT status code.
257	* @retval VWRN_ALREADY_EXISTS if the entry already exists.
258	*
259	* @param hManifest The manifest handle.
260	* @param pszEntry The entry name (UTF-8).
261	*
262	* @remarks Some manifest formats will not be able to store an entry without
263	* any attributes. So, this is just here in case it comes in handy
264	* when dealing with formats which can.
265	*/
266	RTDECL(int) RTManifestEntryAdd(RTMANIFEST hManifest, const char *pszEntry);
267
268	/**
269	* Removes an entry.
270	*
271	* @returns IPRT status code.
272	* @param hManifest The manifest handle.
273	* @param pszEntry The entry name.
274	*/
275	RTDECL(int) RTManifestEntryRemove(RTMANIFEST hManifest, const char *pszEntry);
276
277	/**
278	* Add an entry for an I/O stream using a passthru stream.
279	*
280	* The passthru I/O stream will hash all the data read from or written to the
281	* stream and automatically add an entry to the manifest with the desired
282	* attributes when it is released. Alternatively one can call
283	* RTManifestPtIosAddEntryNow() to have more control over exactly when this
284	* action is performed and which status it yields.
285	*
286	* @returns IPRT status code.
287	* @param hManifest The manifest to add the entry to.
288	* @param hVfsIos The I/O stream to pass thru to/from.
289	* @param pszEntry The entry name.
290	* @param fAttrs The attributes to create for this stream.
291	* @param fReadOrWrite Whether it's a read or write I/O stream.
292	* @param phVfsIosPassthru Where to return the new handle.
293	*/
294	RTDECL(int) RTManifestEntryAddPassthruIoStream(RTMANIFEST hManifest, RTVFSIOSTREAM hVfsIos, const char *pszEntry,
295	uint32_t fAttrs, bool fReadOrWrite, PRTVFSIOSTREAM phVfsIosPassthru);
296
297	/**
298	* Adds the entry to the manifest right now.
299	*
300	* @returns IPRT status code.
301	* @param hVfsPtIos The manifest passthru I/O stream returned by
302	* RTManifestEntryAddPassthruIoStream().
303	*/
304	RTDECL(int) RTManifestPtIosAddEntryNow(RTVFSIOSTREAM hVfsPtIos);
305
306	/**
307	* Adds an entry for a file with the specified set of attributes.
308	*
309	* @returns IPRT status code.
310	*
311	* @param hManifest The manifest handle.
312	* @param hVfsIos The I/O stream handle of the entry. This will
313	* be processed to its end on successful return.
314	* (Must be positioned at the start to get
315	* the expected results.)
316	* @param pszEntry The entry name.
317	* @param fAttrs The attributes to create for this stream. See
318	* RTMANIFEST_ATTR_XXX.
319	*/
320	RTDECL(int) RTManifestEntryAddIoStream(RTMANIFEST hManifest, RTVFSIOSTREAM hVfsIos, const char *pszEntry, uint32_t fAttrs);
321
322	/**
323	* Checks if there is a manifest entry by the given name.
324	*
325	* @returns true if there is, false if not or if the handle is invalid.
326	* @param hManifest The manifest handle.
327	* @param pszEntry The entry name.
328	*/
329	RTDECL(bool) RTManifestEntryExists(RTMANIFEST hManifest, const char *pszEntry);
330
331	/**
332	* Reads in a "standard" manifest.
333	*
334	* This reads the format used by OVF, the distinfo in FreeBSD ports, and
335	* others.
336	*
337	* @returns IPRT status code.
338	* @param hManifest The handle to the manifest where to add the
339	* manifest that's read in.
340	* @param hVfsIos The I/O stream to read the manifest from.
341	*/
342	RTDECL(int) RTManifestReadStandard(RTMANIFEST hManifest, RTVFSIOSTREAM hVfsIos);
343
344	/**
345	* Reads in a "standard" manifest.
346	*
347	* This reads the format used by OVF, the distinfo in FreeBSD ports, and
348	* others.
349	*
350	* @returns IPRT status code.
351	* @param hManifest The handle to the manifest where to add the
352	* manifest that's read in.
353	* @param hVfsIos The I/O stream to read the manifest from.
354	* @param pszErr Where to return extended error info on failure.
355	* Optional.
356	* @param cbErr The size of the buffer @a pszErr points to.
357	*/
358	RTDECL(int) RTManifestReadStandardEx(RTMANIFEST hManifest, RTVFSIOSTREAM hVfsIos, char *pszErr, size_t cbErr);
359
360	/**
361	* Reads in a "standard" manifest from the specified file.
362	*
363	* This reads the format used by OVF, the distinfo in FreeBSD ports, and
364	* others.
365	*
366	* @returns IPRT status code.
367	* @param hManifest The handle to the manifest where to add the
368	* manifest that's read in.
369	* @param pszFilename The name of the file to read in.
370	*/
371	RTDECL(int) RTManifestReadStandardFromFile(RTMANIFEST hManifest, const char *pszFilename);
372
373	/**
374	* Writes a "standard" manifest.
375	*
376	* This writes the format used by OVF, the distinfo in FreeBSD ports, and
377	* others.
378	*
379	* @returns IPRT status code.
380	* @param hManifest The handle to the manifest to write.
381	* @param hVfsIos The I/O stream to read the manifest from.
382	*/
383	RTDECL(int) RTManifestWriteStandard(RTMANIFEST hManifest, RTVFSIOSTREAM hVfsIos);
384
385	/**
386	* Writes a "standard" manifest to the specified file.
387	*
388	* @returns IPRT status code.
389	* @param hManifest The handle to the manifest to write.
390	* @param pszFilename The name of the file.
391	*/
392	RTDECL(int) RTManifestWriteStandardToFile(RTMANIFEST hManifest, const char *pszFilename);
393
394
395
396
397
398	/**
399	* Input structure for RTManifestVerify() which contains the filename & the
400	* SHA1/SHA256 digest.
401	*/
402	typedef struct RTMANIFESTTEST
403	{
404	/** The filename. */
405	const char *pszTestFile;
406	/** The SHA1/SHA256 digest of the file. */
407	const char *pszTestDigest;
408	} RTMANIFESTTEST;
409	/** Pointer to the input structure. */
410	typedef RTMANIFESTTEST* PRTMANIFESTTEST;
411
412
413	/**
414	* Verify the given SHA1 digests against the entries in the manifest file.
415	*
416	* Please note that not only the various digest have to match, but the
417	* filenames as well. If there are more or even less files listed in the
418	* manifest file than provided by paTests, VERR_MANIFEST_FILE_MISMATCH will be
419	* returned.
420	*
421	* @returns iprt status code.
422	*
423	* @param pszManifestFile Filename of the manifest file to verify.
424	* @param paTests Array of files & SHA1 sums.
425	* @param cTests Number of entries in paTests.
426	* @param piFailed A index to paTests in the
427	* VERR_MANIFEST_DIGEST_MISMATCH error case
428	* (optional).
429	* @deprecated Use the RTMANIFEST based API instead.
430	*/
431	RTR3DECL(int) RTManifestVerify(const char pszManifestFile, PRTMANIFESTTEST paTests, size_t cTests, size_t piFailed);
432
433	/**
434	* This is analogous to function RTManifestVerify(), but calculates the SHA1
435	* sums of the given files itself.
436	*
437	* @returns iprt status code.
438	*
439	* @param pszManifestFile Filename of the manifest file to verify.
440	* @param papszFiles Array of files to check SHA1 sums.
441	* @param cFiles Number of entries in papszFiles.
442	* @param piFailed A index to papszFiles in the
443	* VERR_MANIFEST_DIGEST_MISMATCH error case
444	* (optional).
445	* @param pfnProgressCallback optional callback for the progress indication
446	* @param pvUser user defined pointer for the callback
447	* @deprecated Use the RTMANIFEST based API instead.
448	*/
449	RTR3DECL(int) RTManifestVerifyFiles(const char pszManifestFile, const char const papszFiles, size_t cFiles, size_t piFailed,
450	PFNRTPROGRESS pfnProgressCallback, void *pvUser);
451
452	/**
453	* Creates a manifest file for a set of files. The manifest file contains SHA1
454	* sums of every provided file and could be used to verify the data integrity
455	* of them.
456	*
457	* @returns iprt status code.
458	*
459	* @param pszManifestFile Filename of the manifest file to create.
460	* @param enmDigestType The digest type (RTDIGESTTYPE_*)
461	* @param papszFiles Array of files to create SHA1 sums for.
462	* @param cFiles Number of entries in papszFiles.
463	* @param pfnProgressCallback optional callback for the progress indication
464	* @param pvUser user defined pointer for the callback
465	* @deprecated Use the RTMANIFEST based API instead.
466	*/
467	RTR3DECL(int) RTManifestWriteFiles(const char *pszManifestFile, RTDIGESTTYPE enmDigestType,
468	const char * const *papszFiles, size_t cFiles,
469	PFNRTPROGRESS pfnProgressCallback, void *pvUser);
470
471	/**
472	* Queries the first digest type found in the given manifest.
473	*
474	* @returns iprt status code.
475	*
476	* @param pvBuf Pointer to memory buffer of the manifest file.
477	* @param cbSize Size of the memory buffer.
478	* @param penmDigestType Where to return the first digest type found in
479	* the manifest.
480	* @deprecated Use the RTMANIFEST based API instead.
481	*/
482	RTR3DECL(int) RTManifestVerifyDigestType(void const pvBuf, size_t cbSize, RTDIGESTTYPE penmDigestType);
483
484	/**
485	* Verify the given SHA1 digests against the entries in the manifest file in
486	* memory.
487	*
488	* @returns iprt status code.
489	*
490	* @param pvBuf Pointer to memory buffer of the manifest file.
491	* @param cbSize Size of the memory buffer.
492	* @param paTests Array of file names and digests.
493	* @param cTests Number of entries in paTests.
494	* @param piFailed A index to paTests in the
495	* VERR_MANIFEST_DIGEST_MISMATCH error case
496	* (optional).
497	* @deprecated Use the RTMANIFEST based API instead.
498	*/
499	RTR3DECL(int) RTManifestVerifyFilesBuf(void pvBuf, size_t cbSize, PRTMANIFESTTEST paTests, size_t cTests, size_t piFailed);
500
501	/**
502	* Creates a manifest file in memory for a set of files. The manifest file
503	* contains SHA1 sums of every provided file and could be used to verify the
504	* data integrity of them.
505	*
506	* @returns iprt status code.
507	*
508	* @param ppvBuf Pointer to resulting memory buffer.
509	* @param pcbSize Pointer for the size of the memory buffer.
510	* @param enmDigestType Which type of digest ("SHA1", "SHA256", ...)
511	* @param paFiles Array of file names and digests.
512	* @param cFiles Number of entries in paFiles.
513	* @deprecated Use the RTMANIFEST based API instead.
514	*/
515	RTR3DECL(int) RTManifestWriteFilesBuf(void *ppvBuf, size_t pcbSize, RTDIGESTTYPE enmDigestType, PRTMANIFESTTEST paFiles, size_t cFiles);
516
517	/** @} */
518
519	RT_C_DECLS_END
520
521	#endif
522

Note: See TracBrowser for help on using the repository browser.

source: vbox/trunk/include/iprt/manifest.h@ 58802

Download in other formats: