VirtualBox

source: vbox/trunk/src/VBox/Main/include/ApplianceImpl.h@ 84312

Last change on this file since 84312 was 84312, checked in by vboxsync, 5 years ago

Main/ApplianceImport: Read the PKCS7/CMS signature when present. Implemented the basic validation, but the certificate trust stuff is still left to be done. bugref:9699
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 14.0 KB
Line 
1/* $Id: ApplianceImpl.h 84312 2020-05-14 17:46:45Z vboxsync $ */
2/** @file
3 * VirtualBox COM class implementation
4 */
5
6/*
7 * Copyright (C) 2006-2020 Oracle Corporation
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
18#ifndef MAIN_INCLUDED_ApplianceImpl_h
19#define MAIN_INCLUDED_ApplianceImpl_h
20#ifndef RT_WITHOUT_PRAGMA_ONCE
21# pragma once
22#endif
23
24/* VBox includes */
25#include "VirtualSystemDescriptionWrap.h"
26#include "ApplianceWrap.h"
27#include "MediumFormatImpl.h"
28
29/** @todo This file needs massive cleanup. Split IAppliance in a public and
30 * private classes. */
31#include <iprt/tar.h>
32#include "ovfreader.h"
33#include <set>
34
35/* VBox forward declarations */
36class Certificate;
37class Progress;
38class VirtualSystemDescription;
39struct VirtualSystemDescriptionEntry;
40struct LocationInfo;
41typedef struct VDINTERFACE *PVDINTERFACE;
42typedef struct VDINTERFACEIO *PVDINTERFACEIO;
43typedef struct SHASTORAGE *PSHASTORAGE;
44
45namespace ovf
46{
47 struct HardDiskController;
48 struct VirtualSystem;
49 class OVFReader;
50 struct DiskImage;
51 struct EnvelopeData;
52}
53
54namespace xml
55{
56 class Document;
57 class ElementNode;
58}
59
60namespace settings
61{
62 class MachineConfigFile;
63}
64
65class ATL_NO_VTABLE Appliance :
66 public ApplianceWrap
67{
68public:
69
70 DECLARE_EMPTY_CTOR_DTOR(Appliance)
71
72 HRESULT FinalConstruct();
73 void FinalRelease();
74
75
76 HRESULT init(VirtualBox *aVirtualBox);
77 void uninit();
78
79 /* public methods only for internal purposes */
80
81 static HRESULT i_setErrorStatic(HRESULT aResultCode,
82 const Utf8Str &aText)
83 {
84 return setErrorInternal(aResultCode, getStaticClassIID(), getStaticComponentName(), aText, false, true);
85 }
86
87 /* private instance data */
88private:
89 // wrapped IAppliance properties
90 HRESULT getPath(com::Utf8Str &aPath);
91 HRESULT getDisks(std::vector<com::Utf8Str> &aDisks);
92 HRESULT getCertificate(ComPtr<ICertificate> &aCertificateInfo);
93 HRESULT getVirtualSystemDescriptions(std::vector<ComPtr<IVirtualSystemDescription> > &aVirtualSystemDescriptions);
94 HRESULT getMachines(std::vector<com::Utf8Str> &aMachines);
95
96 // wrapped IAppliance methods
97 HRESULT read(const com::Utf8Str &aFile,
98 ComPtr<IProgress> &aProgress);
99 HRESULT interpret();
100 HRESULT importMachines(const std::vector<ImportOptions_T> &aOptions,
101 ComPtr<IProgress> &aProgress);
102 HRESULT createVFSExplorer(const com::Utf8Str &aURI,
103 ComPtr<IVFSExplorer> &aExplorer);
104 HRESULT write(const com::Utf8Str &aFormat,
105 const std::vector<ExportOptions_T> &aOptions,
106 const com::Utf8Str &aPath,
107 ComPtr<IProgress> &aProgress);
108 HRESULT getWarnings(std::vector<com::Utf8Str> &aWarnings);
109 HRESULT getPasswordIds(std::vector<com::Utf8Str> &aIdentifiers);
110 HRESULT getMediumIdsForPasswordId(const com::Utf8Str &aPasswordId, std::vector<com::Guid> &aIdentifiers);
111 HRESULT addPasswords(const std::vector<com::Utf8Str> &aIdentifiers,
112 const std::vector<com::Utf8Str> &aPasswords);
113 HRESULT createVirtualSystemDescriptions(ULONG aRequested, ULONG *aCreated);
114 /** weak VirtualBox parent */
115 VirtualBox* const mVirtualBox;
116
117 struct ImportStack;
118 class TaskOVF;
119 class TaskOPC;
120 class TaskCloud;
121
122 struct Data; // opaque, defined in ApplianceImpl.cpp
123 Data *m;
124
125 enum SetUpProgressMode { ImportFile, ImportS3, WriteFile, WriteS3, ExportCloud, ImportCloud };
126
127 enum ApplianceState { ApplianceIdle, ApplianceImporting, ApplianceExporting };
128 void i_setApplianceState(const ApplianceState &state);
129 /** @name General stuff
130 * @{
131 */
132 bool i_isApplianceIdle();
133 HRESULT i_searchUniqueVMName(Utf8Str& aName) const;
134 HRESULT i_searchUniqueImageFilePath(const Utf8Str &aMachineFolder,
135 DeviceType_T aDeviceType,
136 Utf8Str &aName) const;
137 HRESULT i_setUpProgress(ComObjPtr<Progress> &pProgress,
138 const Utf8Str &strDescription,
139 SetUpProgressMode mode);
140 void i_addWarning(const char* aWarning, ...);
141 void i_disksWeight();
142 void i_parseBucket(Utf8Str &aPath, Utf8Str &aBucket);
143
144 static void i_importOrExportThreadTask(TaskOVF *pTask);
145 static void i_exportOPCThreadTask(TaskOPC *pTask);
146 static void i_importOrExportCloudThreadTask(TaskCloud *pTask);
147
148 HRESULT i_initBackendNames();
149
150 Utf8Str i_typeOfVirtualDiskFormatFromURI(Utf8Str type) const;
151
152#if 0 /* unused */
153 std::set<Utf8Str> i_URIFromTypeOfVirtualDiskFormat(Utf8Str type);
154#endif
155
156 HRESULT i_findMediumFormatFromDiskImage(const ovf::DiskImage &di, ComObjPtr<MediumFormat>& mf);
157
158 RTVFSIOSTREAM i_manifestSetupDigestCalculationForGivenIoStream(RTVFSIOSTREAM hVfsIos, const char *pszManifestEntry,
159 bool fRead = true);
160 /** @} */
161
162 /** @name Read stuff
163 * @{
164 */
165 HRESULT i_readImpl(const LocationInfo &aLocInfo, ComObjPtr<Progress> &aProgress);
166
167 HRESULT i_readFS(TaskOVF *pTask);
168 HRESULT i_readFSOVF(TaskOVF *pTask);
169 HRESULT i_readFSOVA(TaskOVF *pTask);
170 HRESULT i_readOVFFile(TaskOVF *pTask, RTVFSIOSTREAM hIosOvf, const char *pszManifestEntry);
171 HRESULT i_readManifestFile(TaskOVF *pTask, RTVFSIOSTREAM hIosMf, const char *pszSubFileNm);
172 HRESULT i_readSignatureFile(TaskOVF *pTask, RTVFSIOSTREAM hIosCert, const char *pszSubFileNm);
173 HRESULT i_readTailProcessing(TaskOVF *pTask);
174 HRESULT i_readTailProcessingSignedData(PRTERRINFOSTATIC pErrInfo);
175 HRESULT i_readTailProcessingGetManifestData(void **ppvData, size_t *pcbData);
176 HRESULT i_gettingCloudData(TaskCloud *pTask);
177
178 /** @} */
179
180 /** @name Import stuff
181 * @{
182 */
183 HRESULT i_importImpl(const LocationInfo &aLocInfo, ComObjPtr<Progress> &aProgress);
184
185 HRESULT i_importFS(TaskOVF *pTask);
186 HRESULT i_importFSOVF(TaskOVF *pTask, AutoWriteLockBase &rWriteLock);
187 HRESULT i_importFSOVA(TaskOVF *pTask, AutoWriteLockBase &rWriteLock);
188 HRESULT i_importDoIt(TaskOVF *pTask, AutoWriteLockBase &rWriteLock, RTVFSFSSTREAM hVfsFssOva = NIL_RTVFSFSSTREAM);
189
190 HRESULT i_verifyManifestFile(ImportStack &stack);
191
192 void i_convertDiskAttachmentValues(const ovf::HardDiskController &hdc,
193 uint32_t ulAddressOnParent,
194 Utf8Str &controllerName,
195 int32_t &lControllerPort,
196 int32_t &lDevice);
197
198 void i_importOneDiskImage(const ovf::DiskImage &di,
199 const Utf8Str &strDstPath,
200 ComObjPtr<Medium> &pTargetMedium,
201 ImportStack &stack);
202
203 void i_importMachineGeneric(const ovf::VirtualSystem &vsysThis,
204 ComObjPtr<VirtualSystemDescription> &vsdescThis,
205 ComPtr<IMachine> &pNewMachine,
206 ImportStack &stack);
207 void i_importVBoxMachine(ComObjPtr<VirtualSystemDescription> &vsdescThis,
208 ComPtr<IMachine> &pNewMachine,
209 ImportStack &stack);
210 void i_importMachines(ImportStack &stack);
211
212 HRESULT i_preCheckImageAvailability(ImportStack &stack);
213 bool i_importEnsureOvaLookAhead(ImportStack &stack);
214 RTVFSIOSTREAM i_importOpenSourceFile(ImportStack &stack, Utf8Str const &rstrSrcPath, const char *pszManifestEntry);
215 HRESULT i_importCreateAndWriteDestinationFile(Utf8Str const &rstrDstPath,
216 RTVFSIOSTREAM hVfsIosSrc, Utf8Str const &rstrSrcLogNm);
217
218 void i_importCopyFile(ImportStack &stack, Utf8Str const &rstrSrcPath, Utf8Str const &rstrDstPath,
219 const char *pszManifestEntry);
220 void i_importDecompressFile(ImportStack &stack, Utf8Str const &rstrSrcPath, Utf8Str const &rstrDstPath,
221 const char *pszManifestEntry);
222 HRESULT i_importCloudImpl(TaskCloud *pTask);
223 /** @} */
224
225 /** @name Write stuff
226 * @{
227 */
228 HRESULT i_writeImpl(ovf::OVFVersion_T aFormat, const LocationInfo &aLocInfo, ComObjPtr<Progress> &aProgress);
229 HRESULT i_writeOPCImpl(ovf::OVFVersion_T aFormat, const LocationInfo &aLocInfo, ComObjPtr<Progress> &aProgress);
230 HRESULT i_writeCloudImpl(const LocationInfo &aLocInfo, ComObjPtr<Progress> &aProgress);
231
232 HRESULT i_writeFS(TaskOVF *pTask);
233 HRESULT i_writeFSOVF(TaskOVF *pTask, AutoWriteLockBase& writeLock);
234 HRESULT i_writeFSOVA(TaskOVF *pTask, AutoWriteLockBase& writeLock);
235 HRESULT i_writeFSOPC(TaskOPC *pTask);
236 HRESULT i_exportCloudImpl(TaskCloud *pTask);
237 HRESULT i_writeFSImpl(TaskOVF *pTask, AutoWriteLockBase &writeLock, RTVFSFSSTREAM hVfsFssDst);
238 HRESULT i_writeBufferToFile(RTVFSFSSTREAM hVfsFssDst, const char *pszFilename, const void *pvContent, size_t cbContent);
239
240 struct XMLStack;
241
242 void i_buildXML(AutoWriteLockBase& writeLock,
243 xml::Document &doc,
244 XMLStack &stack,
245 const Utf8Str &strPath,
246 ovf::OVFVersion_T enFormat);
247 void i_buildXMLForOneVirtualSystem(AutoWriteLockBase& writeLock,
248 xml::ElementNode &elmToAddVirtualSystemsTo,
249 std::list<xml::ElementNode*> *pllElementsWithUuidAttributes,
250 ComObjPtr<VirtualSystemDescription> &vsdescThis,
251 ovf::OVFVersion_T enFormat,
252 XMLStack &stack);
253 /** @} */
254
255 friend class Machine;
256 friend class Certificate;
257};
258
259void i_parseURI(Utf8Str strUri, LocationInfo &locInfo);
260
261struct VirtualSystemDescriptionEntry
262{
263 uint32_t ulIndex; ///< zero-based index of this entry within array
264 VirtualSystemDescriptionType_T type; ///< type of this entry
265 Utf8Str strRef; ///< reference number (hard disk controllers only)
266 Utf8Str strOvf; ///< original OVF value (type-dependent)
267 Utf8Str strVBoxSuggested; ///< configuration value (type-dependent); original value suggested by interpret()
268 Utf8Str strVBoxCurrent; ///< configuration value (type-dependent); current value, either from interpret() or setFinalValue()
269 Utf8Str strExtraConfigSuggested; ///< extra configuration key=value strings (type-dependent); original value suggested by interpret()
270 Utf8Str strExtraConfigCurrent; ///< extra configuration key=value strings (type-dependent); current value, either from interpret() or setFinalValue()
271
272 uint32_t ulSizeMB; ///< hard disk images only: a copy of ovf::DiskImage::ulSuggestedSizeMB
273 bool skipIt; ///< used during export to skip some parts if it's needed
274};
275
276class ATL_NO_VTABLE VirtualSystemDescription :
277 public VirtualSystemDescriptionWrap
278{
279 friend class Appliance;
280
281public:
282
283 DECLARE_EMPTY_CTOR_DTOR(VirtualSystemDescription)
284
285 HRESULT FinalConstruct();
286 void FinalRelease();
287
288 HRESULT init();
289 void uninit();
290
291 /* public methods only for internal purposes */
292 void i_addEntry(VirtualSystemDescriptionType_T aType,
293 const Utf8Str &strRef,
294 const Utf8Str &aOvfValue,
295 const Utf8Str &aVBoxValue,
296 uint32_t ulSizeMB = 0,
297 const Utf8Str &strExtraConfig = "");
298
299 std::list<VirtualSystemDescriptionEntry*> i_findByType(VirtualSystemDescriptionType_T aType);
300 const VirtualSystemDescriptionEntry* i_findControllerFromID(uint32_t id);
301
302 void i_importVBoxMachineXML(const xml::ElementNode &elmMachine);
303 const settings::MachineConfigFile* i_getMachineConfig() const;
304
305 /* private instance data */
306private:
307
308 // wrapped IVirtualSystemDescription properties
309 HRESULT getCount(ULONG *aCount);
310
311 // wrapped IVirtualSystemDescription methods
312 HRESULT getDescription(std::vector<VirtualSystemDescriptionType_T> &aTypes,
313 std::vector<com::Utf8Str> &aRefs,
314 std::vector<com::Utf8Str> &aOVFValues,
315 std::vector<com::Utf8Str> &aVBoxValues,
316 std::vector<com::Utf8Str> &aExtraConfigValues);
317 HRESULT getDescriptionByType(VirtualSystemDescriptionType_T aType,
318 std::vector<VirtualSystemDescriptionType_T> &aTypes,
319 std::vector<com::Utf8Str> &aRefs,
320 std::vector<com::Utf8Str> &aOVFValues,
321 std::vector<com::Utf8Str> &aVBoxValues,
322 std::vector<com::Utf8Str> &aExtraConfigValues);
323 HRESULT getValuesByType(VirtualSystemDescriptionType_T aType,
324 VirtualSystemDescriptionValueType_T aWhich,
325 std::vector<com::Utf8Str> &aValues);
326 HRESULT setFinalValues(const std::vector<BOOL> &aEnabled,
327 const std::vector<com::Utf8Str> &aVBoxValues,
328 const std::vector<com::Utf8Str> &aExtraConfigValues);
329 HRESULT addDescription(VirtualSystemDescriptionType_T aType,
330 const com::Utf8Str &aVBoxValue,
331 const com::Utf8Str &aExtraConfigValue);
332 HRESULT removeDescriptionByType(VirtualSystemDescriptionType_T aType);
333 void i_removeByType(VirtualSystemDescriptionType_T aType);
334
335 struct Data;
336 Data *m;
337
338 friend class Machine;
339};
340
341#endif /* !MAIN_INCLUDED_ApplianceImpl_h */
342/* vi: set tabstop=4 shiftwidth=4 expandtab: */
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