summaryrefslogtreecommitdiffstats
path: root/compass-tasks-base/db/api/permission.py
blob: f4d777a2154f80be0ce5fb9cca453c43609588e0 (plain)
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
# Copyright 2014 Huawei Technologies Co. Ltd
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

"""Permission database operations."""
import re

from compass.db.api import database
from compass.db.api import user as user_api
from compass.db.api import utils
from compass.db import exception
from compass.db import models
from compass.utils import util


SUPPORTED_FIELDS = ['id', 'name', 'alias', 'description']
RESP_FIELDS = ['id', 'name', 'alias', 'description']


class PermissionWrapper(object):
    def __init__(self, name, alias, description):
        self.name = name
        self.alias = alias
        self.description = description

    def to_dict(self):
        return {
            'name': self.name,
            'alias': self.alias,
            'description': self.description
        }


PERMISSION_LIST_PERMISSIONS = PermissionWrapper(
    'list_permissions', 'list permissions', 'list all permissions'
)
PERMISSION_LIST_SWITCHES = PermissionWrapper(
    'list_switches', 'list switches', 'list all switches'
)
PERMISSION_LIST_SWITCH_FILTERS = PermissionWrapper(
    'list_switch_filters',
    'list switch filters',
    'list switch filters'
)
PERMISSION_ADD_SWITCH = PermissionWrapper(
    'add_switch', 'add switch', 'add switch'
)
PERMISSION_UPDATE_SWITCH_FILTERS = PermissionWrapper(
    'update_switch_filters',
    'update switch filters',
    'update switch filters'
)
PERMISSION_DEL_SWITCH = PermissionWrapper(
    'delete_switch', 'delete switch', 'delete switch'
)
PERMISSION_LIST_SWITCH_MACHINES = PermissionWrapper(
    'list_switch_machines', 'list switch machines', 'list switch machines'
)
PERMISSION_ADD_SWITCH_MACHINE = PermissionWrapper(
    'add_switch_machine', 'add switch machine', 'add switch machine'
)
PERMISSION_DEL_SWITCH_MACHINE = PermissionWrapper(
    'del_switch_machine', 'delete switch machine', 'del switch machine'
)
PERMISSION_UPDATE_SWITCH_MACHINES = PermissionWrapper(
    'update_switch_machines',
    'update switch machines',
    'update switch machines'
)
PERMISSION_LIST_MACHINES = PermissionWrapper(
    'list_machines', 'list machines', 'list machines'
)
PERMISSION_ADD_MACHINE = PermissionWrapper(
    'add_machine', 'add machine', 'add machine'
)
PERMISSION_DEL_MACHINE = PermissionWrapper(
    'delete_machine', 'delete machine', 'delete machine'
)
PERMISSION_LIST_ADAPTERS = PermissionWrapper(
    'list_adapters', 'list adapters', 'list adapters'
)
PERMISSION_LIST_METADATAS = PermissionWrapper(
    'list_metadatas', 'list metadatas', 'list metadatas'
)
PERMISSION_LIST_SUBNETS = PermissionWrapper(
    'list_subnets', 'list subnets', 'list subnets'
)
PERMISSION_ADD_SUBNET = PermissionWrapper(
    'add_subnet', 'add subnet', 'add subnet'
)
PERMISSION_DEL_SUBNET = PermissionWrapper(
    'del_subnet', 'del subnet', 'del subnet'
)
PERMISSION_LIST_CLUSTERS = PermissionWrapper(
    'list_clusters', 'list clusters', 'list clusters'
)
PERMISSION_ADD_CLUSTER = PermissionWrapper(
    'add_cluster', 'add cluster', 'add cluster'
)
PERMISSION_DEL_CLUSTER = PermissionWrapper(
    'del_cluster', 'del cluster', 'del cluster'
)
PERMISSION_LIST_CLUSTER_CONFIG = PermissionWrapper(
    'list_cluster_config', 'list cluster config', 'list cluster config'
)
PERMISSION_ADD_CLUSTER_CONFIG = PermissionWrapper(
    'add_cluster_config', 'add cluster config', 'add cluster config'
)
PERMISSION_DEL_CLUSTER_CONFIG = PermissionWrapper(
    'del_cluster_config', 'del cluster config', 'del cluster config'
)
PERMISSION_UPDATE_CLUSTER_HOSTS = PermissionWrapper(
    'update_cluster_hosts',
    'update cluster hosts',
    'update cluster hosts'
)
PERMISSION_DEL_CLUSTER_HOST = PermissionWrapper(
    'del_clusterhost', 'delete clusterhost', 'delete clusterhost'
)
PERMISSION_REVIEW_CLUSTER = PermissionWrapper(
    'review_cluster', 'review cluster', 'review cluster'
)
PERMISSION_DEPLOY_CLUSTER = PermissionWrapper(
    'deploy_cluster', 'deploy cluster', 'deploy cluster'
)
PERMISSION_DEPLOY_HOST = PermissionWrapper(
    'deploy_host', 'deploy host', 'deploy host'
)
PERMISSION_GET_CLUSTER_STATE = PermissionWrapper(
    'get_cluster_state', 'get cluster state', 'get cluster state'
)
PERMISSION_UPDATE_CLUSTER_STATE = PermissionWrapper(
    'update_cluster_state', 'update cluster state',
    'update cluster state'
)
PERMISSION_LIST_HOSTS = PermissionWrapper(
    'list_hosts', 'list hosts', 'list hosts'
)
PERMISSION_LIST_HOST_CLUSTERS = PermissionWrapper(
    'list_host_clusters',
    'list host clusters',
    'list host clusters'
)
PERMISSION_UPDATE_HOST = PermissionWrapper(
    'update_host', 'update host', 'update host'
)
PERMISSION_DEL_HOST = PermissionWrapper(
    'del_host', 'del host', 'del host'
)
PERMISSION_LIST_HOST_CONFIG = PermissionWrapper(
    'list_host_config', 'list host config', 'list host config'
)
PERMISSION_ADD_HOST_CONFIG = PermissionWrapper(
    'add_host_config', 'add host config', 'add host config'
)
PERMISSION_DEL_HOST_CONFIG = PermissionWrapper(
    'del_host_config', 'del host config', 'del host config'
)
PERMISSION_LIST_HOST_NETWORKS = PermissionWrapper(
    'list_host_networks',
    'list host networks',
    'list host networks'
)
PERMISSION_ADD_HOST_NETWORK = PermissionWrapper(
    'add_host_network', 'add host network', 'add host network'
)
PERMISSION_DEL_HOST_NETWORK = PermissionWrapper(
    'del_host_network', 'del host network', 'del host network'
)
PERMISSION_GET_HOST_STATE = PermissionWrapper(
    'get_host_state', 'get host state', 'get host state'
)
PERMISSION_UPDATE_HOST_STATE = PermissionWrapper(
    'update_host_state', 'update host sate', 'update host state'
)
PERMISSION_LIST_CLUSTERHOSTS = PermissionWrapper(
    'list_clusterhosts', 'list cluster hosts', 'list cluster hosts'
)
PERMISSION_LIST_CLUSTERHOST_CONFIG = PermissionWrapper(
    'list_clusterhost_config',
    'list clusterhost config',
    'list clusterhost config'
)
PERMISSION_ADD_CLUSTERHOST_CONFIG = PermissionWrapper(
    'add_clusterhost_config',
    'add clusterhost config',
    'add clusterhost config'
)
PERMISSION_DEL_CLUSTERHOST_CONFIG = PermissionWrapper(
    'del_clusterhost_config',
    'del clusterhost config',
    'del clusterhost config'
)
PERMISSION_GET_CLUSTERHOST_STATE = PermissionWrapper(
    'get_clusterhost_state',
    'get clusterhost state',
    'get clusterhost state'
)
PERMISSION_UPDATE_CLUSTERHOST_STATE = PermissionWrapper(
    'update_clusterhost_state',
    'update clusterhost state',
    'update clusterhost state'
)
PERMISSION_LIST_HEALTH_REPORT = PermissionWrapper(
    'list_health_reports',
    'list health check report',
    'list health check report'
)
PERMISSION_GET_HEALTH_REPORT = PermissionWrapper(
    'get_health_report',
    'get health report',
    'get health report'
)
PERMISSION_CHECK_CLUSTER_HEALTH = PermissionWrapper(
    'start_check_cluster_health',
    'start check cluster health',
    'start check cluster health'
)
PERMISSION_SET_HEALTH_CHECK_ERROR = PermissionWrapper(
    'set_error_state',
    'set health check into error state',
    'set health check into error state'
)
PERMISSION_DELETE_REPORT = PermissionWrapper(
    'delete_reports',
    'delete health reports',
    'delete health reports'
)
PERMISSIONS = [
    PERMISSION_LIST_PERMISSIONS,
    PERMISSION_LIST_SWITCHES,
    PERMISSION_ADD_SWITCH,
    PERMISSION_DEL_SWITCH,
    PERMISSION_LIST_SWITCH_FILTERS,
    PERMISSION_UPDATE_SWITCH_FILTERS,
    PERMISSION_LIST_SWITCH_MACHINES,
    PERMISSION_ADD_SWITCH_MACHINE,
    PERMISSION_DEL_SWITCH_MACHINE,
    PERMISSION_UPDATE_SWITCH_MACHINES,
    PERMISSION_LIST_MACHINES,
    PERMISSION_ADD_MACHINE,
    PERMISSION_DEL_MACHINE,
    PERMISSION_LIST_ADAPTERS,
    PERMISSION_LIST_METADATAS,
    PERMISSION_LIST_SUBNETS,
    PERMISSION_ADD_SUBNET,
    PERMISSION_DEL_SUBNET,
    PERMISSION_LIST_CLUSTERS,
    PERMISSION_ADD_CLUSTER,
    PERMISSION_DEL_CLUSTER,
    PERMISSION_LIST_CLUSTER_CONFIG,
    PERMISSION_ADD_CLUSTER_CONFIG,
    PERMISSION_DEL_CLUSTER_CONFIG,
    PERMISSION_UPDATE_CLUSTER_HOSTS,
    PERMISSION_DEL_CLUSTER_HOST,
    PERMISSION_REVIEW_CLUSTER,
    PERMISSION_DEPLOY_CLUSTER,
    PERMISSION_GET_CLUSTER_STATE,
    PERMISSION_UPDATE_CLUSTER_STATE,
    PERMISSION_LIST_HOSTS,
    PERMISSION_LIST_HOST_CLUSTERS,
    PERMISSION_UPDATE_HOST,
    PERMISSION_DEL_HOST,
    PERMISSION_LIST_HOST_CONFIG,
    PERMISSION_ADD_HOST_CONFIG,
    PERMISSION_DEL_HOST_CONFIG,
    PERMISSION_LIST_HOST_NETWORKS,
    PERMISSION_ADD_HOST_NETWORK,
    PERMISSION_DEL_HOST_NETWORK,
    PERMISSION_GET_HOST_STATE,
    PERMISSION_UPDATE_HOST_STATE,
    PERMISSION_DEPLOY_HOST,
    PERMISSION_LIST_CLUSTERHOSTS,
    PERMISSION_LIST_CLUSTERHOST_CONFIG,
    PERMISSION_ADD_CLUSTERHOST_CONFIG,
    PERMISSION_DEL_CLUSTERHOST_CONFIG,
    PERMISSION_GET_CLUSTERHOST_STATE,
    PERMISSION_UPDATE_CLUSTERHOST_STATE,
    PERMISSION_LIST_HEALTH_REPORT,
    PERMISSION_GET_HEALTH_REPORT,
    PERMISSION_CHECK_CLUSTER_HEALTH,
    PERMISSION_SET_HEALTH_CHECK_ERROR,
    PERMISSION_DELETE_REPORT
]


