mirror of https://github.com/dahall/Vanara.git
99 lines
4.5 KiB
C#
99 lines
4.5 KiB
C#
#if !(NETSTANDARD2_0)
|
|
using System;
|
|
using System.ComponentModel;
|
|
using System.Security.Principal;
|
|
using static Vanara.PInvoke.AdvApi32;
|
|
|
|
namespace Vanara.Security.Principal
|
|
{
|
|
/// <summary>
|
|
/// Impersonation of a user. Allows to execute code under another user context. Please note that the account that instantiates this class needs to have the 'Act as part of operating system' privilege set.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// <code>
|
|
/// // The following code impersonates an account to perform work
|
|
/// using (new WindowsImpersonatedIdentity("bob", "WORKDOMAIN", "bobs_secret_passw0rd")
|
|
/// {
|
|
/// // Perform impersonated work in the body. Once the 'using' statement closes,
|
|
/// // the impersonation ends.
|
|
/// }
|
|
/// </code>
|
|
/// </remarks>
|
|
public class WindowsImpersonatedIdentity : IDisposable, IIdentity
|
|
{
|
|
private readonly WindowsImpersonationContext impersonationContext;
|
|
private WindowsIdentity identity;
|
|
private readonly bool ownId = true;
|
|
|
|
/// <summary>
|
|
/// Starts the impersonation with the given credentials. Please note that the account that instantiates this class needs to have the 'Act as part of
|
|
/// operating system' privilege set.
|
|
/// </summary>
|
|
/// <param name="userName">
|
|
/// A string that specifies the name of the user. This is the name of the user account to log on to. If you use the user principal name (UPN) format,
|
|
/// User@DNSDomainName, the <paramref name="domainName"/> parameter must be NULL.
|
|
/// </param>
|
|
/// <param name="domainName">
|
|
/// A string that specifies the name of the domain or server whose account database contains the <paramref name="userName"/> account. If this parameter
|
|
/// is NULL, the user name must be specified in UPN format. If this parameter is ".", the account is validated by using only the local account database.
|
|
/// </param>
|
|
/// <param name="password">A string that specifies the plaintext password for the user account specified by <paramref name="userName"/>.</param>
|
|
/// <param name="logonType">
|
|
/// Type of the logon. This parameter can usually be left as the default. For more information, lookup more detail for the dwLogonType parameter of the
|
|
/// Windows LogonUser function.
|
|
/// </param>
|
|
/// <param name="provider">
|
|
/// The logon provider. This parameter can usually be left as the default. For more information, lookup more detail for the dwLogonProvider parameter of
|
|
/// the Windows LogonUser function.
|
|
/// </param>
|
|
public WindowsImpersonatedIdentity(string userName, string domainName, string password, LogonUserType logonType = LogonUserType.LOGON32_LOGON_INTERACTIVE,
|
|
LogonUserProvider provider = LogonUserProvider.LOGON32_PROVIDER_DEFAULT)
|
|
{
|
|
if (string.IsNullOrEmpty(userName)) throw new ArgumentNullException(nameof(userName));
|
|
if (string.IsNullOrEmpty(password)) throw new ArgumentNullException(nameof(password));
|
|
if (string.IsNullOrEmpty(domainName) && !userName.Contains("@")) throw new ArgumentNullException(nameof(domainName));
|
|
if (LogonUser(userName, domainName, password, logonType, provider, out var hToken))
|
|
{
|
|
using (hToken)
|
|
{
|
|
identity = new WindowsIdentity(hToken.DangerousGetHandle());
|
|
impersonationContext = identity.Impersonate();
|
|
}
|
|
}
|
|
else
|
|
throw new Win32Exception();
|
|
}
|
|
|
|
/// <summary>
|
|
/// Starts the impersonation with the given <see cref="WindowsIdentity" />. Please note that the account that instantiates this class needs to have the 'Act as part of operating system' privilege set.
|
|
/// </summary>
|
|
/// <param name="identityToImpersonate">The identity to impersonate.</param>
|
|
public WindowsImpersonatedIdentity(WindowsIdentity identityToImpersonate)
|
|
{
|
|
identity = identityToImpersonate;
|
|
impersonationContext = identity.Impersonate();
|
|
ownId = false;
|
|
}
|
|
|
|
/// <summary>Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.</summary>
|
|
public void Dispose()
|
|
{
|
|
impersonationContext?.Undo();
|
|
if (ownId) identity?.Dispose();
|
|
identity = null;
|
|
}
|
|
|
|
/// <summary>Gets the authenticated identity.</summary>
|
|
public WindowsIdentity AuthenticatedIdentity => identity;
|
|
|
|
/// <summary>Gets the type of authentication used.</summary>
|
|
string IIdentity.AuthenticationType => identity?.AuthenticationType;
|
|
|
|
/// <summary>Gets a value that indicates whether the user has been authenticated.</summary>
|
|
bool IIdentity.IsAuthenticated => identity?.IsAuthenticated ?? false;
|
|
|
|
/// <summary>Gets the name of the current user.</summary>
|
|
string IIdentity.Name => identity?.Name;
|
|
}
|
|
}
|
|
#endif |