models.py 8.62 KB
Newer Older
Lukas Burgey's avatar
Lukas Burgey committed
1
2
from django.contrib.auth.models import AbstractUser, Group
from django.db import models
3
from django.conf import settings
4
from django.dispatch import receiver, Signal
5
from rest_framework.authtoken.models import Token
6
from django.db.models.signals import post_save, m2m_changed
Lukas Burgey's avatar
Lukas Burgey committed
7
from datetime import datetime
Lukas Burgey's avatar
Lukas Burgey committed
8

9
10
11
import requests
from requests.auth import HTTPBasicAuth

12
13
deployment_change = Signal(providing_args=['instance'])

Lukas Burgey's avatar
Lukas Burgey committed
14
15

class User(AbstractUser):
16
17
18
19
20
21
22
23
24
25
    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
26
27
28
    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
29
30
31
32
33
34
    # we hide deleted keys here
    # the full list of ssh keys is at self._ssh_keys
    @property
    def ssh_keys(self):
        return self._ssh_keys.filter(deleted=False)

Lukas Burgey's avatar
Lukas Burgey committed
35

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


Lukas Burgey's avatar
Lukas Burgey committed
42
43
44
45
46
47
48
49
50
51
52
53
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):
54
55
56
    client = models.OneToOneField(
            User,
            related_name='site',
57
            )
Lukas Burgey's avatar
Lukas Burgey committed
58
59
    name = models.CharField(max_length=150, unique=True)
    description = models.TextField(max_length=300, blank=True)
Lukas Burgey's avatar
Lukas Burgey committed
60
    last_fetch = models.DateTimeField(default=datetime.utcfromtimestamp(0))
Lukas Burgey's avatar
Lukas Burgey committed
61
62
63
64

    def __str__(self):
        return self.name

65
    def clientapi_get_deployments(self, all=False):
Lukas Burgey's avatar
Lukas Burgey committed
66
67
68
        services = {}

        for service in self.services.all():
69
            deployments = (
70
71
72
73
74
75
                service.deployments
                .filter(user__user_type='oidcuser')
                # we do not exclude deployments without ssh_keys, as the
                # ssh_keys_to_withdraw still need to be propagated
                # .exclude(ssh_keys=None)
                )
76
            if not all:
77
78
                deployments = deployments.filter(
                        last_change__gt=self.last_fetch)
79

80
            # deployments for this site
81
82
83
84
85
            services[service.name] = deployments

            for deployment in deployments.all():
                # TODO replace this optimism with an acknowledgement
                deployment.client_got_deployment()
86

Lukas Burgey's avatar
Lukas Burgey committed
87
88
89
90
        self.last_fetch = datetime.now()
        self.save()
        return services

Lukas Burgey's avatar
Lukas Burgey committed
91

92
93
94
95
96
97
98
99
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
@receiver(post_save, sender=Site)
def register_client_at_rabbitmq(sender, instance=None, created=False,
                                **kwargs):
    if not created:
        return

    print('registerring client {}'.format(instance.client.username))

    # %2f: url encoded '/' as this is the vhost we use
    api = 'http://localhost:15672/api'
    username = instance.client.username
    vhost = '%2f'
    exchange = 'deployments'
    # guest only works on the localhost
    auth = HTTPBasicAuth('guest', 'guest')

    # create user
    user_creation_uri = '{}/users/{}/'.format(
            api,
            username
            )
    user_creation_data = {
            'password': str(instance.client.auth_token.key),
            'tags': '',
            }
    r = requests.put(user_creation_uri, json=user_creation_data, auth=auth)
    print('status_code {} {}'.format(r.status_code, r.text))

    # set permissions for the user
    set_permission_uri = '{}/permissions/{}/{}/'.format(
            api,
            vhost,
            username,
            )
    permission = '^(amq\.gen.*|{})'.format(exchange)
    set_permission_data = {
            'configure': permission,
            'write': permission,
            'read': permission,
            }

    set_topic_permission_uri = '{}/topic-permissions/{}/{}/'.format(
            api,
            vhost,
            username,
            )
    r = requests.put(set_permission_uri, json=set_permission_data, auth=auth)
    print('status_code {} {}'.format(r.status_code, r.text))

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

        services = services + prefix + service.name

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

    r = requests.put(
            set_topic_permission_uri,
            json=set_topic_permission_data, auth=auth)
    print('status_code {} {}'.format(r.status_code, r.text))


