VirtualBox

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

Last change on this file since 68716 was 62473, checked in by vboxsync, 8 years ago

(C) 2016

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 21.6 KB
Line 
1/** @file
2 * IPRT - Manifest file handling.
3 */
4
5/*
6 * Copyright (C) 2009-2016 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
32RT_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 */
68RTDECL(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 */
76RTDECL(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 */
86RTDECL(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 */
95RTDECL(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 */
115RTDECL(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 */
139RTDECL(int) RTManifestEquals(RTMANIFEST hManifest1, RTMANIFEST hManifest2);
140
141/**
142 *
143 * @returns IPRT status code.
144 * @param hManifest Handle to the manifest.
145 * @param fEntriesOnly Whether to only gather attribute types from the
146 * entries (@c true), or also include the manifest
147 * attributes (@c false).
148 * @param pfTypes Where to return the attributes.
149 */
150RTDECL(int) RTManifestQueryAllAttrTypes(RTMANIFEST hManifest, bool fEntriesOnly, uint32_t *pfTypes);
151
152/**
153 * Sets a manifest attribute.
154 *
155 * @returns IPRT status code.
156 * @param hManifest The manifest handle.
157 * @param pszAttr The attribute name, if NULL it will be termined from @a
158 * fType gives it. If this already exists, its value will
159 * be replaced.
160 * @param pszValue The value string.
161 * @param fType The attribute type. If not know, pass
162 * RTMANIFEST_ATTR_UNKNOWN with a valid attribute
163 * name string (@a pszAttr).
164 */
165RTDECL(int) RTManifestSetAttr(RTMANIFEST hManifest, const char *pszAttr, const char *pszValue, uint32_t fType);
166
167/**
168 * Unsets (removes) a manifest attribute if it exists.
169 *
170 * @returns IPRT status code.
171 * @retval VWRN_NOT_FOUND if not found.
172 *
173 * @param hManifest The manifest handle.
174 * @param pszAttr The attribute name.
175 */
176RTDECL(int) RTManifestUnsetAttr(RTMANIFEST hManifest, const char *pszAttr);
177
178/**
179 * Query a manifest attribute.
180 *
181 * @returns IPRT status code.
182 * @retval VERR_BUFFER_OVERFLOW if the value buffer is too small. The @a
183 * pszValue buffer will not be modified.
184 * @retval VERR_MANIFEST_ATTR_NOT_FOUND
185 * @retval VERR_MANIFEST_ATTR_TYPE_NOT_FOUND
186 * @retval VERR_MANIFEST_ATTR_TYPE_MISMATCH
187 *
188 * @param hManifest The manifest handle.
189 * @param pszAttr The attribute name. If NULL, it will be
190 * selected by @a fType alone.
191 * @param fType The attribute types the entry should match. Pass
192 * Pass RTMANIFEST_ATTR_ANY match any. If more
193 * than one is given, the first matching one is
194 * returned.
195 * @param pszValue Where to return value.
196 * @param cbValue The size of the buffer @a pszValue points to.
197 * @param pfType Where to return the attribute type value.
198 */
199RTDECL(int) RTManifestQueryAttr(RTMANIFEST hManifest, const char *pszAttr, uint32_t fType,
200 char *pszValue, size_t cbValue, uint32_t *pfType);
201
202/**
203 * Sets an attribute of a manifest entry.
204 *
205 * @returns IPRT status code.
206 * @param hManifest The manifest handle.
207 * @param pszEntry The entry name. This will automatically be
208 * added if there was no previous call to
209 * RTManifestEntryAdd for this name. See
210 * RTManifestEntryAdd for the entry name rules.
211 * @param pszAttr The attribute name, if NULL it will be termined from @a
212 * fType gives it. If this already exists, its value will
213 * be replaced.
214 * @param pszValue The value string.
215 * @param fType The attribute type. If not know, pass
216 * RTMANIFEST_ATTR_UNKNOWN with a valid attribute
217 * name string (@a pszAttr).
218 */
219RTDECL(int) RTManifestEntrySetAttr(RTMANIFEST hManifest, const char *pszEntry, const char *pszAttr,
220 const char *pszValue, uint32_t fType);
221
222/**
223 * Unsets (removes) an attribute of a manifest entry if they both exist.
224 *
225 * @returns IPRT status code.
226 * @retval VWRN_NOT_FOUND if not found.
227 *
228 * @param hManifest The manifest handle.
229 * @param pszEntry The entry name.
230 * @param pszAttr The attribute name.
231 */
232RTDECL(int) RTManifestEntryUnsetAttr(RTMANIFEST hManifest, const char *pszEntry, const char *pszAttr);
233
234/**
235 * Query a manifest entry attribute.
236 *
237 * @returns IPRT status code.
238 * @retval VERR_BUFFER_OVERFLOW if the value buffer is too small. The @a
239 * pszValue buffer will not be modified.
240 * @retval VERR_NOT_FOUND if the entry was not found.
241 * @retval VERR_MANIFEST_ATTR_NOT_FOUND
242 * @retval VERR_MANIFEST_ATTR_TYPE_NOT_FOUND
243 * @retval VERR_MANIFEST_ATTR_TYPE_MISMATCH
244 *
245 * @param hManifest The manifest handle.
246 * @param pszEntry The entry name.
247 * @param pszAttr The attribute name. If NULL, it will be
248 * selected by @a fType alone.
249 * @param fType The attribute types the entry should match. Pass
250 * Pass RTMANIFEST_ATTR_ANY match any. If more
251 * than one is given, the first matching one is
252 * returned.
253 * @param pszValue Where to return value.
254 * @param cbValue The size of the buffer @a pszValue points to.
255 * @param pfType Where to return the attribute type value.
256 */
257RTDECL(int) RTManifestEntryQueryAttr(RTMANIFEST hManifest, const char *pszEntry, const char *pszAttr, uint32_t fType,
258 char *pszValue, size_t cbValue, uint32_t *pfType);
259
260/**
261 * Adds a new entry to a manifest.
262 *
263 * The entry name rules:
264 * - The entry name can contain any character defined by unicode, except
265 * control characters, ':', '(' and ')'. The exceptions are mainly there
266 * because of uncertainty around how various formats handles these.
267 * - It is considered case sensitive.
268 * - Forward (unix) and backward (dos) slashes are considered path
269 * separators and converted to forward slashes.
270 *
271 * @returns IPRT status code.
272 * @retval VWRN_ALREADY_EXISTS if the entry already exists.
273 *
274 * @param hManifest The manifest handle.
275 * @param pszEntry The entry name (UTF-8).
276 *
277 * @remarks Some manifest formats will not be able to store an entry without
278 * any attributes. So, this is just here in case it comes in handy
279 * when dealing with formats which can.
280 */
281RTDECL(int) RTManifestEntryAdd(RTMANIFEST hManifest, const char *pszEntry);
282
283/**
284 * Removes an entry.
285 *
286 * @returns IPRT status code.
287 * @param hManifest The manifest handle.
288 * @param pszEntry The entry name.
289 */
290RTDECL(int) RTManifestEntryRemove(RTMANIFEST hManifest, const char *pszEntry);
291
292/**
293 * Add an entry for an I/O stream using a passthru stream.
294 *
295 * The passthru I/O stream will hash all the data read from or written to the
296 * stream and automatically add an entry to the manifest with the desired
297 * attributes when it is released. Alternatively one can call
298 * RTManifestPtIosAddEntryNow() to have more control over exactly when this
299 * action is performed and which status it yields.
300 *
301 * @returns IPRT status code.
302 * @param hManifest The manifest to add the entry to.
303 * @param hVfsIos The I/O stream to pass thru to/from.
304 * @param pszEntry The entry name.
305 * @param fAttrs The attributes to create for this stream.
306 * @param fReadOrWrite Whether it's a read or write I/O stream.
307 * @param phVfsIosPassthru Where to return the new handle.
308 */
309RTDECL(int) RTManifestEntryAddPassthruIoStream(RTMANIFEST hManifest, RTVFSIOSTREAM hVfsIos, const char *pszEntry,
310 uint32_t fAttrs, bool fReadOrWrite, PRTVFSIOSTREAM phVfsIosPassthru);
311
312/**
313 * Adds the entry to the manifest right now.
314 *
315 * @returns IPRT status code.
316 * @param hVfsPtIos The manifest passthru I/O stream returned by
317 * RTManifestEntryAddPassthruIoStream().
318 */
319RTDECL(int) RTManifestPtIosAddEntryNow(RTVFSIOSTREAM hVfsPtIos);
320
321/**
322 * Checks if the give I/O stream is a manifest passthru instance or not.
323 *
324 * @returns true if it's a manifest passthru I/O stream, false if not.
325 * @param hVfsPtIos Possible the manifest passthru I/O stream handle.
326 */
327RTDECL(bool) RTManifestPtIosIsInstanceOf(RTVFSIOSTREAM hVfsPtIos);
328
329/**
330 * Adds an entry for a file with the specified set of attributes.
331 *
332 * @returns IPRT status code.
333 *
334 * @param hManifest The manifest handle.
335 * @param hVfsIos The I/O stream handle of the entry. This will
336 * be processed to its end on successful return.
337 * (Must be positioned at the start to get
338 * the expected results.)
339 * @param pszEntry The entry name.
340 * @param fAttrs The attributes to create for this stream. See
341 * RTMANIFEST_ATTR_XXX.
342 */
343RTDECL(int) RTManifestEntryAddIoStream(RTMANIFEST hManifest, RTVFSIOSTREAM hVfsIos, const char *pszEntry, uint32_t fAttrs);
344
345/**
346 * Checks if there is a manifest entry by the given name.
347 *
348 * @returns true if there is, false if not or if the handle is invalid.
349 * @param hManifest The manifest handle.
350 * @param pszEntry The entry name.
351 */
352RTDECL(bool) RTManifestEntryExists(RTMANIFEST hManifest, const char *pszEntry);
353
354/**
355 * Reads in a "standard" manifest.
356 *
357 * This reads the format used by OVF, the distinfo in FreeBSD ports, and
358 * others.
359 *
360 * @returns IPRT status code.
361 * @param hManifest The handle to the manifest where to add the
362 * manifest that's read in.
363 * @param hVfsIos The I/O stream to read the manifest from.
364 */
365RTDECL(int) RTManifestReadStandard(RTMANIFEST hManifest, RTVFSIOSTREAM hVfsIos);
366
367/**
368 * Reads in a "standard" manifest.
369 *
370 * This reads the format used by OVF, the distinfo in FreeBSD ports, and
371 * others.
372 *
373 * @returns IPRT status code.
374 * @param hManifest The handle to the manifest where to add the
375 * manifest that's read in.
376 * @param hVfsIos The I/O stream to read the manifest from.
377 * @param pszErr Where to return extended error info on failure.
378 * Optional.
379 * @param cbErr The size of the buffer @a pszErr points to.
380 */
381RTDECL(int) RTManifestReadStandardEx(RTMANIFEST hManifest, RTVFSIOSTREAM hVfsIos, char *pszErr, size_t cbErr);
382
383/**
384 * Reads in a "standard" manifest from the specified file.
385 *
386 * This reads the format used by OVF, the distinfo in FreeBSD ports, and
387 * others.
388 *
389 * @returns IPRT status code.
390 * @param hManifest The handle to the manifest where to add the
391 * manifest that's read in.
392 * @param pszFilename The name of the file to read in.
393 */
394RTDECL(int) RTManifestReadStandardFromFile(RTMANIFEST hManifest, const char *pszFilename);
395
396/**
397 * Writes a "standard" manifest.
398 *
399 * This writes the format used by OVF, the distinfo in FreeBSD ports, and
400 * others.
401 *
402 * @returns IPRT status code.
403 * @param hManifest The handle to the manifest to write.
404 * @param hVfsIos The I/O stream to read the manifest from.
405 */
406RTDECL(int) RTManifestWriteStandard(RTMANIFEST hManifest, RTVFSIOSTREAM hVfsIos);
407
408/**
409 * Writes a "standard" manifest to the specified file.
410 *
411 * @returns IPRT status code.
412 * @param hManifest The handle to the manifest to write.
413 * @param pszFilename The name of the file.
414 */
415RTDECL(int) RTManifestWriteStandardToFile(RTMANIFEST hManifest, const char *pszFilename);
416
417
418
419
420
421/**
422 * Input structure for RTManifestVerify() which contains the filename & the
423 * SHA1/SHA256 digest.
424 */
425typedef struct RTMANIFESTTEST
426{
427 /** The filename. */
428 const char *pszTestFile;
429 /** The SHA1/SHA256 digest of the file. */
430 const char *pszTestDigest;
431} RTMANIFESTTEST;
432/** Pointer to the input structure. */
433typedef RTMANIFESTTEST* PRTMANIFESTTEST;
434
435
436/**
437 * Verify the given SHA1 digests against the entries in the manifest file.
438 *
439 * Please note that not only the various digest have to match, but the
440 * filenames as well. If there are more or even less files listed in the
441 * manifest file than provided by paTests, VERR_MANIFEST_FILE_MISMATCH will be
442 * returned.
443 *
444 * @returns iprt status code.
445 *
446 * @param pszManifestFile Filename of the manifest file to verify.
447 * @param paTests Array of files & SHA1 sums.
448 * @param cTests Number of entries in paTests.
449 * @param piFailed A index to paTests in the
450 * VERR_MANIFEST_DIGEST_MISMATCH error case
451 * (optional).
452 * @deprecated Use the RTMANIFEST based API instead.
453 */
454RTR3DECL(int) RTManifestVerify(const char *pszManifestFile, PRTMANIFESTTEST paTests, size_t cTests, size_t *piFailed);
455
456/**
457 * This is analogous to function RTManifestVerify(), but calculates the SHA1
458 * sums of the given files itself.
459 *
460 * @returns iprt status code.
461 *
462 * @param pszManifestFile Filename of the manifest file to verify.
463 * @param papszFiles Array of files to check SHA1 sums.
464 * @param cFiles Number of entries in papszFiles.
465 * @param piFailed A index to papszFiles in the
466 * VERR_MANIFEST_DIGEST_MISMATCH error case
467 * (optional).
468 * @param pfnProgressCallback optional callback for the progress indication
469 * @param pvUser user defined pointer for the callback
470 * @deprecated Use the RTMANIFEST based API instead.
471 */
472RTR3DECL(int) RTManifestVerifyFiles(const char *pszManifestFile, const char * const *papszFiles, size_t cFiles, size_t *piFailed,
473 PFNRTPROGRESS pfnProgressCallback, void *pvUser);
474
475/**
476 * Creates a manifest file for a set of files. The manifest file contains SHA1
477 * sums of every provided file and could be used to verify the data integrity
478 * of them.
479 *
480 * @returns iprt status code.
481 *
482 * @param pszManifestFile Filename of the manifest file to create.
483 * @param enmDigestType The digest type (RTDIGESTTYPE_*)
484 * @param papszFiles Array of files to create SHA1 sums for.
485 * @param cFiles Number of entries in papszFiles.
486 * @param pfnProgressCallback optional callback for the progress indication
487 * @param pvUser user defined pointer for the callback
488 * @deprecated Use the RTMANIFEST based API instead.
489 */
490RTR3DECL(int) RTManifestWriteFiles(const char *pszManifestFile, RTDIGESTTYPE enmDigestType,
491 const char * const *papszFiles, size_t cFiles,
492 PFNRTPROGRESS pfnProgressCallback, void *pvUser);
493
494/**
495 * Queries the first digest type found in the given manifest.
496 *
497 * @returns iprt status code.
498 *
499 * @param pvBuf Pointer to memory buffer of the manifest file.
500 * @param cbSize Size of the memory buffer.
501 * @param penmDigestType Where to return the first digest type found in
502 * the manifest.
503 * @deprecated Use the RTMANIFEST based API instead.
504 */
505RTR3DECL(int) RTManifestVerifyDigestType(void const *pvBuf, size_t cbSize, RTDIGESTTYPE *penmDigestType);
506
507/**
508 * Verify the given SHA1 digests against the entries in the manifest file in
509 * memory.
510 *
511 * @returns iprt status code.
512 *
513 * @param pvBuf Pointer to memory buffer of the manifest file.
514 * @param cbSize Size of the memory buffer.
515 * @param paTests Array of file names and digests.
516 * @param cTests Number of entries in paTests.
517 * @param piFailed A index to paTests in the
518 * VERR_MANIFEST_DIGEST_MISMATCH error case
519 * (optional).
520 * @deprecated Use the RTMANIFEST based API instead.
521 */
522RTR3DECL(int) RTManifestVerifyFilesBuf(void *pvBuf, size_t cbSize, PRTMANIFESTTEST paTests, size_t cTests, size_t *piFailed);
523
524/**
525 * Creates a manifest file in memory for a set of files. The manifest file
526 * contains SHA1 sums of every provided file and could be used to verify the
527 * data integrity of them.
528 *
529 * @returns iprt status code.
530 *
531 * @param ppvBuf Pointer to resulting memory buffer.
532 * @param pcbSize Pointer for the size of the memory buffer.
533 * @param enmDigestType Which type of digest ("SHA1", "SHA256", ...)
534 * @param paFiles Array of file names and digests.
535 * @param cFiles Number of entries in paFiles.
536 * @deprecated Use the RTMANIFEST based API instead.
537 */
538RTR3DECL(int) RTManifestWriteFilesBuf(void **ppvBuf, size_t *pcbSize, RTDIGESTTYPE enmDigestType, PRTMANIFESTTEST paFiles, size_t cFiles);
539
540/** @} */
541
542RT_C_DECLS_END
543
544#endif
545
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette