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