VirtualBox

source: vbox/trunk/src/VBox/HostDrivers/Support/SUPLibInternal.h@ 35650

Last change on this file since 35650 was 35188, checked in by vboxsync, 14 years ago

Use RTERRINFO in SUPLib for hardening APIs and such.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 11.7 KB
Line 
1/* $Id: SUPLibInternal.h 35188 2010-12-16 15:13:07Z vboxsync $ */
2/** @file
3 * VirtualBox Support Library - Internal header.
4 */
5
6/*
7 * Copyright (C) 2006-2007 Oracle Corporation
8 *
9 * This file is part of VirtualBox Open Source Edition (OSE), as
10 * available from http://www.virtualbox.org. This file is free software;
11 * you can redistribute it and/or modify it under the terms of the GNU
12 * General Public License (GPL) as published by the Free Software
13 * Foundation, in version 2 as it comes in the "COPYING" file of the
14 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
15 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
16 *
17 * The contents of this file may alternatively be used under the terms
18 * of the Common Development and Distribution License Version 1.0
19 * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
20 * VirtualBox OSE distribution, in which case the provisions of the
21 * CDDL are applicable instead of those of the GPL.
22 *
23 * You may elect to license modified versions of this file under the
24 * terms and conditions of either the GPL or the CDDL or both.
25 */
26
27#ifndef ___SUPLibInternal_h___
28#define ___SUPLibInternal_h___
29
30#include <VBox/cdefs.h>
31#include <VBox/types.h>
32#include <iprt/stdarg.h>
33
34
35/*******************************************************************************
36* Defined Constants And Macros *
37*******************************************************************************/
38/** @def SUPLIB_DLL_SUFF
39 * The (typical) DLL/DYLIB/SO suffix. */
40#if defined(RT_OS_DARWIN)
41# define SUPLIB_DLL_SUFF ".dylib"
42#elif defined(RT_OS_L4)
43# define SUPLIB_DLL_SUFF ".s.so"
44#elif defined(RT_OS_OS2) || defined(RT_OS_WINDOWS)
45# define SUPLIB_DLL_SUFF ".dll"
46#else
47# define SUPLIB_DLL_SUFF ".so"
48#endif
49
50#ifdef RT_OS_SOLARIS
51/** Number of dummy files to open (2:ip4, 1:ip6, 1:extra) see
52 * @bugref{4650}. */
53# define SUPLIB_FLT_DUMMYFILES 4
54#endif
55
56/** @def SUPLIB_EXE_SUFF
57 * The (typical) executable suffix. */
58#if defined(RT_OS_OS2) || defined(RT_OS_WINDOWS)
59# define SUPLIB_EXE_SUFF ".exe"
60#else
61# define SUPLIB_EXE_SUFF ""
62#endif
63
64/** @def SUP_HARDENED_SUID
65 * Whether we're employing set-user-ID-on-execute in the hardening.
66 */
67#if !defined(RT_OS_OS2) && !defined(RT_OS_WINDOWS) && !defined(RT_OS_L4)
68# define SUP_HARDENED_SUID
69#else
70# undef SUP_HARDENED_SUID
71#endif
72
73#ifdef IN_SUP_HARDENED_R3
74/** @name Make the symbols in SUPR3HardenedStatic different from the VBoxRT ones.
75 * We cannot rely on DECLHIDDEN to make this separation for us since it doesn't
76 * work with all GCC versions. So, we resort to old fashion precompiler hacking.
77 * @{
78 */
79# define supR3HardenedPathAppPrivateNoArch supR3HardenedStaticPathAppPrivateNoArch
80# define supR3HardenedPathAppPrivateArch supR3HardenedStaticPathAppPrivateArch
81# define supR3HardenedPathSharedLibs supR3HardenedStaticPathSharedLibs
82# define supR3HardenedPathAppDocs supR3HardenedStaticPathAppDocs
83# define supR3HardenedPathExecDir supR3HardenedStaticPathExecDir
84# define supR3HardenedPathFilename supR3HardenedStaticPathFilename
85# define supR3HardenedFatalV supR3HardenedStaticFatalV
86# define supR3HardenedFatal supR3HardenedStaticFatal
87# define supR3HardenedFatalMsgV supR3HardenedStaticFatalMsgV
88# define supR3HardenedFatalMsg supR3HardenedStaticFatalMsg
89# define supR3HardenedErrorV supR3HardenedStaticErrorV
90# define supR3HardenedError supR3HardenedStaticError
91# define supR3HardenedVerifyAll supR3HardenedStaticVerifyAll
92# define supR3HardenedVerifyFixedDir supR3HardenedStaticVerifyFixedDir
93# define supR3HardenedVerifyFixedFile supR3HardenedStaticVerifyFixedFile
94# define supR3HardenedVerifyDir supR3HardenedStaticVerifyDir
95# define supR3HardenedVerifyFile supR3HardenedStaticVerifyFile
96# define supR3HardenedGetPreInitData supR3HardenedStaticGetPreInitData
97# define supR3HardenedRecvPreInitData supR3HardenedStaticRecvPreInitData
98/** @} */
99#endif /* IN_SUP_HARDENED_R3 */
100
101
102/*******************************************************************************
103* Structures and Typedefs *
104*******************************************************************************/
105/**
106 * The type of an installed file.
107 */
108typedef enum SUPINSTFILETYPE
109{
110 kSupIFT_Invalid = 0,
111 kSupIFT_Exe,
112 kSupIFT_Dll,
113 kSupIFT_Sys,
114 kSupIFT_Script,
115 kSupIFT_Data,
116 kSupIFT_End
117} SUPINSTFILETYPE;
118
119/**
120 * Installation directory specifier.
121 */
122typedef enum SUPINSTDIR
123{
124 kSupID_Invalid = 0,
125 kSupID_Bin,
126 kSupID_AppBin,
127 kSupID_SharedLib,
128 kSupID_AppPrivArch,
129 kSupID_AppPrivArchComp,
130 kSupID_AppPrivNoArch,
131 kSupID_End
132} SUPINSTDIR;
133
134/**
135 * Installed file.
136 */
137typedef struct SUPINSTFILE
138{
139 /** File type. */
140 SUPINSTFILETYPE enmType;
141 /** Install directory. */
142 SUPINSTDIR enmDir;
143 /** Optional (true) or mandatory (false. */
144 bool fOptional;
145 /** File name. */
146 const char *pszFile;
147} SUPINSTFILE;
148typedef SUPINSTFILE *PSUPINSTFILE;
149typedef SUPINSTFILE const *PCSUPINSTFILE;
150
151/**
152 * Status data for a verified file.
153 */
154typedef struct SUPVERIFIEDFILE
155{
156 /** The file handle or descriptor. -1 if not open. */
157 intptr_t hFile;
158 /** Whether the file has been validated. */
159 bool fValidated;
160} SUPVERIFIEDFILE;
161typedef SUPVERIFIEDFILE *PSUPVERIFIEDFILE;
162typedef SUPVERIFIEDFILE const *PCSUPVERIFIEDFILE;
163
164/**
165 * Status data for a verified directory.
166 */
167typedef struct SUPVERIFIEDDIR
168{
169 /** The directory handle or descriptor. -1 if not open. */
170 intptr_t hDir;
171 /** Whether the directory has been validated. */
172 bool fValidated;
173} SUPVERIFIEDDIR;
174typedef SUPVERIFIEDDIR *PSUPVERIFIEDDIR;
175typedef SUPVERIFIEDDIR const *PCSUPVERIFIEDDIR;
176
177
178/**
179 * SUPLib instance data.
180 *
181 * This is data that is passed from the static to the dynamic SUPLib
182 * in a hardened setup.
183 */
184typedef struct SUPLIBDATA
185{
186 /** The device handle. */
187 RTFILE hDevice;
188#if defined(RT_OS_DARWIN)
189 /** The connection to the VBoxSupDrv service. */
190 uintptr_t uConnection;
191#elif defined(RT_OS_LINUX)
192 /** Indicates whether madvise(,,MADV_DONTFORK) works. */
193 bool fSysMadviseWorks;
194#elif defined(RT_OS_SOLARIS)
195 /** Extra dummy file descriptors to prevent growing file-descriptor table on
196 * clean up (see @bugref{4650}). */
197 int ahDummy[SUPLIB_FLT_DUMMYFILES];
198#elif defined(RT_OS_WINDOWS)
199#endif
200} SUPLIBDATA;
201/** Pointer to the pre-init data. */
202typedef SUPLIBDATA *PSUPLIBDATA;
203/** Pointer to const pre-init data. */
204typedef SUPLIBDATA const *PCSUPLIBDATA;
205
206
207/**
208 * Pre-init data that is handed over from the hardened executable stub.
209 */
210typedef struct SUPPREINITDATA
211{
212 /** Magic value (SUPPREINITDATA_MAGIC). */
213 uint32_t u32Magic;
214 /** The SUPLib instance data. */
215 SUPLIBDATA Data;
216 /** The number of entries in paInstallFiles and paVerifiedFiles. */
217 size_t cInstallFiles;
218 /** g_aSupInstallFiles. */
219 PCSUPINSTFILE paInstallFiles;
220 /** g_aSupVerifiedFiles. */
221 PCSUPVERIFIEDFILE paVerifiedFiles;
222 /** The number of entries in paVerifiedDirs. */
223 size_t cVerifiedDirs;
224 /** g_aSupVerifiedDirs. */
225 PCSUPVERIFIEDDIR paVerifiedDirs;
226 /** Magic value (SUPPREINITDATA_MAGIC). */
227 uint32_t u32EndMagic;
228} SUPPREINITDATA;
229typedef SUPPREINITDATA *PSUPPREINITDATA;
230typedef SUPPREINITDATA const *PCSUPPREINITDATA;
231
232/** Magic value for SUPPREINITDATA::u32Magic and SUPPREINITDATA::u32EndMagic. */
233#define SUPPREINITDATA_MAGIC UINT32_C(0xbeef0001)
234
235/** @copydoc supR3PreInit */
236typedef DECLCALLBACK(int) FNSUPR3PREINIT(PSUPPREINITDATA pPreInitData, uint32_t fFlags);
237/** Pointer to supR3PreInit. */
238typedef FNSUPR3PREINIT *PFNSUPR3PREINIT;
239
240
241/*******************************************************************************
242* Global Variables *
243*******************************************************************************/
244extern DECLHIDDEN(uint32_t) g_u32Cookie;
245extern DECLHIDDEN(uint32_t) g_u32SessionCookie;
246extern DECLHIDDEN(SUPLIBDATA) g_supLibData;
247
248
249/*******************************************************************************
250* OS Specific Function *
251*******************************************************************************/
252RT_C_DECLS_BEGIN
253int suplibOsInstall(void);
254int suplibOsUninstall(void);
255int suplibOsInit(PSUPLIBDATA pThis, bool fPreInited);
256int suplibOsTerm(PSUPLIBDATA pThis);
257int suplibOsIOCtl(PSUPLIBDATA pThis, uintptr_t uFunction, void *pvReq, size_t cbReq);
258int suplibOsIOCtlFast(PSUPLIBDATA pThis, uintptr_t uFunction, uintptr_t idCpu);
259int suplibOsPageAlloc(PSUPLIBDATA pThis, size_t cPages, void **ppvPages);
260int suplibOsPageFree(PSUPLIBDATA pThis, void *pvPages, size_t cPages);
261int suplibOsQueryVTxSupported(void);
262
263
264/**
265 * Performs the pre-initialization of the support library.
266 *
267 * This is dynamically resolved and invoked by the static library before it
268 * calls RTR3Init and thereby SUPR3Init.
269 *
270 * @returns IPRT status code.
271 * @param pPreInitData The pre init data.
272 * @param fFlags The SUPR3HardenedMain flags.
273 */
274DECLEXPORT(int) supR3PreInit(PSUPPREINITDATA pPreInitData, uint32_t fFlags);
275
276
277/** @copydoc RTPathAppPrivateNoArch */
278DECLHIDDEN(int) supR3HardenedPathAppPrivateNoArch(char *pszPath, size_t cchPath);
279/** @copydoc RTPathAppPrivateArch */
280DECLHIDDEN(int) supR3HardenedPathAppPrivateArch(char *pszPath, size_t cchPath);
281/** @copydoc RTPathSharedLibs */
282DECLHIDDEN(int) supR3HardenedPathSharedLibs(char *pszPath, size_t cchPath);
283/** @copydoc RTPathAppDocs */
284DECLHIDDEN(int) supR3HardenedPathAppDocs(char *pszPath, size_t cchPath);
285/** @copydoc RTPathExecDir */
286DECLHIDDEN(int) supR3HardenedPathExecDir(char *pszPath, size_t cchPath);
287/** @copydoc RTPathFilename */
288DECLHIDDEN(char *) supR3HardenedPathFilename(const char *pszPath);
289
290/**
291 * Display a fatal error and try call TrustedError or quit.
292 */
293DECLHIDDEN(void) supR3HardenedFatalMsgV(const char *pszWhere, SUPINITOP enmWhat, int rc, const char *pszMsgFmt, va_list va);
294
295/**
296 * Display a fatal error and try call TrustedError or quit.
297 */
298DECLHIDDEN(void) supR3HardenedFatalMsg(const char *pszWhere, SUPINITOP enmWhat, int rc, const char *pszMsgFmt, ...);
299
300/**
301 * Display a fatal error and quit.
302 */
303DECLHIDDEN(void) supR3HardenedFatalV(const char *pszFormat, va_list va);
304
305/**
306 * Display a fatal error and quit.
307 */
308DECLHIDDEN(void) supR3HardenedFatal(const char *pszFormat, ...);
309
310/**
311 * Display an error which may or may not be fatal.
312 */
313DECLHIDDEN(int) supR3HardenedErrorV(int rc, bool fFatal, const char *pszFormat, va_list va);
314
315/**
316 * Display an error which may or may not be fatal.
317 */
318DECLHIDDEN(int) supR3HardenedError(int rc, bool fFatal, const char *pszFormat, ...);
319DECLHIDDEN(int) supR3HardenedVerifyAll(bool fFatal, bool fLeaveFilesOpen, const char *pszProgName);
320DECLHIDDEN(int) supR3HardenedVerifyFixedDir(SUPINSTDIR enmDir, bool fFatal);
321DECLHIDDEN(int) supR3HardenedVerifyFixedFile(const char *pszFilename, bool fFatal);
322DECLHIDDEN(int) supR3HardenedVerifyDir(const char *pszDirPath, bool fRecursive, bool fCheckFiles, PRTERRINFO pErrInfo);
323DECLHIDDEN(int) supR3HardenedVerifyFile(const char *pszFilename, RTHCUINTPTR hNativeFile, PRTERRINFO pErrInfo);
324DECLHIDDEN(void) supR3HardenedGetPreInitData(PSUPPREINITDATA pPreInitData);
325DECLHIDDEN(int) supR3HardenedRecvPreInitData(PCSUPPREINITDATA pPreInitData);
326
327
328SUPR3DECL(int) supR3PageLock(void *pvStart, size_t cPages, PSUPPAGE paPages);
329SUPR3DECL(int) supR3PageUnlock(void *pvStart);
330
331RT_C_DECLS_END
332
333
334#endif
335
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette