models.py 19.1 KB
Newer Older
Lukas Burgey's avatar
Lukas Burgey committed
1
from django.conf import settings
Lukas Burgey's avatar
Lukas Burgey committed
2
3
from django.contrib.auth.models import AbstractUser, Group
from django.db import models
4
from django.db.models.signals import post_save, pre_delete
Lukas Burgey's avatar
Lukas Burgey committed
5
from django.dispatch import receiver
Lukas Burgey's avatar
Lukas Burgey committed
6
from requests.auth import HTTPBasicAuth
Lukas Burgey's avatar
Lukas Burgey committed
7
from rest_framework.authtoken.models import Token
Lukas Burgey's avatar
Lukas Burgey committed
8
import json
Lukas Burgey's avatar
Lukas Burgey committed
9
10
import pika
import requests
Lukas Burgey's avatar
Lukas Burgey committed
11
from .logging import logger
12

Lukas Burgey's avatar
Lukas Burgey committed
13

Lukas Burgey's avatar
Lukas Burgey committed
14
15
16
# clients are registerred at rabbitmq, when they are assigned to a site
# (because we only then know what services they provide)
class RabbitMQInstance(models.Model):
17

Lukas Burgey's avatar
Lukas Burgey committed
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
    host = models.CharField(
            max_length=150,
            default='localhost',
            )
    exchange = models.CharField(
            max_length=150,
            default='deployments',
            )
    port = models.IntegerField(
            default=15672
            )
    path = models.CharField(
            max_length=150,
            default='api',
            )
    username = models.CharField(
            max_length=150,
            default='guest',
            )
    password = models.CharField(
            max_length=150,
            default='guest',
            )
    enabled = models.BooleanField(
            default=False,
            )

    def __str__(self):
        return self.host

Lukas Burgey's avatar
Lukas Burgey committed
48
49
    def msg(self, msg):
        return '[RabbitMQ:{}] {}'.format(self.host, msg)
Lukas Burgey's avatar
Lukas Burgey committed
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69

    @property
    def api(self):
        return 'http://{}:{}/{}'.format(
                self.host,
                self.port,
                self.path,
                )

    @property
    def auth(self):
        return HTTPBasicAuth(
                self.username,
                self.password
                )

    @property
    def vhost(self):
        return '%2f'

70
71
72
73
74
75
76
77
78
79
80
81
82
    # singletons
    rabbitmq_connection = None
    rabbitmq_channel = None

    @property
    def connection(self):
        if self.rabbitmq_connection is None:
            rabbitmqconnection_properties = pika.ConnectionParameters(
                    host=self.host,
                    ssl=True,
                    )
            self.rabbitmq_connection = pika.BlockingConnection(
                    rabbitmqconnection_properties)
Lukas Burgey's avatar
Lukas Burgey committed
83
            logger.debug(self.msg('opened connection'))
84
85
86
87
88
89
90
91
92
93
94
95

        return self.rabbitmq_connection

    @property
    def channel(self):
        if self.rabbitmq_channel is None:
            self.rabbitmq_channel = self.connection.channel()
            self.rabbitmq_channel.exchange_declare(
                    exchange=self.exchange,
                    durable=True,
                    exchange_type='topic')
            self.rabbitmq_channel.confirm_delivery()
Lukas Burgey's avatar
Lukas Burgey committed
96
97
            logger.debug(self.msg('opened channel'))

98
99
        return self.rabbitmq_channel

