Update remote prompt when using ssh to show username if different #7191

SteveL-MSFT · 2018-06-27T02:46:32Z

PR Summary

Currently, the remote prompt only shows the remote computer name:

[computer] PS:\foo>

With this change, if you use PSRP over SSH and you specified a different username, it shows whom you logged in as:

[user@computer] PS:\foo>

Fix is when the remote prompt is being created to check if using SSH, if so, check if the current user is different than the specified user and specified. If different, use [user@computer], otherwise fallback to default [computer] prompt.

Fix #7156

PR Checklist

iSazonov · 2018-06-27T04:45:59Z

src/System.Management.Automation/engine/hostifaces/HostUtilities.cs

-                return string.Format(CultureInfo.InvariantCulture, "[{0}]: {1}", runspace.ConnectionInfo.ComputerName, basePrompt);
+                SSHConnectionInfo sshConnectionInfo = runspace.ConnectionInfo as SSHConnectionInfo;
+                if (!string.IsNullOrEmpty(sshConnectionInfo.UserName) &&
+                    !System.Environment.UserName.Equals(sshConnectionInfo.UserName, StringComparison.OrdinalIgnoreCase))


Seems we could remove !string.IsNullOrEmpty(sshConnectionInfo.UserName).

In case where username is not explicitly used, at this point in the code UserName is empty so without this check it shows up as [@computer] since empty != current username.

iSazonov · 2018-06-27T04:47:36Z

src/System.Management.Automation/engine/hostifaces/HostUtilities.cs

+                    return string.Format(CultureInfo.InvariantCulture, "[{0}@{1}]: {2}", sshConnectionInfo.UserName, sshConnectionInfo.ComputerName, basePrompt);
+                }
            }
+            return string.Format(CultureInfo.InvariantCulture, "[{0}]: {1}", runspace.ConnectionInfo.ComputerName, basePrompt);


Please add new line after line 783 (from CodeFactor).

PaulHigin · 2018-06-27T15:22:21Z

src/System.Management.Automation/engine/hostifaces/HostUtilities.cs

-                return string.Format(CultureInfo.InvariantCulture, "[{0}]: {1}", runspace.ConnectionInfo.ComputerName, basePrompt);
+                SSHConnectionInfo sshConnectionInfo = runspace.ConnectionInfo as SSHConnectionInfo;
+                if (!string.IsNullOrEmpty(sshConnectionInfo.UserName) &&
+                    !System.Environment.UserName.Equals(sshConnectionInfo.UserName, StringComparison.OrdinalIgnoreCase))


For Windows sshConnectionInfo.UserName can have a domain component (domainName\userName), so we need to handle that unless we make this Linux platform only. We can create a common helper method from here: https://github.com/PowerShell/PowerShell/blob/master/src/System.Management.Automation/engine/remoting/common/RunspaceConnectionInfo.cs#L2052. Or maybe update SSHConnectionInfo to automatically parse and expose UserName and DomainName properties.

I am assuming we would want the prompt to look something like: [user@domain@computer]: PS C:\>

Or maybe just drop the domain...

I think you display it as [<username>@<hostname>] where <username> may or may not specify the additional @domain. That's what I see on Linux with sh (or Bash or whatever ssh is using as a shell).

Currently, it depends on how the user specified the domain name. If they used user@domain, it would be [user@domain@computer]. Alternatively, if they used domain\user, it shows up as [domain\user@computer]. Personally, I think we should show the domain and fine with whichever form the user provided.

We don't currently support user@domain format. It seems like domain information is not needed, but I am fine with [domain\user@computer]. We can easily change it later if it is unpopular.

PaulHigin · 2018-06-27T15:27:06Z

src/System.Management.Automation/engine/hostifaces/HostUtilities.cs

                return basePrompt;
            }
-            else
+            else if (runspace.ConnectionInfo is SSHConnectionInfo)


There is no need to do the runtime cast twice. I suggest:

else { var sshConnectionInfo = runspace.ConnectionInfo as SSHConnectionInfo; if (sshConnectionInfo != null) { ... } else { return string.Format(CultureInfo.InvariantCulture, "[{0}]: {1}", runspace.ConnectionInfo.ComputerName, basePrompt); } }

PaulHigin

Nitpick: I just realized looking at the whole method that we don't need the else block because we are doing early returns. We can just remove it.

