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
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
|
/* $Id: SUPR3HardenedMain.cpp $ */
/** @file
* VirtualBox Support Library - Hardened main().
*/
/*
* Copyright (C) 2006-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>.
*
* The contents of this file may alternatively be used under the terms
* of the Common Development and Distribution License Version 1.0
* (CDDL), a copy of it is provided in the "COPYING.CDDL" file included
* in the VirtualBox distribution, in which case the provisions of the
* CDDL are applicable instead of those of the GPL.
*
* You may elect to license modified versions of this file under the
* terms and conditions of either the GPL or the CDDL or both.
*
* SPDX-License-Identifier: GPL-3.0-only OR CDDL-1.0
*/
/** @page pg_hardening %VirtualBox %VM Process Hardening
*
* The %VM process hardening is to prevent malicious software from using
* %VirtualBox as a vehicle to obtain kernel level access.
*
* The %VirtualBox %VMM requires supervisor (kernel) level access to the CPU.
* For both practical and historical reasons, part of the %VMM is realized in
* ring-3, with a rich interface to the kernel part. While the device
* emulations can be executed exclusively in ring-3, we have performance
* optimizations that loads device emulation code into ring-0 and our special
* raw-mode execution context (none VT-x/AMD-V mode) for handling frequent
* operations a lot more efficiently. These share data between all three
* context (ring-3, ring-0 and raw-mode). All this poses a rather broad attack
* surface, which the hardening protects.
*
* The hardening focuses primarily on restricting access to the support driver,
* VBoxDrv or vboxdrv depending on the OS, as it is ultimately the link and
* instigator of the communication between ring-3 and the ring-0 and raw-mode
* contexts. A secondary focus is to make sure malicious code cannot be loaded
* and executed in the %VM process. Exactly how we go about this depends a lot
* on the host OS.
*
* @section sec_hardening_supdrv The Support Driver Interfaces
*
* The support driver has several interfaces thru which it can be accessed:
* - /dev/vboxdrv (win: \\Device\\VBoxDrv) for full unrestricted access.
* Offers a rich I/O control interface, which needs protecting.
* - /dev/vboxdrvu (win: \\Device\\VBoxDrvU) for restricted access, which
* VBoxSVC uses to query VT-x and AMD-V capabilities. This does not
* require protecting, though we limit it to the vboxgroup on some
* systems.
* - \\Device\\VBoxDrvStub on Windows for protecting the second stub
* process and its child, the %VM process. This is an open+close
* interface, only available to partially verified stub processes.
* - \\Device\\VBoxDrvErrorInfo on Windows for obtaining detailed error
* information on a previous attempt to open \\Device\\VBoxDrv or
* \\Device\\VBoxDrvStub. Open, read and close only interface.
*
* The rest of VBox accesses the device interface thru the support library,
* @ref grp_sup "SUPR3" / sup.h.
*
* The support driver also exposes a set of functions and data that other VBox
* ring-0 modules can import from. This includes much of the IPRT we need in
* the ring-0 part of the %VMM and device emulations.
*
* The ring-0 part of the %VMM and device emulations are loaded via the
* #SUPR3LoadModule and #SUPR3LoadServiceModule support library function, which
* both translates to a sequence of I/O controls against /dev/vboxdrv. On
* Windows we use the native kernel loader to load the module, while on the
* other systems ring-3 prepares the bits with help from the IPRT loader code.
*
*
* @section sec_hardening_unix Hardening on UNIX-like OSes
*
* On UNIX-like systems (Solaris, Linux, darwin, freebsd, ...) we put our trust
* in root and that root knows what he/she/it is doing.
*
* We only allow root to get full unrestricted access to the support driver.
* The device node corresponding to unrestricted access (/dev/vboxdrv) is own by
* root and has a 0600 access mode (i.e. only accessible to the owner, root). In
* addition to this file system level restriction, the support driver also
* checks that the effective user ID (EUID) is root when it is being opened.
*
* The %VM processes temporarily assume root privileges using the set-uid-bit on
* the executable with root as owner. In fact, all the files and directories we
* install are owned by root and the wheel (or equivalent gid = 0) group,
* including extension pack files.
*
* The executable with the set-uid-to-root-bit set is a stub binary that has no
* unnecessary library dependencies (only libc, pthreads, dynamic linker) and
* simply calls #SUPR3HardenedMain. It does the following:
* 1. Validate the VirtualBox installation (#supR3HardenedVerifyAll):
* - Check that the executable file of the process is one of the known
* VirtualBox executables.
* - Check that all mandatory files are present.
* - Check that all installed files and directories (both optional and
* mandatory ones) are owned by root:wheel and are not writable by
* anyone except root.
* - Check that all the parent directories, all the way up to the root
* if possible, only permits root (or system admin) to change them.
* This is that to rule out unintentional rename races.
* - On some systems we may also validate the cryptographic signtures
* of executable images.
*
* 2. Open a file descriptor for the support device driver
* (#supR3HardenedMainOpenDevice).
*
* 3. Grab ICMP capabilities for NAT ping support, if required by the OS
* (#supR3HardenedMainGrabCapabilites).
*
* 4. Correctly drop the root privileges
* (#supR3HardenedMainDropPrivileges).
*
* 5. Load the VBoxRT dynamic link library and hand over the file
* descriptor to the support library code in it
* (#supR3HardenedMainInitRuntime).
*
* 6. Load the dynamic library containing the actual %VM front end code and
* run it (tail of #SUPR3HardenedMain).
*
* The set-uid-to-root stub executable is paired with a dynamic link library
* which export one TrustedMain entry point (see #FNSUPTRUSTEDMAIN) that we
* call. In case of error reporting, the library may also export a TrustedError
* function (#FNSUPTRUSTEDERROR).
*
* That the set-uid-to-root-bit modifies the dynamic linker behavior on all
* systems, even after we've dropped back to the real user ID, is something we
* take advantage of. The dynamic linkers takes special care to prevent users
* from using clever tricks to inject their own code into set-uid processes and
* causing privilege escalation issues. This is the exact help we need.
*
* The VirtualBox installation location is hardcoded, which means the any
* dynamic linker paths embedded or inferred from the executable and dynamic
* libraries are also hardcoded. This helps eliminating search path attack
* vectors at the cost of being inflexible regarding installation location.
*
* In addition to what the dynamic linker does for us, the VirtualBox code will
* not directly be calling either RTLdrLoad or dlopen to load dynamic link
* libraries into the process. Instead it will call #SUPR3HardenedLdrLoad,
* #SUPR3HardenedLdrLoadAppPriv and #SUPR3HardenedLdrLoadPlugIn to do the
* loading. These functions will perform the same validations on the file being
* loaded as #SUPR3HardenedMain did in its validation step. So, anything we
* load must be installed with root/wheel as owner/group, the directory we load
* it from must also be owned by root:wheel and now allow for renaming the file.
* Similar ownership restrictions applies to all the parent directories (except
* on darwin).
*
* So, we place the responsibility of not installing malicious software on the
* root user on UNIX-like systems. Which is fair enough, in our opinion.
*
*
* @section sec_hardening_win Hardening on Windows
*
* On Windows we cannot put the same level or trust in the Administrator user(s)
* (equivalent of root/wheel on unix) as on the UNIX-like systems, which
* complicates things greatly.
*
* Some of the blame for this can be given to Windows being a descendant /
* replacement for a set of single user systems: DOS, Windows 1.0-3.11 Windows
* 95-ME, and OS/2. Users of NT 3.1 and later was inclined to want to always
* run it with full root/administrator privileges like they had done on the
* predecessors, while Microsoft didn't provide much incentive for more secure
* alternatives. Bad idea, security wise, but execellent for the security
* software industry. For this reason using a set-uid-to-root approach is
* pointless, even if Windows had one.
*
* So, in order to protect access to the support driver and protect the %VM
* process while it's running we have to do a lot more work. A keystone in the
* defences is cryptographic code signing. Here's the short version of what we
* do:
* - Minimal stub executable, signed with the same certificate as the
* kernel driver.
*
* - The stub executable respawns itself twice, hooking the NTDLL init
* routine to perform protection tasks as early as possible. The parent
* stub helps keep in the child clean for verification as does the
* support driver.
*
* - In order to protect against loading unwanted code into the process,
* the stub processes installs DLL load hooks with NTDLL as well as
* directly intercepting the LdrLoadDll and NtCreateSection APIs.
*
* - The support driver will verify all but the initial process very
* thoroughly before allowing them protection and in the final case full
* unrestricted access.
*
*
* @subsection sec_hardening_win_protsoft 3rd Party "Protection" Software
*
* What makes our life REALLY difficult on Windows is this 3rd party "security"
* software which is more or less required to keep a Windows system safe for
* normal users and all corporate IT departments rightly insists on installing.
* After the kernel patching clampdown in Vista, anti-* software has to do a
* lot more mucking about in user mode to get their job (kind of) done. So, it
* is common practice to patch a lot of NTDLL, KERNEL32, the executable import
* table, load extra DLLs into the process, allocate executable memory in the
* process (classic code injection) and more.
*
* The BIG problem with all this is that it is indistinguishable from what
* malicious software would be doing in order to intercept process activity
* (network sniffing, maybe password snooping) or gain a level of kernel access
* via the support driver. So, the "protection" software is what is currently
* forcing us to do the pre-NTDLL initialization.
*
*
* @subsection sec_hardening_win_1st_stub The Initial Stub Process
*
* We share the stub executable approach with the UNIX-like systems, so there's
* the #SUPR3HardenedMain calling stub executable with its partner DLL exporting
* TrustedMain and TrustedError. However, the stub executable does a lot more,
* while doing it in a more bare metal fashion:
* - It does not use the Microsoft CRT, what we need of CRT functions comes
* from IPRT.
* - It does not statically import anything. This is to avoid having an
* import table that can be patched to intercept our calls or extended to
* load additional DLLs.
* - Direct NT system calls. System calls normally going thru NTDLL, but
* since there is so much software out there which wants to patch known
* NTDLL entry points to control our software (either for good or
* malicious reasons), we do it ourselves.
*
* The initial stub process is not really to be trusted, though we try our best
* to limit potential harm (user mode debugger checks, disable thread creation).
* So, when it enters #SUPR3HardenedMain we only call #supR3HardenedVerifyAll to
* verify the installation (known executables and DLLs, checking their code
* signing signatures, keeping them all open to deny deletion and replacing) and
* does a respawn via #supR3HardenedWinReSpawn.
*
*
* @subsection sec_hardening_win_2nd_stub The Second Stub Process
*
* The second stub process will be created in suspended state, i.e. the main
* thread is suspended before it executes a single instruction. It is also
* created with a less generous ACLs, though this doesn't protect us from admin
* users. In order for #SUPR3HardenedMain to figure that it is the second stub
* process, the zeroth command line argument has been replaced by a known magic
* string (UUID).
*
* Now, before the process starts executing, the parent (initial stub) will
* patch the LdrInitializeThunk entry point in NTDLL to call
* #supR3HardenedEarlyProcessInit via #supR3HardenedEarlyProcessInitThunk. The
* parent will also plant some synchronization stuff via #g_ProcParams (NTDLL
* location, inherited event handles and associated ping-pong equipment).
*
* The LdrInitializeThunk entry point of NTDLL is where the kernel sets up
* process execution to start executing (via a user alert, so it is not subject
* to SetThreadContext). LdrInitializeThunk performs process, NTDLL and
* sub-system client (kernel32) initialization. A lot of "protection" software
* uses triggers in this initialization sequence (like the KERNEL32.DLL load
* event), so we avoid quite a bit of problems by getting our stuff done early
* on.
*
* However, there are also those that uses events that triggers immediately when
* the process is created or/and starts executing the first instruction. But we
* can easily counter these as we have a known process state we can restore. So,
* the first thing that #supR3HardenedEarlyProcessInit does is to signal the
* parent to perform a child purification, so the potentially evil influences
* can be exorcised.
*
* What the parent does during the purification is very similar to what the
* kernel driver will do later on when verifying the second stub and the %VM
* processes, except that instead of failing when encountering an shortcoming it
* will take corrective actions:
* - Executable memory regions not belonging to a DLL mapping will be
* attempted freed, and we'll only fail if we can't evict them.
* - All pages in the executable images in the process (should be just the
* stub executable and NTDLL) will be compared to the pristine fixed-up
* copy prepared by the IPRT PE loader code, restoring any bytes which
* appears differently in the child. (#g_ProcParams is exempted,
* LdrInitializeThunk is set to call NtTerminateThread.)
* - Unwanted DLLs will be unloaded (we have a set of DLLs we like).
*
* Before signalling the second stub process that it has been purified and should
* get on with it, the parent will close all handles with unrestricted access to
* the process and thread so that the initial stub process no longer can
* influence the child in any really harmful way. (The caller of CreateProcess
* usually receives handles with unrestricted access to the child process and
* its main thread. These could in theory be used with DuplicateHandle or
* WriteProcessMemory to get at the %VM process if we're not careful.)
*
* #supR3HardenedEarlyProcessInit will continue with opening the log file
* (requires command line parsing). It will continue to initialize a bunch of
* global variables, system calls and trustworthy/harmless NTDLL imports.
* #supR3HardenedWinInit is then called to setup image verification, that is:
* - Hook the NtCreateSection entry point in NTDLL so we can check all
* executable mappings before they're created and can be mapped. The
* NtCreateSection code jumps to #supR3HardenedMonitor_NtCreateSection.
* - Hook (ditto) the LdrLoadDll entry point in NTDLL so we can
* pre-validate all images that gets loaded the normal way (partly
* because the NtCreateSection context is restrictive because the NTDLL
* loader lock is usually held, which prevents us from safely calling
* WinVerityTrust). The LdrLoadDll code jumps to
* #supR3HardenedMonitor_LdrLoadDll.
*
* The image/DLL verification hooks are at this point able to verify DLLs
* containing embedded code signing signatures, and will restrict the locations
* from which DLLs will be loaded. When #SUPR3HardenedMain gets going later on,
* they will start insisting on everything having valid signatures, either
* embedded or in a signed installer catalog file.
*
* The function also irrevocably disables debug notifications related to the
* current thread, just to make attaching a debugging that much more difficult
* and less useful.
*
* Now, the second stub process will open the so called stub device
* (\\Device\\VBoxDrvStub), that is a special support driver device node that
* tells the support driver to:
* - Protect the process against the OpenProcess and OpenThread attack
* vectors by stripping risky access rights.
* - Check that the process isn't being debugged.
* - Check that the process contains exactly one thread.
* - Check that the process doesn't have any unknown DLLs loaded into it.
* - Check that the process doesn't have any executable memory (other than
* DLL sections) in it.
* - Check that the process executable is a known VBox executable which may
* access the support driver.
* - Check that the process executable is signed with the same code signing
* certificate as the driver and that the on disk image is valid
* according to its embedded signature.
* - Check all the signature of all DLLs in the process (NTDLL) if they are
* signed, and only accept unsigned ones in versions where they are known
* not to be signed.
* - Check that the code and readonly parts of the executable and DLLs
* mapped into the process matches the on disk content (no patches other
* than our own two in NTDLL are allowed).
*
* Once granted access to the stub device, #supR3HardenedEarlyProcessInit will
* restore the LdrInitializeThunk code and let the process perform normal
* initialization. Leading us to #SUPR3HardenedMain where we detect that this
* is the 2nd stub process and does another respawn.
*
*
* @subsection sec_hardening_win_3rd_stub The Final Stub / VM Process
*
* The third stub process is what becomes the %VM process. Because the parent
* has opened \\Device\\VBoxDrvSub, it is protected from malicious OpenProcess &
* OpenThread calls from the moment of inception, practically speaking.
*
* It goes thru the same suspended creation, patching, purification and such as
* its parent (the second stub process). However, instead of opening
* \\Device\\VBoxDrvStub from #supR3HardenedEarlyProcessInit, it opens the
* support driver for full unrestricted access, i.e. \\Device\\VBoxDrv.
*
* The support driver will perform the same checks as it did when
* \\Device\\VBoxDrvStub was opened, but in addition it will:
* - Check that the process is the first child of a process that opened
* \\Device\\VBoxDrvStub.
* - Check that the parent process is still alive.
* - Scan all open handles in the system for potentially harmful ones to
* the process or the primary thread.
*
* Knowing that the process is genuinly signed with the same certificate as the
* kernel driver, and the exectuable code in the process is either shipped by us
* or Microsoft, the support driver will trust it with full access and to keep
* the handle secure.
*
* We also trust the protection the support driver gives the process to keep out
* malicious ring-3 code, and therefore any code, patching or other mysterious
* stuff that enteres the process must be from kernel mode and that we can trust
* it (the alternative interpretation is that the kernel has been breanched
* already, which isn't our responsibility). This means that, the anti-software
* products can do whatever they like from this point on. However, should they
* do unrevertable changes to the process before this point, VirtualBox won't
* work.
*
* As in the second stub process, we'll now do normal process initialization and
* #SUPR3HardenedMain will take control. It will detect that it is being called
* by the 3rd stub process because of a different magic string starting the
* command line, and not respawn itself any more. #SUPR3HardenedMain will
* recheck the VirtualBox installation, keeping all known files open just like
* in two previous stub processes.
*
* It will then load the Windows cryptographic API and load the trusted root
* certificates from the Windows store. The API enables using installation
* catalog files for signature checking as well as providing a second
* verification in addition to our own implementation (IPRT). The certificates
* allows our signature validation implementation to validate all embedded
* signatures, not just the microsoft ones and the one signed by our own
* certificate.
*
*/
/*********************************************************************************************************************************
* Header Files *
*********************************************************************************************************************************/
#if defined(RT_OS_OS2)
# define INCL_BASE
# define INCL_ERRORS
# include <os2.h>
# include <stdio.h>
# include <stdlib.h>
# include <dlfcn.h>
# include <unistd.h>
#elif RT_OS_WINDOWS
# include <iprt/nt/nt-and-windows.h>
#else /* UNIXes */
# ifdef RT_OS_DARWIN
# define _POSIX_C_SOURCE 1 /* pick the correct prototype for unsetenv. */
# endif
# include <iprt/types.h> /* stdint fun on darwin. */
# include <stdio.h>
# include <stdlib.h>
# include <dlfcn.h>
# include <limits.h>
# include <errno.h>
# include <unistd.h>
# include <sys/stat.h>
# include <sys/time.h>
# include <sys/types.h>
# if defined(RT_OS_LINUX)
# undef USE_LIB_PCAP /* don't depend on libcap as we had to depend on either
libcap1 or libcap2 */
# undef _POSIX_SOURCE
# include <linux/types.h> /* sys/capabilities from uek-headers require this */
# include <sys/capability.h>
# include <sys/prctl.h>
# ifndef CAP_TO_MASK
# define CAP_TO_MASK(cap) RT_BIT(cap)
# endif
# elif defined(RT_OS_FREEBSD)
# include <sys/param.h>
# include <sys/sysctl.h>
# elif defined(RT_OS_SOLARIS)
# include <priv.h>
# endif
# include <pwd.h>
# ifdef RT_OS_DARWIN
# include <mach-o/dyld.h>
# endif
#endif
#include <VBox/sup.h>
#include <VBox/err.h>
#ifdef RT_OS_WINDOWS
# include <VBox/version.h>
# include <iprt/utf16.h>
#endif
#include <iprt/ctype.h>
#include <iprt/string.h>
#include <iprt/initterm.h>
#include <iprt/param.h>
#include <iprt/path.h>
#include "SUPLibInternal.h"
/*********************************************************************************************************************************
* Defined Constants And Macros *
*********************************************************************************************************************************/
/* This mess is temporary after eliminating a define duplicated in SUPLibInternal.h. */
#if !defined(RT_OS_OS2) && !defined(RT_OS_WINDOWS) && !defined(RT_OS_L4)
# ifndef SUP_HARDENED_SUID
# error "SUP_HARDENED_SUID is NOT defined?!?"
# endif
#else
# ifdef SUP_HARDENED_SUID
# error "SUP_HARDENED_SUID is defined?!?"
# endif
#endif
/** @def SUP_HARDENED_SYM
* Decorate a symbol that's resolved dynamically.
*/
#ifdef RT_OS_OS2
# define SUP_HARDENED_SYM(sym) "_" sym
#else
# define SUP_HARDENED_SYM(sym) sym
#endif
/*********************************************************************************************************************************
* Structures and Typedefs *
*********************************************************************************************************************************/
/** @see RTR3InitEx */
typedef DECLCALLBACKTYPE(int, FNRTR3INITEX,(uint32_t iVersion, uint32_t fFlags, int cArgs,
char **papszArgs, const char *pszProgramPath));
typedef FNRTR3INITEX *PFNRTR3INITEX;
/** @see RTLogRelPrintf */
typedef DECLCALLBACKTYPE(void, FNRTLOGRELPRINTF,(const char *pszFormat, ...));
typedef FNRTLOGRELPRINTF *PFNRTLOGRELPRINTF;
/**
* Descriptor of an environment variable to purge.
*/
typedef struct SUPENVPURGEDESC
{
/** Name of the environment variable to purge. */
const char *pszEnv;
/** The length of the variable name. */
uint8_t cchEnv;
/** Flag whether a failure in purging the variable leads to
* a fatal error resulting in an process exit. */
bool fPurgeErrFatal;
} SUPENVPURGEDESC;
/** Pointer to a environment variable purge descriptor. */
typedef SUPENVPURGEDESC *PSUPENVPURGEDESC;
/** Pointer to a const environment variable purge descriptor. */
typedef const SUPENVPURGEDESC *PCSUPENVPURGEDESC;
/**
* Descriptor of an command line argument to purge.
*/
typedef struct SUPARGPURGEDESC
{
/** Name of the argument to purge. */
const char *pszArg;
/** The length of the argument name. */
uint8_t cchArg;
/** Flag whether the argument is followed by an extra argument
* which must be purged too */
bool fTakesValue;
} SUPARGPURGEDESC;
/** Pointer to a environment variable purge descriptor. */
typedef SUPARGPURGEDESC *PSUPARGPURGEDESC;
/** Pointer to a const environment variable purge descriptor. */
typedef const SUPARGPURGEDESC *PCSUPARGPURGEDESC;
/*********************************************************************************************************************************
* Global Variables *
*********************************************************************************************************************************/
/** The pre-init data we pass on to SUPR3 (residing in VBoxRT). */
static SUPPREINITDATA g_SupPreInitData;
/** The program executable path. */
#ifndef RT_OS_WINDOWS
static
#endif
char g_szSupLibHardenedExePath[RTPATH_MAX];
/** The application bin directory path. */
static char g_szSupLibHardenedAppBinPath[RTPATH_MAX];
/** The offset into g_szSupLibHardenedExePath of the executable name. */
static size_t g_offSupLibHardenedExecName;
/** The length of the executable name in g_szSupLibHardenedExePath. */
static size_t g_cchSupLibHardenedExecName;
/** The program name. */
static const char *g_pszSupLibHardenedProgName;
/** The flags passed to SUPR3HardenedMain - SUPSECMAIN_FLAGS_XXX. */
static uint32_t g_fSupHardenedMain;
#ifdef SUP_HARDENED_SUID
/** The real UID at startup. */
static uid_t g_uid;
/** The real GID at startup. */
static gid_t g_gid;
# ifdef RT_OS_LINUX
static uint32_t g_uCaps;
static uint32_t g_uCapsVersion;
# endif
#endif
/** The startup log file. */
#ifdef RT_OS_WINDOWS
static HANDLE g_hStartupLog = NULL;
#else
static int g_hStartupLog = -1;
#endif
/** The number of bytes we've written to the startup log. */
static uint32_t volatile g_cbStartupLog = 0;
/** The current SUPR3HardenedMain state / location. */
SUPR3HARDENEDMAINSTATE g_enmSupR3HardenedMainState = SUPR3HARDENEDMAINSTATE_NOT_YET_CALLED;
AssertCompileSize(g_enmSupR3HardenedMainState, sizeof(uint32_t));
#ifdef RT_OS_WINDOWS
/** Pointer to VBoxRT's RTLogRelPrintf function so we can write errors to the
* release log at runtime. */
static PFNRTLOGRELPRINTF g_pfnRTLogRelPrintf = NULL;
/** Log volume name (for attempting volume flush). */
static RTUTF16 g_wszStartupLogVol[16];
#endif
/** Environment variables to purge from the process because
* they are known to be harmful. */
static const SUPENVPURGEDESC g_aSupEnvPurgeDescs[] =
{
/* pszEnv fPurgeErrFatal */
/* Qt related environment variables: */
{ RT_STR_TUPLE("QT_QPA_PLATFORM_PLUGIN_PATH"), true },
{ RT_STR_TUPLE("QT_PLUGIN_PATH"), true },
/* ALSA related environment variables: */
{ RT_STR_TUPLE("ALSA_MIXER_SIMPLE_MODULES"), true },
{ RT_STR_TUPLE("LADSPA_PATH"), true },
};
/** Arguments to purge from the argument vector because
* they are known to be harmful. */
static const SUPARGPURGEDESC g_aSupArgPurgeDescs[] =
{
/* pszArg fTakesValue */
/* Qt related environment variables: */
{ RT_STR_TUPLE("-platformpluginpath"), true },
};
/*********************************************************************************************************************************
* Internal Functions *
*********************************************************************************************************************************/
#ifdef SUP_HARDENED_SUID
static void supR3HardenedMainDropPrivileges(void);
#endif
static PFNSUPTRUSTEDERROR supR3HardenedMainGetTrustedError(const char *pszProgName);
/**
* Safely copy one or more strings into the given buffer.
*
* @returns VINF_SUCCESS or VERR_BUFFER_OVERFLOW.
* @param pszDst The destionation buffer.
* @param cbDst The size of the destination buffer.
* @param ... One or more zero terminated strings, ending with
* a NULL.
*/
static int suplibHardenedStrCopyEx(char *pszDst, size_t cbDst, ...)
{
int rc = VINF_SUCCESS;
if (cbDst == 0)
return VERR_BUFFER_OVERFLOW;
va_list va;
va_start(va, cbDst);
for (;;)
{
const char *pszSrc = va_arg(va, const char *);
if (!pszSrc)
break;
size_t cchSrc = suplibHardenedStrLen(pszSrc);
if (cchSrc < cbDst)
{
suplibHardenedMemCopy(pszDst, pszSrc, cchSrc);
pszDst += cchSrc;
cbDst -= cchSrc;
}
else
{
rc = VERR_BUFFER_OVERFLOW;
if (cbDst > 1)
{
suplibHardenedMemCopy(pszDst, pszSrc, cbDst - 1);
pszDst += cbDst - 1;
cbDst = 1;
}
}
*pszDst = '\0';
}
va_end(va);
return rc;
}
/**
* Exit current process in the quickest possible fashion.
*
* @param rcExit The exit code.
*/
DECLHIDDEN(DECL_NO_RETURN(void)) suplibHardenedExit(RTEXITCODE rcExit)
{
for (;;)
{
#ifdef RT_OS_WINDOWS
if (g_enmSupR3HardenedMainState >= SUPR3HARDENEDMAINSTATE_WIN_IMPORTS_RESOLVED)
ExitProcess(rcExit);
if (RtlExitUserProcess != NULL)
RtlExitUserProcess(rcExit);
NtTerminateProcess(NtCurrentProcess(), rcExit);
#else
_Exit(rcExit);
#endif
}
}
/**
* Writes a substring to standard error.
*
* @param pch The start of the substring.
* @param cch The length of the substring.
*/
static void suplibHardenedPrintStrN(const char *pch, size_t cch)
{
#ifdef RT_OS_WINDOWS
HANDLE hStdOut = NtCurrentPeb()->ProcessParameters->StandardOutput;
if (hStdOut != NULL)
{
if (g_enmSupR3HardenedMainState >= SUPR3HARDENEDMAINSTATE_WIN_IMPORTS_RESOLVED)
{
DWORD cbWritten;
WriteFile(hStdOut, pch, (DWORD)cch, &cbWritten, NULL);
}
/* Windows 7 and earlier uses fake handles, with the last two bits set ((hStdOut & 3) == 3). */
else if (NtWriteFile != NULL && ((uintptr_t)hStdOut & 3) == 0)
{
IO_STATUS_BLOCK Ios = RTNT_IO_STATUS_BLOCK_INITIALIZER;
NtWriteFile(hStdOut, NULL /*Event*/, NULL /*ApcRoutine*/, NULL /*ApcContext*/,
&Ios, (PVOID)pch, (ULONG)cch, NULL /*ByteOffset*/, NULL /*Key*/);
}
}
#else
int res = write(2, pch, cch);
NOREF(res);
#endif
}
/**
* Writes a string to standard error.
*
* @param psz The string.
*/
static void suplibHardenedPrintStr(const char *psz)
{
suplibHardenedPrintStrN(psz, suplibHardenedStrLen(psz));
}
/**
* Writes a char to standard error.
*
* @param ch The character value to write.
*/
static void suplibHardenedPrintChr(char ch)
{
suplibHardenedPrintStrN(&ch, 1);
}
#ifndef IPRT_NO_CRT
/**
* Writes a decimal number to stdard error.
*
* @param uValue The value.
*/
static void suplibHardenedPrintDecimal(uint64_t uValue)
{
char szBuf[64];
char *pszEnd = &szBuf[sizeof(szBuf) - 1];
char *psz = pszEnd;
*psz-- = '\0';
do
{
*psz-- = '0' + (uValue % 10);
uValue /= 10;
} while (uValue > 0);
psz++;
suplibHardenedPrintStrN(psz, pszEnd - psz);
}
/**
* Writes a hexadecimal or octal number to standard error.
*
* @param uValue The value.
* @param uBase The base (16 or 8).
* @param fFlags Format flags.
*/
static void suplibHardenedPrintHexOctal(uint64_t uValue, unsigned uBase, uint32_t fFlags)
{
static char const s_achDigitsLower[17] = "0123456789abcdef";
static char const s_achDigitsUpper[17] = "0123456789ABCDEF";
const char *pchDigits = !(fFlags & RTSTR_F_CAPITAL) ? s_achDigitsLower : s_achDigitsUpper;
unsigned cShift = uBase == 16 ? 4 : 3;
unsigned fDigitMask = uBase == 16 ? 0xf : 7;
char szBuf[64];
char *pszEnd = &szBuf[sizeof(szBuf) - 1];
char *psz = pszEnd;
*psz-- = '\0';
do
{
*psz-- = pchDigits[uValue & fDigitMask];
uValue >>= cShift;
} while (uValue > 0);
if ((fFlags & RTSTR_F_SPECIAL) && uBase == 16)
{
*psz-- = !(fFlags & RTSTR_F_CAPITAL) ? 'x' : 'X';
*psz-- = '0';
}
psz++;
suplibHardenedPrintStrN(psz, pszEnd - psz);
}
/**
* Writes a wide character string to standard error.
*
* @param pwsz The string.
*/
static void suplibHardenedPrintWideStr(PCRTUTF16 pwsz)
{
for (;;)
{
RTUTF16 wc = *pwsz++;
if (!wc)
return;
if ( (wc < 0x7f && wc >= 0x20)
|| wc == '\n'
|| wc == '\r')
suplibHardenedPrintChr((char)wc);
else
{
suplibHardenedPrintStrN(RT_STR_TUPLE("\\x"));
suplibHardenedPrintHexOctal(wc, 16, 0);
}
}
}
#else /* IPRT_NO_CRT */
/** Buffer structure used by suplibHardenedOutput. */
struct SUPLIBHARDENEDOUTPUTBUF
{
size_t off;
char szBuf[2048];
};
/** Callback for RTStrFormatV, see FNRTSTROUTPUT. */
static DECLCALLBACK(size_t) suplibHardenedOutput(void *pvArg, const char *pachChars, size_t cbChars)
{
SUPLIBHARDENEDOUTPUTBUF *pBuf = (SUPLIBHARDENEDOUTPUTBUF *)pvArg;
size_t cbTodo = cbChars;
for (;;)
{
size_t cbSpace = sizeof(pBuf->szBuf) - pBuf->off - 1;
/* Flush the buffer? */
if ( cbSpace == 0
|| (cbTodo == 0 && pBuf->off))
{
suplibHardenedPrintStrN(pBuf->szBuf, pBuf->off);
# ifdef RT_OS_WINDOWS
if (g_enmSupR3HardenedMainState >= SUPR3HARDENEDMAINSTATE_WIN_IMPORTS_RESOLVED)
OutputDebugString(pBuf->szBuf);
# endif
pBuf->off = 0;
cbSpace = sizeof(pBuf->szBuf) - 1;
}
/* Copy the string into the buffer. */
if (cbTodo == 1)
{
pBuf->szBuf[pBuf->off++] = *pachChars;
break;
}
if (cbSpace >= cbTodo)
{
memcpy(&pBuf->szBuf[pBuf->off], pachChars, cbTodo);
pBuf->off += cbTodo;
break;
}
memcpy(&pBuf->szBuf[pBuf->off], pachChars, cbSpace);
pBuf->off += cbSpace;
cbTodo -= cbSpace;
}
pBuf->szBuf[pBuf->off] = '\0';
return cbChars;
}
#endif /* IPRT_NO_CRT */
/**
* Simple printf to standard error.
*
* @param pszFormat The format string.
* @param va Arguments to format.
*/
DECLHIDDEN(void) suplibHardenedPrintFV(const char *pszFormat, va_list va)
{
#ifdef IPRT_NO_CRT
/*
* Use buffered output here to avoid character mixing on the windows
* console and to enable us to use OutputDebugString.
*/
SUPLIBHARDENEDOUTPUTBUF Buf;
Buf.off = 0;
Buf.szBuf[0] = '\0';
RTStrFormatV(suplibHardenedOutput, &Buf, NULL, NULL, pszFormat, va);
#else /* !IPRT_NO_CRT */
/*
* Format loop.
*/
char ch;
const char *pszLast = pszFormat;
for (;;)
{
ch = *pszFormat;
if (!ch)
break;
pszFormat++;
if (ch == '%')
{
/*
* Format argument.
*/
/* Flush unwritten bits. */
if (pszLast != pszFormat - 1)
suplibHardenedPrintStrN(pszLast, pszFormat - pszLast - 1);
pszLast = pszFormat;
ch = *pszFormat++;
/* flags. */
uint32_t fFlags = 0;
for (;;)
{
if (ch == '#') fFlags |= RTSTR_F_SPECIAL;
else if (ch == '-') fFlags |= RTSTR_F_LEFT;
else if (ch == '+') fFlags |= RTSTR_F_PLUS;
else if (ch == ' ') fFlags |= RTSTR_F_BLANK;
else if (ch == '0') fFlags |= RTSTR_F_ZEROPAD;
else if (ch == '\'') fFlags |= RTSTR_F_THOUSAND_SEP;
else break;
ch = *pszFormat++;
}
/* Width and precision - ignored. */
while (RT_C_IS_DIGIT(ch))
ch = *pszFormat++;
if (ch == '*')
va_arg(va, int);
if (ch == '.')
{
do ch = *pszFormat++;
while (RT_C_IS_DIGIT(ch));
if (ch == '*')
va_arg(va, int);
}
/* Size. */
char chArgSize = 0;
switch (ch)
{
case 'z':
case 'L':
case 'j':
case 't':
chArgSize = ch;
ch = *pszFormat++;
break;
case 'l':
chArgSize = ch;
ch = *pszFormat++;
if (ch == 'l')
{
chArgSize = 'L';
ch = *pszFormat++;
}
break;
case 'h':
chArgSize = ch;
ch = *pszFormat++;
if (ch == 'h')
{
chArgSize = 'H';
ch = *pszFormat++;
}
break;
}
/*
* Do type specific formatting.
*/
switch (ch)
{
case 'c':
ch = (char)va_arg(va, int);
suplibHardenedPrintChr(ch);
break;
case 's':
if (chArgSize == 'l')
{
PCRTUTF16 pwszStr = va_arg(va, PCRTUTF16 );
if (RT_VALID_PTR(pwszStr))
suplibHardenedPrintWideStr(pwszStr);
else
suplibHardenedPrintStr("<NULL>");
}
else
{
const char *pszStr = va_arg(va, const char *);
if (!RT_VALID_PTR(pszStr))
pszStr = "<NULL>";
suplibHardenedPrintStr(pszStr);
}
break;
case 'd':
case 'i':
{
int64_t iValue;
if (chArgSize == 'L' || chArgSize == 'j')
iValue = va_arg(va, int64_t);
else if (chArgSize == 'l')
iValue = va_arg(va, signed long);
else if (chArgSize == 'z' || chArgSize == 't')
iValue = va_arg(va, intptr_t);
else
iValue = va_arg(va, signed int);
if (iValue < 0)
{
suplibHardenedPrintChr('-');
iValue = -iValue;
}
suplibHardenedPrintDecimal(iValue);
break;
}
case 'p':
case 'x':
case 'X':
case 'u':
case 'o':
{
unsigned uBase = 10;
uint64_t uValue;
switch (ch)
{
case 'p':
fFlags |= RTSTR_F_ZEROPAD; /* Note not standard behaviour (but I like it this way!) */
uBase = 16;
break;
case 'X':
fFlags |= RTSTR_F_CAPITAL;
RT_FALL_THRU();
case 'x':
uBase = 16;
break;
case 'u':
uBase = 10;
break;
case 'o':
uBase = 8;
break;
}
if (ch == 'p' || chArgSize == 'z' || chArgSize == 't')
uValue = va_arg(va, uintptr_t);
else if (chArgSize == 'L' || chArgSize == 'j')
uValue = va_arg(va, uint64_t);
else if (chArgSize == 'l')
uValue = va_arg(va, unsigned long);
else
uValue = va_arg(va, unsigned int);
if (uBase == 10)
suplibHardenedPrintDecimal(uValue);
else
suplibHardenedPrintHexOctal(uValue, uBase, fFlags);
break;
}
case 'R':
if (pszFormat[0] == 'r' && pszFormat[1] == 'c')
{
int iValue = va_arg(va, int);
if (iValue < 0)
{
suplibHardenedPrintChr('-');
iValue = -iValue;
}
suplibHardenedPrintDecimal(iValue);
pszFormat += 2;
break;
}
RT_FALL_THRU();
/*
* Custom format.
*/
default:
suplibHardenedPrintStr("[bad format: ");
suplibHardenedPrintStrN(pszLast, pszFormat - pszLast);
suplibHardenedPrintChr(']');
break;
}
/* continue */
pszLast = pszFormat;
}
}
/* Flush the last bits of the string. */
if (pszLast != pszFormat)
suplibHardenedPrintStrN(pszLast, pszFormat - pszLast);
#endif /* !IPRT_NO_CRT */
}
/**
* Prints to standard error.
*
* @param pszFormat The format string.
* @param ... Arguments to format.
*/
DECLHIDDEN(void) suplibHardenedPrintF(const char *pszFormat, ...)
{
va_list va;
va_start(va, pszFormat);
suplibHardenedPrintFV(pszFormat, va);
va_end(va);
}
/**
* @copydoc RTPathStripFilename
*/
static void suplibHardenedPathStripFilename(char *pszPath)
{
char *psz = pszPath;
char *pszLastSep = pszPath;
for (;; psz++)
{
switch (*psz)
{
/* handle separators. */
#if defined(RT_OS_WINDOWS) || defined(RT_OS_OS2)
case ':':
pszLastSep = psz + 1;
break;
case '\\':
#endif
case '/':
pszLastSep = psz;
break;
/* the end */
case '\0':
if (pszLastSep == pszPath)
*pszLastSep++ = '.';
*pszLastSep = '\0';
return;
}
}
/* will never get here */
}
/**
* @copydoc RTPathFilename
*/
DECLHIDDEN(char *) supR3HardenedPathFilename(const char *pszPath)
{
const char *psz = pszPath;
const char *pszLastComp = pszPath;
for (;; psz++)
{
switch (*psz)
{
/* handle separators. */
#if defined(RT_OS_WINDOWS) || defined(RT_OS_OS2)
case ':':
pszLastComp = psz + 1;
break;
case '\\':
#endif
case '/':
pszLastComp = psz + 1;
break;
/* the end */
case '\0':
if (*pszLastComp)
return (char *)(void *)pszLastComp;
return NULL;
}
}
/* will never get here */
}
/**
* @copydoc RTPathAppPrivateNoArch
*/
DECLHIDDEN(int) supR3HardenedPathAppPrivateNoArch(char *pszPath, size_t cchPath)
{
#if !defined(RT_OS_WINDOWS) && defined(RTPATH_APP_PRIVATE)
const char *pszSrcPath = RTPATH_APP_PRIVATE;
size_t cchPathPrivateNoArch = suplibHardenedStrLen(pszSrcPath);
if (cchPathPrivateNoArch >= cchPath)
supR3HardenedFatal("supR3HardenedPathAppPrivateNoArch: Buffer overflow, %zu >= %zu\n", cchPathPrivateNoArch, cchPath);
suplibHardenedMemCopy(pszPath, pszSrcPath, cchPathPrivateNoArch + 1);
return VINF_SUCCESS;
#else
return supR3HardenedPathAppBin(pszPath, cchPath);
#endif
}
/**
* @copydoc RTPathAppPrivateArch
*/
DECLHIDDEN(int) supR3HardenedPathAppPrivateArch(char *pszPath, size_t cchPath)
{
#if !defined(RT_OS_WINDOWS) && defined(RTPATH_APP_PRIVATE_ARCH)
const char *pszSrcPath = RTPATH_APP_PRIVATE_ARCH;
size_t cchPathPrivateArch = suplibHardenedStrLen(pszSrcPath);
if (cchPathPrivateArch >= cchPath)
supR3HardenedFatal("supR3HardenedPathAppPrivateArch: Buffer overflow, %zu >= %zu\n", cchPathPrivateArch, cchPath);
suplibHardenedMemCopy(pszPath, pszSrcPath, cchPathPrivateArch + 1);
return VINF_SUCCESS;
#else
return supR3HardenedPathAppBin(pszPath, cchPath);
#endif
}
/**
* @copydoc RTPathSharedLibs
*/
DECLHIDDEN(int) supR3HardenedPathAppSharedLibs(char *pszPath, size_t cchPath)
{
#if !defined(RT_OS_WINDOWS) && defined(RTPATH_SHARED_LIBS)
const char *pszSrcPath = RTPATH_SHARED_LIBS;
size_t cchPathSharedLibs = suplibHardenedStrLen(pszSrcPath);
if (cchPathSharedLibs >= cchPath)
supR3HardenedFatal("supR3HardenedPathAppSharedLibs: Buffer overflow, %zu >= %zu\n", cchPathSharedLibs, cchPath);
suplibHardenedMemCopy(pszPath, pszSrcPath, cchPathSharedLibs + 1);
return VINF_SUCCESS;
#else
return supR3HardenedPathAppBin(pszPath, cchPath);
#endif
}
/**
* @copydoc RTPathAppDocs
*/
DECLHIDDEN(int) supR3HardenedPathAppDocs(char *pszPath, size_t cchPath)
{
#if !defined(RT_OS_WINDOWS) && defined(RTPATH_APP_DOCS)
const char *pszSrcPath = RTPATH_APP_DOCS;
size_t cchPathAppDocs = suplibHardenedStrLen(pszSrcPath);
if (cchPathAppDocs >= cchPath)
supR3HardenedFatal("supR3HardenedPathAppDocs: Buffer overflow, %zu >= %zu\n", cchPathAppDocs, cchPath);
suplibHardenedMemCopy(pszPath, pszSrcPath, cchPathAppDocs + 1);
return VINF_SUCCESS;
#else
return supR3HardenedPathAppBin(pszPath, cchPath);
#endif
}
/**
* Returns the full path to the executable in g_szSupLibHardenedExePath.
*
* @returns IPRT status code.
*/
static void supR3HardenedGetFullExePath(void)
{
/*
* Get the program filename.
*
* Most UNIXes have no API for obtaining the executable path, but provides a symbolic
* link in the proc file system that tells who was exec'ed. The bad thing about this
* is that we have to use readlink, one of the weirder UNIX APIs.
*
* Darwin, OS/2 and Windows all have proper APIs for getting the program file name.
*/
#if defined(RT_OS_LINUX) || defined(RT_OS_FREEBSD) || defined(RT_OS_SOLARIS)
# ifdef RT_OS_LINUX
int cchLink = readlink("/proc/self/exe", &g_szSupLibHardenedExePath[0], sizeof(g_szSupLibHardenedExePath) - 1);
# elif defined(RT_OS_SOLARIS)
char szFileBuf[PATH_MAX + 1];
sprintf(szFileBuf, "/proc/%ld/path/a.out", (long)getpid());
int cchLink = readlink(szFileBuf, &g_szSupLibHardenedExePath[0], sizeof(g_szSupLibHardenedExePath) - 1);
# else /* RT_OS_FREEBSD */
int aiName[4];
aiName[0] = CTL_KERN;
aiName[1] = KERN_PROC;
aiName[2] = KERN_PROC_PATHNAME;
aiName[3] = getpid();
size_t cbPath = sizeof(g_szSupLibHardenedExePath);
if (sysctl(aiName, RT_ELEMENTS(aiName), g_szSupLibHardenedExePath, &cbPath, NULL, 0) < 0)
supR3HardenedFatal("supR3HardenedExecDir: sysctl failed\n");
g_szSupLibHardenedExePath[sizeof(g_szSupLibHardenedExePath) - 1] = '\0';
int cchLink = suplibHardenedStrLen(g_szSupLibHardenedExePath); /* paranoid? can't we use cbPath? */
# endif
if (cchLink < 0 || cchLink == sizeof(g_szSupLibHardenedExePath) - 1)
supR3HardenedFatal("supR3HardenedExecDir: couldn't read \"%s\", errno=%d cchLink=%d\n",
g_szSupLibHardenedExePath, errno, cchLink);
g_szSupLibHardenedExePath[cchLink] = '\0';
#elif defined(RT_OS_OS2) || defined(RT_OS_L4)
_execname(g_szSupLibHardenedExePath, sizeof(g_szSupLibHardenedExePath));
#elif defined(RT_OS_DARWIN)
const char *pszImageName = _dyld_get_image_name(0);
if (!pszImageName)
supR3HardenedFatal("supR3HardenedExecDir: _dyld_get_image_name(0) failed\n");
size_t cchImageName = suplibHardenedStrLen(pszImageName);
if (!cchImageName || cchImageName >= sizeof(g_szSupLibHardenedExePath))
supR3HardenedFatal("supR3HardenedExecDir: _dyld_get_image_name(0) failed, cchImageName=%d\n", cchImageName);
suplibHardenedMemCopy(g_szSupLibHardenedExePath, pszImageName, cchImageName + 1);
/** @todo abspath the string or this won't work:
* cd /Applications/VirtualBox.app/Contents/Resources/VirtualBoxVM.app/Contents/MacOS/ && ./VirtualBoxVM --startvm name */
#elif defined(RT_OS_WINDOWS)
char *pszDst = g_szSupLibHardenedExePath;
int rc = RTUtf16ToUtf8Ex(g_wszSupLibHardenedExePath, RTSTR_MAX, &pszDst, sizeof(g_szSupLibHardenedExePath), NULL);
if (RT_FAILURE(rc))
supR3HardenedFatal("supR3HardenedExecDir: RTUtf16ToUtf8Ex failed, rc=%Rrc\n", rc);
#else
# error needs porting.
#endif
/*
* Determine the application binary directory location.
*/
suplibHardenedStrCopy(g_szSupLibHardenedAppBinPath, g_szSupLibHardenedExePath);
suplibHardenedPathStripFilename(g_szSupLibHardenedAppBinPath);
g_offSupLibHardenedExecName = suplibHardenedStrLen(g_szSupLibHardenedAppBinPath);
while (RTPATH_IS_SEP(g_szSupLibHardenedExePath[g_offSupLibHardenedExecName]))
g_offSupLibHardenedExecName++;
g_cchSupLibHardenedExecName = suplibHardenedStrLen(&g_szSupLibHardenedExePath[g_offSupLibHardenedExecName]);
if (g_enmSupR3HardenedMainState < SUPR3HARDENEDMAINSTATE_HARDENED_MAIN_CALLED)
supR3HardenedFatal("supR3HardenedExecDir: Called before SUPR3HardenedMain! (%d)\n", g_enmSupR3HardenedMainState);
switch (g_fSupHardenedMain & SUPSECMAIN_FLAGS_LOC_MASK)
{
case SUPSECMAIN_FLAGS_LOC_APP_BIN:
break;
case SUPSECMAIN_FLAGS_LOC_TESTCASE:
suplibHardenedPathStripFilename(g_szSupLibHardenedAppBinPath);
break;
#ifdef RT_OS_DARWIN
case SUPSECMAIN_FLAGS_LOC_OSX_HLP_APP:
{
/* We must ascend to the parent bundle's Contents directory then decend into its MacOS: */
static const RTSTRTUPLE s_aComponentsToSkip[] =
{ { RT_STR_TUPLE("MacOS") }, { RT_STR_TUPLE("Contents") }, { NULL /*some.app*/, 0 }, { RT_STR_TUPLE("Resources") } };
size_t cchPath = suplibHardenedStrLen(g_szSupLibHardenedAppBinPath);
for (uintptr_t i = 0; i < RT_ELEMENTS(s_aComponentsToSkip); i++)
{
while (cchPath > 1 && g_szSupLibHardenedAppBinPath[cchPath - 1] == '/')
cchPath--;
size_t const cchMatch = s_aComponentsToSkip[i].cch;
if (cchMatch > 0)
{
if ( cchPath >= cchMatch + sizeof("VirtualBox.app/Contents")
&& g_szSupLibHardenedAppBinPath[cchPath - cchMatch - 1] == '/'
&& suplibHardenedMemComp(&g_szSupLibHardenedAppBinPath[cchPath - cchMatch],
s_aComponentsToSkip[i].psz, cchMatch) == 0)
cchPath -= cchMatch;
else
supR3HardenedFatal("supR3HardenedExecDir: Bad helper app path (tail component #%u '%s'): %s\n",
i, s_aComponentsToSkip[i].psz, g_szSupLibHardenedAppBinPath);
}
else if ( cchPath > g_cchSupLibHardenedExecName + sizeof("VirtualBox.app/Contents/Resources/.app")
&& suplibHardenedMemComp(&g_szSupLibHardenedAppBinPath[cchPath - 4], ".app", 4) == 0
&& suplibHardenedMemComp(&g_szSupLibHardenedAppBinPath[cchPath - 4 - g_cchSupLibHardenedExecName],
&g_szSupLibHardenedExePath[g_offSupLibHardenedExecName],
g_cchSupLibHardenedExecName) == 0)
cchPath -= g_cchSupLibHardenedExecName + 4;
else
supR3HardenedFatal("supR3HardenedExecDir: Bad helper app path (tail component #%u '%s.app'): %s\n",
i, &g_szSupLibHardenedExePath[g_offSupLibHardenedExecName], g_szSupLibHardenedAppBinPath);
}
suplibHardenedMemCopy(&g_szSupLibHardenedAppBinPath[cchPath], "MacOS", sizeof("MacOS"));
break;
}
#endif /* RT_OS_DARWIN */
default:
supR3HardenedFatal("supR3HardenedExecDir: Unknown program binary location: %#x\n", g_fSupHardenedMain);
}
}
#ifdef RT_OS_LINUX
/**
* Checks if we can read /proc/self/exe.
*
* This is used on linux to see if we have to call init
* with program path or not.
*
* @returns true / false.
*/
static bool supR3HardenedMainIsProcSelfExeAccssible(void)
{
char szPath[RTPATH_MAX];
int cchLink = readlink("/proc/self/exe", szPath, sizeof(szPath));
return cchLink != -1;
}
#endif /* RT_OS_LINUX */
/**
* @remarks not quite like RTPathExecDir actually...
*/
DECLHIDDEN(int) supR3HardenedPathAppBin(char *pszPath, size_t cchPath)
{
/*
* Lazy init (probably not required).
*/
if (!g_szSupLibHardenedAppBinPath[0])
supR3HardenedGetFullExePath();
/*
* Calc the length and check if there is space before copying.
*/
size_t cch = suplibHardenedStrLen(g_szSupLibHardenedAppBinPath) + 1;
if (cch <= cchPath)
{
suplibHardenedMemCopy(pszPath, g_szSupLibHardenedAppBinPath, cch + 1);
return VINF_SUCCESS;
}
supR3HardenedFatal("supR3HardenedPathAppBin: Buffer too small (%u < %u)\n", cchPath, cch);
/* not reached */
}
#ifdef RT_OS_WINDOWS
extern "C" uint32_t g_uNtVerCombined;
#endif
DECLHIDDEN(void) supR3HardenedOpenLog(int *pcArgs, char **papszArgs)
{
static const char s_szLogOption[] = "--sup-hardening-log=";
/*
* Scan the argument vector.
*/
int cArgs = *pcArgs;
for (int iArg = 1; iArg < cArgs; iArg++)
if (strncmp(papszArgs[iArg], s_szLogOption, sizeof(s_szLogOption) - 1) == 0)
{
#ifdef RT_OS_WINDOWS
const char *pszLogFile = &papszArgs[iArg][sizeof(s_szLogOption) - 1];
#endif
/*
* Drop the argument from the vector (has trailing NULL entry).
*/
// memmove(&papszArgs[iArg], &papszArgs[iArg + 1], (cArgs - iArg) * sizeof(papszArgs[0]));
*pcArgs -= 1;
cArgs -= 1;
/*
* Open the log file, unless we've already opened one.
* First argument takes precedence
*/
#ifdef RT_OS_WINDOWS
if (g_hStartupLog == NULL)
{
int rc = RTNtPathOpen(pszLogFile,
GENERIC_WRITE | SYNCHRONIZE,
FILE_ATTRIBUTE_NORMAL,
FILE_SHARE_READ | FILE_SHARE_WRITE,
FILE_OPEN_IF,
FILE_NON_DIRECTORY_FILE | FILE_SYNCHRONOUS_IO_NONALERT,
OBJ_CASE_INSENSITIVE,
&g_hStartupLog,
NULL);
if (RT_SUCCESS(rc))
{
// SUP_DPRINTF(("Log file opened: " VBOX_VERSION_STRING "r%u g_hStartupLog=%p g_uNtVerCombined=%#x\n",
// VBOX_SVN_REV, g_hStartupLog, g_uNtVerCombined));
/*
* If the path contains a drive volume, save it so we can
* use it to flush the volume containing the log file.
*/
if (RT_C_IS_ALPHA(pszLogFile[0]) && pszLogFile[1] == ':')
{
// RTUtf16CopyAscii(g_wszStartupLogVol, RT_ELEMENTS(g_wszStartupLogVol), "\\??\\");
g_wszStartupLogVol[sizeof("\\??\\") - 1] = RT_C_TO_UPPER(pszLogFile[0]);
g_wszStartupLogVol[sizeof("\\??\\") + 0] = ':';
g_wszStartupLogVol[sizeof("\\??\\") + 1] = '\0';
}
}
else
g_hStartupLog = NULL;
}
#else
/* Just some mumbo jumbo to shut up the compiler. */
g_hStartupLog -= 1;
g_cbStartupLog += 1;
//g_hStartupLog = open()
#endif
}
}
DECLHIDDEN(void) supR3HardenedLogV(const char *pszFormat, va_list va)
{
#ifdef RT_OS_WINDOWS
if ( g_hStartupLog != NULL
&& g_cbStartupLog < 16*_1M)
{
char szBuf[5120];
PCLIENT_ID pSelfId = &((PTEB)NtCurrentTeb())->ClientId;
size_t cchPrefix = RTStrPrintf(szBuf, sizeof(szBuf), "%x.%x: ", pSelfId->UniqueProcess, pSelfId->UniqueThread);
size_t cch = RTStrPrintfV(&szBuf[cchPrefix], sizeof(szBuf) - cchPrefix, pszFormat, va) + cchPrefix;
if ((size_t)cch >= sizeof(szBuf))
cch = sizeof(szBuf) - 1;
if (!cch || szBuf[cch - 1] != '\n')
szBuf[cch++] = '\n';
ASMAtomicAddU32(&g_cbStartupLog, (uint32_t)cch);
IO_STATUS_BLOCK Ios = RTNT_IO_STATUS_BLOCK_INITIALIZER;
LARGE_INTEGER Offset;
Offset.QuadPart = -1; /* Write to end of file. */
NtWriteFile(g_hStartupLog, NULL /*Event*/, NULL /*ApcRoutine*/, NULL /*ApcContext*/,
&Ios, szBuf, (ULONG)cch, &Offset, NULL /*Key*/);
}
#else
RT_NOREF(pszFormat, va);
/* later */
#endif
}
DECLHIDDEN(void) supR3HardenedLog(const char *pszFormat, ...)
{
va_list va;
va_start(va, pszFormat);
supR3HardenedLogV(pszFormat, va);
va_end(va);
}
DECLHIDDEN(void) supR3HardenedLogFlush(void)
{
#ifdef RT_OS_WINDOWS
if ( g_hStartupLog != NULL
&& g_cbStartupLog < 16*_1M)
{
IO_STATUS_BLOCK Ios = RTNT_IO_STATUS_BLOCK_INITIALIZER;
NTSTATUS rcNt = NtFlushBuffersFile(g_hStartupLog, &Ios);
/*
* Try flush the volume containing the log file too.
*/
if (g_wszStartupLogVol[0])
{
HANDLE hLogVol = RTNT_INVALID_HANDLE_VALUE;
UNICODE_STRING NtName;
NtName.Buffer = g_wszStartupLogVol;
NtName.Length = (USHORT)(RTUtf16Len(g_wszStartupLogVol) * sizeof(RTUTF16));
NtName.MaximumLength = NtName.Length + 1;
OBJECT_ATTRIBUTES ObjAttr;
InitializeObjectAttributes(&ObjAttr, &NtName, OBJ_CASE_INSENSITIVE, NULL /*hRootDir*/, NULL /*pSecDesc*/);
RTNT_IO_STATUS_BLOCK_REINIT(&Ios);
rcNt = NtCreateFile(&hLogVol,
GENERIC_WRITE | GENERIC_READ | SYNCHRONIZE | FILE_READ_ATTRIBUTES,
&ObjAttr,
&Ios,
NULL /* Allocation Size*/,
0 /*FileAttributes*/,
FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE,
FILE_OPEN,
FILE_NON_DIRECTORY_FILE | FILE_SYNCHRONOUS_IO_NONALERT,
NULL /*EaBuffer*/,
0 /*EaLength*/);
if (NT_SUCCESS(rcNt))
rcNt = Ios.Status;
if (NT_SUCCESS(rcNt))
{
RTNT_IO_STATUS_BLOCK_REINIT(&Ios);
rcNt = NtFlushBuffersFile(hLogVol, &Ios);
NtClose(hLogVol);
}
else
{
/* This may have sideeffects similar to what we want... */
hLogVol = RTNT_INVALID_HANDLE_VALUE;
RTNT_IO_STATUS_BLOCK_REINIT(&Ios);
rcNt = NtCreateFile(&hLogVol,
GENERIC_READ | SYNCHRONIZE | FILE_READ_ATTRIBUTES,
&ObjAttr,
&Ios,
NULL /* Allocation Size*/,
0 /*FileAttributes*/,
FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE,
FILE_OPEN,
FILE_NON_DIRECTORY_FILE | FILE_SYNCHRONOUS_IO_NONALERT,
NULL /*EaBuffer*/,
0 /*EaLength*/);
if (NT_SUCCESS(rcNt) && NT_SUCCESS(Ios.Status))
NtClose(hLogVol);
}
}
}
#else
/* later */
#endif
}
/**
* Prints the message prefix.
*/
static void suplibHardenedPrintPrefix(void)
{
if (g_pszSupLibHardenedProgName)
suplibHardenedPrintStr(g_pszSupLibHardenedProgName);
suplibHardenedPrintStr(": ");
}
DECL_NO_RETURN(DECLHIDDEN(void)) supR3HardenedFatalMsgV(const char *pszWhere, SUPINITOP enmWhat, int rc,
const char *pszMsgFmt, va_list va)
{
/*
* First to the log.
*/
supR3HardenedLog("Error %d in %s! (enmWhat=%d)\n", rc, pszWhere, enmWhat);
va_list vaCopy;
va_copy(vaCopy, va);
supR3HardenedLogV(pszMsgFmt, vaCopy);
va_end(vaCopy);
#ifdef RT_OS_WINDOWS
/*
* The release log.
*/
if (g_pfnRTLogRelPrintf)
{
va_copy(vaCopy, va);
g_pfnRTLogRelPrintf("supR3HardenedFatalMsgV: %s enmWhat=%d rc=%Rrc (%#x)\n", pszWhere, enmWhat, rc);
g_pfnRTLogRelPrintf("supR3HardenedFatalMsgV: %N\n", pszMsgFmt, &vaCopy);
va_end(vaCopy);
}
#endif
/*
* Then to the console.
*/
suplibHardenedPrintPrefix();
suplibHardenedPrintF("Error %d in %s!\n", rc, pszWhere);
suplibHardenedPrintPrefix();
va_copy(vaCopy, va);
suplibHardenedPrintFV(pszMsgFmt, vaCopy);
va_end(vaCopy);
suplibHardenedPrintChr('\n');
switch (enmWhat)
{
case kSupInitOp_Driver:
suplibHardenedPrintChr('\n');
suplibHardenedPrintPrefix();
suplibHardenedPrintStr("Tip! Make sure the kernel module is loaded. It may also help to reinstall VirtualBox.\n");
break;
case kSupInitOp_Misc:
case kSupInitOp_IPRT:
case kSupInitOp_Integrity:
case kSupInitOp_RootCheck:
suplibHardenedPrintChr('\n');
suplibHardenedPrintPrefix();
suplibHardenedPrintStr("Tip! It may help to reinstall VirtualBox.\n");
break;
default:
/* no hints here */
break;
}
/*
* Finally, TrustedError if appropriate.
*/
if (g_enmSupR3HardenedMainState >= SUPR3HARDENEDMAINSTATE_WIN_IMPORTS_RESOLVED)
{
#ifdef SUP_HARDENED_SUID
/* Drop any root privileges we might be holding, this won't return
if it fails but end up calling supR3HardenedFatal[V]. */
supR3HardenedMainDropPrivileges();
#endif
/* Close the driver, if we succeeded opening it. Both because
TrustedError may be untrustworthy and because the driver deosn't
like us if we fork(). @bugref{8838} */
suplibOsTerm(&g_SupPreInitData.Data);
/*
* Now try resolve and call the TrustedError entry point if we can find it.
* Note! Loader involved, so we must guard against loader hooks calling us.
*/
static volatile bool s_fRecursive = false;
if (!s_fRecursive)
{
s_fRecursive = true;
PFNSUPTRUSTEDERROR pfnTrustedError = supR3HardenedMainGetTrustedError(g_pszSupLibHardenedProgName);
if (pfnTrustedError)
{
/* We'll fork before we make the call because that way the session management
in main will see us exiting immediately (if it's involved with us) and possibly
get an error back to the API / user. */
#if !defined(RT_OS_WINDOWS) && !defined(RT_OS_OS2) && /* @bugref{10170}: */ !defined(RT_OS_DARWIN)
int pid = fork();
if (pid <= 0)
#endif
{
pfnTrustedError(pszWhere, enmWhat, rc, pszMsgFmt, va);
}
}
s_fRecursive = false;
}
}
#if defined(RT_OS_WINDOWS)
/*
* Report the error to the parent if this happens during early VM init.
*/
else if ( g_enmSupR3HardenedMainState < SUPR3HARDENEDMAINSTATE_WIN_IMPORTS_RESOLVED
&& g_enmSupR3HardenedMainState != SUPR3HARDENEDMAINSTATE_NOT_YET_CALLED)
supR3HardenedWinReportErrorToParent(pszWhere, enmWhat, rc, pszMsgFmt, va);
#endif
/*
* Quit
*/
suplibHardenedExit(RTEXITCODE_FAILURE);
}
DECL_NO_RETURN(DECLHIDDEN(void)) supR3HardenedFatalMsg(const char *pszWhere, SUPINITOP enmWhat, int rc,
const char *pszMsgFmt, ...)
{
va_list va;
va_start(va, pszMsgFmt);
supR3HardenedFatalMsgV(pszWhere, enmWhat, rc, pszMsgFmt, va);
/* not reached */
}
DECL_NO_RETURN(DECLHIDDEN(void)) supR3HardenedFatalV(const char *pszFormat, va_list va)
{
supR3HardenedLog("Fatal error:\n");
va_list vaCopy;
va_copy(vaCopy, va);
supR3HardenedLogV(pszFormat, vaCopy);
va_end(vaCopy);
#if defined(RT_OS_WINDOWS)
/*
* Report the error to the parent if this happens during early VM init.
*/
if ( g_enmSupR3HardenedMainState < SUPR3HARDENEDMAINSTATE_WIN_IMPORTS_RESOLVED
&& g_enmSupR3HardenedMainState != SUPR3HARDENEDMAINSTATE_NOT_YET_CALLED)
supR3HardenedWinReportErrorToParent(NULL, kSupInitOp_Invalid, VERR_INTERNAL_ERROR, pszFormat, va);
else
#endif
{
#ifdef RT_OS_WINDOWS
if (g_pfnRTLogRelPrintf)
{
va_copy(vaCopy, va);
g_pfnRTLogRelPrintf("supR3HardenedFatalV: %N", pszFormat, &vaCopy);
va_end(vaCopy);
}
#endif
suplibHardenedPrintPrefix();
suplibHardenedPrintFV(pszFormat, va);
}
suplibHardenedExit(RTEXITCODE_FAILURE);
}
DECL_NO_RETURN(DECLHIDDEN(void)) supR3HardenedFatal(const char *pszFormat, ...)
{
va_list va;
va_start(va, pszFormat);
supR3HardenedFatalV(pszFormat, va);
/* not reached */
}
DECLHIDDEN(int) supR3HardenedErrorV(int rc, bool fFatal, const char *pszFormat, va_list va)
{
if (fFatal)
supR3HardenedFatalV(pszFormat, va);
supR3HardenedLog("Error (rc=%d):\n", rc);
va_list vaCopy;
va_copy(vaCopy, va);
supR3HardenedLogV(pszFormat, vaCopy);
va_end(vaCopy);
#ifdef RT_OS_WINDOWS
if (g_pfnRTLogRelPrintf)
{
va_copy(vaCopy, va);
g_pfnRTLogRelPrintf("supR3HardenedErrorV: %N", pszFormat, &vaCopy);
va_end(vaCopy);
}
#endif
suplibHardenedPrintPrefix();
suplibHardenedPrintFV(pszFormat, va);
return rc;
}
DECLHIDDEN(int) supR3HardenedError(int rc, bool fFatal, const char *pszFormat, ...)
{
va_list va;
va_start(va, pszFormat);
supR3HardenedErrorV(rc, fFatal, pszFormat, va);
va_end(va);
return rc;
}
/**
* Attempts to open /dev/vboxdrv (or equvivalent).
*
* @remarks This function will not return on failure.
*/
DECLHIDDEN(void) supR3HardenedMainOpenDevice(void)
{
RTERRINFOSTATIC ErrInfo;
SUPINITOP enmWhat = kSupInitOp_Driver;
uint32_t fFlags = SUPR3INIT_F_UNRESTRICTED;
if (g_fSupHardenedMain & SUPSECMAIN_FLAGS_DRIVERLESS)
fFlags |= SUPR3INIT_F_DRIVERLESS;
if (g_fSupHardenedMain & SUPSECMAIN_FLAGS_DRIVERLESS_IEM_ALLOWED)
fFlags |= SUPR3INIT_F_DRIVERLESS_IEM_ALLOWED;
#ifdef VBOX_WITH_DRIVERLESS_NEM_FALLBACK
if (g_fSupHardenedMain & SUPSECMAIN_FLAGS_DRIVERLESS_NEM_FALLBACK)
fFlags |= SUPR3INIT_F_DRIVERLESS_NEM_FALLBACK;
#endif
int rc = suplibOsInit(&g_SupPreInitData.Data, false /*fPreInit*/, fFlags, &enmWhat, RTErrInfoInitStatic(&ErrInfo));
if (RT_SUCCESS(rc))
return;
if (RTErrInfoIsSet(&ErrInfo.Core))
supR3HardenedFatalMsg("suplibOsInit", enmWhat, rc, "%s", ErrInfo.szMsg);
switch (rc)
{
/** @todo better messages! */
case VERR_VM_DRIVER_NOT_INSTALLED:
supR3HardenedFatalMsg("suplibOsInit", kSupInitOp_Driver, rc, "Kernel driver not installed");
case VERR_VM_DRIVER_NOT_ACCESSIBLE:
supR3HardenedFatalMsg("suplibOsInit", kSupInitOp_Driver, rc, "Kernel driver not accessible");
case VERR_VM_DRIVER_LOAD_ERROR:
supR3HardenedFatalMsg("suplibOsInit", kSupInitOp_Driver, rc, "VERR_VM_DRIVER_LOAD_ERROR");
case VERR_VM_DRIVER_OPEN_ERROR:
supR3HardenedFatalMsg("suplibOsInit", kSupInitOp_Driver, rc, "VERR_VM_DRIVER_OPEN_ERROR");
case VERR_VM_DRIVER_VERSION_MISMATCH:
supR3HardenedFatalMsg("suplibOsInit", kSupInitOp_Driver, rc, "Kernel driver version mismatch");
case VERR_ACCESS_DENIED:
supR3HardenedFatalMsg("suplibOsInit", kSupInitOp_Driver, rc, "VERR_ACCESS_DENIED");
case VERR_NO_MEMORY:
supR3HardenedFatalMsg("suplibOsInit", kSupInitOp_Driver, rc, "Kernel memory allocation/mapping failed");
case VERR_SUPDRV_HARDENING_EVIL_HANDLE:
supR3HardenedFatalMsg("suplibOsInit", kSupInitOp_Integrity, rc, "VERR_SUPDRV_HARDENING_EVIL_HANDLE");
case VERR_SUPLIB_NT_PROCESS_UNTRUSTED_0:
supR3HardenedFatalMsg("suplibOsInit", kSupInitOp_Integrity, rc, "VERR_SUPLIB_NT_PROCESS_UNTRUSTED_0");
case VERR_SUPLIB_NT_PROCESS_UNTRUSTED_1:
supR3HardenedFatalMsg("suplibOsInit", kSupInitOp_Integrity, rc, "VERR_SUPLIB_NT_PROCESS_UNTRUSTED_1");
case VERR_SUPLIB_NT_PROCESS_UNTRUSTED_2:
supR3HardenedFatalMsg("suplibOsInit", kSupInitOp_Integrity, rc, "VERR_SUPLIB_NT_PROCESS_UNTRUSTED_2");
default:
supR3HardenedFatalMsg("suplibOsInit", kSupInitOp_Driver, rc, "Unknown rc=%d (%Rrc)", rc, rc);
}
}
#ifdef SUP_HARDENED_SUID
/**
* Grabs extra non-root capabilities / privileges that we might require.
*
* This is currently only used for being able to do ICMP from the NAT engine
* and for being able to raise thread scheduling priority
*
* @note We still have root privileges at the time of this call.
*/
static void supR3HardenedMainGrabCapabilites(void)
{
# if defined(RT_OS_LINUX)
/*
* We are about to drop all our privileges. Remove all capabilities but
* keep the cap_net_raw capability for ICMP sockets for the NAT stack,
* also keep cap_sys_nice capability for priority tweaking.
*/
if (g_uCaps != 0)
{
# ifdef USE_LIB_PCAP
/* XXX cap_net_bind_service */
if (!cap_set_proc(cap_from_text("all-eip cap_net_raw+ep cap_sys_nice+ep")))
prctl(PR_SET_KEEPCAPS, 1 /*keep=*/, 0, 0, 0);
prctl(PR_SET_DUMPABLE, 1 /*dump*/, 0, 0, 0);
# else
cap_user_header_t hdr = (cap_user_header_t)alloca(sizeof(*hdr));
cap_user_data_t cap = (cap_user_data_t)alloca(2 /*_LINUX_CAPABILITY_U32S_3*/ * sizeof(*cap));
memset(hdr, 0, sizeof(*hdr));
capget(hdr, NULL);
if ( hdr->version != 0x19980330 /* _LINUX_CAPABILITY_VERSION_1, _LINUX_CAPABILITY_U32S_1 = 1 */
&& hdr->version != 0x20071026 /* _LINUX_CAPABILITY_VERSION_2, _LINUX_CAPABILITY_U32S_2 = 2 */
&& hdr->version != 0x20080522 /* _LINUX_CAPABILITY_VERSION_3, _LINUX_CAPABILITY_U32S_3 = 2 */)
hdr->version = _LINUX_CAPABILITY_VERSION;
g_uCapsVersion = hdr->version;
memset(cap, 0, 2 /* _LINUX_CAPABILITY_U32S_3 */ * sizeof(*cap));
cap->effective = g_uCaps;
cap->permitted = g_uCaps;
if (!capset(hdr, cap))
prctl(PR_SET_KEEPCAPS, 1 /*keep*/, 0, 0, 0);
prctl(PR_SET_DUMPABLE, 1 /*dump*/, 0, 0, 0);
# endif /* !USE_LIB_PCAP */
}
# elif defined(RT_OS_SOLARIS)
/*
* Add net_icmpaccess privilege to effective privileges and limit
* permitted privileges before completely dropping root privileges.
* This requires dropping root privileges temporarily to get the normal
* user's privileges.
*/
seteuid(g_uid);
priv_set_t *pPrivEffective = priv_allocset();
priv_set_t *pPrivNew = priv_allocset();
if (pPrivEffective && pPrivNew)
{
int rc = getppriv(PRIV_EFFECTIVE, pPrivEffective);
seteuid(0);
if (!rc)
{
priv_copyset(pPrivEffective, pPrivNew);
rc = priv_addset(pPrivNew, PRIV_NET_ICMPACCESS);
if (!rc)
{
/* Order is important, as one can't set a privilege which is
* not in the permitted privilege set. */
rc = setppriv(PRIV_SET, PRIV_EFFECTIVE, pPrivNew);
if (rc)
supR3HardenedError(rc, false, "SUPR3HardenedMain: failed to set effective privilege set.\n");
rc = setppriv(PRIV_SET, PRIV_PERMITTED, pPrivNew);
if (rc)
supR3HardenedError(rc, false, "SUPR3HardenedMain: failed to set permitted privilege set.\n");
}
else
supR3HardenedError(rc, false, "SUPR3HardenedMain: failed to add NET_ICMPACCESS privilege.\n");
}
}
else
{
/* for memory allocation failures just continue */
seteuid(0);
}
if (pPrivEffective)
priv_freeset(pPrivEffective);
if (pPrivNew)
priv_freeset(pPrivNew);
# endif
}
/*
* Look at the environment for some special options.
*/
static void supR3GrabOptions(void)
{
# ifdef RT_OS_LINUX
g_uCaps = 0;
/*
* Do _not_ perform any capability-related system calls for root processes
* (leaving g_uCaps at 0).
* (Hint: getuid gets the real user id, not the effective.)
*/
if (getuid() != 0)
{
/*
* CAP_NET_RAW.
* Default: enabled.
* Can be disabled with 'export VBOX_HARD_CAP_NET_RAW=0'.
*/
const char *pszOpt = getenv("VBOX_HARD_CAP_NET_RAW");
if ( !pszOpt
|| memcmp(pszOpt, "0", sizeof("0")) != 0)
g_uCaps = CAP_TO_MASK(CAP_NET_RAW);
/*
* CAP_NET_BIND_SERVICE.
* Default: disabled.
* Can be enabled with 'export VBOX_HARD_CAP_NET_BIND_SERVICE=1'.
*/
pszOpt = getenv("VBOX_HARD_CAP_NET_BIND_SERVICE");
if ( pszOpt
&& memcmp(pszOpt, "0", sizeof("0")) != 0)
g_uCaps |= CAP_TO_MASK(CAP_NET_BIND_SERVICE);
/*
* CAP_SYS_NICE.
* Default: enabled.
* Can be disabled with 'export VBOX_HARD_CAP_SYS_NICE=0'.
*/
pszOpt = getenv("VBOX_HARD_CAP_SYS_NICE");
if ( !pszOpt
|| memcmp(pszOpt, "0", sizeof("0")) != 0)
g_uCaps |= CAP_TO_MASK(CAP_SYS_NICE);
}
# endif
}
/**
* Drop any root privileges we might be holding.
*/
static void supR3HardenedMainDropPrivileges(void)
{
/*
* Try use setre[ug]id since this will clear the save uid/gid and thus
* leave fewer traces behind that libs like GTK+ may pick up.
*/
uid_t euid, ruid, suid;
gid_t egid, rgid, sgid;
# if defined(RT_OS_DARWIN)
/* The really great thing here is that setreuid isn't available on
OS X 10.4, libc emulates it. While 10.4 have a slightly different and
non-standard setuid implementation compared to 10.5, the following
works the same way with both version since we're super user (10.5 req).
The following will set all three variants of the group and user IDs. */
setgid(g_gid);
setuid(g_uid);
euid = geteuid();
ruid = suid = getuid();
egid = getegid();
rgid = sgid = getgid();
# elif defined(RT_OS_SOLARIS)
/* Solaris doesn't have setresuid, but the setreuid interface is BSD
compatible and will set the saved uid to euid when we pass it a ruid
that isn't -1 (which we do). */
setregid(g_gid, g_gid);
setreuid(g_uid, g_uid);
euid = geteuid();
ruid = suid = getuid();
egid = getegid();
rgid = sgid = getgid();
# else
/* This is the preferred one, full control no questions about semantics.
PORTME: If this isn't work, try join one of two other gangs above. */
int res = setresgid(g_gid, g_gid, g_gid);
NOREF(res);
res = setresuid(g_uid, g_uid, g_uid);
NOREF(res);
if (getresuid(&ruid, &euid, &suid) != 0)
{
euid = geteuid();
ruid = suid = getuid();
}
if (getresgid(&rgid, &egid, &sgid) != 0)
{
egid = getegid();
rgid = sgid = getgid();
}
# endif
/* Check that it worked out all right. */
if ( euid != g_uid
|| ruid != g_uid
|| suid != g_uid
|| egid != g_gid
|| rgid != g_gid
|| sgid != g_gid)
supR3HardenedFatal("SUPR3HardenedMain: failed to drop root privileges!"
" (euid=%d ruid=%d suid=%d egid=%d rgid=%d sgid=%d; wanted uid=%d and gid=%d)\n",
euid, ruid, suid, egid, rgid, sgid, g_uid, g_gid);
# if RT_OS_LINUX
/*
* Re-enable the cap_net_raw and cap_sys_nice capabilities which were disabled during setresuid.
*/
if (g_uCaps != 0)
{
# ifdef USE_LIB_PCAP
/** @todo Warn if that does not work? */
/* XXX cap_net_bind_service */
cap_set_proc(cap_from_text("cap_net_raw+ep cap_sys_nice+ep"));
# else
cap_user_header_t hdr = (cap_user_header_t)alloca(sizeof(*hdr));
cap_user_data_t cap = (cap_user_data_t)alloca(2 /* _LINUX_CAPABILITY_U32S_3 */ * sizeof(*cap));
memset(hdr, 0, sizeof(*hdr));
hdr->version = g_uCapsVersion;
memset(cap, 0, 2 /* _LINUX_CAPABILITY_U32S_3 */ * sizeof(*cap));
cap->effective = g_uCaps;
cap->permitted = g_uCaps;
/** @todo Warn if that does not work? */
capset(hdr, cap);
# endif /* !USE_LIB_PCAP */
}
# endif
}
#endif /* SUP_HARDENED_SUID */
/**
* Purge the process environment from any environment vairable which can lead
* to loading untrusted binaries compromising the process address space.
*
* @param envp The initial environment vector. (Can be NULL.)
*/
static void supR3HardenedMainPurgeEnvironment(char **envp)
{
for (unsigned i = 0; i < RT_ELEMENTS(g_aSupEnvPurgeDescs); i++)
{
/*
* Update the initial environment vector, just in case someone actually cares about it.
*/
if (envp)
{
const char * const pszEnv = g_aSupEnvPurgeDescs[i].pszEnv;
size_t const cchEnv = g_aSupEnvPurgeDescs[i].cchEnv;
unsigned iSrc = 0;
unsigned iDst = 0;
char *pszTmp;
while ((pszTmp = envp[iSrc]) != NULL)
{
if ( memcmp(pszTmp, pszEnv, cchEnv) != 0
|| (pszTmp[cchEnv] != '=' && pszTmp[cchEnv] != '\0'))
{
if (iDst != iSrc)
envp[iDst] = pszTmp;
iDst++;
}
else
SUP_DPRINTF(("supR3HardenedMainPurgeEnvironment: dropping envp[%d]=%s\n", iSrc, pszTmp));
iSrc++;
}
if (iDst != iSrc)
while (iDst <= iSrc)
envp[iDst++] = NULL;
}
/*
* Remove from the process environment if present.
*/
#ifndef RT_OS_WINDOWS
const char *pszTmp = getenv(g_aSupEnvPurgeDescs[i].pszEnv);
if (pszTmp != NULL)
{
if (unsetenv((char *)g_aSupEnvPurgeDescs[i].pszEnv) == 0)
SUP_DPRINTF(("supR3HardenedMainPurgeEnvironment: dropped %s\n", pszTmp));
else
if (g_aSupEnvPurgeDescs[i].fPurgeErrFatal)
supR3HardenedFatal("SUPR3HardenedMain: failed to purge %s environment variable! (errno=%d %s)\n",
g_aSupEnvPurgeDescs[i].pszEnv, errno, strerror(errno));
else
SUP_DPRINTF(("supR3HardenedMainPurgeEnvironment: dropping %s failed! errno=%d\n", pszTmp, errno));
}
#else
/** @todo Call NT API to do the same. */
#endif
}
}
/**
* Returns the argument purge descriptor of the given argument if available.
*
* @retval 0 if it should not be purged.
* @retval 1 if it only the current argument should be purged.
* @retval 2 if the argument and the following (if present) should be purged.
* @param pszArg The argument to look for.
*/
static unsigned supR3HardenedMainShouldPurgeArg(const char *pszArg)
{
for (unsigned i = 0; i < RT_ELEMENTS(g_aSupArgPurgeDescs); i++)
{
size_t const cchPurge = g_aSupArgPurgeDescs[i].cchArg;
if (!memcmp(pszArg, g_aSupArgPurgeDescs[i].pszArg, cchPurge))
{
if (pszArg[cchPurge] == '\0')
return 1 + g_aSupArgPurgeDescs[i].fTakesValue;
if ( g_aSupArgPurgeDescs[i].fTakesValue
&& (pszArg[cchPurge] == ':' || pszArg[cchPurge] == '='))
return 1;
}
}
return 0;
}
/**
* Purges any command line arguments considered harmful.
*
* @returns nothing.
* @param cArgsOrig The original number of arguments.
* @param papszArgsOrig The original argument vector.
* @param pcArgsNew Where to store the new number of arguments on success.
* @param ppapszArgsNew Where to store the pointer to the purged argument vector.
*/
static void supR3HardenedMainPurgeArgs(int cArgsOrig, char **papszArgsOrig, int *pcArgsNew, char ***ppapszArgsNew)
{
int iDst = 0;
#ifdef RT_OS_WINDOWS
char **papszArgsNew = papszArgsOrig; /* We allocated this, no need to allocate again. */
#else
char **papszArgsNew = (char **)malloc((cArgsOrig + 1) * sizeof(char *));
#endif
if (papszArgsNew)
{
for (int iSrc = 0; iSrc < cArgsOrig; iSrc++)
{
unsigned cPurgedArgs = supR3HardenedMainShouldPurgeArg(papszArgsOrig[iSrc]);
if (!cPurgedArgs)
papszArgsNew[iDst++] = papszArgsOrig[iSrc];
else
iSrc += cPurgedArgs - 1;
}
papszArgsNew[iDst] = NULL; /* The array is NULL terminated, just like envp. */
}
else
supR3HardenedFatal("SUPR3HardenedMain: failed to allocate memory for purged command line!\n");
*pcArgsNew = iDst;
*ppapszArgsNew = papszArgsNew;
#ifdef RT_OS_WINDOWS
/** @todo Update command line pointers in PEB, wont really work without it. */
#endif
}
/**
* Loads the VBoxRT DLL/SO/DYLIB, hands it the open driver,
* and calls RTR3InitEx.
*
* @param fFlags The SUPR3HardenedMain fFlags argument, passed to supR3PreInit.
*
* @remarks VBoxRT contains both IPRT and SUPR3.
* @remarks This function will not return on failure.
*/
static void supR3HardenedMainInitRuntime(uint32_t fFlags)
{
/*
* Construct the name.
*/
char szPath[RTPATH_MAX];
supR3HardenedPathAppSharedLibs(szPath, sizeof(szPath) - sizeof("/VBoxRT" SUPLIB_DLL_SUFF));
suplibHardenedStrCat(szPath, "/VBoxRT" SUPLIB_DLL_SUFF);
/*
* Open it and resolve the symbols.
*/
#if defined(RT_OS_WINDOWS)
HMODULE hMod = (HMODULE)supR3HardenedWinLoadLibrary(szPath, false /*fSystem32Only*/, g_fSupHardenedMain);
if (!hMod)
supR3HardenedFatalMsg("supR3HardenedMainInitRuntime", kSupInitOp_IPRT, VERR_MODULE_NOT_FOUND,
"LoadLibrary \"%s\" failed (rc=%d)",
szPath, RtlGetLastWin32Error());
PFNRTR3INITEX pfnRTInitEx = (PFNRTR3INITEX)GetProcAddress(hMod, SUP_HARDENED_SYM("RTR3InitEx"));
if (!pfnRTInitEx)
supR3HardenedFatalMsg("supR3HardenedMainInitRuntime", kSupInitOp_IPRT, VERR_SYMBOL_NOT_FOUND,
"Entrypoint \"RTR3InitEx\" not found in \"%s\" (rc=%d)",
szPath, RtlGetLastWin32Error());
PFNSUPR3PREINIT pfnSUPPreInit = (PFNSUPR3PREINIT)GetProcAddress(hMod, SUP_HARDENED_SYM("supR3PreInit"));
if (!pfnSUPPreInit)
supR3HardenedFatalMsg("supR3HardenedMainInitRuntime", kSupInitOp_IPRT, VERR_SYMBOL_NOT_FOUND,
"Entrypoint \"supR3PreInit\" not found in \"%s\" (rc=%d)",
szPath, RtlGetLastWin32Error());
g_pfnRTLogRelPrintf = (PFNRTLOGRELPRINTF)GetProcAddress(hMod, SUP_HARDENED_SYM("RTLogRelPrintf"));
Assert(g_pfnRTLogRelPrintf); /* Not fatal in non-strict builds. */
#else
/* the dlopen crowd */
void *pvMod = dlopen(szPath, RTLD_NOW | RTLD_GLOBAL);
if (!pvMod)
supR3HardenedFatalMsg("supR3HardenedMainInitRuntime", kSupInitOp_IPRT, VERR_MODULE_NOT_FOUND,
"dlopen(\"%s\",) failed: %s",
szPath, dlerror());
PFNRTR3INITEX pfnRTInitEx = (PFNRTR3INITEX)(uintptr_t)dlsym(pvMod, SUP_HARDENED_SYM("RTR3InitEx"));
if (!pfnRTInitEx)
supR3HardenedFatalMsg("supR3HardenedMainInitRuntime", kSupInitOp_IPRT, VERR_SYMBOL_NOT_FOUND,
"Entrypoint \"RTR3InitEx\" not found in \"%s\"!\ndlerror: %s",
szPath, dlerror());
PFNSUPR3PREINIT pfnSUPPreInit = (PFNSUPR3PREINIT)(uintptr_t)dlsym(pvMod, SUP_HARDENED_SYM("supR3PreInit"));
if (!pfnSUPPreInit)
supR3HardenedFatalMsg("supR3HardenedMainInitRuntime", kSupInitOp_IPRT, VERR_SYMBOL_NOT_FOUND,
"Entrypoint \"supR3PreInit\" not found in \"%s\"!\ndlerror: %s",
szPath, dlerror());
#endif
/*
* Make the calls.
*/
supR3HardenedGetPreInitData(&g_SupPreInitData);
int rc = pfnSUPPreInit(&g_SupPreInitData, fFlags);
if (RT_FAILURE(rc))
supR3HardenedFatalMsg("supR3HardenedMainInitRuntime", kSupInitOp_IPRT, rc,
"supR3PreInit failed with rc=%d", rc);
/* Get the executable path for the IPRT init on linux if /proc/self/exe isn't accessible. */
const char *pszExePath = NULL;
#ifdef RT_OS_LINUX
if (!supR3HardenedMainIsProcSelfExeAccssible())
pszExePath = g_szSupLibHardenedExePath;
#endif
/* Assemble the IPRT init flags. We could probably just pass RTR3INIT_FLAGS_TRY_SUPLIB
here and be done with it, but it's not too much hazzle to convert fFlags 1:1. */
uint32_t fRtInit = 0;
if (!(fFlags & SUPSECMAIN_FLAGS_DONT_OPEN_DEV))
{
if (fFlags & SUPSECMAIN_FLAGS_DRIVERLESS)
fRtInit |= (SUPR3INIT_F_DRIVERLESS << RTR3INIT_FLAGS_SUPLIB_SHIFT) | RTR3INIT_FLAGS_TRY_SUPLIB;
if (fFlags & SUPSECMAIN_FLAGS_DRIVERLESS_IEM_ALLOWED)
fRtInit |= (SUPR3INIT_F_DRIVERLESS_IEM_ALLOWED << RTR3INIT_FLAGS_SUPLIB_SHIFT) | RTR3INIT_FLAGS_TRY_SUPLIB;
#ifdef VBOX_WITH_DRIVERLESS_NEM_FALLBACK
if (fFlags & SUPSECMAIN_FLAGS_DRIVERLESS_NEM_FALLBACK)
fRtInit |= (SUPR3INIT_F_DRIVERLESS_NEM_FALLBACK << RTR3INIT_FLAGS_SUPLIB_SHIFT) | RTR3INIT_FLAGS_TRY_SUPLIB;
#endif
if (!(fRtInit & RTR3INIT_FLAGS_TRY_SUPLIB))
fRtInit |= RTR3INIT_FLAGS_SUPLIB;
}
/* Now do the IPRT init. */
rc = pfnRTInitEx(RTR3INIT_VER_CUR, fRtInit, 0 /*cArgs*/, NULL /*papszArgs*/, pszExePath);
if (RT_FAILURE(rc))
supR3HardenedFatalMsg("supR3HardenedMainInitRuntime", kSupInitOp_IPRT, rc,
"RTR3InitEx failed with rc=%d (fRtFlags=%#x)", rc, fRtInit);
#if defined(RT_OS_WINDOWS)
/*
* Windows: Create thread that terminates the process when the parent stub
* process terminates (VBoxNetDHCP, Ctrl-C, etc).
*/
if (!(fFlags & SUPSECMAIN_FLAGS_DONT_OPEN_DEV))
supR3HardenedWinCreateParentWatcherThread(hMod);
#endif
}
/**
* Construct the path to the DLL/SO/DYLIB containing the actual program.
*
* @returns VBox status code.
* @param pszProgName The program name.
* @param fMainFlags The flags passed to SUPR3HardenedMain.
* @param pszPath The output buffer.
* @param cbPath The size of the output buffer, in bytes. Must be at
* least 128 bytes!
*/
static int supR3HardenedMainGetTrustedLib(const char *pszProgName, uint32_t fMainFlags, char *pszPath, size_t cbPath)
{
supR3HardenedPathAppPrivateArch(pszPath, sizeof(cbPath) - 10);
const char *pszSubDirSlash;
switch (g_fSupHardenedMain & SUPSECMAIN_FLAGS_LOC_MASK)
{
case SUPSECMAIN_FLAGS_LOC_APP_BIN:
#ifdef RT_OS_DARWIN
case SUPSECMAIN_FLAGS_LOC_OSX_HLP_APP:
#endif
pszSubDirSlash = "/";
break;
case SUPSECMAIN_FLAGS_LOC_TESTCASE:
pszSubDirSlash = "/testcase/";
break;
default:
pszSubDirSlash = "/";
supR3HardenedFatal("supR3HardenedMainGetTrustedMain: Unknown program binary location: %#x\n", g_fSupHardenedMain);
}
#ifdef RT_OS_DARWIN
if (fMainFlags & SUPSECMAIN_FLAGS_OSX_VM_APP)
pszProgName = "VirtualBox";
#else
RT_NOREF1(fMainFlags);
#endif
size_t cch = suplibHardenedStrLen(pszPath);
return suplibHardenedStrCopyEx(&pszPath[cch], cbPath - cch, pszSubDirSlash, pszProgName, SUPLIB_DLL_SUFF, NULL);
}
/**
* Loads the DLL/SO/DYLIB containing the actual program and
* resolves the TrustedError symbol.
*
* This is very similar to supR3HardenedMainGetTrustedMain().
*
* @returns Pointer to the trusted error symbol if it is exported, NULL
* and no error messages otherwise.
* @param pszProgName The program name.
*/
static PFNSUPTRUSTEDERROR supR3HardenedMainGetTrustedError(const char *pszProgName)
{
/*
* Don't bother if the main() function didn't advertise any TrustedError
* export. It's both a waste of time and may trigger additional problems,
* confusing or obscuring the original issue.
*/
if (!(g_fSupHardenedMain & SUPSECMAIN_FLAGS_TRUSTED_ERROR))
return NULL;
/*
* Construct the name.
*/
char szPath[RTPATH_MAX];
supR3HardenedMainGetTrustedLib(pszProgName, g_fSupHardenedMain, szPath, sizeof(szPath));
/*
* Open it and resolve the symbol.
*/
#if defined(RT_OS_WINDOWS)
supR3HardenedWinEnableThreadCreation();
HMODULE hMod = (HMODULE)supR3HardenedWinLoadLibrary(szPath, false /*fSystem32Only*/, 0 /*fMainFlags*/);
if (!hMod)
return NULL;
FARPROC pfn = GetProcAddress(hMod, SUP_HARDENED_SYM("TrustedError"));
if (!pfn)
return NULL;
return (PFNSUPTRUSTEDERROR)pfn;
#else
/* the dlopen crowd */
void *pvMod = dlopen(szPath, RTLD_NOW | RTLD_GLOBAL);
if (!pvMod)
return NULL;
void *pvSym = dlsym(pvMod, SUP_HARDENED_SYM("TrustedError"));
if (!pvSym)
return NULL;
return (PFNSUPTRUSTEDERROR)(uintptr_t)pvSym;
#endif
}
/**
* Loads the DLL/SO/DYLIB containing the actual program and
* resolves the TrustedMain symbol.
*
* @returns Pointer to the trusted main of the actual program.
* @param pszProgName The program name.
* @param fMainFlags The flags passed to SUPR3HardenedMain.
* @remarks This function will not return on failure.
*/
static PFNSUPTRUSTEDMAIN supR3HardenedMainGetTrustedMain(const char *pszProgName, uint32_t fMainFlags)
{
/*
* Construct the name.
*/
char szPath[RTPATH_MAX];
supR3HardenedMainGetTrustedLib(pszProgName, fMainFlags, szPath, sizeof(szPath));
/*
* Open it and resolve the symbol.
*/
#if defined(RT_OS_WINDOWS)
HMODULE hMod = (HMODULE)supR3HardenedWinLoadLibrary(szPath, false /*fSystem32Only*/, 0 /*fMainFlags*/);
if (!hMod)
supR3HardenedFatal("supR3HardenedMainGetTrustedMain: LoadLibrary \"%s\" failed, rc=%d\n",
szPath, RtlGetLastWin32Error());
FARPROC pfn = GetProcAddress(hMod, SUP_HARDENED_SYM("TrustedMain"));
if (!pfn)
supR3HardenedFatal("supR3HardenedMainGetTrustedMain: Entrypoint \"TrustedMain\" not found in \"%s\" (rc=%d)\n",
szPath, RtlGetLastWin32Error());
return (PFNSUPTRUSTEDMAIN)pfn;
#else
/* the dlopen crowd */
void *pvMod = dlopen(szPath, RTLD_NOW | RTLD_GLOBAL);
if (!pvMod)
supR3HardenedFatal("supR3HardenedMainGetTrustedMain: dlopen(\"%s\",) failed: %s\n",
szPath, dlerror());
void *pvSym = dlsym(pvMod, SUP_HARDENED_SYM("TrustedMain"));
if (!pvSym)
supR3HardenedFatal("supR3HardenedMainGetTrustedMain: Entrypoint \"TrustedMain\" not found in \"%s\"!\ndlerror: %s\n",
szPath, dlerror());
return (PFNSUPTRUSTEDMAIN)(uintptr_t)pvSym;
#endif
}
DECLHIDDEN(int) SUPR3HardenedMain(const char *pszProgName, uint32_t fFlags, int argc, char **argv, char **envp)
{
SUP_DPRINTF(("SUPR3HardenedMain: pszProgName=%s fFlags=%#x\n", pszProgName, fFlags));
g_enmSupR3HardenedMainState = SUPR3HARDENEDMAINSTATE_HARDENED_MAIN_CALLED;
/*
* Note! At this point there is no IPRT, so we will have to stick
* to basic CRT functions that everyone agree upon.
*/
g_pszSupLibHardenedProgName = pszProgName;
g_fSupHardenedMain = fFlags;
g_SupPreInitData.u32Magic = SUPPREINITDATA_MAGIC;
g_SupPreInitData.u32EndMagic = SUPPREINITDATA_MAGIC;
#ifdef RT_OS_WINDOWS
if (!g_fSupEarlyProcessInit)
#endif
g_SupPreInitData.Data.hDevice = SUP_HDEVICE_NIL;
/*
* Determine the full exe path as we'll be needing it for the verify all
* call(s) below. (We have to do this early on Linux because we * *might*
* not be able to access /proc/self/exe after the seteuid call.)
*/
supR3HardenedGetFullExePath();
#ifdef RT_OS_WINDOWS
supR3HardenedWinInitAppBin(fFlags);
#endif
#ifdef SUP_HARDENED_SUID
/*
* Grab any options from the environment.
*/
supR3GrabOptions();
/*
* Check that we're root, if we aren't then the installation is butchered.
*/
g_uid = getuid();
g_gid = getgid();
if (geteuid() != 0 /* root */)
supR3HardenedFatalMsg("SUPR3HardenedMain", kSupInitOp_RootCheck, VERR_PERMISSION_DENIED,
"Effective UID is not root (euid=%d egid=%d uid=%d gid=%d)",
geteuid(), getegid(), g_uid, g_gid);
#endif /* SUP_HARDENED_SUID */
#ifdef RT_OS_WINDOWS
/*
* Windows: First respawn. On Windows we will respawn the process twice to establish
* something we can put some kind of reliable trust in. The first respawning aims
* at dropping compatibility layers and process "security" solutions.
*/
if ( !g_fSupEarlyProcessInit
&& !(fFlags & SUPSECMAIN_FLAGS_DONT_OPEN_DEV)
&& supR3HardenedWinIsReSpawnNeeded(1 /*iWhich*/, argc, argv))
{
SUP_DPRINTF(("SUPR3HardenedMain: Respawn #1\n"));
supR3HardenedWinInit(SUPSECMAIN_FLAGS_DONT_OPEN_DEV | SUPSECMAIN_FLAGS_FIRST_PROCESS, false /*fAvastKludge*/);
supR3HardenedVerifyAll(true /* fFatal */, pszProgName, g_szSupLibHardenedExePath, fFlags);
return supR3HardenedWinReSpawn(1 /*iWhich*/);
}
/*
* Windows: Initialize the image verification global data so we can verify the
* signature of the process image and hook the core of the DLL loader API so we
* can check the signature of all DLLs mapped into the process. (Already done
* by early VM process init.)
*/
if (!g_fSupEarlyProcessInit)
supR3HardenedWinInit(fFlags, true /*fAvastKludge*/);
#endif /* RT_OS_WINDOWS */
/*
* Validate the installation.
*/
supR3HardenedVerifyAll(true /* fFatal */, pszProgName, g_szSupLibHardenedExePath, fFlags);
/*
* The next steps are only taken if we actually need to access the support
* driver. (Already done by early process init.)
*/
if (!(fFlags & SUPSECMAIN_FLAGS_DONT_OPEN_DEV))
{
#ifdef RT_OS_WINDOWS
/*
* Windows: Must have done early process init if we get here.
*/
if (!g_fSupEarlyProcessInit)
supR3HardenedFatalMsg("SUPR3HardenedMain", kSupInitOp_Integrity, VERR_WRONG_ORDER,
"Early process init was somehow skipped.");
/*
* Windows: The second respawn. This time we make a special arrangement
* with vboxdrv to monitor access to the new process from its inception.
*/
if (supR3HardenedWinIsReSpawnNeeded(2 /* iWhich*/, argc, argv))
{
SUP_DPRINTF(("SUPR3HardenedMain: Respawn #2\n"));
return supR3HardenedWinReSpawn(2 /* iWhich*/);
}
SUP_DPRINTF(("SUPR3HardenedMain: Final process, opening VBoxDrv...\n"));
supR3HardenedWinFlushLoaderCache();
#else
/*
* Open the vboxdrv device.
*/
supR3HardenedMainOpenDevice();
#endif /* !RT_OS_WINDOWS */
}
#ifdef RT_OS_WINDOWS
/*
* Windows: Enable the use of windows APIs to verify images at load time.
*/
supR3HardenedWinEnableThreadCreation();
supR3HardenedWinFlushLoaderCache();
supR3HardenedWinResolveVerifyTrustApiAndHookThreadCreation(g_pszSupLibHardenedProgName);
g_enmSupR3HardenedMainState = SUPR3HARDENEDMAINSTATE_WIN_VERIFY_TRUST_READY;
#else /* !RT_OS_WINDOWS */
# if defined(RT_OS_DARWIN)
supR3HardenedDarwinInit();
# elif !defined(RT_OS_FREEBSD) /** @todo Portme. */
/*
* Posix: Hook the load library interface interface.
*/
supR3HardenedPosixInit();
# endif
#endif /* !RT_OS_WINDOWS */
#ifdef SUP_HARDENED_SUID
/*
* Grab additional capabilities / privileges.
*/
supR3HardenedMainGrabCapabilites();
/*
* Drop any root privileges we might be holding (won't return on failure)
*/
supR3HardenedMainDropPrivileges();
#endif
/*
* Purge any environment variables and command line arguments considered harmful.
*/
/** @todo May need to move this to a much earlier stage on windows. */
supR3HardenedMainPurgeEnvironment(envp);
supR3HardenedMainPurgeArgs(argc, argv, &argc, &argv);
/*
* Load the IPRT, hand the SUPLib part the open driver and
* call RTR3InitEx.
*/
SUP_DPRINTF(("SUPR3HardenedMain: Load Runtime...\n"));
g_enmSupR3HardenedMainState = SUPR3HARDENEDMAINSTATE_INIT_RUNTIME;
supR3HardenedMainInitRuntime(fFlags);
#ifdef RT_OS_WINDOWS
supR3HardenedWinModifyDllSearchPath(fFlags, g_szSupLibHardenedAppBinPath);
#endif
/*
* Load the DLL/SO/DYLIB containing the actual program
* and pass control to it.
*/
SUP_DPRINTF(("SUPR3HardenedMain: Load TrustedMain...\n"));
g_enmSupR3HardenedMainState = SUPR3HARDENEDMAINSTATE_GET_TRUSTED_MAIN;
PFNSUPTRUSTEDMAIN pfnTrustedMain = supR3HardenedMainGetTrustedMain(pszProgName, fFlags);
SUP_DPRINTF(("SUPR3HardenedMain: Calling TrustedMain (%p)...\n", pfnTrustedMain));
g_enmSupR3HardenedMainState = SUPR3HARDENEDMAINSTATE_CALLED_TRUSTED_MAIN;
return pfnTrustedMain(argc, argv, envp);
}
|