Click here to Skip to main content
15,888,461 members
Articles / Programming Languages / C#
Article

Windows Impersonation using C#

Rate me:
Please Sign up or sign in to vote.
4.77/5 (49 votes)
29 Apr 2003CPOL 722.4K   15.7K   149   74
An article demonstrating how to use Windows impersonation in your C# code

Impersonation

Introduction

I've been a member of the CodeProject for over 3 years now, and still haven't contributed any articles - until now.

While designing a Windows Forms-based application, to administrate containers in our Active Directory, I needed a way to allow binding to the AD using alternate credentials. Windows impersonation was the answer. This sample app demonstrates how to use unmanaged code by calling LogonUser() contained within the advapi32.dll, and pass a token handle back to your .NET application using WindowsImpersonationContext.

One of the downfalls to the LogonUser()function is that the password get passed in clear-text.

Partial Source Code

C#
using System.Runtime.InteropServices; // DllImport
using System.Security.Principal; // WindowsImpersonationContext
using System.Security.Permissions; // PermissionSetAttribute
...

public WindowsImpersonationContext 
    ImpersonateUser(string sUsername, string sDomain, string sPassword)
{
    // initialize tokens
    IntPtr pExistingTokenHandle = new IntPtr(0);
    IntPtr pDuplicateTokenHandle = new IntPtr(0);
    pExistingTokenHandle = IntPtr.Zero;
    pDuplicateTokenHandle = IntPtr.Zero;
    
    // if domain name was blank, assume local machine
    if (sDomain == "")
        sDomain = System.Environment.MachineName;

    try
    {
        string sResult = null;

        const int LOGON32_PROVIDER_DEFAULT = 0;

        // create token
        const int LOGON32_LOGON_INTERACTIVE = 2;
        //const int SecurityImpersonation = 2;

        // get handle to token
        bool bImpersonated = LogonUser(sUsername, sDomain, sPassword, 
            LOGON32_LOGON_INTERACTIVE, LOGON32_PROVIDER_DEFAULT, 
                ref pExistingTokenHandle);

        // did impersonation fail?
        if (false == bImpersonated)
        {
            int nErrorCode = Marshal.GetLastWin32Error();
            sResult = "LogonUser() failed with error code: " + 
                nErrorCode + "\r\n";

            // show the reason why LogonUser failed
            MessageBox.Show(this, sResult, "Error", 
                MessageBoxButtons.OK, MessageBoxIcon.Error);
        }

        // Get identity before impersonation
        sResult += "Before impersonation: " + 
            WindowsIdentity.GetCurrent().Name + "\r\n";

        bool bRetVal = DuplicateToken(pExistingTokenHandle, 
            (int)SECURITY_IMPERSONATION_LEVEL.SecurityImpersonation, 
                ref pDuplicateTokenHandle);

        // did DuplicateToken fail?
        if (false == bRetVal)
        {
            int nErrorCode = Marshal.GetLastWin32Error();
            // close existing handle
            CloseHandle(pExistingTokenHandle); 
            sResult += "DuplicateToken() failed with error code: " 
                + nErrorCode + "\r\n";

            // show the reason why DuplicateToken failed
            MessageBox.Show(this, sResult, "Error", 
                MessageBoxButtons.OK, MessageBoxIcon.Error);
            return null;
        }
        else
        {
            // create new identity using new primary token
            WindowsIdentity newId = new WindowsIdentity
                                        (pDuplicateTokenHandle);
            WindowsImpersonationContext impersonatedUser = 
                                        newId.Impersonate();

            // check the identity after impersonation
            sResult += "After impersonation: " + 
                WindowsIdentity.GetCurrent().Name + "\r\n";
            
            MessageBox.Show(this, sResult, "Success", 
                MessageBoxButtons.OK, MessageBoxIcon.Information);
            return impersonatedUser;
        }
    }
    catch (Exception ex)
    {
        throw ex;
    }
    finally
    {
        // close handle(s)
        if (pExistingTokenHandle != IntPtr.Zero)
            CloseHandle(pExistingTokenHandle);
        if (pDuplicateTokenHandle != IntPtr.Zero) 
            CloseHandle(pDuplicateTokenHandle);
    }
}