SteveL-MSFT · 2018-06-27T17:12:50Z

@PaulHigin agree it's not needed. Can you take a quick look and re-approve?

PaulHigin

LGTM

anmenaga · 2018-07-02T20:18:13Z

src/System.Management.Automation/engine/hostifaces/HostUtilities.cs

+            SSHConnectionInfo sshConnectionInfo = runspace.ConnectionInfo as SSHConnectionInfo;
+            if (sshConnectionInfo != null &&
+                !string.IsNullOrEmpty(sshConnectionInfo.UserName) &&
+                !System.Environment.UserName.Equals(sshConnectionInfo.UserName, StringComparison.OrdinalIgnoreCase))


Aren't unix usernames case sensitive?

You're right, Unix usernames are case-sensitive. I'll change this to a case sensitive comparison.

iSazonov · 2018-07-03T03:41:15Z

src/System.Management.Automation/engine/hostifaces/HostUtilities.cs

+            SSHConnectionInfo sshConnectionInfo = runspace.ConnectionInfo as SSHConnectionInfo;
+            if (sshConnectionInfo != null &&
+                !string.IsNullOrEmpty(sshConnectionInfo.UserName) &&
+                !System.Environment.UserName.Equals(sshConnectionInfo.UserName, StringComparison.Ordinal)) // Usernames are case-sensitive on Unix


Please move the comment on separate line.

TravisEz13 · 2018-07-06T00:03:09Z

@anmenaga Please update your review

rkeithhill

LGTM

iSazonov · 2018-07-17T03:42:46Z

If our docs have related samples we should correct them.

update remote prompt when using ssh to show username if different

704514c

SteveL-MSFT assigned TravisEz13 Jun 27, 2018

SteveL-MSFT requested a review from PaulHigin June 27, 2018 02:46

SteveL-MSFT requested review from BrucePay and daxian-dbw as code owners June 27, 2018 02:46

iSazonov reviewed Jun 27, 2018

View reviewed changes

address codefactor issue

eaaafa3

PaulHigin suggested changes Jun 27, 2018

View reviewed changes

rkeithhill mentioned this pull request Jun 27, 2018

Enhance prompt function to show username/hostname in SSH connection dahlbyk/posh-git#591

Closed

address Paul's feedback

47fb928

PaulHigin approved these changes Jun 27, 2018

View reviewed changes

small optimization to remove unnecessary else clause

a3a1971

PaulHigin approved these changes Jun 28, 2018

View reviewed changes

anmenaga suggested changes Jul 2, 2018

View reviewed changes

address Andrew's feedback

1b30b2c

iSazonov reviewed Jul 3, 2018

View reviewed changes

rkeithhill approved these changes Jul 8, 2018

View reviewed changes

dahlbyk mentioned this pull request Jul 9, 2018

Add Get-PromptConnectionInfo as DefaultPromptPrefix dahlbyk/posh-git#595

Merged

anmenaga approved these changes Jul 9, 2018

View reviewed changes

address CodeFactor issue

82dd133

SteveL-MSFT force-pushed the ssh-prompt branch from 09bc2de to 82dd133 Compare July 9, 2018 19:51

iSazonov approved these changes Jul 10, 2018

View reviewed changes

TravisEz13 merged commit da7b521 into PowerShell:master Jul 16, 2018

SteveL-MSFT deleted the ssh-prompt branch July 16, 2018 19:08

Update remote prompt when using ssh to show username if different #7191

Update remote prompt when using ssh to show username if different #7191

Uh oh!

Conversation

SteveL-MSFT commented Jun 27, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Summary

PR Checklist

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

iSazonov Jun 27, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rkeithhill Jun 27, 2018 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

PaulHigin left a comment

Choose a reason for hiding this comment

Uh oh!

SteveL-MSFT commented Jun 27, 2018

Uh oh!

PaulHigin left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

TravisEz13 commented Jul 6, 2018

Uh oh!

rkeithhill left a comment

Choose a reason for hiding this comment

Uh oh!

iSazonov commented Jul 17, 2018

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

SteveL-MSFT commented Jun 27, 2018 •

edited

Loading

iSazonov Jun 27, 2018 •

edited

Loading

rkeithhill Jun 27, 2018 •

edited

Loading