X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;ds=sidebyside;f=PLC%2FAuth.py;h=f71b63480a015e460284c7529906b8c986df7853;hb=2e7b23eea75847d91f079372191b9fcc822d7d8e;hp=7d9be9776d0b1b82a86038e3c2a2f88056a4bafb;hpb=7d2b14323454c3dba9c907d75a7988ad5a0ac8dc;p=plcapi.git diff --git a/PLC/Auth.py b/PLC/Auth.py index 7d9be97..f71b634 100644 --- a/PLC/Auth.py +++ b/PLC/Auth.py @@ -4,42 +4,262 @@ # Mark Huang # Copyright (C) 2006 The Trustees of Princeton University # -# $Id: Auth.py,v 1.2 2006/09/08 19:44:12 mlhuang Exp $ +# $Id: Auth.py,v 1.13 2007/01/30 23:09:55 mlhuang Exp $ # import crypt +import sha +import hmac +import time from PLC.Faults import * from PLC.Parameter import Parameter, Mixed from PLC.Persons import Persons +from PLC.Nodes import Node, Nodes +from PLC.Sessions import Session, Sessions +from PLC.Peers import Peer, Peers +from PLC.Boot import notify_owners -class Auth(Parameter, dict): +class Auth(Parameter): """ - Base class for all API authentication methods. + Base class for all API authentication methods, as well as a class + that can be used to represent all supported API authentication + methods. """ - def __init__(self, auth): - Parameter.__init__(self, auth, "API authentication structure", False) - dict.__init__(auth) + def __init__(self, auth = None): + if auth is None: + auth = {'AuthMethod': Parameter(str, "Authentication method to use", optional = False)} + Parameter.__init__(self, auth, "API authentication structure") -class NodeAuth(Auth): + def check(self, method, auth, *args): + # Method.type_check() should have checked that all of the + # mandatory fields were present. + assert 'AuthMethod' in auth + + if auth['AuthMethod'] == "session": + expected = SessionAuth() + elif auth['AuthMethod'] == "password" or \ + auth['AuthMethod'] == "capability": + expected = PasswordAuth() + elif auth['AuthMethod'] == "gpg": + expected = GPGAuth() + elif auth['AuthMethod'] == "hmac": + expected = BootAuth() + elif auth['AuthMethod'] == "anonymous": + expected = AnonymousAuth() + else: + raise PLCInvalidArgument("must be 'session', 'password', 'gpg', 'hmac', or 'anonymous'", "AuthMethod") + + # Re-check using the specified authentication method + method.type_check("auth", auth, expected, (auth,) + args) + +class GPGAuth(Auth): + """ + Proposed PlanetLab federation authentication structure. + """ + + def __init__(self): + Auth.__init__(self, { + 'AuthMethod': Parameter(str, "Authentication method to use, always 'gpg'", optional = False), + 'name': Parameter(str, "Peer or user name", optional = False), + 'signature': Parameter(str, "Message signature", optional = False) + }) + + def check(self, method, auth, *args): + try: + peers = Peers(method.api, [auth['name']]) + if peers: + if 'peer' not in method.roles: + raise PLCAuthenticationFailure, "Not allowed to call method" + + method.caller = peer = peers[0] + keys = [peer['key']] + else: + persons = Persons(method.api, {'email': auth['name'], 'enabled': True, 'peer_id': None}) + if not persons: + raise PLCAuthenticationFailure, "No such user '%s'" % auth['name'] + + if not set(person['roles']).intersection(method.roles): + raise PLCAuthenticationFailure, "Not allowed to call method" + + method.caller = person = persons[0] + keys = Keys(method.api, {'key_id': person['key_ids'], 'key_type': "gpg", 'peer_id': None}) + + if not keys: + raise PLCAuthenticationFailure, "No GPG key on record for peer or user '%s'" + + for key in keys: + try: + from PLC.GPG import gpg_verify + gpg_verify(method.name, args, auth['signature'], key) + return + except PLCAuthenticationFailure, fault: + pass + + raise fault + + except PLCAuthenticationFailure, fault: + # XXX Send e-mail + raise fault + +class SessionAuth(Auth): + """ + Secondary authentication method. After authenticating with a + primary authentication method, call GetSession() to generate a + session key that may be used for subsequent calls. + """ + + def __init__(self): + Auth.__init__(self, { + 'AuthMethod': Parameter(str, "Authentication method to use, always 'session'", optional = False), + 'session': Parameter(str, "Session key", optional = False) + }) + + def check(self, method, auth, *args): + # Method.type_check() should have checked that all of the + # mandatory fields were present. + assert auth.has_key('session') + + # Get session record + sessions = Sessions(method.api, [auth['session']], expires = None) + if not sessions: + raise PLCAuthenticationFailure, "No such session" + session = sessions[0] + + try: + if session['node_id'] is not None: + nodes = Nodes(method.api, {'node_id': session['node_id'], 'peer_id': None}) + if not nodes: + raise PLCAuthenticationFailure, "No such node" + node = nodes[0] + + if 'node' not in method.roles: + raise PLCAuthenticationFailure, "Not allowed to call method" + + method.caller = node + + elif session['person_id'] is not None and session['expires'] > time.time(): + persons = Persons(method.api, {'person_id': session['person_id'], 'enabled': True, 'peer_id': None}) + if not persons: + raise PLCAuthenticationFailure, "No such account" + person = persons[0] + + if not set(person['roles']).intersection(method.roles): + raise PLCAuthenticationFailure, "Not allowed to call method" + + method.caller = persons[0] + + else: + raise PLCAuthenticationFailure, "Invalid session" + + except PLCAuthenticationFailure, fault: + session.delete() + raise fault + +class BootAuth(Auth): """ PlanetLab version 3.x node authentication structure. Used by the Boot Manager to make authenticated calls to the API based on a unique node key or boot nonce value. + + The original parameter serialization code did not define the byte + encoding of strings, or the string encoding of all other types. We + define the byte encoding to be UTF-8, and the string encoding of + all other types to be however Python version 2.3 unicode() encodes + them. """ def __init__(self): Auth.__init__(self, { - 'AuthMethod': Parameter(str, "Authentication method to use, always 'hmac'", False), - 'node_id': Parameter(str, "Node identifier", False), - 'node_ip': Parameter(str, "Node primary IP address", False), - 'value': Parameter(str, "HMAC of node key and method call", False) + 'AuthMethod': Parameter(str, "Authentication method to use, always 'hmac'", optional = False), + 'node_id': Parameter(int, "Node identifier", optional = False), + 'value': Parameter(str, "HMAC of node key and method call", optional = False) }) + def canonicalize(self, args): + values = [] + + for arg in args: + if isinstance(arg, list) or isinstance(arg, tuple): + # The old implementation did not recursively handle + # lists of lists. But neither did the old API itself. + values += self.canonicalize(arg) + elif isinstance(arg, dict): + # Yes, the comments in the old implementation are + # misleading. Keys of dicts are not included in the + # hash. + values += self.canonicalize(arg.values()) + else: + # We use unicode() instead of str(). + values.append(unicode(arg)) + + return values + def check(self, method, auth, *args): - # XXX Do HMAC checking - return True + # Method.type_check() should have checked that all of the + # mandatory fields were present. + assert auth.has_key('node_id') + + if 'node' not in method.roles: + raise PLCAuthenticationFailure, "Not allowed to call method" + + try: + nodes = Nodes(method.api, {'node_id': auth['node_id'], 'peer_id': None}) + if not nodes: + raise PLCAuthenticationFailure, "No such node" + node = nodes[0] + + if node['key']: + key = node['key'] + elif node['boot_nonce']: + # Allow very old nodes that do not have a node key in + # their configuration files to use their "boot nonce" + # instead. The boot nonce is a random value generated + # by the node itself and POSTed by the Boot CD when it + # requests the Boot Manager. This is obviously not + # very secure, so we only allow it to be used if the + # requestor IP is the same as the IP address we have + # on record for the node. + key = node['boot_nonce'] + + nodenetwork = None + if node['nodenetwork_ids']: + nodenetworks = NodeNetworks(method.api, node['nodenetwork_ids']) + for nodenetwork in nodenetworks: + if nodenetwork['is_primary']: + break + + if not nodenetwork or not nodenetwork['is_primary']: + raise PLCAuthenticationFailure, "No primary network interface on record" + + if method.source is None: + raise PLCAuthenticationFailure, "Cannot determine IP address of requestor" + + if nodenetwork['ip'] != method.source[0]: + raise PLCAuthenticationFailure, "Requestor IP %s does not match node IP %s" % \ + (method.source[0], nodenetwork['ip']) + else: + raise PLCAuthenticationFailure, "No node key or boot nonce" + + # Yes, this is the "canonicalization" method used. + args = self.canonicalize(args) + args.sort() + msg = "[" + "".join(args) + "]" + + # We encode in UTF-8 before calculating the HMAC, which is + # an 8-bit algorithm. + digest = hmac.new(key, msg.encode('utf-8'), sha).hexdigest() + + if digest != auth['value']: + raise PLCAuthenticationFailure, "Call could not be authenticated" + + method.caller = node + + except PLCAuthenticationFailure, fault: + if nodes: + notify_owners(method, node, 'authfail', include_pis = True, include_techs = True, fault = fault) + raise fault class AnonymousAuth(Auth): """ @@ -52,8 +272,10 @@ class AnonymousAuth(Auth): }) def check(self, method, auth, *args): - # Sure, dude, whatever - return True + if 'anonymous' not in method.roles: + raise PLCAuthenticationFailure, "Not allowed to call method anonymously" + + method.caller = None class PasswordAuth(Auth): """ @@ -62,9 +284,9 @@ class PasswordAuth(Auth): def __init__(self): Auth.__init__(self, { - 'AuthMethod': Parameter(str, "Authentication method to use, typically 'password'", False), - 'Username': Parameter(str, "PlanetLab username, typically an e-mail address", False), - 'AuthString': Parameter(str, "Authentication string, typically a password", False), + 'AuthMethod': Parameter(str, "Authentication method to use, always 'password' or 'capability'", optional = False), + 'Username': Parameter(str, "PlanetLab username, typically an e-mail address", optional = False), + 'AuthString': Parameter(str, "Authentication string, typically a password", optional = False), }) def check(self, method, auth, *args): @@ -73,11 +295,11 @@ class PasswordAuth(Auth): assert auth.has_key('Username') # Get record (must be enabled) - persons = Persons(method.api, [auth['Username']], enabled = True) + persons = Persons(method.api, {'email': auth['Username'], 'enabled': True, 'peer_id': None}) if len(persons) != 1: raise PLCAuthenticationFailure, "No such account" - person = persons.values()[0] + person = persons[0] if auth['Username'] == method.api.config.PLC_API_MAINTENANCE_USER: # "Capability" authentication, whatever the hell that was