Add Proxy Support to Runner

src/Misc/layoutroot/env.sh

@@ -9,9 +9,6 @@ varCheckList=(
  'GRADLE_HOME' 
  'NVM_BIN' 
  'NVM_PATH'
- 'VSTS_HTTP_PROXY'
- 'VSTS_HTTP_PROXY_USERNAME'
- 'VSTS_HTTP_PROXY_PASSWORD'
  'LD_LIBRARY_PATH'
  'PERL5LIB'
  )

src/Runner.Common/Constants.cs

@@ -29,9 +29,6 @@ public enum WellKnownConfigFile
  Service,
  CredentialStore,
  Certificates,
- Proxy,
- ProxyCredentials,
- ProxyBypass,
  Options,
  }
 
@@ -97,8 +94,6 @@ public static class Args
  public static readonly string Auth = "auth";
  public static readonly string MonitorSocketAddress = "monitorsocketaddress";
  public static readonly string Pool = "pool";
- public static readonly string ProxyUrl = "proxyurl";
- public static readonly string ProxyUserName = "proxyusername";
  public static readonly string SslCACert = "sslcacert";
  public static readonly string SslClientCert = "sslclientcert";
  public static readonly string SslClientCertKey = "sslclientcertkey";
@@ -111,14 +106,12 @@ public static class Args
 
  // Secret args. Must be added to the "Secrets" getter as well.
  public static readonly string Password = "password";
- public static readonly string ProxyPassword = "proxypassword";
  public static readonly string SslClientCertPassword = "sslclientcertpassword";
  public static readonly string Token = "token";
  public static readonly string WindowsLogonPassword = "windowslogonpassword";
  public static string[] Secrets => new[]
  {
  Password,
- ProxyPassword,
  SslClientCertPassword,
  Token,
  WindowsLogonPassword,

src/Runner.Common/HostContext.cs

@@ -26,6 +26,7 @@ public interface IHostContext : IDisposable
  ShutdownReason RunnerShutdownReason { get; }
  ISecretMasker SecretMasker { get; }
  ProductInfoHeaderValue UserAgent { get; }
+ RunnerWebProxy WebProxy { get; }
  string GetDirectory(WellKnownDirectory directory);
  string GetConfigFile(WellKnownConfigFile configFile);
  Tracing GetTrace(string name);
@@ -67,12 +68,14 @@ public sealed class HostContext : EventListener, IObserver<DiagnosticListener>,
  private IDisposable _diagListenerSubscription;
  private StartupType _startupType;
  private string _perfFile;
+ private RunnerWebProxy _webProxy = new RunnerWebProxy();
 
  public event EventHandler Unloading;
  public CancellationToken RunnerShutdownToken => _runnerShutdownTokenSource.Token;
  public ShutdownReason RunnerShutdownReason { get; private set; }
  public ISecretMasker SecretMasker => _secretMasker;
  public ProductInfoHeaderValue UserAgent => _userAgent;
+ public RunnerWebProxy WebProxy => _webProxy;
  public HostContext(string hostType, string logFile = null)
  {
  // Validate args.
@@ -147,6 +150,48 @@ public HostContext(string hostType, string logFile = null)
  _trace.Error(ex);
  }
  }
+
+ // Check and trace proxy info
+ if (!string.IsNullOrEmpty(WebProxy.HttpProxyAddress))
+ {
+ if (string.IsNullOrEmpty(WebProxy.HttpProxyUsername) && string.IsNullOrEmpty(WebProxy.HttpProxyPassword))
+ {
+ _trace.Info($"Configuring anonymous proxy {WebProxy.HttpProxyAddress} for all HTTP requests.");
+ }
+ else
+ {
+ // Register proxy password as secret
+ if (!string.IsNullOrEmpty(WebProxy.HttpProxyPassword))
+ {
+ this.SecretMasker.AddValue(WebProxy.HttpProxyPassword);
+ }
+
+ _trace.Info($"Configuring authenticated proxy {WebProxy.HttpProxyAddress} for all HTTP requests.");
+ }
+ }
+
+ if (!string.IsNullOrEmpty(WebProxy.HttpsProxyAddress))
+ {
+ if (string.IsNullOrEmpty(WebProxy.HttpsProxyUsername) && string.IsNullOrEmpty(WebProxy.HttpsProxyPassword))
+ {
+ _trace.Info($"Configuring anonymous proxy {WebProxy.HttpsProxyAddress} for all HTTPS requests.");
+ }
+ else
+ {
+ // Register proxy password as secret
+ if (!string.IsNullOrEmpty(WebProxy.HttpsProxyPassword))
+ {
+ this.SecretMasker.AddValue(WebProxy.HttpsProxyPassword);
+ }
+
+ _trace.Info($"Configuring authenticated proxy {WebProxy.HttpsProxyAddress} for all HTTPS requests.");
+ }
+ }
+
+ if (string.IsNullOrEmpty(WebProxy.HttpProxyAddress) && string.IsNullOrEmpty(WebProxy.HttpsProxyAddress))
+ {
+ _trace.Info($"No proxy settings were found based on environmental variables (http_proxy/https_proxy/HTTP_PROXY/HTTPS_PROXY)");
+ }
  }
 
  public RunMode RunMode