@util.deprecated
def list_permissions_internal(session, **filters):
    """internal functions used only by other db.api modules."""
    return utils.list_db_objects(session, models.Permission, **filters)


@utils.supported_filters(optional_support_keys=SUPPORTED_FIELDS)
@database.run_in_session()
@user_api.check_user_permission(PERMISSION_LIST_PERMISSIONS)
@utils.wrap_to_dict(RESP_FIELDS)
def list_permissions(user=None, session=None, **filters):
    """list permissions."""
    return utils.list_db_objects(
        session, models.Permission, **filters
    )


def _get_permission(permission_id, session=None, **kwargs):
    """Get permission object by the unique key of Permission table."""
    if isinstance(permission_id, (int, long)):
        return utils.get_db_object(
            session, models.Permission, id=permission_id, **kwargs)
    raise exception.InvalidParameter(
        'permission id %s type is not int compatible' % permission_id
    )


def get_permission_internal(permission_id, session=None, **kwargs):
    return _get_permission(permission_id, session=session, **kwargs)


@utils.supported_filters()
@database.run_in_session()
@user_api.check_user_permission(PERMISSION_LIST_PERMISSIONS)
@utils.wrap_to_dict(RESP_FIELDS)
def get_permission(
    permission_id, exception_when_missing=True,
    user=None, session=None, **kwargs
):
    """get permissions."""
    return _get_permission(
        permission_id, session=session,
        exception_when_missing=exception_when_missing
    )


def add_permissions_internal(session=None):
    """internal functions used by other db.api modules only."""
    permissions = []
    for permission in PERMISSIONS:
        permissions.append(
            utils.add_db_object(
                session, models.Permission,
                True,
                permission.name,
                alias=permission.alias,
                description=permission.description
            )
        )

    return permissions