Skip to content
Snippets Groups Projects
README 1.05 KiB
Newer Older
David Fifield's avatar
David Fifield committed
goptlib is a library for writing Tor pluggable transports in Go.

https://spec.torproject.org/pt-spec
https://gitweb.torproject.org/torspec.git/tree/ext-orport-spec.txt
David Fifield's avatar
David Fifield committed

To download a copy of the library into $GOPATH:
	go get git.torproject.org/pluggable-transports/goptlib.git

See the included example programs for examples of how to use the
library. To build them, enter their directory and run "go build".
	examples/dummy-client/dummy-client.go
	examples/dummy-server/dummy-server.go
The recommended way to start writing a new transport plugin is to copy
dummy-client or dummy-server and make changes to it.

There is browseable documentation here:
David Fifield's avatar
David Fifield committed
https://godoc.org/git.torproject.org/pluggable-transports/goptlib.git
David Fifield's avatar
David Fifield committed

Report bugs to the tor-dev@lists.torproject.org mailing list or to the
bug tracker at https://trac.torproject.org/projects/tor.
David Fifield's avatar
David Fifield committed

To the extent possible under law, the authors have dedicated all
copyright and related and neighboring rights to this software to the
public domain worldwide. This software is distributed without any
warranty. See COPYING.