source: trunk/packages/invirt-web/code/validation.py @ 1715

Last change on this file since 1715 was 1709, checked in by broder, 16 years ago

Default to a NULL administrator, instead of the same as the owner

File size: 11.9 KB
Line 
1#!/usr/bin/python
2
3import cache_acls
4import getafsgroups
5import re
6import string
7import dns.resolver
8from invirt.database import Machine, NIC, Type, Disk, CDROM, Autoinstall
9from invirt.config import structs as config
10from invirt.common import InvalidInput
11
12MAX_MEMORY_TOTAL = 512
13MAX_MEMORY_SINGLE = 256
14MIN_MEMORY_SINGLE = 16
15MAX_DISK_TOTAL = 50
16MAX_DISK_SINGLE = 50
17MIN_DISK_SINGLE = 0.1
18MAX_VMS_TOTAL = 10
19MAX_VMS_ACTIVE = 4
20
21class Validate:
22    def __init__(self, username, state, machine_id=None, name=None, description=None, owner=None,
23                 admin=None, contact=None, memory=None, disksize=None,
24                 vmtype=None, cdrom=None, autoinstall=None, strict=False):
25        # XXX Successive quota checks aren't a good idea, since you
26        # can't necessarily change the locker and disk size at the
27        # same time.
28        created_new = (machine_id is None)
29
30        if strict:
31            if name is None:
32                raise InvalidInput('name', name, "You must provide a machine name.")
33            if description is None:
34                raise InvalidInput('description', description, "You must provide a description.")
35            if memory is None:
36                raise InvalidInput('memory', memory, "You must provide a memory size.")
37            if disksize is None:
38                raise InvalidInput('disk', disksize, "You must provide a disk size.")
39
40        if machine_id is not None:
41            self.machine = testMachineId(username, state, machine_id)
42        machine = getattr(self, 'machine', None)
43
44        owner = testOwner(username, owner, machine)
45        if owner is not None:
46            self.owner = owner
47        self.admin = testAdmin(username, admin, machine)
48        contact = testContact(username, contact, machine)
49        if contact is not None:
50            self.contact = contact
51        name = testName(username, name, machine)
52        if name is not None:
53            self.name = name
54        description = testDescription(username, description, machine)
55        if description is not None:
56            self.description = description
57        if memory is not None:
58            self.memory = validMemory(self.owner, state, memory, machine,
59                                      on=not created_new)
60        if disksize is not None:
61            self.disksize = validDisk(self.owner, state, disksize, machine)
62        if vmtype is not None:
63            self.vmtype = validVmType(vmtype)
64        if cdrom is not None:
65            if not CDROM.query().get(cdrom):
66                raise CodeError("Invalid cdrom type '%s'" % cdrom)
67            self.cdrom = cdrom
68        if autoinstall is not None:
69            self.autoinstall = Autoinstall.query().get(autoinstall)
70
71
72def getMachinesByOwner(owner, machine=None):
73    """Return the machines owned by the same as a machine.
74
75    If the machine is None, return the machines owned by the same
76    user.
77    """
78    if machine:
79        owner = machine.owner
80    return Machine.query().filter_by(owner=owner)
81
82def maxMemory(owner, g, machine=None, on=True):
83    """Return the maximum memory for a machine or a user.
84
85    If machine is None, return the memory available for a new
86    machine.  Else, return the maximum that machine can have.
87
88    on is whether the machine should be turned on.  If false, the max
89    memory for the machine to change to, if it is left off, is
90    returned.
91    """
92    if machine is not None and machine.memory > MAX_MEMORY_SINGLE:
93        # If they've been blessed, let them have it
94        return machine.memory
95    if not on:
96        return MAX_MEMORY_SINGLE
97    machines = getMachinesByOwner(owner, machine)
98    active_machines = [m for m in machines if m.name in g.xmlist_raw]
99    mem_usage = sum([x.memory for x in active_machines if x != machine])
100    return min(MAX_MEMORY_SINGLE, MAX_MEMORY_TOTAL-mem_usage)
101
102def maxDisk(owner, machine=None):
103    """Return the maximum disk that a machine can reach.
104
105    If machine is None, the maximum disk for a new machine. Otherwise,
106    return the maximum that a given machine can be changed to.
107    """
108    if machine is not None:
109        machine_id = machine.machine_id
110    else:
111        machine_id = None
112    disk_usage = Disk.query().filter(Disk.c.machine_id != machine_id).\
113                     join('machine').\
114                     filter_by(owner=owner).sum(Disk.c.size) or 0
115    return min(MAX_DISK_SINGLE, MAX_DISK_TOTAL-disk_usage/1024.)
116
117def cantAddVm(owner, g):
118    machines = getMachinesByOwner(owner)
119    active_machines = [m for m in machines if m.name in g.xmlist_raw]
120    if machines.count() >= MAX_VMS_TOTAL:
121        return 'You have too many VMs to create a new one.'
122    if len(active_machines) >= MAX_VMS_ACTIVE:
123        return ('You already have the maximum number of VMs turned on.  '
124                'To create more, turn one off.')
125    return False
126
127def haveAccess(user, state, machine):
128    """Return whether a user has administrative access to a machine"""
129    return (user in cache_acls.accessList(machine)
130            or (machine.adminable and state.isadmin))
131
132def owns(user, machine):
133    """Return whether a user owns a machine"""
134    return user in expandLocker(machine.owner)
135
136def validMachineName(name):
137    """Check that name is valid for a machine name"""
138    if not name:
139        return False
140    charset = string.lowercase + string.digits + '-'
141    if '-' in (name[0], name[-1]) or len(name) > 63:
142        return False
143    for x in name:
144        if x not in charset:
145            return False
146    return True
147
148def validMemory(owner, g, memory, machine=None, on=True):
149    """Parse and validate limits for memory for a given owner and machine.
150
151    on is whether the memory must be valid after the machine is
152    switched on.
153    """
154    try:
155        memory = int(memory)
156        if memory < MIN_MEMORY_SINGLE:
157            raise ValueError
158    except ValueError:
159        raise InvalidInput('memory', memory,
160                           "Minimum %s MiB" % MIN_MEMORY_SINGLE)
161    max_val = maxMemory(owner, g, machine, on)
162    if not g.isadmin and memory > max_val:
163        raise InvalidInput('memory', memory,
164                           'Maximum %s MiB for %s' % (max_val, owner))
165    return memory
166
167def validDisk(owner, g, disk, machine=None):
168    """Parse and validate limits for disk for a given owner and machine."""
169    try:
170        disk = float(disk)
171        if not g.isadmin and disk > maxDisk(owner, machine):
172            raise InvalidInput('disk', disk,
173                               "Maximum %s G" % maxDisk(owner, machine))
174        disk = int(disk * 1024)
175        if disk < MIN_DISK_SINGLE * 1024:
176            raise ValueError
177    except ValueError:
178        raise InvalidInput('disk', disk,
179                           "Minimum %s GiB" % MIN_DISK_SINGLE)
180    return disk
181
182def validVmType(vm_type):
183    if vm_type is None:
184        return None
185    t = Type.query().get(vm_type)
186    if t is None:
187        raise CodeError("Invalid vm type '%s'"  % vm_type)
188    return t
189
190def testMachineId(user, state, machine_id, exists=True):
191    """Parse, validate and check authorization for a given user and machine.
192
193    If exists is False, don't check that it exists.
194    """
195    if machine_id is None:
196        raise InvalidInput('machine_id', machine_id,
197                           "Must specify a machine ID.")
198    try:
199        machine_id = int(machine_id)
200    except ValueError:
201        raise InvalidInput('machine_id', machine_id, "Must be an integer.")
202    machine = Machine.query().get(machine_id)
203    if exists and machine is None:
204        raise InvalidInput('machine_id', machine_id, "Does not exist.")
205    if machine is not None and not haveAccess(user, state, machine):
206        raise InvalidInput('machine_id', machine_id,
207                           "You do not have access to this machine.")
208    return machine
209
210def testAdmin(user, admin, machine):
211    """Determine whether a user can set the admin of a machine to this value.
212
213    Return the value to set the admin field to (possibly 'system:' +
214    admin).  XXX is modifying this a good idea?
215    """
216    if admin is None:
217        return None
218    if machine is not None and admin == machine.administrator:
219        return admin
220    if admin == user:
221        return admin
222    if ':' not in admin:
223        if cache_acls.isUser(admin):
224            return admin
225        admin = 'system:' + admin
226    try:
227        if user in getafsgroups.getAfsGroupMembers(admin, config.authz[0].cell):
228            return admin
229    except getafsgroups.AfsProcessError, e:
230        errmsg = str(e)
231        if errmsg.startswith("pts: User or group doesn't exist"):
232            errmsg = 'The group "%s" does not exist.' % admin
233        raise InvalidInput('administrator', admin, errmsg)
234    #XXX Should we require that user is in the admin group?
235    return admin
236
237def testOwner(user, owner, machine=None):
238    """Determine whether a user can set the owner of a machine to this value.
239
240    If machine is None, this is the owner of a new machine.
241    """
242    if owner == user:
243        return owner
244    if machine is not None and owner in (machine.owner, None):
245        return machine.owner
246    if owner is None:
247        raise InvalidInput('owner', owner, "Owner must be specified")
248    try:
249        if user not in cache_acls.expandLocker(owner):
250            raise InvalidInput('owner', owner, 'You do not have access to the '
251                               + owner + ' locker')
252    except getafsgroups.AfsProcessError, e:
253        raise InvalidInput('owner', owner, str(e))
254    return owner
255
256def testContact(user, contact, machine=None):
257    if contact is None or (machine is not None and contact == machine.contact):
258        return None
259    if not re.match("^[A-Z0-9._%+-]+@[A-Z0-9.-]+\.[A-Z]{2,4}$", contact, re.I):
260        raise InvalidInput('contact', contact, "Not a valid email.")
261    return contact
262
263def testDisk(user, disksize, machine=None):
264    return disksize
265
266def testName(user, name, machine=None):
267    if name is None:
268        return None
269    name = name.lower()
270    if machine is not None and name == machine.name:
271        return None
272    try:
273        hostname = '%s.%s.' % (name, config.dns.domains[0])
274        resolver = dns.resolver.Resolver()
275        resolver.nameservers = ['127.0.0.1']
276        try:
277            resolver.query(hostname, 'A')
278        except dns.resolver.NoAnswer, e:
279            # If we can get the TXT record, then we can verify it's
280            # reserved. If this lookup fails, let it bubble up and be
281            # dealt with
282            answer = resolver.query(hostname, 'TXT')
283            txt = answer[0].strings[0]
284            if txt.startswith('reserved'):
285                raise InvalidInput('name', name, 'The name you have requested has been %s. For more information, contact us at %s' % (txt, config.dns.contact))
286
287        # If the hostname didn't exist, it would have thrown an
288        # exception by now - error out
289        raise InvalidInput('name', name, 'Name is already taken.')
290    except dns.resolver.NXDOMAIN, e:
291        if not validMachineName(name):
292            raise InvalidInput('name', name, 'You must provide a machine name.  Max 63 chars, alnum plus \'-\', does not begin or end with \'-\'.')
293        return name
294    except InvalidInput:
295        raise
296    except:
297        # Any other error is a validation failure
298        raise InvalidInput('name', name, 'We were unable to verify that this name is available. If you believe this is in error, please contact us at %s' % config.dns.contact)
299
300def testDescription(user, description, machine=None):
301    if description is None or description.strip() == '':
302        return None
303    return description.strip()
304
305def testHostname(user, hostname, machine):
306    for nic in machine.nics:
307        if hostname == nic.hostname:
308            return hostname
309    # check if doesn't already exist
310    if NIC.select_by(hostname=hostname):
311        raise InvalidInput('hostname', hostname,
312                           "Already exists")
313    if not re.match("^[A-Z0-9-]{1,22}$", hostname, re.I):
314        raise InvalidInput('hostname', hostname, "Not a valid hostname; "
315                           "must only use number, letters, and dashes.")
316    return hostname
Note: See TracBrowser for help on using the repository browser.