Note

You are viewing the documentation for an older release of Interworx (8.1). To see documentation for the current generally available release of Interworx, click here: 8.2.

SSH Server Guide

The InterWorx Control Panel provides an easy-to-use interface for managing SSH Server settings.

From the SSH Server page in NodeWorx, server administrators can manage auto-restart and start-on-boot settings for the SSH server, set configuration options such as SSH port and root login permissions, and terminate shell user sessions.

Contents

• SSH Server Guide

  • Managing SSH Server Options

  • To Manage Start-On-Boot Options for the SSH Server

  • To Manage Auto-Restart Options for the SSH Server

  • To Change the SSH Port

  • To Manage Root Login Permission

  • To Terminate an SSH Session

    • From the Sessions List

    • From the With Selected Dropdown

Managing SSH Server Options

1. Log into NodeWorx from the browser (https://ip.ad.dr.ess:2443/nodeworx)

2. From NodeWorx, navigate to System Services > SSH Server

   

3. Update the desired fields

   

   • Port: The port that shell users connect to. By default this is set to port 22

     • If SiteWorx users will be given shell access, for simplicity and ease-of-use, it is recommended to keep the SSH port to its default port, as that is the standard most end users will expect and be used to.

     • If SSH is set to listen on port 22, it may be prudent to set Allow Root Login to either No or Without Pass, as Passwordless SSH for the root user tends to be more secure, and ties the root login to a single computer, with the correct keys. More information on Passwordless SSH can be found here

     • If SiteWorx users will not be given shell access, it may be useful to set Allow Root Login to yes and change the port to something other than 22, making sure the new port is not in use by another service on the system. A list of ports that are commonly used by other services can be found here

   • Allow Root Login: Sets whether the root user can log in via SSH

     • Yes: The root user is permitted to log in

     • Without Password: Disables password authentication for the root user

     • Forced Command Only: The root user is permitted to log in, but only if a command option is specified

     • No: The root user is not permitted to log in

   • Login Timeout: Amount of time before the server will disconnect a user who has not yet successfully logged in

   • Loglevel: Sets the verbosity used when logging sshd messages

   • Privilege Separation: Toggles privilege separation. Used to prevent privilege escalation during the authentication process

4. Click Update

To Manage Start-On-Boot Options for the SSH Server

1. Log into NodeWorx from the browser (https://ip.ad.dr.ess:2443/nodeworx)

2. From NodeWorx, navigate to System Services > SSH Server

   

3. Under SSH Server Control, select either Yes or No from the Start On Boot-up dropdown

   

4. Click Update

To Manage Auto-Restart Options for the SSH Server

1. Log into NodeWorx from the browser (https://ip.ad.dr.ess:2443/nodeworx)

2. From NodeWorx, navigate to System Services > SSH Server

   

3. Under SSH Server Control, select either Yes or No from the Auto-Restart SSH dropdown

   

4. Click Update

To Change the SSH Port

1. Log into NodeWorx from the browser (https://ip.ad.dr.ess:2443/nodeworx)

2. From NodeWorx, navigate to System Services > SSH Server

   

3. Under SSH Server Options, update the Port field to the new port

   

4. Click Update

To Manage Root Login Permission

1. Log into NodeWorx from the browser (https://ip.ad.dr.ess:2443/nodeworx)

2. From NodeWorx, navigate to System Services > SSH Server

   

3. Under SSH Server Options, select the desired setting from the Allow Root Login dropdown:

   

   • Yes: The root user is permitted to log in

   • No: The root user is not permitted to log in

   • Without Password : Disables password authentication for the root user

   • Forced Command Only: The root user is permitted to log in, but only if a command option is specified

     • Example:

       ssh root@test.com uptime
       

4. Click Update

To Terminate an SSH Session

From the Sessions List

1. Log into NodeWorx from the browser (https://ip.ad.dr.ess:2443/nodeworx)

2. From NodeWorx, navigate to System Services > SSH Server

   

3. Click the Trashcan next to the shell session. This opens the Confirmation from

   

4. Click Terminate to confirm

From the With Selected Dropdown

1. Log into NodeWorx from the browser (https://ip.ad.dr.ess:2443/nodeworx)

2. From NodeWorx, navigate to System Services > SSH Server

   

3. Select the checkbox next to the user(s)

   • Selecting the checkbox next to the With Selected dropdown will automatically select all

   

4. Select Terminate from the With Selected dropdown

5. Click Go. This opens the Confirmation form

   

6. Click Terminate to confirm