Merge branch 'main' into main

README.md

@@ -53,13 +53,16 @@ Options:
   --ssh-pass      ssh password                                          [string]
   --ssh-key       path to an optional client private key (connection will be
                   password-less and insecure!)                          [string]
+  --ssh-config    Specifies an alternative ssh configuration file. For further
+                  details see "-F" option in ssh(1)                     [string]
   --force-ssh     Connecting through ssh even if running as root       [boolean]
   --known-hosts   path to known hosts file                              [string]
   --base, -b      base path to wetty                                    [string]
   --port, -p      wetty listen port                                     [number]
   --host          wetty listen host                                     [string]
   --command, -c   command to run in shell                               [string]
-  --bypass-helmet  disable helmet from placing security restrictions   [boolean]
+  --allow-iframe  Allow wetty to be embedded in an iframe, defaults to allowing
+                  same origin                                          [boolean]
 ```
 
 Open your browser on `http://yourserver:3000/wetty` and you will prompted to

conf/config.json5

@@ -7,6 +7,7 @@
     // key:     "",                             // path to an optional client private key, connection will be password-less and insecure!
     port:       22,                             // Port to ssh to
     knownHosts: '/dev/null',                    // ssh knownHosts file to use
+    // config:  '/home/user/.wetty_ssh_config', // alternative ssh configuration file, see "-F" option in ssh(1)
   },
   server:  {
     base:         '/wetty/',                           // URL base to serve resources from

docs/API.md

@@ -26,6 +26,7 @@ Starts WeTTy Server
 | [ssh.port]                | `number`  | `22`          | port to connect to over ssh                                                                                            |
 | [ssh.pass]                | `string`  |               | Optional param of a password to use for ssh                                                                            |
 | [ssh.key]                 | `string`  |               | path to an optional client private key (connection will be password-less and insecure!)                                |
+| [ssh.config]              | `string`  |               | Specifies an alternative ssh configuration file. For further details see "-F" option in ssh(1)                         |
 | [serverConf]              | `Object`  |               | Server settings                                                                                                        |
 | [serverConf.base]         | `Object`  | `'/wetty/'`   | Server settings                                                                                                        |
 | [serverConf.port]         | `number`  | `3000`        | Port to run server on                                                                                                  |

docs/atoz.md

@@ -240,6 +240,12 @@ These settings are all specific to `ssh` and will enable you to automatically lo
 
 `--ssh-auth publickey` defines the accepted authentication types. You do not have to use the key file and you can instead require a password but setting this to `--sshauth password`. You can specify both `--sshauth publickey,password`
 
+`--ssh-config configfile` - (not used for this guide) alternative ssh configuration file. From ssh(1):
+
+> If a configuration file is given on the command line, the system-wide
+> configuration file (/etc/ssh/ssh_config) will be ignored. The default for the
+> per-user configuration file is ~/.ssh/config.
+
 ### SSL settings explained
 
 These settings are specific to `openssl` to make WeTTY load https webserver so that all data is transmitted over a secure connection.
@@ -521,22 +527,23 @@ If you chose to not use a password to login in you should protect your instance
   --conf          config file to load config from                       [string]
   --ssl-key       path to SSL key                                       [string]
   --ssl-cert      path to SSL certificate                               [string]
-  --ssh-host      ssh server host                                       [string]
+  --ssh-host      ssh server host                                       [string]   [default: "localhost"]
-  --ssh-port      ssh server port                                       [number]
+  --ssh-port      ssh server port                                       [number]   [default: 22]
-  --ssh-user      ssh user                                              [string]
+  --ssh-user      ssh user                                              [string]   [default: ""]
-  --title         window title                                          [string]
+  --title         window title                                          [string]   [default: "WeTTy - The Web Terminal Emulator"]
   --ssh-auth      defaults to "password", you can use "publickey,password"
-                  instead                                               [string]
+                  instead                                               [string]   [default: "password"]
   --ssh-pass      ssh password                                          [string]
   --ssh-key       path to an optional client private key (connection will be
                   password-less and insecure!)                          [string]
-  --force-ssh     Connecting through ssh even if running as root       [boolean]
+  --ssh-config    Specifies an alternative ssh configuration file. For further
+                  details see "-F" option in ssh(1)                     [string]   [default: ""]
+  --force-ssh     Connecting through ssh even if running as root        [boolean]  [default: false]
   --known-hosts   path to known hosts file                              [string]
-  --base, -b      base path to wetty                                    [string]
+  --base, -b      base path to wetty                                    [string]   [default: "/wetty/"]
-  --port, -p      wetty listen port                                     [number]
+  --port, -p      wetty listen port                                     [number]   [default: 3000]
-  --host          wetty listen host                                     [string]
+  --host          wetty listen host                                     [string]   [default: "0.0.0.0"]
-  --command, -c   command to run in shell                               [string]
+  --command, -c   command to run in shell                               [string]   [default: "login"]
   --allow-iframe  Allow wetty to be embedded in an iframe, defaults to allowing
-                  same origin                                          [boolean]
+                  same origin                                           [boolean]  [default: false]
-
 ```

docs/downloading-files.md

@@ -10,7 +10,7 @@ https://vt100.net/docs/tp83/appendixc.html).
 To take advantage add the following bash function to your `.bashrc`
 
 ```bash
-funtion wetty-download() {
+function wetty-download() {
   echo "\033[5i"$(cat /dev/stdin | base64 -w 0)"\033[4i"
 }
 ```

src/main.ts

@@ -55,6 +55,10 @@ const opts = yargs
       'path to an optional client private key (connection will be password-less and insecure!)',
     type: 'string',
   })
+  .option('ssh-config', {
+    description: 'Specifies an alternative ssh configuration file. For further details see "-F" option in ssh(1)',
+    type: 'string',
+  })
   .option('force-ssh', {
     description: 'Connecting through ssh even if running as root',
     type: 'boolean',

src/server/command.ts

@@ -24,7 +24,7 @@ export const getCommand = (
       conn: { remoteAddress },
     },
   }: Socket,
-  { user, host, port, auth, pass, key, knownHosts }: SSH,
+  { user, host, port, auth, pass, key, knownHosts, config }: SSH,
   command: string,
   forcessh: boolean,
 ): { args: string[]; user: boolean } => ({
@@ -39,6 +39,7 @@ export const getCommand = (
               command,
               auth,
               knownHosts,
+              config: config || '',
             }),
             host: address(referer, user, host),
           },

src/server/command/ssh.ts

@@ -2,7 +2,7 @@ import isUndefined from 'lodash/isUndefined.js';
 import { logger } from '../../shared/logger.js';
 
 export function sshOptions(
-  { pass, path, command, host, port, auth, knownHosts }: Record<string, string>,
+  { pass, path, command, host, port, auth, knownHosts, config }: Record<string, string>,
   key?: string,
 ): string[] {
   const cmd = parseCommand(command, path);
@@ -11,6 +11,8 @@ export function sshOptions(
     'ssh',
     host,
     '-t',
+    config !== '' ? '-F' : '',
+    config,
     '-p',
     port,
     '-o',

src/shared/config.ts

@@ -115,6 +115,7 @@ export function mergeCliConf(opts: Arguments, config: Config): Config {
       port: opts['ssh-port'],
       pass: opts['ssh-pass'],
       key: opts['ssh-key'],
+      config: opts['ssh-config'],
       knownHosts: opts['known-hosts'],
     }) as SSH,
     server: objectAssign(config.server, {

src/shared/defaults.ts

@@ -8,6 +8,7 @@ export const sshDefault: SSH = {
   key: process.env.SSHKEY || undefined,
   port: parseInt(process.env.SSHPORT || '22', 10),
   knownHosts: process.env.KNOWNHOSTS || '/dev/null',
+  config: process.env.SSHCONFIG || undefined,
 };
 
 export const serverDefault: Server = {

src/shared/interfaces.ts

@@ -7,6 +7,7 @@ export interface SSH {
   knownHosts: string;
   pass?: string;
   key?: string;
+  config?: string;
 }
 
 export interface SSL {