Updates get_appointment status messages and small changes

This commit is contained in:
Sergi Delgado Segura
2019-07-09 17:06:19 +01:00
parent 74ecf0ab54
commit 2d77919af4
4 changed files with 195 additions and 152 deletions

View File

@@ -0,0 +1,188 @@
import requests
import re
import os
import sys
import json
from getopt import getopt, GetoptError
from sys import argv
import logging
from conf import CLIENT_LOG_FILE
from hashlib import sha256
from binascii import unhexlify
from apps.blob import Blob
from requests import ConnectTimeout, ConnectionError
from apps import DEFAULT_PISA_API_SERVER, DEFAULT_PISA_API_PORT
def add_appointment(args):
use_help = "Use 'help add_appointment' for help of how to use the command."
if args:
arg_opt = args.pop(0)
try:
if arg_opt in ['-h', '--help']:
sys.exit(help_add_appointment())
if arg_opt in ['-f', '--file']:
if args:
fin = args.pop(0)
if os.path.isfile(fin):
appointment_data = json.load(open(fin))
else:
sys.exit("Can't find file " + fin)
else:
sys.exit("No file provided as appointment. " + use_help)
else:
appointment_data = json.loads(arg_opt)
except json.JSONDecodeError:
sys.exit("Non-JSON encoded data provided as appointment. " + use_help)
else:
sys.exit("No appointment data provided. " + use_help)
valid_locator = check_txid_format(appointment_data.get('tx_id'))
if valid_locator:
pisa_url = "http://{}:{}".format(pisa_api_server, pisa_api_port)
appointment = build_appointment(appointment_data.get('tx'), appointment_data.get('tx_id'),
appointment_data.get('start_time'), appointment_data.get('end_time'),
appointment_data.get('dispute_delta'), debug, logging)
if debug:
logging.info("[Client] sending appointment to PISA")
try:
r = requests.post(url=pisa_url, json=json.dumps(appointment), timeout=5)
if debug:
logging.info("[Client] {} (code: {})".format(r.text, r.status_code))
else:
print("{} (code: {}).".format(r.text, r.status_code))
except ConnectTimeout:
if debug:
logging.info("[Client] can't connect to pisa API. Connection timeout")
else:
sys.exit("Can't connect to pisa API. Connection timeout.")
except ConnectionError:
if debug:
logging.info("[Client] can't connect to pisa API. Server cannot be reached")
else:
sys.exit("Can't connect to pisa API. Server cannot be reached.")
else:
raise sys.exit("The provided locator is not valid.")
def build_appointment(tx, tx_id, start_block, end_block, dispute_delta, debug, logging):
locator = sha256(unhexlify(tx_id)).hexdigest()
cipher = "AES-GCM-128"
hash_function = "SHA256"
# FIXME: The blob data should contain more things that just the transaction. Leaving like this for now.
blob = Blob(tx, cipher, hash_function)
# FIXME: tx_id should not be necessary (can be derived from tx SegWit-like). Passing it for now
encrypted_blob = blob.encrypt(tx_id, debug, logging)
appointment = {"locator": locator, "start_time": start_block, "end_time": end_block,
"dispute_delta": dispute_delta, "encrypted_blob": encrypted_blob, "cipher": cipher, "hash_function":
hash_function}
return appointment
def check_txid_format(txid):
if len(txid) != 64:
raise Exception("txid does not matches the expected size (32-byte / 64 hex chars).")
return re.search(r'^[0-9A-Fa-f]+$', txid) is not None
def show_usage(show_and_quit=False):
print("USAGE: "
"\n\tpython pisa-cli.py [global options] command [command options] [arguments]"
"\n\nCOMMANDS:"
"\n\tadd_appointment \tRegisters a json formatted appointment to the PISA server."
"\n\tget_appointment \tGets json formatted data about an appointment from the PISA server."
"\n\thelp \t\t\tShows a list of commands or help for a specific command."
"\n\nGLOBAL OPTIONS:"
"\n\t-s, --server \tAPI server where to send the requests. Defaults to localhost (modifiable in __init__.py)"
"\n\t-p, --port \tAPI port where to send the requests. Defaults to 9814 (modifiable in __init__.py)"
"\n\t-d, --debug \tshows debug information and stores it in pisa.log"
"\n\t-h --help \tshows this message.")
if show_and_quit:
exit(-1)
if __name__ == '__main__':
debug = False
command = None
appointment_data = None
pisa_api_server = DEFAULT_PISA_API_SERVER
pisa_api_port = DEFAULT_PISA_API_PORT
commands = ['add_appointment', 'get_appointment', 'help']
try:
opts, args = getopt(argv[1:], 's:p:dh', ['server', 'port', 'debug', 'help'])
for opt, arg in opts:
if opt in ['-s', 'server']:
if arg:
pisa_api_server = arg
if opt in ['-p', '--port']:
if arg:
pisa_api_port = int(arg)
if opt in ['-d', '--debug']:
debug = True
if opt in ['-h', '--help']:
show_usage()
if args:
command = args.pop(0)
if command in commands:
if command == 'add_appointment':
appointment_data = add_appointment(args)
elif command == 'get_appointment':
pass
elif command == 'help':
if args:
command = args.pop(0)
if command == 'add_appointment':
pass
elif command == "get_appointment":
pass
else:
sys.exit("Unknown command. Use help to check the list of available commands.")
else:
show_usage()
else:
sys.exit("Unknown command. Use help to check the list of available commands.")
except GetoptError as e:
print(e)
except json.JSONDecodeError as e:
print('Non-JSON encoded appointment passed as parameter.')
# Configure logging
logging.basicConfig(format='%(asctime)s %(message)s', level=logging.INFO, handlers=[
logging.FileHandler(CLIENT_LOG_FILE),
logging.StreamHandler()
])

