idk/i2p.plugins.tor-updater
1
0
Fork 0
Code Issues 6 Pull Requests Actions Packages Projects Releases Wiki Activity

pages

Browse Source
This commit is contained in:
idk
2022-02-12 00:06:07 -05:00
parent cb18068ea4
commit d9945c4f52
5 changed files with 163 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
Makefile
View File

@ -134,7 +134,7 @@ early-release: clean linux windows version upload-linux upload-windows
release: clean all version upload-all
index: index-clearnet index-offline
index: index-clearnet index-offline index-usage
@echo "<!DOCTYPE html>" > index.html
@echo "<html>" >> index.html
@echo "<head>" >> index.html
@ -240,3 +240,14 @@ usagemd:
@echo '```' | tee -a USAGE.md
@echo "" | tee -a USAGE.md
index-usage:
@echo "<!DOCTYPE html>" > usage.html
@echo "<html>" >> usage.html
@echo "<head>" >> usage.html
@echo " <title>$(BINARY) - $(CONSOLEPOSTNAME)</title>" >> usage.html
@echo " <link rel=\"stylesheet\" type=\"text/css\" href =\"/style.css\" />" >> usage.html
@echo "</head>" >> usage.html
@echo "<body>" >> usage.html
pandoc USAGE.md >> usage.html
@echo "</body>" >> usage.html
@echo "</html>" >> usage.html

22
README.md
View File

@ -1,13 +1,19 @@
# i2p.plugins.tor-updater
A Tor package updater and runner as an I2P Plugin. This plugin is
usable on Windows and Linux for now. OSX support is planned soon.
usable on Windows, Linux, and OSX, as is the freestanding binary.
This also functions as a freestanding update for the Tor Browser
Bundle and is capable of configuring Tor Browser from the terminal
and updating it without running it, should the user choose to operate
this way.
Usage:
------
See [Usage](USAGE.md) for command-line usage.
[HTML version](usage.html)
Plugin:
-------
@ -23,9 +29,9 @@ Status:
![Screenshot 2](screenshot-console.png)
Linux: Usable, most things work.
Windows: Usable, most things work.
OSX: Unstable, untested, not usable, WIP.
Linux: Usable, everything implemented works.
Windows: Usable, everything implemented works.
OSX: Usable, everything implemented works.
Other systems are not targeted and should use a Tor binary built from source,
provided by TPO or, their prefered package management system and not this plugin.
@ -49,9 +55,9 @@ The plugin will not start a Tor instance if a SOCKS proxy is open on port 9050.
### Secondary Goals:
1. Launch Tor Browser
- Works on Linux, Windows, OSX with minor bugs
- Works on Linux, Windows, OSX
2. Configure and launch Tor browser for use with I2P
- Works on Linux, Windows, OSX with minor bugs
- Works on Linux, Windows, OSX
#### Optional Features I might add if there is interest
@ -63,6 +69,10 @@ The plugin will not start a Tor instance if a SOCKS proxy is open on port 9050.
- Not done
4. Use Bittorrent-over-I2P to download the Tor Browser software
- Not Done
5. Import libi2pd and offer the use of an embedded i2pd router.
- Not done.
6. Option to use BRB in a thread as an in-I2P replacement for `mibbit` IRC client.
- Not done.
### Usage as a Library

21
index.html
View File

