Skip to content

permissions#

DatasetAccessPolicy#

Bases: BaseAccessPolicy

Source code in src/apps/core/permissions.py 
 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
class DatasetAccessPolicy(BaseAccessPolicy):
    statements = [
        {
            "action": [
                "update",
                "destroy",
                "partial_update",
                "new_version",
                "create_draft",
                "publish",
            ],
            "principal": "authenticated",
            "effect": "allow",
            "condition": "is_edit_allowed",
        },
        {
            "action": ["convert_from_legacy", "contact"],
            "principal": "*",
            "effect": "allow",
        },
        {
            "action": ["create_preservation_version"],
            "principal": "group:pas",
            "effect": "allow",
        },
        {
            # Note that there is no actual "download" action in the viewset
            "action": ["<op:download>"],
            "principal": "*",
            "effect": "allow",
            "condition": "is_download_allowed",
        },
        {
            "action": ["<op:custom_metadata_owner>"],
            "principal": "group:service",
            "effect": "allow",
        },
        {
            "action": ["<op:flush>"],  # hard delete dataset
            "effect": "allow",
            "principal": "authenticated",
            "condition": ["is_edit_allowed", "is_flush_allowed"],
        },
        {
            "action": ["create"],
            "principal": "authenticated",
            "effect": "allow",  # Catalog permission checked in viewset perform_create
        },
    ] + BaseAccessPolicy.statements

    def is_edit_allowed(self, request, view, action) -> bool:
        dataset = view.get_object()
        return dataset.has_permission_to_edit(request.user)

    def is_flush_allowed(self, request, view, action) -> bool:
        dataset = view.get_object()
        if dataset.state == "draft":
            return True  # Drafts are always hard deleted
        if catalog := dataset.data_catalog:
            # Hard delete is allowed for catalog admins in harvested catalogs
            return catalog.harvested and DataCatalogAccessPolicy().query_object_permission(
                user=request.user, object=catalog, action="<op:admin_dataset>"
            )
        return False

    def is_metadata_owner(self, request, view, action) -> bool:
        dataset = view.get_object()
        logger.info(request.user)
        if dataset.metadata_owner:
            return request.user == dataset.metadata_owner.user
        else:
            return False

    def is_download_allowed(self, request, view, action) -> bool:
        dataset = view.get_object()
        if access_rights := dataset.access_rights:
            return access_rights.is_data_available(request, dataset)
        return False

    @classmethod
    def scope_queryset(cls, request, queryset):
        from .models import Dataset

        if (q := super().scope_queryset(request, queryset)) is not None:
            return q
        elif request.user.is_anonymous:
            return queryset.filter(state=Dataset.StateChoices.PUBLISHED)
        groups = request.user.groups.all()
        return queryset.filter(
            Q(state=Dataset.StateChoices.PUBLISHED)
            | Q(metadata_owner__user=request.user)
            | Q(system_creator=request.user)
            | Q(permissions__editors=request.user)
            | Q(file_set__storage__csc_project__in=request.user.csc_projects)
            | Q(data_catalog__dataset_groups_admin__in=groups)
        ).distinct()

    @classmethod
    def scope_queryset_owned_or_shared(cls, request, queryset):
        from .models import Dataset

        if request.user.is_anonymous:
            return Dataset.available_objects.none()
        return queryset.filter(
            Q(metadata_owner__user=request.user)
            | Q(permissions__editors=request.user)
            | Q(file_set__storage__csc_project__in=request.user.csc_projects)
        ).distinct()

DataCatalogAccessPolicy#

Bases: BaseAccessPolicy

Source code in src/apps/core/permissions.py 
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
class DataCatalogAccessPolicy(BaseAccessPolicy):
    statements = [
        {
            "action": ["create"],
            "principal": "group:service",
            "effect": "allow",
        },
        {
            "action": ["update", "partial_update", "destroy"],
            "principal": "group:service",
            "effect": "allow",
            "condition": "is_system_creator",
        },
        {
            "action": ["<op:create_dataset>"],
            "principal": "authenticated",
            "effect": "allow",
            "condition": "is_creating_datasets_allowed",
        },
        {
            "action": ["<op:admin_dataset>"],
            "principal": "authenticated",
            "effect": "allow",
            "condition": "is_dataset_admin",
        },
    ] + BaseAccessPolicy.statements

    def is_creating_datasets_allowed(self, request, view, action) -> bool:
        """Return True if user is allowed to create datasets in this catalog."""
        user = request.user
        if user.is_superuser:
            return True

        catalog = view.get_object()
        user_groups = user.groups.all()
        return catalog.dataset_groups_create.intersection(user_groups).exists()

    def is_dataset_admin(self, request, view, action) -> bool:
        """Return True if user is allowed to edit all datasets in this catalog."""
        user = request.user
        if user.is_superuser:
            return True

        # This function is often called multiple times per dataset listing request.
        # Optimize by using prefetched values instead of making a new intersection query here.
        catalog = view.get_object()
        catalog_admin_groups = set(catalog.dataset_groups_admin.all())
        user_groups = user.groups.all()
        return any(group in catalog_admin_groups for group in user_groups)

