Changeset 34381 in vbox

Timestamp:

Nov 25, 2010 3:49:11 PM (14 years ago)

Author:

vboxsync

Message:

manifest stuff.

Location:

trunk

Files:

• include/iprt/manifest.h (modified) (1 diff)
• include/iprt/types.h (modified) (1 diff)
• src/VBox/Main/VBoxExtPackHelperApp.cpp (modified) (11 diffs)
• src/VBox/Runtime/Makefile.kmk (modified) (1 diff)
• src/VBox/Runtime/common/checksum/manifest-file.cpp (added)
• src/VBox/Runtime/common/checksum/manifest2.cpp (added)
• src/VBox/Runtime/common/checksum/manifest3.cpp (added)

trunk/include/iprt/manifest.h

@@ -36 +36 @@
  * @{
  */
+
+/** @name Manifest attribute types.
+ * The types can be ORed together to form a set.
+ * @{ */
+/** For use with other attributes. Representation unknown. */
+#define RTMANIFEST_ATTR_UNKNOWN     0
+/** The size of the content.    Represented as a decimal number. */
+#define RTMANIFEST_ATTR_SIZE        RT_BIT_32(0)
+/** The MD5 of the content.     Represented as a hex string. */
+#define RTMANIFEST_ATTR_MD5         RT_BIT_32(1)
+/** The SHA-1 of the content.   Represented as a hex string. */
+#define RTMANIFEST_ATTR_SHA1        RT_BIT_32(2)
+/** The SHA-256 of the content. Represented as a hex string. */
+#define RTMANIFEST_ATTR_SHA256      RT_BIT_32(3)
+/** The SHA-512 of the content. Represented as a hex string. */
+#define RTMANIFEST_ATTR_SHA512      RT_BIT_32(4)
+/** The end of the valid values. */
+#define RTMANIFEST_ATTR_END         RT_BIT_32(5)
+/** @} */
+
+
+/**
+ * Creates an empty manifest.
+ *
+ * @returns IPRT status code.
+ * @param   fFlags              Flags, MBZ.
+ * @param   phManifest          Where to return the handle to the manifest.
+ */
+RTDECL(int) RTManifestCreate(uint32_t fFlags, PRTMANIFEST phManifest);
+
+/**
+ * Retains a reference to the manifest handle.
+ *
+ * @returns The new reference count, UINT32_MAX if the handle is invalid.
+ * @param   hManifest           The handle to retain.
+ */
+RTDECL(uint32_t) RTManifestRetain(RTMANIFEST hManifest);
+
+/**
+ * Releases a reference to the manifest handle.
+ *
+ * @returns The new reference count, 0 if free. UINT32_MAX is returned if the
+ *          handle is invalid.
+ * @param   hManifest           The handle to release.
+ *                              NIL is quietly ignored (returns 0).
+ */
+RTDECL(uint32_t) RTManifestRelease(RTMANIFEST hManifest);
+
+/**
+ * Creates a duplicate of the specified manifest.
+ *
+ * @returns IPRT status code
+ * @param   hManifestSrc        The manifest to clone.
+ * @param   phManifestDst       Where to store the handle to the duplicate.
+ */
+RTDECL(int) RTManifestDup(RTMANIFEST hManifestSrc, PRTMANIFEST phManifestDst);
+
+/**
+ * Compares two manifests for equality.
+ *
+ * @returns true if equals, false if not.
+ * @param   hManifest1          The first manifest.
+ * @param   hManifest2          The second manifest.
+ * @param   papszIgnoreEntries  Entries to ignore.  Ends with a NULL entry.
+ * @param   papszIgnoreAttrs    Attributes to ignore.  Ends with a NULL entry.
+ */
+RTDECL(int) RTManifestEqualsEx(RTMANIFEST hManifest1, RTMANIFEST hManifest2, const char * const *papszIgnoreEntries,
+                               const char * const *papszIgnoreAttr);
+
+/**
+ * Compares two manifests for equality.
+ *
+ * @returns true if equals, false if not.
+ * @param   hManifest1          The first manifest.
+ * @param   hManifest2          The second manifest.
+ */
+RTDECL(int) RTManifestEquals(RTMANIFEST hManifest1, RTMANIFEST hManifest2);
+
+/**
+ * Sets a manifest attribute.
+ *
+ * @returns IPRT status code.
+ * @param   hManifest           The manifest handle.
+ * @param   pszAttr             The attribute name.  If this already exists,
+ *                              its value will be replaced.
+ * @param   pszValue            The value string.
+ * @param   fType               The attribute type, pass
+ *                              RTMANIFEST_ATTR_UNKNOWN if not known.
+ */
+RTDECL(int) RTManifestSetAttr(RTMANIFEST hManifest, const char *pszAttr, const char *pszValue, uint32_t fType);
+
+/**
+ * Unsets (removes) a manifest attribute if it exists.
+ *
+ * @returns IPRT status code.
+ * @retval  VWRN_NOT_FOUND if not found.
+ *
+ * @param   hManifest           The manifest handle.
+ * @param   pszAttr             The attribute name.
+ */
+RTDECL(int) RTManifestUnsetAttr(RTMANIFEST hManifest, const char *pszAttr);
+
+/**
+ * Sets an attribute of a manifest entry.
+ *
+ * @returns IPRT status code.
+ * @param   hManifest           The manifest handle.
+ * @param   pszEntry            The entry name.  This will automatically be
+ *                              added if there was no previous call to
+ *                              RTManifestEntryAdd for this name.  See
+ *                              RTManifestEntryAdd for the entry name rules.
+ * @param   pszAttr             The attribute name.  If this already exists,
+ *                              its value will be replaced.
+ * @param   pszValue            The value string.
+ * @param   fType               The attribute type, pass
+ *                              RTMANIFEST_ATTR_UNKNOWN if not known.
+ */
+RTDECL(int) RTManifestEntrySetAttr(RTMANIFEST hManifest, const char *pszEntry, const char *pszAttr,
+                                   const char *pszValue, uint32_t fType);
+
+/**
+ * Unsets (removes) an attribute of a manifest entry if they both exist.
+ *
+ * @returns IPRT status code.
+ * @retval  VWRN_NOT_FOUND if not found.
+ *
+ * @param   hManifest           The manifest handle.
+ * @param   pszEntry            The entry name.
+ * @param   pszAttr             The attribute name.
+ */
+RTDECL(int) RTManifestEntryUnsetAttr(RTMANIFEST hManifest, const char *pszEntry, const char *pszAttr);
+
+/**
+ * Adds a new entry to a manifest.
+ *
+ * The entry name rules:
+ *     - The entry name can contain any character defined by unicode, except
+ *       control characters, ':', '(' and ')'.  The exceptions are mainly there
+ *       because of uncertainty around how various formats handles these.
+ *     - It is considered case sensitive.
+ *     - Forward (unix) and backward (dos) slashes are considered path
+ *       separators and converted to forward slashes.
+ *
+ * @returns IPRT status code.
+ * @retval  VWRN_ALREADY_EXISTS if the entry already exists.
+ *
+ * @param   hManifest           The manifest handle.
+ * @param   pszEntry            The entry name (UTF-8).
+ *
+ * @remarks Some manifest formats will not be able to store an entry without
+ *          any attributes.  So, this is just here in case it comes in handy
+ *          when dealing with formats which can.
+ */
+RTDECL(int) RTManifestEntryAdd(RTMANIFEST hManifest, const char *pszEntry);
+
+/**
+ * Removes an entry.
+ *
+ * @returns IPRT status code.
+ * @param   hManifest           The manifest handle.
+ * @param   pszEntry            The entry name.
+ */
+RTDECL(int) RTManifestEntryRemove(RTMANIFEST hManifest, const char *pszEntry);
+
+
+/**
+ * Adds an entry for a file with the specified set of attributes.
+ *
+ * @returns IPRT status code.
+ *
+ * @param   hManifest           The manifest handle.
+ * @param   hVfsIos             The I/O stream handle of the entry.  This will
+ *                              be processed to its end on successful return.
+ *                              (Must be positioned at the start to get
+ *                              the expected results.)
+ * @param   pszEntry            The entry name.
+ * @param   fAttrs              The attributes to create for this stream.
+ */
+RTDECL(int) RTManifestEntryAddIoStream(RTMANIFEST hManifest, RTVFSIOSTREAM hVfsIos, const char *pszEntry, uint32_t fAttrs);
+
+/**
+ * Reads in a "standard" manifest.
+ *
+ * This reads the format used by OVF, the distinfo in FreeBSD ports, and
+ * others.
+ *
+ * @returns IPRT status code.
+ * @param   hManifest           The handle to the manifest where to add the
+ *                              manifest that's read in.
+ * @param   hVfsIos             The I/O stream to read the manifest from.
+ */
+RTDECL(int) RTManifestReadStandard(RTMANIFEST hManifest, RTVFSIOSTREAM hVfsIos);
+
+/**
+ * Writes a "standard" manifest.
+ *
+ * This writes the format used by OVF, the distinfo in FreeBSD ports, and
+ * others.
+ *
+ * @returns IPRT status code.
+ * @param   hManifest           The handle to the manifest where to add the
+ *                              manifest that's read in.
+ * @param   hVfsIos             The I/O stream to read the manifest from.
+ */
+RTDECL(int) RTManifestWriteStandard(RTMANIFEST hManifest, RTVFSIOSTREAM hVfsIos);
+
+
+
+
 
 /**

trunk/include/iprt/types.h

@@ -1487 +1487 @@
 #define NIL_RTDBGMOD                                ((RTDBGMOD)0)
 
+/** Manifest handle. */
+typedef struct RTMANIFESTINT                       *RTMANIFEST;
+/** Pointer to a manifest handle. */
+typedef RTMANIFEST                                 *PRTMANIFEST;
+/** NIL manifest handle. */
+#define NIL_RTMANIFEST                              ((RTMANIFEST)~(uintptr_t)0)
+
 /** Memory pool handle. */
 typedef R3R0PTRTYPE(struct RTMEMPOOLINT *)          RTMEMPOOL;

trunk/src/VBox/Main/VBoxExtPackHelperApp.cpp

@@ -30 +30 @@
 #include <iprt/getopt.h>
 #include <iprt/initterm.h>
+#include <iprt/manifest.h>
 #include <iprt/message.h>
 #include <iprt/param.h>
@@ -37 +38 @@
 #include <iprt/string.h>
 #include <iprt/stream.h>
+#include <iprt/vfs.h>
+#include <iprt/zip.h>
 
 #include <VBox/log.h>
@@ -51 +54 @@
 }
 #endif