Lukas Burgey's avatar
Lukas Burgey committed
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
    def get_uri(self, path):
        return '{}/{}'.format(self.api, path)

    def rest_get(self, api_path):
        r = requests.get(
                self.get_uri(api_path),
                auth=self.auth)
        r.raise_for_status()
        return r.json()

    # send a rest call with path and data to the rest interface of
    # the rabbitmq instance
    def rest_put(self, api_path, data):
        r = requests.put(
                self.get_uri(api_path),
                json=data,
                auth=self.auth)
        r.raise_for_status()
        return r

    def rest_del(self, api_path):
        r = requests.delete(
                self.get_uri(api_path),
                auth=self.auth)
        r.raise_for_status()
        return r

    def set_topic_permissions(self, site):
        username = site.client.username
        path = 'topic-permissions/{}/{}/'.format(
                self.vhost,
                username,
                )

        # set permissions for the correct topics
        # we construct a regex to match the services of the site
        services = ''
        omitBar = True
        for service in site.services.all():
            prefix = '|'
            if omitBar:
                prefix = ''
                omitBar = False

            services = services + prefix + service.name

        set_topic_permission_data = {
                'exchange': self.exchange,
                'write': '^$',
                'read': '^service\.({})$'.format(services),
                }

        return self.rest_put(path, set_topic_permission_data)

    # set permissions for the user
    def set_permissions(self, site):
        username = site.client.username
        path = 'permissions/{}/{}/'.format(
                self.vhost,
                username,
                )
        permission = '^(amq\.gen.*|{})'.format(self.exchange)
        set_permission_data = {
                'configure': permission,
                'write': permission,
                'read': permission,
                }

        return self.rest_put(path, set_permission_data)

    # create user at the rabbitmq instance
    def create_user(self, site):
        username = site.client.username
        path = 'users/{}/'.format(username)

        user_creation_data = {
                'password': str(site.client.auth_token.key),
                'tags': '',
                }

        return self.rest_put(path, user_creation_data)

    # delete user at the rabbitmq instance
    def delete_user(self, site):
        username = site.client.username
        path = 'users/{}/'.format(username)

        return self.rest_del(path)

    # PUBLIC API

    def register_site(self, site):
        self.create_user(site)
        self.set_permissions(site)
        self.set_topic_permissions(site)
195
        logger.info(self.msg('registered {}'.format(site.client)))
Lukas Burgey's avatar
Lukas Burgey committed
196
197
198

    def update_site(self, site):
        self.set_topic_permissions(site)
199
        logger.info(self.msg('updated permissions for {}'.format(site.client)))
Lukas Burgey's avatar
Lukas Burgey committed
200
201

    def deregister_site(self, site):
202
        logger.info(self.msg('deregistered {}'.format(site.client)))
Lukas Burgey's avatar
Lukas Burgey committed
203
204
205
206
207
208
209
210
211

    def is_client_connected(self, site):
        connections = self.rest_get("connections/")
        clients_for_site = [c
                            for c in connections
                            if c['user'] == site.client.username]
        return len(clients_for_site) > 0

    def disconnect(self):
Lukas Burgey's avatar
Lukas Burgey committed
212
        logger.debug(self.msg('closing connection'))
Lukas Burgey's avatar
Lukas Burgey committed
213
214
215
216
217
218
219
220
221
222
        self.connection.close()

    def service_routing_key(self, service):
        return 'service.' + service.name

    def online_clients(self, service):
        return [site
                for site in service.site.all()
                if self.is_client_connected(site)]

223
224
225
226
227
228
229
230
231
    def publish_by_service(self, service, msg):
        return self.channel.basic_publish(
                exchange=self.exchange,
                routing_key=self.service_routing_key(service),
                body=msg,
                properties=pika.BasicProperties(
                    delivery_mode=1,
                    ),
                )
Lukas Burgey's avatar
Lukas Burgey committed
232
233


234
# TODO dirty
Lukas Burgey's avatar
Lukas Burgey committed
235
236
237
238
def rabbitmq_instance():
    return RabbitMQInstance.objects.get(enabled=True)


Lukas Burgey's avatar
Lukas Burgey committed
239
class User(AbstractUser):
240
241
242
243
244
245
246
247
248
249
    TYPE_CHOICES = (
            ('apiclient', 'API-Client'),
            ('oidcuser', 'OIDC User'),
            ('admin', 'Admin'),
            )
    user_type = models.CharField(
            max_length=20,
            choices=TYPE_CHOICES,
            default='oidcuser',
            )