is_creating_datasets_allowed(request, view, action) #

Return True if user is allowed to create datasets in this catalog.

Source code in src/apps/core/permissions.py 
147
148
149
150
151
152
153
154
155
def is_creating_datasets_allowed(self, request, view, action) -> bool:
    """Return True if user is allowed to create datasets in this catalog."""
    user = request.user
    if user.is_superuser:
        return True

    catalog = view.get_object()
    user_groups = user.groups.all()
    return catalog.dataset_groups_create.intersection(user_groups).exists()

is_dataset_admin(request, view, action) #

Return True if user is allowed to edit all datasets in this catalog.

Source code in src/apps/core/permissions.py 
157
158
159
160
161
162
163
164
165
166
167
168
def is_dataset_admin(self, request, view, action) -> bool:
    """Return True if user is allowed to edit all datasets in this catalog."""
    user = request.user
    if user.is_superuser:
        return True

    # This function is often called multiple times per dataset listing request.
    # Optimize by using prefetched values instead of making a new intersection query here.
    catalog = view.get_object()
    catalog_admin_groups = set(catalog.dataset_groups_admin.all())
    user_groups = user.groups.all()
    return any(group in catalog_admin_groups for group in user_groups)

LegacyDatasetAccessPolicy#

Bases: BaseAccessPolicy

Source code in src/apps/core/permissions.py 
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
class LegacyDatasetAccessPolicy(BaseAccessPolicy):
    statements = [
        {
            "action": ["create", "update", "partial_update", "destroy"],
            "principal": "group:v2_migration",
            "effect": "allow",
        },
    ] + BaseAccessPolicy.statements

    @classmethod
    def scope_queryset(cls, request, queryset):
        from .models import Dataset

        if (q := super().scope_queryset(request, queryset)) is not None:
            return q
        elif request.user.groups.filter(name="v2_migration").exists():
            return queryset.all()

        # Only public datasets are visible for normal users
        return queryset.filter(dataset_json__state=Dataset.StateChoices.PUBLISHED)

DatasetNestedAccessPolicy#

Bases: BaseAccessPolicy

Source code in src/apps/core/permissions.py 
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
class DatasetNestedAccessPolicy(BaseAccessPolicy):
    statements = [
        {
            "action": ["create", "update", "partial_update", "destroy"],
            "principal": "authenticated",
            "effect": "allow",
            "condition": "is_dataset_editor",
        },
    ] + BaseAccessPolicy.statements

    def is_dataset_editor(self, request, view, action) -> bool:
        from .models import Dataset

        dataset: Dataset = view.get_dataset_instance()
        return dataset.has_permission_to_edit(request.user)

DatasetPermissionsAccessPolicy#

Bases: DatasetNestedAccessPolicy

Dataset permissions are viewable only by users who can edit the dataset.

Source code in src/apps/core/permissions.py 
210
211
212
213
214
215
216
217
218
219
220
class DatasetPermissionsAccessPolicy(DatasetNestedAccessPolicy):
    """Dataset permissions are viewable only by users who can edit the dataset."""

    statements = [
        {
            "action": ["list", "retrieve", "create", "update", "partial_update", "destroy"],
            "principal": "authenticated",
            "effect": "allow",
            "condition": "is_dataset_editor",
        },
    ] + BaseAccessPolicy.admin_statements

ContractAccessPolicy#

Bases: BaseAccessPolicy

Source code in src/apps/core/permissions.py 
223
224
225
226
227
228
229
230
231
232
233
234
235
class ContractAccessPolicy(BaseAccessPolicy):
    statements = [
        {
            "action": ["*"],
            "principal": "group:pas",
            "effect": "allow",
        },
        {
            "action": ["from_legacy"],
            "principal": "group:v2_migration",
            "effect": "allow",
        },
    ] + BaseAccessPolicy.statements