| 1 | /* $Id: ClientToken.h 106061 2024-09-16 14:03:52Z vboxsync $ */
|
|---|
| 2 |
|
|---|
| 3 | /** @file
|
|---|
| 4 | *
|
|---|
| 5 | * VirtualBox API client session token abstraction
|
|---|
| 6 | */
|
|---|
| 7 |
|
|---|
| 8 | /*
|
|---|
| 9 | * Copyright (C) 2013-2024 Oracle and/or its affiliates.
|
|---|
| 10 | *
|
|---|
| 11 | * This file is part of VirtualBox base platform packages, as
|
|---|
| 12 | * available from https://www.virtualbox.org.
|
|---|
| 13 | *
|
|---|
| 14 | * This program is free software; you can redistribute it and/or
|
|---|
| 15 | * modify it under the terms of the GNU General Public License
|
|---|
| 16 | * as published by the Free Software Foundation, in version 3 of the
|
|---|
| 17 | * License.
|
|---|
| 18 | *
|
|---|
| 19 | * This program is distributed in the hope that it will be useful, but
|
|---|
| 20 | * WITHOUT ANY WARRANTY; without even the implied warranty of
|
|---|
| 21 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|---|
| 22 | * General Public License for more details.
|
|---|
| 23 | *
|
|---|
| 24 | * You should have received a copy of the GNU General Public License
|
|---|
| 25 | * along with this program; if not, see <https://www.gnu.org/licenses>.
|
|---|
| 26 | *
|
|---|
| 27 | * SPDX-License-Identifier: GPL-3.0-only
|
|---|
| 28 | */
|
|---|
| 29 |
|
|---|
| 30 | #ifndef MAIN_INCLUDED_ClientToken_h
|
|---|
| 31 | #define MAIN_INCLUDED_ClientToken_h
|
|---|
| 32 | #ifndef RT_WITHOUT_PRAGMA_ONCE
|
|---|
| 33 | # pragma once
|
|---|
| 34 | #endif
|
|---|
| 35 |
|
|---|
| 36 | #include <VBox/com/ptr.h>
|
|---|
| 37 | #include <VBox/com/AutoLock.h>
|
|---|
| 38 |
|
|---|
| 39 | #include "MachineImpl.h"
|
|---|
| 40 | #ifdef VBOX_WITH_GENERIC_SESSION_WATCHER
|
|---|
| 41 | # include "TokenImpl.h"
|
|---|
| 42 | #endif /* VBOX_WITH_GENERIC_SESSION_WATCHER */
|
|---|
| 43 |
|
|---|
| 44 | #if defined(RT_OS_WINDOWS)
|
|---|
| 45 | # define CTTOKENARG NULL
|
|---|
| 46 | # define CTTOKENTYPE HANDLE
|
|---|
| 47 | #elif defined(RT_OS_OS2)
|
|---|
| 48 | # define CTTOKENARG NULLHANDLE
|
|---|
| 49 | # define CTTOKENTYPE HMTX
|
|---|
| 50 | #elif defined(VBOX_WITH_SYS_V_IPC_SESSION_WATCHER)
|
|---|
| 51 | # define CTTOKENARG -1
|
|---|
| 52 | # define CTTOKENTYPE int
|
|---|
| 53 | #elif defined(VBOX_WITH_GENERIC_SESSION_WATCHER)
|
|---|
| 54 | # define CTTOKENARG NULL
|
|---|
| 55 | # define CTTOKENTYPE MachineToken *
|
|---|
| 56 | #else
|
|---|
| 57 | # error "Port me!"
|
|---|
| 58 | #endif
|
|---|
| 59 |
|
|---|
| 60 | /**
|
|---|
| 61 | * Class which represents a token which can be used to check for client
|
|---|
| 62 | * crashes and similar purposes.
|
|---|
| 63 | */
|
|---|
| 64 | class Machine::ClientToken
|
|---|
| 65 | {
|
|---|
| 66 | public:
|
|---|
| 67 | /**
|
|---|
| 68 | * Constructor which creates a usable instance
|
|---|
| 69 | *
|
|---|
| 70 | * @param pMachine Reference to Machine object
|
|---|
| 71 | * @param pSessionMachine Reference to corresponding SessionMachine object
|
|---|
| 72 | */
|
|---|
| 73 | ClientToken(const ComObjPtr<Machine> &pMachine, SessionMachine *pSessionMachine);
|
|---|
| 74 |
|
|---|
| 75 | /**
|
|---|
| 76 | * Default destructor. Cleans everything up.
|
|---|
| 77 | */
|
|---|
| 78 | ~ClientToken();
|
|---|
| 79 |
|
|---|
| 80 | /**
|
|---|
| 81 | * Check if object contains a usable token.
|
|---|
| 82 | */
|
|---|
| 83 | bool isReady();
|
|---|
| 84 |
|
|---|
| 85 | /**
|
|---|
| 86 | * Query token ID, which is a unique string value for this token. Do not
|
|---|
| 87 | * assume any specific content/format, it is opaque information.
|
|---|
| 88 | */
|
|---|
| 89 | void getId(Utf8Str &strId);
|
|---|
| 90 |
|
|---|
| 91 | /**
|
|---|
| 92 | * Query token, which is platform dependent.
|
|---|
| 93 | */
|
|---|
| 94 | CTTOKENTYPE getToken();
|
|---|
| 95 |
|
|---|
| 96 | #ifndef VBOX_WITH_GENERIC_SESSION_WATCHER
|
|---|
| 97 | /**
|
|---|
| 98 | * Release token now. Returns information if the client has terminated.
|
|---|
| 99 | */
|
|---|
| 100 | bool release();
|
|---|
| 101 | #endif /* !VBOX_WITH_GENERIC_SESSION_WATCHER */
|
|---|
| 102 |
|
|---|
| 103 | private:
|
|---|
| 104 | /**
|
|---|
| 105 | * Default constructor. Don't use, will not create a sensible instance.
|
|---|
| 106 | */
|
|---|
| 107 | ClientToken();
|
|---|
| 108 |
|
|---|
| 109 | Machine *mMachine;
|
|---|
| 110 | CTTOKENTYPE mClientToken;
|
|---|
| 111 | Utf8Str mClientTokenId;
|
|---|
| 112 | #ifdef VBOX_WITH_GENERIC_SESSION_WATCHER
|
|---|
| 113 | bool mClientTokenPassed;
|
|---|
| 114 | #endif
|
|---|
| 115 | };
|
|---|
| 116 |
|
|---|
| 117 | #endif /* !MAIN_INCLUDED_ClientToken_h */
|
|---|
| 118 | /* vi: set tabstop=4 shiftwidth=4 expandtab: */
|
|---|
