diff --git a/TODO.md b/TODO.md new file mode 100644 index 0000000..a787900 --- /dev/null +++ b/TODO.md @@ -0,0 +1,3 @@ +Port IRC Filtering +Port HTTP Filtering +Implement interactive support for encrypted leasesets in HTTP Client tunnel \ No newline at end of file diff --git a/UNIMPLEMENTED.md b/UNIMPLEMENTED.md index ab39fda..e69de29 100644 --- a/UNIMPLEMENTED.md +++ b/UNIMPLEMENTED.md @@ -1,7 +0,0 @@ -./lib/http/client/httpclient.go-87-func (h *HTTPClient) Start() error { -./lib/http/client/httpclient.go:88: panic("unimplemented") -./lib/http/client/httpclient.go-89-} --- -./lib/http/client/httpclient.go-97-func (h *HTTPClient) Stop() error { -./lib/http/client/httpclient.go:98: panic("unimplemented") -./lib/http/client/httpclient.go-99-} diff --git a/lib/core/doc.md b/lib/core/doc.md index c9e4d21..6a40522 100644 --- a/lib/core/doc.md +++ b/lib/core/doc.md @@ -5,6 +5,14 @@ ## Usage +#### func Clean + +```go +func Clean(name string) string +``` +Clean the name to form an ID change newlines to + change tabs to _ change spaces +to - erase foreslashes + #### type I2PTunnel ```go @@ -15,6 +23,8 @@ type I2PTunnel interface { Stop() error // Get the tunnel's name Name() string + // Get the tunnel's ID + ID() string // Get the tunnel's type Type() string // Get the tunnel's I2P address @@ -25,6 +35,8 @@ type I2PTunnel interface { Options() map[string]string // Set the tunnel's options SetOptions(map[string]string) error + // Load the tunnel config + LoadConfig(path string) error // Get the tunnel's status Status() I2PTunnelStatus // Get the tunnel's error message diff --git a/lib/http/client/doc.md b/lib/http/client/doc.md index e63cb69..9eb8f5d 100644 --- a/lib/http/client/doc.md +++ b/lib/http/client/doc.md @@ -17,6 +17,10 @@ type HTTPClient struct { i2ptunnel.I2PTunnelStatus // The http filtering configuration httpinspector.Config + // The proxy server + *goproxy.ProxyHttpServer + // The http server + *http.Server // Error history of the tunnel Errors []i2ptunnel.I2PTunnelError @@ -38,6 +42,18 @@ func (h *HTTPClient) Address() string ``` Get the tunnel's I2P address +#### func (*HTTPClient) Dial + +```go +func (h *HTTPClient) Dial(network, addr string) (c net.Conn, err error) +``` + +#### func (*HTTPClient) DialContext + +```go +func (h *HTTPClient) DialContext(ctx context.Context, network, addr string) (c net.Conn, err error) +``` + #### func (*HTTPClient) Error ```go @@ -59,13 +75,6 @@ func (h *HTTPClient) Name() string ``` Get the tunnel's name -#### func (*HTTPClient) Options - -```go -func (h *HTTPClient) Options() map[string]string -``` -Get the tunnel's options - #### func (*HTTPClient) Start ```go diff --git a/lib/http/server/doc.md b/lib/http/server/doc.md index f5a3467..9579287 100644 --- a/lib/http/server/doc.md +++ b/lib/http/server/doc.md @@ -63,13 +63,6 @@ func (h *HTTPServer) Name() string ``` Get the tunnel's name -#### func (*HTTPServer) Options - -```go -func (h *HTTPServer) Options() map[string]string -``` -Get the tunnel's options - #### func (*HTTPServer) Start ```go diff --git a/lib/irc/client/doc.md b/lib/irc/client/doc.md index 97cc77d..e8b26d8 100644 --- a/lib/irc/client/doc.md +++ b/lib/irc/client/doc.md @@ -61,13 +61,6 @@ func (i *IRCClient) Name() string ``` Get the tunnel's name -#### func (*IRCClient) Options - -```go -func (i *IRCClient) Options() map[string]string -``` -Get the tunnel's options - #### func (*IRCClient) Start ```go diff --git a/lib/irc/server/doc.md b/lib/irc/server/doc.md index 9b6264b..9771f7f 100644 --- a/lib/irc/server/doc.md +++ b/lib/irc/server/doc.md @@ -63,13 +63,6 @@ func (i *IRCServer) Name() string ``` Get the tunnel's name -#### func (*IRCServer) Options - -```go -func (i *IRCServer) Options() map[string]string -``` -Get the tunnel's options - #### func (*IRCServer) Start ```go diff --git a/lib/socks/client/doc.md b/lib/socks/client/doc.md index 7403436..0bd8723 100644 --- a/lib/socks/client/doc.md +++ b/lib/socks/client/doc.md @@ -24,6 +24,12 @@ type SOCKS struct { ``` +#### func NewSocksClient + +```go +func NewSocksClient(config i2pconv.TunnelConfig, samAddr string) (*SOCKS, error) +``` + #### func (*SOCKS) Address ```go @@ -52,13 +58,6 @@ func (s *SOCKS) Name() string ``` Get the tunnel's name -#### func (*SOCKS) Options - -```go -func (s *SOCKS) Options() map[string]string -``` -Get the tunnel's options - #### func (*SOCKS) Start ```go diff --git a/lib/tcp/client/doc.md b/lib/tcp/client/doc.md index 0983ec9..84dc479 100644 --- a/lib/tcp/client/doc.md +++ b/lib/tcp/client/doc.md @@ -59,13 +59,6 @@ func (t *TCPClient) Name() string ``` Get the tunnel's name -#### func (*TCPClient) Options - -```go -func (t *TCPClient) Options() map[string]string -``` -Get the tunnel's options - #### func (*TCPClient) Start ```go diff --git a/lib/tcp/server/doc.md b/lib/tcp/server/doc.md index 7af8440..7bb24d6 100644 --- a/lib/tcp/server/doc.md +++ b/lib/tcp/server/doc.md @@ -61,13 +61,6 @@ func (t *TCPServer) Name() string ``` Get the tunnel's name -#### func (*TCPServer) Options - -```go -func (t *TCPServer) Options() map[string]string -``` -Get the tunnel's options - #### func (*TCPServer) Start ```go diff --git a/lib/udp/client/doc.md b/lib/udp/client/doc.md index 3c6b9b5..ed66109 100644 --- a/lib/udp/client/doc.md +++ b/lib/udp/client/doc.md @@ -59,13 +59,6 @@ func (u *UDPClient) Name() string ``` Get the tunnel's name -#### func (*UDPClient) Options - -```go -func (u *UDPClient) Options() map[string]string -``` -Get the tunnel's options - #### func (*UDPClient) Start ```go diff --git a/lib/udp/server/doc.md b/lib/udp/server/doc.md index 17cd253..1b1e217 100644 --- a/lib/udp/server/doc.md +++ b/lib/udp/server/doc.md @@ -59,13 +59,6 @@ func (u *UDPServer) Name() string ``` Get the tunnel's name -#### func (*UDPServer) Options - -```go -func (u *UDPServer) Options() map[string]string -``` -Get the tunnel's options - #### func (*UDPServer) Start ```go