From 011642d5ba814ed61f070bdc72f7db76c18841ed Mon Sep 17 00:00:00 2001 From: lazariv <taras.lazariv@tu-dresden.de> Date: Wed, 15 Jun 2022 12:12:19 +0000 Subject: [PATCH] Clean up --- .../docs/access/ssh_linux.md | 130 ------------ .../docs/access/ssh_login.md | 158 --------------- .../docs/access/ssh_windows.md | 187 ------------------ 3 files changed, 475 deletions(-) delete mode 100644 doc.zih.tu-dresden.de/docs/access/ssh_linux.md delete mode 100644 doc.zih.tu-dresden.de/docs/access/ssh_login.md delete mode 100644 doc.zih.tu-dresden.de/docs/access/ssh_windows.md diff --git a/doc.zih.tu-dresden.de/docs/access/ssh_linux.md b/doc.zih.tu-dresden.de/docs/access/ssh_linux.md deleted file mode 100644 index 6126ba2ed..000000000 --- a/doc.zih.tu-dresden.de/docs/access/ssh_linux.md +++ /dev/null @@ -1,130 +0,0 @@ -# Connecting from Linux - -SSH establishes secure connections using authentication and encryption. Thus, please use an -up-to-date SSH client. The login nodes accept the following encryption algorithms: - -* `aes128-ctr` -* `aes192-ctr` -* `aes256-ctr` -* `aes128-gcm@openssh.com` -* `aes256-gcm@openssh.com` -* `chacha20-poly1305@openssh.com` -* `chacha20-poly1305@openssh.com` - -## Before Your First Connection - -We suggest to create an SSH key pair before you work with the ZIH systems. This ensures high -connection security. - -```console -marie@local$ mkdir -p ~/.ssh -marie@local$ ssh-keygen -t ed25519 -f ~/.ssh/id_ed25519 -Generating public/private ed25519 key pair. -Enter passphrase (empty for no passphrase): -Enter same passphrase again: -[...] -``` - -Type in a passphrase for the protection of your key. The passphrase should be **non-empty**. -Copy the public key to the ZIH system (Replace placeholder `marie` with your ZIH login): - -```console -marie@local$ ssh-copy-id -i ~/.ssh/id_ed25519.pub marie@taurus.hrsk.tu-dresden.de -The authenticity of host 'taurus.hrsk.tu-dresden.de (141.30.73.104)' can't be established. -RSA key fingerprint is SHA256:HjpVeymTpk0rqoc8Yvyc8d9KXQ/p2K0R8TJ27aFnIL8. -Are you sure you want to continue connecting (yes/no)? -``` - -Compare the shown fingerprint with the [documented fingerprints](key_fingerprints.md). Make sure -they match. Then you can accept by typing `yes`. - -!!! info - If `ssh-copy-id` is not available, you need to do additional steps: - - ```console - marie@local$ scp ~/.ssh/id_ed25519.pub marie@taurus.hrsk.tu-dresden.de: - The authenticity of host 'taurus.hrsk.tu-dresden.de (141.30.73.104)' can't be established. - RSA key fingerprint is SHA256:HjpVeymTpk0rqoc8Yvyc8d9KXQ/p2K0R8TJ27aFnIL8. - Are you sure you want to continue connecting (yes/no)? - ``` - - After that, you need to manually copy the key to the right place: - - ```console - marie@local$ ssh marie@taurus.hrsk.tu-dresden.de - [...] - marie@login$ mkdir -p ~/.ssh - marie@login$ touch ~/.ssh/authorized_keys - marie@login$ cat id_ed25519.pub >> ~/.ssh/authorized_keys - ``` - -### Configuring Default Parameters for SSH - -After you have copied your key to the ZIH system, you should be able to connect using: - -```console -marie@local$ ssh marie@taurus.hrsk.tu-dresden.de -[...] -marie@login$ exit -``` - -However, you can make this more comfortable if you prepare an SSH configuration on your local -workstation. Navigate to the subdirectory `.ssh` in your home directory and open the file `config` -(`~/.ssh/config`) in your favorite editor. If it does not exist, create it. Put the following lines -in it (you can omit lines starting with `#`): - -```bash -Host taurus - #For login (shell access) - HostName taurus.hrsk.tu-dresden.de - #Put your ZIH-Login after keyword "User": - User marie - #Path to private key: - IdentityFile ~/.ssh/id_ed25519 - #Don't try other keys if you have more: - IdentitiesOnly yes - #Enable X11 forwarding for graphical applications and compression. You don't need parameter -X and -C when invoking ssh then. - ForwardX11 yes - Compression yes -Host taurusexport - #For copying data without shell access - HostName taurusexport.hrsk.tu-dresden.de - #Put your ZIH-Login after keyword "User": - User marie - #Path to private key: - IdentityFile ~/.ssh/id_ed25519 - #Don't try other keys if you have more: - IdentitiesOnly yes -``` - -Afterwards, you can connect to the ZIH system using: - -```console -marie@local$ ssh taurus -``` - -If you want to copy data from/to ZIH systems, please refer to [Export Nodes: Transfer Data to/from -ZIH's Filesystems](../data_transfer/export_nodes.md) for more information on export nodes. - -## X11-Forwarding - -If you plan to use an application with graphical user interface (GUI), you need to enable -X11-forwarding for the connection. If you use the SSH configuration described above, everything is -already prepared and you can simply use: - -```console -marie@local$ ssh taurus -``` - -If you have omitted the last two lines in the default configuration above, you need to add the -option `-X` or `-XC` to your SSH command. The `-C` enables compression which usually improves -usability in this case: - -```console -marie@local$ ssh -XC taurus -``` - -!!! info - - Also consider to use a [DCV session](desktop_cloud_visualization.md) for remote desktop - visualization at ZIH systems. diff --git a/doc.zih.tu-dresden.de/docs/access/ssh_login.md b/doc.zih.tu-dresden.de/docs/access/ssh_login.md deleted file mode 100644 index a0fef4401..000000000 --- a/doc.zih.tu-dresden.de/docs/access/ssh_login.md +++ /dev/null @@ -1,158 +0,0 @@ -# Connecting with SSH - -For security reasons, ZIH systems are only accessible for hosts within the domains of TU Dresden. - -## Virtual Private Network (VPN) - -To access the ZIH systems from outside the campus networks it's recommended to set up a VPN -connection to enter the campus network. While active, it allows the user to connect directly to the -HPC login nodes. - -For more information on our VPN and how to set it up, please visit the corresponding -[ZIH service catalog page](https://tu-dresden.de/zih/dienste/service-katalog/arbeitsumgebung/zugang_datennetz/vpn). - -## Connecting from Linux - -SSH establishes secure connections using authentication and encryption. Thus, please use an -up-to-date SSH client. The login nodes accept the following encryption algorithms: - -* `aes128-ctr` -* `aes192-ctr` -* `aes256-ctr` -* `aes128-gcm@openssh.com` -* `aes256-gcm@openssh.com` -* `chacha20-poly1305@openssh.com` -* `chacha20-poly1305@openssh.com` - -### Before Your First Connection - -We suggest to create an SSH key pair before you work with the ZIH systems. This ensures high -connection security. - -```console -marie@local$ mkdir -p ~/.ssh -marie@local$ ssh-keygen -t ed25519 -f ~/.ssh/id_ed25519 -Generating public/private ed25519 key pair. -Enter passphrase (empty for no passphrase): -Enter same passphrase again: -[...] -``` - -Type in a passphrase for the protection of your key. The passphrase should be **non-empty**. -Copy the public key to the ZIH system (Replace placeholder `marie` with your ZIH login): - -```console -marie@local$ ssh-copy-id -i ~/.ssh/id_ed25519.pub marie@taurus.hrsk.tu-dresden.de -The authenticity of host 'taurus.hrsk.tu-dresden.de (141.30.73.104)' can't be established. -RSA key fingerprint is SHA256:HjpVeymTpk0rqoc8Yvyc8d9KXQ/p2K0R8TJ27aFnIL8. -Are you sure you want to continue connecting (yes/no)? -``` - -Compare the shown fingerprint with the [documented fingerprints](key_fingerprints.md). Make sure -they match. Then you can accept by typing `yes`. - -!!! info - If `ssh-copy-id` is not available, you need to do additional steps: - - ```console - marie@local$ scp ~/.ssh/id_ed25519.pub marie@taurus.hrsk.tu-dresden.de: - The authenticity of host 'taurus.hrsk.tu-dresden.de (141.30.73.104)' can't be established. - RSA key fingerprint is SHA256:HjpVeymTpk0rqoc8Yvyc8d9KXQ/p2K0R8TJ27aFnIL8. - Are you sure you want to continue connecting (yes/no)? - ``` - - After that, you need to manually copy the key to the right place: - - ```console - marie@local$ ssh marie@taurus.hrsk.tu-dresden.de - [...] - marie@login$ mkdir -p ~/.ssh - marie@login$ touch ~/.ssh/authorized_keys - marie@login$ cat id_ed25519.pub >> ~/.ssh/authorized_keys - ``` - -#### Configuring Default Parameters for SSH - -After you have copied your key to the ZIH system, you should be able to connect using: - -```console -marie@local$ ssh marie@taurus.hrsk.tu-dresden.de -[...] -marie@login$ exit -``` - -However, you can make this more comfortable if you prepare an SSH configuration on your local -workstation. Navigate to the subdirectory `.ssh` in your home directory and open the file `config` -(`~/.ssh/config`) in your favorite editor. If it does not exist, create it. Put the following lines -in it (you can omit lines starting with `#`): - -```bash -Host taurus - #For login (shell access) - HostName taurus.hrsk.tu-dresden.de - #Put your ZIH-Login after keyword "User": - User marie - #Path to private key: - IdentityFile ~/.ssh/id_ed25519 - #Don't try other keys if you have more: - IdentitiesOnly yes - #Enable X11 forwarding for graphical applications and compression. You don't need parameter -X and -C when invoking ssh then. - ForwardX11 yes - Compression yes -Host taurusexport - #For copying data without shell access - HostName taurusexport.hrsk.tu-dresden.de - #Put your ZIH-Login after keyword "User": - User marie - #Path to private key: - IdentityFile ~/.ssh/id_ed25519 - #Don't try other keys if you have more: - IdentitiesOnly yes -``` - -Afterwards, you can connect to the ZIH system using: - -```console -marie@local$ ssh taurus -``` - -If you want to copy data from/to ZIH systems, please refer to [Export Nodes: Transfer Data to/from -ZIH's Filesystems](../data_transfer/export_nodes.md) for more information on export nodes. - -### X11-Forwarding - -If you plan to use an application with graphical user interface (GUI), you need to enable -X11-forwarding for the connection. If you use the SSH configuration described above, everything is -already prepared and you can simply use: - -```console -marie@local$ ssh taurus -``` - -If you have omitted the last two lines in the default configuration above, you need to add the -option `-X` or `-XC` to your SSH command. The `-C` enables compression which usually improves -usability in this case: - -```console -marie@local$ ssh -XC taurus -``` - -!!! info - - Also consider to use a [DCV session](desktop_cloud_visualization.md) for remote desktop - visualization at ZIH systems. - -## Connecting from Windows - -We recommend one of the following applications: - - * [MobaXTerm](https://mobaxterm.mobatek.net): [ZIH documentation](misc/basic_usage_of_MobaXterm.pdf) - * [PuTTY](https://www.putty.org): [ZIH documentation](misc/basic_usage_of_PuTTY.pdf) - * For Windows 10 (1809 and higher): - * [Windows Terminal](https://www.microsoft.com/store/productId/9N0DX20HK701) - * Together with the built-in [OpenSSH Client](https://docs.microsoft.com/de-de/windows-server/administration/openssh/openssh_overview) - -## SSH Key Fingerprints - -The page [key fingerprints](key_fingerprints.md) holds the up-to-date fingerprints for the login -nodes. Make sure they match. diff --git a/doc.zih.tu-dresden.de/docs/access/ssh_windows.md b/doc.zih.tu-dresden.de/docs/access/ssh_windows.md deleted file mode 100644 index 5f1c66a5a..000000000 --- a/doc.zih.tu-dresden.de/docs/access/ssh_windows.md +++ /dev/null @@ -1,187 +0,0 @@ -# Connecting from Windows - -There several options to connect with SSH from Windows operating system. For more recent versions -of Windows (Windows 10 - version 1809 and higher) it is possible to use built-in terminal (also -known as [Command Prompt](https://en.wikipedia.org/wiki/Cmd.exe) -or [PowerShell](https://en.wikipedia.org/wiki/PowerShell)). - -## Connecting from Windows with terminal - -Start PowerShell with pressing `Win + R` and typing `powershell`. -Check that SSH client is available by typing `ssh` in a terminal: - -```powershell -PS marie@local$ ssh -usage: ssh [-46AaCfGgKkMNnqsTtVvXxYy] [-B bind_interface] - [-b bind_address] [-c cipher_spec] [-D [bind_address:]port] - [-E log_file] [-e escape_char] [-F configfile] [-I pkcs11] - [-i identity_file] [-J [user@]host[:port]] [-L address] - [-l login_name] [-m mac_spec] [-O ctl_cmd] [-o option] [-p port] - [-Q query_option] [-R address] [-S ctl_path] [-W host:port] - [-w local_tun[:remote_tun]] destination [command] -``` - -If you have similar output as above, just proceed with the documentation for -[connecting with SSH from Linux](ssh_linux.md). Otherwise, refer to Microsoft documentation -regarding [OpenSSH](https://docs.microsoft.com/en-us/windows-hardware/manufacture/desktop/factoryos/connect-using-ssh?view=windows-10). - -## Connecting from Windows with MobaXterm - -MobaXterm is an enhanced terminal for Windows with an X11 server, a tabbed SSH client, network -tools and more. - -Visit its homepage for more information (https://mobaxterm.mobatek.net). - -### Download and install - -To download go to [MobaXterm homepage](https://mobaxterm.mobatek.net/download-home-edition.html) -and download a free home edition. - - - -Pick the installer suiting best your current system and run it afterwards. Follow the instructions. -You should see the following interface after starting the MobaXterm application. - - - -### Configure local settings - -Select the tab `Settings` → `Configuration` or click the button `Settings` in the toolbar. A -new window will open. - - - -Here you can set different options in different tabs: - -- `General` - local pathing-options for local MobaXterm-session, -- `Terminal` - options, which alter your Terminal. e.g. color scheme, -- `X11` - options for X11-forwarding. It is enabled by default, -- `SSH` - general SSH settings e.g. keep-alive, SSH agent, browser-options, -- `Display` - general display-options for the application, -- `Toolbar` - customization of the toolbar, -- `Misc` - options to alter specific actions inside the MobaXterm-application. - -### Start a new session - -1. Select the tab `Sessions` → `New session` or click the button `Session` in the toolbar. - - - -2. Select a SSH section. Insert `Remote host` (taurus.hrsk.tu-dresden.de), `Username` ("marie" in - this example), and `Port` 22. Near username, you can store credentials or just passphrases for - specific connection (not recommended). - - - -3. You can configure advanced settings in the same window below. These are - -- `Advanced SSH settings` - set defaults for this specific new session. For example, set an SSH key or change the remote environment, -- `Terminal settings` - change some terminal options, -- `Network settings` - configure how the connection is built over the network. For example, by adding a proxy as gateway to the targeted system, -- `Bookmark settings` - specify how the session will be saved to your session list, which is afterwards -accessible by the top left navigation tab named `Sessions`. - -4. Start the session by clicking the button `OK`. - - If it is **not** your first time, your previous sessions are saved and you can find by going to - the tab `Sessions` → `User sessions` and click the desired session. You can double click - on one of your previous sessions the left. - - - -5. The last thing to do is to input your HPC password in the command line and to press `enter`. - - - -!!! Caution - - Do not forget to close the session after your jobs are finished. Just enter `exit` in the - command line and complete with pressing `enter`. So, the system knows that you are off. - Otherwise, the cores reserved for you cannot be used by other users. Your CPU time stays active - until your reserved time will be over. - - - - - - - - - -## Connecting from Windows with PuTTY - -PuTTY is a free and open-source terminal emulator, serial console and network file transfer application, supports several network protocols, including SCP, SSH. Visit its homepage for more information (https://www.putty.org) - -### Download and install - -To download go https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html - - - -Pick the installer suiting best your current system and run it afterwards. Follow the instructions. - -### Quickstart a new SSH session - -1. Start PuTTY and insert the `Host Name` (taurus.hrsk.tu-dresden.de) and change the `Port` (22) if needed. - - - -2. Click "Open" to start a new session. A Terminal will open up as new window. This action will do -basically the same as using the command `ssh taurus.hrsk.tu-dresden.de:22` in Terminal. - - - -3. After inserting your user name ("marie" in this example) and your password, it will log you in. You can start working on HPC. - -### Configured start a new SSH session - -You can preconfigure some values. It will save your time during your connections in the future. - -1. Define the connection target. To do so, start PuTTY, define the hostname (taurus.hrsk.tu-dresden.de) and the port (22). - - - -2. Set your user name. For that choose the tab `Connection` → `Data` in the navigation tree on the left. -Insert your user name into the text field `Auto-login username`. -The application will basically perform the same action as the command `ssh marie@taurus.hrsk.tudresden.de:22` in Terminal. - - - -3. Set a SSH-key (optional and recommended for security reason). - - **Note**: For being able to use a SSH key to login to HPC, you have to register the key on the - system before! - - Add the public-key to `~/.ssh/authorized_keys` and use the following format. - - ```console - # <key-type> <public key> <comment> - ssh-ed25519 <public key> myuser@mylocalhost - ``` - - To configure the SSH key to use, navigate to `Connection` → `SSH` → `Auth` in the tree left. - You will see a text field for `Private key file for authentification`. - Insert the path to your local key-file or brows it using the button `Browse...`. - This will do the same as the command `ssh -i .ssh/id_red25519 marie@taurus.hrsk.tudresden.de:22` in Terminal. - - - -4. Enable X-forwarding (optional). To do so, navigate to `Connection` → `SSH` → `X11` in the tree left. Put the tick in the checkbox for `Enable X11 forwarding`. - - - -1. Save your configurations. Go back to the `Session` in the tree left. Insert a name into the text field `Saved Sessions` and click -the button `Save`. Afterwards you will see the name in the list below. - - - -Now, you can start a configured session by double-clicking its name in the list. - -You can change your saved configuration by selecting its name in the list and clicking the button -`Load`. Make your changes and save it again under the same name. This will overwrite the old -configuration permanently. - -You can delete a saved configurations by clicking the button `Delete`. This will remove the -configured session permanently. - -**Enjoy!** -- GitLab