1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
|
/* $Id: ExtPackUtil.cpp $ */
/** @file
* VirtualBox Main - Extension Pack Utilities and definitions, VBoxC, VBoxSVC, ++.
*/
/*
* Copyright (C) 2010-2022 Oracle and/or its affiliates.
*
* This file is part of VirtualBox base platform packages, as
* available from https://www.virtualbox.org.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation, in version 3 of the
* License.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, see <https://www.gnu.org/licenses>.
*
* SPDX-License-Identifier: GPL-3.0-only
*/
/*********************************************************************************************************************************
* Header Files *
*********************************************************************************************************************************/
#include "../include/ExtPackUtil.h"
#include <iprt/ctype.h>
#include <iprt/dir.h>
#include <iprt/err.h>
#include <iprt/file.h>
#include <iprt/manifest.h>
#include <iprt/param.h>
#include <iprt/path.h>
#include <iprt/sha.h>
#include <iprt/string.h>
#include <iprt/vfs.h>
#include <iprt/tar.h>
#include <iprt/zip.h>
#include <iprt/cpp/xml.h>
#include <VBox/log.h>
#include "../include/VBoxNls.h"
/*********************************************************************************************************************************
* Defined Constants And Macros *
*********************************************************************************************************************************/
DECLARE_TRANSLATION_CONTEXT(ExtPackUtil);
/*********************************************************************************************************************************
* Functions *
*********************************************************************************************************************************/
/**
* Worker for VBoxExtPackLoadDesc that loads the plug-in descriptors.
*
* @returns Same as VBoxExtPackLoadDesc.
* @param pVBoxExtPackElm
* @param pcPlugIns Where to return the number of plug-ins in the
* array.
* @param paPlugIns Where to return the plug-in descriptor array.
* (RTMemFree it even on failure)
*/
static RTCString *
vboxExtPackLoadPlugInDescs(const xml::ElementNode *pVBoxExtPackElm,
uint32_t *pcPlugIns, PVBOXEXTPACKPLUGINDESC *paPlugIns)
{
*pcPlugIns = 0;
*paPlugIns = NULL;
/** @todo plug-ins */
NOREF(pVBoxExtPackElm);
return NULL;
}
/**
* Clears the extension pack descriptor.
*
* @param a_pExtPackDesc The descriptor to clear.
*/
static void vboxExtPackClearDesc(PVBOXEXTPACKDESC a_pExtPackDesc)
{
a_pExtPackDesc->strName.setNull();
a_pExtPackDesc->strDescription.setNull();
a_pExtPackDesc->strVersion.setNull();
a_pExtPackDesc->strEdition.setNull();
a_pExtPackDesc->uRevision = 0;
a_pExtPackDesc->strMainModule.setNull();
a_pExtPackDesc->strMainVMModule.setNull();
a_pExtPackDesc->strVrdeModule.setNull();
a_pExtPackDesc->strCryptoModule.setNull();
a_pExtPackDesc->cPlugIns = 0;
a_pExtPackDesc->paPlugIns = NULL;
a_pExtPackDesc->fShowLicense = false;
}
/**
* Initializes an extension pack descriptor so that it's safe to call free on
* it whatever happens later on.
*
* @param a_pExtPackDesc The descirptor to initialize.
*/
void VBoxExtPackInitDesc(PVBOXEXTPACKDESC a_pExtPackDesc)
{
vboxExtPackClearDesc(a_pExtPackDesc);
}
/**
* Load the extension pack descriptor from an XML document.
*
* @returns NULL on success, pointer to an error message on failure (caller
* deletes it).
* @param a_pDoc Pointer to the XML document.
* @param a_pExtPackDesc Where to store the extension pack descriptor.
*/
static RTCString *vboxExtPackLoadDescFromDoc(xml::Document *a_pDoc, PVBOXEXTPACKDESC a_pExtPackDesc)
{
/*
* Get the main element and check its version.
*/
const xml::ElementNode *pVBoxExtPackElm = a_pDoc->getRootElement();
if ( !pVBoxExtPackElm
|| strcmp(pVBoxExtPackElm->getName(), "VirtualBoxExtensionPack") != 0)
return new RTCString(ExtPackUtil::tr("No VirtualBoxExtensionPack element"));
RTCString strFormatVersion;
if (!pVBoxExtPackElm->getAttributeValueN("version", strFormatVersion, RT_XML_ATTR_TINY))
return new RTCString(ExtPackUtil::tr("Missing format version"));
if (!strFormatVersion.equals("1.0"))
return &(new RTCString(ExtPackUtil::tr("Unsupported format version: ")))->append(strFormatVersion);
/*
* Read and validate mandatory bits.
*/
const xml::ElementNode *pNameElm = pVBoxExtPackElm->findChildElement("Name");
if (!pNameElm)
return new RTCString(ExtPackUtil::tr("The 'Name' element is missing"));
const char *pszName = pNameElm->getValueN(RT_XML_CONTENT_SMALL);
if (!VBoxExtPackIsValidName(pszName))
return &(new RTCString(ExtPackUtil::tr("Invalid name: ")))->append(pszName);
const xml::ElementNode *pDescElm = pVBoxExtPackElm->findChildElement("Description");
if (!pDescElm)
return new RTCString(ExtPackUtil::tr("The 'Description' element is missing"));
const char *pszDesc = pDescElm->getValueN(RT_XML_CONTENT_LARGE);
if (!pszDesc || *pszDesc == '\0')
return new RTCString(ExtPackUtil::tr("The 'Description' element is empty"));
if (strpbrk(pszDesc, "\n\r\t\v\b") != NULL)
return new RTCString(ExtPackUtil::tr("The 'Description' must not contain control characters"));
const xml::ElementNode *pVersionElm = pVBoxExtPackElm->findChildElement("Version");
if (!pVersionElm)
return new RTCString(ExtPackUtil::tr("The 'Version' element is missing"));
const char *pszVersion = pVersionElm->getValueN(RT_XML_CONTENT_SMALL);
if (!pszVersion || *pszVersion == '\0')
return new RTCString(ExtPackUtil::tr("The 'Version' element is empty"));
if (!VBoxExtPackIsValidVersionString(pszVersion))
return &(new RTCString(ExtPackUtil::tr("Invalid version string: ")))->append(pszVersion);
uint32_t uRevision;
if (!pVersionElm->getAttributeValue("revision", uRevision))
uRevision = 0;
const char *pszEdition;
if (!pVersionElm->getAttributeValueN("edition", pszEdition, RT_XML_ATTR_TINY))
pszEdition = "";
if (!VBoxExtPackIsValidEditionString(pszEdition))
return &(new RTCString(ExtPackUtil::tr("Invalid edition string: ")))->append(pszEdition);
const xml::ElementNode *pMainModuleElm = pVBoxExtPackElm->findChildElement("MainModule");
if (!pMainModuleElm)
return new RTCString(ExtPackUtil::tr("The 'MainModule' element is missing"));
const char *pszMainModule = pMainModuleElm->getValueN(RT_XML_CONTENT_SMALL);
if (!pszMainModule || *pszMainModule == '\0')
return new RTCString(ExtPackUtil::tr("The 'MainModule' element is empty"));
if (!VBoxExtPackIsValidModuleString(pszMainModule))
return &(new RTCString(ExtPackUtil::tr("Invalid main module string: ")))->append(pszMainModule);
/*
* The main VM module, optional.
* Accept both none and empty as tokens of no main VM module.
*/
const char *pszMainVMModule = NULL;
const xml::ElementNode *pMainVMModuleElm = pVBoxExtPackElm->findChildElement("MainVMModule");
if (pMainVMModuleElm)
{
pszMainVMModule = pMainVMModuleElm->getValueN(RT_XML_CONTENT_SMALL);
if (!pszMainVMModule || *pszMainVMModule == '\0')
pszMainVMModule = NULL;
else if (!VBoxExtPackIsValidModuleString(pszMainVMModule))
return &(new RTCString(ExtPackUtil::tr("Invalid main VM module string: ")))->append(pszMainVMModule);
}
/*
* The VRDE module, optional.
* Accept both none and empty as tokens of no VRDE module.
*/
const char *pszVrdeModule = NULL;
const xml::ElementNode *pVrdeModuleElm = pVBoxExtPackElm->findChildElement("VRDEModule");
if (pVrdeModuleElm)
{
pszVrdeModule = pVrdeModuleElm->getValueN(RT_XML_CONTENT_SMALL);
if (!pszVrdeModule || *pszVrdeModule == '\0')
pszVrdeModule = NULL;
else if (!VBoxExtPackIsValidModuleString(pszVrdeModule))
return &(new RTCString(ExtPackUtil::tr("Invalid VRDE module string: ")))->append(pszVrdeModule);
}
/*
* The cryptographic module, optional.
* Accept both none and empty as tokens of no cryptographic module.
*/
const char *pszCryptoModule = NULL;
const xml::ElementNode *pCryptoModuleElm = pVBoxExtPackElm->findChildElement("CryptoModule");
if (pCryptoModuleElm)
{
pszCryptoModule = pCryptoModuleElm->getValueN(RT_XML_CONTENT_SMALL);
if (!pszCryptoModule || *pszCryptoModule == '\0')
pszCryptoModule = NULL;
else if (!VBoxExtPackIsValidModuleString(pszCryptoModule))
return &(new RTCString(ExtPackUtil::tr("Invalid cryptographic module string: ")))->append(pszCryptoModule);
}
/*
* Whether to show the license, optional. (presense is enough here)
*/
const xml::ElementNode *pShowLicenseElm = pVBoxExtPackElm->findChildElement("ShowLicense");
bool fShowLicense = pShowLicenseElm != NULL;
/*
* Parse plug-in descriptions (last because of the manual memory management).
*/
uint32_t cPlugIns = 0;
PVBOXEXTPACKPLUGINDESC paPlugIns = NULL;
RTCString *pstrRet = vboxExtPackLoadPlugInDescs(pVBoxExtPackElm, &cPlugIns, &paPlugIns);
if (pstrRet)
{
RTMemFree(paPlugIns);
return pstrRet;
}
/*
* Everything seems fine, fill in the return values and return successfully.
*/
a_pExtPackDesc->strName = pszName;
a_pExtPackDesc->strDescription = pszDesc;
a_pExtPackDesc->strVersion = pszVersion;
a_pExtPackDesc->strEdition = pszEdition;
a_pExtPackDesc->uRevision = uRevision;
a_pExtPackDesc->strMainModule = pszMainModule;
a_pExtPackDesc->strMainVMModule = pszMainVMModule;
a_pExtPackDesc->strVrdeModule = pszVrdeModule;
a_pExtPackDesc->strCryptoModule = pszCryptoModule;
a_pExtPackDesc->cPlugIns = cPlugIns;
a_pExtPackDesc->paPlugIns = paPlugIns;
a_pExtPackDesc->fShowLicense = fShowLicense;
return NULL;
}
/**
* Reads the extension pack descriptor.
*
* @returns NULL on success, pointer to an error message on failure (caller
* deletes it).
* @param a_pszDir The directory containing the description file.
* @param a_pExtPackDesc Where to store the extension pack descriptor.
* @param a_pObjInfo Where to store the object info for the file (unix
* attribs). Optional.
*/
RTCString *VBoxExtPackLoadDesc(const char *a_pszDir, PVBOXEXTPACKDESC a_pExtPackDesc, PRTFSOBJINFO a_pObjInfo)
{
vboxExtPackClearDesc(a_pExtPackDesc);
/*
* Validate, open and parse the XML file.
*/
char szFilePath[RTPATH_MAX];
int vrc = RTPathJoin(szFilePath, sizeof(szFilePath), a_pszDir, VBOX_EXTPACK_DESCRIPTION_NAME);
if (RT_FAILURE(vrc))
return new RTCStringFmt(ExtPackUtil::tr("RTPathJoin failed with %Rrc"), vrc);
RTFSOBJINFO ObjInfo;
vrc = RTPathQueryInfoEx(szFilePath, &ObjInfo, RTFSOBJATTRADD_UNIX, RTPATH_F_ON_LINK);
if (RT_FAILURE(vrc))
return new RTCStringFmt(ExtPackUtil::tr("RTPathQueryInfoEx failed with %Rrc"), vrc);
if (a_pObjInfo)
*a_pObjInfo = ObjInfo;
if (!RTFS_IS_FILE(ObjInfo.Attr.fMode))
{
if (RTFS_IS_SYMLINK(ObjInfo.Attr.fMode))
return new RTCString(ExtPackUtil::tr("The XML file is symlinked, that is not allowed"));
return new RTCStringFmt(ExtPackUtil::tr("The XML file is not a file (fMode=%#x)"), ObjInfo.Attr.fMode);
}
xml::Document Doc;
{
xml::XmlFileParser Parser;
try
{
Parser.read(szFilePath, Doc);
}
catch (xml::XmlError &rErr)
{
return new RTCString(rErr.what());
}
}
/*
* Hand the xml doc over to the common code.
*/
try
{
return vboxExtPackLoadDescFromDoc(&Doc, a_pExtPackDesc);
}
catch (RTCError &rXcpt) // includes all XML exceptions
{
return new RTCString(rXcpt.what());
}
}
/**
* Reads the extension pack descriptor.
*
* @returns NULL on success, pointer to an error message on failure (caller
* deletes it).
* @param hVfsFile The file handle of the description file.
* @param a_pExtPackDesc Where to store the extension pack descriptor.
* @param a_pObjInfo Where to store the object info for the file (unix
* attribs). Optional.
*/
RTCString *VBoxExtPackLoadDescFromVfsFile(RTVFSFILE hVfsFile, PVBOXEXTPACKDESC a_pExtPackDesc, PRTFSOBJINFO a_pObjInfo)
{
vboxExtPackClearDesc(a_pExtPackDesc);
/*
* Query the object info.
*/
RTFSOBJINFO ObjInfo;
int vrc = RTVfsFileQueryInfo(hVfsFile, &ObjInfo, RTFSOBJATTRADD_UNIX);
if (RT_FAILURE(vrc))
return &(new RTCString)->printf(ExtPackUtil::tr("RTVfsFileQueryInfo failed: %Rrc"), vrc);
if (a_pObjInfo)
*a_pObjInfo = ObjInfo;
/*
* The simple approach, read the whole thing into memory and pass this to
* the XML parser.
*/
/* Check the file size. */
if (ObjInfo.cbObject > _1M || ObjInfo.cbObject < 0)
return &(new RTCString)->printf(ExtPackUtil::tr("The XML file is too large (%'RU64 bytes)", "", (size_t)ObjInfo.cbObject),
ObjInfo.cbObject);
size_t const cbFile = (size_t)ObjInfo.cbObject;
/* Rewind to the start of the file. */
vrc = RTVfsFileSeek(hVfsFile, 0, RTFILE_SEEK_BEGIN, NULL);
if (RT_FAILURE(vrc))
return &(new RTCString)->printf(ExtPackUtil::tr("RTVfsFileSeek(,0,BEGIN) failed: %Rrc"), vrc);
/* Allocate memory and read the file content into it. */
void *pvFile = RTMemTmpAlloc(cbFile);
if (!pvFile)
return &(new RTCString)->printf(ExtPackUtil::tr("RTMemTmpAlloc(%zu) failed"), cbFile);
RTCString *pstrErr = NULL;
vrc = RTVfsFileRead(hVfsFile, pvFile, cbFile, NULL);
if (RT_FAILURE(vrc))
pstrErr = &(new RTCString)->printf(ExtPackUtil::tr("RTVfsFileRead failed: %Rrc"), vrc);
/*
* Parse the file.
*/
xml::Document Doc;
if (RT_SUCCESS(vrc))
{
xml::XmlMemParser Parser;
RTCString strFileName = VBOX_EXTPACK_DESCRIPTION_NAME;
try
{
Parser.read(pvFile, cbFile, strFileName, Doc);
}
catch (xml::XmlError &rErr)
{
pstrErr = new RTCString(rErr.what());
vrc = VERR_PARSE_ERROR;
}
}
RTMemTmpFree(pvFile);
/*
* Hand the xml doc over to the common code.
*/
if (RT_SUCCESS(vrc))
try
{
pstrErr = vboxExtPackLoadDescFromDoc(&Doc, a_pExtPackDesc);
}
catch (RTCError &rXcpt) // includes all XML exceptions
{
return new RTCString(rXcpt.what());
}
return pstrErr;
}
/**
* Frees all resources associated with a extension pack descriptor.
*
* @param a_pExtPackDesc The extension pack descriptor which members
* should be freed.
*/
void VBoxExtPackFreeDesc(PVBOXEXTPACKDESC a_pExtPackDesc)
{
if (!a_pExtPackDesc)
return;
a_pExtPackDesc->strName.setNull();
a_pExtPackDesc->strDescription.setNull();
a_pExtPackDesc->strVersion.setNull();
a_pExtPackDesc->strEdition.setNull();
a_pExtPackDesc->uRevision = 0;
a_pExtPackDesc->strMainModule.setNull();
a_pExtPackDesc->strMainVMModule.setNull();
a_pExtPackDesc->strVrdeModule.setNull();
a_pExtPackDesc->strCryptoModule.setNull();
a_pExtPackDesc->cPlugIns = 0;
RTMemFree(a_pExtPackDesc->paPlugIns);
a_pExtPackDesc->paPlugIns = NULL;
a_pExtPackDesc->fShowLicense = false;
}
/**
* Extract the extension pack name from the tarball path.
*
* @returns String containing the name on success, the caller must delete it.
* NULL if no valid name was found or if we ran out of memory.
* @param pszTarball The path to the tarball.
*/
RTCString *VBoxExtPackExtractNameFromTarballPath(const char *pszTarball)
{
/*
* Skip ahead to the filename part and count the number of characters
* that matches the criteria for a mangled extension pack name.
*/
const char *pszSrc = RTPathFilename(pszTarball);
if (!pszSrc)
return NULL;
size_t off = 0;
while (RT_C_IS_ALNUM(pszSrc[off]) || pszSrc[off] == '_')
off++;
/*
* Check min and max name limits.
*/
if ( off > VBOX_EXTPACK_NAME_MAX_LEN
|| off < VBOX_EXTPACK_NAME_MIN_LEN)
return NULL;
/*
* Return the unmangled name.
*/
return VBoxExtPackUnmangleName(pszSrc, off);
}
/**
* Validates the extension pack name.
*
* @returns true if valid, false if not.
* @param pszName The name to validate.
* @sa VBoxExtPackExtractNameFromTarballPath
*/
bool VBoxExtPackIsValidName(const char *pszName)
{
if (!pszName)
return false;
/*
* Check the characters making up the name, only english alphabet
* characters, decimal digits and spaces are allowed.
*/
size_t off = 0;
while (pszName[off])
{
if (!RT_C_IS_ALNUM(pszName[off]) && pszName[off] != ' ')
return false;
off++;
}
/*
* Check min and max name limits.
*/
if ( off > VBOX_EXTPACK_NAME_MAX_LEN
|| off < VBOX_EXTPACK_NAME_MIN_LEN)
return false;
return true;
}
/**
* Checks if an alledged manged extension pack name.
*
* @returns true if valid, false if not.
* @param pszMangledName The mangled name to validate.
* @param cchMax The max number of chars to test.
* @sa VBoxExtPackMangleName
*/
bool VBoxExtPackIsValidMangledName(const char *pszMangledName, size_t cchMax /*= RTSTR_MAX*/)
{
if (!pszMangledName)
return false;
/*
* Check the characters making up the name, only english alphabet
* characters, decimal digits and underscores (=space) are allowed.
*/
size_t off = 0;
while (off < cchMax && pszMangledName[off])
{
if (!RT_C_IS_ALNUM(pszMangledName[off]) && pszMangledName[off] != '_')
return false;
off++;
}
/*
* Check min and max name limits.
*/
if ( off > VBOX_EXTPACK_NAME_MAX_LEN
|| off < VBOX_EXTPACK_NAME_MIN_LEN)
return false;
return true;
}
/**
* Mangle an extension pack name so it can be used by a directory or file name.
*
* @returns String containing the mangled name on success, the caller must
* delete it. NULL on failure.
* @param pszName The unmangled name.
* @sa VBoxExtPackUnmangleName, VBoxExtPackIsValidMangledName
*/
RTCString *VBoxExtPackMangleName(const char *pszName)
{
AssertReturn(VBoxExtPackIsValidName(pszName), NULL);
char szTmp[VBOX_EXTPACK_NAME_MAX_LEN + 1];
size_t off = 0;
char ch;
while ((ch = pszName[off]) != '\0')
{
if (ch == ' ')
ch = '_';
szTmp[off++] = ch;
}
szTmp[off] = '\0';
Assert(VBoxExtPackIsValidMangledName(szTmp));
return new RTCString(szTmp, off);
}
/**
* Unmangle an extension pack name (reverses VBoxExtPackMangleName).
*
* @returns String containing the mangled name on success, the caller must
* delete it. NULL on failure.
* @param pszMangledName The mangled name.
* @param cchMax The max name length. RTSTR_MAX is fine.
* @sa VBoxExtPackMangleName, VBoxExtPackIsValidMangledName
*/
RTCString *VBoxExtPackUnmangleName(const char *pszMangledName, size_t cchMax)
{
AssertReturn(VBoxExtPackIsValidMangledName(pszMangledName, cchMax), NULL);
char szTmp[VBOX_EXTPACK_NAME_MAX_LEN + 1];
size_t off = 0;
char ch;
while ( off < cchMax
&& (ch = pszMangledName[off]) != '\0')
{
if (ch == '_')
ch = ' ';
else
AssertReturn(RT_C_IS_ALNUM(ch) || ch == ' ', NULL);
szTmp[off++] = ch;
}
szTmp[off] = '\0';
AssertReturn(VBoxExtPackIsValidName(szTmp), NULL);
return new RTCString(szTmp, off);
}
/**
* Constructs the extension pack directory path.
*
* A combination of RTPathJoin and VBoxExtPackMangleName.
*
* @returns IPRT status code like RTPathJoin.
* @param pszExtPackDir Where to return the directory path.
* @param cbExtPackDir The size of the return buffer.
* @param pszParentDir The parent directory (".../Extensions").
* @param pszName The extension pack name, unmangled.
*/
int VBoxExtPackCalcDir(char *pszExtPackDir, size_t cbExtPackDir, const char *pszParentDir, const char *pszName)
{
AssertReturn(VBoxExtPackIsValidName(pszName), VERR_INTERNAL_ERROR_5);
RTCString *pstrMangledName = VBoxExtPackMangleName(pszName);
if (!pstrMangledName)
return VERR_INTERNAL_ERROR_4;
int vrc = RTPathJoin(pszExtPackDir, cbExtPackDir, pszParentDir, pstrMangledName->c_str());
delete pstrMangledName;
return vrc;
}
/**
* Validates the extension pack version string.
*
* @returns true if valid, false if not.
* @param pszVersion The version string to validate.
*/
bool VBoxExtPackIsValidVersionString(const char *pszVersion)
{
if (!pszVersion || *pszVersion == '\0')
return false;
/* 1.x.y.z... */
for (;;)
{
if (!RT_C_IS_DIGIT(*pszVersion))
return false;
do
pszVersion++;
while (RT_C_IS_DIGIT(*pszVersion));
if (*pszVersion != '.')
break;
pszVersion++;
}
/* upper case string + numbers indicating the build type */
if (*pszVersion == '-' || *pszVersion == '_')
{
/** @todo Should probably restrict this to known build types (alpha,
* beta, release candidate, ++). */
do
pszVersion++;
while ( RT_C_IS_DIGIT(*pszVersion)
|| RT_C_IS_UPPER(*pszVersion)
|| *pszVersion == '-'
|| *pszVersion == '_');
}
return *pszVersion == '\0';
}
/**
* Validates the extension pack edition string.
*
* @returns true if valid, false if not.
* @param pszEdition The edition string to validate.
*/
bool VBoxExtPackIsValidEditionString(const char *pszEdition)
{
if (*pszEdition)
{
if (!RT_C_IS_UPPER(*pszEdition))
return false;
do
pszEdition++;
while ( RT_C_IS_UPPER(*pszEdition)
|| RT_C_IS_DIGIT(*pszEdition)
|| *pszEdition == '-'
|| *pszEdition == '_');
}
return *pszEdition == '\0';
}
/**
* Validates an extension pack module string.
*
* @returns true if valid, false if not.
* @param pszModule The module string to validate.
*/
bool VBoxExtPackIsValidModuleString(const char *pszModule)
{
if (!pszModule || *pszModule == '\0')
return false;
/* Restricted charset, no extensions (dots). */
while ( RT_C_IS_ALNUM(*pszModule)
|| *pszModule == '-'
|| *pszModule == '_')
pszModule++;
return *pszModule == '\0';
}
/**
* RTStrPrintfv wrapper.
*
* @returns @a vrc
* @param vrc The status code to return.
* @param pszError The error buffer.
* @param cbError The size of the buffer.
* @param pszFormat The error message format string.
* @param ... Format arguments.
*/
static int vboxExtPackReturnError(int vrc, char *pszError, size_t cbError, const char *pszFormat, ...)
{
va_list va;
va_start(va, pszFormat);
RTStrPrintfV(pszError, cbError, pszFormat, va);
va_end(va);
return vrc;
}
/**
* RTStrPrintfv wrapper.
*
* @param pszError The error buffer.
* @param cbError The size of the buffer.
* @param pszFormat The error message format string.
* @param ... Format arguments.
*/
static void vboxExtPackSetError(char *pszError, size_t cbError, const char *pszFormat, ...)
{
va_list va;
va_start(va, pszFormat);
RTStrPrintfV(pszError, cbError, pszFormat, va);
va_end(va);
}
/**
* Verifies the manifest and its signature.
*
* @returns VBox status code, failures with message.
* @param hXmlFile The xml from the extension pack.
* @param pszExtPackName The expected extension pack name. This can be
* NULL, in which we don't have any expectations.
* @param pszError Where to store an error message on failure.
* @param cbError The size of the buffer @a pszError points to.
*/
static int vboxExtPackVerifyXml(RTVFSFILE hXmlFile, const char *pszExtPackName, char *pszError, size_t cbError)
{
/*
* Load the XML.
*/
VBOXEXTPACKDESC ExtPackDesc;
RTCString *pstrErr = VBoxExtPackLoadDescFromVfsFile(hXmlFile, &ExtPackDesc, NULL);
if (pstrErr)
{
RTStrCopy(pszError, cbError, pstrErr->c_str());
delete pstrErr;
return VERR_PARSE_ERROR;
}
/*
* Check the name.
*/
/** @todo drop this restriction after the old install interface is
* dropped. */
int vrc = VINF_SUCCESS;
if ( pszExtPackName
&& !ExtPackDesc.strName.equalsIgnoreCase(pszExtPackName))
vrc = vboxExtPackReturnError(VERR_NOT_EQUAL, pszError, cbError,
ExtPackUtil::tr("The name of the downloaded file and the name stored inside the extension pack does not match"
" (xml='%s' file='%s')"), ExtPackDesc.strName.c_str(), pszExtPackName);
return vrc;
}
/**
* Verifies the manifest and its signature.
*
* @returns VBox status code, failures with message.
* @param hOurManifest The manifest we compiled.
* @param hManifestFile The manifest file in the extension pack.
* @param hSignatureFile The manifest signature file.
* @param pszError Where to store an error message on failure.
* @param cbError The size of the buffer @a pszError points to.
*/
static int vboxExtPackVerifyManifestAndSignature(RTMANIFEST hOurManifest, RTVFSFILE hManifestFile, RTVFSFILE hSignatureFile,
char *pszError, size_t cbError)
{
/*
* Read the manifest from the extension pack.
*/
int vrc = RTVfsFileSeek(hManifestFile, 0, RTFILE_SEEK_BEGIN, NULL);
if (RT_FAILURE(vrc))
return vboxExtPackReturnError(vrc, pszError, cbError, ExtPackUtil::tr("RTVfsFileSeek failed: %Rrc"), vrc);
RTMANIFEST hTheirManifest;
vrc = RTManifestCreate(0 /*fFlags*/, &hTheirManifest);
if (RT_FAILURE(vrc))
return vboxExtPackReturnError(vrc, pszError, cbError, ExtPackUtil::tr("RTManifestCreate failed: %Rrc"), vrc);
RTVFSIOSTREAM hVfsIos = RTVfsFileToIoStream(hManifestFile);
vrc = RTManifestReadStandard(hTheirManifest, hVfsIos);
RTVfsIoStrmRelease(hVfsIos);
if (RT_SUCCESS(vrc))
{
/*
* Compare the manifests.
*/
static const char *s_apszIgnoreEntries[] =
{
VBOX_EXTPACK_MANIFEST_NAME,
VBOX_EXTPACK_SIGNATURE_NAME,
"./" VBOX_EXTPACK_MANIFEST_NAME,
"./" VBOX_EXTPACK_SIGNATURE_NAME,
NULL
};
char szError[RTPATH_MAX];
vrc = RTManifestEqualsEx(hOurManifest, hTheirManifest, &s_apszIgnoreEntries[0], NULL,
RTMANIFEST_EQUALS_IGN_MISSING_ATTRS /*fFlags*/,
szError, sizeof(szError));
if (RT_SUCCESS(vrc))
{
/*
* Validate the manifest file signature.
*/
/** @todo implement signature stuff */
NOREF(hSignatureFile);
}
else if (vrc == VERR_NOT_EQUAL && szError[0])
vboxExtPackSetError(pszError, cbError, ExtPackUtil::tr("Manifest mismatch: %s"), szError);
else
vboxExtPackSetError(pszError, cbError, ExtPackUtil::tr("RTManifestEqualsEx failed: %Rrc"), vrc);
#if 0
RTVFSIOSTREAM hVfsIosStdOut = NIL_RTVFSIOSTREAM;
RTVfsIoStrmFromStdHandle(RTHANDLESTD_OUTPUT, RTFILE_O_WRITE, true, &hVfsIosStdOut);
RTVfsIoStrmWrite(hVfsIosStdOut, "Our:\n", sizeof("Our:\n") - 1, true, NULL);
RTManifestWriteStandard(hOurManifest, hVfsIosStdOut);
RTVfsIoStrmWrite(hVfsIosStdOut, "Their:\n", sizeof("Their:\n") - 1, true, NULL);
RTManifestWriteStandard(hTheirManifest, hVfsIosStdOut);
#endif
}
else
vboxExtPackSetError(pszError, cbError, ExtPackUtil::tr("Error parsing '%s': %Rrc"), VBOX_EXTPACK_MANIFEST_NAME, vrc);
RTManifestRelease(hTheirManifest);
return vrc;
}
/**
* Verifies the file digest (if specified) and returns the SHA-256 of the file.
*
* @returns
* @param hFileManifest Manifest containing a SHA-256 digest of the file
* that was calculated as the file was processed.
* @param pszFileDigest SHA-256 digest of the file.
* @param pStrDigest Where to return the SHA-256 digest. Optional.
* @param pszError Where to write an error message on failure.
* @param cbError The size of the @a pszError buffer.
*/
static int vboxExtPackVerifyFileDigest(RTMANIFEST hFileManifest, const char *pszFileDigest,
RTCString *pStrDigest, char *pszError, size_t cbError)
{
/*
* Extract the SHA-256 entry for the extpack file.
*/
char szCalculatedDigest[RTSHA256_DIGEST_LEN + 1];
int vrc = RTManifestEntryQueryAttr(hFileManifest, "extpack", NULL /*no name*/, RTMANIFEST_ATTR_SHA256,
szCalculatedDigest, sizeof(szCalculatedDigest), NULL);
if (RT_SUCCESS(vrc))
{
/*
* Convert the two strings to binary form before comparing.
* We convert the calculated hash even if we don't have anything to
* compare with, just to validate it.
*/
uint8_t abCalculatedHash[RTSHA256_HASH_SIZE];
vrc = RTSha256FromString(szCalculatedDigest, abCalculatedHash);
if (RT_SUCCESS(vrc))
{
if ( pszFileDigest
&& *pszFileDigest != '\0')
{
uint8_t abFileHash[RTSHA256_HASH_SIZE];
vrc = RTSha256FromString(pszFileDigest, abFileHash);
if (RT_SUCCESS(vrc))
{
if (memcmp(abFileHash, abCalculatedHash, sizeof(abFileHash)))
{
vboxExtPackSetError(pszError, cbError,
ExtPackUtil::tr("The extension pack file has changed (SHA-256 mismatch)"));
vrc = VERR_NOT_EQUAL;
}
}
else
vboxExtPackSetError(pszError, cbError, ExtPackUtil::tr("Bad SHA-256 '%s': %Rrc"), szCalculatedDigest, vrc);
}
/*
* Set the output hash on success.
*/
if (pStrDigest && RT_SUCCESS(vrc))
{
try
{
*pStrDigest = szCalculatedDigest;
}
catch (std::bad_alloc &)
{
vrc = VERR_NO_MEMORY;
}
}
}
else
vboxExtPackSetError(pszError, cbError, ExtPackUtil::tr("Bad SHA-256 '%s': %Rrc"), szCalculatedDigest, vrc);
}
else
vboxExtPackSetError(pszError, cbError, "RTManifestEntryGetAttr: %Rrc", vrc);
return vrc;
}
/**
* Validates a standard file.
*
* Generally all files are
*
* @returns VBox status code, failure message in @a pszError.
* @param pszAdjName The adjusted member name.
* @param enmType The VFS object type.
* @param phVfsObj The pointer to the VFS object handle variable.
* This is both input and output.
* @param phVfsFile Where to store the handle to the memorized
* file. This is NULL for license files.
* @param pszError Where to write an error message on failure.
* @param cbError The size of the @a pszError buffer.
*/
static int VBoxExtPackValidateStandardFile(const char *pszAdjName, RTVFSOBJTYPE enmType,
PRTVFSOBJ phVfsObj, PRTVFSFILE phVfsFile, char *pszError, size_t cbError)
{
int vrc;
/*
* Make sure it's a file and that it isn't too large.
*/
if (phVfsFile && *phVfsFile != NIL_RTVFSFILE)
vrc = vboxExtPackReturnError(VERR_DUPLICATE, pszError, cbError,
ExtPackUtil::tr("There can only be one '%s'"), pszAdjName);
else if (enmType != RTVFSOBJTYPE_IO_STREAM && enmType != RTVFSOBJTYPE_FILE)
vrc = vboxExtPackReturnError(VERR_NOT_A_FILE, pszError, cbError,
ExtPackUtil::tr("Standard member '%s' is not a file"), pszAdjName);
else
{
RTFSOBJINFO ObjInfo;
vrc = RTVfsObjQueryInfo(*phVfsObj, &ObjInfo, RTFSOBJATTRADD_NOTHING);
if (RT_SUCCESS(vrc))
{
if (!RTFS_IS_FILE(ObjInfo.Attr.fMode))
vrc = vboxExtPackReturnError(VERR_NOT_A_FILE, pszError, cbError,
ExtPackUtil::tr("Standard member '%s' is not a file"), pszAdjName);
else if (ObjInfo.cbObject >= _1M)
vrc = vboxExtPackReturnError(VERR_OUT_OF_RANGE, pszError, cbError,
ExtPackUtil::tr("Standard member '%s' is too large: %'RU64 bytes (max 1 MB)", "",
(size_t)ObjInfo.cbObject),
pszAdjName, (uint64_t)ObjInfo.cbObject);
else
{
/*
* Make an in memory copy of the stream and check that the file
* is UTF-8 clean.
*/
RTVFSIOSTREAM hVfsIos = RTVfsObjToIoStream(*phVfsObj);
RTVFSFILE hVfsFile;
vrc = RTVfsMemorizeIoStreamAsFile(hVfsIos, RTFILE_O_READ, &hVfsFile);
if (RT_SUCCESS(vrc))
{
vrc = RTVfsIoStrmValidateUtf8Encoding(hVfsIos,
RTVFS_VALIDATE_UTF8_BY_RTC_3629 | RTVFS_VALIDATE_UTF8_NO_NULL,
NULL);
if (RT_SUCCESS(vrc))
{
/*
* Replace *phVfsObj with the memorized file.
*/
vrc = RTVfsFileSeek(hVfsFile, 0, RTFILE_SEEK_BEGIN, NULL);
if (RT_SUCCESS(vrc))
{
RTVfsObjRelease(*phVfsObj);
*phVfsObj = RTVfsObjFromFile(hVfsFile);
}
else
vboxExtPackSetError(pszError, cbError,
ExtPackUtil::tr("RTVfsFileSeek failed on '%s': %Rrc"), pszAdjName, vrc);
}
if (phVfsFile && RT_SUCCESS(vrc))
*phVfsFile = hVfsFile;
else
RTVfsFileRelease(hVfsFile);
}
else
vboxExtPackSetError(pszError, cbError,
ExtPackUtil::tr("RTVfsMemorizeIoStreamAsFile failed on '%s': %Rrc"), pszAdjName, vrc);
RTVfsIoStrmRelease(hVfsIos);
}
}
else
vboxExtPackSetError(pszError, cbError, ExtPackUtil::tr("RTVfsObjQueryInfo failed on '%s': %Rrc"), pszAdjName, vrc);
}
return vrc;
}
/**
* Validates a name in an extension pack.
*
* We restrict the charset to try make sure the extension pack can be unpacked
* on all file systems.
*
* @returns VBox status code, failures with message.
* @param pszName The name to validate.
* @param pszError Where to store an error message on failure.
* @param cbError The size of the buffer @a pszError points to.
*/
static int vboxExtPackValidateMemberName(const char *pszName, char *pszError, size_t cbError)
{
if (RTPathStartsWithRoot(pszName))
return vboxExtPackReturnError(VERR_PATH_IS_NOT_RELATIVE, pszError, cbError,
ExtPackUtil::tr("'%s': starts with root spec"), pszName);
const char *pszErr = NULL;
const char *psz = pszName;
int ch;
while ((ch = *psz) != '\0')
{
/* Character set restrictions. */
if (ch < 0 || ch >= 128)
{
pszErr = "Only 7-bit ASCII allowed";
break;
}
if (ch <= 31 || ch == 127)
{
pszErr = "No control characters are not allowed";
break;
}
if (ch == '\\')
{
pszErr = "Only backward slashes are not allowed";
break;
}
if (strchr("'\":;*?|[]<>(){}", ch))
{
pszErr = "The characters ', \", :, ;, *, ?, |, [, ], <, >, (, ), { and } are not allowed";
break;
}
/* Take the simple way out and ban all ".." sequences. */
if ( ch == '.'
&& psz[1] == '.')
{
pszErr = "Double dot sequence are not allowed";
break;
}
/* Keep the tree shallow or the hardening checks will fail. */
if (psz - pszName > VBOX_EXTPACK_MAX_MEMBER_NAME_LENGTH)
{
pszErr = "Too long";
break;
}
/* advance */
psz++;
}
if (pszErr)
return vboxExtPackReturnError(VERR_INVALID_NAME, pszError, cbError,
ExtPackUtil::tr("Bad member name '%s' (pos %zu): %s"),
pszName, (size_t)(psz - pszName), pszErr);
return RTEXITCODE_SUCCESS;
}
/**
* Validates a file in an extension pack.
*
* @returns VBox status code, failures with message.
* @param pszName The name of the file.
* @param hVfsObj The VFS object.
* @param pszError Where to store an error message on failure.
* @param cbError The size of the buffer @a pszError points to.
*/
static int vboxExtPackValidateMemberFile(const char *pszName, RTVFSOBJ hVfsObj, char *pszError, size_t cbError)
{
int vrc = vboxExtPackValidateMemberName(pszName, pszError, cbError);
if (RT_SUCCESS(vrc))
{
RTFSOBJINFO ObjInfo;
vrc = RTVfsObjQueryInfo(hVfsObj, &ObjInfo, RTFSOBJATTRADD_NOTHING);
if (RT_SUCCESS(vrc))
{
if (ObjInfo.cbObject >= 9*_1G64)
vrc = vboxExtPackReturnError(VERR_OUT_OF_RANGE, pszError, cbError,
ExtPackUtil::tr("'%s': too large (%'RU64 bytes)", "", (size_t)ObjInfo.cbObject),
pszName, (uint64_t)ObjInfo.cbObject);
if (!RTFS_IS_FILE(ObjInfo.Attr.fMode))
vrc = vboxExtPackReturnError(VERR_NOT_A_FILE, pszError, cbError,
ExtPackUtil::tr("The alleged file '%s' has a mode mask stating otherwise (%RTfmode)"),
pszName, ObjInfo.Attr.fMode);
}
else
vboxExtPackSetError(pszError, cbError, ExtPackUtil::tr("RTVfsObjQueryInfo failed on '%s': %Rrc"), pszName, vrc);
}
return vrc;
}
/**
* Validates a directory in an extension pack.
*
* @returns VBox status code, failures with message.
* @param pszName The name of the directory.
* @param hVfsObj The VFS object.
* @param pszError Where to store an error message on failure.
* @param cbError The size of the buffer @a pszError points to.
*/
static int vboxExtPackValidateMemberDir(const char *pszName, RTVFSOBJ hVfsObj, char *pszError, size_t cbError)
{
int vrc = vboxExtPackValidateMemberName(pszName, pszError, cbError);
if (RT_SUCCESS(vrc))
{
RTFSOBJINFO ObjInfo;
vrc = RTVfsObjQueryInfo(hVfsObj, &ObjInfo, RTFSOBJATTRADD_NOTHING);
if (RT_SUCCESS(vrc))
{
if (!RTFS_IS_DIRECTORY(ObjInfo.Attr.fMode))
vrc = vboxExtPackReturnError(VERR_NOT_A_DIRECTORY, pszError, cbError,
ExtPackUtil::tr("The alleged directory '%s' has a mode mask saying differently (%RTfmode)"),
pszName, ObjInfo.Attr.fMode);
}
else
vboxExtPackSetError(pszError, cbError, ExtPackUtil::tr("RTVfsObjQueryInfo failed on '%s': %Rrc"), pszName, vrc);
}
return vrc;
}
/**
* Validates a member of an extension pack.
*
* @returns VBox status code, failures with message.
* @param pszName The name of the directory.
* @param enmType The object type.
* @param hVfsObj The VFS object.
* @param pszError Where to store an error message on failure.
* @param cbError The size of the buffer @a pszError points to.
*/
int VBoxExtPackValidateMember(const char *pszName, RTVFSOBJTYPE enmType, RTVFSOBJ hVfsObj, char *pszError, size_t cbError)
{
Assert(cbError > 0);
*pszError = '\0';
int vrc;
if ( enmType == RTVFSOBJTYPE_FILE
|| enmType == RTVFSOBJTYPE_IO_STREAM)
vrc = vboxExtPackValidateMemberFile(pszName, hVfsObj, pszError, cbError);
else if ( enmType == RTVFSOBJTYPE_DIR
|| enmType == RTVFSOBJTYPE_BASE)
vrc = vboxExtPackValidateMemberDir(pszName, hVfsObj, pszError, cbError);
else
vrc = vboxExtPackReturnError(VERR_UNEXPECTED_FS_OBJ_TYPE, pszError, cbError,
ExtPackUtil::tr("'%s' is not a file or directory (enmType=%d)"), pszName, enmType);
return vrc;
}
/**
* Rewinds the tarball file handle and creates a gunzip | tar chain that
* results in a filesystem stream.
*
* @returns VBox status code, failures with message.
* @param hTarballFile The handle to the tarball file.
* @param pszError Where to store an error message on failure.
* @param cbError The size of the buffer @a pszError points to.
* @param phTarFss Where to return the filesystem stream handle.
* @param phFileManifest Where to return a manifest where the tarball is
* gettting hashed. The entry will be called
* "extpack" and be ready when the file system
* stream is at an end. Optional.
*/
int VBoxExtPackOpenTarFss(RTFILE hTarballFile, char *pszError, size_t cbError, PRTVFSFSSTREAM phTarFss,
PRTMANIFEST phFileManifest)
{
Assert(cbError > 0);
*pszError = '\0';
*phTarFss = NIL_RTVFSFSSTREAM;
/*
* Rewind the file and set up a VFS chain for it.
*/
int vrc = RTFileSeek(hTarballFile, 0, RTFILE_SEEK_BEGIN, NULL);
if (RT_FAILURE(vrc))
return vboxExtPackReturnError(vrc, pszError, cbError,
ExtPackUtil::tr("Failed seeking to the start of the tarball: %Rrc"), vrc);
RTVFSIOSTREAM hTarballIos;
vrc = RTVfsIoStrmFromRTFile(hTarballFile, RTFILE_O_READ | RTFILE_O_DENY_WRITE | RTFILE_O_OPEN, true /*fLeaveOpen*/,
&hTarballIos);
if (RT_FAILURE(vrc))
return vboxExtPackReturnError(vrc, pszError, cbError, ExtPackUtil::tr("RTVfsIoStrmFromRTFile failed: %Rrc"), vrc);
RTMANIFEST hFileManifest = NIL_RTMANIFEST;
vrc = RTManifestCreate(0 /*fFlags*/, &hFileManifest);
if (RT_SUCCESS(vrc))
{
RTVFSIOSTREAM hPtIos;
vrc = RTManifestEntryAddPassthruIoStream(hFileManifest, hTarballIos, "extpack", RTMANIFEST_ATTR_SHA256,
true /*read*/, &hPtIos);
if (RT_SUCCESS(vrc))
{
RTVFSIOSTREAM hGunzipIos;
vrc = RTZipGzipDecompressIoStream(hPtIos, 0 /*fFlags*/, &hGunzipIos);
if (RT_SUCCESS(vrc))
{
RTVFSFSSTREAM hTarFss;
vrc = RTZipTarFsStreamFromIoStream(hGunzipIos, 0 /*fFlags*/, &hTarFss);
if (RT_SUCCESS(vrc))
{
RTVfsIoStrmRelease(hPtIos);
RTVfsIoStrmRelease(hGunzipIos);
RTVfsIoStrmRelease(hTarballIos);
*phTarFss = hTarFss;
if (phFileManifest)
*phFileManifest = hFileManifest;
else
RTManifestRelease(hFileManifest);
return VINF_SUCCESS;
}
vboxExtPackSetError(pszError, cbError, ExtPackUtil::tr("RTZipTarFsStreamFromIoStream failed: %Rrc"), vrc);
RTVfsIoStrmRelease(hGunzipIos);
}
else
vboxExtPackSetError(pszError, cbError, ExtPackUtil::tr("RTZipGzipDecompressIoStream failed: %Rrc"), vrc);
RTVfsIoStrmRelease(hPtIos);
}
else
vboxExtPackSetError(pszError, cbError, ExtPackUtil::tr("RTManifestEntryAddPassthruIoStream failed: %Rrc"), vrc);
RTManifestRelease(hFileManifest);
}
else
vboxExtPackSetError(pszError, cbError, ExtPackUtil::tr("RTManifestCreate failed: %Rrc"), vrc);
RTVfsIoStrmRelease(hTarballIos);
return vrc;
}
/**
* Validates the extension pack tarball prior to unpacking.
*
* Operations performed:
* - Mandatory files.
* - Manifest check.
* - Manifest seal check.
* - XML check, match name.
*
* @returns VBox status code, failures with message.
* @param hTarballFile The handle to open the @a pszTarball file.
* @param pszExtPackName The name of the extension pack name. NULL if
* the name is not fixed.
* @param pszTarball The name of the tarball in case we have to
* complain about something.
* @param pszTarballDigest The SHA-256 digest of the tarball. Empty string
* if no digest available.
* @param pszError Where to store an error message on failure.
* @param cbError The size of the buffer @a pszError points to.
* @param phValidManifest Where to optionally return the handle to fully
* validated the manifest for the extension pack.
* This includes all files.
* @param phXmlFile Where to optionally return the memorized XML
* file.
* @param pStrDigest Where to return the digest of the file.
* Optional.
*/
int VBoxExtPackValidateTarball(RTFILE hTarballFile, const char *pszExtPackName,
const char *pszTarball, const char *pszTarballDigest,
char *pszError, size_t cbError,
PRTMANIFEST phValidManifest, PRTVFSFILE phXmlFile, RTCString *pStrDigest)
{
/*
* Clear return values.
*/
if (phValidManifest)
*phValidManifest = NIL_RTMANIFEST;
if (phXmlFile)
*phXmlFile = NIL_RTVFSFILE;
Assert(cbError > 1);
*pszError = '\0';
NOREF(pszTarball);
/*
* Open the tar.gz filesystem stream and set up an manifest in-memory file.
*/
RTMANIFEST hFileManifest;
RTVFSFSSTREAM hTarFss;
int vrc = VBoxExtPackOpenTarFss(hTarballFile, pszError, cbError, &hTarFss, &hFileManifest);
if (RT_FAILURE(vrc))
return vrc;
RTMANIFEST hOurManifest;
vrc = RTManifestCreate(0 /*fFlags*/, &hOurManifest);
if (RT_SUCCESS(vrc))
{
/*
* Process the tarball (would be nice to move this to a function).
*/
RTVFSFILE hXmlFile = NIL_RTVFSFILE;
RTVFSFILE hManifestFile = NIL_RTVFSFILE;
RTVFSFILE hSignatureFile = NIL_RTVFSFILE;
for (;;)
{
/*
* Get the next stream object.
*/
char *pszName;
RTVFSOBJ hVfsObj;
RTVFSOBJTYPE enmType;
vrc = RTVfsFsStrmNext(hTarFss, &pszName, &enmType, &hVfsObj);
if (RT_FAILURE(vrc))
{
if (vrc != VERR_EOF)
vboxExtPackSetError(pszError, cbError, ExtPackUtil::tr("RTVfsFsStrmNext failed: %Rrc"), vrc);
else
vrc = VINF_SUCCESS;
break;
}
const char *pszAdjName = pszName[0] == '.' && pszName[1] == '/' ? &pszName[2] : pszName;
/*
* Check the type & name validity, performing special tests on
* standard extension pack member files.
*
* N.B. We will always reach the end of the loop before breaking on
* failure - cleanup reasons.
*/
vrc = VBoxExtPackValidateMember(pszName, enmType, hVfsObj, pszError, cbError);
if (RT_SUCCESS(vrc))
{
PRTVFSFILE phVfsFile = NULL;
if (!strcmp(pszAdjName, VBOX_EXTPACK_DESCRIPTION_NAME))
phVfsFile = &hXmlFile;
else if (!strcmp(pszAdjName, VBOX_EXTPACK_MANIFEST_NAME))
phVfsFile = &hManifestFile;
else if (!strcmp(pszAdjName, VBOX_EXTPACK_SIGNATURE_NAME))
phVfsFile = &hSignatureFile;
else if (!strncmp(pszAdjName, VBOX_EXTPACK_LICENSE_NAME_PREFIX, sizeof(VBOX_EXTPACK_LICENSE_NAME_PREFIX) - 1))
vrc = VBoxExtPackValidateStandardFile(pszAdjName, enmType, &hVfsObj, NULL, pszError, cbError);
if (phVfsFile)
vrc = VBoxExtPackValidateStandardFile(pszAdjName, enmType, &hVfsObj, phVfsFile, pszError, cbError);
}
/*
* Add any I/O stream to the manifest
*/
if ( RT_SUCCESS(vrc)
&& ( enmType == RTVFSOBJTYPE_FILE
|| enmType == RTVFSOBJTYPE_IO_STREAM))
{
RTVFSIOSTREAM hVfsIos = RTVfsObjToIoStream(hVfsObj);
vrc = RTManifestEntryAddIoStream(hOurManifest, hVfsIos, pszAdjName, RTMANIFEST_ATTR_SIZE | RTMANIFEST_ATTR_SHA256);
if (RT_FAILURE(vrc))
vboxExtPackSetError(pszError, cbError,
ExtPackUtil::tr("RTManifestEntryAddIoStream failed on '%s': %Rrc"), pszAdjName, vrc);
RTVfsIoStrmRelease(hVfsIos);
}
/*
* Clean up and break out on failure.
*/
RTVfsObjRelease(hVfsObj);
RTStrFree(pszName);
if (RT_FAILURE(vrc))
break;
}
/*
* Check the integrity of the tarball file.
*/
if (RT_SUCCESS(vrc))
{
RTVfsFsStrmRelease(hTarFss);
hTarFss = NIL_RTVFSFSSTREAM;
vrc = vboxExtPackVerifyFileDigest(hFileManifest, pszTarballDigest, pStrDigest, pszError, cbError);
}
/*
* If we've successfully processed the tarball, verify that the
* mandatory files are present.
*/
if (RT_SUCCESS(vrc))
{
if (hXmlFile == NIL_RTVFSFILE)
vrc = vboxExtPackReturnError(VERR_MISSING, pszError, cbError, ExtPackUtil::tr("Mandator file '%s' is missing"),
VBOX_EXTPACK_DESCRIPTION_NAME);
if (hManifestFile == NIL_RTVFSFILE)
vrc = vboxExtPackReturnError(VERR_MISSING, pszError, cbError, ExtPackUtil::tr("Mandator file '%s' is missing"),
VBOX_EXTPACK_MANIFEST_NAME);
if (hSignatureFile == NIL_RTVFSFILE)
vrc = vboxExtPackReturnError(VERR_MISSING, pszError, cbError, ExtPackUtil::tr("Mandator file '%s' is missing"),
VBOX_EXTPACK_SIGNATURE_NAME);
}
/*
* Check the manifest and it's signature.
*/
if (RT_SUCCESS(vrc))
vrc = vboxExtPackVerifyManifestAndSignature(hOurManifest, hManifestFile, hSignatureFile, pszError, cbError);
/*
* Check the XML.
*/
if (RT_SUCCESS(vrc))
vrc = vboxExtPackVerifyXml(hXmlFile, pszExtPackName, pszError, cbError);
/*
* Returns objects.
*/
if (RT_SUCCESS(vrc))
{
if (phValidManifest)
{
RTManifestRetain(hOurManifest);
*phValidManifest = hOurManifest;
}
if (phXmlFile)
{
RTVfsFileRetain(hXmlFile);
*phXmlFile = hXmlFile;
}
}
/*
* Release our object references.
*/
RTManifestRelease(hOurManifest);
RTVfsFileRelease(hXmlFile);
RTVfsFileRelease(hManifestFile);
RTVfsFileRelease(hSignatureFile);
}
else
vboxExtPackSetError(pszError, cbError, "RTManifestCreate failed: %Rrc", vrc);
RTVfsFsStrmRelease(hTarFss);
RTManifestRelease(hFileManifest);
return vrc;
}
|