Onionr/onionr/core.py

618 lines
20 KiB
Python
Raw Normal View History

'''
Onionr - P2P Microblogging Platform & Social network
2018-02-01 22:45:15 +00:00
Core Onionr library, useful for external programs. Handles peer & data processing
'''
'''
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/>.
'''
2018-02-16 04:31:30 +00:00
import sqlite3, os, sys, time, math, base64, tarfile, getpass, simplecrypt, hashlib, nacl, logger
2018-02-07 09:04:58 +00:00
#from Crypto.Cipher import AES
#from Crypto import Random
2018-01-19 09:16:38 +00:00
import netcontroller
2018-01-07 08:55:44 +00:00
2018-04-21 03:10:50 +00:00
import onionrutils, onionrcrypto, btc, onionrevents as events
2018-01-26 09:46:21 +00:00
if sys.version_info < (3, 6):
try:
import sha3
except ModuleNotFoundError:
2018-01-26 07:22:48 +00:00
logger.fatal('On Python 3 versions prior to 3.6.x, you need the sha3 module')
sys.exit(1)
class Core:
def __init__(self):
'''
Initialize Core Onionr library
'''
2018-04-19 02:16:10 +00:00
try:
self.queueDB = 'data/queue.db'
self.peerDB = 'data/peers.db'
self.blockDB = 'data/blocks.db'
self.blockDataLocation = 'data/blocks/'
self.addressDB = 'data/address.db'
self.hsAdder = ''
2018-04-22 23:35:00 +00:00
self.bootstrapFileLocation = 'static-data/bootstrap-nodes.txt'
self.bootstrapList = []
2018-04-19 02:16:10 +00:00
if not os.path.exists('data/'):
os.mkdir('data/')
if not os.path.exists('data/blocks/'):
os.mkdir('data/blocks/')
if not os.path.exists(self.blockDB):
self.createBlockDB()
if os.path.exists('data/hs/hostname'):
with open('data/hs/hostname', 'r') as hs:
self.hsAdder = hs.read()
2018-04-22 23:35:00 +00:00
# Load bootstrap address list
if os.path.exists(self.bootstrapFileLocation):
with open(self.bootstrapFileLocation, 'r') as bootstrap:
bootstrap = bootstrap.read()
for i in bootstrap.split('\n'):
self.bootstrapList.append(i)
else:
logger.warn('Warning: address bootstrap file not found ' + self.bootstrapFileLocation)
2018-04-19 02:16:10 +00:00
self._utils = onionrutils.OnionrUtils(self)
# Initialize the crypto object
self._crypto = onionrcrypto.OnionrCrypto(self)
2018-04-22 23:35:00 +00:00
2018-04-19 02:16:10 +00:00
except Exception as error:
logger.error('Failed to initialize core Onionr library.', error=error)
logger.fatal('Cannot recover from error.')
exit(1)
2018-01-06 08:51:26 +00:00
return
2018-01-10 03:50:38 +00:00
def addPeer(self, peerID, name=''):
'''
2018-03-16 15:35:37 +00:00
Adds a public key to the key database (misleading function name)
DOES NO SAFETY CHECKS if the ID is valid, but prepares the insertion
'''
2018-01-10 03:50:38 +00:00
# This function simply adds a peer to the DB
2018-02-21 09:32:31 +00:00
if not self._utils.validatePubKey(peerID):
2018-01-26 09:46:21 +00:00
return False
conn = sqlite3.connect(self.peerDB)
c = conn.cursor()
t = (peerID, name, 'unknown')
2018-04-04 01:54:49 +00:00
for i in c.execute("SELECT * FROM PEERS where id = '" + peerID + "';"):
try:
if i[0] == peerID:
conn.close()
return False
except ValueError:
pass
except IndexError:
pass
c.execute('INSERT INTO peers (id, name, dateSeen) VALUES(?, ?, ?);', t)
conn.commit()
conn.close()
2018-04-21 03:10:50 +00:00
return True
2018-02-27 21:23:49 +00:00
def addAddress(self, address):
2018-04-21 03:10:50 +00:00
'''
Add an address to the address database (only tor currently)
'''
2018-02-27 21:23:49 +00:00
if self._utils.validateID(address):
conn = sqlite3.connect(self.addressDB)
c = conn.cursor()
# check if address is in database
# this is safe to do because the address is validated above, but we strip some chars here too just in case
address = address.replace('\'', '').replace(';', '').replace('"', '').replace('\\', '')
for i in c.execute("SELECT * FROM adders where address = '" + address + "';"):
try:
if i[0] == address:
logger.warn('Not adding existing address')
conn.close()
return False
except ValueError:
pass
except IndexError:
pass
2018-02-27 21:23:49 +00:00
t = (address, 1)
c.execute('INSERT INTO adders (address, type) VALUES(?, ?);', t)
conn.commit()
conn.close()
2018-04-21 03:10:50 +00:00
events.event('address_add', data = {'address': address}, onionr = None)
2018-02-27 21:23:49 +00:00
return True
else:
return False
2018-02-28 00:00:37 +00:00
2018-02-27 21:23:49 +00:00
def removeAddress(self, address):
2018-04-21 03:10:50 +00:00
'''
Remove an address from the address database
'''
2018-02-27 21:23:49 +00:00
if self._utils.validateID(address):
conn = sqlite3.connect(self.addressDB)
c = conn.cursor()
t = (address,)
c.execute('Delete from adders where address=?;', t)
conn.commit()
conn.close()
2018-04-21 03:10:50 +00:00
events.event('address_remove', data = {'address': address}, onionr = None)
2018-02-27 21:23:49 +00:00
return True
else:
2018-04-19 02:16:10 +00:00
return False
def removeBlock(self, block):
'''
remove a block from this node
'''
if self._utils.validateHash(block):
conn = sqlite3.connect(self.blockDB)
c = conn.cursor()
t = (block,)
c.execute('Delete from hashes where hash=?;', t)
conn.commit()
conn.close()
try:
os.remove('data/blocks/' + block + '.dat')
except FileNotFoundError:
pass
2018-02-27 21:23:49 +00:00
2018-02-21 09:32:31 +00:00
def createAddressDB(self):
'''
Generate the address database
types:
1: I2P b32 address
2: Tor v2 (like facebookcorewwwi.onion)
3: Tor v3
'''
conn = sqlite3.connect(self.addressDB)
c = conn.cursor()
c.execute('''CREATE TABLE adders(
address text,
type int,
knownPeer text,
speed int,
success int,
2018-02-28 00:00:37 +00:00
DBHash text,
2018-02-21 09:32:31 +00:00
failure int
);
''')
conn.commit()
conn.close()
2018-01-10 03:50:38 +00:00
def createPeerDB(self):
'''
Generate the peer sqlite3 database and populate it with the peers table.
'''
2018-01-10 03:50:38 +00:00
# generate the peer database
conn = sqlite3.connect(self.peerDB)
c = conn.cursor()
c.execute('''CREATE TABLE peers(
ID text not null,
name text,
2018-02-21 09:32:31 +00:00
adders text,
blockDBHash text,
forwardKey text,
dateSeen not null,
bytesStored int,
trust int,
pubkeyExchanged int);
2018-01-10 03:50:38 +00:00
''')
conn.commit()
conn.close()
return
def createBlockDB(self):
'''
Create a database for blocks
hash - the hash of a block
dateReceived - the date the block was recieved, not necessarily when it was created
decrypted - if we can successfully decrypt the block (does not describe its current state)
dataType - data type of the block
dataFound - if the data has been found for the block
dataSaved - if the data has been saved for the block
'''
if os.path.exists(self.blockDB):
raise Exception("Block database already exists")
conn = sqlite3.connect(self.blockDB)
c = conn.cursor()
c.execute('''CREATE TABLE hashes(
hash text not null,
dateReceived int,
decrypted int,
dataType text,
2018-01-26 06:28:11 +00:00
dataFound int,
dataSaved int);
''')
conn.commit()
conn.close()
return
def addToBlockDB(self, newHash, selfInsert=False):
'''
Add a hash value to the block db
Should be in hex format!
'''
if not os.path.exists(self.blockDB):
raise Exception('Block db does not exist')
if self._utils.hasBlock(newHash):
return
conn = sqlite3.connect(self.blockDB)
c = conn.cursor()
currentTime = math.floor(time.time())
if selfInsert:
selfInsert = 1
else:
selfInsert = 0
data = (newHash, currentTime, 0, '', 0, selfInsert)
c.execute('INSERT INTO hashes VALUES(?, ?, ?, ?, ?, ?);', data)
conn.commit()
conn.close()
return
def getData(self,hash):
'''
Simply return the data associated to a hash
'''
2018-01-27 21:49:48 +00:00
try:
2018-04-23 01:43:17 +00:00
dataFile = open(self.blockDataLocation + hash + '.dat', 'rb')
2018-01-27 21:49:48 +00:00
data = dataFile.read()
dataFile.close()
except FileNotFoundError:
data = False
return data
def setData(self, data):
'''
Set the data assciated with a hash
'''
data = data
2018-01-25 22:39:09 +00:00
hasher = hashlib.sha3_256()
2018-04-23 02:24:34 +00:00
if not type(data) is bytes:
data = data.encode()
2018-01-25 22:39:09 +00:00
hasher.update(data)
dataHash = hasher.hexdigest()
2018-01-29 02:14:46 +00:00
if type(dataHash) is bytes:
dataHash = dataHash.decode()
2018-01-25 22:39:09 +00:00
blockFileName = self.blockDataLocation + dataHash + '.dat'
if os.path.exists(blockFileName):
pass # TODO: properly check if block is already saved elsewhere
#raise Exception("Data is already set for " + dataHash)
2018-01-25 22:39:09 +00:00
else:
2018-04-23 01:43:17 +00:00
blockFile = open(blockFileName, 'wb')
blockFile.write(data)
2018-01-25 22:39:09 +00:00
blockFile.close()
conn = sqlite3.connect(self.blockDB)
c = conn.cursor()
c.execute("UPDATE hashes SET dataSaved=1 WHERE hash = '" + dataHash + "';")
conn.commit()
conn.close()
2018-01-25 22:39:09 +00:00
return dataHash
2018-01-08 09:25:32 +00:00
def dataDirEncrypt(self, password):
'''
Encrypt the data directory on Onionr shutdown
'''
2018-01-08 09:25:32 +00:00
if os.path.exists('data.tar'):
os.remove('data.tar')
tar = tarfile.open("data.tar", "w")
for name in ['data']:
tar.add(name)
tar.close()
tarData = open('data.tar', 'r', encoding = "ISO-8859-1").read()
encrypted = simplecrypt.encrypt(password, tarData)
open('data-encrypted.dat', 'wb').write(encrypted)
os.remove('data.tar')
return
2018-01-08 09:25:32 +00:00
def dataDirDecrypt(self, password):
'''
Decrypt the data directory on startup
'''
2018-01-08 09:25:32 +00:00
if not os.path.exists('data-encrypted.dat'):
return (False, 'encrypted archive does not exist')
data = open('data-encrypted.dat', 'rb').read()
try:
decrypted = simplecrypt.decrypt(password, data)
except simplecrypt.DecryptionException:
2018-01-09 22:58:12 +00:00
return (False, 'wrong password (or corrupted archive)')
2018-01-08 09:25:32 +00:00
else:
open('data.tar', 'wb').write(decrypted)
2018-01-09 22:58:12 +00:00
tar = tarfile.open('data.tar')
tar.extractall()
tar.close()
2018-01-08 09:25:32 +00:00
return (True, '')
def daemonQueue(self):
'''
Gives commands to the communication proccess/daemon by reading an sqlite3 database
This function intended to be used by the client. Queue to exchange data between "client" and server.
'''
retData = False
if not os.path.exists(self.queueDB):
2018-01-04 07:12:46 +00:00
conn = sqlite3.connect(self.queueDB)
c = conn.cursor()
# Create table
c.execute('''CREATE TABLE commands
(id integer primary key autoincrement, command text, data text, date text)''')
conn.commit()
else:
2018-01-04 07:12:46 +00:00
conn = sqlite3.connect(self.queueDB)
c = conn.cursor()
for row in c.execute('SELECT command, data, date, min(ID) FROM commands group by id'):
retData = row
break
if retData != False:
c.execute('DELETE FROM commands WHERE id=?;', (retData[3],))
2018-01-04 07:12:46 +00:00
conn.commit()
conn.close()
2018-04-21 03:10:50 +00:00
events.event('queue_pop', data = {'data': retData}, onionr = None)
return retData
def daemonQueueAdd(self, command, data=''):
'''
Add a command to the daemon queue, used by the communication daemon (communicator.py)
'''
2018-01-04 07:12:46 +00:00
# Intended to be used by the web server
date = math.floor(time.time())
conn = sqlite3.connect(self.queueDB)
c = conn.cursor()
t = (command, data, date)
c.execute('INSERT INTO commands (command, data, date) VALUES(?, ?, ?)', t)
conn.commit()
conn.close()
2018-04-21 03:10:50 +00:00
events.event('queue_push', data = {'command': command, 'data': data}, onionr = None)
return
2018-01-27 01:16:15 +00:00
def clearDaemonQueue(self):
'''
Clear the daemon queue (somewhat dangerous)
'''
2018-01-27 01:16:15 +00:00
conn = sqlite3.connect(self.queueDB)
c = conn.cursor()
try:
2018-04-21 03:10:50 +00:00
c.execute('DELETE FROM commands;')
conn.commit()
except:
pass
2018-01-27 01:16:15 +00:00
conn.close()
2018-04-21 03:10:50 +00:00
events.event('queue_clear', onionr = None)
return
2018-04-19 02:16:10 +00:00
def listAdders(self, randomOrder=True, i2p=True):
'''
Return a list of addresses
'''
conn = sqlite3.connect(self.addressDB)
c = conn.cursor()
if randomOrder:
addresses = c.execute('SELECT * FROM adders ORDER BY RANDOM();')
else:
addresses = c.execute('SELECT * FROM adders;')
addressList = []
for i in addresses:
2018-02-28 00:00:37 +00:00
addressList.append(i[0])
conn.close()
return addressList
2018-01-28 01:53:24 +00:00
def listPeers(self, randomOrder=True):
'''
2018-03-16 15:35:37 +00:00
Return a list of public keys (misleading function name)
2018-01-28 01:53:24 +00:00
randomOrder determines if the list should be in a random order
2018-01-26 06:28:11 +00:00
'''
conn = sqlite3.connect(self.peerDB)
c = conn.cursor()
2018-04-03 19:39:58 +00:00
payload = ""
2018-01-28 01:53:24 +00:00
if randomOrder:
2018-04-03 19:39:58 +00:00
payload = 'SELECT * FROM peers ORDER BY RANDOM();'
2018-01-28 01:53:24 +00:00
else:
2018-04-03 19:39:58 +00:00
payload = 'SELECT * FROM peers;'
2018-01-26 06:28:11 +00:00
peerList = []
2018-04-03 19:39:58 +00:00
for i in c.execute(payload):
try:
2018-04-04 01:54:49 +00:00
if len(i[0]) != 0:
peerList.append(i[0])
except TypeError:
pass
2018-04-03 19:39:58 +00:00
peerList.append(self._crypto.pubKey)
2018-01-26 06:28:11 +00:00
conn.close()
return peerList
def getPeerInfo(self, peer, info):
'''
Get info about a peer from their database entry
2018-01-26 06:28:11 +00:00
id text 0
name text, 1
2018-04-04 01:54:49 +00:00
adders text, 2
forwardKey text, 3
dateSeen not null, 4
bytesStored int, 5
trust int 6
pubkeyExchanged int 7
2018-01-26 06:28:11 +00:00
'''
conn = sqlite3.connect(self.peerDB)
c = conn.cursor()
command = (peer,)
2018-04-04 01:54:49 +00:00
infoNumbers = {'id': 0, 'name': 1, 'adders': 2, 'forwardKey': 3, 'dateSeen': 4, 'bytesStored': 5, 'trust': 6, 'pubkeyExchanged': 7}
2018-01-26 06:28:11 +00:00
info = infoNumbers[info]
iterCount = 0
retVal = ''
for row in c.execute('SELECT * from peers where id=?;', command):
for i in row:
if iterCount == info:
retVal = i
break
else:
iterCount += 1
conn.close()
2018-01-26 06:28:11 +00:00
return retVal
2018-01-28 01:53:24 +00:00
def setPeerInfo(self, peer, key, data):
'''
Update a peer for a key
'''
2018-01-28 01:53:24 +00:00
conn = sqlite3.connect(self.peerDB)
c = conn.cursor()
2018-01-28 01:56:59 +00:00
command = (data, peer)
2018-01-28 01:53:24 +00:00
# TODO: validate key on whitelist
2018-02-16 04:31:30 +00:00
if key not in ('id', 'name', 'pubkey', 'blockDBHash', 'forwardKey', 'dateSeen', 'bytesStored', 'trust'):
raise Exception("Got invalid database key when setting peer info")
c.execute('UPDATE peers SET ' + key + ' = ? WHERE id=?', command)
2018-01-28 02:05:55 +00:00
conn.commit()
conn.close()
2018-02-28 00:00:37 +00:00
return
2018-01-26 06:28:11 +00:00
2018-02-28 00:00:37 +00:00
def getAddressInfo(self, address, info):
'''
Get info about an address from its database entry
address text, 0
type int, 1
knownPeer text, 2
speed int, 3
success int, 4
DBHash text, 5
failure int 6
'''
conn = sqlite3.connect(self.addressDB)
c = conn.cursor()
command = (address,)
infoNumbers = {'address': 0, 'type': 1, 'knownPeer': 2, 'speed': 3, 'success': 4, 'DBHash': 5, 'failure': 6}
info = infoNumbers[info]
iterCount = 0
retVal = ''
for row in c.execute('SELECT * from adders where address=?;', command):
for i in row:
if iterCount == info:
retVal = i
break
else:
iterCount += 1
conn.close()
return retVal
def setAddressInfo(self, address, key, data):
'''
Update an address for a key
'''
conn = sqlite3.connect(self.addressDB)
c = conn.cursor()
command = (data, address)
# TODO: validate key on whitelist
if key not in ('address', 'type', 'knownPeer', 'speed', 'success', 'DBHash', 'failure'):
raise Exception("Got invalid database key when setting address info")
c.execute('UPDATE adders SET ' + key + ' = ? WHERE address=?', command)
conn.commit()
conn.close()
return
2018-01-27 01:16:15 +00:00
def getBlockList(self, unsaved=False):
'''
Get list of our blocks
'''
2018-01-26 06:28:11 +00:00
conn = sqlite3.connect(self.blockDB)
c = conn.cursor()
retData = ''
2018-01-27 01:16:15 +00:00
if unsaved:
2018-02-22 06:42:02 +00:00
execute = 'SELECT hash FROM hashes WHERE dataSaved != 1;'
2018-01-27 01:16:15 +00:00
else:
execute = 'SELECT hash FROM hashes;'
for row in c.execute(execute):
2018-01-26 06:28:11 +00:00
for i in row:
retData += i + "\n"
2018-01-26 06:28:11 +00:00
return retData
def getBlocksByType(self, blockType):
'''
Returns a list of blocks by the type
'''
conn = sqlite3.connect(self.blockDB)
c = conn.cursor()
retData = ''
execute = 'SELECT hash FROM hashes WHERE dataType=?;'
args = (blockType,)
for row in c.execute(execute, args):
for i in row:
retData += i + "\n"
return retData.split('\n')
def setBlockType(self, hash, blockType):
'''
Sets the type of block
'''
conn = sqlite3.connect(self.blockDB)
c = conn.cursor()
2018-02-02 09:15:28 +00:00
c.execute("UPDATE hashes SET dataType='" + blockType + "' WHERE hash = '" + hash + "';")
conn.commit()
conn.close()
return
def insertBlock(self, data, header='txt'):
'''
Inserts a block into the network
'''
retData = ''
if len(data) == 0:
logger.error('Will not insert empty block')
else:
addedHash = self.setData('-' + header + '-' + data)
self.addToBlockDB(addedHash, selfInsert=True)
self.setBlockType(addedHash, header)
retData = addedHash
2018-04-19 01:17:47 +00:00
return retData
2018-04-19 02:16:10 +00:00
2018-04-19 01:17:47 +00:00
def introduceNode(self):
'''
Introduces our node into the network by telling X many nodes our HS address
'''
2018-04-19 02:56:25 +00:00
announceAmount = 2
nodeList = self.listAdders()
if len(nodeList) == 0:
2018-04-22 23:35:00 +00:00
for i in self.bootstrapList:
if self._utils.validateID(i):
self.addAddress(i)
nodeList.append(i)
2018-04-19 02:56:25 +00:00
if announceAmount > len(nodeList):
announceAmount = len(nodeList)
for i in range(announceAmount):
self.daemonQueueAdd('announceNode', nodeList[i])
2018-04-21 03:10:50 +00:00
events.event('introduction', onionr = None)
2018-04-19 02:16:10 +00:00
return