-
Notifications
You must be signed in to change notification settings - Fork 12
/
Copy pathmodels.py
1510 lines (1272 loc) · 49.7 KB
/
models.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
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
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
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
""" file containing models """
import datetime
import enum
import dataclasses
from django.contrib.auth.models import User as djangoUser
from django.db import models, transaction
from django.db.models.signals import post_save
from django.conf import settings
from enigma_automation.settings import PERMISSION_CONSTANTS
class StoredPassword(models.Model):
""" model for stored password """
user = models.ForeignKey(
settings.AUTH_USER_MODEL,
on_delete=models.CASCADE,
editable=False
)
password = models.CharField(
'Password hash',
max_length=255,
editable=False
)
date = models.DateTimeField(
'Date',
auto_now_add=True,
editable=False
)
class ApprovalType(enum.Enum):
""" Enum for Approval type """
PRIMARY = "Primary"
SECONDARY = "Secondary"
class Permission(models.Model):
"""
Permission to perform actions on enigma
"""
label = models.CharField(max_length=255, null=False, blank=False, unique=True)
def __str__(self):
return f"{self.label}"
class Role(models.Model):
"""
User role to attach permissions to perform actions on enigma; one user can have multiple roles
Role is a group of permissions which can be associated with a group of users
"""
label = models.CharField(max_length=255, null=False, blank=False, unique=True)
permission = models.ManyToManyField(Permission)
def __str__(self):
return f"{self.label}"
class SshPublicKey(models.Model):
"""
SSH Public keys for users
"""
key = models.TextField(null=False, blank=False)
STATUS_CHOICES = (("Active", "active"), ("Revoked", "revoked"))
status = models.CharField(
max_length=100,
null=False,
blank=False,
choices=STATUS_CHOICES,
default="Active",
)
def __str__(self):
return str(self.key)
class User(models.Model):
"""
Represents a user belonging to the organisation
"""
user = models.OneToOneField(
djangoUser, null=False, blank=False, on_delete=models.CASCADE, related_name="user"
)
name = models.CharField(max_length=255, null=True, blank=False)
email = models.EmailField(null=True, blank=False)
phone = models.IntegerField(null=True, blank=True)
is_bot = models.BooleanField(null=False, blank=False, default=False)
BOT_TYPES = (
("None", "none"),
("Github", "github"),
)
bot_type = models.CharField(
max_length=100, null=False, blank=False, choices=BOT_TYPES, default="None"
)
alerts_enabled = models.BooleanField(null=False, blank=False, default=False)
is_manager = models.BooleanField(null=False, blank=False, default=False)
is_ops = models.BooleanField(null=False, blank=False, default=False)
created_at = models.DateTimeField(auto_now_add=True)
updated_at = models.DateTimeField(auto_now=True)
avatar = models.TextField(null=True, blank=True)
USER_STATUS_CHOICES = [
("1", "active"),
("2", "offboarding"),
("3", "offboarded"),
]
state = models.CharField(
max_length=255, null=False, blank=False, choices=USER_STATUS_CHOICES, default=1
)
role = models.ManyToManyField(Role, blank=True)
offbaord_date = models.DateTimeField(null=True, blank=True)
revoker = models.ForeignKey(
"User",
null=True,
blank=True,
related_name="user_revoker",
on_delete=models.PROTECT,
)
@property
def permissions(self):
""" method to get users all permissions """
user_roles = self.role.all()
user_permissions = [
permission for role in user_roles for permission in role.permission.all()
]
return user_permissions
def has_permission(self, permission_label):
""" method to check if user has permission for permission label """
all_permission_labels = [permission.label for permission in self.permissions]
return permission_label in all_permission_labels
def current_state(self):
""" method to get users current state """
return dict(self.USER_STATUS_CHOICES).get(self.state)
def change_state(self, final_state):
""" method to change users state """
user_states = dict(self.USER_STATUS_CHOICES)
state_key = self.state
for key, state in user_states.items():
if state == final_state:
state_key = key
self.state = state_key
self.save()
def is_an_approver(self, all_approver_permissions):
""" method to check if user is an approver given all approver permissions """
permission_labels = [permission.label for permission in self.permissions]
approver_permissions = all_approver_permissions
return len(list(set(permission_labels) & set(approver_permissions))) > 0
def is_primary_approver_for_module(self, access_module, access_label=None):
""" method to check if user is primary approver for access_module having access_label """
module_permissions = access_module.fetch_approver_permissions(access_label)
return self.has_permission(module_permissions["1"])
def is_secondary_approver_for_module(self, access_module, access_label=None):
""" method to check if user is secondary approver for access_module having access_label """
module_permissions = access_module.fetch_approver_permissions(access_label)
return "2" in module_permissions and self.has_permission(
module_permissions["2"]
)
def is_an_approver_for_module(
self, access_module, access_label=None, approver_type="Primary"
):
"""
method to check if user is an approver for access module
having access label and approver type
"""
if approver_type == "Secondary":
return self.is_secondary_approver_for_module(access_module, access_label)
return self.is_primary_approver_for_module(access_module, access_label)
def get_pending_approvals_count(self, all_access_modules):
""" method to get pending approvals count for all access modules """
pending_count = 0
if self.has_permission(PERMISSION_CONSTANTS["DEFAULT_APPROVER_PERMISSION"]):
pending_count += GroupV2.get_pending_memberships().count()
pending_count += len(GroupV2.get_pending_creation())
for _each_tag, each_access_module in all_access_modules.items():
all_requests = each_access_module.get_pending_access_objects(self)
pending_count += len(all_requests["individual_requests"])
pending_count += len(all_requests["group_requests"])
return pending_count
def get_failed_grants_count(self):
""" method to get failed grants count """
return (
UserAccessMapping.objects.filter(status__in=["GrantFailed"]).count()
if self.is_admin_or_ops()
else 0
)
def get_failed_revokes_count(self):
""" method to get failed revokes count """
return (
UserAccessMapping.objects.filter(status__in=["RevokeFailed"]).count()
if self.is_admin_or_ops()
else 0
)
def get_owned_groups(self):
""" method to get owned group of the user """
if self.is_admin_or_ops():
return GroupV2.objects.all().filter(status="Approved")
group_owner_membership = MembershipV2.objects.filter(is_owner=True, user=self)
return [membership_obj.group for membership_obj in group_owner_membership]
def get_active_groups(self):
""" method to get active groups """
all_active_memberships = self.membership_user.filter(status="Approved")
return [each_membership.group for each_membership in all_active_memberships]
def is_admin_or_ops(self):
""" method to check if user is admin or ops """
return self.is_ops or self.user.is_superuser
def get_all_approved_memberships(self):
""" method to get all approved memberships of the user """
return self.membership_user.filter(status="Approved")
def is_allowed_admin_actions_on_group(self, group):
""" method to check is admin actions allowed on group """
return (
group.member_is_owner(self) or self.is_admin_or_ops()
)
def is_allowed_to_offboard_user_from_group(self, group):
""" method to check if it is allowed to off-board user from group """
return group.member_is_owner(self) or self.has_permission("ALLOW_USER_OFFBOARD")
def create_new_identity(self, access_tag="", identity=""):
""" method to create new identity with access tag """
return self.module_identity.create(access_tag=access_tag, identity=identity)
def get_active_identity(self, access_tag):
""" method to get all active identity of user by access tag """
return self.module_identity.filter(
access_tag=access_tag, status="Active"
).first()
def get_all_active_identity(self):
""" method to get all active identities of the user """
return self.module_identity.filter(status="Active")
def is_active(self):
""" method to check if user is active """
return self.current_state() == "active"
def get_all_memberships(self):
""" method to get all memberships of the user """
return self.membership_user.all()
def get_groups_history(self):
""" method to get groups history """
all_user_membership = self.get_all_memberships()
group_history = []
for each_membership in all_user_membership:
group_access = each_membership.get_membership_details()
if len(group_access) > 1:
group_history.append(group_access)
return group_history
def get_group_access_count(self):
""" method to get group access count """
return self.membership_user.filter(group__status="Approved").count()
def get_user_access_mapping_related_manager(self):
""" method to get user access mapping related manager """
all_user_identities = self.module_identity.order_by('id').reverse()
access_request_mapping_related_manager = []
for each_identity in all_user_identities:
access_request_mapping_related_manager.append(each_identity.user_access_mapping)
return access_request_mapping_related_manager
def get_access_history(self, all_access_modules):
""" method to get access history for all access modules """
access_request_mapping_related_manager = self.get_user_access_mapping_related_manager()
access_history = []
for request_mapping_related_manager in access_request_mapping_related_manager:
all_user_access_mappings = request_mapping_related_manager.order_by('id').reverse()
for each_user_access_mapping in all_user_access_mappings:
access_module = all_access_modules[each_user_access_mapping.access.access_tag]
access_history.\
append(each_user_access_mapping.get_access_request_details(access_module))
return access_history
def get_total_access_count(self):
""" method to get total access count """
return UserAccessMapping.objects.filter(user_identity__user=self).count()
@staticmethod
def get_user_from_username(username):
""" method to get user from username """
try:
return User.objects.get(user__username=username)
except User.DoesNotExist:
return None
def get_accesses_by_access_tag_and_status(self, access_tag, status):
""" method to get accesses by access tag and status """
try:
user_identities = self.module_identity.filter(access_tag=access_tag)
except UserIdentity.DoesNotExist:
return None
return UserAccessMapping.objects.filter(
user_identity__in=user_identities,
access__access_tag=access_tag,
status__in=status,
)
def update_revoker(self, revoker):
""" method to update revoker """
self.revoker = revoker
self.save()
def offboard(self, revoker):
""" method to off-board user by revoker """
self.change_state("offboarding")
self.update_revoker(revoker)
self.offbaord_date = datetime.datetime.now()
self.user.is_active = False
self.save()
def revoke_all_memberships(self):
""" method to revoke all memberships """
self.membership_user.filter(status__in=["Pending", "Approved"]).update(
status="Revoked"
)
def get_or_create_active_identity(self, access_tag):
""" method to get or create active identity for access_tag """
identity, _created = self.module_identity.get_or_create(
access_tag=access_tag, status="Active"
)
return identity
@staticmethod
def get_users_by_emails(emails):
""" method to get users by emails """
return User.objects.filter(email__in=emails)
@staticmethod
def get_user_by_email(email):
""" method to get user by email """
try:
return User.objects.get(email=email)
except User.DoesNotExist:
return None
@staticmethod
def get_active_users_with_permission(permission_label):
""" method to get active users with permission based on permission_label """
try:
return User.objects.filter(
role__permission__label=permission_label, state=1
)
except User.DoesNotExist:
return None
@staticmethod
def get_system_user():
""" method to get system users """
try:
return User.objects.get(user__username="system_user")
except User.DoesNotExist:
django_user = djangoUser.objects.create(username="system_user",
email="[email protected]")
return django_user.user
def get_active_users(self):
""" method to get active users """
return User.objects.filter(state='1').exclude(user=self.user)
def __str__(self):
return f"{self.user}"
def create_user(sender, instance, created, **_kwargs):
"""
create a user when a django user is created
"""
del sender, created
user, _created = User.objects.get_or_create(user=instance)
user.name = instance.first_name
user.email = instance.email
try:
user.avatar = instance.avatar
except Exception:
pass
user.save()
post_save.connect(create_user, sender=djangoUser)
class MembershipV2(models.Model):
"""
Membership of user in a GroupV2
"""
membership_id = models.CharField(
max_length=255, null=False, blank=False, unique=True
)
user = models.ForeignKey(
"User",
null=False,
blank=False,
related_name="membership_user",
on_delete=models.PROTECT,
)
group = models.ForeignKey(
"GroupV2",
null=False,
blank=False,
related_name="membership_group",
on_delete=models.PROTECT,
)
is_owner = models.BooleanField(null=False, blank=False, default=False)
requested_by = models.ForeignKey(
User,
null=False,
blank=False,
related_name="membership_requester",
on_delete=models.PROTECT,
)
requested_on = models.DateTimeField(auto_now_add=True)
updated_on = models.DateTimeField(auto_now=True)
STATUS = (
("Pending", "pending"),
("Approved", "approved"),
("Declined", "declined"),
("Revoked", "revoked"),
)
status = models.CharField(
max_length=255, null=False, blank=False, choices=STATUS, default="Pending"
)
reason = models.TextField(null=True, blank=True)
approver = models.ForeignKey(
"User",
null=True,
blank=True,
related_name="membership_approver",
on_delete=models.PROTECT,
)
decline_reason = models.TextField(null=True, blank=True)
def deactivate(self):
""" method to deactivate request """
self.status = "Revoked"
self.save()
def approve(self, approver):
""" method to approve membership """
self.status = "Approved"
self.approver = approver
self.save()
def unapprove(self):
""" method to un-approve membership """
self.status = "Pending"
self.approver = None
self.save()
def get_status(self):
""" method to get status """
return self.status
def is_self_approval(self, approver):
""" method to check is self-approval """
return self.requested_by == approver
def is_pending(self):
""" method to check is status Pending """
return self.status == "Pending"
@staticmethod
def approve_membership(membership_id, approver):
""" method to approve membership """
membership = MembershipV2.objects.get(membership_id=membership_id)
membership.approve(approver=approver)
def decline(self, reason, decliner):
""" method to decline request """
self.status = "Declined"
self.decline_reason = reason
self.approver = decliner
self.save()
def is_already_processed(self):
""" method to check is request already processed """
return self.status in ["Declined", "Approved", "Processing", "Revoked"]
def revoke_membership(self):
""" method to revoke membership """
self.status = "Revoked"
self.save()
@staticmethod
def update_membership(group, reason):
""" method to update membership """
membership = MembershipV2.objects.filter(group=group)
membership.update(status="Declined", decline_reason=reason)
def get_membership_details(self):
""" method to get membership details """
access_request_data = {}
if self.group.status == "Approved":
access_request_data["group_id"] = self.group.group_id
access_request_data["name"] = self.group.name
access_request_data["status"] = self.status
access_request_data["role"] = "Owner" if self.is_owner else "Member"
return access_request_data
@staticmethod
def get_membership(membership_id):
""" method to get membership by membership id """
try:
return MembershipV2.objects.get(membership_id=membership_id)
except MembershipV2.DoesNotExist:
return None
def __str__(self):
return self.group.name + "-" + self.user.email + "-" + self.status
class GroupV2(models.Model):
"""
Model for Enigma Groups redefined.
"""
group_id = models.CharField(max_length=255, null=False, blank=False, unique=True)
requested_on = models.DateTimeField(auto_now_add=True)
updated_on = models.DateTimeField(auto_now=True)
name = models.CharField(max_length=128, null=False, blank=False, unique=True)
description = models.TextField(null=False, blank=False)
requester = models.ForeignKey(
"User",
null=True,
blank=True,
related_name="group_requester",
on_delete=models.PROTECT,
)
STATUS = (
("Pending", "pending"),
("Approved", "approved"),
("Declined", "declined"),
("Deprecated", "deprecated"),
)
status = models.CharField(
max_length=255, null=False, blank=False, choices=STATUS, default="Pending"
)
approver = models.ForeignKey(
"User",
null=True,
blank=True,
related_name="group_approver",
on_delete=models.PROTECT,
)
decline_reason = models.TextField(null=True, blank=True)
needsAccessApprove = models.BooleanField(null=False, blank=False, default=True)
@staticmethod
def group_exists(group_name):
""" method to check if group exists by group name """
if GroupV2.objects.filter(name=group_name):
return True
return False
@staticmethod
def create(
name="", requester=None, description="", needs_access_approve=True, date_time=""
):
""" method to create group """
return GroupV2.objects.create(
name=name,
group_id=name + "-group-" + date_time,
requester=requester,
description=description,
needsAccessApprove=needs_access_approve,
)
def add_member(
self, user=None, is_owner=False, requested_by=None, reason="", date_time=""
):
""" method to add member in the group """
membership_id = (
str(user.user.username) + "-" + self.name + "-membership-" + date_time
)
return self.membership_group.create(
membership_id=membership_id,
user=user,
is_owner=is_owner,
requested_by=requested_by,
reason=reason,
)
def add_members(self, users=None, requested_by=None, reason="", date_time=""):
""" method to add members """
if users:
for usr in users:
self.add_member(
user=usr,
requested_by=requested_by,
reason=reason,
date_time=date_time,
)
@staticmethod
def get_pending_memberships():
""" method to get pending memberships """
return MembershipV2.objects.filter(status="Pending", group__status="Approved")
def is_already_processed(self):
""" method to check if status is already processed """
return self.status in ['Declined', 'Approved', 'Processing', 'Revoked']
def decline_access(self, decline_reason=None):
""" method to get decline access """
self.status = "Declined"
self.decline_reason = decline_reason
self.save()
@staticmethod
def get_pending_creation():
""" method to get pending creation """
new_group_pending = GroupV2.objects.filter(status="Pending")
new_group_pending_data = []
for new_group in new_group_pending:
initial_members = ", ".join(
list(
new_group.membership_group.values_list(
"user__user__username", flat=True
)
)
)
new_group_pending_data.append(
{"groupRequest": new_group, "initialMembers": initial_members}
)
return new_group_pending_data
@staticmethod
def get_pending_group(group_id):
""" method to get pending group """
try:
return GroupV2.objects.get(group_id=group_id, status="Pending")
except GroupV2.DoesNotExist:
return None
@staticmethod
def get_approved_group(group_id):
""" method to get approved group """
try:
return GroupV2.objects.get(group_id=group_id, status="Approved")
except GroupV2.DoesNotExist:
return None
@staticmethod
def get_active_group_by_name(group_name):
""" method to get active group by name """
try:
return GroupV2.objects.get(name=group_name, status="Approved")
except GroupV2.DoesNotExist:
return None
@staticmethod
def get_approved_group_by_name(group_name):
""" method to get approved group by name """
try:
return GroupV2.objects.filter(name=group_name, status="Approved").first()
except GroupV2.DoesNotExist:
return None
def approve_all_pending_users(self, approved_by):
""" method to approve all pending users """
self.membership_group.filter(status="Pending").update(
status="Approved", approver=approved_by
)
def get_all_members(self):
""" method to get all members """
group_members = self.membership_group.all()
return group_members
def get_approved_and_pending_member_emails(self):
""" method to get approved and pending members emails """
group_member_emails = self.membership_group.filter(
status__in=["Approved", "Pending"]
).values_list("user__email", flat=True)
return group_member_emails
def member_is_owner(self, user):
""" method to check if member is owner of the group """
try:
membership = self.membership_group.get(user=user)
except MembershipV2.DoesNotExist:
return False
return membership.is_owner
def get_active_accesses(self):
""" method to get active accesses """
return self.group_access_mapping.filter(
status__in=["Approved", "Pending", "Declined", "SecondaryPending"]
)
def get_group_access_count(self):
""" method to get group access count """
return self.get_active_accesses().count()
def is_self_approval(self, approver):
""" method to check it is self-approval """
return self.requester == approver
def approve(self, approved_by):
""" method ot approve """
self.approver = approved_by
self.status = "Approved"
self.save()
def unapprove(self):
""" method ot un-approve """
self.approver = None
self.status = "Pending"
self.save()
def unapprove_memberships(self):
""" method to un-approve memberships """
self.membership_group.filter(status="Approved").update(
status="Pending", approver=None
)
def is_owner_by_user(self, user):
""" method to check if user is owner """
return (
self.membership_group.filter(is_owner=True)
.filter(user=user)
.first()
is not None
)
def add_access(self, request_id, requested_by, request_reason, access):
""" method to add access """
self.group_access_mapping.create(
request_id=request_id,
requested_by=requested_by,
request_reason=request_reason,
access=access,
)
def check_access_exist(self, access):
""" method to if access exist """
try:
self.group_access_mapping.get(access=access, status__in=["Approved"])
return True
except GroupAccessMapping.DoesNotExist:
return False
def access_mapping_exists(self, access):
""" method to check access mapping exists """
try:
self.group_access_mapping.get(access=access, status__in=["Approved", "Pending"])
return True
except GroupAccessMapping.DoesNotExist:
return False
def get_all_approved_members(self):
""" method to get all approved members """
return self.membership_group.filter(status="Approved")
def get_approved_accesses(self):
""" method to get approved accesses """
return self.group_access_mapping.filter(status="Approved")
def is_owner(self, email):
""" method to check if user is owner based on email """
return (
self.membership_group.filter(is_owner=True)
.filter(user__email=email)
.first()
is not None
)
def __str__(self):
return str(self.name)
class UserAccessMapping(models.Model):
"""
Model to map access to user. Requests are broken down
into mappings which are sent for approval.
"""
request_id = models.CharField(max_length=255, null=False, blank=False, unique=True)
requested_on = models.DateTimeField(auto_now_add=True)
approved_on = models.DateTimeField(null=True, blank=True)
updated_on = models.DateTimeField(auto_now=True)
request_reason = models.TextField(null=False, blank=False)
approver_1 = models.ForeignKey(
"User",
null=True,
blank=True,
related_name="approver_1",
on_delete=models.PROTECT,
)
approver_2 = models.ForeignKey(
"User",
null=True,
blank=True,
related_name="approver_2",
on_delete=models.PROTECT,
)
access = models.ForeignKey(
"AccessV2", null=False, blank=False, on_delete=models.PROTECT
)
STATUS_CHOICES = (
("Pending", "pending"),
("SecondaryPending", "secondarypending"),
("Processing", "processing"),
("Approved", "approved"),
("GrantFailed", "grantfailed"),
("Declined", "declined"),
("Offboarding", "offboarding"),
("ProcessingRevoke", "processingrevoke"),
("RevokeFailed", "revokefailed"),
("Revoked", "revoked"),
)
status = models.CharField(
max_length=100,
null=False,
blank=False,
choices=STATUS_CHOICES,
default="Pending",
)
decline_reason = models.TextField(null=True, blank=True)
fail_reason = models.TextField(null=True, blank=True)
TYPE_CHOICES = (("Individual", "individual"), ("Group", "group"))
access_type = models.CharField(
max_length=255,
null=False,
blank=False,
choices=TYPE_CHOICES,
default="Individual",
)
revoker = models.ForeignKey(
"User",
null=True,
blank=True,
related_name="user_access_revoker",
on_delete=models.PROTECT,
)
meta_data = models.JSONField(default=dict, blank=True, null=True)
user_identity = models.ForeignKey(
"UserIdentity",
null=True,
blank=True,
related_name="user_access_mapping",
on_delete=models.PROTECT,
)
def __str__(self):
return str(self.request_id)
# Wrote the override version of save method in order to update the
# "approved_on" field whenever the request is marked "Approved"
def save(self, *args, **kwargs):
""" method to save UserAccessMapping request """
super().save(*args, **kwargs)
# Consider only the first cycle of approval
if self.status.lower() == "approved" and self.approved_on in [None, ""]:
self.approved_on = self.updated_on
super().save(*args, **kwargs)
@staticmethod
def get_access_request(request_id):
""" method to get access request """
try:
return UserAccessMapping.objects.get(request_id=request_id)
except UserAccessMapping.DoesNotExist:
return None
def get_access_request_details(self, access_module):
""" method to get access request details """
access_request_data = {}
access_tags = [self.access.access_tag]
access_labels = [self.access.access_label]
access_tag = access_tags[0]
# code metadata
access_request_data["access_tag"] = access_tag
# ui metadata
access_request_data["user"] = self.user_identity.user.name
access_request_data["userEmail"] = self.user_identity.user.email
access_request_data["requestId"] = self.request_id
access_request_data["accessReason"] = self.request_reason
access_request_data["requested_on"] = self.requested_on
access_request_data["access_desc"] = access_module.access_desc()
access_request_data["accessCategory"] = access_module.combine_labels_desc(
access_labels
)
access_request_data["accessMeta"] = access_module.combine_labels_meta(
access_labels
)
access_request_data["access_label"] = [
key + "-" + str(val).strip("[]")
for key, val in list(self.access.access_label.items())
if key != "keySecret"
]
access_request_data["access_type"] = self.access_type
access_request_data["approver_1"] = (
self.approver_1.user.username if self.approver_1 else ""
)
access_request_data["approver_2"] = (
self.approver_2.user.username if self.approver_2 else ""
)
access_request_data["approved_on"] = (
self.approved_on if self.approved_on else ""
)
access_request_data["updated_on"] = (
str(self.updated_on)[:19] + "UTC" if self.updated_on else ""
)
access_request_data["status"] = self.status
access_request_data["revoker"] = (
self.revoker.user.username if self.revoker else ""
)
access_request_data["offboarding_date"] = (
str(self.user_identity.user.offbaord_date)[:19] + "UTC"
if self.user_identity.user.offbaord_date
else ""
)
access_request_data["revokeOwner"] = ",".join(access_module.revoke_owner())
access_request_data["grantOwner"] = ",".join(access_module.grant_owner())
access_request_data["accessRequestType"] = self.access_type
return access_request_data
def update_meta_data(self, key, data):
""" method to update metadata """
with transaction.atomic():
setattr(self.meta_data, key, data)
self.save()
return True
def revoke(self, revoker=None):
""" method to revoke access mapping """
self.status = "Revoked"
if revoker:
self.revoker = revoker
self.save()
@staticmethod
def get_accesses_not_declined():
""" method to get accesses excluding the ones with declined status """
return UserAccessMapping.objects.exclude(status="Declined")
@staticmethod
def get_unrevoked_accesses_by_request_id(request_id):
""" method to get un-revoked access by request id """
return UserAccessMapping.objects.filter(request_id=request_id).exclude(
status="Revoked"