Skip to content

Commit a835a79

Browse files
waybackarchiverwaybackarchiver
authored
Add option to disable onion service (#372)
* Improve the definition of embedded tor * Rename tor to onion * Bulk rename _TOR_ to _ONION_
1 parent 5fe18b7 commit a835a79

18 files changed

+149
-167
lines changed

‎README.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -283,9 +283,10 @@ You can also specify configuration options either via command flags or via envir
283283
| - | `WAYBACK_NOSTR_RELAY_URL` | `wss://nostr.developer.li` | Nostr relay server url, multiple separated by comma |
284284
| - | `WAYBACK_NOSTR_PRIVATE_KEY` | - | The private key of a Nostr account |
285285
| `--tor` | `WAYBACK_USE_TOR` | `false` | Snapshot webpage via Tor anonymity network |
286-
| `--tor-key` | `WAYBACK_TOR_PRIVKEY` | - | The private key for Tor Hidden Service |
287-
| - | `WAYBACK_TOR_LOCAL_PORT` | `8964` | Local port for Tor Hidden Service, also support for a **reverse proxy**. This is ignored if `WAYBACK_LISTEN_ADDR` is set. |
288-
| - | `WAYBACK_TOR_REMOTE_PORTS` | `80` | Remote ports for Tor Hidden Service, e.g. `WAYBACK_TOR_REMOTE_PORTS=80,81` |
286+
| `--tor-key` | `WAYBACK_ONION_PRIVKEY` | - | The private key for Tor Hidden Service |
287+
| - | `WAYBACK_ONION_LOCAL_PORT` | `8964` | Local port for Tor Hidden Service, also support for a **reverse proxy**. This is ignored if `WAYBACK_LISTEN_ADDR` is set. |
288+
| - | `WAYBACK_ONION_REMOTE_PORTS` | `80` | Remote ports for Tor Hidden Service, e.g. `WAYBACK_ONION_REMOTE_PORTS=80,81` |
289+
| - | `WAYBACK_ONION_DISABLED` | `false` | Disable onion service |
289290
| - | `WAYBACK_SLOT` | - | Pinning service for IPFS mode of pinner, see [ipfs-pinner](https://github.com/wabarc/ipfs-pinner#supported-pinning-services) |
290291
| - | `WAYBACK_APIKEY` | - | API key for pinning service |
291292
| - | `WAYBACK_SECRET` | - | API secret for pinning service |

‎build/docker/Dockerfile.render

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ ARG WAYBACK_IMAGE_TAG=latest-bundle
88
FROM ghcr.io/wabarc/wayback:${WAYBACK_IMAGE_TAG}
99

1010
ENV BASE_DIR /wayback
11-
ENV WAYBACK_TOR_LOCAL_PORT 80
11+
ENV WAYBACK_ONION_LOCAL_PORT 80
1212

1313
WORKDIR ${BASE_DIR}
1414

‎cmd/wayback/main.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ func setToEnv(cmd *cobra.Command) {
147147
os.Setenv("WAYBACK_USE_TOR", fmt.Sprint(tor))
148148
}
149149
if flags.Changed("tor-key") {
150-
os.Setenv("WAYBACK_TOR_PRIVKEY", torKey)
150+
os.Setenv("WAYBACK_ONION_PRIVKEY", torKey)
151151
}
152152
}
153153

‎config/config_test.go

+44-13
Original file line numberDiff line numberDiff line change
@@ -536,27 +536,27 @@ func TestPublishToChannel(t *testing.T) {
536536
}
537537
}
538538

