summaryrefslogtreecommitdiffstats
path: root/src/VBox/Main/src-all/AuthLibrary.cpp
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--src/VBox/Main/src-all/AuthLibrary.cpp267
1 files changed, 267 insertions, 0 deletions
diff --git a/src/VBox/Main/src-all/AuthLibrary.cpp b/src/VBox/Main/src-all/AuthLibrary.cpp
new file mode 100644
index 00000000..f58c11ef
--- /dev/null
+++ b/src/VBox/Main/src-all/AuthLibrary.cpp
@@ -0,0 +1,267 @@
+/* $Id: AuthLibrary.cpp $ */
+/** @file
+ * Main - External authentication library interface.
+ */
+
+/*
+ * Copyright (C) 2015-2023 Oracle and/or its affiliates.
+ *
+ * This file is part of VirtualBox base platform packages, as
+ * available from https://www.virtualbox.org.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation, in version 3 of the
+ * License.
+ *
+ * This program is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, see <https://www.gnu.org/licenses>.
+ *
+ * SPDX-License-Identifier: GPL-3.0-only
+ */
+
+#define LOG_GROUP LOG_GROUP_MAIN
+#include "AuthLibrary.h"
+#include "LoggingNew.h"
+
+#include <iprt/err.h>
+#include <iprt/ldr.h>
+#include <iprt/path.h>
+#include <iprt/string.h>
+#include <iprt/thread.h>
+
+typedef struct AuthCtx
+{
+ AuthResult result;
+
+ PAUTHENTRY3 pfnAuthEntry3;
+ PAUTHENTRY2 pfnAuthEntry2;
+ PAUTHENTRY pfnAuthEntry;
+
+ const char *pszCaller;
+ PAUTHUUID pUuid;
+ AuthGuestJudgement guestJudgement;
+ const char *pszUser;
+ const char *pszPassword;
+ const char *pszDomain;
+ int fLogon;
+ unsigned clientId;
+} AuthCtx;
+
+static DECLCALLBACK(int) authThread(RTTHREAD hThreadSelf, void *pvUser)
+{
+ RT_NOREF(hThreadSelf);
+ AuthCtx *pCtx = (AuthCtx *)pvUser;
+
+ if (pCtx->pfnAuthEntry3)
+ {
+ pCtx->result = pCtx->pfnAuthEntry3(pCtx->pszCaller, pCtx->pUuid, pCtx->guestJudgement,
+ pCtx->pszUser, pCtx->pszPassword, pCtx->pszDomain,
+ pCtx->fLogon, pCtx->clientId);
+ }
+ else if (pCtx->pfnAuthEntry2)
+ {
+ pCtx->result = pCtx->pfnAuthEntry2(pCtx->pUuid, pCtx->guestJudgement,
+ pCtx->pszUser, pCtx->pszPassword, pCtx->pszDomain,
+ pCtx->fLogon, pCtx->clientId);
+ }
+ else if (pCtx->pfnAuthEntry)
+ {
+ pCtx->result = pCtx->pfnAuthEntry(pCtx->pUuid, pCtx->guestJudgement,
+ pCtx->pszUser, pCtx->pszPassword, pCtx->pszDomain);
+ }
+ return VINF_SUCCESS;
+}
+
+static AuthResult authCall(AuthCtx *pCtx)
+{
+ AuthResult result = AuthResultAccessDenied;
+
+ /* Use a separate thread because external modules might need a lot of stack space. */
+ RTTHREAD thread = NIL_RTTHREAD;
+ int vrc = RTThreadCreate(&thread, authThread, pCtx, 512*_1K,
+ RTTHREADTYPE_DEFAULT, RTTHREADFLAGS_WAITABLE, "VRDEAuth");
+ LogFlowFunc(("RTThreadCreate %Rrc\n", vrc));
+
+ if (RT_SUCCESS(vrc))
+ {
+ vrc = RTThreadWait(thread, RT_INDEFINITE_WAIT, NULL);
+ LogFlowFunc(("RTThreadWait %Rrc\n", vrc));
+ }
+
+ if (RT_SUCCESS(vrc))
+ {
+ /* Only update the result if the thread finished without errors. */
+ result = pCtx->result;
+ }
+ else
+ {
+ LogRel(("AUTH: Unable to execute the auth thread %Rrc\n", vrc));
+ }
+
+ return result;
+}
+
+int AuthLibLoad(AUTHLIBRARYCONTEXT *pAuthLibCtx, const char *pszLibrary)
+{
+ RT_ZERO(*pAuthLibCtx);
+
+ /* Load the external authentication library. */
+ LogRel(("AUTH: Loading external authentication library '%s'\n", pszLibrary));
+
+ int vrc;
+ if (RTPathHavePath(pszLibrary))
+ vrc = RTLdrLoad(pszLibrary, &pAuthLibCtx->hAuthLibrary);
+ else
+ {
+ vrc = RTLdrLoadAppPriv(pszLibrary, &pAuthLibCtx->hAuthLibrary);
+ if (RT_FAILURE(vrc))
+ {
+ /* Backward compatibility with old default 'VRDPAuth' name.
+ * Try to load new default 'VBoxAuth' instead.
+ */
+ if (RTStrICmp(pszLibrary, "VRDPAuth") == 0)
+ {
+ LogRel(("AUTH: Loading external authentication library 'VBoxAuth'\n"));
+ vrc = RTLdrLoadAppPriv("VBoxAuth", &pAuthLibCtx->hAuthLibrary);
+ }
+ }
+ }
+
+ if (RT_FAILURE(vrc))
+ {
+ LogRel(("AUTH: Failed to load external authentication library: %Rrc\n", vrc));
+ pAuthLibCtx->hAuthLibrary = NIL_RTLDRMOD;
+ }
+
+ if (RT_SUCCESS(vrc))
+ {
+ typedef struct AuthEntryInfoStruct
+ {
+ const char *pszName;
+ void **ppvAddress;
+ } AuthEntryInfo;
+
+ AuthEntryInfo entries[] =
+ {
+ { AUTHENTRY3_NAME, (void **)&pAuthLibCtx->pfnAuthEntry3 },
+ { AUTHENTRY2_NAME, (void **)&pAuthLibCtx->pfnAuthEntry2 },
+ { AUTHENTRY_NAME, (void **)&pAuthLibCtx->pfnAuthEntry },
+ { NULL, NULL }
+ };
+
+ /* Get the entry point. */
+ AuthEntryInfo *pEntryInfo = &entries[0];
+ while (pEntryInfo->pszName)
+ {
+ *pEntryInfo->ppvAddress = NULL;
+
+ int vrc2 = RTLdrGetSymbol(pAuthLibCtx->hAuthLibrary, pEntryInfo->pszName, pEntryInfo->ppvAddress);
+ if (RT_SUCCESS(vrc2))
+ {
+ /* Found an entry point. */
+ LogRel(("AUTH: Using entry point '%s'\n", pEntryInfo->pszName));
+ vrc = VINF_SUCCESS;
+ break;
+ }
+
+ if (vrc2 != VERR_SYMBOL_NOT_FOUND)
+ LogRel(("AUTH: Could not resolve import '%s': %Rrc\n", pEntryInfo->pszName, vrc2));
+
+ vrc = vrc2;
+
+ pEntryInfo++;
+ }
+ }
+
+ if (RT_FAILURE(vrc))
+ AuthLibUnload(pAuthLibCtx);
+
+ return vrc;
+}
+
+void AuthLibUnload(AUTHLIBRARYCONTEXT *pAuthLibCtx)
+{
+ if (pAuthLibCtx->hAuthLibrary != NIL_RTLDRMOD)
+ RTLdrClose(pAuthLibCtx->hAuthLibrary);
+
+ RT_ZERO(*pAuthLibCtx);
+ pAuthLibCtx->hAuthLibrary = NIL_RTLDRMOD;
+}
+
+AuthResult AuthLibAuthenticate(const AUTHLIBRARYCONTEXT *pAuthLibCtx,
+ PCRTUUID pUuid, AuthGuestJudgement guestJudgement,
+ const char *pszUser, const char *pszPassword, const char *pszDomain,
+ uint32_t u32ClientId)
+{
+ AuthResult result = AuthResultAccessDenied;
+
+ AUTHUUID rawuuid;
+ memcpy(rawuuid, pUuid, sizeof(rawuuid));
+
+ LogFlowFunc(("pAuthLibCtx = %p, uuid = %RTuuid, guestJudgement = %d, pszUser = %s, pszPassword = %s, pszDomain = %s, u32ClientId = %d\n",
+ pAuthLibCtx, rawuuid, guestJudgement, pszUser, pszPassword, pszDomain, u32ClientId));
+
+ if ( pAuthLibCtx->hAuthLibrary
+ && (pAuthLibCtx->pfnAuthEntry || pAuthLibCtx->pfnAuthEntry2 || pAuthLibCtx->pfnAuthEntry3))
+ {
+ AuthCtx ctx;
+ ctx.result = AuthResultAccessDenied; /* Denied by default. */
+ ctx.pfnAuthEntry3 = pAuthLibCtx->pfnAuthEntry3;
+ ctx.pfnAuthEntry2 = pAuthLibCtx->pfnAuthEntry2;
+ ctx.pfnAuthEntry = pAuthLibCtx->pfnAuthEntry;
+ ctx.pszCaller = "vrde";
+ ctx.pUuid = &rawuuid;
+ ctx.guestJudgement = guestJudgement;
+ ctx.pszUser = pszUser;
+ ctx.pszPassword = pszPassword;
+ ctx.pszDomain = pszDomain;
+ ctx.fLogon = true;
+ ctx.clientId = u32ClientId;
+
+ result = authCall(&ctx);
+ }
+ else
+ {
+ LogRelMax(8, ("AUTH: Invalid authentication module context\n"));
+ AssertFailed();
+ }
+
+ LogFlowFunc(("result = %d\n", result));
+
+ return result;
+}
+
+void AuthLibDisconnect(const AUTHLIBRARYCONTEXT *pAuthLibCtx, PCRTUUID pUuid, uint32_t u32ClientId)
+{
+ AUTHUUID rawuuid;
+ memcpy(rawuuid, pUuid, sizeof(rawuuid));
+
+ LogFlowFunc(("pAuthLibCtx = %p, , uuid = %RTuuid, u32ClientId = %d\n",
+ pAuthLibCtx, rawuuid, u32ClientId));
+
+ if ( pAuthLibCtx->hAuthLibrary
+ && (pAuthLibCtx->pfnAuthEntry || pAuthLibCtx->pfnAuthEntry2 || pAuthLibCtx->pfnAuthEntry3))
+ {
+ AuthCtx ctx;
+ ctx.result = AuthResultAccessDenied; /* Not used. */
+ ctx.pfnAuthEntry3 = pAuthLibCtx->pfnAuthEntry3;
+ ctx.pfnAuthEntry2 = pAuthLibCtx->pfnAuthEntry2;
+ ctx.pfnAuthEntry = NULL; /* Does not use disconnect notification. */
+ ctx.pszCaller = "vrde";
+ ctx.pUuid = &rawuuid;
+ ctx.guestJudgement = AuthGuestNotAsked;
+ ctx.pszUser = NULL;
+ ctx.pszPassword = NULL;
+ ctx.pszDomain = NULL;
+ ctx.fLogon = false;
+ ctx.clientId = u32ClientId;
+
+ authCall(&ctx);
+ }
+}
generated by cgit v1.2.3 (git 2.39.1) at 2024-09-18 10:26:19 +0000