Lukas Burgey's avatar
Lukas Burgey committed
250
251
252
    sub = models.CharField(max_length=150, blank=True, null=True)
    password = models.CharField(max_length=150, blank=True, null=True)

Lukas Burgey's avatar
Lukas Burgey committed
253
    # we hide deleted keys here
254
    # the full list of ssh keys is self._ssh_keys
Lukas Burgey's avatar
Lukas Burgey committed
255
256
257
258
    @property
    def ssh_keys(self):
        return self._ssh_keys.filter(deleted=False)

259
260
261
262
263
264
265
266
267
    def __str__(self):
        if self.user_type == 'admin':
            return 'ADMIN {}'.format(self.username)
        if self.user_type == 'oidcuser':
            if not self.is_active:
                return 'DEACTIVATED USER {}'.format(self.username)
            return 'USER {}'.format(self.username)
        if self.user_type == 'apiclient':
            return 'APICLIENT {}@{}'.format(self.username, self.site)
Lukas Burgey's avatar
Lukas Burgey committed
268

269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
    def msg(self, msg):
        return '[{}] {}'.format(self, msg)

    # oidcuser: withdraw and delete all credentials and delete the user
    def remove(self):
        if self.user_type == 'oidcuser':
            self.deactivate()
            logger.info(self.msg('Deleting'))

            # TODO: deleting the user brings problems:
            # the deletion cascades down to DeploymentTask and DeploymentTaskItem
            # but these need to be conserved so all clients withdrawals can be tracked
            self.delete()

    def activate(self):
        if self.is_active:
            logger.error(self.msg('already activated'))
            return

        if self.user_type == 'oidcuser':
            self.is_active = True
            self.save()

            for dep in self.deployments.all():
                dep.activate()

            logger.info(self.msg('activated'))

    # oidcuser: withdraw all credentials
    def deactivate(self):
        if not self.is_active:
            logger.error(self.msg('already deactivated'))
            return

        if self.user_type == 'oidcuser':
            self.is_active = False
            self.save()

            for dep in self.deployments.all():
                dep.deactivate()

            logger.info(self.msg('deactivated'))
311
312


Lukas Burgey's avatar
Lukas Burgey committed
313
314
315
316
317
318
319
320
321
322
323
324
def construct_user(user_info):
    return User(
            sub=user_info['sub'],
            name=user_info['name'],
            first_name=user_info['given_name'],
            last_name=user_info['family_name'],
            email=user_info['email'],
            username=user_info['email'],
            )


class Site(models.Model):
325
326
327
    client = models.OneToOneField(
            User,
            related_name='site',
328
            )
Lukas Burgey's avatar
Lukas Burgey committed
329
330
331
332
333
334
    name = models.CharField(max_length=150, unique=True)
    description = models.TextField(max_length=300, blank=True)

    def __str__(self):
        return self.name

335
336
337
338
339
340
    # tasks which are still to be executed on this site
    @property
    def tasks(self):
        return [item.task
                for item
                in self.task_items.all()]
Lukas Burgey's avatar
Lukas Burgey committed
341

Lukas Burgey's avatar
Lukas Burgey committed
342
343
344
345

class Service(models.Model):
    name = models.CharField(max_length=150, unique=True)
    description = models.TextField(max_length=300, blank=True)
346
    site = models.ManyToManyField(
Lukas Burgey's avatar
Lukas Burgey committed
347
348
            Site,
            related_name='services')
Lukas Burgey's avatar
Lukas Burgey committed
349
    groups = models.ManyToManyField(
Lukas Burgey's avatar
Lukas Burgey committed
350
351
352
            Group,
            related_name='services',
            blank=True)
Lukas Burgey's avatar
Lukas Burgey committed
353
354

    def __str__(self):
