To get this branch, use:
bzr branch
http://bzr.recompile.se/loggerhead/mandos/trunk
« back to all changes in this revision
Viewing changes to mandos
- browse files at revision 398
- compare with another revision
- download diff
- download tarball
- view history from revision 398
- Committer: Teddy Hogeborn
- Date: 2009-10-30 16:27:17 UTC
- Revision ID: teddy@fukt.bsnet.se-20091030162717-dun2a9li8bu6jm2w
* Makefile (DOCBOOKTOMAN, DOCBOOKTOHTML, common.ent, mandos,
mandos-keygen, mandos-ctl, mandos.lsm): Add $(strip) to
make commands
easier to read
when run.
(plugins.d/mandos-client): Use $(LINK.c) to compile in the
same way as the other programs -
i.e. not via an object file.
mandos-keygen, mandos-ctl, mandos.lsm): Add $(strip) to
make commands
easier to read
when run.
(plugins.d/mandos-client): Use $(LINK.c) to compile in the
same way as the other programs -
i.e. not via an object file.
- files removed:
- DBUS-API
- debian/source
- debian/upstream
- network-hooks.d
- files modified:
- .bzrignore
added
removed
mandos
1
#!/usr/bin/python2.7
1
#!/usr/bin/python
2
2
# -*- mode: python; coding: utf-8 -*-
3
3
#
4
4
# Mandos server - give out binary blobs to connecting clients.
11
11
# "AvahiService" class, and some lines in "main".
12
12
#
13
13
# Everything else is
14
# Copyright © 2008-2014 Teddy Hogeborn
15
# Copyright © 2008-2014 Björn Påhlsson
14
# Copyright © 2008,2009 Teddy Hogeborn
15
# Copyright © 2008,2009 Björn Påhlsson
16
16
#
17
17
# This program is free software: you can redistribute it and/or modify
18
18
# it under the terms of the GNU General Public License as published by
28
28
# along with this program. If not, see
29
29
# <http://www.gnu.org/licenses/>.
30
30
#
31
# Contact the authors at <mandos@recompile.se>.
31
# Contact the authors at <mandos@fukt.bsnet.se>.
32
32
#
33
33
34
from __future__ import (division, absolute_import, print_function,
35
unicode_literals)
36
37
from future_builtins import *
34
from __future__ import division, with_statement, absolute_import
38
35
39
36
import SocketServer as socketserver
40
37
import socket
41
import argparse
38
import optparse
42
39
import datetime
43
40
import errno
44
41
import gnutls.crypto
58
55
import logging
59
56
import logging.handlers
60
57
import pwd
61
import contextlib
58
from contextlib import closing
62
59
import struct
63
60
import fcntl
64
61
import functools
65
import cPickle as pickle
66
import multiprocessing
67
import types
68
import binascii
69
import tempfile
70
import itertools
71
import collections
72
62
73
63
import dbus
74
64
import dbus.service
88
78
except ImportError:
89
79
SO_BINDTODEVICE = None
90
80
91
version = "1.6.7"
92
stored_state_file = "clients.pickle"
93
94
logger = logging.getLogger()
95
syslogger = None
96
97
try:
98
if_nametoindex = (ctypes.cdll.LoadLibrary
99
(ctypes.util.find_library("c"))
100
.if_nametoindex)
101
except (OSError, AttributeError):
102
def if_nametoindex(interface):
103
"Get an interface index the hard way, i.e. using fcntl()"
104
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
105
with contextlib.closing(socket.socket()) as s:
106
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
107
struct.pack(str("16s16x"),
108
interface))
109
interface_index = struct.unpack(str("I"),
110
ifreq[16:20])[0]
111
return interface_index
112
113
114
def initlogger(debug, level=logging.WARNING):
115
"""init logger and add loglevel"""
116
117
global syslogger
118
syslogger = (logging.handlers.SysLogHandler
119
(facility =
120
logging.handlers.SysLogHandler.LOG_DAEMON,
121
address = str("/dev/log")))
122
syslogger.setFormatter(logging.Formatter
123
('Mandos [%(process)d]: %(levelname)s:'
124
' %(message)s'))
125
logger.addHandler(syslogger)
126
127
if debug:
128
console = logging.StreamHandler()
129
console.setFormatter(logging.Formatter('%(asctime)s %(name)s'
130
' [%(process)d]:'
131
' %(levelname)s:'
132
' %(message)s'))
133
logger.addHandler(console)
134
logger.setLevel(level)
135
136
137
class PGPError(Exception):
138
"""Exception if encryption/decryption fails"""
139
pass
140
141
142
class PGPEngine(object):
143
"""A simple class for OpenPGP symmetric encryption & decryption"""
144
def __init__(self):
145
self.tempdir = tempfile.mkdtemp(prefix="mandos-")
146
self.gnupgargs = ['--batch',
147
'--home', self.tempdir,
148
'--force-mdc',
149
'--quiet',
150
'--no-use-agent']
151
152
def __enter__(self):
153
return self
154
155
def __exit__(self, exc_type, exc_value, traceback):
156
self._cleanup()
157
return False
158
159
def __del__(self):
160
self._cleanup()
161
162
def _cleanup(self):
163
if self.tempdir is not None:
164
# Delete contents of tempdir
165
for root, dirs, files in os.walk(self.tempdir,
166
topdown = False):
167
for filename in files:
168
os.remove(os.path.join(root, filename))
169
for dirname in dirs:
170
os.rmdir(os.path.join(root, dirname))
171
# Remove tempdir
172
os.rmdir(self.tempdir)
173
self.tempdir = None
174
175
def password_encode(self, password):
176
# Passphrase can not be empty and can not contain newlines or
177
# NUL bytes. So we prefix it and hex encode it.
178
encoded = b"mandos" + binascii.hexlify(password)
179
if len(encoded) > 2048:
180
# GnuPG can't handle long passwords, so encode differently
181
encoded = (b"mandos" + password.replace(b"\\", b"\\\\")
182
.replace(b"\n", b"\\n")
183
.replace(b"\0", b"\\x00"))
184
return encoded
185
186
def encrypt(self, data, password):
187
passphrase = self.password_encode(password)
188
with tempfile.NamedTemporaryFile(dir=self.tempdir
189
) as passfile:
190
passfile.write(passphrase)
191
passfile.flush()
192
proc = subprocess.Popen(['gpg', '--symmetric',
193
'--passphrase-file',
194
passfile.name]
195
+ self.gnupgargs,
196
stdin = subprocess.PIPE,
197
stdout = subprocess.PIPE,
198
stderr = subprocess.PIPE)
199
ciphertext, err = proc.communicate(input = data)
200
if proc.returncode != 0:
201
raise PGPError(err)
202
return ciphertext
203
204
def decrypt(self, data, password):
205
passphrase = self.password_encode(password)
206
with tempfile.NamedTemporaryFile(dir = self.tempdir
207
) as passfile:
208
passfile.write(passphrase)
209
passfile.flush()
210
proc = subprocess.Popen(['gpg', '--decrypt',
211
'--passphrase-file',
212
passfile.name]
213
+ self.gnupgargs,
214
stdin = subprocess.PIPE,
215
stdout = subprocess.PIPE,
216
stderr = subprocess.PIPE)
217
decrypted_plaintext, err = proc.communicate(input
218
= data)
219
if proc.returncode != 0:
220
raise PGPError(err)
221
return decrypted_plaintext
222
81
82
version = "1.0.14"
83
84
logger = logging.Logger(u'mandos')
85
syslogger = (logging.handlers.SysLogHandler
86
(facility = logging.handlers.SysLogHandler.LOG_DAEMON,
87
address = "/dev/log"))
88
syslogger.setFormatter(logging.Formatter
89
(u'Mandos [%(process)d]: %(levelname)s:'
90
u' %(message)s'))
91
logger.addHandler(syslogger)
92
93
console = logging.StreamHandler()
94
console.setFormatter(logging.Formatter(u'%(name)s [%(process)d]:'
95
u' %(levelname)s:'
96
u' %(message)s'))
97
logger.addHandler(console)
223
98
224
99
class AvahiError(Exception):
225
100
def __init__(self, value, *args, **kwargs):
241
116
Attributes:
242
117
interface: integer; avahi.IF_UNSPEC or an interface index.
243
118
Used to optionally bind to the specified interface.
244
name: string; Example: 'Mandos'
245
type: string; Example: '_mandos._tcp'.
246
See <https://www.iana.org/assignments/service-names-port-numbers>
119
name: string; Example: u'Mandos'
120
type: string; Example: u'_mandos._tcp'.
121
See <http://www.dns-sd.org/ServiceTypes.html>
247
122
port: integer; what port to announce
248
123
TXT: list of strings; TXT record for the service
249
124
domain: string; Domain to publish on, default to .local if empty.
255
130
server: D-Bus Server
256
131
bus: dbus.SystemBus()
257
132
"""
258
259
133
def __init__(self, interface = avahi.IF_UNSPEC, name = None,
260
134
servicetype = None, port = None, TXT = None,
261
domain = "", host = "", max_renames = 32768,
135
domain = u"", host = u"", max_renames = 32768,
262
136
protocol = avahi.PROTO_UNSPEC, bus = None):
263
137
self.interface = interface
264
138
self.name = name
273
147
self.group = None # our entry group
274
148
self.server = None
275
149
self.bus = bus
276
self.entry_group_state_changed_match = None
277
278
150
def rename(self):
279
151
"""Derived from the Avahi example code"""
280
152
if self.rename_count >= self.max_renames:
281
logger.critical("No suitable Zeroconf service name found"
282
" after %i retries, exiting.",
153
logger.critical(u"No suitable Zeroconf service name found"
154
u" after %i retries, exiting.",
283
155
self.rename_count)
284
raise AvahiServiceError("Too many renames")
285
self.name = unicode(self.server
286
.GetAlternativeServiceName(self.name))
287
logger.info("Changing Zeroconf service name to %r ...",
288
self.name)
156
raise AvahiServiceError(u"Too many renames")
157
self.name = self.server.GetAlternativeServiceName(self.name)
158
logger.info(u"Changing Zeroconf service name to %r ...",
159
unicode(self.name))
160
syslogger.setFormatter(logging.Formatter
161
(u'Mandos (%s) [%%(process)d]:'
162
u' %%(levelname)s: %%(message)s'
163
% self.name))
289
164
self.remove()
290
try:
291
self.add()
292
except dbus.exceptions.DBusException as error:
293
logger.critical("D-Bus Exception", exc_info=error)
294
self.cleanup()
295
os._exit(1)
165
self.add()
296
166
self.rename_count += 1
297
298
167
def remove(self):
299
168
"""Derived from the Avahi example code"""
300
if self.entry_group_state_changed_match is not None:
301
self.entry_group_state_changed_match.remove()
302
self.entry_group_state_changed_match = None
303
169
if self.group is not None:
304
170
self.group.Reset()
305
306
171
def add(self):
307
172
"""Derived from the Avahi example code"""
308
self.remove()
309
173
if self.group is None:
310
174
self.group = dbus.Interface(
311
175
self.bus.get_object(avahi.DBUS_NAME,
312
176
self.server.EntryGroupNew()),
313
177
avahi.DBUS_INTERFACE_ENTRY_GROUP)
314
self.entry_group_state_changed_match = (
315
self.group.connect_to_signal(
316
'StateChanged', self.entry_group_state_changed))
317
logger.debug("Adding Zeroconf service '%s' of type '%s' ...",
178
self.group.connect_to_signal('StateChanged',
179
self
180
.entry_group_state_changed)
181
logger.debug(u"Adding Zeroconf service '%s' of type '%s' ...",
318
182
self.name, self.type)
319
183
self.group.AddService(
320
184
self.interface,
325
189
dbus.UInt16(self.port),
326
190
avahi.string_array_to_txt_array(self.TXT))
327
191
self.group.Commit()
328
329
192
def entry_group_state_changed(self, state, error):
330
193
"""Derived from the Avahi example code"""
331
logger.debug("Avahi entry group state change: %i", state)
194
logger.debug(u"Avahi state change: %i", state)
332
195
333
196
if state == avahi.ENTRY_GROUP_ESTABLISHED:
334
logger.debug("Zeroconf service established.")
197
logger.debug(u"Zeroconf service established.")
335
198
elif state == avahi.ENTRY_GROUP_COLLISION:
336
logger.info("Zeroconf service name collision.")
199
logger.warning(u"Zeroconf service name collision.")
337
200
self.rename()
338
201
elif state == avahi.ENTRY_GROUP_FAILURE:
339
logger.critical("Avahi: Error in group state changed %s",
202
logger.critical(u"Avahi: Error in group state changed %s",
340
203
unicode(error))
341
raise AvahiGroupError("State changed: {!s}"
342
.format(error))
343
204
raise AvahiGroupError(u"State changed: %s"
205
% unicode(error))
344
206
def cleanup(self):
345
207
"""Derived from the Avahi example code"""
346
208
if self.group is not None:
347
try:
348
self.group.Free()
349
except (dbus.exceptions.UnknownMethodException,
350
dbus.exceptions.DBusException):
351
pass
209
self.group.Free()
352
210
self.group = None
353
self.remove()
354
355
def server_state_changed(self, state, error=None):
211
def server_state_changed(self, state):
356
212
"""Derived from the Avahi example code"""
357
logger.debug("Avahi server state change: %i", state)
358
bad_states = { avahi.SERVER_INVALID:
359
"Zeroconf server invalid",
360
avahi.SERVER_REGISTERING: None,
361
avahi.SERVER_COLLISION:
362
"Zeroconf server name collision",
363
avahi.SERVER_FAILURE:
364
"Zeroconf server failure" }
365
if state in bad_states:
366
if bad_states[state] is not None:
367
if error is None:
368
logger.error(bad_states[state])
369
else:
370
logger.error(bad_states[state] + ": %r", error)
371
self.cleanup()
213
if state == avahi.SERVER_COLLISION:
214
logger.error(u"Zeroconf server name collision")
215
self.remove()
372
216
elif state == avahi.SERVER_RUNNING:
373
217
self.add()
374
else:
375
if error is None:
376
logger.debug("Unknown state: %r", state)
377
else:
378
logger.debug("Unknown state: %r: %r", state, error)
379
380
218
def activate(self):
381
219
"""Derived from the Avahi example code"""
382
220
if self.server is None:
383
221
self.server = dbus.Interface(
384
222
self.bus.get_object(avahi.DBUS_NAME,
385
avahi.DBUS_PATH_SERVER,
386
follow_name_owner_changes=True),
223
avahi.DBUS_PATH_SERVER),
387
224
avahi.DBUS_INTERFACE_SERVER)
388
self.server.connect_to_signal("StateChanged",
225
self.server.connect_to_signal(u"StateChanged",
389
226
self.server_state_changed)
390
227
self.server_state_changed(self.server.GetState())
391
228
392
229
393
class AvahiServiceToSyslog(AvahiService):
394
def rename(self):
395
"""Add the new name to the syslog messages"""
396
ret = AvahiService.rename(self)
397
syslogger.setFormatter(logging.Formatter
398
('Mandos ({}) [%(process)d]:'
399
' %(levelname)s: %(message)s'
400
.format(self.name)))
401
return ret
402
403
404
def timedelta_to_milliseconds(td):
405
"Convert a datetime.timedelta() to milliseconds"
406
return ((td.days * 24 * 60 * 60 * 1000)
407
+ (td.seconds * 1000)
408
+ (td.microseconds // 1000))
409
410
411
230
class Client(object):
412
231
"""A representation of a client host served by this server.
413
232
414
233
Attributes:
415
approved: bool(); 'None' if not yet approved/disapproved
416
approval_delay: datetime.timedelta(); Time to wait for approval
417
approval_duration: datetime.timedelta(); Duration of one approval
234
name: string; from the config file, used in log messages and
235
D-Bus identifiers
236
fingerprint: string (40 or 32 hexadecimal digits); used to
237
uniquely identify the client
238
secret: bytestring; sent verbatim (over TLS) to client
239
host: string; available for use by the checker command
240
created: datetime.datetime(); (UTC) object creation
241
last_enabled: datetime.datetime(); (UTC)
242
enabled: bool()
243
last_checked_ok: datetime.datetime(); (UTC) or None
244
timeout: datetime.timedelta(); How long from last_checked_ok
245
until this client is invalid
246
interval: datetime.timedelta(); How often to start a new checker
247
disable_hook: If set, called by disable() as disable_hook(self)
418
248
checker: subprocess.Popen(); a running checker process used
419
249
to see if the client lives.
420
250
'None' if no process is running.
421
checker_callback_tag: a gobject event source tag, or None
422
checker_command: string; External command which is run to check
423
if client lives. %() expansions are done at
251
checker_initiator_tag: a gobject event source tag, or None
252
disable_initiator_tag: - '' -
253
checker_callback_tag: - '' -
254
checker_command: string; External command which is run to check if
255
client lives. %() expansions are done at
424
256
runtime with vars(self) as dict, so that for
425
257
instance %(name)s can be used in the command.
426
checker_initiator_tag: a gobject event source tag, or None
427
created: datetime.datetime(); (UTC) object creation
428
client_structure: Object describing what attributes a client has
429
and is used for storing the client at exit
430
258
current_checker_command: string; current running checker_command
431
disable_initiator_tag: a gobject event source tag, or None
432
enabled: bool()
433
fingerprint: string (40 or 32 hexadecimal digits); used to
434
uniquely identify the client
435
host: string; available for use by the checker command
436
interval: datetime.timedelta(); How often to start a new checker
437
last_approval_request: datetime.datetime(); (UTC) or None
438
last_checked_ok: datetime.datetime(); (UTC) or None
439
last_checker_status: integer between 0 and 255 reflecting exit
440
status of last checker. -1 reflects crashed
441
checker, -2 means no checker completed yet.
442
last_enabled: datetime.datetime(); (UTC) or None
443
name: string; from the config file, used in log messages and
444
D-Bus identifiers
445
secret: bytestring; sent verbatim (over TLS) to client
446
timeout: datetime.timedelta(); How long from last_checked_ok
447
until this client is disabled
448
extended_timeout: extra long timeout when secret has been sent
449
runtime_expansions: Allowed attributes for runtime expansion.
450
expires: datetime.datetime(); time (UTC) when a client will be
451
disabled, or None
452
server_settings: The server_settings dict from main()
453
259
"""
454
260
455
runtime_expansions = ("approval_delay", "approval_duration",
456
"created", "enabled", "expires",
457
"fingerprint", "host", "interval",
458
"last_approval_request", "last_checked_ok",
459
"last_enabled", "name", "timeout")
460
client_defaults = { "timeout": "PT5M",
461
"extended_timeout": "PT15M",
462
"interval": "PT2M",
463
"checker": "fping -q -- %%(host)s",
464
"host": "",
465
"approval_delay": "PT0S",
466
"approval_duration": "PT1S",
467
"approved_by_default": "True",
468
"enabled": "True",
469
}
261
@staticmethod
262
def _timedelta_to_milliseconds(td):
263
"Convert a datetime.timedelta() to milliseconds"
264
return ((td.days * 24 * 60 * 60 * 1000)
265
+ (td.seconds * 1000)
266
+ (td.microseconds // 1000))
470
267
471
268
def timeout_milliseconds(self):
472
269
"Return the 'timeout' attribute in milliseconds"
473
return timedelta_to_milliseconds(self.timeout)
474
475
def extended_timeout_milliseconds(self):
476
"Return the 'extended_timeout' attribute in milliseconds"
477
return timedelta_to_milliseconds(self.extended_timeout)
270
return self._timedelta_to_milliseconds(self.timeout)
478
271
479
272
def interval_milliseconds(self):
480
273
"Return the 'interval' attribute in milliseconds"
481
return timedelta_to_milliseconds(self.interval)
482
483
def approval_delay_milliseconds(self):
484
return timedelta_to_milliseconds(self.approval_delay)
485
486
@staticmethod
487
def config_parser(config):
488
"""Construct a new dict of client settings of this form:
489
{ client_name: {setting_name: value, ...}, ...}
490
with exceptions for any special settings as defined above.
491
NOTE: Must be a pure function. Must return the same result
492
value given the same arguments.
493
"""
494
settings = {}
495
for client_name in config.sections():
496
section = dict(config.items(client_name))
497
client = settings[client_name] = {}
498
499
client["host"] = section["host"]
500
# Reformat values from string types to Python types
501
client["approved_by_default"] = config.getboolean(
502
client_name, "approved_by_default")
503
client["enabled"] = config.getboolean(client_name,
504
"enabled")
505
506
client["fingerprint"] = (section["fingerprint"].upper()
507
.replace(" ", ""))
508
if "secret" in section:
509
client["secret"] = section["secret"].decode("base64")
510
elif "secfile" in section:
511
with open(os.path.expanduser(os.path.expandvars
512
(section["secfile"])),
513
"rb") as secfile:
514
client["secret"] = secfile.read()
515
else:
516
raise TypeError("No secret or secfile for section {}"
517
.format(section))
518
client["timeout"] = string_to_delta(section["timeout"])
519
client["extended_timeout"] = string_to_delta(
520
section["extended_timeout"])
521
client["interval"] = string_to_delta(section["interval"])
522
client["approval_delay"] = string_to_delta(
523
section["approval_delay"])
524
client["approval_duration"] = string_to_delta(
525
section["approval_duration"])
526
client["checker_command"] = section["checker"]
527
client["last_approval_request"] = None
528
client["last_checked_ok"] = None
529
client["last_checker_status"] = -2
530
531
return settings
532
533
def __init__(self, settings, name = None, server_settings=None):
274
return self._timedelta_to_milliseconds(self.interval)
275
276
def __init__(self, name = None, disable_hook=None, config=None):
277
"""Note: the 'checker' key in 'config' sets the
278
'checker_command' attribute and *not* the 'checker'
279
attribute."""
534
280
self.name = name
535
if server_settings is None:
536
server_settings = {}
537
self.server_settings = server_settings
538
# adding all client settings
539
for setting, value in settings.items():
540
setattr(self, setting, value)
541
542
if self.enabled:
543
if not hasattr(self, "last_enabled"):
544
self.last_enabled = datetime.datetime.utcnow()
545
if not hasattr(self, "expires"):
546
self.expires = (datetime.datetime.utcnow()
547
+ self.timeout)
548
else:
549
self.last_enabled = None
550
self.expires = None
551
552
logger.debug("Creating client %r", self.name)
281
if config is None:
282
config = {}
283
logger.debug(u"Creating client %r", self.name)
553
284
# Uppercase and remove spaces from fingerprint for later
554
285
# comparison purposes with return value from the fingerprint()
555
286
# function
556
logger.debug(" Fingerprint: %s", self.fingerprint)
557
self.created = settings.get("created",
558
datetime.datetime.utcnow())
559
560
# attributes specific for this server instance
287
self.fingerprint = (config[u"fingerprint"].upper()
288
.replace(u" ", u""))
289
logger.debug(u" Fingerprint: %s", self.fingerprint)
290
if u"secret" in config:
291
self.secret = config[u"secret"].decode(u"base64")
292
elif u"secfile" in config:
293
with closing(open(os.path.expanduser
294
(os.path.expandvars
295
(config[u"secfile"])),
296
"rb")) as secfile:
297
self.secret = secfile.read()
298
else:
299
raise TypeError(u"No secret or secfile for client %s"
300
% self.name)
301
self.host = config.get(u"host", u"")
302
self.created = datetime.datetime.utcnow()
303
self.enabled = False
304
self.last_enabled = None
305
self.last_checked_ok = None
306
self.timeout = string_to_delta(config[u"timeout"])
307
self.interval = string_to_delta(config[u"interval"])
308
self.disable_hook = disable_hook
561
309
self.checker = None
562
310
self.checker_initiator_tag = None
563
311
self.disable_initiator_tag = None
564
312
self.checker_callback_tag = None
313
self.checker_command = config[u"checker"]
565
314
self.current_checker_command = None
566
self.approved = None
567
self.approvals_pending = 0
568
self.changedstate = (multiprocessing_manager
569
.Condition(multiprocessing_manager
570
.Lock()))
571
self.client_structure = [attr for attr in
572
self.__dict__.iterkeys()
573
if not attr.startswith("_")]
574
self.client_structure.append("client_structure")
575
576
for name, t in inspect.getmembers(type(self),
577
lambda obj:
578
isinstance(obj,
579
property)):
580
if not name.startswith("_"):
581
self.client_structure.append(name)
582
583
# Send notice to process children that client state has changed
584
def send_changedstate(self):
585
with self.changedstate:
586
self.changedstate.notify_all()
315
self.last_connect = None
587
316
588
317
def enable(self):
589
318
"""Start this client's checker and timeout hooks"""
590
if getattr(self, "enabled", False):
319
if getattr(self, u"enabled", False):
591
320
# Already enabled
592
321
return
593
self.expires = datetime.datetime.utcnow() + self.timeout
594
self.enabled = True
595
322
self.last_enabled = datetime.datetime.utcnow()
596
self.init_checker()
597
self.send_changedstate()
598
599
def disable(self, quiet=True):
600
"""Disable this client."""
601
if not getattr(self, "enabled", False):
602
return False
603
if not quiet:
604
logger.info("Disabling client %s", self.name)
605
if getattr(self, "disable_initiator_tag", None) is not None:
606
gobject.source_remove(self.disable_initiator_tag)
607
self.disable_initiator_tag = None
608
self.expires = None
609
if getattr(self, "checker_initiator_tag", None) is not None:
610
gobject.source_remove(self.checker_initiator_tag)
611
self.checker_initiator_tag = None
612
self.stop_checker()
613
self.enabled = False
614
if not quiet:
615
self.send_changedstate()
616
# Do not run this again if called by a gobject.timeout_add
617
return False
618
619
def __del__(self):
620
self.disable()
621
622
def init_checker(self):
623
323
# Schedule a new checker to be started an 'interval' from now,
624
324
# and every interval from then on.
625
if self.checker_initiator_tag is not None:
626
gobject.source_remove(self.checker_initiator_tag)
627
325
self.checker_initiator_tag = (gobject.timeout_add
628
326
(self.interval_milliseconds(),
629
327
self.start_checker))
328
# Also start a new checker *right now*.
329
self.start_checker()
630
330
# Schedule a disable() when 'timeout' has passed
631
if self.disable_initiator_tag is not None:
632
gobject.source_remove(self.disable_initiator_tag)
633
331
self.disable_initiator_tag = (gobject.timeout_add
634
332
(self.timeout_milliseconds(),
635
333
self.disable))
636
# Also start a new checker *right now*.
637
self.start_checker()
334
self.enabled = True
335
336
def disable(self):
337
"""Disable this client."""
338
if not getattr(self, "enabled", False):
339
return False
340
logger.info(u"Disabling client %s", self.name)
341
if getattr(self, u"disable_initiator_tag", False):
342
gobject.source_remove(self.disable_initiator_tag)
343
self.disable_initiator_tag = None
344
if getattr(self, u"checker_initiator_tag", False):
345
gobject.source_remove(self.checker_initiator_tag)
346
self.checker_initiator_tag = None
347
self.stop_checker()
348
if self.disable_hook:
349
self.disable_hook(self)
350
self.enabled = False
351
# Do not run this again if called by a gobject.timeout_add
352
return False
353
354
def __del__(self):
355
self.disable_hook = None
356
self.disable()
638
357
639
358
def checker_callback(self, pid, condition, command):
640
359
"""The checker has completed, so take appropriate actions."""
641
360
self.checker_callback_tag = None
642
361
self.checker = None
643
362
if os.WIFEXITED(condition):
644
self.last_checker_status = os.WEXITSTATUS(condition)
645
if self.last_checker_status == 0:
646
logger.info("Checker for %(name)s succeeded",
363
exitstatus = os.WEXITSTATUS(condition)
364
if exitstatus == 0:
365
logger.info(u"Checker for %(name)s succeeded",
647
366
vars(self))
648
367
self.checked_ok()
649
368
else:
650
logger.info("Checker for %(name)s failed",
369
logger.info(u"Checker for %(name)s failed",
651
370
vars(self))
652
371
else:
653
self.last_checker_status = -1
654
logger.warning("Checker for %(name)s crashed?",
372
logger.warning(u"Checker for %(name)s crashed?",
655
373
vars(self))
656
374
657
375
def checked_ok(self):
658
"""Assert that the client has been seen, alive and well."""
376
"""Bump up the timeout for this client.
377
378
This should only be called when the client has been seen,
379
alive and well.
380
"""
659
381
self.last_checked_ok = datetime.datetime.utcnow()
660
self.last_checker_status = 0
661
self.bump_timeout()
662
663
def bump_timeout(self, timeout=None):
664
"""Bump up the timeout for this client."""
665
if timeout is None:
666
timeout = self.timeout
667
if self.disable_initiator_tag is not None:
668
gobject.source_remove(self.disable_initiator_tag)
669
self.disable_initiator_tag = None
670
if getattr(self, "enabled", False):
671
self.disable_initiator_tag = (gobject.timeout_add
672
(timedelta_to_milliseconds
673
(timeout), self.disable))
674
self.expires = datetime.datetime.utcnow() + timeout
675
676
def need_approval(self):
677
self.last_approval_request = datetime.datetime.utcnow()
382
gobject.source_remove(self.disable_initiator_tag)
383
self.disable_initiator_tag = (gobject.timeout_add
384
(self.timeout_milliseconds(),
385
self.disable))
678
386
679
387
def start_checker(self):
680
388
"""Start a new checker subprocess if one is not running.
682
390
If a checker already exists, leave it running and do
683
391
nothing."""
684
392
# The reason for not killing a running checker is that if we
685
# did that, and if a checker (for some reason) started running
686
# slowly and taking more than 'interval' time, then the client
687
# would inevitably timeout, since no checker would get a
688
# chance to run to completion. If we instead leave running
393
# did that, then if a checker (for some reason) started
394
# running slowly and taking more than 'interval' time, the
395
# client would inevitably timeout, since no checker would get
396
# a chance to run to completion. If we instead leave running
689
397
# checkers alone, the checker would have to take more time
690
# than 'timeout' for the client to be disabled, which is as it
691
# should be.
398
# than 'timeout' for the client to be declared invalid, which
399
# is as it should be.
692
400
693
401
# If a checker exists, make sure it is not a zombie
694
402
try:
695
403
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
696
except AttributeError:
697
pass
698
except OSError as error:
699
if error.errno != errno.ECHILD:
700
raise
404
except (AttributeError, OSError), error:
405
if (isinstance(error, OSError)
406
and error.errno != errno.ECHILD):
407
raise error
701
408
else:
702
409
if pid:
703
logger.warning("Checker was a zombie")
410
logger.warning(u"Checker was a zombie")
704
411
gobject.source_remove(self.checker_callback_tag)
705
412
self.checker_callback(pid, status,
706
413
self.current_checker_command)
707
414
# Start a new checker if needed
708
415
if self.checker is None:
709
# Escape attributes for the shell
710
escaped_attrs = { attr:
711
re.escape(unicode(getattr(self,
712
attr)))
713
for attr in self.runtime_expansions }
714
416
try:
715
command = self.checker_command % escaped_attrs
716
except TypeError as error:
717
logger.error('Could not format string "%s"',
718
self.checker_command, exc_info=error)
719
return True # Try again later
417
# In case checker_command has exactly one % operator
418
command = self.checker_command % self.host
419
except TypeError:
420
# Escape attributes for the shell
421
escaped_attrs = dict((key,
422
re.escape(unicode(str(val),
423
errors=
424
u'replace')))
425
for key, val in
426
vars(self).iteritems())
427
try:
428
command = self.checker_command % escaped_attrs
429
except TypeError, error:
430
logger.error(u'Could not format string "%s":'
431
u' %s', self.checker_command, error)
432
return True # Try again later
720
433
self.current_checker_command = command
721
434
try:
722
logger.info("Starting checker %r for %s",
435
logger.info(u"Starting checker %r for %s",
723
436
command, self.name)
724
437
# We don't need to redirect stdout and stderr, since
725
438
# in normal mode, that is already done by daemon(),
726
439
# and in debug mode we don't want to. (Stdin is
727
440
# always replaced by /dev/null.)
728
# The exception is when not debugging but nevertheless
729
# running in the foreground; use the previously
730
# created wnull.
731
popen_args = {}
732
if (not self.server_settings["debug"]
733
and self.server_settings["foreground"]):
734
popen_args.update({"stdout": wnull,
735
"stderr": wnull })
736
441
self.checker = subprocess.Popen(command,
737
442
close_fds=True,
738
shell=True, cwd="/",
739
**popen_args)
740
except OSError as error:
741
logger.error("Failed to start subprocess",
742
exc_info=error)
743
return True
744
self.checker_callback_tag = (gobject.child_watch_add
745
(self.checker.pid,
746
self.checker_callback,
747
data=command))
748
# The checker may have completed before the gobject
749
# watch was added. Check for this.
750
try:
443
shell=True, cwd=u"/")
444
self.checker_callback_tag = (gobject.child_watch_add
445
(self.checker.pid,
446
self.checker_callback,
447
data=command))
448
# The checker may have completed before the gobject
449
# watch was added. Check for this.
751
450
pid, status = os.waitpid(self.checker.pid, os.WNOHANG)
752
except OSError as error:
753
if error.errno == errno.ECHILD:
754
# This should never happen
755
logger.error("Child process vanished",
756
exc_info=error)
757
return True
758
raise
759
if pid:
760
gobject.source_remove(self.checker_callback_tag)
761
self.checker_callback(pid, status, command)
451
if pid:
452
gobject.source_remove(self.checker_callback_tag)
453
self.checker_callback(pid, status, command)
454
except OSError, error:
455
logger.error(u"Failed to start subprocess: %s",
456
error)
762
457
# Re-run this periodically if run by gobject.timeout_add
763
458
return True
764
459
767
462
if self.checker_callback_tag:
768
463
gobject.source_remove(self.checker_callback_tag)
769
464
self.checker_callback_tag = None
770
if getattr(self, "checker", None) is None:
465
if getattr(self, u"checker", None) is None:
771
466
return
772
logger.debug("Stopping checker for %(name)s", vars(self))
467
logger.debug(u"Stopping checker for %(name)s", vars(self))
773
468
try:
774
self.checker.terminate()
775
#time.sleep(0.5)
469
os.kill(self.checker.pid, signal.SIGTERM)
470
#os.sleep(0.5)
776
471
#if self.checker.poll() is None:
777
# self.checker.kill()
778
except OSError as error:
472
# os.kill(self.checker.pid, signal.SIGKILL)
473
except OSError, error:
779
474
if error.errno != errno.ESRCH: # No such process
780
475
raise
781
476
self.checker = None
782
783
784
def dbus_service_property(dbus_interface, signature="v",
785
access="readwrite", byte_arrays=False):
477
478
def still_valid(self):
479
"""Has the timeout not yet passed for this client?"""
480
if not getattr(self, u"enabled", False):
481
return False
482
now = datetime.datetime.utcnow()
483
if self.last_checked_ok is None:
484
return now < (self.created + self.timeout)
485
else:
486
return now < (self.last_checked_ok + self.timeout)
487
488
489
def dbus_service_property(dbus_interface, signature=u"v",
490
access=u"readwrite", byte_arrays=False):
786
491
"""Decorators for marking methods of a DBusObjectWithProperties to
787
492
become properties on the D-Bus.
788
493
793
498
dbus.service.method, except there is only "signature", since the
794
499
type from Get() and the type sent to Set() is the same.
795
500
"""
796
# Encoding deeply encoded byte arrays is not supported yet by the
797
# "Set" method, so we fail early here:
798
if byte_arrays and signature != "ay":
799
raise ValueError("Byte arrays not supported for non-'ay'"
800
" signature {!r}".format(signature))
801
501
def decorator(func):
802
502
func._dbus_is_property = True
803
503
func._dbus_interface = dbus_interface
804
504
func._dbus_signature = signature
805
505
func._dbus_access = access
806
506
func._dbus_name = func.__name__
807
if func._dbus_name.endswith("_dbus_property"):
507
if func._dbus_name.endswith(u"_dbus_property"):
808
508
func._dbus_name = func._dbus_name[:-14]
809
func._dbus_get_args_options = {'byte_arrays': byte_arrays }
810
return func
811
return decorator
812
813
814
def dbus_interface_annotations(dbus_interface):
815
"""Decorator for marking functions returning interface annotations
816
817
Usage:
818
819
@dbus_interface_annotations("org.example.Interface")
820
def _foo(self): # Function name does not matter
821
return {"org.freedesktop.DBus.Deprecated": "true",
822
"org.freedesktop.DBus.Property.EmitsChangedSignal":
823
"false"}
824
"""
825
def decorator(func):
826
func._dbus_is_interface = True
827
func._dbus_interface = dbus_interface
828
func._dbus_name = dbus_interface
829
return func
830
return decorator
831
832
833
def dbus_annotations(annotations):
834
"""Decorator to annotate D-Bus methods, signals or properties
835
Usage:
836
837
@dbus_service_property("org.example.Interface", signature="b",
838
access="r")
839
@dbus_annotations({{"org.freedesktop.DBus.Deprecated": "true",
840
"org.freedesktop.DBus.Property."
841
"EmitsChangedSignal": "false"})
842
def Property_dbus_property(self):
843
return dbus.Boolean(False)
844
"""
845
def decorator(func):
846
func._dbus_annotations = annotations
509
func._dbus_get_args_options = {u'byte_arrays': byte_arrays }
847
510
return func
848
511
return decorator
849
512
869
532
870
533
class DBusObjectWithProperties(dbus.service.Object):
871
534
"""A D-Bus object with properties.
872
535
873
536
Classes inheriting from this can use the dbus_service_property
874
537
decorator to expose methods as D-Bus properties. It exposes the
875
538
standard Get(), Set(), and GetAll() methods on the D-Bus.
876
539
"""
877
540
878
541
@staticmethod
879
def _is_dbus_thing(thing):
880
"""Returns a function testing if an attribute is a D-Bus thing
881
882
If called like _is_dbus_thing("method") it returns a function
883
suitable for use as predicate to inspect.getmembers().
884
"""
885
return lambda obj: getattr(obj, "_dbus_is_{}".format(thing),
886
False)
542
def _is_dbus_property(obj):
543
return getattr(obj, u"_dbus_is_property", False)
887
544
888
def _get_all_dbus_things(self, thing):
545
def _get_all_dbus_properties(self):
889
546
"""Returns a generator of (name, attribute) pairs
890
547
"""
891
return ((getattr(athing.__get__(self), "_dbus_name",
892
name),
893
athing.__get__(self))
894
for cls in self.__class__.__mro__
895
for name, athing in
896
inspect.getmembers(cls,
897
self._is_dbus_thing(thing)))
548
return ((prop._dbus_name, prop)
549
for name, prop in
550
inspect.getmembers(self, self._is_dbus_property))
898
551
899
552
def _get_dbus_property(self, interface_name, property_name):
900
553
"""Returns a bound method if one exists which is a D-Bus
901
554
property with the specified name and interface.
902
555
"""
903
for cls in self.__class__.__mro__:
904
for name, value in (inspect.getmembers
905
(cls,
906
self._is_dbus_thing("property"))):
907
if (value._dbus_name == property_name
908
and value._dbus_interface == interface_name):
909
return value.__get__(self)
910
556
for name in (property_name,
557
property_name + u"_dbus_property"):
558
prop = getattr(self, name, None)
559
if (prop is None
560
or not self._is_dbus_property(prop)
561
or prop._dbus_name != property_name
562
or (interface_name and prop._dbus_interface
563
and interface_name != prop._dbus_interface)):
564
continue
565
return prop
911
566
# No such property
912
raise DBusPropertyNotFound(self.dbus_object_path + ":"
913
+ interface_name + "."
567
raise DBusPropertyNotFound(self.dbus_object_path + u":"
568
+ interface_name + u"."
914
569
+ property_name)
915
570
916
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ss",
917
out_signature="v")
571
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ss",
572
out_signature=u"v")
918
573
def Get(self, interface_name, property_name):
919
574
"""Standard D-Bus property Get() method, see D-Bus standard.
920
575
"""
921
576
prop = self._get_dbus_property(interface_name, property_name)
922
if prop._dbus_access == "write":
577
if prop._dbus_access == u"write":
923
578
raise DBusPropertyAccessException(property_name)
924
579
value = prop()
925
if not hasattr(value, "variant_level"):
580
if not hasattr(value, u"variant_level"):
926
581
return value
927
582
return type(value)(value, variant_level=value.variant_level+1)
928
583
929
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="ssv")
584
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"ssv")
930
585
def Set(self, interface_name, property_name, value):
931
586
"""Standard D-Bus property Set() method, see D-Bus standard.
932
587
"""
933
588
prop = self._get_dbus_property(interface_name, property_name)
934
if prop._dbus_access == "read":
589
if prop._dbus_access == u"read":
935
590
raise DBusPropertyAccessException(property_name)
936
if prop._dbus_get_args_options["byte_arrays"]:
937
# The byte_arrays option is not supported yet on
938
# signatures other than "ay".
939
if prop._dbus_signature != "ay":
940
raise ValueError("Byte arrays not supported for non-"
941
"'ay' signature {!r}"
942
.format(prop._dbus_signature))
943
value = dbus.ByteArray(b''.join(chr(byte)
944
for byte in value))
591
if prop._dbus_get_args_options[u"byte_arrays"]:
592
value = dbus.ByteArray(''.join(unichr(byte)
593
for byte in value))
945
594
prop(value)
946
595
947
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature="s",
948
out_signature="a{sv}")
596
@dbus.service.method(dbus.PROPERTIES_IFACE, in_signature=u"s",
597
out_signature=u"a{sv}")
949
598
def GetAll(self, interface_name):
950
599
"""Standard D-Bus property GetAll() method, see D-Bus
951
600
standard.
952
601
953
602
Note: Will not include properties with access="write".
954
603
"""
955
properties = {}
956
for name, prop in self._get_all_dbus_things("property"):
604
all = {}
605
for name, prop in self._get_all_dbus_properties():
957
606
if (interface_name
958
607
and interface_name != prop._dbus_interface):
959
608
# Interface non-empty but did not match
960
609
continue
961
610
# Ignore write-only properties
962
if prop._dbus_access == "write":
611
if prop._dbus_access == u"write":
963
612
continue
964
613
value = prop()
965
if not hasattr(value, "variant_level"):
966
properties[name] = value
614
if not hasattr(value, u"variant_level"):
615
all[name] = value
967
616
continue
968
properties[name] = type(value)(value, variant_level=
969
value.variant_level+1)
970
return dbus.Dictionary(properties, signature="sv")
617
all[name] = type(value)(value, variant_level=
618
value.variant_level+1)
619
return dbus.Dictionary(all, signature=u"sv")
971
620
972
621
@dbus.service.method(dbus.INTROSPECTABLE_IFACE,
973
out_signature="s",
622
out_signature=u"s",
974
623
path_keyword='object_path',
975
624
connection_keyword='connection')
976
625
def Introspect(self, object_path, connection):
977
"""Overloading of standard D-Bus method.
978
979
Inserts property tags and interface annotation tags.
626
"""Standard D-Bus method, overloaded to insert property tags.
980
627
"""
981
628
xmlstring = dbus.service.Object.Introspect(self, object_path,
982
629
connection)
983
630
try:
984
631
document = xml.dom.minidom.parseString(xmlstring)
985
632
def make_tag(document, name, prop):
986
e = document.createElement("property")
987
e.setAttribute("name", name)
988
e.setAttribute("type", prop._dbus_signature)
989
e.setAttribute("access", prop._dbus_access)
633
e = document.createElement(u"property")
634
e.setAttribute(u"name", name)
635
e.setAttribute(u"type", prop._dbus_signature)
636
e.setAttribute(u"access", prop._dbus_access)
990
637
return e
991
for if_tag in document.getElementsByTagName("interface"):
992
# Add property tags
638
for if_tag in document.getElementsByTagName(u"interface"):
993
639
for tag in (make_tag(document, name, prop)
994
640
for name, prop
995
in self._get_all_dbus_things("property")
641
in self._get_all_dbus_properties()
996
642
if prop._dbus_interface
997
== if_tag.getAttribute("name")):
643
== if_tag.getAttribute(u"name")):
998
644
if_tag.appendChild(tag)
999
# Add annotation tags
1000
for typ in ("method", "signal", "property"):
1001
for tag in if_tag.getElementsByTagName(typ):
1002
annots = dict()
1003
for name, prop in (self.
1004
_get_all_dbus_things(typ)):
1005
if (name == tag.getAttribute("name")
1006
and prop._dbus_interface
1007
== if_tag.getAttribute("name")):
1008
annots.update(getattr
1009
(prop,
1010
"_dbus_annotations",
1011
{}))
1012
for name, value in annots.items():
1013
ann_tag = document.createElement(
1014
"annotation")
1015
ann_tag.setAttribute("name", name)
1016
ann_tag.setAttribute("value", value)
1017
tag.appendChild(ann_tag)
1018
# Add interface annotation tags
1019
for annotation, value in dict(
1020
itertools.chain.from_iterable(
1021
annotations().items()
1022
for name, annotations in
1023
self._get_all_dbus_things("interface")
1024
if name == if_tag.getAttribute("name")
1025
)).items():
1026
ann_tag = document.createElement("annotation")
1027
ann_tag.setAttribute("name", annotation)
1028
ann_tag.setAttribute("value", value)
1029
if_tag.appendChild(ann_tag)
1030
645
# Add the names to the return values for the
1031
646
# "org.freedesktop.DBus.Properties" methods
1032
if (if_tag.getAttribute("name")
1033
== "org.freedesktop.DBus.Properties"):
1034
for cn in if_tag.getElementsByTagName("method"):
1035
if cn.getAttribute("name") == "Get":
1036
for arg in cn.getElementsByTagName("arg"):
1037
if (arg.getAttribute("direction")
1038
== "out"):
1039
arg.setAttribute("name", "value")
1040
elif cn.getAttribute("name") == "GetAll":
1041
for arg in cn.getElementsByTagName("arg"):
1042
if (arg.getAttribute("direction")
1043
== "out"):
1044
arg.setAttribute("name", "props")
1045
xmlstring = document.toxml("utf-8")
647
if (if_tag.getAttribute(u"name")
648
== u"org.freedesktop.DBus.Properties"):
649
for cn in if_tag.getElementsByTagName(u"method"):
650
if cn.getAttribute(u"name") == u"Get":
651
for arg in cn.getElementsByTagName(u"arg"):
652
if (arg.getAttribute(u"direction")
653
== u"out"):
654
arg.setAttribute(u"name", u"value")
655
elif cn.getAttribute(u"name") == u"GetAll":
656
for arg in cn.getElementsByTagName(u"arg"):
657
if (arg.getAttribute(u"direction")
658
== u"out"):
659
arg.setAttribute(u"name", u"props")
660
xmlstring = document.toxml(u"utf-8")
1046
661
document.unlink()
1047
662
except (AttributeError, xml.dom.DOMException,
1048
xml.parsers.expat.ExpatError) as error:
1049
logger.error("Failed to override Introspection method",
1050
exc_info=error)
663
xml.parsers.expat.ExpatError), error:
664
logger.error(u"Failed to override Introspection method",
665
error)
1051
666
return xmlstring
1052
667
1053
668
1054
def datetime_to_dbus(dt, variant_level=0):
1055
"""Convert a UTC datetime.datetime() to a D-Bus type."""
1056
if dt is None:
1057
return dbus.String("", variant_level = variant_level)
1058
return dbus.String(dt.isoformat(),
1059
variant_level=variant_level)
1060
1061
1062
def alternate_dbus_interfaces(alt_interface_names, deprecate=True):
1063
"""A class decorator; applied to a subclass of
1064
dbus.service.Object, it will add alternate D-Bus attributes with
1065
interface names according to the "alt_interface_names" mapping.
1066
Usage:
1067
1068
@alternate_dbus_interfaces({"org.example.Interface":
1069
"net.example.AlternateInterface"})
1070
class SampleDBusObject(dbus.service.Object):
1071
@dbus.service.method("org.example.Interface")
1072
def SampleDBusMethod():
1073
pass
1074
1075
The above "SampleDBusMethod" on "SampleDBusObject" will be
1076
reachable via two interfaces: "org.example.Interface" and
1077
"net.example.AlternateInterface", the latter of which will have
1078
its D-Bus annotation "org.freedesktop.DBus.Deprecated" set to
1079
"true", unless "deprecate" is passed with a False value.
1080
1081
This works for methods and signals, and also for D-Bus properties
1082
(from DBusObjectWithProperties) and interfaces (from the
1083
dbus_interface_annotations decorator).
1084
"""
1085
def wrapper(cls):
1086
for orig_interface_name, alt_interface_name in (
1087
alt_interface_names.items()):
1088
attr = {}
1089
interface_names = set()
1090
# Go though all attributes of the class
1091
for attrname, attribute in inspect.getmembers(cls):
1092
# Ignore non-D-Bus attributes, and D-Bus attributes
1093
# with the wrong interface name
1094
if (not hasattr(attribute, "_dbus_interface")
1095
or not attribute._dbus_interface
1096
.startswith(orig_interface_name)):
1097
continue
1098
# Create an alternate D-Bus interface name based on
1099
# the current name
1100
alt_interface = (attribute._dbus_interface
1101
.replace(orig_interface_name,
1102
alt_interface_name))
1103
interface_names.add(alt_interface)
1104
# Is this a D-Bus signal?
1105
if getattr(attribute, "_dbus_is_signal", False):
1106
# Extract the original non-method undecorated
1107
# function by black magic
1108
nonmethod_func = (dict(
1109
zip(attribute.func_code.co_freevars,
1110
attribute.__closure__))["func"]
1111
.cell_contents)
1112
# Create a new, but exactly alike, function
1113
# object, and decorate it to be a new D-Bus signal
1114
# with the alternate D-Bus interface name
1115
new_function = (dbus.service.signal
1116
(alt_interface,
1117
attribute._dbus_signature)
1118
(types.FunctionType(
1119
nonmethod_func.func_code,
1120
nonmethod_func.func_globals,
1121
nonmethod_func.func_name,
1122
nonmethod_func.func_defaults,
1123
nonmethod_func.func_closure)))
1124
# Copy annotations, if any
1125
try:
1126
new_function._dbus_annotations = (
1127
dict(attribute._dbus_annotations))
1128
except AttributeError:
1129
pass
1130
# Define a creator of a function to call both the
1131
# original and alternate functions, so both the
1132
# original and alternate signals gets sent when
1133
# the function is called
1134
def fixscope(func1, func2):
1135
"""This function is a scope container to pass
1136
func1 and func2 to the "call_both" function
1137
outside of its arguments"""
1138
def call_both(*args, **kwargs):
1139
"""This function will emit two D-Bus
1140
signals by calling func1 and func2"""
1141
func1(*args, **kwargs)
1142
func2(*args, **kwargs)
1143
return call_both
1144
# Create the "call_both" function and add it to
1145
# the class
1146
attr[attrname] = fixscope(attribute, new_function)
1147
# Is this a D-Bus method?
1148
elif getattr(attribute, "_dbus_is_method", False):
1149
# Create a new, but exactly alike, function
1150
# object. Decorate it to be a new D-Bus method
1151
# with the alternate D-Bus interface name. Add it
1152
# to the class.
1153
attr[attrname] = (dbus.service.method
1154
(alt_interface,
1155
attribute._dbus_in_signature,
1156
attribute._dbus_out_signature)
1157
(types.FunctionType
1158
(attribute.func_code,
1159
attribute.func_globals,
1160
attribute.func_name,
1161
attribute.func_defaults,
1162
attribute.func_closure)))
1163
# Copy annotations, if any
1164
try:
1165
attr[attrname]._dbus_annotations = (
1166
dict(attribute._dbus_annotations))
1167
except AttributeError:
1168
pass
1169
# Is this a D-Bus property?
1170
elif getattr(attribute, "_dbus_is_property", False):
1171
# Create a new, but exactly alike, function
1172
# object, and decorate it to be a new D-Bus
1173
# property with the alternate D-Bus interface
1174
# name. Add it to the class.
1175
attr[attrname] = (dbus_service_property
1176
(alt_interface,
1177
attribute._dbus_signature,
1178
attribute._dbus_access,
1179
attribute
1180
._dbus_get_args_options
1181
["byte_arrays"])
1182
(types.FunctionType
1183
(attribute.func_code,
1184
attribute.func_globals,
1185
attribute.func_name,
1186
attribute.func_defaults,
1187
attribute.func_closure)))
1188
# Copy annotations, if any
1189
try:
1190
attr[attrname]._dbus_annotations = (
1191
dict(attribute._dbus_annotations))
1192
except AttributeError:
1193
pass
1194
# Is this a D-Bus interface?
1195
elif getattr(attribute, "_dbus_is_interface", False):
1196
# Create a new, but exactly alike, function
1197
# object. Decorate it to be a new D-Bus interface
1198
# with the alternate D-Bus interface name. Add it
1199
# to the class.
1200
attr[attrname] = (dbus_interface_annotations
1201
(alt_interface)
1202
(types.FunctionType
1203
(attribute.func_code,
1204
attribute.func_globals,
1205
attribute.func_name,
1206
attribute.func_defaults,
1207
attribute.func_closure)))
1208
if deprecate:
1209
# Deprecate all alternate interfaces
1210
iname="_AlternateDBusNames_interface_annotation{}"
1211
for interface_name in interface_names:
1212
@dbus_interface_annotations(interface_name)
1213
def func(self):
1214
return { "org.freedesktop.DBus.Deprecated":
1215
"true" }
1216
# Find an unused name
1217
for aname in (iname.format(i)
1218
for i in itertools.count()):
1219
if aname not in attr:
1220
attr[aname] = func
1221
break
1222
if interface_names:
1223
# Replace the class with a new subclass of it with
1224
# methods, signals, etc. as created above.
1225
cls = type(b"{}Alternate".format(cls.__name__),
1226
(cls,), attr)
1227
return cls
1228
return wrapper
1229
1230
1231
@alternate_dbus_interfaces({"se.recompile.Mandos":
1232
"se.bsnet.fukt.Mandos"})
1233
669
class ClientDBus(Client, DBusObjectWithProperties):
1234
670
"""A Client class using D-Bus
1235
671
1237
673
dbus_object_path: dbus.ObjectPath
1238
674
bus: dbus.SystemBus()
1239
675
"""
1240
1241
runtime_expansions = (Client.runtime_expansions
1242
+ ("dbus_object_path",))
1243
1244
676
# dbus.service.Object doesn't use super(), so we can't either.
1245
677
1246
678
def __init__(self, bus = None, *args, **kwargs):
1248
680
Client.__init__(self, *args, **kwargs)
1249
681
# Only now, when this client is initialized, can it show up on
1250
682
# the D-Bus
1251
client_object_name = unicode(self.name).translate(
1252
{ord("."): ord("_"),
1253
ord("-"): ord("_")})
1254
683
self.dbus_object_path = (dbus.ObjectPath
1255
("/clients/" + client_object_name))
684
(u"/clients/"
685
+ self.name.replace(u".", u"_")))
1256
686
DBusObjectWithProperties.__init__(self, self.bus,
1257
687
self.dbus_object_path)
1258
688
1259
def notifychangeproperty(transform_func,
1260
dbus_name, type_func=lambda x: x,
1261
variant_level=1):
1262
""" Modify a variable so that it's a property which announces
1263
its changes to DBus.
1264
1265
transform_fun: Function that takes a value and a variant_level
1266
and transforms it to a D-Bus type.
1267
dbus_name: D-Bus name of the variable
1268
type_func: Function that transform the value before sending it
1269
to the D-Bus. Default: no transform
1270
variant_level: D-Bus variant level. Default: 1
1271
"""
1272
attrname = "_{}".format(dbus_name)
1273
def setter(self, value):
1274
if hasattr(self, "dbus_object_path"):
1275
if (not hasattr(self, attrname) or
1276
type_func(getattr(self, attrname, None))
1277
!= type_func(value)):
1278
dbus_value = transform_func(type_func(value),
1279
variant_level
1280
=variant_level)
1281
self.PropertyChanged(dbus.String(dbus_name),
1282
dbus_value)
1283
setattr(self, attrname, value)
1284
1285
return property(lambda self: getattr(self, attrname), setter)
1286
1287
expires = notifychangeproperty(datetime_to_dbus, "Expires")
1288
approvals_pending = notifychangeproperty(dbus.Boolean,
1289
"ApprovalPending",
1290
type_func = bool)
1291
enabled = notifychangeproperty(dbus.Boolean, "Enabled")
1292
last_enabled = notifychangeproperty(datetime_to_dbus,
1293
"LastEnabled")
1294
checker = notifychangeproperty(dbus.Boolean, "CheckerRunning",
1295
type_func = lambda checker:
1296
checker is not None)
1297
last_checked_ok = notifychangeproperty(datetime_to_dbus,
1298
"LastCheckedOK")
1299
last_checker_status = notifychangeproperty(dbus.Int16,
1300
"LastCheckerStatus")
1301
last_approval_request = notifychangeproperty(
1302
datetime_to_dbus, "LastApprovalRequest")
1303
approved_by_default = notifychangeproperty(dbus.Boolean,
1304
"ApprovedByDefault")
1305
approval_delay = notifychangeproperty(dbus.UInt64,
1306
"ApprovalDelay",
1307
type_func =
1308
timedelta_to_milliseconds)
1309
approval_duration = notifychangeproperty(
1310
dbus.UInt64, "ApprovalDuration",
1311
type_func = timedelta_to_milliseconds)
1312
host = notifychangeproperty(dbus.String, "Host")
1313
timeout = notifychangeproperty(dbus.UInt64, "Timeout",
1314
type_func =
1315
timedelta_to_milliseconds)
1316
extended_timeout = notifychangeproperty(
1317
dbus.UInt64, "ExtendedTimeout",
1318
type_func = timedelta_to_milliseconds)
1319
interval = notifychangeproperty(dbus.UInt64,
1320
"Interval",
1321
type_func =
1322
timedelta_to_milliseconds)
1323
checker_command = notifychangeproperty(dbus.String, "Checker")
1324
1325
del notifychangeproperty
689
@staticmethod
690
def _datetime_to_dbus(dt, variant_level=0):
691
"""Convert a UTC datetime.datetime() to a D-Bus type."""
692
return dbus.String(dt.isoformat(),
693
variant_level=variant_level)
694
695
def enable(self):
696
oldstate = getattr(self, u"enabled", False)
697
r = Client.enable(self)
698
if oldstate != self.enabled:
699
# Emit D-Bus signals
700
self.PropertyChanged(dbus.String(u"enabled"),
701
dbus.Boolean(True, variant_level=1))
702
self.PropertyChanged(
703
dbus.String(u"last_enabled"),
704
self._datetime_to_dbus(self.last_enabled,
705
variant_level=1))
706
return r
707
708
def disable(self, signal = True):
709
oldstate = getattr(self, u"enabled", False)
710
r = Client.disable(self)
711
if signal and oldstate != self.enabled:
712
# Emit D-Bus signal
713
self.PropertyChanged(dbus.String(u"enabled"),
714
dbus.Boolean(False, variant_level=1))
715
return r
1326
716
1327
717
def __del__(self, *args, **kwargs):
1328
718
try:
1329
719
self.remove_from_connection()
1330
720
except LookupError:
1331
721
pass
1332
if hasattr(DBusObjectWithProperties, "__del__"):
722
if hasattr(DBusObjectWithProperties, u"__del__"):
1333
723
DBusObjectWithProperties.__del__(self, *args, **kwargs)
1334
724
Client.__del__(self, *args, **kwargs)
1335
725
1337
727
*args, **kwargs):
1338
728
self.checker_callback_tag = None
1339
729
self.checker = None
730
# Emit D-Bus signal
731
self.PropertyChanged(dbus.String(u"checker_running"),
732
dbus.Boolean(False, variant_level=1))
1340
733
if os.WIFEXITED(condition):
1341
734
exitstatus = os.WEXITSTATUS(condition)
1342
735
# Emit D-Bus signal
1352
745
return Client.checker_callback(self, pid, condition, command,
1353
746
*args, **kwargs)
1354
747
748
def checked_ok(self, *args, **kwargs):
749
r = Client.checked_ok(self, *args, **kwargs)
750
# Emit D-Bus signal
751
self.PropertyChanged(
752
dbus.String(u"last_checked_ok"),
753
(self._datetime_to_dbus(self.last_checked_ok,
754
variant_level=1)))
755
return r
756
1355
757
def start_checker(self, *args, **kwargs):
1356
old_checker_pid = getattr(self.checker, "pid", None)
758
old_checker = self.checker
759
if self.checker is not None:
760
old_checker_pid = self.checker.pid
761
else:
762
old_checker_pid = None
1357
763
r = Client.start_checker(self, *args, **kwargs)
1358
764
# Only if new checker process was started
1359
765
if (self.checker is not None
1360
766
and old_checker_pid != self.checker.pid):
1361
767
# Emit D-Bus signal
1362
768
self.CheckerStarted(self.current_checker_command)
1363
return r
1364
1365
def _reset_approved(self):
1366
self.approved = None
1367
return False
1368
1369
def approve(self, value=True):
1370
self.approved = value
1371
gobject.timeout_add(timedelta_to_milliseconds
1372
(self.approval_duration),
1373
self._reset_approved)
1374
self.send_changedstate()
1375
1376
## D-Bus methods, signals & properties
1377
_interface = "se.recompile.Mandos.Client"
1378
1379
## Interfaces
1380
1381
@dbus_interface_annotations(_interface)
1382
def _foo(self):
1383
return { "org.freedesktop.DBus.Property.EmitsChangedSignal":
1384
"false"}
1385
1386
## Signals
769
self.PropertyChanged(
770
dbus.String(u"checker_running"),
771
dbus.Boolean(True, variant_level=1))
772
return r
773
774
def stop_checker(self, *args, **kwargs):
775
old_checker = getattr(self, u"checker", None)
776
r = Client.stop_checker(self, *args, **kwargs)
777
if (old_checker is not None
778
and getattr(self, u"checker", None) is None):
779
self.PropertyChanged(dbus.String(u"checker_running"),
780
dbus.Boolean(False, variant_level=1))
781
return r
782
783
## D-Bus methods & signals
784
_interface = u"se.bsnet.fukt.Mandos.Client"
785
786
# CheckedOK - method
787
@dbus.service.method(_interface)
788
def CheckedOK(self):
789
return self.checked_ok()
1387
790
1388
791
# CheckerCompleted - signal
1389
@dbus.service.signal(_interface, signature="nxs")
792
@dbus.service.signal(_interface, signature=u"nxs")
1390
793
def CheckerCompleted(self, exitcode, waitstatus, command):
1391
794
"D-Bus signal"
1392
795
pass
1393
796
1394
797
# CheckerStarted - signal
1395
@dbus.service.signal(_interface, signature="s")
798
@dbus.service.signal(_interface, signature=u"s")
1396
799
def CheckerStarted(self, command):
1397
800
"D-Bus signal"
1398
801
pass
1399
802
1400
803
# PropertyChanged - signal
1401
@dbus.service.signal(_interface, signature="sv")
804
@dbus.service.signal(_interface, signature=u"sv")
1402
805
def PropertyChanged(self, property, value):
1403
806
"D-Bus signal"
1404
807
pass
1406
809
# GotSecret - signal
1407
810
@dbus.service.signal(_interface)
1408
811
def GotSecret(self):
1409
"""D-Bus signal
1410
Is sent after a successful transfer of secret from the Mandos
1411
server to mandos-client
1412
"""
812
"D-Bus signal"
1413
813
pass
1414
814
1415
815
# Rejected - signal
1416
@dbus.service.signal(_interface, signature="s")
1417
def Rejected(self, reason):
816
@dbus.service.signal(_interface)
817
def Rejected(self):
1418
818
"D-Bus signal"
1419
819
pass
1420
820
1421
# NeedApproval - signal
1422
@dbus.service.signal(_interface, signature="tb")
1423
def NeedApproval(self, timeout, default):
1424
"D-Bus signal"
1425
return self.need_approval()
1426
1427
## Methods
1428
1429
# Approve - method
1430
@dbus.service.method(_interface, in_signature="b")
1431
def Approve(self, value):
1432
self.approve(value)
1433
1434
# CheckedOK - method
1435
@dbus.service.method(_interface)
1436
def CheckedOK(self):
1437
self.checked_ok()
1438
1439
821
# Enable - method
1440
822
@dbus.service.method(_interface)
1441
823
def Enable(self):
1459
841
def StopChecker(self):
1460
842
self.stop_checker()
1461
843
1462
## Properties
1463
1464
# ApprovalPending - property
1465
@dbus_service_property(_interface, signature="b", access="read")
1466
def ApprovalPending_dbus_property(self):
1467
return dbus.Boolean(bool(self.approvals_pending))
1468
1469
# ApprovedByDefault - property
1470
@dbus_service_property(_interface, signature="b",
1471
access="readwrite")
1472
def ApprovedByDefault_dbus_property(self, value=None):
1473
if value is None: # get
1474
return dbus.Boolean(self.approved_by_default)
1475
self.approved_by_default = bool(value)
1476
1477
# ApprovalDelay - property
1478
@dbus_service_property(_interface, signature="t",
1479
access="readwrite")
1480
def ApprovalDelay_dbus_property(self, value=None):
1481
if value is None: # get
1482
return dbus.UInt64(self.approval_delay_milliseconds())
1483
self.approval_delay = datetime.timedelta(0, 0, 0, value)
1484
1485
# ApprovalDuration - property
1486
@dbus_service_property(_interface, signature="t",
1487
access="readwrite")
1488
def ApprovalDuration_dbus_property(self, value=None):
1489
if value is None: # get
1490
return dbus.UInt64(timedelta_to_milliseconds(
1491
self.approval_duration))
1492
self.approval_duration = datetime.timedelta(0, 0, 0, value)
1493
1494
# Name - property
1495
@dbus_service_property(_interface, signature="s", access="read")
1496
def Name_dbus_property(self):
844
# name - property
845
@dbus_service_property(_interface, signature=u"s", access=u"read")
846
def name_dbus_property(self):
1497
847
return dbus.String(self.name)
1498
848
1499
# Fingerprint - property
1500
@dbus_service_property(_interface, signature="s", access="read")
1501
def Fingerprint_dbus_property(self):
849
# fingerprint - property
850
@dbus_service_property(_interface, signature=u"s", access=u"read")
851
def fingerprint_dbus_property(self):
1502
852
return dbus.String(self.fingerprint)
1503
853
1504
# Host - property
1505
@dbus_service_property(_interface, signature="s",
1506
access="readwrite")
1507
def Host_dbus_property(self, value=None):
854
# host - property
855
@dbus_service_property(_interface, signature=u"s",
856
access=u"readwrite")
857
def host_dbus_property(self, value=None):
1508
858
if value is None: # get
1509
859
return dbus.String(self.host)
1510
self.host = unicode(value)
1511
1512
# Created - property
1513
@dbus_service_property(_interface, signature="s", access="read")
1514
def Created_dbus_property(self):
1515
return datetime_to_dbus(self.created)
1516
1517
# LastEnabled - property
1518
@dbus_service_property(_interface, signature="s", access="read")
1519
def LastEnabled_dbus_property(self):
1520
return datetime_to_dbus(self.last_enabled)
1521
1522
# Enabled - property
1523
@dbus_service_property(_interface, signature="b",
1524
access="readwrite")
1525
def Enabled_dbus_property(self, value=None):
860
self.host = value
861
# Emit D-Bus signal
862
self.PropertyChanged(dbus.String(u"host"),
863
dbus.String(value, variant_level=1))
864
865
# created - property
866
@dbus_service_property(_interface, signature=u"s", access=u"read")
867
def created_dbus_property(self):
868
return dbus.String(self._datetime_to_dbus(self.created))
869
870
# last_enabled - property
871
@dbus_service_property(_interface, signature=u"s", access=u"read")
872
def last_enabled_dbus_property(self):
873
if self.last_enabled is None:
874
return dbus.String(u"")
875
return dbus.String(self._datetime_to_dbus(self.last_enabled))
876
877
# enabled - property
878
@dbus_service_property(_interface, signature=u"b",
879
access=u"readwrite")
880
def enabled_dbus_property(self, value=None):
1526
881
if value is None: # get
1527
882
return dbus.Boolean(self.enabled)
1528
883
if value:
1530
885
else:
1531
886
self.disable()
1532
887
1533
# LastCheckedOK - property
1534
@dbus_service_property(_interface, signature="s",
1535
access="readwrite")
1536
def LastCheckedOK_dbus_property(self, value=None):
888
# last_checked_ok - property
889
@dbus_service_property(_interface, signature=u"s",
890
access=u"readwrite")
891
def last_checked_ok_dbus_property(self, value=None):
1537
892
if value is not None:
1538
893
self.checked_ok()
1539
894
return
1540
return datetime_to_dbus(self.last_checked_ok)
1541
1542
# LastCheckerStatus - property
1543
@dbus_service_property(_interface, signature="n",
1544
access="read")
1545
def LastCheckerStatus_dbus_property(self):
1546
return dbus.Int16(self.last_checker_status)
1547
1548
# Expires - property
1549
@dbus_service_property(_interface, signature="s", access="read")
1550
def Expires_dbus_property(self):
1551
return datetime_to_dbus(self.expires)
1552
1553
# LastApprovalRequest - property
1554
@dbus_service_property(_interface, signature="s", access="read")
1555
def LastApprovalRequest_dbus_property(self):
1556
return datetime_to_dbus(self.last_approval_request)
1557
1558
# Timeout - property
1559
@dbus_service_property(_interface, signature="t",
1560
access="readwrite")
1561
def Timeout_dbus_property(self, value=None):
895
if self.last_checked_ok is None:
896
return dbus.String(u"")
897
return dbus.String(self._datetime_to_dbus(self
898
.last_checked_ok))
899
900
# timeout - property
901
@dbus_service_property(_interface, signature=u"t",
902
access=u"readwrite")
903
def timeout_dbus_property(self, value=None):
1562
904
if value is None: # get
1563
905
return dbus.UInt64(self.timeout_milliseconds())
1564
old_timeout = self.timeout
1565
906
self.timeout = datetime.timedelta(0, 0, 0, value)
1566
# Reschedule disabling
1567
if self.enabled:
1568
now = datetime.datetime.utcnow()
1569
self.expires += self.timeout - old_timeout
1570
if self.expires <= now:
1571
# The timeout has passed
1572
self.disable()
1573
else:
1574
if (getattr(self, "disable_initiator_tag", None)
1575
is None):
1576
return
1577
gobject.source_remove(self.disable_initiator_tag)
1578
self.disable_initiator_tag = (
1579
gobject.timeout_add(
1580
timedelta_to_milliseconds(self.expires - now),
1581
self.disable))
1582
1583
# ExtendedTimeout - property
1584
@dbus_service_property(_interface, signature="t",
1585
access="readwrite")
1586
def ExtendedTimeout_dbus_property(self, value=None):
1587
if value is None: # get
1588
return dbus.UInt64(self.extended_timeout_milliseconds())
1589
self.extended_timeout = datetime.timedelta(0, 0, 0, value)
1590
1591
# Interval - property
1592
@dbus_service_property(_interface, signature="t",
1593
access="readwrite")
1594
def Interval_dbus_property(self, value=None):
907
# Emit D-Bus signal
908
self.PropertyChanged(dbus.String(u"timeout"),
909
dbus.UInt64(value, variant_level=1))
910
if getattr(self, u"disable_initiator_tag", None) is None:
911
return
912
# Reschedule timeout
913
gobject.source_remove(self.disable_initiator_tag)
914
self.disable_initiator_tag = None
915
time_to_die = (self.
916
_timedelta_to_milliseconds((self
917
.last_checked_ok
918
+ self.timeout)
919
- datetime.datetime
920
.utcnow()))
921
if time_to_die <= 0:
922
# The timeout has passed
923
self.disable()
924
else:
925
self.disable_initiator_tag = (gobject.timeout_add
926
(time_to_die, self.disable))
927
928
# interval - property
929
@dbus_service_property(_interface, signature=u"t",
930
access=u"readwrite")
931
def interval_dbus_property(self, value=None):
1595
932
if value is None: # get
1596
933
return dbus.UInt64(self.interval_milliseconds())
1597
934
self.interval = datetime.timedelta(0, 0, 0, value)
1598
if getattr(self, "checker_initiator_tag", None) is None:
935
# Emit D-Bus signal
936
self.PropertyChanged(dbus.String(u"interval"),
937
dbus.UInt64(value, variant_level=1))
938
if getattr(self, u"checker_initiator_tag", None) is None:
1599
939
return
1600
if self.enabled:
1601
# Reschedule checker run
1602
gobject.source_remove(self.checker_initiator_tag)
1603
self.checker_initiator_tag = (gobject.timeout_add
1604
(value, self.start_checker))
1605
self.start_checker() # Start one now, too
1606
1607
# Checker - property
1608
@dbus_service_property(_interface, signature="s",
1609
access="readwrite")
1610
def Checker_dbus_property(self, value=None):
940
# Reschedule checker run
941
gobject.source_remove(self.checker_initiator_tag)
942
self.checker_initiator_tag = (gobject.timeout_add
943
(value, self.start_checker))
944
self.start_checker() # Start one now, too
945
946
# checker - property
947
@dbus_service_property(_interface, signature=u"s",
948
access=u"readwrite")
949
def checker_dbus_property(self, value=None):
1611
950
if value is None: # get
1612
951
return dbus.String(self.checker_command)
1613
self.checker_command = unicode(value)
952
self.checker_command = value
953
# Emit D-Bus signal
954
self.PropertyChanged(dbus.String(u"checker"),
955
dbus.String(self.checker_command,
956
variant_level=1))
1614
957
1615
# CheckerRunning - property
1616
@dbus_service_property(_interface, signature="b",
1617
access="readwrite")
1618
def CheckerRunning_dbus_property(self, value=None):
958
# checker_running - property
959
@dbus_service_property(_interface, signature=u"b",
960
access=u"readwrite")
961
def checker_running_dbus_property(self, value=None):
1619
962
if value is None: # get
1620
963
return dbus.Boolean(self.checker is not None)
1621
964
if value:
1623
966
else:
1624
967
self.stop_checker()
1625
968
1626
# ObjectPath - property
1627
@dbus_service_property(_interface, signature="o", access="read")
1628
def ObjectPath_dbus_property(self):
969
# object_path - property
970
@dbus_service_property(_interface, signature=u"o", access=u"read")
971
def object_path_dbus_property(self):
1629
972
return self.dbus_object_path # is already a dbus.ObjectPath
1630
973
1631
# Secret = property
1632
@dbus_service_property(_interface, signature="ay",
1633
access="write", byte_arrays=True)
1634
def Secret_dbus_property(self, value):
974
# secret = property
975
@dbus_service_property(_interface, signature=u"ay",
976
access=u"write", byte_arrays=True)
977
def secret_dbus_property(self, value):
1635
978
self.secret = str(value)
1636
979
1637
980
del _interface
1638
981
1639
982
1640
class ProxyClient(object):
1641
def __init__(self, child_pipe, fpr, address):
1642
self._pipe = child_pipe
1643
self._pipe.send(('init', fpr, address))
1644
if not self._pipe.recv():
1645
raise KeyError()
1646
1647
def __getattribute__(self, name):
1648
if name == '_pipe':
1649
return super(ProxyClient, self).__getattribute__(name)
1650
self._pipe.send(('getattr', name))
1651
data = self._pipe.recv()
1652
if data[0] == 'data':
1653
return data[1]
1654
if data[0] == 'function':
1655
def func(*args, **kwargs):
1656
self._pipe.send(('funcall', name, args, kwargs))
1657
return self._pipe.recv()[1]
1658
return func
1659
1660
def __setattr__(self, name, value):
1661
if name == '_pipe':
1662
return super(ProxyClient, self).__setattr__(name, value)
1663
self._pipe.send(('setattr', name, value))
1664
1665
1666
983
class ClientHandler(socketserver.BaseRequestHandler, object):
1667
984
"""A class to handle client connections.
1668
985
1670
987
Note: This will run in its own forked process."""
1671
988
1672
989
def handle(self):
1673
with contextlib.closing(self.server.child_pipe) as child_pipe:
1674
logger.info("TCP connection from: %s",
1675
unicode(self.client_address))
1676
logger.debug("Pipe FD: %d",
1677
self.server.child_pipe.fileno())
1678
990
logger.info(u"TCP connection from: %s",
991
unicode(self.client_address))
992
logger.debug(u"IPC Pipe FD: %d", self.server.pipe[1])
993
# Open IPC pipe to parent process
994
with closing(os.fdopen(self.server.pipe[1], u"w", 1)) as ipc:
1679
995
session = (gnutls.connection
1680
996
.ClientSession(self.request,
1681
997
gnutls.connection
1682
998
.X509Credentials()))
1683
999
1000
line = self.request.makefile().readline()
1001
logger.debug(u"Protocol version: %r", line)
1002
try:
1003
if int(line.strip().split()[0]) > 1:
1004
raise RuntimeError
1005
except (ValueError, IndexError, RuntimeError), error:
1006
logger.error(u"Unknown protocol version: %s", error)
1007
return
1008
1684
1009
# Note: gnutls.connection.X509Credentials is really a
1685
1010
# generic GnuTLS certificate credentials object so long as
1686
1011
# no X.509 keys are added to it. Therefore, we can use it
1687
1012
# here despite using OpenPGP certificates.
1688
1013
1689
#priority = ':'.join(("NONE", "+VERS-TLS1.1",
1690
# "+AES-256-CBC", "+SHA1",
1691
# "+COMP-NULL", "+CTYPE-OPENPGP",
1692
# "+DHE-DSS"))
1014
#priority = u':'.join((u"NONE", u"+VERS-TLS1.1",
1015
# u"+AES-256-CBC", u"+SHA1",
1016
# u"+COMP-NULL", u"+CTYPE-OPENPGP",
1017
# u"+DHE-DSS"))
1693
1018
# Use a fallback default, since this MUST be set.
1694
1019
priority = self.server.gnutls_priority
1695
1020
if priority is None:
1696
priority = "NORMAL"
1021
priority = u"NORMAL"
1697
1022
(gnutls.library.functions
1698
1023
.gnutls_priority_set_direct(session._c_object,
1699
1024
priority, None))
1700
1025
1701
# Start communication using the Mandos protocol
1702
# Get protocol number
1703
line = self.request.makefile().readline()
1704
logger.debug("Protocol version: %r", line)
1705
try:
1706
if int(line.strip().split()[0]) > 1:
1707
raise RuntimeError(line)
1708
except (ValueError, IndexError, RuntimeError) as error:
1709
logger.error("Unknown protocol version: %s", error)
1710
return
1711
1712
# Start GnuTLS connection
1713
1026
try:
1714
1027
session.handshake()
1715
except gnutls.errors.GNUTLSError as error:
1716
logger.warning("Handshake failed: %s", error)
1028
except gnutls.errors.GNUTLSError, error:
1029
logger.warning(u"Handshake failed: %s", error)
1717
1030
# Do not run session.bye() here: the session is not
1718
1031
# established. Just abandon the request.
1719
1032
return
1720
logger.debug("Handshake succeeded")
1721
1722
approval_required = False
1033
logger.debug(u"Handshake succeeded")
1723
1034
try:
1724
try:
1725
fpr = self.fingerprint(self.peer_certificate
1726
(session))
1727
except (TypeError,
1728
gnutls.errors.GNUTLSError) as error:
1729
logger.warning("Bad certificate: %s", error)
1730
return
1731
logger.debug("Fingerprint: %s", fpr)
1732
1733
try:
1734
client = ProxyClient(child_pipe, fpr,
1735
self.client_address)
1736
except KeyError:
1737
return
1738
1739
if client.approval_delay:
1740
delay = client.approval_delay
1741
client.approvals_pending += 1
1742
approval_required = True
1743
1744
while True:
1745
if not client.enabled:
1746
logger.info("Client %s is disabled",
1747
client.name)
1748
if self.server.use_dbus:
1749
# Emit D-Bus signal
1750
client.Rejected("Disabled")
1751
return
1752
1753
if client.approved or not client.approval_delay:
1754
#We are approved or approval is disabled
1755
break
1756
elif client.approved is None:
1757
logger.info("Client %s needs approval",
1758
client.name)
1759
if self.server.use_dbus:
1760
# Emit D-Bus signal
1761
client.NeedApproval(
1762
client.approval_delay_milliseconds(),
1763
client.approved_by_default)
1764
else:
1765
logger.warning("Client %s was not approved",
1766
client.name)
1767
if self.server.use_dbus:
1768
# Emit D-Bus signal
1769
client.Rejected("Denied")
1770
return
1771
1772
#wait until timeout or approved
1773
time = datetime.datetime.now()
1774
client.changedstate.acquire()
1775
client.changedstate.wait(
1776
float(timedelta_to_milliseconds(delay)
1777
/ 1000))
1778
client.changedstate.release()
1779
time2 = datetime.datetime.now()
1780
if (time2 - time) >= delay:
1781
if not client.approved_by_default:
1782
logger.warning("Client %s timed out while"
1783
" waiting for approval",
1784
client.name)
1785
if self.server.use_dbus:
1786
# Emit D-Bus signal
1787
client.Rejected("Approval timed out")
1788
return
1789
else:
1790
break
1791
else:
1792
delay -= time2 - time
1793
1794
sent_size = 0
1795
while sent_size < len(client.secret):
1796
try:
1797
sent = session.send(client.secret[sent_size:])
1798
except gnutls.errors.GNUTLSError as error:
1799
logger.warning("gnutls send failed",
1800
exc_info=error)
1801
return
1802
logger.debug("Sent: %d, remaining: %d",
1803
sent, len(client.secret)
1804
- (sent_size + sent))
1805
sent_size += sent
1806
1807
logger.info("Sending secret to %s", client.name)
1808
# bump the timeout using extended_timeout
1809
client.bump_timeout(client.extended_timeout)
1810
if self.server.use_dbus:
1811
# Emit D-Bus signal
1812
client.GotSecret()
1035
fpr = self.fingerprint(self.peer_certificate(session))
1036
except (TypeError, gnutls.errors.GNUTLSError), error:
1037
logger.warning(u"Bad certificate: %s", error)
1038
session.bye()
1039
return
1040
logger.debug(u"Fingerprint: %s", fpr)
1813
1041
1814
finally:
1815
if approval_required:
1816
client.approvals_pending -= 1
1817
try:
1818
session.bye()
1819
except gnutls.errors.GNUTLSError as error:
1820
logger.warning("GnuTLS bye failed",
1821
exc_info=error)
1042
for c in self.server.clients:
1043
if c.fingerprint == fpr:
1044
client = c
1045
break
1046
else:
1047
ipc.write(u"NOTFOUND %s %s\n"
1048
% (fpr, unicode(self.client_address)))
1049
session.bye()
1050
return
1051
# Have to check if client.still_valid(), since it is
1052
# possible that the client timed out while establishing
1053
# the GnuTLS session.
1054
if not client.still_valid():
1055
ipc.write(u"INVALID %s\n" % client.name)
1056
session.bye()
1057
return
1058
ipc.write(u"SENDING %s\n" % client.name)
1059
sent_size = 0
1060
while sent_size < len(client.secret):
1061
sent = session.send(client.secret[sent_size:])
1062
logger.debug(u"Sent: %d, remaining: %d",
1063
sent, len(client.secret)
1064
- (sent_size + sent))
1065
sent_size += sent
1066
session.bye()
1822
1067
1823
1068
@staticmethod
1824
1069
def peer_certificate(session):
1834
1079
.gnutls_certificate_get_peers
1835
1080
(session._c_object, ctypes.byref(list_size)))
1836
1081
if not bool(cert_list) and list_size.value != 0:
1837
raise gnutls.errors.GNUTLSError("error getting peer"
1838
" certificate")
1082
raise gnutls.errors.GNUTLSError(u"error getting peer"
1083
u" certificate")
1839
1084
if list_size.value == 0:
1840
1085
return None
1841
1086
cert = cert_list[0]
1867
1112
if crtverify.value != 0:
1868
1113
gnutls.library.functions.gnutls_openpgp_crt_deinit(crt)
1869
1114
raise (gnutls.errors.CertificateSecurityError
1870
("Verify failed"))
1115
(u"Verify failed"))
1871
1116
# New buffer for the fingerprint
1872
1117
buf = ctypes.create_string_buffer(20)
1873
1118
buf_len = ctypes.c_size_t()
1880
1125
# Convert the buffer to a Python bytestring
1881
1126
fpr = ctypes.string_at(buf, buf_len.value)
1882
1127
# Convert the bytestring to hexadecimal notation
1883
hex_fpr = binascii.hexlify(fpr).upper()
1128
hex_fpr = u''.join(u"%02X" % ord(char) for char in fpr)
1884
1129
return hex_fpr
1885
1130
1886
1131
1887
class MultiprocessingMixIn(object):
1888
"""Like socketserver.ThreadingMixIn, but with multiprocessing"""
1889
def sub_process_main(self, request, address):
1890
try:
1891
self.finish_request(request, address)
1892
except Exception:
1893
self.handle_error(request, address)
1894
self.close_request(request)
1895
1896
def process_request(self, request, address):
1897
"""Start a new process to process the request."""
1898
proc = multiprocessing.Process(target = self.sub_process_main,
1899
args = (request, address))
1900
proc.start()
1901
return proc
1902
1903
1904
class MultiprocessingMixInWithPipe(MultiprocessingMixIn, object):
1905
""" adds a pipe to the MixIn """
1132
class ForkingMixInWithPipe(socketserver.ForkingMixIn, object):
1133
"""Like socketserver.ForkingMixIn, but also pass a pipe."""
1906
1134
def process_request(self, request, client_address):
1907
1135
"""Overrides and wraps the original process_request().
1908
1136
1909
1137
This function creates a new pipe in self.pipe
1910
1138
"""
1911
parent_pipe, self.child_pipe = multiprocessing.Pipe()
1912
1913
proc = MultiprocessingMixIn.process_request(self, request,
1914
client_address)
1915
self.child_pipe.close()
1916
self.add_pipe(parent_pipe, proc)
1917
1918
def add_pipe(self, parent_pipe, proc):
1139
self.pipe = os.pipe()
1140
super(ForkingMixInWithPipe,
1141
self).process_request(request, client_address)
1142
os.close(self.pipe[1]) # close write end
1143
self.add_pipe(self.pipe[0])
1144
def add_pipe(self, pipe):
1919
1145
"""Dummy function; override as necessary"""
1920
raise NotImplementedError()
1921
1922
1923
class IPv6_TCPServer(MultiprocessingMixInWithPipe,
1146
os.close(pipe)
1147
1148
1149
class IPv6_TCPServer(ForkingMixInWithPipe,
1924
1150
socketserver.TCPServer, object):
1925
1151
"""IPv6-capable TCP server. Accepts 'None' as address and/or port
1926
1152
1930
1156
use_ipv6: Boolean; to use IPv6 or not
1931
1157
"""
1932
1158
def __init__(self, server_address, RequestHandlerClass,
1933
interface=None, use_ipv6=True, socketfd=None):
1934
"""If socketfd is set, use that file descriptor instead of
1935
creating a new one with socket.socket().
1936
"""
1159
interface=None, use_ipv6=True):
1937
1160
self.interface = interface
1938
1161
if use_ipv6:
1939
1162
self.address_family = socket.AF_INET6
1940
if socketfd is not None:
1941
# Save the file descriptor
1942
self.socketfd = socketfd
1943
# Save the original socket.socket() function
1944
self.socket_socket = socket.socket
1945
# To implement --socket, we monkey patch socket.socket.
1946
#
1947
# (When socketserver.TCPServer is a new-style class, we
1948
# could make self.socket into a property instead of monkey
1949
# patching socket.socket.)
1950
#
1951
# Create a one-time-only replacement for socket.socket()
1952
@functools.wraps(socket.socket)
1953
def socket_wrapper(*args, **kwargs):
1954
# Restore original function so subsequent calls are
1955
# not affected.
1956
socket.socket = self.socket_socket
1957
del self.socket_socket
1958
# This time only, return a new socket object from the
1959
# saved file descriptor.
1960
return socket.fromfd(self.socketfd, *args, **kwargs)
1961
# Replace socket.socket() function with wrapper
1962
socket.socket = socket_wrapper
1963
# The socketserver.TCPServer.__init__ will call
1964
# socket.socket(), which might be our replacement,
1965
# socket_wrapper(), if socketfd was set.
1966
1163
socketserver.TCPServer.__init__(self, server_address,
1967
1164
RequestHandlerClass)
1968
1969
1165
def server_bind(self):
1970
1166
"""This overrides the normal server_bind() function
1971
1167
to bind to an interface if one was specified, and also NOT to
1972
1168
bind to an address or port if they were not specified."""
1973
1169
if self.interface is not None:
1974
1170
if SO_BINDTODEVICE is None:
1975
logger.error("SO_BINDTODEVICE does not exist;"
1976
" cannot bind to interface %s",
1171
logger.error(u"SO_BINDTODEVICE does not exist;"
1172
u" cannot bind to interface %s",
1977
1173
self.interface)
1978
1174
else:
1979
1175
try:
1980
1176
self.socket.setsockopt(socket.SOL_SOCKET,
1981
1177
SO_BINDTODEVICE,
1982
str(self.interface + '\0'))
1983
except socket.error as error:
1984
if error.errno == errno.EPERM:
1985
logger.error("No permission to bind to"
1986
" interface %s", self.interface)
1987
elif error.errno == errno.ENOPROTOOPT:
1988
logger.error("SO_BINDTODEVICE not available;"
1989
" cannot bind to interface %s",
1990
self.interface)
1991
elif error.errno == errno.ENODEV:
1992
logger.error("Interface %s does not exist,"
1993
" cannot bind", self.interface)
1178
str(self.interface
1179
+ u'\0'))
1180
except socket.error, error:
1181
if error[0] == errno.EPERM:
1182
logger.error(u"No permission to"
1183
u" bind to interface %s",
1184
self.interface)
1185
elif error[0] == errno.ENOPROTOOPT:
1186
logger.error(u"SO_BINDTODEVICE not available;"
1187
u" cannot bind to interface %s",
1188
self.interface)
1994
1189
else:
1995
1190
raise
1996
1191
# Only bind(2) the socket if we really need to.
1997
1192
if self.server_address[0] or self.server_address[1]:
1998
1193
if not self.server_address[0]:
1999
1194
if self.address_family == socket.AF_INET6:
2000
any_address = "::" # in6addr_any
1195
any_address = u"::" # in6addr_any
2001
1196
else:
2002
any_address = "0.0.0.0" # INADDR_ANY
1197
any_address = socket.INADDR_ANY
2003
1198
self.server_address = (any_address,
2004
1199
self.server_address[1])
2005
1200
elif not self.server_address[1]:
2026
1221
"""
2027
1222
def __init__(self, server_address, RequestHandlerClass,
2028
1223
interface=None, use_ipv6=True, clients=None,
2029
gnutls_priority=None, use_dbus=True, socketfd=None):
1224
gnutls_priority=None, use_dbus=True):
2030
1225
self.enabled = False
2031
1226
self.clients = clients
2032
1227
if self.clients is None:
2033
self.clients = {}
1228
self.clients = set()
2034
1229
self.use_dbus = use_dbus
2035
1230
self.gnutls_priority = gnutls_priority
2036
1231
IPv6_TCPServer.__init__(self, server_address,
2037
1232
RequestHandlerClass,
2038
1233
interface = interface,
2039
use_ipv6 = use_ipv6,
2040
socketfd = socketfd)
1234
use_ipv6 = use_ipv6)
2041
1235
def server_activate(self):
2042
1236
if self.enabled:
2043
1237
return socketserver.TCPServer.server_activate(self)
2044
2045
1238
def enable(self):
2046
1239
self.enabled = True
2047
2048
def add_pipe(self, parent_pipe, proc):
1240
def add_pipe(self, pipe):
2049
1241
# Call "handle_ipc" for both data and EOF events
2050
gobject.io_add_watch(parent_pipe.fileno(),
2051
gobject.IO_IN | gobject.IO_HUP,
2052
functools.partial(self.handle_ipc,
2053
parent_pipe =
2054
parent_pipe,
2055
proc = proc))
2056
2057
def handle_ipc(self, source, condition, parent_pipe=None,
2058
proc = None, client_object=None):
2059
# error, or the other end of multiprocessing.Pipe has closed
2060
if condition & (gobject.IO_ERR | gobject.IO_HUP):
2061
# Wait for other process to exit
2062
proc.join()
2063
return False
2064
2065
# Read a request from the child
2066
request = parent_pipe.recv()
2067
command = request[0]
2068
2069
if command == 'init':
2070
fpr = request[1]
2071
address = request[2]
2072
2073
for c in self.clients.itervalues():
2074
if c.fingerprint == fpr:
2075
client = c
2076
break
2077
else:
2078
logger.info("Client not found for fingerprint: %s, ad"
2079
"dress: %s", fpr, address)
2080
if self.use_dbus:
2081
# Emit D-Bus signal
2082
mandos_dbus_service.ClientNotFound(fpr,
2083
address[0])
2084
parent_pipe.send(False)
2085
return False
2086
2087
gobject.io_add_watch(parent_pipe.fileno(),
2088
gobject.IO_IN | gobject.IO_HUP,
2089
functools.partial(self.handle_ipc,
2090
parent_pipe =
2091
parent_pipe,
2092
proc = proc,
2093
client_object =
2094
client))
2095
parent_pipe.send(True)
2096
# remove the old hook in favor of the new above hook on
2097
# same fileno
2098
return False
2099
if command == 'funcall':
2100
funcname = request[1]
2101
args = request[2]
2102
kwargs = request[3]
2103
2104
parent_pipe.send(('data', getattr(client_object,
2105
funcname)(*args,
2106
**kwargs)))
2107
2108
if command == 'getattr':
2109
attrname = request[1]
2110
if callable(client_object.__getattribute__(attrname)):
2111
parent_pipe.send(('function',))
2112
else:
2113
parent_pipe.send(('data', client_object
2114
.__getattribute__(attrname)))
2115
2116
if command == 'setattr':
2117
attrname = request[1]
2118
value = request[2]
2119
setattr(client_object, attrname, value)
2120
1242
gobject.io_add_watch(pipe, gobject.IO_IN | gobject.IO_HUP,
1243
self.handle_ipc)
1244
def handle_ipc(self, source, condition, file_objects={}):
1245
condition_names = {
1246
gobject.IO_IN: u"IN", # There is data to read.
1247
gobject.IO_OUT: u"OUT", # Data can be written (without
1248
# blocking).
1249
gobject.IO_PRI: u"PRI", # There is urgent data to read.
1250
gobject.IO_ERR: u"ERR", # Error condition.
1251
gobject.IO_HUP: u"HUP" # Hung up (the connection has been
1252
# broken, usually for pipes and
1253
# sockets).
1254
}
1255
conditions_string = ' | '.join(name
1256
for cond, name in
1257
condition_names.iteritems()
1258
if cond & condition)
1259
logger.debug(u"Handling IPC: FD = %d, condition = %s", source,
1260
conditions_string)
1261
1262
# Turn the pipe file descriptor into a Python file object
1263
if source not in file_objects:
1264
file_objects[source] = os.fdopen(source, u"r", 1)
1265
1266
# Read a line from the file object
1267
cmdline = file_objects[source].readline()
1268
if not cmdline: # Empty line means end of file
1269
# close the IPC pipe
1270
file_objects[source].close()
1271
del file_objects[source]
1272
1273
# Stop calling this function
1274
return False
1275
1276
logger.debug(u"IPC command: %r", cmdline)
1277
1278
# Parse and act on command
1279
cmd, args = cmdline.rstrip(u"\r\n").split(None, 1)
1280
1281
if cmd == u"NOTFOUND":
1282
logger.warning(u"Client not found for fingerprint: %s",
1283
args)
1284
if self.use_dbus:
1285
# Emit D-Bus signal
1286
mandos_dbus_service.ClientNotFound(args)
1287
elif cmd == u"INVALID":
1288
for client in self.clients:
1289
if client.name == args:
1290
logger.warning(u"Client %s is invalid", args)
1291
if self.use_dbus:
1292
# Emit D-Bus signal
1293
client.Rejected()
1294
break
1295
else:
1296
logger.error(u"Unknown client %s is invalid", args)
1297
elif cmd == u"SENDING":
1298
for client in self.clients:
1299
if client.name == args:
1300
logger.info(u"Sending secret to %s", client.name)
1301
client.checked_ok()
1302
if self.use_dbus:
1303
# Emit D-Bus signal
1304
client.GotSecret()
1305
break
1306
else:
1307
logger.error(u"Sending secret to unknown client %s",
1308
args)
1309
else:
1310
logger.error(u"Unknown IPC command: %r", cmdline)
1311
1312
# Keep calling this function
2121
1313
return True
2122
1314
2123
1315
2124
def rfc3339_duration_to_delta(duration):
2125
"""Parse an RFC 3339 "duration" and return a datetime.timedelta
2126
2127
>>> rfc3339_duration_to_delta("P7D")
2128
datetime.timedelta(7)
2129
>>> rfc3339_duration_to_delta("PT60S")
2130
datetime.timedelta(0, 60)
2131
>>> rfc3339_duration_to_delta("PT60M")
2132
datetime.timedelta(0, 3600)
2133
>>> rfc3339_duration_to_delta("PT24H")
2134
datetime.timedelta(1)
2135
>>> rfc3339_duration_to_delta("P1W")
2136
datetime.timedelta(7)
2137
>>> rfc3339_duration_to_delta("PT5M30S")
2138
datetime.timedelta(0, 330)
2139
>>> rfc3339_duration_to_delta("P1DT3M20S")
2140
datetime.timedelta(1, 200)
2141
"""
2142
2143
# Parsing an RFC 3339 duration with regular expressions is not
2144
# possible - there would have to be multiple places for the same
2145
# values, like seconds. The current code, while more esoteric, is
2146
# cleaner without depending on a parsing library. If Python had a
2147
# built-in library for parsing we would use it, but we'd like to
2148
# avoid excessive use of external libraries.
2149
2150
# New type for defining tokens, syntax, and semantics all-in-one
2151
Token = collections.namedtuple("Token",
2152
("regexp", # To match token; if
2153
# "value" is not None,
2154
# must have a "group"
2155
# containing digits
2156
"value", # datetime.timedelta or
2157
# None
2158
"followers")) # Tokens valid after
2159
# this token
2160
# RFC 3339 "duration" tokens, syntax, and semantics; taken from
2161
# the "duration" ABNF definition in RFC 3339, Appendix A.
2162
token_end = Token(re.compile(r"$"), None, frozenset())
2163
token_second = Token(re.compile(r"(\d+)S"),
2164
datetime.timedelta(seconds=1),
2165
frozenset((token_end,)))
2166
token_minute = Token(re.compile(r"(\d+)M"),
2167
datetime.timedelta(minutes=1),
2168
frozenset((token_second, token_end)))
2169
token_hour = Token(re.compile(r"(\d+)H"),
2170
datetime.timedelta(hours=1),
2171
frozenset((token_minute, token_end)))
2172
token_time = Token(re.compile(r"T"),
2173
None,
2174
frozenset((token_hour, token_minute,
2175
token_second)))
2176
token_day = Token(re.compile(r"(\d+)D"),
2177
datetime.timedelta(days=1),
2178
frozenset((token_time, token_end)))
2179
token_month = Token(re.compile(r"(\d+)M"),
2180
datetime.timedelta(weeks=4),
2181
frozenset((token_day, token_end)))
2182
token_year = Token(re.compile(r"(\d+)Y"),
2183
datetime.timedelta(weeks=52),
2184
frozenset((token_month, token_end)))
2185
token_week = Token(re.compile(r"(\d+)W"),
2186
datetime.timedelta(weeks=1),
2187
frozenset((token_end,)))
2188
token_duration = Token(re.compile(r"P"), None,
2189
frozenset((token_year, token_month,
2190
token_day, token_time,
2191
token_week)))
2192
# Define starting values
2193
value = datetime.timedelta() # Value so far
2194
found_token = None
2195
followers = frozenset((token_duration,)) # Following valid tokens
2196
s = duration # String left to parse
2197
# Loop until end token is found
2198
while found_token is not token_end:
2199
# Search for any currently valid tokens
2200
for token in followers:
2201
match = token.regexp.match(s)
2202
if match is not None:
2203
# Token found
2204
if token.value is not None:
2205
# Value found, parse digits
2206
factor = int(match.group(1), 10)
2207
# Add to value so far
2208
value += factor * token.value
2209
# Strip token from string
2210
s = token.regexp.sub("", s, 1)
2211
# Go to found token
2212
found_token = token
2213
# Set valid next tokens
2214
followers = found_token.followers
2215
break
2216
else:
2217
# No currently valid tokens were found
2218
raise ValueError("Invalid RFC 3339 duration")
2219
# End token found
2220
return value
2221
2222
2223
1316
def string_to_delta(interval):
2224
1317
"""Parse a string and return a datetime.timedelta
2225
1318
2226
>>> string_to_delta('7d')
1319
>>> string_to_delta(u'7d')
2227
1320
datetime.timedelta(7)
2228
>>> string_to_delta('60s')
1321
>>> string_to_delta(u'60s')
2229
1322
datetime.timedelta(0, 60)
2230
>>> string_to_delta('60m')
1323
>>> string_to_delta(u'60m')
2231
1324
datetime.timedelta(0, 3600)
2232
>>> string_to_delta('24h')
1325
>>> string_to_delta(u'24h')
2233
1326
datetime.timedelta(1)
2234
>>> string_to_delta('1w')
1327
>>> string_to_delta(u'1w')
2235
1328
datetime.timedelta(7)
2236
>>> string_to_delta('5m 30s')
1329
>>> string_to_delta(u'5m 30s')
2237
1330
datetime.timedelta(0, 330)
2238
1331
"""
2239
2240
try:
2241
return rfc3339_duration_to_delta(interval)
2242
except ValueError:
2243
pass
2244
2245
1332
timevalue = datetime.timedelta(0)
2246
1333
for s in interval.split():
2247
1334
try:
2248
1335
suffix = unicode(s[-1])
2249
1336
value = int(s[:-1])
2250
if suffix == "d":
1337
if suffix == u"d":
2251
1338
delta = datetime.timedelta(value)
2252
elif suffix == "s":
1339
elif suffix == u"s":
2253
1340
delta = datetime.timedelta(0, value)
2254
elif suffix == "m":
1341
elif suffix == u"m":
2255
1342
delta = datetime.timedelta(0, 0, 0, 0, value)
2256
elif suffix == "h":
1343
elif suffix == u"h":
2257
1344
delta = datetime.timedelta(0, 0, 0, 0, 0, value)
2258
elif suffix == "w":
1345
elif suffix == u"w":
2259
1346
delta = datetime.timedelta(0, 0, 0, 0, 0, 0, value)
2260
1347
else:
2261
raise ValueError("Unknown suffix {!r}"
2262
.format(suffix))
2263
except IndexError as e:
2264
raise ValueError(*(e.args))
1348
raise ValueError
1349
except (ValueError, IndexError):
1350
raise ValueError
2265
1351
timevalue += delta
2266
1352
return timevalue
2267
1353
2268
1354
1355
def if_nametoindex(interface):
1356
"""Call the C function if_nametoindex(), or equivalent
1357
1358
Note: This function cannot accept a unicode string."""
1359
global if_nametoindex
1360
try:
1361
if_nametoindex = (ctypes.cdll.LoadLibrary
1362
(ctypes.util.find_library(u"c"))
1363
.if_nametoindex)
1364
except (OSError, AttributeError):
1365
logger.warning(u"Doing if_nametoindex the hard way")
1366
def if_nametoindex(interface):
1367
"Get an interface index the hard way, i.e. using fcntl()"
1368
SIOCGIFINDEX = 0x8933 # From /usr/include/linux/sockios.h
1369
with closing(socket.socket()) as s:
1370
ifreq = fcntl.ioctl(s, SIOCGIFINDEX,
1371
struct.pack(str(u"16s16x"),
1372
interface))
1373
interface_index = struct.unpack(str(u"I"),
1374
ifreq[16:20])[0]
1375
return interface_index
1376
return if_nametoindex(interface)
1377
1378
2269
1379
def daemon(nochdir = False, noclose = False):
2270
1380
"""See daemon(3). Standard BSD Unix function.
2271
1381
2274
1384
sys.exit()
2275
1385
os.setsid()
2276
1386
if not nochdir:
2277
os.chdir("/")
1387
os.chdir(u"/")
2278
1388
if os.fork():
2279
1389
sys.exit()
2280
1390
if not noclose:
2281
1391
# Close all standard open file descriptors
2282
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
1392
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
2283
1393
if not stat.S_ISCHR(os.fstat(null).st_mode):
2284
raise OSError(errno.ENODEV, "{} not a character device"
2285
.format(os.devnull))
1394
raise OSError(errno.ENODEV,
1395
u"%s not a character device"
1396
% os.path.devnull)
2286
1397
os.dup2(null, sys.stdin.fileno())
2287
1398
os.dup2(null, sys.stdout.fileno())
2288
1399
os.dup2(null, sys.stderr.fileno())
2295
1406
##################################################################
2296
1407
# Parsing of options, both command line and config file
2297
1408
2298
parser = argparse.ArgumentParser()
2299
parser.add_argument("-v", "--version", action="version",
2300
version = "%(prog)s {}".format(version),
2301
help="show version number and exit")
2302
parser.add_argument("-i", "--interface", metavar="IF",
2303
help="Bind to interface IF")
2304
parser.add_argument("-a", "--address",
2305
help="Address to listen for requests on")
2306
parser.add_argument("-p", "--port", type=int,
2307
help="Port number to receive requests on")
2308
parser.add_argument("--check", action="store_true",
2309
help="Run self-test")
2310
parser.add_argument("--debug", action="store_true",
2311
help="Debug mode; run in foreground and log"
2312
" to terminal", default=None)
2313
parser.add_argument("--debuglevel", metavar="LEVEL",
2314
help="Debug level for stdout output")
2315
parser.add_argument("--priority", help="GnuTLS"
2316
" priority string (see GnuTLS documentation)")
2317
parser.add_argument("--servicename",
2318
metavar="NAME", help="Zeroconf service name")
2319
parser.add_argument("--configdir",
2320
default="/etc/mandos", metavar="DIR",
2321
help="Directory to search for configuration"
2322
" files")
2323
parser.add_argument("--no-dbus", action="store_false",
2324
dest="use_dbus", help="Do not provide D-Bus"
2325
" system bus interface", default=None)
2326
parser.add_argument("--no-ipv6", action="store_false",
2327
dest="use_ipv6", help="Do not use IPv6",
2328
default=None)
2329
parser.add_argument("--no-restore", action="store_false",
2330
dest="restore", help="Do not restore stored"
2331
" state", default=None)
2332
parser.add_argument("--socket", type=int,
2333
help="Specify a file descriptor to a network"
2334
" socket to use instead of creating one")
2335
parser.add_argument("--statedir", metavar="DIR",
2336
help="Directory to save/restore state in")
2337
parser.add_argument("--foreground", action="store_true",
2338
help="Run in foreground", default=None)
2339
parser.add_argument("--no-zeroconf", action="store_false",
2340
dest="zeroconf", help="Do not use Zeroconf",
2341
default=None)
2342
2343
options = parser.parse_args()
1409
parser = optparse.OptionParser(version = "%%prog %s" % version)
1410
parser.add_option("-i", u"--interface", type=u"string",
1411
metavar="IF", help=u"Bind to interface IF")
1412
parser.add_option("-a", u"--address", type=u"string",
1413
help=u"Address to listen for requests on")
1414
parser.add_option("-p", u"--port", type=u"int",
1415
help=u"Port number to receive requests on")
1416
parser.add_option("--check", action=u"store_true",
1417
help=u"Run self-test")
1418
parser.add_option("--debug", action=u"store_true",
1419
help=u"Debug mode; run in foreground and log to"
1420
u" terminal")
1421
parser.add_option("--priority", type=u"string", help=u"GnuTLS"
1422
u" priority string (see GnuTLS documentation)")
1423
parser.add_option("--servicename", type=u"string",
1424
metavar=u"NAME", help=u"Zeroconf service name")
1425
parser.add_option("--configdir", type=u"string",
1426
default=u"/etc/mandos", metavar=u"DIR",
1427
help=u"Directory to search for configuration"
1428
u" files")
1429
parser.add_option("--no-dbus", action=u"store_false",
1430
dest=u"use_dbus", help=u"Do not provide D-Bus"
1431
u" system bus interface")
1432
parser.add_option("--no-ipv6", action=u"store_false",
1433
dest=u"use_ipv6", help=u"Do not use IPv6")
1434
options = parser.parse_args()[0]
2344
1435
2345
1436
if options.check:
2346
1437
import doctest
2347
fail_count, test_count = doctest.testmod()
2348
sys.exit(os.EX_OK if fail_count == 0 else 1)
1438
doctest.testmod()
1439
sys.exit()
2349
1440
2350
1441
# Default values for config file for server-global settings
2351
server_defaults = { "interface": "",
2352
"address": "",
2353
"port": "",
2354
"debug": "False",
2355
"priority":
2356
"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP:+SIGN-RSA-SHA224:+SIGN-RSA-RMD160",
2357
"servicename": "Mandos",
2358
"use_dbus": "True",
2359
"use_ipv6": "True",
2360
"debuglevel": "",
2361
"restore": "True",
2362
"socket": "",
2363
"statedir": "/var/lib/mandos",
2364
"foreground": "False",
2365
"zeroconf": "True",
1442
server_defaults = { u"interface": u"",
1443
u"address": u"",
1444
u"port": u"",
1445
u"debug": u"False",
1446
u"priority":
1447
u"SECURE256:!CTYPE-X.509:+CTYPE-OPENPGP",
1448
u"servicename": u"Mandos",
1449
u"use_dbus": u"True",
1450
u"use_ipv6": u"True",
2366
1451
}
2367
1452
2368
1453
# Parse config file for server-global settings
2369
1454
server_config = configparser.SafeConfigParser(server_defaults)
2370
1455
del server_defaults
2371
1456
server_config.read(os.path.join(options.configdir,
2372
"mandos.conf"))
1457
u"mandos.conf"))
2373
1458
# Convert the SafeConfigParser object to a dict
2374
1459
server_settings = server_config.defaults()
2375
1460
# Use the appropriate methods on the non-string config options
2376
for option in ("debug", "use_dbus", "use_ipv6", "foreground"):
2377
server_settings[option] = server_config.getboolean("DEFAULT",
1461
for option in (u"debug", u"use_dbus", u"use_ipv6"):
1462
server_settings[option] = server_config.getboolean(u"DEFAULT",
2378
1463
option)
2379
1464
if server_settings["port"]:
2380
server_settings["port"] = server_config.getint("DEFAULT",
2381
"port")
2382
if server_settings["socket"]:
2383
server_settings["socket"] = server_config.getint("DEFAULT",
2384
"socket")
2385
# Later, stdin will, and stdout and stderr might, be dup'ed
2386
# over with an opened os.devnull. But we don't want this to
2387
# happen with a supplied network socket.
2388
if 0 <= server_settings["socket"] <= 2:
2389
server_settings["socket"] = os.dup(server_settings
2390
["socket"])
1465
server_settings["port"] = server_config.getint(u"DEFAULT",
1466
u"port")
2391
1467
del server_config
2392
1468
2393
1469
# Override the settings from the config file with command line
2394
1470
# options, if set.
2395
for option in ("interface", "address", "port", "debug",
2396
"priority", "servicename", "configdir",
2397
"use_dbus", "use_ipv6", "debuglevel", "restore",
2398
"statedir", "socket", "foreground", "zeroconf"):
1471
for option in (u"interface", u"address", u"port", u"debug",
1472
u"priority", u"servicename", u"configdir",
1473
u"use_dbus", u"use_ipv6"):
2399
1474
value = getattr(options, option)
2400
1475
if value is not None:
2401
1476
server_settings[option] = value
2404
1479
for option in server_settings.keys():
2405
1480
if type(server_settings[option]) is str:
2406
1481
server_settings[option] = unicode(server_settings[option])
2407
# Force all boolean options to be boolean
2408
for option in ("debug", "use_dbus", "use_ipv6", "restore",
2409
"foreground", "zeroconf"):
2410
server_settings[option] = bool(server_settings[option])
2411
# Debug implies foreground
2412
if server_settings["debug"]:
2413
server_settings["foreground"] = True
2414
1482
# Now we have our good server settings in "server_settings"
2415
1483
2416
1484
##################################################################
2417
1485
2418
if (not server_settings["zeroconf"] and
2419
not (server_settings["port"]
2420
or server_settings["socket"] != "")):
2421
parser.error("Needs port or socket to work without"
2422
" Zeroconf")
2423
2424
1486
# For convenience
2425
debug = server_settings["debug"]
2426
debuglevel = server_settings["debuglevel"]
2427
use_dbus = server_settings["use_dbus"]
2428
use_ipv6 = server_settings["use_ipv6"]
2429
stored_state_path = os.path.join(server_settings["statedir"],
2430
stored_state_file)
2431
foreground = server_settings["foreground"]
2432
zeroconf = server_settings["zeroconf"]
2433
2434
if debug:
2435
initlogger(debug, logging.DEBUG)
2436
else:
2437
if not debuglevel:
2438
initlogger(debug)
2439
else:
2440
level = getattr(logging, debuglevel.upper())
2441
initlogger(debug, level)
2442
2443
if server_settings["servicename"] != "Mandos":
1487
debug = server_settings[u"debug"]
1488
use_dbus = server_settings[u"use_dbus"]
1489
use_ipv6 = server_settings[u"use_ipv6"]
1490
1491
if not debug:
1492
syslogger.setLevel(logging.WARNING)
1493
console.setLevel(logging.WARNING)
1494
1495
if server_settings[u"servicename"] != u"Mandos":
2444
1496
syslogger.setFormatter(logging.Formatter
2445
('Mandos ({}) [%(process)d]:'
2446
' %(levelname)s: %(message)s'
2447
.format(server_settings
2448
["servicename"])))
1497
(u'Mandos (%s) [%%(process)d]:'
1498
u' %%(levelname)s: %%(message)s'
1499
% server_settings[u"servicename"]))
2449
1500
2450
1501
# Parse config file with clients
2451
client_config = configparser.SafeConfigParser(Client
2452
.client_defaults)
2453
client_config.read(os.path.join(server_settings["configdir"],
2454
"clients.conf"))
1502
client_defaults = { u"timeout": u"1h",
1503
u"interval": u"5m",
1504
u"checker": u"fping -q -- %%(host)s",
1505
u"host": u"",
1506
}
1507
client_config = configparser.SafeConfigParser(client_defaults)
1508
client_config.read(os.path.join(server_settings[u"configdir"],
1509
u"clients.conf"))
2455
1510
2456
1511
global mandos_dbus_service
2457
1512
mandos_dbus_service = None
2458
1513
2459
socketfd = None
2460
if server_settings["socket"] != "":
2461
socketfd = server_settings["socket"]
2462
tcp_server = MandosServer((server_settings["address"],
2463
server_settings["port"]),
1514
tcp_server = MandosServer((server_settings[u"address"],
1515
server_settings[u"port"]),
2464
1516
ClientHandler,
2465
interface=(server_settings["interface"]
2466
or None),
1517
interface=server_settings[u"interface"],
2467
1518
use_ipv6=use_ipv6,
2468
1519
gnutls_priority=
2469
server_settings["priority"],
2470
use_dbus=use_dbus,
2471
socketfd=socketfd)
2472
if not foreground:
2473
pidfilename = "/run/mandos.pid"
2474
if not os.path.isdir("/run/."):
2475
pidfilename = "/var/run/mandos.pid"
2476
pidfile = None
2477
try:
2478
pidfile = open(pidfilename, "w")
2479
except IOError as e:
2480
logger.error("Could not open file %r", pidfilename,
2481
exc_info=e)
1520
server_settings[u"priority"],
1521
use_dbus=use_dbus)
1522
pidfilename = u"/var/run/mandos.pid"
1523
try:
1524
pidfile = open(pidfilename, u"w")
1525
except IOError:
1526
logger.error(u"Could not open file %r", pidfilename)
2482
1527
2483
for name in ("_mandos", "mandos", "nobody"):
1528
try:
1529
uid = pwd.getpwnam(u"_mandos").pw_uid
1530
gid = pwd.getpwnam(u"_mandos").pw_gid
1531
except KeyError:
2484
1532
try:
2485
uid = pwd.getpwnam(name).pw_uid
2486
gid = pwd.getpwnam(name).pw_gid
2487
break
1533
uid = pwd.getpwnam(u"mandos").pw_uid
1534
gid = pwd.getpwnam(u"mandos").pw_gid
2488
1535
except KeyError:
2489
continue
2490
else:
2491
uid = 65534
2492
gid = 65534
1536
try:
1537
uid = pwd.getpwnam(u"nobody").pw_uid
1538
gid = pwd.getpwnam(u"nobody").pw_gid
1539
except KeyError:
1540
uid = 65534
1541
gid = 65534
2493
1542
try:
2494
1543
os.setgid(gid)
2495
1544
os.setuid(uid)
2496
except OSError as error:
2497
if error.errno != errno.EPERM:
2498
raise
1545
except OSError, error:
1546
if error[0] != errno.EPERM:
1547
raise error
2499
1548
1549
# Enable all possible GnuTLS debugging
2500
1550
if debug:
2501
# Enable all possible GnuTLS debugging
2502
2503
1551
# "Use a log level over 10 to enable all debugging options."
2504
1552
# - GnuTLS manual
2505
1553
gnutls.library.functions.gnutls_global_set_log_level(11)
2506
1554
2507
1555
@gnutls.library.types.gnutls_log_func
2508
1556
def debug_gnutls(level, string):
2509
logger.debug("GnuTLS: %s", string[:-1])
1557
logger.debug(u"GnuTLS: %s", string[:-1])
2510
1558
2511
1559
(gnutls.library.functions
2512
1560
.gnutls_global_set_log_function(debug_gnutls))
2513
2514
# Redirect stdin so all checkers get /dev/null
2515
null = os.open(os.devnull, os.O_NOCTTY | os.O_RDWR)
2516
os.dup2(null, sys.stdin.fileno())
2517
if null > 2:
2518
os.close(null)
2519
2520
# Need to fork before connecting to D-Bus
2521
if not foreground:
2522
# Close all input and output, do double fork, etc.
2523
daemon()
2524
2525
# multiprocessing will use threads, so before we use gobject we
2526
# need to inform gobject that threads will be used.
2527
gobject.threads_init()
2528
1561
2529
1562
global main_loop
2530
1563
# From the Avahi example code
2531
DBusGMainLoop(set_as_default=True)
1564
DBusGMainLoop(set_as_default=True )
2532
1565
main_loop = gobject.MainLoop()
2533
1566
bus = dbus.SystemBus()
2534
1567
# End of Avahi example code
2535
1568
if use_dbus:
2536
try:
2537
bus_name = dbus.service.BusName("se.recompile.Mandos",
2538
bus, do_not_queue=True)
2539
old_bus_name = (dbus.service.BusName
2540
("se.bsnet.fukt.Mandos", bus,
2541
do_not_queue=True))
2542
except dbus.exceptions.NameExistsException as e:
2543
logger.error("Disabling D-Bus:", exc_info=e)
2544
use_dbus = False
2545
server_settings["use_dbus"] = False
2546
tcp_server.use_dbus = False
2547
if zeroconf:
2548
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
2549
service = AvahiServiceToSyslog(name =
2550
server_settings["servicename"],
2551
servicetype = "_mandos._tcp",
2552
protocol = protocol, bus = bus)
2553
if server_settings["interface"]:
2554
service.interface = (if_nametoindex
2555
(str(server_settings["interface"])))
2556
2557
global multiprocessing_manager
2558
multiprocessing_manager = multiprocessing.Manager()
1569
bus_name = dbus.service.BusName(u"se.bsnet.fukt.Mandos", bus)
1570
protocol = avahi.PROTO_INET6 if use_ipv6 else avahi.PROTO_INET
1571
service = AvahiService(name = server_settings[u"servicename"],
1572
servicetype = u"_mandos._tcp",
1573
protocol = protocol, bus = bus)
1574
if server_settings["interface"]:
1575
service.interface = (if_nametoindex
1576
(str(server_settings[u"interface"])))
2559
1577
2560
1578
client_class = Client
2561
1579
if use_dbus:
2562
1580
client_class = functools.partial(ClientDBus, bus = bus)
2563
2564
client_settings = Client.config_parser(client_config)
2565
old_client_settings = {}
2566
clients_data = {}
2567
2568
# This is used to redirect stdout and stderr for checker processes
2569
global wnull
2570
wnull = open(os.devnull, "w") # A writable /dev/null
2571
# Only used if server is running in foreground but not in debug
2572
# mode
2573
if debug or not foreground:
2574
wnull.close()
2575
2576
# Get client data and settings from last running state.
2577
if server_settings["restore"]:
2578
try:
2579
with open(stored_state_path, "rb") as stored_state:
2580
clients_data, old_client_settings = (pickle.load
2581
(stored_state))
2582
os.remove(stored_state_path)
2583
except IOError as e:
2584
if e.errno == errno.ENOENT:
2585
logger.warning("Could not load persistent state: {}"
2586
.format(os.strerror(e.errno)))
2587
else:
2588
logger.critical("Could not load persistent state:",
2589
exc_info=e)
2590
raise
2591
except EOFError as e:
2592
logger.warning("Could not load persistent state: "
2593
"EOFError:", exc_info=e)
2594
2595
with PGPEngine() as pgp:
2596
for client_name, client in clients_data.items():
2597
# Skip removed clients
2598
if client_name not in client_settings:
2599
continue
2600
2601
# Decide which value to use after restoring saved state.
2602
# We have three different values: Old config file,
2603
# new config file, and saved state.
2604
# New config value takes precedence if it differs from old
2605
# config value, otherwise use saved state.
2606
for name, value in client_settings[client_name].items():
2607
try:
2608
# For each value in new config, check if it
2609
# differs from the old config value (Except for
2610
# the "secret" attribute)
2611
if (name != "secret" and
2612
value != old_client_settings[client_name]
2613
[name]):
2614
client[name] = value
2615
except KeyError:
2616
pass
2617
2618
# Clients who has passed its expire date can still be
2619
# enabled if its last checker was successful. Clients
2620
# whose checker succeeded before we stored its state is
2621
# assumed to have successfully run all checkers during
2622
# downtime.
2623
if client["enabled"]:
2624
if datetime.datetime.utcnow() >= client["expires"]:
2625
if not client["last_checked_ok"]:
2626
logger.warning(
2627
"disabling client {} - Client never "
2628
"performed a successful checker"
2629
.format(client_name))
2630
client["enabled"] = False
2631
elif client["last_checker_status"] != 0:
2632
logger.warning(
2633
"disabling client {} - Client last"
2634
" checker failed with error code {}"
2635
.format(client_name,
2636
client["last_checker_status"]))
2637
client["enabled"] = False
2638
else:
2639
client["expires"] = (datetime.datetime
2640
.utcnow()
2641
+ client["timeout"])
2642
logger.debug("Last checker succeeded,"
2643
" keeping {} enabled"
2644
.format(client_name))
2645
try:
2646
client["secret"] = (
2647
pgp.decrypt(client["encrypted_secret"],
2648
client_settings[client_name]
2649
["secret"]))
2650
except PGPError:
2651
# If decryption fails, we use secret from new settings
2652
logger.debug("Failed to decrypt {} old secret"
2653
.format(client_name))
2654
client["secret"] = (
2655
client_settings[client_name]["secret"])
2656
2657
# Add/remove clients based on new changes made to config
2658
for client_name in (set(old_client_settings)
2659
- set(client_settings)):
2660
del clients_data[client_name]
2661
for client_name in (set(client_settings)
2662
- set(old_client_settings)):
2663
clients_data[client_name] = client_settings[client_name]
2664
2665
# Create all client objects
2666
for client_name, client in clients_data.items():
2667
tcp_server.clients[client_name] = client_class(
2668
name = client_name, settings = client,
2669
server_settings = server_settings)
2670
1581
tcp_server.clients.update(set(
1582
client_class(name = section,
1583
config= dict(client_config.items(section)))
1584
for section in client_config.sections()))
2671
1585
if not tcp_server.clients:
2672
logger.warning("No clients defined")
2673
2674
if not foreground:
2675
if pidfile is not None:
2676
try:
2677
with pidfile:
2678
pid = os.getpid()
2679
pidfile.write(str(pid) + "\n".encode("utf-8"))
2680
except IOError:
2681
logger.error("Could not write to file %r with PID %d",
2682
pidfilename, pid)
1586
logger.warning(u"No clients defined")
1587
1588
if debug:
1589
# Redirect stdin so all checkers get /dev/null
1590
null = os.open(os.path.devnull, os.O_NOCTTY | os.O_RDWR)
1591
os.dup2(null, sys.stdin.fileno())
1592
if null > 2:
1593
os.close(null)
1594
else:
1595
# No console logging
1596
logger.removeHandler(console)
1597
# Close all input and output, do double fork, etc.
1598
daemon()
1599
1600
try:
1601
with closing(pidfile):
1602
pid = os.getpid()
1603
pidfile.write(str(pid) + "\n")
2683
1604
del pidfile
2684
del pidfilename
2685
1605
except IOError:
1606
logger.error(u"Could not write to file %r with PID %d",
1607
pidfilename, pid)
1608
except NameError:
1609
# "pidfile" was never created
1610
pass
1611
del pidfilename
1612
1613
def cleanup():
1614
"Cleanup function; run on exit"
1615
service.cleanup()
1616
1617
while tcp_server.clients:
1618
client = tcp_server.clients.pop()
1619
client.disable_hook = None
1620
client.disable()
1621
1622
atexit.register(cleanup)
1623
1624
if not debug:
1625
signal.signal(signal.SIGINT, signal.SIG_IGN)
2686
1626
signal.signal(signal.SIGHUP, lambda signum, frame: sys.exit())
2687
1627
signal.signal(signal.SIGTERM, lambda signum, frame: sys.exit())
2688
1628
2689
1629
if use_dbus:
2690
@alternate_dbus_interfaces({"se.recompile.Mandos":
2691
"se.bsnet.fukt.Mandos"})
2692
class MandosDBusService(DBusObjectWithProperties):
1630
class MandosDBusService(dbus.service.Object):
2693
1631
"""A D-Bus proxy object"""
2694
1632
def __init__(self):
2695
dbus.service.Object.__init__(self, bus, "/")
2696
_interface = "se.recompile.Mandos"
2697
2698
@dbus_interface_annotations(_interface)
2699
def _foo(self):
2700
return { "org.freedesktop.DBus.Property"
2701
".EmitsChangedSignal":
2702
"false"}
2703
2704
@dbus.service.signal(_interface, signature="o")
2705
def ClientAdded(self, objpath):
2706
"D-Bus signal"
2707
pass
2708
2709
@dbus.service.signal(_interface, signature="ss")
2710
def ClientNotFound(self, fingerprint, address):
2711
"D-Bus signal"
2712
pass
2713
2714
@dbus.service.signal(_interface, signature="os")
1633
dbus.service.Object.__init__(self, bus, u"/")
1634
_interface = u"se.bsnet.fukt.Mandos"
1635
1636
@dbus.service.signal(_interface, signature=u"oa{sv}")
1637
def ClientAdded(self, objpath, properties):
1638
"D-Bus signal"
1639
pass
1640
1641
@dbus.service.signal(_interface, signature=u"s")
1642
def ClientNotFound(self, fingerprint):
1643
"D-Bus signal"
1644
pass
1645
1646
@dbus.service.signal(_interface, signature=u"os")
2715
1647
def ClientRemoved(self, objpath, name):
2716
1648
"D-Bus signal"
2717
1649
pass
2718
1650
2719
@dbus.service.method(_interface, out_signature="ao")
1651
@dbus.service.method(_interface, out_signature=u"ao")
2720
1652
def GetAllClients(self):
2721
1653
"D-Bus method"
2722
1654
return dbus.Array(c.dbus_object_path
2723
for c in
2724
tcp_server.clients.itervalues())
1655
for c in tcp_server.clients)
2725
1656
2726
1657
@dbus.service.method(_interface,
2727
out_signature="a{oa{sv}}")
1658
out_signature=u"a{oa{sv}}")
2728
1659
def GetAllClientsWithProperties(self):
2729
1660
"D-Bus method"
2730
1661
return dbus.Dictionary(
2731
((c.dbus_object_path, c.GetAll(""))
2732
for c in tcp_server.clients.itervalues()),
2733
signature="oa{sv}")
1662
((c.dbus_object_path, c.GetAll(u""))
1663
for c in tcp_server.clients),
1664
signature=u"oa{sv}")
2734
1665
2735
@dbus.service.method(_interface, in_signature="o")
1666
@dbus.service.method(_interface, in_signature=u"o")
2736
1667
def RemoveClient(self, object_path):
2737
1668
"D-Bus method"
2738
for c in tcp_server.clients.itervalues():
1669
for c in tcp_server.clients:
2739
1670
if c.dbus_object_path == object_path:
2740
del tcp_server.clients[c.name]
1671
tcp_server.clients.remove(c)
2741
1672
c.remove_from_connection()
2742
1673
# Don't signal anything except ClientRemoved
2743
c.disable(quiet=True)
1674
c.disable(signal=False)
2744
1675
# Emit D-Bus signal
2745
1676
self.ClientRemoved(object_path, c.name)
2746
1677
return
2747
raise KeyError(object_path)
1678
raise KeyError
2748
1679
2749
1680
del _interface
2750
1681
2751
1682
mandos_dbus_service = MandosDBusService()
2752
1683
2753
def cleanup():
2754
"Cleanup function; run on exit"
2755
if zeroconf:
2756
service.cleanup()
2757
2758
multiprocessing.active_children()
2759
wnull.close()
2760
if not (tcp_server.clients or client_settings):
2761
return
2762
2763
# Store client before exiting. Secrets are encrypted with key
2764
# based on what config file has. If config file is
2765
# removed/edited, old secret will thus be unrecovable.
2766
clients = {}
2767
with PGPEngine() as pgp:
2768
for client in tcp_server.clients.itervalues():
2769
key = client_settings[client.name]["secret"]
2770
client.encrypted_secret = pgp.encrypt(client.secret,
2771
key)
2772
client_dict = {}
2773
2774
# A list of attributes that can not be pickled
2775
# + secret.
2776
exclude = { "bus", "changedstate", "secret",
2777
"checker", "server_settings" }
2778
for name, typ in (inspect.getmembers
2779
(dbus.service.Object)):
2780
exclude.add(name)
2781
2782
client_dict["encrypted_secret"] = (client
2783
.encrypted_secret)
2784
for attr in client.client_structure:
2785
if attr not in exclude:
2786
client_dict[attr] = getattr(client, attr)
2787
2788
clients[client.name] = client_dict
2789
del client_settings[client.name]["secret"]
2790
2791
try:
2792
with (tempfile.NamedTemporaryFile
2793
(mode='wb', suffix=".pickle", prefix='clients-',
2794
dir=os.path.dirname(stored_state_path),
2795
delete=False)) as stored_state:
2796
pickle.dump((clients, client_settings), stored_state)
2797
tempname=stored_state.name
2798
os.rename(tempname, stored_state_path)
2799
except (IOError, OSError) as e:
2800
if not debug:
2801
try:
2802
os.remove(tempname)
2803
except NameError:
2804
pass
2805
if e.errno in (errno.ENOENT, errno.EACCES, errno.EEXIST):
2806
logger.warning("Could not save persistent state: {}"
2807
.format(os.strerror(e.errno)))
2808
else:
2809
logger.warning("Could not save persistent state:",
2810
exc_info=e)
2811
raise
2812
2813
# Delete all clients, and settings from config
2814
while tcp_server.clients:
2815
name, client = tcp_server.clients.popitem()
2816
if use_dbus:
2817
client.remove_from_connection()
2818
# Don't signal anything except ClientRemoved
2819
client.disable(quiet=True)
2820
if use_dbus:
2821
# Emit D-Bus signal
2822
mandos_dbus_service.ClientRemoved(client
2823
.dbus_object_path,
2824
client.name)
2825
client_settings.clear()
2826
2827
atexit.register(cleanup)
2828
2829
for client in tcp_server.clients.itervalues():
1684
for client in tcp_server.clients:
2830
1685
if use_dbus:
2831
1686
# Emit D-Bus signal
2832
mandos_dbus_service.ClientAdded(client.dbus_object_path)
2833
# Need to initiate checking of clients
2834
if client.enabled:
2835
client.init_checker()
1687
mandos_dbus_service.ClientAdded(client.dbus_object_path,
1688
client.GetAll(u""))
1689
client.enable()
2836
1690
2837
1691
tcp_server.enable()
2838
1692
tcp_server.server_activate()
2839
1693
2840
1694
# Find out what port we got
2841
if zeroconf:
2842
service.port = tcp_server.socket.getsockname()[1]
1695
service.port = tcp_server.socket.getsockname()[1]
2843
1696
if use_ipv6:
2844
logger.info("Now listening on address %r, port %d,"
2845
" flowinfo %d, scope_id %d",
2846
*tcp_server.socket.getsockname())
1697
logger.info(u"Now listening on address %r, port %d,"
1698
" flowinfo %d, scope_id %d"
1699
% tcp_server.socket.getsockname())
2847
1700
else: # IPv4
2848
logger.info("Now listening on address %r, port %d",
2849
*tcp_server.socket.getsockname())
1701
logger.info(u"Now listening on address %r, port %d"
1702
% tcp_server.socket.getsockname())
2850
1703
2851
1704
#service.interface = tcp_server.socket.getsockname()[3]
2852
1705
2853
1706
try:
2854
if zeroconf:
2855
# From the Avahi example code
2856
try:
2857
service.activate()
2858
except dbus.exceptions.DBusException as error:
2859
logger.critical("D-Bus Exception", exc_info=error)
2860
cleanup()
2861
sys.exit(1)
2862
# End of Avahi example code
1707
# From the Avahi example code
1708
try:
1709
service.activate()
1710
except dbus.exceptions.DBusException, error:
1711
logger.critical(u"DBusException: %s", error)
1712
sys.exit(1)
1713
# End of Avahi example code
2863
1714
2864
1715
gobject.io_add_watch(tcp_server.fileno(), gobject.IO_IN,
2865
1716
lambda *args, **kwargs:
2866
1717
(tcp_server.handle_request
2867
1718
(*args[2:], **kwargs) or True))
2868
1719
2869
logger.debug("Starting main loop")
1720
logger.debug(u"Starting main loop")
2870
1721
main_loop.run()
2871
except AvahiError as error:
2872
logger.critical("Avahi Error", exc_info=error)
2873
cleanup()
1722
except AvahiError, error:
1723
logger.critical(u"AvahiError: %s", error)
2874
1724
sys.exit(1)
2875
1725
except KeyboardInterrupt:
2876
1726
if debug:
2877
print("", file=sys.stderr)
2878
logger.debug("Server received KeyboardInterrupt")
2879
logger.debug("Server exiting")
2880
# Must run before the D-Bus bus name gets deregistered
2881
cleanup()
1727
print >> sys.stderr
1728
logger.debug(u"Server received KeyboardInterrupt")
1729
logger.debug(u"Server exiting")
2882
1730
2883
1731
if __name__ == '__main__':
2884
1732
main()
Loggerhead is a web-based interface for Breezy
Version: 2.0.2.dev0