def initialize():
"""Initialize a service request.
In order to consume a data service the user is required to send
a number of data tokens to the provider as defined in the Asset's
service description in the Asset's DDO document.
The data tokens are transferred via the ethereum blockchain network
by requesting the user to sign an ERC20 `approveAndLock` transaction
where the approval is given to the provider's ethereum account for
the number of tokens required by the service.
:return:
json object as follows:
{
"from": <consumer-address>,
"to": <receiver-address>,
"numTokens": <tokens-amount-in-base>
"dataToken": <data-token-contract-address>,
"nonce": <nonce-used-in-consumer-signature>
}
"""
data = get_request_data(request)
try:
asset, service, did, consumer_address, token_address = process_consume_request( # noqa
data, 'initialize', require_signature=False)
url = get_asset_url_at_index(0, asset, provider_wallet)
download_url = get_download_url(url, app.config['CONFIG_FILE'])
valid, details = check_url_details(download_url)
if not valid:
logger.error(
f'Error: Asset URL not found or not available. \n'
f'Payload was: {data}',
exc_info=1)
return jsonify(error="Asset URL not found or not available."), 400
minter = get_datatoken_minter(asset, token_address)
# Prepare the `transfer` tokens transaction with the appropriate number
# of tokens required for this service
# The consumer must sign and execute this transaction in order to be
# able to consume the service
approve_params = {
"from": consumer_address,
"to": minter,
"numTokens": float(service.get_cost()),
"dataToken": token_address,
"nonce": user_nonce.get_nonce(consumer_address)
}
return Response(json.dumps(approve_params),
200,
headers={'content-type': 'application/json'})
except Exception as e:
logger.error(f'Error: {e}. \n' f'Payload was: {data}', exc_info=1)
return jsonify(error=str(e)), 500
def fileinfo():
"""Retrieves Content-Type and Content-Length from the given URL or
asset. Supports a payload of either url or did.
This can be used by the publisher of an asset to check basic information
about the URL(s). For now, this information consists of the Content-Type
and Content-Length of the request, using primarily OPTIONS, with fallback
to GET. In the future, we will add a hash to make sure that the file was
not tampered with at consumption time.
tags:
- services
responses:
200:
description: the URL(s) could be analysed (returns the result).
400:
description: the URL(s) could not be analysed (bad request).
return: list of file info (index, valid, contentLength, contentType)
"""
required_attributes = ['url', 'did']
data = get_request_data(request)
msg, status = check_at_least_one_attribute(required_attributes, data,
'checkURL')
if msg:
return jsonify(error=msg), status
did = data.get('did')
if did and not did.startswith('did:op:'):
return jsonify(error=f'Invalid `did` {did}.'), 400
url = data.get('url')
if did:
asset = get_asset_from_metadatastore(get_metadata_url(), did)
url_list = get_asset_download_urls(
asset, provider_wallet, config_file=app.config['CONFIG_FILE'])
else:
url_list = [
get_download_url(url, app.config['CONFIG_FILE']),
]
files_info = []
for i, url in enumerate(url_list):
valid, details = check_url_details(url)
info = {'index': i, 'valid': valid}
info.update(details)
files_info.append(info)
return Response(json.dumps(files_info),
200,
headers={'content-type': 'application/json'})
def test_download_ipfs_file(client):
cid = 'QmQfpdcMWnLTXKKW9GPV7NgtEugghgD6HgzSF6gSrp2mL9'
url = f'ipfs://{cid}'
download_url = get_download_url(url, None)
requests_session = get_requests_session()
request = Mock()
request.range = None
print(f'got ipfs download url: {download_url}')
assert download_url and download_url.endswith(f'ipfs/{cid}')
response = build_download_response(request, requests_session, download_url, download_url, None)
assert response.data, f'got no data {response.data}'
def simple_flow_consume():
required_attributes = [
'consumerAddress',
'dataToken',
'transferTxId'
]
data = get_request_data(request)
msg, status = check_required_attributes(
required_attributes, data, 'simple_flow_consume')
if msg:
return jsonify(error=msg), status
consumer = data.get('consumerAddress')
dt_address = data.get('dataToken')
tx_id = data.get('transferTxId')
dt_map = None
dt_map_str = os.getenv('CONFIG', '')
if dt_map_str:
dt_map = json.loads(dt_map_str)
if not (dt_map_str and dt_map): # or dt not in dt_map:
return jsonify(error='This request is not supported.'), 400
try:
dt = DataToken(dt_address)
# TODO: Verify that the datatoken is owned by this provider's account
# TODO: Enable this check for the token transfer.
# validate_order(
# consumer,
# dt_address,
# 1,
# tx_id
# )
url = list(dt_map.values())[0] # [dt_address]
download_url = get_download_url(url, app.config['CONFIG_FILE'])
logger.info(f'Done processing consume request for data token {dt_address}, '
f' url {download_url}')
return build_download_response(request, requests_session, url, download_url)
except Exception as e:
logger.error(
f'Error: {e}. \n'
f'Payload was: dataToken={dt_address}, '
f'consumerAddress={consumer}',
exc_info=1
)
return jsonify(error=e), 500
def fileinfo():
"""Retrieves Content-Type and Content-Length from the given URL or asset. Supports a payload of either url or did.
This can be used by the publisher of an asset to check basic information
about the URL(s). For now, this information consists of the Content-Type
and Content-Length of the request, using primarily OPTIONS, with fallback
to GET. In the future, we will add a hash to make sure that the file was
not tampered with at consumption time.
---
tags:
- services
responses:
200:
description: the URL(s) could be analysed (returns the result).
400:
description: the URL(s) could not be analysed (bad request).
return: list of file info (index, valid, contentLength, contentType)
"""
data = get_request_data(request)
did = data.get("did")
url = data.get("url")
if did:
asset = get_asset_from_metadatastore(get_metadata_url(), did)
url_list = get_asset_download_urls(
asset, provider_wallet, config_file=app.config["CONFIG_FILE"])
else:
url_list = [get_download_url(url, app.config["CONFIG_FILE"])]
with_checksum = data.get("checksum", False)
files_info = []
for i, url in enumerate(url_list):
valid, details = check_url_details(url, with_checksum=with_checksum)
info = {"index": i, "valid": valid}
info.update(details)
files_info.append(info)
return Response(json.dumps(files_info),
200,
headers={"content-type": "application/json"})
def simple_flow_consume():
data = get_request_data(request)
consumer = data.get("consumerAddress")
dt_address = data.get("dataToken")
dt_map = None
dt_map_str = os.getenv("CONFIG", "")
if dt_map_str:
dt_map = json.loads(dt_map_str)
if not (dt_map_str and dt_map): # or dt not in dt_map:
return jsonify(error="This request is not supported."), 400
try:
_ = DataToken(dt_address)
# TODO: verify that the datatoken is owned by this provider's account
# TODO: Enable this check for the token transfer.
# validate_order(
# consumer,
# dt_address,
# 1,
# tx_id
# )
url = list(dt_map.values())[0] # [dt_address]
download_url = get_download_url(url, app.config["CONFIG_FILE"])
logger.info(
f"Done processing consume request for data token {dt_address}, "
f" url {download_url}")
return build_download_response(request, requests_session, url,
download_url)
except Exception as e:
logger.error(
f"Error: {e}. \n"
f"Payload was: dataToken={dt_address}, "
f"consumerAddress={consumer}",
exc_info=1,
)
return jsonify(error=str(e)), 500
def download():
"""Allows download of asset data file.
---
tags:
- services
consumes:
- application/json
parameters:
- name: consumerAddress
in: query
description: The consumer address.
required: true
type: string
- name: documentId
in: query
description: The ID of the asset/document (the DID).
required: true
type: string
- name: url
in: query
description: This URL is only valid if Provider acts as a proxy.
Consumer can't download using the URL if it's not through the Provider.
required: true
type: string
- name: signature
in: query
description: Signature of the documentId to verify that the consumer has rights to download the asset.
- name: index
in: query
description: Index of the file in the array of files.
responses:
200:
description: Redirect to valid asset url.
400:
description: One of the required attributes is missing.
401:
description: Invalid asset data.
500:
description: Error
"""
data = get_request_data(request)
try:
asset, service, did, consumer_address, token_address = process_consume_request( # noqa
data,
'download',
user_nonce=user_nonce,
additional_params=["transferTxId", "fileIndex"])
service_id = data.get('serviceId')
service_type = data.get('serviceType')
signature = data.get('signature')
tx_id = data.get("transferTxId")
if did.startswith('did:'):
did = add_0x_prefix(did_to_id(did))
_tx, _order_log, _transfer_log = validate_order(
consumer_address, token_address, float(service.get_cost()), tx_id,
did, service_id)
validate_transfer_not_used_for_other_service(did, service_id, tx_id,
consumer_address,
token_address)
record_consume_request(did, service_id, tx_id, consumer_address,
token_address, service.get_cost())
assert service_type == ServiceTypes.ASSET_ACCESS
file_index = int(data.get('fileIndex'))
file_attributes = asset.metadata['main']['files'][file_index]
content_type = file_attributes.get('contentType', None)
url = get_asset_url_at_index(file_index, asset, provider_wallet)
download_url = get_download_url(url, app.config['CONFIG_FILE'])
logger.info(f'Done processing consume request for asset {did}, '
f' url {download_url}')
user_nonce.increment_nonce(consumer_address)
return build_download_response(request, requests_session, url,
download_url, content_type)
except InvalidSignatureError as e:
msg = f'Consumer signature failed verification: {e}'
logger.error(msg, exc_info=1)
return jsonify(error=msg), 401
except Exception as e:
logger.error(
f'Error: {e}. \n'
f'Payload was: documentId={did}, '
f'consumerAddress={consumer_address},'
f'signature={signature}'
f'serviceId={service_id}'
f'serviceType={service_type}',
exc_info=1)
return jsonify(error=str(e)), 500
def download():
"""Allows download of asset data file.
---
tags:
- services
consumes:
- application/json
parameters:
- name: consumerAddress
in: query
description: The consumer address.
required: true
type: string
- name: documentId
in: query
description: The ID of the asset/document (the DID).
required: true
type: string
- name: url
in: query
description: This URL is only valid if Provider acts as a proxy.
Consumer can't download using the URL if it's not through the Provider.
required: true
type: string
- name: signature
in: query
description: Signature of the documentId to verify that the consumer has rights to download the asset.
- name: index
in: query
description: Index of the file in the array of files.
responses:
200:
description: Redirect to valid asset url.
400:
description: One of the required attributes is missing.
401:
description: Invalid asset data.
500:
description: Error
"""
data = get_request_data(request)
try:
(
asset,
service,
did,
consumer_address,
token_address,
) = process_consume_request(data)
service_id = data.get("serviceId")
service_type = data.get("serviceType")
tx_id = data.get("transferTxId")
if did.startswith("did:"):
did = add_0x_prefix(did_to_id(did))
_tx, _order_log, _transfer_log = validate_order(
consumer_address,
token_address,
float(service.get_cost()),
tx_id,
did,
service_id,
)
validate_transfer_not_used_for_other_service(did, service_id, tx_id,
consumer_address,
token_address)
record_consume_request(did, service_id, tx_id, consumer_address,
token_address, service.get_cost())
assert service_type == ServiceTypes.ASSET_ACCESS
file_index = int(data.get("fileIndex"))
file_attributes = asset.metadata["main"]["files"][file_index]
content_type = file_attributes.get("contentType", None)
url = get_asset_url_at_index(file_index, asset, provider_wallet)
if not url:
return jsonify(error="Cannot decrypt files for this asset."), 400
download_url = get_download_url(url, app.config["CONFIG_FILE"])
logger.info(f"Done processing consume request for asset {did}, "
f" url {download_url}")
increment_nonce(consumer_address)
return build_download_response(request, requests_session, url,
download_url, content_type)
except Exception as e:
logger.error(
f"Error: {e}. \n"
f"Payload was: documentId={data.get('did')}, "
f"consumerAddress={data.get('consumerAddress')},"
f"serviceId={data.get('serviceId')}"
f"serviceType={data.get('serviceType')}",
exc_info=1,
)
return jsonify(error=str(e)), 500
def download():
"""Allows download of asset data file.
---
tags:
- services
consumes:
- application/json
parameters:
- name: consumerAddress
in: query
description: The consumer address.
required: true
type: string
- name: serviceAgreementId
in: query
description: The ID of the service agreement.
required: true
type: string
- name: url
in: query
description: This URL is only valid if Provider acts as a proxy.
Consumer can't download using the URL if it's not through the Provider.
required: true
type: string
- name: signature
in: query
description: Signature of the documentId to verify that the consumer has rights to download the asset.
- name: index
in: query
description: Index of the file in the array of files.
responses:
200:
description: Redirect to valid asset url.
400:
description: One of the required attributes is missing.
401:
description: Invalid asset data.
500:
description: Error
"""
data = get_request_data(request)
try:
asset, service, did, consumer_address, token_address = process_consume_request(
data, 'download', additional_params=["transferTxId", "fileIndex"])
service_id = data.get('serviceId')
service_type = data.get('serviceType')
signature = data.get('signature')
tx_id = data.get("transferTxId")
validate_token_transfer(
consumer_address,
provider_acc.address,
token_address,
# FIXME: Replace this constant price number
5, #service.get_price(),
tx_id)
file_index = int(data.get('fileIndex'))
file_attributes = asset.metadata['main']['files'][file_index]
content_type = file_attributes.get('contentType', None)
url = get_asset_url_at_index(file_index, asset, provider_acc)
download_url = get_download_url(url, app.config['CONFIG_FILE'])
logger.info(f'Done processing consume request for asset {did}, '
f' url {download_url}')
return build_download_response(request, requests_session, url,
download_url, content_type)
except InvalidSignatureError as e:
msg = f'Consumer signature failed verification: {e}'
logger.error(msg, exc_info=1)
return jsonify(error=msg), 401
except Exception as e:
logger.error(
f'Error: {e}. \n'
f'Payload was: documentId={did}, '
f'consumerAddress={consumer_address},'
f'signature={signature}'
f'serviceId={service_id}'
f'serviceType={service_type}',
exc_info=1)
return jsonify(error=e), 500