From a85cf6a49c55fbb2049656993a0dda6b27cf51e3 Mon Sep 17 00:00:00 2001 From: william Date: Fri, 30 Jan 2015 11:32:05 -0500 Subject: [PATCH 01/13] refactor, 1/2 done --- src/api.py | 857 ++-------------------------------------------- src/helper_api.py | 846 +++++++++++++++++++++++++++++++++++++++++++++ start.sh | 2 + 3 files changed, 878 insertions(+), 827 deletions(-) create mode 100644 src/helper_api.py create mode 100644 start.sh diff --git a/src/api.py b/src/api.py index 9e498f463b..1ac0658bca 100644 --- a/src/api.py +++ b/src/api.py @@ -17,23 +17,17 @@ import shared import time -from addresses import decodeAddress,addBMIfNotPresent,decodeVarint,calculateInventoryHash,varintDecodeError -import helper_inbox -import helper_sent + import hashlib +from helper_api import _handle_request + from pyelliptic.openssl import OpenSSL from struct import pack # Classes -from helper_sql import sqlQuery,sqlExecute,SqlBulkExecute from debug import logger -# Helper Functions -import proofofwork - -str_chan = '[chan]' - class APIError(Exception): def __init__(self, error_number, error_message): @@ -90,7 +84,7 @@ def do_POST(self): else: # got a valid XML RPC response self.send_response(200) - self.send_header("Content-type", "text/xml") + self.send_header("Content-type", "application/json") self.send_header("Content-length", str(len(response))) # HACK :start -> sends cookies here @@ -149,812 +143,7 @@ def _verifyAddress(self, address): return (status, addressVersionNumber, streamNumber, ripe) - def _handle_request(self, method, params): - if method == 'helloWorld': - (a, b) = params - return a + '-' + b - elif method == 'add': - (a, b) = params - return a + b - elif method == 'statusBar': - message, = params - shared.UISignalQueue.put(('updateStatusBar', message)) - elif method == 'listAddresses' or method == 'listAddresses2': - data = '{"addresses":[' - configSections = shared.config.sections() - for addressInKeysFile in configSections: - if addressInKeysFile != 'bitmessagesettings': - status, addressVersionNumber, streamNumber, hash01 = decodeAddress( - addressInKeysFile) - if len(data) > 20: - data += ',' - if shared.config.has_option(addressInKeysFile, 'chan'): - chan = shared.config.getboolean(addressInKeysFile, 'chan') - else: - chan = False - label = shared.config.get(addressInKeysFile, 'label') - if method == 'listAddresses2': - label = label.encode('base64') - data += json.dumps({'label': label, 'address': addressInKeysFile, 'stream': - streamNumber, 'enabled': shared.config.getboolean(addressInKeysFile, 'enabled'), 'chan': chan}, indent=4, separators=(',', ': ')) - data += ']}' - return data - elif method == 'listAddressBookEntries' or method == 'listAddressbook': # the listAddressbook alias should be removed eventually. - queryreturn = sqlQuery('''SELECT label, address from addressbook''') - data = '{"addresses":[' - for row in queryreturn: - label, address = row - label = shared.fixPotentiallyInvalidUTF8Data(label) - if len(data) > 20: - data += ',' - data += json.dumps({'label':label.encode('base64'), 'address': address}, indent=4, separators=(',', ': ')) - data += ']}' - return data - elif method == 'addAddressBookEntry' or method == 'addAddressbook': # the addAddressbook alias should be deleted eventually. - if len(params) != 2: - raise APIError(0, "I need label and address") - address, label = params - label = self._decode(label, "base64") - address = addBMIfNotPresent(address) - self._verifyAddress(address) - queryreturn = sqlQuery("SELECT address FROM addressbook WHERE address=?", address) - if queryreturn != []: - raise APIError(16, 'You already have this address in your address book.') - - sqlExecute("INSERT INTO addressbook VALUES(?,?)", label, address) - shared.UISignalQueue.put(('rerenderInboxFromLabels','')) - shared.UISignalQueue.put(('rerenderSentToLabels','')) - shared.UISignalQueue.put(('rerenderAddressBook','')) - return "Added address %s to address book" % address - elif method == 'deleteAddressBookEntry' or method == 'deleteAddressbook': # The deleteAddressbook alias should be deleted eventually. - if len(params) != 1: - raise APIError(0, "I need an address") - address, = params - address = addBMIfNotPresent(address) - self._verifyAddress(address) - sqlExecute('DELETE FROM addressbook WHERE address=?', address) - shared.UISignalQueue.put(('rerenderInboxFromLabels','')) - shared.UISignalQueue.put(('rerenderSentToLabels','')) - shared.UISignalQueue.put(('rerenderAddressBook','')) - return "Deleted address book entry for %s if it existed" % address - elif method == 'createRandomAddress': - if len(params) == 0: - raise APIError(0, 'I need parameters!') - elif len(params) == 1: - label, = params - eighteenByteRipe = False - nonceTrialsPerByte = shared.config.get( - 'bitmessagesettings', 'defaultnoncetrialsperbyte') - payloadLengthExtraBytes = shared.config.get( - 'bitmessagesettings', 'defaultpayloadlengthextrabytes') - elif len(params) == 2: - label, eighteenByteRipe = params - nonceTrialsPerByte = shared.config.get( - 'bitmessagesettings', 'defaultnoncetrialsperbyte') - payloadLengthExtraBytes = shared.config.get( - 'bitmessagesettings', 'defaultpayloadlengthextrabytes') - elif len(params) == 3: - label, eighteenByteRipe, totalDifficulty = params - nonceTrialsPerByte = int( - shared.networkDefaultProofOfWorkNonceTrialsPerByte * totalDifficulty) - payloadLengthExtraBytes = shared.config.get( - 'bitmessagesettings', 'defaultpayloadlengthextrabytes') - elif len(params) == 4: - label, eighteenByteRipe, totalDifficulty, smallMessageDifficulty = params - nonceTrialsPerByte = int( - shared.networkDefaultProofOfWorkNonceTrialsPerByte * totalDifficulty) - payloadLengthExtraBytes = int( - shared.networkDefaultPayloadLengthExtraBytes * smallMessageDifficulty) - else: - raise APIError(0, 'Too many parameters!') - label = self._decode(label, "base64") - try: - unicode(label, 'utf-8') - except: - raise APIError(17, 'Label is not valid UTF-8 data.') - shared.apiAddressGeneratorReturnQueue.queue.clear() - streamNumberForAddress = 1 - shared.addressGeneratorQueue.put(( - 'createRandomAddress', 4, streamNumberForAddress, label, 1, "", eighteenByteRipe, nonceTrialsPerByte, payloadLengthExtraBytes)) - return shared.apiAddressGeneratorReturnQueue.get() - elif method == 'createDeterministicAddresses': - if len(params) == 0: - raise APIError(0, 'I need parameters!') - elif len(params) == 1: - passphrase, = params - numberOfAddresses = 1 - addressVersionNumber = 0 - streamNumber = 0 - eighteenByteRipe = False - nonceTrialsPerByte = shared.config.get( - 'bitmessagesettings', 'defaultnoncetrialsperbyte') - payloadLengthExtraBytes = shared.config.get( - 'bitmessagesettings', 'defaultpayloadlengthextrabytes') - elif len(params) == 2: - passphrase, numberOfAddresses = params - addressVersionNumber = 0 - streamNumber = 0 - eighteenByteRipe = False - nonceTrialsPerByte = shared.config.get( - 'bitmessagesettings', 'defaultnoncetrialsperbyte') - payloadLengthExtraBytes = shared.config.get( - 'bitmessagesettings', 'defaultpayloadlengthextrabytes') - elif len(params) == 3: - passphrase, numberOfAddresses, addressVersionNumber = params - streamNumber = 0 - eighteenByteRipe = False - nonceTrialsPerByte = shared.config.get( - 'bitmessagesettings', 'defaultnoncetrialsperbyte') - payloadLengthExtraBytes = shared.config.get( - 'bitmessagesettings', 'defaultpayloadlengthextrabytes') - elif len(params) == 4: - passphrase, numberOfAddresses, addressVersionNumber, streamNumber = params - eighteenByteRipe = False - nonceTrialsPerByte = shared.config.get( - 'bitmessagesettings', 'defaultnoncetrialsperbyte') - payloadLengthExtraBytes = shared.config.get( - 'bitmessagesettings', 'defaultpayloadlengthextrabytes') - elif len(params) == 5: - passphrase, numberOfAddresses, addressVersionNumber, streamNumber, eighteenByteRipe = params - nonceTrialsPerByte = shared.config.get( - 'bitmessagesettings', 'defaultnoncetrialsperbyte') - payloadLengthExtraBytes = shared.config.get( - 'bitmessagesettings', 'defaultpayloadlengthextrabytes') - elif len(params) == 6: - passphrase, numberOfAddresses, addressVersionNumber, streamNumber, eighteenByteRipe, totalDifficulty = params - nonceTrialsPerByte = int( - shared.networkDefaultProofOfWorkNonceTrialsPerByte * totalDifficulty) - payloadLengthExtraBytes = shared.config.get( - 'bitmessagesettings', 'defaultpayloadlengthextrabytes') - elif len(params) == 7: - passphrase, numberOfAddresses, addressVersionNumber, streamNumber, eighteenByteRipe, totalDifficulty, smallMessageDifficulty = params - nonceTrialsPerByte = int( - shared.networkDefaultProofOfWorkNonceTrialsPerByte * totalDifficulty) - payloadLengthExtraBytes = int( - shared.networkDefaultPayloadLengthExtraBytes * smallMessageDifficulty) - else: - raise APIError(0, 'Too many parameters!') - if len(passphrase) == 0: - raise APIError(1, 'The specified passphrase is blank.') - if not isinstance(eighteenByteRipe, bool): - raise APIError(23, 'Bool expected in eighteenByteRipe, saw %s instead' % type(eighteenByteRipe)) - passphrase = self._decode(passphrase, "base64") - if addressVersionNumber == 0: # 0 means "just use the proper addressVersionNumber" - addressVersionNumber = 4 - if addressVersionNumber != 3 and addressVersionNumber != 4: - raise APIError(2,'The address version number currently must be 3, 4, or 0 (which means auto-select). ' + addressVersionNumber + ' isn\'t supported.') - if streamNumber == 0: # 0 means "just use the most available stream" - streamNumber = 1 - if streamNumber != 1: - raise APIError(3,'The stream number must be 1 (or 0 which means auto-select). Others aren\'t supported.') - if numberOfAddresses == 0: - raise APIError(4, 'Why would you ask me to generate 0 addresses for you?') - if numberOfAddresses > 999: - raise APIError(5, 'You have (accidentally?) specified too many addresses to make. Maximum 999. This check only exists to prevent mischief; if you really want to create more addresses than this, contact the Bitmessage developers and we can modify the check or you can do it yourself by searching the source code for this message.') - shared.apiAddressGeneratorReturnQueue.queue.clear() - logger.debug('Requesting that the addressGenerator create %s addresses.', numberOfAddresses) - shared.addressGeneratorQueue.put( - ('createDeterministicAddresses', addressVersionNumber, streamNumber, - 'unused API address', numberOfAddresses, passphrase, eighteenByteRipe, nonceTrialsPerByte, payloadLengthExtraBytes)) - data = '{"addresses":[' - queueReturn = shared.apiAddressGeneratorReturnQueue.get() - for item in queueReturn: - if len(data) > 20: - data += ',' - data += "\"" + item + "\"" - data += ']}' - return data - elif method == 'getDeterministicAddress': - if len(params) != 3: - raise APIError(0, 'I need exactly 3 parameters.') - passphrase, addressVersionNumber, streamNumber = params - numberOfAddresses = 1 - eighteenByteRipe = False - if len(passphrase) == 0: - raise APIError(1, 'The specified passphrase is blank.') - passphrase = self._decode(passphrase, "base64") - if addressVersionNumber != 3 and addressVersionNumber != 4: - raise APIError(2, 'The address version number currently must be 3 or 4. ' + addressVersionNumber + ' isn\'t supported.') - if streamNumber != 1: - raise APIError(3, ' The stream number must be 1. Others aren\'t supported.') - shared.apiAddressGeneratorReturnQueue.queue.clear() - logger.debug('Requesting that the addressGenerator create %s addresses.', numberOfAddresses) - shared.addressGeneratorQueue.put( - ('getDeterministicAddress', addressVersionNumber, - streamNumber, 'unused API address', numberOfAddresses, passphrase, eighteenByteRipe)) - return shared.apiAddressGeneratorReturnQueue.get() - - elif method == 'createChan': - if len(params) == 0: - raise APIError(0, 'I need parameters.') - elif len(params) == 1: - passphrase, = params - passphrase = self._decode(passphrase, "base64") - if len(passphrase) == 0: - raise APIError(1, 'The specified passphrase is blank.') - # It would be nice to make the label the passphrase but it is - # possible that the passphrase contains non-utf-8 characters. - try: - unicode(passphrase, 'utf-8') - label = str_chan + ' ' + passphrase - except: - label = str_chan + ' ' + repr(passphrase) - - addressVersionNumber = 4 - streamNumber = 1 - shared.apiAddressGeneratorReturnQueue.queue.clear() - logger.debug('Requesting that the addressGenerator create chan %s.', passphrase) - shared.addressGeneratorQueue.put(('createChan', addressVersionNumber, streamNumber, label, passphrase)) - queueReturn = shared.apiAddressGeneratorReturnQueue.get() - if len(queueReturn) == 0: - raise APIError(24, 'Chan address is already present.') - address = queueReturn[0] - return address - elif method == 'joinChan': - if len(params) < 2: - raise APIError(0, 'I need two parameters.') - elif len(params) == 2: - passphrase, suppliedAddress= params - passphrase = self._decode(passphrase, "base64") - if len(passphrase) == 0: - raise APIError(1, 'The specified passphrase is blank.') - # It would be nice to make the label the passphrase but it is - # possible that the passphrase contains non-utf-8 characters. - try: - unicode(passphrase, 'utf-8') - label = str_chan + ' ' + passphrase - except: - label = str_chan + ' ' + repr(passphrase) - - status, addressVersionNumber, streamNumber, toRipe = self._verifyAddress(suppliedAddress) - suppliedAddress = addBMIfNotPresent(suppliedAddress) - shared.apiAddressGeneratorReturnQueue.queue.clear() - shared.addressGeneratorQueue.put(('joinChan', suppliedAddress, label, passphrase)) - addressGeneratorReturnValue = shared.apiAddressGeneratorReturnQueue.get() - - if addressGeneratorReturnValue == 'chan name does not match address': - raise APIError(18, 'Chan name does not match address.') - if len(addressGeneratorReturnValue) == 0: - raise APIError(24, 'Chan address is already present.') - #TODO: this variable is not used to anything - createdAddress = addressGeneratorReturnValue[0] # in case we ever want it for anything. - return "success" - elif method == 'leaveChan': - if len(params) == 0: - raise APIError(0, 'I need parameters.') - elif len(params) == 1: - address, = params - status, addressVersionNumber, streamNumber, toRipe = self._verifyAddress(address) - address = addBMIfNotPresent(address) - if not shared.config.has_section(address): - raise APIError(13, 'Could not find this address in your keys.dat file.') - if not shared.safeConfigGetBoolean(address, 'chan'): - raise APIError(25, 'Specified address is not a chan address. Use deleteAddress API call instead.') - shared.config.remove_section(address) - shared.writeKeysFile() - return 'success' - - elif method == 'deleteAddress': - if len(params) == 0: - raise APIError(0, 'I need parameters.') - elif len(params) == 1: - address, = params - status, addressVersionNumber, streamNumber, toRipe = self._verifyAddress(address) - address = addBMIfNotPresent(address) - if not shared.config.has_section(address): - raise APIError(13, 'Could not find this address in your keys.dat file.') - shared.config.remove_section(address) - shared.writeKeysFile() - shared.UISignalQueue.put(('rerenderInboxFromLabels','')) - shared.UISignalQueue.put(('rerenderSentToLabels','')) - shared.reloadMyAddressHashes() - return 'success' - - elif method == 'getAllInboxMessages': - queryreturn = sqlQuery( - '''SELECT msgid, toaddress, fromaddress, subject, received, message, encodingtype, read FROM inbox where folder='inbox' ORDER BY received''') - data = '{"inboxMessages":[' - for row in queryreturn: - msgid, toAddress, fromAddress, subject, received, message, encodingtype, read = row - subject = shared.fixPotentiallyInvalidUTF8Data(subject) - message = shared.fixPotentiallyInvalidUTF8Data(message) - if len(data) > 25: - data += ',' - data += json.dumps({'msgid': msgid.encode('hex'), 'toAddress': toAddress, 'fromAddress': fromAddress, 'subject': subject.encode( - 'base64'), 'message': message.encode('base64'), 'encodingType': encodingtype, 'receivedTime': received, 'read': read}, indent=4, separators=(',', ': ')) - data += ']}' - return data - elif method == 'getAllInboxMessageIds' or method == 'getAllInboxMessageIDs': - queryreturn = sqlQuery( - '''SELECT msgid FROM inbox where folder='inbox' ORDER BY received''') - data = '{"inboxMessageIds":[' - for row in queryreturn: - msgid = row[0] - if len(data) > 25: - data += ',' - data += json.dumps({'msgid': msgid.encode('hex')}, indent=4, separators=(',', ': ')) - data += ']}' - return data - elif method == 'getInboxMessageById' or method == 'getInboxMessageByID': - if len(params) == 0: - raise APIError(0, 'I need parameters!') - elif len(params) == 1: - msgid = self._decode(params[0], "hex") - elif len(params) >= 2: - msgid = self._decode(params[0], "hex") - readStatus = params[1] - if not isinstance(readStatus, bool): - raise APIError(23, 'Bool expected in readStatus, saw %s instead.' % type(readStatus)) - queryreturn = sqlQuery('''SELECT read FROM inbox WHERE msgid=?''', msgid) - # UPDATE is slow, only update if status is different - if queryreturn != [] and (queryreturn[0][0] == 1) != readStatus: - sqlExecute('''UPDATE inbox set read = ? WHERE msgid=?''', readStatus, msgid) - shared.UISignalQueue.put(('changedInboxUnread', None)) - queryreturn = sqlQuery('''SELECT msgid, toaddress, fromaddress, subject, received, message, encodingtype, read FROM inbox WHERE msgid=?''', msgid) - data = '{"inboxMessage":[' - for row in queryreturn: - msgid, toAddress, fromAddress, subject, received, message, encodingtype, read = row - subject = shared.fixPotentiallyInvalidUTF8Data(subject) - message = shared.fixPotentiallyInvalidUTF8Data(message) - data += json.dumps({'msgid':msgid.encode('hex'), 'toAddress':toAddress, 'fromAddress':fromAddress, 'subject':subject.encode('base64'), 'message':message.encode('base64'), 'encodingType':encodingtype, 'receivedTime':received, 'read': read}, indent=4, separators=(',', ': ')) - data += ']}' - return data - elif method == 'getAllSentMessages': - queryreturn = sqlQuery('''SELECT msgid, toaddress, fromaddress, subject, lastactiontime, message, encodingtype, status, ackdata FROM sent where folder='sent' ORDER BY lastactiontime''') - data = '{"sentMessages":[' - for row in queryreturn: - msgid, toAddress, fromAddress, subject, lastactiontime, message, encodingtype, status, ackdata = row - subject = shared.fixPotentiallyInvalidUTF8Data(subject) - message = shared.fixPotentiallyInvalidUTF8Data(message) - if len(data) > 25: - data += ',' - data += json.dumps({'msgid':msgid.encode('hex'), 'toAddress':toAddress, 'fromAddress':fromAddress, 'subject':subject.encode('base64'), 'message':message.encode('base64'), 'encodingType':encodingtype, 'lastActionTime':lastactiontime, 'status':status, 'ackData':ackdata.encode('hex')}, indent=4, separators=(',', ': ')) - data += ']}' - return data - elif method == 'getAllSentMessageIds' or method == 'getAllSentMessageIDs': - queryreturn = sqlQuery('''SELECT msgid FROM sent where folder='sent' ORDER BY lastactiontime''') - data = '{"sentMessageIds":[' - for row in queryreturn: - msgid = row[0] - if len(data) > 25: - data += ',' - data += json.dumps({'msgid':msgid.encode('hex')}, indent=4, separators=(',', ': ')) - data += ']}' - return data - elif method == 'getInboxMessagesByReceiver' or method == 'getInboxMessagesByAddress': #after some time getInboxMessagesByAddress should be removed - if len(params) == 0: - raise APIError(0, 'I need parameters!') - toAddress = params[0] - queryreturn = sqlQuery('''SELECT msgid, toaddress, fromaddress, subject, received, message, encodingtype FROM inbox WHERE folder='inbox' AND toAddress=?''', toAddress) - data = '{"inboxMessages":[' - for row in queryreturn: - msgid, toAddress, fromAddress, subject, received, message, encodingtype = row - subject = shared.fixPotentiallyInvalidUTF8Data(subject) - message = shared.fixPotentiallyInvalidUTF8Data(message) - if len(data) > 25: - data += ',' - data += json.dumps({'msgid':msgid.encode('hex'), 'toAddress':toAddress, 'fromAddress':fromAddress, 'subject':subject.encode('base64'), 'message':message.encode('base64'), 'encodingType':encodingtype, 'receivedTime':received}, indent=4, separators=(',', ': ')) - data += ']}' - return data - elif method == 'getSentMessageById' or method == 'getSentMessageByID': - if len(params) == 0: - raise APIError(0, 'I need parameters!') - msgid = self._decode(params[0], "hex") - queryreturn = sqlQuery('''SELECT msgid, toaddress, fromaddress, subject, lastactiontime, message, encodingtype, status, ackdata FROM sent WHERE msgid=?''', msgid) - data = '{"sentMessage":[' - for row in queryreturn: - msgid, toAddress, fromAddress, subject, lastactiontime, message, encodingtype, status, ackdata = row - subject = shared.fixPotentiallyInvalidUTF8Data(subject) - message = shared.fixPotentiallyInvalidUTF8Data(message) - data += json.dumps({'msgid':msgid.encode('hex'), 'toAddress':toAddress, 'fromAddress':fromAddress, 'subject':subject.encode('base64'), 'message':message.encode('base64'), 'encodingType':encodingtype, 'lastActionTime':lastactiontime, 'status':status, 'ackData':ackdata.encode('hex')}, indent=4, separators=(',', ': ')) - data += ']}' - return data - elif method == 'getSentMessagesByAddress' or method == 'getSentMessagesBySender': - if len(params) == 0: - raise APIError(0, 'I need parameters!') - fromAddress = params[0] - queryreturn = sqlQuery('''SELECT msgid, toaddress, fromaddress, subject, lastactiontime, message, encodingtype, status, ackdata FROM sent WHERE folder='sent' AND fromAddress=? ORDER BY lastactiontime''', - fromAddress) - data = '{"sentMessages":[' - for row in queryreturn: - msgid, toAddress, fromAddress, subject, lastactiontime, message, encodingtype, status, ackdata = row - subject = shared.fixPotentiallyInvalidUTF8Data(subject) - message = shared.fixPotentiallyInvalidUTF8Data(message) - if len(data) > 25: - data += ',' - data += json.dumps({'msgid':msgid.encode('hex'), 'toAddress':toAddress, 'fromAddress':fromAddress, 'subject':subject.encode('base64'), 'message':message.encode('base64'), 'encodingType':encodingtype, 'lastActionTime':lastactiontime, 'status':status, 'ackData':ackdata.encode('hex')}, indent=4, separators=(',', ': ')) - data += ']}' - return data - elif method == 'getSentMessageByAckData': - if len(params) == 0: - raise APIError(0, 'I need parameters!') - ackData = self._decode(params[0], "hex") - queryreturn = sqlQuery('''SELECT msgid, toaddress, fromaddress, subject, lastactiontime, message, encodingtype, status, ackdata FROM sent WHERE ackdata=?''', - ackData) - data = '{"sentMessage":[' - for row in queryreturn: - msgid, toAddress, fromAddress, subject, lastactiontime, message, encodingtype, status, ackdata = row - subject = shared.fixPotentiallyInvalidUTF8Data(subject) - message = shared.fixPotentiallyInvalidUTF8Data(message) - data += json.dumps({'msgid':msgid.encode('hex'), 'toAddress':toAddress, 'fromAddress':fromAddress, 'subject':subject.encode('base64'), 'message':message.encode('base64'), 'encodingType':encodingtype, 'lastActionTime':lastactiontime, 'status':status, 'ackData':ackdata.encode('hex')}, indent=4, separators=(',', ': ')) - data += ']}' - return data - elif method == 'trashMessage': - if len(params) == 0: - raise APIError(0, 'I need parameters!') - msgid = self._decode(params[0], "hex") - - # Trash if in inbox table - helper_inbox.trash(msgid) - # Trash if in sent table - sqlExecute('''UPDATE sent SET folder='trash' WHERE msgid=?''', msgid) - return 'Trashed message (assuming message existed).' - elif method == 'trashInboxMessage': - if len(params) == 0: - raise APIError(0, 'I need parameters!') - msgid = self._decode(params[0], "hex") - helper_inbox.trash(msgid) - return 'Trashed inbox message (assuming message existed).' - elif method == 'trashSentMessage': - if len(params) == 0: - raise APIError(0, 'I need parameters!') - msgid = self._decode(params[0], "hex") - sqlExecute('''UPDATE sent SET folder='trash' WHERE msgid=?''', msgid) - return 'Trashed sent message (assuming message existed).' - elif method == 'trashSentMessageByAckData': - # This API method should only be used when msgid is not available - if len(params) == 0: - raise APIError(0, 'I need parameters!') - ackdata = self._decode(params[0], "hex") - sqlExecute('''UPDATE sent SET folder='trash' WHERE ackdata=?''', - ackdata) - return 'Trashed sent message (assuming message existed).' - elif method == 'sendMessage': - if len(params) == 0: - raise APIError(0, 'I need parameters!') - elif len(params) == 4: - toAddress, fromAddress, subject, message = params - encodingType = 2 - elif len(params) == 5: - toAddress, fromAddress, subject, message, encodingType = params - if encodingType != 2: - raise APIError(6, 'The encoding type must be 2 because that is the only one this program currently supports.') - subject = self._decode(subject, "base64") - message = self._decode(message, "base64") - if len(subject + message) > (2 ** 18 - 500): - raise APIError(27, 'Message is too long.') - toAddress = addBMIfNotPresent(toAddress) - fromAddress = addBMIfNotPresent(fromAddress) - status, addressVersionNumber, streamNumber, toRipe = self._verifyAddress(toAddress) - self._verifyAddress(fromAddress) - try: - fromAddressEnabled = shared.config.getboolean( - fromAddress, 'enabled') - except: - raise APIError(13, 'Could not find your fromAddress in the keys.dat file.') - if not fromAddressEnabled: - raise APIError(14, 'Your fromAddress is disabled. Cannot send.') - - ackdata = OpenSSL.rand(32) - - t = ('', toAddress, toRipe, fromAddress, subject, message, ackdata, int( - time.time()), 'msgqueued', 1, 1, 'sent', 2) - helper_sent.insert(t) - - toLabel = '' - queryreturn = sqlQuery('''select label from addressbook where address=?''', toAddress) - if queryreturn != []: - for row in queryreturn: - toLabel, = row - # apiSignalQueue.put(('displayNewSentMessage',(toAddress,toLabel,fromAddress,subject,message,ackdata))) - shared.UISignalQueue.put(('displayNewSentMessage', ( - toAddress, toLabel, fromAddress, subject, message, ackdata))) - - shared.workerQueue.put(('sendmessage', toAddress)) - - return ackdata.encode('hex') - - elif method == 'sendBroadcast': - if len(params) == 0: - raise APIError(0, 'I need parameters!') - if len(params) == 3: - fromAddress, subject, message = params - encodingType = 2 - elif len(params) == 4: - fromAddress, subject, message, encodingType = params - if encodingType != 2: - raise APIError(6, 'The encoding type must be 2 because that is the only one this program currently supports.') - subject = self._decode(subject, "base64") - message = self._decode(message, "base64") - if len(subject + message) > (2 ** 18 - 500): - raise APIError(27, 'Message is too long.') - fromAddress = addBMIfNotPresent(fromAddress) - self._verifyAddress(fromAddress) - try: - fromAddressEnabled = shared.config.getboolean( - fromAddress, 'enabled') - except: - raise APIError(13, 'could not find your fromAddress in the keys.dat file.') - ackdata = OpenSSL.rand(32) - toAddress = '[Broadcast subscribers]' - ripe = '' - - - t = ('', toAddress, ripe, fromAddress, subject, message, ackdata, int( - time.time()), 'broadcastqueued', 1, 1, 'sent', 2) - helper_sent.insert(t) - - toLabel = '[Broadcast subscribers]' - shared.UISignalQueue.put(('displayNewSentMessage', ( - toAddress, toLabel, fromAddress, subject, message, ackdata))) - shared.workerQueue.put(('sendbroadcast', '')) - - return ackdata.encode('hex') - elif method == 'getStatus': - if len(params) != 1: - raise APIError(0, 'I need one parameter!') - ackdata, = params - if len(ackdata) != 64: - raise APIError(15, 'The length of ackData should be 32 bytes (encoded in hex thus 64 characters).') - ackdata = self._decode(ackdata, "hex") - queryreturn = sqlQuery( - '''SELECT status FROM sent where ackdata=?''', - ackdata) - if queryreturn == []: - return 'notfound' - for row in queryreturn: - status, = row - return status - elif method == 'addSubscription': - if len(params) == 0: - raise APIError(0, 'I need parameters!') - if len(params) == 1: - address, = params - label = '' - if len(params) == 2: - address, label = params - label = self._decode(label, "base64") - try: - unicode(label, 'utf-8') - except: - raise APIError(17, 'Label is not valid UTF-8 data.') - if len(params) > 2: - raise APIError(0, 'I need either 1 or 2 parameters!') - address = addBMIfNotPresent(address) - self._verifyAddress(address) - # First we must check to see if the address is already in the - # subscriptions list. - queryreturn = sqlQuery('''select * from subscriptions where address=?''', address) - if queryreturn != []: - raise APIError(16, 'You are already subscribed to that address.') - sqlExecute('''INSERT INTO subscriptions VALUES (?,?,?)''',label, address, True) - shared.reloadBroadcastSendersForWhichImWatching() - shared.UISignalQueue.put(('rerenderInboxFromLabels', '')) - shared.UISignalQueue.put(('rerenderSubscriptions', '')) - return 'Added subscription.' - - elif method == 'addAddressToBlackWhiteList': - if len(params) == 0: - raise APIError(0, 'I need parameters!') - if len(params) == 1: - address, = params - label = '' - if len(params) == 2: - address, label = params - label = self._decode(label, "base64") - try: - unicode(label, 'utf-8') - except: - raise APIError(17, 'Label is not valid UTF-8 data.') - if len(params) > 2: - raise APIError(0, 'I need either 1 or 2 parameters!') - address = addBMIfNotPresent(address) - self._verifyAddress(address) - - table = '' - if shared.config.get('bitmessagesettings', 'blackwhitelist') == 'black': - table = 'blacklist' - else: - table = 'whitelist' - - # First we must check to see if the address is already in the - # black-/white-list. - queryreturn = sqlQuery('''select * from '''+table+''' where address=?''', address) - if queryreturn != []: - raise APIError(28, 'You have already black-/white-listed that address.') - sqlExecute('''INSERT INTO '''+table+''' VALUES (?,?,?)''',label, address, True) - shared.UISignalQueue.put(('rerenderBlackWhiteList', '')) - return 'Added black-/white-list entry.' - - elif method == 'removeAddressFromBlackWhiteList': - if len(params) != 1: - raise APIError(0, 'I need 1 parameter!') - address, = params - address = addBMIfNotPresent(address) - - table = '' - if shared.config.get('bitmessagesettings', 'blackwhitelist') == 'black': - table = 'blacklist' - else: - table = 'whitelist' - - # First we must check to see if the address is already in the - # black-/white-list. - queryreturn = sqlQuery('''select * from '''+table+''' where address=?''', address) - if queryreturn == []: - raise APIError(29, 'That entry does not exist in the black-/white-list.') - - sqlExecute('''DELETE FROM '''+table+''' WHERE address=?''', address) - shared.UISignalQueue.put(('rerenderBlackWhiteList', '')) - return 'Deleted black-/white-list entry if it existed.' - - elif method == 'deleteSubscription': - if len(params) != 1: - raise APIError(0, 'I need 1 parameter!') - address, = params - address = addBMIfNotPresent(address) - sqlExecute('''DELETE FROM subscriptions WHERE address=?''', address) - shared.reloadBroadcastSendersForWhichImWatching() - shared.UISignalQueue.put(('rerenderInboxFromLabels', '')) - shared.UISignalQueue.put(('rerenderSubscriptions', '')) - return 'Deleted subscription if it existed.' - elif method == 'listSubscriptions': - queryreturn = sqlQuery('''SELECT label, address, enabled FROM subscriptions''') - data = '{"subscriptions":[' - for row in queryreturn: - label, address, enabled = row - label = shared.fixPotentiallyInvalidUTF8Data(label) - if len(data) > 20: - data += ',' - data += json.dumps({'label':label.encode('base64'), 'address': address, 'enabled': enabled == 1}, indent=4, separators=(',',': ')) - data += ']}' - return data - elif method == 'disseminatePreEncryptedMsg': - # The device issuing this command to PyBitmessage supplies a msg object that has - # already been encrypted but which still needs the POW to be done. PyBitmessage - # accepts this msg object and sends it out to the rest of the Bitmessage network - # as if it had generated the message itself. Please do not yet add this to the - # api doc. - if len(params) != 3: - raise APIError(0, 'I need 3 parameter!') - encryptedPayload, requiredAverageProofOfWorkNonceTrialsPerByte, requiredPayloadLengthExtraBytes = params - encryptedPayload = self._decode(encryptedPayload, "hex") - # Let us do the POW and attach it to the front - target = 2**64 / ((len(encryptedPayload)+requiredPayloadLengthExtraBytes+8) * requiredAverageProofOfWorkNonceTrialsPerByte) - with shared.printLock: - print '(For msg message via API) Doing proof of work. Total required difficulty:', float(requiredAverageProofOfWorkNonceTrialsPerByte) / shared.networkDefaultProofOfWorkNonceTrialsPerByte, 'Required small message difficulty:', float(requiredPayloadLengthExtraBytes) / shared.networkDefaultPayloadLengthExtraBytes - powStartTime = time.time() - initialHash = hashlib.sha512(encryptedPayload).digest() - trialValue, nonce = proofofwork.run(target, initialHash) - with shared.printLock: - print '(For msg message via API) Found proof of work', trialValue, 'Nonce:', nonce - try: - print 'POW took', int(time.time() - powStartTime), 'seconds.', nonce / (time.time() - powStartTime), 'nonce trials per second.' - except: - pass - encryptedPayload = pack('>Q', nonce) + encryptedPayload - toStreamNumber = decodeVarint(encryptedPayload[16:26])[0] - inventoryHash = calculateInventoryHash(encryptedPayload) - objectType = 2 - TTL = 2.5 * 24 * 60 * 60 - shared.inventory[inventoryHash] = ( - objectType, toStreamNumber, encryptedPayload, int(time.time()) + TTL,'') - shared.inventorySets[toStreamNumber].add(inventoryHash) - with shared.printLock: - print 'Broadcasting inv for msg(API disseminatePreEncryptedMsg command):', inventoryHash.encode('hex') - shared.broadcastToSendDataQueues(( - toStreamNumber, 'advertiseobject', inventoryHash)) - elif method == 'disseminatePubkey': - # The device issuing this command to PyBitmessage supplies a pubkey object to be - # disseminated to the rest of the Bitmessage network. PyBitmessage accepts this - # pubkey object and sends it out to the rest of the Bitmessage network as if it - # had generated the pubkey object itself. Please do not yet add this to the api - # doc. - if len(params) != 1: - raise APIError(0, 'I need 1 parameter!') - payload, = params - payload = self._decode(payload, "hex") - - # Let us do the POW - target = 2 ** 64 / ((len(payload) + shared.networkDefaultPayloadLengthExtraBytes + - 8) * shared.networkDefaultProofOfWorkNonceTrialsPerByte) - print '(For pubkey message via API) Doing proof of work...' - initialHash = hashlib.sha512(payload).digest() - trialValue, nonce = proofofwork.run(target, initialHash) - print '(For pubkey message via API) Found proof of work', trialValue, 'Nonce:', nonce - payload = pack('>Q', nonce) + payload - - pubkeyReadPosition = 8 # bypass the nonce - if payload[pubkeyReadPosition:pubkeyReadPosition+4] == '\x00\x00\x00\x00': # if this pubkey uses 8 byte time - pubkeyReadPosition += 8 - else: - pubkeyReadPosition += 4 - addressVersion, addressVersionLength = decodeVarint(payload[pubkeyReadPosition:pubkeyReadPosition+10]) - pubkeyReadPosition += addressVersionLength - pubkeyStreamNumber = decodeVarint(payload[pubkeyReadPosition:pubkeyReadPosition+10])[0] - inventoryHash = calculateInventoryHash(payload) - objectType = 1 - #todo: support v4 pubkeys - TTL = 28 * 24 * 60 * 60 - shared.inventory[inventoryHash] = ( - objectType, pubkeyStreamNumber, payload, int(time.time()) + TTL,'') - shared.inventorySets[pubkeyStreamNumber].add(inventoryHash) - with shared.printLock: - print 'broadcasting inv within API command disseminatePubkey with hash:', inventoryHash.encode('hex') - shared.broadcastToSendDataQueues(( - streamNumber, 'advertiseobject', inventoryHash)) - elif method == 'getMessageDataByDestinationHash' or method == 'getMessageDataByDestinationTag': - # Method will eventually be used by a particular Android app to - # select relevant messages. Do not yet add this to the api - # doc. - - if len(params) != 1: - raise APIError(0, 'I need 1 parameter!') - requestedHash, = params - if len(requestedHash) != 32: - raise APIError(19, 'The length of hash should be 32 bytes (encoded in hex thus 64 characters).') - requestedHash = self._decode(requestedHash, "hex") - - # This is not a particularly commonly used API function. Before we - # use it we'll need to fill out a field in our inventory database - # which is blank by default (first20bytesofencryptedmessage). - queryreturn = sqlQuery( - '''SELECT hash, payload FROM inventory WHERE tag = '' and objecttype = 2 ; ''') - with SqlBulkExecute() as sql: - for row in queryreturn: - hash01, payload = row - readPosition = 16 # Nonce length + time length - readPosition += decodeVarint(payload[readPosition:readPosition+10])[1] # Stream Number length - t = (payload[readPosition:readPosition+32],hash01) - sql.execute('''UPDATE inventory SET tag=? WHERE hash=?; ''', *t) - - queryreturn = sqlQuery('''SELECT payload FROM inventory WHERE tag = ?''', - requestedHash) - data = '{"receivedMessageDatas":[' - for row in queryreturn: - payload, = row - if len(data) > 25: - data += ',' - data += json.dumps({'data':payload.encode('hex')}, indent=4, separators=(',', ': ')) - data += ']}' - return data - elif method == 'getPubkeyByHash': - # Method will eventually be used by a particular Android app to - # retrieve pubkeys. Please do not yet add this to the api docs. - if len(params) != 1: - raise APIError(0, 'I need 1 parameter!') - requestedHash, = params - if len(requestedHash) != 40: - raise APIError(19, 'The length of hash should be 20 bytes (encoded in hex thus 40 characters).') - requestedHash = self._decode(requestedHash, "hex") - queryreturn = sqlQuery('''SELECT transmitdata FROM pubkeys WHERE hash = ? ; ''', requestedHash) - data = '{"pubkey":[' - for row in queryreturn: - transmitdata, = row - data += json.dumps({'data':transmitdata.encode('hex')}, indent=4, separators=(',', ': ')) - data += ']}' - return data - elif method == 'clientStatus': - if len(shared.connectedHostsList) == 0: - networkStatus = 'notConnected' - elif len(shared.connectedHostsList) > 0 and not shared.clientHasReceivedIncomingConnections: - networkStatus = 'connectedButHaveNotReceivedIncomingConnections' - else: - networkStatus = 'connectedAndReceivingIncomingConnections' - return json.dumps({'networkConnections':len(shared.connectedHostsList),'numberOfMessagesProcessed':shared.numberOfMessagesProcessed, 'numberOfBroadcastsProcessed':shared.numberOfBroadcastsProcessed, 'numberOfPubkeysProcessed':shared.numberOfPubkeysProcessed, 'networkStatus':networkStatus, 'softwareName':'PyBitmessage','softwareVersion':shared.softwareVersion}, indent=4, separators=(',', ': ')) - elif method == 'decodeAddress': - # Return a meaningful decoding of an address. - if len(params) != 1: - raise APIError(0, 'I need 1 parameter!') - address, = params - status, addressVersion, streamNumber, ripe = decodeAddress(address) - return json.dumps({'status':status, 'addressVersion':addressVersion, - 'streamNumber':streamNumber, 'ripe':ripe.encode('base64')}, indent=4, - separators=(',', ': ')) - else: - raise APIError(20, 'Invalid method: %s' % method) - - def _dispatch(self, method, params): + def _dispatch( self, method, params ): self.cookies = [] validuser = self.APIAuthenticateClient() @@ -962,14 +151,28 @@ def _dispatch(self, method, params): time.sleep(2) return "RPC Username or password incorrect or HTTP header lacks authentication at all." - try: - return self._handle_request(method, params) - except APIError as e: - return str(e) - except varintDecodeError as e: - logger.error(e) - return "API Error 0026: Data contains a malformed varint. Some details: %s" % e - except Exception as e: - logger.exception(e) - return "API Error 0021: Unexpected API Failure - %s" % str(e) - + + if method in dir( _handle_request ): + logger.warn( 'Found "{}" in API'.format( method ) ) + try: + statusCode, data = object.__getattribute__( _handle_request, method )( self, *params ) + except Exception as e: + logger.exception(e) + + response = { + 'data': data, + 'status': statusCode, + 'method': method + } + return json.dumps( response ) + + # try: + # return self._handle_request(method, params) + # except APIError as e: + # return str(e) + # except varintDecodeError as e: + # logger.error(e) + # return "API Error 0026: Data contains a malformed varint. Some details: %s" % e + # except Exception as e: + # logger.exception(e) + # return "API Error 0021: Unexpected API Failure - %s" % str(e) diff --git a/src/helper_api.py b/src/helper_api.py new file mode 100644 index 0000000000..102eea78e5 --- /dev/null +++ b/src/helper_api.py @@ -0,0 +1,846 @@ +import shared +import time +import hashlib + +# Classes +from helper_sql import sqlQuery,sqlExecute,SqlBulkExecute +from debug import logger + +# Helper Functions +import proofofwork + +from addresses import decodeAddress,addBMIfNotPresent,decodeVarint,calculateInventoryHash,varintDecodeError +import helper_inbox +import helper_sent +from pyelliptic.openssl import OpenSSL + +str_chan = '[chan]' + +# class messages( array ): + +# def base( self ): +# msgid, toAddress, fromAddress, subject, message, encodingtype, received, read= query +# subject = shared.fixPotentiallyInvalidUTF8Data(subject) +# message = shared.fixPotentiallyInvalidUTF8Data(message) +# data.append({ +# 'msgid':msgid.encode('hex'), +# 'toAddress':toAddress, +# 'fromAddress':fromAddress, +# 'subject':subject.encode('base64'), +# 'message':message.encode('base64'), +# 'encodingType':encodingtype, + +# }) + +# def sent( sefl, query ): +# lastactiontime, status, ackdata = row[6:8] +# 'lastactiontime':lastactiontime, +# 'status':status, +# 'ackdata': ackdata + +# def ( self, query ): +# received, read = row[6:7] +# 'receivedTime':received +# 'read': read + +class _handle_request( object ): + def ping( self, *args ): + data = { 'pong': args } + return 200, data + + def statusBar( self, *args ): + message, = args + shared.UISignalQueue.put( ('updateStatusBar', message) ) + return 200, True + + def listAddresses( self, *args ): + data = [] + configSections = shared.config.sections() + for addressInKeysFile in configSections: + if addressInKeysFile != 'bitmessagesettings': + status, addressVersionNumber, streamNumber, hash01 = decodeAddress( addressInKeysFile ) + + if shared.config.has_option( addressInKeysFile, 'chan' ): + chan = shared.config.getboolean( addressInKeysFile, 'chan' ) + else: + chan = False + label = shared.config.get( addressInKeysFile, 'label' ).encode( 'base64' ) + + data.append({ + 'label': label, + 'address': addressInKeysFile, + 'stream': streamNumber, + 'enabled': shared.config.getboolean(addressInKeysFile, 'enabled'), + 'chan': chan + }) + return 200, data + + def listAddressBookEntries( self, *args ): + queryreturn = sqlQuery( '''SELECT label, address from addressbook''' ) + data = [] + + # if address book is empty, return nothing and stop for loop from firing. + if not queryreturn: + return data + + for row in queryreturn: + label, address = row + label = shared.fixPotentiallyInvalidUTF8Data( label ) + data.append({ + 'label':label.encode( 'base64' ), + 'address': address + }) + + return 200, data + + ''' test below this line ''' + + def addAddressBookEntry( self, *args ): ## fix verifyAddress! + if len( args ) != 2: + return 0, "I need label and address" + + address, label = args + label = self._decode( label, "base64" ) + address = addBMIfNotPresent( address ) + self._verifyAddress( address ) + queryreturn = sqlQuery( "SELECT address FROM addressbook WHERE address=?", address ) + + if queryreturn != []: + return 16, 'You already have this address in your address book.' + + sqlExecute( "INSERT INTO addressbook VALUES(?,?)", label, address ) + shared.UISignalQueue.put(('rerenderInboxFromLabels','')) + shared.UISignalQueue.put(('rerenderSentToLabels','')) + shared.UISignalQueue.put(('rerenderAddressBook','')) + return 200, address + + def deleteAddressBookEntry( self, *args ): ## fix verifyAddress! + if len( args ) != 1: + return 0, 'I need an address' + + address, = args + address = addBMIfNotPresent(address) + self._verifyAddress(address) + sqlExecute('DELETE FROM addressbook WHERE address=?', address) + shared.UISignalQueue.put(('rerenderInboxFromLabels','')) + shared.UISignalQueue.put(('rerenderSentToLabels','')) + shared.UISignalQueue.put(('rerenderAddressBook','')) + return 200, "Deleted address book entry for %s if it existed" % address + + ''' not tested above this line ''' + def createRandomAddress( self, *args ): + if not args: + return 0, 'I need parameters!' + + if len( args ) == 1: + label, = args + eighteenByteRipe = False + nonceTrialsPerByte = shared.config.get( + 'bitmessagesettings', + 'defaultnoncetrialsperbyte' + ) + payloadLengthExtraBytes = shared.config.get( + 'bitmessagesettings', + 'defaultpayloadlengthextrabytes' + ) + elif len( args ) == 2: + + label, eighteenByteRipe = args + nonceTrialsPerByte = shared.config.get( + 'bitmessagesettings', + 'defaultnoncetrialsperbyte' + ) + payloadLengthExtraBytes = shared.config.get( + 'bitmessagesettings', + 'defaultpayloadlengthextrabytes' + ) + elif len( args ) == 3: + label, eighteenByteRipe, totalDifficulty = args + nonceTrialsPerByte = int( + shared.networkDefaultProofOfWorkNonceTrialsPerByte * totalDifficulty) + payloadLengthExtraBytes = shared.config.get( + 'bitmessagesettings', + 'defaultpayloadlengthextrabytes' + ) + elif len( args ) == 4: + label, eighteenByteRipe, totalDifficulty, smallMessageDifficulty = args + nonceTrialsPerByte = int( + shared.networkDefaultProofOfWorkNonceTrialsPerByte * totalDifficulty) + payloadLengthExtraBytes = int( + shared.networkDefaultPayloadLengthExtraBytes * smallMessageDifficulty) + else: + return 0, 'Too many parameters!' + + label = self._decode(label, "base64") + try: + unicode(label, 'utf-8') + except: + return 17, 'Label is not valid UTF-8 data.' + + shared.apiAddressGeneratorReturnQueue.queue.clear() + streamNumberForAddress = 1 + shared.addressGeneratorQueue.put(( + 'createRandomAddress', + 4, + streamNumberForAddress, + label, + 1, + "", + eighteenByteRipe, + nonceTrialsPerByte, + payloadLengthExtraBytes + )) + + data = { + 'address': shared.apiAddressGeneratorReturnQueue.get(), + 'label': label + } + return 200, data + + def createDeterministicAddresses( self, *args ): # needs to be tested + if not args: + return 0, 'I need parameters!' + + if len( args ) == 1: + passphrase, = args + numberOfAddresses = 1 + addressVersionNumber = 0 + streamNumber = 0 + eighteenByteRipe = False + nonceTrialsPerByte = shared.config.get( + 'bitmessagesettings', + 'defaultnoncetrialsperbyte' + ) + payloadLengthExtraBytes = shared.config.get( + 'bitmessagesettings', + 'defaultpayloadlengthextrabytes' + ) + elif len( args ) == 2: + passphrase, numberOfAddresses = args + addressVersionNumber = 0 + streamNumber = 0 + eighteenByteRipe = False + nonceTrialsPerByte = shared.config.get( + 'bitmessagesettings', + 'defaultnoncetrialsperbyte' + ) + payloadLengthExtraBytes = shared.config.get( + 'bitmessagesettings', + 'defaultpayloadlengthextrabytes' + ) + elif len( args ) == 3: + passphrase, numberOfAddresses, addressVersionNumber = args + streamNumber = 0 + eighteenByteRipe = False + nonceTrialsPerByte = shared.config.get( + 'bitmessagesettings', + 'defaultnoncetrialsperbyte' + ) + payloadLengthExtraBytes = shared.config.get( + 'bitmessagesettings', + 'defaultpayloadlengthextrabytes' + ) + elif len( args ) == 4: + passphrase, numberOfAddresses, addressVersionNumber, streamNumber = args + eighteenByteRipe = False + nonceTrialsPerByte = shared.config.get( + 'bitmessagesettings', + 'defaultnoncetrialsperbyte' + ) + payloadLengthExtraBytes = shared.config.get( + 'bitmessagesettings', + 'defaultpayloadlengthextrabytes' + ) + elif len( args ) == 5: + passphrase, numberOfAddresses, addressVersionNumber, streamNumber, eighteenByteRipe = args + nonceTrialsPerByte = shared.config.get( + 'bitmessagesettings', + 'defaultnoncetrialsperbyte' + ) + payloadLengthExtraBytes = shared.config.get( + 'bitmessagesettings', + 'defaultpayloadlengthextrabytes' + ) + elif len( args ) == 6: + passphrase, numberOfAddresses, addressVersionNumber, streamNumber, eighteenByteRipe, totalDifficulty = args + nonceTrialsPerByte = int( + shared.networkDefaultProofOfWorkNonceTrialsPerByte * totalDifficulty) + payloadLengthExtraBytes = shared.config.get( + 'bitmessagesettings', + 'defaultpayloadlengthextrabytes' + ) + elif len( args ) == 7: + passphrase, numberOfAddresses, addressVersionNumber, streamNumber, eighteenByteRipe, totalDifficulty, smallMessageDifficulty = args + nonceTrialsPerByte = int( + shared.networkDefaultProofOfWorkNonceTrialsPerByte * totalDifficulty) + payloadLengthExtraBytes = int( + shared.networkDefaultPayloadLengthExtraBytes * smallMessageDifficulty) + else: + return 0, 'Too many parameters!' + + if len(passphrase) == 0: + return 1, 'The specified passphrase is blank.' + + if not isinstance(eighteenByteRipe, bool): + return 23, 'Bool expected in eighteenByteRipe, saw %s instead' % type(eighteenByteRipe) + + passphrase = self._decode(passphrase, "base64") + if addressVersionNumber == 0: # 0 means "just use the proper addressVersionNumber" + addressVersionNumber = 4 + + if addressVersionNumber != 3 and addressVersionNumber != 4: + return 2, 'The address version number currently must be 3, 4, or 0 (which means auto-select). ' + addressVersionNumber + ' isn\'t supported.' + + if streamNumber == 0: # 0 means "just use the most available stream" + streamNumber = 1 + + if streamNumber != 1: + return 3, 'The stream number must be 1 (or 0 which means auto-select). Others aren\'t supported.' + + if numberOfAddresses == 0: + return 4, 'Why would you ask me to generate 0 addresses for you?' + + if numberOfAddresses > 999: + return 5, 'You have (accidentally?) specified too many addresses to make. Maximum 999. This check only exists to prevent mischief; if you really want to create more addresses than this, contact the Bitmessage developers and we can modify the check or you can do it yourself by searching the source code for this message.' + + shared.apiAddressGeneratorReturnQueue.queue.clear() + logger.debug('Requesting that the addressGenerator create %s addresses.', numberOfAddresses) + shared.addressGeneratorQueue.put(( + 'createDeterministicAddresses', + addressVersionNumber, + streamNumber, + 'unused API address', + numberOfAddresses, + passphrase, + eighteenByteRipe, + nonceTrialsPerByte, + payloadLengthExtraBytes + )) + data = [] + queueReturn = shared.apiAddressGeneratorReturnQueue.get() + for item in queueReturn: + data.append( item ) + + return 200, data + + def getDeterministicAddress( self, *args ): # needs to be tested + if len( args ) != 3: + return 0, 'I need exactly 3 parameters.' + + passphrase, addressVersionNumber, streamNumber = args + numberOfAddresses = 1 + eighteenByteRipe = False + + if len( passphrase ) == 0: + return 1, 'The specified passphrase is blank.' + + passphrase = self._decode(passphrase, "base64") + if addressVersionNumber != 3 and addressVersionNumber != 4: + return 2, 'The address version number currently must be 3 or 4. ' + addressVersionNumber + ' isn\'t supported.' + + if streamNumber != 1: + return 3, ' The stream number must be 1. Others aren\'t supported.' + + shared.apiAddressGeneratorReturnQueue.queue.clear() + logger.debug('Requesting that the addressGenerator create %s addresses.', numberOfAddresses) + shared.addressGeneratorQueue.put(( + 'getDeterministicAddress', + addressVersionNumber, + streamNumber, + 'unused API address', + numberOfAddresses, + passphrase, + eighteenByteRipe + )) + return 200, shared.apiAddressGeneratorReturnQueue.get() + + def createChan( self, *args ): + if not args: + return 0, 'I need parameters.' + + if len( args ) == 1: + passphrase, = args + + passphrase = self._decode( passphrase, "base64" ) + if len( passphrase ) == 0: + return 1, 'The specified passphrase is blank.' + # It would be nice to make the label the passphrase but it is + # possible that the passphrase contains non-utf-8 characters. -wtf! + try: + unicode( passphrase, 'utf-8' ) + label = str_chan + ' ' + passphrase + except: + label = str_chan + ' ' + repr( passphrase ) + + addressVersionNumber = 4 + streamNumber = 1 + shared.apiAddressGeneratorReturnQueue.queue.clear() + logger.debug('Requesting that the addressGenerator create chan %s.', passphrase) + shared.addressGeneratorQueue.put(( + 'createChan', + addressVersionNumber, + streamNumber, + label, + passphrase + )) + queueReturn = shared.apiAddressGeneratorReturnQueue.get() + if len(queueReturn) == 0: + return 24, 'Chan address is already present.' + address = queueReturn[0] + data = { + 'address': address, + 'label': label + } + return 200, data + + def joinChan( self, *args ): + if len( args ) != 2: + return 0, 'I need two parameters.' + + passphrase, suppliedAddress = args + passphrase = self._decode( passphrase, "base64" ) + + if len( passphrase ) == 0: + return 1, 'The specified passphrase is blank.' + + # It would be nice to make the label the passphrase but it is + # possible that the passphrase contains non-utf-8 characters. + try: + unicode( passphrase, 'utf-8' ) + label = str_chan + ' ' + passphrase + except: + label = str_chan + ' ' + repr( passphrase ) + + status, addressVersionNumber, streamNumber, toRipe = self._verifyAddress(suppliedAddress) + suppliedAddress = addBMIfNotPresent(suppliedAddress) + shared.apiAddressGeneratorReturnQueue.queue.clear() + shared.addressGeneratorQueue.put(('joinChan', suppliedAddress, label, passphrase)) + addressGeneratorReturnValue = shared.apiAddressGeneratorReturnQueue.get() + + if addressGeneratorReturnValue == 'chan name does not match address': + return 18, 'Chan name does not match address.' + + if len(addressGeneratorReturnValue) == 0: + return 24, 'Chan address is already present.' + + data ={ + #TODO: this variable is not used to anything + 'createdAddress': addressGeneratorReturnValue[0] # in case we ever want it for anything. + } + return 200, data + + def leaveChan( self, *args ): + if len( args ) != 1: + return 0, 'I need parameters.' + + address, = args + status, addressVersionNumber, streamNumber, toRipe = self._verifyAddress(address) + address = addBMIfNotPresent(address) + + if not shared.config.has_section(address): + return 13, 'Could not find this address in your keys.dat file.' + + if not shared.safeConfigGetBoolean(address, 'chan'): + return 25, 'Specified address is not a chan address. Use deleteAddress API call instead.' + + shared.config.remove_section(address) + shared.writeKeysFile() + + return 200, {} + + def deleteAddress( self, *args ): + if len( args ) != 0: + return 0, 'I need parameters.' + + address, = args + status, addressVersionNumber, streamNumber, toRipe = self._verifyAddress( address ) + address = addBMIfNotPresent( address ) + if not shared.config.has_section(address): + return 13, 'Could not find this address in your keys.dat file.' + + shared.config.remove_section(address) + shared.writeKeysFile() + shared.UISignalQueue.put(('rerenderInboxFromLabels','')) + shared.UISignalQueue.put(('rerenderSentToLabels','')) + shared.reloadMyAddressHashes() + + return 200, {} + + def getAllInboxMessages( self, *args ): + queryreturn = sqlQuery('''SELECT msgid, toaddress, fromaddress, subject, received, message, encodingtype, read FROM inbox where folder='inbox' ORDER BY received''') + # data = rowMessage( queryreturn ) + print queryreturn + return 200, queryreturn + + # def getAllInboxMessageIDs( self, *args ): + # queryreturn = sqlQuery( + # '''SELECT msgid FROM inbox where folder='inbox' ORDER BY received''') + # data = [] + # for row in queryreturn: + # msgid = row[0] + # data.append({ + # 'msgid': msgid.encode('hex') + # }) + + # return 200, data + + # def getInboxMessageByID( self, *args ): + # if len( args ) not in range(1,2): + # return 0, 'I need parameters!' + + # if len(args) == 1: + # msgid = self._decode(args[0], "hex") + # elif len(args) >= 2: + # msgid = self._decode(args[0], "hex") + # readStatus = args[1] + # if not isinstance(readStatus, bool): + # return 23, 'Bool expected in readStatus, saw %s instead.' % type(readStatus) + + # queryreturn = sqlQuery('''SELECT read FROM inbox WHERE msgid=?''', msgid) + # # UPDATE is slow, only update if status is different + # if queryreturn != [] and (queryreturn[0][0] == 1) != readStatus: + # sqlExecute('''UPDATE inbox set read = ? WHERE msgid=?''', readStatus, msgid) + # shared.UISignalQueue.put(('changedInboxUnread', None)) + + # queryreturn = sqlQuery('''SELECT msgid, toaddress, fromaddress, subject, received, message, encodingtype, read FROM inbox WHERE msgid=?''', msgid) + # data = rowMessage( queryreturn ) + + # return 200, data + + # def getAllSentMessages( self, *args ): + # queryreturn = sqlQuery('''SELECT msgid, toaddress, fromaddress, subject, lastactiontime, message, encodingtype, status, ackdata FROM sent where folder='sent' ORDER BY lastactiontime''') + # data = [] + # for row in queryreturn: + # msgid, toAddress, fromAddress, subject, lastactiontime, message, encodingtype, status, ackdata = row + # subject = shared.fixPotentiallyInvalidUTF8Data(subject) + # message = shared.fixPotentiallyInvalidUTF8Data(message) + # data.append({ + # 'msgid':msgid.encode('hex'), + # 'toAddress':toAddress, + # 'fromAddress':fromAddress, + # 'subject':subject.encode('base64'), + # 'message':message.encode('base64'), + # 'encodingType':encodingtype, + # 'lastActionTime':lastactiontime, + # 'status':status, + # 'ackData':ackdata.encode('hex') + # }) + # return 200, data + + # def getAllSentMessageIDs( self, *args ): # undocumented + # queryreturn = sqlQuery('''SELECT msgid FROM sent where folder='sent' ORDER BY lastactiontime''') + # data = [] + # for row in queryreturn: + # msgid = row[0] + # data.append({ 'msgid':msgid.encode('hex') }) + + # return 200, data + + # def getInboxMessagesByToAddress( self, *args ): # renamed from getInboxMessagesByReceiver / undocumented + # if len( args ) == 0: + # return 0, 'I need parameters!' + + # toAddress = args[0] + # queryreturn = sqlQuery('''SELECT msgid, toaddress, fromaddress, subject, received, message, encodingtype, read FROM inbox WHERE folder='inbox' AND toAddress=?''', toAddress) + # data = rowMessage( queryreturn ) + # return 200, data + + # def getSentMessagesBySender( self, *args ): + # if len( args ) == 0: + # return 0, 'I need parameters!' + # fromAddress = args[0] + # queryreturn = sqlQuery('''SELECT msgid, toaddress, fromaddress, subject, lastactiontime, message, encodingtype, status, ackdata FROM sent WHERE folder='sent' AND fromAddress=? ORDER BY lastactiontime''', + # fromAddress) + # data = [] + # for row in queryreturn: + # msgid, toAddress, fromAddress, subject, lastactiontime, message, encodingtype, status, ackdata = row + # subject = shared.fixPotentiallyInvalidUTF8Data(subject) + # message = shared.fixPotentiallyInvalidUTF8Data(message) + # data.append({'msgid':msgid.encode('hex'), 'toAddress':toAddress, 'fromAddress':fromAddress, 'subject':subject.encode('base64'), 'message':message.encode('base64'), 'encodingType':encodingtype, 'lastActionTime':lastactiontime, 'status':status, 'ackData':ackdata.encode('hex')}, indent=4, separators=(',', ': ')) + # return data + + # def getSentMessageByID( self, *args ): + # if len( args ) == 0: + # return 0, 'I need parameters!' + + # msgid = self._decode( args[0], "hex") + # queryreturn = sqlQuery('''SELECT msgid, toaddress, fromaddress, subject, lastactiontime, message, encodingtype, status, ackdata FROM sent WHERE msgid=?''', msgid) + # data = [] + # for row in queryreturn: + # msgid, toAddress, fromAddress, subject, lastactiontime, message, encodingtype, status, ackdata = row + # subject = shared.fixPotentiallyInvalidUTF8Data(subject) + # message = shared.fixPotentiallyInvalidUTF8Data(message) + # data.append({ + # 'msgid':msgid.encode('hex'), + # 'toAddress':toAddress, + # 'fromAddress':fromAddress, + # 'subject':subject.encode('base64'), + # 'message':message.encode('base64'), + # 'encodingType':encodingtype, + # 'lastActionTime':lastactiontime, + # 'status':status, + # 'ackData':ackdata.encode('hex') + # }) + + # return 200, data + + # def getSentMessageByAckData( self, *args ): + # if len( args ) == 0: + # return 0, 'I need parameters!' + # ackData = self._decode( args[0], "hex" ) + # queryreturn = sqlQuery('''SELECT msgid, toaddress, fromaddress, subject, lastactiontime, message, encodingtype, status, ackdata FROM sent WHERE ackdata=?''', + # ackData) + # data = sentMessageRow( queryreturn ) + # return data + + # def trashMessage( self, *args ): + # if len( args ) == 0: + # return 0, 'I need parameters!' + # msgid = self._decode(args[0], "hex") + + # # Trash if in inbox table + # helper_inbox.trash(msgid) + # # Trash if in sent table + # sqlExecute('''UPDATE sent SET folder='trash' WHERE msgid=?''', msgid) + # return 200, 'Trashed message (assuming message existed).' + + # def trashInboxMessage( self, *args ): + # if len( args ) == 0: + # return 0, 'I need parameters!' + # msgid = self._decode(args[0], "hex") + # helper_inbox.trash(msgid) + # return 200, 'Trashed inbox message (assuming message existed).' + + # def trashInboxMessage( self, *args ): + # if len( args ) == 0: + # return 0, 'I need parameters!' + # msgid = self._decode(args[0], "hex") + # helper_inbox.trash(msgid) + # return 200, 'Trashed inbox message (assuming message existed).' + + # def trashSentMessage( self, *args ): + # if len( args ) == 0: + # return 0, 'I need parameters!' + # msgid = self._decode(args[0], "hex") + # sqlExecute('''UPDATE sent SET folder='trash' WHERE msgid=?''', msgid) + # return 200, 'Trashed sent message (assuming message existed).' + + # def trashSentMessageByAckData( self, *args ): + # # This API method should only be used when msgid is not available + # if len( args ) == 0: + # return 0, 'I need parameters!' + # ackdata = self._decode(args[0], "hex") + # sqlExecute('''UPDATE sent SET folder='trash' WHERE ackdata=?''', + # ackdata) + # return 200, 'Trashed sent message (assuming message existed).' + + # def sendMessage( self, *args ): + # if len( args ) not in [4,5]: + # return 0, 'I need parameters!' + + # elif len( args ) == 4: + # toAddress, fromAddress, subject, message = args + # encodingType = 2 + # elif len( args ) == 5: + # toAddress, fromAddress, subject, message, encodingType = args + + # if encodingType != 2: + # return 6, 'The encoding type must be 2 because that is the only one this program currently supports.' + + # subject = self._decode(subject, "base64") + # message = self._decode(message, "base64") + # if len(subject + message) > (2 ** 18 - 500): + # return 27, 'Message is too long.' + + # toAddress = addBMIfNotPresent(toAddress) + # fromAddress = addBMIfNotPresent(fromAddress) + # status, addressVersionNumber, streamNumber, toRipe = self._verifyAddress(toAddress) + # self._verifyAddress(fromAddress) + # try: + # fromAddressEnabled = shared.config.getboolean( + # fromAddress, 'enabled') + # except: + # return 13, 'Could not find your fromAddress in the keys.dat file.' + + # if not fromAddressEnabled: + # return 14, 'Your fromAddress is disabled. Cannot send.' + + # ackdata = OpenSSL.rand(32) + + # t = ('', toAddress, toRipe, fromAddress, subject, message, ackdata, int( + # time.time()), 'msgqueued', 1, 1, 'sent', 2) + # helper_sent.insert(t) + + # toLabel = '' + # queryreturn = sqlQuery('''select label from addressbook where address=?''', toAddress) + # if queryreturn != []: + # for row in queryreturn: + # toLabel, = row + # # apiSignalQueue.put(('displayNewSentMessage',(toAddress,toLabel,fromAddress,subject,message,ackdata))) + # shared.UISignalQueue.put(('displayNewSentMessage', ( + # toAddress, toLabel, fromAddress, subject, message, ackdata))) + + # shared.workerQueue.put(('sendmessage', toAddress)) + + # return 200, ackdata.encode('hex') + + # def sendBroadcast( self, *args ): + # if len(params) not in [3,4]: + # return 0, 'I need parameters!' + + # if len( args ) == 3: + # fromAddress, subject, message = args + # encodingType = 2 + # elif len(params) == 4: + # fromAddress, subject, message, encodingType = args + + # if encodingType != 2: + # return 6, 'The encoding type must be 2 because that is the only one this program currently supports.' + + # subject = self._decode(subject, "base64") + # message = self._decode(message, "base64") + # if len(subject + message) > (2 ** 18 - 500): + # return 27, 'Message is too long.' + + # fromAddress = addBMIfNotPresent(fromAddress) + # self._verifyAddress(fromAddress) + # try: + # fromAddressEnabled = shared.config.getboolean( + # fromAddress, 'enabled') + # except: + # return 13, 'could not find your fromAddress in the keys.dat file.' + + # ackdata = OpenSSL.rand(32) + # toAddress = '[Broadcast subscribers]' + # ripe = '' + + # t = ('', toAddress, ripe, fromAddress, subject, message, ackdata, int( + # time.time()), 'broadcastqueued', 1, 1, 'sent', 2) + # helper_sent.insert(t) + + # toLabel = '[Broadcast subscribers]' + # shared.UISignalQueue.put(('displayNewSentMessage', ( + # toAddress, toLabel, fromAddress, subject, message, ackdata))) + # shared.workerQueue.put(('sendbroadcast', '')) + + # return 200, ackdata.encode('hex') + + # def getStatus( self, *args ): + # if len( args ) != 1: + # return 0, 'I need one parameter!' + + # ackdata, = args + # if len(ackdata) != 64: + # return 15, 'The length of ackData should be 32 bytes (encoded in hex thus 64 characters).' + + # ackdata = self._decode(ackdata, "hex") + # queryreturn = sqlQuery( + # '''SELECT status FROM sent where ackdata=?''', + # ackdata) + # if queryreturn == []: + # return 404, 'notfound' + # for row in queryreturn: + # status, = row + # return 200, status + + # def addSubscription( self, *args ): + # if len( args ) not in [1,2]: + # return 0, 'I need parameters!' + + # if len( args ) == 1: + # address, = args + # label = '' + # if len( args ) == 2: + # address, label = args + # label = self._decode(label, "base64") + # try: + # unicode(label, 'utf-8') + # except: + # return 17, 'Label is not valid UTF-8 data.' + + # address = addBMIfNotPresent(address) + # self._verifyAddress(address) + # # First we must check to see if the address is already in the + # # subscriptions list. + # queryreturn = sqlQuery('''select * from subscriptions where address=?''', address) + # if queryreturn != []: + # return 16, 'You are already subscribed to that address.' + # sqlExecute('''INSERT INTO subscriptions VALUES (?,?,?)''',label, address, True) + # shared.reloadBroadcastSendersForWhichImWatching() + # shared.UISignalQueue.put(('rerenderInboxFromLabels', '')) + # shared.UISignalQueue.put(('rerenderSubscriptions', '')) + # return 200, 'Added subscription.' + + # def addAddressToBlackWhiteList( self, *args ): + # if len(params) not in [1,2]: + # return 0, 'I need parameters!' + + # if len( args ) == 1: + # address, = args + # label = '' + + # if len( args ) == 2: + # address, label = args + # label = self._decode(label, "base64") + # try: + # unicode(label, 'utf-8') + # except: + # return 17, 'Label is not valid UTF-8 data.' + + # if len( args ) > 2: + # return 0, 'I need either 1 or 2 parameters!' + + # address = addBMIfNotPresent(address) + # self._verifyAddress(address) + + # table = '' + # if shared.config.get('bitmessagesettings', 'blackwhitelist') == 'black': + # table = 'blacklist' + # else: + # table = 'whitelist' + + # # First we must check to see if the address is already in the + # # black-/white-list. + # queryreturn = sqlQuery('''select * from '''+table+''' where address=?''', address) + # if queryreturn != []: + # return 28, 'You have already black-/white-listed that address.' + + # sqlExecute('''INSERT INTO '''+table+''' VALUES (?,?,?)''',label, address, True) + # shared.UISignalQueue.put(('rerenderBlackWhiteList', '')) + + # return 200, 'Added black-/white-list entry.' + + # def removeAddressFromBlackWhiteList': + # if len( args ) != 1: + # return 0, 'I need 1 parameter!' + + # address, = args + # address = addBMIfNotPresent(address) + + # table = '' + # if shared.config.get('bitmessagesettings', 'blackwhitelist') == 'black': + # table = 'blacklist' + # else: + # table = 'whitelist' + + # # First we must check to see if the address is already in the + # # black-/white-list. + # queryreturn = sqlQuery('''select * from '''+table+''' where address=?''', address) + # if queryreturn == []: + # return 29, 'That entry does not exist in the black-/white-list.' + + # sqlExecute('''DELETE FROM '''+table+''' WHERE address=?''', address) + # shared.UISignalQueue.put(('rerenderBlackWhiteList', '')) + # return 200, 'Deleted black-/white-list entry if it existed.' + + # def deleteSubscription( self, *args): + # if len( args ) != 1: + # return 0, 'I need 1 parameter!' + + # address, = args + # address = addBMIfNotPresent(address) + # sqlExecute('''DELETE FROM subscriptions WHERE address=?''', address) + # shared.reloadBroadcastSendersForWhichImWatching() + # shared.UISignalQueue.put(('rerenderInboxFromLabels', '')) + # shared.UISignalQueue.put(('rerenderSubscriptions', '')) + # return 200, 'Deleted subscription if it existed.' \ No newline at end of file diff --git a/start.sh b/start.sh new file mode 100644 index 0000000000..6d190f4525 --- /dev/null +++ b/start.sh @@ -0,0 +1,2 @@ +#!/bin/bash +python2 src/bitmessagemain.py From 2cddc88b243df2f69ad9d271cb5c952d9aa62f5f Mon Sep 17 00:00:00 2001 From: jackson- Date: Fri, 30 Jan 2015 14:09:37 -0500 Subject: [PATCH 02/13] changed messages to be json and inherit from message class --- src/helper_api.py | 61 +++++++++++++++++++++++++++-------------------- 1 file changed, 35 insertions(+), 26 deletions(-) diff --git a/src/helper_api.py b/src/helper_api.py index 102eea78e5..3ad62ff01a 100644 --- a/src/helper_api.py +++ b/src/helper_api.py @@ -16,32 +16,41 @@ str_chan = '[chan]' -# class messages( array ): - -# def base( self ): -# msgid, toAddress, fromAddress, subject, message, encodingtype, received, read= query -# subject = shared.fixPotentiallyInvalidUTF8Data(subject) -# message = shared.fixPotentiallyInvalidUTF8Data(message) -# data.append({ -# 'msgid':msgid.encode('hex'), -# 'toAddress':toAddress, -# 'fromAddress':fromAddress, -# 'subject':subject.encode('base64'), -# 'message':message.encode('base64'), -# 'encodingType':encodingtype, - -# }) - -# def sent( sefl, query ): -# lastactiontime, status, ackdata = row[6:8] -# 'lastactiontime':lastactiontime, -# 'status':status, -# 'ackdata': ackdata - -# def ( self, query ): -# received, read = row[6:7] -# 'receivedTime':received -# 'read': read +class Message: + def __init__(self, query): + self.data = [] + +class Sent( Message ): + def __init__( self, query ): + super( Sent, self).__init__() + # lastactiontime, status, ackdata = query[6:8] + for entry in query: + self.data.append({ + 'msgid':entry[0].encode(), + 'toAddress':entry[1], + 'fromAddress':entry[2], + 'subject':entry[3].encode(), + 'message':entry[4].encode(), + 'encodingType':entry[5], + 'lastactiontime':lastactiontime, + 'status':status, + 'ackdata': ackdata.endcode("hex"), + }) + +class Recieved( Message ): + def __init__( self, query ): + super( Recieved, self ).__init__(query) + for entry in query: + self.data.append({ + 'msgid':entry[0].encode(), + 'toAddress':entry[1], + 'fromAddress':entry[2], + 'subject':entry[3].encode(), + 'message':entry[4].encode(), + 'encodingType':entry[5], + 'receivedTime':entry[6], + 'read': entry[7], + }) class _handle_request( object ): def ping( self, *args ): From a5b3338df0ce6e2b9a2aecbe4a8d73f7f89320ba Mon Sep 17 00:00:00 2001 From: william Date: Fri, 30 Jan 2015 17:47:24 -0500 Subject: [PATCH 03/13] refactor 3/4 --- src/helper_api.py | 242 ++++++++++++++++++++++++++++++++++++---------- 1 file changed, 193 insertions(+), 49 deletions(-) diff --git a/src/helper_api.py b/src/helper_api.py index 102eea78e5..7a407259fd 100644 --- a/src/helper_api.py +++ b/src/helper_api.py @@ -8,7 +8,6 @@ # Helper Functions import proofofwork - from addresses import decodeAddress,addBMIfNotPresent,decodeVarint,calculateInventoryHash,varintDecodeError import helper_inbox import helper_sent @@ -16,33 +15,6 @@ str_chan = '[chan]' -# class messages( array ): - -# def base( self ): -# msgid, toAddress, fromAddress, subject, message, encodingtype, received, read= query -# subject = shared.fixPotentiallyInvalidUTF8Data(subject) -# message = shared.fixPotentiallyInvalidUTF8Data(message) -# data.append({ -# 'msgid':msgid.encode('hex'), -# 'toAddress':toAddress, -# 'fromAddress':fromAddress, -# 'subject':subject.encode('base64'), -# 'message':message.encode('base64'), -# 'encodingType':encodingtype, - -# }) - -# def sent( sefl, query ): -# lastactiontime, status, ackdata = row[6:8] -# 'lastactiontime':lastactiontime, -# 'status':status, -# 'ackdata': ackdata - -# def ( self, query ): -# received, read = row[6:7] -# 'receivedTime':received -# 'read': read - class _handle_request( object ): def ping( self, *args ): data = { 'pong': args } @@ -467,7 +439,7 @@ def deleteAddress( self, *args ): return 200, {} def getAllInboxMessages( self, *args ): - queryreturn = sqlQuery('''SELECT msgid, toaddress, fromaddress, subject, received, message, encodingtype, read FROM inbox where folder='inbox' ORDER BY received''') + queryreturn = sqlQuery('''SELECT msgid, toAddress, fromAddress, subject, message, encodingtype, received, read FROM inbox where folder='inbox' ORDER BY received''') # data = rowMessage( queryreturn ) print queryreturn return 200, queryreturn @@ -507,25 +479,26 @@ def getAllInboxMessages( self, *args ): # return 200, data - # def getAllSentMessages( self, *args ): - # queryreturn = sqlQuery('''SELECT msgid, toaddress, fromaddress, subject, lastactiontime, message, encodingtype, status, ackdata FROM sent where folder='sent' ORDER BY lastactiontime''') - # data = [] - # for row in queryreturn: - # msgid, toAddress, fromAddress, subject, lastactiontime, message, encodingtype, status, ackdata = row - # subject = shared.fixPotentiallyInvalidUTF8Data(subject) - # message = shared.fixPotentiallyInvalidUTF8Data(message) - # data.append({ - # 'msgid':msgid.encode('hex'), - # 'toAddress':toAddress, - # 'fromAddress':fromAddress, - # 'subject':subject.encode('base64'), - # 'message':message.encode('base64'), - # 'encodingType':encodingtype, - # 'lastActionTime':lastactiontime, - # 'status':status, - # 'ackData':ackdata.encode('hex') - # }) - # return 200, data + def getAllSentMessages( self, *args ): + queryreturn = sqlQuery('''SELECT msgid, toAddress, fromAddress, subject, message, encodingtype, lastactiontime, status, ackdata FROM sent where folder='sent' ORDER BY lastactiontime''') + print queryreturn + data = [] + # for row in queryreturn: + # msgid, toAddress, fromAddress, subject, lastactiontime, message, encodingtype, status, ackdata = row + # subject = shared.fixPotentiallyInvalidUTF8Data(subject) + # message = shared.fixPotentiallyInvalidUTF8Data(message) + # data.append({ + # 'msgid':msgid.encode('hex'), + # 'toAddress':toAddress, + # 'fromAddress':fromAddress, + # 'subject':subject.encode('base64'), + # 'message':message.encode('base64'), + # 'encodingType':encodingtype, + # 'lastActionTime':lastactiontime, + # 'status':status, + # 'ackData':ackdata.encode('hex') + # }) + return 200, queryreturn # def getAllSentMessageIDs( self, *args ): # undocumented # queryreturn = sqlQuery('''SELECT msgid FROM sent where folder='sent' ORDER BY lastactiontime''') @@ -843,4 +816,175 @@ def getAllInboxMessages( self, *args ): # shared.reloadBroadcastSendersForWhichImWatching() # shared.UISignalQueue.put(('rerenderInboxFromLabels', '')) # shared.UISignalQueue.put(('rerenderSubscriptions', '')) - # return 200, 'Deleted subscription if it existed.' \ No newline at end of file + # return 200, 'Deleted subscription if it existed.' + + def listSubscriptions( self, *args ): + queryreturn = sqlQuery('''SELECT label, address, enabled FROM subscriptions''') + data = [] + for row in queryreturn: + label, address, enabled = row + label = shared.fixPotentiallyInvalidUTF8Data(label) + data.append({ + 'label':label.encode('base64'), + 'address': address, + 'enabled': enabled == 1 + }) + return 200, data + + def disseminatePreEncryptedMsg( self, *args ): + # The device issuing this command to PyBitmessage supplies a msg object that has + # already been encrypted but which still needs the POW to be done. PyBitmessage + # accepts this msg object and sends it out to the rest of the Bitmessage network + # as if it had generated the message itself. Please do not yet add this to the + # api doc. + if len( args ) != 3: + return 0, 'I need 3 parameter!' + encryptedPayload, requiredAverageProofOfWorkNonceTrialsPerByte, requiredPayloadLengthExtraBytes = args + encryptedPayload = self._decode(encryptedPayload, "hex") + # Let us do the POW and attach it to the front + target = 2**64 / ((len(encryptedPayload)+requiredPayloadLengthExtraBytes+8) * requiredAverageProofOfWorkNonceTrialsPerByte) + with shared.printLock: + print '(For msg message via API) Doing proof of work. Total required difficulty:', float(requiredAverageProofOfWorkNonceTrialsPerByte) / shared.networkDefaultProofOfWorkNonceTrialsPerByte, 'Required small message difficulty:', float(requiredPayloadLengthExtraBytes) / shared.networkDefaultPayloadLengthExtraBytes + powStartTime = time.time() + initialHash = hashlib.sha512(encryptedPayload).digest() + trialValue, nonce = proofofwork.run(target, initialHash) + with shared.printLock: + print '(For msg message via API) Found proof of work', trialValue, 'Nonce:', nonce + try: + print 'POW took', int(time.time() - powStartTime), 'seconds.', nonce / (time.time() - powStartTime), 'nonce trials per second.' + except: + pass + encryptedPayload = pack('>Q', nonce) + encryptedPayload + toStreamNumber = decodeVarint(encryptedPayload[16:26])[0] + inventoryHash = calculateInventoryHash(encryptedPayload) + objectType = 2 + TTL = 2.5 * 24 * 60 * 60 + shared.inventory[inventoryHash] = ( + objectType, toStreamNumber, encryptedPayload, int(time.time()) + TTL,'') + shared.inventorySets[toStreamNumber].add(inventoryHash) + with shared.printLock: + print 'Broadcasting inv for msg(API disseminatePreEncryptedMsg command):', inventoryHash.encode('hex') + shared.broadcastToSendDataQueues(( + toStreamNumber, 'advertiseobject', inventoryHash)) + + def disseminatePubkey': + # The device issuing this command to PyBitmessage supplies a pubkey object to be + # disseminated to the rest of the Bitmessage network. PyBitmessage accepts this + # pubkey object and sends it out to the rest of the Bitmessage network as if it + # had generated the pubkey object itself. Please do not yet add this to the api + # doc. + if len( args ) != 1: + return 0, 'I need 1 parameter!' + payload, = args + payload = self._decode(payload, "hex") + + # Let us do the POW + target = 2 ** 64 / ((len(payload) + shared.networkDefaultPayloadLengthExtraBytes + + 8) * shared.networkDefaultProofOfWorkNonceTrialsPerByte) + print '(For pubkey message via API) Doing proof of work...' + initialHash = hashlib.sha512(payload).digest() + trialValue, nonce = proofofwork.run(target, initialHash) + print '(For pubkey message via API) Found proof of work', trialValue, 'Nonce:', nonce + payload = pack('>Q', nonce) + payload + + pubkeyReadPosition = 8 # bypass the nonce + if payload[pubkeyReadPosition:pubkeyReadPosition+4] == '\x00\x00\x00\x00': # if this pubkey uses 8 byte time + pubkeyReadPosition += 8 + else: + pubkeyReadPosition += 4 + addressVersion, addressVersionLength = decodeVarint(payload[pubkeyReadPosition:pubkeyReadPosition+10]) + pubkeyReadPosition += addressVersionLength + pubkeyStreamNumber = decodeVarint(payload[pubkeyReadPosition:pubkeyReadPosition+10])[0] + inventoryHash = calculateInventoryHash(payload) + objectType = 1 + #todo: support v4 pubkeys + TTL = 28 * 24 * 60 * 60 + shared.inventory[inventoryHash] = ( + objectType, pubkeyStreamNumber, payload, int(time.time()) + TTL,'') + shared.inventorySets[pubkeyStreamNumber].add(inventoryHash) + with shared.printLock: + print 'broadcasting inv within API command disseminatePubkey with hash:', inventoryHash.encode('hex') + shared.broadcastToSendDataQueues(( + streamNumber, 'advertiseobject', inventoryHash)) + + def getMessageDataByDestinationTag( self, *args ): + # Method will eventually be used by a particular Android app to + # select relevant messages. Do not yet add this to the api + # doc. + + if len( args ) != 1: + 0, 'I need 1 parameter!' + requestedHash, = args + if len(requestedHash) != 32: + return 19, 'The length of hash should be 32 bytes (encoded in hex thus 64 characters).' + requestedHash = self._decode(requestedHash, "hex") + + # This is not a particularly commonly used API function. Before we + # use it we'll need to fill out a field in our inventory database + # which is blank by default (first20bytesofencryptedmessage). + queryreturn = sqlQuery( + '''SELECT hash, payload FROM inventory WHERE tag = '' and objecttype = 2 ; ''') + with SqlBulkExecute() as sql: + for row in queryreturn: + hash01, payload = row + readPosition = 16 # Nonce length + time length + readPosition += decodeVarint(payload[readPosition:readPosition+10])[1] # Stream Number length + t = (payload[readPosition:readPosition+32],hash01) + sql.execute('''UPDATE inventory SET tag=? WHERE hash=?; ''', *t) + + queryreturn = sqlQuery('''SELECT payload FROM inventory WHERE tag = ?''', + requestedHash) + data = [] + for row in queryreturn: + payload, = row + data.append({'data':payload.encode('hex')}) + + return 200, data + + def getPubkeyByHash( self, *args ): + # Method will eventually be used by a particular Android app to + # retrieve pubkeys. Please do not yet add this to the api docs. + if len( args ) != 1: + return 0, 'I need 1 parameter!' + requestedHash, = args + if len(requestedHash) != 40: + return 19, 'The length of hash should be 20 bytes (encoded in hex thus 40 characters).' + requestedHash = self._decode(requestedHash, "hex") + queryreturn = sqlQuery('''SELECT transmitdata FROM pubkeys WHERE hash = ? ; ''', requestedHash) + data = [] + for row in queryreturn: + transmitdata, = row + data.append({'data':transmitdata.encode('hex')}) + return 200, data + + def clientStatus( self, *args ): + if len(shared.connectedHostsList) == 0: + networkStatus = 'notConnected' + elif len(shared.connectedHostsList) > 0 and not shared.clientHasReceivedIncomingConnections: + networkStatus = 'connectedButHaveNotReceivedIncomingConnections' + else: + networkStatus = 'connectedAndReceivingIncomingConnections' + data = { + 'networkConnections':len(shared.connectedHostsList), + 'numberOfMessagesProcessed':shared.numberOfMessagesProcessed, + 'numberOfBroadcastsProcessed':shared.numberOfBroadcastsProcessed, + 'numberOfPubkeysProcessed':shared.numberOfPubkeysProcessed, + 'networkStatus':networkStatus, + 'softwareName':'PyBitmessage', + 'softwareVersion':shared.softwareVersion + } + return 200, data + + def decodeAddress( self, *args ): + # Return a meaningful decoding of an address. + if len( args ) != 1: + return 0, 'I need 1 parameter!' + address, = params + status, addressVersion, streamNumber, ripe = decodeAddress(address) + data = { + 'status':status, + 'addressVersion':addressVersion, + 'streamNumber':streamNumber, + 'ripe':ripe.encode('base64') + } + return 200, data From 92a8b4b1b39efb18e74a788b633b36261ef4a9c2 Mon Sep 17 00:00:00 2001 From: william Date: Sun, 1 Feb 2015 11:08:38 -0500 Subject: [PATCH 04/13] helper_api is done --- src/api.py | 9 +- src/helper_api.py | 272 +++++++++++++++++++++++++++++++++++++++------- 2 files changed, 239 insertions(+), 42 deletions(-) diff --git a/src/api.py b/src/api.py index 8e5987e8ab..94b925dbdf 100644 --- a/src/api.py +++ b/src/api.py @@ -29,7 +29,6 @@ # Classes from debug import logger - class APIError(Exception): def __init__(self, error_number, error_message): super(APIError, self).__init__() @@ -76,8 +75,6 @@ def do_POST(self): # check to see if a subclass implements _dispatch and dispatch # using that method if present. - from pprint import pprint - print self.headers['Content-type'] response = self.server._marshaled_dispatch( data, getattr(self, '_dispatch', None) ) @@ -155,12 +152,16 @@ def _dispatch( self, method, params ): time.sleep(2) return "RPC Username or password incorrect or HTTP header lacks authentication at all." - if method in dir( _handle_request ): + self.apiDir = _handle_request + + if method in dir( self.apiDir ): logger.warn( 'Found "{}" in API'.format( method ) ) try: statusCode, data = object.__getattribute__( _handle_request, method )( self, *params ) except Exception as e: logger.exception(e) + statusCode = 500 + data = "500" else: statusCode = 404 data = "Method not found" diff --git a/src/helper_api.py b/src/helper_api.py index 0a5ee134fc..c6bb84ea8b 100644 --- a/src/helper_api.py +++ b/src/helper_api.py @@ -1,6 +1,7 @@ import shared import time import hashlib +import re # Classes from helper_sql import sqlQuery,sqlExecute,SqlBulkExecute @@ -50,18 +51,47 @@ def recievedMessage( query ): class _handle_request( object ): def ping( self, *args ): + '''( echo's ) Test method, echo response ''' + data = { 'pong': args } + + return 200, data + + def help( self, *args ): + ''' List all method's''' + + data = [] + for method in dir( self.apiDir ): + print method, re.match( "^_", method ) + if re.match( "^_", method ): continue + + this = object.__getattribute__( self.apiDir, method ) + if this.__doc__ != None: + data.append( { + 'mathod': method, + 'doc': this.__doc__ + } ) return 200, data def statusBar( self, *args ): - if not args: + '''( new status ) Displays the message in the status bar on the GUI ''' + + if len( args != 1 ): return 0, 'Need status message!' + message, = args shared.UISignalQueue.put( ('updateStatusBar', message) ) # does this need to be encoded before transmission? return 200, True def listAddresses( self, *args ): + ''' Lists all addresses shown on the Your Identities tab. Returns a list of objects with these properties: +label (base64, decodes into utf-8) +address (ascii/utf-8) +stream (integer) +enabled (bool) +chan (bool)''' + data = [] configSections = shared.config.sections() for addressInKeysFile in configSections: @@ -84,6 +114,10 @@ def listAddresses( self, *args ): return 200, data def listAddressBookEntries( self, *args ): + '''() Returns a list of objects with these properties: +address (ascii/utf-8) +label (base64, decodes into utf-8)''' + queryreturn = sqlQuery( '''SELECT label, address from addressbook''' ) data = [] @@ -102,6 +136,9 @@ def listAddressBookEntries( self, *args ): return 200, data def addAddressBookEntry( self, *args ): ## fix verifyAddress! + '''( address, label ) +add an entry to your address book. label must be base64-encoded.''' + if len( args ) != 2: return 0, "I need label and address" @@ -121,6 +158,9 @@ def addAddressBookEntry( self, *args ): ## fix verifyAddress! return 200, address def deleteAddressBookEntry( self, *args ): ## fix verifyAddress! + ''' ( address ) +Delete an entry from your address book. The program does not check to see whether it was there in the first place.''' + if len( args ) != 1: return 0, 'I need an address' @@ -134,6 +174,11 @@ def deleteAddressBookEntry( self, *args ): ## fix verifyAddress! return 200, "Deleted address book entry for %s if it existed" % address def createRandomAddress( self, *args ): + '''( label [eighteenByteRipe] [totalDifficulty] [smallMessageDifficulty] ) +Creates one address using the random number generator. label should be base64 encoded. eighteenByteRipe is a boolean telling Bitmessage whether to generate an address with an 18 byte RIPE hash(as opposed to a 19 byte hash). This is the same setting as the "Do extra work to make the address 1 or 2 characters shorter" in the user interface. Using False is recommended if you are running some sort of website and will be generating a lot of addresses. Note that even if you don't ask for it, there is still a 1 in 256 chance that you will get an address with an 18 byte RIPE hash so if you actually need an address with a 19 byte RIPE hash for some reason, you will need to check for it. eighteenByteRipe defaults to False. totalDifficulty and smallMessageDifficulty default to 1. +Returns the address. +Warning: At present, Bitmessage gets confused if you use both the API and the UI to make an address at the same time.''' + if len( args ) not in [1,2,3,4]: return 0, 'I need parameters!' @@ -205,6 +250,11 @@ def createRandomAddress( self, *args ): return 200, data def createDeterministicAddresses( self, *args ): # needs to be tested + ''' ( passphrase> [numberOfAddresses] [addressVersionNumber] [streamNumber] [eighteenByteRipe] [totalDifficulty] [smallMessageDifficulty] ) +Similar to createRandomAddress except that you may generate many addresses in one go. passphrase should be base64 encoded. numberOfAddresses defaults to 1. addressVersionNumber and streamNumber may be set to 0 which will tell Bitmessage to use the most up-to-date addressVersionNumber and the most available streamNumber. Using zero for each of these fields is recommended. eighteenByteRipe defaults to False. totalDifficulty and smallMessageDifficulty default to 1. +Returns a list of new addresses. This list will be empty if the addresses already existed. +Warning: At present, Bitmessage gets confused if you use both the API and the UI to make addresses at the same time.''' + if len( args ) not in range( 1,7 ): return 0, 'I need parameters!' @@ -338,6 +388,11 @@ def createDeterministicAddresses( self, *args ): # needs to be tested return 200, data def getDeterministicAddress( self, *args ): # needs to be tested + '''( passphrase, addressVersionNumber, streamNumber ) +Similar to createDeterministicAddresses except that the one address that is returned will not be added to the Bitmessage user interface or the keys.dat file. passphrase should be base64 encoded. addressVersionNumber should be set to 3 or 4 as these are the only ones currently supported. streamNumber must be set to 1 as this is the only one currently supported. +Returns a single address. +Warning: At present, Bitmessage gets confused if you use both this API command and the UI to make addresses at the same time.''' + if len( args ) != 3: return 0, 'I need exactly 3 parameters.' @@ -373,6 +428,9 @@ def getDeterministicAddress( self, *args ): # needs to be tested return 200, shared.apiAddressGeneratorReturnQueue.get() def createChan( self, *args ): + '''( passphrase ) +Creates a new chan. passphrase must be base64 encoded. Outputs the corresponding Bitmessage address and label.''' + if len( args ) != 1: return 0, 'Passphrase needed!' @@ -418,6 +476,8 @@ def createChan( self, *args ): return 200, data def joinChan( self, *args ): + '''( passphrase, address ) +Join a chan. passphrase must be base64 encoded. Outputs chan address''' if len( args ) != 2: return 0, 'I need two parameters.' @@ -454,6 +514,10 @@ def joinChan( self, *args ): return 200, data def leaveChan( self, *args ): + '''( address ) +Leave a chan. Outputs "success". +Note that at this time, the address is still shown in the UI until a restart.''' + if len( args ) != 1: return 0, 'I need parameters.' @@ -473,6 +537,10 @@ def leaveChan( self, *args ): return 200, {} def deleteAddress( self, *args ): + '''( address ) +Permanently delete an address from Your Identities and your keys.dat file. Outputs "success". +Note that at this time, the address is still shown in the UI until a restart.''' + if len( args ) != 1: return 0, 'I need parameters.' @@ -491,6 +559,18 @@ def deleteAddress( self, *args ): return 200, {} def getAllInboxMessages( self, *args ): + '''() +Does not include trashed messages. Returns a list of objects with these properties: +msgid (hex) +toAddress (ascii/utf-8) +fromAddress (ascii/utf-8) +subject (base64, decodes into utf-8) +message (base64, decodes into utf-8) +encodingType (integer) +receivedTime (integer, Unix time) +read (integer representing binary state (0 or 1)) +The msgid is the same as the hash of the message (analogous to the TXID in Bitcoin) thus it is shown in hex as that is the de facto standard. The base64 encoding Bitmessage uses includes line breaks including one on the end of the string.''' + queryreturn = sqlQuery( '''SELECT msgid, toAddress, fromAddress, subject, message, encodingtype, received, read FROM inbox where folder='inbox' ORDER BY received''' ) @@ -498,6 +578,10 @@ def getAllInboxMessages( self, *args ): return 200, data def getAllInboxMessageIDs( self, *args ): + '''() +Returns a list of msgids of all Inbox messages with there properties: +msgid (hex)''' + queryreturn = sqlQuery( '''SELECT msgid FROM inbox where folder='inbox' ORDER BY received''' ) @@ -511,6 +595,19 @@ def getAllInboxMessageIDs( self, *args ): return 200, data def getInboxMessageByID( self, *args ): + ''' ( msgid, [read] ) +Returns an object with these properties: +msgid (hex) +toAddress (ascii/utf-8) +fromAddress (ascii/utf-8) +subject (base64, decodes into utf-8) +message (base64, decodes into utf-8) +encodingType (integer) +receivedTime (integer, Unix time) +read (integer representing binary state (0 or 1)) +Optionally sets the specific message to have a read status of 'read' (bool). +The msgid is the same as the hash of the message (analogous to the TXID in Bitcoin) thus it should be given in hex as that is the de facto standard. The base64 encoding Bitmessage uses includes line breaks including one on the end of the string.''' + if len( args ) not in [1,2]: return 0, 'Missing message id' @@ -538,6 +635,18 @@ def getInboxMessageByID( self, *args ): return 200, data def getAllSentMessages( self, *args ): + '''() +Returns an object with these properties: +msgid (hex) +toAddress (ascii/utf-8) +fromAddress (ascii/utf-8) +subject (base64, decodes into utf-8) +message (base64, decodes into utf-8) +encodingType (integer) +lastActionTime (integer, Unix time) +status (ascii/utf-8) +ackData (hex)''' + queryreturn = sqlQuery( '''SELECT msgid, toAddress, fromAddress, subject, message, encodingtype, lastactiontime, status, ackdata FROM sent where folder='sent' ORDER BY lastactiontime''' ) @@ -546,6 +655,9 @@ def getAllSentMessages( self, *args ): return 200, queryreturn def getAllSentMessageIDs( self, *args ): # undocumented + '''() +Returns a list of all sent message ids''' + queryreturn = sqlQuery( '''SELECT msgid FROM sent where folder='sent' ORDER BY lastactiontime''' ) data = [] for row in queryreturn: @@ -555,6 +667,9 @@ def getAllSentMessageIDs( self, *args ): # undocumented return 200, data def getInboxMessagesByToAddress( self, *args ): # renamed from getInboxMessagesByReceiver / undocumented + '''( toAddress ) +Returns a list of messages that are address to toAddress''' + if len( args ) != 1: return 0, 'I need parameters!' @@ -568,19 +683,43 @@ def getInboxMessagesByToAddress( self, *args ): # renamed from getInboxMessagesB return 200, data def getSentMessagesBySender( self, *args ): - if len( args ) != 1: - return 0, 'I need parameters!' + '''( fromAddress ) +Returns a list of objects with these properties: +msgid (hex) +toAddress (ascii/utf-8) +fromAddress (ascii/utf-8) +subject (base64, decodes into utf-8) +message (base64, decodes into utf-8) +encodingType (integer) +lastActionTime (integer, Unix time) +status (ascii/utf-8) +ackData (hex)''' - fromAddress, = args - queryreturn = sqlQuery( - '''SELECT msgid, toAddress, fromAddress, subject, message, encodingtype, lastactiontime, status, ackdata FROM sent WHERE folder='sent' AND fromAddress=? ORDER BY lastactiontime''', - fromAddress - ) - data = sentMessage( queryreturn ) + if len( args ) != 1: + return 0, 'I need parameters!' - return 200, data + fromAddress, = args + queryreturn = sqlQuery( + '''SELECT msgid, toAddress, fromAddress, subject, message, encodingtype, lastactiontime, status, ackdata FROM sent WHERE folder='sent' AND fromAddress=? ORDER BY lastactiontime''', + fromAddress + ) + data = sentMessage( queryreturn ) + + return 200, data def getSentMessageByID( self, *args ): + '''( msgid ) +Returns an object with these properties: +msgid (hex) +toAddress (ascii/utf-8) +fromAddress (ascii/utf-8) +subject (base64, decodes into utf-8) +message (base64, decodes into utf-8) +encodingType (integer) +lastActionTime (integer, Unix time) +status (ascii/utf-8) +ackData (hex)''' + if len( args ) != 1: return 0, 'I need parameters!' @@ -594,6 +733,18 @@ def getSentMessageByID( self, *args ): return 200, data def getSentMessageByAckData( self, *args ): + '''( ackData ) +Returns an object with these properties: +msgid (hex) +toAddress (ascii/utf-8) +fromAddress (ascii/utf-8) +subject (base64, decodes into utf-8) +message (base64, decodes into utf-8) +encodingType (integer) +lastActionTime (integer, Unix time) +status (ascii/utf-8) +ackData (hex)''' + if len( args ) != 1: return 0, 'I need parameters!' @@ -607,6 +758,9 @@ def getSentMessageByAckData( self, *args ): return 200, data def trashMessage( self, *args ): + '''( msgid ) +returns a simple message saying that the message was trashed assuming it ever even existed. Prior existence is not checked. msgid is encoded in hex just like in the getAllInboxMessages function.''' + if len( args ) != 1: return 0, 'I need parameters!' @@ -619,15 +773,9 @@ def trashMessage( self, *args ): return 200, 'Trashed message (assuming message existed).' def trashInboxMessage( self, *args ): - if len( args ) != 1: - return 0, 'I need parameters!' - - msgid = self._decode( args[0], "hex" ) - helper_inbox.trash( msgid ) - - return 200, 'Trashed inbox message (assuming message existed).' + '''( msgid ) +returns a simple message saying that the message was trashed assuming it ever even existed. Prior existence is not checked. msgid is encoded in hex just like in the getAllInboxMessages function.''' - def trashInboxMessage( self, *args ): if len( args ) != 1: return 0, 'I need parameters!' @@ -637,6 +785,9 @@ def trashInboxMessage( self, *args ): return 200, 'Trashed inbox message (assuming message existed).' def trashSentMessage( self, *args ): + '''( msgid ) +returns a simple message saying that the message was trashed assuming it ever even existed. Prior existence is not checked. msgid is encoded in hex just like in the getAllInboxMessages function.''' + if len( args ) != 1: return 0, 'I need parameters!' @@ -646,7 +797,10 @@ def trashSentMessage( self, *args ): return 200, 'Trashed sent message (assuming message existed).' def trashSentMessageByAckData( self, *args ): - # This API method should only be used when msgid is not available + '''( ackData ) +Trashes a sent message based on its ackdata. ackData should be encoded in hex. Returns a simple message saying that the message was trashed assuming it ever even existed. Prior existence is not checked. +This API method should only be used when msgid is not available''' + if len( args ) != 1: return 0, 'I need parameters!' @@ -656,6 +810,9 @@ def trashSentMessageByAckData( self, *args ): return 200, 'Trashed sent message (assuming message existed).' def sendMessage( self, *args ): + '''( toAddress, fromAddress, subject, message, [encodingType] ) +returns ackdata encoded in hex. subject and message must be encoded in base64 which may optionally include line breaks. If used, the encodingType must be set to 2; this is included for forwards compatibility.''' + if len( args ) not in [4,5]: return 0, 'I need parameters!' @@ -726,6 +883,9 @@ def sendMessage( self, *args ): return 200, ackdata.encode( 'hex' ) def sendBroadcast( self, *args ): + '''( fromAddress, subject, message, [encodingType] ) +returns ackData encoded in hex. subject and message must be encoded in base64. If used, the encodingType must be set to 2; this is included for forwards compatibility.''' + if len( args ) not in [3,4]: return 0, 'I need parameters!' @@ -787,6 +947,9 @@ def sendBroadcast( self, *args ): return 200, ackdata.encode( 'hex' ) def getStatus( self, *args ): + '''( ackData ) +returns one of these strings: notFound, findingPubkey, doingPOW, sentMessage, or ackReceived notfound, msgqueued, broadcastqueued, broadcastsent, doingpubkeypow, awaitingpubkey, doingmsgpow, forcepow, msgsent, msgsentnoackexpected, or ackreceived.''' + if len( args ) != 1: return 0, 'I need one parameter!' @@ -807,6 +970,9 @@ def getStatus( self, *args ): return 200, status def addSubscription( self, *args ): + '''( address [label] ) +Subscribe to an address. label must be base64-encoded.''' + if len( args ) not in [1,2]: return 0, 'I need parameters!' @@ -836,6 +1002,9 @@ def addSubscription( self, *args ): return 200, 'Added subscription.' def addAddressToBlackWhiteList( self, *args ): + '''( address, [label] ) +Add an entry to your black or white list- whichever you are currently using. label must be base64-encoded.''' + if len( args ) not in [1,2]: return 0, 'I need parameters!' @@ -875,6 +1044,9 @@ def addAddressToBlackWhiteList( self, *args ): return 200, 'Added black-/white-list entry.' def removeAddressFromBlackWhiteList( self, *args ): + '''( address ) +Delete an entry from your black or white list- whichever you are currently using (but not both).''' + if len( args ) != 1: return 0, 'I need 1 parameter!' @@ -899,6 +1071,9 @@ def removeAddressFromBlackWhiteList( self, *args ): return 200, 'Deleted black-/white-list entry if it existed.' def deleteSubscription( self, *args): + '''( address ) +Unsubscribe from an address. The program does not check to see whether you were subscribed in the first place.''' + if len( args ) != 1: return 0, 'I need 1 parameter!' @@ -912,6 +1087,11 @@ def deleteSubscription( self, *args): return 200, 'Deleted subscription if it existed.' def listSubscriptions( self, *args ): + '''Returns a list of objects with these properties: +label (base64, decodes into utf-8) +address (ascii/utf-8) +enabled (bool)''' + queryreturn = sqlQuery( '''SELECT label, address, enabled FROM subscriptions''' ) data = [] for row in queryreturn: @@ -925,12 +1105,14 @@ def listSubscriptions( self, *args ): return 200, data - def disseminatePreEncryptedMsg( self, *args ): - # The device issuing this command to PyBitmessage supplies a msg object that has - # already been encrypted but which still needs the POW to be done. PyBitmessage - # accepts this msg object and sends it out to the rest of the Bitmessage network - # as if it had generated the message itself. Please do not yet add this to the - # api doc. + def disseminatePreEncryptedMsg( self, *args ): # undocumented + ''' (encryptedPayload, requiredAverageProofOfWorkNonceTrialsPerByte, requiredPayloadLengthExtraBytes ) +The device issuing this command to PyBitmessage supplies a msg object that has +already been encrypted but which still needs the POW to be done. PyBitmessage +accepts this msg object and sends it out to the rest of the Bitmessage network +as if it had generated the message itself. Please do not yet add this to the +api doc.''' + if len( args ) != 3: return 0, 'I need 3 parameter!' encryptedPayload, requiredAverageProofOfWorkNonceTrialsPerByte, requiredPayloadLengthExtraBytes = args @@ -961,12 +1143,14 @@ def disseminatePreEncryptedMsg( self, *args ): shared.broadcastToSendDataQueues(( toStreamNumber, 'advertiseobject', inventoryHash)) - def disseminatePubkey( self, *args ): - # The device issuing this command to PyBitmessage supplies a pubkey object to be - # disseminated to the rest of the Bitmessage network. PyBitmessage accepts this - # pubkey object and sends it out to the rest of the Bitmessage network as if it - # had generated the pubkey object itself. Please do not yet add this to the api - # doc. + def disseminatePubkey( self, *args ): # undocumented + '''( payload ) +The device issuing this command to PyBitmessage supplies a pubkey object to be +disseminated to the rest of the Bitmessage network. PyBitmessage accepts this +pubkey object and sends it out to the rest of the Bitmessage network as if it +had generated the pubkey object itself. Please do not yet add this to the api +doc.''' + if len( args ) != 1: return 0, 'I need 1 parameter!' payload, = args @@ -1001,10 +1185,11 @@ def disseminatePubkey( self, *args ): shared.broadcastToSendDataQueues(( streamNumber, 'advertiseobject', inventoryHash)) - def getMessageDataByDestinationTag( self, *args ): - # Method will eventually be used by a particular Android app to - # select relevant messages. Do not yet add this to the api - # doc. + def getMessageDataByDestinationTag( self, *args ): # undocumented + '''( requestedHash ) +Method will eventually be used by a particular Android app to +select relevant messages. Do not yet add this to the api +doc.''' if len( args ) != 1: 0, 'I need 1 parameter!' @@ -1040,9 +1225,11 @@ def getMessageDataByDestinationTag( self, *args ): return 200, data - def getPubkeyByHash( self, *args ): - # Method will eventually be used by a particular Android app to - # retrieve pubkeys. Please do not yet add this to the api docs. + def getPubkeyByHash( self, *args ): #undocumented + '''( requestedHash ) +Method will eventually be used by a particular Android app to +retrieve pubkeys. Please do not yet add this to the api docs.''' + if len( args ) != 1: return 0, 'I need 1 parameter!' requestedHash, = args @@ -1061,6 +1248,8 @@ def getPubkeyByHash( self, *args ): return 200, data def clientStatus( self, *args ): + '''Returns the softwareName, softwareVersion, networkStatus, networkConnections, numberOfPubkeysProcessed, numberOfMessagesProcessed, and numberOfBroadcastsProcessed. networkStatus will be one of these strings: "notConnected", "connectedButHaveNotReceivedIncomingConnections", or "connectedAndReceivingIncomingConnections".''' + if len( shared.connectedHostsList ) == 0: networkStatus = 'notConnected' elif len( shared.connectedHostsList ) > 0 and not shared.clientHasReceivedIncomingConnections: @@ -1081,6 +1270,13 @@ def clientStatus( self, *args ): return 200, data def decodeAddress( self, *args ): + '''( address ) +Returns an object with these properties: +status (ascii/utf-8) +addressVersion (ascii integer) +streamNumber (ascii integer) +ripe (base64, decodes into binary data)''' + # Return a meaningful decoding of an address. if len( args ) != 1: return 0, 'I need 1 parameter!' From 9646b8329a84f3ee57818e8f1e1dfaf73ab7f061 Mon Sep 17 00:00:00 2001 From: william Date: Mon, 2 Feb 2015 11:01:49 -0500 Subject: [PATCH 05/13] small fixes --- src/helper_api.py | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/src/helper_api.py b/src/helper_api.py index c6bb84ea8b..dc26fe5abd 100644 --- a/src/helper_api.py +++ b/src/helper_api.py @@ -68,9 +68,10 @@ def help( self, *args ): this = object.__getattribute__( self.apiDir, method ) if this.__doc__ != None: data.append( { - 'mathod': method, + 'method': method, 'doc': this.__doc__ } ) + return 200, data def statusBar( self, *args ): @@ -111,6 +112,7 @@ def listAddresses( self, *args ): 'enabled': shared.config.getboolean(addressInKeysFile, 'enabled'), 'chan': chan } ) + return 200, data def listAddressBookEntries( self, *args ): @@ -250,7 +252,7 @@ def createRandomAddress( self, *args ): return 200, data def createDeterministicAddresses( self, *args ): # needs to be tested - ''' ( passphrase> [numberOfAddresses] [addressVersionNumber] [streamNumber] [eighteenByteRipe] [totalDifficulty] [smallMessageDifficulty] ) + ''' ( passphrase [numberOfAddresses] [addressVersionNumber] [streamNumber] [eighteenByteRipe] [totalDifficulty] [smallMessageDifficulty] ) Similar to createRandomAddress except that you may generate many addresses in one go. passphrase should be base64 encoded. numberOfAddresses defaults to 1. addressVersionNumber and streamNumber may be set to 0 which will tell Bitmessage to use the most up-to-date addressVersionNumber and the most available streamNumber. Using zero for each of these fields is recommended. eighteenByteRipe defaults to False. totalDifficulty and smallMessageDifficulty default to 1. Returns a list of new addresses. This list will be empty if the addresses already existed. Warning: At present, Bitmessage gets confused if you use both the API and the UI to make addresses at the same time.''' From 5fb123d17b8d99b3d7bb0e91a7e3c99c5501f7fa Mon Sep 17 00:00:00 2001 From: william Date: Mon, 2 Feb 2015 13:58:06 -0500 Subject: [PATCH 06/13] response fix --- src/helper_api.py | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/src/helper_api.py b/src/helper_api.py index dc26fe5abd..821bb65002 100644 --- a/src/helper_api.py +++ b/src/helper_api.py @@ -882,7 +882,11 @@ def sendMessage( self, *args ): ) ) shared.workerQueue.put( ( 'sendmessage', toAddress ) ) - return 200, ackdata.encode( 'hex' ) + data = { + 'ackdata': ackdata.encode( 'hex' ) + } + + return 200, data def sendBroadcast( self, *args ): '''( fromAddress, subject, message, [encodingType] ) @@ -946,7 +950,11 @@ def sendBroadcast( self, *args ): ) ) shared.workerQueue.put( ( 'sendbroadcast', '' ) ) - return 200, ackdata.encode( 'hex' ) + data = { + 'ackdata': ackdata.encode( 'hex' ) + } + + return 200, data def getStatus( self, *args ): '''( ackData ) @@ -1001,6 +1009,7 @@ def addSubscription( self, *args ): shared.reloadBroadcastSendersForWhichImWatching() shared.UISignalQueue.put( ( 'rerenderInboxFromLabels', '' ) ) shared.UISignalQueue.put( ( 'rerenderSubscriptions', '' ) ) + return 200, 'Added subscription.' def addAddressToBlackWhiteList( self, *args ): From 9da655a3f659c66b5c2945f669f5d6cdee25fa3c Mon Sep 17 00:00:00 2001 From: william Date: Mon, 2 Feb 2015 15:36:11 -0500 Subject: [PATCH 07/13] api fix --- src/helper_api.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/helper_api.py b/src/helper_api.py index 821bb65002..e1cb3e2cbf 100644 --- a/src/helper_api.py +++ b/src/helper_api.py @@ -28,7 +28,7 @@ def sentMessage( query ): 'encodingType': row[5], 'lastactiontime': row[6], 'status': row[7], - 'ackdata': row[8].endcode( 'hex' ), + 'ackdata': row[8].encode( 'hex' ), } ) return data @@ -653,8 +653,8 @@ def getAllSentMessages( self, *args ): '''SELECT msgid, toAddress, fromAddress, subject, message, encodingtype, lastactiontime, status, ackdata FROM sent where folder='sent' ORDER BY lastactiontime''' ) data = sentMessage( queryreturn ) - - return 200, queryreturn + + return 200, data def getAllSentMessageIDs( self, *args ): # undocumented '''() @@ -1009,7 +1009,7 @@ def addSubscription( self, *args ): shared.reloadBroadcastSendersForWhichImWatching() shared.UISignalQueue.put( ( 'rerenderInboxFromLabels', '' ) ) shared.UISignalQueue.put( ( 'rerenderSubscriptions', '' ) ) - + return 200, 'Added subscription.' def addAddressToBlackWhiteList( self, *args ): From 45805b06ec6a5c5beefb923fff841465d14de2d9 Mon Sep 17 00:00:00 2001 From: william Date: Mon, 2 Feb 2015 17:34:44 -0500 Subject: [PATCH 08/13] api fix --- src/helper_api.py | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/src/helper_api.py b/src/helper_api.py index e1cb3e2cbf..38ef840eb2 100644 --- a/src/helper_api.py +++ b/src/helper_api.py @@ -245,9 +245,10 @@ def createRandomAddress( self, *args ): nonceTrialsPerByte, payloadLengthExtraBytes ) ) + label = shared.fixPotentiallyInvalidUTF8Data( label ) data = { 'address': shared.apiAddressGeneratorReturnQueue.get(), - 'label': label + 'label': label.encode( 'base64' ) } return 200, data @@ -653,7 +654,7 @@ def getAllSentMessages( self, *args ): '''SELECT msgid, toAddress, fromAddress, subject, message, encodingtype, lastactiontime, status, ackdata FROM sent where folder='sent' ORDER BY lastactiontime''' ) data = sentMessage( queryreturn ) - + return 200, data def getAllSentMessageIDs( self, *args ): # undocumented From 5d1624ccb505acc62d8801096c4bcd2cbde3ae48 Mon Sep 17 00:00:00 2001 From: william Date: Wed, 4 Feb 2015 15:14:10 -0500 Subject: [PATCH 09/13] changed status code 13 to 406 --- src/helper_api.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/helper_api.py b/src/helper_api.py index 38ef840eb2..6334c08c53 100644 --- a/src/helper_api.py +++ b/src/helper_api.py @@ -529,7 +529,7 @@ def leaveChan( self, *args ): address = addBMIfNotPresent( address ) if not shared.config.has_section( address ): - return 13, 'Could not find this address in your keys.dat file.' + return 406, 'Could not find this address in your keys.dat file.' if not shared.safeConfigGetBoolean( address, 'chan' ): return 25, 'Specified address is not a chan address. Use deleteAddress API call instead.' @@ -551,7 +551,7 @@ def deleteAddress( self, *args ): status, addressVersionNumber, streamNumber, toRipe = self._verifyAddress( address ) address = addBMIfNotPresent( address ) if not shared.config.has_section(address): - return 13, 'Could not find this address in your keys.dat file.' + return 406, 'Could not find this address in your keys.dat file.' shared.config.remove_section( address ) shared.writeKeysFile() @@ -840,7 +840,7 @@ def sendMessage( self, *args ): try: fromAddressEnabled = shared.config.getboolean( fromAddress, 'enabled' ) except: - return 13, 'Could not find your fromAddress in the keys.dat file.' + return 406, 'Could not find your fromAddress in the keys.dat file.' if not fromAddressEnabled: return 14, 'Your fromAddress is disabled. Cannot send.' @@ -915,7 +915,7 @@ def sendBroadcast( self, *args ): try: fromAddressEnabled = shared.config.getboolean( fromAddress, 'enabled' ) except: - return 13, 'could not find your fromAddress in the keys.dat file.' + return 406, 'could not find your fromAddress in the keys.dat file.' ackdata = OpenSSL.rand( 32 ) toAddress = '[Broadcast subscribers]' From feecf5f559c8642ecbca6d5bb1f5b5a6defef973 Mon Sep 17 00:00:00 2001 From: william Date: Wed, 4 Feb 2015 17:31:48 -0500 Subject: [PATCH 10/13] fixed lable in createChan --- src/helper_api.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/helper_api.py b/src/helper_api.py index 6334c08c53..ca2afca12f 100644 --- a/src/helper_api.py +++ b/src/helper_api.py @@ -473,7 +473,7 @@ def createChan( self, *args ): address = queueReturn[0] data = { 'address': address, - 'label': label + 'label': label.encode( 'base64') } return 200, data From f0a1dd426d7dbeb851faafe2e12fb7a18184494f Mon Sep 17 00:00:00 2001 From: william Date: Thu, 5 Feb 2015 19:13:16 -0500 Subject: [PATCH 11/13] fixed trashed message API return --- src/helper_api.py | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/src/helper_api.py b/src/helper_api.py index ca2afca12f..81e6d2aaf1 100644 --- a/src/helper_api.py +++ b/src/helper_api.py @@ -785,7 +785,10 @@ def trashInboxMessage( self, *args ): msgid = self._decode( args[0], "hex" ) helper_inbox.trash( msgid ) - return 200, 'Trashed inbox message (assuming message existed).' + data = { + 'message': data + } + return 200, data def trashSentMessage( self, *args ): '''( msgid ) @@ -797,7 +800,10 @@ def trashSentMessage( self, *args ): msgid = self._decode( args[0], "hex" ) sqlExecute( '''UPDATE sent SET folder='trash' WHERE msgid=?''', msgid ) - return 200, 'Trashed sent message (assuming message existed).' + data = { + 'message': data + } + return 200, data def trashSentMessageByAckData( self, *args ): '''( ackData ) From 6bdb0518770e75d918a639dd439eeb03fbae8876 Mon Sep 17 00:00:00 2001 From: william Date: Thu, 5 Feb 2015 19:33:11 -0500 Subject: [PATCH 12/13] fixed trashed message API return --- src/helper_api.py | 19 +++++++++++++++---- 1 file changed, 15 insertions(+), 4 deletions(-) diff --git a/src/helper_api.py b/src/helper_api.py index 81e6d2aaf1..9658632193 100644 --- a/src/helper_api.py +++ b/src/helper_api.py @@ -773,7 +773,12 @@ def trashMessage( self, *args ): helper_inbox.trash(msgid) # Trash if in sent table sqlExecute( '''UPDATE sent SET folder='trash' WHERE msgid=?''', msgid ) - return 200, 'Trashed message (assuming message existed).' + + data = { + 'message': 'Trashed message (assuming message existed).' + } + + return 200, data def trashInboxMessage( self, *args ): '''( msgid ) @@ -786,8 +791,9 @@ def trashInboxMessage( self, *args ): helper_inbox.trash( msgid ) data = { - 'message': data + 'message': 'Trashed message (assuming message existed).' } + return 200, data def trashSentMessage( self, *args ): @@ -801,8 +807,9 @@ def trashSentMessage( self, *args ): sqlExecute( '''UPDATE sent SET folder='trash' WHERE msgid=?''', msgid ) data = { - 'message': data + 'message': 'Trashed message (assuming message existed).' } + return 200, data def trashSentMessageByAckData( self, *args ): @@ -816,7 +823,11 @@ def trashSentMessageByAckData( self, *args ): ackdata = self._decode (args[0], "hex" ) sqlExecute( '''UPDATE sent SET folder='trash' WHERE ackdata=?''', ackdata ) - return 200, 'Trashed sent message (assuming message existed).' + data = { + 'message': 'Trashed message (assuming message existed).' + } + + return 200, data def sendMessage( self, *args ): '''( toAddress, fromAddress, subject, message, [encodingType] ) From 2f7cb11e8ceb810450ff6331fb67c673927f85ec Mon Sep 17 00:00:00 2001 From: william Date: Wed, 11 Feb 2015 11:12:34 -0500 Subject: [PATCH 13/13] fixed chan stuff --- src/addresses.py | 4 ++-- src/helper_api.py | 6 +++++- start.sh | 0 3 files changed, 7 insertions(+), 3 deletions(-) mode change 100644 => 100755 start.sh diff --git a/src/addresses.py b/src/addresses.py index f6fbbf7321..d1d54df412 100644 --- a/src/addresses.py +++ b/src/addresses.py @@ -246,8 +246,8 @@ def addBMIfNotPresent(address): if __name__ == "__main__": print 'Let us make an address from scratch. Suppose we generate two random 32 byte values and call the first one the signing key and the second one the encryption key:' - privateSigningKey = '93d0b61371a54b53df143b954035d612f8efa8a3ed1cf842c2186bfd8f876665' - privateEncryptionKey = '4b0b73a54e19b059dc274ab69df095fe699f43b17397bca26fdf40f4d7400a3a' + privateSigningKey = '176b9c357297fd32ad1abcff52fcd45d1af9fb255bb79718922de5f114b0db57' + privateEncryptionKey = 'bfe026dbdcb4a128adf7512e37e73bbaa5c847c24790f421ae299a34428ace76' print 'privateSigningKey =', privateSigningKey print 'privateEncryptionKey =', privateEncryptionKey print 'Now let us convert them to public keys by doing an elliptic curve point multiplication.' diff --git a/src/helper_api.py b/src/helper_api.py index 9658632193..2849f7c4ee 100644 --- a/src/helper_api.py +++ b/src/helper_api.py @@ -1028,7 +1028,11 @@ def addSubscription( self, *args ): shared.UISignalQueue.put( ( 'rerenderInboxFromLabels', '' ) ) shared.UISignalQueue.put( ( 'rerenderSubscriptions', '' ) ) - return 200, 'Added subscription.' + data = { + "label": 'Added subscription.' + } + + return 200, data def addAddressToBlackWhiteList( self, *args ): '''( address, [label] ) diff --git a/start.sh b/start.sh old mode 100644 new mode 100755