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
|
# Software Name: MOON
# Version: 5.4
# SPDX-FileCopyrightText: Copyright (c) 2018-2020 Orange and its contributors
# SPDX-License-Identifier: Apache-2.0
# This software is distributed under the 'Apache License 2.0',
# the text of which is available at 'http://www.apache.org/licenses/LICENSE-2.0.txt'
# or see the "LICENSE" file for more details.
"""
Policies are instances of security models and implement security policies
"""
import hug
import logging
import requests
from moon_manager.api import ERROR_CODE
from moon_utilities.auth_functions import api_key_authentication, connect_from_env
from moon_manager import db_driver
from moon_utilities import exceptions
from moon_utilities.security_functions import validate_input
from moon_utilities.invalided_functions import invalidate_policy_in_slaves
from moon_manager.api import slave as slave_class
from moon_manager.api import configuration
LOGGER = logging.getLogger("moon.manager.api." + __name__)
class Policies(object):
"""
Endpoint for policy requests
"""
@staticmethod
@hug.local()
@hug.get("/policies/", requires=api_key_authentication)
@hug.get("/policies/{uuid}", requires=api_key_authentication)
def get(uuid: hug.types.uuid = None, authed_user: hug.directives.user = None):
"""Retrieve all policies
:param uuid: uuid of the policy
:param authed_user: the name of the authenticated user
:return: {
"policy_id1": {
"name": "name of the policy (mandatory)",
"model_id": "ID of the model linked to this policy",
"genre": "authz of admin (optional, default to authz)",
"description": "description of the policy (optional)",
}
}
"""
if uuid:
uuid = str(uuid).replace("-", "")
data = db_driver.PolicyManager.get_policies(moon_user_id=authed_user, policy_id=uuid)
return {"policies": data}
@staticmethod
@hug.local()
@hug.post("/policies/", requires=api_key_authentication)
def post(body: validate_input("name"), response, authed_user: hug.directives.user = None):
"""Create policy.
:param body: preformed body from Hug
:param response: preformed response from Hug
:param authed_user: the name of the authenticated user
:request body: {
"name": "name of the policy (mandatory)",
"model_id": "ID of the model linked to this policy",
"genre": "authz of admin (optional, default to authz)",
"description": "description of the policy (optional)",
}
:return: {
"policy_id1": {
"name": "name of the policy (mandatory)",
"model_id": "ID of the model linked to this policy",
"genre": "authz of admin (optional, default to authz)",
"description": "description of the policy (optional)",
}
}
"""
data = db_driver.PolicyManager.add_policy(
moon_user_id=authed_user, policy_id=None, value=body)
return {"policies": data}
@staticmethod
@hug.local()
@hug.delete("/policies/{uuid}", requires=api_key_authentication)
def delete(uuid: hug.types.text, response=None, authed_user: hug.directives.user = None):
"""Delete a policy
:param uuid: uuid of the policy to delete
:param response: preformed response from Hug
:param authed_user: the name of the authenticated user
:return: {
"result": "True or False",
"message": "optional message (optional)"
}
"""
uuid = str(uuid).replace("-", "")
db_driver.PolicyManager.delete_policy(
moon_user_id=authed_user, policy_id=uuid)
slaves = slave_class.Slaves.get().get("slaves")
invalidate_policy_in_slaves(slaves=slaves, policy_id=uuid)
return {"result": True}
@staticmethod
@hug.local()
@hug.patch("/policies/{uuid}", requires=api_key_authentication)
def patch(uuid: hug.types.uuid, body: validate_input("name"), response,
authed_user: hug.directives.user = None):
"""Update a policy
:param uuid: uuid of the policy to update
:param body: preformed body from Hug
:param response: preformed response from Hug
:param authed_user: the name of the authenticated user
:return: {
"policy_id1": {
"name": "name of the policy (mandatory)",
"model_id": "ID of the model linked to this policy",
"genre": "authz of admin (optional, default to authz)",
"description": "description of the policy (optional)",
}
}
"""
uuid = str(uuid).replace("-", "")
prev_data = db_driver.PolicyManager.get_policies(moon_user_id=authed_user, policy_id=uuid)
if not prev_data:
response.status = ERROR_CODE[400]
return {"message": "The policy is unknown."}
data = db_driver.PolicyManager.update_policy(
moon_user_id=authed_user, policy_id=uuid, value=body).get(uuid)
slaves = slave_class.Slaves.get().get("slaves")
invalidate_policy_in_slaves(slaves=slaves, policy_id=uuid, data=data, is_delete=False)
return {"policies": db_driver.PolicyManager.get_policies(moon_user_id=authed_user,
policy_id=uuid)}
PoliciesAPI = hug.API(name='policies', doc=Policies.__doc__)
@hug.object(name='policies', version='1.0.0', api=PoliciesAPI)
class PoliciesCLI(object):
"""An example of command like calls via an Object"""
@staticmethod
@hug.object.cli
def list(name_or_id="", human: bool = False):
"""
List policies from the database
:return: JSON status output
"""
db_conf = configuration.get_configuration(key='management')
manager_api_key = connect_from_env()
_policies_req = requests.get("{}/policies".format(db_conf.get("url")),
headers={"x-api-key": manager_api_key}
)
if _policies_req.status_code == 200:
if name_or_id:
_policies = None
if name_or_id in _policies_req.json().get("policies"):
_policies = _policies_req.json().get("policies").get(name_or_id)
else:
for _policies_key in _policies_req.json().get("policies"):
_name = _policies_req.json().get("policies").get(_policies_key).get("name")
if _name == name_or_id :
_policies = _policies_req.json().get("policies").get(_policies_key)
name_or_id = _policies_key
break
if not _policies:
raise Exception("Cannot find policy with name {}".format(name_or_id))
else:
result = {"policies": {name_or_id: _policies}}
else:
result = _policies_req.json()
if human:
return PoliciesCLI.human_display(result);
else:
return result
@staticmethod
@hug.object.cli
def add(name, model, description="", genre="authz", human: bool = False):
"""
Add a new policy from the database
:return: JSON policies output
"""
from moon_manager.api import models
db_conf = configuration.get_configuration(key='management')
manager_api_key = connect_from_env()
_model = models.ModelsCLI.list(model).get("models")[0]
_policies = requests.post(
"{}/policies".format(db_conf.get("url")),
json={
"name": name,
"model_id": list(_model.keys())[0],
"genre": genre,
"description": description,
},
headers={
"x-api-key": manager_api_key,
"Content-Type": "application/json"
}
)
if _policies.status_code == 200:
LOGGER.warning('Create {}'.format(_policies.content))
if human:
return PoliciesCLI.list('', True)
else:
return _policies.json()
LOGGER.error('Cannot create {} ({})'.format(name, _policies.content))
@staticmethod
@hug.object.cli
def delete(name_or_id):
db_conf = configuration.get_configuration(key='management')
manager_api_key = connect_from_env()
_policies = PoliciesCLI.list()
for _id, _value in _policies.get("policies").items():
if _id == name_or_id or _value.get("name") == name_or_id:
req = requests.delete(
"{}/policies/{}".format(db_conf.get("url"), _id),
headers={"x-api-key": manager_api_key}
)
break
else:
LOGGER.error("Cannot find policy with name {}".format(name_or_id))
return False
if req.status_code == 200:
LOGGER.warning('Deleted {}'.format(name_or_id))
return True
LOGGER.error("Cannot delete policy with name {}".format(name_or_id))
return False
@staticmethod
@hug.object.cli
def update(name_or_id, model_id=None, description=None, genre=None):
db_conf = configuration.get_configuration(key='management')
manager_api_key = connect_from_env()
_policies = PoliciesCLI.list()
for _id, _value in _policies.get("policies").items():
if _id == name_or_id or _value.get("name") == name_or_id:
updated_model_id = _value.get("model_id")
updated_genre = _value.get("genre")
updated_description = _value.get("description")
if model_id is not None:
updated_model_id = model_id
if description is not None:
updated_description = description
if genre is not None:
updated_genre = genre
req = requests.patch(
"{}/policies/{}".format(db_conf.get("url"), _id),
json={
"name": _value.get("name"),
"model_id": updated_model_id,
"genre": updated_genre,
"description": updated_description,
},
headers={"x-api-key": manager_api_key}
)
break
else:
LOGGER.error("Cannot find policy with name {}".format(name_or_id))
return False
if req.status_code == 200:
LOGGER.warning('Updated {}'.format(name_or_id))
return True
LOGGER.error("Cannot update policy with name {}".format(name_or_id))
return False
@staticmethod
def human_display(policies_json):
human_result = "Policies"
for policy in policies_json.get("policies"):
human_result += "\n" + policies_json.get("policies").get(policy).get("name") + " : \n"
human_result += "\tname : " + policies_json.get("policies").get(policy).get("name") + "\n"
human_result += "\tdescription : " + policies_json.get("policies").get(policy).get("description") + "\n"
human_result += "\tgenre : " + policies_json.get("policies").get(policy).get("genre") + "\n"
human_result += "\tmodel_id : " + policies_json.get("policies").get(policy).get("model_id") + "\n"
return human_result
|
