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
|
/* $Id: VBoxGuestR3LibDrmClient.cpp $ */
/** @file
* VBoxGuestR3Lib - Ring-3 Support Library for VirtualBox guest additions, DRM client handling.
*/
/*
* Copyright (C) 2020-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>.
*
* The contents of this file may alternatively be used under the terms
* of the Common Development and Distribution License Version 1.0
* (CDDL), a copy of it is provided in the "COPYING.CDDL" file included
* in the VirtualBox distribution, in which case the provisions of the
* CDDL are applicable instead of those of the GPL.
*
* You may elect to license modified versions of this file under the
* terms and conditions of either the GPL or the CDDL or both.
*
* SPDX-License-Identifier: GPL-3.0-only OR CDDL-1.0
*/
/*********************************************************************************************************************************
* Header Files *
*********************************************************************************************************************************/
#include "VBoxGuestR3LibInternal.h"
#include <iprt/env.h>
#include <iprt/path.h>
#include <iprt/process.h>
#if defined(RT_OS_LINUX)
# include <VBox/HostServices/GuestPropertySvc.h>
/** Defines the DRM client executable (image). */
# define VBOX_DRMCLIENT_EXECUTABLE "/usr/bin/VBoxDRMClient"
# define VBOX_DRMCLIENT_LEGACY_EXECUTABLE "/usr/bin/VBoxClient"
/** Defines the guest property that defines if the DRM resizing client needs to be active or not. */
# define VBOX_DRMCLIENT_GUEST_PROP_RESIZE "/VirtualBox/GuestAdd/DRMResize"
/**
* Check if specified guest property exist.
*
* @returns \c true if the property exists and its flags do match, \c false otherwise.
* @param pszPropName Guest property name.
* @param fPropFlags Guest property flags mask to verify if property exist.
* If \p fPropFlags is 0, flags verification is omitted.
*/
static bool vbglR3DrmClientCheckProp(const char *pszPropName, uint32_t fPropFlags)
{
bool fExist = false;
# if defined(VBOX_WITH_GUEST_PROPS)
uint32_t idClient;
int rc = VbglR3GuestPropConnect(&idClient);
if (RT_SUCCESS(rc))
{
char *pcszFlags = NULL;
rc = VbglR3GuestPropReadEx(idClient, pszPropName, NULL /* ppszValue */, &pcszFlags, NULL);
if (RT_SUCCESS(rc))
{
/* Check property flags match. */
if (fPropFlags)
{
uint32_t fFlags = 0;
rc = GuestPropValidateFlags(pcszFlags, &fFlags);
fExist = RT_SUCCESS(rc) && (fFlags == fPropFlags);
}
else
fExist = true;
RTStrFree(pcszFlags);
}
VbglR3GuestPropDisconnect(idClient);
}
# endif /* VBOX_WITH_GUEST_PROPS */
return fExist;
}
#endif /* RT_OS_LINUX */
/**
* Returns true if the DRM resizing client is needed.
* This is achieved by querying existence of a guest property.
*
* @returns \c true if the DRM resizing client is needed, \c false if not.
*/
VBGLR3DECL(bool) VbglR3DrmClientIsNeeded(void)
{
#if defined(RT_OS_LINUX)
return vbglR3DrmClientCheckProp(VBOX_DRMCLIENT_GUEST_PROP_RESIZE, 0);
#else
return false;
#endif
}
/**
* Returns true if the DRM IPC server socket access should be restricted.
*
* Restricted access means that only users from a certain group should
* be granted with read and write access permission to IPC socket. Check
* is done by examining \c VBGLR3DRMIPCPROPRESTRICT guest property. Property
* is only considered valid if is read-only for guest. I.e., the following
* property should be set on the host side:
*
* VBoxManage guestproperty set <VM> /VirtualBox/GuestAdd/DRMIpcRestricted 1 --flags RDONLYGUEST
*
* @returns \c true if restricted socket access is required, \c false otherwise.
*/
VBGLR3DECL(bool) VbglR3DrmRestrictedIpcAccessIsNeeded(void)
{
#if defined(RT_OS_LINUX)
return vbglR3DrmClientCheckProp(VBGLR3DRMIPCPROPRESTRICT, GUEST_PROP_F_RDONLYGUEST);
#else
return false;
#endif
}
/**
* Returns true if the DRM resizing client already is running.
* This is achieved by querying existence of a guest property.
*
* @returns \c true if the DRM resizing client is running, \c false if not.
*/
VBGLR3DECL(bool) VbglR3DrmClientIsRunning(void)
{
return VbglR3DrmClientIsNeeded();
}
#if defined(RT_OS_LINUX)
static int VbglR3DrmStart(const char *pszCmd, const char **apszArgs)
{
return RTProcCreate(pszCmd, apszArgs, RTENV_DEFAULT,
RTPROC_FLAGS_DETACHED | RTPROC_FLAGS_SEARCH_PATH, NULL);
}
#endif
/**
* Starts (executes) the DRM resizing client process ("VBoxDRMClient").
*
* @returns VBox status code.
*/
VBGLR3DECL(int) VbglR3DrmClientStart(void)
{
#if defined(RT_OS_LINUX)
const char *apszArgs[2] = { VBOX_DRMCLIENT_EXECUTABLE, NULL }; /** @todo r=andy Pass path + process name as argv0? */
return VbglR3DrmStart(VBOX_DRMCLIENT_EXECUTABLE, apszArgs);
#else
return VERR_NOT_SUPPORTED;
#endif
}
/**
* Starts (executes) the legacy DRM resizing client process ("VBoxClient --vmsvga").
*
* @returns VBox status code.
*/
VBGLR3DECL(int) VbglR3DrmLegacyClientStart(void)
{
#if defined(RT_OS_LINUX)
const char *apszArgs[3] = { VBOX_DRMCLIENT_LEGACY_EXECUTABLE, "--vmsvga", NULL };
return VbglR3DrmStart(VBOX_DRMCLIENT_LEGACY_EXECUTABLE, apszArgs);
#else
return VERR_NOT_SUPPORTED;
#endif
}
/**
* Starts (executes) the legacy X11 resizing agent process ("VBoxClient --display").
*
* @returns VBox status code.
*/
VBGLR3DECL(int) VbglR3DrmLegacyX11AgentStart(void)
{
#if defined(RT_OS_LINUX)
const char *apszArgs[3] = { VBOX_DRMCLIENT_LEGACY_EXECUTABLE, "--display", NULL };
return VbglR3DrmStart(VBOX_DRMCLIENT_LEGACY_EXECUTABLE, apszArgs);
#else
return VERR_NOT_SUPPORTED;
#endif
}
|