View File

@@ -1,145 +0,0 @@
import requests
import re
import os
import json
from getopt import getopt, GetoptError
from sys import argv
import logging
from conf import CLIENT_LOG_FILE
from hashlib import sha256
from binascii import unhexlify
from apps.blob import Blob
from requests import ConnectTimeout
from apps import DEFAULT_PISA_API_SERVER, DEFAULT_PISA_API_PORT
def build_appointment(tx, tx_id, start_block, end_block, dispute_delta, debug, logging):
locator = sha256(unhexlify(tx_id)).hexdigest()
cipher = "AES-GCM-128"
hash_function = "SHA256"
# FIXME: The blob data should contain more things that just the transaction. Leaving like this for now.
blob = Blob(tx, cipher, hash_function)
# FIXME: tx_id should not be necessary (can be derived from tx SegWit-like). Passing it for now
encrypted_blob = blob.encrypt(tx_id, debug, logging)
appointment = {"locator": locator, "start_time": start_block, "end_time": end_block,
"dispute_delta": dispute_delta, "encrypted_blob": encrypted_blob, "cipher": cipher, "hash_function":
hash_function}
return appointment
def check_txid_format(txid):
if len(txid) != 64:
raise Exception("txid does not matches the expected size (32-byte / 64 hex chars).")
return re.search(r'^[0-9A-Fa-f]+$', txid) is not None
def show_usage(show_and_quit=False):
print("usage: python pisa-cli.py arguments [additional_arguments]."
"\nArguments:"
"\n-a, --add_appointment appointment: \tregisters a json formatted appointment"
"\n-f, --file appointment_file: \tregisters an appointment from a an json formatted file"
"\n-s, --server: \tAPI server where to send the requests. Defaults to localhost (modifiable in __init__.py)"
"\n-p, --port: \tAPI port where to send the requests. Defaults to 9814 (modifiable in __init__.py)"
"\n-d, --debug: \tshows debug information and stores it in pisa.log"
"\n-h --help: \tshows this message.")
if show_and_quit:
exit(-1)
if __name__ == '__main__':
debug = False
help_command = False
command = None
appointment_data = None
pisa_api_server = DEFAULT_PISA_API_SERVER
pisa_api_port = DEFAULT_PISA_API_PORT
commands = ['add_appointment']
try:
opts, args = getopt(argv[1:], 'a:-f:s:p:dh', ['add_appointment, file, server, port, debug, help'])
for opt, arg in opts:
if opt in ['-a', '--add_appointment']:
if arg:
command = 'add_appointment'
appointment_data = json.loads(arg)
else:
print("No appointment provided.")
show_usage(show_and_quit=True)
elif opt in ['-f', '--file']:
if arg:
if not os.path.isfile(arg):
print("Can't find file " + arg)
show_usage(show_and_quit=True)
else:
command = 'add_appointment'
appointment_data = json.load(open(arg))
else:
raise Exception("Path to appointment_data.json missing.")
if opt in ['-s', 'server']:
if arg:
pisa_api_server = arg
if opt in ['-p', '--port']:
if arg:
pisa_api_port = int(arg)
if opt in ['-d', '--debug']:
debug = True
if opt in ['-h', '--help']:
help_command = True
except GetoptError as e:
print(e)
except json.JSONDecodeError as e:
print('Non-JSON encoded appointment passed as parameter.')
# Configure logging
logging.basicConfig(format='%(asctime)s %(message)s', level=logging.INFO, handlers=[
logging.FileHandler(CLIENT_LOG_FILE),
logging.StreamHandler()
])
if help_command:
show_usage()
elif command in commands:
if command == 'add_appointment' and appointment_data:
valid_locator = check_txid_format(appointment_data.get('tx_id'))
if valid_locator:
pisa_url = "http://{}:{}".format(pisa_api_server, pisa_api_port)
appointment = build_appointment(appointment_data.get('tx'), appointment_data.get('tx_id'),
appointment_data.get('start_time'), appointment_data.get('end_time'),
appointment_data.get('dispute_delta'), debug, logging)
if debug:
logging.info("[Client] sending appointment to PISA")
try:
r = requests.post(url=pisa_url, json=json.dumps(appointment), timeout=5)
if debug:
logging.info("[Client] {} (code: {})".format(r.text, r.status_code))
else:
print("[Client] {} (code: {})".format(r.text, r.status_code))
except ConnectTimeout:
if debug:
logging.info("[Client] can't connect to pisa API. Connection timeout")
else:
raise ValueError("The provided locator is not valid.")
else:
print("No valid appointment data provided.")
show_usage(show_and_quit=True)

