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