Skip to content

Avoid validation of options.password when using private key file on SFTP connection. #673

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

Merged
merged 2 commits into from
Sep 7, 2022
Merged

Avoid validation of options.password when using private key file on SFTP connection. #673

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
4d553af
Avoid validation of options.password when using private key file.
sgrampone Aug 22, 2022
738456b
Add test
sgrampone Aug 22, 2022
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
37 changes: 13 additions & 24 deletions dotnet/src/extensions/SecurityAPI/dotnet/dotnetframework/GeneXusSftp/Sftp/SftpClient.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,27 +51,19 @@ public override bool Connect(SftpOptions options)
return false;
}
bool useKey = false;
if (SecurityUtils.compareStrings("", options.KeyPath) || SecurityUtils.compareStrings("", options.User) || SecurityUtils.compareStrings("", options.KeyPassword))
{
useKey = false;
if (SecurityUtils.compareStrings("", options.User)
|| SecurityUtils.compareStrings("", options.Password))
{

this.error.setError("SF001", "Authentication misconfiguration");
return false;
}
else
{
useKey = false;
}
}
else
{
useKey = true;
}


if (!SecurityUtils.compareStrings("", options.KeyPath) )
{
useKey = true;
}else
{
if (SecurityUtils.compareStrings("", options.User)
|| SecurityUtils.compareStrings("", options.Password))
{

this.error.setError("SF001", "Authentication misconfiguration. Missing user or password");
return false;
}
}

if (SecurityUtils.compareStrings("", options.Host))
{
Expand Down Expand Up @@ -318,9 +310,6 @@ private void SetupChannelSftp(SftpOptions options, bool useKey)

PrivateKeyFile keyFile = new PrivateKeyFile(options.KeyPath, options.KeyPassword);
method.Add(new PrivateKeyAuthenticationMethod(options.User, keyFile));



}
else
{
Expand Down
1 change: 1 addition & 0 deletions ...tensions/SecurityAPI/test/dotnetcore/SecurityAPITestNetCore/SecurityAPITestNetCore.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@
<Compile Include="..\..\dotnetframework\SecurityAPITest\SecurityAPICommons\keys\TestBase64PrivateKey.cs" Link="SecurityAPICommons\keys\TestBase64PrivateKey.cs" />
<Compile Include="..\..\dotnetframework\SecurityAPITest\SecurityAPICommons\keys\TestBase64PublicKey.cs" Link="SecurityAPICommons\keys\TestBase64PublicKey.cs" />
<Compile Include="..\..\dotnetframework\SecurityAPITest\Sftp\TestSftp.cs" Link="Sftp\TestSftp.cs" />
<Compile Include="..\..\dotnetframework\SecurityAPITest\Sftp\TestLoginWithKeyWithoutPassword.cs" Link="Sftp\TestLoginWithKeyWithoutPassword.cs" />
<Compile Include="..\..\dotnetframework\SecurityAPITest\XmlSignature\DSig\TestBase64Certificate.cs" Link="XmlSignature\DSig\TestBase64Certificate.cs" />
<Compile Include="..\..\dotnetframework\SecurityAPITest\XmlSignature\DSig\TestFindID.cs" Link="XmlSignature\DSig\TestFindID.cs" />
<Compile Include="..\..\dotnetframework\SecurityAPITest\XmlSignature\DSig\TestRSASigning.cs" Link="XmlSignature\DSig\TestRSASigning.cs" />
Expand Down
74 changes: 74 additions & 0 deletions .../SecurityAPI/test/dotnetframework/SecurityAPITest/Sftp/TestLoginWithKeyWithoutPassword.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
using SecurityAPITest.SecurityAPICommons.commons;
using NUnit.Framework;
using Sftp.GeneXusSftp;
using System.IO;
using System;

namespace SecurityAPITest.Sftp
{
[TestFixture]
[RunIfRunSettingsConfigured]
public class TestLoginWithKeyWithoutPassword : SecurityAPITestObject
{
protected static string host;
protected static string user;
protected static string keyPath;
protected static string keyPassword;
protected static string localPath;
protected static string remoteDir;
protected static string remoteFilePath;
protected static string localDir;


[SetUp]
public virtual void SetUp()
{

host = TestContextParameter("gx_ftp_host");
user = TestContextParameter("gx_sftp_user");
string known_hosts_content_base64 = TestContextParameter("gx_ftp_known_hosts_content_base64");
keyPath = Path.Combine(BASE_PATH, "Temp", "sftptest", "key", "id_rsa");
string id_rsaConentBase64 = TestContextParameter("gx_ftp_id_rsa_content_base64");
File.WriteAllBytes(keyPath, Convert.FromBase64String(id_rsaConentBase64));
keyPassword = TestContextParameter("gx_sftp_key_password");
localPath = Path.Combine(BASE_PATH, "Temp", "sftptest", "sftptest1.txt");
remoteDir = "sftp";
remoteFilePath = "sftp/sftptest1.txt";
localDir = Path.Combine(BASE_PATH, "Temp", "sftptest", "back");
}

private SftpClient TestConnection(SftpOptions options)
{
SftpClient client = new SftpClient();
bool connected = client.Connect(options);
True(connected, client);
return client;
}

private void TestPut(SftpClient client)
{
bool put = client.Put(localPath, remoteDir);
True(put, client);
}

private void TestGet(SftpClient client)
{
bool get = client.Get(remoteFilePath, localDir);
True(get, client);
}

[Test]
public void TestWithKey()
{
SftpOptions options = new SftpOptions();
options.Host = host;
options.User = user;
options.AllowHostKeyChecking = false;
options.KeyPassword = keyPassword;
SftpClient client = TestConnection(options);
TestPut(client);
TestGet(client);
client.Disconnect();
}
}
}