def decode_name_zonefile(zonefile_txt):
"""
Decode a serialized zonefile into a JSON dict
Return None on error
"""
user_zonefile = None
try:
# by default, it's a zonefile-formatted text file
user_zonefile_defaultdict = blockstack_zones.parse_zone_file(
zonefile_txt)
assert user_db.is_user_zonefile(
user_zonefile_defaultdict), "Not a user zonefile"
# force dict
user_zonefile = dict(user_zonefile_defaultdict)
except (IndexError, ValueError, blockstack_zones.InvalidLineException):
# might be legacy profile
log.debug(
"WARN: failed to parse user zonefile; trying to import as legacy")
try:
user_zonefile = json.loads(zonefile_txt)
if type(user_zonefile) != dict:
log.debug("Not a legacy user zonefile")
return None
except Exception, e:
if os.environ.get("BLOCKSTACK_DEBUG", None) == "1":
log.exception(e)
log.error("Failed to parse non-standard zonefile")
return None
def store_name_zonefile( name, user_zonefile, txid, storage_drivers=None ):
"""
Store JSON user zonefile data to the immutable storage providers, synchronously.
This is only necessary if we've added/changed/removed immutable data.
Return (True, hash(user zonefile)) on success
Return (False, None) on failure
"""
storage_drivers = [] if storage_drivers is None else storage_drivers
assert not blockstack_profiles.is_profile_in_legacy_format(user_zonefile), "User zonefile is a legacy profile"
assert user_db.is_user_zonefile(user_zonefile), "Not a user zonefile (maybe a custom legacy profile?)"
# serialize and send off
user_zonefile_txt = blockstack_zones.make_zone_file( user_zonefile, origin=name, ttl=USER_ZONEFILE_TTL )
return store_name_zonefile_data( name, user_zonefile_txt, txid, storage_drivers=storage_drivers )
def get_profile(name,
zonefile_storage_drivers=None,
profile_storage_drivers=None,
proxy=None,
user_zonefile=None,
name_record=None,
include_name_record=False,
include_raw_zonefile=False,
use_zonefile_urls=True,
use_legacy=False,
use_legacy_zonefile=True,
decode_profile=True):
"""
Given a name, look up an associated profile.
Do so by first looking up the zonefile the name points to,
and then loading the profile from that zonefile's public key.
Notes on backwards compatibility (activated if use_legacy=True and use_legacy_zonefile=True):
* (use_legacy=True) If the user's zonefile is really a legacy profile from Onename, then
the profile returned will be the converted legacy profile. The returned zonefile will still
be a legacy profile, however.
The caller can check this and perform the conversion automatically.
* (use_legacy_zonefile=True) If the name points to a current zonefile that does not have a
data public key, then the owner address of the name will be used to verify
the profile's authenticity.
Returns {'status': True, 'profile': profile, 'zonefile': zonefile, 'public_key': ...} on success.
* If include_name_record is True, then include 'name_record': name_record with the user's blockchain information
* If include_raw_zonefile is True, then include 'raw_zonefile': raw_zonefile with unparsed zone file
Returns {'error': ...} on error
"""
proxy = get_default_proxy() if proxy is None else proxy
user_profile_pubkey = None
res = subdomains.is_address_subdomain(str(name))
if res:
subdomain, domain = res[1]
try:
return subdomains.resolve_subdomain(subdomain, domain)
except subdomains.SubdomainNotFound as e:
log.exception(e)
return {
'error': "Failed to find name {}.{}".format(subdomain, domain)
}
raw_zonefile = None
if user_zonefile is None:
user_zonefile = get_name_zonefile(
name,
proxy=proxy,
name_record=name_record,
include_name_record=True,
storage_drivers=zonefile_storage_drivers,
include_raw_zonefile=include_raw_zonefile,
allow_legacy=True)
if 'error' in user_zonefile:
return user_zonefile
raw_zonefile = None
if include_raw_zonefile:
raw_zonefile = user_zonefile.pop('raw_zonefile')
user_zonefile = user_zonefile['zonefile']
# is this really a legacy profile?
if blockstack_profiles.is_profile_in_legacy_format(user_zonefile):
if not use_legacy:
return {'error': 'Profile is in legacy format'}
# convert it
log.debug('Converting legacy profile to modern profile')
user_profile = blockstack_profiles.get_person_from_legacy_format(
user_zonefile)
elif not user_db.is_user_zonefile(user_zonefile):
if not use_legacy:
return {'error': 'Name zonefile is non-standard'}
# not a legacy profile, but a custom profile
log.debug('Using custom legacy profile')
user_profile = copy.deepcopy(user_zonefile)
else:
# get user's data public key
data_address, owner_address = None, None
try:
user_data_pubkey = user_db.user_zonefile_data_pubkey(user_zonefile)
if user_data_pubkey is not None:
user_data_pubkey = str(user_data_pubkey)
data_address = keylib.ECPublicKey(user_data_pubkey).address()
except ValueError:
# multiple keys defined; we don't know which one to use
user_data_pubkey = None
if not use_legacy_zonefile and user_data_pubkey is None:
# legacy zonefile without a data public key
return {'error': 'Name zonefile is missing a public key'}
# find owner address
if name_record is None:
name_record = get_name_blockchain_record(name, proxy=proxy)
if name_record is None or 'error' in name_record:
log.error(
'Failed to look up name record for "{}"'.format(name))
return {'error': 'Failed to look up name record'}
assert 'address' in name_record.keys(), json.dumps(name_record,
indent=4,
sort_keys=True)
owner_address = name_record['address']
# get user's data public key from the zonefile
urls = None
if use_zonefile_urls and user_zonefile is not None:
urls = user_db.user_zonefile_urls(user_zonefile)
user_profile = None
user_profile_pubkey = None
try:
user_profile_res = storage.get_mutable_data(
name,
user_data_pubkey,
blockchain_id=name,
data_address=data_address,
owner_address=owner_address,
urls=urls,
drivers=profile_storage_drivers,
decode=decode_profile,
return_public_key=True)
user_profile = user_profile_res['data']
user_profile_pubkey = user_profile_res['public_key']
except Exception as e:
log.exception(e)
return {'error': 'Failure in parsing and fetching profile'}
if user_profile is None or json_is_error(user_profile):
if user_profile is None:
log.error('no user profile for {}'.format(name))
else:
log.error('failed to load profile for {}: {}'.format(
name, user_profile['error']))
return {'error': 'Failed to load user profile'}
# finally, if the caller asked for the name record, and we didn't get a chance to look it up,
# then go get it.
ret = {
'status': True,
'profile': user_profile,
'zonefile': user_zonefile,
'public_key': user_profile_pubkey
}
if include_name_record:
if name_record is None:
name_record = get_name_blockchain_record(name, proxy=proxy)
if name_record is None or 'error' in name_record:
log.error('Failed to look up name record for "{}"'.format(name))
return {'error': 'Failed to look up name record'}
ret['name_record'] = name_record
if include_raw_zonefile:
if raw_zonefile is not None:
ret['raw_zonefile'] = raw_zonefile
return ret
def get_and_migrate_profile(name,
zonefile_storage_drivers=None,
profile_storage_drivers=None,
proxy=None,
create_if_absent=False,
wallet_keys=None,
include_name_record=False):
"""
Get a name's profile and zonefile, optionally creating a new one along the way. Migrate the profile to a new zonefile,
if the profile is in legacy format.
Only pass 'create_if_absent=True' for names we own
If @include_name_record is set, then the resulting zonefile will have a key called 'name_record' that includes the name record.
@wallet_keys, if given, only needs the data public key set.
Return ({'profile': user_profile}, {'zonefile': user_zonefile}, migrated:bool) on success
Return ({'error': ...}, None, False) on error
"""
if proxy is None:
proxy = get_default_proxy()
created_new_zonefile = False
created_new_profile = False
name_record = None
user_zonefile = get_name_zonefile(name,
storage_drivers=zonefile_storage_drivers,
proxy=proxy,
wallet_keys=wallet_keys,
include_name_record=True)
if user_zonefile is None or 'error' in user_zonefile:
if not create_if_absent:
return ({'error': 'No such zonefile'}, None, False)
# creating. we'd better have a data public key
log.debug("Creating new profile and zonefile for name '%s'" % name)
data_pubkey = load_data_pubkey_for_new_zonefile(
wallet_keys=wallet_keys, config_path=proxy.conf['path'])
if data_pubkey is None:
log.warn(
"No data keypair set; will fall back to owner private key for data signing"
)
user_profile = user_db.make_empty_user_profile()
user_zonefile = user_db.make_empty_user_zonefile(name, data_pubkey)
# look up name too
name_record = proxy.get_name_blockchain_record(name)
if name_record is None:
return ({'error': 'No such name'}, None, False)
if 'error' in name_record:
return ({
'error':
'Failed to look up name: %s' % name_record['error']
}, None, False)
created_new_zonefile = True
created_new_profile = True
else:
name_record = user_zonefile['name_record']
del user_zonefile['name_record']
user_zonefile = user_zonefile['zonefile']
if blockstack_profiles.is_profile_in_legacy_format(
user_zonefile) or not user_db.is_user_zonefile(user_zonefile):
log.debug("Migrating legacy profile to modern zonefile for name '%s'" %
name)
data_pubkey = load_data_pubkey_for_new_zonefile(
wallet_keys=wallet_keys, config_path=proxy.conf['path'])
if data_pubkey is None:
log.warn(
"No data keypair set; will fall back to owner private key for data signing"
)
user_profile = {}
if blockstack_profiles.is_profile_in_legacy_format(user_zonefile):
# traditional profile
user_profile = blockstack_profiles.get_person_from_legacy_format(
user_zonefile)
else:
# custom profile
user_profile = copy.deepcopy(user_zonefile)
user_zonefile = user_db.make_empty_user_zonefile(name, data_pubkey)
created_new_zonefile = True
created_new_profile = True
else:
if not created_new_profile:
user_profile, error_msg = get_name_profile(
name,
zonefile_storage_drivers=zonefile_storage_drivers,
profile_storage_drivers=profile_storage_drivers,
proxy=proxy,
user_zonefile=user_zonefile,
name_record=name_record)
if user_profile is None:
return (error_msg, None, False)
elif create_if_absent:
log.debug(
"Creating new profile for existing zonefile for name '%s'" %
name)
user_profile = user_db.make_empty_user_profile()
created_new_profile = True
else:
raise Exception("Should be unreachable")
ret_user_profile = {"profile": user_profile}
ret_user_zonefile = {"zonefile": user_zonefile}
if include_name_record:
# put it back
ret_user_zonefile['name_record'] = name_record
return (ret_user_profile, ret_user_zonefile, created_new_zonefile)
def get_name_profile(name,
zonefile_storage_drivers=None,
profile_storage_drivers=None,
create_if_absent=False,
proxy=None,
user_zonefile=None,
name_record=None,
include_name_record=False,
include_raw_zonefile=False,
use_zonefile_urls=True,
decode_profile=True):
"""
Given the name of the user, look up the user's record hash,
and then get the record itself from storage.
If the user's zonefile is really a legacy profile, then
the profile will be the converted legacy profile. The
returned zonefile will still be a legacy profile, however.
The caller can check this and perform the conversion automatically.
Returns (profile, zonefile) on success. If include_name_record is True, then zonefile['name_record'] will be defined and will contain the user's blockchain information
Returns (None, {'error': ...}) on failure
"""
if proxy is None:
proxy = get_default_proxy()
raw_zonefile = None
if user_zonefile is None:
user_zonefile = get_name_zonefile(
name,
create_if_absent=create_if_absent,
proxy=proxy,
name_record=name_record,
include_name_record=True,
storage_drivers=zonefile_storage_drivers,
include_raw_zonefile=include_raw_zonefile)
if user_zonefile is None:
return (None, {'error': 'No user zonefile'})
if 'error' in user_zonefile:
return (None, user_zonefile)
name_record = user_zonefile['name_record']
del user_zonefile['name_record']
raw_zonefile = None
if include_raw_zonefile:
raw_zonefile = user_zonefile['raw_zonefile']
del user_zonefile['raw_zonefile']
user_zonefile = user_zonefile['zonefile']
# is this really a legacy profile?
if blockstack_profiles.is_profile_in_legacy_format(user_zonefile):
# convert it
log.debug("Converting legacy profile to modern profile")
user_profile = blockstack_profiles.get_person_from_legacy_format(
user_zonefile)
elif not user_db.is_user_zonefile(user_zonefile):
# not a legacy profile, but a custom profile
log.debug("Using custom legacy profile")
user_profile = copy.deepcopy(user_zonefile)
else:
# get user's data public key
user_address = None
old_address = None
try:
user_data_pubkey = user_db.user_zonefile_data_pubkey(user_zonefile)
if user_data_pubkey is not None:
user_data_pubkey = str(user_data_pubkey)
user_address = virtualchain.BitcoinPublicKey(
user_data_pubkey).address()
except ValueError:
# user decided to put multiple keys under the same name into the zonefile.
# so don't use them.
user_data_pubkey = None
# convert to address
if name_record is None:
name_record = proxy.get_name_blockchain_record(name)
if name_record is None or 'error' in name_record:
log.error("Failed to look up name record for '%s'" % name)
return (None, {'error': 'Failed to look up name record'})
old_address = name_record['address']
if user_address is None:
# cut to the chase
user_address = old_address
user_profile = load_name_profile(
name,
user_zonefile,
user_address,
old_address,
use_zonefile_urls=use_zonefile_urls,
storage_drivers=profile_storage_drivers,
decode=decode_profile)
if user_profile is not None:
if decode_profile:
assert isinstance(user_profile, dict)
else:
assert type(user_profile) in [str, unicode]
else:
log.debug("WARN: no user profile for %s" % name)
if create_if_absent:
user_profile = user_db.make_empty_user_profile()
else:
return (None, {'error': 'Failed to load user profile'})
# finally, if the caller asked for the name record, and we didn't get a chance to look it up,
# then go get it.
if include_name_record:
if name_record is None:
name_record = proxy.get_name_blockchain_record(name)
if name_record is None or 'error' in name_record:
log.error("Failed to look up name record for '%s'" % name)
return (None, {'error': 'Failed to look up name record'})
user_zonefile['name_record'] = name_record
if include_raw_zonefile:
if raw_zonefile is not None:
user_zonefile['raw_zonefile'] = raw_zonefile
return (user_profile, user_zonefile)
def get_profile(name, zonefile_storage_drivers=None, profile_storage_drivers=None,
proxy=None, user_zonefile=None, name_record=None,
include_name_record=False, include_raw_zonefile=False, use_zonefile_urls=True,
use_legacy=False, use_legacy_zonefile=True, decode_profile=True):
"""
Given a name, look up an associated profile.
Do so by first looking up the zonefile the name points to,
and then loading the profile from that zonefile's public key.
Notes on backwards compatibility (activated if use_legacy=True and use_legacy_zonefile=True):
* (use_legacy=True) If the user's zonefile is really a legacy profile from Onename, then
the profile returned will be the converted legacy profile. The returned zonefile will still
be a legacy profile, however.
The caller can check this and perform the conversion automatically.
* (use_legacy_zonefile=True) If the name points to a current zonefile that does not have a
data public key, then the owner address of the name will be used to verify
the profile's authenticity.
Returns {'status': True, 'profile': profile, 'zonefile': zonefile} on success.
* If include_name_record is True, then include 'name_record': name_record with the user's blockchain information
* If include_raw_zonefile is True, then include 'raw_zonefile': raw_zonefile with unparsed zone file
Returns {'error': ...} on error
"""
proxy = get_default_proxy() if proxy is None else proxy
raw_zonefile = None
if user_zonefile is None:
user_zonefile = get_name_zonefile(
name, proxy=proxy,
name_record=name_record, include_name_record=True,
storage_drivers=zonefile_storage_drivers,
include_raw_zonefile=include_raw_zonefile,
allow_legacy=True
)
if 'error' in user_zonefile:
return user_zonefile
raw_zonefile = None
if include_raw_zonefile:
raw_zonefile = user_zonefile.pop('raw_zonefile')
user_zonefile = user_zonefile['zonefile']
# is this really a legacy profile?
if blockstack_profiles.is_profile_in_legacy_format(user_zonefile):
if not use_legacy:
return {'error': 'Profile is in legacy format'}
# convert it
log.debug('Converting legacy profile to modern profile')
user_profile = blockstack_profiles.get_person_from_legacy_format(user_zonefile)
elif not user_db.is_user_zonefile(user_zonefile):
if not use_legacy:
return {'error': 'Name zonefile is non-standard'}
# not a legacy profile, but a custom profile
log.debug('Using custom legacy profile')
user_profile = copy.deepcopy(user_zonefile)
else:
# get user's data public key
data_address, owner_address = None, None
try:
user_data_pubkey = user_db.user_zonefile_data_pubkey(user_zonefile)
if user_data_pubkey is not None:
user_data_pubkey = str(user_data_pubkey)
data_address = keylib.ECPublicKey(user_data_pubkey).address()
except ValueError:
# multiple keys defined; we don't know which one to use
user_data_pubkey = None
if not use_legacy_zonefile and user_data_pubkey is None:
# legacy zonefile without a data public key
return {'error': 'Name zonefile is missing a public key'}
# find owner address
if name_record is None:
name_record = get_name_blockchain_record(name, proxy=proxy)
if name_record is None or 'error' in name_record:
log.error('Failed to look up name record for "{}"'.format(name))
return {'error': 'Failed to look up name record'}
assert 'address' in name_record.keys(), json.dumps(name_record, indent=4, sort_keys=True)
owner_address = name_record['address']
# get user's data public key from the zonefile
urls = None
if use_zonefile_urls and user_zonefile is not None:
urls = user_db.user_zonefile_urls(user_zonefile)
user_profile = storage.get_mutable_data(
name, user_data_pubkey, blockchain_id=name,
data_address=data_address, owner_address=owner_address,
urls=urls, drivers=profile_storage_drivers, decode=decode_profile,
)
if user_profile is None or json_is_error(user_profile):
if user_profile is None:
log.error('no user profile for {}'.format(name))
else:
log.error('failed to load profile for {}: {}'.format(name, user_profile['error']))
return {'error': 'Failed to load user profile'}
# finally, if the caller asked for the name record, and we didn't get a chance to look it up,
# then go get it.
ret = {
'status': True,
'profile': user_profile,
'zonefile': user_zonefile
}
if include_name_record:
if name_record is None:
name_record = get_name_blockchain_record(name, proxy=proxy)
if name_record is None or 'error' in name_record:
log.error('Failed to look up name record for "{}"'.format(name))
return {'error': 'Failed to look up name record'}
ret['name_record'] = name_record
if include_raw_zonefile:
if raw_zonefile is not None:
ret['raw_zonefile'] = raw_zonefile
return ret
def get_profile(name,
zonefile_storage_drivers=None,
profile_storage_drivers=None,
proxy=None,
user_zonefile=None,
name_record=None,
include_name_record=False,
include_raw_zonefile=False,
use_zonefile_urls=True,
use_legacy=False,
use_legacy_zonefile=True,
decode_profile=True):
"""
Given a name, look up an associated profile.
Do so by first looking up the zonefile the name points to,
and then loading the profile from that zonefile's public key.
Notes on backwards compatibility (activated if use_legacy=True and use_legacy_zonefile=True):
* (use_legacy=True) If the user's zonefile is really a legacy profile from Onename, then
the profile returned will be the converted legacy profile. The returned zonefile will still
be a legacy profile, however.
The caller can check this and perform the conversion automatically.
* (use_legacy_zonefile=True) If the name points to a current zonefile that does not have a
data public key, then the owner address of the name will be used to verify
the profile's authenticity.
Returns (profile, zonefile) on success. If include_name_record is True, then zonefile['name_record'] will be defined and will contain the user's blockchain information
Returns (None, {'error': ...}) on failure
"""
proxy = get_default_proxy() if proxy is None else proxy
raw_zonefile = None
if user_zonefile is None:
user_zonefile = get_name_zonefile(
name,
proxy=proxy,
name_record=name_record,
include_name_record=True,
storage_drivers=zonefile_storage_drivers,
include_raw_zonefile=include_raw_zonefile,
allow_legacy=True)
if 'error' in user_zonefile:
return None, user_zonefile
raw_zonefile = None
if include_raw_zonefile:
raw_zonefile = user_zonefile.pop('raw_zonefile')
user_zonefile = user_zonefile['zonefile']
# is this really a legacy profile?
if blockstack_profiles.is_profile_in_legacy_format(user_zonefile):
if not use_legacy:
return (None, {'error': 'Profile is in legacy format'})
# convert it
log.debug('Converting legacy profile to modern profile')
user_profile = blockstack_profiles.get_person_from_legacy_format(
user_zonefile)
elif not user_db.is_user_zonefile(user_zonefile):
if not use_legacy:
return (None, {'error': 'Name zonefile is non-standard'})
# not a legacy profile, but a custom profile
log.debug('Using custom legacy profile')
user_profile = copy.deepcopy(user_zonefile)
else:
# get user's data public key
data_address, owner_address = None, None
try:
user_data_pubkey = user_db.user_zonefile_data_pubkey(user_zonefile)
if user_data_pubkey is not None:
user_data_pubkey = str(user_data_pubkey)
data_address = virtualchain.BitcoinPublicKey(
user_data_pubkey).address()
except ValueError:
# multiple keys defined; we don't know which one to use
user_data_pubkey = None
if not use_legacy_zonefile and user_data_pubkey is None:
# legacy zonefile without a data public key
return (None, {'error': 'Name zonefile is missing a public key'})
# find owner address
if name_record is None:
name_record = get_name_blockchain_record(name, proxy=proxy)
if name_record is None or 'error' in name_record:
log.error(
'Failed to look up name record for "{}"'.format(name))
return None, {'error': 'Failed to look up name record'}
assert 'address' in name_record.keys(), json.dumps(name_record,
indent=4,
sort_keys=True)
owner_address = name_record['address']
# get user's data public key from the zonefile
urls = None
if use_zonefile_urls and user_zonefile is not None:
urls = user_db.user_zonefile_urls(user_zonefile)
user_profile = storage.get_mutable_data(
name,
user_data_pubkey,
data_address=data_address,
owner_address=owner_address,
urls=urls,
drivers=profile_storage_drivers,
decode=decode_profile,
)
if user_profile is None or json_is_error(user_profile):
if user_profile is None:
log.debug('WARN: no user profile for {}'.format(name))
else:
log.debug('WARN: failed to load profile for {}: {}'.format(
name, user_profile['error']))
return None, {'error': 'Failed to load user profile'}
# finally, if the caller asked for the name record, and we didn't get a chance to look it up,
# then go get it.
if include_name_record:
if name_record is None:
name_record = get_name_blockchain_record(name, proxy=proxy)
if name_record is None or 'error' in name_record:
log.error('Failed to look up name record for "{}"'.format(name))
return None, {'error': 'Failed to look up name record'}
user_zonefile['name_record'] = name_record
if include_raw_zonefile:
if raw_zonefile is not None:
user_zonefile['raw_zonefile'] = raw_zonefile
return user_profile, user_zonefile
