topaLE
/
wetty
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
Browse Source

Merge pull request #293 from janoskk/introduce-ssh-config 

Added --ssh-config option for alternate ssh configuration
pull/296/head
Cian Butler 4 years ago
committed by GitHub
parent
b692e04ce1 2de2fd3c61
commit
0eff7bffc4
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
10 changed files with 79 additions and 53 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Split View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 45
      README.md
  2. 27
      conf/config.json5
  3. 1
      docs/API.md
  4. 45
      docs/atoz.md
  5. 4
      src/main.ts
  6. 3
      src/server/command.ts
  7. 4
      src/server/command/ssh.ts
  8. 1
      src/shared/config.ts
  9. 1
      src/shared/defaults.ts
  10. 1
      src/shared/interfaces.ts

45
README.md
View File

@ -39,27 +39,30 @@ yarn global add wetty
```sh
$ wetty --help
Options:
--help, -h Print help message [boolean]
--version Show version number [boolean]
--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-port ssh server port [number]
--ssh-user ssh user [string]
--title window title [string]
--ssh-auth defaults to "password", you can use "publickey,password"
instead [string]
--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]
--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]
--help, -h Print help message [boolean]
--version Show version number [boolean]
--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-port ssh server port [number]
--ssh-user ssh user [string]
--title window title [string]
--ssh-auth defaults to "password", you can use "publickey,password"
instead [string]
--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]
--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

27
conf/config.json5
View File

@ -1,22 +1,23 @@
{
ssh: {
// user: 'username', // default user to use when ssh-ing
host: 'localhost', // Server to ssh to
auth: 'password', // shh authentication, method. Defaults to "password", you can use "publickey,password" instead'
// pass: "password", // Password to use when sshing
// 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
// user: 'username', // default user to use when ssh-ing
host: 'localhost', // Server to ssh to
auth: 'password', // shh authentication, method. Defaults to "password", you can use "publickey,password" instead'
// pass: "password", // Password to use when sshing
// 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
port: 3000, // Port to listen on
host: '0.0.0.0', // address to listen on
title: 'WeTTy - The Web Terminal Emulator', // Page title
bypassHelmet: false, // Disable Helmet security checks
base: '/wetty/', // URL base to serve resources from
port: 3000, // Port to listen on
host: '0.0.0.0', // address to listen on
title: 'WeTTy - The Web Terminal Emulator', // Page title
bypassHelmet: false, // Disable Helmet security checks
},
forceSSH: false, // Force sshing to local machine over login if running as root
forceSSH: false, // Force sshing to local machine over login if running as root
command: 'login', // Command to run on server. Login will use ssh if connecting to different server
/*
ssl:{

1
docs/API.md
View File

@ -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 |

45
docs/atoz.md
View File

@ -347,6 +347,12 @@ username.
have to use the key file and you can instead require a password but setting this
to `--ssh-auth password`. You can specify both `--ssh-auth publickey,password`
`--ssh-config configfile` - 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
@ -505,21 +511,26 @@ echo https://$(curl -s4 icanhazip.com)/wetty
`wetty -h` configuration options for reference.
```bash
--help, -h Print help message [boolean]
--version Show version number [boolean]
--sslkey path to SSL key [string]
--sslcert path to SSL certificate [string]
--sshhost ssh server host [string] [default: "localhost"]
--sshport ssh server port [number] [default: 22]
--sshuser ssh user [string] [default: ""]
--title window title [string] [default: "WeTTy - The Web Terminal Emulator"]
--sshauth defaults to "password", you can use "publickey,password" instead[string] [default: "password"]
--sshpass ssh password [string]
--sshkey path to an optional client private key (connection will be password-less and insecure!) [string]
--forcessh Connecting through ssh even if running as root [boolean] [default: false]
--base, -b base path to wetty [string] [default: "/wetty/"]
--port, -p wetty listen port [number] [default: 3000]
--host wetty listen host [string] [default: "0.0.0.0"]
--command, -c command to run in shell [string] [default: "login"]
--bypasshelmet disable helmet from placing security restrictions [boolean] [default: false]
--help, -h Print help message [boolean]
--version Show version number [boolean]
--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] [default: "localhost"]
--ssh-port ssh server port [number] [default: 22]
--ssh-user ssh user [string] [default: ""]
--title window title [string] [default: "WeTTy - The Web Terminal Emulator"]
--ssh-auth defaults to "password", you can use "publickey,password" 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]
--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] [default: "/wetty/"]
--port, -p wetty listen port [number] [default: 3000]
--host wetty listen host [string] [default: "0.0.0.0"]
--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] [default: false]
```

4
src/main.ts
View File

@ -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',

3
src/server/command.ts
View File

@ -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),
},

4
src/server/command/ssh.ts
View File

@ -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',

1
src/shared/config.ts
View File

@ -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, {

1
src/shared/defaults.ts
View File

@ -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 = {

1
src/shared/interfaces.ts
View File

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

Write Preview
Loading…
Cancel
Save