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