VirtualBox

source: vbox/trunk/src/VBox/Runtime/common/checksum/manifest.cpp@ 25528

Last change on this file since 25528 was 23501, checked in by vboxsync, 15 years ago

IPRT: Added SHA-1, SHA-256 and SHA-512 APIs. Added a simple digest program for testing these.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 9.0 KB
Line 
1/* $Id: manifest.cpp 23501 2009-10-02 10:59:42Z vboxsync $ */
2/** @file
3 * IPRT - Manifest file handling.
4 */
5
6/*
7 * Copyright (C) 2009 Sun Microsystems, Inc.
8 *
9 * This file is part of VirtualBox Open Source Edition (OSE), as
10 * available from http://www.virtualbox.org. This file is free software;
11 * you can redistribute it and/or modify it under the terms of the GNU
12 * General Public License (GPL) as published by the Free Software
13 * Foundation, in version 2 as it comes in the "COPYING" file of the
14 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16 *
17 * The contents of this file may alternatively be used under the terms
18 * of the Common Development and Distribution License Version 1.0
19 * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
20 * VirtualBox OSE distribution, in which case the provisions of the
21 * CDDL are applicable instead of those of the GPL.
22 *
23 * You may elect to license modified versions of this file under the
24 * terms and conditions of either the GPL or the CDDL or both.
25 *
26 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
27 * Clara, CA 95054 USA or visit http://www.sun.com if you need
28 * additional information or have any questions.
29 */
30
31
32/*******************************************************************************
33* Header Files *
34*******************************************************************************/
35#include "internal/iprt.h"
36#include <iprt/manifest.h>
37
38#include <iprt/err.h>
39#include <iprt/file.h>
40#include <iprt/mem.h>
41#include <iprt/path.h>
42#include <iprt/sha.h>
43#include <iprt/stream.h>
44#include <iprt/string.h>
45
46
47/*******************************************************************************
48* Structures and Typedefs *
49*******************************************************************************/
50/**
51 * Internal per file structure used by RTManifestVerify
52 */
53typedef struct RTMANIFESTFILEENTRY
54{
55 char *pszManifestFile;
56 char *pszManifestDigest;
57 PRTMANIFESTTEST pTestPattern;
58} RTMANIFESTFILEENTRY;
59typedef RTMANIFESTFILEENTRY* PRTMANIFESTFILEENTRY;
60
61
62
63RTR3DECL(int) RTManifestVerify(const char *pszManifestFile, PRTMANIFESTTEST paTests, size_t cTests, size_t *piFailed)
64{
65 /* Validate input */
66 AssertPtrReturn(pszManifestFile, VERR_INVALID_POINTER);
67 AssertPtrReturn(paTests, VERR_INVALID_POINTER);
68 AssertReturn(cTests > 0, VERR_INVALID_PARAMETER);
69
70 /* Open the manifest file */
71 PRTSTREAM pStream;
72 int rc = RTStrmOpen(pszManifestFile, "r", &pStream);
73 if (RT_FAILURE(rc))
74 return rc;
75
76 PRTMANIFESTFILEENTRY paFiles = (PRTMANIFESTFILEENTRY)RTMemTmpAllocZ(sizeof(RTMANIFESTFILEENTRY) * cTests);
77 if (!paFiles)
78 {
79 RTStrmClose(pStream);
80 return VERR_NO_MEMORY;
81 }
82
83 /* Fill our compare list */
84 for (size_t i = 0; i < cTests; ++i)
85 paFiles[i].pTestPattern = &paTests[i];
86
87 /* Parse the manifest file line by line */
88 char szLine[1024];
89 for (;;)
90 {
91 rc = RTStrmGetLine(pStream, szLine, sizeof(szLine));
92 if (RT_FAILURE(rc))
93 break;
94 size_t cch = strlen(szLine);
95
96 /* Skip empty lines */
97 if (cch == 0)
98 continue;
99
100 /** @todo r=bird:
101 * -# The SHA1 test should probably include a blank space check.
102 * -# If there is a specific order to the elements in the string, it would be
103 * good if the delimiter searching checked for it.
104 * -# Deal with filenames containing delimiter characters.
105 */
106
107 /* Check for the digest algorithm */
108 if ( cch < 4
109 || !( szLine[0] == 'S'
110 && szLine[1] == 'H'
111 && szLine[2] == 'A'
112 && szLine[3] == '1'))
113 {
114 /* Digest unsupported */
115 rc = VERR_MANIFEST_UNSUPPORTED_DIGEST_TYPE;
116 break;
117 }
118
119 /* Try to find the filename */
120 char *pszNameStart = strchr(szLine, '(');
121 if (!pszNameStart)
122 {
123 rc = VERR_MANIFEST_WRONG_FILE_FORMAT;
124 break;
125 }
126 char *pszNameEnd = strchr(szLine, ')');
127 if (!pszNameEnd)
128 {
129 rc = VERR_MANIFEST_WRONG_FILE_FORMAT;
130 break;
131 }
132
133 /* Copy the filename part */
134 size_t cchName = pszNameEnd - pszNameStart - 1;
135 char *pszName = (char *)RTMemTmpAlloc(cchName + 1);
136 if (!pszName)
137 {
138 rc = VERR_NO_MEMORY;
139 break;
140 }
141 memcpy(pszName, pszNameStart + 1, cchName);
142 pszName[cchName] = '\0';
143
144 /* Try to find the digest sum */
145 char *pszDigestStart = strchr(szLine, '=');
146 if (!pszDigestStart)
147 {
148 RTMemTmpFree(pszName);
149 rc = VERR_MANIFEST_WRONG_FILE_FORMAT;
150 break;
151 }
152 char *pszDigest = ++pszDigestStart;
153
154 /* Check our file list against the extracted data */
155 bool fFound = false;
156 for (size_t i = 0; i < cTests; ++i)
157 {
158 if (!RTStrCmp(RTPathFilename(paFiles[i].pTestPattern->pszTestFile), RTStrStrip(pszName)))
159 {
160 /* Add the data of the manifest file to the file list */
161 paFiles[i].pszManifestFile = RTStrDup(RTStrStrip(pszName));
162 paFiles[i].pszManifestDigest = RTStrDup(RTStrStrip(pszDigest));
163 fFound = true;
164 break;
165 }
166 }
167 RTMemTmpFree(pszName);
168 if (!fFound)
169 {
170 /* There have to be an entry in the file list */
171 rc = VERR_MANIFEST_FILE_MISMATCH;
172 break;
173 }
174 }
175 RTStrmClose(pStream);
176
177 if ( rc == VINF_SUCCESS
178 || rc == VERR_EOF)
179 {
180 rc = VINF_SUCCESS;
181 for (size_t i = 0; i < cTests; ++i)
182 {
183 /* If there is an entry in the file list, which hasn't an
184 * equivalent in the manifest file, its an error. */
185 if ( !paFiles[i].pszManifestFile
186 || !paFiles[i].pszManifestDigest)
187 {
188 rc = VERR_MANIFEST_FILE_MISMATCH;
189 break;
190 }
191
192 /* Do the manifest SHA1 digest match against the actual digest? */
193 if (RTStrICmp(paFiles[i].pszManifestDigest, paFiles[i].pTestPattern->pszTestDigest))
194 {
195 if (piFailed)
196 *piFailed = i;
197 rc = VERR_MANIFEST_DIGEST_MISMATCH;
198 break;
199 }
200 }
201 }
202
203 /* Cleanup */
204 for (size_t i = 0; i < cTests; ++i)
205 {
206 if (paFiles[i].pszManifestFile)
207 RTStrFree(paFiles[i].pszManifestFile);
208 if (paFiles[i].pszManifestDigest)
209 RTStrFree(paFiles[i].pszManifestDigest);
210 }
211 RTMemTmpFree(paFiles);
212
213 return rc;
214}
215
216
217RTR3DECL(int) RTManifestVerifyFiles(const char *pszManifestFile, const char * const *papszFiles, size_t cFiles, size_t *piFailed)
218{
219 /* Validate input */
220 AssertPtrReturn(pszManifestFile, VERR_INVALID_POINTER);
221 AssertPtrReturn(papszFiles, VERR_INVALID_POINTER);
222
223 /* Create our compare list */
224 PRTMANIFESTTEST paFiles = (PRTMANIFESTTEST)RTMemTmpAllocZ(sizeof(RTMANIFESTTEST) * cFiles);
225 if (!paFiles)
226 return VERR_NO_MEMORY;
227
228 /* Fill our compare list */
229 int rc = VINF_SUCCESS;
230 for (size_t i = 0; i < cFiles; ++i)
231 {
232 char *pszDigest;
233 rc = RTSha1Digest(papszFiles[i], &pszDigest);
234 if (RT_FAILURE(rc))
235 break;
236 paFiles[i].pszTestFile = (char*)papszFiles[i];
237 paFiles[i].pszTestDigest = pszDigest;
238 }
239
240 /* Do the verification */
241 if (RT_SUCCESS(rc))
242 rc = RTManifestVerify(pszManifestFile, paFiles, cFiles, piFailed);
243
244 /* Cleanup */
245 for (size_t i = 0; i < cFiles; ++i)
246 {
247 if (paFiles[i].pszTestDigest)
248 RTStrFree(paFiles[i].pszTestDigest);
249 }
250 RTMemTmpFree(paFiles);
251
252 return rc;
253}
254
255
256RTR3DECL(int) RTManifestWriteFiles(const char *pszManifestFile, const char * const *papszFiles, size_t cFiles)
257{
258 /* Validate input */
259 AssertPtrReturn(pszManifestFile, VERR_INVALID_POINTER);
260 AssertPtrReturn(papszFiles, VERR_INVALID_POINTER);
261
262 /* Open a file to stream in */
263 PRTSTREAM pStream;
264 int rc = RTStrmOpen(pszManifestFile, "w", &pStream);
265 if (RT_FAILURE(rc))
266 return rc;
267
268 for (size_t i = 0; i < cFiles; ++i)
269 {
270 /* Calculate the SHA1 digest of every file */
271 char *pszDigest;
272 rc = RTSha1Digest(papszFiles[i], &pszDigest);
273 if (RT_FAILURE(rc))
274 break;
275
276 /* Add the entry to the manifest file */
277 int cch = RTStrmPrintf(pStream, "SHA1 (%s)= %s\n", RTPathFilename(papszFiles[i]), pszDigest);
278 RTStrFree(pszDigest);
279 if (RT_UNLIKELY(cch < 0))
280 {
281 rc = VERR_INTERNAL_ERROR;
282 break;
283 }
284 }
285 int rc2 = RTStrmClose(pStream);
286 if (RT_FAILURE(rc2) && RT_SUCCESS(rc))
287 rc2 = rc;
288
289 /* Delete the manifest file on failure */
290 if (RT_FAILURE(rc))
291 RTFileDelete(pszManifestFile);
292
293 return rc;
294}
295
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