| 1 | /** @file
|
|---|
| 2 | * IPRT - Manifest file handling.
|
|---|
| 3 | */
|
|---|
| 4 |
|
|---|
| 5 | /*
|
|---|
| 6 | * Copyright (C) 2009 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 | /** @} */
|
|---|
| 57 |
|
|---|
| 58 |
|
|---|
| 59 | /**
|
|---|
| 60 | * Creates an empty manifest.
|
|---|
| 61 | *
|
|---|
| 62 | * @returns IPRT status code.
|
|---|
| 63 | * @param fFlags Flags, MBZ.
|
|---|
| 64 | * @param phManifest Where to return the handle to the manifest.
|
|---|
| 65 | */
|
|---|
| 66 | RTDECL(int) RTManifestCreate(uint32_t fFlags, PRTMANIFEST phManifest);
|
|---|
| 67 |
|
|---|
| 68 | /**
|
|---|
| 69 | * Retains a reference to the manifest handle.
|
|---|
| 70 | *
|
|---|
| 71 | * @returns The new reference count, UINT32_MAX if the handle is invalid.
|
|---|
| 72 | * @param hManifest The handle to retain.
|
|---|
| 73 | */
|
|---|
| 74 | RTDECL(uint32_t) RTManifestRetain(RTMANIFEST hManifest);
|
|---|
| 75 |
|
|---|
| 76 | /**
|
|---|
| 77 | * Releases a reference to the manifest handle.
|
|---|
| 78 | *
|
|---|
| 79 | * @returns The new reference count, 0 if free. UINT32_MAX is returned if the
|
|---|
| 80 | * handle is invalid.
|
|---|
| 81 | * @param hManifest The handle to release.
|
|---|
| 82 | * NIL is quietly ignored (returns 0).
|
|---|
| 83 | */
|
|---|
| 84 | RTDECL(uint32_t) RTManifestRelease(RTMANIFEST hManifest);
|
|---|
| 85 |
|
|---|
| 86 | /**
|
|---|
| 87 | * Creates a duplicate of the specified manifest.
|
|---|
| 88 | *
|
|---|
| 89 | * @returns IPRT status code
|
|---|
| 90 | * @param hManifestSrc The manifest to clone.
|
|---|
| 91 | * @param phManifestDst Where to store the handle to the duplicate.
|
|---|
| 92 | */
|
|---|
| 93 | RTDECL(int) RTManifestDup(RTMANIFEST hManifestSrc, PRTMANIFEST phManifestDst);
|
|---|
| 94 |
|
|---|
| 95 | /**
|
|---|
| 96 | * Compares two manifests for equality.
|
|---|
| 97 | *
|
|---|
| 98 | * @returns IPRT status code.
|
|---|
| 99 | * @retval VINF_SUCCESS if equal.
|
|---|
| 100 | * @retval VERR_NOT_EQUAL if not equal.
|
|---|
| 101 | *
|
|---|
| 102 | * @param hManifest1 The first manifest.
|
|---|
| 103 | * @param hManifest2 The second manifest.
|
|---|
| 104 | * @param papszIgnoreEntries Entries to ignore. Ends with a NULL entry.
|
|---|
| 105 | * @param papszIgnoreAttrs Attributes to ignore. Ends with a NULL entry.
|
|---|
| 106 | * @param pszEntry Where to store the name of the mismatching
|
|---|
| 107 | * entry, or as much of the name as there is room
|
|---|
| 108 | * for. This is always set. Optional.
|
|---|
| 109 | * @param cbEntry The size of the buffer pointed to by @a
|
|---|
| 110 | * pszEntry.
|
|---|
| 111 | */
|
|---|
| 112 | RTDECL(int) RTManifestEqualsEx(RTMANIFEST hManifest1, RTMANIFEST hManifest2, const char * const *papszIgnoreEntries,
|
|---|
| 113 | const char * const *papszIgnoreAttr, char *pszEntry, size_t cbEntry);
|
|---|
| 114 |
|
|---|
| 115 | /**
|
|---|
| 116 | * Compares two manifests for equality.
|
|---|
| 117 | *
|
|---|
| 118 | * @returns IPRT status code.
|
|---|
| 119 | * @retval VINF_SUCCESS if equal.
|
|---|
| 120 | * @retval VERR_NOT_EQUAL if not equal.
|
|---|
| 121 | *
|
|---|
| 122 | * @param hManifest1 The first manifest.
|
|---|
| 123 | * @param hManifest2 The second manifest.
|
|---|
| 124 | */
|
|---|
| 125 | RTDECL(int) RTManifestEquals(RTMANIFEST hManifest1, RTMANIFEST hManifest2);
|
|---|
| 126 |
|
|---|
| 127 | /**
|
|---|
| 128 | * Sets a manifest attribute.
|
|---|
| 129 | *
|
|---|
| 130 | * @returns IPRT status code.
|
|---|
| 131 | * @param hManifest The manifest handle.
|
|---|
| 132 | * @param pszAttr The attribute name. If this already exists,
|
|---|
| 133 | * its value will be replaced.
|
|---|
| 134 | * @param pszValue The value string.
|
|---|
| 135 | * @param fType The attribute type, pass
|
|---|
| 136 | * RTMANIFEST_ATTR_UNKNOWN if not known.
|
|---|
| 137 | */
|
|---|
| 138 | RTDECL(int) RTManifestSetAttr(RTMANIFEST hManifest, const char *pszAttr, const char *pszValue, uint32_t fType);
|
|---|
| 139 |
|
|---|
| 140 | /**
|
|---|
| 141 | * Unsets (removes) a manifest attribute if it exists.
|
|---|
| 142 | *
|
|---|
| 143 | * @returns IPRT status code.
|
|---|
| 144 | * @retval VWRN_NOT_FOUND if not found.
|
|---|
| 145 | *
|
|---|
| 146 | * @param hManifest The manifest handle.
|
|---|
| 147 | * @param pszAttr The attribute name.
|
|---|
| 148 | */
|
|---|
| 149 | RTDECL(int) RTManifestUnsetAttr(RTMANIFEST hManifest, const char *pszAttr);
|
|---|
| 150 |
|
|---|
| 151 | /**
|
|---|
| 152 | * Sets an attribute of a manifest entry.
|
|---|
| 153 | *
|
|---|
| 154 | * @returns IPRT status code.
|
|---|
| 155 | * @param hManifest The manifest handle.
|
|---|
| 156 | * @param pszEntry The entry name. This will automatically be
|
|---|
| 157 | * added if there was no previous call to
|
|---|
| 158 | * RTManifestEntryAdd for this name. See
|
|---|
| 159 | * RTManifestEntryAdd for the entry name rules.
|
|---|
| 160 | * @param pszAttr The attribute name. If this already exists,
|
|---|
| 161 | * its value will be replaced.
|
|---|
| 162 | * @param pszValue The value string.
|
|---|
| 163 | * @param fType The attribute type, pass
|
|---|
| 164 | * RTMANIFEST_ATTR_UNKNOWN if not known.
|
|---|
| 165 | */
|
|---|
| 166 | RTDECL(int) RTManifestEntrySetAttr(RTMANIFEST hManifest, const char *pszEntry, const char *pszAttr,
|
|---|
| 167 | const char *pszValue, uint32_t fType);
|
|---|
| 168 |
|
|---|
| 169 | /**
|
|---|
| 170 | * Unsets (removes) an attribute of a manifest entry if they both exist.
|
|---|
| 171 | *
|
|---|
| 172 | * @returns IPRT status code.
|
|---|
| 173 | * @retval VWRN_NOT_FOUND if not found.
|
|---|
| 174 | *
|
|---|
| 175 | * @param hManifest The manifest handle.
|
|---|
| 176 | * @param pszEntry The entry name.
|
|---|
| 177 | * @param pszAttr The attribute name.
|
|---|
| 178 | */
|
|---|
| 179 | RTDECL(int) RTManifestEntryUnsetAttr(RTMANIFEST hManifest, const char *pszEntry, const char *pszAttr);
|
|---|
| 180 |
|
|---|
| 181 | /**
|
|---|
| 182 | * Adds a new entry to a manifest.
|
|---|
| 183 | *
|
|---|
| 184 | * The entry name rules:
|
|---|
| 185 | * - The entry name can contain any character defined by unicode, except
|
|---|
| 186 | * control characters, ':', '(' and ')'. The exceptions are mainly there
|
|---|
| 187 | * because of uncertainty around how various formats handles these.
|
|---|
| 188 | * - It is considered case sensitive.
|
|---|
| 189 | * - Forward (unix) and backward (dos) slashes are considered path
|
|---|
| 190 | * separators and converted to forward slashes.
|
|---|
| 191 | *
|
|---|
| 192 | * @returns IPRT status code.
|
|---|
| 193 | * @retval VWRN_ALREADY_EXISTS if the entry already exists.
|
|---|
| 194 | *
|
|---|
| 195 | * @param hManifest The manifest handle.
|
|---|
| 196 | * @param pszEntry The entry name (UTF-8).
|
|---|
| 197 | *
|
|---|
| 198 | * @remarks Some manifest formats will not be able to store an entry without
|
|---|
| 199 | * any attributes. So, this is just here in case it comes in handy
|
|---|
| 200 | * when dealing with formats which can.
|
|---|
| 201 | */
|
|---|
| 202 | RTDECL(int) RTManifestEntryAdd(RTMANIFEST hManifest, const char *pszEntry);
|
|---|
| 203 |
|
|---|
| 204 | /**
|
|---|
| 205 | * Removes an entry.
|
|---|
| 206 | *
|
|---|
| 207 | * @returns IPRT status code.
|
|---|
| 208 | * @param hManifest The manifest handle.
|
|---|
| 209 | * @param pszEntry The entry name.
|
|---|
| 210 | */
|
|---|
| 211 | RTDECL(int) RTManifestEntryRemove(RTMANIFEST hManifest, const char *pszEntry);
|
|---|
| 212 |
|
|---|
| 213 |
|
|---|
| 214 | /**
|
|---|
| 215 | * Adds an entry for a file with the specified set of attributes.
|
|---|
| 216 | *
|
|---|
| 217 | * @returns IPRT status code.
|
|---|
| 218 | *
|
|---|
| 219 | * @param hManifest The manifest handle.
|
|---|
| 220 | * @param hVfsIos The I/O stream handle of the entry. This will
|
|---|
| 221 | * be processed to its end on successful return.
|
|---|
| 222 | * (Must be positioned at the start to get
|
|---|
| 223 | * the expected results.)
|
|---|
| 224 | * @param pszEntry The entry name.
|
|---|
| 225 | * @param fAttrs The attributes to create for this stream. See
|
|---|
| 226 | * RTMANIFEST_ATTR_XXX.
|
|---|
| 227 | */
|
|---|
| 228 | RTDECL(int) RTManifestEntryAddIoStream(RTMANIFEST hManifest, RTVFSIOSTREAM hVfsIos, const char *pszEntry, uint32_t fAttrs);
|
|---|
| 229 |
|
|---|
| 230 | /**
|
|---|
| 231 | * Reads in a "standard" manifest.
|
|---|
| 232 | *
|
|---|
| 233 | * This reads the format used by OVF, the distinfo in FreeBSD ports, and
|
|---|
| 234 | * others.
|
|---|
| 235 | *
|
|---|
| 236 | * @returns IPRT status code.
|
|---|
| 237 | * @param hManifest The handle to the manifest where to add the
|
|---|
| 238 | * manifest that's read in.
|
|---|
| 239 | * @param hVfsIos The I/O stream to read the manifest from.
|
|---|
| 240 | */
|
|---|
| 241 | RTDECL(int) RTManifestReadStandard(RTMANIFEST hManifest, RTVFSIOSTREAM hVfsIos);
|
|---|
| 242 |
|
|---|
| 243 | /**
|
|---|
| 244 | * Writes a "standard" manifest.
|
|---|
| 245 | *
|
|---|
| 246 | * This writes the format used by OVF, the distinfo in FreeBSD ports, and
|
|---|
| 247 | * others.
|
|---|
| 248 | *
|
|---|
| 249 | * @returns IPRT status code.
|
|---|
| 250 | * @param hManifest The handle to the manifest where to add the
|
|---|
| 251 | * manifest that's read in.
|
|---|
| 252 | * @param hVfsIos The I/O stream to read the manifest from.
|
|---|
| 253 | */
|
|---|
| 254 | RTDECL(int) RTManifestWriteStandard(RTMANIFEST hManifest, RTVFSIOSTREAM hVfsIos);
|
|---|
| 255 |
|
|---|
| 256 |
|
|---|
| 257 |
|
|---|
| 258 |
|
|---|
| 259 |
|
|---|
| 260 | /**
|
|---|
| 261 | * Input structure for RTManifestVerify() which contains the filename & the
|
|---|
| 262 | * SHA1 digest.
|
|---|
| 263 | */
|
|---|
| 264 | typedef struct RTMANIFESTTEST
|
|---|
| 265 | {
|
|---|
| 266 | /** The filename. */
|
|---|
| 267 | const char *pszTestFile;
|
|---|
| 268 | /** The SHA1 digest of the file. */
|
|---|
| 269 | const char *pszTestDigest;
|
|---|
| 270 | } RTMANIFESTTEST;
|
|---|
| 271 | /** Pointer to the input structure. */
|
|---|
| 272 | typedef RTMANIFESTTEST* PRTMANIFESTTEST;
|
|---|
| 273 |
|
|---|
| 274 |
|
|---|
| 275 | /**
|
|---|
| 276 | * Verify the given SHA1 digests against the entries in the manifest file.
|
|---|
| 277 | *
|
|---|
| 278 | * Please note that not only the various digest have to match, but the
|
|---|
| 279 | * filenames as well. If there are more or even less files listed in the
|
|---|
| 280 | * manifest file than provided by paTests, VERR_MANIFEST_FILE_MISMATCH will be
|
|---|
| 281 | * returned.
|
|---|
| 282 | *
|
|---|
| 283 | * @returns iprt status code.
|
|---|
| 284 | *
|
|---|
| 285 | * @param pszManifestFile Filename of the manifest file to verify.
|
|---|
| 286 | * @param paTests Array of files & SHA1 sums.
|
|---|
| 287 | * @param cTests Number of entries in paTests.
|
|---|
| 288 | * @param piFailed A index to paTests in the
|
|---|
| 289 | * VERR_MANIFEST_DIGEST_MISMATCH error case
|
|---|
| 290 | * (optional).
|
|---|
| 291 | */
|
|---|
| 292 | RTR3DECL(int) RTManifestVerify(const char *pszManifestFile, PRTMANIFESTTEST paTests, size_t cTests, size_t *piFailed);
|
|---|
| 293 |
|
|---|
| 294 | /**
|
|---|
| 295 | * This is analogous to function RTManifestVerify(), but calculates the SHA1
|
|---|
| 296 | * sums of the given files itself.
|
|---|
| 297 | *
|
|---|
| 298 | * @returns iprt status code.
|
|---|
| 299 | *
|
|---|
| 300 | * @param pszManifestFile Filename of the manifest file to verify.
|
|---|
| 301 | * @param papszFiles Array of files to check SHA1 sums.
|
|---|
| 302 | * @param cFiles Number of entries in papszFiles.
|
|---|
| 303 | * @param piFailed A index to papszFiles in the
|
|---|
| 304 | * VERR_MANIFEST_DIGEST_MISMATCH error case
|
|---|
| 305 | * (optional).
|
|---|
| 306 | * @param pfnProgressCallback optional callback for the progress indication
|
|---|
| 307 | * @param pvUser user defined pointer for the callback
|
|---|
| 308 | */
|
|---|
| 309 | RTR3DECL(int) RTManifestVerifyFiles(const char *pszManifestFile, const char * const *papszFiles, size_t cFiles, size_t *piFailed,
|
|---|
| 310 | PFNRTPROGRESS pfnProgressCallback, void *pvUser);
|
|---|
| 311 |
|
|---|
| 312 | /**
|
|---|
| 313 | * Creates a manifest file for a set of files. The manifest file contains SHA1
|
|---|
| 314 | * sums of every provided file and could be used to verify the data integrity
|
|---|
| 315 | * of them.
|
|---|
| 316 | *
|
|---|
| 317 | * @returns iprt status code.
|
|---|
| 318 | *
|
|---|
| 319 | * @param pszManifestFile Filename of the manifest file to create.
|
|---|
| 320 | * @param papszFiles Array of files to create SHA1 sums for.
|
|---|
| 321 | * @param cFiles Number of entries in papszFiles.
|
|---|
| 322 | * @param pfnProgressCallback optional callback for the progress indication
|
|---|
| 323 | * @param pvUser user defined pointer for the callback
|
|---|
| 324 | */
|
|---|
| 325 | RTR3DECL(int) RTManifestWriteFiles(const char *pszManifestFile, const char * const *papszFiles, size_t cFiles,
|
|---|
| 326 | PFNRTPROGRESS pfnProgressCallback, void *pvUser);
|
|---|
| 327 |
|
|---|
| 328 | /**
|
|---|
| 329 | * Verify the given SHA1 digests against the entries in the manifest file in
|
|---|
| 330 | * memory.
|
|---|
| 331 | *
|
|---|
| 332 | * @returns iprt status code.
|
|---|
| 333 | *
|
|---|
| 334 | * @param pvBuf Pointer to memory buffer of the manifest file.
|
|---|
| 335 | * @param cbSize Size of the memory buffer.
|
|---|
| 336 | * @param paTests Array of file names and digests.
|
|---|
| 337 | * @param cTest Number of entries in paTests.
|
|---|
| 338 | * @param piFailed A index to paTests in the
|
|---|
| 339 | * VERR_MANIFEST_DIGEST_MISMATCH error case
|
|---|
| 340 | * (optional).
|
|---|
| 341 | */
|
|---|
| 342 | RTR3DECL(int) RTManifestVerifyFilesBuf(void *pvBuf, size_t cbSize, PRTMANIFESTTEST paTests, size_t cTests, size_t *piFailed);
|
|---|
| 343 |
|
|---|
| 344 | /**
|
|---|
| 345 | * Creates a manifest file in memory for a set of files. The manifest file
|
|---|
| 346 | * contains SHA1 sums of every provided file and could be used to verify the
|
|---|
| 347 | * data integrity of them.
|
|---|
| 348 | *
|
|---|
| 349 | * @returns iprt status code.
|
|---|
| 350 | *
|
|---|
| 351 | * @param ppvBuf Pointer to resulting memory buffer.
|
|---|
| 352 | * @param pcbSize Pointer for the size of the memory buffer.
|
|---|
| 353 | * @param paFiles Array of file names and digests.
|
|---|
| 354 | * @param cFiles Number of entries in paFiles.
|
|---|
| 355 | */
|
|---|
| 356 | RTR3DECL(int) RTManifestWriteFilesBuf(void **ppvBuf, size_t *pcbSize, PRTMANIFESTTEST paFiles, size_t cFiles);
|
|---|
| 357 |
|
|---|
| 358 | /** @} */
|
|---|
| 359 |
|
|---|
| 360 | RT_C_DECLS_END
|
|---|
| 361 |
|
|---|
| 362 | #endif
|
|---|
| 363 |
|
|---|
