win32_usertoken_utils.c

/*
* Author: Manoj Ampalam <manoj.ampalam@microsoft.com>
*   Utilities to generate user tokens
*
* Author: Bryan Berns <berns@uwalumni.com>
*   Updated s4u, logon, and profile loading routines to use 
*   normalized login names.
*
* Copyright (c) 2015 Microsoft Corp.
* All rights reserved
*
* Microsoft openssh win32 port
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#define SECURITY_WIN32
#define UMDF_USING_NTSTATUS 
#include <Windows.h>
#include <UserEnv.h>
#include <Ntsecapi.h>
#include <ntstatus.h>
#include <Shlobj.h>
#include <LM.h>
#include <security.h>

#include "inc\utf.h"
#include "w32api_proxies.h"
#include <Ntsecapi.h>
#include <Strsafe.h>
#include <sddl.h>
#include <ntstatus.h>
#include "misc_internal.h"
#include "lsa_missingdefs.h"
#include "Debug.h"
#include "inc\pwd.h"

#pragma warning(push, 3)
HANDLE password_auth_token = NULL;

static void
InitLsaString(LSA_STRING *lsa_string, const char *str)
{
	if (!str)
		memset(lsa_string, 0, sizeof(LSA_STRING));
	else {
		lsa_string->Buffer = (char *)str;
		lsa_string->Length = (USHORT)strlen(str);
		lsa_string->MaximumLength = lsa_string->Length + 1;
	}
}

static void
EnablePrivilege(const char *privName, int enabled)
{
	TOKEN_PRIVILEGES tp;
	HANDLE hProcToken = NULL;
	LUID luid;

	int exitCode = 1;

	if (LookupPrivilegeValueA(NULL, privName, &luid) == FALSE ||
		OpenProcessToken(GetCurrentProcess(), TOKEN_ADJUST_PRIVILEGES, &hProcToken) == FALSE)
		goto done;

	tp.PrivilegeCount = 1;
	tp.Privileges[0].Luid = luid;
	tp.Privileges[0].Attributes = enabled ? SE_PRIVILEGE_ENABLED : 0;

	AdjustTokenPrivileges(hProcToken, FALSE, &tp, sizeof(TOKEN_PRIVILEGES), NULL, NULL);

done:
	if (hProcToken)
		CloseHandle(hProcToken);

	return;
}

BOOL
is_domain_joined_machine(void){
    BOOL result = FALSE;

	LPWSTR name = NULL;
	NETSETUP_JOIN_STATUS s = NetSetupUnknownStatus;
	DWORD api_res = NetGetJoinInformation(NULL, &name, &s);
	if (api_res == NERR_Success) {
		result = s == NetSetupDomainName;
		NetApiBufferFree(name);
		name = NULL;
	}
	else{
		debug("%s: NetGetJoinInformation() failed. Error %d.", __FUNCTION__, api_res);
	}
	debug("%s: NetGetJoinInformation(). Join result %d", __FUNCTION__, result);
	return result;
}

HANDLE
generate_s4u_user_token(wchar_t* user_cpn, int impersonation) {
	HANDLE lsa_handle = NULL, token = NULL;
	ULONG auth_package_id;
	NTSTATUS ret, subStatus;
	void * logon_info = NULL;
	size_t logon_info_size;
	LSA_STRING logon_process_name, auth_package_name, origin_name;
	TOKEN_SOURCE source_context;
	PKERB_INTERACTIVE_PROFILE profile = NULL;
	LUID logon_id = { 0, 0 };
	QUOTA_LIMITS quotas;
	DWORD profile_size;

	/* the format for the user will be constrained to the output of get_passwd()
	 * so only the only two formats are a NetBiosDomain\SamAccountName which is
	 * a domain account or just SamAccountName in which is a local account */
	BOOL domain_user = wcschr(user_cpn, L'\\') != NULL;
	BOOL use_kerberos = domain_user && is_domain_joined_machine();

	/* initialize connection to local security provider */
	if (impersonation) {

		/* trusted mode - used for impersonation */
		LSA_OPERATIONAL_MODE mode;
		InitLsaString(&logon_process_name, __progname);
		if ((ret = LsaRegisterLogonProcess(&logon_process_name, &lsa_handle, &mode)) != STATUS_SUCCESS) {
			ULONG winError = LsaNtStatusToWinError(ret);
			error_f("LsaRegisterLogonProcess failed with error:%d", winError);

			goto done;
		}
	}
	else {
		/* untrusted mode - used for information lookup */
		if (LsaConnectUntrusted(&lsa_handle) != STATUS_SUCCESS)
			goto done;
	}

	InitLsaString(&auth_package_name, use_kerberos ? MICROSOFT_KERBEROS_NAME_A : MSV1_0_PACKAGE_NAME);
	if (ret = LsaLookupAuthenticationPackage(lsa_handle, &auth_package_name, &auth_package_id) != STATUS_SUCCESS)
		goto done;

	if (use_kerberos) {

		/* lookup the user principal name for the account */
		WCHAR domain_upn[MAX_UPN_LEN + 1];

		if (lookup_principal_name(user_cpn, domain_upn) != 0) {
			/* failure - fallback to NetBiosDomain\SamAccountName */
			wcscpy_s(domain_upn, ARRAYSIZE(domain_upn), user_cpn);
		}
		
		KERB_S4U_LOGON *s4u_logon;
		logon_info_size = sizeof(KERB_S4U_LOGON);

		/* additional buffer is necessary at end to hold user name */
		logon_info_size += (wcslen(domain_upn) * sizeof(wchar_t));
		logon_info = calloc(1, logon_info_size);
		if (logon_info == NULL)
			goto done;
		s4u_logon = (KERB_S4U_LOGON*)logon_info;
		s4u_logon->MessageType = KerbS4ULogon;
		s4u_logon->Flags = (impersonation) ? 0x0 : 0x8;

		/* copy the user name into the memory immediately after the structure */
		s4u_logon->ClientUpn.Length = (USHORT)wcslen(domain_upn) * sizeof(wchar_t);
		s4u_logon->ClientUpn.MaximumLength = s4u_logon->ClientUpn.Length;
		s4u_logon->ClientUpn.Buffer = (PWSTR)(s4u_logon + 1);
		if (memcpy_s(s4u_logon->ClientUpn.Buffer, s4u_logon->ClientUpn.Length,
			domain_upn, s4u_logon->ClientUpn.Length))
			goto done;
	}
	else {

		/* if a domain prefix slipped through (non-domain-joined host. e.g. winpe is backed with such domain), 
		  point past it without mutating the caller's buffer */
		wchar_t *backslash = wcschr(user_cpn, L'\\');
		if (backslash != NULL)
			user_cpn = backslash + 1;
		MSV1_0_S4U_LOGON *s4u_logon;
		logon_info_size = sizeof(MSV1_0_S4U_LOGON);

		/* additional buffer is necessary at end to hold user and computer name */
		logon_info_size += (wcslen(user_cpn) + wcslen(L".")) * sizeof(wchar_t);
		logon_info = calloc(1, logon_info_size);
		if (logon_info == NULL)
			goto done;
		s4u_logon = (MSV1_0_S4U_LOGON*)logon_info;
		s4u_logon->MessageType = MsV1_0S4ULogon;
		s4u_logon->Flags = 0x0;

		/* copy the user name into the memory immediately after the structure */
		s4u_logon->UserPrincipalName.Length = (USHORT)wcslen(user_cpn) * sizeof(wchar_t);
		s4u_logon->UserPrincipalName.MaximumLength = s4u_logon->UserPrincipalName.Length;
		s4u_logon->UserPrincipalName.Buffer = (WCHAR*)(s4u_logon + 1);
		if (memcpy_s(s4u_logon->UserPrincipalName.Buffer, s4u_logon->UserPrincipalName.Length,
			user_cpn, s4u_logon->UserPrincipalName.Length))
			goto done;

		/* copy the computer name immediately after the user name */
		s4u_logon->DomainName.Length = (USHORT)wcslen(L".") * sizeof(wchar_t);
		s4u_logon->DomainName.MaximumLength = s4u_logon->DomainName.Length;
		s4u_logon->DomainName.Buffer = (PWSTR)(((PBYTE)s4u_logon->UserPrincipalName.Buffer)
			+ s4u_logon->UserPrincipalName.Length);
		if (memcpy_s(s4u_logon->DomainName.Buffer, s4u_logon->DomainName.Length,
			L".", s4u_logon->DomainName.Length))
			goto done;
	}

	if (strcpy_s(source_context.SourceName, TOKEN_SOURCE_LENGTH, "sshd") != 0 ||
		AllocateLocallyUniqueId(&source_context.SourceIdentifier) != TRUE)
		goto done;

	InitLsaString(&origin_name, "sshd");
	if ((ret = LsaLogonUser(lsa_handle, &origin_name, Network, auth_package_id,
		logon_info, (ULONG)logon_info_size, NULL, &source_context,
		(PVOID*)&profile, &profile_size, &logon_id, &token, &quotas, &subStatus)) != STATUS_SUCCESS) {
		debug("%s: LsaLogonUser() failed. User '%ls' Status: 0x%08X SubStatus %d.", 
			__FUNCTION__, user_cpn, ret, subStatus);
		goto done;
	}

	debug3("LsaLogonUser Succeeded (Impersonation: %d)", impersonation);