Lukas Burgey's avatar
Lukas Burgey committed
355
        return self.name
Lukas Burgey's avatar
Lukas Burgey committed
356
357
358
359
360


class SSHPublicKey(models.Model):
    name = models.CharField(max_length=150, unique=True)
    key = models.TextField(max_length=1000)
Lukas Burgey's avatar
Lukas Burgey committed
361
    # hidden field at the user
Lukas Burgey's avatar
Lukas Burgey committed
362
    user = models.ForeignKey(
Lukas Burgey's avatar
Lukas Burgey committed
363
            User,
Lukas Burgey's avatar
Lukas Burgey committed
364
            related_name='_ssh_keys')
Lukas Burgey's avatar
Lukas Burgey committed
365

Lukas Burgey's avatar
Lukas Burgey committed
366
367
368
369
370
    # has the user triggered the deletion of this key
    deleted = models.BooleanField(
            default=False,
            editable=False,
            )
371

Lukas Burgey's avatar
Lukas Burgey committed
372
373
    def msg(self, msg):
        return '[SSHPublicKey:{}] {}'.format(self, msg)
374

375
376
377
    # does not directly delete the key if the key is deployed or withdrawn
    # somewhere
    # the receiver 'delete_withdrawn_ssh_key' does the actual deletion
378
    def delete_key(self):
Lukas Burgey's avatar
Lukas Burgey committed
379
380
        if (not self.tasks.exists() and not self.deployments.exists()):
            logger.info(self.msg('Direct deletion of key'))
381
382
383
            self.delete()
            return

Lukas Burgey's avatar
Lukas Burgey committed
384
        logger.info(self.msg('Deletion of key started'))
385
386
387
        self.deleted = True
        self.save()

Lukas Burgey's avatar
Lukas Burgey committed
388
        # delete implies withdrawing the key from all clients
389
390
391
        for deployment in self.deployments.all():
            deployment.withdraw_key(self)

Lukas Burgey's avatar
Lukas Burgey committed
392
393
    # when a key is withdrawn by a client we try to finally delete it
    def try_final_deletion(self):
Lukas Burgey's avatar
Lukas Burgey committed
394
395
396
        if (self.deleted and not self.tasks.exists()):
            logger.info(self.msg(
                'All clients have withdrawn this key. Final deletion'))
Lukas Burgey's avatar
Lukas Burgey committed
397
398
399
            self.delete()
            return

Lukas Burgey's avatar
Lukas Burgey committed
400
    def __str__(self):
Lukas Burgey's avatar
Lukas Burgey committed
401
402
        if self.deleted:
            return "DELETED: {}".format(self.name)
Lukas Burgey's avatar
Lukas Burgey committed
403
404
405
        return self.name


406
# Deployment describes the credential state per user as it is supposed to be
407
408
409
410
#
# (exception: if is_active=False the ssh_keys contain the keys to be deployed
# if the deployment is reactivated)
#
411
412
# DeploymentTask is what is sent to the clients via rabbitmq
# The DeploymentTaskItem track the acknowledgements from the clients
Lukas Burgey's avatar
Lukas Burgey committed
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
class Deployment(models.Model):
    user = models.ForeignKey(
            User,
            related_name='deployments',
            on_delete=models.CASCADE,
            )
    service = models.ForeignKey(
            Service,
            related_name='deployments',
            on_delete=models.CASCADE,
            )
    ssh_keys = models.ManyToManyField(
            SSHPublicKey,
            related_name='deployments',
            blank=True,
            )
429
430
431
432
433
    ssh_keys_to_withdraw = models.ManyToManyField(
            SSHPublicKey,
            related_name='withdrawn_deployments',
            blank=True,
            )
434
435
    is_active = models.BooleanField(
            default=True)
436

437
438
439
    @property
    def withdrawals(self):
        return self.tasks.filter(action='withdraw')
