mirror of
https://github.com/alexgo-io/stacks-puppet-node.git
synced 2026-04-12 20:42:06 +08:00
685 lines
19 KiB
Python
685 lines
19 KiB
Python
#!/usr/bin/env python2
|
|
# -*- coding: utf-8 -*-
|
|
"""
|
|
Blockstack-client
|
|
~~~~~
|
|
copyright: (c) 2014-2015 by Halfmoon Labs, Inc.
|
|
copyright: (c) 2016 by Blockstack.org
|
|
|
|
This file is part of Blockstack-client.
|
|
|
|
Blockstack-client is free software: you can redistribute it and/or modify
|
|
it under the terms of the GNU General Public License as published by
|
|
the Free Software Foundation, either version 3 of the License, or
|
|
(at your option) any later version.
|
|
|
|
Blockstack-client is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
GNU General Public License for more details.
|
|
You should have received a copy of the GNU General Public License
|
|
along with Blockstack-client. If not, see <http://www.gnu.org/licenses/>.
|
|
"""
|
|
|
|
import sys
|
|
import os
|
|
|
|
from xmlrpclib import ServerProxy, Transport
|
|
from defusedxml import xmlrpc
|
|
import httplib
|
|
import base64
|
|
import jsonschema
|
|
from jsonschema.exceptions import ValidationError
|
|
|
|
from .util import url_to_host_port
|
|
from .config import MAX_RPC_LEN, BLOCKSTACK_TEST, BLOCKSTACK_DEBUG, RPC_SERVER_PORT, LENGTHS, RPC_DEFAULT_TIMEOUT
|
|
|
|
# prevent the usual XML attacks
|
|
xmlrpc.MAX_DATA = MAX_RPC_LEN
|
|
xmlrpc.monkey_patch()
|
|
|
|
# schema constants
|
|
OP_HEX_PATTERN = r'^([0-9a-fA-F]+)$'
|
|
OP_CONSENSUS_HASH_PATTERN = r'^([0-9a-fA-F]{{{}}})$'.format(LENGTHS['consensus_hash'] * 2)
|
|
OP_ZONEFILE_HASH_PATTERN = r'^([0-9a-fA-F]{{{}}})$'.format(LENGTHS['value_hash'] * 2)
|
|
OP_BASE64_EMPTY_PATTERN = '^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$' # base64 with empty string
|
|
OP_BASE58CHECK_CLASS = r'[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]'
|
|
OP_BASE58CHECK_PATTERN = r'^({}+)$'.format(OP_BASE58CHECK_CLASS)
|
|
OP_ADDRESS_PATTERN = r'^({}{{1,34}})$'.format(OP_BASE58CHECK_CLASS)
|
|
|
|
class TimeoutHTTPConnection(httplib.HTTPConnection):
|
|
"""
|
|
borrowed with gratitude from Justin Cappos
|
|
https://seattle.poly.edu/browser/seattle/trunk/demokit/timeout_xmlrpclib.py?rev=692
|
|
"""
|
|
def connect(self):
|
|
httplib.HTTPConnection.connect(self)
|
|
self.sock.settimeout(self.timeout)
|
|
|
|
|
|
class TimeoutHTTPSConnection(httplib.HTTPSConnection):
|
|
def connect(self):
|
|
httplib.HTTPSConnection.connect(self)
|
|
self.sock.settimeout(self.timeout)
|
|
|
|
|
|
class TimeoutHTTP(httplib.HTTP):
|
|
_connection_class = TimeoutHTTPConnection
|
|
|
|
def set_timeout(self, timeout):
|
|
self._conn.timeout = timeout
|
|
|
|
def getresponse(self, **kw):
|
|
return self._conn.getresponse(**kw)
|
|
|
|
|
|
class TimeoutHTTPS(httplib.HTTP):
|
|
_connection_class = TimeoutHTTPSConnection
|
|
|
|
def set_timeout(self, timeout):
|
|
self._conn.timeout = timeout
|
|
|
|
def getresponse(self, **kw):
|
|
return self._conn.getresponse(**kw)
|
|
|
|
|
|
class TimeoutTransport(Transport):
|
|
def __init__(self, protocol, *l, **kw):
|
|
self.timeout = kw.pop('timeout', 10)
|
|
self.protocol = protocol
|
|
if protocol not in ['http', 'https']:
|
|
raise Exception("Protocol {} not supported".format(protocol))
|
|
Transport.__init__(self, *l, **kw)
|
|
|
|
def make_connection(self, host):
|
|
if self.protocol == 'http':
|
|
conn = TimeoutHTTP(host)
|
|
elif self.protocol == 'https':
|
|
conn = TimeoutHTTPS(host)
|
|
|
|
conn.set_timeout(self.timeout)
|
|
return conn
|
|
|
|
|
|
class TimeoutServerProxy(ServerProxy):
|
|
def __init__(self, uri, protocol, *l, **kw):
|
|
timeout = kw.pop('timeout', 10)
|
|
use_datetime = kw.get('use_datetime', 0)
|
|
kw['transport'] = TimeoutTransport(protocol, timeout=timeout, use_datetime=use_datetime)
|
|
ServerProxy.__init__(self, uri, *l, **kw)
|
|
|
|
|
|
class BlockstackRPCClient(object):
|
|
"""
|
|
RPC client for the blockstackd
|
|
"""
|
|
def __init__(self, server, port, max_rpc_len=MAX_RPC_LEN,
|
|
timeout=RPC_DEFAULT_TIMEOUT, debug_timeline=False, protocol=None, **kw):
|
|
|
|
if protocol is None:
|
|
log.warn("RPC constructor called without a protocol, defaulting " +
|
|
"to HTTP, this could be an issue if connection is on :6263")
|
|
protocol = 'http'
|
|
|
|
self.url = '{}://{}:{}'.format(protocol, server, port)
|
|
self.srv = TimeoutServerProxy(self.url, protocol, timeout=timeout, allow_none=True)
|
|
self.server = server
|
|
self.port = port
|
|
self.debug_timeline = debug_timeline
|
|
|
|
def log_debug_timeline(self, event, key, r=-1):
|
|
# random ID to match in logs
|
|
r = random.randint(0, 2 ** 16) if r == -1 else r
|
|
if self.debug_timeline:
|
|
log.debug('RPC({}) {} {} {}'.format(r, event, self.url, key))
|
|
return r
|
|
|
|
def __getattr__(self, key):
|
|
try:
|
|
return object.__getattr__(self, key)
|
|
except AttributeError:
|
|
r = self.log_debug_timeline('begin', key)
|
|
|
|
def inner(*args, **kw):
|
|
func = getattr(self.srv, key)
|
|
res = func(*args, **kw)
|
|
if res is None:
|
|
self.log_debug_timeline('end', key, r)
|
|
return
|
|
|
|
# lol jsonrpc within xmlrpc
|
|
try:
|
|
res = json.loads(res)
|
|
except (ValueError, TypeError):
|
|
msg = 'Server replied invalid JSON'
|
|
if BLOCKSTACK_TEST is not None:
|
|
log.debug('{}: {}'.format(msg, res))
|
|
|
|
log.error(msg)
|
|
res = {'error': msg}
|
|
|
|
self.log_debug_timeline('end', key, r)
|
|
|
|
return res
|
|
|
|
return inner
|
|
|
|
|
|
def json_is_error(resp):
|
|
"""
|
|
Is the given response object
|
|
(be it a string, int, or dict)
|
|
an error message?
|
|
|
|
Return True if so
|
|
Return False if not
|
|
"""
|
|
|
|
if not isinstance(resp, dict):
|
|
return False
|
|
|
|
return 'error' in resp
|
|
|
|
|
|
def json_is_exception(resp):
|
|
"""
|
|
Is the given response object
|
|
an exception traceback?
|
|
|
|
Return True if so
|
|
Return False if not
|
|
"""
|
|
if not json_is_error(resp):
|
|
return False
|
|
|
|
if 'traceback' not in resp.keys() or 'error' not in resp.keys():
|
|
return False
|
|
|
|
return True
|
|
|
|
|
|
def json_validate(schema, resp):
|
|
"""
|
|
Validate an RPC response.
|
|
The response must either take the
|
|
form of the given schema, or it must
|
|
take the form of {'error': ...}
|
|
|
|
Returns the resp on success
|
|
Returns {'error': ...} on validation error
|
|
"""
|
|
error_schema = {
|
|
'type': 'object',
|
|
'properties': {
|
|
'error': {
|
|
'type': 'string'
|
|
}
|
|
},
|
|
'required': [
|
|
'error'
|
|
]
|
|
}
|
|
|
|
# is this an error?
|
|
try:
|
|
jsonschema.validate(resp, error_schema)
|
|
except ValidationError:
|
|
# not an error.
|
|
jsonschema.validate(resp, schema)
|
|
|
|
return resp
|
|
|
|
|
|
def json_traceback(error_msg=None):
|
|
"""
|
|
Generate a stack trace as a JSON-formatted error message.
|
|
Optionally use error_msg as the error field.
|
|
Return {'error': ..., 'traceback'...}
|
|
"""
|
|
|
|
exception_data = traceback.format_exc().splitlines()
|
|
if error_msg is None:
|
|
error_msg = exception_data[-1]
|
|
else:
|
|
error_msg = 'Remote RPC error: {}'.format(error_msg)
|
|
|
|
return {
|
|
'error': error_msg,
|
|
'traceback': exception_data
|
|
}
|
|
|
|
|
|
def json_response_schema( expected_object_schema ):
|
|
"""
|
|
Make a schema for a "standard" server response.
|
|
Standard server responses have 'status': True
|
|
and possibly 'indexing': True set.
|
|
"""
|
|
schema = {
|
|
'type': 'object',
|
|
'properties': {
|
|
'status': {
|
|
'type': 'boolean',
|
|
},
|
|
'indexing': {
|
|
'type': 'boolean',
|
|
},
|
|
'lastblock': {
|
|
'anyOf': [
|
|
{
|
|
'type': 'integer',
|
|
'minimum': 0,
|
|
},
|
|
{
|
|
'type': 'null',
|
|
},
|
|
],
|
|
},
|
|
},
|
|
'required': [
|
|
'status',
|
|
'indexing',
|
|
'lastblock'
|
|
],
|
|
}
|
|
|
|
# fold in the given object schema
|
|
schema['properties'].update( expected_object_schema['properties'] )
|
|
schema['required'] = list(set( schema['required'] + expected_object_schema['required'] ))
|
|
|
|
return schema
|
|
|
|
|
|
def connect_hostport(hostport):
|
|
"""
|
|
Connect to the given "host:port" string
|
|
Returns a BlockstackRPCClient instance
|
|
"""
|
|
host, port = url_to_host_port(hostport)
|
|
assert host is not None and port is not None
|
|
|
|
protocol = None
|
|
if port == RPC_SERVER_PORT:
|
|
protocol = 'http'
|
|
else:
|
|
protocol = 'https'
|
|
|
|
proxy = BlockstackRPCClient(host, port, timeout=timeout, src=my_hostport, protocol=protocol)
|
|
return proxy
|
|
|
|
|
|
def ping(proxy=None, hostport=None):
|
|
"""
|
|
rpc_ping
|
|
Returns {'alive': True} on succcess
|
|
Returns {'error': ...} on error
|
|
"""
|
|
assert proxy or hostport, 'Need either proxy handle or hostport string'
|
|
|
|
schema = {
|
|
'type': 'object',
|
|
'properties': {
|
|
'status': {
|
|
'type': 'string'
|
|
},
|
|
},
|
|
'required': [
|
|
'status'
|
|
]
|
|
}
|
|
|
|
if proxy is None:
|
|
proxy = connect_hostport(hostport)
|
|
|
|
resp = {}
|
|
|
|
try:
|
|
resp = proxy.ping()
|
|
resp = json_validate( schema, resp )
|
|
if json_is_error(resp):
|
|
return resp
|
|
|
|
assert resp['status'] == 'alive'
|
|
|
|
except ValidationError as e:
|
|
if BLOCKSTACK_DEBUG:
|
|
log.exception(e)
|
|
|
|
resp = json_traceback(resp.get('error'))
|
|
|
|
except Exception as ee:
|
|
if BLOCKSTACK_DEBUG:
|
|
log.exception(ee)
|
|
|
|
log.error("Caught exception while connecting to Blockstack node: {}".format(ee))
|
|
resp = {'error': 'Failed to contact Blockstack node. Try again with `--debug`.'}
|
|
return resp
|
|
|
|
return resp
|
|
|
|
|
|
def getinfo(proxy=None, hostport=None):
|
|
"""
|
|
getinfo
|
|
Returns server info on success
|
|
Returns {'error': ...} on error
|
|
"""
|
|
assert proxy or hostport, 'Need either proxy handle or hostport string'
|
|
|
|
schema = {
|
|
'type': 'object',
|
|
'properties': {
|
|
'last_block_seen': {
|
|
'type': 'integer',
|
|
'minimum': 0,
|
|
},
|
|
'consensus': {
|
|
'type': 'string'
|
|
},
|
|
'server_version': {
|
|
'type': 'string'
|
|
},
|
|
'last_block_processed': {
|
|
'type': 'integer',
|
|
'minimum': 0,
|
|
},
|
|
'server_alive': {
|
|
'type': 'boolean'
|
|
},
|
|
'zonefile_count': {
|
|
'type': 'integer',
|
|
'minimum': 0,
|
|
},
|
|
'indexing': {
|
|
'type': 'boolean'
|
|
}
|
|
},
|
|
'required': [
|
|
'last_block_seen',
|
|
'consensus',
|
|
'server_version',
|
|
'last_block_processed',
|
|
'server_alive',
|
|
'indexing'
|
|
]
|
|
}
|
|
|
|
resp = {}
|
|
|
|
if proxy is None:
|
|
proxy = connect_hostport(hostport)
|
|
|
|
try:
|
|
resp = proxy.getinfo()
|
|
old_resp = resp
|
|
resp = json_validate( schema, resp )
|
|
if json_is_error(resp):
|
|
if BLOCKSTACK_TEST:
|
|
log.debug("invalid response: {}".format(old_resp))
|
|
return resp
|
|
|
|
except ValidationError as e:
|
|
if BLOCKSTACK_DEBUG:
|
|
log.exception(e)
|
|
|
|
resp = json_traceback(resp.get('error'))
|
|
|
|
except Exception as ee:
|
|
if BLOCKSTACK_DEBUG:
|
|
log.exception(ee)
|
|
|
|
log.error("Caught exception while connecting to Blockstack node: {}".format(ee))
|
|
resp = {'error': 'Failed to contact Blockstack node. Try again with `--debug`.'}
|
|
return resp
|
|
|
|
return resp
|
|
|
|
|
|
def get_zonefile_inventory(hostport, bit_offset, bit_count, timeout=30, my_hostport=None, proxy=None):
|
|
"""
|
|
Get the atlas zonefile inventory from the given peer.
|
|
Return {'status': True, 'inv': inventory} on success.
|
|
Return {'error': ...} on error
|
|
"""
|
|
|
|
assert hostport or proxy, 'Need either hostport or proxy'
|
|
|
|
inv_schema = {
|
|
'type': 'object',
|
|
'properties': {
|
|
'inv': {
|
|
'type': 'string',
|
|
'pattern': OP_BASE64_EMPTY_PATTERN
|
|
},
|
|
},
|
|
'required': [
|
|
'inv'
|
|
]
|
|
}
|
|
|
|
schema = json_response_schema( inv_schema )
|
|
|
|
if proxy is None:
|
|
proxy = connect_hostport(hostport)
|
|
|
|
zf_inv = None
|
|
try:
|
|
zf_inv = proxy.get_zonefile_inventory(bit_offset, bit_count)
|
|
zf_inv = json_validate(schema, zf_inv)
|
|
if json_is_error(zf_inv):
|
|
return zf_inv
|
|
|
|
# decode
|
|
zf_inv['inv'] = base64.b64decode(str(zf_inv['inv']))
|
|
|
|
# make sure it corresponds to this range
|
|
assert len(zf_inv['inv']) <= (bit_count / 8) + (bit_count % 8), 'Zonefile inventory in is too long (got {} bytes)'.format(len(zf_inv['inv']))
|
|
except (ValidationError, AssertionError) as e:
|
|
if BLOCKSTACK_DEBUG:
|
|
log.exception(e)
|
|
|
|
zf_inv = {'error': 'Failed to fetch and parse zonefile inventory'}
|
|
|
|
except Exception as ee:
|
|
if BLOCKSTACK_DEBUG:
|
|
log.exception(ee)
|
|
|
|
log.error("Caught exception while connecting to Blockstack node: {}".format(ee))
|
|
resp = {'error': 'Failed to contact Blockstack node. Try again with `--debug`.'}
|
|
return resp
|
|
|
|
return zf_inv
|
|
|
|
|
|
def get_atlas_peers(hostport, timeout=30, my_hostport=None, proxy=None):
|
|
"""
|
|
Get an atlas peer's neighbors.
|
|
Return {'status': True, 'peers': [peers]} on success.
|
|
Return {'error': ...} on error
|
|
"""
|
|
assert hostport or proxy, 'need either hostport or proxy'
|
|
|
|
peers_schema = {
|
|
'type': 'object',
|
|
'properties': {
|
|
'peers': {
|
|
'type': 'array',
|
|
'items': {
|
|
'type': 'string',
|
|
'pattern': '^([^:]+):([1-9][0-9]{1,4})$',
|
|
},
|
|
},
|
|
},
|
|
'required': [
|
|
'peers'
|
|
],
|
|
}
|
|
|
|
schema = json_response_schema( peers_schema )
|
|
|
|
if proxy is None:
|
|
proxy = connect_hostport(hostport)
|
|
|
|
peers = None
|
|
try:
|
|
peer_list_resp = proxy.get_atlas_peers()
|
|
peer_list_resp = json_validate(schema, peer_list_resp)
|
|
if json_is_error(peer_list_resp):
|
|
return peer_list_resp
|
|
|
|
# verify that all strings are host:ports
|
|
for peer_hostport in peer_list_resp['peers']:
|
|
peer_host, peer_port = url_to_host_port(peer_hostport)
|
|
if peer_host is None or peer_port is None:
|
|
return {'error': 'Invalid peer listing'}
|
|
|
|
peers = peer_list_resp
|
|
|
|
except (ValidationError, AssertionError) as e:
|
|
if BLOCKSTACK_DEBUG:
|
|
log.exception(e)
|
|
|
|
peers = json_traceback()
|
|
|
|
except Exception as ee:
|
|
if BLOCKSTACK_DEBUG:
|
|
log.exception(ee)
|
|
|
|
log.error("Caught exception while connecting to Blockstack node: {}".format(ee))
|
|
resp = {'error': 'Failed to contact Blockstack node {}. Try again with `--debug`.'.format(hostport)}
|
|
return resp
|
|
|
|
return peers
|
|
|
|
|
|
def get_zonefiles(hostport, zonefile_hashes, timeout=30, my_hostport=None, proxy=None):
|
|
"""
|
|
Get a set of zonefiles from the given server.
|
|
Return {'status': True, 'zonefiles': {hash: data, ...}} on success
|
|
Return {'error': ...} on error
|
|
"""
|
|
|
|
assert hostport or proxy, 'need either hostport or proxy'
|
|
|
|
zonefiles_schema = {
|
|
'type': 'object',
|
|
'properties': {
|
|
'zonefiles': {
|
|
'type': 'object',
|
|
'patternProperties': {
|
|
OP_ZONEFILE_HASH_PATTERN: {
|
|
'type': 'string',
|
|
'pattern': OP_BASE64_EMPTY_PATTERN
|
|
},
|
|
},
|
|
},
|
|
},
|
|
'required': [
|
|
'zonefiles',
|
|
]
|
|
}
|
|
|
|
schema = json_response_schema( zonefiles_schema )
|
|
|
|
if proxy is None:
|
|
proxy = connect_hostport(hostport)
|
|
|
|
zonefiles = None
|
|
try:
|
|
zf_payload = proxy.get_zonefiles(zonefile_hashes)
|
|
zf_payload = json_validate(schema, zf_payload)
|
|
if json_is_error(zf_payload):
|
|
return zf_payload
|
|
|
|
decoded_zonefiles = {}
|
|
|
|
for zf_hash, zf_data_b64 in zf_payload['zonefiles'].items():
|
|
zf_data = base64.b64decode( zf_data_b64 )
|
|
assert storage.verify_zonefile( zf_data, zf_hash ), "Zonefile data mismatch"
|
|
|
|
# valid
|
|
decoded_zonefiles[ zf_hash ] = zf_data
|
|
|
|
# return this
|
|
zf_payload['zonefiles'] = decoded_zonefiles
|
|
zonefiles = zf_payload
|
|
|
|
except AssertionError as ae:
|
|
if BLOCKSTACK_DEBUG:
|
|
log.exception(ae)
|
|
|
|
zonefiles = {'error': 'Zonefile data mismatch'}
|
|
|
|
except ValidationError as ve:
|
|
if BLOCKSTACK_DEBUG:
|
|
log.exception(ve)
|
|
|
|
zonefiles = json_traceback()
|
|
|
|
except Exception as ee:
|
|
if BLOCKSTACK_DEBUG:
|
|
log.exception(ee)
|
|
|
|
log.error("Caught exception while connecting to Blockstack node: {}".format(ee))
|
|
resp = {'error': 'Failed to contact Blockstack node. Try again with `--debug`.'}
|
|
return resp
|
|
|
|
return zonefiles
|
|
|
|
|
|
def put_zonefiles(hostport, zonefile_data_list, timeout=30, my_hostport=None, proxy=None):
|
|
"""
|
|
Push one or more zonefiles to the given server.
|
|
Return {'status': True, 'saved': [...]} on success
|
|
Return {'error': ...} on error
|
|
"""
|
|
assert hostport or proxy, 'need either hostport or proxy'
|
|
|
|
saved_schema = {
|
|
'type': 'object',
|
|
'properties': {
|
|
'saved': {
|
|
'type': 'array',
|
|
'items': {
|
|
'type': 'integer',
|
|
'minimum': 0,
|
|
'maximum': 1,
|
|
},
|
|
'minItems': len(zonefile_data_list),
|
|
'maxItems': len(zonefile_data_list)
|
|
},
|
|
},
|
|
'required': [
|
|
'saved'
|
|
]
|
|
}
|
|
|
|
schema = json_response_schema( saved_schema )
|
|
|
|
if proxy is None:
|
|
proxy = connect_hostport(hostport)
|
|
|
|
push_info = None
|
|
try:
|
|
|
|
push_info = proxy.put_zonefiles(zonefile_data_list)
|
|
push_info = json_validate(schema, push_info)
|
|
if json_is_error(push_info):
|
|
return push_info
|
|
|
|
except ValidationError as e:
|
|
if BLOCKSTACK_DEBUG:
|
|
log.exception(e)
|
|
|
|
push_info = json_traceback()
|
|
|
|
except Exception as ee:
|
|
if BLOCKSTACK_DEBUG:
|
|
log.exception(ee)
|
|
|
|
log.error("Caught exception while connecting to Blockstack node: {}".format(ee))
|
|
resp = {'error': 'Failed to contact Blockstack node. Try again with `--debug`.'}
|
|
return resp
|
|
|
|
return push_info
|