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