+
 
 
@@ -77 +81 @@
                       "        --tarball <tarball> --tarball-fd <fd>\n"
                       "    uninstall --base-dir <dir> --name <name>\n"
+                      "    cleanup --base-dir <dir>\n"
                       , RTProcShortName());
             return RTEXITCODE_SUCCESS;
@@ -135 +140 @@
     return RTPathCompare(szCorrect, pszBaseDir) == 0;
 }
+
 
 /**
@@ -156 +162 @@
                               fTemporary ? "temporary " : "", rc, pszDir);
     return RTEXITCODE_SUCCESS;
+}
+
+
+/**
+ * Rewinds the tarball file handle and creates a gunzip | tar chain that
+ * results in a filesystem stream.
+ *
+ * @returns success or failure, message displayed on failure.
+ * @param   hTarballFile    The handle to the tarball file.
+ * @param   phTarFss        Where to return the filesystem stream handle.
+ */
+static RTEXITCODE OpenTarFss(RTFILE hTarballFile, PRTVFSFSSTREAM phTarFss)
+{
+    /*
+     * Rewind the file and set up a VFS chain for it.
+     */
+    int rc = RTFileSeek(hTarballFile, 0, RTFILE_SEEK_BEGIN, NULL);
+    if (RT_FAILURE(rc))
+        return RTMsgErrorExit(RTEXITCODE_FAILURE, "Failed seeking to the start of the tarball: %Rrc\n", rc);
+
+    RTVFSIOSTREAM hTarballIos;
+    rc = RTVfsIoStrmFromRTFile(hTarballFile, RTFILE_O_READ | RTFILE_O_DENY_WRITE | RTFILE_O_OPEN, true /*fLeaveOpen*/,
+                               &hTarballIos);
+    if (RT_FAILURE(rc))
+        return RTMsgErrorExit(RTEXITCODE_FAILURE, "RTVfsIoStrmFromRTFile failed: %Rrc\n", rc);
+
+    RTVFSIOSTREAM hGunzipIos;
+    rc = RTZipGzipDecompressIoStream(hTarballIos, 0 /*fFlags*/, &hGunzipIos);
+    if (RT_SUCCESS(rc))
+    {
+        RTVFSFSSTREAM hTarFss;
+        rc = RTZipTarFsStreamFromIoStream(hGunzipIos, 0 /*fFlags*/, &hTarFss);
+        if (RT_SUCCESS(rc))
+        {
+            RTVfsIoStrmRelease(hGunzipIos);
+            RTVfsIoStrmRelease(hTarballIos);
+            *phTarFss = hTarFss;
+            return RTEXITCODE_SUCCESS;
+        }
+        RTMsgError("RTZipTarFsStreamFromIoStream failed: %Rrc\n", rc);
+        RTVfsIoStrmRelease(hGunzipIos);
+    }
+    else
+        RTMsgError("RTZipGzipDecompressIoStream failed: %Rrc\n", rc);
+    RTVfsIoStrmRelease(hTarballIos);
+    return RTEXITCODE_FAILURE;
 }
 
