maxmustermann/PowerShell
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Remove extraneous SSH and install docs from the 'demos' folder (#6628)

Browse source
This commit is contained in:
Joey Aiello 2018-04-13 15:50:54 -07:00 committed by Dongbo Wang
parent 11631e7412
commit feb38cff70
5 changed files with 5 additions and 262 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

36
.spelling
View file

@ -466,39 +466,6 @@ _script.ps1.
rest.ps1
#endregion
#region demos/SSHRemoting/README.md Overrides
- demos/SSHRemoting/README.md
_config
2kCbnhT2dUE6WCGgVJ8Hyfu1z2wE4lifaJXLO7QJy0Y
com.openssh.sshd
ComputerName
ComputerType
ConfigurationName
Enter-PSSession
HostName
KeyFilePath
KeyPath
launchctl
New-PSSession
NoLogo
NoProfile
openssh-client
openssh-server
PasswordAuthentication
PSCredential
PSSessions
PubkeyAuthentication
RSAAuthentication
ssh.exe
sshd
sshd.exe
sshs
TestUser
UbuntuVM1
UbuntuVM1s
usr
#endregion
#region demos/SystemD/readme.md Overrides
- demos/SystemD/readme.md
Get-SystemDJournal
@ -707,6 +674,7 @@ windir
- docs/KNOWNISSUES.md
cp
globbing
New-PSSession
pipelining
psl-omi-provider
Register-WmiEvent
@ -834,6 +802,7 @@ Enable-RunspaceDebug
Enable-WSManCredSSP
Enable-WSManTrace
Enter-PSHostProcess
Enter-PSSession
Exit-PSHostProcess
Exit-PSSession
Export-BinaryMiLog
@ -899,6 +868,7 @@ New-LocalGroup
New-LocalUser
New-ModuleManifest
New-PSDrive
New-PSSession
New-PSRoleCapabilityFile
New-PSSessionConfigurationFile
New-ScriptFileInfo

221
demos/SSHRemoting/README.md
View file

@ -1,221 +0,0 @@
# PowerShell Remoting Over SSH
## Overview
PowerShell remoting normally uses WinRM for connection negotiation and data transport.
SSH was chosen for this remoting implementation since it is now available for both Linux and Windows platforms and allows true multiplatform PowerShell remoting.
However, WinRM also provides a robust hosting model for PowerShell remote sessions which this implementation does not yet do.
And this means that PowerShell remote endpoint configuration and JEA (Just Enough Administration) is not yet supported in this implementation.
PowerShell SSH remoting lets you do basic PowerShell session remoting between Windows and Linux machines.
This is done by creating a PowerShell hosting process on the target machine as an SSH subsystem.
Eventually this will be changed to a more general hosting model similar to how WinRM works in order to support endpoint configuration and JEA.
The New-PSSession, Enter-PSSession and Invoke-Command cmdlets now have a new parameter set to facilitate this new remoting connection
```powershell
[-HostName <string>] [-UserName <string>] [-KeyFilePath <string>]
```
This new parameter set will likely change but for now allows you to create SSH PSSessions that you can interact with from the command line or invoke commands and scripts on.
You specify the target machine with the HostName parameter and provide the user name with UserName.
When running the cmdlets interactively at the PowerShell command line you will be prompted for a password.
But you also have the option to use SSH key authentication and provide a private key file path with the KeyFilePath parameter.
## General setup information
SSH is required to be installed on all machines.
You should install both client (ssh.exe) and server (sshd.exe) so that you can experiment with remoting to and from the machines.
For Windows you will need to install [Win32 OpenSSH from GitHub](https://github.com/PowerShell/Win32-OpenSSH/releases).
For Linux you will need to install SSH (including sshd server) appropriate to your platform.
You will also need a recent PowerShell build or package from GitHub having the SSH remoting feature.
SSH subsystems is used to establish a PowerShell process on the remote machine and the SSH server will need to be configured for that.
In addition you will need to enable password authentication and optionally key based authentication.
## Setup on Windows Machine
1. Install the latest [PowerShell for Windows] build from GitHub
- You can tell if it has the SSH remoting support by looking at the parameter sets for New-PSSession
```powershell
PS> Get-Command New-PSSession -syntax
New-PSSession [-HostName] <string[]> [-Name <string[]>] [-UserName <string>] [-KeyFilePath <string>] [-SSHTransport] [<CommonParameters>]
```
1. Install the latest [Win32 Open SSH] build from GitHub using the [installation] instructions
1. Edit the `sshd_config` file at the location where you installed Win32 Open SSH
- Make sure password authentication is enabled
```none
PasswordAuthentication yes
```
- Add a PowerShell subsystem entry, replace `c:/program files/powershell/6.0.1/pwsh.exe` with the correct path to the version you want to use
```none
Subsystem powershell c:/program files/powershell/6.0.1/pwsh.exe -sshs -NoLogo -NoProfile
```
- Optionally enable key authentication
```none
PubkeyAuthentication yes
```
1. Restart the sshd service
```powershell
Restart-Service sshd
```
1. Add the path where OpenSSH is installed to your Path Env Variable
- This should be along the lines of `C:\Program Files\OpenSSH\`
- This allows for the ssh.exe to be found
## Setup on Linux (Ubuntu 14.04) Machine
1. Install the latest [PowerShell for Linux] build from GitHub
1. Install [Ubuntu SSH] as needed
```bash
sudo apt install openssh-client
sudo apt install openssh-server
```
1. Edit the `sshd_config` file at location /etc/ssh
- Make sure password authentication is enabled
```none
PasswordAuthentication yes
```
- Add a PowerShell subsystem entry
```none
Subsystem powershell /usr/bin/pwsh -sshs -NoLogo -NoProfile
```
- Optionally enable key authentication
```none
PubkeyAuthentication yes
```
1. Restart the sshd service
```bash
sudo service sshd restart
```
## Setup on MacOS Machine
1. Install the latest [PowerShell for MacOS] build
- Make sure SSH Remoting is enabled by following these steps:
+ Open `System Preferences`
+ Click on `Sharing`
+ Check `Remote Login` - Should say `Remote Login: On`
+ Allow access to appropriate users
1. Edit the `sshd_config` file at location `/private/etc/ssh/sshd_config`
- Use your favorite editor or
```bash
sudo nano /private/etc/ssh/sshd_config
```
- Make sure password authentication is enabled
```none
PasswordAuthentication yes
```
- Add a PowerShell subsystem entry
```none
Subsystem powershell /usr/local/bin/powershell -sshs -NoLogo -NoProfile
```
- Optionally enable key authentication
```none
PubkeyAuthentication yes
```
1. Restart the sshd service
```bash
sudo launchctl stop com.openssh.sshd
sudo launchctl start com.openssh.sshd
```
## PowerShell Remoting Example
The easiest way to test remoting is to just try it on a single machine.
Here I will create a remote session back to the same machine on a Linux box.
Notice that I am using PowerShell cmdlets from a command prompt so we see prompts from SSH asking to verify the host computer as well as password prompts.
You can do the same thing on a Windows machine to ensure remoting is working there and then remote between machines by simply changing the host name.
```powershell
#
# Linux to Linux
#
PS /home/TestUser> $session = New-PSSession -HostName UbuntuVM1 -UserName TestUser
The authenticity of host 'UbuntuVM1 (9.129.17.107)' cannot be established.
ECDSA key fingerprint is SHA256:2kCbnhT2dUE6WCGgVJ8Hyfu1z2wE4lifaJXLO7QJy0Y.
Are you sure you want to continue connecting (yes/no)?
TestUser@UbuntuVM1s password:
PS /home/TestUser> $session
Id Name ComputerName ComputerType State ConfigurationName Availability
-- ---- ------------ ------------ ----- ----------------- ------------
1 SSH1 UbuntuVM1 RemoteMachine Opened DefaultShell Available
PS /home/TestUser> Enter-PSSession $session
[UbuntuVM1]: PS /home/TestUser> uname -a
Linux TestUser-UbuntuVM1 4.2.0-42-generic 49~14.04.1-Ubuntu SMP Wed Jun 29 20:22:11 UTC 2016 x86_64 x86_64 x86_64 GNU/Linux
[UbuntuVM1]: PS /home/TestUser> Exit-PSSession
PS /home/TestUser> Invoke-Command $session -ScriptBlock { Get-Process powershell }
Handles NPM(K) PM(K) WS(K) CPU(s) Id SI ProcessName PSComputerName
------- ------ ----- ----- ------ -- -- ----------- --------------
0 0 0 19 3.23 10635 635 powershell UbuntuVM1
0 0 0 21 4.92 11033 017 powershell UbuntuVM1
0 0 0 20 3.07 11076 076 powershell UbuntuVM1
#
# Linux to Windows
#
PS /home/TestUser> Enter-PSSession -HostName WinVM1 -UserName PTestName
PTestName@WinVM1s password:
[WinVM1]: PS C:\Users\PTestName\Documents> cmd /c ver
Microsoft Windows [Version 10.0.10586]
[WinVM1]: PS C:\Users\PTestName\Documents>
#
# Windows to Windows
#
C:\Users\PSUser\Documents>pwsh.exe
PowerShell
Copyright (c) Microsoft Corporation. All rights reserved.
PS C:\Users\PSUser\Documents> $session = New-PSSession -HostName WinVM2 -UserName PSRemoteUser
The authenticity of host 'WinVM2 (10.13.37.3)' can't be established.
ECDSA key fingerprint is SHA256:kSU6slAROyQVMEynVIXAdxSiZpwDBigpAF/TXjjWjmw.
Are you sure you want to continue connecting (yes/no)?
Warning: Permanently added 'WinVM2,10.13.37.3' (ECDSA) to the list of known hosts.
PSRemoteUser@WinVM2's password:
PS C:\Users\PSUser\Documents> $session
Id Name ComputerName ComputerType State ConfigurationName Availability
-- ---- ------------ ------------ ----- ----------------- ------------
1 SSH1 WinVM2 RemoteMachine Opened DefaultShell Available
PS C:\Users\PSUser\Documents> Enter-PSSession -Session $session
[WinVM2]: PS C:\Users\PSRemoteUser\Documents> $PSVersionTable
Name Value
---- -----
PSEdition Core
PSCompatibleVersions {1.0, 2.0, 3.0, 4.0...}
SerializationVersion 1.1.0.1
BuildVersion 3.0.0.0
CLRVersion
PSVersion 6.0.0-alpha
WSManStackVersion 3.0
PSRemotingProtocolVersion 2.3
GitCommitId v6.0.0-alpha.17
[WinVM2]: PS C:\Users\PSRemoteUser\Documents>
```
### Known Issues
1. sudo command does not work in remote session to Linux machine.
[PowerShell for Windows]: https://github.com/PowerShell/PowerShell/blob/master/docs/installation/windows.md#msi
[Win32 Open SSH]: https://github.com/PowerShell/Win32-OpenSSH
[installation]: https://github.com/PowerShell/Win32-OpenSSH/wiki/Install-Win32-OpenSSH
[PowerShell for Linux]: https://github.com/PowerShell/PowerShell/blob/master/docs/installation/linux.md#ubuntu-1404
[Ubuntu SSH]: https://help.ubuntu.com/lts/serverguide/openssh-server.html
[PowerShell for MacOS]: https://github.com/PowerShell/PowerShell/blob/master/docs/installation/macos.md

5
demos/install/README.md
View file

@ -1,5 +0,0 @@
# Install demo
For Windows refer to the [installation instructions](https://github.com/PowerShell/PowerShell/blob/master/docs/installation/windows.md).
For Linux, using [`install-powershell.sh`](https://github.com/PowerShell/PowerShell/blob/master/tools/install-powershell-readme.md) is the best way to deploy PowerShell bits.

4
docs/KNOWNISSUES.md
View file

@ -84,7 +84,7 @@ We are working to support UTF-8 without a BOM and potentially changing the encod
There is no job-control support in PowerShell on Linux/macOS.
The `fg` and `bg` commands are not available.
For the time being, you can use [PowerShell jobs](https://msdn.microsoft.com/en-us/powershell/reference/5.1/microsoft.powershell.core/about/about_jobs) which do work across all platforms.
For the time being, you can use [PowerShell jobs](https://msdn.microsoft.com/powershell/reference/5.1/microsoft.powershell.core/about/about_jobs) which do work across all platforms.
### Remoting Support
@ -94,7 +94,7 @@ Currently, PowerShell Core supports PowerShell Remoting (PSRP) over WSMan with B
The work for WSMan-based remoting is being done in the [psl-omi-provider](https://github.com/PowerShell/psl-omi-provider) repo.
PowerShell Core also supports PowerShell Remoting (PSRP) over SSH on all platforms (Windows, macOS, and Linux).
While this is not currently supported in production, you can learn more about setting this up [here](https://github.com/PowerShell/PowerShell/tree/master/demos/SSHRemoting).
While this is not currently supported in production, you can learn more about setting this up [here](https://docs.microsoft.com/powershell/scripting/core-powershell/ssh-remoting-in-powershell-core).
### Just-Enough-Administration (JEA) Support

1
test/common/markdown/markdown.tests.ps1
View file

@ -76,7 +76,6 @@ Describe 'Common Tests - Validate Markdown Files' -Tag 'CI' {
$docsToTest = @(
'./.github/CONTRIBUTING.md'
'./*.md'
'./demos/SSHRemoting/*.md'
'./demos/python/*.md'
'./docker/*.md'
'./docs/*.md'