View File

@@ -2,7 +2,7 @@ from pisa import *
from pisa.watcher import Watcher
from pisa.inspector import Inspector
from pisa.appointment import Appointment
from flask import Flask, request, Response, abort
from flask import Flask, request, Response, abort, jsonify
import json
app = Flask(__name__)
@@ -28,7 +28,7 @@ def add_appointment():
# FIXME: Response should be signed receipt (created and signed by the API)
if appointment_added:
response = "appointment accepted"
response = "appointment accepted. locator: {}".format(appointment.locator)
else:
response = "appointment rejected"
# FIXME: change the response code maybe?
@@ -60,7 +60,7 @@ def get_appointment():
if job_in_watcher:
for job in job_in_watcher:
job_data = job.to_json()
job_data['status'] = "being watched"
job_data['status'] = "being_watched"
response.append(job_data)
if watcher.responder:
@@ -69,14 +69,14 @@ def get_appointment():
for job_id, job in responder_jobs.items():
if job.locator == locator:
job_data = job.to_json()
job_data['status'] = "dispute responded"
job_data['status'] = "dispute_responded"
job_data['confirmations'] = watcher.responder.confirmation_counter.get(job_id)
response.append(job_data)
if not response:
response.append({"locator": locator, "status": "not found"})
response = json.dumps(response)
response = jsonify(response)
return response
@@ -86,7 +86,7 @@ def get_all_appointments():
watcher_appointments = []
responder_jobs = []
if request.remote_addr in ['localhost', '127.0.0.1']:
if request.remote_addr in request.host or request.remote_addr == '127.0.0.1':
for app_id, appointment in watcher.appointments.items():
jobs_data = [job.to_json() for job in appointment]
@@ -98,7 +98,7 @@ def get_all_appointments():
job_data['confirmations'] = watcher.responder.confirmation_counter.get(job_id)
responder_jobs.append({job_id: job_data})
response = json.dumps({"watcher_appointments": watcher_appointments, "responder_jobs": responder_jobs})
response = jsonify({"watcher_appointments": watcher_appointments, "responder_jobs": responder_jobs})
else:
abort(404)