/
views.py
489 lines (383 loc) · 18.6 KB
/
views.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
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
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
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
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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
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
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
import uuid
from django.conf import settings
from django.contrib.auth.models import update_last_login
from django.contrib.auth.password_validation import validate_password
from django.core.exceptions import ValidationError
from django.http import Http404
from django.shortcuts import redirect
from drf_yasg.utils import swagger_auto_schema
from mozilla_django_oidc.views import OIDCAuthenticationCallbackView
from pydash import get
from rest_framework import mixins, status
from rest_framework.authtoken.serializers import AuthTokenSerializer
from rest_framework.authtoken.views import ObtainAuthToken
from rest_framework.exceptions import PermissionDenied
from rest_framework.generics import RetrieveAPIView, UpdateAPIView, DestroyAPIView, RetrieveUpdateDestroyAPIView
from rest_framework.permissions import IsAdminUser, IsAuthenticated, AllowAny
from rest_framework.response import Response
from rest_framework.views import APIView
from core.common.constants import NOT_FOUND, MUST_SPECIFY_EXTRA_PARAM_IN_BODY, LAST_LOGIN_SINCE_PARAM, \
LAST_LOGIN_BEFORE_PARAM, DATE_JOINED_SINCE_PARAM, DATE_JOINED_BEFORE_PARAM
from core.common.exceptions import Http400
from core.common.mixins import ListWithHeadersMixin
from core.common.swagger_parameters import last_login_before_param, last_login_since_param, updated_since_param, \
date_joined_since_param, date_joined_before_param
from core.common.utils import parse_updated_since_param, from_string_to_date
from core.common.views import BaseAPIView, BaseLogoView
from core.orgs.models import Organization
from core.users.constants import VERIFICATION_TOKEN_MISMATCH, VERIFY_EMAIL_MESSAGE, REACTIVATE_USER_MESSAGE
from core.users.documents import UserProfileDocument
from core.users.search import UserProfileSearch
from core.users.serializers import UserDetailSerializer, UserCreateSerializer, UserListSerializer, UserSummarySerializer
from .models import UserProfile
from ..common.services import AuthService, OIDCAuthService
class OCLOIDCAuthenticationCallbackView(OIDCAuthenticationCallbackView):
pass
class OIDCodeExchangeView(APIView):
"""API to exchange OIDP one-time authorization_code with token"""
permission_classes = (AllowAny, )
@staticmethod
def post(request):
code = request.data.get('code', None)
redirect_uri = request.data.get('redirect_uri', None)
client_id = request.data.get('client_id', None)
client_secret = request.data.get('client_secret', None)
if not code or not redirect_uri or not client_id or not client_secret:
return Response(
dict(error='code and redirect_uri are mandatory to exchange for token'),
status=status.HTTP_400_BAD_REQUEST
)
return Response(
OIDCAuthService.exchange_code_for_token(code, redirect_uri, client_id, client_secret))
# This API is only to migrate users from Django to OID, requires OID admin credentials in payload
class SSOMigrateView(APIView): # pragma: no cover
permission_classes = (AllowAny, )
def get_object(self):
username = self.kwargs.get('user')
user = UserProfile.objects.filter(username=username).first()
if not user:
raise Http404()
return user
def post(self, request, **kwargs): # pylint: disable=unused-argument
username = request.data.get('username')
password = request.data.get('password')
if not username or not password:
return Response(
dict(error='keycloak admin username/password are required'),
status=status.HTTP_400_BAD_REQUEST
)
user = self.get_object()
result = OIDCAuthService.add_user(user=user, username=username, password=password)
return Response(result)
class TokenExchangeView(APIView):
permission_classes = (IsAuthenticated, )
@staticmethod
def get(request):
return Response(dict(token=request.user.get_token()))
class OIDCLogoutView(APIView):
permission_classes = (AllowAny,)
@staticmethod
def get(request):
if AuthService.is_sso_enabled():
return redirect(
OIDCAuthService.get_logout_redirect_url(
request.query_params.get('id_token_hint'),
request.query_params.get('post_logout_redirect_uri'),
)
)
return Response(status=status.HTTP_405_METHOD_NOT_ALLOWED)
class TokenAuthenticationView(ObtainAuthToken):
"""Implementation of ObtainAuthToken with last_login update"""
@staticmethod
def get(request):
if AuthService.is_sso_enabled():
return redirect(
OIDCAuthService.get_login_redirect_url(
request.query_params.get('client_id'),
request.query_params.get('redirect_uri'),
request.query_params.get('state'),
request.query_params.get('nonce'),
)
)
return Response(status=status.HTTP_405_METHOD_NOT_ALLOWED)
@swagger_auto_schema(request_body=AuthTokenSerializer)
def post(self, request, *args, **kwargs):
if AuthService.is_sso_enabled():
raise Http400(
dict(error=["Single Sign On is enabled in this environment. Cannot login via API directly."]))
user = UserProfile.objects.filter(username=request.data.get('username')).first()
if not user or not user.check_password(request.data.get('password')):
raise Http400(dict(non_field_errors=["Unable to log in with provided credentials."]))
if not user.is_active:
user.verify()
return Response(
{
'detail': REACTIVATE_USER_MESSAGE,
'email': user.email
}, status=status.HTTP_401_UNAUTHORIZED
)
if not user.verified:
user.send_verification_email()
return Response(
{
'detail': VERIFY_EMAIL_MESSAGE,
'email': user.email
}, status=status.HTTP_401_UNAUTHORIZED
)
result = super().post(request, *args, **kwargs)
try:
update_last_login(None, user)
except: # pylint: disable=bare-except
pass
return result
class UserBaseView(BaseAPIView):
lookup_field = 'user'
pk_field = 'username'
model = UserProfile
queryset = UserProfile.objects
es_fields = UserProfile.es_fields
document_model = UserProfileDocument
facet_class = UserProfileSearch
is_searchable = True
default_qs_sort_attr = '-date_joined'
serializer_class = UserDetailSerializer
def get_queryset(self):
updated_since = parse_updated_since_param(self.request.query_params)
last_login_since = self.request.query_params.get(LAST_LOGIN_SINCE_PARAM, None)
last_login_before = self.request.query_params.get(LAST_LOGIN_BEFORE_PARAM, None)
date_joined_since = self.request.query_params.get(DATE_JOINED_SINCE_PARAM, None)
date_joined_before = self.request.query_params.get(DATE_JOINED_BEFORE_PARAM, None)
if updated_since:
self.queryset = self.queryset.filter(updated_at__gte=updated_since)
if last_login_since:
self.queryset = self.queryset.filter(last_login__gte=from_string_to_date(last_login_since))
if last_login_before:
self.queryset = self.queryset.filter(last_login__lt=from_string_to_date(last_login_before))
if date_joined_since:
self.queryset = self.queryset.filter(created_at__gte=from_string_to_date(date_joined_since))
if date_joined_before:
self.queryset = self.queryset.filter(created_at__lt=from_string_to_date(date_joined_before))
if not self.should_include_inactive():
self.queryset = self.queryset.filter(is_active=True)
return self.queryset
class UserLogoView(UserBaseView, BaseLogoView):
permission_classes = (IsAuthenticated, )
class UserListView(UserBaseView,
ListWithHeadersMixin,
mixins.CreateModelMixin):
def get_serializer_class(self):
if self.request.query_params.get('summary') in ['true', True] and self.request.method == 'GET':
return UserSummarySerializer
if self.request.method == 'GET' and self.is_verbose():
return UserDetailSerializer
if self.request.method == 'POST':
return UserCreateSerializer
return UserListSerializer
def get_permissions(self):
if self.request.method in ['POST', 'DELETE']:
return [IsAdminUser()]
return []
def can_view(self, organization):
user = self.request.user
return organization.public_can_view or user.is_staff or organization.is_member(user)
@swagger_auto_schema(
manual_parameters=[
last_login_before_param, last_login_since_param, date_joined_before_param, date_joined_since_param,
updated_since_param
]
)
def get(self, request, *args, **kwargs):
org = kwargs.pop('org', None)
if org:
organization = Organization.objects.filter(mnemonic=org).first()
if not organization:
return Response(status=status.HTTP_404_NOT_FOUND)
if not self.can_view(organization):
return Response(status=status.HTTP_403_FORBIDDEN)
queryset = organization.members
if not self.should_include_inactive():
queryset = queryset.filter(is_active=True)
self.queryset = queryset.all()
return self.list(request, *args, **kwargs)
def post(self, request, *args, **kwargs): # pylint: disable=unused-argument
serializer = self.get_serializer(data=request.data)
serializer.is_valid(raise_exception=True)
self.perform_create(serializer)
headers = self.get_success_headers(serializer.data)
if serializer.errors:
return Response(serializer.data, status=status.HTTP_400_BAD_REQUEST)
data = serializer.data.copy()
if 'username' in serializer.errors and 'token' not in data and get(serializer, 'instance.token'):
data['token'] = serializer.instance.token # for ocl_web
return Response(data, status=status.HTTP_201_CREATED, headers=headers)
class UserSignup(UserBaseView, mixins.CreateModelMixin):
serializer_class = UserCreateSerializer
permission_classes = (AllowAny, )
def post(self, request, *args, **kwargs): # pylint: disable=unused-argument
serializer = self.get_serializer(data={**request.data, 'verified': False})
serializer.is_valid(raise_exception=True)
self.perform_create(serializer)
if serializer.errors:
return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)
headers = self.get_success_headers(serializer.data)
return Response({'detail': VERIFY_EMAIL_MESSAGE}, status=status.HTTP_201_CREATED, headers=headers)
def perform_create(self, serializer):
if AuthService.is_sso_enabled():
raise Http400(
dict(error=["Single Sign On is enabled in this environment. Cannot signup via API directly."]))
data = self.request.data
try:
validate_password(data.get('password'))
except ValidationError as ex:
serializer._errors['password'] = ex.messages # pylint: disable=protected-access
return
response = AuthService.get().create_user(data)
if response is True or get(settings, 'TEST_MODE', False):
super().perform_create(serializer)
elif response:
serializer._errors = response # pylint: disable=protected-access
class UserEmailVerificationView(UserBaseView):
permission_classes = (AllowAny, )
def get(self, request, *args, **kwargs): # pylint: disable=unused-argument
user = self.get_object()
if not user:
return Response(status=status.HTTP_404_NOT_FOUND)
result = AuthService.get(user=user).mark_verified(
token=kwargs.get('verification_token'), force=get(request.user, 'is_staff'))
if result is True:
return Response(status=status.HTTP_200_OK)
return Response(dict(detail=VERIFICATION_TOKEN_MISMATCH), status=status.HTTP_401_UNAUTHORIZED)
class UserPasswordResetView(UserBaseView):
permission_classes = (AllowAny, )
def post(self, request, *args, **kwargs): # pylint: disable=unused-argument
"""Sends reset password mail"""
email = request.data.get('email')
if not email:
return Response(status=status.HTTP_400_BAD_REQUEST)
user = UserProfile.objects.filter(email=email).first()
if not user:
return Response(status=status.HTTP_404_NOT_FOUND)
user.verification_token = uuid.uuid4()
user.save()
user.send_reset_password_email()
return Response(status=status.HTTP_200_OK)
def put(self, request, *args, **kwargs): # pylint: disable=unused-argument
"""Resets password"""
if AuthService.is_sso_enabled():
raise Http400(
dict(error=["Single Sign On is enabled in this environment. Cannot reset password via API directly."]))
token = request.data.get('token', None)
password = request.data.get('new_password', None)
if not token or not password:
return Response(status=status.HTTP_400_BAD_REQUEST)
user = UserProfile.objects.filter(verification_token=token).first()
if not user:
return Response(status=status.HTTP_404_NOT_FOUND)
try:
validate_password(password)
except ValidationError as ex:
return Response(dict(errors=ex.messages), status=status.HTTP_400_BAD_REQUEST)
result = AuthService.get(user=user).update_password(password)
if get(result, 'errors'):
return Response(result, status=status.HTTP_400_BAD_REQUEST)
return Response(status=status.HTTP_200_OK)
class UserDetailView(UserBaseView, RetrieveAPIView, DestroyAPIView, mixins.UpdateModelMixin):
def get_serializer_class(self):
if self.request.query_params.get('summary') in ['true', True] and self.request.method == 'GET':
return UserSummarySerializer
return UserDetailSerializer
def get_queryset(self):
if self.kwargs.get('user_is_self'):
return self.queryset.filter(username=self.request.user.username)
return self.queryset.filter(username=self.kwargs['user'])
def get_permissions(self):
if self.request.method == 'DELETE':
return [IsAdminUser()]
if self.request.query_params.get('includeVerificationToken') and self.request.method == 'GET':
return [AllowAny()]
return [IsAuthenticated()]
def get_object(self, queryset=None):
instance = self.request.user if self.kwargs.get('user_is_self') else super().get_object(queryset)
self.user_is_self = self.request.user.username == instance.username
if not instance or instance.is_anonymous:
raise Http404()
is_self = self.kwargs.get('user_is_self') or self.user_is_self
is_admin = self.request.user.is_staff
if self.request.query_params.get('includeVerificationToken') and self.request.method == 'GET':
return instance
if not is_self and not is_admin:
raise PermissionDenied()
return instance
def put(self, request, *args, **kwargs):
obj = self.get_object()
obj.update_password(request.data.get('password'), request.data.get('hashed_password'))
return self.partial_update(request, *args, **kwargs)
def delete(self, request, *args, **kwargs):
obj = self.get_object()
if self.user_is_self:
return Response(status=status.HTTP_405_METHOD_NOT_ALLOWED)
if self.is_hard_delete_requested():
obj.delete()
else:
obj.deactivate()
return Response(status=status.HTTP_204_NO_CONTENT)
class UserReactivateView(UserBaseView, UpdateAPIView):
permission_classes = (IsAdminUser, )
queryset = UserProfile.objects.filter(is_active=False)
def get_queryset(self):
return self.queryset
def update(self, request, *args, **kwargs):
profile = self.get_object()
profile.undelete()
return Response(status=status.HTTP_204_NO_CONTENT)
class UserStaffToggleView(UserBaseView, UpdateAPIView):
permission_classes = (IsAdminUser, )
swagger_schema = None
def update(self, request, *args, **kwargs):
user = self.get_object()
if user.username == self.request.user.username:
raise Http400()
is_admin_already = user.is_staff
user.is_staff = not is_admin_already
if is_admin_already:
user.is_superuser = False
user.save()
return Response(status=status.HTTP_204_NO_CONTENT)
class UserExtrasBaseView(APIView):
serializer_class = UserDetailSerializer
def get_object(self):
instance = self.request.user if self.kwargs.get('user_is_self') else UserProfile.objects.filter(
username=self.kwargs['user']).first()
if not instance:
raise Http404()
return instance
class UserExtrasView(UserExtrasBaseView):
def get(self, request, **kwargs): # pylint: disable=unused-argument
return Response(get(self.get_object(), 'extras', {}))
class UserExtraRetrieveUpdateDestroyView(UserExtrasBaseView, RetrieveUpdateDestroyAPIView):
def retrieve(self, request, *args, **kwargs):
key = kwargs.get('extra')
instance = self.get_object()
extras = get(instance, 'extras', {})
if key in extras:
return Response({key: extras[key]})
return Response(dict(detail=NOT_FOUND), status=status.HTTP_404_NOT_FOUND)
def update(self, request, **kwargs): # pylint: disable=arguments-differ
key = kwargs.get('extra')
value = request.data.get(key)
if not value:
return Response([MUST_SPECIFY_EXTRA_PARAM_IN_BODY.format(key)], status=status.HTTP_400_BAD_REQUEST)
instance = self.get_object()
instance.extras = get(instance, 'extras', {})
instance.extras[key] = value
instance.save()
return Response({key: value})
def delete(self, request, *args, **kwargs):
key = kwargs.get('extra')
instance = self.get_object()
instance.extras = get(instance, 'extras', {})
if key in instance.extras:
del instance.extras[key]
instance.save()
return Response(status=status.HTTP_204_NO_CONTENT)
return Response(dict(detail=NOT_FOUND), status=status.HTTP_404_NOT_FOUND)