Latest revision as of 11:39, 20 December 2023

Overview

This article provides a short overview of SSH on Alpine Linux.

Note: This article describes two popular SSH implementations: OpenSSH and Dropbear. Either can be installed using the setup-sshd script, or by following the instructions below.

OpenSSH

OpenSSH is a popular SSH implementation for remote encrypted login to a machine. OpenSSH defines sshd as the daemon, and ssh as the client program.

The openssh package provides OpenSSH on Alpine Linux.

Installation

Install the openssh package:

apk add openssh

Note: To use the ACF-frontend for openssh, install acf-openssh instead (assuming that you have the setup-acf script).

Also see Alpine Linux package management.

Service commands

Enable the sshd service so that it starts at boot:

rc-update add sshd

List services to verify sshd is enabled:

rc-status

Start the sshd service immediately and create configuration files:

rc-service sshd start

Note: If you are running from RAM, ensure you save your settings using the 'lbu ci' command as necessary. See Alpine local backup.

Also see Alpine Linux Init System.

Fine tuning

You may wish to change the default configuration. This section describes some of the configuration options as examples, however it is by no means an exhaustive list. See the manual for full details.

The fine-tuning is done by editing /etc/ssh/sshd_config. Any line starting with "#" is ignored by sshd.

UseDNS no   # By setting this to no, connection speed can increase.
PasswordAuthentication no  # Do not allow password authentication.

Other configuration options are shown in etc/ssh/sshd_config. The file includes comments that explain many of the options.

Firewalling and Port Changes

By default, sshd will communicate on TCP port 22.

Sometimes 22/tcp is blocked by a firewall over which you have no control. Changing the Port option to an unused port number in /etc/ssh/sshd_config may be useful in this situation.

Port 443   # Use whichever port number fits your needs

Note: Ensure the port you wish to use is not already in use by running netstat -lnp on the machine running sshd.

Restart sshd after making modifications to the configuration file:

rc-service sshd restart

Note: If you are running from RAM, ensure you save your settings using the 'lbu ci' command as necessary. See Alpine local backup.

Dropbear

Dropbear is a lightweight SSH client/server alternative to OpenSSH.

server

Tip: You can use ~/.ssh/authorized_keys in the same way as with OpenSSH

dropbear can be install through the Alpine setup scripts, or manually with:

apk add dropbear

Start it:

rc-service dropbear start

Add it to the default runlevel:

rc-update add dropbear

Use the following command to check all available server options:

dropbear -h

The config file is located at /etc/conf.d/dropbear

Tip: DROPBEAR_OPTS="-w -s" will forbid root login and password login

client

dropbear-dbclient contains the SSH client and can be installed manually with:

apk add dropbear-dbclient

In its simplest form it can be used like this:

dbclient <user>@host.example.com

dbclient host.example.com

dbclient x.x.x.x

(where x.x.x.x is the IP address of the remote machine).

Use dbclient -h to see all available options.

