A secure remote client/server terminal, written in Golang. Intended as a test-bed for experimental key exchanges and symmetric session crypto. Integrated traffic chaffing.
Go to file
Russ Magee 7e60a395ad Updated go.mod to include newhope deps
Signed-off-by: Russ Magee <rmagee@gmail.com>
2019-04-17 20:00:22 -07:00
hkexnet Added NEWHOPE and NEWHOPE_SIMPLE KEM algs 2019-04-08 21:58:33 -07:00
hkexpasswd Added test files for hkexcp testing 2019-03-22 22:40:41 -07:00
hkexsh Merge branch 'master' of https://gogs.blitter.com/RLabs/hkexsh 2019-04-08 22:00:06 -07:00
hkexshd Added NEWHOPE and NEWHOPE_SIMPLE KEM algs 2019-04-08 21:58:33 -07:00
logger Gometalinter cleanup/audit of hkexsh, hkexshd, hkexpasswd 2018-11-25 10:24:10 -08:00
spinsult Updates to main Makefile (and added spinsult Makefile) 2018-07-04 23:07:09 -07:00
CODE_OF_MERIT.md Updated to stable archived link 2019-04-06 23:19:26 -07:00
LICENSE.mit Added hkexnet to LICENSE file 2018-10-10 22:37:25 -07:00
Makefile Moved herradurakex to its own package 2018-12-06 17:20:43 -08:00
README.md Update 'README.md' 2019-04-08 22:26:03 -07:00
TODO.txt Moved herradurakex to its own package 2018-12-06 17:20:43 -08:00
consts.go Added NEWHOPE and NEWHOPE_SIMPLE KEM algs 2019-04-08 21:58:33 -07:00
cp.cmd Continuing groundwork for cp mode - refactor main client code into shell/copy subroutines; -r option 2018-08-06 22:29:51 -07:00
cptest.sha1sum Sorted cptest.sha1sum 2019-04-03 22:37:43 -07:00
fixup-gv.sh Added fixup-gv.sh and Makefile rules to generate annotated goroutines in graphviz output. 2018-11-25 18:43:53 -08:00
go.mod Updated go.mod to include newhope deps 2019-04-17 20:00:22 -07:00
go.sum Updated go.mod to include newhope deps 2019-04-17 20:00:22 -07:00
grml.yaml Updated vis targets to match go-callvis updated cmdline options 2019-01-09 23:35:34 -08:00
hkexauth.go Rearranged godoc pkg comments 2018-12-08 11:29:58 -08:00
hkexsession.go Rearranged godoc pkg comments 2018-12-08 11:29:58 -08:00
hkexshd.initrc Added example openrc init script 2018-11-13 23:59:34 -08:00
termmode_unix.go termmode.go: Added nil check in term.Restore() for nonexistent cp filename 2019-04-05 19:10:38 -07:00
termmode_windows.go MSYS+mintty support; pkg renaming to hkexsh 2018-04-04 15:43:27 -07:00
viz_hkexsh_dot.png Added go-code-visualizer PNG and 'make vis' rule to generate 2018-11-20 22:34:16 -08:00

README.md

GoDoc

HKExSh

HKExSh (HerraduraKyberEx Shell) is a golang implementation of a simple remote shell client and server, similar in role to ssh, offering encrypted interactive and non-interactive sessions, file copying and tunnels with traffic obfuscation ('chaffing').


NOTE: Due to the experimental nature of the KEX/KEM algorithms used, and the novelty of the overall codebase, this package SHOULD BE CONSIDERED EXTREMELY EXPERIMENTAL and USED WITH CAUTION. It DEFINITELY SHOULD NOT be used for any sensitive applications. USE AT YOUR OWN RISK. NEITHER WARRANTY NOR CLAIM OF FITNESS FOR PURPOSE IS EXPRESSED OR IMPLIED.


The client and server programs (hkexsh and hkexshd) use a mostly drop-in replacement for golang's standard golang/pkg/net facilities (net.Dial(), net.Listen(), net.Accept() and the net.Conn type), which automatically negotiate keying material for secure sockets using one of a selectable set of experimental key exchange (KEX) or key encapsulation mechanisms (KEM).

Currently supported exchanges are:

Currently supported session algorithms:

[Encryption]

[HMAC]

  • HMAC-SHA256
  • HMAC-SHA512

Calls to hkexnet.Dial() and hkexnet.Listen()/Accept() are generally the same as calls to the equivalents within the net package; however upon connection a key exchange automatically occurs whereby client and server independently derive the same keying material, and all following traffic is secured by a symmetric encryption algorithm.

Above the hkexnet.Conn layer, the server and client apps in this repository (hkexshd/ and hkexsh/ respectively) negotiate session settings (cipher/hmac algorithms, interactive/non-interactive, tunnels, if any, etc.) to be used for communication.

Packets are subject to random padding (size, prefix/postfix), and (optionally) the client and server channels can both send chaff packets at random defineable intervals to help thwart analysis of session activity (applicable to interactive and non-interactive command sessions, file copies and tunnels).

