VBoxGuestR3LibCredentials.cpp revision c7814cf6e1240a519cbec0441e033d0e2470ed00
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync/* $Id$ */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync/** @file
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * VBoxGuestR3Lib - Ring-3 Support Library for VirtualBox guest additions, user credentials.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync/*
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * Copyright (C) 2009-2012 Oracle Corporation
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync *
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * available from http://www.virtualbox.org. This file is free software;
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * you can redistribute it and/or modify it under the terms of the GNU
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * General Public License (GPL) as published by the Free Software
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync *
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * The contents of this file may alternatively be used under the terms
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * of the Common Development and Distribution License Version 1.0
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * VirtualBox OSE distribution, in which case the provisions of the
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * CDDL are applicable instead of those of the GPL.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync *
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * You may elect to license modified versions of this file under the
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * terms and conditions of either the GPL or the CDDL or both.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync/*******************************************************************************
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync* Header Files *
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync*******************************************************************************/
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync#include <iprt/asm.h>
99cfb4b2e2b340e368182fbf3e5ddd29d4b27180vboxsync#include <iprt/mem.h>
99cfb4b2e2b340e368182fbf3e5ddd29d4b27180vboxsync#include <iprt/rand.h>
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync#include <iprt/string.h>
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync#include <VBox/log.h>
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync#include "VBGLR3Internal.h"
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync/**
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * Checks whether user credentials are available to the guest or not.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync *
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @returns IPRT status value; VINF_SUCCESS if credentials are available,
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * VERR_NOT_FOUND if not. Otherwise an error is occurred.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncVBGLR3DECL(int) VbglR3CredentialsQueryAvailability(void)
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync{
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync VMMDevCredentials Req;
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync RT_ZERO(Req);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync vmmdevInitRequest((VMMDevRequestHeader*)&Req, VMMDevReq_QueryCredentials);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync Req.u32Flags |= VMMDEV_CREDENTIALS_QUERYPRESENCE;
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync int rc = vbglR3GRPerform(&Req.header);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync if (RT_SUCCESS(rc))
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync {
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync if ((Req.u32Flags & VMMDEV_CREDENTIALS_PRESENT) == 0)
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync rc = VERR_NOT_FOUND;
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync }
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync return rc;
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync}
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync/**
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * Retrieves and clears the user credentials for logging into the guest OS.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync *
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @returns IPRT status value
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param ppszUser Receives pointer of allocated user name string.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * The returned pointer must be freed using VbglR3CredentialsDestroy().
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param ppszPassword Receives pointer of allocated user password string.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * The returned pointer must be freed using VbglR3CredentialsDestroy().
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param ppszDomain Receives pointer of allocated domain name string.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * The returned pointer must be freed using VbglR3CredentialsDestroy().
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncVBGLR3DECL(int) VbglR3CredentialsRetrieve(char **ppszUser, char **ppszPassword, char **ppszDomain)
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync{
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync AssertPtrReturn(ppszUser, VERR_INVALID_POINTER);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync AssertPtrReturn(ppszPassword, VERR_INVALID_POINTER);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync AssertPtrReturn(ppszDomain, VERR_INVALID_POINTER);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync VMMDevCredentials Req;
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync RT_ZERO(Req);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync vmmdevInitRequest((VMMDevRequestHeader*)&Req, VMMDevReq_QueryCredentials);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync Req.u32Flags |= VMMDEV_CREDENTIALS_READ | VMMDEV_CREDENTIALS_CLEAR;
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync int rc = vbglR3GRPerform(&Req.header);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync if (RT_SUCCESS(rc))
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync {
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync rc = RTStrDupEx(ppszUser, Req.szUserName);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync if (RT_SUCCESS(rc))
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync {
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync rc = RTStrDupEx(ppszPassword, Req.szPassword);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync if (RT_SUCCESS(rc))
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync {
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync rc = RTStrDupEx(ppszDomain, Req.szDomain);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync if (RT_SUCCESS(rc))
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync return VINF_SUCCESS;
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync RTStrFree(*ppszPassword);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync }
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync RTStrFree(*ppszUser);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync }
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync }
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync return rc;
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync}
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync/**
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * Retrieves and clears the user credentials for logging into the guest OS.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * UTF-16 version.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync *
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @returns IPRT status value
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param ppwszUser Receives pointer of allocated user name string.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * The returned pointer must be freed using VbglR3CredentialsDestroyUtf16().
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param ppswzPassword Receives pointer of allocated user password string.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * The returned pointer must be freed using VbglR3CredentialsDestroyUtf16().
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param ppwszDomain Receives pointer of allocated domain name string.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * The returned pointer must be freed using VbglR3CredentialsDestroyUtf16().
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncVBGLR3DECL(int) VbglR3CredentialsRetrieveUtf16(PRTUTF16 *ppwszUser, PRTUTF16 *ppwszPassword, PRTUTF16 *ppwszDomain)
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync{
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync AssertPtrReturn(ppwszUser, VERR_INVALID_POINTER);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync AssertPtrReturn(ppwszPassword, VERR_INVALID_POINTER);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync AssertPtrReturn(ppwszDomain, VERR_INVALID_POINTER);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync char *pszUser, *pszPassword, *pszDomain;
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync int rc = VbglR3CredentialsRetrieve(&pszUser, &pszPassword, &pszDomain);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync if (RT_SUCCESS(rc))
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync {
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync PRTUTF16 pwszUser = NULL;
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync PRTUTF16 pwszPassword = NULL;
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync PRTUTF16 pwszDomain = NULL;
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync rc = RTStrToUtf16(pszUser, &pwszUser);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync if (RT_SUCCESS(rc))
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync {
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync rc = RTStrToUtf16(pszPassword, &pwszPassword);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync if (RT_SUCCESS(rc))
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync rc = RTStrToUtf16(pszDomain, &pwszDomain);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync }
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync if (RT_SUCCESS(rc))
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync {
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync *ppwszUser = pwszUser;
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync *ppwszPassword = pwszPassword;
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync *ppwszDomain = pwszDomain;
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync }
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync else
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync VbglR3CredentialsDestroyUtf16(pwszUser, pwszPassword, pwszDomain, 3 /* Passes */);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync VbglR3CredentialsDestroy(pszUser, pszPassword, pszDomain, 3 /* Passes */);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync }
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync return rc;
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync}
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync/**
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * Clears and frees the three strings.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync *
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param pszUser Receives pointer of the user name string to destroy.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * Optional.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param pszPassword Receives pointer of the password string to destroy.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * Optional.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param pszDomain Receives pointer of allocated domain name string.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * Optional.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param cPasses Number of wipe passes. The more the better + slower.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncVBGLR3DECL(void) VbglR3CredentialsDestroy(char *pszUser, char *pszPassword, char *pszDomain, uint32_t cPasses)
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync{
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync /* wipe first */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync if (pszUser)
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync RTMemWipeThoroughly(pszUser, strlen(pszUser) + 1, cPasses);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync if (pszPassword)
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync RTMemWipeThoroughly(pszPassword, strlen(pszPassword) + 1, cPasses);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync if (pszDomain)
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync RTMemWipeThoroughly(pszDomain, strlen(pszDomain) + 1, cPasses);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync /* then free. */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync RTStrFree(pszUser);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync RTStrFree(pszPassword);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync RTStrFree(pszDomain);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync}
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync/**
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * Clears and frees the three strings. UTF-16 version.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync *
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param pwszUser Receives pointer of the user name string to destroy.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * Optional.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param pwszPassword Receives pointer of the password string to destroy.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * Optional.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param pwszDomain Receives pointer of allocated domain name string.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * Optional.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync * @param cPasses Number of wipe passes. The more the better + slower.
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsyncVBGLR3DECL(void) VbglR3CredentialsDestroyUtf16(PRTUTF16 pwszUser, PRTUTF16 pwszPassword, PRTUTF16 pwszDomain,
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync uint32_t cPasses)
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync{
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync /* wipe first */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync if (pwszUser)
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync RTMemWipeThoroughly(pwszUser, (RTUtf16Len(pwszUser) + 1) * sizeof(RTUTF16), cPasses);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync if (pwszPassword)
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync RTMemWipeThoroughly(pwszPassword, (RTUtf16Len(pwszPassword) + 1) * sizeof(RTUTF16), cPasses);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync if (pwszDomain)
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync RTMemWipeThoroughly(pwszDomain, (RTUtf16Len(pwszDomain) + 1) * sizeof(RTUTF16), cPasses);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync /* then free. */
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync RTUtf16Free(pwszUser);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync RTUtf16Free(pwszPassword);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync RTUtf16Free(pwszDomain);
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync}
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync
0b74a2f80aba476dc8be8bc1c63891fc53945986vboxsync