682 lines
30 KiB
HTML
682 lines
30 KiB
HTML
|
<!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">'''
|
||
|
|
Onionr - Private P2P Communication
|
||
|
|
|
||
|
|
Netcontroller library, used to control/work with Tor/I2P and send requests through them
|
||
|
|
'''
|
||
|
|
'''
|
||
|
|
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 <https://www.gnu.org/licenses/>.
|
||
|
|
'''
|
||
|
|
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)->str:
|
||
|
|
"""Configure tor to use a bridge using Onionr config keys"""
|
||
|
|
if config.get('tor.use_bridge', False) == True:
|
||
|
|
bridge = config.get('tor.bridge_ip', None)
|
||
|
|
if not bridge is None:
|
||
|
|
fingerprint = config.get('tor.bridge_fingerprint', '') # allow blank fingerprint purposefully
|
||
|
|
torrc += '\nUseBridges 1\nBridge %s %s\n' % (bridge, fingerprint)
|
||
|
|
else:
|
||
|
|
logger.warn('bridge was enabled but not specified in config')
|
||
|
|
|
||
|
|
return torrc
|
||
|
|
|
||
|
|
class NetController:
|
||
|
|
'''
|
||
|
|
This class handles hidden service setup on Tor and I2P
|
||
|
|
'''
|
||
|
|
|
||
|
|
def __init__(self, hsPort, apiServerIP='127.0.0.1'):
|
||
|
|
# set data dir
|
||
|
|
self.dataDir = identifyhome.identify_home()
|
||
|
|
|
||
|
|
self.torConfigLocation = self.dataDir + 'torrc'
|
||
|
|
self.readyState = False
|
||
|
|
self.socksPort = getopenport.get_open_port()
|
||
|
|
self.hsPort = hsPort
|
||
|
|
self._torInstnace = ''
|
||
|
|
self.myID = ''
|
||
|
|
self.apiServerIP = apiServerIP
|
||
|
|
|
||
|
|
if os.path.exists('./tor'):
|
||
|
|
self.torBinary = './tor'
|
||
|
|
elif os.path.exists('/usr/bin/tor'):
|
||
|
|
self.torBinary = '/usr/bin/tor'
|
||
|
|
else:
|
||
|
|
self.torBinary = 'tor'
|
||
|
|
|
||
|
|
def generateTorrc(self):
|
||
|
|
'''
|
||
|
|
Generate a torrc file for our tor instance
|
||
|
|
'''
|
||
|
|
hsVer = '# v2 onions'
|
||
|
|
if config.get('tor.v3onions'):
|
||
|
|
hsVer = 'HiddenServiceVersion 3'
|
||
|
|
|
||
|
|
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('tor.controlpassword', plaintext, savefile=True)
|
||
|
|
config.set('tor.socksport', self.socksPort, savefile=True)
|
||
|
|
|
||
|
|
controlPort = getopenport.get_open_port()
|
||
|
|
|
||
|
|
config.set('tor.controlPort', controlPort, savefile=True)
|
||
|
|
|
||
|
|
hashedPassword = subprocess.Popen([self.torBinary, '--hash-password', plaintext], stdout=subprocess.PIPE, stderr=subprocess.PIPE)
|
||
|
|
for line in iter(hashedPassword.stdout.readline, b''):
|
||
|
|
password = line.decode()
|
||
|
|
if 'warn' not in password:
|
||
|
|
break
|
||
|
|
|
||
|
|
torrcData = '''SocksPort ''' + str(self.socksPort) + ''' OnionTrafficOnly
|
||
|
|
DataDirectory ''' + self.dataDir + '''tordata/
|
||
|
|
CookieAuthentication 1
|
||
|
|
KeepalivePeriod 40
|
||
|
|
CircuitsAvailableTimeout 86400
|
||
|
|
ControlPort ''' + str(controlPort) + '''
|
||
|
|
HashedControlPassword ''' + str(password) + '''
|
||
|
|
'''
|
||
|
|
if config.get('general.security_level', 1) == 0:
|
||
|
|
torrcData += '''\nHiddenServiceDir ''' + self.dataDir + '''hs/
|
||
|
|
\n''' + hsVer + '''\n
|
||
|
|
HiddenServiceNumIntroductionPoints 6
|
||
|
|
HiddenServiceMaxStreams 100
|
||
|
|
HiddenServiceMaxStreamsCloseCircuit 1
|
||
|
|
HiddenServicePort 80 ''' + self.apiServerIP + ''':''' + str(self.hsPort)
|
||
|
|
|
||
|
|
torrcData = add_bridges(torrcData)
|
||
|
|
|
||
|
|
torrc = open(self.torConfigLocation, 'w')
|
||
|
|
torrc.write(torrcData)
|
||
|
|
torrc.close()
|
||
|
|
return
|
||
|
|
|
||
|
|
def startTor(self, gen_torrc=True):
|
||
|
|
'''
|
||
|
|
Start Tor with onion service on port 80 & socks proxy on random port
|
||
|
|
'''
|
||
|
|
if gen_torrc:
|
||
|
|
self.generateTorrc()
|
||
|
|
|
||
|
|
if os.path.exists('./tor'):
|
||
|
|
self.torBinary = './tor'
|
||
|
|
elif os.path.exists('/usr/bin/tor'):
|
||
|
|
self.torBinary = '/usr/bin/tor'
|
||
|
|
else:
|
||
|
|
self.torBinary = 'tor'
|
||
|
|
|
||
|
|
try:
|
||
|
|
tor = subprocess.Popen([self.torBinary, '-f', self.torConfigLocation], stdout=subprocess.PIPE, stderr=subprocess.PIPE)
|
||
|
|
except FileNotFoundError:
|
||
|
|
logger.fatal("Tor was not found in your path or the Onionr directory. Please install Tor and try again.", terminal=True)
|
||
|
|
sys.exit(1)
|
||
|
|
else:
|
||
|
|
# Test Tor Version
|
||
|
|
torVersion = subprocess.Popen([self.torBinary, '--version'], stdout=subprocess.PIPE, stderr=subprocess.PIPE)
|
||
|
|
for line in iter(torVersion.stdout.readline, b''):
|
||
|
|
if 'Tor 0.2.' in line.decode():
|
||
|
|
logger.fatal('Tor 0.3+ required', 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''):
|
||
|
|
if 'bootstrapped 100' in line.decode().lower():
|
||
|
|
logger.info(line.decode())
|
||
|
|
break
|
||
|
|
elif 'opening socks listener' in line.decode().lower():
|
||
|
|
logger.debug(line.decode().replace('\n', ''))
|
||
|
|
else:
|
||
|
|
logger.fatal('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', terminal=True)
|
||
|
|
return False
|
||
|
|
except KeyboardInterrupt:
|
||
|
|
logger.fatal('Got keyboard interrupt. Onionr will exit soon.', timestamp = False, terminal=True)
|
||
|
|
return False
|
||
|
|
|
||
|
|
logger.info('Finished starting Tor.', terminal=True)
|
||
|
|
|
||
|
|
self.readyState = True
|
||
|
|
|
||
|
|
try:
|
||
|
|
myID = open(self.dataDir + 'hs/hostname', 'r')
|
||
|
|
self.myID = myID.read().replace('\n', '')
|
||
|
|
myID.close()
|
||
|
|
except FileNotFoundError:
|
||
|
|
self.myID = ""
|
||
|
|
|
||
|
|
torPidFile = open(self.dataDir + 'torPid.txt', 'w')
|
||
|
|
torPidFile.write(str(tor.pid))
|
||
|
|
torPidFile.close()
|
||
|
|
|
||
|
|
return True
|
||
|
|
|
||
|
|
def killTor(self):
|
||
|
|
'''
|
||
|
|
Properly kill tor based on pid saved to file
|
||
|
|
'''
|
||
|
|
|
||
|
|
try:
|
||
|
|
pid = open(self.dataDir + 'torPid.txt', 'r')
|
||
|
|
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 + 'torPid.txt')
|
||
|
|
except ProcessLookupError:
|
||
|
|
pass
|
||
|
|
except FileNotFoundError:
|
||
|
|
pass
|
||
|
|
|
||
|
|
try:
|
||
|
|
time.sleep(TOR_KILL_WAIT)
|
||
|
|
except KeyboardInterrupt:
|
||
|
|
pass
|
||
|
|
|
||
|
|
if 'windows' == platform.system().lower():
|
||
|
|
os.system('taskkill /PID %s /F' % (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)->str:
|
||
|
|
"""Configure tor to use a bridge using Onionr config keys"""
|
||
|
|
if config.get('tor.use_bridge', False) == True:
|
||
|
|
bridge = config.get('tor.bridge_ip', None)
|
||
|
|
if not bridge is None:
|
||
|
|
fingerprint = config.get('tor.bridge_fingerprint', '') # allow blank fingerprint purposefully
|
||
|
|
torrc += '\nUseBridges 1\nBridge %s %s\n' % (bridge, fingerprint)
|
||
|
|
else:
|
||
|
|
logger.warn('bridge was enabled but not specified in config')
|
||
|
|
|
||
|
|
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:
|
||
|
|
'''
|
||
|
|
This class handles hidden service setup on Tor and I2P
|
||
|
|
'''
|
||
|
|
|
||
|
|
def __init__(self, hsPort, apiServerIP='127.0.0.1'):
|
||
|
|
# set data dir
|
||
|
|
self.dataDir = identifyhome.identify_home()
|
||
|
|
|
||
|
|
self.torConfigLocation = self.dataDir + 'torrc'
|
||
|
|
self.readyState = False
|
||
|
|
self.socksPort = getopenport.get_open_port()
|
||
|
|
self.hsPort = hsPort
|
||
|
|
self._torInstnace = ''
|
||
|
|
self.myID = ''
|
||
|
|
self.apiServerIP = apiServerIP
|
||
|
|
|
||
|
|
if os.path.exists('./tor'):
|
||
|
|
self.torBinary = './tor'
|
||
|
|
elif os.path.exists('/usr/bin/tor'):
|
||
|
|
self.torBinary = '/usr/bin/tor'
|
||
|
|
else:
|
||
|
|
self.torBinary = 'tor'
|
||
|
|
|
||
|
|
def generateTorrc(self):
|
||
|
|
'''
|
||
|
|
Generate a torrc file for our tor instance
|
||
|
|
'''
|
||
|
|
hsVer = '# v2 onions'
|
||
|
|
if config.get('tor.v3onions'):
|
||
|
|
hsVer = 'HiddenServiceVersion 3'
|
||
|
|
|
||
|
|
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('tor.controlpassword', plaintext, savefile=True)
|
||
|
|
config.set('tor.socksport', self.socksPort, savefile=True)
|
||
|
|
|
||
|
|
controlPort = getopenport.get_open_port()
|
||
|
|
|
||
|
|
config.set('tor.controlPort', controlPort, savefile=True)
|
||
|
|
|
||
|
|
hashedPassword = subprocess.Popen([self.torBinary, '--hash-password', plaintext], stdout=subprocess.PIPE, stderr=subprocess.PIPE)
|
||
|
|
for line in iter(hashedPassword.stdout.readline, b''):
|
||
|
|
password = line.decode()
|
||
|
|
if 'warn' not in password:
|
||
|
|
break
|
||
|
|
|
||
|
|
torrcData = '''SocksPort ''' + str(self.socksPort) + ''' OnionTrafficOnly
|
||
|
|
DataDirectory ''' + self.dataDir + '''tordata/
|
||
|
|
CookieAuthentication 1
|
||
|
|
KeepalivePeriod 40
|
||
|
|
CircuitsAvailableTimeout 86400
|
||
|
|
ControlPort ''' + str(controlPort) + '''
|
||
|
|
HashedControlPassword ''' + str(password) + '''
|
||
|
|
'''
|
||
|
|
if config.get('general.security_level', 1) == 0:
|
||
|
|
torrcData += '''\nHiddenServiceDir ''' + self.dataDir + '''hs/
|
||
|
|
\n''' + hsVer + '''\n
|
||
|
|
HiddenServiceNumIntroductionPoints 6
|
||
|
|
HiddenServiceMaxStreams 100
|
||
|
|
HiddenServiceMaxStreamsCloseCircuit 1
|
||
|
|
HiddenServicePort 80 ''' + self.apiServerIP + ''':''' + str(self.hsPort)
|
||
|
|
|
||
|
|
torrcData = add_bridges(torrcData)
|
||
|
|
|
||
|
|
torrc = open(self.torConfigLocation, 'w')
|
||
|
|
torrc.write(torrcData)
|
||
|
|
torrc.close()
|
||
|
|
return
|
||
|
|
|
||
|
|
def startTor(self, gen_torrc=True):
|
||
|
|
'''
|
||
|
|
Start Tor with onion service on port 80 & socks proxy on random port
|
||
|
|
'''
|
||
|
|
if gen_torrc:
|
||
|
|
self.generateTorrc()
|
||
|
|
|
||
|
|
if os.path.exists('./tor'):
|
||
|
|
self.torBinary = './tor'
|
||
|
|
elif os.path.exists('/usr/bin/tor'):
|
||
|
|
self.torBinary = '/usr/bin/tor'
|
||
|
|
else:
|
||
|
|
self.torBinary = 'tor'
|
||
|
|
|
||
|
|
try:
|
||
|
|
tor = subprocess.Popen([self.torBinary, '-f', self.torConfigLocation], stdout=subprocess.PIPE, stderr=subprocess.PIPE)
|
||
|
|
except FileNotFoundError:
|
||
|
|
logger.fatal("Tor was not found in your path or the Onionr directory. Please install Tor and try again.", terminal=True)
|
||
|
|
sys.exit(1)
|
||
|
|
else:
|
||
|
|
# Test Tor Version
|
||
|
|
torVersion = subprocess.Popen([self.torBinary, '--version'], stdout=subprocess.PIPE, stderr=subprocess.PIPE)
|
||
|
|
for line in iter(torVersion.stdout.readline, b''):
|
||
|
|
if 'Tor 0.2.' in line.decode():
|
||
|
|
logger.fatal('Tor 0.3+ required', 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''):
|
||
|
|
if 'bootstrapped 100' in line.decode().lower():
|
||
|
|
logger.info(line.decode())
|
||
|
|
break
|
||
|
|
elif 'opening socks listener' in line.decode().lower():
|
||
|
|
logger.debug(line.decode().replace('\n', ''))
|
||
|
|
else:
|
||
|
|
logger.fatal('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', terminal=True)
|
||
|
|
return False
|
||
|
|
except KeyboardInterrupt:
|
||
|
|
logger.fatal('Got keyboard interrupt. Onionr will exit soon.', timestamp = False, terminal=True)
|
||
|
|
return False
|
||
|
|
|
||
|
|
logger.info('Finished starting Tor.', terminal=True)
|
||
|
|
|
||
|
|
self.readyState = True
|
||
|
|
|
||
|
|
try:
|
||
|
|
myID = open(self.dataDir + 'hs/hostname', 'r')
|
||
|
|
self.myID = myID.read().replace('\n', '')
|
||
|
|
myID.close()
|
||
|
|
except FileNotFoundError:
|
||
|
|
self.myID = ""
|
||
|
|
|
||
|
|
torPidFile = open(self.dataDir + 'torPid.txt', 'w')
|
||
|
|
torPidFile.write(str(tor.pid))
|
||
|
|
torPidFile.close()
|
||
|
|
|
||
|
|
return True
|
||
|
|
|
||
|
|
def killTor(self):
|
||
|
|
'''
|
||
|
|
Properly kill tor based on pid saved to file
|
||
|
|
'''
|
||
|
|
|
||
|
|
try:
|
||
|
|
pid = open(self.dataDir + 'torPid.txt', 'r')
|
||
|
|
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 + 'torPid.txt')
|
||
|
|
except ProcessLookupError:
|
||
|
|
pass
|
||
|
|
except FileNotFoundError:
|
||
|
|
pass
|
||
|
|
|
||
|
|
try:
|
||
|
|
time.sleep(TOR_KILL_WAIT)
|
||
|
|
except KeyboardInterrupt:
|
||
|
|
pass
|
||
|
|
|
||
|
|
if 'windows' == platform.system().lower():
|
||
|
|
os.system('taskkill /PID %s /F' % (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):
|
||
|
|
'''
|
||
|
|
Generate a torrc file for our tor instance
|
||
|
|
'''
|
||
|
|
hsVer = '# v2 onions'
|
||
|
|
if config.get('tor.v3onions'):
|
||
|
|
hsVer = 'HiddenServiceVersion 3'
|
||
|
|
|
||
|
|
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('tor.controlpassword', plaintext, savefile=True)
|
||
|
|
config.set('tor.socksport', self.socksPort, savefile=True)
|
||
|
|
|
||
|
|
controlPort = getopenport.get_open_port()
|
||
|
|
|
||
|
|
config.set('tor.controlPort', controlPort, savefile=True)
|
||
|
|
|
||
|
|
hashedPassword = subprocess.Popen([self.torBinary, '--hash-password', plaintext], stdout=subprocess.PIPE, stderr=subprocess.PIPE)
|
||
|
|
for line in iter(hashedPassword.stdout.readline, b''):
|
||
|
|
password = line.decode()
|
||
|
|
if 'warn' not in password:
|
||
|
|
break
|
||
|
|
|
||
|
|
torrcData = '''SocksPort ''' + str(self.socksPort) + ''' OnionTrafficOnly
|
||
|
|
DataDirectory ''' + self.dataDir + '''tordata/
|
||
|
|
CookieAuthentication 1
|
||
|
|
KeepalivePeriod 40
|
||
|
|
CircuitsAvailableTimeout 86400
|
||
|
|
ControlPort ''' + str(controlPort) + '''
|
||
|
|
HashedControlPassword ''' + str(password) + '''
|
||
|
|
'''
|
||
|
|
if config.get('general.security_level', 1) == 0:
|
||
|
|
torrcData += '''\nHiddenServiceDir ''' + self.dataDir + '''hs/
|
||
|
|
\n''' + hsVer + '''\n
|
||
|
|
HiddenServiceNumIntroductionPoints 6
|
||
|
|
HiddenServiceMaxStreams 100
|
||
|
|
HiddenServiceMaxStreamsCloseCircuit 1
|
||
|
|
HiddenServicePort 80 ''' + self.apiServerIP + ''':''' + str(self.hsPort)
|
||
|
|
|
||
|
|
torrcData = add_bridges(torrcData)
|
||
|
|
|
||
|
|
torrc = open(self.torConfigLocation, 'w')
|
||
|
|
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):
|
||
|
|
'''
|
||
|
|
Properly kill tor based on pid saved to file
|
||
|
|
'''
|
||
|
|
|
||
|
|
try:
|
||
|
|
pid = open(self.dataDir + 'torPid.txt', 'r')
|
||
|
|
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 + 'torPid.txt')
|
||
|
|
except ProcessLookupError:
|
||
|
|
pass
|
||
|
|
except FileNotFoundError:
|
||
|
|
pass
|
||
|
|
|
||
|
|
try:
|
||
|
|
time.sleep(TOR_KILL_WAIT)
|
||
|
|
except KeyboardInterrupt:
|
||
|
|
pass
|
||
|
|
|
||
|
|
if 'windows' == platform.system().lower():
|
||
|
|
os.system('taskkill /PID %s /F' % (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 & socks proxy on random port</p></section>
|
||
|
|
<details class="source">
|
||
|
|
<summary>Source code</summary>
|
||
|
|
<pre><code class="python">def startTor(self, gen_torrc=True):
|
||
|
|
'''
|
||
|
|
Start Tor with onion service on port 80 & socks proxy on random port
|
||
|
|
'''
|
||
|
|
if gen_torrc:
|
||
|
|
self.generateTorrc()
|
||
|
|
|
||
|
|
if os.path.exists('./tor'):
|
||
|
|
self.torBinary = './tor'
|
||
|
|
elif os.path.exists('/usr/bin/tor'):
|
||
|
|
self.torBinary = '/usr/bin/tor'
|
||
|
|
else:
|
||
|
|
self.torBinary = 'tor'
|
||
|
|
|
||
|
|
try:
|
||
|
|
tor = subprocess.Popen([self.torBinary, '-f', self.torConfigLocation], stdout=subprocess.PIPE, stderr=subprocess.PIPE)
|
||
|
|
except FileNotFoundError:
|
||
|
|
logger.fatal("Tor was not found in your path or the Onionr directory. Please install Tor and try again.", terminal=True)
|
||
|
|
sys.exit(1)
|
||
|
|
else:
|
||
|
|
# Test Tor Version
|
||
|
|
torVersion = subprocess.Popen([self.torBinary, '--version'], stdout=subprocess.PIPE, stderr=subprocess.PIPE)
|
||
|
|
for line in iter(torVersion.stdout.readline, b''):
|
||
|
|
if 'Tor 0.2.' in line.decode():
|
||
|
|
logger.fatal('Tor 0.3+ required', 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''):
|
||
|
|
if 'bootstrapped 100' in line.decode().lower():
|
||
|
|
logger.info(line.decode())
|
||
|
|
break
|
||
|
|
elif 'opening socks listener' in line.decode().lower():
|
||
|
|
logger.debug(line.decode().replace('\n', ''))
|
||
|
|
else:
|
||
|
|
logger.fatal('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', terminal=True)
|
||
|
|
return False
|
||
|
|
except KeyboardInterrupt:
|
||
|
|
logger.fatal('Got keyboard interrupt. Onionr will exit soon.', timestamp = False, terminal=True)
|
||
|
|
return False
|
||
|
|
|
||
|
|
logger.info('Finished starting Tor.', terminal=True)
|
||
|
|
|
||
|
|
self.readyState = True
|
||
|
|
|
||
|
|
try:
|
||
|
|
myID = open(self.dataDir + 'hs/hostname', 'r')
|
||
|
|
self.myID = myID.read().replace('\n', '')
|
||
|
|
myID.close()
|
||
|
|
except FileNotFoundError:
|
||
|
|
self.myID = ""
|
||
|
|
|
||
|
|
torPidFile = open(self.dataDir + 'torPid.txt', 'w')
|
||
|
|
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>
|