done:
	if (lsa_handle)
		LsaDeregisterLogonProcess(lsa_handle);
	if (logon_info)
		free(logon_info);
	if (profile)
		LsaFreeReturnBuffer(profile);

	return token;
}

HANDLE
process_custom_lsa_auth(const char* user, const char* pwd, const char* lsa_pkg)
{
	HANDLE token = NULL, lsa_handle = NULL;
	LSA_OPERATIONAL_MODE mode;
	ULONG auth_package_id;
	NTSTATUS ret, subStatus;
	LSA_STRING logon_process_name, lsa_auth_package_name, origin_name;
	TOKEN_SOURCE source_context;
	PVOID profile = NULL;
	LUID logon_id = { 0, 0 };
	QUOTA_LIMITS quotas;
	DWORD profile_size;
	int retVal = -1;
	wchar_t *user_utf16 = NULL, *pwd_utf16 = NULL, *seperator = NULL;
	wchar_t logon_info[UNLEN + 1 + PWLEN + 1 + DNLEN + 1];
	ULONG logon_info_size = ARRAYSIZE(logon_info);

	debug3("LSA auth request, user:%s lsa_pkg:%s ", user, lsa_pkg);

	if ((user_utf16 = utf8_to_utf16(user)) == NULL ||
		(pwd_utf16 = utf8_to_utf16(pwd)) == NULL)
		goto done;
	
	/* the format for the user will be constrained to the output of get_passwd()
	* so only the only two formats are NetBiosDomain\SamAccountName which is
	* a domain account or just SamAccountName in which is a local account */

	seperator = wcschr(user_utf16, L'\\');
	if (seperator != NULL) {
		/* domain user: generate login info string user;password;domain */
		swprintf_s(logon_info, ARRAYSIZE(logon_info), L"%s;%s;%.*s",
			seperator + 1, pwd_utf16, (int) (seperator - user_utf16), user_utf16);
	} else {
		/* local user: generate login info string user;password */
		swprintf_s(logon_info, ARRAYSIZE(logon_info), L"%s;%s",
			user_utf16, pwd_utf16);
	}

	InitLsaString(&logon_process_name, "sshd");
	InitLsaString(&lsa_auth_package_name, lsa_pkg);
	InitLsaString(&origin_name, "sshd");

	if ((ret = LsaRegisterLogonProcess(&logon_process_name, &lsa_handle, &mode)) != STATUS_SUCCESS) {
		error("LsaRegisterLogonProcess failed, error:%x", ret);
		goto done;
	}

	if ((ret = LsaLookupAuthenticationPackage(lsa_handle, &lsa_auth_package_name, &auth_package_id)) != STATUS_SUCCESS) {
		error("LsaLookupAuthenticationPackage failed, lsa auth pkg:%ls error:%x", lsa_pkg, ret);
		goto done;
	}

	strcpy_s(source_context.SourceName, sizeof(source_context.SourceName), "sshd");

	if (!AllocateLocallyUniqueId(&source_context.SourceIdentifier)) {
		error("AllocateLocallyUniqueId failed, error:%d", GetLastError());
		goto done;
	}

	if ((ret = LsaLogonUser(lsa_handle, &origin_name, Network, auth_package_id,
		logon_info, (ULONG)logon_info_size, NULL, &source_context,
		(PVOID*)&profile, &profile_size, &logon_id, &token, &quotas, &subStatus)) != STATUS_SUCCESS) {
		debug("%s: LsaLogonUser() failed: User '%s' Status: %08X SubStatus %d.", 
			__FUNCTION__, user, ret, subStatus);
		goto done;
	}

	debug3("LSA auth request is successful for user:%s ", user);
	retVal = 0;
done:
	if (lsa_handle)
		LsaDeregisterLogonProcess(lsa_handle);
	if (profile)
		LsaFreeReturnBuffer(profile);
	if (user_utf16)
		free(user_utf16);
	if (pwd_utf16) {
		SecureZeroMemory(pwd_utf16, wcslen(pwd_utf16) * sizeof(WCHAR));
		free(pwd_utf16);
	}
	SecureZeroMemory(logon_info, sizeof(logon_info));

	return token;
}