@ -6,9 +6,10 @@
</head>
<body>
<h1 id="i2p.plugins.tor-updater">i2p.plugins.tor-updater</h1>
<p>A Tor package updater and runner as an I2P Plugin. This plugin is usable on Windows and Linux for now. OSX support is planned soon.</p>
<p>A Tor package updater and runner as an I2P Plugin. This plugin is usable on Windows, Linux, and OSX, as is the freestanding binary. This also functions as a freestanding update for the Tor Browser Bundle and is capable of configuring Tor Browser from the terminal and updating it without running it, should the user choose to operate this way.</p>
<h2 id="usage">Usage:</h2>
<p>See <a href="USAGE.md">Usage</a> for command-line usage.</p>
<p><a href="usage.html">HTML version</a></p>
<h2 id="plugin">Plugin:</h2>
<ul>
<li><a href="i2p.plugins.tor-manager-linux-386.su3">i2p.plugins.tor-manager-linux-386</a></li>
@ -22,7 +23,7 @@
<figure>
<img src="screenshot-console.png" alt="" /><figcaption>Screenshot 2</figcaption>
</figure>
<p>Linux: Usable, most things work. Windows: Usable, most things work. OSX: Unstable, untested, not usable, WIP.</p>
<p>Linux: Usable, everything implemented works. Windows: Usable, everything implemented works. OSX: Usable, everything implemented works.</p>
<p>Other systems are not targeted and should use a Tor binary built from source, provided by TPO or, their prefered package management system and not this plugin. The plugin will not start a Tor instance if a SOCKS proxy is open on port 9050.</p>
<figure>
<img src="screenshot-i2pbrowser.png" alt="" /><figcaption>Screenshot</figcaption>
@ -63,13 +64,13 @@
<li>Launch Tor Browser</li>
</ol>
<ul>
<li>Works on Linux, Windows, OSX with minor bugs</li>
<li>Works on Linux, Windows, OSX</li>
</ul>
<ol start="2" type="1">
<li>Configure and launch Tor browser for use with I2P</li>
</ol>
<ul>
<li>Works on Linux, Windows, OSX with minor bugs</li>
<li>Works on Linux, Windows, OSX</li>
</ul>
<h4 id="optional-features-i-might-add-if-there-is-interest">Optional Features I might add if there is interest</h4>
<ol type="1">
@ -96,6 +97,18 @@
<ul>
<li>Not Done</li>
</ul>
<ol start="5" type="1">
<li>Import libi2pd and offer the use of an embedded i2pd router.</li>
</ol>
<ul>
<li>Not done.</li>
</ul>
<ol start="6" type="1">
<li>Option to use BRB in a thread as an in-I2P replacement for <code>mibbit</code> IRC client.</li>
</ol>
<ul>
<li>Not done.</li>
</ul>
<h3 id="usage-as-a-library">Usage as a Library</h3>
<p><a href="https://pkg.go.dev/i2pgit.org/idk/i2p.plugins.tor-manager">More information at the GoDoc</a></p>
<p>This is also useful as a library for downloading a Tor Browser Bundle. This API isn’t really stable, more “stabilizing.” Feel free to use it, but it may still change a little.</p>

6
supervise/supervise.go
View File

