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