HANDLE generate_sshd_virtual_token();
HANDLE generate_sshd_token_as_nonsystem();

HANDLE
get_user_token(const char* user, int impersonation) {
	HANDLE token = NULL;
	wchar_t *user_utf16 = NULL;
	PSID user_sid = NULL, process_sid = NULL;
	
	if ((user_utf16 = utf8_to_utf16(user)) == NULL) {
		debug("out of memory");
		goto done;
	}

	if (wcscmp(user_utf16, L"sshd") == 0) {
		/* not running as system, try generating sshd token as admin */
		if (!am_system() && (token = generate_sshd_token_as_nonsystem()) != 0)
			goto done;
			
		if ((token = generate_sshd_virtual_token()) == 0)
  		    error("%s - unable to generate sshd virtual token, ensure sshd service has TCB privileges", __func__);

		goto done;
	}

	if (!am_system()) {
		process_sid = get_sid(NULL);
		user_sid = get_sid(user);
		HANDLE t1;

		if (user_sid == NULL && get_custom_lsa_package())
			debug3("%s - i am running as %s, returning process token since custom lsa is configured", __func__, user);
		else if (EqualSid(process_sid, user_sid))
			debug3("%s - i am running as %s, returning process token", __func__, user);
		else {
			debug("%s - unable to generate user token for %s as i am not running as system", __func__, user);
			goto done;
		}

		if (!OpenProcessToken(GetCurrentProcess(), TOKEN_ALL_ACCESS_P, &t1)) {
			error("%s - OpenProcessToken failed with %d", __func__, GetLastError());
			goto done;
		}

		if (impersonation) {
			token = t1;
			goto done;
		} else if (!DuplicateToken(t1, SecurityIdentification, &token))
			error("%s - DuplicateToken failed with %d", __func__, GetLastError());
				
		CloseHandle(t1);
		goto done;
	}

	/* is this is a virtual user to be authenticated via custom lsa provider ? */
	if ((user_sid = get_sid(user)) == NULL && get_custom_lsa_package() && !impersonation) {
		if ((token = process_custom_lsa_auth(user, "", get_custom_lsa_package())) == NULL)
			error("%s - unable to generate identity token for %s from custom lsa provider: %s", 
				__func__, user, get_custom_lsa_package());
		goto done;
	}

	if ((token = generate_s4u_user_token(user_utf16, impersonation)) == 0) {
		debug3("%s - unable to generate token for user %ls", __func__, user_utf16);
		/* work around for https://github.com/PowerShell/Win32-OpenSSH/issues/727 by doing a fake login */
		pLogonUserExExW(L"FakeUser", L"FakeDomain", L"FakePasswd",
			LOGON32_LOGON_NETWORK_CLEARTEXT, LOGON32_PROVIDER_DEFAULT, NULL, &token, NULL, NULL, NULL, NULL);
		if ((token = generate_s4u_user_token(user_utf16, impersonation)) == 0)
			error("%s - unable to generate token on 2nd attempt for user %ls", __func__, user_utf16);
		goto done;
	}

done:
	if (user_utf16)
		free(user_utf16);

	if (user_sid)
		free(user_sid);

	if (process_sid)
		free(process_sid);

	return token;
}

