13194d15bc799cdfb231c1ba3fa26674334601b5vboxsync * IPRT - Manifest file handling, old style - deprecated.
13194d15bc799cdfb231c1ba3fa26674334601b5vboxsync * Copyright (C) 2009-2013 Oracle Corporation
c40afa339b10a23d6fffcbeb7d4572bb494685f0vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
c40afa339b10a23d6fffcbeb7d4572bb494685f0vboxsync * available from http://www.virtualbox.org. This file is free software;
c40afa339b10a23d6fffcbeb7d4572bb494685f0vboxsync * you can redistribute it and/or modify it under the terms of the GNU
c40afa339b10a23d6fffcbeb7d4572bb494685f0vboxsync * General Public License (GPL) as published by the Free Software
c40afa339b10a23d6fffcbeb7d4572bb494685f0vboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
c40afa339b10a23d6fffcbeb7d4572bb494685f0vboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
c40afa339b10a23d6fffcbeb7d4572bb494685f0vboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
c40afa339b10a23d6fffcbeb7d4572bb494685f0vboxsync * The contents of this file may alternatively be used under the terms
c40afa339b10a23d6fffcbeb7d4572bb494685f0vboxsync * of the Common Development and Distribution License Version 1.0
c40afa339b10a23d6fffcbeb7d4572bb494685f0vboxsync * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
c40afa339b10a23d6fffcbeb7d4572bb494685f0vboxsync * VirtualBox OSE distribution, in which case the provisions of the
c40afa339b10a23d6fffcbeb7d4572bb494685f0vboxsync * CDDL are applicable instead of those of the GPL.
c40afa339b10a23d6fffcbeb7d4572bb494685f0vboxsync * You may elect to license modified versions of this file under the
c40afa339b10a23d6fffcbeb7d4572bb494685f0vboxsync * terms and conditions of either the GPL or the CDDL or both.
70dd77b2f7732defac9d929109f20d92676f0570vboxsync/*******************************************************************************
70dd77b2f7732defac9d929109f20d92676f0570vboxsync* Header Files *
70dd77b2f7732defac9d929109f20d92676f0570vboxsync*******************************************************************************/
c40afa339b10a23d6fffcbeb7d4572bb494685f0vboxsync/*******************************************************************************
c40afa339b10a23d6fffcbeb7d4572bb494685f0vboxsync* Structures and Typedefs *
c40afa339b10a23d6fffcbeb7d4572bb494685f0vboxsync*******************************************************************************/
70dd77b2f7732defac9d929109f20d92676f0570vboxsync * Internal per file structure used by RTManifestVerify
510dd1bd989d25f95680fc2a3b51bf11854bc6a4vboxsync * Internal structure used for the progress callback
510dd1bd989d25f95680fc2a3b51bf11854bc6a4vboxsynctypedef RTMANIFESTCALLBACKDATA* PRTMANIFESTCALLBACKDATA;
382dd16193dd5770e53a99d3e3f3bc4e96f1ddd8vboxsync/*******************************************************************************
382dd16193dd5770e53a99d3e3f3bc4e96f1ddd8vboxsync* Private functions
382dd16193dd5770e53a99d3e3f3bc4e96f1ddd8vboxsync*******************************************************************************/
382dd16193dd5770e53a99d3e3f3bc4e96f1ddd8vboxsyncDECLINLINE(char *) rtManifestPosOfCharInBuf(char const *pv, size_t cb, char c)
382dd16193dd5770e53a99d3e3f3bc4e96f1ddd8vboxsyncDECLINLINE(size_t) rtManifestIndexOfCharInBuf(char const *pv, size_t cb, char c)
510dd1bd989d25f95680fc2a3b51bf11854bc6a4vboxsyncint rtSHAProgressCallback(unsigned uPercent, void *pvUser)
510dd1bd989d25f95680fc2a3b51bf11854bc6a4vboxsync PRTMANIFESTCALLBACKDATA pData = (PRTMANIFESTCALLBACKDATA)pvUser;
44918d7b9fb45f0d3e2ba56bf6d2cede9a2ae566vboxsync return pData->pfnProgressCallback((unsigned)( (uPercent + (float)pData->cCurrentFile * 100.0)
382dd16193dd5770e53a99d3e3f3bc4e96f1ddd8vboxsync/*******************************************************************************
382dd16193dd5770e53a99d3e3f3bc4e96f1ddd8vboxsync* Public functions
382dd16193dd5770e53a99d3e3f3bc4e96f1ddd8vboxsync*******************************************************************************/
0aa6851583f4cb074ccc163d5b53948b9429ab77vboxsyncRTR3DECL(int) RTManifestVerify(const char *pszManifestFile, PRTMANIFESTTEST paTests, size_t cTests, size_t *piFailed)
c40afa339b10a23d6fffcbeb7d4572bb494685f0vboxsync /* Validate input */
70dd77b2f7732defac9d929109f20d92676f0570vboxsync AssertPtrReturn(pszManifestFile, VERR_INVALID_POINTER);
c40afa339b10a23d6fffcbeb7d4572bb494685f0vboxsync /* Open the manifest file */
382dd16193dd5770e53a99d3e3f3bc4e96f1ddd8vboxsync int rc = RTFileOpen(&file, pszManifestFile, RTFILE_O_OPEN | RTFILE_O_READ | RTFILE_O_DENY_NONE);
382dd16193dd5770e53a99d3e3f3bc4e96f1ddd8vboxsync /* Cast down for the case size_t < uint64_t. This isn't really correct,
382dd16193dd5770e53a99d3e3f3bc4e96f1ddd8vboxsync but we consider manifest files bigger than size_t as not supported
382dd16193dd5770e53a99d3e3f3bc4e96f1ddd8vboxsync rc = RTManifestVerifyFilesBuf(pvBuf, cbRead, paTests, cTests, piFailed);
382dd16193dd5770e53a99d3e3f3bc4e96f1ddd8vboxsync }while (0);
382dd16193dd5770e53a99d3e3f3bc4e96f1ddd8vboxsync /* Cleanup */
382dd16193dd5770e53a99d3e3f3bc4e96f1ddd8vboxsyncRTR3DECL(int) RTManifestVerifyFiles(const char *pszManifestFile, const char * const *papszFiles, size_t cFiles, size_t *piFailed,
382dd16193dd5770e53a99d3e3f3bc4e96f1ddd8vboxsync /* Validate input */
382dd16193dd5770e53a99d3e3f3bc4e96f1ddd8vboxsync AssertPtrReturn(pszManifestFile, VERR_INVALID_POINTER);
382dd16193dd5770e53a99d3e3f3bc4e96f1ddd8vboxsync AssertPtrNullReturn(pfnProgressCallback, VERR_INVALID_POINTER);
382dd16193dd5770e53a99d3e3f3bc4e96f1ddd8vboxsync /* Create our compare list */
382dd16193dd5770e53a99d3e3f3bc4e96f1ddd8vboxsync PRTMANIFESTTEST paFiles = (PRTMANIFESTTEST)RTMemTmpAllocZ(sizeof(RTMANIFESTTEST) * cFiles);
382dd16193dd5770e53a99d3e3f3bc4e96f1ddd8vboxsync RTMANIFESTCALLBACKDATA callback = { pfnProgressCallback, pvUser, cFiles, 0 };
382dd16193dd5770e53a99d3e3f3bc4e96f1ddd8vboxsync /* Fill our compare list */
382dd16193dd5770e53a99d3e3f3bc4e96f1ddd8vboxsync rc = RTSha1DigestFromFile(papszFiles[i], &pszDigest, rtSHAProgressCallback, &callback);
382dd16193dd5770e53a99d3e3f3bc4e96f1ddd8vboxsync rc = RTSha1DigestFromFile(papszFiles[i], &pszDigest, NULL, NULL);
382dd16193dd5770e53a99d3e3f3bc4e96f1ddd8vboxsync /* Do the verification */
382dd16193dd5770e53a99d3e3f3bc4e96f1ddd8vboxsync rc = RTManifestVerify(pszManifestFile, paFiles, cFiles, piFailed);
382dd16193dd5770e53a99d3e3f3bc4e96f1ddd8vboxsync /* Cleanup */
454ac5c6ef4960887035ceea6b5247789d3272davboxsyncRTR3DECL(int) RTManifestWriteFiles(const char *pszManifestFile, RTDIGESTTYPE enmDigestType,
382dd16193dd5770e53a99d3e3f3bc4e96f1ddd8vboxsync /* Validate input */
382dd16193dd5770e53a99d3e3f3bc4e96f1ddd8vboxsync AssertPtrReturn(pszManifestFile, VERR_INVALID_POINTER);
382dd16193dd5770e53a99d3e3f3bc4e96f1ddd8vboxsync AssertPtrNullReturn(pfnProgressCallback, VERR_INVALID_POINTER);
382dd16193dd5770e53a99d3e3f3bc4e96f1ddd8vboxsync int rc = RTFileOpen(&file, pszManifestFile, RTFILE_O_CREATE | RTFILE_O_WRITE | RTFILE_O_DENY_ALL);
382dd16193dd5770e53a99d3e3f3bc4e96f1ddd8vboxsync paFiles = (PRTMANIFESTTEST)RTMemAllocZ(sizeof(RTMANIFESTTEST) * cFiles);
382dd16193dd5770e53a99d3e3f3bc4e96f1ddd8vboxsync RTMANIFESTCALLBACKDATA callback = { pfnProgressCallback, pvUser, cFiles, 0 };
382dd16193dd5770e53a99d3e3f3bc4e96f1ddd8vboxsync /* Calculate the SHA1 digest of every file */
382dd16193dd5770e53a99d3e3f3bc4e96f1ddd8vboxsync rc = RTSha1DigestFromFile(paFiles[i].pszTestFile, (char**)&paFiles[i].pszTestDigest, rtSHAProgressCallback, &callback);
382dd16193dd5770e53a99d3e3f3bc4e96f1ddd8vboxsync rc = RTSha1DigestFromFile(paFiles[i].pszTestFile, (char**)&paFiles[i].pszTestDigest, NULL, NULL);
454ac5c6ef4960887035ceea6b5247789d3272davboxsync rc = RTManifestWriteFilesBuf(&pvBuf, &cbSize, enmDigestType, paFiles, cFiles);
382dd16193dd5770e53a99d3e3f3bc4e96f1ddd8vboxsync }while (0);
382dd16193dd5770e53a99d3e3f3bc4e96f1ddd8vboxsync /* Cleanup */
382dd16193dd5770e53a99d3e3f3bc4e96f1ddd8vboxsync /* Delete the manifest file on failure */
3ebe113eb15a12d6c582ae88a0dae0d70a536b17vboxsyncRTR3DECL(int) RTManifestVerifyDigestType(void const *pvBuf, size_t cbSize, RTDIGESTTYPE *penmDigestType)
62c8fef246519d59ee7ad41dd71de75b96b3552bvboxsync /* Validate input */
b5bd02feb556d7d95f484d9cbd87c97888e9cc9avboxsync AssertPtrReturn(penmDigestType, VERR_INVALID_POINTER);
62c8fef246519d59ee7ad41dd71de75b96b3552bvboxsync /* Parse the manifest file line by line */
62c8fef246519d59ee7ad41dd71de75b96b3552bvboxsync size_t cch = rtManifestIndexOfCharInBuf(pcBuf, cbSize - cbRead, '\n') + 1;
62c8fef246519d59ee7ad41dd71de75b96b3552bvboxsync /* Skip empty lines (UNIX/DOS format) */
13194d15bc799cdfb231c1ba3fa26674334601b5vboxsync/** @todo r=bird: Missing space check here. */
62c8fef246519d59ee7ad41dd71de75b96b3552bvboxsync /* Check for the digest algorithm */
382dd16193dd5770e53a99d3e3f3bc4e96f1ddd8vboxsyncRTR3DECL(int) RTManifestVerifyFilesBuf(void *pvBuf, size_t cbSize, PRTMANIFESTTEST paTests, size_t cTests, size_t *piFailed)
382dd16193dd5770e53a99d3e3f3bc4e96f1ddd8vboxsync /* Validate input */
382dd16193dd5770e53a99d3e3f3bc4e96f1ddd8vboxsync AssertPtrNullReturn(piFailed, VERR_INVALID_POINTER);
382dd16193dd5770e53a99d3e3f3bc4e96f1ddd8vboxsync PRTMANIFESTFILEENTRY paFiles = (PRTMANIFESTFILEENTRY)RTMemTmpAllocZ(sizeof(RTMANIFESTFILEENTRY) * cTests);
c40afa339b10a23d6fffcbeb7d4572bb494685f0vboxsync /* Fill our compare list */
c40afa339b10a23d6fffcbeb7d4572bb494685f0vboxsync /* Parse the manifest file line by line */
382dd16193dd5770e53a99d3e3f3bc4e96f1ddd8vboxsync size_t cch = rtManifestIndexOfCharInBuf(pcBuf, cbSize - cbRead, '\n') + 1;
382dd16193dd5770e53a99d3e3f3bc4e96f1ddd8vboxsync /* Skip empty lines (UNIX/DOS format) */
70dd77b2f7732defac9d929109f20d92676f0570vboxsync /** @todo r=bird:
382dd16193dd5770e53a99d3e3f3bc4e96f1ddd8vboxsync * -# Better deal with this EOF line platform dependency
13194d15bc799cdfb231c1ba3fa26674334601b5vboxsync * -# The SHA1 and SHA256 tests should probably include a blank space check.
70dd77b2f7732defac9d929109f20d92676f0570vboxsync * -# If there is a specific order to the elements in the string, it would be
70dd77b2f7732defac9d929109f20d92676f0570vboxsync * good if the delimiter searching checked for it.
70dd77b2f7732defac9d929109f20d92676f0570vboxsync * -# Deal with filenames containing delimiter characters.
c40afa339b10a23d6fffcbeb7d4572bb494685f0vboxsync /* Check for the digest algorithm */
c40afa339b10a23d6fffcbeb7d4572bb494685f0vboxsync /* Digest unsupported */
c40afa339b10a23d6fffcbeb7d4572bb494685f0vboxsync /* Try to find the filename */
382dd16193dd5770e53a99d3e3f3bc4e96f1ddd8vboxsync char *pszNameStart = rtManifestPosOfCharInBuf(pcBuf, cch, '(');
382dd16193dd5770e53a99d3e3f3bc4e96f1ddd8vboxsync char *pszNameEnd = rtManifestPosOfCharInBuf(pcBuf, cch, ')');
c40afa339b10a23d6fffcbeb7d4572bb494685f0vboxsync /* Copy the filename part */
70dd77b2f7732defac9d929109f20d92676f0570vboxsync char *pszName = (char *)RTMemTmpAlloc(cchName + 1);
c40afa339b10a23d6fffcbeb7d4572bb494685f0vboxsync /* Try to find the digest sum */
382dd16193dd5770e53a99d3e3f3bc4e96f1ddd8vboxsync char *pszDigestStart = rtManifestPosOfCharInBuf(pcBuf, cch, '=') + 1;
382dd16193dd5770e53a99d3e3f3bc4e96f1ddd8vboxsync char *pszDigestEnd = rtManifestPosOfCharInBuf(pcBuf, cch, '\r');
382dd16193dd5770e53a99d3e3f3bc4e96f1ddd8vboxsync pszDigestEnd = rtManifestPosOfCharInBuf(pcBuf, cch, '\n');
382dd16193dd5770e53a99d3e3f3bc4e96f1ddd8vboxsync /* Copy the digest part */
382dd16193dd5770e53a99d3e3f3bc4e96f1ddd8vboxsync size_t cchDigest = pszDigestEnd - pszDigestStart - 1;
382dd16193dd5770e53a99d3e3f3bc4e96f1ddd8vboxsync char *pszDigest = (char *)RTMemTmpAlloc(cchDigest + 1);
c40afa339b10a23d6fffcbeb7d4572bb494685f0vboxsync /* Check our file list against the extracted data */
13194d15bc799cdfb231c1ba3fa26674334601b5vboxsync /** @todo r=bird: Using RTStrStr here looks bogus. */
25479956e51de7af723c8958182331275d25542dvboxsync if (RTStrStr(paFiles[i].pTestPattern->pszTestFile, RTStrStrip(pszName)) != NULL)
c40afa339b10a23d6fffcbeb7d4572bb494685f0vboxsync /* Add the data of the manifest file to the file list */
70dd77b2f7732defac9d929109f20d92676f0570vboxsync paFiles[i].pszManifestFile = RTStrDup(RTStrStrip(pszName));
70dd77b2f7732defac9d929109f20d92676f0570vboxsync paFiles[i].pszManifestDigest = RTStrDup(RTStrStrip(pszDigest));
c40afa339b10a23d6fffcbeb7d4572bb494685f0vboxsync /* There have to be an entry in the file list */
c40afa339b10a23d6fffcbeb7d4572bb494685f0vboxsync /* If there is an entry in the file list, which hasn't an
c40afa339b10a23d6fffcbeb7d4572bb494685f0vboxsync * equivalent in the manifest file, its an error. */
25479956e51de7af723c8958182331275d25542dvboxsync /* Do the manifest SHA digest match against the actual digest? */
70dd77b2f7732defac9d929109f20d92676f0570vboxsync if (RTStrICmp(paFiles[i].pszManifestDigest, paFiles[i].pTestPattern->pszTestDigest))
c40afa339b10a23d6fffcbeb7d4572bb494685f0vboxsync /* Cleanup */
454ac5c6ef4960887035ceea6b5247789d3272davboxsyncRTR3DECL(int) RTManifestWriteFilesBuf(void **ppvBuf, size_t *pcbSize, RTDIGESTTYPE enmDigestType, PRTMANIFESTTEST paFiles, size_t cFiles)
42f4857b15e5d875e39345f1d1b804c2c1313e91vboxsync /* Validate input */
2cc6ff50968f2560102f978e15835298ecfb6f2fvboxsync case RTDIGESTTYPE_CRC32: pcszDigestType = "CRC32"; break;
2cc6ff50968f2560102f978e15835298ecfb6f2fvboxsync case RTDIGESTTYPE_CRC64: pcszDigestType = "CRC64"; break;
2cc6ff50968f2560102f978e15835298ecfb6f2fvboxsync case RTDIGESTTYPE_MD5: pcszDigestType = "MD5"; break;
2cc6ff50968f2560102f978e15835298ecfb6f2fvboxsync case RTDIGESTTYPE_SHA1: pcszDigestType = "SHA1"; break;
24048050269b0c5b8eafb93ffee96baf17c4f23cvboxsync case RTDIGESTTYPE_SHA256: pcszDigestType = "SHA256"; break;
24048050269b0c5b8eafb93ffee96baf17c4f23cvboxsync default: return VERR_INVALID_PARAMETER;
42f4857b15e5d875e39345f1d1b804c2c1313e91vboxsync /* Calculate the size necessary for the memory buffer. */
2cc6ff50968f2560102f978e15835298ecfb6f2fvboxsync size_t cbTmp = strlen(RTPathFilename(paFiles[i].pszTestFile))
42f4857b15e5d875e39345f1d1b804c2c1313e91vboxsync /* Create the memory buffer */
42f4857b15e5d875e39345f1d1b804c2c1313e91vboxsync /* Allocate a temporary string buffer. */
454ac5c6ef4960887035ceea6b5247789d3272davboxsync size_t cch = RTStrPrintf(pszTmp, cbMaxSize + 1, "%s (%s)= %s\n", pcszDigestType, RTPathFilename(paFiles[i].pszTestFile), paFiles[i].pszTestDigest);
42f4857b15e5d875e39345f1d1b804c2c1313e91vboxsync /* Results */