VirtualBox

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

Last change on this file since 45674 was 45367, checked in by vboxsync, 12 years ago

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