summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorYawning Angel <yawning@schwanenlied.me>2014-06-07 20:03:29 +0000
committerYawning Angel <yawning@schwanenlied.me>2014-06-07 20:03:29 +0000
commit6245391c93adf7b9617888d9d9ca8b12518cc52a (patch)
treedaa631b85175a4f1e13c9ec6a388f8c218c9772b /README.md
parentb19b6de31f160b70f5d38d78d16c539a3b07c6fa (diff)
Document dependencies, add LICENSE (No functional changes).
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/README.md b/README.md
index d8d7923..c97588a 100644
--- a/README.md
+++ b/README.md
@@ -30,6 +30,19 @@ Since a lot of the changes are to the handshaking process, it didn't make sense
to extend ScrambleSuit as writing a server implementation that supported both
handshake variants without being obscenely slow is non-trivial.
+### Dependencies
+
+Build time library dependencies are handled by go get automatically but are
+listed for clarity.
+
+ * Go 1.2.0 or later. Debian stable packages Go 1.0.2 which is missing several
+ things obfs4 depends on like SHA256.
+ * go.crypto (https://code.google.com/p/go.crypto)
+ * go.net (https://code.google.com/p/go.net)
+ * ed25519/extra25519 (https://github.com/agl/ed25519/extra25519)
+ * SipHash-2-4 (https://github.com/dchest/siphash)
+ * goptlib (https://git.torproject.org/pluggable-transports/goptlib.git)
+
### TODO
* Code cleanups.
@@ -45,6 +58,7 @@ handshake variants without being obscenely slow is non-trivial.
* I do not care about older versions of the go runtime.
### Thanks
+
* David Fifield for goptlib.
* Adam Langley for his Elligator implementation.
* Philipp Winter for the ScrambleSuit protocol which provided much of the