Points of Interest

This code won't work on Windows 98 or ME because they do not utilize user tokens. Code was built and run using Visual Studio.NET 2002 on Windows XP Service Pack 1.

One of the other uses for this code I've found is, for instantiating COM components that must run in an alternate security context to that of the logged-on user.

If anyone has a more secure method of achieving the same thing, please let me know.

History

  • Version 1.0 - 04.25.03 - First release version

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)


Written By
Zambia Zambia
Living abroad and loving life.

Comments and Discussions

 
GeneralFirst call takes too long Pin
schweeneh4-Apr-06 6:04
schweeneh4-Apr-06 6:04 
GeneralRe: First call takes too long Pin
Christian Merritt12-Jun-06 2:24
Christian Merritt12-Jun-06 2:24 
GeneralA similar article Pin
Uwe Keim23-Apr-05 23:59
sitebuilderUwe Keim23-Apr-05 23:59 
GeneralRe: A similar article Pin
craigg753-Nov-06 5:57
craigg753-Nov-06 5:57 
GeneralRe: A similar article Pin
Uwe Keim3-Nov-06 6:14
sitebuilderUwe Keim3-Nov-06 6:14 
GeneralImpersonation Pin
chriskoiak16-Mar-04 5:13
chriskoiak16-Mar-04 5:13 
QuestionRe: Impersonation Pin
tee_jay10-Apr-06 22:08
tee_jay10-Apr-06 22:08 
AnswerRe: Impersonation Pin
Harkamal Singh12-Jul-07 19:01
Harkamal Singh12-Jul-07 19:01 
Here you go...Smile | :)

public class NetworkHelper {
// Used to Map UNC from a Windows Service

#region Constants
//NetResource Scope
private const int RESOURCE_CONNECTED = 0x00000001;
private const int RESOURCE_GLOBALNET = 0x00000002;
private const int RESOURCE_REMEMBERED = 0x00000003;

//NetResource Type
private const int RESOURCETYPE_ANY = 0x00000000;
private const int RESOURCETYPE_DISK = 0x00000001;
private const int RESOURCETYPE_PRINT = 0x00000002;

//NetResource Usage
private const int RESOURCEUSAGE_CONNECTABLE = 0x00000001;
private const int RESOURCEUSAGE_CONTAINER = 0x00000002;


//NetResource Display Type
private const int RESOURCEDISPLAYTYPE_GENERIC = 0x00000000;
private const int RESOURCEDISPLAYTYPE_DOMAIN = 0x00000001;
private const int RESOURCEDISPLAYTYPE_SERVER = 0x00000002;
private const int RESOURCEDISPLAYTYPE_SHARE = 0x00000003;
private const int RESOURCEDISPLAYTYPE_FILE = 0x00000004;
private const int RESOURCEDISPLAYTYPE_GROUP = 0x00000005;

//Flags
private const int CONNECT_UPDATE_PROFILE = 0x00000001;
private const int CONNECT_UPDATE_RECENT = 0x00000002;
private const int CONNECT_TEMPORARY = 0x00000004;
private const int CONNECT_INTERACTIVE = 0x00000008;
private const int CONNECT_PROMPT = 0x00000010;
private const int CONNECT_NEED_DRIVE = 0x00000020;

#endregion

#region NetResource Structure
[StructLayout(LayoutKind.Sequential)]
private struct NetResource {
public int Scope;
public int Type;
public int DisplayType;
public int Usage;
public string LocalName;
public string RemoteName;
public string Comment;
public string Provider;
}
#endregion

#region Win32 Functions
[DllImport("mpr.dll", EntryPoint = "WNetAddConnection2A", CharSet = CharSet.Ansi, SetLastError = true)]
private static extern int WNetAddConnection2A(ref NetResource netresource, string password, string username, int flags);

[DllImport("mpr.dll", EntryPoint = "WNetCancelConnection2", CharSet = CharSet.Ansi, SetLastError = true)]
private static extern int WNetCancelConnection2(string drivename, int flag, bool force);

#endregion

myLib lib = new myLib();

public bool WNetAddConnection(string LocalDrive, string NetworkFolderPath, string User, string Password, bool Force) {
bool success = false;

try {
NetResource netresource = new NetResource();
netresource.Scope = RESOURCE_GLOBALNET;
netresource.Type = RESOURCETYPE_DISK;
netresource.Usage = RESOURCEUSAGE_CONNECTABLE;
netresource.DisplayType = RESOURCEDISPLAYTYPE_SHARE;
netresource.LocalName = LocalDrive;
netresource.RemoteName = NetworkFolderPath;
netresource.Comment = "";
netresource.Provider = "";

int Flag = CONNECT_UPDATE_PROFILE;

if (Force) {
success = WNetCancelConnection(LocalDrive, true);
}

int result = WNetAddConnection2A(ref netresource, Password, User, Flag);

if (result > 0) {
throw new System.ComponentModel.Win32Exception(result);
}
success = true;

}
catch (Exception e) {
lib.Echo("Error: " + e.Message, myLib.MsgType.FAIL);
}

return success;
}

public bool WNetCancelConnection(string LocalDrive, bool Force) {
bool success = false;
try {
int result = WNetCancelConnection2(LocalDrive, CONNECT_UPDATE_PROFILE, Force);
if (result > 0) {
throw new System.ComponentModel.Win32Exception(result);
}
success = true;

}
catch (Exception e) {
lib.Echo("Error:" + e.Message, myLib.MsgType.FAIL);
}
return success;


}

}