Lukas Burgey's avatar
Lukas Burgey committed
165
166
167
168
class Service(models.Model):
    name = models.CharField(max_length=150, unique=True)
    description = models.TextField(max_length=300, blank=True)
    site = models.ForeignKey(
Lukas Burgey's avatar
Lukas Burgey committed
169
170
            Site,
            related_name='services')
Lukas Burgey's avatar
Lukas Burgey committed
171
    groups = models.ManyToManyField(
Lukas Burgey's avatar
Lukas Burgey committed
172
173
174
            Group,
            related_name='services',
            blank=True)
Lukas Burgey's avatar
Lukas Burgey committed
175
176
177
178
179
180
181
182

    def __str__(self):
        return self.name + '@' + self.site.name


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
183
    # hidden field at the user
Lukas Burgey's avatar
Lukas Burgey committed
184
    user = models.ForeignKey(
Lukas Burgey's avatar
Lukas Burgey committed
185
            User,
Lukas Burgey's avatar
Lukas Burgey committed
186
            related_name='_ssh_keys')
Lukas Burgey's avatar
Lukas Burgey committed
187

Lukas Burgey's avatar
Lukas Burgey committed
188
189
190
191
192
    # has the user triggered the deletion of this key
    deleted = models.BooleanField(
            default=False,
            editable=False,
            )
193

194
195
196
    # does not directly delete the key if the key is deployed or withdrawn
    # somewhere
    # the receiver 'delete_withdrawn_ssh_key' does the actual deletion
197
    def delete_key(self):
198
199
200
201
202
        if (not self.deployments.exists()
                and not self.withdrawn_deployments.exists()):
            self.delete()
            return

203
204
205
206
207
208
        self.deleted = True
        self.save()

        for deployment in self.deployments.all():
            deployment.withdraw_key(self)

Lukas Burgey's avatar
Lukas Burgey committed
209
    def __str__(self):
Lukas Burgey's avatar
Lukas Burgey committed
210
211
        if self.deleted:
            return "DELETED: {}".format(self.name)
Lukas Burgey's avatar
Lukas Burgey committed
212
213
214
        return self.name


215
216
217
218
# finally delete the key if all the deployments are withdrawn
# and the withdrawal was seen by all clients
@receiver(m2m_changed, sender=SSHPublicKey)
def delete_withdrawn_ssh_key(
219
220
        sender, instance=None, created=False, **kwargs):

221
222
223
    if (instance.deleted
            and not instance.deployments.exists()
            and not instance.withdrawn_deployments.exists()):
224
225
226
        instance.delete()


Lukas Burgey's avatar
Lukas Burgey committed
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
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,
            )
    # SET_NULL: we allow credentials to be deleted after deployment
    ssh_keys = models.ManyToManyField(
            SSHPublicKey,
            related_name='deployments',
            blank=True,
            )
244
245
246
247
248
249
250
251

    # these ssh keys are to be withdrawn by the clients
    ssh_keys_to_withdraw = models.ManyToManyField(
            SSHPublicKey,
            related_name='withdrawn_deployments',
            blank=True,
            )

252
253
254
    last_change = models.DateTimeField(
            auto_now=True
            )
Lukas Burgey's avatar
Lukas Burgey committed
255

256
257
258
259
260
261
262
    def deploy_key(self, key):
        # key state: -> (2.5)
        self.ssh_keys.add(key)

        if key in self.ssh_keys_to_withdraw.all():
            self.ssh_keys_to_withdraw.remove(key)
        self.save()
263
        self.send_change()
264
265
266
267
268
269
270
271

    def withdraw_key(self, key):
        # key state: -> (4)
        self.ssh_keys.remove(key)

        # keys which are to be withdrawn by the clients
        self.ssh_keys_to_withdraw.add(key)
        self.save()
272
        self.send_change()
273
274
275
276
277
278
279

    def client_got_deployment(self):
        # the client has withdrawn the keys so we can empty the list
        self.ssh_keys_to_withdraw.clear()
        # TODO: does the deletion of the ssh_keys actually occur?
        self.save()

280
281
282
    def send_change(self):
        deployment_change.send(sender=self.__class__, instance=self)

Lukas Burgey's avatar
Lukas Burgey committed
283
    def __str__(self):
284
        return '{}@{}'.format(self.user, self.service)
285
286
287
288
289
290


@receiver(post_save, sender=Deployment)
def publish_deployment_creation(
        sender, instance=None, created=False, **kwargs):
    instance.send_change()