Onionr/onionr/core.py

424 lines
13 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-01-26 07:22:48 +00:00
import sqlite3, os, sys, time, math, gnupg, 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-02-07 09:04:58 +00:00
import onionrutils, onionrcrypto
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
'''
self.queueDB = 'data/queue.db'
2018-01-10 03:50:38 +00:00
self.peerDB = 'data/peers.db'
2018-01-20 07:23:09 +00:00
self.ownPGPID = ''
self.blockDB = 'data/blocks.db'
self.blockDataLocation = 'data/blocks/'
2018-02-07 09:04:58 +00:00
self.gpgHome = './data/pgp/'
2018-01-26 09:46:21 +00:00
self._utils = onionrutils.OnionrUtils(self)
2018-02-07 09:04:58 +00:00
self._crypto = onionrcrypto.OnionrCrypto(self)
2018-01-10 03:50:38 +00:00
if not os.path.exists('data/'):
os.mkdir('data/')
2018-01-27 21:49:48 +00:00
if not os.path.exists('data/blocks/'):
os.mkdir('data/blocks/')
if not os.path.exists(self.blockDB):
self.createBlockDB()
return
2018-01-20 07:23:09 +00:00
def generateMainPGP(self, myID):
'''
Generate the main PGP key for our client. Should not be done often.
Uses own PGP home folder in the data/ directory
'''
2018-02-07 09:04:58 +00:00
gpg = gnupg.GPG(homedir=self.gpgHome)
input_data = gpg.gen_key_input(key_type="RSA", key_length=1024, name_real=myID, name_email='anon@onionr', testing=True)
2018-01-06 08:51:26 +00:00
key = gpg.gen_key(input_data)
logger.info("Generating PGP key, this will take some time..")
while key.status != "key created":
time.sleep(0.5)
print(key.status)
logger.info("Finished generating PGP key")
2018-01-20 07:23:09 +00:00
# Write the key
myFingerpintFile = open('data/own-fingerprint.txt', 'w')
myFingerpintFile.write(key.fingerprint)
myFingerpintFile.close()
2018-01-06 08:51:26 +00:00
return
2018-01-10 03:50:38 +00:00
def addPeer(self, peerID, name=''):
'''
Add a peer by their ID, with an optional name, to the peer database
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-01-26 09:46:21 +00:00
if not self._utils.validateID(peerID):
return False
conn = sqlite3.connect(self.peerDB)
c = conn.cursor()
t = (peerID, name, 'unknown')
c.execute('INSERT INTO peers (id, name, dateSeen) VALUES(?, ?, ?);', t)
conn.commit()
conn.close()
return True
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,
pgpKey text,
hmacKey text,
blockDBHash text,
forwardKey text,
dateSeen not null,
bytesStored int,
trust 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:
dataFile = open(self.blockDataLocation + hash + '.dat')
data = dataFile.read()
dataFile.close()
except FileNotFoundError:
data = False
return data
def setData(self, data):
'''
Set the data assciated with a hash
'''
2018-01-25 22:39:09 +00:00
data = data.encode()
hasher = hashlib.sha3_256()
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:
blockFile = open(blockFileName, 'w')
2018-01-27 21:49:48 +00:00
blockFile.write(data.decode())
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()
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()
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:
c.execute('delete from commands;')
conn.commit()
except:
pass
2018-01-27 01:16:15 +00:00
conn.close()
return
def generateHMAC(self, length=32):
'''
Generate and return an HMAC key
'''
key = base64.b64encode(os.urandom(length))
2018-01-25 22:39:09 +00:00
return key
2018-01-28 01:53:24 +00:00
def listPeers(self, randomOrder=True):
'''
Return a list of peers
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-01-28 01:53:24 +00:00
if randomOrder:
peers = c.execute('SELECT * FROM peers ORDER BY RANDOM();')
2018-01-28 01:53:24 +00:00
else:
peers = c.execute('SELECT * FROM peers;')
2018-01-26 06:28:11 +00:00
peerList = []
for i in peers:
peerList.append(i[0])
conn.close()
2018-01-26 06:28:11 +00:00
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
pgpKey text, 2
hmacKey text, 3
blockDBHash text, 4
forwardKey text, 5
dateSeen not null, 7
bytesStored int, 8
trust int 9
2018-01-26 06:28:11 +00:00
'''
conn = sqlite3.connect(self.peerDB)
c = conn.cursor()
command = (peer,)
infoNumbers = {'id': 0, 'name': 1, 'pgpKey': 2, 'hmacKey': 3, 'blockDBHash': 4, 'forwardKey': 5, 'dateSeen': 6, 'bytesStored': 7, 'trust': 8}
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
if key not in ('id', 'text', 'name', 'pgpKey', 'hmacKey', '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-01-26 06:28:11 +00:00
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:
execute = 'SELECT hash FROM hashes where dataSaved != 1;'
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