Skip to content

Get Proxy from Separate module #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Get Proxy from Separate module #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b46b95d
POC
vthiebaut10 Mar 21, 2023
7e08fb2
Address Paul's reviwe comments
vthiebaut10 Mar 27, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
106 changes: 37 additions & 69 deletions src/Ssh/Ssh/Common/SshBaseCmdlet.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -518,54 +518,6 @@ protected internal string GetClientApplicationPath(string command)
return appInfo.Path;
}

protected internal string GetClientSideProxy()
{
string proxyPath = null;
string oldProxyPattern = null;
string requestUrl = null;

GetProxyUrlAndFilename(ref proxyPath, ref oldProxyPattern, ref requestUrl);

if (!File.Exists(proxyPath))
{
string proxyDir = Path.GetDirectoryName(proxyPath);

if (!Directory.Exists(proxyDir))
{
Directory.CreateDirectory(proxyDir);
}
else
{
var files = Directory.GetFiles(proxyDir, oldProxyPattern);
foreach (string file in files)
{
try
{
File.Delete(file);
}
catch (Exception exception)
{
WriteWarning(String.Format(Resources.FailedToDeleteOldProxy, file, exception.Message));
}
}
}

try
{
WebClient wc = new WebClient();
wc.DownloadFile(new Uri(requestUrl), proxyPath);
}
catch (Exception exception)
{
string errorMessage = String.Format(Resources.FailedToDownloadProxy, requestUrl, exception.Message);
throw new AzPSApplicationException(errorMessage);
}

ValidateSshProxy(proxyPath);
}
return proxyPath;
}

protected internal void DeleteFile(string fileName, string warningMessage = null)
{
if (File.Exists(fileName))
Expand Down Expand Up @@ -622,6 +574,35 @@ protected internal bool IsArc()
return false;
}

/// <summary>
/// Get the path of the required Ssh Proxy from the Az.Ssh.ArcProxy module
/// that should be installed, per pre-reqs.
/// </summary>
/// <returns>Path to Proxy Executable</returns>
/// <exception cref="AzPSApplicationException"></exception>
protected internal string GetInstalledProxyModulePath()
{
var results = InvokeCommand.InvokeScript(
script: "(Get-module -ListAvailable -Name Az.Ssh.ArcProxy).Path");

foreach (var result in results)
{
if (result?.BaseObject is string tempPath)
{
string proxyPath = GetProxyPath(tempPath);

if (!File.Exists(proxyPath) || !ValidateSshProxy(proxyPath))
{
continue;
}

return proxyPath;
}
}

throw new AzPSApplicationException("Unable to find a valid proxy");
}

#endregion

#region Private Methods
Expand Down Expand Up @@ -807,10 +788,7 @@ private string CreateTempFolder()
return dirname;
}

private void GetProxyUrlAndFilename(
ref string proxyPath,
ref string oldProxyPattern,
ref string requestUrl)
private string GetProxyPath(string modulePath)
{
string os;
string architecture;
Expand Down Expand Up @@ -842,23 +820,19 @@ private void GetProxyUrlAndFilename(
architecture = "386";
}

string proxyName = "sshProxy_" + os + "_" + architecture;
requestUrl = clientProxyStorageUrl + "/" + clientProxyRelease + "/" + proxyName + "_" + clientProxyVersion;

string installPath = proxyName + "_" + clientProxyVersion.Replace('.', '_');
oldProxyPattern = proxyName + "*";
string proxyName = $"sshProxy_{os}_{architecture}_{clientProxyVersion.Replace('.', '_')}";

if (RuntimeInformation.IsOSPlatform(OSPlatform.Windows))
{
requestUrl = requestUrl + ".exe";
installPath = installPath + ".exe";
oldProxyPattern = oldProxyPattern + ".exe";
proxyName += ".exe";
}

proxyPath = Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.UserProfile), Path.Combine(".clientsshproxy", installPath));
string parentDirectory = Directory.GetParent(modulePath).FullName;

return Path.Combine(parentDirectory, proxyName);
}

private void ValidateSshProxy(string path)
private bool ValidateSshProxy(string path)

{
string hashString;
Expand Down Expand Up @@ -892,13 +866,7 @@ private void ValidateSshProxy(string path)
isValid = hashString.Equals(sshproxy_darwin_amd64_sha256_hash);
break;
}

if (!isValid)
{
WriteWarning($"Validation of SSH Proxy {path} failed. Removing file from system.");
DeleteFile(path);
throw new AzPSApplicationException("Failed to download valid SSH Proxy. Unable to continue cmdlet execution.");
}
return isValid;
}
#endregion

Expand Down
2 changes: 1 addition & 1 deletion src/Ssh/Ssh/SshCommands/EnterAzVMCommand.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ public override void ExecuteCmdlet()
}
if (IsArc())
{
proxyPath = GetClientSideProxy();
proxyPath = GetInstalledProxyModulePath();
UpdateProgressBar(record, $"Dowloaded SSH Proxy, saved to {proxyPath}", 25);
GetRelayInformation();
UpdateProgressBar(record, $"Retrieved Relay Information", 50);
Expand Down
2 changes: 1 addition & 1 deletion src/Ssh/Ssh/SshCommands/ExportAzSshConfig.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ public override void ExecuteCmdlet()
}
if (IsArc())
{
proxyPath = GetClientSideProxy();
proxyPath = GetInstalledProxyModulePath();
UpdateProgressBar(record, $"Downloaded proxy to {proxyPath}", 25);
GetRelayInformation();
UpdateProgressBar(record, "Retrieved relay information", 50);
Expand Down