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
|
# -------------------------------------------------------------------------
# Copyright (c) 2015-2017 AT&T Intellectual Property
#
# 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.
#
# -------------------------------------------------------------------------
#
import base64
import itertools
import json
from requests import RequestException
from osdf.operation.exceptions import BusinessException
from osdf.adapters.local_data.local_policies import get_local_policies
from osdf.adapters.policy.utils import policy_name_as_regex, retrieve_node
from osdf.config.base import osdf_config
from osdf.logging.osdf_logging import audit_log, MH, metrics_log, debug_log
from osdf.utils.interfaces import RestClient
def get_by_name(rest_client, policy_name_list, wildcards=True):
policy_list = []
for policy_name in policy_name_list:
try:
query_name = policy_name
if wildcards:
query_name = policy_name_as_regex(query_name)
policy_list.append(rest_client.request(json={"policyName": query_name}))
except RequestException as err:
audit_log.warn("Error in fetching policy: " + policy_name)
raise BusinessException("Cannot fetch policy {}: ".format(policy_name), err)
return policy_list
def get_subscriber_name(req, pmain):
subs_name = retrieve_node(req, pmain['subscriber_name'])
if subs_name is None:
return "DEFAULT"
else:
subs_name_uc = subs_name.upper()
if subs_name_uc in ("DEFAULT", "NULL", ""):
subs_name = "DEFAULT"
return subs_name
def get_subscriber_role(rest_client, req, pmain, service_name, scope):
"""Make a request to policy and return subscriberRole
:param rest_client: rest client to make call
:param req: request object from MSO
:param pmain: main config that will have policy path information
:param service_name: the type of service to call: e.g. "vCPE
:param scope: the scope of policy to call: e.g. "OOF_HAS_vCPE".
:return: subscriberRole and provStatus retrieved from Subscriber policy
"""
subscriber_role = "DEFAULT"
prov_status = []
subs_name = get_subscriber_name(req, pmain) # what if there is no subs_name
if subs_name == "DEFAULT":
return subscriber_role, prov_status
policy_subs = pmain['policy_subscriber']
policy_scope = {"policyName": "{}.*".format(scope),
"configAttributes": {
"serviceType": "{}".format(service_name),
"service": "{}".format(policy_subs)}
}
try:
policy_list = rest_client.request(json=policy_scope)
except RequestException as err:
audit_log.warn("Error in fetching policy for {}, {}: ".format(policy_subs, err))
return subscriber_role, prov_status
policies = list(itertools.chain(*policy_list))
for x in policies:
if not x['config']: # some policy has no 'config' field, so it will be empty
raise BusinessException("Config not found for policy with name %s" % x['policyName'])
formatted_policies = [json.loads(x['config']) for x in policies]
role, prov = _get_subscriber_role_from_policies(formatted_policies, subs_name, subscriber_role, prov_status)
return role, prov
def _get_subscriber_role_from_policies(policies, subs_name, default_role, default_prov):
"""
Get the first subscriber role found in policies
:param policies: JSON-loaded policies
:param subs_name: subscriber name
:param default_val: default role (e.g. "DEFAULT")
:param default_prov: default prov_status (e.g. [])
:return: role and prov_status
"""
for policy in policies:
property_list = policy['content']['property']
for prop in property_list:
if subs_name in prop['subscriberName']:
subs_role_list = prop['subscriberRole']
prov_status = prop['provStatus']
if isinstance(subs_role_list, list):
return subs_role_list[0], prov_status # TODO: check what to do otherwise
return default_role, default_prov
def get_by_scope(rest_client, req, config_local, type_service):
policy_list = []
pmain = config_local['policy_info'][type_service]
pscope = pmain['policy_scope']
model_name = retrieve_node(req, pscope['service_name'])
service_name = model_name
scope = pscope['scope_{}'.format(service_name.lower())]
subscriber_role, prov_status = get_subscriber_role(rest_client, req, pmain, service_name, scope)
policy_type_list = pmain['policy_type_{}'.format(service_name.lower())]
for policy_type in policy_type_list:
policy_scope = {"policyName": "{}.*".format(scope),
"configAttributes": {
"serviceType": "{}".format(service_name),
"service": "{}".format(policy_type),
"subscriberRole": "{}".format(subscriber_role)}
}
policy_list.append(rest_client.request(json=policy_scope))
return policy_list, prov_status
def remote_api(req_json, osdf_config, service_type="placement"):
"""Make a request to policy and return response -- it accounts for multiple requests that be needed
:param req_json: policy request object (can have multiple policy names)
:param osdf_config: main config that will have credential information
:param service_type: the type of service to call: "placement", "scheduling"
:return: all related policies and provStatus retrieved from Subscriber policy
"""
prov_status = None
config = osdf_config.deployment
uid, passwd = config['policyPlatformUsername'], config['policyPlatformPassword']
pcuid, pcpasswd = config['policyClientUsername'], config['policyClientPassword']
headers = {"ClientAuth": base64.b64encode(bytes("{}:{}".format(pcuid, pcpasswd), "ascii"))}
headers.update({'Environment': config['policyPlatformEnv']})
url = config['policyPlatformUrl']
rc = RestClient(userid=uid, passwd=passwd, headers=headers, url=url, log_func=debug_log.debug)
if osdf_config.core['policy_info'][service_type]['policy_fetch'] == "by_name":
policies = get_by_name(rc, req_json[service_type + "Info"]['policyId'], wildcards=True)
elif osdf_config.core['policy_info'][service_type]['policy_fetch'] == "by_name_no_wildcards":
policies = get_by_name(rc, req_json[service_type + "Info"]['policyId'], wildcards=False)
else: # Get policy by scope
policies, prov_status = get_by_scope(rc, req_json, osdf_config.core, service_type)
# policies in res are list of lists, so flatten them; also only keep config part
formatted_policies = []
for x in itertools.chain(*policies):
if x['config'] is None:
raise BusinessException("Config not found for policy with name %s" % x['policyName'])
else:
formatted_policies.append(json.loads(x['config']))
return formatted_policies, prov_status
def local_policies_location(req_json, osdf_config, service_type):
"""
Get folder and list of policy_files if "local policies" option is enabled
:param service_type: placement supported for now, but can be any other service
:return: a tuple (folder, file_list) or None
"""
lp = osdf_config.core.get('osdf_temp', {}).get('local_policies', {})
if lp.get('global_disabled'):
return None # short-circuit to disable all local policies
if lp.get('local_{}_policies_enabled'.format(service_type)):
if service_type == "scheduling":
return lp.get('{}_policy_dir'.format(service_type)), lp.get('{}_policy_files'.format(service_type))
else:
required_node = osdf_config.core['policy_info'][service_type]['policy_scope']['service_name']
model_name = retrieve_node(req_json, required_node)
service_name = model_name # TODO: data_mapping.get_service_type(model_name)
return lp.get('{}_policy_dir_{}'.format(service_type, service_name.lower())), \
lp.get('{}_policy_files_{}'.format(service_type, service_name.lower()))
return None
def get_policies(request_json, service_type):
"""Validate the request and get relevant policies
:param request_json: Request object
:param service_type: the type of service to call: "placement", "scheduling"
:return: policies associated with this request and provStatus retrieved from Subscriber policy
"""
prov_status = []
req_info = request_json['requestInfo']
req_id = req_info['requestId']
metrics_log.info(MH.requesting("policy", req_id))
local_info = local_policies_location(request_json, osdf_config, service_type)
if local_info: # tuple containing location and list of files
to_filter = None
if osdf_config.core['policy_info'][service_type]['policy_fetch'] == "by_name":
to_filter = request_json[service_type + "Info"]['policyId']
policies = get_local_policies(local_info[0], local_info[1], to_filter)
else:
policies, prov_status = remote_api(request_json, osdf_config, service_type)
return policies, prov_status
|
