PLC/Methods/BlacklistKey.py

   1 from PLC.Faults import *
   2 from PLC.Method import Method
   3 from PLC.Parameter import Parameter, Mixed
   4 from PLC.Keys import Key, Keys
   5 from PLC.Auth import Auth
   6
   7 class BlacklistKey(Method):
   8     """
   9     Blacklists a key, disassociating it and all others identical to it
  10     from all accounts and preventing it from ever being added again.
  11
  12     WARNING: Identical keys associated with other accounts with also
  13     be blacklisted.
  14
  15     Returns 1 if successful, faults otherwise.
  16     """
  17
  18     roles = ['admin']
  19
  20     accepts = [
  21         Auth(),
  22         Key.fields['key_id'],
  23         ]
  24
  25     returns = Parameter(int, '1 if successful')
  26
  27     def call(self, auth, key_id):
  28         # Get associated key details
  29         keys = Keys(self.api, [key_id])
  30         if not keys:
  31             raise PLCInvalidArgument, "No such key"
  32         key = keys[0]
  33
  34         # N.B.: Can blacklist any key, even foreign ones
  35
  36         key.blacklist()
  37
  38         # Logging variables
  39         self.event_objects = {'Key': [key['key_id']]}
  40         self.message = 'Key %d blacklisted' % key['key_id']
  41
  42         return 1