int 
load_user_profile(HANDLE user_token, char* user)
{
	wchar_t * user_utf16 = NULL;

	if (!am_system()) {
	    debug("Not running as SYSTEM: skipping loading user profile");
	    return 0;
	}

	if ((user_utf16 = utf8_to_utf16(user)) == NULL) {
		fatal("out of memory");
		return -1;
	}

	/* note: user string will normalized form output of get_passwd() */
	wchar_t * user_name = user_utf16;
	wchar_t * domain_name = NULL;
	wchar_t * seperator = wcschr(user_name, L'\\');
	if (seperator != NULL) {
		domain_name = user_name;
		*seperator = L'\0';
		user_name = seperator + 1;
	}

	PROFILEINFOW profileInfo = { 0 };
	profileInfo.dwSize = sizeof(profileInfo);
	profileInfo.dwFlags = PI_NOUI;
	profileInfo.lpProfilePath = NULL;
	profileInfo.lpUserName = user_name;
	profileInfo.lpDefaultPath = NULL;
	profileInfo.lpServerName = domain_name;
	profileInfo.lpPolicyPath = NULL;
	profileInfo.hProfile = NULL;
	EnablePrivilege("SeBackupPrivilege", 1);
	EnablePrivilege("SeRestorePrivilege", 1);
	if (LoadUserProfileW(user_token, &profileInfo) == FALSE) {
		debug3("%s: LoadUserProfileW() failed for user %S with error %d.", __FUNCTION__, user_name, GetLastError());
	}
	EnablePrivilege("SeBackupPrivilege", 0);
	EnablePrivilege("SeRestorePrivilege", 0);

	if (user_utf16)
		free(user_utf16);

	return 0;
}


