Updated README.md

README.md

@@ -1,16 +1,30 @@
 HKExSh
 --
 
-'hkexsh' (HerraduraKEx shell) is a golang implementation of a simple
+'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 as well as file copying.
 
 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 the experimental HerraduraKEx key exchange algorithm
-first released at
-[Omar Elejandro Herrera Reyna's HerraduraKEx project](http://github.com/Caume/HerraduraKEx).
+'secure' sockets, using one of a selectable set of experimental key exchange (KEX) or
+key encapsulation mechanisms (KEM).
+
+Currently supported exchanges are:
+
+* The HerraduraKEx key exchange algorithm first released at
+[Omar Elejandro Herrera Reyna's HerraduraKEx project](http://github.com/Caume/HerraduraKEx);
+* The KYBER IND-CCA-2 secure key encapsulation mechanism, [pq-crystals Kyber](https://pq-crystals.org/kyber/)  :: [Yawning/kyber golang implementation](https://git.schwanenlied.me/yawning/kyber)
+
+Currently supported session encryption and hmac algorithms:
+
+* AES-256
+* Twofish-128
+* Blowfish-64
+* HMAC-SHA256
+* HMAC-SHA512
+
 
 One can simply replace calls to net.Dial() with hkex.Dial(), and likewise
 net.Listen() with hkex.Listen(), to obtain connections (hkex.Conn) conforming
@@ -27,30 +41,33 @@ Packets are subject to random padding, and (optionally) the client and server
 channels can both send _chaff_ packets at random defineable intervals to help
 thwart analysis of session activity (especially for interactive shell sessions).
 
-NOTE: Due to the experimental nature of the HerraduraKEx algorithm used to
-derive crypto keying material, this algorithm and the demonstration remote
-shell client/server programs should be used with caution and should definitely
-NOT be used for any sensitive applications, or at the very least at one's
-own risk.
+NOTE: THIS PROJECT IS EXPERIMENTAL. Due to the experimental nature of the HerraduraKEx and Kyber IND-CCA-2 algorithms, this package SHOULD BE USED WITH CAUTION and should DEFINITELY NOT be used for any sensitive applications. USE AT YOUR OWN RISK. NO WARRANTY OR CLAIM OF FITNESS FOR PURPOSE IS IMPLIED.
 
-As of this time (Jan 2018) no verdict by acknowledged 'crypto experts' as to
+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](https://csrc.nist.gov/Projects/Post-Quantum-Cryptography). 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, for purposes of simplicity of code and to evaluate the algorithm in operation by itself (again, THIS PROJECT IS EXPERIMENTAL.)
+
 Finally, within the hkexpasswd/ directory is a password-setting utility
 using its own user/password file distinct from the system /etc/passwd, which
 is used by the hkexshd server to authenticate clients.
 
 Dependencies:
 --
-* Recent version of go (tested with go-1.9)
+* Recent version of go (tested, at various times, with go-1.9 to go-1.11.1)
 * [github.com/mattn/go-isatty](http://github.com/mattn/go-isatty) //terminal tty detection
 * [github.com/kr/pty](http://github.com/kr/pty) //unix pty control (server pty connections)
 * [github.com/jameskeane/bcrypt](http://github.com/jameskeane/bcrypt) //password storage/auth
 * [blitter.com/go/goutmp](https://blitter.com/gogs/Russtopia/goutmp) // wtmp/lastlog C bindings
+* [https://git.schwanenlied.me/yawning/kyber](https://git.schwanenlied.me/yawning/kyber) // golang Kyber KEM
 
 Get source code
 --