@@ -183 +235 @@
 
 /**
- * Validates the extension pack.
+ * Validates the extension pack tarball prior to unpacking.
  *
  * Operations performed:
- *      - Manifest seal check.
- *      - Manifest check.
- *      - Recursive hardening check.
+ *      - Hardening checks.
  *      - XML validity check.
  *      - Name check (against XML).
@@ -199 +249 @@
  *                              complain about something.
  */
-static RTEXITCODE ValidateExtPack(const char *pszDir, const char *pszTarball, const char *pszName)
+static RTEXITCODE ValidateUnpackedExtPack(const char *pszDir, const char *pszTarball, const char *pszName)
 {
     /** @todo  */
@@ -217 +267 @@
  * @param   pszTarball          The name of the tarball in case we have to
  *                              complain about something.
+ * @todo    Needs to take the previous verified manifest as input.
  */
 static RTEXITCODE UnpackExtPack(RTFILE hTarballFile, const char *pszDirDst, const char *pszTarball)
@@ -222 +273 @@
     /** @todo  */
     return RTEXITCODE_SUCCESS;
+}
+
+
+/**
+ * Validates the extension pack tarball prior to unpacking.
+ *
+ * Operations performed:
+ *      - Manifest check.
+ *      - Manifest seal check.
+ *      - Mandatory files.
+ *
+ * @returns The program exit code.
+ * @param   hTarballFile        The handle to open the @a pszTarball file.
+ * @param   pszTarball          The name of the tarball in case we have to
+ *                              complain about something.
+ *
+ * @todo    Should validate the XML and name.
+ * @todo    Needs to return a manifest.
+ */
+static RTEXITCODE ValidateExtPackTarball(RTFILE hTarballFile, const char *pszTarball)
+{
+    /*
+     * Open the tar.gz filesystem stream and set up an manifest in-memory file.
+     */
+    RTVFSFSSTREAM hTarFss;
+    RTEXITCODE rcExit = OpenTarFss(hTarballFile, &hTarFss);
+    if (rcExit != RTEXITCODE_SUCCESS)
+        return rcExit;
+
+    RTMANIFEST hManifest;
+    int rc = RTManifestCreate(0 /*fFlags*/, &hManifest);
+
+    /** @todo continue coding here! */
+    AssertRC(rc);
+
+    return RTEXITCODE_FAILURE;
 }
 
