public void ConfigureService(AgentSettings settings, CommandSettings command)
{
ArgUtil.NotNull(command, nameof(command));
Trace.Entering();
if (!_windowsServiceHelper.IsRunningInElevatedMode())
{
Trace.Error("Needs Administrator privileges for configure agent as windows service.");
throw new SecurityException(StringUtil.Loc("NeedAdminForConfigAgentWinService"));
}
// TODO: Fix bug that exists in the legacy Windows agent where configuration using mirrored credentials causes an error, but the agent is still functional (after restarting). Mirrored credentials is a supported scenario and shouldn't manifest any errors.
// We use NetworkService as default account for build and release agent
// We use Local System as default account for deployment agent, deployment pool agent, environment vm agent
bool isDeploymentGroupScenario = command.GetDeploymentOrMachineGroup() || command.GetDeploymentPool() || command.GetEnvironmentVMResource();
NTAccount defaultServiceAccount = isDeploymentGroupScenario ? _windowsServiceHelper.GetDefaultAdminServiceAccount() : _windowsServiceHelper.GetDefaultServiceAccount();
string logonAccount = command.GetWindowsLogonAccount(defaultValue: defaultServiceAccount.ToString(), descriptionMsg: StringUtil.Loc("WindowsLogonAccountNameDescription"));
string domainName;
string userName;
GetAccountSegments(logonAccount, out domainName, out userName);
if ((string.IsNullOrEmpty(domainName) || domainName.Equals(".", StringComparison.CurrentCultureIgnoreCase)) && !logonAccount.Contains('@'))
{
logonAccount = String.Format("{0}\\{1}", Environment.MachineName, userName);
domainName = Environment.MachineName;
}
Trace.Info("LogonAccount after transforming: {0}, user: {1}, domain: {2}", logonAccount, userName, domainName);
string logonPassword = string.Empty;
if (!defaultServiceAccount.Equals(new NTAccount(logonAccount)) && !NativeWindowsServiceHelper.IsWellKnownIdentity(logonAccount))
{
while (true)
{
logonPassword = command.GetWindowsLogonPassword(logonAccount);
if (_windowsServiceHelper.IsValidCredential(domainName, userName, logonPassword))
{
Trace.Info("Credential validation succeed");
break;
}
else
{
if (!command.Unattended())
{
Trace.Info("Invalid credential entered");
_term.WriteLine(StringUtil.Loc("InvalidWindowsCredential"));
}
else
{
throw new SecurityException(StringUtil.Loc("InvalidWindowsCredential"));
}
}
}
}
string serviceName;
string serviceDisplayName;
CalculateServiceName(settings, ServiceNamePattern, ServiceDisplayNamePattern, out serviceName, out serviceDisplayName);
if (_windowsServiceHelper.IsServiceExists(serviceName))
{
_term.WriteLine(StringUtil.Loc("ServiceAlreadyExists", serviceName));
_windowsServiceHelper.UninstallService(serviceName);
}
Trace.Info("Verifying if the account has LogonAsService permission");
if (_windowsServiceHelper.IsUserHasLogonAsServicePrivilege(domainName, userName))
{
Trace.Info($"Account: {logonAccount} already has Logon As Service Privilege.");
}
else
{
if (!_windowsServiceHelper.GrantUserLogonAsServicePrivilage(domainName, userName))
{
throw new InvalidOperationException(StringUtil.Loc("CanNotGrantPermission", logonAccount));
}
}
// grant permission for agent root folder and work folder
Trace.Info("Create local group and grant folder permission to service logon account.");
string agentRoot = HostContext.GetDirectory(WellKnownDirectory.Root);
string workFolder = HostContext.GetDirectory(WellKnownDirectory.Work);
Directory.CreateDirectory(workFolder);
_windowsServiceHelper.GrantDirectoryPermissionForAccount(logonAccount, new[] { agentRoot, workFolder });
_term.WriteLine(StringUtil.Loc("GrantingFilePermissions", logonAccount));
// install service.
_windowsServiceHelper.InstallService(serviceName, serviceDisplayName, logonAccount, logonPassword);
// create .service file with service name.
SaveServiceSettings(serviceName);
// Add registry key after installation
_windowsServiceHelper.CreateVstsAgentRegistryKey();
Trace.Info("Configuration was successful, trying to start the service");
if (!command.GetPreventServiceStart())
{
_windowsServiceHelper.StartService(serviceName);
}
}
public override bool ConfigureService(AgentSettings settings, CommandSettings command)
{
Trace.Entering();
// TODO: add entering with info level. By default the error leve would be info. Config changes can get lost with this as entering is at Verbose level. For config all the logs should be logged.
// TODO: Fix bug that exists in the legacy Windows agent where configuration using mirrored credentials causes an error, but the agent is still functional (after restarting). Mirrored credentials is a supported scenario and shouldn't manifest any errors.
string logonPassword = string.Empty;
NTAccount defaultServiceAccount = _windowsServiceHelper.GetDefaultServiceAccount();
_logonAccount = command.GetWindowsLogonAccount(defaultValue: defaultServiceAccount.ToString());
NativeWindowsServiceHelper.GetAccountSegments(_logonAccount, out _domainName, out _userName);
if ((string.IsNullOrEmpty(_domainName) || _domainName.Equals(".", StringComparison.CurrentCultureIgnoreCase)) && !_logonAccount.Contains('@'))
{
_logonAccount = String.Format("{0}\\{1}", Environment.MachineName, _userName);
}
Trace.Info("LogonAccount after transforming: {0}, user: {1}, domain: {2}", _logonAccount, _userName, _domainName);
if (!defaultServiceAccount.Equals(new NTAccount(_logonAccount)) &&
!NativeWindowsServiceHelper.IsWellKnownIdentity(_logonAccount))
{
while (true)
{
logonPassword = command.GetWindowsLogonPassword(_logonAccount);
// TODO: Fix this for unattended (should throw if not valid).
// TODO: If account is locked there is no point in retrying, translate error to useful message
if (_windowsServiceHelper.IsValidCredential(_domainName, _userName, logonPassword) || command.Unattended)
{
break;
}
Trace.Info("Invalid credential entered");
_term.WriteLine(StringUtil.Loc("InvalidWindowsCredential"));
}
}
CalculateServiceName(settings, ServiceNamePattern, ServiceDisplayNamePattern);
if (CheckServiceExists(ServiceName))
{
_term.WriteLine(StringUtil.Loc("ServiceAleadyExists"));
StopService();
UninstallService(ServiceName);
}
Trace.Info("Verifying if the account has LogonAsService permission");
if (!_windowsServiceHelper.CheckUserHasLogonAsServicePrivilege(_domainName, _userName))
{
Trace.Info(StringUtil.Format("Account: {0} already has Logon As Service Privilege.", _logonAccount));
}
else
{
if (!_windowsServiceHelper.GrantUserLogonAsServicePrivilage(_domainName, _userName))
{
throw new InvalidOperationException(StringUtil.Loc("CanNotGrantPermission", _logonAccount));
}
}
_windowsServiceHelper.InstallService(ServiceName, ServiceDisplayName, _logonAccount, logonPassword);
SaveServiceSettings();
// TODO: If its service identity add it to appropriate PoolGroup
// Add registry key after installation
_windowsServiceHelper.CreateVstsAgentRegistryKey();
return(true);
}
public void ConfigureService(AgentSettings settings, CommandSettings command)
{
Trace.Entering();
// TODO: Fix bug that exists in the legacy Windows agent where configuration using mirrored credentials causes an error, but the agent is still functional (after restarting). Mirrored credentials is a supported scenario and shouldn't manifest any errors.
// We use NetworkService as default account.
NTAccount defaultServiceAccount = _windowsServiceHelper.GetDefaultServiceAccount();
string logonAccount = command.GetWindowsLogonAccount(defaultValue: defaultServiceAccount.ToString());
string domainName;
string userName;
GetAccountSegments(logonAccount, out domainName, out userName);
if ((string.IsNullOrEmpty(domainName) || domainName.Equals(".", StringComparison.CurrentCultureIgnoreCase)) && !logonAccount.Contains('@'))
{
logonAccount = String.Format("{0}\\{1}", Environment.MachineName, userName);
}
Trace.Info("LogonAccount after transforming: {0}, user: {1}, domain: {2}", logonAccount, userName, domainName);
string logonPassword = string.Empty;
if (!defaultServiceAccount.Equals(new NTAccount(logonAccount)) && !NativeWindowsServiceHelper.IsWellKnownIdentity(logonAccount))
{
while (true)
{
logonPassword = command.GetWindowsLogonPassword(logonAccount);
if (_windowsServiceHelper.IsValidCredential(domainName, userName, logonPassword))
{
Trace.Info("Credential validation succeed");
break;
}
else
{
if (!command.Unattended)
{
Trace.Info("Invalid credential entered");
_term.WriteLine(StringUtil.Loc("InvalidWindowsCredential"));
}
else
{
throw new SecurityException(StringUtil.Loc("InvalidWindowsCredential"));
}
}
}
}
string serviceName;
string serviceDisplayName;
CalculateServiceName(settings, ServiceNamePattern, ServiceDisplayNamePattern, out serviceName, out serviceDisplayName);
if (_windowsServiceHelper.IsServiceExists(serviceName))
{
_term.WriteLine(StringUtil.Loc("ServiceAlreadyExists", serviceName));
_windowsServiceHelper.UninstallService(serviceName);
}
Trace.Info("Verifying if the account has LogonAsService permission");
if (_windowsServiceHelper.IsUserHasLogonAsServicePrivilege(domainName, userName))
{
Trace.Info($"Account: {logonAccount} already has Logon As Service Privilege.");
}
else
{
if (!_windowsServiceHelper.GrantUserLogonAsServicePrivilage(domainName, userName))
{
throw new InvalidOperationException(StringUtil.Loc("CanNotGrantPermission", logonAccount));
}
}
Trace.Info("Create local group and grant folder permission to service logon account.");
GrantDirectoryPermissionForAccount(logonAccount);
// install service.
_windowsServiceHelper.InstallService(serviceName, serviceDisplayName, logonAccount, logonPassword);
// create .service file with service name.
SaveServiceSettings(serviceName);
// Add registry key after installation
_windowsServiceHelper.CreateVstsAgentRegistryKey();
Trace.Info("Configuration was successful, trying to start the service");
_windowsServiceHelper.StartService(serviceName);
}
public override bool ConfigureService(AgentSettings settings, Dictionary <string, string> args, bool enforceSupplied)
{
Trace.Entering();
// TODO: add entering with info level. By default the error leve would be info. Config changes can get lost with this as entering is at Verbose level. For config all the logs should be logged.
// TODO: Fix bug that exists in the legacy Windows agent where configuration using mirrored credentials causes an error, but the agent is still functional (after restarting). Mirrored credentials is a supported scenario and shouldn't manifest any errors.
var consoleWizard = HostContext.GetService <IConsoleWizard>();
string logonPassword = string.Empty;
NTAccount defaultServiceAccount = _windowsServiceHelper.GetDefaultServiceAccount();
_logonAccount = consoleWizard.ReadValue(WindowsLogonAccount,
StringUtil.Loc("WindowsLogonAccountNameDescription"),
false,
defaultServiceAccount.ToString(),
Validators.NTAccountValidator,
args,
enforceSupplied);
Trace.Info("Received LogonAccount: {0}", _logonAccount);
NativeWindowsServiceHelper.GetAccountSegments(_logonAccount, out _domainName, out _userName);
if ((string.IsNullOrEmpty(_domainName) || _domainName.Equals(".", StringComparison.CurrentCultureIgnoreCase)) && !_logonAccount.Contains('@'))
{
_logonAccount = String.Format("{0}\\{1}", Environment.MachineName, _userName);
}
Trace.Info("LogonAccount after transforming: {0}, user: {1}, domain: {2}", _logonAccount, _userName, _domainName);
if (!defaultServiceAccount.Equals(new NTAccount(_logonAccount)))
{
while (true)
{
Trace.Info("Acquiring logon account password");
logonPassword = consoleWizard.ReadValue(WindowsLogonPassword,
StringUtil.Loc("WindowsLogonPasswordDescription", _logonAccount),
true,
string.Empty,
Validators.NonEmptyValidator,
args,
enforceSupplied);
// TODO: If account is locked there is no point in retrying, translate error to useful message
if (_windowsServiceHelper.IsValidCredential(_domainName, _userName, logonPassword) || enforceSupplied)
{
break;
}
Trace.Info("Invalid credential entered");
_term.WriteLine(StringUtil.Loc("InvalidWindowsCredential"));
}
}
CalculateServiceName(settings, ServiceNamePattern, ServiceDisplayNamePattern);
if (CheckServiceExists(settings.ServiceName))
{
_term.WriteLine(StringUtil.Loc("ServiceAleadyExists"));
StopService(settings.ServiceName);
UninstallService(settings.ServiceName);
}
Trace.Info("Verifying if the account has LogonAsService permission");
if (!_windowsServiceHelper.CheckUserHasLogonAsServicePrivilege(_domainName, _userName))
{
Trace.Info(StringUtil.Format("Account: {0} already has Logon As Service Privilege.", _logonAccount));
}
else
{
if (!_windowsServiceHelper.GrantUserLogonAsServicePrivilage(_domainName, _userName))
{
throw new InvalidOperationException(StringUtil.Loc("CanNotGrantPermission", _logonAccount));
}
}
_windowsServiceHelper.InstallService(settings.ServiceName, settings.ServiceDisplayName, _logonAccount, logonPassword);
// TODO: If its service identity add it to appropriate PoolGroup
// TODO: Add registry key after installation
return(true);
}