1178 lines
61 KiB
Python
1178 lines
61 KiB
Python
# Copyright (c) 2012-2014 Jonathan Warren
|
|
# Copyright (c) 2012-2014 The Bitmessage developers
|
|
|
|
comment= """
|
|
This is not what you run to run the Bitmessage API. Instead, enable the API
|
|
( https://bitmessage.org/wiki/API ) and optionally enable daemon mode
|
|
( https://bitmessage.org/wiki/Daemon ) then run bitmessagemain.py.
|
|
"""
|
|
|
|
if __name__ == "__main__":
|
|
print comment
|
|
import sys
|
|
sys.exit(0)
|
|
|
|
from SimpleXMLRPCServer import SimpleXMLRPCRequestHandler
|
|
import json
|
|
|
|
import shared
|
|
import time
|
|
from addresses import decodeAddress,addBMIfNotPresent,decodeVarint,calculateInventoryHash,varintDecodeError
|
|
import helper_inbox
|
|
import helper_sent
|
|
import hashlib
|
|
|
|
from pyelliptic.openssl import OpenSSL
|
|
from struct import pack
|
|
|
|
# Classes
|
|
from helper_sql import sqlQuery,sqlExecute,SqlBulkExecute,sqlStoredProcedure
|
|
from debug import logger
|
|
|
|
# Helper Functions
|
|
import proofofwork
|
|
|
|
str_chan = '[chan]'
|
|
|
|
|
|
class APIError(Exception):
|
|
def __init__(self, error_number, error_message):
|
|
super(APIError, self).__init__()
|
|
self.error_number = error_number
|
|
self.error_message = error_message
|
|
def __str__(self):
|
|
return "API Error %04i: %s" % (self.error_number, self.error_message)
|
|
|
|
# This is one of several classes that constitute the API
|
|
# This class was written by Vaibhav Bhatia. Modified by Jonathan Warren (Atheros).
|
|
# http://code.activestate.com/recipes/501148-xmlrpc-serverclient-which-does-cookie-handling-and/
|
|
class MySimpleXMLRPCRequestHandler(SimpleXMLRPCRequestHandler):
|
|
|
|
def do_POST(self):
|
|
# Handles the HTTP POST request.
|
|
# Attempts to interpret all HTTP POST requests as XML-RPC calls,
|
|
# which are forwarded to the server's _dispatch method for handling.
|
|
|
|
# Note: this method is the same as in SimpleXMLRPCRequestHandler,
|
|
# just hacked to handle cookies
|
|
|
|
# Check that the path is legal
|
|
if not self.is_rpc_path_valid():
|
|
self.report_404()
|
|
return
|
|
|
|
try:
|
|
# Get arguments by reading body of request.
|
|
# We read this in chunks to avoid straining
|
|
# socket.read(); around the 10 or 15Mb mark, some platforms
|
|
# begin to have problems (bug #792570).
|
|
max_chunk_size = 10 * 1024 * 1024
|
|
size_remaining = int(self.headers["content-length"])
|
|
L = []
|
|
while size_remaining:
|
|
chunk_size = min(size_remaining, max_chunk_size)
|
|
L.append(self.rfile.read(chunk_size))
|
|
size_remaining -= len(L[-1])
|
|
data = ''.join(L)
|
|
|
|
# In previous versions of SimpleXMLRPCServer, _dispatch
|
|
# could be overridden in this class, instead of in
|
|
# SimpleXMLRPCDispatcher. To maintain backwards compatibility,
|
|
# check to see if a subclass implements _dispatch and dispatch
|
|
# using that method if present.
|
|
response = self.server._marshaled_dispatch(
|
|
data, getattr(self, '_dispatch', None)
|
|
)
|
|
except: # This should only happen if the module is buggy
|
|
# internal error, report as HTTP server error
|
|
self.send_response(500)
|
|
self.end_headers()
|
|
else:
|
|
# got a valid XML RPC response
|
|
self.send_response(200)
|
|
self.send_header("Content-type", "text/xml")
|
|
self.send_header("Content-length", str(len(response)))
|
|
|
|
# HACK :start -> sends cookies here
|
|
if self.cookies:
|
|
for cookie in self.cookies:
|
|
self.send_header('Set-Cookie', cookie.output(header=''))
|
|
# HACK :end
|
|
|
|
self.end_headers()
|
|
self.wfile.write(response)
|
|
|
|
# shut down the connection
|
|
self.wfile.flush()
|
|
self.connection.shutdown(1)
|
|
|
|
def APIAuthenticateClient(self):
|
|
if 'Authorization' in self.headers:
|
|
# handle Basic authentication
|
|
(enctype, encstr) = self.headers.get('Authorization').split()
|
|
(emailid, password) = encstr.decode('base64').split(':')
|
|
if emailid == shared.config.get('bitmessagesettings', 'apiusername') and password == shared.config.get('bitmessagesettings', 'apipassword'):
|
|
return True
|
|
else:
|
|
return False
|
|
else:
|
|
logger.warn('Authentication failed because header lacks Authentication field')
|
|
time.sleep(2)
|
|
return False
|
|
|
|
return False
|
|
|
|
def _decode(self, text, decode_type):
|
|
try:
|
|
return text.decode(decode_type)
|
|
except Exception as e:
|
|
raise APIError(22, "Decode error - " + str(e) + ". Had trouble while decoding string: " + repr(text))
|
|
|
|
def _verifyAddress(self, address):
|
|
status, addressVersionNumber, streamNumber, ripe = decodeAddress(address)
|
|
if status != 'success':
|
|
logger.warn('API Error 0007: Could not decode address %s. Status: %s.', address, status)
|
|
|
|
if status == 'checksumfailed':
|
|
raise APIError(8, 'Checksum failed for address: ' + address)
|
|
if status == 'invalidcharacters':
|
|
raise APIError(9, 'Invalid characters in address: ' + address)
|
|
if status == 'versiontoohigh':
|
|
raise APIError(10, 'Address version number too high (or zero) in address: ' + address)
|
|
if status == 'varintmalformed':
|
|
raise APIError(26, 'Malformed varint in address: ' + address)
|
|
raise APIError(7, 'Could not decode address: ' + address + ' : ' + status)
|
|
if addressVersionNumber < 2 or addressVersionNumber > 4:
|
|
raise APIError(11, 'The address version number currently must be 2, 3 or 4. Others aren\'t supported. Check the address.')
|
|
if streamNumber != 1:
|
|
raise APIError(12, 'The stream number must be 1. Others aren\'t supported. Check the 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''')
|
|
if len(params) == 1:
|
|
label, = params
|
|
label = self._decode(label, "base64")
|
|
queryreturn = sqlQuery('''SELECT label, address from addressbook WHERE label = ?''', label)
|
|
elif len(params) > 1:
|
|
raise APIError(0, "Too many paremeters, max 1")
|
|
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 == 'getAddressBookEntry': # search by label
|
|
if len(params) != 1:
|
|
raise APIError(0, "I need a label")
|
|
label, = params
|
|
label = self._decode(label, "base64")
|
|
queryreturn = sqlQuery('''SELECT label, address from addressbook WHERE label = ?''', label)
|
|
data = '{"address":['
|
|
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 += ','
|
|
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
|
|
|
|
def HandleListAddressBookEntries(self, params):
|
|
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
|
|
|
|
def HandleAddAddressBookEntry(self, params):
|
|
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
|
|
|
|
def HandleDeleteAddressBookEntry(self, params):
|
|
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
|
|
|
|
def HandleCreateRandomAddress(self, params):
|
|
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()
|
|
|
|
def HandleCreateDeterministicAddresses(self, params):
|
|
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
|
|
|
|
def HandleGetDeterministicAddress(self, params):
|
|
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 == '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':
|
|
import pprint
|
|
try:
|
|
queryreturn = sqlQuery('''SELECT msgid, toaddress, fromaddress, subject, lastactiontime, message, encodingtype, status, ackdata FROM sent where folder='sent' ORDER BY lastactiontime''')
|
|
except:
|
|
print "Exception in getallSentMessages"
|
|
pprint.pprint (queryreturn)
|
|
data = '{"sentMessages":['
|
|
if type(queryreturn) is list:
|
|
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=(',', ': '))
|
|
else:
|
|
print "queryreturn is not a list"
|
|
pprint.pprint (queryreturn)
|
|
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")
|
|
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
|
|
|
|
def HandleGetAllSentMessages(self, params):
|
|
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
|
|
|
|
def HandleGetAllSentMessageIds(self, params):
|
|
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
|
|
|
|
def HandleInboxMessagesByReceiver(self, params):
|
|
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
|
|
|
|
def HandleGetSentMessageById(self, params):
|
|
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
|
|
|
|
def HandleGetSentMessagesByAddress(self, params):
|
|
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
|
|
|
|
def HandleGetSentMessagesByAckData(self, params):
|
|
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
|
|
|
|
def HandleTrashMessage(self, params):
|
|
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).'
|
|
|
|
def HandleTrashInboxMessage(self, params):
|
|
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).'
|
|
|
|
def HandleTrashSentMessage(self, params):
|
|
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).'
|
|
|
|
def HandleSendMessage(self, params):
|
|
if len(params) == 0:
|
|
raise APIError(0, 'I need parameters!')
|
|
elif len(params) == 4:
|
|
toAddress, fromAddress, subject, message = params
|
|
encodingType = 2
|
|
TTL = 4*24*60*60
|
|
elif len(params) == 5:
|
|
toAddress, fromAddress, subject, message, encodingType = params
|
|
TTL = 4*24*60*60
|
|
elif len(params) == 6:
|
|
toAddress, fromAddress, subject, message, encodingType, TTL = 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.')
|
|
if TTL < 60*60:
|
|
TTL = 60*60
|
|
if TTL > 28*24*60*60:
|
|
TTL = 28*24*60*60
|
|
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()), # sentTime (this won't change)
|
|
int(time.time()), # lastActionTime
|
|
0,
|
|
'msgqueued',
|
|
0,
|
|
'sent',
|
|
2,
|
|
TTL)
|
|
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')
|
|
|
|
def HandleSendBroadcast(self, params):
|
|
if len(params) == 0:
|
|
raise APIError(0, 'I need parameters!')
|
|
if len(params) == 3:
|
|
fromAddress, subject, message = params
|
|
encodingType = 2
|
|
TTL = 4*24*60*60
|
|
elif len(params) == 4:
|
|
fromAddress, subject, message, encodingType = params
|
|
TTL = 4*24*60*60
|
|
elif len(params) == 5:
|
|
fromAddress, subject, message, encodingType, TTL = 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.')
|
|
if TTL < 60*60:
|
|
TTL = 60*60
|
|
if TTL > 28*24*60*60:
|
|
TTL = 28*24*60*60
|
|
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()), # sentTime (this doesn't change)
|
|
int(time.time()), # lastActionTime
|
|
0,
|
|
'broadcastqueued',
|
|
0,
|
|
'sent',
|
|
2,
|
|
TTL)
|
|
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')
|
|
|
|
def HandleGetStatus(self, params):
|
|
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
|
|
|
|
def HandleAddSubscription(self, params):
|
|
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.'
|
|
|
|
def HandleDeleteSubscription(self, params):
|
|
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.'
|
|
|
|
def ListSubscriptions(self, params):
|
|
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
|
|
|
|
def HandleDisseminatePreEncryptedMsg(self, params):
|
|
# 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))
|
|
|
|
def HandleTrashSentMessageByAckDAta(self, params):
|
|
# 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).'
|
|
|
|
def HandleDissimatePubKey(self, params):
|
|
# 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))
|
|
|
|
def HandleGetMessageDataByDestinationHash(self, params):
|
|
# 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:
|
|
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=(',', ': '))
|
|
elif method == 'getInboxCount':
|
|
#queryreturn = sqlQuery('''SELECT read, received < 'now' - 60 AS old, COUNT (*) AS cnt FROM inbox WHERE folder = 'inbox' GROUP BY read, old''')
|
|
ret = {}
|
|
queryreturn = sqlQuery('''SELECT COUNT (*) AS cnt FROM inbox WHERE folder = 'inbox' AND read = 0 AND received < 'now' - 60''')
|
|
for row in queryreturn:
|
|
count, = row
|
|
ret['oldread'] = count
|
|
queryreturn = sqlQuery('''SELECT COUNT (*) AS cnt FROM inbox WHERE folder = 'inbox' AND read = 1 AND received < 'now' - 60''')
|
|
for row in queryreturn:
|
|
count, = row
|
|
ret['oldunread'] = count
|
|
queryreturn = sqlQuery('''SELECT COUNT (*) AS cnt FROM inbox WHERE folder = 'inbox' AND read = 0 AND received >= 'now' - 60''')
|
|
for row in queryreturn:
|
|
count, = row
|
|
ret['newread'] = count
|
|
queryreturn = sqlQuery('''SELECT COUNT (*) AS cnt FROM inbox WHERE folder = 'inbox' AND read = 1 AND received >= 'now' - 60''')
|
|
for row in queryreturn:
|
|
count, = row
|
|
ret['newunread'] = count
|
|
data = '{"inboxCount":{'
|
|
for key in ret:
|
|
val = ret[key]
|
|
if len(data) > 16:
|
|
data += ','
|
|
data += json.dumps({key:val}, indent=4, separators=(',', ': '))
|
|
data += '}}'
|
|
elif method == 'getSentCount':
|
|
ret = {}
|
|
queryreturn = sqlQuery('''SELECT COUNT (*) AS cnt FROM sent WHERE folder = 'sent' AND status = 'msgqueued' ''')
|
|
for row in queryreturn:
|
|
count, = row
|
|
ret['queued'] = count
|
|
queryreturn = sqlQuery('''SELECT COUNT (*) AS cnt FROM sent WHERE folder = 'sent' AND status = 'msgsent' ''')
|
|
for row in queryreturn:
|
|
count, = row
|
|
ret['awaitingack'] = count
|
|
data = '{"sentCount":{'
|
|
for key in ret:
|
|
val = ret[key]
|
|
if len(data) > 15:
|
|
data += ','
|
|
data += json.dumps({key:val}, indent=4, separators=(',', ': '))
|
|
data += '}}'
|
|
elif method == 'deleteAndVacuum':
|
|
sqlStoredProcedure('deleteandvacuume')
|
|
return 'done'
|
|
else:
|
|
raise APIError(20, 'Invalid method: %s' % method)
|
|
|
|
def _dispatch(self, method, params):
|
|
self.cookies = []
|
|
|
|
validuser = self.APIAuthenticateClient()
|
|
if not validuser:
|
|
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)
|