@@ -305 +392 @@
         return RTMsgErrorExit(RTEXITCODE_FAILURE, "Failed to create temporary directory: %Rrc ('%s')", rc, szTmpPath);
 
-    RTEXITCODE rcExit = UnpackExtPack(hTarballFile, szTmpPath, pszTarball);
+    RTEXITCODE rcExit = ValidateExtPackTarball(hTarballFile, pszTarball);
     if (rcExit == RTEXITCODE_SUCCESS)
-        rcExit = ValidateExtPack(szTmpPath, pszTarball, pszName);
+        rcExit = UnpackExtPack(hTarballFile, szTmpPath, pszTarball);
+    if (rcExit == RTEXITCODE_SUCCESS)
+        rcExit = ValidateUnpackedExtPack(szTmpPath, pszTarball, pszName);
     if (rcExit == RTEXITCODE_SUCCESS)
         rcExit = SetExtPackPermissions(szTmpPath);

trunk/src/VBox/Runtime/Makefile.kmk

@@ -1112 +1112 @@
         common/checksum/crc32-zlib.cpp \
         common/checksum/manifest.cpp \
+        common/checksum/manifest2.cpp \
+        common/checksum/manifest3.cpp \
+        common/checksum/manifest-file.cpp \
         common/checksum/sha1.cpp \
         common/checksum/sha1str.cpp \