GeneralRe: Impersonation Pin
Phutphornxai19-Jul-07 1:43
Phutphornxai19-Jul-07 1:43 
GeneralCoding Style Issues Pin
Andy Neilson7-May-03 2:56
Andy Neilson7-May-03 2:56 
GeneralRe: Coding Style Issues Pin
Maximilian Hänel27-May-03 12:54
Maximilian Hänel27-May-03 12:54 
GeneralRe: Coding Style Issues Pin
Andy Neilson28-May-03 2:53
Andy Neilson28-May-03 2:53 
GeneralRe: Coding Style Issues Pin
Maximilian Hänel28-May-03 4:56
Maximilian Hänel28-May-03 4:56 
GeneralJust to complete this Pin
Jahava25-Oct-03 4:53
Jahava25-Oct-03 4:53 
GeneralRe: Just to complete this Pin
Christian Merritt25-Oct-03 8:42
Christian Merritt25-Oct-03 8:42 
GeneralWhat an attitude... Pin
Jahava27-Oct-03 5:08
Jahava27-Oct-03 5:08 
GeneralRe: What an attitude... Pin
Christian Merritt27-Oct-03 5:46
Christian Merritt27-Oct-03 5:46 
GeneralIt's cool Pin
Jahava27-Oct-03 13:45
Jahava27-Oct-03 13:45 
GeneralRe: Coding Style Issues Pin
Jonathan C Dickinson5-May-08 1:53
Jonathan C Dickinson5-May-08 1:53 
GeneralError messages Pin
Maximilian Hänel6-May-03 1:24
Maximilian Hänel6-May-03 1:24 
GeneralRe: Error messages Pin
Haidong Chen27-May-03 12:15
Haidong Chen27-May-03 12:15 
GeneralRe: Error messages Pin
Haidong Chen27-May-03 12:17
Haidong Chen27-May-03 12:17 
GeneralRe: Error messages Pin
Maximilian Hänel27-May-03 12:47
Maximilian Hänel27-May-03 12:47 
GeneralSeImpersonatePrivilege Pin
geo_m3-May-03 22:56
geo_m3-May-03 22:56 
GeneralThis method won't work on Windows 2000 or Windows NT Pin
Softomatix3-May-03 13:54
Softomatix3-May-03 13:54 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Praise Praise    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.