VirtualBox

source: vbox/trunk/src/VBox/Main/webservice/vboxweb.cpp@ 59654

Last change on this file since 59654 was 59654, checked in by vboxsync, 9 years ago

webservice: drop Weblog()
  • Property filesplitter.c set to Makefile.kmk
  • Property svn:eol-style set to native
  • Property svn:keywords set to Id Revision
File size: 80.0 KB
Line 
1/**
2 * vboxweb.cpp:
3 * hand-coded parts of the webservice server. This is linked with the
4 * generated code in out/.../src/VBox/Main/webservice/methodmaps.cpp
5 * (plus static gSOAP server code) to implement the actual webservice
6 * server, to which clients can connect.
7 *
8 * Copyright (C) 2007-2015 Oracle Corporation
9 *
10 * This file is part of VirtualBox Open Source Edition (OSE), as
11 * available from http://www.virtualbox.org. This file is free software;
12 * you can redistribute it and/or modify it under the terms of the GNU
13 * General Public License (GPL) as published by the Free Software
14 * Foundation, in version 2 as it comes in the "COPYING" file of the
15 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
16 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
17 */
18
19// shared webservice header
20#include "vboxweb.h"
21
22// vbox headers
23#include <VBox/com/com.h>
24#include <VBox/com/array.h>
25#include <VBox/com/string.h>
26#include <VBox/com/ErrorInfo.h>
27#include <VBox/com/errorprint.h>
28#include <VBox/com/listeners.h>
29#include <VBox/com/NativeEventQueue.h>
30#include <VBox/VBoxAuth.h>
31#include <VBox/version.h>
32#include <VBox/log.h>
33
34#include <iprt/buildconfig.h>
35#include <iprt/ctype.h>
36#include <iprt/getopt.h>
37#include <iprt/initterm.h>
38#include <iprt/ldr.h>
39#include <iprt/message.h>
40#include <iprt/process.h>
41#include <iprt/rand.h>
42#include <iprt/semaphore.h>
43#include <iprt/critsect.h>
44#include <iprt/string.h>
45#include <iprt/thread.h>
46#include <iprt/time.h>
47#include <iprt/path.h>
48#include <iprt/system.h>
49#include <iprt/base64.h>
50#include <iprt/stream.h>
51#include <iprt/asm.h>
52
53#ifndef RT_OS_WINDOWS
54# include <signal.h>
55#endif
56
57// workaround for compile problems on gcc 4.1
58#ifdef __GNUC__
59#pragma GCC visibility push(default)
60#endif
61
62// gSOAP headers (must come after vbox includes because it checks for conflicting defs)
63#include "soapH.h"
64
65// standard headers
66#include <map>
67#include <list>
68
69#ifdef __GNUC__
70#pragma GCC visibility pop
71#endif
72
73// include generated namespaces table
74#include "vboxwebsrv.nsmap"
75
76RT_C_DECLS_BEGIN
77
78// declarations for the generated WSDL text
79extern const unsigned char g_abVBoxWebWSDL[];
80extern const unsigned g_cbVBoxWebWSDL;
81
82RT_C_DECLS_END
83
84static void WebLogSoapError(struct soap *soap);
85
86/****************************************************************************
87 *
88 * private typedefs
89 *
90 ****************************************************************************/
91
92typedef std::map<uint64_t, ManagedObjectRef*> ManagedObjectsMapById;
93typedef ManagedObjectsMapById::iterator ManagedObjectsIteratorById;
94typedef std::map<uintptr_t, ManagedObjectRef*> ManagedObjectsMapByPtr;
95typedef ManagedObjectsMapByPtr::iterator ManagedObjectsIteratorByPtr;
96
97typedef std::map<uint64_t, WebServiceSession*> WebsessionsMap;
98typedef WebsessionsMap::iterator WebsessionsMapIterator;
99
100typedef std::map<RTTHREAD, com::Utf8Str> ThreadsMap;
101
102static DECLCALLBACK(int) fntWatchdog(RTTHREAD ThreadSelf, void *pvUser);
103
104/****************************************************************************
105 *
106 * Read-only global variables
107 *
108 ****************************************************************************/
109
110static ComPtr<IVirtualBoxClient> g_pVirtualBoxClient = NULL;
111
112// generated strings in methodmaps.cpp
113extern const char *g_pcszISession,
114 *g_pcszIVirtualBox,
115 *g_pcszIVirtualBoxErrorInfo;
116
117// globals for vboxweb command-line arguments
118#define DEFAULT_TIMEOUT_SECS 300
119#define DEFAULT_TIMEOUT_SECS_STRING "300"
120static int g_iWatchdogTimeoutSecs = DEFAULT_TIMEOUT_SECS;
121static int g_iWatchdogCheckInterval = 5;
122
123static const char *g_pcszBindToHost = NULL; // host; NULL = localhost
124static unsigned int g_uBindToPort = 18083; // port
125static unsigned int g_uBacklog = 100; // backlog = max queue size for requests
126
127#ifdef WITH_OPENSSL
128static bool g_fSSL = false; // if SSL is enabled
129static const char *g_pcszKeyFile = NULL; // server key file
130static const char *g_pcszPassword = NULL; // password for server key
131static const char *g_pcszCACert = NULL; // file with trusted CA certificates
132static const char *g_pcszCAPath = NULL; // directory with trusted CA certificates
133static const char *g_pcszDHFile = NULL; // DH file name or DH key length in bits, NULL=use RSA
134static const char *g_pcszRandFile = NULL; // file with random data seed
135static const char *g_pcszSID = "vboxwebsrv"; // server ID for SSL session cache
136#endif /* WITH_OPENSSL */
137
138static unsigned int g_cMaxWorkerThreads = 100; // max. no. of worker threads
139static unsigned int g_cMaxKeepAlive = 100; // maximum number of soap requests in one connection
140
141static const char *g_pcszAuthentication = NULL; // web service authentication
142
143static uint32_t g_cHistory = 10; // enable log rotation, 10 files
144static uint32_t g_uHistoryFileTime = RT_SEC_1DAY; // max 1 day per file
145static uint64_t g_uHistoryFileSize = 100 * _1M; // max 100MB per file
146bool g_fVerbose = false; // be verbose
147
148static bool g_fDaemonize = false; // run in background.
149static volatile bool g_fKeepRunning = true; // controlling the exit
150
151const WSDLT_ID g_EmptyWSDLID; // for NULL MORs
152
153/****************************************************************************
154 *
155 * Writeable global variables
156 *
157 ****************************************************************************/
158
159// The one global SOAP queue created by main().
160class SoapQ;
161static SoapQ *g_pSoapQ = NULL;
162
163// this mutex protects the auth lib and authentication
164static util::WriteLockHandle *g_pAuthLibLockHandle;
165
166// this mutex protects the global VirtualBox reference below
167static util::RWLockHandle *g_pVirtualBoxLockHandle;
168
169static ComPtr<IVirtualBox> g_pVirtualBox = NULL;
170
171// this mutex protects all of the below
172util::WriteLockHandle *g_pWebsessionsLockHandle;
173
174static WebsessionsMap g_mapWebsessions;
175static ULONG64 g_cManagedObjects = 0;
176
177// this mutex protects g_mapThreads
178static util::RWLockHandle *g_pThreadsLockHandle;
179
180// Threads map, so we can quickly map an RTTHREAD struct to a logger prefix
181static ThreadsMap g_mapThreads;
182
183/****************************************************************************
184 *
185 * Command line help
186 *
187 ****************************************************************************/
188
189static const RTGETOPTDEF g_aOptions[]
190 = {
191 { "--help", 'h', RTGETOPT_REQ_NOTHING }, /* for DisplayHelp() */
192#if defined(RT_OS_DARWIN) || defined(RT_OS_LINUX) || defined (RT_OS_SOLARIS) || defined(RT_OS_FREEBSD)
193 { "--background", 'b', RTGETOPT_REQ_NOTHING },
194#endif
195 { "--host", 'H', RTGETOPT_REQ_STRING },
196 { "--port", 'p', RTGETOPT_REQ_UINT32 },
197#ifdef WITH_OPENSSL
198 { "--ssl", 's', RTGETOPT_REQ_NOTHING },
199 { "--keyfile", 'K', RTGETOPT_REQ_STRING },
200 { "--passwordfile", 'a', RTGETOPT_REQ_STRING },
201 { "--cacert", 'c', RTGETOPT_REQ_STRING },
202 { "--capath", 'C', RTGETOPT_REQ_STRING },
203 { "--dhfile", 'D', RTGETOPT_REQ_STRING },
204 { "--randfile", 'r', RTGETOPT_REQ_STRING },
205#endif /* WITH_OPENSSL */
206 { "--timeout", 't', RTGETOPT_REQ_UINT32 },
207 { "--check-interval", 'i', RTGETOPT_REQ_UINT32 },
208 { "--threads", 'T', RTGETOPT_REQ_UINT32 },
209 { "--keepalive", 'k', RTGETOPT_REQ_UINT32 },
210 { "--authentication", 'A', RTGETOPT_REQ_STRING },
211 { "--verbose", 'v', RTGETOPT_REQ_NOTHING },
212 { "--pidfile", 'P', RTGETOPT_REQ_STRING },
213 { "--logfile", 'F', RTGETOPT_REQ_STRING },
214 { "--logrotate", 'R', RTGETOPT_REQ_UINT32 },
215 { "--logsize", 'S', RTGETOPT_REQ_UINT64 },
216 { "--loginterval", 'I', RTGETOPT_REQ_UINT32 }
217 };
218
219static void DisplayHelp()
220{
221 RTStrmPrintf(g_pStdErr, "\nUsage: vboxwebsrv [options]\n\nSupported options (default values in brackets):\n");
222 for (unsigned i = 0;
223 i < RT_ELEMENTS(g_aOptions);
224 ++i)
225 {
226 std::string str(g_aOptions[i].pszLong);
227 str += ", -";
228 str += g_aOptions[i].iShort;
229 str += ":";
230
231 const char *pcszDescr = "";
232
233 switch (g_aOptions[i].iShort)
234 {
235 case 'h':
236 pcszDescr = "Print this help message and exit.";
237 break;
238
239#if defined(RT_OS_DARWIN) || defined(RT_OS_LINUX) || defined (RT_OS_SOLARIS) || defined(RT_OS_FREEBSD)
240 case 'b':
241 pcszDescr = "Run in background (daemon mode).";
242 break;
243#endif
244
245 case 'H':
246 pcszDescr = "The host to bind to (localhost).";
247 break;
248
249 case 'p':
250 pcszDescr = "The port to bind to (18083).";
251 break;
252
253#ifdef WITH_OPENSSL
254 case 's':
255 pcszDescr = "Enable SSL/TLS encryption.";
256 break;
257
258 case 'K':
259 pcszDescr = "Server key and certificate file, PEM format (\"\").";
260 break;
261
262 case 'a':
263 pcszDescr = "File name for password to server key (\"\").";
264 break;
265
266 case 'c':
267 pcszDescr = "CA certificate file, PEM format (\"\").";
268 break;
269
270 case 'C':
271 pcszDescr = "CA certificate path (\"\").";
272 break;
273
274 case 'D':
275 pcszDescr = "DH file name or DH key length in bits (\"\").";
276 break;
277
278 case 'r':
279 pcszDescr = "File containing seed for random number generator (\"\").";
280 break;
281#endif /* WITH_OPENSSL */
282
283 case 't':
284 pcszDescr = "Session timeout in seconds; 0 = disable timeouts (" DEFAULT_TIMEOUT_SECS_STRING ").";
285 break;
286
287 case 'T':
288 pcszDescr = "Maximum number of worker threads to run in parallel (100).";
289 break;
290
291 case 'k':
292 pcszDescr = "Maximum number of requests before a socket will be closed (100).";
293 break;
294
295 case 'A':
296 pcszDescr = "Authentication method for the webservice (\"\").";
297 break;
298
299 case 'i':
300 pcszDescr = "Frequency of timeout checks in seconds (5).";
301 break;
302
303 case 'v':
304 pcszDescr = "Be verbose.";
305 break;
306
307 case 'P':
308 pcszDescr = "Name of the PID file which is created when the daemon was started.";
309 break;
310
311 case 'F':
312 pcszDescr = "Name of file to write log to (no file).";
313 break;
314
315 case 'R':
316 pcszDescr = "Number of log files (0 disables log rotation).";
317 break;
318
319 case 'S':
320 pcszDescr = "Maximum size of a log file to trigger rotation (bytes).";
321 break;
322
323 case 'I':
324 pcszDescr = "Maximum time interval to trigger log rotation (seconds).";
325 break;
326 }
327
328 RTStrmPrintf(g_pStdErr, "%-23s%s\n", str.c_str(), pcszDescr);
329 }
330}
331
332/****************************************************************************
333 *
334 * SoapQ, SoapThread (multithreading)
335 *
336 ****************************************************************************/
337
338class SoapQ;
339
340class SoapThread
341{
342public:
343 /**
344 * Constructor. Creates the new thread and makes it call process() for processing the queue.
345 * @param u Thread number. (So we can count from 1 and be readable.)
346 * @param q SoapQ instance which has the queue to process.
347 * @param soap struct soap instance from main() which we copy here.
348 */
349 SoapThread(size_t u,
350 SoapQ &q,
351 const struct soap *soap)
352 : m_u(u),
353 m_strThread(com::Utf8StrFmt("SQW%02d", m_u)),
354 m_pQ(&q)
355 {
356 // make a copy of the soap struct for the new thread
357 m_soap = soap_copy(soap);
358 m_soap->fget = fnHttpGet;
359
360 /* The soap.max_keep_alive value can be set to the maximum keep-alive calls allowed,
361 * which is important to avoid a client from holding a thread indefinitely.
362 * http://www.cs.fsu.edu/~engelen/soapdoc2.html#sec:keepalive
363 *
364 * Strings with 8-bit content can hold ASCII (default) or UTF8. The latter is
365 * possible by enabling the SOAP_C_UTFSTRING flag.
366 */
367 soap_set_omode(m_soap, SOAP_IO_KEEPALIVE | SOAP_C_UTFSTRING);
368 soap_set_imode(m_soap, SOAP_IO_KEEPALIVE | SOAP_C_UTFSTRING);
369 m_soap->max_keep_alive = g_cMaxKeepAlive;
370
371 int rc = RTThreadCreate(&m_pThread,
372 fntWrapper,
373 this, // pvUser
374 0, // cbStack
375 RTTHREADTYPE_MAIN_HEAVY_WORKER,
376 0,
377 m_strThread.c_str());
378 if (RT_FAILURE(rc))
379 {
380 RTMsgError("Cannot start worker thread %d: %Rrc\n", u, rc);
381 exit(1);
382 }
383 }
384
385 void process();
386
387 static int fnHttpGet(struct soap *soap)
388 {
389 char *s = strchr(soap->path, '?');
390 if (!s || strcmp(s, "?wsdl"))
391 return SOAP_GET_METHOD;
392 soap_response(soap, SOAP_HTML);
393 soap_send_raw(soap, (const char *)g_abVBoxWebWSDL, g_cbVBoxWebWSDL);
394 soap_end_send(soap);
395 return SOAP_OK;
396 }
397
398 /**
399 * Static function that can be passed to RTThreadCreate and that calls
400 * process() on the SoapThread instance passed as the thread parameter.
401 * @param pThread
402 * @param pvThread
403 * @return
404 */
405 static DECLCALLBACK(int) fntWrapper(RTTHREAD pThread, void *pvThread)
406 {
407 SoapThread *pst = (SoapThread*)pvThread;
408 pst->process();
409 return 0;
410 }
411
412 size_t m_u; // thread number
413 com::Utf8Str m_strThread; // thread name ("SoapQWrkXX")
414 SoapQ *m_pQ; // the single SOAP queue that all the threads service
415 struct soap *m_soap; // copy of the soap structure for this thread (from soap_copy())
416 RTTHREAD m_pThread; // IPRT thread struct for this thread
417};
418
419/**
420 * SOAP queue encapsulation. There is only one instance of this, to
421 * which add() adds a queue item (called on the main thread),
422 * and from which get() fetch items, called from each queue thread.
423 */
424class SoapQ
425{
426public:
427
428 /**
429 * Constructor. Creates the soap queue.
430 * @param pSoap
431 */
432 SoapQ(const struct soap *pSoap)
433 : m_soap(pSoap),
434 m_mutex(util::LOCKCLASS_OBJECTSTATE), // lowest lock order, no other may be held while this is held
435 m_cIdleThreads(0)
436 {
437 RTSemEventMultiCreate(&m_event);
438 }
439
440 ~SoapQ()
441 {
442 /* Tell the threads to terminate. */
443 RTSemEventMultiSignal(m_event);
444 {
445 util::AutoWriteLock qlock(m_mutex COMMA_LOCKVAL_SRC_POS);
446 int i = 0;
447 while (m_llAllThreads.size() && i++ <= 30)
448 {
449 qlock.release();
450 RTThreadSleep(1000);
451 RTSemEventMultiSignal(m_event);
452 qlock.acquire();
453 }
454 LogRel(("ending queue processing (%d out of %d threads idle)\n", m_cIdleThreads, m_llAllThreads.size()));
455 }
456
457 RTSemEventMultiDestroy(m_event);
458 }
459
460 /**
461 * Adds the given socket to the SOAP queue and posts the
462 * member event sem to wake up the workers. Called on the main thread
463 * whenever a socket has work to do. Creates a new SOAP thread on the
464 * first call or when all existing threads are busy.
465 * @param s Socket from soap_accept() which has work to do.
466 */
467 size_t add(SOAP_SOCKET s)
468 {
469 size_t cItems;
470 util::AutoWriteLock qlock(m_mutex COMMA_LOCKVAL_SRC_POS);
471
472 // if no threads have yet been created, or if all threads are busy,
473 // create a new SOAP thread
474 if ( !m_cIdleThreads
475 // but only if we're not exceeding the global maximum (default is 100)
476 && (m_llAllThreads.size() < g_cMaxWorkerThreads)
477 )
478 {
479 SoapThread *pst = new SoapThread(m_llAllThreads.size() + 1,
480 *this,
481 m_soap);
482 m_llAllThreads.push_back(pst);
483 util::AutoWriteLock thrLock(g_pThreadsLockHandle COMMA_LOCKVAL_SRC_POS);
484 g_mapThreads[pst->m_pThread] = com::Utf8StrFmt("[%3u]", pst->m_u);
485 ++m_cIdleThreads;
486 }
487
488 // enqueue the socket of this connection and post eventsem so that
489 // one of the threads (possibly the one just created) can pick it up
490 m_llSocketsQ.push_back(s);
491 cItems = m_llSocketsQ.size();
492 qlock.release();
493
494 // unblock one of the worker threads
495 RTSemEventMultiSignal(m_event);
496
497 return cItems;
498 }
499
500 /**
501 * Blocks the current thread until work comes in; then returns
502 * the SOAP socket which has work to do. This reduces m_cIdleThreads
503 * by one, and the caller MUST call done() when it's done processing.
504 * Called from the worker threads.
505 * @param cIdleThreads out: no. of threads which are currently idle (not counting the caller)
506 * @param cThreads out: total no. of SOAP threads running
507 * @return
508 */
509 SOAP_SOCKET get(size_t &cIdleThreads, size_t &cThreads)
510 {
511 while (g_fKeepRunning)
512 {
513 // wait for something to happen
514 RTSemEventMultiWait(m_event, RT_INDEFINITE_WAIT);
515
516 if (!g_fKeepRunning)
517 break;
518
519 util::AutoWriteLock qlock(m_mutex COMMA_LOCKVAL_SRC_POS);
520 if (!m_llSocketsQ.empty())
521 {
522 SOAP_SOCKET socket = m_llSocketsQ.front();
523 m_llSocketsQ.pop_front();
524 cIdleThreads = --m_cIdleThreads;
525 cThreads = m_llAllThreads.size();
526
527 // reset the multi event only if the queue is now empty; otherwise
528 // another thread will also wake up when we release the mutex and
529 // process another one
530 if (m_llSocketsQ.empty())
531 RTSemEventMultiReset(m_event);
532
533 qlock.release();
534
535 return socket;
536 }
537
538 // nothing to do: keep looping
539 }
540 return SOAP_INVALID_SOCKET;
541 }
542
543 /**
544 * To be called by a worker thread after fetching an item from the
545 * queue via get() and having finished its lengthy processing.
546 */
547 void done()
548 {
549 util::AutoWriteLock qlock(m_mutex COMMA_LOCKVAL_SRC_POS);
550 ++m_cIdleThreads;
551 }
552
553 /**
554 * To be called by a worker thread when signing off, i.e. no longer
555 * willing to process requests.
556 */
557 void signoff(SoapThread *th)
558 {
559 {
560 util::AutoWriteLock thrLock(g_pThreadsLockHandle COMMA_LOCKVAL_SRC_POS);
561 size_t c = g_mapThreads.erase(th->m_pThread);
562 AssertReturnVoid(c == 1);
563 }
564 {
565 util::AutoWriteLock qlock(m_mutex COMMA_LOCKVAL_SRC_POS);
566 m_llAllThreads.remove(th);
567 --m_cIdleThreads;
568 }
569 }
570
571 const struct soap *m_soap; // soap structure created by main(), passed to constructor
572
573 util::WriteLockHandle m_mutex;
574 RTSEMEVENTMULTI m_event; // posted by add(), blocked on by get()
575
576 std::list<SoapThread*> m_llAllThreads; // all the threads created by the constructor
577 size_t m_cIdleThreads; // threads which are currently idle (statistics)
578
579 // A std::list abused as a queue; this contains the actual jobs to do,
580 // each int being a socket from soap_accept()
581 std::list<SOAP_SOCKET> m_llSocketsQ;
582};
583
584/**
585 * Thread function for each of the SOAP queue worker threads. This keeps
586 * running, blocks on the event semaphore in SoapThread.SoapQ and picks
587 * up a socket from the queue therein, which has been put there by
588 * beginProcessing().
589 */
590void SoapThread::process()
591{
592 LogRel(("New SOAP thread started\n"));
593
594 while (g_fKeepRunning)
595 {
596 // wait for a socket to arrive on the queue
597 size_t cIdleThreads = 0, cThreads = 0;
598 m_soap->socket = m_pQ->get(cIdleThreads, cThreads);
599
600 if (!soap_valid_socket(m_soap->socket))
601 continue;
602
603 LogRel(("Processing connection from IP=%RTnaipv4 socket=%d (%d out of %d threads idle)\n",
604 RT_H2N_U32(m_soap->ip), m_soap->socket, cIdleThreads, cThreads));
605
606 // Ensure that we don't get stuck indefinitely for connections using
607 // keepalive, otherwise stale connections tie up worker threads.
608 m_soap->send_timeout = 60;
609 m_soap->recv_timeout = 60;
610 // process the request; this goes into the COM code in methodmaps.cpp
611 do {
612#ifdef WITH_OPENSSL
613 if (g_fSSL && soap_ssl_accept(m_soap))
614 {
615 WebLogSoapError(m_soap);
616 break;
617 }
618#endif /* WITH_OPENSSL */
619 soap_serve(m_soap);
620 } while (0);
621
622 soap_destroy(m_soap); // clean up class instances
623 soap_end(m_soap); // clean up everything and close socket
624
625 // tell the queue we're idle again
626 m_pQ->done();
627 }
628 m_pQ->signoff(this);
629}
630
631/****************************************************************************
632 *
633 * VirtualBoxClient event listener
634 *
635 ****************************************************************************/
636
637class VirtualBoxClientEventListener
638{
639public:
640 VirtualBoxClientEventListener()
641 {
642 }
643
644 virtual ~VirtualBoxClientEventListener()
645 {
646 }
647
648 HRESULT init()
649 {
650 return S_OK;
651 }
652
653 void uninit()
654 {
655 }
656
657
658 STDMETHOD(HandleEvent)(VBoxEventType_T aType, IEvent *aEvent)
659 {
660 switch (aType)
661 {
662 case VBoxEventType_OnVBoxSVCAvailabilityChanged:
663 {
664 ComPtr<IVBoxSVCAvailabilityChangedEvent> pVSACEv = aEvent;
665 Assert(pVSACEv);
666 BOOL fAvailable = FALSE;
667 pVSACEv->COMGETTER(Available)(&fAvailable);
668 if (!fAvailable)
669 {
670 LogRel(("VBoxSVC became unavailable\n"));
671 {
672 util::AutoWriteLock vlock(g_pVirtualBoxLockHandle COMMA_LOCKVAL_SRC_POS);
673 g_pVirtualBox.setNull();
674 }
675 {
676 // we're messing with websessions, so lock them
677 util::AutoWriteLock lock(g_pWebsessionsLockHandle COMMA_LOCKVAL_SRC_POS);
678 WEBDEBUG(("SVC unavailable: deleting %d websessions\n", g_mapWebsessions.size()));
679
680 WebsessionsMapIterator it = g_mapWebsessions.begin(),
681 itEnd = g_mapWebsessions.end();
682 while (it != itEnd)
683 {
684 WebServiceSession *pWebsession = it->second;
685 WEBDEBUG(("SVC unavailable: websession %#llx stale, deleting\n", pWebsession->getID()));
686 delete pWebsession;
687 it = g_mapWebsessions.begin();
688 }
689 }
690 }
691 else
692 {
693 LogRel(("VBoxSVC became available\n"));
694 util::AutoWriteLock vlock(g_pVirtualBoxLockHandle COMMA_LOCKVAL_SRC_POS);
695 HRESULT hrc = g_pVirtualBoxClient->COMGETTER(VirtualBox)(g_pVirtualBox.asOutParam());
696 AssertComRC(hrc);
697 }
698 break;
699 }
700 default:
701 AssertFailed();
702 }
703
704 return S_OK;
705 }
706
707private:
708};
709
710typedef ListenerImpl<VirtualBoxClientEventListener> VirtualBoxClientEventListenerImpl;
711
712VBOX_LISTENER_DECLARE(VirtualBoxClientEventListenerImpl)
713
714/**
715 * Helper for printing SOAP error messages.
716 * @param soap
717 */
718/*static*/
719void WebLogSoapError(struct soap *soap)
720{
721 if (soap_check_state(soap))
722 {
723 LogRel(("Error: soap struct not initialized\n"));
724 return;
725 }
726
727 const char *pcszFaultString = *soap_faultstring(soap);
728 const char **ppcszDetail = soap_faultcode(soap);
729 LogRel(("#### SOAP FAULT: %s [%s]\n",
730 pcszFaultString ? pcszFaultString : "[no fault string available]",
731 (ppcszDetail && *ppcszDetail) ? *ppcszDetail : "no details available"));
732}
733
734/**
735 * Helper for decoding AuthResult.
736 * @param result AuthResult
737 */
738static const char * decodeAuthResult(AuthResult result)
739{
740 switch (result)
741 {
742 case AuthResultAccessDenied: return "access DENIED";
743 case AuthResultAccessGranted: return "access granted";
744 case AuthResultDelegateToGuest: return "delegated to guest";
745 default: return "unknown AuthResult";
746 }
747}
748
749#ifdef WITH_OPENSSL
750/****************************************************************************
751 *
752 * OpenSSL convenience functions for multithread support
753 *
754 ****************************************************************************/
755
756static RTCRITSECT *g_pSSLMutexes = NULL;
757
758struct CRYPTO_dynlock_value
759{
760 RTCRITSECT mutex;
761};
762
763static unsigned long CRYPTO_id_function()
764{
765 return (unsigned long)RTThreadNativeSelf();
766}
767
768static void CRYPTO_locking_function(int mode, int n, const char * /*file*/, int /*line*/)
769{
770 if (mode & CRYPTO_LOCK)
771 RTCritSectEnter(&g_pSSLMutexes[n]);
772 else
773 RTCritSectLeave(&g_pSSLMutexes[n]);
774}
775
776static struct CRYPTO_dynlock_value *CRYPTO_dyn_create_function(const char * /*file*/, int /*line*/)
777{
778 static uint32_t s_iCritSectDynlock = 0;
779 struct CRYPTO_dynlock_value *value = (struct CRYPTO_dynlock_value *)RTMemAlloc(sizeof(struct CRYPTO_dynlock_value));
780 if (value)
781 RTCritSectInitEx(&value->mutex, RTCRITSECT_FLAGS_NO_LOCK_VAL,
782 NIL_RTLOCKVALCLASS, RTLOCKVAL_SUB_CLASS_NONE,
783 "openssl-dyn-%u", ASMAtomicIncU32(&s_iCritSectDynlock) - 1);
784
785 return value;
786}
787
788static void CRYPTO_dyn_lock_function(int mode, struct CRYPTO_dynlock_value *value, const char * /*file*/, int /*line*/)
789{
790 if (mode & CRYPTO_LOCK)
791 RTCritSectEnter(&value->mutex);
792 else
793 RTCritSectLeave(&value->mutex);
794}
795
796static void CRYPTO_dyn_destroy_function(struct CRYPTO_dynlock_value *value, const char * /*file*/, int /*line*/)
797{
798 if (value)
799 {
800 RTCritSectDelete(&value->mutex);
801 free(value);
802 }
803}
804
805static int CRYPTO_thread_setup()
806{
807 int num_locks = CRYPTO_num_locks();
808 g_pSSLMutexes = (RTCRITSECT *)RTMemAlloc(num_locks * sizeof(RTCRITSECT));
809 if (!g_pSSLMutexes)
810 return SOAP_EOM;
811
812 for (int i = 0; i < num_locks; i++)
813 {
814 int rc = RTCritSectInitEx(&g_pSSLMutexes[i], RTCRITSECT_FLAGS_NO_LOCK_VAL,
815 NIL_RTLOCKVALCLASS, RTLOCKVAL_SUB_CLASS_NONE,
816 "openssl-%d", i);
817 if (RT_FAILURE(rc))
818 {
819 for ( ; i >= 0; i--)
820 RTCritSectDelete(&g_pSSLMutexes[i]);
821 RTMemFree(g_pSSLMutexes);
822 g_pSSLMutexes = NULL;
823 return SOAP_EOM;
824 }
825 }
826
827 CRYPTO_set_id_callback(CRYPTO_id_function);
828 CRYPTO_set_locking_callback(CRYPTO_locking_function);
829 CRYPTO_set_dynlock_create_callback(CRYPTO_dyn_create_function);
830 CRYPTO_set_dynlock_lock_callback(CRYPTO_dyn_lock_function);
831 CRYPTO_set_dynlock_destroy_callback(CRYPTO_dyn_destroy_function);
832
833 return SOAP_OK;
834}
835
836static void CRYPTO_thread_cleanup()
837{
838 if (!g_pSSLMutexes)
839 return;
840
841 CRYPTO_set_id_callback(NULL);
842 CRYPTO_set_locking_callback(NULL);
843 CRYPTO_set_dynlock_create_callback(NULL);
844 CRYPTO_set_dynlock_lock_callback(NULL);
845 CRYPTO_set_dynlock_destroy_callback(NULL);
846
847 int num_locks = CRYPTO_num_locks();
848 for (int i = 0; i < num_locks; i++)
849 RTCritSectDelete(&g_pSSLMutexes[i]);
850
851 RTMemFree(g_pSSLMutexes);
852 g_pSSLMutexes = NULL;
853}
854#endif /* WITH_OPENSSL */
855
856/****************************************************************************
857 *
858 * SOAP queue pumper thread
859 *
860 ****************************************************************************/
861
862static void doQueuesLoop()
863{
864#ifdef WITH_OPENSSL
865 if (g_fSSL && CRYPTO_thread_setup())
866 {
867 LogRel(("Failed to set up OpenSSL thread mutex!"));
868 exit(RTEXITCODE_FAILURE);
869 }
870#endif /* WITH_OPENSSL */
871
872 // set up gSOAP
873 struct soap soap;
874 soap_init(&soap);
875
876#ifdef WITH_OPENSSL
877 if (g_fSSL && soap_ssl_server_context(&soap, SOAP_SSL_REQUIRE_SERVER_AUTHENTICATION | SOAP_TLSv1, g_pcszKeyFile,
878 g_pcszPassword, g_pcszCACert, g_pcszCAPath,
879 g_pcszDHFile, g_pcszRandFile, g_pcszSID))
880 {
881 WebLogSoapError(&soap);
882 exit(RTEXITCODE_FAILURE);
883 }
884#endif /* WITH_OPENSSL */
885
886 soap.bind_flags |= SO_REUSEADDR;
887 // avoid EADDRINUSE on bind()
888
889 SOAP_SOCKET m, s; // master and slave sockets
890 m = soap_bind(&soap,
891 g_pcszBindToHost ? g_pcszBindToHost : "localhost", // safe default host
892 g_uBindToPort, // port
893 g_uBacklog); // backlog = max queue size for requests
894 if (m < 0)
895 WebLogSoapError(&soap);
896 else
897 {
898 LogRel(("Socket connection successful: host = %s, port = %u, %smaster socket = %d\n",
899 (g_pcszBindToHost) ? g_pcszBindToHost : "default (localhost)",
900 g_uBindToPort,
901#ifdef WITH_OPENSSL
902 g_fSSL ? "SSL, " : "",
903#else /* !WITH_OPENSSL */
904 "",
905#endif /*!WITH_OPENSSL */
906 m));
907
908 // initialize thread queue, mutex and eventsem
909 g_pSoapQ = new SoapQ(&soap);
910
911 for (uint64_t i = 1;
912 g_fKeepRunning;
913 i++)
914 {
915 // call gSOAP to handle incoming SOAP connection
916 soap.accept_timeout = 10;
917 s = soap_accept(&soap);
918 if (!soap_valid_socket(s))
919 {
920 if (soap.errnum)
921 WebLogSoapError(&soap);
922 continue;
923 }
924
925 // add the socket to the queue and tell worker threads to
926 // pick up the job
927 size_t cItemsOnQ = g_pSoapQ->add(s);
928 LogRel(("Request %llu on socket %d queued for processing (%d items on Q)\n", i, s, cItemsOnQ));
929 }
930
931 delete g_pSoapQ;
932 g_pSoapQ = NULL;
933
934 LogRel(("ending SOAP request handling\n"));
935
936 delete g_pSoapQ;
937 g_pSoapQ = NULL;
938
939 }
940 soap_done(&soap); // close master socket and detach environment
941
942#ifdef WITH_OPENSSL
943 if (g_fSSL)
944 CRYPTO_thread_cleanup();
945#endif /* WITH_OPENSSL */
946}
947
948/**
949 * Thread function for the "queue pumper" thread started from main(). This implements
950 * the loop that takes SOAP calls from HTTP and serves them by handing sockets to the
951 * SOAP queue worker threads.
952 */
953static DECLCALLBACK(int) fntQPumper(RTTHREAD ThreadSelf, void *pvUser)
954{
955 // store a log prefix for this thread
956 util::AutoWriteLock thrLock(g_pThreadsLockHandle COMMA_LOCKVAL_SRC_POS);
957 g_mapThreads[RTThreadSelf()] = "[ P ]";
958 thrLock.release();
959
960 doQueuesLoop();
961
962 thrLock.acquire();
963 g_mapThreads.erase(RTThreadSelf());
964 return 0;
965}
966
967#ifdef RT_OS_WINDOWS
968// Required for ATL
969static CComModule _Module;
970
971/**
972 * "Signal" handler for cleanly terminating the event loop.
973 */
974static BOOL WINAPI websrvSignalHandler(DWORD dwCtrlType)
975{
976 bool fEventHandled = FALSE;
977 switch (dwCtrlType)
978 {
979 /* User pressed CTRL+C or CTRL+BREAK or an external event was sent
980 * via GenerateConsoleCtrlEvent(). */
981 case CTRL_BREAK_EVENT:
982 case CTRL_CLOSE_EVENT:
983 case CTRL_C_EVENT:
984 case CTRL_LOGOFF_EVENT:
985 case CTRL_SHUTDOWN_EVENT:
986 ASMAtomicWriteBool(&g_fKeepRunning, false);
987 fEventHandled = TRUE;
988 break;
989 default:
990 break;
991 }
992 return fEventHandled;
993}
994#else
995class ForceQuitEvent : public com::NativeEvent
996{
997 void *handler()
998 {
999 LogFlowFunc(("\n"));
1000
1001 ASMAtomicWriteBool(&g_fKeepRunning, false);
1002
1003 return NULL;
1004 }
1005};
1006
1007/**
1008 * Signal handler for cleanly terminating the event loop.
1009 */
1010static void websrvSignalHandler(int iSignal)
1011{
1012 NOREF(iSignal);
1013 com::NativeEventQueue *pQ = com::NativeEventQueue::getMainEventQueue();
1014 pQ->postEvent(new ForceQuitEvent());
1015}
1016#endif
1017
1018
1019/**
1020 * Start up the webservice server. This keeps running and waits
1021 * for incoming SOAP connections; for each request that comes in,
1022 * it calls method implementation code, most of it in the generated
1023 * code in methodmaps.cpp.
1024 *
1025 * @param argc
1026 * @param argv[]
1027 * @return
1028 */
1029int main(int argc, char *argv[])
1030{
1031 // initialize runtime
1032 int rc = RTR3InitExe(argc, &argv, 0);
1033 if (RT_FAILURE(rc))
1034 return RTMsgInitFailure(rc);
1035
1036 // store a log prefix for this thread
1037 g_mapThreads[RTThreadSelf()] = "[M ]";
1038
1039 RTStrmPrintf(g_pStdErr, VBOX_PRODUCT " web service Version " VBOX_VERSION_STRING "\n"
1040 "(C) 2007-" VBOX_C_YEAR " " VBOX_VENDOR "\n"
1041 "All rights reserved.\n");
1042
1043 int c;
1044 const char *pszLogFile = NULL;
1045 const char *pszPidFile = NULL;
1046 RTGETOPTUNION ValueUnion;
1047 RTGETOPTSTATE GetState;
1048 RTGetOptInit(&GetState, argc, argv, g_aOptions, RT_ELEMENTS(g_aOptions), 1, 0 /*fFlags*/);
1049 while ((c = RTGetOpt(&GetState, &ValueUnion)))
1050 {
1051 switch (c)
1052 {
1053 case 'H':
1054 if (!ValueUnion.psz || !*ValueUnion.psz)
1055 {
1056 /* Normalize NULL/empty string to NULL, which will be
1057 * interpreted as "localhost" below. */
1058 g_pcszBindToHost = NULL;
1059 }
1060 else
1061 g_pcszBindToHost = ValueUnion.psz;
1062 break;
1063
1064 case 'p':
1065 g_uBindToPort = ValueUnion.u32;
1066 break;
1067
1068#ifdef WITH_OPENSSL
1069 case 's':
1070 g_fSSL = true;
1071 break;
1072
1073 case 'K':
1074 g_pcszKeyFile = ValueUnion.psz;
1075 break;
1076
1077 case 'a':
1078 if (ValueUnion.psz[0] == '\0')
1079 g_pcszPassword = NULL;
1080 else
1081 {
1082 PRTSTREAM StrmIn;
1083 if (!strcmp(ValueUnion.psz, "-"))
1084 StrmIn = g_pStdIn;
1085 else
1086 {
1087 int vrc = RTStrmOpen(ValueUnion.psz, "r", &StrmIn);
1088 if (RT_FAILURE(vrc))
1089 return RTMsgErrorExit(RTEXITCODE_FAILURE, "failed to open password file (%s, %Rrc)", ValueUnion.psz, vrc);
1090 }
1091 char szPasswd[512];
1092 int vrc = RTStrmGetLine(StrmIn, szPasswd, sizeof(szPasswd));
1093 if (RT_FAILURE(vrc))
1094 return RTMsgErrorExit(RTEXITCODE_FAILURE, "failed to read password (%s, %Rrc)", ValueUnion.psz, vrc);
1095 g_pcszPassword = RTStrDup(szPasswd);
1096 memset(szPasswd, '\0', sizeof(szPasswd));
1097 if (StrmIn != g_pStdIn)
1098 RTStrmClose(StrmIn);
1099 }
1100 break;
1101
1102 case 'c':
1103 g_pcszCACert = ValueUnion.psz;
1104 break;
1105
1106 case 'C':
1107 g_pcszCAPath = ValueUnion.psz;
1108 break;
1109
1110 case 'D':
1111 g_pcszDHFile = ValueUnion.psz;
1112 break;
1113
1114 case 'r':
1115 g_pcszRandFile = ValueUnion.psz;
1116 break;
1117#endif /* WITH_OPENSSL */
1118
1119 case 't':
1120 g_iWatchdogTimeoutSecs = ValueUnion.u32;
1121 break;
1122
1123 case 'i':
1124 g_iWatchdogCheckInterval = ValueUnion.u32;
1125 break;
1126
1127 case 'F':
1128 pszLogFile = ValueUnion.psz;
1129 break;
1130
1131 case 'R':
1132 g_cHistory = ValueUnion.u32;
1133 break;
1134
1135 case 'S':
1136 g_uHistoryFileSize = ValueUnion.u64;
1137 break;
1138
1139 case 'I':
1140 g_uHistoryFileTime = ValueUnion.u32;
1141 break;
1142
1143 case 'P':
1144 pszPidFile = ValueUnion.psz;
1145 break;
1146
1147 case 'T':
1148 g_cMaxWorkerThreads = ValueUnion.u32;
1149 break;
1150
1151 case 'k':
1152 g_cMaxKeepAlive = ValueUnion.u32;
1153 break;
1154
1155 case 'A':
1156 g_pcszAuthentication = ValueUnion.psz;
1157 break;
1158
1159 case 'h':
1160 DisplayHelp();
1161 return 0;
1162
1163 case 'v':
1164 g_fVerbose = true;
1165 break;
1166
1167#if defined(RT_OS_DARWIN) || defined(RT_OS_LINUX) || defined (RT_OS_SOLARIS) || defined(RT_OS_FREEBSD)
1168 case 'b':
1169 g_fDaemonize = true;
1170 break;
1171#endif
1172 case 'V':
1173 RTPrintf("%sr%s\n", RTBldCfgVersion(), RTBldCfgRevisionStr());
1174 return 0;
1175
1176 default:
1177 rc = RTGetOptPrintError(c, &ValueUnion);
1178 return rc;
1179 }
1180 }
1181
1182 /* create release logger, to stdout */
1183 char szError[RTPATH_MAX + 128];
1184 rc = com::VBoxLogRelCreate("web service", g_fDaemonize ? NULL : pszLogFile,
1185 RTLOGFLAGS_PREFIX_THREAD | RTLOGFLAGS_PREFIX_TIME_PROG,
1186 "all", "VBOXWEBSRV_RELEASE_LOG",
1187 RTLOGDEST_STDOUT, UINT32_MAX /* cMaxEntriesPerGroup */,
1188 g_cHistory, g_uHistoryFileTime, g_uHistoryFileSize,
1189 szError, sizeof(szError));
1190 if (RT_FAILURE(rc))
1191 return RTMsgErrorExit(RTEXITCODE_FAILURE, "failed to open release log (%s, %Rrc)", szError, rc);
1192
1193#if defined(RT_OS_DARWIN) || defined(RT_OS_LINUX) || defined (RT_OS_SOLARIS) || defined(RT_OS_FREEBSD)
1194 if (g_fDaemonize)
1195 {
1196 /* prepare release logging */
1197 char szLogFile[RTPATH_MAX];
1198
1199 if (!pszLogFile || !*pszLogFile)
1200 {
1201 rc = com::GetVBoxUserHomeDirectory(szLogFile, sizeof(szLogFile));
1202 if (RT_FAILURE(rc))
1203 return RTMsgErrorExit(RTEXITCODE_FAILURE, "could not get base directory for logging: %Rrc", rc);
1204 rc = RTPathAppend(szLogFile, sizeof(szLogFile), "vboxwebsrv.log");
1205 if (RT_FAILURE(rc))
1206 return RTMsgErrorExit(RTEXITCODE_FAILURE, "could not construct logging path: %Rrc", rc);
1207 pszLogFile = szLogFile;
1208 }
1209
1210 rc = RTProcDaemonizeUsingFork(false /* fNoChDir */, false /* fNoClose */, pszPidFile);
1211 if (RT_FAILURE(rc))
1212 return RTMsgErrorExit(RTEXITCODE_FAILURE, "failed to daemonize, rc=%Rrc. exiting.", rc);
1213
1214 /* create release logger, to file */
1215 rc = com::VBoxLogRelCreate("web service", pszLogFile,
1216 RTLOGFLAGS_PREFIX_THREAD | RTLOGFLAGS_PREFIX_TIME_PROG,
1217 "all", "VBOXWEBSRV_RELEASE_LOG",
1218 RTLOGDEST_FILE, UINT32_MAX /* cMaxEntriesPerGroup */,
1219 g_cHistory, g_uHistoryFileTime, g_uHistoryFileSize,
1220 szError, sizeof(szError));
1221 if (RT_FAILURE(rc))
1222 return RTMsgErrorExit(RTEXITCODE_FAILURE, "failed to open release log (%s, %Rrc)", szError, rc);
1223 }
1224#endif
1225
1226 // initialize SOAP SSL support if enabled
1227#ifdef WITH_OPENSSL
1228 if (g_fSSL)
1229 soap_ssl_init();
1230#endif /* WITH_OPENSSL */
1231
1232 // initialize COM/XPCOM
1233 HRESULT hrc = com::Initialize();
1234#ifdef VBOX_WITH_XPCOM
1235 if (hrc == NS_ERROR_FILE_ACCESS_DENIED)
1236 {
1237 char szHome[RTPATH_MAX] = "";
1238 com::GetVBoxUserHomeDirectory(szHome, sizeof(szHome));
1239 return RTMsgErrorExit(RTEXITCODE_FAILURE,
1240 "Failed to initialize COM because the global settings directory '%s' is not accessible!", szHome);
1241 }
1242#endif
1243 if (FAILED(hrc))
1244 return RTMsgErrorExit(RTEXITCODE_FAILURE, "failed to initialize COM! hrc=%Rhrc\n", hrc);
1245
1246 hrc = g_pVirtualBoxClient.createInprocObject(CLSID_VirtualBoxClient);
1247 if (FAILED(hrc))
1248 {
1249 RTMsgError("failed to create the VirtualBoxClient object!");
1250 com::ErrorInfo info;
1251 if (!info.isFullAvailable() && !info.isBasicAvailable())
1252 {
1253 com::GluePrintRCMessage(hrc);
1254 RTMsgError("Most likely, the VirtualBox COM server is not running or failed to start.");
1255 }
1256 else
1257 com::GluePrintErrorInfo(info);
1258 return RTEXITCODE_FAILURE;
1259 }
1260
1261 hrc = g_pVirtualBoxClient->COMGETTER(VirtualBox)(g_pVirtualBox.asOutParam());
1262 if (FAILED(hrc))
1263 {
1264 RTMsgError("Failed to get VirtualBox object (rc=%Rhrc)!", hrc);
1265 return RTEXITCODE_FAILURE;
1266 }
1267
1268 // set the authentication method if requested
1269 if (g_pVirtualBox && g_pcszAuthentication && g_pcszAuthentication[0])
1270 {
1271 ComPtr<ISystemProperties> pSystemProperties;
1272 g_pVirtualBox->COMGETTER(SystemProperties)(pSystemProperties.asOutParam());
1273 if (pSystemProperties)
1274 pSystemProperties->COMSETTER(WebServiceAuthLibrary)(com::Bstr(g_pcszAuthentication).raw());
1275 }
1276
1277 /* VirtualBoxClient events registration. */
1278 ComPtr<IEventListener> vboxClientListener;
1279 {
1280 ComPtr<IEventSource> pES;
1281 CHECK_ERROR(g_pVirtualBoxClient, COMGETTER(EventSource)(pES.asOutParam()));
1282 ComObjPtr<VirtualBoxClientEventListenerImpl> clientListener;
1283 clientListener.createObject();
1284 clientListener->init(new VirtualBoxClientEventListener());
1285 vboxClientListener = clientListener;
1286 com::SafeArray<VBoxEventType_T> eventTypes;
1287 eventTypes.push_back(VBoxEventType_OnVBoxSVCAvailabilityChanged);
1288 CHECK_ERROR(pES, RegisterListener(vboxClientListener, ComSafeArrayAsInParam(eventTypes), true));
1289 }
1290
1291 // create the global mutexes
1292 g_pAuthLibLockHandle = new util::WriteLockHandle(util::LOCKCLASS_WEBSERVICE);
1293 g_pVirtualBoxLockHandle = new util::RWLockHandle(util::LOCKCLASS_WEBSERVICE);
1294 g_pWebsessionsLockHandle = new util::WriteLockHandle(util::LOCKCLASS_WEBSERVICE);
1295 g_pThreadsLockHandle = new util::RWLockHandle(util::LOCKCLASS_OBJECTSTATE);
1296
1297 // SOAP queue pumper thread
1298 RTTHREAD threadQPumper;
1299 rc = RTThreadCreate(&threadQPumper,
1300 fntQPumper,
1301 NULL, // pvUser
1302 0, // cbStack (default)
1303 RTTHREADTYPE_MAIN_WORKER,
1304 RTTHREADFLAGS_WAITABLE,
1305 "SQPmp");
1306 if (RT_FAILURE(rc))
1307 return RTMsgErrorExit(RTEXITCODE_FAILURE, "Cannot start SOAP queue pumper thread: %Rrc", rc);
1308
1309 // watchdog thread
1310 RTTHREAD threadWatchdog = NIL_RTTHREAD;
1311 if (g_iWatchdogTimeoutSecs > 0)
1312 {
1313 // start our watchdog thread
1314 rc = RTThreadCreate(&threadWatchdog,
1315 fntWatchdog,
1316 NULL,
1317 0,
1318 RTTHREADTYPE_MAIN_WORKER,
1319 RTTHREADFLAGS_WAITABLE,
1320 "Watchdog");
1321 if (RT_FAILURE(rc))
1322 return RTMsgErrorExit(RTEXITCODE_FAILURE, "Cannot start watchdog thread: %Rrc", rc);
1323 }
1324
1325#ifdef RT_OS_WINDOWS
1326 if (!SetConsoleCtrlHandler((PHANDLER_ROUTINE)websrvSignalHandler, TRUE /* Add handler */))
1327 {
1328 rc = RTErrConvertFromWin32(GetLastError());
1329 RTMsgError("Unable to install console control handler, rc=%Rrc\n", rc);
1330 }
1331#else
1332 signal(SIGINT, websrvSignalHandler);
1333# ifdef SIGBREAK
1334 signal(SIGBREAK, websrvSignalHandler);
1335# endif
1336#endif
1337
1338 com::NativeEventQueue *pQ = com::NativeEventQueue::getMainEventQueue();
1339 while (g_fKeepRunning)
1340 {
1341 // we have to process main event queue
1342 WEBDEBUG(("Pumping COM event queue\n"));
1343 rc = pQ->processEventQueue(RT_INDEFINITE_WAIT);
1344 if (RT_FAILURE(rc))
1345 RTMsgError("processEventQueue -> %Rrc", rc);
1346 }
1347
1348 LogRel(("requested termination, cleaning up\n"));
1349
1350#ifdef RT_OS_WINDOWS
1351 if (!SetConsoleCtrlHandler((PHANDLER_ROUTINE)websrvSignalHandler, FALSE /* Remove handler */))
1352 {
1353 rc = RTErrConvertFromWin32(GetLastError());
1354 RTMsgError("Unable to remove console control handler, rc=%Rrc\n", rc);
1355 }
1356#else
1357 signal(SIGINT, SIG_DFL);
1358# ifdef SIGBREAK
1359 signal(SIGBREAK, SIG_DFL);
1360# endif
1361#endif
1362
1363 RTThreadWait(threadQPumper, 30000, NULL);
1364 if (threadWatchdog != NIL_RTTHREAD)
1365 RTThreadWait(threadWatchdog, g_iWatchdogCheckInterval * 1000 + 10000, NULL);
1366
1367 /* VirtualBoxClient events unregistration. */
1368 if (vboxClientListener)
1369 {
1370 ComPtr<IEventSource> pES;
1371 CHECK_ERROR(g_pVirtualBoxClient, COMGETTER(EventSource)(pES.asOutParam()));
1372 if (!pES.isNull())
1373 CHECK_ERROR(pES, UnregisterListener(vboxClientListener));
1374 vboxClientListener.setNull();
1375 }
1376
1377 {
1378 util::AutoWriteLock vlock(g_pVirtualBoxLockHandle COMMA_LOCKVAL_SRC_POS);
1379 g_pVirtualBox.setNull();
1380 }
1381 {
1382 util::AutoWriteLock lock(g_pWebsessionsLockHandle COMMA_LOCKVAL_SRC_POS);
1383 WebsessionsMapIterator it = g_mapWebsessions.begin(),
1384 itEnd = g_mapWebsessions.end();
1385 while (it != itEnd)
1386 {
1387 WebServiceSession *pWebsession = it->second;
1388 WEBDEBUG(("SVC unavailable: websession %#llx stale, deleting\n", pWebsession->getID()));
1389 delete pWebsession;
1390 it = g_mapWebsessions.begin();
1391 }
1392 }
1393 g_pVirtualBoxClient.setNull();
1394
1395 com::Shutdown();
1396
1397 return 0;
1398}
1399
1400/****************************************************************************
1401 *
1402 * Watchdog thread
1403 *
1404 ****************************************************************************/
1405
1406/**
1407 * Watchdog thread, runs in the background while the webservice is alive.
1408 *
1409 * This gets started by main() and runs in the background to check all websessions
1410 * for whether they have been no requests in a configurable timeout period. In
1411 * that case, the websession is automatically logged off.
1412 */
1413static DECLCALLBACK(int) fntWatchdog(RTTHREAD ThreadSelf, void *pvUser)
1414{
1415 // store a log prefix for this thread
1416 util::AutoWriteLock thrLock(g_pThreadsLockHandle COMMA_LOCKVAL_SRC_POS);
1417 g_mapThreads[RTThreadSelf()] = "[W ]";
1418 thrLock.release();
1419
1420 WEBDEBUG(("Watchdog thread started\n"));
1421
1422 while (g_fKeepRunning)
1423 {
1424 WEBDEBUG(("Watchdog: sleeping %d seconds\n", g_iWatchdogCheckInterval));
1425 RTThreadSleep(g_iWatchdogCheckInterval * 1000);
1426
1427 time_t tNow;
1428 time(&tNow);
1429
1430 // we're messing with websessions, so lock them
1431 util::AutoWriteLock lock(g_pWebsessionsLockHandle COMMA_LOCKVAL_SRC_POS);
1432 WEBDEBUG(("Watchdog: checking %d websessions\n", g_mapWebsessions.size()));
1433
1434 WebsessionsMapIterator it = g_mapWebsessions.begin(),
1435 itEnd = g_mapWebsessions.end();
1436 while (it != itEnd)
1437 {
1438 WebServiceSession *pWebsession = it->second;
1439 WEBDEBUG(("Watchdog: tNow: %d, websession timestamp: %d\n", tNow, pWebsession->getLastObjectLookup()));
1440 if (tNow > pWebsession->getLastObjectLookup() + g_iWatchdogTimeoutSecs)
1441 {
1442 WEBDEBUG(("Watchdog: websession %#llx timed out, deleting\n", pWebsession->getID()));
1443 delete pWebsession;
1444 it = g_mapWebsessions.begin();
1445 }
1446 else
1447 ++it;
1448 }
1449
1450 // re-set the authentication method in case it has been changed
1451 if (g_pVirtualBox && g_pcszAuthentication && g_pcszAuthentication[0])
1452 {
1453 ComPtr<ISystemProperties> pSystemProperties;
1454 g_pVirtualBox->COMGETTER(SystemProperties)(pSystemProperties.asOutParam());
1455 if (pSystemProperties)
1456 pSystemProperties->COMSETTER(WebServiceAuthLibrary)(com::Bstr(g_pcszAuthentication).raw());
1457 }
1458 }
1459
1460 thrLock.acquire();
1461 g_mapThreads.erase(RTThreadSelf());
1462
1463 LogRel(("ending Watchdog thread\n"));
1464 return 0;
1465}
1466
1467/****************************************************************************
1468 *
1469 * SOAP exceptions
1470 *
1471 ****************************************************************************/
1472
1473/**
1474 * Helper function to raise a SOAP fault. Called by the other helper
1475 * functions, which raise specific SOAP faults.
1476 *
1477 * @param soap
1478 * @param str
1479 * @param extype
1480 * @param ex
1481 */
1482static void RaiseSoapFault(struct soap *soap,
1483 const char *pcsz,
1484 int extype,
1485 void *ex)
1486{
1487 // raise the fault
1488 soap_sender_fault(soap, pcsz, NULL);
1489
1490 struct SOAP_ENV__Detail *pDetail = (struct SOAP_ENV__Detail*)soap_malloc(soap, sizeof(struct SOAP_ENV__Detail));
1491
1492 // without the following, gSOAP crashes miserably when sending out the
1493 // data because it will try to serialize all fields (stupid documentation)
1494 memset(pDetail, 0, sizeof(struct SOAP_ENV__Detail));
1495
1496 // fill extended info depending on SOAP version
1497 if (soap->version == 2) // SOAP 1.2 is used
1498 {
1499 soap->fault->SOAP_ENV__Detail = pDetail;
1500 soap->fault->SOAP_ENV__Detail->__type = extype;
1501 soap->fault->SOAP_ENV__Detail->fault = ex;
1502 soap->fault->SOAP_ENV__Detail->__any = NULL; // no other XML data
1503 }
1504 else
1505 {
1506 soap->fault->detail = pDetail;
1507 soap->fault->detail->__type = extype;
1508 soap->fault->detail->fault = ex;
1509 soap->fault->detail->__any = NULL; // no other XML data
1510 }
1511}
1512
1513/**
1514 * Raises a SOAP fault that signals that an invalid object was passed.
1515 *
1516 * @param soap
1517 * @param obj
1518 */
1519void RaiseSoapInvalidObjectFault(struct soap *soap,
1520 WSDLT_ID obj)
1521{
1522 _vbox__InvalidObjectFault *ex = soap_new__vbox__InvalidObjectFault(soap, 1);
1523 ex->badObjectID = obj;
1524
1525 std::string str("VirtualBox error: ");
1526 str += "Invalid managed object reference \"" + obj + "\"";
1527
1528 RaiseSoapFault(soap,
1529 str.c_str(),
1530 SOAP_TYPE__vbox__InvalidObjectFault,
1531 ex);
1532}
1533
1534/**
1535 * Return a safe C++ string from the given COM string,
1536 * without crashing if the COM string is empty.
1537 * @param bstr
1538 * @return
1539 */
1540std::string ConvertComString(const com::Bstr &bstr)
1541{
1542 com::Utf8Str ustr(bstr);
1543 return ustr.c_str(); // @todo r=dj since the length is known, we can probably use a better std::string allocator
1544}
1545
1546/**
1547 * Return a safe C++ string from the given COM UUID,
1548 * without crashing if the UUID is empty.
1549 * @param bstr
1550 * @return
1551 */
1552std::string ConvertComString(const com::Guid &uuid)
1553{
1554 com::Utf8Str ustr(uuid.toString());
1555 return ustr.c_str(); // @todo r=dj since the length is known, we can probably use a better std::string allocator
1556}
1557
1558/** Code to handle string <-> byte arrays base64 conversion. */
1559std::string Base64EncodeByteArray(ComSafeArrayIn(BYTE, aData))
1560{
1561
1562 com::SafeArray<BYTE> sfaData(ComSafeArrayInArg(aData));
1563 ssize_t cbData = sfaData.size();
1564
1565 if (cbData == 0)
1566 return "";
1567
1568 ssize_t cchOut = RTBase64EncodedLength(cbData);
1569
1570 RTCString aStr;
1571
1572 aStr.reserve(cchOut+1);
1573 int rc = RTBase64Encode(sfaData.raw(), cbData,
1574 aStr.mutableRaw(), aStr.capacity(),
1575 NULL);
1576 AssertRC(rc);
1577 aStr.jolt();
1578
1579 return aStr.c_str();
1580}
1581
1582#define DECODE_STR_MAX _1M
1583void Base64DecodeByteArray(struct soap *soap, const std::string& aStr, ComSafeArrayOut(BYTE, aData), const WSDLT_ID &idThis, const char *pszMethodName, IUnknown *pObj, const com::Guid &iid)
1584{
1585 const char* pszStr = aStr.c_str();
1586 ssize_t cbOut = RTBase64DecodedSize(pszStr, NULL);
1587
1588 if (cbOut > DECODE_STR_MAX)
1589 {
1590 LogRel(("Decode string too long.\n"));
1591 RaiseSoapRuntimeFault(soap, idThis, pszMethodName, E_INVALIDARG, pObj, iid);
1592 }
1593
1594 com::SafeArray<BYTE> result(cbOut);
1595 int rc = RTBase64Decode(pszStr, result.raw(), cbOut, NULL, NULL);
1596 if (FAILED(rc))
1597 {
1598 LogRel(("String Decoding Failed. Error code: %Rrc\n", rc));
1599 RaiseSoapRuntimeFault(soap, idThis, pszMethodName, E_INVALIDARG, pObj, iid);
1600 }
1601
1602 result.detachTo(ComSafeArrayOutArg(aData));
1603}
1604
1605/**
1606 * Raises a SOAP runtime fault.
1607 *
1608 * @param soap
1609 * @param idThis
1610 * @param pcszMethodName
1611 * @param apirc
1612 * @param pObj
1613 * @param iid
1614 */
1615void RaiseSoapRuntimeFault(struct soap *soap,
1616 const WSDLT_ID &idThis,
1617 const char *pcszMethodName,
1618 HRESULT apirc,
1619 IUnknown *pObj,
1620 const com::Guid &iid)
1621{
1622 com::ErrorInfo info(pObj, iid.ref());
1623
1624 WEBDEBUG((" error, raising SOAP exception\n"));
1625
1626 LogRel(("API method name: %s\n", pcszMethodName));
1627 LogRel(("API return code: %#10lx (%Rhrc)\n", apirc, apirc));
1628 if (info.isFullAvailable() || info.isBasicAvailable())
1629 {
1630 const com::ErrorInfo *pInfo = &info;
1631 do
1632 {
1633 LogRel(("COM error info result code: %#10lx (%Rhrc)\n", pInfo->getResultCode(), pInfo->getResultCode()));
1634 LogRel(("COM error info text: %ls\n", pInfo->getText().raw()));
1635
1636 pInfo = pInfo->getNext();
1637 }
1638 while (pInfo);
1639 }
1640
1641 // compose descriptive message
1642 com::Utf8Str str = com::Utf8StrFmt("VirtualBox error: rc=%#lx", apirc);
1643 if (info.isFullAvailable() || info.isBasicAvailable())
1644 {
1645 const com::ErrorInfo *pInfo = &info;
1646 do
1647 {
1648 str += com::Utf8StrFmt(" %ls (%#lx)", pInfo->getText().raw(), pInfo->getResultCode());
1649 pInfo = pInfo->getNext();
1650 }
1651 while (pInfo);
1652 }
1653
1654 // allocate our own soap fault struct
1655 _vbox__RuntimeFault *ex = soap_new__vbox__RuntimeFault(soap, 1);
1656 ComPtr<IVirtualBoxErrorInfo> pVirtualBoxErrorInfo;
1657 info.getVirtualBoxErrorInfo(pVirtualBoxErrorInfo);
1658 ex->resultCode = apirc;
1659 ex->returnval = createOrFindRefFromComPtr(idThis, g_pcszIVirtualBoxErrorInfo, pVirtualBoxErrorInfo);
1660
1661 RaiseSoapFault(soap,
1662 str.c_str(),
1663 SOAP_TYPE__vbox__RuntimeFault,
1664 ex);
1665}
1666
1667/****************************************************************************
1668 *
1669 * splitting and merging of object IDs
1670 *
1671 ****************************************************************************/
1672
1673/**
1674 * Splits a managed object reference (in string form, as passed in from a SOAP
1675 * method call) into two integers for websession and object IDs, respectively.
1676 *
1677 * @param id
1678 * @param pWebsessId
1679 * @param pObjId
1680 * @return
1681 */
1682static bool SplitManagedObjectRef(const WSDLT_ID &id,
1683 uint64_t *pWebsessId,
1684 uint64_t *pObjId)
1685{
1686 // 64-bit numbers in hex have 16 digits; hence
1687 // the object-ref string must have 16 + "-" + 16 characters
1688 if ( id.length() == 33
1689 && id[16] == '-'
1690 )
1691 {
1692 char psz[34];
1693 memcpy(psz, id.c_str(), 34);
1694 psz[16] = '\0';
1695 if (pWebsessId)
1696 RTStrToUInt64Full(psz, 16, pWebsessId);
1697 if (pObjId)
1698 RTStrToUInt64Full(psz + 17, 16, pObjId);
1699 return true;
1700 }
1701
1702 return false;
1703}
1704
1705/**
1706 * Creates a managed object reference (in string form) from
1707 * two integers representing a websession and object ID, respectively.
1708 *
1709 * @param sz Buffer with at least 34 bytes space to receive MOR string.
1710 * @param websessId
1711 * @param objId
1712 * @return
1713 */
1714static void MakeManagedObjectRef(char *sz,
1715 uint64_t websessId,
1716 uint64_t objId)
1717{
1718 RTStrFormatNumber(sz, websessId, 16, 16, 0, RTSTR_F_64BIT | RTSTR_F_ZEROPAD);
1719 sz[16] = '-';
1720 RTStrFormatNumber(sz + 17, objId, 16, 16, 0, RTSTR_F_64BIT | RTSTR_F_ZEROPAD);
1721}
1722
1723/****************************************************************************
1724 *
1725 * class WebServiceSession
1726 *
1727 ****************************************************************************/
1728
1729class WebServiceSessionPrivate
1730{
1731 public:
1732 ManagedObjectsMapById _mapManagedObjectsById;
1733 ManagedObjectsMapByPtr _mapManagedObjectsByPtr;
1734};
1735
1736/**
1737 * Constructor for the websession object.
1738 *
1739 * Preconditions: Caller must have locked g_pWebsessionsLockHandle.
1740 *
1741 * @param username
1742 * @param password
1743 */
1744WebServiceSession::WebServiceSession()
1745 : _uNextObjectID(1), // avoid 0 for no real reason
1746 _fDestructing(false),
1747 _tLastObjectLookup(0)
1748{
1749 _pp = new WebServiceSessionPrivate;
1750 _uWebsessionID = RTRandU64();
1751
1752 // register this websession globally
1753 Assert(g_pWebsessionsLockHandle->isWriteLockOnCurrentThread());
1754 g_mapWebsessions[_uWebsessionID] = this;
1755}
1756
1757/**
1758 * Destructor. Cleans up and destroys all contained managed object references on the way.
1759 *
1760 * Preconditions: Caller must have locked g_pWebsessionsLockHandle.
1761 */
1762WebServiceSession::~WebServiceSession()
1763{
1764 // delete us from global map first so we can't be found
1765 // any more while we're cleaning up
1766 Assert(g_pWebsessionsLockHandle->isWriteLockOnCurrentThread());
1767 g_mapWebsessions.erase(_uWebsessionID);
1768
1769 // notify ManagedObjectRef destructor so it won't
1770 // remove itself from the maps; this avoids rebalancing
1771 // the map's tree on every delete as well
1772 _fDestructing = true;
1773
1774 ManagedObjectsIteratorById it,
1775 end = _pp->_mapManagedObjectsById.end();
1776 for (it = _pp->_mapManagedObjectsById.begin();
1777 it != end;
1778 ++it)
1779 {
1780 ManagedObjectRef *pRef = it->second;
1781 delete pRef; // this frees the contained ComPtr as well
1782 }
1783
1784 delete _pp;
1785}
1786
1787/**
1788 * Authenticate the username and password against an authentication authority.
1789 *
1790 * @return 0 if the user was successfully authenticated, or an error code
1791 * otherwise.
1792 */
1793int WebServiceSession::authenticate(const char *pcszUsername,
1794 const char *pcszPassword,
1795 IVirtualBox **ppVirtualBox)
1796{
1797 int rc = VERR_WEB_NOT_AUTHENTICATED;
1798 ComPtr<IVirtualBox> pVirtualBox;
1799 {
1800 util::AutoReadLock vlock(g_pVirtualBoxLockHandle COMMA_LOCKVAL_SRC_POS);
1801 pVirtualBox = g_pVirtualBox;
1802 }
1803 if (pVirtualBox.isNull())
1804 return rc;
1805 pVirtualBox.queryInterfaceTo(ppVirtualBox);
1806
1807 util::AutoReadLock lock(g_pAuthLibLockHandle COMMA_LOCKVAL_SRC_POS);
1808
1809 static bool fAuthLibLoaded = false;
1810 static PAUTHENTRY pfnAuthEntry = NULL;
1811 static PAUTHENTRY2 pfnAuthEntry2 = NULL;
1812 static PAUTHENTRY3 pfnAuthEntry3 = NULL;
1813
1814 if (!fAuthLibLoaded)
1815 {
1816 // retrieve authentication library from system properties
1817 ComPtr<ISystemProperties> systemProperties;
1818 pVirtualBox->COMGETTER(SystemProperties)(systemProperties.asOutParam());
1819
1820 com::Bstr authLibrary;
1821 systemProperties->COMGETTER(WebServiceAuthLibrary)(authLibrary.asOutParam());
1822 com::Utf8Str filename = authLibrary;
1823
1824 LogRel(("External authentication library is '%ls'\n", authLibrary.raw()));
1825
1826 if (filename == "null")
1827 // authentication disabled, let everyone in:
1828 fAuthLibLoaded = true;
1829 else
1830 {
1831 RTLDRMOD hlibAuth = 0;
1832 do
1833 {
1834 if (RTPathHavePath(filename.c_str()))
1835 rc = RTLdrLoad(filename.c_str(), &hlibAuth);
1836 else
1837 rc = RTLdrLoadAppPriv(filename.c_str(), &hlibAuth);
1838
1839 if (RT_FAILURE(rc))
1840 {
1841 WEBDEBUG(("%s() Failed to load external authentication library '%s'. Error code: %Rrc\n",
1842 __FUNCTION__, filename.c_str(), rc));
1843 break;
1844 }
1845
1846 if (RT_FAILURE(rc = RTLdrGetSymbol(hlibAuth, AUTHENTRY3_NAME, (void**)&pfnAuthEntry3)))
1847 {
1848 WEBDEBUG(("%s(): Could not resolve import '%s'. Error code: %Rrc\n",
1849 __FUNCTION__, AUTHENTRY3_NAME, rc));
1850
1851 if (RT_FAILURE(rc = RTLdrGetSymbol(hlibAuth, AUTHENTRY2_NAME, (void**)&pfnAuthEntry2)))
1852 {
1853 WEBDEBUG(("%s(): Could not resolve import '%s'. Error code: %Rrc\n",
1854 __FUNCTION__, AUTHENTRY2_NAME, rc));
1855
1856 if (RT_FAILURE(rc = RTLdrGetSymbol(hlibAuth, AUTHENTRY_NAME, (void**)&pfnAuthEntry)))
1857 WEBDEBUG(("%s(): Could not resolve import '%s'. Error code: %Rrc\n",
1858 __FUNCTION__, AUTHENTRY_NAME, rc));
1859 }
1860 }
1861
1862 if (pfnAuthEntry || pfnAuthEntry2 || pfnAuthEntry3)
1863 fAuthLibLoaded = true;
1864
1865 } while (0);
1866 }
1867 }
1868
1869 if (pfnAuthEntry3 || pfnAuthEntry2 || pfnAuthEntry)
1870 {
1871 const char *pszFn;
1872 AuthResult result;
1873 if (pfnAuthEntry3)
1874 {
1875 result = pfnAuthEntry3("webservice", NULL, AuthGuestNotAsked, pcszUsername, pcszPassword, NULL, true, 0);
1876 pszFn = AUTHENTRY3_NAME;
1877 }
1878 else if (pfnAuthEntry2)
1879 {
1880 result = pfnAuthEntry2(NULL, AuthGuestNotAsked, pcszUsername, pcszPassword, NULL, true, 0);
1881 pszFn = AUTHENTRY2_NAME;
1882 }
1883 else
1884 {
1885 result = pfnAuthEntry(NULL, AuthGuestNotAsked, pcszUsername, pcszPassword, NULL);
1886 pszFn = AUTHENTRY_NAME;
1887 }
1888 WEBDEBUG(("%s(): result of %s('%s', [%d]): %d (%s)\n",
1889 __FUNCTION__, pszFn, pcszUsername, strlen(pcszPassword), result, decodeAuthResult(result)));
1890 if (result == AuthResultAccessGranted)
1891 {
1892 LogRel(("Access for user '%s' granted\n", pcszUsername));
1893 rc = VINF_SUCCESS;
1894 }
1895 else
1896 {
1897 if (result == AuthResultAccessDenied)
1898 LogRel(("Access for user '%s' denied\n", pcszUsername));
1899 rc = VERR_WEB_NOT_AUTHENTICATED;
1900 }
1901 }
1902 else if (fAuthLibLoaded)
1903 {
1904 // fAuthLibLoaded = true but all pointers are NULL:
1905 // The authlib was "null" and auth was disabled
1906 rc = VINF_SUCCESS;
1907 }
1908 else
1909 {
1910 WEBDEBUG(("Could not resolve AuthEntry, VRDPAuth2 or VRDPAuth entry point"));
1911 rc = VERR_WEB_NOT_AUTHENTICATED;
1912 }
1913
1914 lock.release();
1915
1916 return rc;
1917}
1918
1919/**
1920 * Look up, in this websession, whether a ManagedObjectRef has already been
1921 * created for the given COM pointer.
1922 *
1923 * Note how we require that a ComPtr<IUnknown> is passed, which causes a
1924 * queryInterface call when the caller passes in a different type, since
1925 * a ComPtr<IUnknown> will point to something different than a
1926 * ComPtr<IVirtualBox>, for example. As we store the ComPtr<IUnknown> in
1927 * our private hash table, we must search for one too.
1928 *
1929 * Preconditions: Caller must have locked g_pWebsessionsLockHandle.
1930 *
1931 * @param pcu pointer to a COM object.
1932 * @return The existing ManagedObjectRef that represents the COM object, or NULL if there's none yet.
1933 */
1934ManagedObjectRef* WebServiceSession::findRefFromPtr(const IUnknown *pObject)
1935{
1936 Assert(g_pWebsessionsLockHandle->isWriteLockOnCurrentThread());
1937
1938 uintptr_t ulp = (uintptr_t)pObject;
1939 // WEBDEBUG((" %s: looking up %#lx\n", __FUNCTION__, ulp));
1940 ManagedObjectsIteratorByPtr it = _pp->_mapManagedObjectsByPtr.find(ulp);
1941 if (it != _pp->_mapManagedObjectsByPtr.end())
1942 {
1943 ManagedObjectRef *pRef = it->second;
1944 WEBDEBUG((" %s: found existing ref %s (%s) for COM obj %#lx\n", __FUNCTION__, pRef->getWSDLID().c_str(), pRef->getInterfaceName(), ulp));
1945 return pRef;
1946 }
1947
1948 return NULL;
1949}
1950
1951/**
1952 * Static method which attempts to find the websession for which the given
1953 * managed object reference was created, by splitting the reference into the
1954 * websession and object IDs and then looking up the websession object.
1955 *
1956 * Preconditions: Caller must have locked g_pWebsessionsLockHandle in read mode.
1957 *
1958 * @param id Managed object reference (with combined websession and object IDs).
1959 * @return
1960 */
1961WebServiceSession *WebServiceSession::findWebsessionFromRef(const WSDLT_ID &id)
1962{
1963 Assert(g_pWebsessionsLockHandle->isWriteLockOnCurrentThread());
1964
1965 WebServiceSession *pWebsession = NULL;
1966 uint64_t websessId;
1967 if (SplitManagedObjectRef(id,
1968 &websessId,
1969 NULL))
1970 {
1971 WebsessionsMapIterator it = g_mapWebsessions.find(websessId);
1972 if (it != g_mapWebsessions.end())
1973 pWebsession = it->second;
1974 }
1975 return pWebsession;
1976}
1977
1978/**
1979 * Touches the websession to prevent it from timing out.
1980 *
1981 * Each websession has an internal timestamp that records the last request made
1982 * to it from the client that started it. If no request was made within a
1983 * configurable timeframe, then the client is logged off automatically,
1984 * by calling IWebsessionManager::logoff()
1985 */
1986void WebServiceSession::touch()
1987{
1988 time(&_tLastObjectLookup);
1989}
1990
1991
1992/****************************************************************************
1993 *
1994 * class ManagedObjectRef
1995 *
1996 ****************************************************************************/
1997
1998/**
1999 * Constructor, which assigns a unique ID to this managed object
2000 * reference and stores it in two hashes (living in the associated
2001 * WebServiceSession object):
2002 *
2003 * a) _mapManagedObjectsById, which maps ManagedObjectID's to
2004 * instances of this class; this hash is then used by the
2005 * findObjectFromRef() template function in vboxweb.h
2006 * to quickly retrieve the COM object from its managed
2007 * object ID (mostly in the context of the method mappers
2008 * in methodmaps.cpp, when a web service client passes in
2009 * a managed object ID);
2010 *
2011 * b) _mapManagedObjectsByPtr, which maps COM pointers to
2012 * instances of this class; this hash is used by
2013 * createRefFromObject() to quickly figure out whether an
2014 * instance already exists for a given COM pointer.
2015 *
2016 * This constructor calls AddRef() on the given COM object, and
2017 * the destructor will call Release(). We require two input pointers
2018 * for that COM object, one generic IUnknown* pointer which is used
2019 * as the map key, and a specific interface pointer (e.g. IMachine*)
2020 * which must support the interface given in guidInterface. All
2021 * three values are returned by getPtr(), which gives future callers
2022 * a chance to reuse the specific interface pointer without having
2023 * to call QueryInterface, which can be expensive.
2024 *
2025 * This does _not_ check whether another instance already
2026 * exists in the hash. This gets called only from the
2027 * createOrFindRefFromComPtr() template function in vboxweb.h, which
2028 * does perform that check.
2029 *
2030 * Preconditions: Caller must have locked g_pWebsessionsLockHandle.
2031 *
2032 * @param websession Websession to which the MOR will be added.
2033 * @param pobjUnknown Pointer to IUnknown* interface for the COM object; this will be used in the hashes.
2034 * @param pobjInterface Pointer to a specific interface for the COM object, described by guidInterface.
2035 * @param guidInterface Interface which pobjInterface points to.
2036 * @param pcszInterface String representation of that interface (e.g. "IMachine") for readability and logging.
2037 */
2038ManagedObjectRef::ManagedObjectRef(WebServiceSession &websession,
2039 IUnknown *pobjUnknown,
2040 void *pobjInterface,
2041 const com::Guid &guidInterface,
2042 const char *pcszInterface)
2043 : _websession(websession),
2044 _pobjUnknown(pobjUnknown),
2045 _pobjInterface(pobjInterface),
2046 _guidInterface(guidInterface),
2047 _pcszInterface(pcszInterface)
2048{
2049 Assert(pobjUnknown);
2050 Assert(pobjInterface);
2051
2052 // keep both stubs alive while this MOR exists (matching Release() calls are in destructor)
2053 uint32_t cRefs1 = pobjUnknown->AddRef();
2054 uint32_t cRefs2 = ((IUnknown*)pobjInterface)->AddRef();
2055 _ulp = (uintptr_t)pobjUnknown;
2056
2057 Assert(g_pWebsessionsLockHandle->isWriteLockOnCurrentThread());
2058 _id = websession.createObjectID();
2059 // and count globally
2060 ULONG64 cTotal = ++g_cManagedObjects; // raise global count and make a copy for the debug message below
2061
2062 char sz[34];
2063 MakeManagedObjectRef(sz, websession._uWebsessionID, _id);
2064 _strID = sz;
2065
2066 websession._pp->_mapManagedObjectsById[_id] = this;
2067 websession._pp->_mapManagedObjectsByPtr[_ulp] = this;
2068
2069 websession.touch();
2070
2071 WEBDEBUG((" * %s: MOR created for %s*=%#p (IUnknown*=%#p; COM refcount now %RI32/%RI32), new ID is %#llx; now %lld objects total\n",
2072 __FUNCTION__,
2073 pcszInterface,
2074 pobjInterface,
2075 pobjUnknown,
2076 cRefs1,
2077 cRefs2,
2078 _id,
2079 cTotal));
2080}
2081
2082/**
2083 * Destructor; removes the instance from the global hash of
2084 * managed objects. Calls Release() on the contained COM object.
2085 *
2086 * Preconditions: Caller must have locked g_pWebsessionsLockHandle.
2087 */
2088ManagedObjectRef::~ManagedObjectRef()
2089{
2090 Assert(g_pWebsessionsLockHandle->isWriteLockOnCurrentThread());
2091 ULONG64 cTotal = --g_cManagedObjects;
2092
2093 Assert(_pobjUnknown);
2094 Assert(_pobjInterface);
2095
2096 // we called AddRef() on both interfaces, so call Release() on
2097 // both as well, but in reverse order
2098 uint32_t cRefs2 = ((IUnknown*)_pobjInterface)->Release();
2099 uint32_t cRefs1 = _pobjUnknown->Release();
2100 WEBDEBUG((" * %s: deleting MOR for ID %#llx (%s; COM refcount now %RI32/%RI32); now %lld objects total\n", __FUNCTION__, _id, _pcszInterface, cRefs1, cRefs2, cTotal));
2101
2102 // if we're being destroyed from the websession's destructor,
2103 // then that destructor is iterating over the maps, so
2104 // don't remove us there! (data integrity + speed)
2105 if (!_websession._fDestructing)
2106 {
2107 WEBDEBUG((" * %s: removing from websession maps\n", __FUNCTION__));
2108 _websession._pp->_mapManagedObjectsById.erase(_id);
2109 if (_websession._pp->_mapManagedObjectsByPtr.erase(_ulp) != 1)
2110 WEBDEBUG((" WARNING: could not find %#llx in _mapManagedObjectsByPtr\n", _ulp));
2111 }
2112}
2113
2114/**
2115 * Static helper method for findObjectFromRef() template that actually
2116 * looks up the object from a given integer ID.
2117 *
2118 * This has been extracted into this non-template function to reduce
2119 * code bloat as we have the actual STL map lookup only in this function.
2120 *
2121 * This also "touches" the timestamp in the websession whose ID is encoded
2122 * in the given integer ID, in order to prevent the websession from timing
2123 * out.
2124 *
2125 * Preconditions: Caller must have locked g_pWebsessionsLockHandle.
2126 *
2127 * @param strId
2128 * @param iter
2129 * @return
2130 */
2131int ManagedObjectRef::findRefFromId(const WSDLT_ID &id,
2132 ManagedObjectRef **pRef,
2133 bool fNullAllowed)
2134{
2135 int rc = 0;
2136
2137 do
2138 {
2139 // allow NULL (== empty string) input reference, which should return a NULL pointer
2140 if (!id.length() && fNullAllowed)
2141 {
2142 *pRef = NULL;
2143 return 0;
2144 }
2145
2146 uint64_t websessId;
2147 uint64_t objId;
2148 WEBDEBUG((" %s(): looking up objref %s\n", __FUNCTION__, id.c_str()));
2149 if (!SplitManagedObjectRef(id,
2150 &websessId,
2151 &objId))
2152 {
2153 rc = VERR_WEB_INVALID_MANAGED_OBJECT_REFERENCE;
2154 break;
2155 }
2156
2157 WebsessionsMapIterator it = g_mapWebsessions.find(websessId);
2158 if (it == g_mapWebsessions.end())
2159 {
2160 WEBDEBUG((" %s: cannot find websession for objref %s\n", __FUNCTION__, id.c_str()));
2161 rc = VERR_WEB_INVALID_SESSION_ID;
2162 break;
2163 }
2164
2165 WebServiceSession *pWebsession = it->second;
2166 // "touch" websession to prevent it from timing out
2167 pWebsession->touch();
2168
2169 ManagedObjectsIteratorById iter = pWebsession->_pp->_mapManagedObjectsById.find(objId);
2170 if (iter == pWebsession->_pp->_mapManagedObjectsById.end())
2171 {
2172 WEBDEBUG((" %s: cannot find comobj for objref %s\n", __FUNCTION__, id.c_str()));
2173 rc = VERR_WEB_INVALID_OBJECT_ID;
2174 break;
2175 }
2176
2177 *pRef = iter->second;
2178
2179 } while (0);
2180
2181 return rc;
2182}
2183
2184/****************************************************************************
2185 *
2186 * interface IManagedObjectRef
2187 *
2188 ****************************************************************************/
2189
2190/**
2191 * This is the hard-coded implementation for the IManagedObjectRef::getInterfaceName()
2192 * that our WSDL promises to our web service clients. This method returns a
2193 * string describing the interface that this managed object reference
2194 * supports, e.g. "IMachine".
2195 *
2196 * @param soap
2197 * @param req
2198 * @param resp
2199 * @return
2200 */
2201int __vbox__IManagedObjectRef_USCOREgetInterfaceName(
2202 struct soap *soap,
2203 _vbox__IManagedObjectRef_USCOREgetInterfaceName *req,
2204 _vbox__IManagedObjectRef_USCOREgetInterfaceNameResponse *resp)
2205{
2206 HRESULT rc = S_OK;
2207 WEBDEBUG(("-- entering %s\n", __FUNCTION__));
2208
2209 do
2210 {
2211 // findRefFromId require the lock
2212 util::AutoWriteLock lock(g_pWebsessionsLockHandle COMMA_LOCKVAL_SRC_POS);
2213
2214 ManagedObjectRef *pRef;
2215 if (!ManagedObjectRef::findRefFromId(req->_USCOREthis, &pRef, false))
2216 resp->returnval = pRef->getInterfaceName();
2217
2218 } while (0);
2219
2220 WEBDEBUG(("-- leaving %s, rc: %#lx\n", __FUNCTION__, rc));
2221 if (FAILED(rc))
2222 return SOAP_FAULT;
2223 return SOAP_OK;
2224}
2225
2226/**
2227 * This is the hard-coded implementation for the IManagedObjectRef::release()
2228 * that our WSDL promises to our web service clients. This method releases
2229 * a managed object reference and removes it from our stacks.
2230 *
2231 * @param soap
2232 * @param req
2233 * @param resp
2234 * @return
2235 */
2236int __vbox__IManagedObjectRef_USCORErelease(
2237 struct soap *soap,
2238 _vbox__IManagedObjectRef_USCORErelease *req,
2239 _vbox__IManagedObjectRef_USCOREreleaseResponse *resp)
2240{
2241 HRESULT rc = S_OK;
2242 WEBDEBUG(("-- entering %s\n", __FUNCTION__));
2243
2244 do
2245 {
2246 // findRefFromId and the delete call below require the lock
2247 util::AutoWriteLock lock(g_pWebsessionsLockHandle COMMA_LOCKVAL_SRC_POS);
2248
2249 ManagedObjectRef *pRef;
2250 if ((rc = ManagedObjectRef::findRefFromId(req->_USCOREthis, &pRef, false)))
2251 {
2252 RaiseSoapInvalidObjectFault(soap, req->_USCOREthis);
2253 break;
2254 }
2255
2256 WEBDEBUG((" found reference; deleting!\n"));
2257 // this removes the object from all stacks; since
2258 // there's a ComPtr<> hidden inside the reference,
2259 // this should also invoke Release() on the COM
2260 // object
2261 delete pRef;
2262 } while (0);
2263
2264 WEBDEBUG(("-- leaving %s, rc: %#lx\n", __FUNCTION__, rc));
2265 if (FAILED(rc))
2266 return SOAP_FAULT;
2267 return SOAP_OK;
2268}
2269
2270/****************************************************************************
2271 *
2272 * interface IWebsessionManager
2273 *
2274 ****************************************************************************/
2275
2276/**
2277 * Hard-coded implementation for IWebsessionManager::logon. As opposed to the underlying
2278 * COM API, this is the first method that a webservice client must call before the
2279 * webservice will do anything useful.
2280 *
2281 * This returns a managed object reference to the global IVirtualBox object; into this
2282 * reference a websession ID is encoded which remains constant with all managed object
2283 * references returned by other methods.
2284 *
2285 * When the webservice client is done, it should call IWebsessionManager::logoff. This
2286 * will clean up internally (destroy all remaining managed object references and
2287 * related COM objects used internally).
2288 *
2289 * After logon, an internal timeout ensures that if the webservice client does not
2290 * call any methods, after a configurable number of seconds, the webservice will log
2291 * off the client automatically. This is to ensure that the webservice does not
2292 * drown in managed object references and eventually deny service. Still, it is
2293 * a much better solution, both for performance and cleanliness, for the webservice
2294 * client to clean up itself.
2295 *
2296 * @param
2297 * @param vbox__IWebsessionManager_USCORElogon
2298 * @param vbox__IWebsessionManager_USCORElogonResponse
2299 * @return
2300 */
2301int __vbox__IWebsessionManager_USCORElogon(
2302 struct soap *soap,
2303 _vbox__IWebsessionManager_USCORElogon *req,
2304 _vbox__IWebsessionManager_USCORElogonResponse *resp)
2305{
2306 HRESULT rc = S_OK;
2307 WEBDEBUG(("-- entering %s\n", __FUNCTION__));
2308
2309 do
2310 {
2311 // WebServiceSession constructor tinkers with global MOR map and requires a write lock
2312 util::AutoWriteLock lock(g_pWebsessionsLockHandle COMMA_LOCKVAL_SRC_POS);
2313
2314 // create new websession; the constructor stores the new websession
2315 // in the global map automatically
2316 WebServiceSession *pWebsession = new WebServiceSession();
2317 ComPtr<IVirtualBox> pVirtualBox;
2318
2319 // authenticate the user
2320 if (!(pWebsession->authenticate(req->username.c_str(),
2321 req->password.c_str(),
2322 pVirtualBox.asOutParam())))
2323 {
2324 // fake up a "root" MOR for this websession
2325 char sz[34];
2326 MakeManagedObjectRef(sz, pWebsession->getID(), 0ULL);
2327 WSDLT_ID id = sz;
2328
2329 // in the new websession, create a managed object reference (MOR) for the
2330 // global VirtualBox object; this encodes the websession ID in the MOR so
2331 // that it will be implicitly be included in all future requests of this
2332 // webservice client
2333 resp->returnval = createOrFindRefFromComPtr(id, g_pcszIVirtualBox, pVirtualBox);
2334 WEBDEBUG(("VirtualBox object ref is %s\n", resp->returnval.c_str()));
2335 }
2336 else
2337 rc = E_FAIL;
2338 } while (0);
2339
2340 WEBDEBUG(("-- leaving %s, rc: %#lx\n", __FUNCTION__, rc));
2341 if (FAILED(rc))
2342 return SOAP_FAULT;
2343 return SOAP_OK;
2344}
2345
2346/**
2347 * Returns a new ISession object every time.
2348 *
2349 * No longer connected in any way to logons, one websession can easily
2350 * handle multiple sessions.
2351 */
2352int __vbox__IWebsessionManager_USCOREgetSessionObject(
2353 struct soap*,
2354 _vbox__IWebsessionManager_USCOREgetSessionObject *req,
2355 _vbox__IWebsessionManager_USCOREgetSessionObjectResponse *resp)
2356{
2357 HRESULT rc = S_OK;
2358 WEBDEBUG(("-- entering %s\n", __FUNCTION__));
2359
2360 do
2361 {
2362 // create a new ISession object
2363 ComPtr<ISession> pSession;
2364 rc = g_pVirtualBoxClient->COMGETTER(Session)(pSession.asOutParam());
2365 if (FAILED(rc))
2366 {
2367 WEBDEBUG(("ERROR: cannot create session object!"));
2368 break;
2369 }
2370
2371 // return its MOR
2372 resp->returnval = createOrFindRefFromComPtr(req->refIVirtualBox, g_pcszISession, pSession);
2373 WEBDEBUG(("Session object ref is %s\n", resp->returnval.c_str()));
2374 } while (0);
2375
2376 WEBDEBUG(("-- leaving %s, rc: %#lx\n", __FUNCTION__, rc));
2377 if (FAILED(rc))
2378 return SOAP_FAULT;
2379 return SOAP_OK;
2380}
2381
2382/**
2383 * hard-coded implementation for IWebsessionManager::logoff.
2384 *
2385 * @param
2386 * @param vbox__IWebsessionManager_USCORElogon
2387 * @param vbox__IWebsessionManager_USCORElogonResponse
2388 * @return
2389 */
2390int __vbox__IWebsessionManager_USCORElogoff(
2391 struct soap*,
2392 _vbox__IWebsessionManager_USCORElogoff *req,
2393 _vbox__IWebsessionManager_USCORElogoffResponse *resp)
2394{
2395 HRESULT rc = S_OK;
2396 WEBDEBUG(("-- entering %s\n", __FUNCTION__));
2397
2398 do
2399 {
2400 // findWebsessionFromRef and the websession destructor require the lock
2401 util::AutoWriteLock lock(g_pWebsessionsLockHandle COMMA_LOCKVAL_SRC_POS);
2402
2403 WebServiceSession* pWebsession;
2404 if ((pWebsession = WebServiceSession::findWebsessionFromRef(req->refIVirtualBox)))
2405 {
2406 WEBDEBUG(("websession logoff, deleting websession %#llx\n", pWebsession->getID()));
2407 delete pWebsession;
2408 // destructor cleans up
2409
2410 WEBDEBUG(("websession destroyed, %d websessions left open\n", g_mapWebsessions.size()));
2411 }
2412 } while (0);
2413
2414 WEBDEBUG(("-- leaving %s, rc: %#lx\n", __FUNCTION__, rc));
2415 if (FAILED(rc))
2416 return SOAP_FAULT;
2417 return SOAP_OK;
2418}
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