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
|
# ================================================================================
# Copyright (c) 2018 AT&T Intellectual Property. All rights reserved.
# ================================================================================
# 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.
# ============LICENSE_END=========================================================
#
# ECOMP is a trademark and service mark of AT&T Intellectual Property.
"""
policy-receiver communicates with policy-engine
thru web-socket to receive push notifications
on updates and removal of policies.
on receiving the policy-notifications, the policy-receiver
passes the notifications to policy-updater
"""
import copy
import json
import logging
import os
import ssl
import time
from threading import Lock, Thread
import websocket
from .config import Config, Settings
from .policy_consts import MATCHING_CONDITIONS, POLICY_NAME, POLICY_VERSION
from .policy_updater import PolicyUpdater
from .policy_utils import Utils
LOADED_POLICIES = 'loadedPolicies'
REMOVED_POLICIES = 'removedPolicies'
POLICY_VER = 'versionNo'
POLICY_MATCHES = 'matches'
class _PolicyReceiver(Thread):
"""web-socket to PolicyEngine"""
_logger = logging.getLogger("policy_handler.policy_receiver")
def __init__(self):
"""web-socket inside the thread to receive policy notifications from PolicyEngine"""
Thread.__init__(self, name="policy_receiver", daemon=True)
self._lock = Lock()
self._keep_running = True
self._settings = Settings(Config.FIELD_POLICY_ENGINE)
self._sleep_before_restarting = 5
self._web_socket_url = None
self._web_socket_sslopt = None
self._tls_wss_ca_mode = None
self._web_socket = None
self.reconfigure()
self._policy_updater = PolicyUpdater(self.reconfigure)
self._policy_updater.start()
def reconfigure(self):
"""configure and reconfigure the web-socket"""
with self._lock:
self._sleep_before_restarting = 5
self._settings.set_config(Config.discovered_config)
changed, config = self._settings.get_by_key(Config.FIELD_POLICY_ENGINE)
if not changed:
self._settings.commit_change()
return False
prev_web_socket_url = self._web_socket_url
prev_web_socket_sslopt = self._web_socket_sslopt
self._web_socket_sslopt = None
resturl = (config.get("url", "").lower()
+ config.get("path_notifications", "/pdp/notifications"))
self._tls_wss_ca_mode = config.get(Config.TLS_WSS_CA_MODE)
if resturl.startswith("https:"):
self._web_socket_url = resturl.replace("https:", "wss:")
verify = Config.get_tls_verify(self._tls_wss_ca_mode)
if verify is False:
self._web_socket_sslopt = {'cert_reqs': ssl.CERT_NONE}
elif verify is True:
pass
else:
self._web_socket_sslopt = {'ca_certs': verify}
else:
self._web_socket_url = resturl.replace("http:", "ws:")
if (self._web_socket_url == prev_web_socket_url
and Utils.are_the_same(prev_web_socket_sslopt, self._web_socket_sslopt)):
_PolicyReceiver._logger.info(
"not changed web_socket_url(%s) or tls_wss_ca_mode(%s): %s",
self._web_socket_url, self._tls_wss_ca_mode, self._settings)
self._settings.commit_change()
return False
_PolicyReceiver._logger.info("changed web_socket_url(%s) or tls_wss_ca_mode(%s): %s",
self._web_socket_url, self._tls_wss_ca_mode,
self._settings)
self._settings.commit_change()
self._stop_notifications()
return True
def run(self):
"""listen on web-socket and pass the policy notifications to policy-updater"""
websocket.enableTrace(True)
restarting = False
while True:
if not self._get_keep_running():
break
self._stop_notifications()
if restarting:
with self._lock:
sleep_before_restarting = self._sleep_before_restarting
_PolicyReceiver._logger.info(
"going to sleep for %s secs before restarting policy-notifications",
sleep_before_restarting)
time.sleep(sleep_before_restarting)
if not self._get_keep_running():
break
with self._lock:
web_socket_url = self._web_socket_url
sslopt = copy.deepcopy(self._web_socket_sslopt)
tls_wss_ca_mode = self._tls_wss_ca_mode
_PolicyReceiver._logger.info(
"connecting to policy-notifications at %s with sslopt(%s) tls_wss_ca_mode(%s)",
web_socket_url, json.dumps(sslopt), tls_wss_ca_mode)
self._web_socket = websocket.WebSocketApp(
web_socket_url,
on_message=self._on_pdp_message,
on_close=self._on_ws_close,
on_error=self._on_ws_error
)
_PolicyReceiver._logger.info("waiting for policy-notifications...")
self._web_socket.run_forever(sslopt=sslopt)
restarting = True
_PolicyReceiver._logger.info("exit policy-receiver")
def _get_keep_running(self):
"""thread-safe check whether to continue running"""
with self._lock:
keep_running = self._keep_running
return keep_running
def _stop_notifications(self):
"""close the web-socket == stops the notification service if running."""
with self._lock:
if self._web_socket and self._web_socket.sock and self._web_socket.sock.connected:
self._web_socket.close()
_PolicyReceiver._logger.info("Stopped receiving notifications from PDP")
def _on_pdp_message(self, *args):
"""received the notification from PDP"""
try:
message = args and args[-1]
_PolicyReceiver._logger.info("Received notification message: %s", message)
if not message:
return
message = json.loads(message)
if not message or not isinstance(message, dict):
_PolicyReceiver._logger.warning("unexpected message from PDP: %s",
json.dumps(message))
return
policies_updated = [
{POLICY_NAME: policy.get(POLICY_NAME),
POLICY_VERSION: policy.get(POLICY_VER),
MATCHING_CONDITIONS: policy.get(POLICY_MATCHES, {})}
for policy in message.get(LOADED_POLICIES, [])
]
policies_removed = [
{POLICY_NAME: removed_policy.get(POLICY_NAME),
POLICY_VERSION: removed_policy.get(POLICY_VER)}
for removed_policy in message.get(REMOVED_POLICIES, [])
]
if not policies_updated and not policies_removed:
_PolicyReceiver._logger.info("no policy updated or removed")
return
self._policy_updater.policy_update(policies_updated, policies_removed)
except Exception as ex:
error_msg = "crash {} {} at {}: {}".format(type(ex).__name__, str(ex),
"on_pdp_message", json.dumps(message))
_PolicyReceiver._logger.exception(error_msg)
def _on_ws_error(self, error):
"""report an error"""
_PolicyReceiver._logger.exception("policy-notification error %s", str(error))
self._sleep_before_restarting = 60 if isinstance(error, ssl.SSLError) else 5
def _on_ws_close(self, code, reason):
"""restart web-socket on close"""
_PolicyReceiver._logger.info("lost connection(%s, %s) to PDP - restarting...", code, reason)
def shutdown(self, audit):
"""Shutdown the policy-receiver"""
_PolicyReceiver._logger.info("shutdown policy-receiver")
with self._lock:
self._keep_running = False
self._stop_notifications()
if self.is_alive():
self.join()
self._policy_updater.shutdown(audit)
def catch_up(self, audit):
"""need to bring the latest policies to DCAE-Controller"""
self._policy_updater.catch_up(audit)
class PolicyReceiver(object):
"""policy-receiver - static singleton wrapper"""
_policy_receiver = None
@staticmethod
def shutdown(audit):
"""Shutdown the notification-handler"""
PolicyReceiver._policy_receiver.shutdown(audit)
@staticmethod
def catch_up(audit):
"""bring the latest policies from policy-engine"""
PolicyReceiver._policy_receiver.catch_up(audit)
@staticmethod
def run(audit):
"""Using policy-engine client to talk to policy engine"""
PolicyReceiver._policy_receiver = _PolicyReceiver()
PolicyReceiver._policy_receiver.start()
PolicyReceiver.catch_up(audit)
|