@@ -282,24 +327,6 @@ public string GetConfigFile(WellKnownConfigFile configFile)
  ".certificates");
  break;
 
- case WellKnownConfigFile.Proxy:
- path = Path.Combine(
- GetDirectory(WellKnownDirectory.Root),
- ".proxy");
- break;
-
- case WellKnownConfigFile.ProxyCredentials:
- path = Path.Combine(
- GetDirectory(WellKnownDirectory.Root),
- ".proxycredentials");
- break;
-
- case WellKnownConfigFile.ProxyBypass:
- path = Path.Combine(
- GetDirectory(WellKnownDirectory.Root),
- ".proxybypass");
- break;
-
  case WellKnownConfigFile.Options:
  path = Path.Combine(
  GetDirectory(WellKnownDirectory.Root),
@@ -580,8 +607,7 @@ public static class HostContextExtension
  public static HttpClientHandler CreateHttpClientHandler(this IHostContext context)
  {
  HttpClientHandler clientHandler = new HttpClientHandler();
- var runnerWebProxy = context.GetService<IRunnerWebProxy>();
- clientHandler.Proxy = runnerWebProxy.WebProxy;
+ clientHandler.Proxy = context.WebProxy;
  return clientHandler;
  }
  }

src/Runner.Listener/Agent.cs

@@ -37,9 +37,8 @@ public async Task<int> ExecuteCommand(CommandSettings command)
  {
  try
  {
- var runnerWebProxy = HostContext.GetService<IRunnerWebProxy>();
  var runnerCertManager = HostContext.GetService<IRunnerCertificateManager>();
- VssUtil.InitializeVssClientSettings(HostContext.UserAgent, runnerWebProxy.WebProxy, runnerCertManager.VssClientCertificateManager);
+ VssUtil.InitializeVssClientSettings(HostContext.UserAgent, HostContext.WebProxy, runnerCertManager.VssClientCertificateManager);
 
  _inConfigStage = true;
  _completedCommand.Reset();

src/Runner.Listener/CommandSettings.cs

@@ -47,9 +47,6 @@ public sealed class CommandSettings
  Constants.Runner.CommandLine.Args.MonitorSocketAddress,
  Constants.Runner.CommandLine.Args.Password,
  Constants.Runner.CommandLine.Args.Pool,
- Constants.Runner.CommandLine.Args.ProxyPassword,
- Constants.Runner.CommandLine.Args.ProxyUrl,
- Constants.Runner.CommandLine.Args.ProxyUserName,
  Constants.Runner.CommandLine.Args.SslCACert,
  Constants.Runner.CommandLine.Args.SslClientCert,
  Constants.Runner.CommandLine.Args.SslClientCertKey,
@@ -290,21 +287,6 @@ public string GetStartupType()
  return GetArg(Constants.Runner.CommandLine.Args.StartupType);
  }
 
- public string GetProxyUrl()
- {
- return GetArg(Constants.Runner.CommandLine.Args.ProxyUrl);
- }
-
- public string GetProxyUserName()
- {
- return GetArg(Constants.Runner.CommandLine.Args.ProxyUserName);
- }
-
- public string GetProxyPassword()
- {
- return GetArg(Constants.Runner.CommandLine.Args.ProxyPassword);
- }
-
  public bool GetSkipCertificateValidation()
  {
  return TestFlag(Constants.Runner.CommandLine.Flags.SslSkipCertValidation);