-
Notifications
You must be signed in to change notification settings - Fork 5.5k
/
base.py
495 lines (410 loc) · 15.2 KB
/
base.py
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
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
import hashlib
import logging
import os
import ssl
import traceback
import warnings
import salt.utils.stringutils
log = logging.getLogger(__name__)
TRANSPORTS = (
"zeromq",
"tcp",
"ws",
)
def request_server(opts, **kwargs):
# Default to ZeroMQ for now
ttype = "zeromq"
# determine the ttype
if "transport" in opts:
ttype = opts["transport"]
elif "transport" in opts.get("pillar", {}).get("master", {}):
ttype = opts["pillar"]["master"]["transport"]
if ttype == "zeromq":
import salt.transport.zeromq
return salt.transport.zeromq.RequestServer(opts)
elif ttype == "tcp":
import salt.transport.tcp
return salt.transport.tcp.RequestServer(opts)
elif ttype == "ws":
import salt.transport.ws
return salt.transport.ws.RequestServer(opts)
elif ttype == "local":
import salt.transport.local
transport = salt.transport.local.LocalServerChannel(opts)
else:
raise Exception("Channels are only defined for ZeroMQ and TCP")
def request_client(opts, io_loop):
ttype = "zeromq"
if "transport" in opts:
ttype = opts["transport"]
elif "transport" in opts.get("pillar", {}).get("master", {}):
ttype = opts["pillar"]["master"]["transport"]
if ttype == "zeromq":
import salt.transport.zeromq
return salt.transport.zeromq.RequestClient(opts, io_loop=io_loop)
elif ttype == "tcp":
import salt.transport.tcp
resolver = salt.transport.tcp.Resolver()
return salt.transport.tcp.RequestClient(
opts, resolver=resolver, io_loop=io_loop
)
elif ttype == "ws":
import salt.transport.ws
return salt.transport.ws.RequestClient(opts, io_loop=io_loop)
else:
raise Exception("Channels are only defined for tcp, zeromq")
def publish_server(opts, **kwargs):
# Default to ZeroMQ for now
ttype = "zeromq"
# determine the ttype
if "transport" in kwargs:
ttype = kwargs.pop("transport")
elif "transport" in opts:
ttype = opts["transport"]
elif "transport" in opts.get("pillar", {}).get("master", {}):
ttype = opts["pillar"]["master"]["transport"]
if "pub_host" not in kwargs and "pub_path" not in kwargs:
kwargs["pub_host"] = opts["interface"]
if "pub_port" not in kwargs and "pub_path" not in kwargs:
kwargs["pub_port"] = opts.get("publish_port", 4506)
if "pull_host" not in kwargs and "pull_path" not in kwargs:
if opts.get("ipc_mode", "") == "tcp":
kwargs["pull_host"] = "127.0.0.1"
kwargs["pull_port"] = opts.get("tcp_master_publish_pull", 4514)
else:
kwargs["pull_path"] = os.path.join(opts["sock_dir"], "publish_pull.ipc")
if "ssl" not in kwargs and opts.get("ssl", None) is not None:
kwargs["ssl"] = opts["ssl"]
# switch on available ttypes
if ttype == "zeromq":
import salt.transport.zeromq
return salt.transport.zeromq.PublishServer(opts, **kwargs)
elif ttype == "tcp":
import salt.transport.tcp
return salt.transport.tcp.PublishServer(opts, **kwargs)
elif ttype == "ws":
import salt.transport.ws
return salt.transport.ws.PublishServer(opts, **kwargs)
elif ttype == "local": # TODO:
import salt.transport.local
return salt.transport.local.LocalPubServerChannel(opts, **kwargs)
raise Exception(f"Transport type not found: {ttype}")
def publish_client(
opts, io_loop, host=None, port=None, path=None, transport=None, **kwargs
):
# Default to ZeroMQ for now
ttype = "zeromq"
# determine the ttype
if transport is not None:
ttype = transport
elif "transport" in opts:
ttype = opts["transport"]
elif "transport" in opts.get("pillar", {}).get("master", {}):
ttype = opts["pillar"]["master"]["transport"]
ssl_opts = None
if "ssl" in kwargs:
ssl_opts = kwargs["ssl"]
elif opts.get("ssl", None) is not None:
ssl_opts = opts["ssl"]
# switch on available ttypes
if ttype == "zeromq":
import salt.transport.zeromq
if ssl_opts:
log.warning("TLS not supported with zeromq transport")
return salt.transport.zeromq.PublishClient(
opts, io_loop, host=host, port=port, path=path
)
elif ttype == "tcp":
import salt.transport.tcp
return salt.transport.tcp.PublishClient(
opts,
io_loop,
host=host,
port=port,
path=path,
ssl=ssl_opts,
)
elif ttype == "ws":
import salt.transport.ws
return salt.transport.ws.PublishClient(
opts,
io_loop,
host=host,
port=port,
path=path,
ssl=ssl_opts,
)
raise Exception(f"Transport type not found: {ttype}")
def _minion_hash(hash_type, minion_id):
"""
Generate a hash string for the minion id
"""
hasher = getattr(hashlib, hash_type)
return hasher(salt.utils.stringutils.to_bytes(minion_id)).hexdigest()[:10]
def ipc_publish_client(node, opts, io_loop):
# Default to TCP for now
kwargs = {"transport": "tcp", "ssl": None}
if opts["ipc_mode"] == "tcp":
if node == "master":
kwargs.update(
host="127.0.0.1",
port=int(opts["tcp_master_pub_port"]),
)
else:
kwargs.update(
host="127.0.0.1",
port=int(opts["tcp_pub_port"]),
)
else:
if node == "master":
kwargs.update(
path=os.path.join(opts["sock_dir"], "master_event_pub.ipc"),
)
else:
id_hash = _minion_hash(
hash_type=opts["hash_type"],
minion_id=opts.get("hash_id", opts["id"]),
)
kwargs.update(
path=os.path.join(opts["sock_dir"], f"minion_event_{id_hash}_pub.ipc")
)
return publish_client(opts, io_loop, **kwargs)
def ipc_publish_server(node, opts):
# Default to TCP for now
kwargs = {"transport": "tcp", "ssl": None}
if opts["ipc_mode"] == "tcp":
if node == "master":
kwargs.update(
pub_host="127.0.0.1",
pub_port=int(opts["tcp_master_pub_port"]),
pull_host="127.0.0.1",
pull_port=int(opts["tcp_master_pull_port"]),
)
else:
kwargs.update(
pub_host="127.0.0.1",
pub_port=int(opts["tcp_pub_port"]),
pull_host="127.0.0.1",
pull_port=int(opts["tcp_pull_port"]),
)
else:
if node == "master":
kwargs.update(
pub_path=os.path.join(opts["sock_dir"], "master_event_pub.ipc"),
pull_path=os.path.join(opts["sock_dir"], "master_event_pull.ipc"),
)
else:
id_hash = _minion_hash(
hash_type=opts["hash_type"],
minion_id=opts.get("hash_id", opts["id"]),
)
pub_path = os.path.join(opts["sock_dir"], f"minion_event_{id_hash}_pub.ipc")
kwargs.update(
pub_path=pub_path,
pull_path=os.path.join(
opts["sock_dir"], f"minion_event_{id_hash}_pull.ipc"
),
)
return publish_server(opts, **kwargs)
class TransportWarning(Warning):
"""
Transport warning.
"""
class Transport:
def __init__(self, *args, **kwargs):
self._trace = "\n".join(traceback.format_stack()[:-1])
if not hasattr(self, "_closing"):
self._closing = False
if not hasattr(self, "_connect_called"):
self._connect_called = False
def connect(self, *args, **kwargs):
self._connect_called = True
# pylint: disable=W1701
def __del__(self):
"""
Warn the user if the transport's close method was never called.
If the _closing attribute is missing we won't raise a warning. This
prevents issues when class's dunder init method is called with improper
arguments, and is later getting garbage collected. Users of this class
should take care to call super() and validate the functionality with a
test.
"""
if getattr(self, "_connect_called") and not getattr(self, "_closing", True):
warnings.warn(
f"Unclosed transport! {self!r} \n{self._trace}",
TransportWarning,
source=self,
)
# pylint: enable=W1701
class RequestClient(Transport):
"""
The RequestClient transport is used to make requests and get corresponding
replies from the RequestServer.
"""
def __init__(self, opts, io_loop, **kwargs):
super().__init__()
async def send(self, load, timeout=60):
"""
Send a request message and return the reply from the server.
"""
raise NotImplementedError
def close(self):
"""
Close the connection.
"""
raise NotImplementedError
def connect(self): # pylint: disable=W0221
"""
Connect to the server / broker.
"""
raise NotImplementedError
class RequestServer:
"""
The RequestServer transport is responsible for handling requests from
RequestClients and sending replies to those requests.
"""
def __init__(self, opts):
pass
def close(self):
"""
Close the underlying network connection.
"""
raise NotImplementedError
class DaemonizedRequestServer(RequestServer):
def pre_fork(self, process_manager):
raise NotImplementedError
def post_fork(self, message_handler, io_loop):
"""
The message handler is a coroutine that will be called called when a
new request comes into the server. The return from the message handler
will be send back to the RequestClient
"""
raise NotImplementedError
class PublishServer:
"""
The PublishServer publishes messages to PublishClients or to a borker
service.
"""
def publish(self, payload, **kwargs):
"""
Publish "load" to minions. This send the load to the publisher daemon
process with does the actual sending to minions.
:param dict load: A load to be sent across the wire to minions
"""
raise NotImplementedError
class DaemonizedPublishServer(PublishServer):
"""
PublishServer that has a daemon associated with it.
"""
def pre_fork(self, process_manager):
raise NotImplementedError
def publish_daemon(
self,
publish_payload,
presence_callback=None,
remove_presence_callback=None,
):
"""
If a daemon is needed to act as a broker implement it here.
:param func publish_payload: A method used to publish the payload
:param func presence_callback: If the transport support presence
callbacks call this method to notify the
channel of a client's presence
:param func remove_presence_callback: If the transport support presence
callbacks call this method to
notify the channel a client is no
longer present
"""
raise NotImplementedError
class PublishClient(Transport):
"""
The PublishClient receives messages from the PublishServer and runs a callback.
"""
def __init__(self, opts, io_loop, **kwargs):
super().__init__()
def on_recv(self, callback):
"""
Add a message handler when we receive a message from the PublishServer
"""
raise NotImplementedError
async def connect( # pylint: disable=arguments-differ,invalid-overridden-method
self, port=None, connect_callback=None, disconnect_callback=None, timeout=None
):
"""
Create a network connection to the the PublishServer or broker.
"""
raise NotImplementedError
async def recv(self, timeout=None):
"""
Receive a single message from the publish server.
The default timeout=None will wait indefinitly for a message. When
timeout is 0 return immediately if no message is ready. A positive
value sepcifies a period of time to wait for a message before raising a
TimeoutError.
"""
raise NotImplementedError
def close(self):
"""
Close the underlying network connection
"""
raise NotImplementedError
def __enter__(self):
return self
def __exit__(self, exc_type, exc_val, exc_tb):
pass
def ssl_context(ssl_options, server_side=False):
"""
Create an ssl context from the provided ssl_options. This method preserves
backwards compatability older ssl config settings but adds verify_locations
and verify_flags options.
"""
default_version = ssl.PROTOCOL_TLS
if server_side:
default_version = ssl.PROTOCOL_TLS_SERVER
purpose = ssl.Purpose.CLIENT_AUTH
elif server_side is not None:
default_version = ssl.PROTOCOL_TLS_CLIENT
purpose = ssl.Purpose.SERVER_AUTH
# Use create_default_context to start with what Python considers resonably
# secure settings.
context = ssl.create_default_context(purpose)
context.protocol = ssl_options.get("ssl_version", default_version)
if "certfile" in ssl_options:
context.load_cert_chain(
ssl_options["certfile"], ssl_options.get("keyfile", None)
)
if "cert_reqs" in ssl_options:
if ssl_options["cert_reqs"].upper() == "CERT_NONE":
# This may have been set automatically by PROTOCOL_TLS_CLIENT but is
# incompatible with CERT_NONE so we must manually clear it.
context.check_hostname = False
context.verify_mode = getattr(ssl.VerifyMode, ssl_options["cert_reqs"])
if "ca_certs" in ssl_options:
context.load_verify_locations(ssl_options["ca_certs"])
if "verify_locations" in ssl_options:
for _ in ssl_options["verify_locations"]:
if isinstance(_, dict):
for key in _:
if key.lower() == "cafile":
context.load_verify_locations(cafile=_[key])
elif key.lower() == "capath":
context.load_verify_locations(capath=_[key])
elif key.lower() == "cadata":
context.load_verify_locations(cadata=_[key])
else:
log.warning("Unkown verify location type: %s", key)
else:
cafile = _
context.load_verify_locations(cafile=_)
if "verify_flags" in ssl_options:
for flag in ssl_options["verify_flags"]:
context.verify_flags |= getattr(ssl.VerifyFlags, flag.upper())
if "ciphers" in ssl_options:
context.set_ciphers(ssl_options["ciphers"])
return context
def common_name(cert):
try:
name = dict([_[0] for _ in cert["subject"]])["commonName"]
except (ValueError, KeyError):
return None
return name