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