1066 lines
41 KiB
Python
Executable File
1066 lines
41 KiB
Python
Executable File
#!/usr/bin/env python3
|
|
'''
|
|
Onionr - P2P Anonymous Storage Network
|
|
|
|
Onionr is the name for both the protocol and the original/reference software.
|
|
|
|
Run with 'help' for usage.
|
|
'''
|
|
'''
|
|
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 sys
|
|
MIN_PY_VERSION = 6
|
|
if sys.version_info[0] == 2 or sys.version_info[1] < MIN_PY_VERSION:
|
|
print('Error, Onionr requires Python 3.%s+' % (MIN_PY_VERSION,))
|
|
sys.exit(1)
|
|
import os, base64, random, getpass, shutil, time, platform, datetime, re, json, getpass, sqlite3
|
|
import webbrowser, uuid, signal
|
|
from threading import Thread
|
|
import api, core, config, logger, onionrplugins as plugins, onionrevents as events
|
|
import onionrutils
|
|
import netcontroller, onionrstorage
|
|
from netcontroller import NetController
|
|
from onionrblockapi import Block
|
|
import onionrproofs, onionrexceptions, communicator
|
|
from onionrusers import onionrusers
|
|
|
|
try:
|
|
from urllib3.contrib.socks import SOCKSProxyManager
|
|
except ImportError:
|
|
raise Exception("You need the PySocks module (for use with socks5 proxy to use Tor)")
|
|
|
|
ONIONR_TAGLINE = 'Anonymous P2P Platform - GPLv3 - https://Onionr.net'
|
|
ONIONR_VERSION = '0.5.0' # for debugging and stuff
|
|
ONIONR_VERSION_TUPLE = tuple(ONIONR_VERSION.split('.')) # (MAJOR, MINOR, VERSION)
|
|
API_VERSION = '5' # increments of 1; only change when something fundamental about how the API works changes. This way other nodes know how to communicate without learning too much information about you.
|
|
|
|
class Onionr:
|
|
def __init__(self):
|
|
'''
|
|
Main Onionr class. This is for the CLI program, and does not handle much of the logic.
|
|
In general, external programs and plugins should not use this class.
|
|
'''
|
|
self.userRunDir = os.getcwd() # Directory user runs the program from
|
|
self.killed = False
|
|
|
|
if sys.argv[0] == os.path.basename(__file__):
|
|
try:
|
|
os.chdir(sys.path[0])
|
|
except FileNotFoundError:
|
|
pass
|
|
|
|
try:
|
|
self.dataDir = os.environ['ONIONR_HOME']
|
|
if not self.dataDir.endswith('/'):
|
|
self.dataDir += '/'
|
|
except KeyError:
|
|
self.dataDir = 'data/'
|
|
|
|
# Load global configuration data
|
|
data_exists = Onionr.setupConfig(self.dataDir, self = self)
|
|
|
|
if netcontroller.torBinary() is None:
|
|
logger.error('Tor is not installed')
|
|
sys.exit(1)
|
|
|
|
self.communicatorInst = None
|
|
self.onionrCore = core.Core()
|
|
self.onionrCore.onionrInst = self
|
|
#self.deleteRunFiles()
|
|
self.onionrUtils = onionrutils.OnionrUtils(self.onionrCore)
|
|
|
|
self.clientAPIInst = '' # Client http api instance
|
|
self.publicAPIInst = '' # Public http api instance
|
|
|
|
signal.signal(signal.SIGTERM, self.exitSigterm)
|
|
|
|
# Handle commands
|
|
|
|
self.debug = False # Whole application debugging
|
|
|
|
# If data folder does not exist
|
|
if not data_exists:
|
|
if not os.path.exists(self.dataDir + 'blocks/'):
|
|
os.mkdir(self.dataDir + 'blocks/')
|
|
|
|
# Copy default plugins into plugins folder
|
|
if not os.path.exists(plugins.get_plugins_folder()):
|
|
if os.path.exists('static-data/default-plugins/'):
|
|
names = [f for f in os.listdir("static-data/default-plugins/") if not os.path.isfile(f)]
|
|
shutil.copytree('static-data/default-plugins/', plugins.get_plugins_folder())
|
|
|
|
# Enable plugins
|
|
for name in names:
|
|
if not name in plugins.get_enabled_plugins():
|
|
plugins.enable(name, self)
|
|
|
|
for name in plugins.get_enabled_plugins():
|
|
if not os.path.exists(plugins.get_plugin_data_folder(name)):
|
|
try:
|
|
os.mkdir(plugins.get_plugin_data_folder(name))
|
|
except:
|
|
plugins.disable(name, onionr = self, stop_event = False)
|
|
|
|
# Get configuration
|
|
if type(config.get('client.webpassword')) is type(None):
|
|
config.set('client.webpassword', base64.b16encode(os.urandom(32)).decode('utf-8'), savefile=True)
|
|
if type(config.get('client.client.port')) is type(None):
|
|
randomPort = netcontroller.getOpenPort()
|
|
config.set('client.client.port', randomPort, savefile=True)
|
|
if type(config.get('client.public.port')) is type(None):
|
|
randomPort = netcontroller.getOpenPort()
|
|
print(randomPort)
|
|
config.set('client.public.port', randomPort, savefile=True)
|
|
if type(config.get('client.participate')) is type(None):
|
|
config.set('client.participate', True, savefile=True)
|
|
if type(config.get('client.api_version')) is type(None):
|
|
config.set('client.api_version', API_VERSION, savefile=True)
|
|
|
|
self.cmds = {
|
|
'': self.showHelpSuggestion,
|
|
'help': self.showHelp,
|
|
'version': self.version,
|
|
'config': self.configure,
|
|
'start': self.start,
|
|
'stop': self.killDaemon,
|
|
'status': self.showStats,
|
|
'statistics': self.showStats,
|
|
'stats': self.showStats,
|
|
'details' : self.showDetails,
|
|
'detail' : self.showDetails,
|
|
'show-details' : self.showDetails,
|
|
'show-detail' : self.showDetails,
|
|
'showdetails' : self.showDetails,
|
|
'showdetail' : self.showDetails,
|
|
'get-details' : self.showDetails,
|
|
'get-detail' : self.showDetails,
|
|
'getdetails' : self.showDetails,
|
|
'getdetail' : self.showDetails,
|
|
|
|
'enable-plugin': self.enablePlugin,
|
|
'enplugin': self.enablePlugin,
|
|
'enableplugin': self.enablePlugin,
|
|
'enmod': self.enablePlugin,
|
|
'disable-plugin': self.disablePlugin,
|
|
'displugin': self.disablePlugin,
|
|
'disableplugin': self.disablePlugin,
|
|
'dismod': self.disablePlugin,
|
|
'reload-plugin': self.reloadPlugin,
|
|
'reloadplugin': self.reloadPlugin,
|
|
'reload-plugins': self.reloadPlugin,
|
|
'reloadplugins': self.reloadPlugin,
|
|
'create-plugin': self.createPlugin,
|
|
'createplugin': self.createPlugin,
|
|
'plugin-create': self.createPlugin,
|
|
|
|
'listkeys': self.listKeys,
|
|
'list-keys': self.listKeys,
|
|
|
|
'addpeer': self.addPeer,
|
|
'add-peer': self.addPeer,
|
|
'add-address': self.addAddress,
|
|
'add-addr': self.addAddress,
|
|
'addaddr': self.addAddress,
|
|
'addaddress': self.addAddress,
|
|
'list-peers': self.listPeers,
|
|
|
|
'blacklist-block': self.banBlock,
|
|
|
|
'add-file': self.addFile,
|
|
'addfile': self.addFile,
|
|
'addhtml': self.addWebpage,
|
|
'add-html': self.addWebpage,
|
|
'add-site': self.addWebpage,
|
|
'addsite': self.addWebpage,
|
|
|
|
'openhome': self.openHome,
|
|
'open-home': self.openHome,
|
|
|
|
'export-block': self.exportBlock,
|
|
'exportblock': self.exportBlock,
|
|
|
|
'get-file': self.getFile,
|
|
'getfile': self.getFile,
|
|
|
|
'listconn': self.listConn,
|
|
'list-conn': self.listConn,
|
|
|
|
'import-blocks': self.onionrUtils.importNewBlocks,
|
|
'importblocks': self.onionrUtils.importNewBlocks,
|
|
|
|
'introduce': self.onionrCore.introduceNode,
|
|
'connect': self.addAddress,
|
|
'pex': self.doPEX,
|
|
|
|
'getpassword': self.printWebPassword,
|
|
'get-password': self.printWebPassword,
|
|
'getpwd': self.printWebPassword,
|
|
'get-pwd': self.printWebPassword,
|
|
'getpass': self.printWebPassword,
|
|
'get-pass': self.printWebPassword,
|
|
'getpasswd': self.printWebPassword,
|
|
'get-passwd': self.printWebPassword,
|
|
|
|
'friend': self.friendCmd,
|
|
'add-id': self.addID,
|
|
'change-id': self.changeID
|
|
}
|
|
|
|
self.cmdhelp = {
|
|
'help': 'Displays this Onionr help menu',
|
|
'version': 'Displays the Onionr version',
|
|
'config': 'Configures something and adds it to the file',
|
|
|
|
'start': 'Starts the Onionr daemon',
|
|
'stop': 'Stops the Onionr daemon',
|
|
|
|
'stats': 'Displays node statistics',
|
|
'details': 'Displays the web password, public key, and human readable public key',
|
|
|
|
'enable-plugin': 'Enables and starts a plugin',
|
|
'disable-plugin': 'Disables and stops a plugin',
|
|
'reload-plugin': 'Reloads a plugin',
|
|
'create-plugin': 'Creates directory structure for a plugin',
|
|
|
|
'add-peer': 'Adds a peer to database',
|
|
'list-peers': 'Displays a list of peers',
|
|
'add-file': 'Create an Onionr block from a file',
|
|
'get-file': 'Get a file from Onionr blocks',
|
|
'import-blocks': 'import blocks from the disk (Onionr is transport-agnostic!)',
|
|
'listconn': 'list connected peers',
|
|
'pex': 'exchange addresses with peers (done automatically)',
|
|
'blacklist-block': 'deletes a block by hash and permanently removes it from your node',
|
|
'introduce': 'Introduce your node to the public Onionr network',
|
|
'friend': '[add|remove] [public key/id]',
|
|
'add-id': 'Generate a new ID (key pair)',
|
|
'change-id': 'Change active ID',
|
|
'open-home': 'Open your node\'s home/info screen'
|
|
}
|
|
|
|
# initialize plugins
|
|
events.event('init', onionr = self, threaded = False)
|
|
|
|
command = ''
|
|
try:
|
|
command = sys.argv[1].lower()
|
|
except IndexError:
|
|
command = ''
|
|
finally:
|
|
self.execute(command)
|
|
|
|
return
|
|
|
|
def exitSigterm(self, signum, frame):
|
|
self.killed = True
|
|
|
|
'''
|
|
THIS SECTION HANDLES THE COMMANDS
|
|
'''
|
|
|
|
def doExport(self, bHash):
|
|
exportDir = self.dataDir + 'block-export/'
|
|
if not os.path.exists(exportDir):
|
|
if os.path.exists(self.dataDir):
|
|
os.mkdir(exportDir)
|
|
else:
|
|
logger.error('Onionr Not initialized')
|
|
data = onionrstorage.getData(self.onionrCore, bHash)
|
|
with open('%s/%s.dat' % (exportDir, bHash), 'wb') as exportFile:
|
|
exportFile.write(data)
|
|
|
|
def exportBlock(self):
|
|
exportDir = self.dataDir + 'block-export/'
|
|
try:
|
|
assert self.onionrUtils.validateHash(sys.argv[2])
|
|
except (IndexError, AssertionError):
|
|
logger.error('No valid block hash specified.')
|
|
sys.exit(1)
|
|
else:
|
|
bHash = sys.argv[2]
|
|
self.doExport(bHash)
|
|
|
|
def showDetails(self):
|
|
details = {
|
|
'Node Address' : self.get_hostname(),
|
|
'Web Password' : self.getWebPassword(),
|
|
'Public Key' : self.onionrCore._crypto.pubKey,
|
|
'Human-readable Public Key' : self.onionrCore._utils.getHumanReadableID()
|
|
}
|
|
|
|
for detail in details:
|
|
logger.info('%s%s: \n%s%s\n' % (logger.colors.fg.lightgreen, detail, logger.colors.fg.green, details[detail]), sensitive = True)
|
|
|
|
def openHome(self):
|
|
try:
|
|
url = self.onionrUtils.getClientAPIServer()
|
|
except FileNotFoundError:
|
|
logger.error('Onionr seems to not be running (could not get api host)')
|
|
else:
|
|
webbrowser.open_new_tab('http://%s/#%s' % (url, config.get('client.webpassword')))
|
|
|
|
def addID(self):
|
|
try:
|
|
sys.argv[2]
|
|
assert sys.argv[2] == 'true'
|
|
except (IndexError, AssertionError) as e:
|
|
newID = self.onionrCore._crypto.keyManager.addKey()[0]
|
|
else:
|
|
logger.warn('Deterministic keys require random and long passphrases.')
|
|
logger.warn('If a good passphrase is not used, your key can be easily stolen.')
|
|
logger.warn('You should use a series of hard to guess words, see this for reference: https://www.xkcd.com/936/')
|
|
pass1 = getpass.getpass(prompt='Enter at least %s characters: ' % (self.onionrCore._crypto.deterministicRequirement,))
|
|
pass2 = getpass.getpass(prompt='Confirm entry: ')
|
|
if self.onionrCore._crypto.safeCompare(pass1, pass2):
|
|
try:
|
|
logger.info('Generating deterministic key. This can take a while.')
|
|
newID, privKey = self.onionrCore._crypto.generateDeterministic(pass1)
|
|
except onionrexceptions.PasswordStrengthError:
|
|
logger.error('Must use at least 25 characters.')
|
|
sys.exit(1)
|
|
else:
|
|
logger.error('Passwords do not match.')
|
|
sys.exit(1)
|
|
self.onionrCore._crypto.keyManager.addKey(pubKey=newID,
|
|
privKey=privKey)
|
|
logger.info('Added ID: %s' % (self.onionrUtils.bytesToStr(newID),))
|
|
|
|
def changeID(self):
|
|
try:
|
|
key = sys.argv[2]
|
|
except IndexError:
|
|
logger.error('Specify pubkey to use')
|
|
else:
|
|
if self.onionrUtils.validatePubKey(key):
|
|
if key in self.onionrCore._crypto.keyManager.getPubkeyList():
|
|
config.set('general.public_key', key)
|
|
config.save()
|
|
logger.info('Set active key to: %s' % (key,))
|
|
logger.info('Restart Onionr if it is running.')
|
|
else:
|
|
logger.error('That key does not exist')
|
|
else:
|
|
logger.error('Invalid key %s' % (key,))
|
|
|
|
def getCommands(self):
|
|
return self.cmds
|
|
|
|
def friendCmd(self):
|
|
'''List, add, or remove friend(s)
|
|
Changes their peer DB entry.
|
|
'''
|
|
friend = ''
|
|
try:
|
|
# Get the friend command
|
|
action = sys.argv[2]
|
|
except IndexError:
|
|
logger.info('Syntax: friend add/remove/list [address]')
|
|
else:
|
|
action = action.lower()
|
|
if action == 'list':
|
|
# List out peers marked as our friend
|
|
for friend in self.onionrCore.listPeers(randomOrder=False, trust=1):
|
|
if friend == self.onionrCore._crypto.pubKey: # do not list our key
|
|
continue
|
|
friendProfile = onionrusers.OnionrUser(self.onionrCore, friend)
|
|
logger.info(friend + ' - ' + friendProfile.getName())
|
|
elif action in ('add', 'remove'):
|
|
try:
|
|
friend = sys.argv[3]
|
|
if not self.onionrUtils.validatePubKey(friend):
|
|
raise onionrexceptions.InvalidPubkey('Public key is invalid')
|
|
if friend not in self.onionrCore.listPeers():
|
|
raise onionrexceptions.KeyNotKnown
|
|
friend = onionrusers.OnionrUser(self.onionrCore, friend)
|
|
except IndexError:
|
|
logger.error('Friend ID is required.')
|
|
except onionrexceptions.KeyNotKnown:
|
|
self.onionrCore.addPeer(friend)
|
|
friend = onionrusers.OnionrUser(self.onionrCore, friend)
|
|
finally:
|
|
if action == 'add':
|
|
friend.setTrust(1)
|
|
logger.info('Added %s as friend.' % (friend.publicKey,))
|
|
else:
|
|
friend.setTrust(0)
|
|
logger.info('Removed %s as friend.' % (friend.publicKey,))
|
|
else:
|
|
logger.info('Syntax: friend add/remove/list [address]')
|
|
|
|
def deleteRunFiles(self):
|
|
try:
|
|
os.remove(self.onionrCore.publicApiHostFile)
|
|
except FileNotFoundError:
|
|
pass
|
|
try:
|
|
os.remove(self.onionrCore.privateApiHostFile)
|
|
except FileNotFoundError:
|
|
pass
|
|
|
|
def deleteRunFiles(self):
|
|
try:
|
|
os.remove(self.onionrCore.publicApiHostFile)
|
|
except FileNotFoundError:
|
|
pass
|
|
try:
|
|
os.remove(self.onionrCore.privateApiHostFile)
|
|
except FileNotFoundError:
|
|
pass
|
|
|
|
def banBlock(self):
|
|
try:
|
|
ban = sys.argv[2]
|
|
except IndexError:
|
|
ban = logger.readline('Enter a block hash:')
|
|
if self.onionrUtils.validateHash(ban):
|
|
if not self.onionrCore._blacklist.inBlacklist(ban):
|
|
try:
|
|
self.onionrCore._blacklist.addToDB(ban)
|
|
self.onionrCore.removeBlock(ban)
|
|
except Exception as error:
|
|
logger.error('Could not blacklist block', error=error)
|
|
else:
|
|
logger.info('Block blacklisted')
|
|
else:
|
|
logger.warn('That block is already blacklisted')
|
|
else:
|
|
logger.error('Invalid block hash')
|
|
return
|
|
|
|
def listConn(self):
|
|
randID = str(uuid.uuid4())
|
|
self.onionrCore.daemonQueueAdd('connectedPeers', responseID=randID)
|
|
while True:
|
|
try:
|
|
time.sleep(3)
|
|
peers = self.onionrCore.daemonQueueGetResponse(randID)
|
|
except KeyboardInterrupt:
|
|
break
|
|
if not type(peers) is None:
|
|
if peers not in ('', 'failure', None):
|
|
if peers != False:
|
|
print(peers)
|
|
else:
|
|
print('Daemon probably not running. Unable to list connected peers.')
|
|
break
|
|
|
|
def listPeers(self):
|
|
logger.info('Peer transport address list:')
|
|
for i in self.onionrCore.listAdders():
|
|
logger.info(i)
|
|
|
|
def getWebPassword(self):
|
|
return config.get('client.webpassword')
|
|
|
|
def printWebPassword(self):
|
|
logger.info(self.getWebPassword(), sensitive = True)
|
|
|
|
def getHelp(self):
|
|
return self.cmdhelp
|
|
|
|
def addCommand(self, command, function):
|
|
self.cmds[str(command).lower()] = function
|
|
|
|
def addHelp(self, command, description):
|
|
self.cmdhelp[str(command).lower()] = str(description)
|
|
|
|
def delCommand(self, command):
|
|
return self.cmds.pop(str(command).lower(), None)
|
|
|
|
def delHelp(self, command):
|
|
return self.cmdhelp.pop(str(command).lower(), None)
|
|
|
|
def configure(self):
|
|
'''
|
|
Displays something from the configuration file, or sets it
|
|
'''
|
|
|
|
if len(sys.argv) >= 4:
|
|
config.reload()
|
|
config.set(sys.argv[2], sys.argv[3], True)
|
|
logger.debug('Configuration file updated.')
|
|
elif len(sys.argv) >= 3:
|
|
config.reload()
|
|
logger.info(logger.colors.bold + sys.argv[2] + ': ' + logger.colors.reset + str(config.get(sys.argv[2], logger.colors.fg.red + 'Not set.')))
|
|
else:
|
|
logger.info(logger.colors.bold + 'Get a value: ' + logger.colors.reset + sys.argv[0] + ' ' + sys.argv[1] + ' <key>')
|
|
logger.info(logger.colors.bold + 'Set a value: ' + logger.colors.reset + sys.argv[0] + ' ' + sys.argv[1] + ' <key> <value>')
|
|
|
|
|
|
def execute(self, argument):
|
|
'''
|
|
Executes a command
|
|
'''
|
|
|
|
argument = argument[argument.startswith('--') and len('--'):] # remove -- if it starts with it
|
|
|
|
# define commands
|
|
commands = self.getCommands()
|
|
|
|
command = commands.get(argument, self.notFound)
|
|
command()
|
|
|
|
return
|
|
|
|
'''
|
|
THIS SECTION DEFINES THE COMMANDS
|
|
'''
|
|
|
|
def version(self, verbosity = 5, function = logger.info):
|
|
'''
|
|
Displays the Onionr version
|
|
'''
|
|
|
|
function('Onionr v%s (%s) (API v%s)' % (ONIONR_VERSION, platform.machine(), API_VERSION))
|
|
if verbosity >= 1:
|
|
function(ONIONR_TAGLINE)
|
|
if verbosity >= 2:
|
|
function('Running on %s %s' % (platform.platform(), platform.release()))
|
|
|
|
return
|
|
|
|
def doPEX(self):
|
|
'''make communicator do pex'''
|
|
logger.info('Sending pex to command queue...')
|
|
self.onionrCore.daemonQueueAdd('pex')
|
|
|
|
def listKeys(self):
|
|
'''
|
|
Displays a list of keys (used to be called peers) (?)
|
|
'''
|
|
|
|
logger.info('%sPublic keys in database: \n%s%s' % (logger.colors.fg.lightgreen, logger.colors.fg.green, '\n'.join(self.onionrCore.listPeers())))
|
|
|
|
def addPeer(self):
|
|
'''
|
|
Adds a peer (?)
|
|
'''
|
|
try:
|
|
newPeer = sys.argv[2]
|
|
except:
|
|
pass
|
|
else:
|
|
if self.onionrUtils.hasKey(newPeer):
|
|
logger.info('We already have that key')
|
|
return
|
|
logger.info("Adding peer: " + logger.colors.underline + newPeer)
|
|
try:
|
|
if self.onionrCore.addPeer(newPeer):
|
|
logger.info('Successfully added key')
|
|
except AssertionError:
|
|
logger.error('Failed to add key')
|
|
return
|
|
|
|
def addAddress(self):
|
|
'''
|
|
Adds a Onionr node address
|
|
'''
|
|
|
|
try:
|
|
newAddress = sys.argv[2]
|
|
newAddress = newAddress.replace('http:', '').replace('/', '')
|
|
except:
|
|
pass
|
|
else:
|
|
logger.info("Adding address: " + logger.colors.underline + newAddress)
|
|
if self.onionrCore.addAddress(newAddress):
|
|
logger.info("Successfully added address.")
|
|
else:
|
|
logger.warn("Unable to add address.")
|
|
return
|
|
|
|
def addMessage(self, header="txt"):
|
|
'''
|
|
Broadcasts a message to the Onionr network
|
|
'''
|
|
|
|
while True:
|
|
try:
|
|
messageToAdd = logger.readline('Broadcast message to network: ')
|
|
if len(messageToAdd) >= 1:
|
|
break
|
|
except KeyboardInterrupt:
|
|
return
|
|
|
|
#addedHash = Block(type = 'txt', content = messageToAdd).save()
|
|
addedHash = self.onionrCore.insertBlock(messageToAdd)
|
|
if addedHash != None and addedHash != False and addedHash != "":
|
|
logger.info("Message inserted as as block %s" % addedHash)
|
|
else:
|
|
logger.error('Failed to insert block.', timestamp = False)
|
|
return
|
|
|
|
def enablePlugin(self):
|
|
'''
|
|
Enables and starts the given plugin
|
|
'''
|
|
|
|
if len(sys.argv) >= 3:
|
|
plugin_name = sys.argv[2]
|
|
logger.info('Enabling plugin "%s"...' % plugin_name)
|
|
plugins.enable(plugin_name, self)
|
|
else:
|
|
logger.info('%s %s <plugin>' % (sys.argv[0], sys.argv[1]))
|
|
|
|
return
|
|
|
|
def disablePlugin(self):
|
|
'''
|
|
Disables and stops the given plugin
|
|
'''
|
|
|
|
if len(sys.argv) >= 3:
|
|
plugin_name = sys.argv[2]
|
|
logger.info('Disabling plugin "%s"...' % plugin_name)
|
|
plugins.disable(plugin_name, self)
|
|
else:
|
|
logger.info('%s %s <plugin>' % (sys.argv[0], sys.argv[1]))
|
|
|
|
return
|
|
|
|
def reloadPlugin(self):
|
|
'''
|
|
Reloads (stops and starts) all plugins, or the given plugin
|
|
'''
|
|
|
|
if len(sys.argv) >= 3:
|
|
plugin_name = sys.argv[2]
|
|
logger.info('Reloading plugin "%s"...' % plugin_name)
|
|
plugins.stop(plugin_name, self)
|
|
plugins.start(plugin_name, self)
|
|
else:
|
|
logger.info('Reloading all plugins...')
|
|
plugins.reload(self)
|
|
|
|
return
|
|
|
|
def createPlugin(self):
|
|
'''
|
|
Creates the directory structure for a plugin name
|
|
'''
|
|
|
|
if len(sys.argv) >= 3:
|
|
try:
|
|
plugin_name = re.sub('[^0-9a-zA-Z_]+', '', str(sys.argv[2]).lower())
|
|
|
|
if not plugins.exists(plugin_name):
|
|
logger.info('Creating plugin "%s"...' % plugin_name)
|
|
|
|
os.makedirs(plugins.get_plugins_folder(plugin_name))
|
|
with open(plugins.get_plugins_folder(plugin_name) + '/main.py', 'a') as main:
|
|
contents = ''
|
|
with open('static-data/default_plugin.py', 'rb') as file:
|
|
contents = file.read().decode()
|
|
|
|
# TODO: Fix $user. os.getlogin() is B U G G Y
|
|
main.write(contents.replace('$user', 'some random developer').replace('$date', datetime.datetime.now().strftime('%Y-%m-%d')).replace('$name', plugin_name))
|
|
|
|
with open(plugins.get_plugins_folder(plugin_name) + '/info.json', 'a') as main:
|
|
main.write(json.dumps({'author' : 'anonymous', 'description' : 'the default description of the plugin', 'version' : '1.0'}))
|
|
|
|
logger.info('Enabling plugin "%s"...' % plugin_name)
|
|
plugins.enable(plugin_name, self)
|
|
else:
|
|
logger.warn('Cannot create plugin directory structure; plugin "%s" exists.' % plugin_name)
|
|
|
|
except Exception as e:
|
|
logger.error('Failed to create plugin directory structure.', e)
|
|
else:
|
|
logger.info('%s %s <plugin>' % (sys.argv[0], sys.argv[1]))
|
|
|
|
return
|
|
|
|
def notFound(self):
|
|
'''
|
|
Displays a "command not found" message
|
|
'''
|
|
|
|
logger.error('Command not found.', timestamp = False)
|
|
|
|
def showHelpSuggestion(self):
|
|
'''
|
|
Displays a message suggesting help
|
|
'''
|
|
if __name__ == '__main__':
|
|
logger.info('Do ' + logger.colors.bold + sys.argv[0] + ' --help' + logger.colors.reset + logger.colors.fg.green + ' for Onionr help.')
|
|
|
|
def start(self, input = False, override = False):
|
|
'''
|
|
Starts the Onionr daemon
|
|
'''
|
|
|
|
if os.path.exists('.onionr-lock') and not override:
|
|
logger.fatal('Cannot start. Daemon is already running, or it did not exit cleanly.\n(if you are sure that there is not a daemon running, delete .onionr-lock & try again).')
|
|
else:
|
|
if not self.debug and not self._developmentMode:
|
|
lockFile = open('.onionr-lock', 'w')
|
|
lockFile.write('')
|
|
lockFile.close()
|
|
self.running = True
|
|
self.daemon()
|
|
self.running = False
|
|
if not self.debug and not self._developmentMode:
|
|
try:
|
|
os.remove('.onionr-lock')
|
|
except FileNotFoundError:
|
|
pass
|
|
def setClientAPIInst(self, inst):
|
|
self.clientAPIInst = inst
|
|
|
|
def getClientApi(self):
|
|
while self.clientAPIInst == '':
|
|
time.sleep(0.5)
|
|
return self.clientAPIInst
|
|
|
|
def daemon(self):
|
|
'''
|
|
Starts the Onionr communication daemon
|
|
'''
|
|
|
|
# remove runcheck if it exists
|
|
if os.path.isfile('data/.runcheck'):
|
|
logger.debug('Runcheck file found on daemon start, deleting in advance.')
|
|
os.remove('data/.runcheck')
|
|
|
|
Thread(target=api.API, args=(self, self.debug, API_VERSION)).start()
|
|
Thread(target=api.PublicAPI, args=[self.getClientApi()]).start()
|
|
try:
|
|
time.sleep(0)
|
|
except KeyboardInterrupt:
|
|
logger.debug('Got keyboard interrupt, shutting down...')
|
|
time.sleep(1)
|
|
self.onionrUtils.localCommand('shutdown')
|
|
|
|
apiHost = ''
|
|
while apiHost == '':
|
|
try:
|
|
with open(self.onionrCore.publicApiHostFile, 'r') as hostFile:
|
|
apiHost = hostFile.read()
|
|
except FileNotFoundError:
|
|
pass
|
|
time.sleep(0.5)
|
|
Onionr.setupConfig('data/', self = self)
|
|
|
|
if self._developmentMode:
|
|
logger.warn('DEVELOPMENT MODE ENABLED (NOT RECOMMENDED)', timestamp = False)
|
|
net = NetController(config.get('client.public.port', 59497), apiServerIP=apiHost)
|
|
logger.debug('Tor is starting...')
|
|
if not net.startTor():
|
|
self.onionrUtils.localCommand('shutdown')
|
|
sys.exit(1)
|
|
if len(net.myID) > 0 and config.get('general.security_level') == 0:
|
|
logger.debug('Started .onion service: %s' % (logger.colors.underline + net.myID))
|
|
else:
|
|
logger.debug('.onion service disabled')
|
|
logger.debug('Using public key: %s' % (logger.colors.underline + self.onionrCore._crypto.pubKey))
|
|
time.sleep(1)
|
|
|
|
self.onionrCore.torPort = net.socksPort
|
|
communicatorThread = Thread(target=communicator.startCommunicator, args=(self, str(net.socksPort)))
|
|
communicatorThread.start()
|
|
|
|
while self.communicatorInst is None:
|
|
time.sleep(0.1)
|
|
|
|
# print nice header thing :)
|
|
if config.get('general.display_header', True):
|
|
self.header()
|
|
|
|
# print out debug info
|
|
self.version(verbosity = 5, function = logger.debug)
|
|
logger.debug('Python version %s' % platform.python_version())
|
|
|
|
logger.debug('Started communicator.')
|
|
|
|
events.event('daemon_start', onionr = self)
|
|
try:
|
|
while True:
|
|
time.sleep(3)
|
|
# Debug to print out used FDs (regular and net)
|
|
#proc = psutil.Process()
|
|
#print('api-files:',proc.open_files(), len(psutil.net_connections()))
|
|
# Break if communicator process ends, so we don't have left over processes
|
|
if self.communicatorInst.shutdown:
|
|
break
|
|
if self.killed:
|
|
break # Break out if sigterm for clean exit
|
|
except KeyboardInterrupt:
|
|
pass
|
|
finally:
|
|
self.onionrCore.daemonQueueAdd('shutdown')
|
|
self.onionrUtils.localCommand('shutdown')
|
|
net.killTor()
|
|
time.sleep(3)
|
|
self.deleteRunFiles()
|
|
return
|
|
|
|
def killDaemon(self):
|
|
'''
|
|
Shutdown the Onionr daemon
|
|
'''
|
|
|
|
logger.warn('Stopping the running daemon...', timestamp = False)
|
|
try:
|
|
events.event('daemon_stop', onionr = self)
|
|
net = NetController(config.get('client.port', 59496))
|
|
try:
|
|
self.onionrCore.daemonQueueAdd('shutdown')
|
|
except sqlite3.OperationalError:
|
|
pass
|
|
|
|
net.killTor()
|
|
except Exception as e:
|
|
logger.error('Failed to shutdown daemon.', error = e, timestamp = False)
|
|
return
|
|
|
|
def showStats(self):
|
|
'''
|
|
Displays statistics and exits
|
|
'''
|
|
|
|
try:
|
|
# define stats messages here
|
|
totalBlocks = len(self.onionrCore.getBlockList())
|
|
signedBlocks = len(Block.getBlocks(signed = True))
|
|
messages = {
|
|
# info about local client
|
|
'Onionr Daemon Status' : ((logger.colors.fg.green + 'Online') if self.onionrUtils.isCommunicatorRunning(timeout = 9) else logger.colors.fg.red + 'Offline'),
|
|
|
|
# file and folder size stats
|
|
'div1' : True, # this creates a solid line across the screen, a div
|
|
'Total Block Size' : onionrutils.humanSize(onionrutils.size(self.dataDir + 'blocks/')),
|
|
'Total Plugin Size' : onionrutils.humanSize(onionrutils.size(self.dataDir + 'plugins/')),
|
|
'Log File Size' : onionrutils.humanSize(onionrutils.size(self.dataDir + 'output.log')),
|
|
|
|
# count stats
|
|
'div2' : True,
|
|
'Known Peers Count' : str(len(self.onionrCore.listPeers()) - 1),
|
|
'Enabled Plugins Count' : str(len(config.get('plugins.enabled', list()))) + ' / ' + str(len(os.listdir(self.dataDir + 'plugins/'))),
|
|
'Known Blocks Count' : str(totalBlocks),
|
|
'Percent Blocks Signed' : str(round(100 * signedBlocks / max(totalBlocks, 1), 2)) + '%'
|
|
}
|
|
|
|
# color configuration
|
|
colors = {
|
|
'title' : logger.colors.bold,
|
|
'key' : logger.colors.fg.lightgreen,
|
|
'val' : logger.colors.fg.green,
|
|
'border' : logger.colors.fg.lightblue,
|
|
|
|
'reset' : logger.colors.reset
|
|
}
|
|
|
|
# pre-processing
|
|
maxlength = 0
|
|
width = self.getConsoleWidth()
|
|
for key, val in messages.items():
|
|
if not (type(val) is bool and val is True):
|
|
maxlength = max(len(key), maxlength)
|
|
prewidth = maxlength + len(' | ')
|
|
groupsize = width - prewidth - len('[+] ')
|
|
|
|
# generate stats table
|
|
logger.info(colors['title'] + 'Onionr v%s Statistics' % ONIONR_VERSION + colors['reset'])
|
|
logger.info(colors['border'] + '-' * (maxlength + 1) + '+' + colors['reset'])
|
|
for key, val in messages.items():
|
|
if not (type(val) is bool and val is True):
|
|
val = [str(val)[i:i + groupsize] for i in range(0, len(str(val)), groupsize)]
|
|
|
|
logger.info(colors['key'] + str(key).rjust(maxlength) + colors['reset'] + colors['border'] + ' | ' + colors['reset'] + colors['val'] + str(val.pop(0)) + colors['reset'])
|
|
|
|
for value in val:
|
|
logger.info(' ' * maxlength + colors['border'] + ' | ' + colors['reset'] + colors['val'] + str(value) + colors['reset'])
|
|
else:
|
|
logger.info(colors['border'] + '-' * (maxlength + 1) + '+' + colors['reset'])
|
|
logger.info(colors['border'] + '-' * (maxlength + 1) + '+' + colors['reset'])
|
|
except Exception as e:
|
|
logger.error('Failed to generate statistics table.', error = e, timestamp = False)
|
|
|
|
return
|
|
|
|
def showHelp(self, command = None):
|
|
'''
|
|
Show help for Onionr
|
|
'''
|
|
|
|
helpmenu = self.getHelp()
|
|
|
|
if command is None and len(sys.argv) >= 3:
|
|
for cmd in sys.argv[2:]:
|
|
self.showHelp(cmd)
|
|
elif not command is None:
|
|
if command.lower() in helpmenu:
|
|
logger.info(logger.colors.bold + command + logger.colors.reset + logger.colors.fg.blue + ' : ' + logger.colors.reset + helpmenu[command.lower()], timestamp = False)
|
|
else:
|
|
logger.warn(logger.colors.bold + command + logger.colors.reset + logger.colors.fg.blue + ' : ' + logger.colors.reset + 'No help menu entry was found', timestamp = False)
|
|
else:
|
|
self.version(0)
|
|
for command, helpmessage in helpmenu.items():
|
|
self.showHelp(command)
|
|
return
|
|
|
|
def get_hostname(self):
|
|
try:
|
|
with open('./' + self.dataDir + 'hs/hostname', 'r') as hostname:
|
|
return hostname.read().strip()
|
|
except FileNotFoundError:
|
|
return "Not Generated"
|
|
except Exception:
|
|
return None
|
|
|
|
def getConsoleWidth(self):
|
|
'''
|
|
Returns an integer, the width of the terminal/cmd window
|
|
'''
|
|
|
|
columns = 80
|
|
|
|
try:
|
|
columns = int(os.popen('stty size', 'r').read().split()[1])
|
|
except:
|
|
# if it errors, it's probably windows, so default to 80.
|
|
pass
|
|
|
|
return columns
|
|
|
|
def getFile(self):
|
|
'''
|
|
Get a file from onionr blocks
|
|
'''
|
|
try:
|
|
fileName = sys.argv[2]
|
|
bHash = sys.argv[3]
|
|
except IndexError:
|
|
logger.error("Syntax %s %s" % (sys.argv[0], '/path/to/filename <blockhash>'))
|
|
else:
|
|
logger.info(fileName)
|
|
|
|
contents = None
|
|
if os.path.exists(fileName):
|
|
logger.error("File already exists")
|
|
return
|
|
if not self.onionrUtils.validateHash(bHash):
|
|
logger.error('Block hash is invalid')
|
|
return
|
|
|
|
with open(fileName, 'wb') as myFile:
|
|
myFile.write(base64.b64decode(Block(bHash, core=self.onionrCore).bcontent))
|
|
return
|
|
|
|
def addWebpage(self):
|
|
'''
|
|
Add a webpage to the onionr network
|
|
'''
|
|
self.addFile(singleBlock=True, blockType='html')
|
|
|
|
def addFile(self, singleBlock=False, blockType='bin'):
|
|
'''
|
|
Adds a file to the onionr network
|
|
'''
|
|
|
|
if len(sys.argv) >= 3:
|
|
filename = sys.argv[2]
|
|
contents = None
|
|
|
|
if not os.path.exists(filename):
|
|
logger.error('That file does not exist. Improper path (specify full path)?')
|
|
return
|
|
logger.info('Adding file... this might take a long time.')
|
|
try:
|
|
with open(filename, 'rb') as singleFile:
|
|
blockhash = self.onionrCore.insertBlock(base64.b64encode(singleFile.read()), header=blockType)
|
|
if len(blockhash) > 0:
|
|
logger.info('File %s saved in block %s' % (filename, blockhash))
|
|
except:
|
|
logger.error('Failed to save file in block.', timestamp = False)
|
|
else:
|
|
logger.error('%s add-file <filename>' % sys.argv[0], timestamp = False)
|
|
|
|
def setupConfig(dataDir, self = None):
|
|
data_exists = os.path.exists(dataDir)
|
|
|
|
if not data_exists:
|
|
os.mkdir(dataDir)
|
|
|
|
if os.path.exists('static-data/default_config.json'):
|
|
# this is the default config, it will be overwritten if a config file already exists. Else, it saves it
|
|
with open('static-data/default_config.json', 'r') as configReadIn:
|
|
config.set_config(json.loads(configReadIn.read()))
|
|
else:
|
|
# the default config file doesn't exist, try hardcoded config
|
|
logger.warn('Default configuration file does not exist, switching to hardcoded fallback configuration!')
|
|
config.set_config({'dev_mode': True, 'log': {'file': {'output': True, 'path': dataDir + 'output.log'}, 'console': {'output': True, 'color': True}}})
|
|
if not data_exists:
|
|
config.save()
|
|
config.reload() # this will read the configuration file into memory
|
|
|
|
settings = 0b000
|
|
if config.get('log.console.color', True):
|
|
settings = settings | logger.USE_ANSI
|
|
if config.get('log.console.output', True):
|
|
settings = settings | logger.OUTPUT_TO_CONSOLE
|
|
if config.get('log.file.output', True):
|
|
settings = settings | logger.OUTPUT_TO_FILE
|
|
logger.set_settings(settings)
|
|
|
|
if not self is None:
|
|
if str(config.get('general.dev_mode', True)).lower() == 'true':
|
|
self._developmentMode = True
|
|
logger.set_level(logger.LEVEL_DEBUG)
|
|
else:
|
|
self._developmentMode = False
|
|
logger.set_level(logger.LEVEL_INFO)
|
|
|
|
verbosity = str(config.get('log.verbosity', 'default')).lower().strip()
|
|
if not verbosity in ['default', 'null', 'none', 'nil']:
|
|
map = {
|
|
str(logger.LEVEL_DEBUG) : logger.LEVEL_DEBUG,
|
|
'verbose' : logger.LEVEL_DEBUG,
|
|
'debug' : logger.LEVEL_DEBUG,
|
|
str(logger.LEVEL_INFO) : logger.LEVEL_INFO,
|
|
'info' : logger.LEVEL_INFO,
|
|
'information' : logger.LEVEL_INFO,
|
|
str(logger.LEVEL_WARN) : logger.LEVEL_WARN,
|
|
'warn' : logger.LEVEL_WARN,
|
|
'warning' : logger.LEVEL_WARN,
|
|
'warnings' : logger.LEVEL_WARN,
|
|
str(logger.LEVEL_ERROR) : logger.LEVEL_ERROR,
|
|
'err' : logger.LEVEL_ERROR,
|
|
'error' : logger.LEVEL_ERROR,
|
|
'errors' : logger.LEVEL_ERROR,
|
|
str(logger.LEVEL_FATAL) : logger.LEVEL_FATAL,
|
|
'fatal' : logger.LEVEL_FATAL,
|
|
str(logger.LEVEL_IMPORTANT) : logger.LEVEL_IMPORTANT,
|
|
'silent' : logger.LEVEL_IMPORTANT,
|
|
'quiet' : logger.LEVEL_IMPORTANT,
|
|
'important' : logger.LEVEL_IMPORTANT
|
|
}
|
|
|
|
if verbosity in map:
|
|
logger.set_level(map[verbosity])
|
|
else:
|
|
logger.warn('Verbosity level %s is not valid, using default verbosity.' % verbosity)
|
|
|
|
return data_exists
|
|
|
|
def header(self, message = logger.colors.fg.pink + logger.colors.bold + 'Onionr' + logger.colors.reset + logger.colors.fg.pink + ' has started.'):
|
|
if os.path.exists('static-data/header.txt') and logger.get_level() <= logger.LEVEL_INFO:
|
|
with open('static-data/header.txt', 'rb') as file:
|
|
# only to stdout, not file or log or anything
|
|
sys.stderr.write(file.read().decode().replace('P', logger.colors.fg.pink).replace('W', logger.colors.reset + logger.colors.bold).replace('G', logger.colors.fg.green).replace('\n', logger.colors.reset + '\n').replace('B', logger.colors.bold).replace('A', '%s' % API_VERSION).replace('V', ONIONR_VERSION))
|
|
logger.info(logger.colors.fg.lightgreen + '-> ' + str(message) + logger.colors.reset + logger.colors.fg.lightgreen + ' <-\n')
|
|
|
|
if __name__ == "__main__":
|
|
Onionr()
|