models.py 7.73 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
6
from rest_framework.authtoken.models import Token
from django.db.models.signals import post_save
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
            ds = (
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
77
78
            if not all:
                ds = ds.filter(last_change__gt=self.last_fetch)

79
            # deployments for this site
80
81
            services[service.name] = ds

Lukas Burgey's avatar
Lukas Burgey committed
82
83
84
85
        self.last_fetch = datetime.now()
        self.save()
        return services

Lukas Burgey's avatar
Lukas Burgey committed
86

87
88
89
90
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
@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
160
161
162
163
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
164
165
            Site,
            related_name='services')
Lukas Burgey's avatar
Lukas Burgey committed
166
    groups = models.ManyToManyField(
Lukas Burgey's avatar
Lukas Burgey committed
167
168
169
            Group,
            related_name='services',
            blank=True)
Lukas Burgey's avatar
Lukas Burgey committed
170
171
172
173
174
175
176
177

    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
178
    # hidden field at the user
Lukas Burgey's avatar
Lukas Burgey committed
179
    user = models.ForeignKey(
Lukas Burgey's avatar
Lukas Burgey committed
180
            User,
Lukas Burgey's avatar
Lukas Burgey committed
181
            related_name='_ssh_keys')
Lukas Burgey's avatar
Lukas Burgey committed
182

Lukas Burgey's avatar
Lukas Burgey committed
183
184
185
186
187
    # has the user triggered the deletion of this key
    deleted = models.BooleanField(
            default=False,
            editable=False,
            )
188

Lukas Burgey's avatar
Lukas Burgey committed
189
    def __str__(self):
Lukas Burgey's avatar
Lukas Burgey committed
190
191
        if self.deleted:
            return "DELETED: {}".format(self.name)
Lukas Burgey's avatar
Lukas Burgey committed
192
193
194
        return self.name


195
196
197
198
199
200
201
202
@receiver(post_save, sender=SSHPublicKey)
def delete_old_ssh_key(
        sender, instance=None, created=False, **kwargs):

    if instance.deleted and len(instance.deployments.all()) == 0:
        instance.delete()


Lukas Burgey's avatar
Lukas Burgey committed
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
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,
            )
220
221
222
223
224
225
226
227

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

228
229
230
    last_change = models.DateTimeField(
            auto_now=True
            )
Lukas Burgey's avatar
Lukas Burgey committed
231

232
233
234
235
236
237
238
    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()
239
        self.send_change()
240
241
242
243
244
245
246
247

    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()
248
        self.send_change()
249
250
251
252
253
254
255

    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()

256
257
258
    def send_change(self):
        deployment_change.send(sender=self.__class__, instance=self)

Lukas Burgey's avatar
Lukas Burgey committed
259
    def __str__(self):
260
        return '{}@{}'.format(self.user, self.service)
261
262
263
264
265
266


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