@@ Line 1: / Line 1: @@
-= General =
+= Overview =
-If you need to administer a Alpine Linux box, you can install and use openssh.<BR>
-Openssh is used to provide a secure encrypted communications between you and the host where openssh is running (the ssh-server is called ''sshd'' and the ssh-client is called ''ssh'').
-== Initial Setup ==
+This article provides a short overview of SSH on Alpine Linux.
-We assume you are running a ''alpine-1.8.x''. If not, please follow [http://wiki.alpinelinux.org/w/index.php?title=Installing_Alpine Installing_Alpine] on how to setup Alpine.
-== Install programs ==
+Also see [https://en.wikipedia.org/wiki/Secure_Shell Secure Shell (Wikipedia)].
-Installing programs in Alpine Linux is easy.<BR>
-In this case we only need to install one program:
- apk_add openssh
-'''''Note:''' If you want the ACF-frontend for openssh, you should install 'acf-openssh' instead (assuming that you have setup-webconf)''
+{{Note|This article describes two popular SSH implementations: OpenSSH and Dropbear. Either can be installed using the [[Alpine setup scripts#setup-sshd|setup-sshd]] script, or by following the instructions below.}}
-== Make it autostart ==
+= OpenSSH =
-Next time you reboot your Linux box, you would probably want your ''sshd'' to automatically start.
- rc-update add sshd
-You can check your boot sequence:
+[https://www.openssh.com/ OpenSSH] is a popular SSH implementation for remote encrypted login to a machine. OpenSSH defines ''sshd'' as the daemon, and ''ssh'' as the client program.
- rc_status
-== Start it up now ==
+The {{Pkg|openssh}} package provides OpenSSH on Alpine Linux.
-The reason we want to manually start ''sshd'' at this moment is...<BR>
-We want ''sshd'' to create some initial files that he needs. After they are created, we can permanently save them.<BR>
-Next reason is... we don't have time to wait for the box to reboot ;-)
- /etc/init.d/sshd start
-'''''Note:''' Don't forget to permanently save your settings by using the 'lbu ci' command when you are done.''
-= Fine tuning =
+== Installation ==
-The default config that comes with openssh has pretty good default values.<BR>
+Install the {{Pkg|openssh}} package:
-But sometimes you would like to fine-tune things. We show some examples below on what you might want to do.<BR>
+{{Cmd|apk add openssh}}
-'''''Note:''' You are _not_ required to follow this [[#Fine_tuning]] section. You can skip it if you want to make things easy!''
-The fine-tuning is done by editing '''/etc/ssh/sshd_config'''<BR>
+{{Note|To use the ACF-frontend for openssh, install {{Pkg|acf-openssh}} instead (assuming that you have the setup-acf script).}}
-"#" marks that the rest of the line should be ignored by ''sshd''. Everything right to the "#" is treated as comments.
- UseDNS no   # By setting this to no, you could increase speed when the client starts to connect to this ssh-server
- PasswordAuthentication no   # Instead you could use private/public keys to authenticate to this box (this increases security for the box)
-Many other options are found in '''/etc/ssh/sshd_config'''. The describing text that comes in the same file will guide you in your fine-tuning.
-= Firewalling =
+Also see [[Alpine_Package_Keeper|Alpine Linux package management]].
-As default, sshd will communicate on port ''''22'''' using protocol ''''TCP''''.<BR>
-You would need to make sure that the box where ''sshd'' is running, doesn't block your connection attempts on '''22TCP'''.<BR>
-If you still have trouble accessing your box, make sure that there is no other firewall blocking your connection.
-Sometimes '''22TCP''' is blocked by some firewall that you can not control. In those cases you might want to configure '''sshd''' to communicate on some other port.<BR>
+== Service commands ==
-In that case you change '''/etc/ssh/sshd_config''' to reflect your needs.<BR>
+Enable the sshd service so that it starts at boot:
-But before you do so, you need to check so you don't use a port that already is in use. (You can check this by using the command ''''netstat -ln'''' on the box where you plan to run ''sshd'')
+{{Cmd|rc-update add sshd}}
- Port 443   # Use whatever port number that fits your needs
-You need to restart ''sshd'' after you done you modifications.
+List services to verify sshd is enabled:
- /etc/init.d/sshd restart
+{{Cmd|rc-status}}
-= Save settings =
+Start the sshd service immediately and create configuration files:
-If you already haven't done so, save all your settings
+{{Cmd|rc-service sshd start}}
- lbu ci
+{{Note|If you are running from RAM, ensure you save your settings using the 'lbu ci' command as necessary. See [https://wiki.alpinelinux.org/wiki/Alpine_local_backup Alpine local backup].}}
+Also see [[OpenRC|Alpine Linux Init System]].
+== Fine tuning ==
+You may wish to change the default configuration. This section describes some of the configuration options as examples, however it is by no means an exhaustive list. See [https://www.openssh.com/manual.html the manual] for full details.
+The fine-tuning is done by editing {{Path|/etc/ssh/sshd_config}}. Any line starting with "#" is ignored by ''sshd''.
+ UseDNS no   # By setting this to no, connection speed can increase.
+ PasswordAuthentication no  # Do not allow password authentication.
+Other configuration options are shown in {{Path|etc/ssh/sshd_config}}. The file includes comments that explain many of the options.
+== Firewalling and Port Changes ==
+By default, sshd will communicate on TCP port '''22'''.<BR>
+Sometimes '''22/tcp''' is blocked by a firewall over which you have no control. Changing the '''Port''' option to an unused port number in {{Path|/etc/ssh/sshd_config}} may be useful in this situation.<BR>
+ Port 443   # Use whichever port number fits your needs
+{{Note|Ensure the port you wish to use is not already in use by running '''netstat -lnp''' on the machine running ''sshd''.}}
+Restart ''sshd'' after making modifications to the configuration file:
+{{Cmd|rc-service sshd restart}}
+{{Note|If you are running from RAM, ensure you save your settings using the 'lbu ci' command as necessary. See [https://wiki.alpinelinux.org/wiki/Alpine_local_backup Alpine local backup].}}
+= Dropbear =
+[https://matt.ucc.asn.au/dropbear/dropbear.html Dropbear] is a lightweight SSH client/server alternative to OpenSSH.
+=== server ===
+{{Tip|You can use {{Path|~/.ssh/authorized_keys}} in the same way as with OpenSSH}}
+{{Pkg|dropbear}} can be install through the [[Alpine setup scripts]], or manually with:
+{{Cmd|apk add dropbear}}
+Start it:
+{{Cmd|rc-service dropbear start}}
+Add it to the default runlevel:
+{{Cmd|rc-update add dropbear}}
+Use the following command to check all available server options:
+{{Cmd|dropbear -h}}
+The config file is located at {{Path|/etc/conf.d/dropbear}}
+{{Tip|<code>DROPBEAR_OPTS{{=}}"-w -s"</code> will forbid root login and password login}}
+=== client ===
+{{Pkg|dropbear-dbclient}} contains the SSH client and can be installed manually with:
+{{Cmd|apk add dropbear-dbclient}}
+In its simplest form it can be used like this:
+{{Cmd|dbclient <user>@host.example.com}}
+{{Cmd|dbclient host.example.com}}
+{{Cmd|dbclient x.x.x.x}} (where x.x.x.x is the IP address of the remote machine).
+Use <code>dbclient -h</code> to see all available options.
+= See also =
+* [[HOWTO OpenSSH 2FA with password and Google Authenticator|Two Factor Authentication With OpenSSH]]
+= Further Reading =
+[https://www.openssh.com/portable.html OpenSSH (openssh.com)]<BR>
+[https://en.wikipedia.org/wiki/OpenSSH OpenSSH (wikipedia.org)]
+[[Category:Server]]
+[[Category:Networking]]
+[[Category:Security]]