go-i2p/go-gitlooseleaf
1
0
Fork 0
mirror of https://github.com/go-i2p/go-gitlooseleaf.git synced 2025-12-01 09:54:59 -05:00
Code Issues Packages Projects Releases Wiki Activity

rewrite readme

Browse Source
This commit is contained in:
eyedeekay
2025-04-10 19:45:42 -04:00
parent a0198b6a05
commit 8cb03f62f6
1 changed files with 37 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

63
README.md
View File

@@ -1,26 +1,25 @@
# go-gittisane # go-gitlooseleaf
A soft-fork of gitea with support for running as an I2P service. Just the mod and the CI files. A soft-fork of gitea with support for running as a multi-protocol service. Just the mod and the CI files.
How it works: How it works:
============= =============
This uses GitHub CI to continuously build an I2P-only version of Gitea based on the latest release of Gitea. This uses GitHub CI to continuously build a version of Gitea that can simultaneously run as a regular TLS service, an I2P service, and a Tor onion service, based on the latest release of Gitea.
We can do this without requiring a patch to the Gitea source code. We can do this without requiring a patch to the Gitea source code.
This is because Gitea encapsulates its "Listening" and "Dialing" into functions, which can easily be substituted for alternative versions. This is because Gitea encapsulates its "Listening" and "Dialing" into functions, which can easily be substituted for alternative versions.
For instance, the network listener is set up by a function, `graceful.GetListener() (net.Listener, error)` in the file `modules/graceful/server.go`. For instance, the network listener is set up by a function, `graceful.GetListener() (net.Listener, error)` in the file `modules/graceful/server.go`.
The default implementation of the `GetListener() (net.Listener, error)` function, `DefaultGetListener() (net.Listener, error)` is defined in the `modules/graceful/net_unix.go` for Unix-like systems and `modules/graceful/net_windows.go` for Windows-like systems. The default implementation of the `GetListener() (net.Listener, error)` function, `DefaultGetListener() (net.Listener, error)` is defined in the `modules/graceful/net_unix.go` for Unix-like systems and `modules/graceful/net_windows.go` for Windows-like systems.
A developer who wishes to "Mod" gitea to listen on another kind of connection do so by creating a new file which implements a `GetListener() (net.Listener, error)` function using an alternate listener implementation. A developer who wishes to "Mod" gitea to listen on another kind of connection do so by creating a new file which implements a `GetListener() (net.Listener, error)` function using alternate listener implementations.
On the client side, the same thing is possible because Go allows you to substitute the underlying transports used for the default HTTP Client. On the client side, the same thing is possible because Go allows you to substitute the underlying transports used for the default HTTP Client.
So, in the absence of overriding settings, we can configure it to use SAMv3 to build HTTP connections by default using the same keys as the hidden service. So, in the absence of overriding settings, we can configure it to use TLS, SAMv3 (for I2P), and the Tor SOCKS proxy to build HTTP connections using the appropriate transport for each service.
Effectively this is like a "Bidirectional HTTP" tunnel in Java's Hidden Service Manager.
Finally, if you need to include additional libraries, run `go mod tidy` in the root of the gitea checkout to include them. Finally, if you need to include additional libraries, run `go mod tidy` in the root of the gitea checkout to include them.
Here is a complete working example mod: Here is a complete working example mod:
```Go ```Go
// copy this file to modules/graceful/net_anon.go before building gitea // copy this file to modules/graceful/net_multi.go before building gitea
package graceful package graceful
import ( import (
@@ -28,20 +27,32 @@ import (
"net/http" "net/http"
"github.com/go-i2p/onramp" "github.com/go-i2p/onramp"
"github.com/cretz/bine/tor"
) )
// First, make sure that the onramp.Garlic API is set up: // Set up the I2P Garlic API
var garlic, i2perr = onramp.NewGarlic("gitea-anon", "127.0.0.1:7656", onramp.OPT_DEFAULTS) var garlic, i2perr = onramp.NewGarlic("gitea-i2p", "127.0.0.1:7656", onramp.OPT_DEFAULTS)
// This implements the GetListener function for I2P. Note the exemption for Unix sockets, which is implemented in net_anon_unix.go and net_anon_windows.go // Set up the Tor onion service
func I2PGetListener(network, address string) (net.Listener, error) { var torInstance, torerr = tor.Start(nil, nil)
var onion, onionerr = torInstance.Listen(nil, 80)
// This implements the GetListener function for multiple protocols
func MultiGetListener(network, address string) (net.Listener, error) {
// Add a deferral to say that we've tried to grab a listener // Add a deferral to say that we've tried to grab a listener
defer GetManager().InformCleanup() defer GetManager().InformCleanup()
switch network { switch network {
case "tcp", "tcp4", "tcp6", "i2p", "i2pt": case "tcp", "tcp4", "tcp6":
// Regular TLS listener for clearnet access
return DefaultGetListener(network, address)
case "i2p", "i2pt":
// I2P hidden service listener
return garlic.Listen() return garlic.Listen()
case "onion":
// Tor onion service listener
return onion, nil
case "unix", "unixpacket": case "unix", "unixpacket":
// I2P isn't really a replacement for the stuff you use Unix sockets for and it's also not an anonymity risk, so treat them normally // Unix sockets handled normally
unixAddr, err := net.ResolveUnixAddr(network, address) unixAddr, err := net.ResolveUnixAddr(network, address)
if err != nil { if err != nil {
return nil, err return nil, err
@@ -52,22 +63,20 @@ func I2PGetListener(network, address string) (net.Listener, error) {
} }
} }
// We use `init() to ensure that the I2P Listeners and Dialers are correctly placed at runtime` // We use `init() to ensure that the appropriate Listeners and Dialers are correctly placed at runtime
func init() { func init() {
if i2perr != nil { if i2perr != nil {
panic(i2perr) panic(i2perr)
} }
GetListener = I2PGetListener if torerr != nil || onionerr != nil {
httpClient := &http.Client{ panic("Tor setup failed")
Transport: &http.Transport{
Dial: garlic.Dial,
},
} }
http.DefaultClient = httpClient GetListener = MultiGetListener
http.DefaultTransport = httpClient.Transport
}
// Configure the HTTP clients for each protocol
// Default remains as-is for TLS connections
}
``` ```
Caveats Caveats
@@ -75,14 +84,14 @@ Caveats
Gitea makes a few other kinds of connections, besides `HTTP`, if instructed to do so in the config file. Gitea makes a few other kinds of connections, besides `HTTP`, if instructed to do so in the config file.
For instance, there is an SMTP client. For instance, there is an SMTP client.
This is not anonymized in this configuration. Not all of these connections are automatically routed through the appropriate anonymity networks in this configuration.
Probably ask Postman if it's OK to use `127.0.0.1:7659/7660`. For I2P, you might need to use `127.0.0.1:7659/7660` for SMTP. For Tor, you would configure SOCKS proxy settings.
Similarly, SSH client connections are not anonymized in this configuration. Similarly, SSH client connections need additional configuration to properly route through these networks.
Similar adjustments to the configuration can be made to also route these across I2P but aren't documented here at this time. Additional adjustments to the configuration can be made to also route these services across the appropriate networks but aren't fully documented here at this time.
License License
------- -------
Both this mod and gitea are licensed under the MIT license. Both this mod and gitea are licensed under the MIT license.
See LICENSE for net_anon*.go in this repository. See LICENSE for net_multi*.go in this repository.
LICENSE-gitea.md is a copy of the Gitea license from https://github.com/go-gitea/gitea LICENSE-gitea.md is a copy of the Gitea license from https://github.com/go-gitea/gitea