VirtualBox

source: vbox/trunk/src/VBox/HostDrivers/Support/SUPR3HardenedMain.cpp@ 104166

Last change on this file since 104166 was 104166, checked in by vboxsync, 6 weeks ago

SUPR3HardenedMain: Prevent hardened binaries from starting in unknown location (fix Linux packages), bugref:10626.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 100.1 KB
Line 
1/* $Id: SUPR3HardenedMain.cpp 104166 2024-04-04 18:45:02Z vboxsync $ */
2/** @file
3 * VirtualBox Support Library - Hardened main().
4 */
5
6/*
7 * Copyright (C) 2006-2023 Oracle and/or its affiliates.
8 *
9 * This file is part of VirtualBox base platform packages, as
10 * available from https://www.virtualbox.org.
11 *
12 * This program is free software; you can redistribute it and/or
13 * modify it under the terms of the GNU General Public License
14 * as published by the Free Software Foundation, in version 3 of the
15 * License.
16 *
17 * This program is distributed in the hope that it will be useful, but
18 * WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 * General Public License for more details.
21 *
22 * You should have received a copy of the GNU General Public License
23 * along with this program; if not, see <https://www.gnu.org/licenses>.
24 *
25 * The contents of this file may alternatively be used under the terms
26 * of the Common Development and Distribution License Version 1.0
27 * (CDDL), a copy of it is provided in the "COPYING.CDDL" file included
28 * in the VirtualBox distribution, in which case the provisions of the
29 * CDDL are applicable instead of those of the GPL.
30 *
31 * You may elect to license modified versions of this file under the
32 * terms and conditions of either the GPL or the CDDL or both.
33 *
34 * SPDX-License-Identifier: GPL-3.0-only OR CDDL-1.0
35 */
36
37/** @page pg_hardening %VirtualBox %VM Process Hardening
38 *
39 * The %VM process hardening is to prevent malicious software from using
40 * %VirtualBox as a vehicle to obtain kernel level access.
41 *
42 * The %VirtualBox %VMM requires supervisor (kernel) level access to the CPU.
43 * For both practical and historical reasons, part of the %VMM is realized in
44 * ring-3, with a rich interface to the kernel part. While the device
45 * emulations can be executed exclusively in ring-3, we have performance
46 * optimizations that loads device emulation code into ring-0 and our special
47 * raw-mode execution context (none VT-x/AMD-V mode) for handling frequent
48 * operations a lot more efficiently. These share data between all three
49 * context (ring-3, ring-0 and raw-mode). All this poses a rather broad attack
50 * surface, which the hardening protects.
51 *
52 * The hardening focuses primarily on restricting access to the support driver,
53 * VBoxDrv or vboxdrv depending on the OS, as it is ultimately the link and
54 * instigator of the communication between ring-3 and the ring-0 and raw-mode
55 * contexts. A secondary focus is to make sure malicious code cannot be loaded
56 * and executed in the %VM process. Exactly how we go about this depends a lot
57 * on the host OS.
58 *
59 * @section sec_hardening_supdrv The Support Driver Interfaces
60 *
61 * The support driver has several interfaces thru which it can be accessed:
62 * - /dev/vboxdrv (win: \\Device\\VBoxDrv) for full unrestricted access.
63 * Offers a rich I/O control interface, which needs protecting.
64 * - /dev/vboxdrvu (win: \\Device\\VBoxDrvU) for restricted access, which
65 * VBoxSVC uses to query VT-x and AMD-V capabilities. This does not
66 * require protecting, though we limit it to the vboxgroup on some
67 * systems.
68 * - \\Device\\VBoxDrvStub on Windows for protecting the second stub
69 * process and its child, the %VM process. This is an open+close
70 * interface, only available to partially verified stub processes.
71 * - \\Device\\VBoxDrvErrorInfo on Windows for obtaining detailed error
72 * information on a previous attempt to open \\Device\\VBoxDrv or
73 * \\Device\\VBoxDrvStub. Open, read and close only interface.
74 *
75 * The rest of VBox accesses the device interface thru the support library,
76 * @ref grp_sup "SUPR3" / sup.h.
77 *
78 * The support driver also exposes a set of functions and data that other VBox
79 * ring-0 modules can import from. This includes much of the IPRT we need in
80 * the ring-0 part of the %VMM and device emulations.
81 *
82 * The ring-0 part of the %VMM and device emulations are loaded via the
83 * #SUPR3LoadModule and #SUPR3LoadServiceModule support library function, which
84 * both translates to a sequence of I/O controls against /dev/vboxdrv. On
85 * Windows we use the native kernel loader to load the module, while on the
86 * other systems ring-3 prepares the bits with help from the IPRT loader code.
87 *
88 *
89 * @section sec_hardening_unix Hardening on UNIX-like OSes
90 *
91 * On UNIX-like systems (Solaris, Linux, darwin, freebsd, ...) we put our trust
92 * in root and that root knows what he/she/it is doing.
93 *
94 * We only allow root to get full unrestricted access to the support driver.
95 * The device node corresponding to unrestricted access (/dev/vboxdrv) is own by
96 * root and has a 0600 access mode (i.e. only accessible to the owner, root). In
97 * addition to this file system level restriction, the support driver also
98 * checks that the effective user ID (EUID) is root when it is being opened.
99 *
100 * The %VM processes temporarily assume root privileges using the set-uid-bit on
101 * the executable with root as owner. In fact, all the files and directories we
102 * install are owned by root and the wheel (or equivalent gid = 0) group,
103 * including extension pack files.
104 *
105 * The executable with the set-uid-to-root-bit set is a stub binary that has no
106 * unnecessary library dependencies (only libc, pthreads, dynamic linker) and
107 * simply calls #SUPR3HardenedMain. It does the following:
108 * 1. Validate the VirtualBox installation (#supR3HardenedVerifyAll):
109 * - Check that the executable file of the process is one of the known
110 * VirtualBox executables.
111 * - Check that all mandatory files are present.
112 * - Check that all installed files and directories (both optional and
113 * mandatory ones) are owned by root:wheel and are not writable by
114 * anyone except root.
115 * - Check that all the parent directories, all the way up to the root
116 * if possible, only permits root (or system admin) to change them.
117 * This is that to rule out unintentional rename races.
118 * - On some systems we may also validate the cryptographic signtures
119 * of executable images.
120 *
121 * 2. Open a file descriptor for the support device driver
122 * (#supR3HardenedMainOpenDevice).
123 *
124 * 3. Grab ICMP capabilities for NAT ping support, if required by the OS
125 * (#supR3HardenedMainGrabCapabilites).
126 *
127 * 4. Correctly drop the root privileges
128 * (#supR3HardenedMainDropPrivileges).
129 *
130 * 5. Load the VBoxRT dynamic link library and hand over the file
131 * descriptor to the support library code in it
132 * (#supR3HardenedMainInitRuntime).
133 *
134 * 6. Load the dynamic library containing the actual %VM front end code and
135 * run it (tail of #SUPR3HardenedMain).
136 *
137 * The set-uid-to-root stub executable is paired with a dynamic link library
138 * which export one TrustedMain entry point (see #FNSUPTRUSTEDMAIN) that we
139 * call. In case of error reporting, the library may also export a TrustedError
140 * function (#FNSUPTRUSTEDERROR).
141 *
142 * That the set-uid-to-root-bit modifies the dynamic linker behavior on all
143 * systems, even after we've dropped back to the real user ID, is something we
144 * take advantage of. The dynamic linkers takes special care to prevent users
145 * from using clever tricks to inject their own code into set-uid processes and
146 * causing privilege escalation issues. This is the exact help we need.
147 *
148 * The VirtualBox installation location is hardcoded, which means the any
149 * dynamic linker paths embedded or inferred from the executable and dynamic
150 * libraries are also hardcoded. This helps eliminating search path attack
151 * vectors at the cost of being inflexible regarding installation location.
152 *
153 * In addition to what the dynamic linker does for us, the VirtualBox code will
154 * not directly be calling either RTLdrLoad or dlopen to load dynamic link
155 * libraries into the process. Instead it will call #SUPR3HardenedLdrLoad,
156 * #SUPR3HardenedLdrLoadAppPriv and #SUPR3HardenedLdrLoadPlugIn to do the
157 * loading. These functions will perform the same validations on the file being
158 * loaded as #SUPR3HardenedMain did in its validation step. So, anything we
159 * load must be installed with root/wheel as owner/group, the directory we load
160 * it from must also be owned by root:wheel and now allow for renaming the file.
161 * Similar ownership restrictions applies to all the parent directories (except
162 * on darwin).
163 *
164 * So, we place the responsibility of not installing malicious software on the
165 * root user on UNIX-like systems. Which is fair enough, in our opinion.
166 *
167 *
168 * @section sec_hardening_win Hardening on Windows
169 *
170 * On Windows we cannot put the same level or trust in the Administrator user(s)
171 * (equivalent of root/wheel on unix) as on the UNIX-like systems, which
172 * complicates things greatly.
173 *
174 * Some of the blame for this can be given to Windows being a descendant /
175 * replacement for a set of single user systems: DOS, Windows 1.0-3.11 Windows
176 * 95-ME, and OS/2. Users of NT 3.1 and later was inclined to want to always
177 * run it with full root/administrator privileges like they had done on the
178 * predecessors, while Microsoft didn't provide much incentive for more secure
179 * alternatives. Bad idea, security wise, but execellent for the security
180 * software industry. For this reason using a set-uid-to-root approach is
181 * pointless, even if Windows had one.
182 *
183 * So, in order to protect access to the support driver and protect the %VM
184 * process while it's running we have to do a lot more work. A keystone in the
185 * defences is cryptographic code signing. Here's the short version of what we
186 * do:
187 * - Minimal stub executable, signed with the same certificate as the
188 * kernel driver.
189 *
190 * - The stub executable respawns itself twice, hooking the NTDLL init
191 * routine to perform protection tasks as early as possible. The parent
192 * stub helps keep in the child clean for verification as does the
193 * support driver.
194 *
195 * - In order to protect against loading unwanted code into the process,
196 * the stub processes installs DLL load hooks with NTDLL as well as
197 * directly intercepting the LdrLoadDll and NtCreateSection APIs.
198 *
199 * - The support driver will verify all but the initial process very
200 * thoroughly before allowing them protection and in the final case full
201 * unrestricted access.
202 *
203 *
204 * @subsection sec_hardening_win_protsoft 3rd Party "Protection" Software
205 *
206 * What makes our life REALLY difficult on Windows is this 3rd party "security"
207 * software which is more or less required to keep a Windows system safe for
208 * normal users and all corporate IT departments rightly insists on installing.
209 * After the kernel patching clampdown in Vista, anti-* software has to do a
210 * lot more mucking about in user mode to get their job (kind of) done. So, it
211 * is common practice to patch a lot of NTDLL, KERNEL32, the executable import
212 * table, load extra DLLs into the process, allocate executable memory in the
213 * process (classic code injection) and more.
214 *
215 * The BIG problem with all this is that it is indistinguishable from what
216 * malicious software would be doing in order to intercept process activity
217 * (network sniffing, maybe password snooping) or gain a level of kernel access
218 * via the support driver. So, the "protection" software is what is currently
219 * forcing us to do the pre-NTDLL initialization.
220 *
221 *
222 * @subsection sec_hardening_win_1st_stub The Initial Stub Process
223 *
224 * We share the stub executable approach with the UNIX-like systems, so there's
225 * the #SUPR3HardenedMain calling stub executable with its partner DLL exporting
226 * TrustedMain and TrustedError. However, the stub executable does a lot more,
227 * while doing it in a more bare metal fashion:
228 * - It does not use the Microsoft CRT, what we need of CRT functions comes
229 * from IPRT.
230 * - It does not statically import anything. This is to avoid having an
231 * import table that can be patched to intercept our calls or extended to
232 * load additional DLLs.
233 * - Direct NT system calls. System calls normally going thru NTDLL, but
234 * since there is so much software out there which wants to patch known
235 * NTDLL entry points to control our software (either for good or
236 * malicious reasons), we do it ourselves.
237 *
238 * The initial stub process is not really to be trusted, though we try our best
239 * to limit potential harm (user mode debugger checks, disable thread creation).
240 * So, when it enters #SUPR3HardenedMain we only call #supR3HardenedVerifyAll to
241 * verify the installation (known executables and DLLs, checking their code
242 * signing signatures, keeping them all open to deny deletion and replacing) and
243 * does a respawn via #supR3HardenedWinReSpawn.
244 *
245 *
246 * @subsection sec_hardening_win_2nd_stub The Second Stub Process
247 *
248 * The second stub process will be created in suspended state, i.e. the main
249 * thread is suspended before it executes a single instruction. It is also
250 * created with a less generous ACLs, though this doesn't protect us from admin
251 * users. In order for #SUPR3HardenedMain to figure that it is the second stub
252 * process, the zeroth command line argument has been replaced by a known magic
253 * string (UUID).
254 *
255 * Now, before the process starts executing, the parent (initial stub) will
256 * patch the LdrInitializeThunk entry point in NTDLL to call
257 * #supR3HardenedEarlyProcessInit via #supR3HardenedEarlyProcessInitThunk. The
258 * parent will also plant some synchronization stuff via #g_ProcParams (NTDLL
259 * location, inherited event handles and associated ping-pong equipment).
260 *
261 * The LdrInitializeThunk entry point of NTDLL is where the kernel sets up
262 * process execution to start executing (via a user alert, so it is not subject
263 * to SetThreadContext). LdrInitializeThunk performs process, NTDLL and
264 * sub-system client (kernel32) initialization. A lot of "protection" software
265 * uses triggers in this initialization sequence (like the KERNEL32.DLL load
266 * event), so we avoid quite a bit of problems by getting our stuff done early
267 * on.
268 *
269 * However, there are also those that uses events that triggers immediately when
270 * the process is created or/and starts executing the first instruction. But we
271 * can easily counter these as we have a known process state we can restore. So,
272 * the first thing that #supR3HardenedEarlyProcessInit does is to signal the
273 * parent to perform a child purification, so the potentially evil influences
274 * can be exorcised.
275 *
276 * What the parent does during the purification is very similar to what the
277 * kernel driver will do later on when verifying the second stub and the %VM
278 * processes, except that instead of failing when encountering an shortcoming it
279 * will take corrective actions:
280 * - Executable memory regions not belonging to a DLL mapping will be
281 * attempted freed, and we'll only fail if we can't evict them.
282 * - All pages in the executable images in the process (should be just the
283 * stub executable and NTDLL) will be compared to the pristine fixed-up
284 * copy prepared by the IPRT PE loader code, restoring any bytes which
285 * appears differently in the child. (#g_ProcParams is exempted,
286 * LdrInitializeThunk is set to call NtTerminateThread.)
287 * - Unwanted DLLs will be unloaded (we have a set of DLLs we like).
288 *
289 * Before signalling the second stub process that it has been purified and should
290 * get on with it, the parent will close all handles with unrestricted access to
291 * the process and thread so that the initial stub process no longer can
292 * influence the child in any really harmful way. (The caller of CreateProcess
293 * usually receives handles with unrestricted access to the child process and
294 * its main thread. These could in theory be used with DuplicateHandle or
295 * WriteProcessMemory to get at the %VM process if we're not careful.)
296 *
297 * #supR3HardenedEarlyProcessInit will continue with opening the log file
298 * (requires command line parsing). It will continue to initialize a bunch of
299 * global variables, system calls and trustworthy/harmless NTDLL imports.
300 * #supR3HardenedWinInit is then called to setup image verification, that is:
301 * - Hook the NtCreateSection entry point in NTDLL so we can check all
302 * executable mappings before they're created and can be mapped. The
303 * NtCreateSection code jumps to #supR3HardenedMonitor_NtCreateSection.
304 * - Hook (ditto) the LdrLoadDll entry point in NTDLL so we can
305 * pre-validate all images that gets loaded the normal way (partly
306 * because the NtCreateSection context is restrictive because the NTDLL
307 * loader lock is usually held, which prevents us from safely calling
308 * WinVerityTrust). The LdrLoadDll code jumps to
309 * #supR3HardenedMonitor_LdrLoadDll.
310 *
311 * The image/DLL verification hooks are at this point able to verify DLLs
312 * containing embedded code signing signatures, and will restrict the locations
313 * from which DLLs will be loaded. When #SUPR3HardenedMain gets going later on,
314 * they will start insisting on everything having valid signatures, either
315 * embedded or in a signed installer catalog file.
316 *
317 * The function also irrevocably disables debug notifications related to the
318 * current thread, just to make attaching a debugging that much more difficult
319 * and less useful.
320 *
321 * Now, the second stub process will open the so called stub device
322 * (\\Device\\VBoxDrvStub), that is a special support driver device node that
323 * tells the support driver to:
324 * - Protect the process against the OpenProcess and OpenThread attack
325 * vectors by stripping risky access rights.
326 * - Check that the process isn't being debugged.
327 * - Check that the process contains exactly one thread.
328 * - Check that the process doesn't have any unknown DLLs loaded into it.
329 * - Check that the process doesn't have any executable memory (other than
330 * DLL sections) in it.
331 * - Check that the process executable is a known VBox executable which may
332 * access the support driver.
333 * - Check that the process executable is signed with the same code signing
334 * certificate as the driver and that the on disk image is valid
335 * according to its embedded signature.
336 * - Check all the signature of all DLLs in the process (NTDLL) if they are
337 * signed, and only accept unsigned ones in versions where they are known
338 * not to be signed.
339 * - Check that the code and readonly parts of the executable and DLLs
340 * mapped into the process matches the on disk content (no patches other
341 * than our own two in NTDLL are allowed).
342 *
343 * Once granted access to the stub device, #supR3HardenedEarlyProcessInit will
344 * restore the LdrInitializeThunk code and let the process perform normal
345 * initialization. Leading us to #SUPR3HardenedMain where we detect that this
346 * is the 2nd stub process and does another respawn.
347 *
348 *
349 * @subsection sec_hardening_win_3rd_stub The Final Stub / VM Process
350 *
351 * The third stub process is what becomes the %VM process. Because the parent
352 * has opened \\Device\\VBoxDrvSub, it is protected from malicious OpenProcess &
353 * OpenThread calls from the moment of inception, practically speaking.
354 *
355 * It goes thru the same suspended creation, patching, purification and such as
356 * its parent (the second stub process). However, instead of opening
357 * \\Device\\VBoxDrvStub from #supR3HardenedEarlyProcessInit, it opens the
358 * support driver for full unrestricted access, i.e. \\Device\\VBoxDrv.
359 *
360 * The support driver will perform the same checks as it did when
361 * \\Device\\VBoxDrvStub was opened, but in addition it will:
362 * - Check that the process is the first child of a process that opened
363 * \\Device\\VBoxDrvStub.
364 * - Check that the parent process is still alive.
365 * - Scan all open handles in the system for potentially harmful ones to
366 * the process or the primary thread.
367 *
368 * Knowing that the process is genuinly signed with the same certificate as the
369 * kernel driver, and the exectuable code in the process is either shipped by us
370 * or Microsoft, the support driver will trust it with full access and to keep
371 * the handle secure.
372 *
373 * We also trust the protection the support driver gives the process to keep out
374 * malicious ring-3 code, and therefore any code, patching or other mysterious
375 * stuff that enteres the process must be from kernel mode and that we can trust
376 * it (the alternative interpretation is that the kernel has been breanched
377 * already, which isn't our responsibility). This means that, the anti-software
378 * products can do whatever they like from this point on. However, should they
379 * do unrevertable changes to the process before this point, VirtualBox won't
380 * work.
381 *
382 * As in the second stub process, we'll now do normal process initialization and
383 * #SUPR3HardenedMain will take control. It will detect that it is being called
384 * by the 3rd stub process because of a different magic string starting the
385 * command line, and not respawn itself any more. #SUPR3HardenedMain will
386 * recheck the VirtualBox installation, keeping all known files open just like
387 * in two previous stub processes.
388 *
389 * It will then load the Windows cryptographic API and load the trusted root
390 * certificates from the Windows store. The API enables using installation
391 * catalog files for signature checking as well as providing a second
392 * verification in addition to our own implementation (IPRT). The certificates
393 * allows our signature validation implementation to validate all embedded
394 * signatures, not just the microsoft ones and the one signed by our own
395 * certificate.
396 *
397 */
398
399
400/*********************************************************************************************************************************
401* Header Files *
402*********************************************************************************************************************************/
403#if defined(RT_OS_OS2)
404# define INCL_BASE
405# define INCL_ERRORS
406# include <os2.h>
407# include <stdio.h>
408# include <stdlib.h>
409# include <dlfcn.h>
410# include <unistd.h>
411
412#elif RT_OS_WINDOWS
413# include <iprt/nt/nt-and-windows.h>
414
415#else /* UNIXes */
416# ifdef RT_OS_DARWIN
417# define _POSIX_C_SOURCE 1 /* pick the correct prototype for unsetenv. */
418# endif
419# include <iprt/types.h> /* stdint fun on darwin. */
420
421# include <stdio.h>
422# include <stdlib.h>
423# include <dlfcn.h>
424# include <limits.h>
425# include <errno.h>
426# include <unistd.h>
427# include <sys/stat.h>
428# include <sys/time.h>
429# include <sys/types.h>
430# if defined(RT_OS_LINUX)
431# undef USE_LIB_PCAP /* don't depend on libcap as we had to depend on either
432 libcap1 or libcap2 */
433
434# undef _POSIX_SOURCE
435# include <linux/types.h> /* sys/capabilities from uek-headers require this */
436# include <sys/capability.h>
437# include <sys/prctl.h>
438# ifndef CAP_TO_MASK
439# define CAP_TO_MASK(cap) RT_BIT(cap)
440# endif
441# elif defined(RT_OS_FREEBSD)
442# include <sys/param.h>
443# include <sys/sysctl.h>
444# elif defined(RT_OS_SOLARIS)
445# include <priv.h>
446# endif
447# include <pwd.h>
448# ifdef RT_OS_DARWIN
449# include <mach-o/dyld.h>
450# endif
451
452#endif
453
454#include <VBox/sup.h>
455#include <VBox/err.h>
456#ifdef RT_OS_WINDOWS
457# include <VBox/version.h>
458# include <iprt/utf16.h>
459#endif
460#include <iprt/ctype.h>
461#include <iprt/string.h>
462#include <iprt/initterm.h>
463#include <iprt/param.h>
464#include <iprt/path.h>
465
466#include "SUPLibInternal.h"
467
468
469/*********************************************************************************************************************************
470* Defined Constants And Macros *
471*********************************************************************************************************************************/
472/* This mess is temporary after eliminating a define duplicated in SUPLibInternal.h. */
473#if !defined(RT_OS_OS2) && !defined(RT_OS_WINDOWS) && !defined(RT_OS_L4)
474# ifndef SUP_HARDENED_SUID
475# error "SUP_HARDENED_SUID is NOT defined?!?"
476# endif
477#else
478# ifdef SUP_HARDENED_SUID
479# error "SUP_HARDENED_SUID is defined?!?"
480# endif
481#endif
482
483/** @def SUP_HARDENED_SYM
484 * Decorate a symbol that's resolved dynamically.
485 */
486#ifdef RT_OS_OS2
487# define SUP_HARDENED_SYM(sym) "_" sym
488#else
489# define SUP_HARDENED_SYM(sym) sym
490#endif
491
492
493/*********************************************************************************************************************************
494* Structures and Typedefs *
495*********************************************************************************************************************************/
496/** @see RTR3InitEx */
497typedef DECLCALLBACKTYPE(int, FNRTR3INITEX,(uint32_t iVersion, uint32_t fFlags, int cArgs,
498 char **papszArgs, const char *pszProgramPath));
499typedef FNRTR3INITEX *PFNRTR3INITEX;
500
501/** @see RTLogRelPrintf */
502typedef DECLCALLBACKTYPE(void, FNRTLOGRELPRINTF,(const char *pszFormat, ...));
503typedef FNRTLOGRELPRINTF *PFNRTLOGRELPRINTF;
504
505
506/**
507 * Descriptor of an environment variable to purge.
508 */
509typedef struct SUPENVPURGEDESC
510{
511 /** Name of the environment variable to purge. */
512 const char *pszEnv;
513 /** The length of the variable name. */
514 uint8_t cchEnv;
515 /** Flag whether a failure in purging the variable leads to
516 * a fatal error resulting in an process exit. */
517 bool fPurgeErrFatal;
518} SUPENVPURGEDESC;
519/** Pointer to a environment variable purge descriptor. */
520typedef SUPENVPURGEDESC *PSUPENVPURGEDESC;
521/** Pointer to a const environment variable purge descriptor. */
522typedef const SUPENVPURGEDESC *PCSUPENVPURGEDESC;
523
524/**
525 * Descriptor of an command line argument to purge.
526 */
527typedef struct SUPARGPURGEDESC
528{
529 /** Name of the argument to purge. */
530 const char *pszArg;
531 /** The length of the argument name. */
532 uint8_t cchArg;
533 /** Flag whether the argument is followed by an extra argument
534 * which must be purged too */
535 bool fTakesValue;
536} SUPARGPURGEDESC;
537/** Pointer to a environment variable purge descriptor. */
538typedef SUPARGPURGEDESC *PSUPARGPURGEDESC;
539/** Pointer to a const environment variable purge descriptor. */
540typedef const SUPARGPURGEDESC *PCSUPARGPURGEDESC;
541
542
543/*********************************************************************************************************************************
544* Global Variables *
545*********************************************************************************************************************************/
546/** The pre-init data we pass on to SUPR3 (residing in VBoxRT). */
547static SUPPREINITDATA g_SupPreInitData;
548/** The program executable path. */
549#ifndef RT_OS_WINDOWS
550static
551#endif
552char g_szSupLibHardenedExePath[RTPATH_MAX];
553/** The application bin directory path. */
554static char g_szSupLibHardenedAppBinPath[RTPATH_MAX];
555/** The offset into g_szSupLibHardenedExePath of the executable name. */
556static size_t g_offSupLibHardenedExecName;
557/** The length of the executable name in g_szSupLibHardenedExePath. */
558static size_t g_cchSupLibHardenedExecName;
559
560/** The program name. */
561static const char *g_pszSupLibHardenedProgName;
562/** The flags passed to SUPR3HardenedMain - SUPSECMAIN_FLAGS_XXX. */
563static uint32_t g_fSupHardenedMain;
564
565#ifdef SUP_HARDENED_SUID
566/** The real UID at startup. */
567static uid_t g_uid;
568/** The real GID at startup. */
569static gid_t g_gid;
570# ifdef RT_OS_LINUX
571static uint32_t g_uCaps;
572static uint32_t g_uCapsVersion;
573# endif
574#endif
575
576/** The startup log file. */
577#ifdef RT_OS_WINDOWS
578static HANDLE g_hStartupLog = NULL;
579#else
580static int g_hStartupLog = -1;
581#endif
582/** The number of bytes we've written to the startup log. */
583static uint32_t volatile g_cbStartupLog = 0;
584
585/** The current SUPR3HardenedMain state / location. */
586SUPR3HARDENEDMAINSTATE g_enmSupR3HardenedMainState = SUPR3HARDENEDMAINSTATE_NOT_YET_CALLED;
587AssertCompileSize(g_enmSupR3HardenedMainState, sizeof(uint32_t));
588
589#ifdef RT_OS_WINDOWS
590/** Pointer to VBoxRT's RTLogRelPrintf function so we can write errors to the
591 * release log at runtime. */
592static PFNRTLOGRELPRINTF g_pfnRTLogRelPrintf = NULL;
593/** Log volume name (for attempting volume flush). */
594static RTUTF16 g_wszStartupLogVol[16];
595#endif
596
597/** Environment variables to purge from the process because
598 * they are known to be harmful. */
599static const SUPENVPURGEDESC g_aSupEnvPurgeDescs[] =
600{
601 /* pszEnv fPurgeErrFatal */
602 /* Qt related environment variables: */
603 { RT_STR_TUPLE("QT_QPA_PLATFORM_PLUGIN_PATH"), true },
604 { RT_STR_TUPLE("QT_PLUGIN_PATH"), true },
605 /* ALSA related environment variables: */
606 { RT_STR_TUPLE("ALSA_MIXER_SIMPLE_MODULES"), true },
607 { RT_STR_TUPLE("LADSPA_PATH"), true },
608};
609
610/** Arguments to purge from the argument vector because
611 * they are known to be harmful. */
612static const SUPARGPURGEDESC g_aSupArgPurgeDescs[] =
613{
614 /* pszArg fTakesValue */
615 /* Qt related environment variables: */
616 { RT_STR_TUPLE("-platformpluginpath"), true },
617};
618
619
620/*********************************************************************************************************************************
621* Internal Functions *
622*********************************************************************************************************************************/
623#ifdef SUP_HARDENED_SUID
624static void supR3HardenedMainDropPrivileges(void);
625#endif
626static PFNSUPTRUSTEDERROR supR3HardenedMainGetTrustedError(const char *pszProgName);
627
628
629/**
630 * Safely copy one or more strings into the given buffer.
631 *
632 * @returns VINF_SUCCESS or VERR_BUFFER_OVERFLOW.
633 * @param pszDst The destionation buffer.
634 * @param cbDst The size of the destination buffer.
635 * @param ... One or more zero terminated strings, ending with
636 * a NULL.
637 */
638static int suplibHardenedStrCopyEx(char *pszDst, size_t cbDst, ...)
639{
640 int rc = VINF_SUCCESS;
641
642 if (cbDst == 0)
643 return VERR_BUFFER_OVERFLOW;
644
645 va_list va;
646 va_start(va, cbDst);
647 for (;;)
648 {
649 const char *pszSrc = va_arg(va, const char *);
650 if (!pszSrc)
651 break;
652
653 size_t cchSrc = suplibHardenedStrLen(pszSrc);
654 if (cchSrc < cbDst)
655 {
656 suplibHardenedMemCopy(pszDst, pszSrc, cchSrc);
657 pszDst += cchSrc;
658 cbDst -= cchSrc;
659 }
660 else
661 {
662 rc = VERR_BUFFER_OVERFLOW;
663 if (cbDst > 1)
664 {
665 suplibHardenedMemCopy(pszDst, pszSrc, cbDst - 1);
666 pszDst += cbDst - 1;
667 cbDst = 1;
668 }
669 }
670 *pszDst = '\0';
671 }
672 va_end(va);
673
674 return rc;
675}
676
677
678/**
679 * Exit current process in the quickest possible fashion.
680 *
681 * @param rcExit The exit code.
682 */
683DECLHIDDEN(DECL_NO_RETURN(void)) suplibHardenedExit(RTEXITCODE rcExit)
684{
685 for (;;)
686 {
687#ifdef RT_OS_WINDOWS
688 if (g_enmSupR3HardenedMainState >= SUPR3HARDENEDMAINSTATE_WIN_IMPORTS_RESOLVED)
689 ExitProcess(rcExit);
690 if (RtlExitUserProcess != NULL)
691 RtlExitUserProcess(rcExit);
692 NtTerminateProcess(NtCurrentProcess(), rcExit);
693#else
694 _Exit(rcExit);
695#endif
696 }
697}
698
699
700/**
701 * Writes a substring to standard error.
702 *
703 * @param pch The start of the substring.
704 * @param cch The length of the substring.
705 */
706static void suplibHardenedPrintStrN(const char *pch, size_t cch)
707{
708#ifdef RT_OS_WINDOWS
709 HANDLE hStdOut = NtCurrentPeb()->ProcessParameters->StandardOutput;
710 if (hStdOut != NULL)
711 {
712 if (g_enmSupR3HardenedMainState >= SUPR3HARDENEDMAINSTATE_WIN_IMPORTS_RESOLVED)
713 {
714 DWORD cbWritten;
715 WriteFile(hStdOut, pch, (DWORD)cch, &cbWritten, NULL);
716 }
717 /* Windows 7 and earlier uses fake handles, with the last two bits set ((hStdOut & 3) == 3). */
718 else if (NtWriteFile != NULL && ((uintptr_t)hStdOut & 3) == 0)
719 {
720 IO_STATUS_BLOCK Ios = RTNT_IO_STATUS_BLOCK_INITIALIZER;
721 NtWriteFile(hStdOut, NULL /*Event*/, NULL /*ApcRoutine*/, NULL /*ApcContext*/,
722 &Ios, (PVOID)pch, (ULONG)cch, NULL /*ByteOffset*/, NULL /*Key*/);
723 }
724 }
725#else
726 int res = write(2, pch, cch);
727 NOREF(res);
728#endif
729}
730
731
732/**
733 * Writes a string to standard error.
734 *
735 * @param psz The string.
736 */
737static void suplibHardenedPrintStr(const char *psz)
738{
739 suplibHardenedPrintStrN(psz, suplibHardenedStrLen(psz));
740}
741
742
743/**
744 * Writes a char to standard error.
745 *
746 * @param ch The character value to write.
747 */
748static void suplibHardenedPrintChr(char ch)
749{
750 suplibHardenedPrintStrN(&ch, 1);
751}
752
753#ifndef IPRT_NO_CRT
754
755/**
756 * Writes a decimal number to stdard error.
757 *
758 * @param uValue The value.
759 */
760static void suplibHardenedPrintDecimal(uint64_t uValue)
761{
762 char szBuf[64];
763 char *pszEnd = &szBuf[sizeof(szBuf) - 1];
764 char *psz = pszEnd;
765
766 *psz-- = '\0';
767
768 do
769 {
770 *psz-- = '0' + (uValue % 10);
771 uValue /= 10;
772 } while (uValue > 0);
773
774 psz++;
775 suplibHardenedPrintStrN(psz, pszEnd - psz);
776}
777
778
779/**
780 * Writes a hexadecimal or octal number to standard error.
781 *
782 * @param uValue The value.
783 * @param uBase The base (16 or 8).
784 * @param fFlags Format flags.
785 */
786static void suplibHardenedPrintHexOctal(uint64_t uValue, unsigned uBase, uint32_t fFlags)
787{
788 static char const s_achDigitsLower[17] = "0123456789abcdef";
789 static char const s_achDigitsUpper[17] = "0123456789ABCDEF";
790 const char *pchDigits = !(fFlags & RTSTR_F_CAPITAL) ? s_achDigitsLower : s_achDigitsUpper;
791 unsigned cShift = uBase == 16 ? 4 : 3;
792 unsigned fDigitMask = uBase == 16 ? 0xf : 7;
793 char szBuf[64];
794 char *pszEnd = &szBuf[sizeof(szBuf) - 1];
795 char *psz = pszEnd;
796
797 *psz-- = '\0';
798
799 do
800 {
801 *psz-- = pchDigits[uValue & fDigitMask];
802 uValue >>= cShift;
803 } while (uValue > 0);
804
805 if ((fFlags & RTSTR_F_SPECIAL) && uBase == 16)
806 {
807 *psz-- = !(fFlags & RTSTR_F_CAPITAL) ? 'x' : 'X';
808 *psz-- = '0';
809 }
810
811 psz++;
812 suplibHardenedPrintStrN(psz, pszEnd - psz);
813}
814
815
816/**
817 * Writes a wide character string to standard error.
818 *
819 * @param pwsz The string.
820 */
821static void suplibHardenedPrintWideStr(PCRTUTF16 pwsz)
822{
823 for (;;)
824 {
825 RTUTF16 wc = *pwsz++;
826 if (!wc)
827 return;
828 if ( (wc < 0x7f && wc >= 0x20)
829 || wc == '\n'
830 || wc == '\r')
831 suplibHardenedPrintChr((char)wc);
832 else
833 {
834 suplibHardenedPrintStrN(RT_STR_TUPLE("\\x"));
835 suplibHardenedPrintHexOctal(wc, 16, 0);
836 }
837 }
838}
839
840#else /* IPRT_NO_CRT */
841
842/** Buffer structure used by suplibHardenedOutput. */
843struct SUPLIBHARDENEDOUTPUTBUF
844{
845 size_t off;
846 char szBuf[2048];
847};
848
849/** Callback for RTStrFormatV, see FNRTSTROUTPUT. */
850static DECLCALLBACK(size_t) suplibHardenedOutput(void *pvArg, const char *pachChars, size_t cbChars)
851{
852 SUPLIBHARDENEDOUTPUTBUF *pBuf = (SUPLIBHARDENEDOUTPUTBUF *)pvArg;
853 size_t cbTodo = cbChars;
854 for (;;)
855 {
856 size_t cbSpace = sizeof(pBuf->szBuf) - pBuf->off - 1;
857
858 /* Flush the buffer? */
859 if ( cbSpace == 0
860 || (cbTodo == 0 && pBuf->off))
861 {
862 suplibHardenedPrintStrN(pBuf->szBuf, pBuf->off);
863# ifdef RT_OS_WINDOWS
864 if (g_enmSupR3HardenedMainState >= SUPR3HARDENEDMAINSTATE_WIN_IMPORTS_RESOLVED)
865 OutputDebugString(pBuf->szBuf);
866# endif
867 pBuf->off = 0;
868 cbSpace = sizeof(pBuf->szBuf) - 1;
869 }
870
871 /* Copy the string into the buffer. */
872 if (cbTodo == 1)
873 {
874 pBuf->szBuf[pBuf->off++] = *pachChars;
875 break;
876 }
877 if (cbSpace >= cbTodo)
878 {
879 memcpy(&pBuf->szBuf[pBuf->off], pachChars, cbTodo);
880 pBuf->off += cbTodo;
881 break;
882 }
883 memcpy(&pBuf->szBuf[pBuf->off], pachChars, cbSpace);
884 pBuf->off += cbSpace;
885 cbTodo -= cbSpace;
886 }
887 pBuf->szBuf[pBuf->off] = '\0';
888
889 return cbChars;
890}
891
892#endif /* IPRT_NO_CRT */
893
894/**
895 * Simple printf to standard error.
896 *
897 * @param pszFormat The format string.
898 * @param va Arguments to format.
899 */
900DECLHIDDEN(void) suplibHardenedPrintFV(const char *pszFormat, va_list va)
901{
902#ifdef IPRT_NO_CRT
903 /*
904 * Use buffered output here to avoid character mixing on the windows
905 * console and to enable us to use OutputDebugString.
906 */
907 SUPLIBHARDENEDOUTPUTBUF Buf;
908 Buf.off = 0;
909 Buf.szBuf[0] = '\0';
910 RTStrFormatV(suplibHardenedOutput, &Buf, NULL, NULL, pszFormat, va);
911
912#else /* !IPRT_NO_CRT */
913 /*
914 * Format loop.
915 */
916 char ch;
917 const char *pszLast = pszFormat;
918 for (;;)
919 {
920 ch = *pszFormat;
921 if (!ch)
922 break;
923 pszFormat++;
924
925 if (ch == '%')
926 {
927 /*
928 * Format argument.
929 */
930
931 /* Flush unwritten bits. */
932 if (pszLast != pszFormat - 1)
933 suplibHardenedPrintStrN(pszLast, pszFormat - pszLast - 1);
934 pszLast = pszFormat;
935 ch = *pszFormat++;
936
937 /* flags. */
938 uint32_t fFlags = 0;
939 for (;;)
940 {
941 if (ch == '#') fFlags |= RTSTR_F_SPECIAL;
942 else if (ch == '-') fFlags |= RTSTR_F_LEFT;
943 else if (ch == '+') fFlags |= RTSTR_F_PLUS;
944 else if (ch == ' ') fFlags |= RTSTR_F_BLANK;
945 else if (ch == '0') fFlags |= RTSTR_F_ZEROPAD;
946 else if (ch == '\'') fFlags |= RTSTR_F_THOUSAND_SEP;
947 else break;
948 ch = *pszFormat++;
949 }
950
951 /* Width and precision - ignored. */
952 while (RT_C_IS_DIGIT(ch))
953 ch = *pszFormat++;
954 if (ch == '*')
955 va_arg(va, int);
956 if (ch == '.')
957 {
958 do ch = *pszFormat++;
959 while (RT_C_IS_DIGIT(ch));
960 if (ch == '*')
961 va_arg(va, int);
962 }
963
964 /* Size. */
965 char chArgSize = 0;
966 switch (ch)
967 {
968 case 'z':
969 case 'L':
970 case 'j':
971 case 't':
972 chArgSize = ch;
973 ch = *pszFormat++;
974 break;
975
976 case 'l':
977 chArgSize = ch;
978 ch = *pszFormat++;
979 if (ch == 'l')
980 {
981 chArgSize = 'L';
982 ch = *pszFormat++;
983 }
984 break;
985
986 case 'h':
987 chArgSize = ch;
988 ch = *pszFormat++;
989 if (ch == 'h')
990 {
991 chArgSize = 'H';
992 ch = *pszFormat++;
993 }
994 break;
995 }
996
997 /*
998 * Do type specific formatting.
999 */
1000 switch (ch)
1001 {
1002 case 'c':
1003 ch = (char)va_arg(va, int);
1004 suplibHardenedPrintChr(ch);
1005 break;
1006
1007 case 's':
1008 if (chArgSize == 'l')
1009 {
1010 PCRTUTF16 pwszStr = va_arg(va, PCRTUTF16 );
1011 if (RT_VALID_PTR(pwszStr))
1012 suplibHardenedPrintWideStr(pwszStr);
1013 else
1014 suplibHardenedPrintStr("<NULL>");
1015 }
1016 else
1017 {
1018 const char *pszStr = va_arg(va, const char *);
1019 if (!RT_VALID_PTR(pszStr))
1020 pszStr = "<NULL>";
1021 suplibHardenedPrintStr(pszStr);
1022 }
1023 break;
1024
1025 case 'd':
1026 case 'i':
1027 {
1028 int64_t iValue;
1029 if (chArgSize == 'L' || chArgSize == 'j')
1030 iValue = va_arg(va, int64_t);
1031 else if (chArgSize == 'l')
1032 iValue = va_arg(va, signed long);
1033 else if (chArgSize == 'z' || chArgSize == 't')
1034 iValue = va_arg(va, intptr_t);
1035 else
1036 iValue = va_arg(va, signed int);
1037 if (iValue < 0)
1038 {
1039 suplibHardenedPrintChr('-');
1040 iValue = -iValue;
1041 }
1042 suplibHardenedPrintDecimal(iValue);
1043 break;
1044 }
1045
1046 case 'p':
1047 case 'x':
1048 case 'X':
1049 case 'u':
1050 case 'o':
1051 {
1052 unsigned uBase = 10;
1053 uint64_t uValue;
1054
1055 switch (ch)
1056 {
1057 case 'p':
1058 fFlags |= RTSTR_F_ZEROPAD; /* Note not standard behaviour (but I like it this way!) */
1059 uBase = 16;
1060 break;
1061 case 'X':
1062 fFlags |= RTSTR_F_CAPITAL;
1063 RT_FALL_THRU();
1064 case 'x':
1065 uBase = 16;
1066 break;
1067 case 'u':
1068 uBase = 10;
1069 break;
1070 case 'o':
1071 uBase = 8;
1072 break;
1073 }
1074
1075 if (ch == 'p' || chArgSize == 'z' || chArgSize == 't')
1076 uValue = va_arg(va, uintptr_t);
1077 else if (chArgSize == 'L' || chArgSize == 'j')
1078 uValue = va_arg(va, uint64_t);
1079 else if (chArgSize == 'l')
1080 uValue = va_arg(va, unsigned long);
1081 else
1082 uValue = va_arg(va, unsigned int);
1083
1084 if (uBase == 10)
1085 suplibHardenedPrintDecimal(uValue);
1086 else
1087 suplibHardenedPrintHexOctal(uValue, uBase, fFlags);
1088 break;
1089 }
1090
1091 case 'R':
1092 if (pszFormat[0] == 'r' && pszFormat[1] == 'c')
1093 {
1094 int iValue = va_arg(va, int);
1095 if (iValue < 0)
1096 {
1097 suplibHardenedPrintChr('-');
1098 iValue = -iValue;
1099 }
1100 suplibHardenedPrintDecimal(iValue);
1101 pszFormat += 2;
1102 break;
1103 }
1104 RT_FALL_THRU();
1105
1106 /*
1107 * Custom format.
1108 */
1109 default:
1110 suplibHardenedPrintStr("[bad format: ");
1111 suplibHardenedPrintStrN(pszLast, pszFormat - pszLast);
1112 suplibHardenedPrintChr(']');
1113 break;
1114 }
1115
1116 /* continue */
1117 pszLast = pszFormat;
1118 }
1119 }
1120
1121 /* Flush the last bits of the string. */
1122 if (pszLast != pszFormat)
1123 suplibHardenedPrintStrN(pszLast, pszFormat - pszLast);
1124#endif /* !IPRT_NO_CRT */
1125}
1126
1127
1128/**
1129 * Prints to standard error.
1130 *
1131 * @param pszFormat The format string.
1132 * @param ... Arguments to format.
1133 */
1134DECLHIDDEN(void) suplibHardenedPrintF(const char *pszFormat, ...)
1135{
1136 va_list va;
1137 va_start(va, pszFormat);
1138 suplibHardenedPrintFV(pszFormat, va);
1139 va_end(va);
1140}
1141
1142
1143/**
1144 * @copydoc RTPathStripFilename
1145 */
1146static void suplibHardenedPathStripFilename(char *pszPath)
1147{
1148 char *psz = pszPath;
1149 char *pszLastSep = pszPath;
1150
1151 for (;; psz++)
1152 {
1153 switch (*psz)
1154 {
1155 /* handle separators. */
1156#if defined(RT_OS_WINDOWS) || defined(RT_OS_OS2)
1157 case ':':
1158 pszLastSep = psz + 1;
1159 break;
1160
1161 case '\\':
1162#endif
1163 case '/':
1164 pszLastSep = psz;
1165 break;
1166
1167 /* the end */
1168 case '\0':
1169 if (pszLastSep == pszPath)
1170 *pszLastSep++ = '.';
1171 *pszLastSep = '\0';
1172 return;
1173 }
1174 }
1175 /* will never get here */
1176}
1177
1178
1179DECLHIDDEN(char *) supR3HardenedPathFilename(const char *pszPath)
1180{
1181 const char *psz = pszPath;
1182 const char *pszLastComp = pszPath;
1183
1184 for (;; psz++)
1185 {
1186 switch (*psz)
1187 {
1188 /* handle separators. */
1189#if defined(RT_OS_WINDOWS) || defined(RT_OS_OS2)
1190 case ':':
1191 pszLastComp = psz + 1;
1192 break;
1193
1194 case '\\':
1195#endif
1196 case '/':
1197 pszLastComp = psz + 1;
1198 break;
1199
1200 /* the end */
1201 case '\0':
1202 if (*pszLastComp)
1203 return (char *)(void *)pszLastComp;
1204 return NULL;
1205 }
1206 }
1207
1208 /* will never get here */
1209}
1210
1211
1212DECLHIDDEN(int) supR3HardenedPathAppPrivateNoArch(char *pszPath, size_t cchPath)
1213{
1214#if !defined(RT_OS_WINDOWS) && defined(RTPATH_APP_PRIVATE)
1215 const char *pszSrcPath = RTPATH_APP_PRIVATE;
1216 size_t cchPathPrivateNoArch = suplibHardenedStrLen(pszSrcPath);
1217 if (cchPathPrivateNoArch >= cchPath)
1218 supR3HardenedFatal("supR3HardenedPathAppPrivateNoArch: Buffer overflow, %zu >= %zu\n", cchPathPrivateNoArch, cchPath);
1219 suplibHardenedMemCopy(pszPath, pszSrcPath, cchPathPrivateNoArch + 1);
1220 return VINF_SUCCESS;
1221
1222#else
1223 return supR3HardenedPathAppBin(pszPath, cchPath);
1224#endif
1225}
1226
1227
1228DECLHIDDEN(int) supR3HardenedPathAppPrivateArch(char *pszPath, size_t cchPath)
1229{
1230#if !defined(RT_OS_WINDOWS) && defined(RTPATH_APP_PRIVATE_ARCH)
1231 const char *pszSrcPath = RTPATH_APP_PRIVATE_ARCH;
1232 size_t cchPathPrivateArch = suplibHardenedStrLen(pszSrcPath);
1233 if (cchPathPrivateArch >= cchPath)
1234 supR3HardenedFatal("supR3HardenedPathAppPrivateArch: Buffer overflow, %zu >= %zu\n", cchPathPrivateArch, cchPath);
1235 suplibHardenedMemCopy(pszPath, pszSrcPath, cchPathPrivateArch + 1);
1236 return VINF_SUCCESS;
1237
1238#else
1239 return supR3HardenedPathAppBin(pszPath, cchPath);
1240#endif
1241}
1242
1243
1244DECLHIDDEN(int) supR3HardenedPathAppSharedLibs(char *pszPath, size_t cchPath)
1245{
1246#if !defined(RT_OS_WINDOWS) && defined(RTPATH_SHARED_LIBS)
1247 const char *pszSrcPath = RTPATH_SHARED_LIBS;
1248 size_t cchPathSharedLibs = suplibHardenedStrLen(pszSrcPath);
1249 if (cchPathSharedLibs >= cchPath)
1250 supR3HardenedFatal("supR3HardenedPathAppSharedLibs: Buffer overflow, %zu >= %zu\n", cchPathSharedLibs, cchPath);
1251 suplibHardenedMemCopy(pszPath, pszSrcPath, cchPathSharedLibs + 1);
1252 return VINF_SUCCESS;
1253
1254#else
1255 return supR3HardenedPathAppBin(pszPath, cchPath);
1256#endif
1257}
1258
1259
1260DECLHIDDEN(int) supR3HardenedPathAppDocs(char *pszPath, size_t cchPath)
1261{
1262#if !defined(RT_OS_WINDOWS) && defined(RTPATH_APP_DOCS)
1263 const char *pszSrcPath = RTPATH_APP_DOCS;
1264 size_t cchPathAppDocs = suplibHardenedStrLen(pszSrcPath);
1265 if (cchPathAppDocs >= cchPath)
1266 supR3HardenedFatal("supR3HardenedPathAppDocs: Buffer overflow, %zu >= %zu\n", cchPathAppDocs, cchPath);
1267 suplibHardenedMemCopy(pszPath, pszSrcPath, cchPathAppDocs + 1);
1268 return VINF_SUCCESS;
1269
1270#else
1271 return supR3HardenedPathAppBin(pszPath, cchPath);
1272#endif
1273}
1274
1275
1276/**
1277 * Returns the full path to the executable in g_szSupLibHardenedExePath.
1278 */
1279static void supR3HardenedGetFullExePath(void)
1280{
1281 /*
1282 * Get the program filename.
1283 *
1284 * Most UNIXes have no API for obtaining the executable path, but provides a symbolic
1285 * link in the proc file system that tells who was exec'ed. The bad thing about this
1286 * is that we have to use readlink, one of the weirder UNIX APIs.
1287 *
1288 * Darwin, OS/2 and Windows all have proper APIs for getting the program file name.
1289 */
1290#if defined(RT_OS_LINUX) || defined(RT_OS_FREEBSD) || defined(RT_OS_SOLARIS)
1291# ifdef RT_OS_LINUX
1292 int cchLink = readlink("/proc/self/exe", &g_szSupLibHardenedExePath[0], sizeof(g_szSupLibHardenedExePath) - 1);
1293
1294# elif defined(RT_OS_SOLARIS)
1295 char szFileBuf[PATH_MAX + 1];
1296 sprintf(szFileBuf, "/proc/%ld/path/a.out", (long)getpid());
1297 int cchLink = readlink(szFileBuf, &g_szSupLibHardenedExePath[0], sizeof(g_szSupLibHardenedExePath) - 1);
1298
1299# else /* RT_OS_FREEBSD */
1300 int aiName[4];
1301 aiName[0] = CTL_KERN;
1302 aiName[1] = KERN_PROC;
1303 aiName[2] = KERN_PROC_PATHNAME;
1304 aiName[3] = getpid();
1305
1306 size_t cbPath = sizeof(g_szSupLibHardenedExePath);
1307 if (sysctl(aiName, RT_ELEMENTS(aiName), g_szSupLibHardenedExePath, &cbPath, NULL, 0) < 0)
1308 supR3HardenedFatal("supR3HardenedExecDir: sysctl failed\n");
1309 g_szSupLibHardenedExePath[sizeof(g_szSupLibHardenedExePath) - 1] = '\0';
1310 int cchLink = suplibHardenedStrLen(g_szSupLibHardenedExePath); /* paranoid? can't we use cbPath? */
1311
1312# endif
1313 if (cchLink < 0 || cchLink == sizeof(g_szSupLibHardenedExePath) - 1)
1314 supR3HardenedFatal("supR3HardenedExecDir: couldn't read \"%s\", errno=%d cchLink=%d\n",
1315 g_szSupLibHardenedExePath, errno, cchLink);
1316 g_szSupLibHardenedExePath[cchLink] = '\0';
1317
1318#elif defined(RT_OS_OS2) || defined(RT_OS_L4)
1319 _execname(g_szSupLibHardenedExePath, sizeof(g_szSupLibHardenedExePath));
1320
1321#elif defined(RT_OS_DARWIN)
1322 const char *pszImageName = _dyld_get_image_name(0);
1323 if (!pszImageName)
1324 supR3HardenedFatal("supR3HardenedExecDir: _dyld_get_image_name(0) failed\n");
1325 size_t cchImageName = suplibHardenedStrLen(pszImageName);
1326 if (!cchImageName || cchImageName >= sizeof(g_szSupLibHardenedExePath))
1327 supR3HardenedFatal("supR3HardenedExecDir: _dyld_get_image_name(0) failed, cchImageName=%d\n", cchImageName);
1328 suplibHardenedMemCopy(g_szSupLibHardenedExePath, pszImageName, cchImageName + 1);
1329 /** @todo abspath the string or this won't work:
1330 * cd /Applications/VirtualBox.app/Contents/Resources/VirtualBoxVM.app/Contents/MacOS/ && ./VirtualBoxVM --startvm name */
1331
1332#elif defined(RT_OS_WINDOWS)
1333 char *pszDst = g_szSupLibHardenedExePath;
1334 int rc = RTUtf16ToUtf8Ex(g_wszSupLibHardenedExePath, RTSTR_MAX, &pszDst, sizeof(g_szSupLibHardenedExePath), NULL);
1335 if (RT_FAILURE(rc))
1336 supR3HardenedFatal("supR3HardenedExecDir: RTUtf16ToUtf8Ex failed, rc=%Rrc\n", rc);
1337#else
1338# error needs porting.
1339#endif
1340
1341 /*
1342 * Determine the application binary directory location.
1343 */
1344 suplibHardenedStrCopy(g_szSupLibHardenedAppBinPath, g_szSupLibHardenedExePath);
1345 suplibHardenedPathStripFilename(g_szSupLibHardenedAppBinPath);
1346
1347 /* Make sure binary is located in known location (unix-like hosts only). */
1348#if defined(RT_OS_LINUX) || defined(RT_OS_FREEBSD) || defined(RT_OS_SOLARIS) || defined(RT_OS_DARWIN)
1349 if (strncmp(RTPATH_APP_PRIVATE_ARCH, g_szSupLibHardenedAppBinPath, sizeof(RTPATH_APP_PRIVATE_ARCH)) != 0)
1350 supR3HardenedFatal("supR3HardenedExecDir: refusing to start binary from unknown location %s\n",
1351 g_szSupLibHardenedAppBinPath);
1352#endif
1353
1354 g_offSupLibHardenedExecName = suplibHardenedStrLen(g_szSupLibHardenedAppBinPath);
1355 while (RTPATH_IS_SEP(g_szSupLibHardenedExePath[g_offSupLibHardenedExecName]))
1356 g_offSupLibHardenedExecName++;
1357 g_cchSupLibHardenedExecName = suplibHardenedStrLen(&g_szSupLibHardenedExePath[g_offSupLibHardenedExecName]);
1358
1359 if (g_enmSupR3HardenedMainState < SUPR3HARDENEDMAINSTATE_HARDENED_MAIN_CALLED)
1360 supR3HardenedFatal("supR3HardenedExecDir: Called before SUPR3HardenedMain! (%d)\n", g_enmSupR3HardenedMainState);
1361 switch (g_fSupHardenedMain & SUPSECMAIN_FLAGS_LOC_MASK)
1362 {
1363 case SUPSECMAIN_FLAGS_LOC_APP_BIN:
1364 break;
1365 case SUPSECMAIN_FLAGS_LOC_TESTCASE:
1366 suplibHardenedPathStripFilename(g_szSupLibHardenedAppBinPath);
1367 break;
1368#ifdef RT_OS_DARWIN
1369 case SUPSECMAIN_FLAGS_LOC_OSX_HLP_APP:
1370 {
1371 /* We must ascend to the parent bundle's Contents directory then decend into its MacOS: */
1372 static const RTSTRTUPLE s_aComponentsToSkip[] =
1373 { { RT_STR_TUPLE("MacOS") }, { RT_STR_TUPLE("Contents") }, { NULL /*some.app*/, 0 }, { RT_STR_TUPLE("Resources") } };
1374 size_t cchPath = suplibHardenedStrLen(g_szSupLibHardenedAppBinPath);
1375 for (uintptr_t i = 0; i < RT_ELEMENTS(s_aComponentsToSkip); i++)
1376 {
1377 while (cchPath > 1 && g_szSupLibHardenedAppBinPath[cchPath - 1] == '/')
1378 cchPath--;
1379 size_t const cchMatch = s_aComponentsToSkip[i].cch;
1380 if (cchMatch > 0)
1381 {
1382 if ( cchPath >= cchMatch + sizeof("VirtualBox.app/Contents")
1383 && g_szSupLibHardenedAppBinPath[cchPath - cchMatch - 1] == '/'
1384 && suplibHardenedMemComp(&g_szSupLibHardenedAppBinPath[cchPath - cchMatch],
1385 s_aComponentsToSkip[i].psz, cchMatch) == 0)
1386 cchPath -= cchMatch;
1387 else
1388 supR3HardenedFatal("supR3HardenedExecDir: Bad helper app path (tail component #%u '%s'): %s\n",
1389 i, s_aComponentsToSkip[i].psz, g_szSupLibHardenedAppBinPath);
1390 }
1391 else if ( cchPath > g_cchSupLibHardenedExecName + sizeof("VirtualBox.app/Contents/Resources/.app")
1392 && suplibHardenedMemComp(&g_szSupLibHardenedAppBinPath[cchPath - 4], ".app", 4) == 0
1393 && suplibHardenedMemComp(&g_szSupLibHardenedAppBinPath[cchPath - 4 - g_cchSupLibHardenedExecName],
1394 &g_szSupLibHardenedExePath[g_offSupLibHardenedExecName],
1395 g_cchSupLibHardenedExecName) == 0)
1396 cchPath -= g_cchSupLibHardenedExecName + 4;
1397 else
1398 supR3HardenedFatal("supR3HardenedExecDir: Bad helper app path (tail component #%u '%s.app'): %s\n",
1399 i, &g_szSupLibHardenedExePath[g_offSupLibHardenedExecName], g_szSupLibHardenedAppBinPath);
1400 }
1401 suplibHardenedMemCopy(&g_szSupLibHardenedAppBinPath[cchPath], "MacOS", sizeof("MacOS"));
1402 break;
1403 }
1404#endif /* RT_OS_DARWIN */
1405 default:
1406 supR3HardenedFatal("supR3HardenedExecDir: Unknown program binary location: %#x\n", g_fSupHardenedMain);
1407 }
1408}
1409
1410
1411#ifdef RT_OS_LINUX
1412/**
1413 * Checks if we can read /proc/self/exe.
1414 *
1415 * This is used on linux to see if we have to call init
1416 * with program path or not.
1417 *
1418 * @returns true / false.
1419 */
1420static bool supR3HardenedMainIsProcSelfExeAccssible(void)
1421{
1422 char szPath[RTPATH_MAX];
1423 int cchLink = readlink("/proc/self/exe", szPath, sizeof(szPath));
1424 return cchLink != -1;
1425}
1426#endif /* RT_OS_LINUX */
1427
1428
1429
1430/**
1431 * @remarks not quite like RTPathExecDir actually...
1432 */
1433DECLHIDDEN(int) supR3HardenedPathAppBin(char *pszPath, size_t cchPath)
1434{
1435 /*
1436 * Lazy init (probably not required).
1437 */
1438 if (!g_szSupLibHardenedAppBinPath[0])
1439 supR3HardenedGetFullExePath();
1440
1441 /*
1442 * Calc the length and check if there is space before copying.
1443 */
1444 size_t cch = suplibHardenedStrLen(g_szSupLibHardenedAppBinPath) + 1;
1445 if (cch <= cchPath)
1446 {
1447 suplibHardenedMemCopy(pszPath, g_szSupLibHardenedAppBinPath, cch + 1);
1448 return VINF_SUCCESS;
1449 }
1450
1451 supR3HardenedFatal("supR3HardenedPathAppBin: Buffer too small (%u < %u)\n", cchPath, cch);
1452 /* not reached */
1453}
1454
1455
1456#ifdef RT_OS_WINDOWS
1457extern "C" uint32_t g_uNtVerCombined;
1458#endif
1459
1460DECLHIDDEN(void) supR3HardenedOpenLog(int *pcArgs, char **papszArgs)
1461{
1462 static const char s_szLogOption[] = "--sup-hardening-log=";
1463
1464 /*
1465 * Scan the argument vector.
1466 */
1467 int cArgs = *pcArgs;
1468 for (int iArg = 1; iArg < cArgs; iArg++)
1469 if (strncmp(papszArgs[iArg], s_szLogOption, sizeof(s_szLogOption) - 1) == 0)
1470 {
1471#ifdef RT_OS_WINDOWS
1472 const char *pszLogFile = &papszArgs[iArg][sizeof(s_szLogOption) - 1];
1473#endif
1474
1475 /*
1476 * Drop the argument from the vector (has trailing NULL entry).
1477 */
1478// memmove(&papszArgs[iArg], &papszArgs[iArg + 1], (cArgs - iArg) * sizeof(papszArgs[0]));
1479 *pcArgs -= 1;
1480 cArgs -= 1;
1481
1482 /*
1483 * Open the log file, unless we've already opened one.
1484 * First argument takes precedence
1485 */
1486#ifdef RT_OS_WINDOWS
1487 if (g_hStartupLog == NULL)
1488 {
1489 int rc = RTNtPathOpen(pszLogFile,
1490 GENERIC_WRITE | SYNCHRONIZE,
1491 FILE_ATTRIBUTE_NORMAL,
1492 FILE_SHARE_READ | FILE_SHARE_WRITE,
1493 FILE_OPEN_IF,
1494 FILE_NON_DIRECTORY_FILE | FILE_SYNCHRONOUS_IO_NONALERT,
1495 OBJ_CASE_INSENSITIVE,
1496 &g_hStartupLog,
1497 NULL);
1498 if (RT_SUCCESS(rc))
1499 {
1500// SUP_DPRINTF(("Log file opened: " VBOX_VERSION_STRING "r%u g_hStartupLog=%p g_uNtVerCombined=%#x\n",
1501// VBOX_SVN_REV, g_hStartupLog, g_uNtVerCombined));
1502
1503 /*
1504 * If the path contains a drive volume, save it so we can
1505 * use it to flush the volume containing the log file.
1506 */
1507 if (RT_C_IS_ALPHA(pszLogFile[0]) && pszLogFile[1] == ':')
1508 {
1509// RTUtf16CopyAscii(g_wszStartupLogVol, RT_ELEMENTS(g_wszStartupLogVol), "\\??\\");
1510 g_wszStartupLogVol[sizeof("\\??\\") - 1] = RT_C_TO_UPPER(pszLogFile[0]);
1511 g_wszStartupLogVol[sizeof("\\??\\") + 0] = ':';
1512 g_wszStartupLogVol[sizeof("\\??\\") + 1] = '\0';
1513 }
1514 }
1515 else
1516 g_hStartupLog = NULL;
1517 }
1518#else
1519 /* Just some mumbo jumbo to shut up the compiler. */
1520 g_hStartupLog -= 1;
1521 g_cbStartupLog += 1;
1522 //g_hStartupLog = open()
1523#endif
1524 }
1525}
1526
1527
1528DECLHIDDEN(void) supR3HardenedLogV(const char *pszFormat, va_list va)
1529{
1530#ifdef RT_OS_WINDOWS
1531 if ( g_hStartupLog != NULL
1532 && g_cbStartupLog < 16*_1M)
1533 {
1534 char szBuf[5120];
1535 PCLIENT_ID pSelfId = &((PTEB)NtCurrentTeb())->ClientId;
1536 size_t cchPrefix = RTStrPrintf(szBuf, sizeof(szBuf), "%x.%x: ", pSelfId->UniqueProcess, pSelfId->UniqueThread);
1537 size_t cch = RTStrPrintfV(&szBuf[cchPrefix], sizeof(szBuf) - cchPrefix, pszFormat, va) + cchPrefix;
1538
1539 if ((size_t)cch >= sizeof(szBuf))
1540 cch = sizeof(szBuf) - 1;
1541
1542 if (!cch || szBuf[cch - 1] != '\n')
1543 szBuf[cch++] = '\n';
1544
1545 ASMAtomicAddU32(&g_cbStartupLog, (uint32_t)cch);
1546
1547 IO_STATUS_BLOCK Ios = RTNT_IO_STATUS_BLOCK_INITIALIZER;
1548 LARGE_INTEGER Offset;
1549 Offset.QuadPart = -1; /* Write to end of file. */
1550 NtWriteFile(g_hStartupLog, NULL /*Event*/, NULL /*ApcRoutine*/, NULL /*ApcContext*/,
1551 &Ios, szBuf, (ULONG)cch, &Offset, NULL /*Key*/);
1552 }
1553#else
1554 RT_NOREF(pszFormat, va);
1555 /* later */
1556#endif
1557}
1558
1559
1560DECLHIDDEN(void) supR3HardenedLog(const char *pszFormat, ...)
1561{
1562 va_list va;
1563 va_start(va, pszFormat);
1564 supR3HardenedLogV(pszFormat, va);
1565 va_end(va);
1566}
1567
1568
1569DECLHIDDEN(void) supR3HardenedLogFlush(void)
1570{
1571#ifdef RT_OS_WINDOWS
1572 if ( g_hStartupLog != NULL
1573 && g_cbStartupLog < 16*_1M)
1574 {
1575 IO_STATUS_BLOCK Ios = RTNT_IO_STATUS_BLOCK_INITIALIZER;
1576 NTSTATUS rcNt = NtFlushBuffersFile(g_hStartupLog, &Ios);
1577
1578 /*
1579 * Try flush the volume containing the log file too.
1580 */
1581 if (g_wszStartupLogVol[0])
1582 {
1583 HANDLE hLogVol = RTNT_INVALID_HANDLE_VALUE;
1584 UNICODE_STRING NtName;
1585 NtName.Buffer = g_wszStartupLogVol;
1586 NtName.Length = (USHORT)(RTUtf16Len(g_wszStartupLogVol) * sizeof(RTUTF16));
1587 NtName.MaximumLength = NtName.Length + 1;
1588 OBJECT_ATTRIBUTES ObjAttr;
1589 InitializeObjectAttributes(&ObjAttr, &NtName, OBJ_CASE_INSENSITIVE, NULL /*hRootDir*/, NULL /*pSecDesc*/);
1590 RTNT_IO_STATUS_BLOCK_REINIT(&Ios);
1591 rcNt = NtCreateFile(&hLogVol,
1592 GENERIC_WRITE | GENERIC_READ | SYNCHRONIZE | FILE_READ_ATTRIBUTES,
1593 &ObjAttr,
1594 &Ios,
1595 NULL /* Allocation Size*/,
1596 0 /*FileAttributes*/,
1597 FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE,
1598 FILE_OPEN,
1599 FILE_NON_DIRECTORY_FILE | FILE_SYNCHRONOUS_IO_NONALERT,
1600 NULL /*EaBuffer*/,
1601 0 /*EaLength*/);
1602 if (NT_SUCCESS(rcNt))
1603 rcNt = Ios.Status;
1604 if (NT_SUCCESS(rcNt))
1605 {
1606 RTNT_IO_STATUS_BLOCK_REINIT(&Ios);
1607 rcNt = NtFlushBuffersFile(hLogVol, &Ios);
1608 NtClose(hLogVol);
1609 }
1610 else
1611 {
1612 /* This may have sideeffects similar to what we want... */
1613 hLogVol = RTNT_INVALID_HANDLE_VALUE;
1614 RTNT_IO_STATUS_BLOCK_REINIT(&Ios);
1615 rcNt = NtCreateFile(&hLogVol,
1616 GENERIC_READ | SYNCHRONIZE | FILE_READ_ATTRIBUTES,
1617 &ObjAttr,
1618 &Ios,
1619 NULL /* Allocation Size*/,
1620 0 /*FileAttributes*/,
1621 FILE_SHARE_READ | FILE_SHARE_WRITE | FILE_SHARE_DELETE,
1622 FILE_OPEN,
1623 FILE_NON_DIRECTORY_FILE | FILE_SYNCHRONOUS_IO_NONALERT,
1624 NULL /*EaBuffer*/,
1625 0 /*EaLength*/);
1626 if (NT_SUCCESS(rcNt) && NT_SUCCESS(Ios.Status))
1627 NtClose(hLogVol);
1628 }
1629 }
1630 }
1631#else
1632 /* later */
1633#endif
1634}
1635
1636
1637/**
1638 * Prints the message prefix.
1639 */
1640static void suplibHardenedPrintPrefix(void)
1641{
1642 if (g_pszSupLibHardenedProgName)
1643 suplibHardenedPrintStr(g_pszSupLibHardenedProgName);
1644 suplibHardenedPrintStr(": ");
1645}
1646
1647
1648DECL_NO_RETURN(DECLHIDDEN(void)) supR3HardenedFatalMsgV(const char *pszWhere, SUPINITOP enmWhat, int rc,
1649 const char *pszMsgFmt, va_list va)
1650{
1651 /*
1652 * First to the log.
1653 */
1654 supR3HardenedLog("Error %d in %s! (enmWhat=%d)\n", rc, pszWhere, enmWhat);
1655 va_list vaCopy;
1656 va_copy(vaCopy, va);
1657 supR3HardenedLogV(pszMsgFmt, vaCopy);
1658 va_end(vaCopy);
1659
1660#ifdef RT_OS_WINDOWS
1661 /*
1662 * The release log.
1663 */
1664 if (g_pfnRTLogRelPrintf)
1665 {
1666 va_copy(vaCopy, va);
1667 g_pfnRTLogRelPrintf("supR3HardenedFatalMsgV: %s enmWhat=%d rc=%Rrc (%#x)\n", pszWhere, enmWhat, rc);
1668 g_pfnRTLogRelPrintf("supR3HardenedFatalMsgV: %N\n", pszMsgFmt, &vaCopy);
1669 va_end(vaCopy);
1670 }
1671#endif
1672
1673 /*
1674 * Then to the console.
1675 */
1676 suplibHardenedPrintPrefix();
1677 suplibHardenedPrintF("Error %d in %s!\n", rc, pszWhere);
1678
1679 suplibHardenedPrintPrefix();
1680 va_copy(vaCopy, va);
1681 suplibHardenedPrintFV(pszMsgFmt, vaCopy);
1682 va_end(vaCopy);
1683 suplibHardenedPrintChr('\n');
1684
1685 switch (enmWhat)
1686 {
1687 case kSupInitOp_Driver:
1688 suplibHardenedPrintChr('\n');
1689 suplibHardenedPrintPrefix();
1690 suplibHardenedPrintStr("Tip! Make sure the kernel module is loaded. It may also help to reinstall VirtualBox.\n");
1691 break;
1692
1693 case kSupInitOp_Misc:
1694 case kSupInitOp_IPRT:
1695 case kSupInitOp_Integrity:
1696 case kSupInitOp_RootCheck:
1697 suplibHardenedPrintChr('\n');
1698 suplibHardenedPrintPrefix();
1699 suplibHardenedPrintStr("Tip! It may help to reinstall VirtualBox.\n");
1700 break;
1701
1702 default:
1703 /* no hints here */
1704 break;
1705 }
1706
1707 /*
1708 * Finally, TrustedError if appropriate.
1709 */
1710 if (g_enmSupR3HardenedMainState >= SUPR3HARDENEDMAINSTATE_WIN_IMPORTS_RESOLVED)
1711 {
1712#ifdef SUP_HARDENED_SUID
1713 /* Drop any root privileges we might be holding, this won't return
1714 if it fails but end up calling supR3HardenedFatal[V]. */
1715 supR3HardenedMainDropPrivileges();
1716#endif
1717 /* Close the driver, if we succeeded opening it. Both because
1718 TrustedError may be untrustworthy and because the driver deosn't
1719 like us if we fork(). @bugref{8838} */
1720 suplibOsTerm(&g_SupPreInitData.Data);
1721
1722 /*
1723 * Now try resolve and call the TrustedError entry point if we can find it.
1724 * Note! Loader involved, so we must guard against loader hooks calling us.
1725 */
1726 static volatile bool s_fRecursive = false;
1727 if (!s_fRecursive)
1728 {
1729 s_fRecursive = true;
1730
1731 PFNSUPTRUSTEDERROR pfnTrustedError = supR3HardenedMainGetTrustedError(g_pszSupLibHardenedProgName);
1732 if (pfnTrustedError)
1733 {
1734 /* We'll fork before we make the call because that way the session management
1735 in main will see us exiting immediately (if it's involved with us) and possibly
1736 get an error back to the API / user. */
1737#if !defined(RT_OS_WINDOWS) && !defined(RT_OS_OS2) && /* @bugref{10170}: */ !defined(RT_OS_DARWIN)
1738 int pid = fork();
1739 if (pid <= 0)
1740#endif
1741 {
1742 pfnTrustedError(pszWhere, enmWhat, rc, pszMsgFmt, va);
1743 }
1744 }
1745
1746 s_fRecursive = false;
1747 }
1748 }
1749#if defined(RT_OS_WINDOWS)
1750 /*
1751 * Report the error to the parent if this happens during early VM init.
1752 */
1753 else if ( g_enmSupR3HardenedMainState < SUPR3HARDENEDMAINSTATE_WIN_IMPORTS_RESOLVED
1754 && g_enmSupR3HardenedMainState != SUPR3HARDENEDMAINSTATE_NOT_YET_CALLED)
1755 supR3HardenedWinReportErrorToParent(pszWhere, enmWhat, rc, pszMsgFmt, va);
1756#endif
1757
1758 /*
1759 * Quit
1760 */
1761 suplibHardenedExit(RTEXITCODE_FAILURE);
1762}
1763
1764
1765DECL_NO_RETURN(DECLHIDDEN(void)) supR3HardenedFatalMsg(const char *pszWhere, SUPINITOP enmWhat, int rc,
1766 const char *pszMsgFmt, ...)
1767{
1768 va_list va;
1769 va_start(va, pszMsgFmt);
1770 supR3HardenedFatalMsgV(pszWhere, enmWhat, rc, pszMsgFmt, va);
1771 /* not reached */
1772}
1773
1774
1775DECL_NO_RETURN(DECLHIDDEN(void)) supR3HardenedFatalV(const char *pszFormat, va_list va)
1776{
1777 supR3HardenedLog("Fatal error:\n");
1778 va_list vaCopy;
1779 va_copy(vaCopy, va);
1780 supR3HardenedLogV(pszFormat, vaCopy);
1781 va_end(vaCopy);
1782
1783#if defined(RT_OS_WINDOWS)
1784 /*
1785 * Report the error to the parent if this happens during early VM init.
1786 */
1787 if ( g_enmSupR3HardenedMainState < SUPR3HARDENEDMAINSTATE_WIN_IMPORTS_RESOLVED
1788 && g_enmSupR3HardenedMainState != SUPR3HARDENEDMAINSTATE_NOT_YET_CALLED)
1789 supR3HardenedWinReportErrorToParent(NULL, kSupInitOp_Invalid, VERR_INTERNAL_ERROR, pszFormat, va);
1790 else
1791#endif
1792 {
1793#ifdef RT_OS_WINDOWS
1794 if (g_pfnRTLogRelPrintf)
1795 {
1796 va_copy(vaCopy, va);
1797 g_pfnRTLogRelPrintf("supR3HardenedFatalV: %N", pszFormat, &vaCopy);
1798 va_end(vaCopy);
1799 }
1800#endif
1801
1802 suplibHardenedPrintPrefix();
1803 suplibHardenedPrintFV(pszFormat, va);
1804 }
1805
1806 suplibHardenedExit(RTEXITCODE_FAILURE);
1807}
1808
1809
1810DECL_NO_RETURN(DECLHIDDEN(void)) supR3HardenedFatal(const char *pszFormat, ...)
1811{
1812 va_list va;
1813 va_start(va, pszFormat);
1814 supR3HardenedFatalV(pszFormat, va);
1815 /* not reached */
1816}
1817
1818
1819DECLHIDDEN(int) supR3HardenedErrorV(int rc, bool fFatal, const char *pszFormat, va_list va)
1820{
1821 if (fFatal)
1822 supR3HardenedFatalV(pszFormat, va);
1823
1824 supR3HardenedLog("Error (rc=%d):\n", rc);
1825 va_list vaCopy;
1826 va_copy(vaCopy, va);
1827 supR3HardenedLogV(pszFormat, vaCopy);
1828 va_end(vaCopy);
1829
1830#ifdef RT_OS_WINDOWS
1831 if (g_pfnRTLogRelPrintf)
1832 {
1833 va_copy(vaCopy, va);
1834 g_pfnRTLogRelPrintf("supR3HardenedErrorV: %N", pszFormat, &vaCopy);
1835 va_end(vaCopy);
1836 }
1837#endif
1838
1839 suplibHardenedPrintPrefix();
1840 suplibHardenedPrintFV(pszFormat, va);
1841
1842 return rc;
1843}
1844
1845
1846DECLHIDDEN(int) supR3HardenedError(int rc, bool fFatal, const char *pszFormat, ...)
1847{
1848 va_list va;
1849 va_start(va, pszFormat);
1850 supR3HardenedErrorV(rc, fFatal, pszFormat, va);
1851 va_end(va);
1852 return rc;
1853}
1854
1855
1856
1857/**
1858 * Attempts to open /dev/vboxdrv (or equvivalent).
1859 *
1860 * @remarks This function will not return on failure.
1861 */
1862DECLHIDDEN(void) supR3HardenedMainOpenDevice(void)
1863{
1864 RTERRINFOSTATIC ErrInfo;
1865 SUPINITOP enmWhat = kSupInitOp_Driver;
1866 uint32_t fFlags = SUPR3INIT_F_UNRESTRICTED;
1867 if (g_fSupHardenedMain & SUPSECMAIN_FLAGS_DRIVERLESS)
1868 fFlags |= SUPR3INIT_F_DRIVERLESS;
1869 if (g_fSupHardenedMain & SUPSECMAIN_FLAGS_DRIVERLESS_IEM_ALLOWED)
1870 fFlags |= SUPR3INIT_F_DRIVERLESS_IEM_ALLOWED;
1871#ifdef VBOX_WITH_DRIVERLESS_NEM_FALLBACK
1872 if (g_fSupHardenedMain & SUPSECMAIN_FLAGS_DRIVERLESS_NEM_FALLBACK)
1873 fFlags |= SUPR3INIT_F_DRIVERLESS_NEM_FALLBACK;
1874#endif
1875 int rc = suplibOsInit(&g_SupPreInitData.Data, false /*fPreInit*/, fFlags, &enmWhat, RTErrInfoInitStatic(&ErrInfo));
1876 if (RT_SUCCESS(rc))
1877 return;
1878
1879 if (RTErrInfoIsSet(&ErrInfo.Core))
1880 supR3HardenedFatalMsg("suplibOsInit", enmWhat, rc, "%s", ErrInfo.szMsg);
1881
1882 switch (rc)
1883 {
1884 /** @todo better messages! */
1885 case VERR_VM_DRIVER_NOT_INSTALLED:
1886 supR3HardenedFatalMsg("suplibOsInit", kSupInitOp_Driver, rc, "Kernel driver not installed");
1887 case VERR_VM_DRIVER_NOT_ACCESSIBLE:
1888 supR3HardenedFatalMsg("suplibOsInit", kSupInitOp_Driver, rc, "Kernel driver not accessible");
1889 case VERR_VM_DRIVER_LOAD_ERROR:
1890 supR3HardenedFatalMsg("suplibOsInit", kSupInitOp_Driver, rc, "VERR_VM_DRIVER_LOAD_ERROR");
1891 case VERR_VM_DRIVER_OPEN_ERROR:
1892 supR3HardenedFatalMsg("suplibOsInit", kSupInitOp_Driver, rc, "VERR_VM_DRIVER_OPEN_ERROR");
1893 case VERR_VM_DRIVER_VERSION_MISMATCH:
1894 supR3HardenedFatalMsg("suplibOsInit", kSupInitOp_Driver, rc, "Kernel driver version mismatch");
1895 case VERR_ACCESS_DENIED:
1896 supR3HardenedFatalMsg("suplibOsInit", kSupInitOp_Driver, rc, "VERR_ACCESS_DENIED");
1897 case VERR_NO_MEMORY:
1898 supR3HardenedFatalMsg("suplibOsInit", kSupInitOp_Driver, rc, "Kernel memory allocation/mapping failed");
1899 case VERR_SUPDRV_HARDENING_EVIL_HANDLE:
1900 supR3HardenedFatalMsg("suplibOsInit", kSupInitOp_Integrity, rc, "VERR_SUPDRV_HARDENING_EVIL_HANDLE");
1901 case VERR_SUPLIB_NT_PROCESS_UNTRUSTED_0:
1902 supR3HardenedFatalMsg("suplibOsInit", kSupInitOp_Integrity, rc, "VERR_SUPLIB_NT_PROCESS_UNTRUSTED_0");
1903 case VERR_SUPLIB_NT_PROCESS_UNTRUSTED_1:
1904 supR3HardenedFatalMsg("suplibOsInit", kSupInitOp_Integrity, rc, "VERR_SUPLIB_NT_PROCESS_UNTRUSTED_1");
1905 case VERR_SUPLIB_NT_PROCESS_UNTRUSTED_2:
1906 supR3HardenedFatalMsg("suplibOsInit", kSupInitOp_Integrity, rc, "VERR_SUPLIB_NT_PROCESS_UNTRUSTED_2");
1907 default:
1908 supR3HardenedFatalMsg("suplibOsInit", kSupInitOp_Driver, rc, "Unknown rc=%d (%Rrc)", rc, rc);
1909 }
1910}
1911
1912
1913#ifdef SUP_HARDENED_SUID
1914
1915/**
1916 * Grabs extra non-root capabilities / privileges that we might require.
1917 *
1918 * This is currently only used for being able to do ICMP from the NAT engine
1919 * and for being able to raise thread scheduling priority
1920 *
1921 * @note We still have root privileges at the time of this call.
1922 */
1923static void supR3HardenedMainGrabCapabilites(void)
1924{
1925# if defined(RT_OS_LINUX)
1926 /*
1927 * We are about to drop all our privileges. Remove all capabilities but
1928 * keep the cap_net_raw capability for ICMP sockets for the NAT stack,
1929 * also keep cap_sys_nice capability for priority tweaking.
1930 */
1931 if (g_uCaps != 0)
1932 {
1933# ifdef USE_LIB_PCAP
1934 /* XXX cap_net_bind_service */
1935 if (!cap_set_proc(cap_from_text("all-eip cap_net_raw+ep cap_sys_nice+ep")))
1936 prctl(PR_SET_KEEPCAPS, 1 /*keep=*/, 0, 0, 0);
1937 prctl(PR_SET_DUMPABLE, 1 /*dump*/, 0, 0, 0);
1938# else
1939 cap_user_header_t hdr = (cap_user_header_t)alloca(sizeof(*hdr));
1940 cap_user_data_t cap = (cap_user_data_t)alloca(2 /*_LINUX_CAPABILITY_U32S_3*/ * sizeof(*cap));
1941 memset(hdr, 0, sizeof(*hdr));
1942 capget(hdr, NULL);
1943 if ( hdr->version != 0x19980330 /* _LINUX_CAPABILITY_VERSION_1, _LINUX_CAPABILITY_U32S_1 = 1 */
1944 && hdr->version != 0x20071026 /* _LINUX_CAPABILITY_VERSION_2, _LINUX_CAPABILITY_U32S_2 = 2 */
1945 && hdr->version != 0x20080522 /* _LINUX_CAPABILITY_VERSION_3, _LINUX_CAPABILITY_U32S_3 = 2 */)
1946 hdr->version = _LINUX_CAPABILITY_VERSION;
1947 g_uCapsVersion = hdr->version;
1948 memset(cap, 0, 2 /* _LINUX_CAPABILITY_U32S_3 */ * sizeof(*cap));
1949 cap->effective = g_uCaps;
1950 cap->permitted = g_uCaps;
1951 if (!capset(hdr, cap))
1952 prctl(PR_SET_KEEPCAPS, 1 /*keep*/, 0, 0, 0);
1953 prctl(PR_SET_DUMPABLE, 1 /*dump*/, 0, 0, 0);
1954# endif /* !USE_LIB_PCAP */
1955 }
1956
1957# elif defined(RT_OS_SOLARIS)
1958 /*
1959 * Add net_icmpaccess privilege to effective privileges and limit
1960 * permitted privileges before completely dropping root privileges.
1961 * This requires dropping root privileges temporarily to get the normal
1962 * user's privileges.
1963 */
1964 seteuid(g_uid);
1965 priv_set_t *pPrivEffective = priv_allocset();
1966 priv_set_t *pPrivNew = priv_allocset();
1967 if (pPrivEffective && pPrivNew)
1968 {
1969 int rc = getppriv(PRIV_EFFECTIVE, pPrivEffective);
1970 seteuid(0);
1971 if (!rc)
1972 {
1973 priv_copyset(pPrivEffective, pPrivNew);
1974 rc = priv_addset(pPrivNew, PRIV_NET_ICMPACCESS);
1975 if (!rc)
1976 {
1977 /* Order is important, as one can't set a privilege which is
1978 * not in the permitted privilege set. */
1979 rc = setppriv(PRIV_SET, PRIV_EFFECTIVE, pPrivNew);
1980 if (rc)
1981 supR3HardenedError(rc, false, "SUPR3HardenedMain: failed to set effective privilege set.\n");
1982 rc = setppriv(PRIV_SET, PRIV_PERMITTED, pPrivNew);
1983 if (rc)
1984 supR3HardenedError(rc, false, "SUPR3HardenedMain: failed to set permitted privilege set.\n");
1985 }
1986 else
1987 supR3HardenedError(rc, false, "SUPR3HardenedMain: failed to add NET_ICMPACCESS privilege.\n");
1988 }
1989 }
1990 else
1991 {
1992 /* for memory allocation failures just continue */
1993 seteuid(0);
1994 }
1995
1996 if (pPrivEffective)
1997 priv_freeset(pPrivEffective);
1998 if (pPrivNew)
1999 priv_freeset(pPrivNew);
2000# endif
2001}
2002
2003/*
2004 * Look at the environment for some special options.
2005 */
2006static void supR3GrabOptions(void)
2007{
2008# ifdef RT_OS_LINUX
2009 g_uCaps = 0;
2010
2011 /*
2012 * Do _not_ perform any capability-related system calls for root processes
2013 * (leaving g_uCaps at 0).
2014 * (Hint: getuid gets the real user id, not the effective.)
2015 */
2016 if (getuid() != 0)
2017 {
2018 /*
2019 * CAP_NET_RAW.
2020 * Default: enabled.
2021 * Can be disabled with 'export VBOX_HARD_CAP_NET_RAW=0'.
2022 */
2023 const char *pszOpt = getenv("VBOX_HARD_CAP_NET_RAW");
2024 if ( !pszOpt
2025 || memcmp(pszOpt, "0", sizeof("0")) != 0)
2026 g_uCaps = CAP_TO_MASK(CAP_NET_RAW);
2027
2028 /*
2029 * CAP_NET_BIND_SERVICE.
2030 * Default: disabled.
2031 * Can be enabled with 'export VBOX_HARD_CAP_NET_BIND_SERVICE=1'.
2032 */
2033 pszOpt = getenv("VBOX_HARD_CAP_NET_BIND_SERVICE");
2034 if ( pszOpt
2035 && memcmp(pszOpt, "0", sizeof("0")) != 0)
2036 g_uCaps |= CAP_TO_MASK(CAP_NET_BIND_SERVICE);
2037
2038 /*
2039 * CAP_SYS_NICE.
2040 * Default: enabled.
2041 * Can be disabled with 'export VBOX_HARD_CAP_SYS_NICE=0'.
2042 */
2043 pszOpt = getenv("VBOX_HARD_CAP_SYS_NICE");
2044 if ( !pszOpt
2045 || memcmp(pszOpt, "0", sizeof("0")) != 0)
2046 g_uCaps |= CAP_TO_MASK(CAP_SYS_NICE);
2047 }
2048# endif
2049}
2050
2051/**
2052 * Drop any root privileges we might be holding.
2053 */
2054static void supR3HardenedMainDropPrivileges(void)
2055{
2056 /*
2057 * Try use setre[ug]id since this will clear the save uid/gid and thus
2058 * leave fewer traces behind that libs like GTK+ may pick up.
2059 */
2060 uid_t euid, ruid, suid;
2061 gid_t egid, rgid, sgid;
2062# if defined(RT_OS_DARWIN)
2063 /* The really great thing here is that setreuid isn't available on
2064 OS X 10.4, libc emulates it. While 10.4 have a slightly different and
2065 non-standard setuid implementation compared to 10.5, the following
2066 works the same way with both version since we're super user (10.5 req).
2067 The following will set all three variants of the group and user IDs. */
2068 setgid(g_gid);
2069 setuid(g_uid);
2070 euid = geteuid();
2071 ruid = suid = getuid();
2072 egid = getegid();
2073 rgid = sgid = getgid();
2074
2075# elif defined(RT_OS_SOLARIS)
2076 /* Solaris doesn't have setresuid, but the setreuid interface is BSD
2077 compatible and will set the saved uid to euid when we pass it a ruid
2078 that isn't -1 (which we do). */
2079 setregid(g_gid, g_gid);
2080 setreuid(g_uid, g_uid);
2081 euid = geteuid();
2082 ruid = suid = getuid();
2083 egid = getegid();
2084 rgid = sgid = getgid();
2085
2086# else
2087 /* This is the preferred one, full control no questions about semantics.
2088 PORTME: If this isn't work, try join one of two other gangs above. */
2089 int res = setresgid(g_gid, g_gid, g_gid);
2090 NOREF(res);
2091 res = setresuid(g_uid, g_uid, g_uid);
2092 NOREF(res);
2093 if (getresuid(&ruid, &euid, &suid) != 0)
2094 {
2095 euid = geteuid();
2096 ruid = suid = getuid();
2097 }
2098 if (getresgid(&rgid, &egid, &sgid) != 0)
2099 {
2100 egid = getegid();
2101 rgid = sgid = getgid();
2102 }
2103# endif
2104
2105
2106 /* Check that it worked out all right. */
2107 if ( euid != g_uid
2108 || ruid != g_uid
2109 || suid != g_uid
2110 || egid != g_gid
2111 || rgid != g_gid
2112 || sgid != g_gid)
2113 supR3HardenedFatal("SUPR3HardenedMain: failed to drop root privileges!"
2114 " (euid=%d ruid=%d suid=%d egid=%d rgid=%d sgid=%d; wanted uid=%d and gid=%d)\n",
2115 euid, ruid, suid, egid, rgid, sgid, g_uid, g_gid);
2116
2117# if RT_OS_LINUX
2118 /*
2119 * Re-enable the cap_net_raw and cap_sys_nice capabilities which were disabled during setresuid.
2120 */
2121 if (g_uCaps != 0)
2122 {
2123# ifdef USE_LIB_PCAP
2124 /** @todo Warn if that does not work? */
2125 /* XXX cap_net_bind_service */
2126 cap_set_proc(cap_from_text("cap_net_raw+ep cap_sys_nice+ep"));
2127# else
2128 cap_user_header_t hdr = (cap_user_header_t)alloca(sizeof(*hdr));
2129 cap_user_data_t cap = (cap_user_data_t)alloca(2 /* _LINUX_CAPABILITY_U32S_3 */ * sizeof(*cap));
2130 memset(hdr, 0, sizeof(*hdr));
2131 hdr->version = g_uCapsVersion;
2132 memset(cap, 0, 2 /* _LINUX_CAPABILITY_U32S_3 */ * sizeof(*cap));
2133 cap->effective = g_uCaps;
2134 cap->permitted = g_uCaps;
2135 /** @todo Warn if that does not work? */
2136 capset(hdr, cap);
2137# endif /* !USE_LIB_PCAP */
2138 }
2139# endif
2140}
2141
2142#endif /* SUP_HARDENED_SUID */
2143
2144/**
2145 * Purge the process environment from any environment vairable which can lead
2146 * to loading untrusted binaries compromising the process address space.
2147 *
2148 * @param envp The initial environment vector. (Can be NULL.)
2149 */
2150static void supR3HardenedMainPurgeEnvironment(char **envp)
2151{
2152 for (unsigned i = 0; i < RT_ELEMENTS(g_aSupEnvPurgeDescs); i++)
2153 {
2154 /*
2155 * Update the initial environment vector, just in case someone actually cares about it.
2156 */
2157 if (envp)
2158 {
2159 const char * const pszEnv = g_aSupEnvPurgeDescs[i].pszEnv;
2160 size_t const cchEnv = g_aSupEnvPurgeDescs[i].cchEnv;
2161 unsigned iSrc = 0;
2162 unsigned iDst = 0;
2163 char *pszTmp;
2164
2165 while ((pszTmp = envp[iSrc]) != NULL)
2166 {
2167 if ( memcmp(pszTmp, pszEnv, cchEnv) != 0
2168 || (pszTmp[cchEnv] != '=' && pszTmp[cchEnv] != '\0'))
2169 {
2170 if (iDst != iSrc)
2171 envp[iDst] = pszTmp;
2172 iDst++;
2173 }
2174 else
2175 SUP_DPRINTF(("supR3HardenedMainPurgeEnvironment: dropping envp[%d]=%s\n", iSrc, pszTmp));
2176 iSrc++;
2177 }
2178
2179 if (iDst != iSrc)
2180 while (iDst <= iSrc)
2181 envp[iDst++] = NULL;
2182 }
2183
2184 /*
2185 * Remove from the process environment if present.
2186 */
2187#ifndef RT_OS_WINDOWS
2188 const char *pszTmp = getenv(g_aSupEnvPurgeDescs[i].pszEnv);
2189 if (pszTmp != NULL)
2190 {
2191 if (unsetenv((char *)g_aSupEnvPurgeDescs[i].pszEnv) == 0)
2192 SUP_DPRINTF(("supR3HardenedMainPurgeEnvironment: dropped %s\n", pszTmp));
2193 else
2194 if (g_aSupEnvPurgeDescs[i].fPurgeErrFatal)
2195 supR3HardenedFatal("SUPR3HardenedMain: failed to purge %s environment variable! (errno=%d %s)\n",
2196 g_aSupEnvPurgeDescs[i].pszEnv, errno, strerror(errno));
2197 else
2198 SUP_DPRINTF(("supR3HardenedMainPurgeEnvironment: dropping %s failed! errno=%d\n", pszTmp, errno));
2199 }
2200#else
2201 /** @todo Call NT API to do the same. */
2202#endif
2203 }
2204}
2205
2206
2207/**
2208 * Returns the argument purge descriptor of the given argument if available.
2209 *
2210 * @retval 0 if it should not be purged.
2211 * @retval 1 if it only the current argument should be purged.
2212 * @retval 2 if the argument and the following (if present) should be purged.
2213 * @param pszArg The argument to look for.
2214 */
2215static unsigned supR3HardenedMainShouldPurgeArg(const char *pszArg)
2216{
2217 for (unsigned i = 0; i < RT_ELEMENTS(g_aSupArgPurgeDescs); i++)
2218 {
2219 size_t const cchPurge = g_aSupArgPurgeDescs[i].cchArg;
2220 if (!memcmp(pszArg, g_aSupArgPurgeDescs[i].pszArg, cchPurge))
2221 {
2222 if (pszArg[cchPurge] == '\0')
2223 return 1 + g_aSupArgPurgeDescs[i].fTakesValue;
2224 if ( g_aSupArgPurgeDescs[i].fTakesValue
2225 && (pszArg[cchPurge] == ':' || pszArg[cchPurge] == '='))
2226 return 1;
2227 }
2228 }
2229
2230 return 0;
2231}
2232
2233
2234/**
2235 * Purges any command line arguments considered harmful.
2236 *
2237 * @param cArgsOrig The original number of arguments.
2238 * @param papszArgsOrig The original argument vector.
2239 * @param pcArgsNew Where to store the new number of arguments on success.
2240 * @param ppapszArgsNew Where to store the pointer to the purged argument vector.
2241 */
2242static void supR3HardenedMainPurgeArgs(int cArgsOrig, char **papszArgsOrig, int *pcArgsNew, char ***ppapszArgsNew)
2243{
2244 int iDst = 0;
2245#ifdef RT_OS_WINDOWS
2246 char **papszArgsNew = papszArgsOrig; /* We allocated this, no need to allocate again. */
2247#else
2248 char **papszArgsNew = (char **)malloc((cArgsOrig + 1) * sizeof(char *));
2249#endif
2250 if (papszArgsNew)
2251 {
2252 for (int iSrc = 0; iSrc < cArgsOrig; iSrc++)
2253 {
2254 unsigned cPurgedArgs = supR3HardenedMainShouldPurgeArg(papszArgsOrig[iSrc]);
2255 if (!cPurgedArgs)
2256 papszArgsNew[iDst++] = papszArgsOrig[iSrc];
2257 else
2258 iSrc += cPurgedArgs - 1;
2259 }
2260
2261 papszArgsNew[iDst] = NULL; /* The array is NULL terminated, just like envp. */
2262 }
2263 else
2264 supR3HardenedFatal("SUPR3HardenedMain: failed to allocate memory for purged command line!\n");
2265 *pcArgsNew = iDst;
2266 *ppapszArgsNew = papszArgsNew;
2267
2268#ifdef RT_OS_WINDOWS
2269 /** @todo Update command line pointers in PEB, wont really work without it. */
2270#endif
2271}
2272
2273
2274/**
2275 * Loads the VBoxRT DLL/SO/DYLIB, hands it the open driver,
2276 * and calls RTR3InitEx.
2277 *
2278 * @param fFlags The SUPR3HardenedMain fFlags argument, passed to supR3PreInit.
2279 *
2280 * @remarks VBoxRT contains both IPRT and SUPR3.
2281 * @remarks This function will not return on failure.
2282 */
2283static void supR3HardenedMainInitRuntime(uint32_t fFlags)
2284{
2285 /*
2286 * Construct the name.
2287 */
2288 char szPath[RTPATH_MAX];
2289 supR3HardenedPathAppSharedLibs(szPath, sizeof(szPath) - sizeof("/VBoxRT" SUPLIB_DLL_SUFF));
2290 suplibHardenedStrCat(szPath, "/VBoxRT" SUPLIB_DLL_SUFF);
2291
2292 /*
2293 * Open it and resolve the symbols.
2294 */
2295#if defined(RT_OS_WINDOWS)
2296 HMODULE hMod = (HMODULE)supR3HardenedWinLoadLibrary(szPath, false /*fSystem32Only*/, g_fSupHardenedMain);
2297 if (!hMod)
2298 supR3HardenedFatalMsg("supR3HardenedMainInitRuntime", kSupInitOp_IPRT, VERR_MODULE_NOT_FOUND,
2299 "LoadLibrary \"%s\" failed (rc=%d)",
2300 szPath, RtlGetLastWin32Error());
2301 PFNRTR3INITEX pfnRTInitEx = (PFNRTR3INITEX)GetProcAddress(hMod, SUP_HARDENED_SYM("RTR3InitEx"));
2302 if (!pfnRTInitEx)
2303 supR3HardenedFatalMsg("supR3HardenedMainInitRuntime", kSupInitOp_IPRT, VERR_SYMBOL_NOT_FOUND,
2304 "Entrypoint \"RTR3InitEx\" not found in \"%s\" (rc=%d)",
2305 szPath, RtlGetLastWin32Error());
2306
2307 PFNSUPR3PREINIT pfnSUPPreInit = (PFNSUPR3PREINIT)GetProcAddress(hMod, SUP_HARDENED_SYM("supR3PreInit"));
2308 if (!pfnSUPPreInit)
2309 supR3HardenedFatalMsg("supR3HardenedMainInitRuntime", kSupInitOp_IPRT, VERR_SYMBOL_NOT_FOUND,
2310 "Entrypoint \"supR3PreInit\" not found in \"%s\" (rc=%d)",
2311 szPath, RtlGetLastWin32Error());
2312
2313 g_pfnRTLogRelPrintf = (PFNRTLOGRELPRINTF)GetProcAddress(hMod, SUP_HARDENED_SYM("RTLogRelPrintf"));
2314 Assert(g_pfnRTLogRelPrintf); /* Not fatal in non-strict builds. */
2315
2316#else
2317 /* the dlopen crowd */
2318 void *pvMod = dlopen(szPath, RTLD_NOW | RTLD_GLOBAL);
2319 if (!pvMod)
2320 supR3HardenedFatalMsg("supR3HardenedMainInitRuntime", kSupInitOp_IPRT, VERR_MODULE_NOT_FOUND,
2321 "dlopen(\"%s\",) failed: %s",
2322 szPath, dlerror());
2323 PFNRTR3INITEX pfnRTInitEx = (PFNRTR3INITEX)(uintptr_t)dlsym(pvMod, SUP_HARDENED_SYM("RTR3InitEx"));
2324 if (!pfnRTInitEx)
2325 supR3HardenedFatalMsg("supR3HardenedMainInitRuntime", kSupInitOp_IPRT, VERR_SYMBOL_NOT_FOUND,
2326 "Entrypoint \"RTR3InitEx\" not found in \"%s\"!\ndlerror: %s",
2327 szPath, dlerror());
2328 PFNSUPR3PREINIT pfnSUPPreInit = (PFNSUPR3PREINIT)(uintptr_t)dlsym(pvMod, SUP_HARDENED_SYM("supR3PreInit"));
2329 if (!pfnSUPPreInit)
2330 supR3HardenedFatalMsg("supR3HardenedMainInitRuntime", kSupInitOp_IPRT, VERR_SYMBOL_NOT_FOUND,
2331 "Entrypoint \"supR3PreInit\" not found in \"%s\"!\ndlerror: %s",
2332 szPath, dlerror());
2333#endif
2334
2335 /*
2336 * Make the calls.
2337 */
2338 supR3HardenedGetPreInitData(&g_SupPreInitData);
2339 int rc = pfnSUPPreInit(&g_SupPreInitData, fFlags);
2340 if (RT_FAILURE(rc))
2341 supR3HardenedFatalMsg("supR3HardenedMainInitRuntime", kSupInitOp_IPRT, rc,
2342 "supR3PreInit failed with rc=%d", rc);
2343
2344 /* Get the executable path for the IPRT init on linux if /proc/self/exe isn't accessible. */
2345 const char *pszExePath = NULL;
2346#ifdef RT_OS_LINUX
2347 if (!supR3HardenedMainIsProcSelfExeAccssible())
2348 pszExePath = g_szSupLibHardenedExePath;
2349#endif
2350
2351 /* Assemble the IPRT init flags. We could probably just pass RTR3INIT_FLAGS_TRY_SUPLIB
2352 here and be done with it, but it's not too much hazzle to convert fFlags 1:1. */
2353 uint32_t fRtInit = 0;
2354 if (!(fFlags & SUPSECMAIN_FLAGS_DONT_OPEN_DEV))
2355 {
2356 if (fFlags & SUPSECMAIN_FLAGS_DRIVERLESS)
2357 fRtInit |= (SUPR3INIT_F_DRIVERLESS << RTR3INIT_FLAGS_SUPLIB_SHIFT) | RTR3INIT_FLAGS_TRY_SUPLIB;
2358 if (fFlags & SUPSECMAIN_FLAGS_DRIVERLESS_IEM_ALLOWED)
2359 fRtInit |= (SUPR3INIT_F_DRIVERLESS_IEM_ALLOWED << RTR3INIT_FLAGS_SUPLIB_SHIFT) | RTR3INIT_FLAGS_TRY_SUPLIB;
2360#ifdef VBOX_WITH_DRIVERLESS_NEM_FALLBACK
2361 if (fFlags & SUPSECMAIN_FLAGS_DRIVERLESS_NEM_FALLBACK)
2362 fRtInit |= (SUPR3INIT_F_DRIVERLESS_NEM_FALLBACK << RTR3INIT_FLAGS_SUPLIB_SHIFT) | RTR3INIT_FLAGS_TRY_SUPLIB;
2363#endif
2364 if (!(fRtInit & RTR3INIT_FLAGS_TRY_SUPLIB))
2365 fRtInit |= RTR3INIT_FLAGS_SUPLIB;
2366 }
2367
2368 /* Now do the IPRT init. */
2369 rc = pfnRTInitEx(RTR3INIT_VER_CUR, fRtInit, 0 /*cArgs*/, NULL /*papszArgs*/, pszExePath);
2370 if (RT_FAILURE(rc))
2371 supR3HardenedFatalMsg("supR3HardenedMainInitRuntime", kSupInitOp_IPRT, rc,
2372 "RTR3InitEx failed with rc=%d (fRtFlags=%#x)", rc, fRtInit);
2373
2374#if defined(RT_OS_WINDOWS)
2375 /*
2376 * Windows: Create thread that terminates the process when the parent stub
2377 * process terminates (VBoxNetDHCP, Ctrl-C, etc).
2378 */
2379 if (!(fFlags & SUPSECMAIN_FLAGS_DONT_OPEN_DEV))
2380 supR3HardenedWinCreateParentWatcherThread(hMod);
2381#endif
2382}
2383
2384
2385/**
2386 * Construct the path to the DLL/SO/DYLIB containing the actual program.
2387 *
2388 * @returns VBox status code.
2389 * @param pszProgName The program name.
2390 * @param fMainFlags The flags passed to SUPR3HardenedMain.
2391 * @param pszPath The output buffer.
2392 * @param cbPath The size of the output buffer, in bytes. Must be at
2393 * least 128 bytes!
2394 */
2395static int supR3HardenedMainGetTrustedLib(const char *pszProgName, uint32_t fMainFlags, char *pszPath, size_t cbPath)
2396{
2397 supR3HardenedPathAppPrivateArch(pszPath, sizeof(cbPath) - 10);
2398 const char *pszSubDirSlash;
2399 switch (g_fSupHardenedMain & SUPSECMAIN_FLAGS_LOC_MASK)
2400 {
2401 case SUPSECMAIN_FLAGS_LOC_APP_BIN:
2402#ifdef RT_OS_DARWIN
2403 case SUPSECMAIN_FLAGS_LOC_OSX_HLP_APP:
2404#endif
2405 pszSubDirSlash = "/";
2406 break;
2407 case SUPSECMAIN_FLAGS_LOC_TESTCASE:
2408 pszSubDirSlash = "/testcase/";
2409 break;
2410 default:
2411 pszSubDirSlash = "/";
2412 supR3HardenedFatal("supR3HardenedMainGetTrustedMain: Unknown program binary location: %#x\n", g_fSupHardenedMain);
2413 }
2414#ifdef RT_OS_DARWIN
2415 if (fMainFlags & SUPSECMAIN_FLAGS_OSX_VM_APP)
2416 pszProgName = "VirtualBox";
2417#else
2418 RT_NOREF1(fMainFlags);
2419#endif
2420 size_t cch = suplibHardenedStrLen(pszPath);
2421 return suplibHardenedStrCopyEx(&pszPath[cch], cbPath - cch, pszSubDirSlash, pszProgName, SUPLIB_DLL_SUFF, NULL);
2422}
2423
2424
2425/**
2426 * Loads the DLL/SO/DYLIB containing the actual program and
2427 * resolves the TrustedError symbol.
2428 *
2429 * This is very similar to supR3HardenedMainGetTrustedMain().
2430 *
2431 * @returns Pointer to the trusted error symbol if it is exported, NULL
2432 * and no error messages otherwise.
2433 * @param pszProgName The program name.
2434 */
2435static PFNSUPTRUSTEDERROR supR3HardenedMainGetTrustedError(const char *pszProgName)
2436{
2437 /*
2438 * Don't bother if the main() function didn't advertise any TrustedError
2439 * export. It's both a waste of time and may trigger additional problems,
2440 * confusing or obscuring the original issue.
2441 */
2442 if (!(g_fSupHardenedMain & SUPSECMAIN_FLAGS_TRUSTED_ERROR))
2443 return NULL;
2444
2445 /*
2446 * Construct the name.
2447 */
2448 char szPath[RTPATH_MAX];
2449 supR3HardenedMainGetTrustedLib(pszProgName, g_fSupHardenedMain, szPath, sizeof(szPath));
2450
2451 /*
2452 * Open it and resolve the symbol.
2453 */
2454#if defined(RT_OS_WINDOWS)
2455 supR3HardenedWinEnableThreadCreation();
2456 HMODULE hMod = (HMODULE)supR3HardenedWinLoadLibrary(szPath, false /*fSystem32Only*/, 0 /*fMainFlags*/);
2457 if (!hMod)
2458 return NULL;
2459 FARPROC pfn = GetProcAddress(hMod, SUP_HARDENED_SYM("TrustedError"));
2460 if (!pfn)
2461 return NULL;
2462 return (PFNSUPTRUSTEDERROR)pfn;
2463
2464#else
2465 /* the dlopen crowd */
2466 void *pvMod = dlopen(szPath, RTLD_NOW | RTLD_GLOBAL);
2467 if (!pvMod)
2468 return NULL;
2469 void *pvSym = dlsym(pvMod, SUP_HARDENED_SYM("TrustedError"));
2470 if (!pvSym)
2471 return NULL;
2472 return (PFNSUPTRUSTEDERROR)(uintptr_t)pvSym;
2473#endif
2474}
2475
2476
2477/**
2478 * Loads the DLL/SO/DYLIB containing the actual program and
2479 * resolves the TrustedMain symbol.
2480 *
2481 * @returns Pointer to the trusted main of the actual program.
2482 * @param pszProgName The program name.
2483 * @param fMainFlags The flags passed to SUPR3HardenedMain.
2484 * @remarks This function will not return on failure.
2485 */
2486static PFNSUPTRUSTEDMAIN supR3HardenedMainGetTrustedMain(const char *pszProgName, uint32_t fMainFlags)
2487{
2488 /*
2489 * Construct the name.
2490 */
2491 char szPath[RTPATH_MAX];
2492 supR3HardenedMainGetTrustedLib(pszProgName, fMainFlags, szPath, sizeof(szPath));
2493
2494 /*
2495 * Open it and resolve the symbol.
2496 */
2497#if defined(RT_OS_WINDOWS)
2498 HMODULE hMod = (HMODULE)supR3HardenedWinLoadLibrary(szPath, false /*fSystem32Only*/, 0 /*fMainFlags*/);
2499 if (!hMod)
2500 supR3HardenedFatal("supR3HardenedMainGetTrustedMain: LoadLibrary \"%s\" failed, rc=%d\n",
2501 szPath, RtlGetLastWin32Error());
2502 FARPROC pfn = GetProcAddress(hMod, SUP_HARDENED_SYM("TrustedMain"));
2503 if (!pfn)
2504 supR3HardenedFatal("supR3HardenedMainGetTrustedMain: Entrypoint \"TrustedMain\" not found in \"%s\" (rc=%d)\n",
2505 szPath, RtlGetLastWin32Error());
2506 return (PFNSUPTRUSTEDMAIN)pfn;
2507
2508#else
2509 /* the dlopen crowd */
2510 void *pvMod = dlopen(szPath, RTLD_NOW | RTLD_GLOBAL);
2511 if (!pvMod)
2512 supR3HardenedFatal("supR3HardenedMainGetTrustedMain: dlopen(\"%s\",) failed: %s\n",
2513 szPath, dlerror());
2514 void *pvSym = dlsym(pvMod, SUP_HARDENED_SYM("TrustedMain"));
2515 if (!pvSym)
2516 supR3HardenedFatal("supR3HardenedMainGetTrustedMain: Entrypoint \"TrustedMain\" not found in \"%s\"!\ndlerror: %s\n",
2517 szPath, dlerror());
2518 return (PFNSUPTRUSTEDMAIN)(uintptr_t)pvSym;
2519#endif
2520}
2521
2522
2523DECLHIDDEN(int) SUPR3HardenedMain(const char *pszProgName, uint32_t fFlags, int argc, char **argv, char **envp)
2524{
2525 SUP_DPRINTF(("SUPR3HardenedMain: pszProgName=%s fFlags=%#x\n", pszProgName, fFlags));
2526 g_enmSupR3HardenedMainState = SUPR3HARDENEDMAINSTATE_HARDENED_MAIN_CALLED;
2527
2528 /*
2529 * Note! At this point there is no IPRT, so we will have to stick
2530 * to basic CRT functions that everyone agree upon.
2531 */
2532 g_pszSupLibHardenedProgName = pszProgName;
2533 g_fSupHardenedMain = fFlags;
2534 g_SupPreInitData.u32Magic = SUPPREINITDATA_MAGIC;
2535 g_SupPreInitData.u32EndMagic = SUPPREINITDATA_MAGIC;
2536#ifdef RT_OS_WINDOWS
2537 if (!g_fSupEarlyProcessInit)
2538#endif
2539 g_SupPreInitData.Data.hDevice = SUP_HDEVICE_NIL;
2540
2541 /*
2542 * Determine the full exe path as we'll be needing it for the verify all
2543 * call(s) below. (We have to do this early on Linux because we * *might*
2544 * not be able to access /proc/self/exe after the seteuid call.)
2545 */
2546 supR3HardenedGetFullExePath();
2547#ifdef RT_OS_WINDOWS
2548 supR3HardenedWinInitAppBin(fFlags);
2549#endif
2550
2551#ifdef SUP_HARDENED_SUID
2552 /*
2553 * Grab any options from the environment.
2554 */
2555 supR3GrabOptions();
2556
2557 /*
2558 * Check that we're root, if we aren't then the installation is butchered.
2559 */
2560 g_uid = getuid();
2561 g_gid = getgid();
2562 if (geteuid() != 0 /* root */)
2563 supR3HardenedFatalMsg("SUPR3HardenedMain", kSupInitOp_RootCheck, VERR_PERMISSION_DENIED,
2564 "Effective UID is not root (euid=%d egid=%d uid=%d gid=%d)",
2565 geteuid(), getegid(), g_uid, g_gid);
2566#endif /* SUP_HARDENED_SUID */
2567
2568#ifdef RT_OS_WINDOWS
2569 /*
2570 * Windows: First respawn. On Windows we will respawn the process twice to establish
2571 * something we can put some kind of reliable trust in. The first respawning aims
2572 * at dropping compatibility layers and process "security" solutions.
2573 */
2574 if ( !g_fSupEarlyProcessInit
2575 && !(fFlags & SUPSECMAIN_FLAGS_DONT_OPEN_DEV)
2576 && supR3HardenedWinIsReSpawnNeeded(1 /*iWhich*/, argc, argv))
2577 {
2578 SUP_DPRINTF(("SUPR3HardenedMain: Respawn #1\n"));
2579 supR3HardenedWinInit(SUPSECMAIN_FLAGS_DONT_OPEN_DEV | SUPSECMAIN_FLAGS_FIRST_PROCESS, false /*fAvastKludge*/);
2580 supR3HardenedVerifyAll(true /* fFatal */, pszProgName, g_szSupLibHardenedExePath, fFlags);
2581 return supR3HardenedWinReSpawn(1 /*iWhich*/);
2582 }
2583
2584 /*
2585 * Windows: Initialize the image verification global data so we can verify the
2586 * signature of the process image and hook the core of the DLL loader API so we
2587 * can check the signature of all DLLs mapped into the process. (Already done
2588 * by early VM process init.)
2589 */
2590 if (!g_fSupEarlyProcessInit)
2591 supR3HardenedWinInit(fFlags, true /*fAvastKludge*/);
2592#endif /* RT_OS_WINDOWS */
2593
2594 /*
2595 * Validate the installation.
2596 */
2597 supR3HardenedVerifyAll(true /* fFatal */, pszProgName, g_szSupLibHardenedExePath, fFlags);
2598
2599 /*
2600 * The next steps are only taken if we actually need to access the support
2601 * driver. (Already done by early process init.)
2602 */
2603 if (!(fFlags & SUPSECMAIN_FLAGS_DONT_OPEN_DEV))
2604 {
2605#ifdef RT_OS_WINDOWS
2606 /*
2607 * Windows: Must have done early process init if we get here.
2608 */
2609 if (!g_fSupEarlyProcessInit)
2610 supR3HardenedFatalMsg("SUPR3HardenedMain", kSupInitOp_Integrity, VERR_WRONG_ORDER,
2611 "Early process init was somehow skipped.");
2612
2613 /*
2614 * Windows: The second respawn. This time we make a special arrangement
2615 * with vboxdrv to monitor access to the new process from its inception.
2616 */
2617 if (supR3HardenedWinIsReSpawnNeeded(2 /* iWhich*/, argc, argv))
2618 {
2619 SUP_DPRINTF(("SUPR3HardenedMain: Respawn #2\n"));
2620 return supR3HardenedWinReSpawn(2 /* iWhich*/);
2621 }
2622 SUP_DPRINTF(("SUPR3HardenedMain: Final process, opening VBoxDrv...\n"));
2623 supR3HardenedWinFlushLoaderCache();
2624
2625#else
2626 /*
2627 * Open the vboxdrv device.
2628 */
2629 supR3HardenedMainOpenDevice();
2630#endif /* !RT_OS_WINDOWS */
2631 }
2632
2633#ifdef RT_OS_WINDOWS
2634 /*
2635 * Windows: Enable the use of windows APIs to verify images at load time.
2636 */
2637 supR3HardenedWinEnableThreadCreation();
2638 supR3HardenedWinFlushLoaderCache();
2639 supR3HardenedWinResolveVerifyTrustApiAndHookThreadCreation(g_pszSupLibHardenedProgName);
2640 g_enmSupR3HardenedMainState = SUPR3HARDENEDMAINSTATE_WIN_VERIFY_TRUST_READY;
2641#else /* !RT_OS_WINDOWS */
2642# if defined(RT_OS_DARWIN)
2643 supR3HardenedDarwinInit();
2644# elif !defined(RT_OS_FREEBSD) /** @todo Portme. */
2645 /*
2646 * Posix: Hook the load library interface interface.
2647 */
2648 supR3HardenedPosixInit();
2649# endif
2650#endif /* !RT_OS_WINDOWS */
2651
2652#ifdef SUP_HARDENED_SUID
2653 /*
2654 * Grab additional capabilities / privileges.
2655 */
2656 supR3HardenedMainGrabCapabilites();
2657
2658 /*
2659 * Drop any root privileges we might be holding (won't return on failure)
2660 */
2661 supR3HardenedMainDropPrivileges();
2662#endif
2663
2664 /*
2665 * Purge any environment variables and command line arguments considered harmful.
2666 */
2667 /** @todo May need to move this to a much earlier stage on windows. */
2668 supR3HardenedMainPurgeEnvironment(envp);
2669 supR3HardenedMainPurgeArgs(argc, argv, &argc, &argv);
2670
2671 /*
2672 * Load the IPRT, hand the SUPLib part the open driver and
2673 * call RTR3InitEx.
2674 */
2675 SUP_DPRINTF(("SUPR3HardenedMain: Load Runtime...\n"));
2676 g_enmSupR3HardenedMainState = SUPR3HARDENEDMAINSTATE_INIT_RUNTIME;
2677 supR3HardenedMainInitRuntime(fFlags);
2678#ifdef RT_OS_WINDOWS
2679 supR3HardenedWinModifyDllSearchPath(fFlags, g_szSupLibHardenedAppBinPath);
2680#endif
2681
2682 /*
2683 * Load the DLL/SO/DYLIB containing the actual program
2684 * and pass control to it.
2685 */
2686 SUP_DPRINTF(("SUPR3HardenedMain: Load TrustedMain...\n"));
2687 g_enmSupR3HardenedMainState = SUPR3HARDENEDMAINSTATE_GET_TRUSTED_MAIN;
2688 PFNSUPTRUSTEDMAIN pfnTrustedMain = supR3HardenedMainGetTrustedMain(pszProgName, fFlags);
2689
2690 SUP_DPRINTF(("SUPR3HardenedMain: Calling TrustedMain (%p)...\n", pfnTrustedMain));
2691 g_enmSupR3HardenedMainState = SUPR3HARDENEDMAINSTATE_CALLED_TRUSTED_MAIN;
2692 return pfnTrustedMain(argc, argv, envp);
2693}
2694
Note: See TracBrowser for help on using the repository browser.

© 2023 Oracle
ContactPrivacy policyTerms of Use