| 1 | /** @file
|
|---|
| 2 | * VBox Remote Desktop Protocol:
|
|---|
| 3 | * External Authentication Library Interface.
|
|---|
| 4 | */
|
|---|
| 5 |
|
|---|
| 6 | /*
|
|---|
| 7 | * Copyright (C) 2006-2007 innotek GmbH
|
|---|
| 8 | *
|
|---|
| 9 | * This file is part of VirtualBox Open Source Edition (OSE), as
|
|---|
| 10 | * available from http://www.virtualbox.org. This file is free software;
|
|---|
| 11 | * you can redistribute it and/or modify it under the terms of the GNU
|
|---|
| 12 | * General Public License as published by the Free Software Foundation,
|
|---|
| 13 | * in version 2 as it comes in the "COPYING" file of the VirtualBox OSE
|
|---|
| 14 | * distribution. VirtualBox OSE is distributed in the hope that it will
|
|---|
| 15 | * be useful, but WITHOUT ANY WARRANTY of any kind.
|
|---|
| 16 | *
|
|---|
| 17 | * If you received this file as part of a commercial VirtualBox
|
|---|
| 18 | * distribution, then only the terms of your commercial VirtualBox
|
|---|
| 19 | * license agreement apply instead of the previous paragraph.
|
|---|
| 20 | */
|
|---|
| 21 |
|
|---|
| 22 | #ifndef __VBox_vrdpauth_h__
|
|---|
| 23 | #define __VBox_vrdpauth_h__
|
|---|
| 24 |
|
|---|
| 25 | /* The following 2 enums are 32 bits values.*/
|
|---|
| 26 | typedef enum _VRDPAuthResult
|
|---|
| 27 | {
|
|---|
| 28 | VRDPAuthAccessDenied = 0,
|
|---|
| 29 | VRDPAuthAccessGranted = 1,
|
|---|
| 30 | VRDPAuthDelegateToGuest = 2,
|
|---|
| 31 | VRDPAuthSizeHack = 0x7fffffff
|
|---|
| 32 | } VRDPAuthResult;
|
|---|
| 33 |
|
|---|
| 34 | typedef enum _VRDPAuthGuestJudgement
|
|---|
| 35 | {
|
|---|
| 36 | VRDPAuthGuestNotAsked = 0,
|
|---|
| 37 | VRDPAuthGuestAccessDenied = 1,
|
|---|
| 38 | VRDPAuthGuestNoJudgement = 2,
|
|---|
| 39 | VRDPAuthGuestAccessGranted = 3,
|
|---|
| 40 | VRDPAuthGuestNotReacted = 4,
|
|---|
| 41 | VRDPAuthGuestSizeHack = 0x7fffffff
|
|---|
| 42 | } VRDPAuthGuestJudgement;
|
|---|
| 43 |
|
|---|
| 44 | /* UUID memory representation. Array of 16 bytes. */
|
|---|
| 45 | typedef unsigned char VRDPAUTHUUID[16];
|
|---|
| 46 | typedef VRDPAUTHUUID *PVRDPAUTHUUID;
|
|---|
| 47 |
|
|---|
| 48 |
|
|---|
| 49 | /* The library entry point calling convention. */
|
|---|
| 50 | #ifdef _MSC_VER
|
|---|
| 51 | # define VRDPAUTHCALL __cdecl
|
|---|
| 52 | #elif defined(__GNUC__)
|
|---|
| 53 | # define VRDPAUTHCALL
|
|---|
| 54 | #else
|
|---|
| 55 | # error "Unsupported compiler"
|
|---|
| 56 | #endif
|
|---|
| 57 |
|
|---|
| 58 |
|
|---|
| 59 | /**
|
|---|
| 60 | * Authentication library entry point. Decides whether to allow
|
|---|
| 61 | * a client connection.
|
|---|
| 62 | *
|
|---|
| 63 | * Parameters:
|
|---|
| 64 | *
|
|---|
| 65 | * pUuid Pointer to the UUID of the virtual machine
|
|---|
| 66 | * which the client connected to.
|
|---|
| 67 | * guestJudgement Result of the guest authentication.
|
|---|
| 68 | * szUser User name passed in by the client (UTF8).
|
|---|
| 69 | * szPassword Password passed in by the client (UTF8).
|
|---|
| 70 | * szDomain Domain passed in by the client (UTF8).
|
|---|
| 71 | *
|
|---|
| 72 | * Return code:
|
|---|
| 73 | *
|
|---|
| 74 | * VRDPAuthAccessDenied Client access has been denied.
|
|---|
| 75 | * VRDPAuthAccessGranted Client has the right to use the
|
|---|
| 76 | * virtual machine.
|
|---|
| 77 | * VRDPAuthDelegateToGuest Guest operating system must
|
|---|
| 78 | * authenticate the client and the
|
|---|
| 79 | * library must be called again with
|
|---|
| 80 | * the result of the guest
|
|---|
| 81 | * authentication.
|
|---|
| 82 | */
|
|---|
| 83 | typedef VRDPAuthResult VRDPAUTHCALL VRDPAUTHENTRY(PVRDPAUTHUUID pUuid,
|
|---|
| 84 | VRDPAuthGuestJudgement guestJudgement,
|
|---|
| 85 | const char *szUser,
|
|---|
| 86 | const char *szPassword,
|
|---|
| 87 | const char *szDomain);
|
|---|
| 88 |
|
|---|
| 89 |
|
|---|
| 90 | typedef VRDPAUTHENTRY *PVRDPAUTHENTRY;
|
|---|
| 91 |
|
|---|
| 92 | /**
|
|---|
| 93 | * Authentication library entry point version 2. Decides whether to allow
|
|---|
| 94 | * a client connection.
|
|---|
| 95 | *
|
|---|
| 96 | * Parameters:
|
|---|
| 97 | *
|
|---|
| 98 | * pUuid Pointer to the UUID of the virtual machine
|
|---|
| 99 | * which the client connected to.
|
|---|
| 100 | * guestJudgement Result of the guest authentication.
|
|---|
| 101 | * szUser User name passed in by the client (UTF8).
|
|---|
| 102 | * szPassword Password passed in by the client (UTF8).
|
|---|
| 103 | * szDomain Domain passed in by the client (UTF8).
|
|---|
| 104 | * fLogon Boolean flag. Indicates whether the entry point is called
|
|---|
| 105 | * for a client logon or the client disconnect.
|
|---|
| 106 | * clientId Server side unique identifier of the client.
|
|---|
| 107 | *
|
|---|
| 108 | * Return code:
|
|---|
| 109 | *
|
|---|
| 110 | * VRDPAuthAccessDenied Client access has been denied.
|
|---|
| 111 | * VRDPAuthAccessGranted Client has the right to use the
|
|---|
| 112 | * virtual machine.
|
|---|
| 113 | * VRDPAuthDelegateToGuest Guest operating system must
|
|---|
| 114 | * authenticate the client and the
|
|---|
| 115 | * library must be called again with
|
|---|
| 116 | * the result of the guest
|
|---|
| 117 | * authentication.
|
|---|
| 118 | *
|
|---|
| 119 | * Note: When 'fLogon' is false, only pUuid and clientId are valid and the return
|
|---|
| 120 | * code is ignored.
|
|---|
| 121 | */
|
|---|
| 122 | typedef VRDPAuthResult VRDPAUTHCALL VRDPAUTHENTRY2(PVRDPAUTHUUID pUuid,
|
|---|
| 123 | VRDPAuthGuestJudgement guestJudgement,
|
|---|
| 124 | const char *szUser,
|
|---|
| 125 | const char *szPassword,
|
|---|
| 126 | const char *szDomain,
|
|---|
| 127 | bool fLogon,
|
|---|
| 128 | unsigned clientId);
|
|---|
| 129 |
|
|---|
| 130 |
|
|---|
| 131 | typedef VRDPAUTHENTRY2 *PVRDPAUTHENTRY2;
|
|---|
| 132 |
|
|---|
| 133 | #endif /* __VBox_vrdpauth_h__ */
|
|---|
