VirtualBox

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

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

Main/webservice: switch to using monotonic time for sessin expiration, and add statistics logging for session and MOR count
  • Property filesplitter.c set to Makefile.kmk
  • Property svn:eol-style set to native
  • Property svn:keywords set to Id Revision
File size: 82.3 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-2016 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#ifdef WITH_OPENSSL
899 const char *pszSsl = g_fSSL ? "SSL, " : "";
900#else /* !WITH_OPENSSL */
901 const char *pszSsl = "";
902#endif /*!WITH_OPENSSL */
903 LogRel(("Socket connection successful: host = %s, port = %u, %smaster socket = %d\n",
904 (g_pcszBindToHost) ? g_pcszBindToHost : "default (localhost)",
905 g_uBindToPort, pszSsl, m));
906
907 // initialize thread queue, mutex and eventsem
908 g_pSoapQ = new SoapQ(&soap);
909
910 uint64_t cAccepted = 1;
911 while (g_fKeepRunning)
912 {
913 struct timeval timeout;
914 fd_set fds;
915 int rv;
916 for (;;)
917 {
918 timeout.tv_sec = 60;
919 timeout.tv_usec = 0;
920 FD_ZERO(&fds);
921 FD_SET(soap.master, &fds);
922 rv = select((int)soap.master + 1, &fds, &fds, &fds, &timeout);
923 if (rv > 0)
924 break; // work is waiting
925 else if (rv == 0)
926 continue; // timeout, not necessary to bother gsoap
927 else // r < 0, errno
928 {
929 if (soap_socket_errno(soap.master) == SOAP_EINTR)
930 rv = 0; // re-check if we should terminate
931 break;
932 }
933 }
934 if (rv == 0)
935 continue;
936
937 // call gSOAP to handle incoming SOAP connection
938 soap.accept_timeout = -1; // 1usec timeout, actual waiting is above
939 s = soap_accept(&soap);
940 if (!soap_valid_socket(s))
941 {
942 if (soap.errnum)
943 WebLogSoapError(&soap);
944 continue;
945 }
946
947 // add the socket to the queue and tell worker threads to
948 // pick up the job
949 size_t cItemsOnQ = g_pSoapQ->add(s);
950 LogRel(("Request %llu on socket %d queued for processing (%d items on Q)\n", cAccepted, s, cItemsOnQ));
951 cAccepted++;
952 }
953
954 delete g_pSoapQ;
955 g_pSoapQ = NULL;
956
957 LogRel(("ending SOAP request handling\n"));
958
959 delete g_pSoapQ;
960 g_pSoapQ = NULL;
961
962 }
963 soap_done(&soap); // close master socket and detach environment
964
965#ifdef WITH_OPENSSL
966 if (g_fSSL)
967 CRYPTO_thread_cleanup();
968#endif /* WITH_OPENSSL */
969}
970
971/**
972 * Thread function for the "queue pumper" thread started from main(). This implements
973 * the loop that takes SOAP calls from HTTP and serves them by handing sockets to the
974 * SOAP queue worker threads.
975 */
976static DECLCALLBACK(int) fntQPumper(RTTHREAD ThreadSelf, void *pvUser)
977{
978 // store a log prefix for this thread
979 util::AutoWriteLock thrLock(g_pThreadsLockHandle COMMA_LOCKVAL_SRC_POS);
980 g_mapThreads[RTThreadSelf()] = "[ P ]";
981 thrLock.release();
982
983 doQueuesLoop();
984
985 thrLock.acquire();
986 g_mapThreads.erase(RTThreadSelf());
987 return 0;
988}
989
990#ifdef RT_OS_WINDOWS
991/**
992 * "Signal" handler for cleanly terminating the event loop.
993 */
994static BOOL WINAPI websrvSignalHandler(DWORD dwCtrlType)
995{
996 bool fEventHandled = FALSE;
997 switch (dwCtrlType)
998 {
999 /* User pressed CTRL+C or CTRL+BREAK or an external event was sent
1000 * via GenerateConsoleCtrlEvent(). */
1001 case CTRL_BREAK_EVENT:
1002 case CTRL_CLOSE_EVENT:
1003 case CTRL_C_EVENT:
1004 case CTRL_LOGOFF_EVENT:
1005 case CTRL_SHUTDOWN_EVENT:
1006 {
1007 ASMAtomicWriteBool(&g_fKeepRunning, false);
1008 com::NativeEventQueue *pQ = com::NativeEventQueue::getMainEventQueue();
1009 pQ->interruptEventQueueProcessing();
1010 fEventHandled = TRUE;
1011 break;
1012 }
1013 default:
1014 break;
1015 }
1016 return fEventHandled;
1017}
1018#else
1019/**
1020 * Signal handler for cleanly terminating the event loop.
1021 */
1022static void websrvSignalHandler(int iSignal)
1023{
1024 NOREF(iSignal);
1025 ASMAtomicWriteBool(&g_fKeepRunning, false);
1026 com::NativeEventQueue *pQ = com::NativeEventQueue::getMainEventQueue();
1027 pQ->interruptEventQueueProcessing();
1028}
1029#endif
1030
1031
1032/**
1033 * Start up the webservice server. This keeps running and waits
1034 * for incoming SOAP connections; for each request that comes in,
1035 * it calls method implementation code, most of it in the generated
1036 * code in methodmaps.cpp.
1037 *
1038 * @param argc
1039 * @param argv[]
1040 * @return
1041 */
1042int main(int argc, char *argv[])
1043{
1044 // initialize runtime
1045 int rc = RTR3InitExe(argc, &argv, 0);
1046 if (RT_FAILURE(rc))
1047 return RTMsgInitFailure(rc);
1048#ifdef RT_OS_WINDOWS
1049 ATL::CComModule _Module; /* Required internally by ATL (constructor records instance in global variable). */
1050#endif
1051
1052 // store a log prefix for this thread
1053 g_mapThreads[RTThreadSelf()] = "[M ]";
1054
1055 RTStrmPrintf(g_pStdErr, VBOX_PRODUCT " web service Version " VBOX_VERSION_STRING "\n"
1056 "(C) 2007-" VBOX_C_YEAR " " VBOX_VENDOR "\n"
1057 "All rights reserved.\n");
1058
1059 int c;
1060 const char *pszLogFile = NULL;
1061 const char *pszPidFile = NULL;
1062 RTGETOPTUNION ValueUnion;
1063 RTGETOPTSTATE GetState;
1064 RTGetOptInit(&GetState, argc, argv, g_aOptions, RT_ELEMENTS(g_aOptions), 1, 0 /*fFlags*/);
1065 while ((c = RTGetOpt(&GetState, &ValueUnion)))
1066 {
1067 switch (c)
1068 {
1069 case 'H':
1070 if (!ValueUnion.psz || !*ValueUnion.psz)
1071 {
1072 /* Normalize NULL/empty string to NULL, which will be
1073 * interpreted as "localhost" below. */
1074 g_pcszBindToHost = NULL;
1075 }
1076 else
1077 g_pcszBindToHost = ValueUnion.psz;
1078 break;
1079
1080 case 'p':
1081 g_uBindToPort = ValueUnion.u32;
1082 break;
1083
1084#ifdef WITH_OPENSSL
1085 case 's':
1086 g_fSSL = true;
1087 break;
1088
1089 case 'K':
1090 g_pcszKeyFile = ValueUnion.psz;
1091 break;
1092
1093 case 'a':
1094 if (ValueUnion.psz[0] == '\0')
1095 g_pcszPassword = NULL;
1096 else
1097 {
1098 PRTSTREAM StrmIn;
1099 if (!strcmp(ValueUnion.psz, "-"))
1100 StrmIn = g_pStdIn;
1101 else
1102 {
1103 int vrc = RTStrmOpen(ValueUnion.psz, "r", &StrmIn);
1104 if (RT_FAILURE(vrc))
1105 return RTMsgErrorExit(RTEXITCODE_FAILURE, "failed to open password file (%s, %Rrc)", ValueUnion.psz, vrc);
1106 }
1107 char szPasswd[512];
1108 int vrc = RTStrmGetLine(StrmIn, szPasswd, sizeof(szPasswd));
1109 if (RT_FAILURE(vrc))
1110 return RTMsgErrorExit(RTEXITCODE_FAILURE, "failed to read password (%s, %Rrc)", ValueUnion.psz, vrc);
1111 g_pcszPassword = RTStrDup(szPasswd);
1112 memset(szPasswd, '\0', sizeof(szPasswd));
1113 if (StrmIn != g_pStdIn)
1114 RTStrmClose(StrmIn);
1115 }
1116 break;
1117
1118 case 'c':
1119 g_pcszCACert = ValueUnion.psz;
1120 break;
1121
1122 case 'C':
1123 g_pcszCAPath = ValueUnion.psz;
1124 break;
1125
1126 case 'D':
1127 g_pcszDHFile = ValueUnion.psz;
1128 break;
1129
1130 case 'r':
1131 g_pcszRandFile = ValueUnion.psz;
1132 break;
1133#endif /* WITH_OPENSSL */
1134
1135 case 't':
1136 g_iWatchdogTimeoutSecs = ValueUnion.u32;
1137 break;
1138
1139 case 'i':
1140 g_iWatchdogCheckInterval = ValueUnion.u32;
1141 break;
1142
1143 case 'F':
1144 pszLogFile = ValueUnion.psz;
1145 break;
1146
1147 case 'R':
1148 g_cHistory = ValueUnion.u32;
1149 break;
1150
1151 case 'S':
1152 g_uHistoryFileSize = ValueUnion.u64;
1153 break;
1154
1155 case 'I':
1156 g_uHistoryFileTime = ValueUnion.u32;
1157 break;
1158
1159 case 'P':
1160 pszPidFile = ValueUnion.psz;
1161 break;
1162
1163 case 'T':
1164 g_cMaxWorkerThreads = ValueUnion.u32;
1165 break;
1166
1167 case 'k':
1168 g_cMaxKeepAlive = ValueUnion.u32;
1169 break;
1170
1171 case 'A':
1172 g_pcszAuthentication = ValueUnion.psz;
1173 break;
1174
1175 case 'h':
1176 DisplayHelp();
1177 return 0;
1178
1179 case 'v':
1180 g_fVerbose = true;
1181 break;
1182
1183#if defined(RT_OS_DARWIN) || defined(RT_OS_LINUX) || defined (RT_OS_SOLARIS) || defined(RT_OS_FREEBSD)
1184 case 'b':
1185 g_fDaemonize = true;
1186 break;
1187#endif
1188 case 'V':
1189 RTPrintf("%sr%s\n", RTBldCfgVersion(), RTBldCfgRevisionStr());
1190 return 0;
1191
1192 default:
1193 rc = RTGetOptPrintError(c, &ValueUnion);
1194 return rc;
1195 }
1196 }
1197
1198 /* create release logger, to stdout */
1199 char szError[RTPATH_MAX + 128];
1200 rc = com::VBoxLogRelCreate("web service", g_fDaemonize ? NULL : pszLogFile,
1201 RTLOGFLAGS_PREFIX_THREAD | RTLOGFLAGS_PREFIX_TIME_PROG,
1202 "all", "VBOXWEBSRV_RELEASE_LOG",
1203 RTLOGDEST_STDOUT, UINT32_MAX /* cMaxEntriesPerGroup */,
1204 g_cHistory, g_uHistoryFileTime, g_uHistoryFileSize,
1205 szError, sizeof(szError));
1206 if (RT_FAILURE(rc))
1207 return RTMsgErrorExit(RTEXITCODE_FAILURE, "failed to open release log (%s, %Rrc)", szError, rc);
1208
1209#if defined(RT_OS_DARWIN) || defined(RT_OS_LINUX) || defined (RT_OS_SOLARIS) || defined(RT_OS_FREEBSD)
1210 if (g_fDaemonize)
1211 {
1212 /* prepare release logging */
1213 char szLogFile[RTPATH_MAX];
1214
1215 if (!pszLogFile || !*pszLogFile)
1216 {
1217 rc = com::GetVBoxUserHomeDirectory(szLogFile, sizeof(szLogFile));
1218 if (RT_FAILURE(rc))
1219 return RTMsgErrorExit(RTEXITCODE_FAILURE, "could not get base directory for logging: %Rrc", rc);
1220 rc = RTPathAppend(szLogFile, sizeof(szLogFile), "vboxwebsrv.log");
1221 if (RT_FAILURE(rc))
1222 return RTMsgErrorExit(RTEXITCODE_FAILURE, "could not construct logging path: %Rrc", rc);
1223 pszLogFile = szLogFile;
1224 }
1225
1226 rc = RTProcDaemonizeUsingFork(false /* fNoChDir */, false /* fNoClose */, pszPidFile);
1227 if (RT_FAILURE(rc))
1228 return RTMsgErrorExit(RTEXITCODE_FAILURE, "failed to daemonize, rc=%Rrc. exiting.", rc);
1229
1230 /* create release logger, to file */
1231 rc = com::VBoxLogRelCreate("web service", pszLogFile,
1232 RTLOGFLAGS_PREFIX_THREAD | RTLOGFLAGS_PREFIX_TIME_PROG,
1233 "all", "VBOXWEBSRV_RELEASE_LOG",
1234 RTLOGDEST_FILE, UINT32_MAX /* cMaxEntriesPerGroup */,
1235 g_cHistory, g_uHistoryFileTime, g_uHistoryFileSize,
1236 szError, sizeof(szError));
1237 if (RT_FAILURE(rc))
1238 return RTMsgErrorExit(RTEXITCODE_FAILURE, "failed to open release log (%s, %Rrc)", szError, rc);
1239 }
1240#endif
1241
1242 // initialize SOAP SSL support if enabled
1243#ifdef WITH_OPENSSL
1244 if (g_fSSL)
1245 soap_ssl_init();
1246#endif /* WITH_OPENSSL */
1247
1248 // initialize COM/XPCOM
1249 HRESULT hrc = com::Initialize();
1250#ifdef VBOX_WITH_XPCOM
1251 if (hrc == NS_ERROR_FILE_ACCESS_DENIED)
1252 {
1253 char szHome[RTPATH_MAX] = "";
1254 com::GetVBoxUserHomeDirectory(szHome, sizeof(szHome));
1255 return RTMsgErrorExit(RTEXITCODE_FAILURE,
1256 "Failed to initialize COM because the global settings directory '%s' is not accessible!", szHome);
1257 }
1258#endif
1259 if (FAILED(hrc))
1260 return RTMsgErrorExit(RTEXITCODE_FAILURE, "failed to initialize COM! hrc=%Rhrc\n", hrc);
1261
1262 hrc = g_pVirtualBoxClient.createInprocObject(CLSID_VirtualBoxClient);
1263 if (FAILED(hrc))
1264 {
1265 RTMsgError("failed to create the VirtualBoxClient object!");
1266 com::ErrorInfo info;
1267 if (!info.isFullAvailable() && !info.isBasicAvailable())
1268 {
1269 com::GluePrintRCMessage(hrc);
1270 RTMsgError("Most likely, the VirtualBox COM server is not running or failed to start.");
1271 }
1272 else
1273 com::GluePrintErrorInfo(info);
1274 return RTEXITCODE_FAILURE;
1275 }
1276
1277 hrc = g_pVirtualBoxClient->COMGETTER(VirtualBox)(g_pVirtualBox.asOutParam());
1278 if (FAILED(hrc))
1279 {
1280 RTMsgError("Failed to get VirtualBox object (rc=%Rhrc)!", hrc);
1281 return RTEXITCODE_FAILURE;
1282 }
1283
1284 // set the authentication method if requested
1285 if (g_pVirtualBox && g_pcszAuthentication && g_pcszAuthentication[0])
1286 {
1287 ComPtr<ISystemProperties> pSystemProperties;
1288 g_pVirtualBox->COMGETTER(SystemProperties)(pSystemProperties.asOutParam());
1289 if (pSystemProperties)
1290 pSystemProperties->COMSETTER(WebServiceAuthLibrary)(com::Bstr(g_pcszAuthentication).raw());
1291 }
1292
1293 /* VirtualBoxClient events registration. */
1294 ComPtr<IEventListener> vboxClientListener;
1295 {
1296 ComPtr<IEventSource> pES;
1297 CHECK_ERROR(g_pVirtualBoxClient, COMGETTER(EventSource)(pES.asOutParam()));
1298 ComObjPtr<VirtualBoxClientEventListenerImpl> clientListener;
1299 clientListener.createObject();
1300 clientListener->init(new VirtualBoxClientEventListener());
1301 vboxClientListener = clientListener;
1302 com::SafeArray<VBoxEventType_T> eventTypes;
1303 eventTypes.push_back(VBoxEventType_OnVBoxSVCAvailabilityChanged);
1304 CHECK_ERROR(pES, RegisterListener(vboxClientListener, ComSafeArrayAsInParam(eventTypes), true));
1305 }
1306
1307 // create the global mutexes
1308 g_pAuthLibLockHandle = new util::WriteLockHandle(util::LOCKCLASS_WEBSERVICE);
1309 g_pVirtualBoxLockHandle = new util::RWLockHandle(util::LOCKCLASS_WEBSERVICE);
1310 g_pWebsessionsLockHandle = new util::WriteLockHandle(util::LOCKCLASS_WEBSERVICE);
1311 g_pThreadsLockHandle = new util::RWLockHandle(util::LOCKCLASS_OBJECTSTATE);
1312
1313 // SOAP queue pumper thread
1314 RTTHREAD threadQPumper;
1315 rc = RTThreadCreate(&threadQPumper,
1316 fntQPumper,
1317 NULL, // pvUser
1318 0, // cbStack (default)
1319 RTTHREADTYPE_MAIN_WORKER,
1320 RTTHREADFLAGS_WAITABLE,
1321 "SQPmp");
1322 if (RT_FAILURE(rc))
1323 return RTMsgErrorExit(RTEXITCODE_FAILURE, "Cannot start SOAP queue pumper thread: %Rrc", rc);
1324
1325 // watchdog thread
1326 RTTHREAD threadWatchdog = NIL_RTTHREAD;
1327 if (g_iWatchdogTimeoutSecs > 0)
1328 {
1329 // start our watchdog thread
1330 rc = RTThreadCreate(&threadWatchdog,
1331 fntWatchdog,
1332 NULL,
1333 0,
1334 RTTHREADTYPE_MAIN_WORKER,
1335 RTTHREADFLAGS_WAITABLE,
1336 "Watchdog");
1337 if (RT_FAILURE(rc))
1338 return RTMsgErrorExit(RTEXITCODE_FAILURE, "Cannot start watchdog thread: %Rrc", rc);
1339 }
1340
1341#ifdef RT_OS_WINDOWS
1342 if (!SetConsoleCtrlHandler((PHANDLER_ROUTINE)websrvSignalHandler, TRUE /* Add handler */))
1343 {
1344 rc = RTErrConvertFromWin32(GetLastError());
1345 RTMsgError("Unable to install console control handler, rc=%Rrc\n", rc);
1346 }
1347#else
1348 signal(SIGINT, websrvSignalHandler);
1349 signal(SIGTERM, websrvSignalHandler);
1350# ifdef SIGBREAK
1351 signal(SIGBREAK, websrvSignalHandler);
1352# endif
1353#endif
1354
1355 com::NativeEventQueue *pQ = com::NativeEventQueue::getMainEventQueue();
1356 while (g_fKeepRunning)
1357 {
1358 // we have to process main event queue
1359 WEBDEBUG(("Pumping COM event queue\n"));
1360 rc = pQ->processEventQueue(RT_INDEFINITE_WAIT);
1361 if (RT_FAILURE(rc))
1362 RTMsgError("processEventQueue -> %Rrc", rc);
1363 }
1364
1365 LogRel(("requested termination, cleaning up\n"));
1366
1367#ifdef RT_OS_WINDOWS
1368 if (!SetConsoleCtrlHandler((PHANDLER_ROUTINE)websrvSignalHandler, FALSE /* Remove handler */))
1369 {
1370 rc = RTErrConvertFromWin32(GetLastError());
1371 RTMsgError("Unable to remove console control handler, rc=%Rrc\n", rc);
1372 }
1373#else
1374 signal(SIGINT, SIG_DFL);
1375 signal(SIGTERM, SIG_DFL);
1376# ifdef SIGBREAK
1377 signal(SIGBREAK, SIG_DFL);
1378# endif
1379#endif
1380
1381#ifndef RT_OS_WINDOWS
1382 RTThreadPoke(threadQPumper);
1383#endif
1384 RTThreadWait(threadQPumper, 30000, NULL);
1385 if (threadWatchdog != NIL_RTTHREAD)
1386 {
1387#ifndef RT_OS_WINDOWS
1388 RTThreadPoke(threadWatchdog);
1389#endif
1390 RTThreadWait(threadWatchdog, g_iWatchdogCheckInterval * 1000 + 10000, NULL);
1391 }
1392
1393 /* VirtualBoxClient events unregistration. */
1394 if (vboxClientListener)
1395 {
1396 ComPtr<IEventSource> pES;
1397 CHECK_ERROR(g_pVirtualBoxClient, COMGETTER(EventSource)(pES.asOutParam()));
1398 if (!pES.isNull())
1399 CHECK_ERROR(pES, UnregisterListener(vboxClientListener));
1400 vboxClientListener.setNull();
1401 }
1402
1403 {
1404 util::AutoWriteLock vlock(g_pVirtualBoxLockHandle COMMA_LOCKVAL_SRC_POS);
1405 g_pVirtualBox.setNull();
1406 }
1407 {
1408 util::AutoWriteLock lock(g_pWebsessionsLockHandle COMMA_LOCKVAL_SRC_POS);
1409 WebsessionsMapIterator it = g_mapWebsessions.begin(),
1410 itEnd = g_mapWebsessions.end();
1411 while (it != itEnd)
1412 {
1413 WebServiceSession *pWebsession = it->second;
1414 WEBDEBUG(("SVC unavailable: websession %#llx stale, deleting\n", pWebsession->getID()));
1415 delete pWebsession;
1416 it = g_mapWebsessions.begin();
1417 }
1418 }
1419 g_pVirtualBoxClient.setNull();
1420
1421 com::Shutdown();
1422
1423 return 0;
1424}
1425
1426/****************************************************************************
1427 *
1428 * Watchdog thread
1429 *
1430 ****************************************************************************/
1431
1432/**
1433 * Watchdog thread, runs in the background while the webservice is alive.
1434 *
1435 * This gets started by main() and runs in the background to check all websessions
1436 * for whether they have been no requests in a configurable timeout period. In
1437 * that case, the websession is automatically logged off.
1438 */
1439static DECLCALLBACK(int) fntWatchdog(RTTHREAD ThreadSelf, void *pvUser)
1440{
1441 // store a log prefix for this thread
1442 util::AutoWriteLock thrLock(g_pThreadsLockHandle COMMA_LOCKVAL_SRC_POS);
1443 g_mapThreads[RTThreadSelf()] = "[W ]";
1444 thrLock.release();
1445
1446 WEBDEBUG(("Watchdog thread started\n"));
1447
1448 uint32_t tNextStat = 0;
1449
1450 while (g_fKeepRunning)
1451 {
1452 WEBDEBUG(("Watchdog: sleeping %d seconds\n", g_iWatchdogCheckInterval));
1453 RTThreadSleep(g_iWatchdogCheckInterval * 1000);
1454
1455 uint32_t tNow = RTTimeProgramSecTS();
1456
1457 // we're messing with websessions, so lock them
1458 util::AutoWriteLock lock(g_pWebsessionsLockHandle COMMA_LOCKVAL_SRC_POS);
1459 WEBDEBUG(("Watchdog: checking %d websessions\n", g_mapWebsessions.size()));
1460
1461 WebsessionsMapIterator it = g_mapWebsessions.begin(),
1462 itEnd = g_mapWebsessions.end();
1463 while (it != itEnd)
1464 {
1465 WebServiceSession *pWebsession = it->second;
1466 WEBDEBUG(("Watchdog: tNow: %d, websession timestamp: %d\n", tNow, pWebsession->getLastObjectLookup()));
1467 if (tNow > pWebsession->getLastObjectLookup() + g_iWatchdogTimeoutSecs)
1468 {
1469 WEBDEBUG(("Watchdog: websession %#llx timed out, deleting\n", pWebsession->getID()));
1470 delete pWebsession;
1471 it = g_mapWebsessions.begin();
1472 }
1473 else
1474 ++it;
1475 }
1476
1477 // re-set the authentication method in case it has been changed
1478 if (g_pVirtualBox && g_pcszAuthentication && g_pcszAuthentication[0])
1479 {
1480 ComPtr<ISystemProperties> pSystemProperties;
1481 g_pVirtualBox->COMGETTER(SystemProperties)(pSystemProperties.asOutParam());
1482 if (pSystemProperties)
1483 pSystemProperties->COMSETTER(WebServiceAuthLibrary)(com::Bstr(g_pcszAuthentication).raw());
1484 }
1485
1486 // Log some MOR usage statistics every 5 minutes, but only if there's
1487 // something worth logging (at least one reference or a transition to
1488 // zero references). Avoids useless log spamming in idle webservice.
1489 if (tNow >= tNextStat)
1490 {
1491 size_t cMOR = 0;
1492 it = g_mapWebsessions.begin();
1493 itEnd = g_mapWebsessions.end();
1494 while (it != itEnd)
1495 {
1496 cMOR += it->second->CountRefs();
1497 ++it;
1498 }
1499 static bool fLastZero = false;
1500 if (cMOR || !fLastZero)
1501 LogRel(("Statistics: %zu websessions, %zu references\n",
1502 g_mapWebsessions.size(), cMOR));
1503 fLastZero = (cMOR == 0);
1504 while (tNextStat <= tNow)
1505 tNextStat += 5 * 60; /* 5 minutes */
1506 }
1507 }
1508
1509 thrLock.acquire();
1510 g_mapThreads.erase(RTThreadSelf());
1511
1512 LogRel(("ending Watchdog thread\n"));
1513 return 0;
1514}
1515
1516/****************************************************************************
1517 *
1518 * SOAP exceptions
1519 *
1520 ****************************************************************************/
1521
1522/**
1523 * Helper function to raise a SOAP fault. Called by the other helper
1524 * functions, which raise specific SOAP faults.
1525 *
1526 * @param soap
1527 * @param str
1528 * @param extype
1529 * @param ex
1530 */
1531static void RaiseSoapFault(struct soap *soap,
1532 const char *pcsz,
1533 int extype,
1534 void *ex)
1535{
1536 // raise the fault
1537 soap_sender_fault(soap, pcsz, NULL);
1538
1539 struct SOAP_ENV__Detail *pDetail = (struct SOAP_ENV__Detail*)soap_malloc(soap, sizeof(struct SOAP_ENV__Detail));
1540
1541 // without the following, gSOAP crashes miserably when sending out the
1542 // data because it will try to serialize all fields (stupid documentation)
1543 memset(pDetail, 0, sizeof(struct SOAP_ENV__Detail));
1544
1545 // fill extended info depending on SOAP version
1546 if (soap->version == 2) // SOAP 1.2 is used
1547 {
1548 soap->fault->SOAP_ENV__Detail = pDetail;
1549 soap->fault->SOAP_ENV__Detail->__type = extype;
1550 soap->fault->SOAP_ENV__Detail->fault = ex;
1551 soap->fault->SOAP_ENV__Detail->__any = NULL; // no other XML data
1552 }
1553 else
1554 {
1555 soap->fault->detail = pDetail;
1556 soap->fault->detail->__type = extype;
1557 soap->fault->detail->fault = ex;
1558 soap->fault->detail->__any = NULL; // no other XML data
1559 }
1560}
1561
1562/**
1563 * Raises a SOAP fault that signals that an invalid object was passed.
1564 *
1565 * @param soap
1566 * @param obj
1567 */
1568void RaiseSoapInvalidObjectFault(struct soap *soap,
1569 WSDLT_ID obj)
1570{
1571 _vbox__InvalidObjectFault *ex = soap_new__vbox__InvalidObjectFault(soap, 1);
1572 ex->badObjectID = obj;
1573
1574 std::string str("VirtualBox error: ");
1575 str += "Invalid managed object reference \"" + obj + "\"";
1576
1577 RaiseSoapFault(soap,
1578 str.c_str(),
1579 SOAP_TYPE__vbox__InvalidObjectFault,
1580 ex);
1581}
1582
1583/**
1584 * Return a safe C++ string from the given COM string,
1585 * without crashing if the COM string is empty.
1586 * @param bstr
1587 * @return
1588 */
1589std::string ConvertComString(const com::Bstr &bstr)
1590{
1591 com::Utf8Str ustr(bstr);
1592 return ustr.c_str(); // @todo r=dj since the length is known, we can probably use a better std::string allocator
1593}
1594
1595/**
1596 * Return a safe C++ string from the given COM UUID,
1597 * without crashing if the UUID is empty.
1598 * @param bstr
1599 * @return
1600 */
1601std::string ConvertComString(const com::Guid &uuid)
1602{
1603 com::Utf8Str ustr(uuid.toString());
1604 return ustr.c_str(); // @todo r=dj since the length is known, we can probably use a better std::string allocator
1605}
1606
1607/** Code to handle string <-> byte arrays base64 conversion. */
1608std::string Base64EncodeByteArray(ComSafeArrayIn(BYTE, aData))
1609{
1610
1611 com::SafeArray<BYTE> sfaData(ComSafeArrayInArg(aData));
1612 ssize_t cbData = sfaData.size();
1613
1614 if (cbData == 0)
1615 return "";
1616
1617 ssize_t cchOut = RTBase64EncodedLength(cbData);
1618
1619 RTCString aStr;
1620
1621 aStr.reserve(cchOut+1);
1622 int rc = RTBase64Encode(sfaData.raw(), cbData,
1623 aStr.mutableRaw(), aStr.capacity(),
1624 NULL);
1625 AssertRC(rc);
1626 aStr.jolt();
1627
1628 return aStr.c_str();
1629}
1630
1631#define DECODE_STR_MAX _1M
1632void Base64DecodeByteArray(struct soap *soap, const std::string& aStr, ComSafeArrayOut(BYTE, aData), const WSDLT_ID &idThis, const char *pszMethodName, IUnknown *pObj, const com::Guid &iid)
1633{
1634 const char* pszStr = aStr.c_str();
1635 ssize_t cbOut = RTBase64DecodedSize(pszStr, NULL);
1636
1637 if (cbOut > DECODE_STR_MAX)
1638 {
1639 LogRel(("Decode string too long.\n"));
1640 RaiseSoapRuntimeFault(soap, idThis, pszMethodName, E_INVALIDARG, pObj, iid);
1641 }
1642
1643 com::SafeArray<BYTE> result(cbOut);
1644 int rc = RTBase64Decode(pszStr, result.raw(), cbOut, NULL, NULL);
1645 if (FAILED(rc))
1646 {
1647 LogRel(("String Decoding Failed. Error code: %Rrc\n", rc));
1648 RaiseSoapRuntimeFault(soap, idThis, pszMethodName, E_INVALIDARG, pObj, iid);
1649 }
1650
1651 result.detachTo(ComSafeArrayOutArg(aData));
1652}
1653
1654/**
1655 * Raises a SOAP runtime fault.
1656 *
1657 * @param soap
1658 * @param idThis
1659 * @param pcszMethodName
1660 * @param apirc
1661 * @param pObj
1662 * @param iid
1663 */
1664void RaiseSoapRuntimeFault(struct soap *soap,
1665 const WSDLT_ID &idThis,
1666 const char *pcszMethodName,
1667 HRESULT apirc,
1668 IUnknown *pObj,
1669 const com::Guid &iid)
1670{
1671 com::ErrorInfo info(pObj, iid.ref());
1672
1673 WEBDEBUG((" error, raising SOAP exception\n"));
1674
1675 LogRel(("API method name: %s\n", pcszMethodName));
1676 LogRel(("API return code: %#10lx (%Rhrc)\n", apirc, apirc));
1677 if (info.isFullAvailable() || info.isBasicAvailable())
1678 {
1679 const com::ErrorInfo *pInfo = &info;
1680 do
1681 {
1682 LogRel(("COM error info result code: %#10lx (%Rhrc)\n", pInfo->getResultCode(), pInfo->getResultCode()));
1683 LogRel(("COM error info text: %ls\n", pInfo->getText().raw()));
1684
1685 pInfo = pInfo->getNext();
1686 }
1687 while (pInfo);
1688 }
1689
1690 // compose descriptive message
1691 com::Utf8Str str = com::Utf8StrFmt("VirtualBox error: rc=%#lx", apirc);
1692 if (info.isFullAvailable() || info.isBasicAvailable())
1693 {
1694 const com::ErrorInfo *pInfo = &info;
1695 do
1696 {
1697 str += com::Utf8StrFmt(" %ls (%#lx)", pInfo->getText().raw(), pInfo->getResultCode());
1698 pInfo = pInfo->getNext();
1699 }
1700 while (pInfo);
1701 }
1702
1703 // allocate our own soap fault struct
1704 _vbox__RuntimeFault *ex = soap_new__vbox__RuntimeFault(soap, 1);
1705 ComPtr<IVirtualBoxErrorInfo> pVirtualBoxErrorInfo;
1706 info.getVirtualBoxErrorInfo(pVirtualBoxErrorInfo);
1707 ex->resultCode = apirc;
1708 ex->returnval = createOrFindRefFromComPtr(idThis, g_pcszIVirtualBoxErrorInfo, pVirtualBoxErrorInfo);
1709
1710 RaiseSoapFault(soap,
1711 str.c_str(),
1712 SOAP_TYPE__vbox__RuntimeFault,
1713 ex);
1714}
1715
1716/****************************************************************************
1717 *
1718 * splitting and merging of object IDs
1719 *
1720 ****************************************************************************/
1721
1722/**
1723 * Splits a managed object reference (in string form, as passed in from a SOAP
1724 * method call) into two integers for websession and object IDs, respectively.
1725 *
1726 * @param id
1727 * @param pWebsessId
1728 * @param pObjId
1729 * @return
1730 */
1731static bool SplitManagedObjectRef(const WSDLT_ID &id,
1732 uint64_t *pWebsessId,
1733 uint64_t *pObjId)
1734{
1735 // 64-bit numbers in hex have 16 digits; hence
1736 // the object-ref string must have 16 + "-" + 16 characters
1737 if ( id.length() == 33
1738 && id[16] == '-'
1739 )
1740 {
1741 char psz[34];
1742 memcpy(psz, id.c_str(), 34);
1743 psz[16] = '\0';
1744 if (pWebsessId)
1745 RTStrToUInt64Full(psz, 16, pWebsessId);
1746 if (pObjId)
1747 RTStrToUInt64Full(psz + 17, 16, pObjId);
1748 return true;
1749 }
1750
1751 return false;
1752}
1753
1754/**
1755 * Creates a managed object reference (in string form) from
1756 * two integers representing a websession and object ID, respectively.
1757 *
1758 * @param sz Buffer with at least 34 bytes space to receive MOR string.
1759 * @param websessId
1760 * @param objId
1761 * @return
1762 */
1763static void MakeManagedObjectRef(char *sz,
1764 uint64_t websessId,
1765 uint64_t objId)
1766{
1767 RTStrFormatNumber(sz, websessId, 16, 16, 0, RTSTR_F_64BIT | RTSTR_F_ZEROPAD);
1768 sz[16] = '-';
1769 RTStrFormatNumber(sz + 17, objId, 16, 16, 0, RTSTR_F_64BIT | RTSTR_F_ZEROPAD);
1770}
1771
1772/****************************************************************************
1773 *
1774 * class WebServiceSession
1775 *
1776 ****************************************************************************/
1777
1778class WebServiceSessionPrivate
1779{
1780 public:
1781 ManagedObjectsMapById _mapManagedObjectsById;
1782 ManagedObjectsMapByPtr _mapManagedObjectsByPtr;
1783};
1784
1785/**
1786 * Constructor for the websession object.
1787 *
1788 * Preconditions: Caller must have locked g_pWebsessionsLockHandle.
1789 *
1790 * @param username
1791 * @param password
1792 */
1793WebServiceSession::WebServiceSession()
1794 : _uNextObjectID(1), // avoid 0 for no real reason
1795 _fDestructing(false),
1796 _tLastObjectLookup(0)
1797{
1798 _pp = new WebServiceSessionPrivate;
1799 _uWebsessionID = RTRandU64();
1800
1801 // register this websession globally
1802 Assert(g_pWebsessionsLockHandle->isWriteLockOnCurrentThread());
1803 g_mapWebsessions[_uWebsessionID] = this;
1804}
1805
1806/**
1807 * Destructor. Cleans up and destroys all contained managed object references on the way.
1808 *
1809 * Preconditions: Caller must have locked g_pWebsessionsLockHandle.
1810 */
1811WebServiceSession::~WebServiceSession()
1812{
1813 // delete us from global map first so we can't be found
1814 // any more while we're cleaning up
1815 Assert(g_pWebsessionsLockHandle->isWriteLockOnCurrentThread());
1816 g_mapWebsessions.erase(_uWebsessionID);
1817
1818 // notify ManagedObjectRef destructor so it won't
1819 // remove itself from the maps; this avoids rebalancing
1820 // the map's tree on every delete as well
1821 _fDestructing = true;
1822
1823 ManagedObjectsIteratorById it,
1824 end = _pp->_mapManagedObjectsById.end();
1825 for (it = _pp->_mapManagedObjectsById.begin();
1826 it != end;
1827 ++it)
1828 {
1829 ManagedObjectRef *pRef = it->second;
1830 delete pRef; // this frees the contained ComPtr as well
1831 }
1832
1833 delete _pp;
1834}
1835
1836/**
1837 * Authenticate the username and password against an authentication authority.
1838 *
1839 * @return 0 if the user was successfully authenticated, or an error code
1840 * otherwise.
1841 */
1842int WebServiceSession::authenticate(const char *pcszUsername,
1843 const char *pcszPassword,
1844 IVirtualBox **ppVirtualBox)
1845{
1846 int rc = VERR_WEB_NOT_AUTHENTICATED;
1847 ComPtr<IVirtualBox> pVirtualBox;
1848 {
1849 util::AutoReadLock vlock(g_pVirtualBoxLockHandle COMMA_LOCKVAL_SRC_POS);
1850 pVirtualBox = g_pVirtualBox;
1851 }
1852 if (pVirtualBox.isNull())
1853 return rc;
1854 pVirtualBox.queryInterfaceTo(ppVirtualBox);
1855
1856 util::AutoReadLock lock(g_pAuthLibLockHandle COMMA_LOCKVAL_SRC_POS);
1857
1858 static bool fAuthLibLoaded = false;
1859 static PAUTHENTRY pfnAuthEntry = NULL;
1860 static PAUTHENTRY2 pfnAuthEntry2 = NULL;
1861 static PAUTHENTRY3 pfnAuthEntry3 = NULL;
1862
1863 if (!fAuthLibLoaded)
1864 {
1865 // retrieve authentication library from system properties
1866 ComPtr<ISystemProperties> systemProperties;
1867 pVirtualBox->COMGETTER(SystemProperties)(systemProperties.asOutParam());
1868
1869 com::Bstr authLibrary;
1870 systemProperties->COMGETTER(WebServiceAuthLibrary)(authLibrary.asOutParam());
1871 com::Utf8Str filename = authLibrary;
1872
1873 LogRel(("External authentication library is '%ls'\n", authLibrary.raw()));
1874
1875 if (filename == "null")
1876 // authentication disabled, let everyone in:
1877 fAuthLibLoaded = true;
1878 else
1879 {
1880 RTLDRMOD hlibAuth = 0;
1881 do
1882 {
1883 if (RTPathHavePath(filename.c_str()))
1884 rc = RTLdrLoad(filename.c_str(), &hlibAuth);
1885 else
1886 rc = RTLdrLoadAppPriv(filename.c_str(), &hlibAuth);
1887
1888 if (RT_FAILURE(rc))
1889 {
1890 WEBDEBUG(("%s() Failed to load external authentication library '%s'. Error code: %Rrc\n",
1891 __FUNCTION__, filename.c_str(), rc));
1892 break;
1893 }
1894
1895 if (RT_FAILURE(rc = RTLdrGetSymbol(hlibAuth, AUTHENTRY3_NAME, (void**)&pfnAuthEntry3)))
1896 {
1897 WEBDEBUG(("%s(): Could not resolve import '%s'. Error code: %Rrc\n",
1898 __FUNCTION__, AUTHENTRY3_NAME, rc));
1899
1900 if (RT_FAILURE(rc = RTLdrGetSymbol(hlibAuth, AUTHENTRY2_NAME, (void**)&pfnAuthEntry2)))
1901 {
1902 WEBDEBUG(("%s(): Could not resolve import '%s'. Error code: %Rrc\n",
1903 __FUNCTION__, AUTHENTRY2_NAME, rc));
1904
1905 if (RT_FAILURE(rc = RTLdrGetSymbol(hlibAuth, AUTHENTRY_NAME, (void**)&pfnAuthEntry)))
1906 WEBDEBUG(("%s(): Could not resolve import '%s'. Error code: %Rrc\n",
1907 __FUNCTION__, AUTHENTRY_NAME, rc));
1908 }
1909 }
1910
1911 if (pfnAuthEntry || pfnAuthEntry2 || pfnAuthEntry3)
1912 fAuthLibLoaded = true;
1913
1914 } while (0);
1915 }
1916 }
1917
1918 if (pfnAuthEntry3 || pfnAuthEntry2 || pfnAuthEntry)
1919 {
1920 const char *pszFn;
1921 AuthResult result;
1922 if (pfnAuthEntry3)
1923 {
1924 result = pfnAuthEntry3("webservice", NULL, AuthGuestNotAsked, pcszUsername, pcszPassword, NULL, true, 0);
1925 pszFn = AUTHENTRY3_NAME;
1926 }
1927 else if (pfnAuthEntry2)
1928 {
1929 result = pfnAuthEntry2(NULL, AuthGuestNotAsked, pcszUsername, pcszPassword, NULL, true, 0);
1930 pszFn = AUTHENTRY2_NAME;
1931 }
1932 else
1933 {
1934 result = pfnAuthEntry(NULL, AuthGuestNotAsked, pcszUsername, pcszPassword, NULL);
1935 pszFn = AUTHENTRY_NAME;
1936 }
1937 WEBDEBUG(("%s(): result of %s('%s', [%d]): %d (%s)\n",
1938 __FUNCTION__, pszFn, pcszUsername, strlen(pcszPassword), result, decodeAuthResult(result)));
1939 if (result == AuthResultAccessGranted)
1940 {
1941 LogRel(("Access for user '%s' granted\n", pcszUsername));
1942 rc = VINF_SUCCESS;
1943 }
1944 else
1945 {
1946 if (result == AuthResultAccessDenied)
1947 LogRel(("Access for user '%s' denied\n", pcszUsername));
1948 rc = VERR_WEB_NOT_AUTHENTICATED;
1949 }
1950 }
1951 else if (fAuthLibLoaded)
1952 {
1953 // fAuthLibLoaded = true but all pointers are NULL:
1954 // The authlib was "null" and auth was disabled
1955 rc = VINF_SUCCESS;
1956 }
1957 else
1958 {
1959 WEBDEBUG(("Could not resolve AuthEntry, VRDPAuth2 or VRDPAuth entry point"));
1960 rc = VERR_WEB_NOT_AUTHENTICATED;
1961 }
1962
1963 lock.release();
1964
1965 return rc;
1966}
1967
1968/**
1969 * Look up, in this websession, whether a ManagedObjectRef has already been
1970 * created for the given COM pointer.
1971 *
1972 * Note how we require that a ComPtr<IUnknown> is passed, which causes a
1973 * queryInterface call when the caller passes in a different type, since
1974 * a ComPtr<IUnknown> will point to something different than a
1975 * ComPtr<IVirtualBox>, for example. As we store the ComPtr<IUnknown> in
1976 * our private hash table, we must search for one too.
1977 *
1978 * Preconditions: Caller must have locked g_pWebsessionsLockHandle.
1979 *
1980 * @param pcu pointer to a COM object.
1981 * @return The existing ManagedObjectRef that represents the COM object, or NULL if there's none yet.
1982 */
1983ManagedObjectRef* WebServiceSession::findRefFromPtr(const IUnknown *pObject)
1984{
1985 Assert(g_pWebsessionsLockHandle->isWriteLockOnCurrentThread());
1986
1987 uintptr_t ulp = (uintptr_t)pObject;
1988 // WEBDEBUG((" %s: looking up %#lx\n", __FUNCTION__, ulp));
1989 ManagedObjectsIteratorByPtr it = _pp->_mapManagedObjectsByPtr.find(ulp);
1990 if (it != _pp->_mapManagedObjectsByPtr.end())
1991 {
1992 ManagedObjectRef *pRef = it->second;
1993 WEBDEBUG((" %s: found existing ref %s (%s) for COM obj %#lx\n", __FUNCTION__, pRef->getWSDLID().c_str(), pRef->getInterfaceName(), ulp));
1994 return pRef;
1995 }
1996
1997 return NULL;
1998}
1999
2000/**
2001 * Static method which attempts to find the websession for which the given
2002 * managed object reference was created, by splitting the reference into the
2003 * websession and object IDs and then looking up the websession object.
2004 *
2005 * Preconditions: Caller must have locked g_pWebsessionsLockHandle in read mode.
2006 *
2007 * @param id Managed object reference (with combined websession and object IDs).
2008 * @return
2009 */
2010WebServiceSession *WebServiceSession::findWebsessionFromRef(const WSDLT_ID &id)
2011{
2012 Assert(g_pWebsessionsLockHandle->isWriteLockOnCurrentThread());
2013
2014 WebServiceSession *pWebsession = NULL;
2015 uint64_t websessId;
2016 if (SplitManagedObjectRef(id,
2017 &websessId,
2018 NULL))
2019 {
2020 WebsessionsMapIterator it = g_mapWebsessions.find(websessId);
2021 if (it != g_mapWebsessions.end())
2022 pWebsession = it->second;
2023 }
2024 return pWebsession;
2025}
2026
2027/**
2028 * Touches the websession to prevent it from timing out.
2029 *
2030 * Each websession has an internal timestamp that records the last request made
2031 * to it from the client that started it. If no request was made within a
2032 * configurable timeframe, then the client is logged off automatically,
2033 * by calling IWebsessionManager::logoff()
2034 */
2035void WebServiceSession::touch()
2036{
2037 _tLastObjectLookup = RTTimeProgramSecTS();
2038}
2039
2040/**
2041 * Counts the number of managed object references in this websession.
2042 */
2043size_t WebServiceSession::CountRefs()
2044{
2045 return _pp->_mapManagedObjectsById.size();
2046}
2047
2048
2049/****************************************************************************
2050 *
2051 * class ManagedObjectRef
2052 *
2053 ****************************************************************************/
2054
2055/**
2056 * Constructor, which assigns a unique ID to this managed object
2057 * reference and stores it in two hashes (living in the associated
2058 * WebServiceSession object):
2059 *
2060 * a) _mapManagedObjectsById, which maps ManagedObjectID's to
2061 * instances of this class; this hash is then used by the
2062 * findObjectFromRef() template function in vboxweb.h
2063 * to quickly retrieve the COM object from its managed
2064 * object ID (mostly in the context of the method mappers
2065 * in methodmaps.cpp, when a web service client passes in
2066 * a managed object ID);
2067 *
2068 * b) _mapManagedObjectsByPtr, which maps COM pointers to
2069 * instances of this class; this hash is used by
2070 * createRefFromObject() to quickly figure out whether an
2071 * instance already exists for a given COM pointer.
2072 *
2073 * This constructor calls AddRef() on the given COM object, and
2074 * the destructor will call Release(). We require two input pointers
2075 * for that COM object, one generic IUnknown* pointer which is used
2076 * as the map key, and a specific interface pointer (e.g. IMachine*)
2077 * which must support the interface given in guidInterface. All
2078 * three values are returned by getPtr(), which gives future callers
2079 * a chance to reuse the specific interface pointer without having
2080 * to call QueryInterface, which can be expensive.
2081 *
2082 * This does _not_ check whether another instance already
2083 * exists in the hash. This gets called only from the
2084 * createOrFindRefFromComPtr() template function in vboxweb.h, which
2085 * does perform that check.
2086 *
2087 * Preconditions: Caller must have locked g_pWebsessionsLockHandle.
2088 *
2089 * @param websession Websession to which the MOR will be added.
2090 * @param pobjUnknown Pointer to IUnknown* interface for the COM object; this will be used in the hashes.
2091 * @param pobjInterface Pointer to a specific interface for the COM object, described by guidInterface.
2092 * @param guidInterface Interface which pobjInterface points to.
2093 * @param pcszInterface String representation of that interface (e.g. "IMachine") for readability and logging.
2094 */
2095ManagedObjectRef::ManagedObjectRef(WebServiceSession &websession,
2096 IUnknown *pobjUnknown,
2097 void *pobjInterface,
2098 const com::Guid &guidInterface,
2099 const char *pcszInterface)
2100 : _websession(websession),
2101 _pobjUnknown(pobjUnknown),
2102 _pobjInterface(pobjInterface),
2103 _guidInterface(guidInterface),
2104 _pcszInterface(pcszInterface)
2105{
2106 Assert(pobjUnknown);
2107 Assert(pobjInterface);
2108
2109 // keep both stubs alive while this MOR exists (matching Release() calls are in destructor)
2110 uint32_t cRefs1 = pobjUnknown->AddRef();
2111 uint32_t cRefs2 = ((IUnknown*)pobjInterface)->AddRef();
2112 _ulp = (uintptr_t)pobjUnknown;
2113
2114 Assert(g_pWebsessionsLockHandle->isWriteLockOnCurrentThread());
2115 _id = websession.createObjectID();
2116 // and count globally
2117 ULONG64 cTotal = ++g_cManagedObjects; // raise global count and make a copy for the debug message below
2118
2119 char sz[34];
2120 MakeManagedObjectRef(sz, websession._uWebsessionID, _id);
2121 _strID = sz;
2122
2123 websession._pp->_mapManagedObjectsById[_id] = this;
2124 websession._pp->_mapManagedObjectsByPtr[_ulp] = this;
2125
2126 websession.touch();
2127
2128 WEBDEBUG((" * %s: MOR created for %s*=%#p (IUnknown*=%#p; COM refcount now %RI32/%RI32), new ID is %#llx; now %lld objects total\n",
2129 __FUNCTION__,
2130 pcszInterface,
2131 pobjInterface,
2132 pobjUnknown,
2133 cRefs1,
2134 cRefs2,
2135 _id,
2136 cTotal));
2137}
2138
2139/**
2140 * Destructor; removes the instance from the global hash of
2141 * managed objects. Calls Release() on the contained COM object.
2142 *
2143 * Preconditions: Caller must have locked g_pWebsessionsLockHandle.
2144 */
2145ManagedObjectRef::~ManagedObjectRef()
2146{
2147 Assert(g_pWebsessionsLockHandle->isWriteLockOnCurrentThread());
2148 ULONG64 cTotal = --g_cManagedObjects;
2149
2150 Assert(_pobjUnknown);
2151 Assert(_pobjInterface);
2152
2153 // we called AddRef() on both interfaces, so call Release() on
2154 // both as well, but in reverse order
2155 uint32_t cRefs2 = ((IUnknown*)_pobjInterface)->Release();
2156 uint32_t cRefs1 = _pobjUnknown->Release();
2157 WEBDEBUG((" * %s: deleting MOR for ID %#llx (%s; COM refcount now %RI32/%RI32); now %lld objects total\n", __FUNCTION__, _id, _pcszInterface, cRefs1, cRefs2, cTotal));
2158
2159 // if we're being destroyed from the websession's destructor,
2160 // then that destructor is iterating over the maps, so
2161 // don't remove us there! (data integrity + speed)
2162 if (!_websession._fDestructing)
2163 {
2164 WEBDEBUG((" * %s: removing from websession maps\n", __FUNCTION__));
2165 _websession._pp->_mapManagedObjectsById.erase(_id);
2166 if (_websession._pp->_mapManagedObjectsByPtr.erase(_ulp) != 1)
2167 WEBDEBUG((" WARNING: could not find %#llx in _mapManagedObjectsByPtr\n", _ulp));
2168 }
2169}
2170
2171/**
2172 * Static helper method for findObjectFromRef() template that actually
2173 * looks up the object from a given integer ID.
2174 *
2175 * This has been extracted into this non-template function to reduce
2176 * code bloat as we have the actual STL map lookup only in this function.
2177 *
2178 * This also "touches" the timestamp in the websession whose ID is encoded
2179 * in the given integer ID, in order to prevent the websession from timing
2180 * out.
2181 *
2182 * Preconditions: Caller must have locked g_pWebsessionsLockHandle.
2183 *
2184 * @param strId
2185 * @param iter
2186 * @return
2187 */
2188int ManagedObjectRef::findRefFromId(const WSDLT_ID &id,
2189 ManagedObjectRef **pRef,
2190 bool fNullAllowed)
2191{
2192 int rc = 0;
2193
2194 do
2195 {
2196 // allow NULL (== empty string) input reference, which should return a NULL pointer
2197 if (!id.length() && fNullAllowed)
2198 {
2199 *pRef = NULL;
2200 return 0;
2201 }
2202
2203 uint64_t websessId;
2204 uint64_t objId;
2205 WEBDEBUG((" %s(): looking up objref %s\n", __FUNCTION__, id.c_str()));
2206 if (!SplitManagedObjectRef(id,
2207 &websessId,
2208 &objId))
2209 {
2210 rc = VERR_WEB_INVALID_MANAGED_OBJECT_REFERENCE;
2211 break;
2212 }
2213
2214 WebsessionsMapIterator it = g_mapWebsessions.find(websessId);
2215 if (it == g_mapWebsessions.end())
2216 {
2217 WEBDEBUG((" %s: cannot find websession for objref %s\n", __FUNCTION__, id.c_str()));
2218 rc = VERR_WEB_INVALID_SESSION_ID;
2219 break;
2220 }
2221
2222 WebServiceSession *pWebsession = it->second;
2223 // "touch" websession to prevent it from timing out
2224 pWebsession->touch();
2225
2226 ManagedObjectsIteratorById iter = pWebsession->_pp->_mapManagedObjectsById.find(objId);
2227 if (iter == pWebsession->_pp->_mapManagedObjectsById.end())
2228 {
2229 WEBDEBUG((" %s: cannot find comobj for objref %s\n", __FUNCTION__, id.c_str()));
2230 rc = VERR_WEB_INVALID_OBJECT_ID;
2231 break;
2232 }
2233
2234 *pRef = iter->second;
2235
2236 } while (0);
2237
2238 return rc;
2239}
2240
2241/****************************************************************************
2242 *
2243 * interface IManagedObjectRef
2244 *
2245 ****************************************************************************/
2246
2247/**
2248 * This is the hard-coded implementation for the IManagedObjectRef::getInterfaceName()
2249 * that our WSDL promises to our web service clients. This method returns a
2250 * string describing the interface that this managed object reference
2251 * supports, e.g. "IMachine".
2252 *
2253 * @param soap
2254 * @param req
2255 * @param resp
2256 * @return
2257 */
2258int __vbox__IManagedObjectRef_USCOREgetInterfaceName(
2259 struct soap *soap,
2260 _vbox__IManagedObjectRef_USCOREgetInterfaceName *req,
2261 _vbox__IManagedObjectRef_USCOREgetInterfaceNameResponse *resp)
2262{
2263 HRESULT rc = S_OK;
2264 WEBDEBUG(("-- entering %s\n", __FUNCTION__));
2265
2266 do
2267 {
2268 // findRefFromId require the lock
2269 util::AutoWriteLock lock(g_pWebsessionsLockHandle COMMA_LOCKVAL_SRC_POS);
2270
2271 ManagedObjectRef *pRef;
2272 if (!ManagedObjectRef::findRefFromId(req->_USCOREthis, &pRef, false))
2273 resp->returnval = pRef->getInterfaceName();
2274
2275 } while (0);
2276
2277 WEBDEBUG(("-- leaving %s, rc: %#lx\n", __FUNCTION__, rc));
2278 if (FAILED(rc))
2279 return SOAP_FAULT;
2280 return SOAP_OK;
2281}
2282
2283/**
2284 * This is the hard-coded implementation for the IManagedObjectRef::release()
2285 * that our WSDL promises to our web service clients. This method releases
2286 * a managed object reference and removes it from our stacks.
2287 *
2288 * @param soap
2289 * @param req
2290 * @param resp
2291 * @return
2292 */
2293int __vbox__IManagedObjectRef_USCORErelease(
2294 struct soap *soap,
2295 _vbox__IManagedObjectRef_USCORErelease *req,
2296 _vbox__IManagedObjectRef_USCOREreleaseResponse *resp)
2297{
2298 HRESULT rc = S_OK;
2299 WEBDEBUG(("-- entering %s\n", __FUNCTION__));
2300
2301 do
2302 {
2303 // findRefFromId and the delete call below require the lock
2304 util::AutoWriteLock lock(g_pWebsessionsLockHandle COMMA_LOCKVAL_SRC_POS);
2305
2306 ManagedObjectRef *pRef;
2307 if ((rc = ManagedObjectRef::findRefFromId(req->_USCOREthis, &pRef, false)))
2308 {
2309 RaiseSoapInvalidObjectFault(soap, req->_USCOREthis);
2310 break;
2311 }
2312
2313 WEBDEBUG((" found reference; deleting!\n"));
2314 // this removes the object from all stacks; since
2315 // there's a ComPtr<> hidden inside the reference,
2316 // this should also invoke Release() on the COM
2317 // object
2318 delete pRef;
2319 } while (0);
2320
2321 WEBDEBUG(("-- leaving %s, rc: %#lx\n", __FUNCTION__, rc));
2322 if (FAILED(rc))
2323 return SOAP_FAULT;
2324 return SOAP_OK;
2325}
2326
2327/****************************************************************************
2328 *
2329 * interface IWebsessionManager
2330 *
2331 ****************************************************************************/
2332
2333/**
2334 * Hard-coded implementation for IWebsessionManager::logon. As opposed to the underlying
2335 * COM API, this is the first method that a webservice client must call before the
2336 * webservice will do anything useful.
2337 *
2338 * This returns a managed object reference to the global IVirtualBox object; into this
2339 * reference a websession ID is encoded which remains constant with all managed object
2340 * references returned by other methods.
2341 *
2342 * When the webservice client is done, it should call IWebsessionManager::logoff. This
2343 * will clean up internally (destroy all remaining managed object references and
2344 * related COM objects used internally).
2345 *
2346 * After logon, an internal timeout ensures that if the webservice client does not
2347 * call any methods, after a configurable number of seconds, the webservice will log
2348 * off the client automatically. This is to ensure that the webservice does not
2349 * drown in managed object references and eventually deny service. Still, it is
2350 * a much better solution, both for performance and cleanliness, for the webservice
2351 * client to clean up itself.
2352 *
2353 * @param
2354 * @param vbox__IWebsessionManager_USCORElogon
2355 * @param vbox__IWebsessionManager_USCORElogonResponse
2356 * @return
2357 */
2358int __vbox__IWebsessionManager_USCORElogon(
2359 struct soap *soap,
2360 _vbox__IWebsessionManager_USCORElogon *req,
2361 _vbox__IWebsessionManager_USCORElogonResponse *resp)
2362{
2363 HRESULT rc = S_OK;
2364 WEBDEBUG(("-- entering %s\n", __FUNCTION__));
2365
2366 do
2367 {
2368 // WebServiceSession constructor tinkers with global MOR map and requires a write lock
2369 util::AutoWriteLock lock(g_pWebsessionsLockHandle COMMA_LOCKVAL_SRC_POS);
2370
2371 // create new websession; the constructor stores the new websession
2372 // in the global map automatically
2373 WebServiceSession *pWebsession = new WebServiceSession();
2374 ComPtr<IVirtualBox> pVirtualBox;
2375
2376 // authenticate the user
2377 if (!(pWebsession->authenticate(req->username.c_str(),
2378 req->password.c_str(),
2379 pVirtualBox.asOutParam())))
2380 {
2381 // fake up a "root" MOR for this websession
2382 char sz[34];
2383 MakeManagedObjectRef(sz, pWebsession->getID(), 0ULL);
2384 WSDLT_ID id = sz;
2385
2386 // in the new websession, create a managed object reference (MOR) for the
2387 // global VirtualBox object; this encodes the websession ID in the MOR so
2388 // that it will be implicitly be included in all future requests of this
2389 // webservice client
2390 resp->returnval = createOrFindRefFromComPtr(id, g_pcszIVirtualBox, pVirtualBox);
2391 WEBDEBUG(("VirtualBox object ref is %s\n", resp->returnval.c_str()));
2392 }
2393 else
2394 rc = E_FAIL;
2395 } while (0);
2396
2397 WEBDEBUG(("-- leaving %s, rc: %#lx\n", __FUNCTION__, rc));
2398 if (FAILED(rc))
2399 return SOAP_FAULT;
2400 return SOAP_OK;
2401}
2402
2403/**
2404 * Returns a new ISession object every time.
2405 *
2406 * No longer connected in any way to logons, one websession can easily
2407 * handle multiple sessions.
2408 */
2409int __vbox__IWebsessionManager_USCOREgetSessionObject(
2410 struct soap*,
2411 _vbox__IWebsessionManager_USCOREgetSessionObject *req,
2412 _vbox__IWebsessionManager_USCOREgetSessionObjectResponse *resp)
2413{
2414 HRESULT rc = S_OK;
2415 WEBDEBUG(("-- entering %s\n", __FUNCTION__));
2416
2417 do
2418 {
2419 // create a new ISession object
2420 ComPtr<ISession> pSession;
2421 rc = g_pVirtualBoxClient->COMGETTER(Session)(pSession.asOutParam());
2422 if (FAILED(rc))
2423 {
2424 WEBDEBUG(("ERROR: cannot create session object!"));
2425 break;
2426 }
2427
2428 // return its MOR
2429 resp->returnval = createOrFindRefFromComPtr(req->refIVirtualBox, g_pcszISession, pSession);
2430 WEBDEBUG(("Session object ref is %s\n", resp->returnval.c_str()));
2431 } while (0);
2432
2433 WEBDEBUG(("-- leaving %s, rc: %#lx\n", __FUNCTION__, rc));
2434 if (FAILED(rc))
2435 return SOAP_FAULT;
2436 return SOAP_OK;
2437}
2438
2439/**
2440 * hard-coded implementation for IWebsessionManager::logoff.
2441 *
2442 * @param
2443 * @param vbox__IWebsessionManager_USCORElogon
2444 * @param vbox__IWebsessionManager_USCORElogonResponse
2445 * @return
2446 */
2447int __vbox__IWebsessionManager_USCORElogoff(
2448 struct soap*,
2449 _vbox__IWebsessionManager_USCORElogoff *req,
2450 _vbox__IWebsessionManager_USCORElogoffResponse *resp)
2451{
2452 HRESULT rc = S_OK;
2453 WEBDEBUG(("-- entering %s\n", __FUNCTION__));
2454
2455 do
2456 {
2457 // findWebsessionFromRef and the websession destructor require the lock
2458 util::AutoWriteLock lock(g_pWebsessionsLockHandle COMMA_LOCKVAL_SRC_POS);
2459
2460 WebServiceSession* pWebsession;
2461 if ((pWebsession = WebServiceSession::findWebsessionFromRef(req->refIVirtualBox)))
2462 {
2463 WEBDEBUG(("websession logoff, deleting websession %#llx\n", pWebsession->getID()));
2464 delete pWebsession;
2465 // destructor cleans up
2466
2467 WEBDEBUG(("websession destroyed, %d websessions left open\n", g_mapWebsessions.size()));
2468 }
2469 } while (0);
2470
2471 WEBDEBUG(("-- leaving %s, rc: %#lx\n", __FUNCTION__, rc));
2472 if (FAILED(rc))
2473 return SOAP_FAULT;
2474 return SOAP_OK;
2475}
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