[tor-commits] [oonib/master] Clean up report api and handlers
art at torproject.org
art at torproject.org
Wed Sep 11 09:13:51 UTC 2013
commit 784e859ba1851e9221307b44b0543a7e0bc19426
Author: aagbsn <aagbsn at extc.org>
Date: Sun Jul 7 20:17:07 2013 +0200
Clean up report api and handlers
---
oonib/__init__.py | 67 ---------
oonib/report/__init__.py | 5 -
oonib/report/api.py | 52 +------
oonib/report/file_collector.py | 303 ----------------------------------------
oonib/report/handlers.py | 292 ++++++++++++++++++++++++++++++++++++++
5 files changed, 296 insertions(+), 423 deletions(-)
diff --git a/oonib/__init__.py b/oonib/__init__.py
deleted file mode 100644
index c374f53..0000000
--- a/oonib/__init__.py
+++ /dev/null
@@ -1,67 +0,0 @@
-# -*- encoding: utf-8 -*-
-#
-# :authors: Arturo Filastò, Isis Lovecruft
-# :licence: see LICENSE for details
-"""
-In here we shall keep track of all variables and objects that should be
-instantiated only once and be common to pieces of GLBackend code.
-"""
-
-__version__ = '0.9.1'
-
-__all__ = ['Storage', 'randomStr']
-
-import string
-import random
-
-class Storage(dict):
- """
- A Storage object is like a dictionary except `obj.foo` can be used
- in addition to `obj['foo']`.
-
- >>> o = Storage(a=1)
- >>> o.a
- 1
- >>> o['a']
- 1
- >>> o.a = 2
- >>> o['a']
- 2
- >>> del o.a
- >>> o.a
- None
- """
- def __getattr__(self, key):
- try:
- return self[key]
- except KeyError, k:
- return None
-
- def __setattr__(self, key, value):
- self[key] = value
-
- def __delattr__(self, key):
- try:
- del self[key]
- except KeyError, k:
- raise AttributeError, k
-
- def __repr__(self):
- return '<Storage ' + dict.__repr__(self) + '>'
-
- def __getstate__(self):
- return dict(self)
-
- def __setstate__(self, value):
- for (k, v) in value.items():
- self[k] = v
-
-def randomStr(length, num=True):
- """
- Returns a random a mixed lowercase, uppercase, alfanumerical (if num True)
- string long length
- """
- chars = string.ascii_lowercase + string.ascii_uppercase
- if num:
- chars += string.digits
- return ''.join(random.choice(chars) for x in range(length))
diff --git a/oonib/report/__init__.py b/oonib/report/__init__.py
deleted file mode 100644
index fcbf220..0000000
--- a/oonib/report/__init__.py
+++ /dev/null
@@ -1,5 +0,0 @@
-class MissingField(Exception):
- pass
-
-class InvalidRequestField(Exception):
- pass
diff --git a/oonib/report/api.py b/oonib/report/api.py
index 8835784..c707291 100644
--- a/oonib/report/api.py
+++ b/oonib/report/api.py
@@ -7,54 +7,10 @@ This is the async pcap reporting system. It requires the client to have created
a report already, but can work independently from test progress.
"""
-import random
-import string
-import json
-import re
-import os
+from oonib.report import handlers
-from twisted.internet import reactor, defer
-
-from cyclone import web
-
-from oonib import otime
-from oonib import randomStr
-
-from oonib import config
-from oonib.report import file_collector
-
-def parseUpdateReportRequest(request):
- #db_report_id_regexp = re.compile("[a-zA-Z0-9]+$")
-
- # this is the regexp for the reports that include the timestamp
- report_id_regexp = re.compile("[a-zA-Z0-9_-]+$")
-
- # XXX here we are actually parsing a json object that could be quite big.
- # If we want this to scale properly we only want to look at the test_id
- # field.
- # We are also keeping in memory multiple copies of the same object. A lot
- # of optimization can be done.
- parsed_request = json.loads(request)
- try:
- report_id = parsed_request['report_id']
- except KeyError:
- raise MissingField('report_id')
-
- if not re.match(report_id_regexp, report_id):
- raise InvalidRequestField('report_id')
-
- return parsed_request
-
-reportingBackendAPI = [
- (r"/report/([a-zA-Z0-9_\-]+)/close", file_collector.CloseReportHandlerFile),
- (r"/report", file_collector.NewReportHandlerFile),
+reportAPI = [
+ (r"/report/([a-zA-Z0-9_\-]+)/close", handlers.CloseReportHandlerFile),
+ (r"/report", handlers.NewReportHandlerFile),
(r"/pcap", file_collector.PCAPReportHandler),
- (r"/deck", file_collector.DeckListHandler),
- (r"/input", file_collector.InputListHandler),
- (r"/deck/([a-z0-9]{40})$", web.StaticFileHandler, {"path":
- config.main.deck_dir}),
- (r"/input/([a-z0-9]{40})$", web.StaticFileHandler, {"path":
- config.main.input_dir}),
]
-
-reportingBackend = web.Application(reportingBackendAPI, debug=True)
diff --git a/oonib/report/file_collector.py b/oonib/report/file_collector.py
deleted file mode 100644
index 57c4175..0000000
--- a/oonib/report/file_collector.py
+++ /dev/null
@@ -1,303 +0,0 @@
-import glob
-import json
-import os
-import random
-import re
-import string
-import time
-import yaml
-
-from cyclone import web
-from datetime import datetime
-from oonib import randomStr, otime, config, log
-from oonib.report import MissingField, InvalidRequestField
-from twisted.internet import fdesc, reactor
-
-def parseUpdateReportRequest(request):
- #db_report_id_regexp = re.compile("[a-zA-Z0-9]+$")
-
- # this is the regexp for the reports that include the timestamp
- report_id_regexp = re.compile("[a-zA-Z0-9_\-]+$")
-
- # XXX here we are actually parsing a json object that could be quite big.
- # If we want this to scale properly we only want to look at the test_id
- # field.
- # We are also keeping in memory multiple copies of the same object. A lot
- # of optimization can be done.
- parsed_request = json.loads(request)
- try:
- report_id = parsed_request['report_id']
- except KeyError:
- raise MissingField('report_id')
-
- if not re.match(report_id_regexp, report_id):
- raise InvalidRequestField('report_id')
-
- return parsed_request
-
-def parseNewReportRequest(request):
- """
- Here we parse a new report request.
- """
- version_string = re.compile("[0-9A-Za-z_\-\.]+$")
- name = re.compile("[a-zA-Z0-9_\- ]+$")
- probe_asn = re.compile("AS[0-9]+$")
-
- expected_request = {
- 'software_name': name,
- 'software_version': version_string,
- 'test_name': name,
- 'test_version': version_string,
- 'probe_asn': probe_asn
- }
-
- parsed_request = json.loads(request)
- if not parsed_request['probe_asn']:
- parsed_request['probe_asn'] = 'AS0'
-
- for k, regexp in expected_request.items():
- try:
- value_to_check = parsed_request[k]
- except KeyError:
- raise MissingField(k)
-
- print "Matching %s with %s | %s" % (regexp, value_to_check, k)
- if re.match(regexp, str(value_to_check)):
- continue
- else:
- raise InvalidRequestField(k)
-
- return parsed_request
-
-class InvalidReportHeader(Exception):
- pass
-
-class MissingReportHeaderKey(InvalidReportHeader):
- pass
-
-def validate_report_header(report_header):
- required_keys = ['probe_asn', 'probe_cc', 'probe_ip', 'software_name',
- 'software_version', 'test_name', 'test_version']
- for key in required_keys:
- if key not in report_header:
- raise MissingReportHeaderKey(key)
-
- if report_header['probe_asn'] is None:
- report_header['probe_asn'] = 'AS0'
-
- if not re.match('AS[0-9]+$', report_header['probe_asn']):
- raise InvalidReportHeader('probe_asn')
-
- # If no country is known, set it to be ZZ (user assigned value in ISO 3166)
- if report_header['probe_cc'] is None:
- report_header['probe_cc'] = 'ZZ'
-
- if not re.match('[a-zA-Z]{2}$', report_header['probe_cc']):
- raise InvalidReportHeader('probe_cc')
-
- if not re.match('[a-z_\-]+$', report_header['test_name']):
- raise InvalidReportHeader('test_name')
-
-
- if not re.match('([0-9]+\.)+[0-9]+$', report_header['test_version']):
- raise InvalidReportHeader('test_version')
-
- return report_header
-
-def get_report_path(report_id):
- return os.path.join(config.main.report_dir, report_id)
-
-def stale_check(report_id):
- if (time.time() - config.reports[report_id]) > config.main.stale_time:
- try:
- close_report(report_id)
- except ReportNotFound:
- pass
-
-class NewReportHandlerFile(web.RequestHandler):
- """
- Responsible for creating and updating reports by writing to flat file.
- """
-
- def post(self):
- """
- Creates a new report with the input
-
- * Request
-
- {'software_name': 'XXX',
- 'software_version': 'XXX',
- 'test_name': 'XXX',
- 'test_version': 'XXX',
- 'probe_asn': 'XXX'
- 'content': 'XXX'
- }
-
- Optional:
- 'test_helper': 'XXX'
- 'client_ip': 'XXX'
-
- (not implemented, nor in client, nor in backend)
- The idea behind these two fields is that it would be interesting to
- also collect how the request was observed from the collectors point
- of view.
-
- We use as a unique key the client_ip address and a time window. We
- then need to tell the test_helper that is selected the client_ip
- address and tell it to expect a connection from a probe in that time
- window.
-
- Once the test_helper sees a connection from that client_ip it will
- store for the testing session the data that it receives.
- When the probe completes the report (or the time window is over) the
- final report will include also the data collected from the
- collectors view point.
-
- * Response
-
- {'backend_version': 'XXX', 'report_id': 'XXX'}
-
- """
- # XXX here we should validate and sanitize the request
- try:
- report_data = parseNewReportRequest(self.request.body)
- except InvalidRequestField, e:
- raise web.HTTPError(400, "Invalid Request Field %s" % e)
- except MissingField, e:
- raise web.HTTPError(400, "Missing Request Field %s" % e)
-
- print "Parsed this data %s" % report_data
- software_name = report_data['software_name']
- software_version = report_data['software_version']
- test_name = report_data['test_name']
- test_version = report_data['test_version']
- probe_asn = report_data['probe_asn']
- content = yaml.safe_load(report_data['content'])
- content['backend_version'] = config.backend_version
-
- try:
- report_header = validate_report_header(content)
-
- except MissingReportHeaderKey, key:
- raise web.HTTPError(406, "Missing report header key %s" % key)
-
- except InvalidReportHeader, key:
- raise web.HTTPError(406, "Invalid report header %s" % key)
-
- report_header = yaml.dump(report_header)
- content = "---\n" + report_header + '...\n'
-
- if not probe_asn:
- probe_asn = "AS0"
-
- report_id = otime.timestamp() + '_' \
- + probe_asn + '_' \
- + randomStr(50)
-
- # The report filename contains the timestamp of the report plus a
- # random nonce
- report_filename = os.path.join(config.main.report_dir, report_id)
-
- response = {'backend_version': config.backend_version,
- 'report_id': report_id
- }
-
- config.reports[report_id] = time.time()
-
- reactor.callLater(config.main.stale_time, stale_check, report_id)
-
- self.writeToReport(report_filename, content)
-
- self.write(response)
-
- def writeToReport(self, report_filename, data):
- with open(report_filename, 'w+') as fd:
- fdesc.setNonBlocking(fd.fileno())
- fdesc.writeToFD(fd.fileno(), data)
-
- def put(self):
- """
- Update an already existing report.
-
- {
- 'report_id': 'XXX',
- 'content': 'XXX'
- }
- """
- parsed_request = parseUpdateReportRequest(self.request.body)
-
- report_id = parsed_request['report_id']
-
- log.debug("Got this request %s" % parsed_request)
- report_filename = os.path.join(config.main.report_dir,
- report_id)
-
- config.reports[report_id] = time.time()
- reactor.callLater(config.main.stale_time, stale_check, report_id)
-
- self.updateReport(report_filename, parsed_request['content'])
-
- def updateReport(self, report_filename, data):
- try:
- with open(report_filename, 'a+') as fd:
- fdesc.setNonBlocking(fd.fileno())
- fdesc.writeToFD(fd.fileno(), data)
- except IOError as e:
- web.HTTPError(404, "Report not found")
-
-class ReportNotFound(Exception):
- pass
-
-def close_report(report_id):
- report_filename = get_report_path(report_id)
- try:
- with open(report_filename) as fd:
- yaml_data = ''.join(fd.readline() for _ in range(12))
- report_details = yaml.safe_load(yaml_data)
- except IOError:
- raise ReportNotFound
-
- timestamp = otime.timestamp(datetime.fromtimestamp(report_details['start_time']))
- dst_filename = '{test_name}-{timestamp}-{probe_asn}-probe.yamloo'.format(
- timestamp=timestamp,
- **report_details)
-
- dst_path = os.path.join(config.main.archive_dir,
- report_details['probe_cc'])
-
- if not os.path.isdir(dst_path):
- os.mkdir(dst_path)
-
- dst_path = os.path.join(dst_path, dst_filename)
- os.rename(report_filename, dst_path)
-
-class CloseReportHandlerFile(web.RequestHandler):
- def get(self):
- pass
-
- def post(self, report_id):
- try:
- close_report(report_id)
- except ReportNotFound:
- web.HTTPError(404, "Report not found")
-
-class PCAPReportHandler(web.RequestHandler):
- def get(self):
- pass
-
- def post(self):
- pass
-
-class DeckListHandler(web.RequestHandler):
- def get(self):
- if not config.main.deck_dir: return
- path = os.path.abspath(config.main.deck_dir) + "/*"
- decknames = map(os.path.basename, glob.iglob(path))
- self.write(json.dumps(decknames))
-
-class InputListHandler(web.RequestHandler):
- def get(self):
- if not config.main.input_dir: return
- path = os.path.abspath(config.main.input_dir) + "/*"
- inputnames = map(os.path.basename, glob.iglob(path))
- self.write(json.dumps(decknames))
diff --git a/oonib/report/handlers.py b/oonib/report/handlers.py
new file mode 100644
index 0000000..c5e4a97
--- /dev/null
+++ b/oonib/report/handlers.py
@@ -0,0 +1,292 @@
+import json
+import os
+import re
+import string
+import time
+import yaml
+
+from cyclone import web
+from datetime import datetime
+from oonib import randomStr, otime, config, log
+from twisted.internet import fdesc, reactor
+
+class MissingField(Exception):
+ pass
+
+class InvalidRequestField(Exception):
+ pass
+
+def parseUpdateReportRequest(request):
+ #db_report_id_regexp = re.compile("[a-zA-Z0-9]+$")
+
+ # this is the regexp for the reports that include the timestamp
+ report_id_regexp = re.compile("[a-zA-Z0-9_\-]+$")
+
+ # XXX here we are actually parsing a json object that could be quite big.
+ # If we want this to scale properly we only want to look at the test_id
+ # field.
+ # We are also keeping in memory multiple copies of the same object. A lot
+ # of optimization can be done.
+ parsed_request = json.loads(request)
+ try:
+ report_id = parsed_request['report_id']
+ except KeyError:
+ raise MissingField('report_id')
+
+ if not re.match(report_id_regexp, report_id):
+ raise InvalidRequestField('report_id')
+
+ return parsed_request
+
+def parseNewReportRequest(request):
+ """
+ Here we parse a new report request.
+ """
+ version_string = re.compile("[0-9A-Za-z_\-\.]+$")
+ name = re.compile("[a-zA-Z0-9_\- ]+$")
+ probe_asn = re.compile("AS[0-9]+$")
+
+ expected_request = {
+ 'software_name': name,
+ 'software_version': version_string,
+ 'test_name': name,
+ 'test_version': version_string,
+ 'probe_asn': probe_asn
+ }
+
+ parsed_request = json.loads(request)
+ if not parsed_request['probe_asn']:
+ parsed_request['probe_asn'] = 'AS0'
+
+ for k, regexp in expected_request.items():
+ try:
+ value_to_check = parsed_request[k]
+ except KeyError:
+ raise MissingField(k)
+
+ print "Matching %s with %s | %s" % (regexp, value_to_check, k)
+ if re.match(regexp, str(value_to_check)):
+ continue
+ else:
+ raise InvalidRequestField(k)
+
+ return parsed_request
+
+class InvalidReportHeader(Exception):
+ pass
+
+class MissingReportHeaderKey(InvalidReportHeader):
+ pass
+
+def validate_report_header(report_header):
+ required_keys = ['probe_asn', 'probe_cc', 'probe_ip', 'software_name',
+ 'software_version', 'test_name', 'test_version']
+ for key in required_keys:
+ if key not in report_header:
+ raise MissingReportHeaderKey(key)
+
+ if report_header['probe_asn'] is None:
+ report_header['probe_asn'] = 'AS0'
+
+ if not re.match('AS[0-9]+$', report_header['probe_asn']):
+ raise InvalidReportHeader('probe_asn')
+
+ # If no country is known, set it to be ZZ (user assigned value in ISO 3166)
+ if report_header['probe_cc'] is None:
+ report_header['probe_cc'] = 'ZZ'
+
+ if not re.match('[a-zA-Z]{2}$', report_header['probe_cc']):
+ raise InvalidReportHeader('probe_cc')
+
+ if not re.match('[a-z_\-]+$', report_header['test_name']):
+ raise InvalidReportHeader('test_name')
+
+
+ if not re.match('([0-9]+\.)+[0-9]+$', report_header['test_version']):
+ raise InvalidReportHeader('test_version')
+
+ return report_header
+
+def get_report_path(report_id):
+ return os.path.join(config.main.report_dir, report_id)
+
+def stale_check(report_id):
+ if (time.time() - config.reports[report_id]) > config.main.stale_time:
+ try:
+ close_report(report_id)
+ except ReportNotFound:
+ pass
+
+class NewReportHandlerFile(web.RequestHandler):
+ """
+ Responsible for creating and updating reports by writing to flat file.
+ """
+
+ def post(self):
+ """
+ Creates a new report with the input
+
+ * Request
+
+ {'software_name': 'XXX',
+ 'software_version': 'XXX',
+ 'test_name': 'XXX',
+ 'test_version': 'XXX',
+ 'probe_asn': 'XXX'
+ 'content': 'XXX'
+ }
+
+ Optional:
+ 'test_helper': 'XXX'
+ 'client_ip': 'XXX'
+
+ (not implemented, nor in client, nor in backend)
+ The idea behind these two fields is that it would be interesting to
+ also collect how the request was observed from the collectors point
+ of view.
+
+ We use as a unique key the client_ip address and a time window. We
+ then need to tell the test_helper that is selected the client_ip
+ address and tell it to expect a connection from a probe in that time
+ window.
+
+ Once the test_helper sees a connection from that client_ip it will
+ store for the testing session the data that it receives.
+ When the probe completes the report (or the time window is over) the
+ final report will include also the data collected from the
+ collectors view point.
+
+ * Response
+
+ {'backend_version': 'XXX', 'report_id': 'XXX'}
+
+ """
+ # XXX here we should validate and sanitize the request
+ try:
+ report_data = parseNewReportRequest(self.request.body)
+ except InvalidRequestField, e:
+ raise web.HTTPError(400, "Invalid Request Field %s" % e)
+ except MissingField, e:
+ raise web.HTTPError(400, "Missing Request Field %s" % e)
+
+ print "Parsed this data %s" % report_data
+ software_name = report_data['software_name']
+ software_version = report_data['software_version']
+ test_name = report_data['test_name']
+ test_version = report_data['test_version']
+ probe_asn = report_data['probe_asn']
+ content = yaml.safe_load(report_data['content'])
+ content['backend_version'] = config.backend_version
+
+ try:
+ report_header = validate_report_header(content)
+
+ except MissingReportHeaderKey, key:
+ raise web.HTTPError(406, "Missing report header key %s" % key)
+
+ except InvalidReportHeader, key:
+ raise web.HTTPError(406, "Invalid report header %s" % key)
+
+ report_header = yaml.dump(report_header)
+ content = "---\n" + report_header + '...\n'
+
+ if not probe_asn:
+ probe_asn = "AS0"
+
+ report_id = otime.timestamp() + '_' \
+ + probe_asn + '_' \
+ + randomStr(50)
+
+ # The report filename contains the timestamp of the report plus a
+ # random nonce
+ report_filename = os.path.join(config.main.report_dir, report_id)
+
+ response = {'backend_version': config.backend_version,
+ 'report_id': report_id
+ }
+
+ config.reports[report_id] = time.time()
+
+ reactor.callLater(config.main.stale_time, stale_check, report_id)
+
+ self.writeToReport(report_filename, content)
+
+ self.write(response)
+
+ def writeToReport(self, report_filename, data):
+ with open(report_filename, 'w+') as fd:
+ fdesc.setNonBlocking(fd.fileno())
+ fdesc.writeToFD(fd.fileno(), data)
+
+ def put(self):
+ """
+ Update an already existing report.
+
+ {
+ 'report_id': 'XXX',
+ 'content': 'XXX'
+ }
+ """
+ parsed_request = parseUpdateReportRequest(self.request.body)
+
+ report_id = parsed_request['report_id']
+
+ log.debug("Got this request %s" % parsed_request)
+ report_filename = os.path.join(config.main.report_dir,
+ report_id)
+
+ config.reports[report_id] = time.time()
+ reactor.callLater(config.main.stale_time, stale_check, report_id)
+
+ self.updateReport(report_filename, parsed_request['content'])
+
+ def updateReport(self, report_filename, data):
+ try:
+ with open(report_filename, 'a+') as fd:
+ fdesc.setNonBlocking(fd.fileno())
+ fdesc.writeToFD(fd.fileno(), data)
+ except IOError as e:
+ web.HTTPError(404, "Report not found")
+
+class ReportNotFound(Exception):
+ pass
+
+def close_report(report_id):
+ report_filename = get_report_path(report_id)
+ try:
+ with open(report_filename) as fd:
+ yaml_data = ''.join(fd.readline() for _ in range(12))
+ report_details = yaml.safe_load(yaml_data)
+ except IOError:
+ raise ReportNotFound
+
+ timestamp = otime.timestamp(datetime.fromtimestamp(report_details['start_time']))
+ dst_filename = '{test_name}-{timestamp}-{probe_asn}-probe.yamloo'.format(
+ timestamp=timestamp,
+ **report_details)
+
+ dst_path = os.path.join(config.main.archive_dir,
+ report_details['probe_cc'])
+
+ if not os.path.isdir(dst_path):
+ os.mkdir(dst_path)
+
+ dst_path = os.path.join(dst_path, dst_filename)
+ os.rename(report_filename, dst_path)
+
+class CloseReportHandlerFile(web.RequestHandler):
+ def get(self):
+ pass
+
+ def post(self, report_id):
+ try:
+ close_report(report_id)
+ except ReportNotFound:
+ web.HTTPError(404, "Report not found")
+
+class PCAPReportHandler(web.RequestHandler):
+ def get(self):
+ pass
+
+ def post(self):
+ pass
More information about the tor-commits
mailing list