/* *** virtual account token generation logic ***/

char* LSAMappingErrorDetails[] = {
	"LsaSidNameMappingOperation_Success",
	"LsaSidNameMappingOperation_NonMappingError",
	"LsaSidNameMappingOperation_NameCollision",
	"LsaSidNameMappingOperation_SidCollision",
	"LsaSidNameMappingOperation_DomainNotFound",
	"LsaSidNameMappingOperation_DomainSidPrefixMismatch",
	"LsaSidNameMappingOperation_MappingNotFound"
};

#define VIRTUALUSER_DOMAIN L"VIRTUAL USERS"
#define VIRTUALUSER_GROUP_NAME L"ALL VIRTUAL USERS"

/* returns 0 on success -1 on failure */
int
add_sid_mapping_to_lsa(PUNICODE_STRING domain_name,
	 PUNICODE_STRING account_name,
	 PSID sid)
{
	LSA_SID_NAME_MAPPING_OPERATION_INPUT   input = { 0 };
	PLSA_SID_NAME_MAPPING_OPERATION_OUTPUT p_output = NULL;
	LSA_SID_NAME_MAPPING_OPERATION_ERROR op_result =
		LsaSidNameMappingOperation_NonMappingError;
	NTSTATUS status = STATUS_SUCCESS;
	int ret = 0;

	input.AddInput.DomainName = *domain_name;
	if (account_name)
		input.AddInput.AccountName = *account_name;
	input.AddInput.Sid = sid;

	status = LsaManageSidNameMapping(LsaSidNameMappingOperation_Add,
		&input,
		&p_output);
	if (status != STATUS_SUCCESS) {
		ret = -1;
		if (p_output) {
			op_result = p_output->AddOutput.ErrorCode;
			if (op_result == LsaSidNameMappingOperation_NameCollision || op_result == LsaSidNameMappingOperation_SidCollision)
				ret = 0; /* OK as it failed due to collision */
			else
				error("LsaManageSidNameMapping failed with : %s", LSAMappingErrorDetails[op_result]);
		}
		else
			error("LsaManageSidNameMapping failed with ntstatus: %d", status);
	}

	if (p_output) {
		status = pLsaFreeMemory(p_output);
		if (status != STATUS_SUCCESS)
			debug3("LsaFreeMemory failed with ntstatus: %d", status);
	}

	return ret;
}


int remove_virtual_account_lsa_mapping(PUNICODE_STRING domain_name,
	PUNICODE_STRING account_name)
{
	int ret = 0;

	LSA_SID_NAME_MAPPING_OPERATION_INPUT         input = { 0 };
	PLSA_SID_NAME_MAPPING_OPERATION_OUTPUT       p_output = NULL;
	PLSA_SID_NAME_MAPPING_OPERATION_REMOVE_INPUT remove_input = &input.RemoveInput;

	remove_input->DomainName = *domain_name;
	if (account_name)
		remove_input->AccountName = *account_name;
	
	NTSTATUS status = LsaManageSidNameMapping(LsaSidNameMappingOperation_Remove,
		&input,
		&p_output);
	if (status != STATUS_SUCCESS)
		ret = -1;
		
	if (p_output) {
		status = pLsaFreeMemory(p_output);
		if (status != STATUS_SUCCESS)
			debug3("LsaFreeMemory failed with ntstatus: %d", status);
	}
	return ret;
}

void 
init_unicode_string(PUNICODE_STRING dest, PWSTR source)
{
	dest->Buffer = source;
	dest->Length = (USHORT)(wcslen(source) * sizeof(wchar_t));
	dest->MaximumLength = dest->Length + 2;
}

