nktty

Management and automation for remote hosts.

How to install.

Git:

git clone https://github.com/reekol/nktty
cd nktty
npm i

Run: bin/nktty.js --help

Standalone binary:

Download builds for your distro from Releases section.

Run:

# To build example configuration files for standalone usage in current directory:
./nktty-linux -B .
# Explicitly use those configs.
./nktty-linux -C ./commandsAll.json -E ./execute.json -R ./remotes.json --remotes="host1|host2"
# OR for other options
./nktty-linux --help

Linux OS standalone builds.

# Install
sudo curl -s https://api.github.com/repos/reekol/nktty/releases/latest | grep nktty-linux | grep download | cut -d '"' -f4 | sudo wget -qi - -O /usr/local/bin/nktty
sudo chmod a+rx /usr/local/bin/nktty
# Create default user's configuration
mkdir ~/.nktty
nktty --config-build ~/.nktty

# Usage
nktty -h

Options:

Options:
  -r, --remotes             Filter remote hosts.(regex)                 [string]
  -e, --execute             Filter tasks to executed.(regex)            [string]
  -u, --ude                 User Defined Execution: (Command).          [string]
  -R, --config-remotes      override path to reomtes.json               [string]
  -C, --config-commandsall  override path to commandsAll.json           [string]
  -E, --config-execute      override path to execute.json               [string]
  -B, --config-build        Build example config. files                 [string]
  -X, --config-export       Export Encrypted config.                   [boolean]
  -h, --help                Show help.                                 [boolean]
  -v, --version             Show version number                        [boolean]

Configure:

./config/remotes.json (List of all hosts to be monitored/used).
- Example:

...
 { 
    "title": "host1 title",
    "host": "192.168.1.1",
    "port":22,
    "username": "user",
    "privateKey": "/home/user/.ssh/id_rsa",
    "readyTimeout": 5000,
    "cmd":null
 },
 ...

- Example Jump host:

...
 {
    "title": "host1 title",
    "host": "192.168.1.1",
    "port":22,
    "username": "root",
    "privateKey": "/home/user/.ssh/id_rsa",
    "readyTimeout": 5000,
    "jumpToHost": "192.168.1.11",
    "jumpToUsername": "jumpix",
    "jumpToPort": 22,
    "jumpToForwardPort": 1234,
    "jumpToPrivateKey": "/home/jumpix/.ssh/id_rsa_jump",
    "jumpToReadyTimeout": 5000,
    "cmd":null
 },
 ...

./config/commandsAll.json (commands used only in UI mode, to show/check system information)
- Example:

...
{
	"name":" Rand percent ",
	"cmd":"echo $(( ( RANDOM % 100 )  + 1 ))",
	"type":"bar",
	"suffix":"%"
},
...

./config/execute.json ("Stage two" commands available for each selected host)
- Example:

...
{
	"title": "Log",
	"cmd": "dmesg"
},
...

Eamples:

Shows and checks only selected hosts. nktty --remotes="host1|host2|host3"
- Select a host and hit enter, than select an initial command. You will be redirected into fully functional interactive command shell.
Execute predefined commands on selected hosts. nktty --remotes="host1|host2|host3" --execute="command1|command2|command3"
Execute user defined commands [--ude] on selected hosts. nktty --remotes="host1|host2|host3" --ude="whoami"
Live monitor of multiple hosts [ kernel.log ] nktty.js --remotes='host1|host2' --ude='tail -F /var/log/kern.log'

The output of non interactive execution will contain something like: Cmd:

nktty --remotes='host1|host2' --ude='whoami'

<STDOUT time="2021-02-27T15:13:19.441Z" host="host1" command="U.D.E."><![CDATA[
root
]]></STDOUT>
<STDOUT time="2021-02-27T15:13:19.443Z" host="host1" command="U.D.E."><![CDATA[
root
]]></STDOUT>

Useful commands to try:

nktty --remotes='host1|host2' --ude='tail -F /var/log/kern.log'

The output from the command above will be updated live in your terminal. Output:

