1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
|
/* $Id: VBoxServiceUtils.cpp $ */
/** @file
* VBoxServiceUtils - Some utility functions.
*/
/*
* Copyright (C) 2009-2023 Oracle and/or its affiliates.
*
* This file is part of VirtualBox base platform packages, as
* available from https://www.virtualbox.org.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation, in version 3 of the
* License.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, see <https://www.gnu.org/licenses>.
*
* SPDX-License-Identifier: GPL-3.0-only
*/
/*********************************************************************************************************************************
* Header Files *
*********************************************************************************************************************************/
#ifdef RT_OS_WINDOWS
# include <iprt/win/windows.h>
# include <iprt/param.h>
# include <iprt/path.h>
#endif
#include <iprt/assert.h>
#include <iprt/mem.h>
#include <iprt/string.h>
#include <VBox/VBoxGuestLib.h>
#include "VBoxServiceInternal.h"
#ifdef VBOX_WITH_GUEST_PROPS
/**
* Reads a guest property as a 32-bit value.
*
* @returns VBox status code, fully bitched.
*
* @param u32ClientId The HGCM client ID for the guest property session.
* @param pszPropName The property name.
* @param pu32 Where to store the 32-bit value.
*
*/
int VGSvcReadPropUInt32(uint32_t u32ClientId, const char *pszPropName, uint32_t *pu32, uint32_t u32Min, uint32_t u32Max)
{
char *pszValue;
int rc = VbglR3GuestPropReadEx(u32ClientId, pszPropName, &pszValue, NULL /* ppszFlags */, NULL /* puTimestamp */);
if (RT_SUCCESS(rc))
{
char *pszNext;
rc = RTStrToUInt32Ex(pszValue, &pszNext, 0, pu32);
if ( RT_SUCCESS(rc)
&& (*pu32 < u32Min || *pu32 > u32Max))
rc = VGSvcError("The guest property value %s = %RU32 is out of range [%RU32..%RU32].\n",
pszPropName, *pu32, u32Min, u32Max);
RTStrFree(pszValue);
}
return rc;
}
/**
* Reads a guest property from the host side.
*
* @returns IPRT status code, fully bitched.
* @param u32ClientId The HGCM client ID for the guest property session.
* @param pszPropName The property name.
* @param fReadOnly Whether or not this property needs to be read only
* by the guest side. Otherwise VERR_ACCESS_DENIED will
* be returned.
* @param ppszValue Where to return the value. This is always set
* to NULL. Free it using RTStrFree().
* @param ppszFlags Where to return the value flags. Free it
* using RTStrFree(). Optional.
* @param puTimestamp Where to return the timestamp. This is only set
* on success. Optional.
*/
int VGSvcReadHostProp(uint32_t u32ClientId, const char *pszPropName, bool fReadOnly,
char **ppszValue, char **ppszFlags, uint64_t *puTimestamp)
{
AssertPtrReturn(ppszValue, VERR_INVALID_PARAMETER);
char *pszValue = NULL;
char *pszFlags = NULL;
int rc = VbglR3GuestPropReadEx(u32ClientId, pszPropName, &pszValue, &pszFlags, puTimestamp);
if (RT_SUCCESS(rc))
{
/* Check security bits. */
if ( fReadOnly /* Do we except a guest read-only property */
&& !RTStrStr(pszFlags, "RDONLYGUEST"))
{
/* If we want a property which is read-only on the guest
* and it is *not* marked as such, deny access! */
rc = VERR_ACCESS_DENIED;
}
if (RT_SUCCESS(rc))
{
*ppszValue = pszValue;
if (ppszFlags)
*ppszFlags = pszFlags;
else if (pszFlags)
RTStrFree(pszFlags);
}
else
{
if (pszValue)
RTStrFree(pszValue);
if (pszFlags)
RTStrFree(pszFlags);
}
}
return rc;
}
/**
* Wrapper around VbglR3GuestPropWriteValue that does value formatting and
* logging.
*
* @returns VBox status code. Errors will be logged.
*
* @param u32ClientId The HGCM client ID for the guest property session.
* @param pszName The property name.
* @param pszValueFormat The property format string. If this is NULL then
* the property will be deleted (if possible).
* @param ... Format arguments.
*/
int VGSvcWritePropF(uint32_t u32ClientId, const char *pszName, const char *pszValueFormat, ...)
{
AssertPtr(pszName);
int rc;
if (pszValueFormat != NULL)
{
va_list va;
va_start(va, pszValueFormat);
VGSvcVerbose(3, "Writing guest property '%s' = '%N'\n", pszName, pszValueFormat, &va);
va_end(va);
va_start(va, pszValueFormat);
rc = VbglR3GuestPropWriteValueV(u32ClientId, pszName, pszValueFormat, va);
va_end(va);
if (RT_FAILURE(rc))
VGSvcError("Error writing guest property '%s' (rc=%Rrc)\n", pszName, rc);
}
else
{
VGSvcVerbose(3, "Deleting guest property '%s'\n", pszName);
rc = VbglR3GuestPropWriteValue(u32ClientId, pszName, NULL);
if (RT_FAILURE(rc))
VGSvcError("Error deleting guest property '%s' (rc=%Rrc)\n", pszName, rc);
}
return rc;
}
#endif /* VBOX_WITH_GUEST_PROPS */
#ifdef RT_OS_WINDOWS
/**
* Helper for vgsvcUtilGetFileVersion and attempts to read and parse
* FileVersion.
*
* @returns Success indicator.
*/
static bool vgsvcUtilGetFileVersionOwn(LPSTR pVerData, uint32_t *puMajor, uint32_t *puMinor,
uint32_t *puBuildNumber, uint32_t *puRevisionNumber)
{
UINT cchStrValue = 0;
LPTSTR pStrValue = NULL;
if (!VerQueryValueA(pVerData, "\\StringFileInfo\\040904b0\\FileVersion", (LPVOID *)&pStrValue, &cchStrValue))
return false;
char *pszNext = pStrValue;
int rc = RTStrToUInt32Ex(pszNext, &pszNext, 0, puMajor);
AssertReturn(rc == VWRN_TRAILING_CHARS, false);
AssertReturn(*pszNext == '.', false);
rc = RTStrToUInt32Ex(pszNext + 1, &pszNext, 0, puMinor);
AssertReturn(rc == VWRN_TRAILING_CHARS, false);
AssertReturn(*pszNext == '.', false);
rc = RTStrToUInt32Ex(pszNext + 1, &pszNext, 0, puBuildNumber);
AssertReturn(rc == VWRN_TRAILING_CHARS, false);
AssertReturn(*pszNext == '.', false);
rc = RTStrToUInt32Ex(pszNext + 1, &pszNext, 0, puRevisionNumber);
AssertReturn(rc == VINF_SUCCESS || rc == VWRN_TRAILING_CHARS /*??*/, false);
return true;
}
/**
* Worker for VGSvcUtilWinGetFileVersionString.
*
* @returns VBox status code.
* @param pszFilename ASCII & ANSI & UTF-8 compliant name.
* @param puMajor Where to return the major version number.
* @param puMinor Where to return the minor version number.
* @param puBuildNumber Where to return the build number.
* @param puRevisionNumber Where to return the revision number.
*/
static int vgsvcUtilGetFileVersion(const char *pszFilename, uint32_t *puMajor, uint32_t *puMinor, uint32_t *puBuildNumber,
uint32_t *puRevisionNumber)
{
int rc;
*puMajor = *puMinor = *puBuildNumber = *puRevisionNumber = 0;
/*
* Get the file version info.
*/
DWORD dwHandleIgnored;
DWORD cbVerData = GetFileVersionInfoSizeA(pszFilename, &dwHandleIgnored);
if (cbVerData)
{
LPTSTR pVerData = (LPTSTR)RTMemTmpAllocZ(cbVerData);
if (pVerData)
{
if (GetFileVersionInfoA(pszFilename, dwHandleIgnored, cbVerData, pVerData))
{
/*
* Try query and parse the FileVersion string our selves first
* since this will give us the correct revision number when
* it goes beyond the range of an uint16_t / WORD.
*/
if (vgsvcUtilGetFileVersionOwn(pVerData, puMajor, puMinor, puBuildNumber, puRevisionNumber))
rc = VINF_SUCCESS;
else
{
/* Fall back on VS_FIXEDFILEINFO */
UINT cbFileInfoIgnored = 0;
VS_FIXEDFILEINFO *pFileInfo = NULL;
if (VerQueryValue(pVerData, "\\", (LPVOID *)&pFileInfo, &cbFileInfoIgnored))
{
*puMajor = HIWORD(pFileInfo->dwFileVersionMS);
*puMinor = LOWORD(pFileInfo->dwFileVersionMS);
*puBuildNumber = HIWORD(pFileInfo->dwFileVersionLS);
*puRevisionNumber = LOWORD(pFileInfo->dwFileVersionLS);
rc = VINF_SUCCESS;
}
else
{
rc = RTErrConvertFromWin32(GetLastError());
VGSvcVerbose(3, "No file version value for file '%s' available! (%d / rc=%Rrc)\n",
pszFilename, GetLastError(), rc);
}
}
}
else
{
rc = RTErrConvertFromWin32(GetLastError());
VGSvcVerbose(0, "GetFileVersionInfo(%s) -> %u / %Rrc\n", pszFilename, GetLastError(), rc);
}
RTMemTmpFree(pVerData);
}
else
{
VGSvcVerbose(0, "Failed to allocate %u byte for file version info for '%s'\n", cbVerData, pszFilename);
rc = VERR_NO_TMP_MEMORY;
}
}
else
{
rc = RTErrConvertFromWin32(GetLastError());
VGSvcVerbose(3, "GetFileVersionInfoSize(%s) -> %u / %Rrc\n", pszFilename, GetLastError(), rc);
}
return rc;
}
/**
* Gets a re-formatted version string from the VS_FIXEDFILEINFO table.
*
* @returns VBox status code. The output buffer is always valid and the status
* code can safely be ignored.
*
* @param pszPath The base path.
* @param pszFilename The filename.
* @param pszVersion Where to return the version string.
* @param cbVersion The size of the version string buffer. This MUST be
* at least 2 bytes!
*/
int VGSvcUtilWinGetFileVersionString(const char *pszPath, const char *pszFilename, char *pszVersion, size_t cbVersion)
{
/*
* We will ALWAYS return with a valid output buffer.
*/
AssertReturn(cbVersion >= 2, VERR_BUFFER_OVERFLOW);
pszVersion[0] = '-';
pszVersion[1] = '\0';
/*
* Create the path and query the bits.
*/
char szFullPath[RTPATH_MAX];
int rc = RTPathJoin(szFullPath, sizeof(szFullPath), pszPath, pszFilename);
if (RT_SUCCESS(rc))
{
uint32_t uMajor, uMinor, uBuild, uRev;
rc = vgsvcUtilGetFileVersion(szFullPath, &uMajor, &uMinor, &uBuild, &uRev);
if (RT_SUCCESS(rc))
RTStrPrintf(pszVersion, cbVersion, "%u.%u.%ur%u", uMajor, uMinor, uBuild, uRev);
}
return rc;
}
#endif /* RT_OS_WINDOWS */
|