@ -257,7 +257,7 @@ func (s *Supervisor) RunTBWithLang() error {
bcmd.Dir = s.UnpackPath
bcmd.Stdout = os.Stdout
bcmd.Stderr = os.Stderr
defer bcmd.Process.Kill()
return bcmd.Run()
case "win":
log.Println("Running Windows EXE", s.TBDirectory(), "firefox.exe")
@ -304,7 +304,7 @@ func (s *Supervisor) RunTBHelpWithLang() error {
bcmd.Stdout = os.Stdout
bcmd.Stderr = os.Stderr
bcmd.Dir = s.TBDirectory()
defer bcmd.Process.Kill()
return bcmd.Run()
case "win":
log.Println("Running Windows EXE", s.TBDirectory(), "firefox.exe")
@ -501,7 +501,7 @@ func (s *Supervisor) RunTBBWithOfflineClearnetProfile(profiledata string, offlin
bcmd.Dir = profiledata
bcmd.Stdout = os.Stdout
bcmd.Stderr = os.Stderr
defer bcmd.Process.Kill()
return bcmd.Run()
case "win":
args := []string{"--profile", profiledata, defaultpage}

115
usage.html Normal file
View File

@ -0,0 +1,115 @@
<!DOCTYPE html>
<html>
<head>
<title>i2p.plugins.tor-manager - Tor Binary Manager</title>
<link rel="stylesheet" type="text/css" href ="/style.css" />
</head>
<body>
<h1 id="torand-sometimes-firefox-manager-for-i2p">Tor(And sometimes Firefox) Manager for I2P</h1>
<h2 id="usage-i2p.plugins.tor-manager-options">Usage: i2p.plugins.tor-manager [options]</h2>
<h3 id="options">Options:</h3>
<div class="sourceCode" id="cb1"><pre class="sourceCode sh"><code class="sourceCode bash"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true"></a><span class="ex">Usage</span>: i2p.plugins.tor-manager [options]</span>
<span id="cb1-2"><a href="#cb1-2" aria-hidden="true"></a></span>
<span id="cb1-3"><a href="#cb1-3" aria-hidden="true"></a><span class="ex">Downloads</span>, verifies and unpacks Tor Browser. Manages the Tor Browser</span>
<span id="cb1-4"><a href="#cb1-4" aria-hidden="true"></a><span class="ex">system</span> in environments where Tor is not in use.</span>
<span id="cb1-5"><a href="#cb1-5" aria-hidden="true"></a></span>
<span id="cb1-6"><a href="#cb1-6" aria-hidden="true"></a><span class="ex">Options</span>:</span>
<span id="cb1-7"><a href="#cb1-7" aria-hidden="true"></a></span>
<span id="cb1-8"><a href="#cb1-8" aria-hidden="true"></a><span class="ex">Usage</span> of ./i2p.plugins.tor-manager:</span>
<span id="cb1-9"><a href="#cb1-9" aria-hidden="true"></a> <span class="ex">-apparmor</span></span>
<span id="cb1-10"><a href="#cb1-10" aria-hidden="true"></a> <span class="ex">Generate</span> apparmor rules</span>
<span id="cb1-11"><a href="#cb1-11" aria-hidden="true"></a> <span class="ex">-arch</span> string</span>
<span id="cb1-12"><a href="#cb1-12" aria-hidden="true"></a> <span class="ex">OS/arch</span> to download (default <span class="st">&quot;64&quot;</span>)</span>
<span id="cb1-13"><a href="#cb1-13" aria-hidden="true"></a> <span class="ex">-bemirror</span></span>
<span id="cb1-14"><a href="#cb1-14" aria-hidden="true"></a> <span class="ex">Act</span> as an in-I2P mirror when you<span class="st">&#39;re done downloading</span></span>
<span id="cb1-15"><a href="#cb1-15" aria-hidden="true"></a><span class="st"> -directory string</span></span>
<span id="cb1-16"><a href="#cb1-16" aria-hidden="true"></a><span class="st"> Directory operate in</span></span>
<span id="cb1-17"><a href="#cb1-17" aria-hidden="true"></a><span class="st"> -help</span></span>
<span id="cb1-18"><a href="#cb1-18" aria-hidden="true"></a><span class="st"> Print help</span></span>
<span id="cb1-19"><a href="#cb1-19" aria-hidden="true"></a><span class="st"> -host string</span></span>
<span id="cb1-20"><a href="#cb1-20" aria-hidden="true"></a><span class="st"> Host to serve on (default &quot;127.0.0.1&quot;)</span></span>
<span id="cb1-21"><a href="#cb1-21" aria-hidden="true"></a><span class="st"> -i2pbrowser</span></span>
<span id="cb1-22"><a href="#cb1-22" aria-hidden="true"></a><span class="st"> Open I2P in Tor Browser</span></span>
<span id="cb1-23"><a href="#cb1-23" aria-hidden="true"></a><span class="st"> -i2pconfig</span></span>
<span id="cb1-24"><a href="#cb1-24" aria-hidden="true"></a><span class="st"> Open I2P routerconsole in Tor Browser with javscript enabled and non-routerconsole sites disabled</span></span>
<span id="cb1-25"><a href="#cb1-25" aria-hidden="true"></a><span class="st"> -lang string</span></span>
<span id="cb1-26"><a href="#cb1-26" aria-hidden="true"></a><span class="st"> Language to download</span></span>
<span id="cb1-27"><a href="#cb1-27" aria-hidden="true"></a><span class="st"> -offline</span></span>
<span id="cb1-28"><a href="#cb1-28" aria-hidden="true"></a><span class="st"> Work offline</span></span>
<span id="cb1-29"><a href="#cb1-29" aria-hidden="true"></a><span class="st"> -os string</span></span>
<span id="cb1-30"><a href="#cb1-30" aria-hidden="true"></a><span class="st"> OS/arch to download (default &quot;linux&quot;)</span></span>
<span id="cb1-31"><a href="#cb1-31" aria-hidden="true"></a><span class="st"> -port int</span></span>
<span id="cb1-32"><a href="#cb1-32" aria-hidden="true"></a><span class="st"> Port to serve on (default 7695)</span></span>
<span id="cb1-33"><a href="#cb1-33" aria-hidden="true"></a><span class="st"> -profile string</span></span>
<span id="cb1-34"><a href="#cb1-34" aria-hidden="true"></a><span class="st"> use a custom profile path, normally blank</span></span>
<span id="cb1-35"><a href="#cb1-35" aria-hidden="true"></a><span class="st"> -shortcuts</span></span>
<span id="cb1-36"><a href="#cb1-36" aria-hidden="true"></a><span class="st"> Create desktop shortcuts</span></span>
<span id="cb1-37"><a href="#cb1-37" aria-hidden="true"></a><span class="st"> -torbrowser</span></span>
<span id="cb1-38"><a href="#cb1-38" aria-hidden="true"></a><span class="st"> Open Tor Browser</span></span>
<span id="cb1-39"><a href="#cb1-39" aria-hidden="true"></a><span class="st"> -verbose</span></span>
<span id="cb1-40"><a href="#cb1-40" aria-hidden="true"></a><span class="st"> Verbose output</span></span>
<span id="cb1-41"><a href="#cb1-41" aria-hidden="true"></a><span class="st"> -watch-profiles string</span></span>
<span id="cb1-42"><a href="#cb1-42" aria-hidden="true"></a><span class="st"> Monitor and control these Firefox profiles. Temporarily Unused.</span></span>
<span id="cb1-43"><a href="#cb1-43" aria-hidden="true"></a><span class="st">Usage: ./firefox.real [ options ... ] [URL]</span></span>
<span id="cb1-44"><a href="#cb1-44" aria-hidden="true"></a><span class="st"> where options include:</span></span>
<span id="cb1-45"><a href="#cb1-45" aria-hidden="true"></a></span>
<span id="cb1-46"><a href="#cb1-46" aria-hidden="true"></a><span class="st">X11 options</span></span>
<span id="cb1-47"><a href="#cb1-47" aria-hidden="true"></a><span class="st"> --display=DISPLAY X display to use</span></span>
<span id="cb1-48"><a href="#cb1-48" aria-hidden="true"></a><span class="st"> --sync Make X calls synchronous</span></span>
<span id="cb1-49"><a href="#cb1-49" aria-hidden="true"></a><span class="st"> --g-fatal-warnings Make all warnings fatal</span></span>
<span id="cb1-50"><a href="#cb1-50" aria-hidden="true"></a></span>
<span id="cb1-51"><a href="#cb1-51" aria-hidden="true"></a><span class="st">Firefox options</span></span>
<span id="cb1-52"><a href="#cb1-52" aria-hidden="true"></a><span class="st"> -h or --help Print this message.</span></span>
<span id="cb1-53"><a href="#cb1-53" aria-hidden="true"></a><span class="st"> -v or --version Print Firefox version.</span></span>
<span id="cb1-54"><a href="#cb1-54" aria-hidden="true"></a><span class="st"> --full-version Print Firefox version, build and platform build ids.</span></span>
<span id="cb1-55"><a href="#cb1-55" aria-hidden="true"></a><span class="st"> -P &lt;profile&gt; Start with &lt;profile&gt;.</span></span>
<span id="cb1-56"><a href="#cb1-56" aria-hidden="true"></a><span class="st"> --profile &lt;path&gt; Start with profile at &lt;path&gt;.</span></span>
<span id="cb1-57"><a href="#cb1-57" aria-hidden="true"></a><span class="st"> --migration Start with migration wizard.</span></span>
<span id="cb1-58"><a href="#cb1-58" aria-hidden="true"></a><span class="st"> --ProfileManager Start with ProfileManager.</span></span>
<span id="cb1-59"><a href="#cb1-59" aria-hidden="true"></a><span class="st"> --no-remote (default) Do not accept or send remote commands; implies</span></span>
<span id="cb1-60"><a href="#cb1-60" aria-hidden="true"></a><span class="st"> --new-instance.</span></span>
<span id="cb1-61"><a href="#cb1-61" aria-hidden="true"></a><span class="st"> --allow-remote Accept and send remote commands.</span></span>
<span id="cb1-62"><a href="#cb1-62" aria-hidden="true"></a><span class="st"> --new-instance Open new instance, not a new window in running instance.</span></span>
<span id="cb1-63"><a href="#cb1-63" aria-hidden="true"></a><span class="st"> --safe-mode Disables extensions and themes for this session.</span></span>
<span id="cb1-64"><a href="#cb1-64" aria-hidden="true"></a><span class="st"> --MOZ_LOG=&lt;modules&gt; Treated as MOZ_LOG=&lt;modules&gt; environment variable,</span></span>
<span id="cb1-65"><a href="#cb1-65" aria-hidden="true"></a><span class="st"> overrides it.</span></span>
<span id="cb1-66"><a href="#cb1-66" aria-hidden="true"></a><span class="st"> --MOZ_LOG_FILE=&lt;file&gt; Treated as MOZ_LOG_FILE=&lt;file&gt; environment variable,</span></span>
<span id="cb1-67"><a href="#cb1-67" aria-hidden="true"></a><span class="st"> overrides it. If MOZ_LOG_FILE is not specified as an</span></span>
<span id="cb1-68"><a href="#cb1-68" aria-hidden="true"></a><span class="st"> argument or as an environment variable, logging will be</span></span>
<span id="cb1-69"><a href="#cb1-69" aria-hidden="true"></a><span class="st"> written to stdout.</span></span>
<span id="cb1-70"><a href="#cb1-70" aria-hidden="true"></a><span class="st"> --headless Run without a GUI.</span></span>
<span id="cb1-71"><a href="#cb1-71" aria-hidden="true"></a><span class="st"> --browser Open a browser window.</span></span>
<span id="cb1-72"><a href="#cb1-72" aria-hidden="true"></a><span class="st"> --new-window &lt;url&gt; Open &lt;url&gt; in a new window.</span></span>
<span id="cb1-73"><a href="#cb1-73" aria-hidden="true"></a><span class="st"> --new-tab &lt;url&gt; Open &lt;url&gt; in a new tab.</span></span>
<span id="cb1-74"><a href="#cb1-74" aria-hidden="true"></a><span class="st"> --private-window &lt;url&gt; Open &lt;url&gt; in a new private window.</span></span>
<span id="cb1-75"><a href="#cb1-75" aria-hidden="true"></a><span class="st"> --preferences Open Preferences dialog.</span></span>
<span id="cb1-76"><a href="#cb1-76" aria-hidden="true"></a><span class="st"> --screenshot [&lt;path&gt;] Save screenshot to &lt;path&gt; or in working directory.</span></span>
<span id="cb1-77"><a href="#cb1-77" aria-hidden="true"></a><span class="st"> --window-size width[,height] Width and optionally height of screenshot.</span></span>
<span id="cb1-78"><a href="#cb1-78" aria-hidden="true"></a><span class="st"> --search &lt;term&gt; Search &lt;term&gt; with your default search engine.</span></span>
<span id="cb1-79"><a href="#cb1-79" aria-hidden="true"></a><span class="st"> --setDefaultBrowser Set this app as the default browser.</span></span>
<span id="cb1-80"><a href="#cb1-80" aria-hidden="true"></a><span class="st"> --first-startup Run post-install actions before opening a new window.</span></span>
<span id="cb1-81"><a href="#cb1-81" aria-hidden="true"></a><span class="st"> --kiosk Start the browser in kiosk mode.</span></span>
<span id="cb1-82"><a href="#cb1-82" aria-hidden="true"></a><span class="st"> --jsconsole Open the Browser Console.</span></span>
<span id="cb1-83"><a href="#cb1-83" aria-hidden="true"></a><span class="st"> --jsdebugger [&lt;path&gt;] Open the Browser Toolbox. Defaults to the local build</span></span>
<span id="cb1-84"><a href="#cb1-84" aria-hidden="true"></a><span class="st"> but can be overridden by a firefox path.</span></span>
<span id="cb1-85"><a href="#cb1-85" aria-hidden="true"></a><span class="st"> --wait-for-jsdebugger Spin event loop until JS debugger connects.</span></span>
<span id="cb1-86"><a href="#cb1-86" aria-hidden="true"></a><span class="st"> Enables debugging (some) application startup code paths.</span></span>
<span id="cb1-87"><a href="#cb1-87" aria-hidden="true"></a><span class="st"> Only has an effect when `--jsdebugger` is also supplied.</span></span>
<span id="cb1-88"><a href="#cb1-88" aria-hidden="true"></a><span class="st"> --devtools Open DevTools on initial load.</span></span>
<span id="cb1-89"><a href="#cb1-89" aria-hidden="true"></a><span class="st"> --start-debugger-server [ws:][ &lt;port&gt; | &lt;path&gt; ] Start the devtools server on</span></span>
<span id="cb1-90"><a href="#cb1-90" aria-hidden="true"></a><span class="st"> a TCP port or Unix domain socket path. Defaults to TCP port</span></span>
<span id="cb1-91"><a href="#cb1-91" aria-hidden="true"></a><span class="st"> 6000. Use WebSocket protocol if ws: prefix is specified.</span></span>
<span id="cb1-92"><a href="#cb1-92" aria-hidden="true"></a><span class="st"> --recording &lt;file&gt; Record drawing for a given URL.</span></span>
<span id="cb1-93"><a href="#cb1-93" aria-hidden="true"></a><span class="st"> --recording-output &lt;file&gt; Specify destination file for a drawing recording.</span></span>
<span id="cb1-94"><a href="#cb1-94" aria-hidden="true"></a><span class="st"> --remote-debugging-port [&lt;port&gt;] Start the Firefox remote agent,</span></span>
<span id="cb1-95"><a href="#cb1-95" aria-hidden="true"></a><span class="st"> which is a low-level debugging interface based on the CDP protocol.</span></span>
<span id="cb1-96"><a href="#cb1-96" aria-hidden="true"></a><span class="st"> Defaults to listen on localhost:9222.</span></span>
<span id="cb1-97"><a href="#cb1-97" aria-hidden="true"></a></span>
<span id="cb1-98"><a href="#cb1-98" aria-hidden="true"></a><span class="st">Tor Browser Script Options</span></span>
<span id="cb1-99"><a href="#cb1-99" aria-hidden="true"></a><span class="st"> --verbose Display Tor and Firefox output in the terminal</span></span>
<span id="cb1-100"><a href="#cb1-100" aria-hidden="true"></a><span class="st"> --log [file] Record Tor and Firefox output in file (default: tor-browser.log)</span></span>
<span id="cb1-101"><a href="#cb1-101" aria-hidden="true"></a><span class="st"> --detach Detach from terminal and run Tor Browser in the background.</span></span>
<span id="cb1-102"><a href="#cb1-102" aria-hidden="true"></a><span class="st"> --register-app Register Tor Browser as a desktop app for this user</span></span>
<span id="cb1-103"><a href="#cb1-103" aria-hidden="true"></a><span class="st"> --unregister-app Unregister Tor Browser as a desktop app for this user</span></span></code></pre></div>
</body>
</html>