...
<STDOUT time="2021-02-27T15:43:17.315Z" host="host1" command="U.D.E."><![CDATA[
Feb 27 17:43:17 localhost kernel: [353444.072757] w1_master_driver w1_bus_master1: Attaching one wire slave 00.9b3800000000 crc 6a
]]></STDOUT>
<STDOUT time="2021-02-27T15:43:17.321Z" host="host1" command="U.D.E."><![CDATA[
Feb 27 17:43:17 localhost kernel: [353444.085895] w1_master_driver w1_bus_master1: Family 0 for 00.9b3800000000.6a is not registered.
]]></STDOUT>
<STDOUT time="2021-02-27T15:43:17.322Z" host="host1" command="U.D.E."><![CDATA[
Feb 27 17:43:17 localhost kernel: [353444.085895] w1_master_driver w1_bus_master1: Family 0 for 00.9b3800000000.6a is not registered.
]]></STDOUT>
...

nktty --remotes='host1|host2' --execute='port'

Output:

<STDOUT time="2021-02-27T15:16:45.596Z" host="host1 title" command="Scan servces per port"><![CDATA[
sshd     22    2
node     3001  1
apache2  443   1
named    53    5
apache2  80    1
named    953   2
]]></STDOUT>
<STDOUT time="2021-02-27T15:16:45.606Z" host="host2 title" command="Scan servces per port"><![CDATA[
sshd     22    2
node     3001  1
apache2  443   1
named    53    5
apache2  80    1
named    953   2
]]></STDOUT>

nktty --remotes='host' --ude='ping -c 192.168.1.1'

Check if IP is accessible from all of the remote hosts. Output:

...
<STDOUT time="2021-02-27T16:25:14.685Z" host="host1" command="U.D.E."><![CDATA[
64 bytes from 192.168.1.1: icmp_seq=12 ttl=64 time=0.256 ms
]]></STDOUT>
<STDOUT time="2021-02-27T16:25:14.693Z" host="host2" command="U.D.E."><![CDATA[
64 bytes from 192.168.1.1: icmp_seq=12 ttl=64 time=0.234 ms
]]></STDOUT>
<STDOUT time="2021-02-27T16:25:14.716Z" host="host2" command="U.D.E."><![CDATA[
64 bytes from 192.168.1.1: icmp_seq=12 ttl=64 time=0.226 ms
]]></STDOUT>
<STDOUT time="2021-02-27T16:25:14.717Z" host="host1" command="U.D.E."><![CDATA[
64 bytes from 192.168.1.1: icmp_seq=12 ttl=64 time=0.326 ms
]]></STDOUT>
...

Errors:

When Error is received, output tag will be STDERR instead of STDOUT and will be coloured in red.

Example:

nktty -r '*' -u 'asdd'

Output:

...
<STDERR time="2021-02-27T17:05:57.741Z" host="host2" command="U.D.E."><![CDATA[
bash: asdd: command not found
]]></STDERR>
<STDERR time="2021-02-27T17:05:57.779Z" host="host1" command="U.D.E."><![CDATA[
bash: asdd: command not found
]]></STDERR>
<STDERR time="2021-02-27T17:05:57.779Z" host="host3" command="U.D.E."><![CDATA[
bash: asdd: command not found
]]></STDERR>
...

How it works?

nktty is single threaded, non blocking, asynchronous process running on your machine.

Initial checks (./config/commandsAll.json), are executed in parallel manner on remote hosts and collected in asynchronous manner.
Execution: (./config/execute.json). Every matching command in every selected host is executed in parallel with others, per host. So you will have multiple commands running (if more than one is matched) on every matched host.
User defined execution [Same as previous but with user provided command].
Output of --execute and --ude is XML formatted and contains following properties.
- Tag: STDOUT (green) or STDERR (red) depending on the received data type.
- time: time of receiving the output based on user's clock.
- host: Title of the host of which it was received.
- command: Title of the command executed (Or U.D.E. when --ude, -u options are used).
- <![CDATA[\n .. \n]]> containing the actual output.

Advanced usage.

All params accept file paths as input when using '@' at the begining. For exemple: To execute stack of commands on each host, you can put them into file and provide it as an input to user defined execution (--ude, -u). lets, put those lines into

File test.sh

date && \
whoami && \
ping -c 1 google.com && \
echo $(( ( RANDOM % 100 )  + 1 ))

And call:

nktty -r 'host1|host2' -u '@test.sh'

The resut is:

<STDOUT time="2021-02-28T11:30:08.000Z" host="host2" command="U.D.E."><![CDATA[
Sun Feb 28 13:30:07 EET 2021
]]></STDOUT>
<STDOUT time="2021-02-28T11:30:08.008Z" host="host2" command="U.D.E."><![CDATA[
root
]]></STDOUT>
<STDOUT time="2021-02-28T11:30:08.042Z" host="host1" command="U.D.E."><![CDATA[
Sun Feb 28 13:30:08 EET 2021
]]></STDOUT>
<STDOUT time="2021-02-28T11:30:08.082Z" host="host1" command="U.D.E."><![CDATA[
root
]]></STDOUT>
<STDOUT time="2021-02-28T11:30:08.082Z" host="host2" command="U.D.E."><![CDATA[
PING google.com (216.58.214.142) 56(84) bytes of data.
64 bytes from fra16s06-in-f142.1e100.net (216.58.214.142): icmp_seq=1 ttl=117 time=2.09 ms
]]></STDOUT>
<STDOUT time="2021-02-28T11:30:08.083Z" host="host2" command="U.D.E."><![CDATA[
--- google.com ping statistics ---
1 packets transmitted, 1 received, 0% packet loss, time 0ms
rtt min/avg/max/mdev = 2.094/2.094/2.094/0.000 ms
]]></STDOUT>
<STDOUT time="2021-02-28T11:30:08.083Z" host="host2" command="U.D.E."><![CDATA[
37
]]></STDOUT>
<STDOUT time="2021-02-28T11:30:08.099Z" host="host1" command="U.D.E."><![CDATA[
PING google.com (142.250.184.142) 56(84) bytes of data.
64 bytes from sof02s43-in-f14.1e100.net (142.250.184.142): icmp_seq=1 ttl=117 time=1.86 ms
]]></STDOUT>
<STDOUT time="2021-02-28T11:30:08.100Z" host="host1" command="U.D.E."><![CDATA[
--- google.com ping statistics ---
1 packets transmitted, 1 received, 0% packet loss, time 0ms
rtt min/avg/max/mdev = 1.863/1.863/1.863/0.000 ms
]]></STDOUT>
<STDOUT time="2021-02-28T11:30:08.101Z" host="host1" command="U.D.E."><![CDATA[
91
]]></STDOUT>

Compiling to portable binary with configuration and keys included.

!ATTENTION ... while this is usefull in some very rare cases, it is realy dangerous (despite using AES-256). I strongly advise you to cosider using proper ssh key storage. Do not use this option if you don't know what and why you are doing it.

nktty can be compiled as a portable binary with configuration and keys included in encrypted storage. It is not shipped this way (on purpose). This requires some minor code modifications.

After setting up nktty you can dump your current configuration using -X option. You will be asked for a password ( will be used to encrypt config. ) Remember your password because you will be assked for it every time you start your portable binary.

nktty -X
? Password to encrypt configuration ›

After that a large string containing something similar to this will be shown.

const STATIC_CONFIG = {"iv":"2b9627b5f1d94febd556e8925a86fb0d","content":"e33...

Copy this string and re/place it in bin/nktty.js

// BEGIN STATIC_CONFIG

const STATIC_CONFIG = false

// END STATIC_CONFIG

now you are ready to compile you own binary with credentials included: In the root directory of nktty repo: Step 1:

cd /mygit/nktty

Set up pkg

npm install -g pkg

Now create builds:

npm run build

bin files will be in ../build directory

Name		Name	Last commit message	Last commit date
Latest commit History 32 Commits
bin		bin
config		config
.gitignore		.gitignore
LICENSE		LICENSE
README.md		README.md
package-lock.json		package-lock.json
package.json		package.json

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

bin

bin

config

config

.gitignore

.gitignore

LICENSE

LICENSE

README.md

README.md

package-lock.json

package-lock.json

package.json

package.json

Repository files navigation

nktty

How to install.

Git:

Standalone binary:

Linux OS standalone builds.

Options:

Configure:

Eamples:

Useful commands to try:

Errors:

How it works?

Advanced usage.

Compiling to portable binary with configuration and keys included.

About

Releases 7

Packages

Languages

License

reekol/nktty

Folders and files

Latest commit

History

Repository files navigation

nktty

How to install.

Git:

Standalone binary:

Linux OS standalone builds.

Options:

Configure:

Eamples:

Useful commands to try:

Errors:

How it works?

Advanced usage.

Compiling to portable binary with configuration and keys included.

About

Resources

License

Stars

Watchers

Forks

Languages