Lukas Burgey's avatar
Lukas Burgey committed
440

441
442
443
    @property
    def deploys(self):
        return self.tasks.filter(action='deploy')
Lukas Burgey's avatar
Lukas Burgey committed
444

445
446
    def __str__(self):
        return '{}:{}'.format(self.service, self.user)
447

448
449
    def msg(self, msg):
        return '[Deployment:{}] {}'.format(self, msg)
450

451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
    # deploy credentials which were deployed prior to deactivation
    def activate(self):
        if self.is_active:
            logger.error(self.msg('already active'))
            return

        logger.debug(self.msg(str(self.ssh_keys.all())))
        for key in self.ssh_keys.all():
            self._deploy_key(key)

        self.is_active = True
        self.save()
        logger.info(self.msg('activated'))

    # withdraw all credentials
    def deactivate(self):
        if not self.is_active:
            logger.error(self.msg('already deactivated'))
            return

        self.is_active = False
472
        self.save()
473

474
475
476
477
478
479
480
481
        for key in self.ssh_keys.all():
            self._withdraw_key(key)

        logger.info(self.msg('deactivated'))

    # only deploy the key
    def _deploy_key(self, key):
        # delete outstanding tasks which are made obsolete by this task
482
        for withdrawal in self.withdrawals.filter(key=key):
Lukas Burgey's avatar
Lukas Burgey committed
483
484
            logger.debug(withdrawal.msg('now obsolete'))
            withdrawal.delete()
485
486
487
488
489
490
491
492

        # generate task
        task = DeploymentTask(
                action='deploy',
                deployment=self,
                key=key,
                )
        task.save()
Lukas Burgey's avatar
Lukas Burgey committed
493
        logger.debug(task.msg('generated'))
494
495
496
497
498
499
500
501

        # generate task items
        for site in self.service.site.all():
            deploy = DeploymentTaskItem(
                    task=task,
                    site=site,
                    )
            deploy.save()
Lukas Burgey's avatar
Lukas Burgey committed
502
            logger.debug(deploy.msg('generated'))
503
504
505

        # publish the task
        task.publish()
506

507
508
    def _withdraw_key(self, key):
        # delete outstanding tasks which are made obsolete by this task
509
        for deploy in self.deploys.filter(key=key):
Lukas Burgey's avatar
Lukas Burgey committed
510
511
            logger.debug(deploy.msg("now obsolete"))
            deploy.delete()
Lukas Burgey's avatar
Lukas Burgey committed
512

513
514
515
516
517
518
519
        # generate task
        task = DeploymentTask(
                action='withdraw',
                deployment=self,
                key=key,
                )
        task.save()
Lukas Burgey's avatar
Lukas Burgey committed
520
        logger.debug(task.msg('generated'))
Lukas Burgey's avatar
Lukas Burgey committed
521

522
523
524
525
526
527
528
        # generate task items
        for site in self.service.site.all():
            withdrawal = DeploymentTaskItem(
                    task=task,
                    site=site,
                    )
            withdrawal.save()
Lukas Burgey's avatar
Lukas Burgey committed
529
            logger.debug(withdrawal.msg('generated'))
530

531
532
        # publish the task
        task.publish()
Lukas Burgey's avatar
Lukas Burgey committed
533

534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
    # deploy key and track changes in the key lists
    def deploy_key(self, key):
        if not self.is_active:
            logger.error(self.msg('cannot deploy while deactivated'))
            raise Exception('deployment deactivated')

        self.ssh_keys.add(key)

        if key in self.ssh_keys_to_withdraw.all():
            self.ssh_keys_to_withdraw.remove(key)
        self.save()

        self._deploy_key(key)

    # withdraw key and track changes in the key lists
    def withdraw_key(self, key):
        if not self.is_active:
            logger.error(self.msg('cannot withdraw while deactivated'))
            raise Exception('deployment deactivated')

        self.ssh_keys.remove(key)

        # keys which are to be withdrawn by the clients
        self.ssh_keys_to_withdraw.add(key)
        self.save()

        self._withdraw_key(key)

