Skip to content

Commit 8488973

Browse files
waybackarchiverwaybackarchiver
authored
Deprecate torrc configuration (#332)
* Deprecate torrc configuration * Update docs
1 parent 54a6fb3 commit 8488973

File tree

9 files changed

+6
-67
lines changed

9 files changed

+6
-67
lines changed

‎README.md

-1
Original file line numberDiff line numberDiff line change
@@ -286,7 +286,6 @@ You can also specify configuration options either via command flags or via envir
286286
| `--tor-key` | `WAYBACK_TOR_PRIVKEY` | - | The private key for Tor Hidden Service |
287287
| - | `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. |
288288
| - | `WAYBACK_TOR_REMOTE_PORTS` | `80` | Remote ports for Tor Hidden Service, e.g. `WAYBACK_TOR_REMOTE_PORTS=80,81` |
289-
| - | `WAYBACK_TORRC` | `/etc/tor/torrc` | Using `torrc` for Tor Hidden Service |
290289
| - | `WAYBACK_SLOT` | - | Pinning service for IPFS mode of pinner, see [ipfs-pinner](https://github.com/wabarc/ipfs-pinner#supported-pinning-services) |
291290
| - | `WAYBACK_APIKEY` | - | API key for pinning service |
292291
| - | `WAYBACK_SECRET` | - | API secret for pinning service |

‎config/config_test.go

-18
Original file line numberDiff line numberDiff line change
@@ -607,24 +607,6 @@ func TestTorRemotePorts(t *testing.T) {
607607
}
608608
}
609609

610-
func TestTorrcFile(t *testing.T) {
611-
os.Clearenv()
612-
os.Setenv("WAYBACK_TORRC", "/path/to/torrc")
613-
614-
parser := NewParser()
615-
opts, err := parser.ParseEnvironmentVariables()
616-
if err != nil {
617-
t.Fatalf(`Parsing environment variables failed: %v`, err)
618-
}
619-
620-
expected := `/path/to/torrc`
621-
got := opts.TorrcFile()
622-
623-
if got != expected {
624-
t.Fatalf(`Unexpected Set torrc file, got %v instead of %v`, got, expected)
625-
}
626-
}
627-
628610
func TestListenAddr(t *testing.T) {
629611
t.Parallel()
630612

‎config/options.go

-8
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,6 @@ const (
7575
defTorPrivateKey = ""
7676
defListenAddr = "0.0.0.0:8964"
7777
defTorLocalPort = 8964
78-
defTorrcFile = "/etc/tor/torrc"
7978

8079
defChromeRemoteAddr = ""
8180
defEnabledChromeRemote = false
@@ -222,7 +221,6 @@ type tor struct {
222221

223222
localPort int
224223
remotePorts []int
225-
torrcFile string
226224
}
227225

228226
// NewOptions returns Options with default values.
@@ -319,7 +317,6 @@ func NewOptions() *Options {
319317
pvk: defTorPrivateKey,
320318
localPort: defTorLocalPort,
321319
remotePorts: defTorRemotePorts,
322-
torrcFile: defTorrcFile,
323320
},
324321
}
325322

@@ -683,11 +680,6 @@ func (o *Options) TorRemotePorts() []int {
683680
return o.tor.remotePorts
684681
}
685682

686-
// TorrcFile returns path of the torrc file to set on start Tor Hidden Service.
687-
func (o *Options) TorrcFile() string {
688-
return o.tor.torrcFile
689-
}
690-
691683
// ListenAddr returns the listen address for the HTTP server.
692684
func (o *Options) ListenAddr() string {
693685
return o.listenAddr

‎config/parser.go

-2
Original file line numberDiff line numberDiff line change
@@ -187,8 +187,6 @@ func (p *Parser) parseLines(lines []string) (err error) {
187187
p.opts.tor.localPort = parseInt(val, defTorLocalPort)
188188
case "WAYBACK_TOR_REMOTE_PORTS":
189189
p.opts.tor.remotePorts = parseIntList(val, defTorRemotePorts)
190-
case "WAYBACK_TORRC":
191-
p.opts.tor.torrcFile = parseString(val, defTorrcFile)
192190
case "WAYBACK_POOLING_SIZE":
193191
p.opts.poolingSize = parseInt(val, defPoolingSize)
194192
case "WAYBACK_BOLT_PATH":

‎docs/changelog.md

+3
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
3838
- Fix semgrep scan workflow ([#312](https://github.com/wabarc/wayback/pull/312))
3939
- Fix terminal determination
4040

41+
### Removed
42+
- Deprecate torrc configuration ([#332](https://github.com/wabarc/wayback/pull/332))
43+
4144
## [0.18.1] - 2022-10-30
4245

4346
### Fixed

‎docs/integrations/web.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: Interactive with Web Service
44

55
## How to build a Web Service
66

7-
Wayback supports serving both **Clear Web** and **Onion Service**. If the Tor binary or torrc file is missing, the Onion Service feature will be ignored.
7+
Wayback supports serving both **Clear Web** and **Onion Service**. If the Tor binary is missing, the Onion Service feature will be ignored.
88

99
## Configuration
1010

@@ -14,6 +14,5 @@ After installation, you need to provide the required keys by placing them in the
1414
- `WAYBACK_TOR_PRIVKEY`: The private key for Onion Service.
1515
- `WAYBACK_TOR_LOCAL_PORT`: Local port for Onion Service, also support for a reverse proxy. This is ignored if `WAYBACK_LISTEN_ADDR` is set.
1616
- `WAYBACK_TOR_REMOTE_PORTS`: Remote ports for Onion Service, e.g. `WAYBACK_TOR_REMOTE_PORTS=80,81`.
17-
- `WAYBACK_TORRC`: Using torrc for Onion Service, defaults to `/etc/tor/torrc`.
1817

1918
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.

‎service/httpd/tor.go

+2-32
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@ import (
1212
"net/http"
1313
"os"
1414
"os/exec"
15-
"path/filepath"
1615
"time"
1716

1817
// "github.com/ipsn/go-libtor"
@@ -76,7 +75,7 @@ func (t *Tor) Serve() error {
7675
}
7776

7877
switch {
79-
case torExist() && t.torrc() != "":
78+
case torExist():
8079
logger.Info("start a tor hidden server")
8180
t.startTorServer(server)
8281
default:
@@ -109,19 +108,6 @@ func (t *Tor) Shutdown() error {
109108
return nil
110109
}
111110

112-
func (t *Tor) torrc() string {
113-
if t.opts.TorrcFile() == "" {
114-
return ""
115-
}
116-
if torPortBusy() {
117-
return ""
118-
}
119-
if _, err := os.Open(filepath.Clean(t.opts.TorrcFile())); err != nil {
120-
return ""
121-
}
122-
return t.opts.TorrcFile()
123-
}
124-
125111
func (t *Tor) startTorServer(server *http.Server) {
126112
var pvk ed25519.PrivateKey
127113
if t.opts.TorPrivKey() == "" {
@@ -141,7 +127,7 @@ func (t *Tor) startTorServer(server *http.Server) {
141127

142128
verbose := t.opts.HasDebugMode()
143129
// startConf := &tor.StartConf{ProcessCreator: libtor.Creator, DataDir: "tor-data"}
144-
startConf := &tor.StartConf{TorrcFile: t.torrc(), TempDataDirBase: os.TempDir()}
130+
startConf := &tor.StartConf{TempDataDirBase: os.TempDir()}
145131
if verbose {
146132
startConf.DebugWriter = os.Stdout
147133
} else {
@@ -193,22 +179,6 @@ func startHTTPServer(server *http.Server) {
193179
}
194180
}
195181

196-
func torPortBusy() bool {
197-
addr := net.JoinHostPort("127.0.0.1", "9050")
198-
conn, err := net.DialTimeout("tcp", addr, time.Second)
199-
if err != nil {
200-
logger.Warn("defaults tor port is idle")
201-
return false
202-
}
203-
if conn != nil {
204-
conn.Close()
205-
logger.Debug("defaults tor port is busy")
206-
return true
207-
}
208-
209-
return false
210-
}
211-
212182
func torExist() bool {
213183
if _, err := exec.LookPath("tor"); err != nil {
214184
return false

‎wayback.1

-3
Original file line numberDiff line numberDiff line change
@@ -276,9 +276,6 @@ Local port of Tor service. This is ignored if `WAYBACK_LISTEN_ADDR` is set.\&.
276276
.B WAYBACK_TOR_REMOTE_PORTS
277277
Remote ports of Tor hidden service, e.g. WAYBACK_TOR_REMOTE_PORTS=80,81\&.
278278
.TP
279-
.B WAYBACK_TORRC
280-
Using torrc for Tor Hidden Service. default: "/etc/tor/torrc"\&.
281-
.TP
282279
.B WAYBACK_SLOT
283280
Pinning service for IPFS mode of pinner, see
284281
.UR

‎wayback.conf

-1
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,6 @@ WAYBACK_USE_TOR=false
5252
WAYBACK_TOR_PRIVKEY=
5353
WAYBACK_TOR_LOCAL_PORT=8964
5454
WAYBACK_TOR_REMOTE_PORTS=80
55-
WAYBACK_TORRC=/etc/tor/torrc
5655
WAYBACK_LISTEN_ADDR=0.0.0.0:8964
5756
CHROME_REMOTE_ADDR=127.0.0.1:9222
5857
WAYBACK_POOLING_SIZE=3

0 commit comments

Comments
 (0)