| Both sides previous revision Previous revision Next revision | Previous revision Next revisionBoth sides next revision |
| docs:guide-quick-start:sshadministration [2020/10/14 09:34] – update vgaetera | docs:guide-quick-start:sshadministration [2022/08/05 18:08] – [Windows terminal emulators] added external link and cleanup palebloodsky |
|---|
| ====== SSH access for newcomers ====== | ====== SSH access for newcomers ====== |
| OpenWrt listens for SSH on address ''192.168.1.1'' port ''22/tcp'' by default. | One of the methods to manage OpenWrt is using [[docs:guide-user:base-system:user.beginner.cli|command-line interface]] over [[wp>SSH_(Secure_Shell)|SSH]]. |
| To "SSH into your router", you enter the command in a terminal emulator: | OpenWrt listens for incoming SSH connections on port ''22/tcp'' by default. |
| | To "ssh into your router", you can enter the following command in a terminal emulator using you router's LAN IP address that is typically ''192.168.1.1'': |
| |
| <code bash> | <code bash> |
| |
| <code> | <code> |
| $ ssh root@192.168.1.1 <== You type this | $ ssh root@192.168.1.1 <== You type this |
| The authenticity of host '192.168.1.1 (192.168.1.1)' can't be established. | The authenticity of host '192.168.1.1 (192.168.1.1)' can't be established. |
| RSA key fingerprint is SHA256:4VbDA/MOc7inPiyllF5f0r3Q6iEx89ddKdhLGBovsiY. | RSA key fingerprint is SHA256:4VbDA/MOc7inPiyllF5f0r3Q6iEx89ddKdhLGBovsiY. |
| Are you sure you want to continue connecting (yes/no)? yes <== and this | Are you sure you want to continue connecting (yes/no)? yes <== and this |
| Warning: Permanently added '192.168.1.1' (RSA) to the list of known hosts. | Warning: Permanently added '192.168.1.1' (RSA) to the list of known hosts. |
| root@192.168.1.1's password: <== and the password here | root@192.168.1.1's password: <== and the password here |
| |
| BusyBox v1.28.4 () built-in shell (ash) | BusyBox v1.28.4 () built-in shell (ash) |
| ----------------------------------------------------- | ----------------------------------------------------- |
| |
| root@OpenWrt:~# <== type next command here | root@OpenWrt:~# <== type next command here |
| </code> | </code> |
| |
| The remainder of this page describes several terminal emulators that Windows, Linux, or macOS can use to access your OpenWrt device. | The remainder of this page describes several terminal emulators that Windows, Linux, or macOS can use to access your OpenWrt device. |
| |
| | //Note: To add a SSH public key to your OpenWrt device, see [[:docs:guide-user:security:dropbear.public-key.auth#From the LuCI Web Interface]]// |
| ===== Windows terminal emulators ===== | ===== Windows terminal emulators ===== |
| Windows Terminal for Windows 10 or the legacy ConHost (both giving access to Windows Powershell, Windows Command Prompt, WSL Bash), PuTTY, Cmder, SmarTTY, and WinSCP are terminal emulators that allow you to SSH into an OpenWrt router. | [[https://github.com/microsoft/terminal|Windows Terminal]] or the legacy PowerShell, Command Prompt, ConHost, or WSL Bash choices are available. Third party programs such as [[https://www.putty.org/|PuTTY]], MinGW (installed with Git), Cmder, SmarTTY, and WinSCP are also terminal emulators that can provide SSH into an OpenWrt router. |
| |
| ==== Using Windows 10 built-in terminals ==== | ==== Windows 10 built-in terminals ==== |
| Both **Windows Powershell** and **Command Prompt** allows to use the default Windows 10 SSH client. | Both Windows PowerShell and Command Prompt allows using the default Windows 10 SSH client. |
| That SSH client is an optional windows feature and has to be enabled, read here: [[https://docs.microsoft.com/en-us/windows-server/administration/openssh/openssh_install_firstuse|Installing OpenSSH for Windows 10]] | That SSH client is an optional windows feature and has to be [[https://docs.microsoft.com/en-us/windows-server/administration/openssh/openssh_install_firstuse|enabled]]. |
| |
| If you have installed a WSL distribution, the SSH client is usually preinstalled in there. | If you have installed a WSL distribution, the SSH client is usually preinstalled in there. |
| The Windows 10 optional SSH feature also includes SCP client (to open/edit/download/upload files in OpenWrt via SSH). | The Windows 10 optional SSH feature also includes SCP client (to open/edit/download/upload files in OpenWrt via SSH). |
| Try google for some SCP tutorials to learn how to use it. | Try google for some SCP tutorials to learn how to use it. |
| Otherwise, use [[:docs:guide-quick-start:sshadministration#using_winscp|WinSCP]] which is way easier for SCP purposes. | Otherwise, use [[docs:guide-quick-start:sshadministration#winscp|WinSCP]] which is way easier for SCP purposes. |
| |
| ==== Using PowerShell ==== | ==== PowerShell ==== |
| **Powershell** provides SSH access. | [[https://devblogs.microsoft.com/powershell/announcing-PowerShell-7-0/|Powershell]] provides SSH access. |
| Here's the announcement of version 7.0, with instructions for installing it: https://devblogs.microsoft.com/powershell/announcing-PowerShell-7-0/ | |
| |
| ==== Using PuTTY ==== | ==== Windows Subsystem for Linux (WSL) ==== |
| Putty gives you command line access to OpenWrt: | The Windows Subsystem for Linux is a convenient way to run a Linux environment of your choice including most,command-line tools, utilities, and applications directly on Windows. For detailed steps of how to install WSL on Windows 10, refer to Microsoft's documentation: https://docs.microsoft.com/en-us/windows/wsl/install-win10 |
| - Download Putty from [[https://www.putty.org]]: Simply get the 32bit ''putty.exe'' download from the ''Alternative binary files'' section. | |
| - Start ''putty.exe'' on your Windows client -> Putty's login window pops up. | ==== PuTTY ==== |
| - go to the ''Session'' category of Putty's login window, look for the field ''Host Name (or IP address)'' and simply enter the IP-address (e.g. **192.168.1.1**) of your OpenWrt device, keep the default provided port **22**. | PuTTY gives you command-line access to OpenWrt. |
| | |
| | - Download [[https://www.putty.org/|PuTTY]], get the 32bit ''putty.exe'' from the ''Alternative binary files'' section. |
| | - Start ''putty.exe'' on your Windows client -> PuTTY's login window pops up. |
| | - go to the ''Session'' category of PuTTY's login window, look for the field ''Host Name (or IP address)'' and simply enter the IP-address (e.g. **192.168.1.1**) of your OpenWrt device, keep the default provided port **22**. |
| - Click the ''Open'' button at the Bottom to open a connection. This will pop up a shell windows, asking to ''login as''. Login as **root** with the OpenWrt password you have defined some time before. If you have not yet set a password yet on "root", you will not be asked for the password. | - Click the ''Open'' button at the Bottom to open a connection. This will pop up a shell windows, asking to ''login as''. Login as **root** with the OpenWrt password you have defined some time before. If you have not yet set a password yet on "root", you will not be asked for the password. |
| - Done, you are logged into the OpenWrt command line. | - Done, you are logged into the OpenWrt command line. |
| |
| ==== Using WinSCP ==== | Setting up key-based authentication. |
| WinSCP allows you to browse the OpenWrt file system in Windows Exlorer like GUI-style: | |
| - Download WinSCP from [[https://winscp.net/eng/download.php]], get the non-beta ''Installation package'' or ''portable executables'' and install or unzip them on your Windows client | - Generate a key pair using ''puttygen.exe''. Save the private key to the PC and add the public key to ''/etc/dropbear/authorized_keys'' on your OpenWrt device. |
| | - Connection -> SSH -> Auth: In the box "Authentication Parameters" under "Private key file for Authentication" state the path to your private key file for this connection (e.g. the ''openwrt.ppk'' file you created before). Best is to click "Browse..." and select the file via the file dialog. |
| | |
| | Automating connections. |
| | |
| | - Connection -> Data: In the box "Login details" enter the "Auto-login username" which is ''root''. |
| | - Load, save or delete a stored session, enter ''openwrt.lan'' in Saved Sessions and click the Save button. |
| | - To make a PuTTY shortcut with an automatic login, create one and append the saved session with an ''@'' sign, for example call PuTTY with: ''putty.exe @openwrt.lan'' |
| | |
| | ==== WinSCP ==== |
| | WinSCP allows you to browse the OpenWrt file system in Windows Exlorer like GUI-style. |
| | |
| | - Download [[https://winscp.net/eng/download.php|WinSCP]], get the non-beta ''Installation package'' or ''portable executables'' and install or unzip them on your Windows client |
| - Start ''WinSCP.exe'' on your Windows client, WinSCP's login window will pop up | - Start ''WinSCP.exe'' on your Windows client, WinSCP's login window will pop up |
| - Click on ''New Site'' on the left, then enter your OpenWrt device IP address (192.168.1.1) on the right side into ''Host name'', keep the default port ''22''. In ''User name'' enter **root**, in ''Password'', enter your root **password** (or leave blank, if you have not set a password yet) | - Click on ''New Site'' on the left, ensure ''File protocol'' is set to **scp** then enter your OpenWrt device IP address (192.168.1.1) on the right side into ''Host name'', keep the default port ''22''. In ''User name'' enter **root**, in ''Password'', enter your root **password** (or leave blank, if you have not set a password yet) |
| - Click the ''Login'' at the bottom of the Window. | - Click the ''Login'' at the bottom of the Window. |
| - Done. You now have an Exlorer-like view of your OpenWrt filesystem. | - Done. You now have an Exlorer-like view of your OpenWrt file system. |
| |
| **Editing OpenWrt config files with WINSCP's integrated GUI editor:**\\ | Editing OpenWrt config files with WinSCP's integrated GUI editor. |
| To edit a OpenWrt config file with WinSCP's GUI-based editor, just right-click the file in WinSCP and select ''Edit'' from the context menu. | |
| |
| ==== Using Cmder ==== | - To edit an OpenWrt config file with WinSCP's GUI-based editor, just right-click the file in WinSCP and select ''Edit'' from the context menu. |
| **Cmder for Windows** is an open-source terminal emulator that runs on Windows. | |
| | ==== Cmder ==== |
| | Cmder for Windows is an open-source terminal emulator that runs on Windows. |
| It is free to use and provides an easy "command line shell" that allows you to ssh into OpenWrt. | It is free to use and provides an easy "command line shell" that allows you to ssh into OpenWrt. |
| Its attractive fonts and color scheme are easy on the eyes. | Its attractive fonts and color scheme are easy on the eyes. |
| The //Full// distribution is preferred (over the //mini// distribution), since it provides a bash emulation, with a Unix-y suite of commands. | The //Full// distribution is preferred (over the //mini// distribution), since it provides a bash emulation, with a Unix-y suite of commands. |
| |
| - Download cmder from [[https://cmder.net/]] | - Download [[https://cmder.net/|Cmder]]. |
| - Unzip the //cmder.zip// file | - Unzip the //cmder.zip// file. |
| - Open the Cmder folder, and double-click the {{:media:docs:howto:cmdericon.png?16|}} Cmder icon. You'll see a Cmder window open similar to the image below. | - Open the Cmder folder, and double-click the Cmder icon. You'll see a Cmder window open similar to the image below. |
| - To ssh into the OpenWrt router at 192.168.1.1, type ''ssh root@192.168.1.1'' then press Return | - To ssh into the OpenWrt router at 192.168.1.1, type ''ssh root@192.168.1.1'' then press Return. |
| {{:media:docs:howto:cmder.png?1592|}} | |
| |
| ==== Using SmarTTY ==== | ==== SmarTTY ==== |
| SmarTTY gives you command line access to OpenWrt and allows you to open/edit/download/upload files in OpenWrt, and is overall more modern and user-friendly than Putty (another tool detailed below): | SmarTTY gives you command line access to OpenWrt and allows you to open/edit/download/upload files in OpenWrt, and is overall more modern and user-friendly than PuTTY (another tool detailed below). |
| |
| - Download SmarTTY from [[http://sysprogs.com/SmarTTY/]]: choose "download" for the installer, or "portable version" if you want it as a standalone program that works without installation. | - Download [[http://sysprogs.com/SmarTTY/|SmarTTY]], choose "download" for the installer, or "portable version" if you want it as a standalone program that works without installation. |
| - after installation or after unzipping the archive, doubleclick on **SmarTTY** executable file. | - after installation or after unzipping the archive, doubleclick on **SmarTTY** executable file. |
| - You will be greeted by a window with two choices, doubleclick on "setup a new SSH connection" (the other option is for serial connections, for usb-TTL dongles and somesuch you connect to the device's debug serial pins on the board, we won't use that now). | - You will be greeted by a window with two choices, doubleclick on "setup a new SSH connection" (the other option is for serial connections, for usb-TTL dongles and somesuch you connect to the device's debug serial pins on the board, we won't use that now). |
| - **Password:** leave this blank for your first connection, then write the password you set up (either in Luci GUI or after your first SSH access) | - **Password:** leave this blank for your first connection, then write the password you set up (either in Luci GUI or after your first SSH access) |
| - Click "Connect" button at the bottom, and you will now see a big terminal screen coming up | - Click "Connect" button at the bottom, and you will now see a big terminal screen coming up |
| - A default OpenWrt firmware lacks the server component to allow you to open/edit/view/upoad/download files in Smartty, so after you have connected to the internet write ''opkg update && opkg install openssh-sftp-server'' to install it. If the next step fails, it might be necessary to reboot the OpenWrt device for this new service to start up properly. | - A default OpenWrt firmware lacks the server component to allow you to open/edit/view/upoad/download files in SmarTTY, so after you have connected to the internet write ''opkg update && opkg install openssh-sftp-server'' to install it. If the next step fails, it might be necessary to reboot the OpenWrt device for this new service to start up properly. |
| - Now you can click on **File -> Open a Remote File** to open a popup that shows the filesystem of the OpenWrt device, and you can navigate in it and open text files for example as normal (they will open in a SmarTTY text editor window) | - Now you can click on **File -> Open a Remote File** to open a popup that shows the file system of the OpenWrt device, and you can navigate in it and open text files for example as normal (they will open in a SmarTTY text editor window) |
| - If you want to upload or download files to/from a specific folder in the device, you can click on SCP menu and choose the most appropriate action from there. | - If you want to upload or download files to/from a specific folder in the device, you can click on SCP menu and choose the most appropriate action from there. |
| |
| After the first time you connected to a device, Smartty saved a profile, so you can connect again to the same device (at that IP address with that password) by just doubleclicking its icon on the first window you see when starting Smartty. | After the first time you connected to a device, SmarTTY saved a profile, so you can connect again to the same device (at that IP address with that password) by just doubleclicking its icon on the first window you see when starting SmarTTY. |
| You can right-click on this profile icon to edit it again, if needed. | You can right-click on this profile icon to edit it again, if needed. |
| |
| - if you want to close the session, write "exit" | - if you want to close the session, write "exit" |
| |
| Linux also usually has SCP clients (to open/edit/download/upload files in OpenWrt), which may or may not be installed by default. | Linux also usually has SCP/SFTP clients (to open/edit/download/upload files in OpenWrt), which may or may not be installed by default. |
| You need to look up your distro's documentation or search with your package management interface for "SCP" to find where it is and its current installation status. | You need to look up your distro's documentation or search with your package management interface for "scp" and "sftp" to find where it is and its current installation status. |
| Read its integrated manual ("man scp" for example is for the command line SCP client) or google some tutorials to learn how to use it. | Read [[man>scp|scp manual]] for the command line SCP client or google some tutorials to learn how to use it. |
| | |
| | ==== Midnight Commander ==== |
| | [[https://midnight-commander.org/|Midnight Commander]] is Norton Commander like file manager that works on Linux and macOS. |
| | You can access remote files on OpenWrt via mc: |
| | |
| | - Press 'F9' |
| | - Select 'Left' panel config |
| | - Select 'Shell link' |
| | - Input 'root@192.168.1.1/' and press OK |
| | - Now you'll see list of files and directories in root of OpenWrt |
| | |
| | Internally it works over [[wp>Files_transferred_over_shell_protocol|scp like protocol FISH]] so it not needs for installed SFTP server. |
| |
| ===== macOS terminal emulators ===== | ===== macOS terminal emulators ===== |
| On macOS (formerly Mac OSX) any terminal emulator will allow you to ssh. | On macOS (formerly Mac OSX) any terminal emulator will allow you to ssh. |
| There several terminal emulators: | |
| |
| - Terminal - The macOS built-in terminal program. Find it in /Applications/Utilities | - Terminal - The macOS built-in terminal program, find it in /Applications/Utilities. |
| - iTerm2 [[https://iterm2.com/]] a much-enhanced terminal program. Donation-ware - it's worth it. | - [[https://iterm2.com/|iTerm2]] a much-enhanced terminal program, donation-ware - it's worth it. |
| |
| To ssh into your OpenWrt router at 192.168.1.1, type ''ssh root@192.168.1.1'', then press Return. | To ssh into your OpenWrt router at 192.168.1.1, type ''ssh root@192.168.1.1'', then press Return. |
| | |
| | ===== Chrome OS terminal emulator ===== |
| | On Chrome OS, [[https://chrome.google.com/webstore/detail/secure-shell-app/pnhechapfaindjhompbnflcldabbghjo?hl=en|Secure Shell App]] will allow you to ssh. |
| |