Lukas Burgey's avatar
Lukas Burgey committed
562

563
564
565
566
567
568
569
570
571
572
573
574
575
576
class DeploymentTask(models.Model):
    ACTION_CHOICES = (
            ('deploy', 'deploy'),
            ('withdraw', 'withdraw'),
            )
    action = models.CharField(
            max_length=10,
            choices=ACTION_CHOICES,
            )
    key = models.ForeignKey(
            SSHPublicKey,
            related_name='tasks',
            on_delete=models.CASCADE,
            )
Lukas Burgey's avatar
Lukas Burgey committed
577
578
    deployment = models.ForeignKey(
            Deployment,
579
580
            related_name='tasks',
            on_delete=models.CASCADE,
Lukas Burgey's avatar
Lukas Burgey committed
581
582
583
584
585
586
587
588
589
590
            )

    @property
    def user(self):
        return self.deployment.user

    @property
    def service(self):
        return self.deployment.service

591
    def __str__(self):
592
        return "{}:{}:{} - {}".format(
593
594
595
596
597
598
                self.deployment.service,
                self.deployment.user,
                self.key,
                self.action,
                )

Lukas Burgey's avatar
Lukas Burgey committed
599
600
    def msg(self, msg):
        return '[DeploymentTask:{}] {}'.format(self, msg)
601
602
603
604
605
606
607
608
609
610
611

    def publish(self):
        from .clientapi.serializers import DeploymentTaskSerializer
        msg = json.dumps(DeploymentTaskSerializer(self).data)

        rabbitmq_instance().publish_by_service(
                self.service,
                msg)

    # the client acked the receipt and execution of the task for his site
    def item_finished(self, site):
Lukas Burgey's avatar
Lukas Burgey committed
612
613
614
        item = self.task_items.get(site=site)
        logger.debug(item.msg('done'))
        item.delete()
615
616
617
618
619
620

        if not self.task_items.exists():
            self.finished()

    # maintenance after all task items are done
    def finished(self):
Lukas Burgey's avatar
Lukas Burgey committed
621
        logger.info(self.msg('done'))
Lukas Burgey's avatar
Lukas Burgey committed
622
        self.delete()
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640

        # check if this was the final withdraw in a key deletion
        if self.action == 'withdraw':
            self.key.try_final_deletion()


class DeploymentTaskItem(models.Model):
    task = models.ForeignKey(
            DeploymentTask,
            related_name='task_items',
            on_delete=models.CASCADE,
            )
    site = models.ForeignKey(
            Site,
            related_name='task_items',
            on_delete=models.CASCADE,
            )

Lukas Burgey's avatar
Lukas Burgey committed
641
    def __str__(self):
642
643
644
645
646
        return "{}@{}".format(
                self.task,
                self.site,
                )

Lukas Burgey's avatar
Lukas Burgey committed
647
648
    def msg(self, msg):
        return '[DeploymentTaskItem:{}] {}'.format(self, msg)
649

Lukas Burgey's avatar
Lukas Burgey committed
650

651
652
653
#
# RECEIVERS
#
Lukas Burgey's avatar
Lukas Burgey committed
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674

@receiver(post_save, sender=settings.AUTH_USER_MODEL)
def create_auth_token(sender, instance=None, created=False, **kwargs):
    if instance.user_type == 'apiclient' and created:
        Token.objects.create(user=instance)


@receiver(post_save, sender=Site)
def register_at_rabbitmq(
        sender, instance=None, created=False, **kwargs):
    if not created:
        return

    RabbitMQInstance().register_site(instance)


@receiver(pre_delete, sender=Site)
def deregister_at_rabbitmq(
        sender, instance=None, **kwargs):

    RabbitMQInstance().deregister_site(instance)