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