HANDLE generate_sshd_token_as_nonsystem()
{
	/*
	 * This logic tries to reset sshd account password and generate sshd token via logon user
	 * however this token cannot be used to spawn child processes in typical interactive 
	 * scenarios, without modifying ACLs on desktop station. 
	 * Since sshd is run in interactive mode primarily for debugging/testing purposes, we are
	 * simply returing the process token (to be used for spawning unprivileged worker)
	 {
	    UUID uuid;
	    RPC_CWSTR rpc_str;
	    USER_INFO_1003 info;
	    HANDLE token = 0;
	    UuidCreate(&uuid);
	    UuidToStringW(&uuid, (RPC_WSTR*)&rpc_str);

	    info.usri1003_password = (LPWSTR)rpc_str;
	    NetUserSetInfo(NULL, L"sshd", 1003, (LPBYTE)&info, NULL);

	    LogonUserW(L"sshd", NULL, (LPCWSTR)rpc_str, LOGON32_LOGON_INTERACTIVE, LOGON32_PROVIDER_DEFAULT, &token);
	}
	*/
	HANDLE token = 0;
	OpenProcessToken(GetCurrentProcess(), TOKEN_ALL_ACCESS_P , &token);
	return token;
}

HANDLE generate_sshd_virtual_token()
{
	SID_IDENTIFIER_AUTHORITY nt_authority = SECURITY_NT_AUTHORITY;
	UNICODE_STRING domain, group, account, svcLogonRight;
	WCHAR va_name[16]; /* enough to accommodate sshd_ + log10(MAXDWORD) */
	LSA_OBJECT_ATTRIBUTES ObjectAttributes;
	LSA_HANDLE lsa_policy = NULL;
	NTSTATUS lsa_ret = 0, lsa_add_ret = (NTSTATUS)-1;

	PSID sid_domain = NULL, sid_group = NULL, sid_user = NULL;
	HANDLE va_token = 0, va_token_restricted = 0;

	StringCchPrintfW(va_name, 32, L"%s_%d", L"sshd", GetCurrentProcessId());

	init_unicode_string(&svcLogonRight, L"SeServiceLogonRight");
	init_unicode_string(&domain, VIRTUALUSER_DOMAIN);
	init_unicode_string(&group, VIRTUALUSER_GROUP_NAME);
	init_unicode_string(&account, va_name);

	/* Initialize SIDs */
	/* domain SID - S-1-5-111 */
	if (!(AllocateAndInitializeSid(&nt_authority, 1, 111, 0, 0, 0, 0, 0, 0, 0, &sid_domain))) {
		debug3("AllocateAndInitializeSid failed with domain SID");
		goto cleanup;
	}

	/* group SID - S-1-5-111-0 */
	if (!(AllocateAndInitializeSid(&nt_authority, 2, 111, 0, 0, 0, 0, 0, 0, 0, &sid_group))) {
		debug3("AllocateAndInitializeSid failed with group SID");
		goto cleanup;
	}

	/*
	* account SID
	* this is derived from higher RIDs in sshd service account SID to ensure there are no conflicts
	* S-1-5-80-3847866527-469524349-687026318-516638107-1125189541 (Well Known group: NT SERVICE\sshd)
	* Ex account SID - S-1-5-111-3847866527-469524349-687026318-516638107-1125189541-123
	*/
	if (!(AllocateAndInitializeSid(&nt_authority, 7, 111, 3847866527, 469524349,
		687026318, 516638107, 1125189541, GetCurrentProcessId(), 0, &sid_user))) {
		debug3("AllocateAndInitializeSid failed with account SID");
		goto cleanup;
	}

	/* Map the domain SID */
	if (add_sid_mapping_to_lsa(&domain, NULL, sid_domain) != 0) {
		debug3("add_sid_mapping_to_lsa failed to map the domain Sid");
		goto cleanup;
	}

	/* Map the group SID */
	if (add_sid_mapping_to_lsa(&domain, &group, sid_group) != 0) {
		debug3("add_sid_mapping_to_lsa failed to map the group Sid");
		goto cleanup;
	}

	/* Map the user SID */
	if (add_sid_mapping_to_lsa(&domain, &account, sid_user) != 0) {
		debug3("add_sid_mapping_to_lsa failed to map the user Sid");
		goto cleanup;
	}

	/* assign service logon privilege to virtual account */
	ZeroMemory(&ObjectAttributes, sizeof(ObjectAttributes));
	if ((lsa_ret = pLsaOpenPolicy(NULL, &ObjectAttributes,
		POLICY_CREATE_ACCOUNT | POLICY_LOOKUP_NAMES,
		&lsa_policy)) != STATUS_SUCCESS) {
		error("%s: unable to open policy handle, error: %d",
			__FUNCTION__, (ULONG)pRtlNtStatusToDosError(lsa_ret));
		goto cleanup;
	}

	/* alter security to allow policy to account to logon as a service */
	if ((lsa_add_ret = pLsaAddAccountRights(lsa_policy, sid_user, &svcLogonRight, 1)) != STATUS_SUCCESS) {
		error("%s: unable to assign SE_SERVICE_LOGON_NAME privilege, error: %d",
			__FUNCTION__, (ULONG)pRtlNtStatusToDosError(lsa_add_ret));
		goto cleanup;
	}

	/* Logon virtual and create token */
	if (!pLogonUserExExW(va_name, VIRTUALUSER_DOMAIN, L"", LOGON32_LOGON_SERVICE,
		LOGON32_PROVIDER_VIRTUAL, NULL, &va_token, NULL, NULL, NULL, NULL)) {
		debug3("LogonUserExExW failed with %d", GetLastError());
		goto cleanup;
	}

	/* remove all privileges */
	if (!CreateRestrictedToken(va_token, DISABLE_MAX_PRIVILEGE, 0, NULL, 0, NULL, 0, NULL, &va_token_restricted))
		debug3("CreateRestrictedToken failed with %d", GetLastError());

	CloseHandle(va_token);

cleanup:
	remove_virtual_account_lsa_mapping(&domain, &account);

	/* attempt to remove virtual account permissions if previous add succeeded */
	if (lsa_add_ret == STATUS_SUCCESS)
		if ((lsa_ret = pLsaRemoveAccountRights(lsa_policy, sid_user, FALSE, &svcLogonRight, 1)) != STATUS_SUCCESS)
			debug("%s: unable to remove SE_SERVICE_LOGON_NAME privilege, error: %d", __FUNCTION__, pRtlNtStatusToDosError(lsa_ret));

	if (sid_domain)
		FreeSid(sid_domain);
	if (sid_user)
		FreeSid(sid_user);
	if (sid_group)
		FreeSid(sid_group);
	if (lsa_policy)
		pLsaClose(lsa_policy);

	return va_token_restricted;
}


