|
@@ -6,16 +6,16 @@ Psiphon 3 Tunnel Core README
|
|
|
Overview
|
|
Overview
|
|
|
--------------------------------------------------------------------------------
|
|
--------------------------------------------------------------------------------
|
|
|
|
|
|
|
|
-A Psiphon client component implemented in Go. This component provide core tunnel functionality, handling all aspects of connecting to Psiphon servers and relaying traffic through those servers. Local proxies provide an interface for routing traffic through the tunnel.
|
|
|
|
|
|
|
+Psiphon client and server components implemented in Go. These components provides core tunnel functionality, handling all aspects of evading blocking and relaying traffic through Psiphon. In the client, local proxies provide an interface for routing traffic through the tunnel.
|
|
|
|
|
|
|
|
-This component does not include a UI and does not handle capturing or routing local traffic. These major aspects are handled by other parts of Psiphon client applications.
|
|
|
|
|
|
|
+The client component does not include a UI and does not handle capturing or routing local traffic. These major aspects are handled by other parts of Psiphon client applications.
|
|
|
|
|
|
|
|
Status
|
|
Status
|
|
|
--------------------------------------------------------------------------------
|
|
--------------------------------------------------------------------------------
|
|
|
|
|
|
|
|
This project is in production and used as the tunneling engine in our Windows and Android clients, which are available at our [Psiphon 3 repository](https://bitbucket.org/psiphon/psiphon-circumvention-system).
|
|
This project is in production and used as the tunneling engine in our Windows and Android clients, which are available at our [Psiphon 3 repository](https://bitbucket.org/psiphon/psiphon-circumvention-system).
|
|
|
|
|
|
|
|
-Setup
|
|
|
|
|
|
|
+Client Setup
|
|
|
--------------------------------------------------------------------------------
|
|
--------------------------------------------------------------------------------
|
|
|
|
|
|
|
|
#### Build
|
|
#### Build
|
|
@@ -67,9 +67,25 @@ Setup
|
|
|
Other Platforms
|
|
Other Platforms
|
|
|
--------------------------------------------------------------------------------
|
|
--------------------------------------------------------------------------------
|
|
|
|
|
|
|
|
-* The project builds and runs on Android. See the [AndroidLibrary README](AndroidLibrary/README.md) for more information about building the Go component, and the [AndroidApp README](AndroidApp/README.md) for a sample Android app that uses it.
|
|
|
|
|
|
|
+* The project builds and runs on Android. See the [Android Library README](MobileLibrary/Android/README.md) for more information about building the Go component, and the [Android Sample App README](MobileLibrary/Android/SampleApps/TunneledWebView/README.md) for a sample Android app that uses it.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
+Acknowledgements
|
|
|
|
|
+--------------------------------------------------------------------------------
|
|
|
|
|
+
|
|
|
|
|
+Psiphon Tunnel Core uses:
|
|
|
|
|
+
|
|
|
|
|
+* [Go](https://golang.org/)
|
|
|
|
|
+* [Logrus](https://github.com/Sirupsen/logrus)
|
|
|
|
|
+* [MaxMind DB Reader for Go](https://github.com/oschwald/maxminddb-golang)
|
|
|
|
|
+* [go-cache](https://github.com/patrickmn/go-cache)
|
|
|
|
|
+* [ratelimit](https://github.com/juju/ratelimit)
|
|
|
|
|
+* [Bolt](https://github.com/boltdb/bolt)
|
|
|
|
|
+* [Go DNS](https://github.com/miekg/dns)
|
|
|
|
|
+* [OpenSSL Bindings for Go](https://github.com/spacemonkeygo/openssl)
|
|
|
|
|
+* [goptlib](https://github.com/Yawning/goptlib)
|
|
|
|
|
+* [goregen](https://github.com/zach-klippenstein/goregen)
|
|
|
|
|
+
|
|
|
Licensing
|
|
Licensing
|
|
|
--------------------------------------------------------------------------------
|
|
--------------------------------------------------------------------------------
|
|
|
|
|
|