Tunnels, if specified, are set up during initial client->server connection. Packets from the client local port(s) are sent through the main secured connection to the server's remote port(s), and vice versa, tagged with a tunnel specifier so that they can be de-multiplexed and delivered to the proper tunnel endpoints.

Finally, within the hkexpasswd/ directory is a password-setting utility. HKExSh uses its own passwd file distinct from the system /etc/passwd to authenticate clients, using standard bcrypt+salt storage.

HERRADURA KEX

As of this time (Oct 2018) no verdict by acknowledged 'crypto experts' as to the level of security of the HerraduraKEx algorithm for purposes of session key exchange over an insecure channel has been rendered. It is hoped that experts in the field will analyze the algorithm and determine if it is indeed a suitable one for use in situations where Diffie-Hellman or other key exchange algorithms are currently utilized.

KYBER IND-CCA-2 KEM

As of this time (Oct 2018) Kyber is one of the candidate algorithms submitted to the NIST post-quantum cryptography project. The authors recommend using it in "... so-called hybrid mode in combination with established "pre-quantum" security; for example in combination with elliptic-curve Diffie-Hellman." THIS PROJECT DOES NOT DO THIS (in case you didn't notice yet, THIS PROJECT IS EXPERIMENTAL.)

Dependencies:

Get source code

  • $ go get -u blitter.com/go/hkexsh
  • $ cd $GOPATH/src/blitter.com/go/hkexsh
  • $ go build ./... # install all dependent go pkgs

To build

  • $ cd $GOPATH/src/blitter.com/go/hkexsh
  • $ make clean all

To install, uninstall, re-install

  • $ sudo make [install | uninstall | reinstall]

To manage service (assuming openrc init)

  • $ sudo rc-config [start | restart | stop] hkexshd

An example init script (hkexshd.initrc) is provided. Consult your Linux distribution documentation for proper service/daemon installation. Default assumes installation in /usr/local/sbin (hkexshd, hkexpasswd) and /usr/local/bin (hkexsh/hkexcp symlink).

To set accounts & passwords:

  • $ sudo touch /etc/hkexsh.passwd
  • $ sudo hkexpasswd/hkexpasswd -u joebloggs
  • $ <enter a password, enter again to confirm>

Testing Client and Server from $GOPATH dev tree (w/o 'make install')

In separate shells A and B:

  • [A]$ cd hkexshd && sudo ./hkexshd & # add -d for debugging

Interactive shell

  • [B]$ cd hkexsh && ./hkexsh joebloggs@host-or-ip # add -d for debugging

One-shot command

  • [B]$ cd hkexsh && ./hkexsh -x "ls /tmp" joebloggs@host-or-ip

WARNING WARNING WARNING: the -d debug flag will echo passwords to the log/console! Logging on Linux usually goes to /var/log/syslog and/or /var/log/debug, /var/log/daemon.log.

NOTE if running client (hkexsh) with -d, one will likely need to run 'reset' afterwards to fix up the shell tty afterwards, as stty echo may not be restored if client crashes or is interrupted.

Setting up an 'authtoken' for scripted (password-free) logins

Use the -g option of hkexsh to request a token from the remote server, which will return a hostname:token string. Place this string into $HOME/.hkexsh_id to allow logins without entering a password (obviously, $HOME/.hkexsh_id on both server and client for the user should not be world-readable.)

File Copying using hkexcp

hkexcp is a symlink to hkexsh, and the binary checks its own filename to determine whether it is being invoked in 'shell' or 'copy' mode. Refer to the '-h' output for differences in accepted options.

General remote syntax is: user@server:[/]src-or-dest-path If no leading / is specified in src-or-dest-path, it is assumed to be relative to $HOME of the remote user. File operations are all performed as the remote user, so account permissions apply as expected.

Local (client) to remote (server) copy:

  • hkexcp fileA /some/where/fileB /some/where/else/dirC joebloggs@host-or-ip:remoteDir

Remote (server) to local (client) copy:

  • hkexcp joebloggs@host-or-ip:/remoteDirOrFile /some/where/local/Dir

NOTE: Renaming while copying (eg., 'cp /foo/bar/fileA ./fileB') is NOT supported. Put another way, the destination (whether local or remote) must ALWAYS be a directory.

hkexcp uses tar (a 'tarpipe') with gzip compression, sending tar data over the hkex encrypted channel. Use the -d flag on client or server to see the generated tar commands if you're curious.

Tunnels

Simple tunnels (client -> server, no reverse tunnels for now) are supported.

Syntax: hkexsh -T=<tunspec>{,<tunspec>...} .. where <tunspec> is <localport:remoteport>

Example, tunnelling ssh through hkexsh (NOTE issue #15)

  • [server side] $ sudo /usr/sbin/sshd -p 7002
  • [client side, term A] $ hkexsh -T=6002:7002 user@server
  • [client side, term B] $ ssh user@localhost -p 6002