/* returns NULL if not configured, fatal exists on error */
char *
get_custom_lsa_package()
{
	static char *s_lsa_auth_pkg = NULL;
	static int s_processed = 0;
	wchar_t *lsa_auth_pkg_w = NULL;
	int lsa_auth_pkg_len = 0;
	HKEY reg_key = 0;
	REGSAM mask = STANDARD_RIGHTS_READ | KEY_QUERY_VALUE | KEY_WOW64_64KEY;

	if (s_processed)
		return s_lsa_auth_pkg;

	if ((RegOpenKeyExW(HKEY_LOCAL_MACHINE, SSH_REGISTRY_ROOT, 0, mask, &reg_key) == ERROR_SUCCESS) &&
	    (RegQueryValueExW(reg_key, L"LSAAuthenticationPackage", 0, NULL, NULL, &lsa_auth_pkg_len) == ERROR_SUCCESS)) {
		lsa_auth_pkg_w = (wchar_t *)malloc(lsa_auth_pkg_len); // lsa_auth_pkg_len includes the null terminating character.
		if (!lsa_auth_pkg_w)
			fatal("%s: out of memory", __func__);

		memset(lsa_auth_pkg_w, 0, lsa_auth_pkg_len);
		if (RegQueryValueExW(reg_key, L"LSAAuthenticationPackage", 0, NULL, (LPBYTE)lsa_auth_pkg_w, &lsa_auth_pkg_len) == ERROR_SUCCESS) {
			s_lsa_auth_pkg = utf16_to_utf8(lsa_auth_pkg_w);
			if (!s_lsa_auth_pkg)
				fatal("utf16_to_utf8 failed to convert lsa_auth_pkg_w:%ls", lsa_auth_pkg_w);
		}
	}

	if (lsa_auth_pkg_w)
		free(lsa_auth_pkg_w);
	if (reg_key)
		RegCloseKey(reg_key);

	s_processed = 1;
	return s_lsa_auth_pkg;
}

/*
 * Not thread safe 
 * returned value is pointer from static buffer
 * dont free()
 */
wchar_t* get_final_path_by_handle(HANDLE h)
{
	static wchar_t path_buf[PATH_MAX];

	if (GetFinalPathNameByHandleW(h, path_buf, PATH_MAX, 0) == 0) {
		errno = EOTHER;
		debug3("failed to get final path of file with handle:%d error:%d", h, GetLastError());
		return NULL;
	}

	return (path_buf + 4);
}

/* using the netbiosname\samaccountname as an input, lookup the upn for the user.
 * if no explicit upn is defined, implicit upn is returned (samaccountname@fqdn) */
