VirtualBox

source: vbox/trunk/src/VBox/Main/include/ApplianceImplPrivate.h@ 67885

Last change on this file since 67885 was 67249, checked in by vboxsync, 8 years ago

Main/Appliance++: Removed non-VBOX_WITH_NEW_TAR_CREATOR code.
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 14.7 KB
Line 
1/* $Id: ApplianceImplPrivate.h 67249 2017-06-02 15:24:58Z vboxsync $ */
2/** @file
3 * VirtualBox Appliance private data definitions
4 */
5
6/*
7 * Copyright (C) 2006-2016 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 ____H_APPLIANCEIMPLPRIVATE
19#define ____H_APPLIANCEIMPLPRIVATE
20
21
22class VirtualSystemDescription;
23
24#include "ovfreader.h"
25#include "SecretKeyStore.h"
26#include "ThreadTask.h"
27#include "CertificateImpl.h"
28#include <map>
29#include <vector>
30#include <iprt/manifest.h>
31#include <iprt/vfs.h>
32#include <iprt/crypto/x509.h>
33
34////////////////////////////////////////////////////////////////////////////////
35//
36// Appliance data definition
37//
38////////////////////////////////////////////////////////////////////////////////
39
40namespace settings
41{
42 struct AttachedDevice;
43}
44
45typedef std::pair<Utf8Str, Utf8Str> STRPAIR;
46
47typedef std::vector<com::Guid> GUIDVEC;
48
49/* Describe a location for the import/export. The location could be a file on a
50 * local hard disk or a remote target based on the supported inet protocols. */
51struct LocationInfo
52{
53 LocationInfo()
54 : storageType(VFSType_File) {}
55 VFSType_T storageType; /* Which type of storage should be handled */
56 Utf8Str strPath; /* File path for the import/export */
57 Utf8Str strHostname; /* Hostname on remote storage locations (could be empty) */
58 Utf8Str strUsername; /* Username on remote storage locations (could be empty) */
59 Utf8Str strPassword; /* Password on remote storage locations (could be empty) */
60};
61
62// opaque private instance data of Appliance class
63struct Appliance::Data
64{
65 enum ApplianceState { ApplianceIdle, ApplianceImporting, ApplianceExporting };
66 enum digest_T {SHA1, SHA256};
67
68 Data()
69 : state(ApplianceIdle)
70 , fDigestTypes(0)
71 , hOurManifest(NIL_RTMANIFEST)
72 , fManifest(true)
73 , fDeterminedDigestTypes(false)
74 , hTheirManifest(NIL_RTMANIFEST)
75 , hMemFileTheirManifest(NIL_RTVFSFILE)
76 , fSignerCertLoaded(false)
77 , fCertificateIsSelfSigned(false)
78 , fSignatureValid(false)
79 , fCertificateValid(false)
80 , fCertificateMissingPath(true)
81 , fCertificateValidTime(false)
82 , pbSignedDigest(NULL)
83 , cbSignedDigest(0)
84 , enmSignedDigestType(RTDIGESTTYPE_INVALID)
85 , fExportISOImages(false)
86 , pReader(NULL)
87 , ulWeightForXmlOperation(0)
88 , ulWeightForManifestOperation(0)
89 , ulTotalDisksMB(0)
90 , cDisks(0)
91 , m_cPwProvided(0)
92 {
93 }
94
95 ~Data()
96 {
97 if (pReader)
98 {
99 delete pReader;
100 pReader = NULL;
101 }
102 resetReadData();
103 }
104
105 /**
106 * Resets data used by read.
107 */
108 void resetReadData(void)
109 {
110 strOvfManifestEntry.setNull();
111 if (hOurManifest != NIL_RTMANIFEST)
112 {
113 RTManifestRelease(hOurManifest);
114 hOurManifest = NIL_RTMANIFEST;
115 }
116 if (hTheirManifest != NIL_RTMANIFEST)
117 {
118 RTManifestRelease(hTheirManifest);
119 hTheirManifest = NIL_RTMANIFEST;
120 }
121 if (hMemFileTheirManifest)
122 {
123 RTVfsFileRelease(hMemFileTheirManifest);
124 hMemFileTheirManifest = NIL_RTVFSFILE;
125 }
126 if (pbSignedDigest)
127 {
128 RTMemFree(pbSignedDigest);
129 pbSignedDigest = NULL;
130 cbSignedDigest = 0;
131 }
132 if (fSignerCertLoaded)
133 {
134 RTCrX509Certificate_Delete(&SignerCert);
135 fSignerCertLoaded = false;
136 }
137 enmSignedDigestType = RTDIGESTTYPE_INVALID;
138 fCertificateIsSelfSigned = false;
139 fSignatureValid = false;
140 fCertificateValid = false;
141 fCertificateMissingPath = true;
142 fCertificateValidTime = false;
143 fDeterminedDigestTypes = false;
144 fDigestTypes = RTMANIFEST_ATTR_SHA1 | RTMANIFEST_ATTR_SHA256 | RTMANIFEST_ATTR_SHA512;
145 ptrCertificateInfo.setNull();
146 strCertError.setNull();
147 }
148
149 ApplianceState state;
150
151 LocationInfo locInfo; // location info for the currently processed OVF
152 /** The digests types to calculate (RTMANIFEST_ATTR_XXX) for the manifest.
153 * This will be a single value when exporting. Zero, one or two. */
154 uint32_t fDigestTypes;
155 /** Manifest created while importing or exporting. */
156 RTMANIFEST hOurManifest;
157
158 /** @name Write data
159 * @{ */
160 bool fManifest; // Create a manifest file on export
161 /** @} */
162
163 /** @name Read data
164 * @{ */
165 /** The manifest entry name of the OVF-file. */
166 Utf8Str strOvfManifestEntry;
167
168 /** Set if we've parsed the manifest and determined the digest types. */
169 bool fDeterminedDigestTypes;
170
171 /** Manifest read in during read() and kept around for later verification. */
172 RTMANIFEST hTheirManifest;
173 /** Memorized copy of the manifest file for signature checking purposes. */
174 RTVFSFILE hMemFileTheirManifest;
175
176 /** The signer certificate from the signature file (.cert).
177 * This will be used in the future provide information about the signer via
178 * the API. */
179 RTCRX509CERTIFICATE SignerCert;
180 /** Set if the SignerCert member contains usable data. */
181 bool fSignerCertLoaded;
182 /** Cached RTCrX509Validity_IsValidAtTimeSpec result set by read(). */
183 bool fCertificateIsSelfSigned;
184 /** Set by read() if pbSignedDigest verified correctly against SignerCert. */
185 bool fSignatureValid;
186 /** Set by read() when the SignerCert checked out fine. */
187 bool fCertificateValid;
188 /** Set by read() when the SignerCert certificate path couldn't be built. */
189 bool fCertificateMissingPath;
190 /** Set by read() when the SignerCert (+path) is valid in the temporal sense. */
191 bool fCertificateValidTime;
192 /** For keeping certificate error messages we delay from read() to import(). */
193 Utf8Str strCertError;
194 /** The signed digest of the manifest. */
195 uint8_t *pbSignedDigest;
196 /** The size of the signed digest. */
197 size_t cbSignedDigest;
198 /** The digest type used to sign the manifest. */
199 RTDIGESTTYPE enmSignedDigestType;
200 /** The certificate info object. This is NULL if no signature and
201 * successfully loaded certificate. */
202 ComObjPtr<Certificate> ptrCertificateInfo;
203 /** @} */
204
205 bool fExportISOImages;// when 1 the ISO images are exported
206
207 RTCList<ImportOptions_T> optListImport;
208 RTCList<ExportOptions_T> optListExport;
209
210 ovf::OVFReader *pReader;
211
212 std::list< ComObjPtr<VirtualSystemDescription> >
213 virtualSystemDescriptions;
214
215 std::list<Utf8Str> llWarnings;
216
217 ULONG ulWeightForXmlOperation;
218 ULONG ulWeightForManifestOperation;
219 ULONG ulTotalDisksMB;
220 ULONG cDisks;
221
222 std::list<Guid> llGuidsMachinesCreated;
223
224 /** Sequence of password identifiers to encrypt disk images during export. */
225 std::vector<com::Utf8Str> m_vecPasswordIdentifiers;
226 /** Map to get all medium identifiers assoicated with a given password identifier. */
227 std::map<com::Utf8Str, GUIDVEC> m_mapPwIdToMediumIds;
228 /** Secret key store used to hold the passwords during export. */
229 SecretKeyStore *m_pSecretKeyStore;
230 /** Number of passwords provided. */
231 uint32_t m_cPwProvided;
232};
233
234struct Appliance::XMLStack
235{
236 std::map<Utf8Str, const VirtualSystemDescriptionEntry*> mapDisks;
237 std::list<Utf8Str> mapDiskSequence;
238 std::list<Utf8Str> mapDiskSequenceForOneVM;//temporary keeps all disks attached to one exported VM
239 std::map<Utf8Str, bool> mapNetworks;
240};
241
242class Appliance::TaskOVF : public ThreadTask
243{
244public:
245 enum TaskType
246 {
247 Read,
248 Import,
249 Write
250 };
251
252 TaskOVF(Appliance *aThat,
253 TaskType aType,
254 LocationInfo aLocInfo,
255 ComObjPtr<Progress> &aProgress)
256 : ThreadTask("TaskOVF"),
257 pAppliance(aThat),
258 taskType(aType),
259 locInfo(aLocInfo),
260 pProgress(aProgress),
261 enFormat(ovf::OVFVersion_unknown),
262 rc(S_OK)
263 {
264 switch (taskType)
265 {
266 case TaskOVF::Read: m_strTaskName = "ApplRead"; break;
267 case TaskOVF::Import: m_strTaskName = "ApplImp"; break;
268 case TaskOVF::Write: m_strTaskName = "ApplWrit"; break;
269 default: m_strTaskName = "ApplTask"; break;
270 }
271 }
272
273 static DECLCALLBACK(int) updateProgress(unsigned uPercent, void *pvUser);
274
275 Appliance *pAppliance;
276 TaskType taskType;
277 const LocationInfo locInfo;
278 ComObjPtr<Progress> pProgress;
279
280 ovf::OVFVersion_T enFormat;
281
282 HRESULT rc;
283
284 void handler()
285 {
286 Appliance::i_importOrExportThreadTask(this);
287 }
288};
289
290struct MyHardDiskAttachment
291{
292 ComPtr<IMachine> pMachine;
293 Utf8Str controllerName;
294 int32_t lControllerPort; // 0-29 for SATA
295 int32_t lDevice; // IDE: 0 or 1, otherwise 0 always
296};
297
298/**
299 * Used by Appliance::importMachineGeneric() to store
300 * input parameters and rollback information.
301 */
302struct Appliance::ImportStack
303{
304 // input pointers
305 const LocationInfo &locInfo; // ptr to location info from Appliance::importFS()
306 Utf8Str strSourceDir; // directory where source files reside
307 const ovf::DiskImagesMap &mapDisks; // ptr to disks map in OVF
308 ComObjPtr<Progress> &pProgress; // progress object passed into Appliance::importFS()
309
310 // input parameters from VirtualSystemDescriptions
311 Utf8Str strNameVBox; // VM name
312 Utf8Str strMachineFolder; // FQ host folder where the VirtualBox machine would be created
313 Utf8Str strOsTypeVBox; // VirtualBox guest OS type as string
314 Utf8Str strDescription;
315 uint32_t cCPUs; // CPU count
316 bool fForceHWVirt; // if true, we force enabling hardware virtualization
317 bool fForceIOAPIC; // if true, we force enabling the IOAPIC
318 uint32_t ulMemorySizeMB; // virtual machine RAM in megabytes
319#ifdef VBOX_WITH_USB
320 bool fUSBEnabled;
321#endif
322 Utf8Str strAudioAdapter; // if not empty, then the guest has audio enabled, and this is the decimal
323 // representation of the audio adapter (should always be "0" for AC97 presently)
324
325 // session (not initially created)
326 ComPtr<ISession> pSession; // session opened in Appliance::importFS() for machine manipulation
327 bool fSessionOpen; // true if the pSession is currently open and needs closing
328
329 /** @name File access related stuff (TAR stream)
330 * @{ */
331 /** OVA file system stream handle. NIL if not OVA. */
332 RTVFSFSSTREAM hVfsFssOva;
333 /** OVA lookahead I/O stream object. */
334 RTVFSIOSTREAM hVfsIosOvaLookAhead;
335 /** OVA lookahead I/O stream object name. */
336 char *pszOvaLookAheadName;
337 /** @} */
338
339 // a list of images that we created/imported; this is initially empty
340 // and will be cleaned up on errors
341 std::list<MyHardDiskAttachment> llHardDiskAttachments; // disks that were attached
342 std::map<Utf8Str , Utf8Str> mapNewUUIDsToOriginalUUIDs;
343
344 ImportStack(const LocationInfo &aLocInfo,
345 const ovf::DiskImagesMap &aMapDisks,
346 ComObjPtr<Progress> &aProgress,
347 RTVFSFSSTREAM aVfsFssOva)
348 : locInfo(aLocInfo),
349 mapDisks(aMapDisks),
350 pProgress(aProgress),
351 cCPUs(1),
352 fForceHWVirt(false),
353 fForceIOAPIC(false),
354 ulMemorySizeMB(0),
355 fSessionOpen(false),
356 hVfsFssOva(aVfsFssOva),
357 hVfsIosOvaLookAhead(NIL_RTVFSIOSTREAM),
358 pszOvaLookAheadName(NULL)
359 {
360 if (hVfsFssOva != NIL_RTVFSFSSTREAM)
361 RTVfsFsStrmRetain(hVfsFssOva);
362
363 // disk images have to be on the same place as the OVF file. So
364 // strip the filename out of the full file path
365 strSourceDir = aLocInfo.strPath;
366 strSourceDir.stripFilename();
367 }
368
369 ~ImportStack()
370 {
371 if (hVfsFssOva != NIL_RTVFSFSSTREAM)
372 {
373 RTVfsFsStrmRelease(hVfsFssOva);
374 hVfsFssOva = NIL_RTVFSFSSTREAM;
375 }
376 if (hVfsIosOvaLookAhead != NIL_RTVFSIOSTREAM)
377 {
378 RTVfsIoStrmRelease(hVfsIosOvaLookAhead);
379 hVfsIosOvaLookAhead = NIL_RTVFSIOSTREAM;
380 }
381 if (pszOvaLookAheadName)
382 {
383 RTStrFree(pszOvaLookAheadName);
384 pszOvaLookAheadName = NULL;
385 }
386 }
387
388 HRESULT restoreOriginalUUIDOfAttachedDevice(settings::MachineConfigFile *config);
389 HRESULT saveOriginalUUIDOfAttachedDevice(settings::AttachedDevice &device,
390 const Utf8Str &newlyUuid);
391 RTVFSIOSTREAM claimOvaLookAHead(void);
392
393};
394
395////////////////////////////////////////////////////////////////////////////////
396//
397// VirtualSystemDescription data definition
398//
399////////////////////////////////////////////////////////////////////////////////
400
401struct VirtualSystemDescription::Data
402{
403 std::vector<VirtualSystemDescriptionEntry>
404 maDescriptions; // item descriptions
405
406 ComPtr<Machine> pMachine; // VirtualBox machine this description was exported from (export only)
407
408 settings::MachineConfigFile
409 *pConfig; // machine config created from <vbox:Machine> element if found (import only)
410};
411
412////////////////////////////////////////////////////////////////////////////////
413//
414// Internal helpers
415//
416////////////////////////////////////////////////////////////////////////////////
417
418void convertCIMOSType2VBoxOSType(Utf8Str &strType, ovf::CIMOSType_T c, const Utf8Str &cStr);
419
420ovf::CIMOSType_T convertVBoxOSType2CIMOSType(const char *pcszVBox, BOOL fLongMode);
421
422Utf8Str convertNetworkAttachmentTypeToString(NetworkAttachmentType_T type);
423
424
425#endif // !____H_APPLIANCEIMPLPRIVATE
426
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