aspects/ratelimitaspects.py

   1 #!/usr/bin/python
   2 #-*- coding: utf-8 -*-
   3 #
   4 # S.Çağlar Onur <caglar@cs.princeton.edu>
   5
   6 from PLC.Config import Config
   7 from PLC.Faults import PLCPermissionDenied
   8
   9 from datetime import datetime, timedelta
  10
  11 from pyaspects.meta import MetaAspect
  12
  13 import memcache
  14
  15 class BaseRateLimit(object):
  16
  17     def __init__(self):
  18         self.config = Config("/etc/planetlab/plc_config")
  19
  20         # FIXME: change with Config values
  21         self.prefix = "ratelimit"
  22         self.minutes = 5 # The time period
  23         self.requests = 50 # Number of allowed requests in that time period
  24         self.expire_after = (self.minutes + 1) * 60
  25
  26         self.whitelist = []
  27
  28     def log(self, line):
  29         log = open("/var/log/plc_ratelimit.log", "a")
  30         date = datetime.now().strftime("%d/%m/%y %H:%M")
  31         log.write("%s - %s\n" % (date, line))
  32         log.flush()
  33
  34     def before(self, wobj, data, *args, **kwargs):
  35         # ratelimit_128.112.139.115_201011091532 = 1
  36         # ratelimit_128.112.139.115_201011091533 = 14
  37         # ratelimit_128.112.139.115_201011091534 = 11
  38         # Now, on every request we work out the keys for the past five minutes and use get_multi to retrieve them.
  39         # If the sum of those counters exceeds the maximum allowed for that time period, we block the request.
  40
  41         api_method_name = wobj.name
  42         api_method_source = wobj.source
  43
  44         # FIXME: Support  SessionAuth, GPGAuth, BootAuth and AnonymousAuth
  45         try:
  46             api_method_caller = args[0]["Username"]
  47         except KeyError:
  48             api_method_caller = "_"
  49
  50         if api_method_source == None or api_method_source[0] == self.config.PLC_API_IP or api_method_source[0] in self.whitelist:
  51             return
  52
  53         if api_method_caller == None:
  54             self.log("%s called from %s with Username = None" % (api_method_name, api_method_source[0]))
  55             return
  56
  57         mc = memcache.Client(["%s:11211" % self.config.PLC_API_HOST])
  58         now = datetime.now()
  59         current_key = "%s_%s_%s_%s" % (self.prefix, api_method_caller, api_method_source[0], now.strftime("%Y%m%d%H%M"))
  60
  61         keys_to_check = ["%s_%s_%s_%s" % (self.prefix, api_method_caller, api_method_source[0], (now - timedelta(minutes = minute)).strftime("%Y%m%d%H%M")) for minute in range(self.minutes + 1)]
  62
  63         try:
  64             value = mc.incr(current_key)
  65         except ValueError:
  66             value = None
  67
  68         if value == None:
  69             mc.set(current_key, 1, time=self.expire_after)
  70
  71         result = mc.get_multi(keys_to_check)
  72         total_requests = 0
  73         for i in result:
  74             total_requests += result[i]
  75
  76         if total_requests > self.requests:
  77             self.log("%s - %s" % (api_method_source[0], api_method_caller))
  78             raise PLCPermissionDenied, "Maximum allowed number of API calls exceeded"
  79
  80     def after(self, wobj, data, *args, **kwargs):
  81         return
  82
  83 class RateLimitAspect_class(BaseRateLimit):
  84     __metaclass__ = MetaAspect
  85     name = "ratelimitaspect_class"
  86
  87     def __init__(self):
  88         BaseRateLimit.__init__(self)
  89
  90     def before(self, wobj, data, *args, **kwargs):
  91         BaseRateLimit.before(self, wobj, data, *args, **kwargs)
  92
  93     def after(self, wobj, data, *args, **kwargs):
  94         BaseRateLimit.after(self, wobj, data, *args, **kwargs)
  95
  96 RateLimitAspect = RateLimitAspect_class