539-
func TestTorPrivateKey(t *testing.T) {
539+
func TestOnionPrivateKey(t *testing.T) {
540540
os.Clearenv()
541-
os.Setenv("WAYBACK_TOR_PRIVKEY", "tor:private:key")
541+
os.Setenv("WAYBACK_ONION_PRIVKEY", "onion:private:key")
542542

543543
parser := NewParser()
544544
opts, err := parser.ParseEnvironmentVariables()
545545
if err != nil {
546546
t.Fatalf(`Parsing environment variables failed: %v`, err)
547547
}
548548

549-
expected := "tor:private:key"
550-
got := opts.TorPrivKey()
549+
expected := "onion:private:key"
550+
got := opts.OnionPrivKey()
551551

552552
if got != expected {
553553
t.Fatalf(`Unexpected Tor private key, got %v instead of %s`, got, expected)
554554
}
555555
}
556556

557-
func TestTorLocalPort(t *testing.T) {
557+
func TestOnionLocalPort(t *testing.T) {
558558
os.Clearenv()
559-
os.Setenv("WAYBACK_TOR_LOCAL_PORT", "8080")
559+
os.Setenv("WAYBACK_ONION_LOCAL_PORT", "8080")
560560

561561
parser := NewParser()
562562
opts, err := parser.ParseEnvironmentVariables()
@@ -565,14 +565,14 @@ func TestTorLocalPort(t *testing.T) {
565565
}
566566

567567
expected := 8080
568-
got := opts.TorLocalPort()
568+
got := opts.OnionLocalPort()
569569

570570
if got != expected {
571571
t.Fatalf(`Unexpected Tor local port, got %v instead of %q`, got, expected)
572572
}
573573
}
574574

575-
func TestDefaultTorLocalPortValue(t *testing.T) {
575+
func TestDefaultOnionLocalPortValue(t *testing.T) {
576576
os.Clearenv()
577577

578578
parser := NewParser()
@@ -581,8 +581,8 @@ func TestDefaultTorLocalPortValue(t *testing.T) {
581581
t.Fatalf(`Parsing environment variables failed: %v`, err)
582582
}
583583

584-
expected := defTorLocalPort
585-
got := opts.TorLocalPort()
584+
expected := defOnionLocalPort
585+
got := opts.OnionLocalPort()
586586

587587
if got != expected {
588588
t.Fatalf(`Unexpected Tor local port, got %v instead of %q`, got, expected)
@@ -591,7 +591,7 @@ func TestDefaultTorLocalPortValue(t *testing.T) {
591591

592592
func TestTorRemotePorts(t *testing.T) {
593593
os.Clearenv()
594-
os.Setenv("WAYBACK_TOR_REMOTE_PORTS", "80,81,82")
594+
os.Setenv("WAYBACK_ONION_REMOTE_PORTS", "80,81,82")
595595

596596
parser := NewParser()
597597
opts, err := parser.ParseEnvironmentVariables()
@@ -600,13 +600,44 @@ func TestTorRemotePorts(t *testing.T) {
600600
}
601601

602602
expected := []int{80, 81, 82}
603-
got := opts.TorRemotePorts()
603+
got := opts.OnionRemotePorts()
604604

605605
if got == nil || len(got) != 3 {
606606
t.Fatalf(`Unexpected Tor remote port, got %v instead of %v`, got, expected)
607607
}
608608
}
609609

610+
func TestOnionDisabled(t *testing.T) {
611+
tests := []struct {
612+
name string
613+
disabled bool
614+
expected bool
615+
}{
616+
{"default", defOnionDisabled, false},
617+
{"disabled", true, true},
618+
{"enabled", false, false},
619+
}
620+
621+
for _, test := range tests {
622+
t.Run(test.name, func(t *testing.T) {
623+
os.Clearenv()
624+
os.Setenv("WAYBACK_ONION_DISABLED", strconv.FormatBool(test.disabled))
625+
626+
parser := NewParser()
627+
opts, err := parser.ParseEnvironmentVariables()
628+
if err != nil {
629+
t.Fatalf(`Parsing environment variables failed: %v`, err)
630+
}
631+
632+
got := opts.OnionDisabled()
633+
634+
if got != test.expected {
635+
t.Fatalf(`Unexpected disable onion service, got %v instead of %v`, got, test.expected)
636+
}
637+
})
638+
}
639+
}
640+
610641
func TestListenAddr(t *testing.T) {
611642
t.Parallel()
612643

@@ -653,7 +684,7 @@ func TestDefaultTorRemotePortsValue(t *testing.T) {
653684
}
654685

655686
expected := []int{80}
656-
got := opts.TorRemotePorts()
687+
got := opts.OnionRemotePorts()
657688

658689
if got == nil || len(got) != 1 {
659690
t.Fatalf(`Unexpected Tor remote port, got %v instead of %v`, got, expected)

‎config/options.go

+27-20
Original file line numberDiff line numberDiff line change
@@ -72,9 +72,10 @@ const (
7272
defNostrRelayURL = "wss://nostr.developer.li"
7373
defNostrPrivateKey = ""
7474

75-
defTorPrivateKey = ""
76-
defListenAddr = "0.0.0.0:8964"
77-
defTorLocalPort = 8964
75+
defListenAddr = "0.0.0.0:8964"
76+
defOnionLocalPort = 8964
77+
defOnionPrivateKey = ""
78+
defOnionDisabled = false
7879

7980
defChromeRemoteAddr = ""
8081
defEnabledChromeRemote = false
@@ -99,8 +100,8 @@ var (
99100
IPFSToken = ""
100101
IPFSTarget = "web3storage"
101102

102-
defStorageDir = path.Join(os.TempDir(), "reduxer")
103-
defTorRemotePorts = []int{80}
103+
defStorageDir = path.Join(os.TempDir(), "reduxer")
104+
defOnionRemotePorts = []int{80}
104105
)
105106

106107
// Options represents a configuration options in the application.
@@ -123,7 +124,7 @@ type Options struct {
123124
slack *slack
124125
nostr *nostr
125126
irc *irc
126-
tor *tor
127+
onion *onion
127128

128129
listenAddr string
129130
chromeRemoteAddr string
@@ -216,11 +217,13 @@ type irc struct {
216217
server string
217218
}
218219

219-
type tor struct {
220+
type onion struct {
220221
pvk string
221222

222223
localPort int
223224
remotePorts []int
225+
226+
disabled bool
224227
}
225228

226229
// NewOptions returns Options with default values.
@@ -313,10 +316,9 @@ func NewOptions() *Options {
313316
channel: defIRCChannel,
314317
server: defIRCServer,
315318
},
316-
tor: &tor{
317-
pvk: defTorPrivateKey,
318-
localPort: defTorLocalPort,
319-
remotePorts: defTorRemotePorts,
319+
onion: &onion{
320+
localPort: defOnionLocalPort,
321+
remotePorts: defOnionRemotePorts,
320322
},
321323
}
322324

@@ -664,20 +666,25 @@ func (o *Options) PublishToNostr() bool {
664666
return len(o.NostrRelayURL()) > 0 && o.NostrPrivateKey() != ""
665667
}
666668

667-
// TorPrivKey returns the private key of Tor service.
668-
func (o *Options) TorPrivKey() string {
669-
return o.tor.pvk
669+
// OnionPrivKey returns the private key of Onion service.
670+
func (o *Options) OnionPrivKey() string {
671+
return o.onion.pvk
670672
}
671673

672-
// TorLocalPort returns the local port to a TCP listener on.
674+
// OnionLocalPort returns the local port to a TCP listener on.
673675
// This is ignored if `WAYBACK_LISTEN_ADDR` is set.
674-
func (o *Options) TorLocalPort() int {
675-
return o.tor.localPort
676+
func (o *Options) OnionLocalPort() int {
677+
return o.onion.localPort
678+
}
679+
680+
// OnionRemotePorts returns the remote ports to serve the Onion hidden service on.
681+
func (o *Options) OnionRemotePorts() []int {
682+
return o.onion.remotePorts
676683
}
677684

678-
// TorRemotePorts returns the remote ports to serve the Tor hidden service on.
679-
func (o *Options) TorRemotePorts() []int {
680-
return o.tor.remotePorts
685+
// OnionDisabled returns whether disable Onion service.
686+
func (o *Options) OnionDisabled() bool {
687+
return o.onion.disabled
681688
}
682689

683690
// ListenAddr returns the listen address for the HTTP server.

‎config/parser.go

+8-6
Original file line numberDiff line numberDiff line change
@@ -181,12 +181,14 @@ func (p *Parser) parseLines(lines []string) (err error) {
181181
p.opts.nostr.url = parseString(val, defNostrRelayURL)
182182
case "WAYBACK_NOSTR_PRIVATE_KEY":
183183
p.opts.nostr.privateKey = parseString(val, defNostrPrivateKey)
184-
case "WAYBACK_TOR_PRIVKEY":
185-
p.opts.tor.pvk = parseString(val, defTorPrivateKey)
186-
case "WAYBACK_TOR_LOCAL_PORT":
187-
p.opts.tor.localPort = parseInt(val, defTorLocalPort)
188-
case "WAYBACK_TOR_REMOTE_PORTS":
189-
p.opts.tor.remotePorts = parseIntList(val, defTorRemotePorts)
184+
case "WAYBACK_TOR_PRIVKEY", "WAYBACK_ONION_PRIVKEY":
185+
p.opts.onion.pvk = parseString(val, defOnionPrivateKey)
186+
case "WAYBACK_TOR_LOCAL_PORT", "WAYBACK_ONION_LOCAL_PORT":
187+
p.opts.onion.localPort = parseInt(val, defOnionLocalPort)
188+
case "WAYBACK_TOR_REMOTE_PORTS", "WAYBACK_ONION_REMOTE_PORTS":
189+
p.opts.onion.remotePorts = parseIntList(val, defOnionRemotePorts)
190+
case "WAYBACK_ONION_DISABLED":
191+
p.opts.onion.disabled = parseBool(val, defOnionDisabled)
190192
case "WAYBACK_POOLING_SIZE":
191193
p.opts.poolingSize = parseInt(val, defPoolingSize)
192194
case "WAYBACK_BOLT_PATH":

‎docs/changelog.md

+1
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
99

1010
### Added
1111
- Add docker-compose.yml ([#367](https://github.com/wabarc/wayback/pull/367))
12+
- Add option to disable onion service ([#372](https://github.com/wabarc/wayback/pull/372))
1213

1314
### Changed
1415
- Set NoWait to true for tor listen config ([#368](https://github.com/wabarc/wayback/pull/368))

‎docs/integrations/web.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ Wayback supports serving both **Clear Web** and **Onion Service**. If the Tor bi
1111
After installation, you need to provide the required keys by placing them in the environment or configuration file. This allows you to customize the configuration based on your needs.
1212

1313
- `WAYBACK_LISTEN_ADDR`: The listen address for the HTTP server, defaults to `0.0.0.0:8964`.
14-
- `WAYBACK_TOR_PRIVKEY`: The private key for Onion Service.
15-
- `WAYBACK_TOR_LOCAL_PORT`: Local port for Onion Service, also support for a reverse proxy. This is ignored if `WAYBACK_LISTEN_ADDR` is set.
16-
- `WAYBACK_TOR_REMOTE_PORTS`: Remote ports for Onion Service, e.g. `WAYBACK_TOR_REMOTE_PORTS=80,81`.
14+
- `WAYBACK_ONION_PRIVKEY`: The private key for Onion Service.
15+
- `WAYBACK_ONION_LOCAL_PORT`: Local port for Onion Service, also support for a reverse proxy. This is ignored if `WAYBACK_LISTEN_ADDR` is set.
16+
- `WAYBACK_ONION_REMOTE_PORTS`: Remote ports for Onion Service, e.g. `WAYBACK_ONION_REMOTE_PORTS=80,81`.
1717

1818
Note: To run a Onion Service for the first time, you need to keep the `private key`, which can be seen from the log output.

‎docs/integrations/web.zh.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ Wayback支持服务于**明文Web**和**Onion服务**。如果缺少Tor二进制
1111
安装完成后，您需要通过将其放置在环境或配置文件中来提供所需的密钥。这允许您根据需要自定义配置。
1212

1313
- `WAYBACK_LISTEN_ADDR`：HTTP服务器的侦听地址，默认为`0.0.0.0:8964`。
14-
- `WAYBACK_TOR_PRIVKEY`：Onion服务的私钥。
15-
- `WAYBACK_TOR_LOCAL_PORT`：Onion服务的本地端口，也支持反向代理。如果设置了`WAYBACK_LISTEN_ADDR`，则忽略此设置。
16-
- `WAYBACK_TOR_REMOTE_PORTS`：Onion服务的远程端口，例如`WAYBACK_TOR_REMOTE_PORTS=80,81`。
14+
- `WAYBACK_ONION_PRIVKEY`：Onion服务的私钥。
15+
- `WAYBACK_ONION_LOCAL_PORT`：Onion服务的本地端口，也支持反向代理。如果设置了`WAYBACK_LISTEN_ADDR`，则忽略此设置。
16+
- `WAYBACK_ONION_REMOTE_PORTS`：Onion服务的远程端口，例如`WAYBACK_ONION_REMOTE_PORTS=80,81`。
1717

1818
注意：要首次运行Onion服务，您需要保留`私钥`，该私钥可以从日志输出中看到。

‎docs/troubleshooting.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ This will disable JavaScript for the entire site `wikipedia.org` or only for the
1919

2020
When running the `wayback` service for the first time, it is important to keep the private key from the output message
2121
(the key is the part after `private key:`). The next time you run the wayback service, you can use the key by providing
22-
it to the `--tor-key` option or setting it as the `WAYBACK_TOR_PRIVKEY` environment variable.
22+
it to the `--tor-key` option or setting it as the `WAYBACK_ONION_PRIVKEY` environment variable.
2323

2424
```text
2525
[INFO] Web: Important: remember to keep the private key: d005473a611d2b23e54d6446dfe209cb6c52ddd698818d1233b1d750f790445fcfb5ece556fe5ee3b4724ac6bea7431898ee788c6011febba7f779c85845ae87

‎docs/troubleshooting.zh.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ export DISABLEJS_URIS=wikipedia.org|eff.org/tags
1414

1515
## 如何保留Tor隐藏服务主机名？
1616

17-
第一次运行`wayback`服务时，保留来自输出消息的私钥非常重要（私钥是`private key:`之后的部分）。下次运行wayback服务时，您可以通过将其提供给`--tor-key`选项或将其设置为`WAYBACK_TOR_PRIVKEY`环境变量来使用密钥。
17+
第一次运行`wayback`服务时，保留来自输出消息的私钥非常重要（私钥是`private key:`之后的部分）。下次运行wayback服务时，您可以通过将其提供给`--tor-key`选项或将其设置为`WAYBACK_ONION_PRIVKEY`环境变量来使用密钥。
1818

1919
```text
2020
[INFO] Web: Important: remember to keep the private key: d005473a611d2b23e54d6446dfe209cb6c52ddd698818d1233b1d750f790445fcfb5ece556fe5ee3b4724ac6bea7431898ee788c6011febba7f779c85845ae87

‎service/httpd/httpd.go

+5-5
Original file line numberDiff line numberDiff line change
@@ -54,8 +54,8 @@ func New(ctx context.Context, opts service.Options) *Httpd {
5454
}
5555

5656
// Serve accepts incoming HTTP requests over Tor network, or open
57-
// a local port for proxy server by "WAYBACK_TOR_LOCAL_PORT" env.
58-
// Use "WAYBACK_TOR_PRIVKEY" to keep the Tor hidden service hostname.
57+
// a local port for proxy server by "WAYBACK_ONION_LOCAL_PORT" env.
58+
// Use "WAYBACK_ONION_PRIVKEY" to keep the Tor hidden service hostname.
5959
//
6060
// Serve always returns an error.
6161
func (h *Httpd) Serve() error {
@@ -71,9 +71,9 @@ func (h *Httpd) Serve() error {
7171
}
7272

7373
switch {
74-
case torExist():
74+
case h.serveOnion():
7575
logger.Info("start a tor hidden server")
76-
err := h.startTorServer(server)
76+
err := h.startOnionService(server)
7777
if err != nil {
7878
return errors.Wrap(err, "start tor server failed")
7979
}
@@ -92,7 +92,7 @@ func (h *Httpd) Serve() error {
9292
return ErrServiceClosed
9393
}
9494

95-
// Shutdown shuts down the Tor server
95+
// Shutdown shuts down the httpd server
9696
func (h *Httpd) Shutdown() error {
9797
h.RLock()
9898
defer h.RUnlock()

‎service/httpd/libtor.go

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
// Copyright 2023 Wayback Archiver. All rights reserved.
2+
// Use of this source code is governed by the GNU GPL v3
3+
// license that can be found in the LICENSE file.
4+
5+
//go:build with_tor
6+
7+
package httpd // import "github.com/wabarc/wayback/service/httpd"
8+
9+
import (
10+
"github.com/cretz/bine/process"
11+
"github.com/ipsn/go-libtor"
12+
)
13+
14+
var creator process.Creator = libtor.Creator

‎service/httpd/libtor_stub.go

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
// Copyright 2023 Wayback Archiver. All rights reserved.
2+
// Use of this source code is governed by the GNU GPL v3
3+
// license that can be found in the LICENSE file.
4+
5+
//go:build !with_tor
6+
7+
package httpd // import "github.com/wabarc/wayback/service/httpd"
8+
9+
import (
10+
"github.com/cretz/bine/process"
11+
)
12+
13+
var creator process.Creator

0 commit comments

Comments
 (0)