int lookup_principal_name(const wchar_t * sam_account_name, wchar_t * user_principal_name)
{
	wchar_t * seperator = wcschr(sam_account_name, L'\\');
	wchar_t domain_upn[MAX_UPN_LEN + 1];
	DWORD domain_upn_len = ARRAYSIZE(domain_upn);
	DWORD lookup_error = 0;

	/* sanity check */
	if (seperator == NULL)
		return -1;

	/* try explicit lookup */
	if (pTranslateNameW(sam_account_name, NameSamCompatible, NameUserPrincipal, domain_upn, &domain_upn_len) != 0) {
		wcscpy_s(user_principal_name, MAX_UPN_LEN + 1, domain_upn);
		debug3("%s: Successfully discovered explicit principal name: '%ls'=>'%ls'",
			__FUNCTION__, sam_account_name, user_principal_name);
		return 0;
	}

	/* try implicit lookup */
	lookup_error = GetLastError();
	domain_upn_len = ARRAYSIZE(domain_upn);
	if (pTranslateNameW(sam_account_name, NameSamCompatible, NameCanonical, domain_upn, &domain_upn_len) != 0) {
		/* construct an implicit upn using the samaccountname from the passed parameter 
		 * and the fully qualified domain portion of the canonical name */
		wcscpy_s(user_principal_name, MAX_UPN_LEN + 1, seperator + 1);
		wcscat_s(user_principal_name, MAX_UPN_LEN + 1, L"@");
		wcsncat_s(user_principal_name, MAX_UPN_LEN + 1, domain_upn, wcschr(domain_upn, L'/') - domain_upn);
		debug3("%s: Successfully discovered implicit principal name: '%ls'=>'%ls'",
			__FUNCTION__, sam_account_name, user_principal_name);
		return 0;
	}

	/* report error */
	error("%s: User principal name lookup failed for user '%ls' (explicit: %d, implicit: %d)",
		__FUNCTION__, sam_account_name, lookup_error, GetLastError());
	return -1;
}

int 
windows_password_auth(const char *username, const char* password)
{
	wchar_t *user_utf16 = NULL, *pwd_utf16 = NULL, *unam_utf16 = NULL, *udom_utf16 = L".";
	HANDLE token = NULL;
	WCHAR domain_upn[MAX_UPN_LEN + 1];
	ULONG domain_upn_len = ARRAYSIZE(domain_upn);

	user_utf16 = utf8_to_utf16(username);
	pwd_utf16 = utf8_to_utf16(password);
	if (user_utf16 == NULL || pwd_utf16 == NULL) {
		debug("out of memory");
		goto done;
	}

	/* the format for the user will be constrained to the output of get_passwd()
	* so only the only two formats are NetBiosDomain\SamAccountName which is
	* a domain account or just SamAccountName in which is a local account */

	/* default assumption - local user */
	unam_utf16 = user_utf16;

	/* translate to domain user if format contains a backslash */
	wchar_t * backslash = wcschr(user_utf16, L'\\');
	if (backslash != NULL) {

		/* attempt to format into upn format as this is preferred for login */
		if (lookup_principal_name(user_utf16, domain_upn) == 0) {
			unam_utf16 = domain_upn;
			udom_utf16 = NULL;
		}

		/* could not discover upn so just use netbios for the domain parameter and
		* the sam account name for the user name */
		else {
			*backslash = '\0';
			unam_utf16 = backslash + 1;
			udom_utf16 = user_utf16;
		}
	}

	if (pLogonUserExExW(unam_utf16, udom_utf16, pwd_utf16, LOGON32_LOGON_NETWORK_CLEARTEXT,
		LOGON32_PROVIDER_DEFAULT, NULL, &token, NULL, NULL, NULL, NULL) == TRUE)
		password_auth_token = token;
	else {
		if (GetLastError() == ERROR_PASSWORD_MUST_CHANGE)
			/*
			* TODO - need to add support to force password change
			* by sending back SSH_MSG_USERAUTH_PASSWD_CHANGEREQ
			*/
			error("password for user %s has expired", username);
		else {
			debug("Windows authentication failed for user: %ls domain: %ls error: %d",
				unam_utf16, udom_utf16, GetLastError());

			/* If LSA authentication package is configured then it will return the auth_token */
			if (get_custom_lsa_package())
				password_auth_token = process_custom_lsa_auth(username, password, get_custom_lsa_package());
		}
	}

done:

	if (user_utf16)
		free(user_utf16);
	if (pwd_utf16)
		SecureZeroMemory(pwd_utf16, sizeof(wchar_t) * wcslen(pwd_utf16));

	return (password_auth_token) ? 1 : 0;

}

#pragma warning(pop)