kev
/
Onionr
1
0
Fork 0
Code Issues 24 Pull Requests Projects Releases 2 Wiki Activity
Onionr/docs/html/onionr/netcontroller/netcontrol.html

682 lines
30 KiB
HTML
Raw Normal View History

added auto generated api documentation
2019-09-23 23:20:14 +00:00
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
<meta name="generator" content="pdoc 0.6.3" />
<title>onionr.netcontroller.netcontrol API documentation</title>
<meta name="description" content="Onionr - Private P2P Communication …" />
<link href='https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.0/normalize.min.css' rel='stylesheet'>
<link href='https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/8.0.0/sanitize.min.css' rel='stylesheet'>
<link href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css" rel="stylesheet">
<style>.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:30px;overflow:hidden}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:1em 0 .50em 0}h3{font-size:1.4em;margin:25px 0 10px 0}h4{margin:0;font-size:105%}a{color:#058;text-decoration:none;transition:color .3s ease-in-out}a:hover{color:#e82}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900}pre code{background:#f8f8f8;font-size:.8em;line-height:1.4em}code{background:#f2f2f1;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{background:#f8f8f8;border:0;border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0;padding:1ex}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{font-weight:bold}#index h4 + ul{margin-bottom:.6em}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-weight:bold;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source summary{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase;cursor:pointer}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}.admonition{padding:.1em .5em;margin-bottom:1em}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.item .name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul{padding-left:1.5em}.toc > ul > li{margin-top:.5em}}</style>
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
</head>
<body>
<main>
<article id="content">
<header>
<h1 class="title">Module <code>onionr.netcontroller.netcontrol</code></h1>
</header>
<section id="section-intro">
<p>Onionr - Private P2P Communication</p>
<p>Netcontroller library, used to control/work with Tor/I2P and send requests through them</p>
<details class="source">
<summary>Source code</summary>
<pre><code class="python">&#39;&#39;&#39;
Onionr - Private P2P Communication
Netcontroller library, used to control/work with Tor/I2P and send requests through them
&#39;&#39;&#39;
&#39;&#39;&#39;
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see &lt;https://www.gnu.org/licenses/&gt;.
&#39;&#39;&#39;
import os, sys, base64, subprocess, signal, time
import platform # For windows sigkill workaround
import config, logger
from . import getopenport
from utils import identifyhome
config.reload()
TOR_KILL_WAIT = 3
def add_bridges(torrc: str)-&gt;str:
&#34;&#34;&#34;Configure tor to use a bridge using Onionr config keys&#34;&#34;&#34;
if config.get(&#39;tor.use_bridge&#39;, False) == True:
bridge = config.get(&#39;tor.bridge_ip&#39;, None)
if not bridge is None:
fingerprint = config.get(&#39;tor.bridge_fingerprint&#39;, &#39;&#39;) # allow blank fingerprint purposefully
torrc += &#39;\nUseBridges 1\nBridge %s %s\n&#39; % (bridge, fingerprint)
else:
logger.warn(&#39;bridge was enabled but not specified in config&#39;)
return torrc
class NetController:
&#39;&#39;&#39;
This class handles hidden service setup on Tor and I2P
&#39;&#39;&#39;
def __init__(self, hsPort, apiServerIP=&#39;127.0.0.1&#39;):
# set data dir
self.dataDir = identifyhome.identify_home()
self.torConfigLocation = self.dataDir + &#39;torrc&#39;
self.readyState = False
self.socksPort = getopenport.get_open_port()
self.hsPort = hsPort
self._torInstnace = &#39;&#39;
self.myID = &#39;&#39;
self.apiServerIP = apiServerIP
if os.path.exists(&#39;./tor&#39;):
self.torBinary = &#39;./tor&#39;
elif os.path.exists(&#39;/usr/bin/tor&#39;):
self.torBinary = &#39;/usr/bin/tor&#39;
else:
self.torBinary = &#39;tor&#39;
def generateTorrc(self):
&#39;&#39;&#39;
Generate a torrc file for our tor instance
&#39;&#39;&#39;
hsVer = &#39;# v2 onions&#39;
if config.get(&#39;tor.v3onions&#39;):
hsVer = &#39;HiddenServiceVersion 3&#39;
if os.path.exists(self.torConfigLocation):
os.remove(self.torConfigLocation)
# Set the Tor control password. Meant to make it harder to manipulate our Tor instance
plaintext = base64.b64encode(os.urandom(50)).decode()
config.set(&#39;tor.controlpassword&#39;, plaintext, savefile=True)
config.set(&#39;tor.socksport&#39;, self.socksPort, savefile=True)
controlPort = getopenport.get_open_port()
config.set(&#39;tor.controlPort&#39;, controlPort, savefile=True)
hashedPassword = subprocess.Popen([self.torBinary, &#39;--hash-password&#39;, plaintext], stdout=subprocess.PIPE, stderr=subprocess.PIPE)
for line in iter(hashedPassword.stdout.readline, b&#39;&#39;):
password = line.decode()
if &#39;warn&#39; not in password:
break
torrcData = &#39;&#39;&#39;SocksPort &#39;&#39;&#39; + str(self.socksPort) + &#39;&#39;&#39; OnionTrafficOnly
DataDirectory &#39;&#39;&#39; + self.dataDir + &#39;&#39;&#39;tordata/
CookieAuthentication 1
KeepalivePeriod 40
CircuitsAvailableTimeout 86400
ControlPort &#39;&#39;&#39; + str(controlPort) + &#39;&#39;&#39;
HashedControlPassword &#39;&#39;&#39; + str(password) + &#39;&#39;&#39;
&#39;&#39;&#39;
if config.get(&#39;general.security_level&#39;, 1) == 0:
torrcData += &#39;&#39;&#39;\nHiddenServiceDir &#39;&#39;&#39; + self.dataDir + &#39;&#39;&#39;hs/
\n&#39;&#39;&#39; + hsVer + &#39;&#39;&#39;\n
HiddenServiceNumIntroductionPoints 6
HiddenServiceMaxStreams 100
HiddenServiceMaxStreamsCloseCircuit 1
HiddenServicePort 80 &#39;&#39;&#39; + self.apiServerIP + &#39;&#39;&#39;:&#39;&#39;&#39; + str(self.hsPort)
torrcData = add_bridges(torrcData)
torrc = open(self.torConfigLocation, &#39;w&#39;)
torrc.write(torrcData)
torrc.close()
return
def startTor(self, gen_torrc=True):
&#39;&#39;&#39;
Start Tor with onion service on port 80 &amp; socks proxy on random port
&#39;&#39;&#39;
if gen_torrc:
self.generateTorrc()
if os.path.exists(&#39;./tor&#39;):
self.torBinary = &#39;./tor&#39;
elif os.path.exists(&#39;/usr/bin/tor&#39;):
self.torBinary = &#39;/usr/bin/tor&#39;
else:
self.torBinary = &#39;tor&#39;
try:
tor = subprocess.Popen([self.torBinary, &#39;-f&#39;, self.torConfigLocation], stdout=subprocess.PIPE, stderr=subprocess.PIPE)
except FileNotFoundError:
logger.fatal(&#34;Tor was not found in your path or the Onionr directory. Please install Tor and try again.&#34;, terminal=True)
sys.exit(1)
else:
# Test Tor Version
torVersion = subprocess.Popen([self.torBinary, &#39;--version&#39;], stdout=subprocess.PIPE, stderr=subprocess.PIPE)
for line in iter(torVersion.stdout.readline, b&#39;&#39;):
if &#39;Tor 0.2.&#39; in line.decode():
logger.fatal(&#39;Tor 0.3+ required&#39;, terminal=True)
sys.exit(1)
break
torVersion.kill()
# wait for tor to get to 100% bootstrap
try:
for line in iter(tor.stdout.readline, b&#39;&#39;):
if &#39;bootstrapped 100&#39; in line.decode().lower():
logger.info(line.decode())
break
elif &#39;opening socks listener&#39; in line.decode().lower():
logger.debug(line.decode().replace(&#39;\n&#39;, &#39;&#39;))
else:
logger.fatal(&#39;Failed to start Tor. Maybe a stray instance of Tor used by Onionr is still running? This can also be a result of file permissions being too open&#39;, terminal=True)
return False
except KeyboardInterrupt:
logger.fatal(&#39;Got keyboard interrupt. Onionr will exit soon.&#39;, timestamp = False, terminal=True)
return False
logger.info(&#39;Finished starting Tor.&#39;, terminal=True)
self.readyState = True
try:
myID = open(self.dataDir + &#39;hs/hostname&#39;, &#39;r&#39;)
self.myID = myID.read().replace(&#39;\n&#39;, &#39;&#39;)
myID.close()
except FileNotFoundError:
self.myID = &#34;&#34;
torPidFile = open(self.dataDir + &#39;torPid.txt&#39;, &#39;w&#39;)
torPidFile.write(str(tor.pid))
torPidFile.close()
return True
def killTor(self):
&#39;&#39;&#39;
Properly kill tor based on pid saved to file
&#39;&#39;&#39;
try:
pid = open(self.dataDir + &#39;torPid.txt&#39;, &#39;r&#39;)
pidN = pid.read()
pid.close()
except FileNotFoundError:
return
try:
int(pidN)
except:
return
try:
try:
os.kill(int(pidN), signal.SIGTERM)
except PermissionError:
# seems to happen on win 10
pass
os.remove(self.dataDir + &#39;torPid.txt&#39;)
except ProcessLookupError:
pass
except FileNotFoundError:
pass
try:
time.sleep(TOR_KILL_WAIT)
except KeyboardInterrupt:
pass
if &#39;windows&#39; == platform.system().lower():
os.system(&#39;taskkill /PID %s /F&#39; % (pidN,))
time.sleep(0.5)
return
try:
os.kill(int(pidN), signal.SIGKILL)
except (ProcessLookupError, PermissionError) as e:
pass</code></pre>
</details>
</section>
<section>
</section>
<section>
</section>
<section>
<h2 class="section-title" id="header-functions">Functions</h2>
<dl>
<dt id="onionr.netcontroller.netcontrol.add_bridges"><code class="name flex">
<span>def <span class="ident">add_bridges</span></span>(<span>torrc)</span>
</code></dt>
<dd>
<section class="desc"><p>Configure tor to use a bridge using Onionr config keys</p></section>
<details class="source">
<summary>Source code</summary>
<pre><code class="python">def add_bridges(torrc: str)-&gt;str:
&#34;&#34;&#34;Configure tor to use a bridge using Onionr config keys&#34;&#34;&#34;
if config.get(&#39;tor.use_bridge&#39;, False) == True:
bridge = config.get(&#39;tor.bridge_ip&#39;, None)
if not bridge is None:
fingerprint = config.get(&#39;tor.bridge_fingerprint&#39;, &#39;&#39;) # allow blank fingerprint purposefully
torrc += &#39;\nUseBridges 1\nBridge %s %s\n&#39; % (bridge, fingerprint)
else:
logger.warn(&#39;bridge was enabled but not specified in config&#39;)
return torrc</code></pre>
</details>
</dd>
</dl>
</section>
<section>
<h2 class="section-title" id="header-classes">Classes</h2>
<dl>
<dt id="onionr.netcontroller.netcontrol.NetController"><code class="flex name class">
<span>class <span class="ident">NetController</span></span>
<span>(</span><span>hsPort, apiServerIP='127.0.0.1')</span>
</code></dt>
<dd>
<section class="desc"><p>This class handles hidden service setup on Tor and I2P</p></section>
<details class="source">
<summary>Source code</summary>
<pre><code class="python">class NetController:
&#39;&#39;&#39;
This class handles hidden service setup on Tor and I2P
&#39;&#39;&#39;
def __init__(self, hsPort, apiServerIP=&#39;127.0.0.1&#39;):
# set data dir
self.dataDir = identifyhome.identify_home()
self.torConfigLocation = self.dataDir + &#39;torrc&#39;
self.readyState = False
self.socksPort = getopenport.get_open_port()
self.hsPort = hsPort
self._torInstnace = &#39;&#39;
self.myID = &#39;&#39;
self.apiServerIP = apiServerIP
if os.path.exists(&#39;./tor&#39;):
self.torBinary = &#39;./tor&#39;
elif os.path.exists(&#39;/usr/bin/tor&#39;):
self.torBinary = &#39;/usr/bin/tor&#39;
else:
self.torBinary = &#39;tor&#39;
def generateTorrc(self):
&#39;&#39;&#39;
Generate a torrc file for our tor instance
&#39;&#39;&#39;
hsVer = &#39;# v2 onions&#39;
if config.get(&#39;tor.v3onions&#39;):
hsVer = &#39;HiddenServiceVersion 3&#39;
if os.path.exists(self.torConfigLocation):
os.remove(self.torConfigLocation)
# Set the Tor control password. Meant to make it harder to manipulate our Tor instance
plaintext = base64.b64encode(os.urandom(50)).decode()
config.set(&#39;tor.controlpassword&#39;, plaintext, savefile=True)
config.set(&#39;tor.socksport&#39;, self.socksPort, savefile=True)
controlPort = getopenport.get_open_port()
config.set(&#39;tor.controlPort&#39;, controlPort, savefile=True)
hashedPassword = subprocess.Popen([self.torBinary, &#39;--hash-password&#39;, plaintext], stdout=subprocess.PIPE, stderr=subprocess.PIPE)
for line in iter(hashedPassword.stdout.readline, b&#39;&#39;):
password = line.decode()
if &#39;warn&#39; not in password:
break
torrcData = &#39;&#39;&#39;SocksPort &#39;&#39;&#39; + str(self.socksPort) + &#39;&#39;&#39; OnionTrafficOnly
DataDirectory &#39;&#39;&#39; + self.dataDir + &#39;&#39;&#39;tordata/
CookieAuthentication 1
KeepalivePeriod 40
CircuitsAvailableTimeout 86400
ControlPort &#39;&#39;&#39; + str(controlPort) + &#39;&#39;&#39;
HashedControlPassword &#39;&#39;&#39; + str(password) + &#39;&#39;&#39;
&#39;&#39;&#39;
if config.get(&#39;general.security_level&#39;, 1) == 0:
torrcData += &#39;&#39;&#39;\nHiddenServiceDir &#39;&#39;&#39; + self.dataDir + &#39;&#39;&#39;hs/
\n&#39;&#39;&#39; + hsVer + &#39;&#39;&#39;\n
HiddenServiceNumIntroductionPoints 6
HiddenServiceMaxStreams 100
HiddenServiceMaxStreamsCloseCircuit 1
HiddenServicePort 80 &#39;&#39;&#39; + self.apiServerIP + &#39;&#39;&#39;:&#39;&#39;&#39; + str(self.hsPort)
torrcData = add_bridges(torrcData)
torrc = open(self.torConfigLocation, &#39;w&#39;)
torrc.write(torrcData)
torrc.close()
return
def startTor(self, gen_torrc=True):
&#39;&#39;&#39;
Start Tor with onion service on port 80 &amp; socks proxy on random port
&#39;&#39;&#39;
if gen_torrc:
self.generateTorrc()
if os.path.exists(&#39;./tor&#39;):
self.torBinary = &#39;./tor&#39;
elif os.path.exists(&#39;/usr/bin/tor&#39;):
self.torBinary = &#39;/usr/bin/tor&#39;
else:
self.torBinary = &#39;tor&#39;
try:
tor = subprocess.Popen([self.torBinary, &#39;-f&#39;, self.torConfigLocation], stdout=subprocess.PIPE, stderr=subprocess.PIPE)
except FileNotFoundError:
logger.fatal(&#34;Tor was not found in your path or the Onionr directory. Please install Tor and try again.&#34;, terminal=True)
sys.exit(1)
else:
# Test Tor Version
torVersion = subprocess.Popen([self.torBinary, &#39;--version&#39;], stdout=subprocess.PIPE, stderr=subprocess.PIPE)
for line in iter(torVersion.stdout.readline, b&#39;&#39;):
if &#39;Tor 0.2.&#39; in line.decode():
logger.fatal(&#39;Tor 0.3+ required&#39;, terminal=True)
sys.exit(1)
break
torVersion.kill()
# wait for tor to get to 100% bootstrap
try:
for line in iter(tor.stdout.readline, b&#39;&#39;):
if &#39;bootstrapped 100&#39; in line.decode().lower():
logger.info(line.decode())
break
elif &#39;opening socks listener&#39; in line.decode().lower():
logger.debug(line.decode().replace(&#39;\n&#39;, &#39;&#39;))
else:
logger.fatal(&#39;Failed to start Tor. Maybe a stray instance of Tor used by Onionr is still running? This can also be a result of file permissions being too open&#39;, terminal=True)
return False
except KeyboardInterrupt:
logger.fatal(&#39;Got keyboard interrupt. Onionr will exit soon.&#39;, timestamp = False, terminal=True)
return False
logger.info(&#39;Finished starting Tor.&#39;, terminal=True)
self.readyState = True
try:
myID = open(self.dataDir + &#39;hs/hostname&#39;, &#39;r&#39;)
self.myID = myID.read().replace(&#39;\n&#39;, &#39;&#39;)
myID.close()
except FileNotFoundError:
self.myID = &#34;&#34;
torPidFile = open(self.dataDir + &#39;torPid.txt&#39;, &#39;w&#39;)
torPidFile.write(str(tor.pid))
torPidFile.close()
return True
def killTor(self):
&#39;&#39;&#39;
Properly kill tor based on pid saved to file
&#39;&#39;&#39;
try:
pid = open(self.dataDir + &#39;torPid.txt&#39;, &#39;r&#39;)
pidN = pid.read()
pid.close()
except FileNotFoundError:
return
try:
int(pidN)
except:
return
try:
try:
os.kill(int(pidN), signal.SIGTERM)
except PermissionError:
# seems to happen on win 10
pass
os.remove(self.dataDir + &#39;torPid.txt&#39;)
except ProcessLookupError:
pass
except FileNotFoundError:
pass
try:
time.sleep(TOR_KILL_WAIT)
except KeyboardInterrupt:
pass
if &#39;windows&#39; == platform.system().lower():
os.system(&#39;taskkill /PID %s /F&#39; % (pidN,))
time.sleep(0.5)
return
try:
os.kill(int(pidN), signal.SIGKILL)
except (ProcessLookupError, PermissionError) as e:
pass</code></pre>
</details>
<h3>Methods</h3>
<dl>
<dt id="onionr.netcontroller.netcontrol.NetController.generateTorrc"><code class="name flex">
<span>def <span class="ident">generateTorrc</span></span>(<span>self)</span>
</code></dt>
<dd>
<section class="desc"><p>Generate a torrc file for our tor instance</p></section>
<details class="source">
<summary>Source code</summary>
<pre><code class="python"> def generateTorrc(self):
&#39;&#39;&#39;
Generate a torrc file for our tor instance
&#39;&#39;&#39;
hsVer = &#39;# v2 onions&#39;
if config.get(&#39;tor.v3onions&#39;):
hsVer = &#39;HiddenServiceVersion 3&#39;
if os.path.exists(self.torConfigLocation):
os.remove(self.torConfigLocation)
# Set the Tor control password. Meant to make it harder to manipulate our Tor instance
plaintext = base64.b64encode(os.urandom(50)).decode()
config.set(&#39;tor.controlpassword&#39;, plaintext, savefile=True)
config.set(&#39;tor.socksport&#39;, self.socksPort, savefile=True)
controlPort = getopenport.get_open_port()
config.set(&#39;tor.controlPort&#39;, controlPort, savefile=True)
hashedPassword = subprocess.Popen([self.torBinary, &#39;--hash-password&#39;, plaintext], stdout=subprocess.PIPE, stderr=subprocess.PIPE)
for line in iter(hashedPassword.stdout.readline, b&#39;&#39;):
password = line.decode()
if &#39;warn&#39; not in password:
break
torrcData = &#39;&#39;&#39;SocksPort &#39;&#39;&#39; + str(self.socksPort) + &#39;&#39;&#39; OnionTrafficOnly
DataDirectory &#39;&#39;&#39; + self.dataDir + &#39;&#39;&#39;tordata/
CookieAuthentication 1
KeepalivePeriod 40
CircuitsAvailableTimeout 86400
ControlPort &#39;&#39;&#39; + str(controlPort) + &#39;&#39;&#39;
HashedControlPassword &#39;&#39;&#39; + str(password) + &#39;&#39;&#39;
&#39;&#39;&#39;
if config.get(&#39;general.security_level&#39;, 1) == 0:
torrcData += &#39;&#39;&#39;\nHiddenServiceDir &#39;&#39;&#39; + self.dataDir + &#39;&#39;&#39;hs/
\n&#39;&#39;&#39; + hsVer + &#39;&#39;&#39;\n
HiddenServiceNumIntroductionPoints 6
HiddenServiceMaxStreams 100
HiddenServiceMaxStreamsCloseCircuit 1
HiddenServicePort 80 &#39;&#39;&#39; + self.apiServerIP + &#39;&#39;&#39;:&#39;&#39;&#39; + str(self.hsPort)
torrcData = add_bridges(torrcData)
torrc = open(self.torConfigLocation, &#39;w&#39;)
torrc.write(torrcData)
torrc.close()
return</code></pre>
</details>
</dd>
<dt id="onionr.netcontroller.netcontrol.NetController.killTor"><code class="name flex">
<span>def <span class="ident">killTor</span></span>(<span>self)</span>
</code></dt>
<dd>
<section class="desc"><p>Properly kill tor based on pid saved to file</p></section>
<details class="source">
<summary>Source code</summary>
<pre><code class="python">def killTor(self):
&#39;&#39;&#39;
Properly kill tor based on pid saved to file
&#39;&#39;&#39;
try:
pid = open(self.dataDir + &#39;torPid.txt&#39;, &#39;r&#39;)
pidN = pid.read()
pid.close()
except FileNotFoundError:
return
try:
int(pidN)
except:
return
try:
try:
os.kill(int(pidN), signal.SIGTERM)
except PermissionError:
# seems to happen on win 10
pass
os.remove(self.dataDir + &#39;torPid.txt&#39;)
except ProcessLookupError:
pass
except FileNotFoundError:
pass
try:
time.sleep(TOR_KILL_WAIT)
except KeyboardInterrupt:
pass
if &#39;windows&#39; == platform.system().lower():
os.system(&#39;taskkill /PID %s /F&#39; % (pidN,))
time.sleep(0.5)
return
try:
os.kill(int(pidN), signal.SIGKILL)
except (ProcessLookupError, PermissionError) as e:
pass</code></pre>
</details>
</dd>
<dt id="onionr.netcontroller.netcontrol.NetController.startTor"><code class="name flex">
<span>def <span class="ident">startTor</span></span>(<span>self, gen_torrc=True)</span>
</code></dt>
<dd>
<section class="desc"><p>Start Tor with onion service on port 80 &amp; socks proxy on random port</p></section>
<details class="source">
<summary>Source code</summary>
<pre><code class="python">def startTor(self, gen_torrc=True):
&#39;&#39;&#39;
Start Tor with onion service on port 80 &amp; socks proxy on random port
&#39;&#39;&#39;
if gen_torrc:
self.generateTorrc()
if os.path.exists(&#39;./tor&#39;):
self.torBinary = &#39;./tor&#39;
elif os.path.exists(&#39;/usr/bin/tor&#39;):
self.torBinary = &#39;/usr/bin/tor&#39;
else:
self.torBinary = &#39;tor&#39;
try:
tor = subprocess.Popen([self.torBinary, &#39;-f&#39;, self.torConfigLocation], stdout=subprocess.PIPE, stderr=subprocess.PIPE)
except FileNotFoundError:
logger.fatal(&#34;Tor was not found in your path or the Onionr directory. Please install Tor and try again.&#34;, terminal=True)
sys.exit(1)
else:
# Test Tor Version
torVersion = subprocess.Popen([self.torBinary, &#39;--version&#39;], stdout=subprocess.PIPE, stderr=subprocess.PIPE)
for line in iter(torVersion.stdout.readline, b&#39;&#39;):
if &#39;Tor 0.2.&#39; in line.decode():
logger.fatal(&#39;Tor 0.3+ required&#39;, terminal=True)
sys.exit(1)
break
torVersion.kill()
# wait for tor to get to 100% bootstrap
try:
for line in iter(tor.stdout.readline, b&#39;&#39;):
if &#39;bootstrapped 100&#39; in line.decode().lower():
logger.info(line.decode())
break
elif &#39;opening socks listener&#39; in line.decode().lower():
logger.debug(line.decode().replace(&#39;\n&#39;, &#39;&#39;))
else:
logger.fatal(&#39;Failed to start Tor. Maybe a stray instance of Tor used by Onionr is still running? This can also be a result of file permissions being too open&#39;, terminal=True)
return False
except KeyboardInterrupt:
logger.fatal(&#39;Got keyboard interrupt. Onionr will exit soon.&#39;, timestamp = False, terminal=True)
return False
logger.info(&#39;Finished starting Tor.&#39;, terminal=True)
self.readyState = True
try:
myID = open(self.dataDir + &#39;hs/hostname&#39;, &#39;r&#39;)
self.myID = myID.read().replace(&#39;\n&#39;, &#39;&#39;)
myID.close()
except FileNotFoundError:
self.myID = &#34;&#34;
torPidFile = open(self.dataDir + &#39;torPid.txt&#39;, &#39;w&#39;)
torPidFile.write(str(tor.pid))
torPidFile.close()
return True</code></pre>
</details>
</dd>
</dl>
</dd>
</dl>
</section>
</article>
<nav id="sidebar">
<h1>Index</h1>
<div class="toc">
<ul></ul>
</div>
<ul id="index">
<li><h3>Super-module</h3>
<ul>
<li><code><a title="onionr.netcontroller" href="index.html">onionr.netcontroller</a></code></li>
</ul>
</li>
<li><h3><a href="#header-functions">Functions</a></h3>
<ul class="">
<li><code><a title="onionr.netcontroller.netcontrol.add_bridges" href="#onionr.netcontroller.netcontrol.add_bridges">add_bridges</a></code></li>
</ul>
</li>
<li><h3><a href="#header-classes">Classes</a></h3>
<ul>
<li>
<h4><code><a title="onionr.netcontroller.netcontrol.NetController" href="#onionr.netcontroller.netcontrol.NetController">NetController</a></code></h4>
<ul class="">
<li><code><a title="onionr.netcontroller.netcontrol.NetController.generateTorrc" href="#onionr.netcontroller.netcontrol.NetController.generateTorrc">generateTorrc</a></code></li>
<li><code><a title="onionr.netcontroller.netcontrol.NetController.killTor" href="#onionr.netcontroller.netcontrol.NetController.killTor">killTor</a></code></li>
<li><code><a title="onionr.netcontroller.netcontrol.NetController.startTor" href="#onionr.netcontroller.netcontrol.NetController.startTor">startTor</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</nav>
</main>
<footer id="footer">
<p>Generated by <a href="https://pdoc3.github.io/pdoc"><cite>pdoc</cite> 0.6.3</a>.</p>
</footer>
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad()</script>
</body>
</html>